bin/fvwm-bug.1.in

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