/contrib/groff/README

https://bitbucket.org/freebsd/freebsd-head/ · #! · 134 lines · 100 code · 34 blank · 0 comment · 0 complexity · 604c1d9b887ab867e32268efe0926262 MD5 · raw file

  1. This is the GNU `groff' document formatting system. The version
  2. number is given in the file VERSION.
  3. Included in this release are implementations of `troff', `pic', `eqn',
  4. `tbl', `grn', `refer', `-man', `-mdoc', `-mom', and `-ms' macros, and
  5. drivers for `PostScript', `TeX dvi' format, `HP LaserJet 4' printers,
  6. `Canon CAPSL' printers, `HTML' format (beta status), and
  7. typewriter-like devices. Also included is a modified version of the
  8. Berkeley `-me' macros, the enhanced version `gxditview' of the X11
  9. `xditview' previewer, and an implementation of the `-mm' macros
  10. contributed by Joergen Haegg (jh@axis.se).
  11. See the file `INSTALL' for installation instructions. You will
  12. require a C++ compiler.
  13. The file `NEWS' describes recent user-visible changes to `groff'.
  14. `groff' is free software. See the file `COPYING' for copying
  15. permission.
  16. The file `PROBLEMS' describes various problems that have been
  17. encountered in compiling, installing, and running `groff'.
  18. The most recent released version of `groff' is always available by
  19. anonymous ftp from `ftp.gnu.org' in the directory `gnu/groff'.
  20. The current development version of `groff' is available from a `CVS'
  21. repository. You can access it by first selecting a parent directory
  22. in which to create a working copy (call it, say, `~/cvswork'), and
  23. then executing the commands
  24. cd ~/cvswork
  25. CVS_RSH=ssh; export CVS_RSH
  26. cvs -d:ext:anoncvs@savannah.gnu.org/cvsroot/groff -z5 co groff
  27. (Note that you need an `ssh' client for security reasons.)
  28. This will create a subdirectory, `~/cvswork/groff', with a "checked
  29. out" copy of the `CVS' repository. An update of this working copy may
  30. be achieved, at any later time by invoking the commands
  31. cd ~/cvswork/groff
  32. CVS_RSH=ssh cvs -z5 update -dP
  33. Please read the `CVS' info pages for further details.
  34. Finally, it is possible to access the `CVS' with a web browser by
  35. pointing it to
  36. http://savannah.gnu.org/cvs/?group=groff
  37. Alternatively, you can download snapshots (which are updated twice a day).
  38. The complete `groff' source as a single file is available at
  39. http://groff.ffii.org/groff/devel/groff-current.tar.gz
  40. A diff file relative to `groff-<version>', the latest official `groff'
  41. release is available at
  42. http://groff.ffii.org/groff/devel/groff-<version>-current.diff.gz
  43. Assuming that `groff-<version>.tar.gz' and
  44. `groff-<version>-current.diff.gz' are in the same directory, do the
  45. following to apply the diff file:
  46. tar xzvf groff-<version>.tar.gz
  47. cd groff-<version>
  48. gunzip -c ../groff-<version>-current.diff.gz | patch -p1
  49. Depending on your requirements, you may need at least some of the
  50. following tools to build `groff' directly from its source:
  51. ghostscript
  52. the psutils package
  53. the netpbm package
  54. texinfo 4.8
  55. bison >= 1.875b or byacc
  56. Note that `texinfo' and `bison' or `byacc' are required only for
  57. building from `CVS' sources (either a checked out working copy, or a
  58. daily snapshot). They are not required for building from a stable
  59. release tarball. Also note that the version numbers stated are the
  60. minimum supported. No version of `texinfo' < 4.8 will work, and the
  61. original release of `bison' 1.875 is known not to work; you *may* find
  62. that `bison' releases < 1.875 will work, but in case of difficulty,
  63. please update to a later version *before* posting a bug report.
  64. For *all* sources, you need ghostscript for creation of either `PDF' or
  65. `HTML' output; the `netpbm' and `psutils' packages are required only for
  66. `HTML' output. If you don't intend to produce output in either of these
  67. formats, then these packages are unnecessary.
  68. In Linux Debian, the installation of `texinfo' is dangerous. For it
  69. creates a file `install-info' that will block the system installation.
  70. So the created `/usr/local/bin/install-info' must be renamed.
  71. The `groff' configure script searches for the X11 headers and
  72. libraries `Xaw' and `Xmu'. So the corresponding developer packages of
  73. your system must be installed, otherwise `groff' does not install
  74. `gxditview' and the `-TX*' devices. In Debian, the developer packages
  75. are `libxaw7-dev' and `libxmu-dev'.
  76. Please report bugs using the form in the file `BUG-REPORT'; the idea of
  77. this is to make sure that FSF has all the information it needs to fix
  78. the bug. At the very least, read the `BUG-REPORT' form and make sure
  79. that you supply all the information that it asks for. Even if you are
  80. not sure that something is a bug, report it using `BUG-REPORT': this will
  81. enable us to determine whether it really is a bug or not.
  82. Three mailing lists are available:
  83. bug-groff@gnu.org for reporting bugs
  84. groff@gnu.org for general discussion of groff
  85. groff-commit@gnu.org a read-only list showing commitments
  86. to the CVS repository
  87. You can post mails directly to the `bug-groff' list, without subscribing;
  88. to post mails to the `groff' list you must subscribe to it.
  89. To subscribe, send a mail to <list>-request@<domain> (example:
  90. groff-request@gnu.org for the `groff' list) with the word `subscribe'
  91. in either the subject or body of the email (don't include the quotes).
  92. Alternatively, you may subscribe by visiting the web pages at
  93. http://lists.gnu.org/mailman/listinfo/bug-groff
  94. http://lists.gnu.org/mailman/listinfo/groff
  95. http://lists.gnu.org/mailman/listinfo/groff-commit
  96. Each of these web pages also provides a link to a browseable archive of
  97. postings to the corresponding mailing list.
  98. GNU `groff' was written by James Clark <jjc@jclark.com>. It is now
  99. maintained by Ted Harding <ted.harding@nessie.mcc.ac.uk> and Werner
  100. Lemberg <wl@gnu.org>.