bug-gawk
[Top][All Lists]
Advanced

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

Re: Broken use of \c in man page


From: arnold
Subject: Re: Broken use of \c in man page
Date: Fri, 02 Jun 2023 02:23:21 -0600
User-agent: Heirloom mailx 12.5 7/5/10

OK, I've applied the path and fixed up the last use of \c.
Thanks all.

Arnold

Bjarni Ingi Gislason <bjarniig@simnet.is> wrote:

> From f3d53d66f0117bdb672b02df734f4f4a98d4c6db Mon Sep 17 00:00:00 2001
> >From: Bjarni Ingi Gislason <bjarniig@simnet.is>
> Date: Tue, 30 May 2023 15:47:34 +0000
> Subject: [PATCH] doc/gawk.1: Drop '\c' and join the lines to make one
>  "two-fonts macro" line
>
>   '\c' makes only sense with three different font changes in a logical
> line.
>
>   The lines
>
> .IB expr1 " ? " expr2 " : " expr3\c
> \&.
>
>   could be made to one line with a \fR before '.', so
>
> .IB expr1 " ? " expr2 " : " expr3 \fR.
>
>   The '\c' in an italic argument "eats" the italic correction in the IB
> macro,
> so the transformed line gets a better typographical appearance.
>
>   Otherwise "expr3\c" should be changed to "expr3\/\c"
>
>   Both the current master version and the patched version were tested
> with
>
> groff -man -Z <file>
>
> and showed the same result.
>
> Signed-off-by: Bjarni Ingi Gislason <bjarniig@simnet.is>
> ---
>  doc/gawk.1 | 63 ++++++++++++++++++------------------------------------
>  1 file changed, 21 insertions(+), 42 deletions(-)
>
> diff --git a/doc/gawk.1 b/doc/gawk.1
> index eb5980d5..f90c44e1 100644
> --- a/doc/gawk.1
> +++ b/doc/gawk.1
> @@ -94,8 +94,7 @@ Standard options are listed first, followed by options for
>  .I gawk
>  extensions, listed alphabetically by short option.
>  .TP
> -.BI \-f " program-file\fR,\fP "\c
> -.BI \-\^\-file " program-file"
> +.BI \-f " program-file\fR,\fP " \-\^\-file " program-file"
>  Read the \*(AK program source from the file
>  .IR program-file ,
>  instead of from the first command line argument.
> @@ -106,8 +105,7 @@ Files read with
>  .B \-f
>  are treated as if they begin with an implicit \fB@namespace "awk"\fR 
> statement.
>  .TP
> -.BI \-F " fs\fR, \fP"\c
> -.BI \-\^\-field-separator " fs"
> +.BI \-F " fs\fR, \fP" \-\^\-field-separator " fs"
>  Use
>  .I fs
>  for the input field separator (the value of the
> @@ -125,15 +123,13 @@ Such variable values are available to the
>  .B BEGIN
>  rule of an \*(AK program.
>  .TP
> -.BR \-b ", "\c
> -.B \-\^\-characters\-as\-bytes
> +.BR \-b ", " \-\^\-characters\-as\-bytes
>  Treat all input data as single-byte characters.
>  The
>  .B \-\^\-posix
>  option overrides this one.
>  .TP
> -.BR \-c ", "\c
> -.B \-\^\-traditional
> +.BR \-c ", " \-\^\-traditional
>  Run in
>  .I compatibility
>  mode.  In compatibility mode,
> @@ -142,8 +138,7 @@ behaves identically to Brian Kernighan's
>  .IR awk ;
>  none of the \*(GN-specific extensions are recognized.
>  .TP
> -.BR \-C ", "\c
> -.B \-\^\-copyright
> +.BR \-C ", " \-\^\-copyright
>  Print the short version of the \*(GN copyright information message on
>  the standard output and exit successfully.
>  .TP
> @@ -176,8 +171,7 @@ options.
>  The debugger is documented in \*(EP; see
>  .IR 
> https://www.gnu.org/software/gawk/manual/html_node/Debugger.html#Debugger .
>  .TP
> -.BI \-e " program-text\fR, \fP"\c
> -.BI \-\^\-source " program-text"
> +.BI \-e " program-text\fR, \fP" \-\^\-source " program-text"
>  Use
>  .I program-text
>  as \*(AK program source code.
> @@ -196,16 +190,14 @@ passing in options or source code (!) on the command 
> line
>  from a URL.
>  This option disables command-line variable assignments.
>  .TP
> -.BR \-g ", "\c
> -.B \-\^\-gen\-pot
> +.BR \-g ", " \-\^\-gen\-pot
>  Scan and parse the \*(AK program, and generate a \*(GN
>  .B \&.pot
>  (Portable Object Template)
>  format file on standard output with entries for all localizable
>  strings in the program.  The program itself is not executed.
>  .TP
> -.BR \-h ", "\c
> -.B \-\^\-help
> +.BR \-h ", " \-\^\-help
>  Print a relatively short summary of the available options on
>  the standard output.
>  Per the
> @@ -226,8 +218,7 @@ Files read with
>  .B \-\^\-include
>  are treated as if they begin with an implicit \fB@namespace "awk"\fR 
> statement.
>  .TP
> -.BR \-I ", "\c
> -.B \-\^\-trace
> +.BR \-I ", " \-\^\-trace
>  Print the internal byte code names as they are executed when running
>  the program. The trace is printed to standard error. Each ``op code''
>  is preceded by a
> @@ -240,8 +231,7 @@ See the manual for details.
>  .BR FIXME :
>  eventually provide a URL here.
>  .TP
> -.BI \-l " lib\fR, "\c
> -.BI \-\^\-load " lib"
> +.BI \-l " lib\fR, " \-\^\-load " lib"
>  Load a
>  .I gawk
>  extension from the shared library
> @@ -261,8 +251,7 @@ See
>  for the list of possible values for
>  .IR value .
>  .TP
> -.BR \-M ", "\c
> -.B \-\^\-bignum
> +.BR \-M ", " \-\^\-bignum
>  Force arbitrary precision arithmetic on numbers. This option has
>  no effect if
>  .I gawk
> @@ -287,21 +276,18 @@ Set
>  in the environment to silence the warning.
>  ..
>  .TP
> -.BR \-n ", "\c
> -.B \-\^\-non\-decimal\-data
> +.BR \-n ", " \-\^\-non\-decimal\-data
>  Recognize octal and hexadecimal values in input data.
>  .I "Use this option with great caution!"
>  .TP
> -.BR \-N ", "\c
> -.B \-\^\-use\-lc\-numeric
> +.BR \-N ", " \-\^\-use\-lc\-numeric
>  Force
>  .I gawk
>  to use the locale's decimal point character when parsing input data.
>  .ig
>  .\" This option is left undocumented, on purpose.
>  .TP
> -.BR "\-W nostalgia" ", "\c
> -.B \-\^\-nostalgia
> +.BR "\-W nostalgia" ", " \-\^\-nostalgia
>  Provide a moment of nostalgia for long time
>  .I awk
>  users.
> @@ -316,8 +302,7 @@ in the current directory.
>  This option implies
>  .BR \-\^\-no\-optimize .
>  .TP
> -.BR \-O ", "\c
> -.B \-\^\-optimize
> +.BR \-O ", " \-\^\-optimize
>  Enable
>  .IR gawk 's
>  default optimizations upon the internal representation of the program.
> @@ -336,28 +321,24 @@ runs more slowly in this mode.
>  This option implies
>  .BR \-\^\-no\-optimize .
>  .TP
> -.BR \-P ", "\c
> -.B \-\^\-posix
> +.BR \-P ", " \-\^\-posix
>  This turns on
>  .I compatibility
>  mode, and disables a number of common extensions.
>  .TP
> -.BR \-r ", "\c
> -.B \-\^\-re\-interval
> +.BR \-r ", " \-\^\-re\-interval
>  Enable the use of
>  .I "interval expressions"
>  in regular expression matching.
>  Interval expressions
>  are enabled by default, but this option remains for backwards compatibility.
>  .TP
> -.BR \-s ", "\c
> -.B \-\^\-no\-optimize
> +.BR \-s ", " \-\^\-no\-optimize
>  Disable
>  .IR gawk 's
>  default optimizations upon the internal representation of the program.
>  .TP
> -.BR \-S ", "\c
> -.B \-\^\-sandbox
> +.BR \-S ", " \-\^\-sandbox
>  Run
>  .I gawk
>  in sandbox mode, disabling the
> @@ -369,14 +350,12 @@ output redirection with
>  and loading dynamic extensions.
>  Command execution (through pipelines) is also disabled.
>  .TP
> -.BR \-t ", "\c
> -.B \-\^\-lint\-old
> +.BR \-t ", " \-\^\-lint\-old
>  Provide warnings about constructs that are
>  not portable to the original version of \*(UX
>  .IR awk .
>  .TP
> -.BR \-V ", "\c
> -.B \-\^\-version
> +.BR \-V ", " \-\^\-version
>  Print version information for this particular copy of
>  .I gawk
>  on the standard output.
> -- 
> 2.39.2



reply via email to

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