[0m


REPORTBUG(1)	    UNIX Programmer's Manual	     REPORTBUG(1)



[1mNAME
     [0mreportbug - prepare a bug report for sending to Acorn

[1mSYNOPSIS
     reportbug [0m[ program ...  ]
     [1mreportbug [0m[ [1m-o [0m] [ [1m-t [0m]
     [1mreportbug -f [0m[ file ...  ]

[1mINTRODUCTION
     [0m_R_e_p_o_r_t_b_u_g provides a uniform method of reporting bugs in the
     [1mRISC-iX [0mkernel and utilities to Acorn. It determines whether
     the user is local to Acorn (on the local network), and if so
     enters the bug report directly into the central bug data-
     base, otherwise it prepares a text form of the report for
     mailing to Acorn.

     At external sites _r_e_p_o_r_t_b_u_g will write a text file to the
     user's current working directory, and whilst terminating
     will print a message indicating the file name given. This
     file should be printed out and posted to Acorn, or put on a
     floppy disc and sent to Acorn. The floppy disc is preferable
     when supporting files are also to be sent.

     The [1m-o[0m, [1m-t [0mand [1m-f [0mflags are for Acorn internal use only and
     are not available at external sites. The [1m-o [0mflag is for
     entering old pre-database bug reports, the [1m-t [0mflag is used
     to enter text form external bug reports, and the [1m-f [0mflag is
     used to enter any non-local bug database files into the main
     database.

     The programs specified on the command line are a list of
     programs exhibiting a given problem. They should all have
     the same problem.	_D_O _N_O_T combine bug reports, all distinct
     problems should have a separate bug report.  If no programs
     are specified, _r_e_p_o_r_t_b_u_g will prompt for them. If the prob-
     lem relates to the kernel, specify `/vmunix' as the program
     with the problem.	_R_e_p_o_r_t_b_u_g will use _w_h_i_c_h(1) to determine
     where the program causing the problem came from, and _v_e_r_-
     _s_i_o_n(1) to produce a reference for Acorn of the exact binary
     being run.

     _R_e_p_o_r_t_b_u_g prompts for a priority of the bug. This should be
     set with the importance assigned to the bug by the user.
     Acorn reserve the right to assign a different priority to
     bugs!

     _R_e_p_o_r_t_b_u_g then prompts for a description of the bug. Type in
     as much information as possible on the problem to allow
     Acorn to duplicate the bug so that it can be fixed. Input is
     terminated by a `.' or a control-D on a line of its own.





Printed 31/1/92     Revision 1.11 of 28/11/88			1






REPORTBUG(1)	    UNIX Programmer's Manual	     REPORTBUG(1)



     The user is then prompted for any supporting information.
     This is a multiline field like the bug description above.
     This should be a list of accompanying files, such as C
     sources, which the user feels useful to Acorn to identify
     the bug. External bug reports should enclose machine read-
     able copies of these files. Internal bug reports should
     specify a network accessible file name for the UNIX group to
     read directly.

     Finally the user is prompted for a one line synopsis of the
     problem.

[1mSUMMARY
     [0m_R_e_p_o_r_t_b_u_g has three types of input:

     [1moptions	 [0mHere a prompt is displayed, followed by a list
		 of options numbered from 1 upwards. The user
		 should type in a number from 1 to the upper
		 limit shown.

     [1msingle line [0mHere a prompt followed by a colon is displayed.
		 A single line should be input terminated by
		 `enter' or `return'. A null entry can be created
		 by just typing `return'. A line of `~d' destroys
		 any existing value and reprompts you for a new
		 value.

     [1mmulti line  [0mHere a prompt is displayed, followed by a line
		 prompt `>>'. The line prompt is repeated for
		 each line of input.

		 Input is terminated by a line containing just a
		 `.' or a control-D.

		 If a line is entered containing just `~e' then
		 the input so far is fed into your favorite edi-
		 tor (found in the environment variable [1mEDITOR[0m)
		 for full screen editing.  The editor can also be
		 specified by typing its name after the `~e'.
		 Quitting the editor (after resaving the file)
		 returns to _r_e_p_o_r_t_b_u_g, the field is reprompted,
		 and any further input is appended to the result
		 of the editor session.

		 Similarly `~v' calls up the program specified in
		 the [1mVISUAL [0menvironment variable.

		 A line of just `~o' inserts the previous value
		 of the field at the current point in the input
		 text.

		 A line of just `~p' prints out the input



Printed 31/1/92     Revision 1.11 of 28/11/88			2






REPORTBUG(1)	    UNIX Programmer's Manual	     REPORTBUG(1)



		 accumulated into this field so far.

		 A line of `~w filename' appends the field accu-
		 mulated so far to the named file.

		 A line of `~r filename' appends the contents of
		 the file named to the field accumulated so far.

		 A line of `~! command' uses your current shell
		 (found in environment variable [1mSHELL[0m) to execute
		 the command given.

		 A line of `~q' quits _r_e_p_o_r_t_b_u_g without sending
		 the report.

		 A line of just `~d' deletes any existing entry,
		 abandons the lines typed so far, and reprompts.

     _R_e_p_o_r_t_b_u_g can be aborted at any time by pressing control-C.
     This prevents the sending of the report.

[1mFILES
     [0m/tmp/BugEdit.*	  temporary for editor escape
     BUG*		  textual report for sending to Acorn

[1mAUTHOR
     [0mAndy Bray

[1mBUGS
     [0mWhen using this program with a bug database present, the
     program will use _l_o_c_k_d(8C) to administer file locking. This
     in turn requires the _s_t_a_t_d(8C) and _p_o_r_t_m_a_p(8C) daemons to
     also be running. If any of these daemons are missing,
     _r_e_p_o_r_t_b_u_g will wait for them - potentially forever.  _R_e_p_o_r_t_-
     _b_u_g cannot even be _k_i_l_led in this state.




















Printed 31/1/92     Revision 1.11 of 28/11/88			3



[0m