This file describes various problems that have been encountered in compiling, installing and running groff. Suggestions for additions or other improvements to this file are welcome. ---------------------------------------------------------------------- Generic Problems ================ * My document says that the current year is 19100, not 2000. In groff, as in traditional troff, the yr number register yields the year minus 1900. Unfortunately, there is a longstanding bug in the Troff User's Manual , which incorrectly claims that yr is the last two digits of the year. This claim was never true of either Unix troff or of groff. If your text looks like this: .\" Wrong: This document was formatted in 19\n(yr. you can correct it as follows: This document was formatted in \n[year]. or, if you want to be portable to older troff versions, as follows: .nr y4 1900+\n(yr This document was formatted in \n(y4. ---------------------------------------------------------------------- * groff can't handle my troff document. It works fine with AT&T troff. Read the section on incompatibilities in gtroff(1). Try using the -C option. Alternatively there's the sed script `tmac/fixmacros.sed' which will attempt to edit a file of macros so that it can be used with groff without the -C flag. ---------------------------------------------------------------------- * gtroff doesn't understand lines like `.ce99' with no space between the name of the request or macro and the arguments. gtroff requires a space between macro or request and its arguments because it allows the use of long names for macros and requests. You can use the -C option or the `cp' request to put gtroff into a compatibility mode in which it is not possible to use long names for macros but in which no space is required between macros and their arguments. The use of compatibility mode is strongly discouraged. ---------------------------------------------------------------------- * groff -Tdvi produces dvi files that use fonts at weird magnifications. Yes, it does. You may need to compile fonts with Metafont at these magnifications. The CompileFonts script in the devdvi/generate directory may help you to do this. (It will take a *long* time on slow computers.) ---------------------------------------------------------------------- * Groff doesn't use the font names I'm used to. Use the `ftr' request. See (g)troff(1). ---------------------------------------------------------------------- * pic output is not centered horizontally; pictures sometimes run off the bottom of the page. The macro package you are using is not supplying appropriate definitions of PS and PE. Give groff a -mpic option. ---------------------------------------------------------------------- * gpic doesn't accept the syntax `chop N M' for chopping both ends of a line. The correct syntax is `chop N chop M'. ---------------------------------------------------------------------- * With gpic -t, when I print `line ->; box' using a dvi to ps program, the arrow head sticks through into the inside of the box. The dvi to ps program should be modified to set the line cap and line join parameters to 1 while printing tpic specials. ---------------------------------------------------------------------- * gtroff gives warnings about lines like .ev \" a comment (with a tab after the .ev). A tab character cannot be used as a substitute for a space character (except in one case: between a control character at the beginning of a line and the name of a macro or request). For example, in Unix troff .ps \" restore the previous point size (with a tab after the .ps) will NOT restore the previous point-size; instead it will be silently ignored. Since this is very likely to be an error, gtroff can give a warning about it. If you want to align comments, you can do it like this: .ev\" \" a comment ---------------------------------------------------------------------- * I don't like the page headers and footers produced by groff -man. There seem to be many different styles of page header and footer produced by different versions of the -man macros. You will need to modify tmac/an-old.tmac to suit your personal taste. For example, if you want the center of the page header to say System Programmer's Manual you will need to change the line .el .ds an-extra3 \"System Programmer's Manual to .el .ds an-extra3 System Programmer's Manual ---------------------------------------------------------------------- * Where can I get grap? Ted Faber has written a freely available grap: http://www.lunabase.org/~faber/Vault/software/grap/ ---------------------------------------------------------------------- * The \n(st and \n(sb registers don't seem to work. I thought \w set them to the height and depth of its argument, but the registers always seem to be 0. \n(st and \n(sb aren't supposed to give the height and depth of the string rather they give the minimum and maximum vertical displacement of the baseline. For example for \v'2u'\v'-3u', \n(st will be 1 and \n(sb will be -2. The height and depth of the string is available in the \n[rst] and \n[rsb] registers: these are groff extensions. ---------------------------------------------------------------------- * While formatting a manual page, groff complains about not being able to break lines. The problem seems to be caused by a line like: .TP \w'label'+2 The -man documentation says that the default scale indicator for TP macro is `n'. The groff -man macros implement this correctly, so that the argument will be evaluated as if it were \w'label'n+2n The Unix -man macros don't implement this correctly (probably because it's hard to do in Unix troff); they just append `n' to the entire argument, so that it will be evaluated as if it were \w'label'u+2n The solution is to fix the manual page: .TP \w'label'u+2 ---------------------------------------------------------------------- * I'm having problems formatting man pages produced by the perl wrapman script. Some versions of wrapman have a superfluous blank line before the .TH line. This must be deleted. Then either use groff -C, or apply the following patch: *** wrapman.~2~ Sun Jan 19 12:10:24 1992 --- wrapman Tue Aug 10 02:06:41 1993 *************** *** 35,41 **** $line1 .= if $line1 =~ /eval/; $line1 .= if $line1 =~ /argv/; $line2 = ; ! next if $line2 eq "'di';\n"; # Pull the old switcheroo. --- 35,41 ---- $line1 .= if $line1 =~ /eval/; $line1 .= if $line1 =~ /argv/; $line2 = ; ! next if $line2 eq "'di ';\n" || $line2 eq "'di';\n"; # Pull the old switcheroo. *************** *** 49,56 **** print OUT $line1; print OUT <0 .if \\n(YE=0 .LP --- 22,30 ---- .. . \" EN - end of a displayed equation .de EN ! .if \\n(.k>0 .br .di + .ds 10 \\*(EZ\\ .rm EZ .nr ZN \\n(dn .if \\n(ZN>0 .if \\n(YE=0 .LP ---------------------------------------------------------------------- * I'm having problems formatting Ultrix man pages with groff -man. The Ultrix man pages use a number of non-standard extensions to the Unix man macros. One solution is to use the Ultrix -man macros with groff. Copy /usr/lib/tmac/tmac.an to /usr/local/share/groff/site-tmac/an.tmac and apply the following patch (from Frank Wortner): *** /usr/local/lib/groff/tmac/tmac.an Wed Sep 9 12:29:28 1992 --- /usr/lib/tmac/tmac.an Fri Jul 24 19:58:19 1992 *************** *** 489,495 **** . \" make special case of shift out of italic .de }S .ds ]F ! .if \\$12 .if !\\$5 .ds ]F \^ .ie !\\$4 .}S \\$2 \\$1 "\\$3\f\\$1\\$4\\*(]F" "\\$5" "\\$6" "\\$7" "\\$8" "\\$9" .el \\$3 .}f --- 489,495 ---- . \" make special case of shift out of italic .de }S .ds ]F ! .if \\$12 .if !\\$5 .ds ]F\^ .ie !\\$4 .}S \\$2 \\$1 "\\$3\f\\$1\\$4\\*(]F" "\\$5" "\\$6" "\\$7" "\\$8" "\\$9" .el \\$3 .}f Another possible solution is to install tmac/man.ultrix as /usr/local/share/groff/site-tmac/man.local. ---------------------------------------------------------------------- * On an SGI system, how can I make the man command use groff? From David Hinds (some of these steps are unnecessary if you install with the `g' Makefile variable defined as empty): Create a script called 'eqn': > #!/bin/sh > if [ ${1:-""} = /usr/pub/eqnchar ] ; then shift ; fi > geqn $* and a script called 'neqn': > #!/bin/sh > if [ ${1:-""} = /usr/pub/eqnchar ] ; then shift ; fi > geqn -Tascii $* and do: > ln -s gnroff nroff and edit the end of the gnroff script to be: > rest=`echo ${1+"$@"} | sed -e 's+/usr/lib/tmac+/usr/local/lib/groff/tmac+'` > exec groff -Wall -mtty-char $T $opts $rest To get PostScript output from 'man -t', you also need to create a 'psroff' script similar to 'nroff'. Here are the context diffs: *** /usr/local/bin/nroff Sat Feb 13 15:51:09 1993 --- /usr/local/bin/psroff Sat Feb 13 17:45:46 1993 *************** *** 1,8 **** #!/bin/sh ! # Emulate nroff with groff. prog="$0" ! T=-Tascii opts= for i --- 1,8 ---- #!/bin/sh ! # Emulate psroff with groff. prog="$0" ! T=-Tps opts= for i *************** *** 25,30 **** --- 25,33 ---- -Tascii|-Tlatin1) T=$1 ;; + -t) + # ignore -- default is send to stdout + ;; -T*) # ignore other devices ;; *************** *** 49,53 **** rest=`echo ${1+"$@"} | sed -e 's+/usr/lib/tmac+/usr/local/lib/groff/tmac+'` # This shell script is intended for use with man, so warnings are # probably not wanted. Also load nroff-style character definitions. ! exec groff -Wall -mtty-char $T $opts $rest --- 52,56 ---- rest=`echo ${1+"$@"} | sed -e 's+/usr/lib/tmac+/usr/local/lib/groff/tmac+'` # This shell script is intended for use with man, so warnings are ! # probably not wanted. ! exec groff -Wall $T $opts $rest Compilation Problems ==================== * Compilation dies with y.tab.c: In function `int yyparse()': y.tab.c: `size_t' undeclared in namespace `std' This is a bug in bison 1.32. Don't use this version. 1.28 or 1.33 works fine. Alternatively, use yacc or byacc. ---------------------------------------------------------------------- * There are many empty `Makefile.dep' files. Is this a bug? No. Real dependency files are created with a `make depend' call. ---------------------------------------------------------------------- * On HP-UX, the compiler complains about missing symbol `alloca'. Say export LDFLAGS=-lPW before starting the configure script. ---------------------------------------------------------------------- * The configure script fails on OS/390 (z/OS) Unix. [This has been fixed in z/OS V1R3 (aka OS/390 R13).] There is a bug in the Language Environment (LE) whereby the test program for static destructors fails. You will see the message `configure: error: a working C++ compiler is required' Applying PTF UQ42006 is supposed to fix this, but the test program is still returning the wrong value (1). To work around this problem, you can comment out the following in the configure script (near line 2029). This will effectively bypass the test (static constructors and destructors do actually work properly): #if { (eval echo "$as_me:2029: \"$ac_link\"") >&5 # (eval $ac_link) 2>&5 # ac_status=$? # echo "$as_me:2032: \$? = $ac_status" >&5 # (exit $ac_status); } && { ac_try='./conftest$ac_exeext' # { (eval echo "$as_me:2034: \"$ac_try\"") >&5 # (eval $ac_try) 2>&5 # ac_status=$? # echo "$as_me:2037: \$? = $ac_status" >&5 # (exit $ac_status); }; }; then # echo "$as_me:2039: result: yes" >&5 #echo "${ECHO_T}yes" >&6 #else # echo "$as_me: program exited with status $ac_status" >&5 #echo "$as_me: failed program was:" >&5 #cat conftest.$ac_ext >&5 #echo "$as_me:2045: result: no" >&5 #echo "${ECHO_T}no" >&6;{ { echo "$as_me:2046: error: a working C++ compiler is required" >&5 #echo "$as_me: error: a working C++ compiler is required" >&2;} # { (exit 1); exit 1; }; } #fi ---------------------------------------------------------------------- * I get errors when I try to compile groff with DEC C++. Fix the declaration of write() in so that the second argument is a const char *. Fix the declaration of open() in so that the first argument is a const char *. ---------------------------------------------------------------------- * On a host using Unix make (e.g. Solaris), if you are compiling for multiple architectures by building in a subdirectory, the make stops with a message like this: make: Fatal error: Don't know how to make target `assert.o' or like this: make: Fatal error: Can't find /u/src/groff/src/include/Makefile.sub': No such file or directory This occurs because GNU make and Unix make handle VPATH differently, and the groff build relies on GNU make's VPATH handling. Use GNU make to work around the problem. In Solaris 8, GNU make is on the Software Companion CD and is installed as /opt/sfw/bin/gmake. ---------------------------------------------------------------------- * On Ultrix, the make stops with the message *** Error code 1 Stop. for no apparent reason. Use GNU make. ---------------------------------------------------------------------- * I'm having problems compiling groff on 386BSD 0.1. If you're using ash as /bin/sh, you'll need the following patch. *** gendef.sh.org Sun Jun 30 13:30:36 1991 --- gendef.sh Sun Feb 28 10:23:49 1993 *************** *** 3,9 **** file=$1 shift ! defs="#define $1" shift for def do --- 3,10 ---- file=$1 shift ! x=$1 ! defs="#define $x" shift for def do You'll also need to change dirnamemax.c so that it doesn't use pathconf(). ---------------------------------------------------------------------- * While compiling on Xenix, ranlib libgroff.a fails. The system ranlib can't handle externals longer than 40 characters. Use the ranlib included in demon.co.uk:/pub/xenix/g++-1.40.3a.v1 instead. ---------------------------------------------------------------------- * I get errors when I try to compile groff with Sun C++ version 3 or earlier. Groff requires header files that are moderately compatible with AT&T C++ and ANSI C. With some versions of Sun C++, the supplied header files need some of the following changes to meet this requirement: must declare the mem* functions, (just add `#include ' to ); the first argument to fopen and freopen should be declared as `const char *'; the first argument to fread should be declared as `void *'; the first argument to fwrite should be declared as `const void *'; malloc should be declared to return `void *'; in , the declaration `extern "C" { void *__builtin_alloca(int); }' should be added; in the return type and the second argument type of signal() should be changed to be `void (*)(int)'. You can either change them in place, or copy them to some other directory and include that directory with a -I option. ---------------------------------------------------------------------- * I get errors when I try to compile groff with Sun C++ version 5.0 or 5.1. This is a known problem; see Sun bug #4301919. As of this writing, no patch is available. Use GCC 2.95.2 or later instead. ---------------------------------------------------------------------- * I get lots of `numeric overflow' error messages whenever I run groff; I compiled groff with AT&T C++ 2.0 with an ANSI C compiler. Make sure -DCFRONT_ANSI_BUG is included in DEFINES in the top-level Makefile. If that doesn't solve the problem, define INT_MIN as -INT_MAX in libgroff/lib.h. ---------------------------------------------------------------------- * When compiling on MacOS X, groff compiles but does not run well. Use ./configure CXX=g++2 then make as usual.