README revision 151497
1151497SruThis is the GNU `groff' document formatting system. The version 2151497Srunumber is given in the file VERSION. 318099Spst 4151497SruIncluded in this release are implementations of `troff', `pic', `eqn', 5151497Sru`tbl', `grn', `refer', `-man', `-mdoc', `-mom', and `-ms' macros, and 6151497Srudrivers for `PostScript', `TeX dvi' format, `HP LaserJet 4' printers, 7151497Sru`Canon CAPSL' printers, `HTML' format (beta status), and 8151497Srutypewriter-like devices. Also included is a modified version of the 9151497SruBerkeley `-me' macros, the enhanced version `gxditview' of the X11 10151497Sru`xditview' previewer, and an implementation of the `-mm' macros 11151497Srucontributed by Joergen Haegg (jh@axis.se). 1218099Spst 13151497SruSee the file `INSTALL' for installation instructions. You will 14151497Srurequire a C++ compiler. 1518099Spst 16151497SruThe file `NEWS' describes recent user-visible changes to `groff'. 1718099Spst 18151497Sru`groff' is free software. See the file `COPYING' for copying 19151497Srupermission. 2018099Spst 21151497SruThe file `PROBLEMS' describes various problems that have been 22151497Sruencountered in compiling, installing, and running `groff'. 2318099Spst 24151497SruThe most recent released version of `groff' is always available by 25151497Sruanonymous ftp from `ftp.gnu.org' in the directory `gnu/groff'. 2618099Spst 27151497SruThe current development version of `groff' is available from a `CVS' 28151497Srurepository. You can access it by first selecting a parent directory 29151497Sruin which to create a working copy (call it, say, `~/cvswork'), and 30151497Sruthen executing the commands 3118099Spst 32151497Sru cd ~/cvswork 33151497Sru CVS_RSH=ssh; export CVS_RSH 34151497Sru cvs -d:ext:anoncvs@savannah.gnu.org/cvsroot/groff -z5 co groff 3555839Sasmodai 36151497Sru(Note that you need an `ssh' client for security reasons.) 3755839Sasmodai 38151497SruThis will create a subdirectory, `~/cvswork/groff', with a "checked 39151497Sruout" copy of the `CVS' repository. An update of this working copy may 40151497Srube achieved, at any later time by invoking the commands 4155839Sasmodai 42151497Sru cd ~/cvswork/groff 43151497Sru CVS_RSH=ssh cvs -z5 update -dP 4455839Sasmodai 45151497SruPlease read the `CVS' info pages for further details. 4655839Sasmodai 47151497SruFinally, it is possible to access the `CVS' with a web browser by 48151497Srupointing it to 4955839Sasmodai 50151497Sru http://savannah.gnu.org/cvs/?group=groff 5155839Sasmodai 52151497SruAlternatively, you can download snapshots (which are updated twice a day). 53151497SruThe complete `groff' source as a single file is available at 5455839Sasmodai 55151497Sru http://groff.ffii.org/groff/devel/groff-current.tar.gz 5655839Sasmodai 57151497SruA diff file relative to `groff-<version>', the latest official `groff' 58151497Srurelease is available at 59151497Sru 60151497Sru http://groff.ffii.org/groff/devel/groff-<version>-current.diff.gz 61151497Sru 62151497SruAssuming that `groff-<version>.tar.gz' and 63151497Sru`groff-<version>-current.diff.gz' are in the same directory, do the 6469626Srufollowing to apply the diff file: 6569626Sru 6669626Sru tar xzvf groff-<version>.tar.gz 6769626Sru cd groff-<version> 6869626Sru gunzip -c ../groff-<version>-current.diff.gz | patch -p1 6969626Sru 70151497SruDepending on your requirements, you may need at least some of the 71151497Srufollowing tools to build `groff' directly from its source: 72151497Sru 73151497Sru ghostscript 74151497Sru the psutils package 75151497Sru the netpbm package 76151497Sru texinfo 4.8 77151497Sru bison >= 1.875b or byacc 78151497Sru 79151497SruNote that `texinfo' and `bison' or `byacc' are required only for 80151497Srubuilding from `CVS' sources (either a checked out working copy, or a 81151497Srudaily snapshot). They are not required for building from a stable 82151497Srurelease tarball. Also note that the version numbers stated are the 83151497Sruminimum supported. No version of `texinfo' < 4.8 will work, and the 84151497Sruoriginal release of `bison' 1.875 is known not to work; you *may* find 85151497Sruthat `bison' releases < 1.875 will work, but in case of difficulty, 86151497Sruplease update to a later version *before* posting a bug report. 87151497Sru 88151497SruFor *all* sources, you need ghostscript for creation of either `PDF' or 89151497Sru`HTML' output; the `netpbm' and `psutils' packages are required only for 90151497Sru`HTML' output. If you don't intend to produce output in either of these 91151497Sruformats, then these packages are unnecessary. 92151497Sru 93151497SruIn Linux Debian, the installation of `texinfo' is dangerous. For it 94151497Srucreates a file `install-info' that will block the system installation. 95151497SruSo the created `/usr/local/bin/install-info' must be renamed. 96151497Sru 97151497SruThe `groff' configure script searches for the X11 headers and 98151497Srulibraries `Xaw' and `Xmu'. So the corresponding developer packages of 99151497Sruyour system must be installed, otherwise `groff' does not install 100151497Sru`gxditview' and the `-TX*' devices. In Debian, the developer packages 101151497Sruare `libxaw7-dev' and `libxmu-dev'. 102151497Sru 103151497SruPlease report bugs using the form in the file `BUG-REPORT'; the idea of 10455839Sasmodaithis is to make sure that FSF has all the information it needs to fix 105151497Sruthe bug. At the very least, read the `BUG-REPORT' form and make sure 10655839Sasmodaithat you supply all the information that it asks for. Even if you are 107151497Srunot sure that something is a bug, report it using `BUG-REPORT': this will 10869626Sruenable us to determine whether it really is a bug or not. 10918099Spst 11055839SasmodaiThree mailing lists are available: 11155839Sasmodai 11255839Sasmodai bug-groff@gnu.org for reporting bugs 11355839Sasmodai groff@gnu.org for general discussion of groff 114151497Sru groff-commit@gnu.org a read-only list showing commitments 115151497Sru to the CVS repository 11655839Sasmodai 117151497SruYou can post mails directly to the `bug-groff' list, without subscribing; 118151497Sruto post mails to the `groff' list you must subscribe to it. 11955839Sasmodai 12055839SasmodaiTo subscribe, send a mail to <list>-request@<domain> (example: 121151497Srugroff-request@gnu.org for the `groff' list) with the word `subscribe' 122151497Sruin either the subject or body of the email (don't include the quotes). 123151497SruAlternatively, you may subscribe by visiting the web pages at 12455839Sasmodai 125151497Sru http://lists.gnu.org/mailman/listinfo/bug-groff 126151497Sru http://lists.gnu.org/mailman/listinfo/groff 127151497Sru http://lists.gnu.org/mailman/listinfo/groff-commit 128151497Sru 129151497SruEach of these web pages also provides a link to a browseable archive of 130151497Srupostings to the corresponding mailing list. 131151497Sru 132151497SruGNU `groff' was written by James Clark <jjc@jclark.com>. It is now 13355839Sasmodaimaintained by Ted Harding <ted.harding@nessie.mcc.ac.uk> and Werner 13455839SasmodaiLemberg <wl@gnu.org>. 135