home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / misc / volume33 / problem / part02 / README < prev    next >
Encoding:
Text File  |  1992-10-19  |  8.7 KB  |  227 lines
  1.  
  2. Problem - A "problem" database manager
  3.  
  4. Problem is a database manager for bug reports and such, meant to be
  5. used in a UNIX environment.  It is written in C++; uses the GNU
  6. Database Management Library (GDBM) for low-level database operations;
  7. and the termcap(3) library for screen comtrol.  An X Windows interface
  8. is being developed.  The basic idea is to provide a central front-end
  9. for managing the various databases of bugs and miscreant behaviour
  10. that a large UNIX site might be interested in tracking, and
  11. facilitating the sharing of this information amongst all interested
  12. parties.
  13.  
  14. On startup, a list of problem areas is displayed:
  15.  
  16. The 4 Areas:
  17.  
  18.   1 apf
  19.   2 aix370
  20.   3 aixws
  21.   4 dbx
  22.  
  23. This is called the area window.  Upon entering a number corresponding
  24. to the area of interest, the following screen is displayed:
  25.  
  26. Commands
  27.  
  28.   l  -- log new problem
  29.   a  -- append to a problem
  30.   c  -- close a problem
  31.   e  -- examine a problem
  32.   v  -- view problem summaries
  33.   s  -- subscribe to this problem area
  34.   u  -- unsubscribe from this problem area
  35.   k  -- keyword search over problem headers
  36.   K  -- keyword search over problem headers and data
  37.   M  -- modify keyword field
  38.   d  -- delete a problem from the database
  39.   r  -- reorganize the database
  40.   R  -- reopen a closed problem
  41.   q  -- quit
  42.  
  43. Here you are expected to type a single letter symbolizing the
  44. command of interest.
  45.  
  46.   l  -- log new problem
  47.  
  48. Choosing `l', you'll immediately see a screen of the form:
  49.  
  50. Area      networking
  51. Logger    mjlx
  52. Reporter
  53. Logged    Mon Jun 29 08:56:27 1992
  54. Updated   Mon Jun 29 08:56:27 1992
  55. Keywords
  56. Summary
  57. Status    open
  58. Site
  59. Severity
  60. Problem #
  61.  
  62. This is known as the problem header.  Here, Reporter is the user name
  63. or real name of the person who reported the problem;  this needn't be
  64. the same as Logger.  Severity, which runs from 4 (the lowest) to 1
  65. (the highest) is meant to be some indication of the severity of the
  66. problem.  The remaining fields have their obvious meaning.
  67.  
  68. In the above, "problem" has filled in the fields that it can and will
  69. prompt for the others.  It will fill in the Problem # field, if and
  70. when the problem is really logged, with a positive number unique
  71. across all problem areas.  There is no limit to the amount of text
  72. that can be stored in each field.  After filling out this header,
  73. "problem" will invoke the editor in the user's EDITOR environment
  74. variable (or "vi" if not defined), from which the user is expected to
  75. enter the text of the problem.  When you exit from your editor, you'll
  76. be prompted as to whether or not you really want to log the problem.
  77. Typing `y' logs the problem while typing `n' takes you back to the
  78. command window.
  79.  
  80.   a  -- append to a problem
  81.  
  82. Here you'll be prompted for the problem # of an existing problem.  If
  83. a problem of that number actually exists, you'll immediately be
  84. brought up into your editor to enter the text of your append.  When you
  85. exit from your editor, you'll be prompted as to whether or not you
  86. really wish to make this append.
  87.  
  88.   c  -- close a problem
  89.  
  90. Here you'll be prompted for the problem # of an existing problem.  If
  91. a problem of that number actually exists, you'll immediately be
  92. brought up into your editor to enter the text of your close.  Closing
  93. a problem changes the Status field of the problem entry from "open" to
  94. "closed"; it is not removed from the database.  It is meant to be an
  95. indication that the problem has been solved.  Only the original logger
  96. of the problem, or the "problem" administrator can close a problem.
  97.  
  98.   e  -- examine a problem
  99.  
  100. You will be prompted for the problem # of an existing problem.  If
  101. that problem exists you'll be placed into the pager "less" with a copy
  102. of the complete problem header and data of that problem.  This way you
  103. can then page through the problem and do any thing else you might do
  104. from a pager such as saving a copy of the problem or only a portion of
  105. it to another file.
  106.  
  107.   v  -- view problem summaries
  108.  
  109. Typing `v' a list consisting of selected parts of each problem header
  110. is displayed on the screen, one per line:
  111.  
  112. 77 open 1 Jun 28 16:37:09 1992 calloc prototyped wrong
  113. 73 open 2 Jun 26 06:16:03 1992 Fortran code gets seg fault
  114. 18 closed May 30 12:51:34 1992 <stdarg.h> is broken
  115. 53 open 3 May  6 13:45:23 1992 optimization slows down c!
  116. 16 open 3 Apr 26 09:54:49 1992 why don't we have a Pascal compiler?
  117.  
  118. This is called a view window.  The fields displayed are: Problem #,
  119. Status, Severity, if Status is "open", Updated and Summary.  The lines
  120. are sorted: "open" before "closed"; severity order 1 to 4; and then in
  121. most recently updated to least recently updated order.  It the text of
  122. a line is longer than the screen width the line is truncated and a `!'
  123. is place in the final position in the line.  The cursor is initially
  124. placed in the first column of the first line.  The problem list can be
  125. perused using the screen and cursor motion commands of vi and emacs.
  126.  
  127. The line the cursor is on is called the current line.  If the current
  128. line is longer than the screen width it will be shifted left so that
  129. the final screenwidth characters are visible.  In this way, by moving
  130. the cursor on and off of a line, it is possible to read the complete
  131. line, provided that the length of the line is not more than twice the
  132. width of your screen.  Most of the commands in the command window are
  133. accessible from here and apply to the problem in the current line.
  134. For example, typing `a' will append to the problem in the current
  135. line.
  136.  
  137. Typing `H' or `?' from any of the three main windows in "problem" will
  138. display a screen of help commands called the help screen.  The help
  139. screen from within the view window is:
  140.  
  141.  CURSOR MOVEMENT COMMANDS:
  142.  
  143.     ?  H               Display this help.
  144.     q                  quit.
  145.     j  n  ^N  SPC  CR  Forward  one line.
  146.     DOWN_ARROW_KEY             "        .
  147.     k  p  ^P  ^Y       Backward one line.
  148.     UP_ARROW_KEY               "        .
  149.     ^F  ^V             Forward  one window.
  150.     b  ^B  ESC-V       Backward one window.
  151.     ^D                 Forward  one half-window.
  152.     ^U                 Backward one half-window.
  153.     <                  Go to first line of listing.
  154.     >                  Go to last line of listing.
  155.  
  156.  COMMANDS WHICH OPERATE ON THE CURRENT PROBLEM:
  157.  
  158.     a                  Append to current problem.
  159.     c                  Close current problem.
  160.     d                  Delete current problem.
  161.     e m v              Examine, View, or "more" current problem.
  162.     m                  Modify keyword field.
  163.     r                  Reorganize the database.
  164.     R                  Reopen a closed problem.
  165.     s                  Save problem listing to a file - prompts for filename.
  166.  
  167.  MISCELLANEOUS COMMANDS:
  168.  
  169.     !                  starts up a shell.
  170.     ! cmd              executes a shell command - prompts for command.
  171.     !!                 reexecutes previous shell command.
  172.     ^L                 Repaint screen.
  173.     CR                 Signifies end-of-response when in a prompt.
  174.     V                  Print out version string.
  175.  
  176.   s  -- subscribe to this problem area
  177.  
  178. You will be added to a list of interested parties for this area.  Each
  179. time a change is made to the database for this area, every person on
  180. the mailing list receives mail indicating the change that was made.
  181. In this way, it is easy to keep track of problems without having to
  182. regular read all the problems to see if anything new has happened.
  183.  
  184.   u  -- unsubscribe from this problem area
  185.  
  186. You will be removed from the interested parties mailing list for this
  187. area.
  188.  
  189.   k  -- keyword search over problem headers
  190.  
  191. You will be prompted for a regular expression which will then be used
  192. to search over the problem headers.  If there are any matches, the
  193. summary lines of each of the problems which matched will be displayed
  194. in a view window.  For example, if you wished to peruse only open
  195. problems, you could search for "open" whereupon you would be put in a
  196. view window consisting of only the open problems in this area.
  197.  
  198.   K  -- keyword search over problem headers and data
  199.  
  200. This is similar the the `k' command except that the regular expression
  201. search is over the complete problem header and data for each problem.
  202.  
  203.   M  -- modify keyword field
  204.  
  205. This command is useful if you want to modify the keyword field.
  206.  
  207.   d  -- delete a problem from the database
  208.  
  209. This command allows the database administrator to delete problems from
  210. the database for this area.  The problem data is irretrievably removed
  211. from the database.
  212.  
  213.   r  -- reorganize the database
  214.  
  215. This is an administrative command which can be used after many appends and
  216. deletions have been made in the database to shrink it down and make
  217. accessing it more efficient.  It corresponds directly to the GDBM
  218. reorganize command.
  219.  
  220.   R  -- reopen a closed problem
  221.  
  222. A closed problem can be reopened with this command.
  223.  
  224.   q  -- quit
  225.  
  226. This quits from the command window and returns you to the area window.
  227.