doc/webpage.ms

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