summaryrefslogtreecommitdiffstats
path: root/contrib/groff/man
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2001-04-17 12:12:05 +0000
committerru <ru@FreeBSD.org>2001-04-17 12:12:05 +0000
commit78a36d21097dbce47cbcd4818ecd041388952f73 (patch)
tree8c20bfd611f113ea0cc691f0a026ad5ed1b43c72 /contrib/groff/man
parent3b4ec64f2874f8497458268896220e5c9c859d05 (diff)
parent0e0a0e6429c7113acf15c4c94bd5fe94c45f9e99 (diff)
downloadFreeBSD-src-78a36d21097dbce47cbcd4818ecd041388952f73.zip
FreeBSD-src-78a36d21097dbce47cbcd4818ecd041388952f73.tar.gz
This commit was generated by cvs2svn to compensate for changes in r75584,
which included commits to RCS files with non-trunk default branches.
Diffstat (limited to 'contrib/groff/man')
-rw-r--r--contrib/groff/man/groff.man218
-rw-r--r--contrib/groff/man/groff_char.man4
-rw-r--r--contrib/groff/man/groff_font.man26
-rw-r--r--contrib/groff/man/roff.man65
4 files changed, 232 insertions, 81 deletions
diff --git a/contrib/groff/man/groff.man b/contrib/groff/man/groff.man
index 73c9188..d69330d 100644
--- a/contrib/groff/man/groff.man
+++ b/contrib/groff/man/groff.man
@@ -24,7 +24,7 @@ FDL in the main directory of the groff source package.
.\" --------------------------------------------------------------------
.
.if n \{\
-. mso tmac.tty-char
+. mso tty-char.tmac
. ftr CR R
. ftr CI I
. ftr CB B
@@ -542,7 +542,14 @@ Groff provides a printable representation with the
escape sequence.
.TP
.character \(dq
-The double quote is used to enclose arguments in requests and macros.
+The double quote is used to enclose arguments in requests and macros. In
+the
+.request .ds
+and
+.request .as
+requests, a leading double quote in the argument will be stripped off,
+making everything else afterwards the string to be defined (enabling leading
+whitespace).
The escaped double quote
.esc \(dq
introduces a comment.
@@ -866,7 +873,7 @@ to
.argument stringvar .
.
.REQ .asciify diversion
-Unformat special ASCII characters in
+Unformat ASCII characters, spaces, and some escape sequences in
.argument diversion .
.
.REQ .backtrace
@@ -885,6 +892,21 @@ Embolden Special Font
when current font is
.argument font .
.
+.REQ .box
+End current diversion.
+.
+.REQ .box macro
+Divert to
+.argument macro ,
+omitting a partially filled line.
+.
+.REQ .boxa
+End current diversion.
+.
+.REQ .boxa macro
+Divert and append to
+.argument macro ,
+omitting a partially filled line.
.REQ .bp
Eject current page and begin new page.
.
@@ -985,6 +1007,9 @@ Continuous underline in nroff, like
.request .ul
in troff.
.
+.REQ .da
+End current diversion.
+.
.REQ .da macro
Divert and append to
.argument macro .
@@ -1003,6 +1028,21 @@ until
.request .end
is called.
.
+.REQ .dei macro
+Define or redefine a macro whose name is contained in the string register
+.argument macro
+until
+.request ..
+is called.
+.
+.REQ .dei macro end
+Define or redefine a macro indirectly.
+.argument macro
+and
+.argument end
+are string registers whose contents are interpolated for the macro name
+and the end macro, respectively.
+.
.REQ .di
End current diversion.
.
@@ -1035,6 +1075,13 @@ Reset escape character to
Set escape character to
.argument c .
.
+.REQ .ecr
+Restore escape character saved with
+.request .ecs .
+.
+.REQ .ecs
+Save current escape character.
+.
.REQ .el anything
Else part for if-else (\c
.argument .ie )
@@ -1065,6 +1112,9 @@ No pushing or popping.
.REQ .ex
Exit from roff processing.
.
+.REQ .fam
+Return to previous font family.
+.
.REQ .fam name
Set the current font family to
.argument name .
@@ -1235,6 +1285,15 @@ Write the length of the string
in
.argument register .
.
+.REQ .linetabs
+Enable line-tabs mode (i.e., calculate tab positions relative to output
+line).
+.
+.REQ .linetabs n
+If
+.argument n
+is zero, disable line-tabs mode, otherwise enable it.
+.
.REQ .lf N file
Set input line number to
.argument N
@@ -1293,7 +1352,7 @@ Mark current vertical position in
.REQ .mso file
The same as the .so request except that
.I file
-is also searched in the tmac directories.
+is searched in the tmac directories.
.
.REQ .na
No output-line adjusting.
@@ -1327,6 +1386,10 @@ Do not number next
.argument N
lines.
.
+.REQ .nop anything
+Always execute
+.argument anything .
+.
.REQ .nr register \(+-N M
Define or modify
.argument register
@@ -1440,6 +1503,9 @@ Remove the definitions of characters
.REQ .rd prompt
Read insertion.
.
+.REQ .return
+Return from a macro.
+.
.REQ .rj n
Right justify the next
.argument n
@@ -1595,15 +1661,25 @@ Enable track kerning for
.REQ .tl \f(CB\(cq\fPleft\f(CB\(cq\fPcenter\f(CB\(cq\fPright\f(CB\(cq\fP
Three-part title.
.
-.REQ .trf filename
-Transparently output the contents of file
-.argument filename .
-.
.REQ .tm anything
Print
.argument anything
on terminal (UNIX standard message output).
.
+.REQ .tm1 anything
+Print
+.argument anything
+on terminal (UNIX standard message output), allowing leading whitespace if
+.argument anything
+starts with
+.character \(dq
+(which will be stripped off).
+.
+.REQ .tmc anything
+Similar to
+.request .tm1
+without emitting a final newline.
+.
.REQ .tr abcd....
Translate
.argument a
@@ -1614,6 +1690,10 @@ to
.argument d ,
etc. on output.
.
+.REQ .trf filename
+Transparently output the contents of file
+.argument filename .
+.
.REQ .trnt abcd....
This is the same as the
.request .tr
@@ -1639,6 +1719,9 @@ Underline (italicize in troff)
.argument N
input lines.
.
+.REQ .unformat diversion
+Unformat space characters and tabs, preserving font information in
+.argument diversion .
.REQ .vpt n
Enable vertical position traps if
.argument n
@@ -1891,6 +1974,11 @@ preceding character is a roman character.
Unbreakable space that stretches like a normal inter-word space when a
line is adjusted.
.
+.ESC :
+Inserts a zero-width break point (similar to
+.esc %
+but without a soft hyphen character).
+.
.ESC \& newline
Ignored newline, for continuation lines.
.
@@ -1922,15 +2010,25 @@ Non-interpreted leader character.
.ESCq A anything
If
.argument anything
-acceptable as name of a string, macro, diversion, register,
-environment or font it is
-.number 1
-otherwise
-.number 0 .
+is acceptable as a name of a string, macro, diversion, register,
+environment or font it expands to
+.number 1 ,
+and
+.number 0
+otherwise.
.
.ESCq b abc...
Bracket building function.
.
+.ESCq B anything
+If
+.argument anything
+is acceptable as a valid numeric expression it expands to
+.number 1 ,
+and
+.number 0
+otherwise.
+.
.ESC c
Interrupt text processing.
.
@@ -2220,6 +2318,9 @@ from request calls.
.LP
.PD 0
.REG .$ Number of arguments in the current macro.
+.REG .a
+Post-line extra line-space most recently utilized using
+.escarg x 'N' .
.REG .A
Set to
.number 1
@@ -2231,19 +2332,8 @@ is used; always
.number 1
in
.BR nroff .
-.REG .H Available horizontal resolution in basic units.
-.REG .T
-Set to
-.number 1
-if option
-.B \-T
-is used.
-.REG .V Available vertical resolution in basic units.
-.REG .a
-Post-line extra line-space most recently utilized using
-.escarg x 'N' .
-.REG .C 1 if compatibility mode is in effect, 0 otherwise.
.REG .c Current input line number.
+.REG .C 1 if compatibility mode is in effect, 0 otherwise.
.REG .cdp
The depth of the last character added to the current environment.
It is positive if the character extends below the baseline.
@@ -2269,6 +2359,7 @@ Current vertical place in current diversion; equal to register
Always 1 in GNU troff.
Macros should use it to test if running under groff.
.REG .h Text base-line high-water mark on current page or diversion.
+.REG .H Available horizontal resolution in basic units.
.REG .hla
The current hyphenation language as set by the
.B .hla
@@ -2294,6 +2385,9 @@ The current hyphenation space (as set by the
request).
.REG .i Current ident.
.REG .in The indent that applies to the current output line.
+.REG .int
+Positive if last output line contains
+.esc c .
.REG .kern
.number 1
if pairwise kerning is enabled,
@@ -2304,6 +2398,10 @@ otherwise.
The current ligature mode (as set by the
.request .lg
request).
+.REG .linetabs
+The current line-tabs mode (as set by the
+.request .linetabs
+request).
.REG .ll The line length that applies to the current output line.
.REG .lt
The title length (as set by the
@@ -2331,6 +2429,12 @@ The number of lines to be right-justified as set by the rj request.
The last requested pointsize in points as a decimal fraction
(string-valued).
.REG .t Distance to the next trap.
+.REG .T
+Set to
+.number 1
+if option
+.B \-T
+is used.
.REG .tabs
A string representation of the current tab settings suitable for use as
an argument to the
@@ -2359,6 +2463,7 @@ The value of the parameters set by the second argument of the
request.
.REG .u Equal to 1 bin fill mode and 0 in nofill mode.
.REG .v Current vertical line spacing.
+.REG .V Available vertical resolution in basic units.
.REG .vpt
.number 1
if vertical position traps are enabled,
@@ -2371,6 +2476,25 @@ The sum of the number codes of the currently enabled warnings.
.REG .y The minor version number.
.REG .Y The revision number of groff.
.REG .z Name of current diversion.
+.PD
+.
+.\" --------------------------------------------------------------------
+.SS "WRITABLE REGISTERS"
+.\" --------------------------------------------------------------------
+The following registers can be read and written by the user.
+They have predefined default values, but these can be modified for
+customizing a document.
+.LP
+.PD 0
+.REG % Current page number.
+.REG c. Current input line number.
+.REG ct Character type (set by width function
+.esc w ).
+.REG dl Maximal width of last completed diversion.
+.REG dn Height of last completed diversion.
+.REG dw Current day of week (1-7).
+.REG dy Current day of month (1-31).
+.REG hp Current horizontal position at input line.
.REG llx
Lower left x-coordinate (in PostScript units) of a given PostScript
image (set by
@@ -2379,6 +2503,9 @@ image (set by
Lower left y-coordinate (in PostScript units) of a given PostScript
image (set by
.request .psbb ).
+.REG ln Output line number.
+.REG mo Current month (1-12).
+.REG nl Vertical position of last printed text base-line.
.REG rsb Like
.register sb ,
but takes account of the heights and depths of characters.
@@ -2393,6 +2520,10 @@ Depth of string below base line (generated by width function
Right skip width from the center of the last character in the
.esc w
argument.
+.REG slimit
+If greater than 0, the maximum number of objects on the input stack.
+If \(<=0 there is no limit, i.e., recursion can continue until virtual
+memory is exhausted.
.REG ssc
The amount of horizontal space (possibly negative) that should be added
to the last character before a subscript (generated by width function
@@ -2400,6 +2531,12 @@ to the last character before a subscript (generated by width function
.REG st
Height of string above base line (generated by width function
.esc w ).
+.REG systat
+The return value of the
+.I system()
+function executed by the last
+.request .sy
+request.
.REG urx
Upper right x-coordinate (in PostScript units) of a given PostScript
image (set by
@@ -2408,37 +2545,6 @@ image (set by
Upper right y-coordinate (in PostScript units) of a given PostScript
image (set by
.request .psbb ).
-.PD
-.
-.\" --------------------------------------------------------------------
-.SS "WRITABLE REGISTERS"
-.\" --------------------------------------------------------------------
-The following registers can be read and written by the user.
-They have predefined default values, but these can be modified for
-customizing a document.
-.LP
-.PD 0
-.REG % Current page number.
-.REG c. Current input line number.
-.REG ct Character type (set by width function
-.esc w ).
-.REG dl Maximal width of last completed diversion.
-.REG dw Current day of week (1-7).
-.REG dy Current day of month (1-31).
-.REG hp Current horizontal position at input line.
-.REG ln Output line number.
-.REG mo Current month (1-12).
-.REG nl Vertical position of last printed text base-line.
-.REG slimit
-If greater than 0, the maximum number of objects on the input stack.
-If \(<=0 there is no limit, i.e., recursion can continue until virtual
-memory is exhausted.
-.REG systat
-The return value of the
-.I system()
-function executed by the last
-.request .sy
-request.
.REG year The current year (year 2000 compliant).
.REG yr
Current year minus 1900. For Y2K compliance use register
diff --git a/contrib/groff/man/groff_char.man b/contrib/groff/man/groff_char.man
index fd9f4ce..1a2de90 100644
--- a/contrib/groff/man/groff_char.man
+++ b/contrib/groff/man/groff_char.man
@@ -132,7 +132,7 @@ a larger glyph can be obtained with
\&\\$3\t\\*(CH\t\\$2\t\\$4\t\\$5
.\}
..
-.wh \n(nlu+\n(.tu-\n(.Vu Fo
+.if !\n[cR] .wh \n(nlu+\n(.tu-\n(.Vu Fo
.de Fo
'bp
.He
@@ -290,12 +290,14 @@ Output Input Input PostScript Notes
.C2 'I Iacute
.C2 'O Oacute
.C2 'U Uacute
+.C2 'Y Yacute
.C2 'a aacute
.C2 'c cacute
.C2 'e eacute
.C2 'i iacute
.C2 'o oacute
.C2 'u uacute
+.C2 'y yacute
.C2 :A Adieresis
.C2 :E Edieresis
.C2 :I Idieresis
diff --git a/contrib/groff/man/groff_font.man b/contrib/groff/man/groff_font.man
index 8b9e3b4..9700e6a 100644
--- a/contrib/groff/man/groff_font.man
+++ b/contrib/groff/man/groff_font.man
@@ -1,5 +1,5 @@
.ig \"-*- nroff -*-
-Copyright (C) 1989-1995 Free Software Foundation, Inc.
+Copyright (C) 1989-1995, 2001 Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
@@ -87,6 +87,16 @@ for fonts whose point size is
.I n
scaled points.
.TP
+.BI prepro\ program
+Call
+.I program
+as a preprocessor.
+.TP
+.BI postpro\ program
+Use
+.I program
+as the postprocessor.
+.TP
.B tcommand
This means that the postprocessor can handle the
.B t
@@ -143,6 +153,18 @@ This is achieved by another tcommand:
.B charset
This line and everything following in the file are ignored.
It is allowed for the sake of backwards compatibility.
+.TP
+.BI print\ program
+Use
+.I program
+as the spooler program for printing.
+If omitted, the
+.B \-l
+and
+.B \-L
+options of
+.B groff
+are ignored.
.LP
The res, unitwidth, fonts and sizes lines are compulsory.
Other commands are ignored by
@@ -250,7 +272,7 @@ otherwise it corresponds to the groff input character
(if it is exactly two characters
.I xx
it can be entered as
-.BI \e( xx\fR.)
+.BI \e( xx\fR).
Groff supports eight bit characters; however some utilities
has difficulties with eight bit characters.
For this reason, there is a convention that the name
diff --git a/contrib/groff/man/roff.man b/contrib/groff/man/roff.man
index 793ce61..0ed8a37 100644
--- a/contrib/groff/man/roff.man
+++ b/contrib/groff/man/roff.man
@@ -1,4 +1,4 @@
-.\" -*- nroff -*-
+.\" t -*- nroff -*-
.ig
roff.7
@@ -24,7 +24,7 @@ FDL in the main directory of the groff source package.
.\" --------------------------------------------------------------------
.
.if n \{\
-. mso tmac.tty-char
+. mso tty-char.tmac
. ftr CR R
. ftr CI I
. ftr CB B
@@ -70,6 +70,12 @@ FDL in the main directory of the groff source package.
. rm @tmp@
..
.
+.de TQ
+.br
+.ns
+.TP \\$1
+..
+.
.\" --------------------------------------------------------------------
.\" Title
.\" --------------------------------------------------------------------
@@ -276,8 +282,10 @@ Macro packages are collections of macros that are suitable to format a
special kind of documents in a convenient way.
This greatly eases the usage of roff.
The macro definitions of a package are kept in a file called
-.BI tmac. name
-where
+.IB name .tmac
+(or
+.BI tmac. name\c
+) where
.I name
is the internal roff name for this package.
All tmac files are stored in a single or few directories at standard
@@ -294,7 +302,7 @@ or
.argname name .
General details on the naming of macro packages and their placement is
found in
-.BR tmac (@MAN5EXT@).
+.BR groff_tmac (@MAN5EXT@).
.LP
Famous classical macro packages are
.IR man ,
@@ -371,7 +379,7 @@ in all flavors of the Emacs editor.
.B GROFF_TMAC_PATH
A colon separated list of directories in which to search for
macro files, see
-.BR tmac (@MAN5EXT@).
+.BR groff_tmac (@MAN5EXT@).
.TP
.SM
.B GROFF_TYPESETTER
@@ -383,38 +391,52 @@ A colon separated list of directories in which to search for the
.BI dev name
directory.
.B troff
-will search in directories given in the
+will first search in directories given with the
.option \-F
-option before these, and in standard directories
-.RB ( .:/usr/local/share/groff/font:/usr/lib/font )
-after these.
+command line option, then in
+.BR GROFF_FONT_PATH ,
+and finally in the standard directories
+.RB ( @FONTPATH@ ).
.\" --------------------------------------------------------------------
.SH FILES
.\" --------------------------------------------------------------------
By default,
.I groff
-installs all of its library files in a directory tree under
-.IR /usr/local/share/groff .
-This location might vary for different systems.
-In the following, this directory is referred to as
-.IR <groff_dir> .
-.LP
+installs all of its data files in subdirectories of
+.I @FONTDIR@
+and in
+.I @MACRODIR@
+(except wrapper files for system-specific macro packages which will be
+in
+.IR @SYSTEMMACRODIR@ ).
+These locations might vary for different systems.
+In the following, the former is referred to as
+.IR <groff_font_dir> ,
+the latter as
+.IR <groff_macro_dir> .
.TP
-.IB <groff_dir> /tmac/troffrc
+.IB <groff_macro_dir> /troffrc
Initialization file for troff.
.TP
-.IB <groff_dir> /tmac/tmac. name
+.IB <groff_macro_dir> / name .tmac
+.TQ
+.IB <groff_macro_dir> /tmac. name
Macro files.
.TP
-.IB <groff_dir> /font/dev name /DESC
+.IB <groff_font_dir> /dev name /DESC
Device description file for device
.IR name .
.TP
-.IB <groff_dir> /font/dev name / F
+.IB <groff_font_dir> /dev name / F
Font file for font
.I F
of device
.IR name .
+.LP
+Finally, a local macro directory
+.I @LOCALMACRODIR@
+is provided for site-specific macros and packages; by default, it will be
+searched before the main macro directory.
.\" --------------------------------------------------------------------
.SH BUGS
.\" --------------------------------------------------------------------
@@ -482,9 +504,8 @@ The man pages for macro packages include
.BR groff_me (@MAN7EXT@),
.BR groff_mm (@MAN7EXT@),
.BR groff_mmroff (@MAN7EXT@),
-.BR groff_ms (@MAN7EXT@),
and
-.BR groff_msafer (@MAN7EXT@).
+.BR groff_ms (@MAN7EXT@).
.LP
The following utilities are available:
.BR addftinfo (@MAN1EXT@),
OpenPOWER on IntegriCloud