1 This file describes various problems that have been encountered in
2 compiling, installing and running groff. Suggestions for additions or
3 other improvements to this file are welcome.
5 ----------------------------------------------------------------------
14 * My document says that the current year is 19100, not 2000.
16 In groff, as in traditional troff, the yr number register yields the
17 year minus 1900. Unfortunately, there is a longstanding bug in the
18 Troff User's Manual <http://cm.bell-labs.com/cm/cs/cstr/54.ps.gz>,
19 which incorrectly claims that yr is the last two digits of the year.
20 This claim was never true of either Unix troff or of groff.
22 If your text looks like this:
25 This document was formatted in 19\n(yr.
27 you can correct it as follows:
29 This document was formatted in \n[year].
31 or, if you want to be portable to older troff versions, as follows:
34 This document was formatted in \n(y4.
36 ----------------------------------------------------------------------
38 * groff can't handle my troff document. It works fine with AT&T
41 Read the section on incompatibilities in groff_diff(7). Try using
42 the -C option. Alternatively there's the sed script
43 `tmac/fixmacros.sed' which will attempt to edit a file of macros so
44 that it can be used with groff without the -C flag.
46 ----------------------------------------------------------------------
48 * gtroff doesn't understand lines like `.ce99' with no space between
49 the name of the request or macro and the arguments.
51 gtroff requires a space between macro or request and its arguments
52 because it allows the use of long names for macros and requests. You
53 can use the -C option or the `cp' request to put gtroff into a
54 compatibility mode in which it is not possible to use long names for
55 macros but in which no space is required between macros and their
56 arguments. The use of compatibility mode is strongly discouraged.
58 ----------------------------------------------------------------------
60 * groff -Tdvi produces dvi files that use fonts at weird
63 Yes, it does. You may need to compile fonts with Metafont at these
64 magnifications. The CompileFonts script in the devdvi/generate
65 directory may help you to do this. (It will take a *long* time on
68 ----------------------------------------------------------------------
70 * Groff doesn't use the font names I'm used to.
72 Use the `ftr' request. See groff_diff(7).
74 ----------------------------------------------------------------------
76 * pic output is not centered horizontally; pictures sometimes run off
77 the bottom of the page.
79 The macro package you are using is not supplying appropriate
80 definitions of PS and PE. Give groff a -mpic option.
82 ----------------------------------------------------------------------
84 * gpic doesn't accept the syntax `chop N M' for chopping both ends of
87 The correct syntax is `chop N chop M'.
89 ----------------------------------------------------------------------
91 * With gpic -t, when I print `line ->; box' using a dvi to ps program,
92 the arrow head sticks through into the inside of the box.
94 The dvi to ps program should be modified to set the line cap and line
95 join parameters to 1 while printing tpic specials.
97 ----------------------------------------------------------------------
99 * gtroff gives warnings about lines like
101 (with a tab after the .ev).
103 A tab character cannot be used as a substitute for a space character
104 (except in one case: between a control character at the beginning of a
105 line and the name of a macro or request). For example, in Unix troff
107 .ps \" restore the previous point size
109 (with a tab after the .ps) will NOT restore the previous point-size;
110 instead it will be silently ignored. Since this is very likely to be
111 an error, gtroff can give a warning about it. If you want to align
112 comments, you can do it like this:
116 ----------------------------------------------------------------------
118 * I don't like the page headers and footers produced by groff -man.
120 There seem to be many different styles of page header and footer
121 produced by different versions of the -man macros. You will need to
122 put modified macros from tmac/an-old.tmac into man.local. More
123 information is available in groff_man(7).
125 ----------------------------------------------------------------------
127 * Where can I get grap?
129 Ted Faber <faber@lunabase.org> has written a freely available grap:
131 http://www.lunabase.org/~faber/Vault/software/grap/
133 ----------------------------------------------------------------------
135 * The \n(st and \n(sb registers don't seem to work. I thought \w set
136 them to the height and depth of its argument, but the registers
139 \n(st and \n(sb aren't supposed to give the height and depth of the
140 string rather they give the minimum and maximum vertical displacement
141 of the baseline. For example for \v'2u'\v'-3u', \n(st will be 1 and
142 \n(sb will be -2. The height and depth of the string is available in
143 the \n[rst] and \n[rsb] registers: these are groff extensions.
145 ----------------------------------------------------------------------
147 * While formatting a manual page, groff complains about not being able
148 to break lines. The problem seems to be caused by a line like:
151 The -man documentation says that the default scale indicator for TP
152 macro is `n'. The groff -man macros implement this correctly, so that
153 the argument will be evaluated as if it were
157 The Unix -man macros don't implement this correctly (probably because
158 it's hard to do in Unix troff); they just append `n' to the entire
159 argument, so that it will be evaluated as if it were
163 The solution is to fix the manual page:
167 ----------------------------------------------------------------------
169 * I'm having problems formatting man pages produced by the perl
172 Some versions of wrapman have a superfluous blank line before the .TH
173 line. This must be deleted. Then either use groff -C, or apply the
176 *** wrapman.~2~ Sun Jan 19 12:10:24 1992
177 --- wrapman Tue Aug 10 02:06:41 1993
180 $line1 .= <IN> if $line1 =~ /eval/;
181 $line1 .= <IN> if $line1 =~ /argv/;
183 ! next if $line2 eq "'di';\n";
185 # Pull the old switcheroo.
188 $line1 .= <IN> if $line1 =~ /eval/;
189 $line1 .= <IN> if $line1 =~ /argv/;
191 ! next if $line2 eq "'di ';\n" || $line2 eq "'di';\n";
193 # Pull the old switcheroo.
219 # These next few lines are legal in both Perl and nroff.
221 ! $null.00; # finish .ig
223 'di \\" finish diversion--previous line must be blank
224 .nr nl 0-1 \\" fake up transition to first page again
225 .nr % 0 \\" start at page 1
226 ! '; __END__ ##### From here on it's a standard manual page #####
227 .TH $PROG 1 "$month $mday, 19$year"
234 # These next few lines are legal in both Perl and nroff.
236 ! $null.00 ; # finish .ig
239 'di \\" finish diversion--previous line must be blank
240 .nr nl 0-1 \\" fake up transition to first page again
241 .nr % 0 \\" start at page 1
242 ! .\\"'; __END__ ##### From here on it's a standard manual page #####
243 .TH $PROG 1 "$month $mday, 19$year"
248 ----------------------------------------------------------------------
250 * groff uses up an enormous amount of memory processing large files.
251 I'm using 386BSD 0.1.
253 386BSD includes an old version of g++, 1.39, which has a bug that
254 causes a major memory leak in gtroff. Apply the following fix to g++
257 *** cplus-decl.c.~1~ Mon Aug 6 05:28:59 1990
258 --- cplus-decl.c Wed Jun 5 08:55:04 1991
262 /* At the end, call delete if that's what's requested. */
263 if (TREE_GETS_DELETE (current_class_type))
264 exprstmt = build_method_call (build1 (NOP_EXPR, TYPE_POINTER_TO (current_class_type), error_mark_node),
265 get_identifier (OPERATOR_DELETE_FORMAT),
266 ! build_tree_list (NULL_TREE, integer_zero_node),
267 NULL_TREE, LOOKUP_NORMAL);
268 else if (TYPE_USES_VIRTUAL_BASECLASSES (current_class_type))
269 exprstmt = build_x_delete (ptr_type_node, current_class_decl, 0);
274 /* At the end, call delete if that's what's requested. */
275 if (TREE_GETS_DELETE (current_class_type))
276 exprstmt = build_method_call (build1 (NOP_EXPR, TYPE_POINTER_TO (current_class_type), error_mark_node),
277 get_identifier (OPERATOR_DELETE_FORMAT),
278 ! build_tree_list (NULL_TREE, current_class_decl),
279 NULL_TREE, LOOKUP_NORMAL);
280 else if (TYPE_USES_VIRTUAL_BASECLASSES (current_class_type))
281 exprstmt = build_x_delete (ptr_type_node, current_class_decl, 0);
287 Printing and Display Problems
288 =============================
292 * I'm having problems including PostScript illustrations (EPS) using
293 the PSPIC macro and/or \X'ps: import ...'.
295 A PostScript document must meet three requirements in order to be
296 included with the PSPIC macro: it must comply with the Adobe Document
297 Structuring Conventions; it must contain a BoundingBox line; it must
298 be ``well-behaved''. The BoundingBox line should be of the form:
300 %%BoundingBox: llx lly urx ury
302 where llx, lly, urx, ury are the coordinates of the lower left x,
303 lower left y, upper right x, upper right y of the bounding box of
304 marks on the page expressed as integers in the default PostScript
305 coordinate system (72 units per inch, origin at bottom left corner).
307 The most convenient program to get the bounding box of a document is
308 the `ps2epsi' script coming with GhostScript.
310 If you can't use this program, another useful tactic is to print out
311 the illustration by itself (you may need to add a `showpage' at the
312 end), and physically measure the bounding box. For more detail on
313 these requirements, read the specification of Encapsulated PostScript
314 format. (This is available from the Adobe file server; send a message
315 with a body of `help' to ps-file-server@adobe.com.)
317 If an EPS file to be included via \X'ps: import' does not start with
318 %!PS-Adobe-...', gtroff will still include the file, but grops will
319 not add any fonts to the generated output file that are listed in the
320 EPS file, even though the files are listed in the `download' file and
321 are available in the devps directory.
323 ----------------------------------------------------------------------
325 * I've configured groff for A4 paper, but gtroff still seems to think
326 that the length of a page (as returned by `\n(.p') is 11 inches.
328 This is intentional. The PAGE option during configuration is used
329 only by grops. For compatibility with ditroff, the default page
330 length in gtroff is always 11 inches. The page length can be changed
331 with the `pl' request.
333 A convenient way to set paper dimensions is to use the -dpaper option
334 of groff, together with proper -P options for the postprocessor
335 (overriding the default). For example, use the following for PS
336 output on A4 paper in landscape orientation:
338 groff -Tps -dpaper=a4l -P-pa4 -P-l -ms foo.ms > foo.ps
340 See groff_tmac(5) for more information.
342 ----------------------------------------------------------------------
344 * When I print the output of groff -Tps, the output is always shifted
345 up by about 0.7 inches; I'm using 8.5x11 inch paper.
347 Make sure that the paper size is `letter'. See groff_tmac(5).
349 ----------------------------------------------------------------------
351 * When I try to run gxditview, I get the error:
352 Error: Widget viewport has zero width and/or height
354 This error means you haven't correctly installed the application
355 defaults file, GXditview.ad; ``make install'' does this for you
356 automatically, so either you didn't do ``make install'', or you don't
357 have imake configured correctly.
359 ----------------------------------------------------------------------
361 * When I preview documents using -TX75 or -TX100, the layout is not
362 the same as when I print the document with -Tps: the line and page
363 breaks come in different places.
367 ----------------------------------------------------------------------
369 * When I try to print the output of groff -Tps, I get no output at all
370 from the printer, and the log file shows the error
371 %%[ error: undefined; offendingcommand: BP ]%%
372 I'm using TranScript spooling software.
374 This is a bug in the page reversal filter in early versions of
375 TranScript. Change the `broken' parameter in
376 /usr/local/lib/groff/font/devps/DESC to 7.
378 ----------------------------------------------------------------------
380 * When I preview groff -Tps output using the Sun OpenWindows 2.0
381 pageview program, all the pages are displayed on top of each other.
383 This is a defect in pageview. Change the `broken' parameter in
384 /usr/local/lib/groff/font/devps/DESC to 2.
386 ----------------------------------------------------------------------
388 * With groff -TX75, -TX100 or -X, I can only view the first page.
390 The left mouse button brings up a menu that allows you to view other
393 ----------------------------------------------------------------------
395 * When I print the output of groff -Tdvi, I just get a black dot in
398 Some dvi drivers (notably early versions of xtex) do not correctly
399 handle dvi files that use a resolution different from that used by dvi
400 files produced by TeX. Try getting a more up to date driver.
402 ----------------------------------------------------------------------
404 * How can I use groff with an old LaserJet printer that doesn't work
407 You have at least 3 options:
409 - use groff -Tps with GNU Ghostscript;
411 - use groff -Tdvi with a TeX .dvi to Laserjet driver;
413 - use groff with the LaserJet driver in Chris Lewis' psroff package
414 (available for ftp from:
415 ftp.uunet.ca:/distrib/chris_lewis/psroff3.0pl17).
417 ----------------------------------------------------------------------
419 * Groff seems to generate level 3 Postscript, but my printer is only a
420 level 1 or 2 PostScript printer.
422 In fact groff generates only level 2 PostScript (or rather level 1
423 with some extensions; see grops(1) for more information how to disable
424 them). The `%!PS-Adobe-3.0' comment at the beginning of PostScript
425 output generated by groff indicates that the file conforms to
426 version 3.0 of the Adobe Document Structuring Conventions. The output
427 generated by groff should be printable on any PostScript printer.
428 Problems with groff output's not printing are most often caused by the
433 Platform-Dependent Macro Problems
434 =================================
438 * I get lots of errors when I use groff with the AT&T -mm macros.
440 Use the groff -mm macros.
442 ----------------------------------------------------------------------
444 * groff produces wrapper macros for `ms' and friends which call the
445 system's original macros. Then, to get groff's ms macro package I
446 have to use `-mgs' instead `-ms'. Can I avoid this?
448 Yes. Configure and compile groff as usual, but install it with
450 make install tmac_wrap=""
452 Then no wrapper files are produced, and `-ms' will use groff's `ms'
455 ----------------------------------------------------------------------
457 * I'm having problems formatting HP-UX 9.0 man pages with groff -man.
459 Copy HP's tmac.an into /usr/local/share/groff/site-tmac/an.tmac, and
460 either put `.cp 1' at the beginning or filter it (and any files it
461 .so's) through tmac/fixmacros.sed.
463 ----------------------------------------------------------------------
465 * I get errors using the Unix -ms macros with groff -e -C.
469 *** /usr/lib/ms/ms.eqn Tue Apr 25 02:14:28 1989
470 --- ms.eqn Sun Nov 11 10:33:59 1990
474 . \" EN - end of a displayed equation
476 ! .if !
\a\\*(10
\a\a .br
480 .if \\n(ZN>0 .if \\n(YE=0 .LP
483 . \" EN - end of a displayed equation
490 .if \\n(ZN>0 .if \\n(YE=0 .LP
492 ----------------------------------------------------------------------
494 * I'm having problems formatting Ultrix man pages with groff -man.
496 The Ultrix man pages use a number of non-standard extensions to the
497 Unix man macros. One solution is to use the Ultrix -man macros with
498 groff. Copy /usr/lib/tmac/tmac.an to
499 /usr/local/share/groff/site-tmac/an.tmac and apply the following patch
500 (from Frank Wortner):
502 *** /usr/local/lib/groff/tmac/tmac.an Wed Sep 9 12:29:28 1992
503 --- /usr/lib/tmac/tmac.an Fri Jul 24 19:58:19 1992
506 . \" make special case of shift out of italic
509 ! .if \\$12 .if !\\$5 .ds ]F \^
510 .ie !\\$4 .}S \\$2 \\$1 "\\$3\f\\$1\\$4\\*(]F" "\\$5" "\\$6" "\\$7" "\\$8" "\\$9"
514 . \" make special case of shift out of italic
517 ! .if \\$12 .if !\\$5 .ds ]F\^
518 .ie !\\$4 .}S \\$2 \\$1 "\\$3\f\\$1\\$4\\*(]F" "\\$5" "\\$6" "\\$7" "\\$8" "\\$9"
522 Another possible solution is to install tmac/man.ultrix as
523 /usr/local/share/groff/site-tmac/man.local.
525 ----------------------------------------------------------------------
527 * On an SGI system, how can I make the man command use groff?
529 From David Hinds <dhinds@allegro.stanford.edu> (some of these steps
530 are unnecessary if you install with the `g' Makefile variable defined
533 Create a script called 'eqn':
536 > if [ ${1:-""} = /usr/pub/eqnchar ] ; then shift ; fi
539 and a script called 'neqn':
542 > if [ ${1:-""} = /usr/pub/eqnchar ] ; then shift ; fi
549 and edit the end of the gnroff script to be:
551 > rest=`echo ${1+"$@"} | sed -e 's+/usr/lib/tmac+/usr/local/lib/groff/tmac+'`
552 > exec groff -Wall -mtty-char $T $opts $rest
554 To get PostScript output from 'man -t', you also need to create a
555 'psroff' script similar to 'nroff'. Here are the context diffs:
557 *** /usr/local/bin/nroff Sat Feb 13 15:51:09 1993
558 --- /usr/local/bin/psroff Sat Feb 13 17:45:46 1993
562 ! # Emulate nroff with groff.
571 ! # Emulate psroff with groff.
585 + # ignore -- default is send to stdout
588 # ignore other devices
592 rest=`echo ${1+"$@"} | sed -e 's+/usr/lib/tmac+/usr/local/lib/groff/tmac+'`
594 # This shell script is intended for use with man, so warnings are
595 # probably not wanted. Also load nroff-style character definitions.
596 ! exec groff -Wall -mtty-char $T $opts $rest
598 rest=`echo ${1+"$@"} | sed -e 's+/usr/lib/tmac+/usr/local/lib/groff/tmac+'`
600 # This shell script is intended for use with man, so warnings are
601 ! # probably not wanted.
602 ! exec groff -Wall $T $opts $rest
611 * Compilation dies with
613 y.tab.c: In function `int yyparse()':
614 y.tab.c: `size_t' undeclared in namespace `std'
616 * bison reports conflicts (either on stderr or in the `pic.output'
617 file) while processing `pic.y', and the produced pic binary doesn't
620 You need bison version 1.875b or greater. Alternatively, use yacc or
623 ----------------------------------------------------------------------
625 * There are many empty `Makefile.dep' files. Is this a bug?
627 No. Real dependency files are created with a `make depend' call.
629 ----------------------------------------------------------------------
631 * On HP-UX, the compiler complains about missing symbol `alloca'.
637 before starting the configure script.
639 ----------------------------------------------------------------------
641 * The configure script fails on OS/390 (z/OS) Unix.
643 [This has been fixed in z/OS V1R3 (aka OS/390 R13).]
645 There is a bug in the Language Environment (LE) whereby the test
646 program for static destructors fails. You will see the message
647 `configure: error: a working C++ compiler is required'
649 Applying PTF UQ42006 is supposed to fix this, but the test program is
650 still returning the wrong value (1). To work around this problem, you
651 can comment out the following in the configure script (near line 2029).
652 This will effectively bypass the test (static constructors and
653 destructors do actually work properly):
655 #if { (eval echo "$as_me:2029: \"$ac_link\"") >&5
656 # (eval $ac_link) 2>&5
658 # echo "$as_me:2032: \$? = $ac_status" >&5
659 # (exit $ac_status); } && { ac_try='./conftest$ac_exeext'
660 # { (eval echo "$as_me:2034: \"$ac_try\"") >&5
661 # (eval $ac_try) 2>&5
663 # echo "$as_me:2037: \$? = $ac_status" >&5
664 # (exit $ac_status); }; }; then
665 # echo "$as_me:2039: result: yes" >&5
666 #echo "${ECHO_T}yes" >&6
668 # echo "$as_me: program exited with status $ac_status" >&5
669 #echo "$as_me: failed program was:" >&5
670 #cat conftest.$ac_ext >&5
671 #echo "$as_me:2045: result: no" >&5
672 #echo "${ECHO_T}no" >&6;{ { echo "$as_me:2046: error: a working C++ compiler is required" >&5
673 #echo "$as_me: error: a working C++ compiler is required" >&2;}
674 # { (exit 1); exit 1; }; }
677 ----------------------------------------------------------------------
679 * I get errors when I try to compile groff with DEC C++.
681 Fix the declaration of write() in <unistd.h> so that the second
682 argument is a const char *. Fix the declaration of open() in
683 <sys/file.h> so that the first argument is a const char *.
685 ----------------------------------------------------------------------
687 * On a host using Unix make (e.g. Solaris), if you are compiling for
688 multiple architectures by building in a subdirectory, the make stops
689 with a message like this:
691 make: Fatal error: Don't know how to make target `assert.o'
695 make: Fatal error: Can't find /u/src/groff/src/include/Makefile.sub': No such file or directory
697 This occurs because GNU make and Unix make handle VPATH differently,
698 and the groff build relies on GNU make's VPATH handling.
700 Use GNU make to work around the problem. In Solaris 8, GNU make is
701 on the Software Companion CD and is installed as /opt/sfw/bin/gmake.
703 ----------------------------------------------------------------------
705 * On Ultrix, the make stops with the message
711 for no apparent reason.
715 ----------------------------------------------------------------------
717 * I'm having problems compiling groff on 386BSD 0.1.
719 If you're using ash as /bin/sh, you'll need the following patch.
721 *** gendef.sh.org Sun Jun 30 13:30:36 1991
722 --- gendef.sh Sun Feb 28 10:23:49 1993
742 You'll also need to change dirnamemax.c so that it doesn't use
745 ----------------------------------------------------------------------
747 * While compiling on Xenix, ranlib libgroff.a fails.
749 The system ranlib can't handle externals longer than 40 characters.
750 Use the ranlib included in demon.co.uk:/pub/xenix/g++-1.40.3a.v1
753 ----------------------------------------------------------------------
755 * I get errors when I try to compile groff with Sun C++ version 3 or
758 Groff requires header files that are moderately compatible with AT&T
759 C++ and ANSI C. With some versions of Sun C++, the supplied header
760 files need some of the following changes to meet this requirement:
761 <string.h> must declare the mem* functions, (just add `#include
762 <memory.h>' to <string.h>); the first argument to fopen and freopen
763 should be declared as `const char *'; the first argument to fread
764 should be declared as `void *'; the first argument to fwrite should be
765 declared as `const void *'; malloc should be declared to return
766 `void *'; in <alloca.h>, the declaration `extern "C" { void
767 *__builtin_alloca(int); }' should be added; in <sys/signal.h> the
768 return type and the second argument type of signal() should be changed
769 to be `void (*)(int)'.
771 You can either change them in place, or copy them to some other
772 directory and include that directory with a -I option.
774 ----------------------------------------------------------------------
776 * I get errors when I try to compile groff with Sun C++ version 5.0
779 This is a known problem; see Sun bug #4301919. As of this writing, no
780 patch is available. Use GCC 2.95.2 or later instead.
782 ----------------------------------------------------------------------
784 * I get lots of `numeric overflow' error messages whenever I run
785 groff; I compiled groff with AT&T C++ 2.0 with an ANSI C compiler.
787 Make sure -DCFRONT_ANSI_BUG is included in DEFINES in the top-level
788 Makefile. If that doesn't solve the problem, define INT_MIN as
789 -INT_MAX in libgroff/lib.h.
791 ----------------------------------------------------------------------
793 * When compiling on MacOS X, groff compiles but does not run well,
794 especially `eqn', causing many `can't break line' messages.
796 Use ./configure CXX=g++2 then make as usual.