diff options
| -rw-r--r-- | ChangeLog | 16 | ||||
| -rw-r--r-- | doc/groff.texinfo | 21 | ||||
| -rw-r--r-- | tmac/an-old.tmac | 23 | ||||
| -rw-r--r-- | tmac/groff_man.man | 30 | ||||
| -rw-r--r-- | tmac/groff_mdoc.man | 9 |
5 files changed, 89 insertions, 10 deletions
@@ -1,3 +1,19 @@ +2005-09-01 Keith Marshall <keith.d.marshall@ntlworld.com> + + Backward compatibility support for `man' program. + + * tmac/an-old.tmac (LL): Initialize it to respect prior LL register + assignment, prior `.ll' request and then package defaults, in this + specified order of decreasing priority. + + * tmac/groff_man.man, doc/groff.texinfo: Document altered `LL' + register initialization priorities. + +2005-08-29 Gary W. Swearingen <garys@opusnet.com> + + * tmac/groff_mdoc.man: Go into more details how the `AUTHORS' + section should look like. + 2005-08-29 Werner Lemberg <wl@gnu.org> * tmac/groff_mdoc.man: The month's name in a call to .Dd shouldn't diff --git a/doc/groff.texinfo b/doc/groff.texinfo index dce23b99..e4d90b6f 100644 --- a/doc/groff.texinfo +++ b/doc/groff.texinfo @@ -460,7 +460,7 @@ Software Foundation raise funds for GNU development.'' @title groff @subtitle The GNU implementation of @code{troff} @subtitle Edition 1.19.2 -@subtitle Spring 2005 +@subtitle Summer 2005 @author by Trent A.@tie{}Fisher @author and Werner Lemberg (@email{bug-groff@@gnu.org}) @@ -2156,8 +2156,23 @@ to get consistent indentation. @item -rLL=@var{length} Set line length to @var{length}. If not specified, the line length -defaults to 78@tie{}en in nroff mode (this is 78@tie{}characters per -line) and 6.5@tie{}inch otherwise. +is set to respect any value set by a prior @samp{ll} request (which +@emph{must} be in effect when the @samp{TH} macro is invoked), if +this differs from the built-in default for the formatter; otherwise it +defaults to 78@dmn{n} in nroff mode (this is 78 characters per +line) and 6.5@dmn{i} in troff mode.@footnote{Note that the use of +a @samp{.ll @var{length}} request to initialize the line length, prior +to use of the @samp{TH} macro, is supported for backward compatibility +with some versions of the @code{man} program. @emph{Always} use the +@option{-rLL=@var{length}} option, or an equivalent @samp{.nr LL @var{length}} +request, in preference to such a @samp{.ll @var{length}} request. +In particular, note that in nroff mode, the request @samp{.ll 65n}, +(with any @var{length} expression which evaluates equal to 65@dmn{n}, +i.e., the formatter's default line length in nroff mode), will @emph{not} +set the line length to 65@dmn{n} (it will be adjusted to the @code{man} +macro package's default setting of 78@dmn{n}), whereas the use of the +@option{-rLL=65n} option, or the @samp{.nr LL 65n} +request @emph{will} establish a line length of 65@dmn{n}.} @item -rLT=@var{length} Set title length to @var{length}. If not specified, the title length diff --git a/tmac/an-old.tmac b/tmac/an-old.tmac index 6742fb77..b51f2e2f 100644 --- a/tmac/an-old.tmac +++ b/tmac/an-old.tmac @@ -1,6 +1,6 @@ .\" an-old.tmac .\" -.\" Copyright (C) 1989, 1990, 1991, 1992, 2001, 2002, 2003, 2004 +.\" Copyright (C) 1989, 1990, 1991, 1992, 2001, 2002, 2003, 2004, 2005 .\" Free Software Foundation, Inc. .\" Written by James Clark (jjc@jclark.com) .\" @@ -62,10 +62,27 @@ . .nr need_eo_h 0 . +.\" set up the line length... +.\" giving precedence to any prior assignment to the \n[LL] register. .if !r LL \{\ -. ie n .nr LL 78n -. el .nr LL 6.5i +. +. \" but if that isn't predefined... +. \" then try to respect any prior `.ll' request. +. nr LL \n[.l] +. +. \" For troff, this is sufficient to give us a default line length of +. \" 6.5i, but for nroff, we prefer a default of 78n to nroff's default +. \" 65n. This has the unfortunate side effect that we will override a +. \" user's `.ll 65n' request, with our preferred 78n default; we can't +. \" possibly know that the 65n came from a `.ll' request, and MUST +. \" assume that it was set by nroff, as its built-in default! If the +. \" user wants to force this setting, then he MUST use the `-rLL=65n' +. \" option, or an equivalent `.nr LL 65n' request. +. if n \ +. if (\n[LL] = 65n) \ +. nr LL 78n .\} +. .if !r LT \ . nr LT \n[LL] . diff --git a/tmac/groff_man.man b/tmac/groff_man.man index a070450b..985014eb 100644 --- a/tmac/groff_man.man +++ b/tmac/groff_man.man @@ -138,12 +138,40 @@ consistent indentation. .BI \-rLL= line-length Set line length. . -If this option is not given, the line length defaults to 78n in +If this option is not given, +the line length is set to respect any value set by a prior `.ll' request, +(which +.I must +be in effect when the `.TH' macro is invoked), +if this differs from the built\-in default for the formatter; +otherwise it defaults to 78n in .I nroff mode and 6.5i in .I troff mode. . +.IP +Note that the use of a `.ll' request to initialize the line length +is supported for backward compatibility with some versions of the +.B man +program; +direct initialization of the `LL' register should +.I always +be preferred to the use of such a request. +In particular, note that a `.ll\ 65n' request will +.I not +preserve the normal +.I nroff +default line length, +(the +.B man +default initialization to 78n will prevail), +whereas, +the `-rLL=65n' option, or an equivalent `.nr\ LL\ 65n' +request preceding the use of the `TH' macro, +.I will +set a line length of 65n. +. .TP .BI \-rLT= title-length Set title length. diff --git a/tmac/groff_mdoc.man b/tmac/groff_mdoc.man index 0893760d..004d784f 100644 --- a/tmac/groff_mdoc.man +++ b/tmac/groff_mdoc.man @@ -2901,10 +2901,13 @@ outlined historically in this section. . .It Li ".Sh AUTHORS" Credits should be placed here. -The +Use the .Ql .An -macro should be used to specify the name(s) of the person(s). -. +macro for names and the +.Ql .Aq +macro for e-mail addresses within optional contact information. +Explicitly indicate whether the person authored the initial manual page +or the software or whatever the person is being credited for. .It Li ".Sh BUGS" Blatant problems with the topic go here. .El |