summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorG. Branden Robinson <g.branden.robinson@gmail.com>2023-05-05 10:01:41 -0500
committerG. Branden Robinson <g.branden.robinson@gmail.com>2023-05-05 13:33:01 -0500
commitd1329d297325156bca6916526e4887a112eb4bf0 (patch)
tree9f488dbb225245f697b97345da5ead8a37d824ed
parent7ce5bad10e2d0f4e1de575c0a876869aa8fa6f73 (diff)
downloadgroff-git-d1329d297325156bca6916526e4887a112eb4bf0.tar.gz
groff_out(5): Edit "Simple commands" subsection.
-rw-r--r--man/groff_out.5.man223
1 files changed, 111 insertions, 112 deletions
diff --git a/man/groff_out.5.man b/man/groff_out.5.man
index 320315b08..672f56c7d 100644
--- a/man/groff_out.5.man
+++ b/man/groff_out.5.man
@@ -305,10 +305,8 @@ commands must have all of their arguments on the same line as the
command, i.e., the arguments may not be split by a line break.
.
.P
-Empty lines, i.e., lines containing only space and/or a comment, can
-occur everywhere.
-.
-They are just ignored.
+Lines containing only spaces and/or a comment are treated as empty and
+ignored.
.
.
.\" ====================================================================
@@ -522,54 +520,53 @@ stack as the current device configuration data.
.
.TP
.command C xxx \[la]white-space\[ra]
-Print a glyph (special character) named
+Typeset the glyph of the special character
.IR xxx .
.
-The trailing
-.I syntactical space
-or
-.I line break
-is necessary to allow glyph names of arbitrary length.
-.
-The glyph is printed at the current print position;
-its size is read from the font description file.
+Trailing syntactical space is necessary to allow special character names
+of arbitrary length.
.
-The print position is not changed.
+The drawing position is not advanced.
+.\" XXX: Why does it matter that we read its size if we don't advance
+.\" the drawing position?
+.\" its size is read from the font description file.
.
.
.TP
.command c c
-Print glyph with single-letter name\~\c
-.I c
-at the current print position;
-its size is read from the font description file.
+Typeset the glyph of the ordinary character
+.IR c .
.
-The print position is not changed.
+The drawing position is not advanced.
+.\" XXX: Why does it matter that we read its size if we don't advance
+.\" the drawing position?
+.\" its size is read from the font description file.
.
.
.TP
.command f n
-Set font to font number\~\c
-.I n
-(a non-negative integer).
+Select the font mounted at
+.RI position\~ n .
+.
+.IR n\~ cannot
+be negative.
.
.
.TP
.command H n
-Move right to the absolute vertical position\~\c
-.I n
-(a non-negative integer in basic units\~\c
-.BR u )
-relative to left edge of current page.
+Horizontally move the drawing position to
+.IR n\~ basic
+units from the left edge of the page.
+.
+.IR n\~ cannot
+be negative.
.
.
.TP
.command h n
-Move
+Move the drawing position right
.I n
-(a non-negative integer) basic units\~\c
-.B u
-horizontally to the right.
+basic units.
.
AT&T
.I troff \" AT&T
@@ -584,123 +581,125 @@ output driver library handles them.
.
.
.TP
-.command m "color-scheme \f[R][\f[]component\f[R]] .\|.\|."
-Set the color for text (glyphs), line drawing, and the outline of
-graphic objects using different color schemes; the analogous command
-for the filling color of graphic objects is
-.BR DF .
-.
-The color components are specified as integer arguments between 0 and
-\n[@maxcolor].
+.command m "scheme \f[R][\f[]component\f[R]] .\|.\|."
+Select the stroke color using the
+.IR component s
+in the color space
+.IR scheme .
.
-The number of color components and their meaning vary for the
-different color schemes.
+Each
+.I component
+is an integer between 0 and \n[@maxcolor].
.
-These commands are generated by the
-.I groff
-escape sequence
-.BR \*[@backslash]m .
+The quantity of components and their meanings vary with each
+.IR scheme .
.
-They are
+This command is a
.I groff
-extensions.
+extension.
.
.
.RS
-.
.TP
.command mc "cyan magenta yellow"
-Set color using the CMY color scheme, having the 3\~color components
-cyan, magenta, and yellow.
+Use the CMY color scheme with components
+cyan,
+magenta,
+and yellow.
.
.
.TP
.command md
-Set color to the default color value
-(black in most cases).
-.
-No component arguments.
+Use the default color
+(no components;
+black in most cases).
.
.
.TP
.command mg "gray"
-Set color to the shade of gray given by the argument, an integer
+Use a grayscale color scheme with a component ranging
between 0 (black) and \n[@maxcolor] (white).
.
.
.TP
.command mk "cyan magenta yellow black"
-Set color using the CMYK color scheme, having the 4\~color components
-cyan, magenta, yellow, and black.
+Use the CMYK color scheme with components
+cyan,
+magenta,
+yellow,
+and black.
+.
.
.TP
.command mr "red green blue"
-Set color using the RGB color scheme, having the 3\~color components
-red, green, and blue.
-.
+Use the RGB color scheme with components
+red,
+green,
+and blue.
.RE
.
.
.TP
.command N n
-Print glyph with index\~\c
-.I n
-(an integer, normally non-negative) of the current font.
+Typeset the glyph with
+.RI index\~ n
+in the current font.
.
-The print position is not changed.
+.IR n\~ is normally a non-negative integer.
.
-If
-.B \-T\~html
-or
-.B \-T\~xhtml
-is used, negative values are emitted also to indicate an unbreakable
-space with given width.
-.
-For example,
-.B N\~\-193
-represents an unbreakable space which has a width of 193\|u.
+The drawing position is not advanced.
.
+The
+.B html
+and
+.B xhtml
+devices use this command with
+.RI negative\~ n
+to produce unbreakable space;
+the absolute value of
+.I n
+is taken and interpreted in basic units.
.
.
.TP
.command n b\ a
-Inform the device about a line break, but no positioning is done by
-this command.
+Describe a line break.
.
-In
-.I classical
+In AT&T
.IR troff ,
the integer arguments
.I b
-and\~\c
-.I a
-informed about the space before and after the current line to
-make the
-.I intermediate output
-more human readable without performing any action.
+.RI and\~ a
+describe the vertical space amounts before and after the break,
+respectively,
+to make the output more readable by humans.
.
-In
-.IR groff ,
-they are just ignored, but they must be provided for compatibility
-reasons.
+.I groff
+reports these values but its output driver library ignores them.
+.
+Vertical space is applied with
+.B V
+.RB or\~ v
+commands.
.
.
.TP
.command p n
-Begin a new page in the outprint.
-.
-The page number is set to\~\c
-.IR n .
+Begin a new page,
+setting its number
+.RI to\~ n .
.
-This page is completely independent of pages formerly processed even
-if those have the same page number.
+Each page is independent,
+even from those using the same number.
.
-The vertical position on the outprint is automatically set to\~0.
+The vertical drawing position is set to\~0.
.
-All positioning, writing, and drawing is always done relative to a
-page, so a
+All positioning,
+writing,
+and drawing command are done in the context of a page,
+so a
.BR p \~command
-must be issued before any of these commands.
+must precede any of these.
.
.
.TP
@@ -721,7 +720,7 @@ see section \[lq]Compatibility\[rq] below.
.
.
.TP
-.command t xyz\f[R]\|.\|.\|.\& \[la]white-space\[ra]
+.command t xyz\f[R]\|.\|.\|.\& \f[R]\[la]white-space\[ra]
.TQ
.command t "xyz\f[R]\|.\|.\|.\&\f[] dummy-arg" \[la]white-space\[ra]
Typeset a word
@@ -763,7 +762,7 @@ see
.
.
.TP
-.command u "n xyz\f[R]\|.\|.\|." \[la]white-space\[ra]
+.command u xyz\f[R]\|.\|.\|.\& \f[R]\[la]white-space\[ra]
Typeset word
.I xyz
with track kerning.
@@ -791,22 +790,19 @@ see
.
.TP
.command V n
-Move down to the absolute vertical position\~\c
-.I n
-(a non-negative integer in basic units\~\c
-.BR u )
-relative to upper edge of current page.
+Vertically move the drawing position to
+.IR n\~ basic
+units from the top edge of the page.
+.
+.IR n\~ cannot
+be negative.
.
.
.TP
.command v n
-Move
+Move the drawing position down
.I n
-basic units\~\c
-.B u
-down
-.RI ( n
-is a non-negative integer).
+basic units.
.
AT&T
.I troff \" AT&T
@@ -827,7 +823,10 @@ Describe an adjustable space.
This performs no action;
it is present for documentary purposes.
.
-The spacing itself must be performed explicitly by a move command.
+Horizontal space is applied with
+.B H
+.RB or\~ h
+commands.
.
.
.\" ====================================================================