summaryrefslogtreecommitdiff
path: root/README
blob: 0dadd927a090eb8afc622b6f90693aad91563cb9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
    Copyright (C) 1989-2022 Free Software Foundation, Inc.

    Copying and distribution of this file, with or without
    modification, are permitted in any medium without royalty provided
    the copyright notice and this notice are preserved.

This is the 'groff' document formatting system, a reimplementation and
extension of the AT&T Unix 'troff' system.  The version number is given
in the file '.tarball-version' if you are building from a distribution
archive, or the file '.version' if you are building directly from its
Git repository.

This release includes implementations of the 'troff', 'nroff', 'pic',
'eqn', 'tbl', 'grn', 'refer' programs; the 'man', 'mdoc', and 'ms' macro
packages; and output drivers for for PostScript, PDF, and TeX DVI file
formats, HP LaserJet 4- and Canon CaPSL-compatible printers, HTML and
XHTML (in beta status), and typewriter/terminal devices.

It also provides a modified version of the Berkeley 'me' macro packages;
'gxditview', an enhanced version of the X11 'xditview' previewer for
'troff' device-independent output, and an implementation of the 'mm'
macro package contributed by Joergen Haegg.

Peter Schaffter's 'mom' macro package is also featured.

See the file 'INSTALL.extra' for instructions on how to install from a
distribution archive, such as a release, beta, or release candidate.

The file 'INSTALL.REPO' contains supplementary instructions for building
directly from a clone of the Git repository or a snapshot archive.

The file 'NEWS' contains a history of user-visible changes to 'groff'.

'groff' is free software.  See the file 'COPYING' for copying
permissions, and 'LICENSES' for further detail.

The file 'PROBLEMS' describes various problems that have been
encountered in compiling, installing, and running 'groff'.

The file 'MORE.STUFF' contains information about add-on packages
useful for 'groff'.

Current and historical releases of 'groff' are available via HTTPS and
anonymous FTP from the host 'ftp.gnu.org' in the directory 'gnu/groff'.

'groff' has a home page at the GNU Project.

https://www.gnu.org/software/groff/

Administration of the project is done through GNU Savannah.

  https://savannah.gnu.org/git/?group=groff

'groff' is developed at its Git repository, which has a web interface.

  https://git.savannah.gnu.org/cgit/groff.git

You can view any commit in isolation, and browse the entire source tree
or produce a snapshot archive corresponding to its state as of that
commit.  Click the summary line of the commit message to expose these
options.

Build requirements are discussed in the 'INSTALL.extra' and
'INSTALL.REPO' files noted above.  'groff' also has runtime
dependencies.

Ghostscript is required for creation of PDF and (X)HTML output.
Production of (X)HTML furthermore demands tools from the 'netpbm' and
'psutils' packages.

Perl is required for production of PDF output using the 'gropdf' output
driver.  (You can alternatively produce PostScript with 'groff' and
covert that to PDF using Ghostscipt.)  The 'chem', 'gperl', and
'gpinyin' preprocessors and several utilities, such as 'grog', are also
written in Perl.

If 'groff' is configured with 'lp' or 'lpr' support, the corresponding
program must remain available on the system for the 'groff' command's
'-l' option to work.  Similarly, build-time detection of development
headers for the 'uchardet', 'Xaw', and 'Xmu' libraries (and their
dependencies) assumes that their runtime counterparts will remain
installed to support the 'groff' that is built.

The GNU project's web page for 'groff' includes a link to its issue
tracker.

  https://savannah.gnu.org/projects/groff

You may use the form in the file 'BUG-REPORT'; its purpose is to
make sure that FSF has all the information it needs to fix the bug.
At the very least, read the 'BUG-REPORT' form and make sure that you
supply all the information that it asks for.  Even if you are not sure
that something is a bug, report it: this enables us to determine whether
it is a software defect, or an omission from our documentation.

Three mailing lists are available.

  bug-groff@gnu.org          a read-only list for following bug reports
  groff@gnu.org              for general discussion of groff
  groff-commit@gnu.org       a read-only list for following commits
                             to the Git repository

To subscribe, send a mail to <list>-request@<domain> (example:
groff-request@gnu.org for the 'groff' list) with the word 'subscribe'
in either the subject or body of the email (don't include the quotes).
Alternatively, subscribe via our web pages by completing an HTML form.

  https://lists.gnu.org/mailman/listinfo/bug-groff
  https://lists.gnu.org/mailman/listinfo/groff
  https://lists.gnu.org/mailman/listinfo/groff-commit

Each of these web pages also provides a link to a browseable archive of
postings to the corresponding mailing list.

'groff' was primarily written by James Clark <jjc@jclark.com>.


##### Editor settings
Local Variables:
fill-column: 72
mode: text
End:
vim: set textwidth=72: