[Groff-commit] groff ./ChangeLog doc/groff.texinfo tmac/an-old...

[Werner LEMBERG]

CVSROOT:        /cvsroot/groff
Module name:    groff
Branch:         
Changes by:     Werner LEMBERG <address@hidden> 05/09/01 22:25:06

Modified files:
        .              : ChangeLog 
        doc            : groff.texinfo 
        tmac           : an-old.tmac groff_man.man groff_mdoc.man 

Log message:
        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.

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/ChangeLog.diff?tr1=1.847&tr2=1.848&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/doc/groff.texinfo.diff?tr1=1.220&tr2=1.221&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/tmac/an-old.tmac.diff?tr1=1.51&tr2=1.52&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/tmac/groff_man.man.diff?tr1=1.24&tr2=1.25&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/groff/groff/tmac/groff_mdoc.man.diff?tr1=1.37&tr2=1.38&r1=text&r2=text

Patches:
Index: groff/ChangeLog
diff -u groff/ChangeLog:1.847 groff/ChangeLog:1.848
--- groff/ChangeLog:1.847       Mon Aug 29 11:55:48 2005
+++ groff/ChangeLog     Thu Sep  1 22:25:06 2005
@@ -1,3 +1,19 @@
+2005-09-01  Keith Marshall  <address@hidden>
+
+       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  <address@hidden>
+
+       * tmac/groff_mdoc.man: Go into more details how the `AUTHORS'
+       section should look like.
+
 2005-08-29  Werner Lemberg  <address@hidden>
 
        * tmac/groff_mdoc.man: The month's name in a call to .Dd shouldn't
Index: groff/doc/groff.texinfo
diff -u groff/doc/groff.texinfo:1.220 groff/doc/groff.texinfo:1.221
--- groff/doc/groff.texinfo:1.220       Sat Feb 19 04:23:40 2005
+++ groff/doc/groff.texinfo     Thu Sep  1 22:25:06 2005
@@ -460,7 +460,7 @@
 @title groff
 @subtitle The GNU implementation of @code{troff}
 @subtitle Edition 1.19.2
address@hidden Spring 2005
address@hidden Summer 2005
 @author by Trent address@hidden
 @author and Werner Lemberg (@email{bug-groff@@gnu.org})
 
@@ -2156,8 +2156,23 @@
 
 @item address@hidden
 Set line length to @var{length}.  If not specified, the line length
-defaults to address@hidden in nroff mode (this is address@hidden per
-line) and address@hidden otherwise.
+is set to respect any value set by a prior @samp{ll} request (which
address@hidden 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 address@hidden in nroff mode (this is 78 characters per
+line) and address@hidden in troff address@hidden 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
address@hidden@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 address@hidden,
+i.e., the formatter's default line length in nroff mode), will @emph{not}
+set the line length to address@hidden (it will be adjusted to the @code{man}
+macro package's default setting of address@hidden), whereas the use of the
address@hidden option, or the @samp{.nr LL 65n}
+request @emph{will} establish a line length of address@hidden
 
 @item address@hidden
 Set title length to @var{length}.  If not specified, the title length
Index: groff/tmac/an-old.tmac
diff -u groff/tmac/an-old.tmac:1.51 groff/tmac/an-old.tmac:1.52
--- groff/tmac/an-old.tmac:1.51 Thu May 26 21:02:01 2005
+++ groff/tmac/an-old.tmac      Thu Sep  1 22:25:06 2005
@@ -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 (address@hidden)
 .\"
@@ -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]
 .
Index: groff/tmac/groff_man.man
diff -u groff/tmac/groff_man.man:1.24 groff/tmac/groff_man.man:1.25
--- groff/tmac/groff_man.man:1.24       Sun Aug 28 09:44:09 2005
+++ groff/tmac/groff_man.man    Thu Sep  1 22:25:06 2005
@@ -138,11 +138,39 @@
 .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
Index: groff/tmac/groff_mdoc.man
diff -u groff/tmac/groff_mdoc.man:1.37 groff/tmac/groff_mdoc.man:1.38
--- groff/tmac/groff_mdoc.man:1.37      Mon Aug 29 11:55:49 2005
+++ groff/tmac/groff_mdoc.man   Thu Sep  1 22:25:06 2005
@@ -2901,10 +2901,13 @@
 .
 .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