home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / misc / volume33 / problem1.1 / part02 / problem.lpr < prev    next >
Encoding:
Text File  |  1992-11-13  |  16.1 KB  |  388 lines

  1.  
  2. PROBLEM(1)               USER COMMANDS                 PROBLEM(1)
  3.  
  4. NAME
  5.      problem - a problem database manager
  6.  
  7. SYNOPSIS
  8.      problem [-v] [-d] [area1 area2 ...]
  9.  
  10. DESCRIPTION
  11.      Problem is a database manager for problems and bug  reports.
  12.      It  was  inspired  by  PROBLEM, the problem database manager
  13.      under IBM VM/CMS that was written  by  Andy  Hanushevsky  at
  14.      Cornell  University.   It  is  intended  to provide a common
  15.      interface to a collection of databases  describing  problems
  16.      and/or  bugs which a UNIX site might be interested in track-
  17.      ing, and to  facilitate  the  sharing  of  this  information
  18.      amongst all interested parties.
  19.  
  20.  
  21. COMMANDS
  22.      In the following  descriptions,  ^X  means  control-X.   ESC
  23.      stands  for  the ESCAPE key; for example ESC-v means the two
  24.      character sequence "ESCAPE", then "v".  TAB stands  for  the
  25.      tab key. UP_ARROW stands for the up arrow key and DOWN_ARROW
  26.      stands for the down arrow key,  if  your  keyboard  supports
  27.      arrow keys.
  28.  
  29.      Typing problem, a list of problem  areas,  called  the  area
  30.      window,  is  displayed.   This list is set up by the problem
  31.      administrator at your site.  It consists of the  areas  into
  32.      which  problems and bug reports can be logged. A sample area
  33.      window:
  34.  
  35.        1 apf        - for AIX Parallel Fortran problems under AIX/370
  36.        2 aix370     - general AIX/370 problems
  37.        3 aixws      - any workstation related problem
  38.        4 dbx        - any dbx-related problem
  39.        5 AFS or NFS - any AFS or NFS related problem
  40.  
  41.      The areas are numbered from 1 to N, where  N  is  the  total
  42.      number  of  areas  defined  at your site.  If N is less than
  43.      ten, you simply need to press the key corresponding to  that
  44.      number  to  indicate your interest in that area.  Otherwise,
  45.      you must type in the number followed by a  carriage  return.
  46.      If  there  are more areas than lines on your screen, problem
  47.      will display as many as will fit on the  screen  by  forcing
  48.      the  areas  to fit in a series of twenty-five character wide
  49.      columns.  If they still don't all fit on the screen,  typing
  50.      `H' or `?' will scroll through all the areas.
  51.  
  52.      Once you've selected an area, a list of available  commands,
  53.      called the command window, is displayed:
  54.  
  55.        l  -- log new problem
  56.        a  -- append to a problem
  57.        c  -- close a problem
  58.        d  -- delete a problem from the database
  59.        e  -- examine a problem
  60.        q  -- quit
  61.        r  -- reorganize the database
  62.        s  -- subscribe to this problem area
  63.        u  -- unsubscribe from this problem area
  64.        v  -- view problem summaries
  65.        k  -- keyword search over problem headers
  66.        K  -- keyword search over problem headers and data
  67.        M  -- modify keyword field
  68.        R  -- reopen a closed problem
  69.        P  -- change priority (severity) of problem
  70.        T  -- transfer problem to another area
  71.  
  72.  
  73.      Here you are expected to type a  single  letter  symbolizing
  74.      the  command  of  interest.   Typing  `H' or `?' will scroll
  75.      through the list of available commands.
  76.  
  77.  
  78.      l  -- log new problem
  79.  
  80.           Typing `l', you'll immediately  see  a  screen  of  the
  81.           form:
  82.  
  83.           Area      networking
  84.           Logger    mjlx
  85.           Reporter
  86.           Logged    Mon Jun 29 08:56:27 1992
  87.           Updated   Mon Jun 29 08:56:27 1992
  88.           Keywords
  89.           Summary
  90.           Status    open
  91.           Site
  92.           Severity
  93.           Problem #
  94.  
  95.           This is known as the problem header.  Here, Reporter is
  96.           intended to represent the user name or real name of the
  97.           person who reported the problem, which needn't  be  the
  98.           same  as  Logger.  Of course you can fill in any of the
  99.           fields as you see fit. Severity ,  which  runs  from  4
  100.           (the  lowest)  to  1  (the highest) is meant to be some
  101.           indication of the severity of the problem.  The remain-
  102.           ing fields have their more or less obvious meaning.
  103.  
  104.           In the above problem header, problem has filled in  the
  105.           fields  that it can and will prompt for the others.  It
  106.           will fill in the Problem # field, if and when the prob-
  107.           lem  is  really  logged,  with a positive number unique
  108.           across all problem areas.  There is  no  limit  to  the
  109.           amount of text that can be stored in each field.  After
  110.           filling out this header, problem will invoke the editor
  111.           in  your  EDITOR  environment  variable (or "vi" if not
  112.           defined), from which you are expected to enter the text
  113.           of the problem.  When you exit from your editor, you'll
  114.           be prompted as to whether or not you really want to log
  115.           the  problem.   Typing `y' logs the problem and returns
  116.           you to the command  window,  while  typing  `n'  simply
  117.           takes you back to the command window.
  118.  
  119.  
  120.      a  -- append to a problem
  121.  
  122.           Here you'll be prompted for the problem # of an  exist-
  123.           ing  problem.   If  a  problem  of that number actually
  124.           exists, you'll immediately be brought up into your edi-
  125.           tor  to  enter  the text of your append.  When you exit
  126.           from your editor, you'll be prompted as to  whether  or
  127.           not  you  really wish to make this append.  The Updated
  128.           field of the problem header will be updated to  reflect
  129.           the time of the append.
  130.  
  131.  
  132.      c  -- close a problem
  133.  
  134.           Here you'll be prompted for the problem # of an  exist-
  135.           ing  problem.   If  a  problem  of that number actually
  136.           exists, you'll immediately be brought up into your edi-
  137.           tor to enter the text of your close.  Closing a problem
  138.           changes the Status field  of  the  problem  entry  from
  139.           "open"  to  "closed";  it is not removed from the data-
  140.           base.  It is meant to be an indication that the problem
  141.           has been solved.  Only the original logger of the prob-
  142.           lem, or the problem administrator can close a  problem.
  143.           The Updated field of the problem header will be updated
  144.           to reflect the time of the close.
  145.  
  146.  
  147.      e  -- examine a problem
  148.  
  149.           You will be prompted for the problem # of  an  existing
  150.           problem.   If that problem exists you'll be placed into
  151.           the pager "less" with a copy of  the  complete  problem
  152.           header and data of that problem.  This way you can then
  153.           page through the problem and  do  any  thing  else  you
  154.           might  do  from  a  pager  such as saving a copy of the
  155.           problem or only a portion of it to another file.
  156.  
  157.  
  158.      v  -- view problem summaries
  159.  
  160.           Here a list consisting of selected parts of each  prob-
  161.           lem  header  is  displayed on the screen, one per line,
  162.           called the view  window.   The  fields  displayed  are:
  163.           Problem  #,  Status, Severity (if the problem is open),
  164.           Updated, and Summary.  The  lines  are  sorted:  "open"
  165.           before  "closed"; severity 1 to severity 4; and then in
  166.           most recently updated to least recently updated  order.
  167.           It  the  text of a line is longer than the screen width
  168.           the line is truncated and a `!' is place in  the  final
  169.           position  in  the line.  The cursor is initially placed
  170.           in the first column of the first line.
  171.  
  172.           The line the cursor is on is called the  current  line.
  173.           The line the cursor is on can be changed using the cur-
  174.           sor motion and scrolling  commands  of  vi  and  emacs,
  175.           though the cursor will always remain in first column of
  176.           whatever line it is on.  If the current line is  longer
  177.           than  the  screen width it will be shifted left so that
  178.           the final screenwidth characters are visible.  In  this
  179.           way,  by  moving the cursor on and off of a line, it is
  180.           possible to read the complete line, provided  that  the
  181.           length  of the line is not more than twice the width of
  182.           your screen.  Most of the commands in the command  win-
  183.           dow  are  accessible  from  within  the view window and
  184.           apply to the problem in the current line.  For example,
  185.           typing  `a'  will  append to the problem in the current
  186.           line.
  187.  
  188.           Typing `H' or `?' will scroll through a list of all the
  189.           valid keypresses from within the view window:
  190.  
  191.            CURSOR MOVEMENT COMMANDS:
  192.  
  193.               ?  H               Display this help.
  194.               q                  quit.
  195.               j  n  ^N  SPC  CR  Forward  one line.
  196.               DOWN_ARROW_KEY             "        .
  197.               k  p  ^P  ^Y       Backward one line.
  198.               UP_ARROW_KEY               "        .
  199.               ^F  ^V             Forward  one window.
  200.               b  ^B  ESC-V       Backward one window.
  201.               ^D                 Forward  one half-window.
  202.               ^U                 Backward one half-window.
  203.               <                  Go to first line of listing.
  204.               >                  Go to last line of listing.
  205.  
  206.            COMMANDS WHICH OPERATE ON THE CURRENT PROBLEM:
  207.  
  208.               a                  Append to current problem.
  209.               c                  Close current problem.
  210.               d                  Delete current problem.
  211.               e m v              Examine, View, or "more" current problem.
  212.               M                  Modify keyword field.
  213.               r                  Reorganize the database.
  214.               P                  Change the priority (severity) of problem.
  215.               R                  Reopen a closed problem.
  216.               S                  Save problem listing to a file.
  217.               T                  Transfer problem to another area.
  218.  
  219.            MISCELLANEOUS COMMANDS:
  220.  
  221.               !                  starts up a shell.
  222.               ! cmd              executes a shell command
  223.               !!                 reexecutes previous shell command.
  224.               ^L                 Repaint screen.
  225.               CR                 End-of-response when in a prompt.
  226.               V                  Print out version string.
  227.  
  228.  
  229.      s  -- subscribe to this problem area
  230.  
  231.           You will be added to a list of interested  parties  for
  232.           this  area.  Each time a change is made to the database
  233.           for  this  area,  every  person  on  the  mailing  list
  234.           receives  mail indicating the change that was made.  In
  235.           this way, it is easy to keep track of problems  without
  236.           having  to  regularly read all the areas to see if any-
  237.           thing new has happened.
  238.  
  239.  
  240.      u  -- unsubscribe from this problem area
  241.  
  242.           You will be removed from the interested parties mailing
  243.           list for this area.
  244.  
  245.  
  246.      k  -- keyword search over problem headers
  247.  
  248.           You will be prompted for  a  regular  expression  which
  249.           will  then  be used to search over the problem headers.
  250.           If there are any matches, the summary lines of each  of
  251.           the  problems which matched will be displayed in a view
  252.           window.  For example, if you wished to peruse only open
  253.           problems,  you  could  search  for "open" whereupon you
  254.           would be put in a view window consisting  of  only  the
  255.           open problems in the area.
  256.  
  257.  
  258.      K  -- keyword search over problem headers and data
  259.  
  260.           This is similar the the `k'  command  except  that  the
  261.           regular  expression search is over the complete problem
  262.           header and data for each problem.
  263.  
  264.      M  -- modify keyword field
  265.  
  266.           This command is useful if you want to modify  the  key-
  267.           word  field.  At the authors site, being an IBM strong-
  268.           hold, we place the  number  of  each  APAR  (Authorized
  269.           Problem Analysis Report) which supposedly fixes a prob-
  270.           lem, in the keyword field.  This cannot  be  done  when
  271.           the  problem  is logged since the APAR number(s) aren't
  272.           known at that time.  You must be the original logger of
  273.           the  problem  or the problem administrator to do modify
  274.           the keywords of a problem.
  275.  
  276.  
  277.      d  -- delete a problem from the database
  278.  
  279.           This  command  allows  the  database  administrator  to
  280.           delete  problems  from the database for this area.  The
  281.           problem data is irretrievably removed  from  the  data-
  282.           base.
  283.  
  284.  
  285.      r  -- reorganize the database
  286.  
  287.           This is an administrative command  which  can  be  used
  288.           after  many appends and deletions have been made in the
  289.           database to shrink it down and make accessing  it  more
  290.           efficient.   It  directly corresponds to the GDBM reor-
  291.           ganize command.
  292.  
  293.  
  294.      P  -- modify priority (severity) of problem
  295.  
  296.           This command is useful if you want to modify the prior-
  297.           ity  (severity)  of a problem.  Given that the original
  298.           logger of the problem initially chooses  the  severity,
  299.           the  problem  administrator  may choose to later change
  300.           the priority of the problem  to  reflect  the  priority
  301.           from  the  point  of view of the person responsible for
  302.           fixing the problem.  You must be the original logger of
  303.           the  problem or the problem administrator to change the
  304.           priority of a problem.
  305.  
  306.  
  307.      T  -- transfer problem to another area
  308.  
  309.           This command is useful if you want to  move  a  problem
  310.           from  the  current  area  to  another  area.  You'll be
  311.           prompted for the area in which to transfer the problem.
  312.           You  must  be the original logger of the problem or the
  313.           problem administrator to transfer a problem.
  314.  
  315.      R  -- reopen a closed problem
  316.  
  317.           A closed problem can be  reopened  with  this  command.
  318.           The  Status  field  is  changed  from  "closed" back to
  319.           "open".
  320.  
  321.  
  322.      q  -- quit
  323.  
  324.           This quits from the command window and returns  you  to
  325.           the area window.
  326.  
  327.  
  328. OPTIONS
  329.      Command line options are described below.
  330.  
  331.      -d dirname
  332.           Instructs problem to use the next argument as the  name
  333.           of the directory in which all the problem databases and
  334.           mailing list files are stored.  The author uses it pri-
  335.           marily  as  a  debugging tool.  However, it allows dif-
  336.           ferent groups at a single site  to  set  up  their  own
  337.           databases,  instead  of forcing a single person to cen-
  338.           trally administer all the problem areas at the site.
  339.  
  340.      -v   Prints out the version string and exits.
  341.  
  342.           Problem can also be invoked with one  or  more  problem
  343.           areas  as  arguments.  It will then immediately startup
  344.           in the command window for that area.  Typing  `q'  will
  345.           then move on to the next problem area, or the area win-
  346.           dow if no more areas have been specified.   If  any  of
  347.           the  arguments  are  not  valid problem areas, you will
  348.           also be placed in the area window when problem tries to
  349.           process that area.
  350.  
  351.  
  352. ENVIRONMENT VARIABLES
  353.      COLUMNS
  354.           This value, if nonzero, overrides the number of columns
  355.           as  read  from termcap(3).  Hence by setting COLUMNS it
  356.           is easy to use  a  different  number  of  columns  than
  357.           termcap(3) expects for a given terminal type.
  358.  
  359.      EDITOR
  360.           The name of the editor (used by the `e'  and  `f'  com-
  361.           mands).
  362.  
  363.      HOME The user's home directory.
  364.  
  365.      LINES
  366.           This value, if nonzero, overrides the number  of  lines
  367.           as  read from termcap(3).  Hence by setting LINES it is
  368.           easy to use a different number of lines than termcap(3)
  369.           expects for a given terminal type.
  370.  
  371.      PAGER
  372.           The pager used when viewing a problem.   This  is  only
  373.           used  if  problem is built to not automatically use the
  374.           pager "less".  If not built to automaticaly use  "less"
  375.           and PAGER isn't defined, "more" is used.
  376.  
  377.      SHELL
  378.           The shell used to execute the `!' command, as  well  as
  379.           to expand filenames.
  380.  
  381.      TERM The type of terminal on which problem is being run.
  382.  
  383.  
  384. AUTHORS
  385.      Written by Mike  Lijewski  while  at  the  Cornell  National
  386.      Supercomputer Facility.
  387.  
  388.