utils/fvwmbug.1

   1 .TH FVWMBUG 1 "3 July 2001" GNU
   2 .SH NAME
   3 fvwmbug \- report a bug in FVWM
   4 .SH SYNOPSIS
   5 \fBfvwmbug\fP [\fIaddress\fP]
   6 .SH DESCRIPTION
   7 .B fvwmbug
   8 is a shell script to help the user compose and mail bug reports
   9 concerning FVWM in a standard format.
  10 .B fvwmbug
  11 invokes the editor specified by the environment variable
  12 .SM
  13 .B EDITOR
  14 on a temporary copy of the bug report format outline. The user must
  15 fill in the appropriate fields and exit the editor.
  16 .B fvwmbug
  17 then mails the completed report to the local FVWM maintainer, the FVWM workers list
  18 \fIfvwm-workers@fvwm.org\fP, or
  19 \fIaddress\fP.  If the report cannot be mailed, it is saved in the
  20 file \fIdead.fvwmbug\fP in the invoking user's home directory.
  21 .PP
  22 The bug report format outline consists of several sections.  The first
  23 section provides information about the machine, operating system, the
  24 FVWM version, and the compilation environment.  The second section
  25 should be filled in with a description of the bug.  The third section
  26 should be a description of how to reproduce the bug.  The optional
  27 fourth section is for a proposed fix.  Fixes are encouraged.
  28 .SH ENVIRONMENT
  29 .B fvwmbug
  30 will utilize the following environment variables if they exist:
  31 .TP
  32 .B EDITOR
  33 Specifies the preferred editor. If
  34 .SM
  35 .B EDITOR
  36 is not set,
  37 .B fvwmbug
  38 defaults to
  39 .BR emacs .
  40 .TP
  41 .B HOME
  42 Directory in which the failed bug report is saved if the mail fails.