* doc/groff.texinfo: More examples, other fixes.
[s-roff.git] / BUG-REPORT
blob293101e34e58c697199d54b3e99cd17f89a0fa77
1                            Groff Bug Report
3 Please read the PROBLEMS file before sending in a bug report.
5 Please fill in all fields, even if you think they are not relevant.
7 Please delete the text in brackets before sending it in.
9 Please report separate bugs separately.
11 Send the completed form to bug-groff@gnu.org
13 GROFF VERSION:
14 [The version of groff you are using.  For example, `1.05']
16 MACHINE:
17 [The machine you are using.  For example, `Sun SPARCstation 2']
19 OS:
20 [The operating system you are using.  For example, `SunOS 4.1.1']
22 COMPILER:
23 [The compiler you are used to compile groff.  For example, `g++ 1.40.3']
25 INPUT FILES:
26 [Include all the files necessary to reproduce the problem that are not
27 part of the standard groff distribution.  This includes font
28 description files, DESC files and macro files (with the exception of
29 the -ms and -mm macros: we have them).  Send them as a shell archive or
30 as a uuencoded, compressed tar file.
32 It's easier for us if you can provide an example that doesn't depend on
33 any macro package, but obviously if you're reporting a problem with a
34 macro package that won't be possible.  Also a short example is more
35 convenient than a long one, but don't worry if you can't find a short
36 example.  Don't say something like ``any file that X'': Always send a
37 definite example.]
39 COMMAND LINE:
40 [The command line that we should run in order to observe the bug.  For
41 example, `gtroff -Tps bug.tr'.  If the command line uses -ms or -mm,
42 say whether these refer to the groff versions or the Unix versions of
43 the macros.]
45 DESCRIPTION OF INCORRECT BEHAVIOUR:
46 [What goes wrong when that command line is run?  For example, `gtroff
47 gets a segmentation fault', or `The output looks bad because the bar
48 over the x is too long and is too far over to the left.'  If you get an
49 error message, include it here without modification: Don't edit it to
50 make it more readable.]
52 SUGGESTED FIX [optional]:
53 [If you can suggest a fix for the problem, include a context diff here. 
54 But don't delay sending in a bug report in the hope of finding a fix. 
55 Guesses about the cause of the bug are not usually helpful.]