GNU bug report logs - #71087
grep.in.1: some remarks and editorial changes for this man page

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 71087 in the body.
You can then email your comments to 71087 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Bjarni Ingi Gislason <bjarniig <at> simnet.is>
To: bug-grep <at> gnu.org
Subject: grep.in.1: some remarks and editorial changes for this man page
Date: Tue, 21 May 2024 02:26:32 +0000

[Message part 1 (text/plain, inline)]

  Here are some notes and editorial fixes for the manual.

  The patch is in the attachment.

-.-

The difference between the formatted outputs can be seen with:

  nroff -man <file1> > <out1>
  nroff -man <file2> > <out2>
  diff -u <out1> <out2>

and for groff, using

"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "

instead of "nroff -man"

  Add the option "-t", if the file contains a table.

  Read the output of "diff -u" with "less -R" or similar.

-.-.

  If "man" (man-db) is used to check the manual for warnings,
the following must be set:

  The option "-warnings=w"

  The environmental variable:

export MAN_KEEP_STDERR=yes (or any non-empty value)

  or

  (produce only warnings):

export MANROFFOPT="-ww -z"

export MAN_KEEP_STDERR=yes (or any non-empty value)

-.-.

Output from "mandoc -T lint grep.in.1": (possibly shortened list)

mandoc: grep.in.1:27:9: WARNING: undefined string, using "": la

  The fix to eliminate this warning is to add explicitly an empty string to
its value:

.as la ""

  A similar method can be used for undefined registers:

.nr a +0

   The groff's 'an-ext.tmac' does not define the string 'la',
just the character.

-.-.

Use the correct macro for the font change of a single argument or
split the argument into two.

248:.IR FILE
677:.BR \-I

-.-.

Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.

752:.B sort -z

-.-.

Output from "groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z -rCHECKSTYLE=0":
troff: backtrace: file '<stdin>':26
troff:<stdin>:26: warning: macro 'la' not defined

[grep.in.1.diff (text/x-diff, attachment)]

Message #10 received at 71087-done <at> debbugs.gnu.org (full text, mbox):

From: Paul Eggert <eggert <at> cs.ucla.edu>
To: Bjarni Ingi Gislason <bjarniig <at> simnet.is>
Cc: 71087-done <at> debbugs.gnu.org
Subject: Re: bug#71087: grep.in.1: some remarks and editorial changes for this
 man page
Date: Tue, 21 May 2024 09:52:19 -0700

[Message part 1 (text/plain, inline)]

Thanks, I installed the attached.

[0001-doc-fix-troff-typos.patch (text/x-patch, attachment)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.