Added request `hpfa' to append hyphenation patterns.
[s-roff.git] / doc / homepage.ms
blob1dcf977682dc147d876b4c72b0f2d5a29a947452
1 .\" This file gives a small example how a web page could look like if created
2 .\" with groff.
3 .\"
4 .\"
5 .\" To make it work with other output devices also, we include www.tmac
6 .\" directly.
7 .\"
8 .nr PS 10
9 .nr VS 12
10 .if '\*[.T]'html' .nr LL 10i
11 .if r ps4html .nr LL 10i
12 .mso www.tmac
14 .de blm-macro
15 .  nr tmp \\n[.i]
16 .  LP
17 .  in \\n[tmp]u
19 .blm blm-macro
21 .HX 0
23 .defcolor darkred rgb 0.65f 0.1f 0.2f
24 .defcolor darkgreen rgb 0.1f 0.5f 0.2f
25 .defcolor darkblue rgb 0.1f 0.2f 0.6f
27 .ds GNU \m[darkred]G\mP\m[darkgreen]N\mP\m[darkblue]U\mP
29 .HTL
31 Home of Groff (GNU Troff).
33 .HTML-IMAGE-LEFT
34 .PSPIC -L gnu.eps 1i 1i
35 \v'-0.5i'\h'1.5i'\s[50]\*[GNU] Troff\s0
36 .HTML-IMAGE-END
38 .HnS 1
39 .HR
40 GNU Troff
41 .URL http://\:groff.ffii.org/ (Groff) 
42 \[em] a
43 .URL http://\:www.gnu.org/ GNU 
44 project.
45 Hosted by
46 .URL http://\:ffii.org/ FFII .
47 .HR
48 .HnE
49 .LK
51 .DC T HE darkred
52 groff (GNU Troff) software
53 is a typesetting package which reads plain text mixed with
54 formatting commands and produces formatted output.
55 Groff now supports HTML.
56 .\" Please see
57 .\" .URL "Groff Web Tips" "#Web Tips" .
60 .SH
61 Download
63 .URL "ftp://\:groff.ffii.org/\:pub/\:groff/" Germany 
65 .URL "ftp://\:ftp.gnu.org/\:gnu/\:groff/" USA 
67 .URL http://\:www.gnu.org/\:copyleft/\:gpl.html License 
69 .URL http://\:ffii.org/\:mailman/\:listinfo/\:groff/ "Mailing list" 
71 .URL "http://\:www.cs.vu.nl/\:~tmgil/\:misc/\:wingroff.html" "Groff for Windows" 
73 User issues lead:
74 .MTO Ted.Harding@\:nessie.mcc.ac.uk "Ted Harding"
75 .br
76 Technical issues lead:
77 .MTO wl@\:gnu.org "Werner Lemberg"
80 .SH
81 README
83 This is the GNU groff document formatting system.
84 The version number is given in the file VERSION.
86 Included in this release are implementations of troff, pic, eqn, tbl, refer,
87 the -man macros and the -ms macros, and drivers for PostScript, TeX dvi
88 format, HP LaserJet 4 printers, HTML format (still alpha), and
89 typewriter-like devices.
90 Also included is a modified version of the Berkeley -me macros, an enhanced
91 version of the X11 xditview previewer, and an implementation of the -mm
92 macros contributed by
93 .MTO jh@\:axis.se "J\(:orgen H\(:agg" .
95 See the file INSTALL for installation instructions.
96 You will require a C++ compiler.
98 The file NEWS describes recent user-visible changes to groff.
100 Groff is free software.
101 See the file COPYING for copying permission.
103 The file PROBLEMS describes various problems that have been encountered in
104 compiling, installing, and running groff.
106 For the moment, the documentation assumes that you are already familiar with
107 the Unix versions of troff, -man, -ms and the preprocessors.
109 The most recent released version of groff is always available by anonymous
110 ftp from ftp.gnu.org in the directory pub/\:gnu/\:groff.
112 A CVS repository is now available, containing the current development
113 version of groff.
114 You can access it with the commands:
118 .ft C
119 export CVSROOT=:pserver:anoncvs@anoncvs.ffii.org:/var/cvs
120 cvs login
121 cvs -z9 co groff
122 .ft P
126 (if the prompt for the password appears, just press the enter key).
127 After a successful login you no longer need the first two commands; an
128 update of a checked out repository should be done with:
131 .ft C
132 cvs -z9 update -dP
133 .ft P
136 Please read the info pages of cvs for further details.
138 Alternatively, you can download snapshots (which are updated twice a day)
139 from
140 .URL ftp://\:ftp.ffii.org/\:pub/\:groff/\:devel/\:groff-current.tar.gz here
141 or a diff file relative to the latest official groff release as:
144 .ft C
145 ftp://ftp.ffii.org/pub/groff/devel/groff-[version]-current.diff.gz
146 .ft P
149 Please report bugs using the form in the file BUG-REPORT; the idea of this
150 is to make sure that FSF has all the information it needs to fix the bug.
151 At the very least, read the BUG-REPORT form and make sure that you supply
152 all the information that it asks for.
153 Even if you are not sure that something is a bug, report it using
154 BUG-REPORT: this will enable us to determine whether it really is a bug or
155 not.
157 Three mailing lists are available:
159 .ULS
161 .MTO bug-groff@gnu.org bug-groff@gnu.org
162 for reporting bugs
165 .MTO groff@gnu.org groff@gnu.org
166 for general discussion of groff
169 .MTO groff-commit@ffii.org groff-commit@ffii.org
170 a read-only list showing logs of commitments to the CVS repository
171 .ULE
173 Note that groff@gnu.org is an alias for
174 .MTO groff@\:ffii.org groff@\:ffii.org ;
175 you must be subscribed to the `groff' and `groff-commit' lists to send mails.
177 To subscribe, send e-mail to [list]-request@[domain] (example:
178 .MTO groff-request@\:ffii.org groff-request@\:ffii.org )
179 with the word `subscribe' in either the
180 subject or body of the e-mail (don't include the quotes).
182 GNU groff was written by
183 .MTO jjc@\:jclark.com "James Clark" .
184 It is now maintained by
185 .MTO Ted.Harding@\:nessie.mcc.ac.uk "Ted Harding"
187 .MTO wl@\:gnu.org "Werner Lemberg" .
193 NEWS VERSION 1.18
195 This section describes recent user-visible changes in groff.  Bug
196 fixes are not described.  There are more details in the man pages.
199 .SH 2
200 Troff
202 .ULS
204 Color support has been added to troff and pic (and to two device drivers,
205 grops and grohtml -- other preprocessors and drivers will follow).  A new
206 function `defcolor' defines colors; the escape sequence `\em' sets the
207 drawing color, the escape sequence `\eM' specifies the background color for
208 closed objects created with \eD'...' commands.  Similar to fonts, `\emP' and
209 `\eMP' switch back to the previous color.  `\em' and `\eM' correspond to the
210 new troff output commands `m' and `DF'.
212 Outputting color can be disabled in troff and groff with the option -c
213 (it is always disabled in compatibility mode).
215 For defining color components as fractions between 0 and 1, a new scaling
216 indicator `f' has been defined: 1f = 65536u.  For testing whether a color
217 is defined (with .if and .ie), a new conditional operator `m' is
218 available.
220 More details can be found in the troff manual page.
223 It is now possible to have whitespace between the first and second dot (or
224 the name of the ending macro) to end a macro definition.  Example:
227 .ft C
228 \&.de !
229 \&..
231 \&.de foo
232 \&.  nop Hello, I'm `foo'.
233 \&.  nop I will now define `bar'.
234 \&.  de bar !
235 \&.    nop Hello, I'm `bar'.
236 \&.  !
237 \&..
238 .ft P
243 `.fn' is a new string-valued register which returns the (internal) real
244 font name; styles and families are properly concatenated.
247 The new request `fchar' can be used to provide fallback characters.  Its
248 syntax is the same as the `char' request; the only difference is that a
249 character defined with `.char' hides the glyph with the same name in the
250 current font, whereas a character defined with `.fchar' is checked only if
251 the particular glyph isn't found in the current font.  This test happens
252 before checking special fonts.
255 The new request `itc' is a variant of `.it' for which a line interrupted
256 with \ec counts as one input line.
259 A new escape sequence `\eO' is available (mainly for internal use with
260 grohtml).  Please see groff_diff.man and groff.texinfo for more details.
263 Two macros `AT' (AT&T) and `UC' (Univ. of California) have been added to
264 the man macros for compatibility with older BSD releases.
267 The `-xwidth' specifier in the mdoc macro package has been removed.  Its
268 functionality is now integrated directly into `-width'.  Similarly,
269 `-column' has been extended to has this functionality also.
272 A new macro `Ex' has been added to the mdoc macro package to document an
273 exit status.
276 `troff.man' has been split.  Differences to UNIX troff are now documented
277 in the new man page `groff_diff.man'.
280 groff_mwww.man' has been renamed to `groff_www.man'.  The file mwww.tmac
281 has been removed.
284 The macro `NO-AUTO-RULE' has been added to www.tmac; it suppresses the
285 generation of top and bottom rules which grohtml emits by default.
286 .ULE
289 .SH 2
290 groff
292 .ULS
294 The new command line `-c' disables color output (which is always disabled
295 in compatibility mode).
296 .ULE
299 .SH 2
302 .ULS
304 New keywords `color' (or `colour', `colored', `coloured'), `outline' (or
305 `outlined'), and `shaded' are available.  `outline' sets the color of the
306 outline, `shaded' the fill color, and `color' sets both.  Example:
308 \fCcircle shaded "green" outline "black" ;\fP
310 Color support for TeX output is not implemented yet.
311 .ULE
314 .SH 2
315 Pic2graph
317 .ULS
319 A new script contributed by Eric S. Raymond <esr@thyrsus.com>.  It
320 converts a PIC diagram into a cropped image.  Since it uses gs and the PNM
321 library, virtually all graphics formats are available for output.
322 .ULE
325 .SH 2
326 grops
328 .ULS
330 Color support has been added.
331 .ULE
334 .SH 2
335 grohtml
337 .ULS
339 Color support for glyphs has been added.
342 New option `\fC-h\fP' to select the style of headings in HTML output.
343 .ULE
346 .SH 2
347 Miscellaneous
349 .ULS
351 A new manual page `\fCditroff.7\fP' is available.
352 .ULE
356 \s-2\fIThis document was produced using
357 .URL http://groff.ffii.org/ groff-\n[.x].\n[.y] .\s0\fP
359 .\" EOF