groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 52/72: troff(1): Sync synopsis with usage message.


From: G. Branden Robinson
Subject: [groff] 52/72: troff(1): Sync synopsis with usage message.
Date: Sun, 23 Oct 2022 22:25:44 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 411721f6cfff7c0b709ab67f112042aca9dcc005
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sun Oct 23 13:04:45 2022 -0500

    troff(1): Sync synopsis with usage message.
    
    Also clarify when command-line string and register assignments occur.
---
 src/roff/troff/troff.1.man | 82 +++++++++++++++++++++++++---------------------
 1 file changed, 45 insertions(+), 37 deletions(-)

diff --git a/src/roff/troff/troff.1.man b/src/roff/troff/troff.1.man
index 90dbe119d..7b299424f 100644
--- a/src/roff/troff/troff.1.man
+++ b/src/roff/troff/troff.1.man
@@ -34,35 +34,35 @@
 .SY @g@troff
 .RB [ \-abcCEiRUz ]
 .RB [ \-d\~\c
-.IR cs ]
+.IR ctext ]
 .RB [ \-d\~\c
-.IB name =\c
-.IR string ]
+.IB string =\c
+.IR text ]
 .RB [ \-f\~\c
-.IR  fam ]
+.IR  font-family ]
 .RB [ \-F\~\c
-.IR  dir ]
+.IR  font-directory ]
 .RB [ \-I\~\c
-.IR  dir ]
+.IR  inclusion-directory ]
 .RB [ \-m\~\c
-.IR  name ]
+.IR  macro-package ]
 .RB [ \-M\~\c
-.IR  dir ]
+.IR  macro-directory ]
 .RB [ \-n\~\c
-.IR  num ]
+.IR  page-number ]
 .RB [ \-o\~\c
-.IR  list ]
+.IR  page-list ]
 .RB [ \-r\~\c
-.IR  cn ]
+.IR  cnumeric-expression ]
 .RB [ \-r\~\c
-.IB reg =\c
-.IR expr ]
+.IB register =\c
+.IR numeric-expression ]
 .RB [ \-T\~\c
-.IR  dev ]
+.IR  output-device ]
 .RB [ \-w\~\c
-.IR  name ]
+.IR  warning-category ]
 .RB [ \-W\~\c
-.IR  name ]
+.IR  warning-category ]
 .RI [ file\~ .\|.\|.]
 .YS
 .
@@ -184,8 +184,9 @@ input parser to the standard error stream with each 
diagnostic message.
 The line numbers given in the backtrace might not always be correct,
 because
 .IR @g@troff 's
-idea of line numbers can be confused by requests that append to strings
-or macros.
+idea of line numbers can be confused by requests that append to
+.\" strings or (??? strings never contain newlines)
+macros.
 .
 .
 .TP
@@ -203,19 +204,24 @@ implies
 .
 .
 .TP
-.BI \-d\~ cs
+.BI \-d\~ ctext
 .TQ
-.BI \-d\~ name = string
+.BI \-d\~ string = text
 Define
 .I roff
 .RI string\~ c
 or
-.I name
-.RI as\~ s
-or
-.I string;
-.I c
-must be a one-character name.
+.I string
+as
+.I text.
+.
+.IR c \~must
+be one character;
+.I string
+can be of arbitrary length.
+.
+Such string assignments happen before any macro file is loaded,
+including the startup file.
 .
 Due to
 .MR getopt_long 3
@@ -223,7 +229,7 @@ limitations,
 .IR c\~ cannot
 be,
 and
-.I name
+.I string
 cannot contain,
 an equals sign,
 even though that is a valid character in a
@@ -374,22 +380,24 @@ stops processing and exits after formatting the last page 
enumerated in
 .
 .
 .TP
-.BI \-r\~ cn
+.BI \-r\~ cnumeric-expression
 .TQ
-.BI \-r\~ reg = expr
+.BI \-r\~ register = numeric-expression
 Define
 .I roff
 .RI register\~ c
 or
-.I reg
+.I register
 as
-.I groff
-numeric
-.RI expression\~ n
-or
-.I expr;
+.I numeric-expression.
+.
 .IR c \~must
-be a one-character name.
+be a one-character name;
+.I register
+can be of arbitrary length.
+.
+Such register assignments happen before any macro file is loaded,
+including the startup file.
 .
 Due to
 .MR getopt_long 3
@@ -397,7 +405,7 @@ limitations,
 .IR c\~ cannot
 be,
 and
-.I reg
+.I register
 cannot contain,
 an equals sign,
 even though that is a valid character in a



reply via email to

[Prev in Thread] Current Thread [Next in Thread]