bug.report.sh(1)       Grass User's Manual	 bug.report.sh(1)



NNAAMMEE
       bbuugg..rreeppoorrtt..sshh   - A mechanism for writing, storing, and e-
       mailing bug reports on GRASS 5 commands.
       _(_G_R_A_S_S _S_h_e_l_l _S_c_r_i_p_t_)

SSYYNNOOPPSSIISS
       bbuugg..rreeppoorrtt..sshh _m_o_d_u_l_e___n_a_m_e [_m_o_d_u_l_e___a_r_g_u_m_e_n_t_s]

DDEESSCCRRIIPPTTIIOONN
       _b_u_g_._r_e_p_o_r_t_._s_h is a Bourne shell (sh(1)) script which, when
       given a GRASS 5 module name, allows the user to complete a
       bug report for that program.  Completed bug reports can be
       e-mailed  to  the GRASS development Team (GRASS Bug report
       system), saved to a file in the user's home directory,  or
       discarded.

OOPPTTIIOONNSS
       This  program  is  not interactive;  the user must specify
       the name of a 5.x module on  the  command  line.   Program
       arguments can optionally be entered by the user.

   PPaarraammeetteerrss::
       _m_o_d_u_l_e___n_a_m_e
	      The  name  of  an  existing GRASS version 5 program
	      tested by the user.

       _m_o_d_u_l_e___a_r_g_u_m_e_n_t_(_s_)
	      Program arguments (parameters and/or flags) for the
	      _m_o_d_u_l_e___n_a_m_e  tested  by  the user.  The user should
	      enter whatever command arguments were actually  run
	      when the program bug occurred.


EEXXAAMMPPLLEE
       For  example,  if the user wished to complete a bug report
       on _v_._t_o_._r_a_s_t after running the  program,  the  user  might
       then type: bbuugg..rreeppoorrtt..sshh v.to.rast

       A  standard bug report form would then be displayed on the
       user's text terminal, containing the user's current  GRASS
       region  settings,  and  the machine name, GRASS data base,
       location, and mapset, on which the user is currently  run-
       ning GRASS.  Program parameters and flag settings, and the
       command entered by the user on the command line, are  also
       automatically entered on the bug report form.  The user is
       put into a text editor and expected  to	enter  additional
       information  describing the nature of the bug found or the
       results of program testing.


       The user is then asked whether the completed bug report is
       to be: 1 - mailed to grass-bugs@intevation.de
       2 - added to the file grass.bugs in the user's home direc-
       tory
       3 - both 1 and 2
       4 - thrown away


NNOOTTEESS
       This program prints whatever region settings,  GRASS  data
       base,  location, and mapset are current when the user runs
       _b_u_g_._r_e_p_o_r_t_._s_h.  The  user  is  therefore  advised  to  run
       _b_u_g_._r_e_p_o_r_t_._s_h  immediately  after  experiencing	a program
       bug, to ensure that the	settings  current  when  the  bug
       occurred are reported on the bug report form.


       Note,  that  the  $EDITOR  environment variable is used to
       define the editor. The "vi" editor is the default  editor.

FFIILLEESS
       This  shell  script  is	stored under the $GISBASE/scripts
       directory on the user's system.	The user is encouraged to
       examine the shell script commands stored in this directory
       and to produce similar scripts for their own use.

AAUUTTHHOORR
       James  Westervelt,   U.S.Army   Construction   Engineering
       Research Laboratory

       _L_a_s_t _c_h_a_n_g_e_d_: _$_D_a_t_e_: _2_0_0_2_/_0_1_/_2_5 _0_5_:_4_5_:_3_2 _$



GRASS 5.0					 bug.report.sh(1)
