[PATCH] man/man3/getopt.3: ffix

[PATCH] man/man3/getopt.3: ffix

[G. Branden Robinson]

[-- Attachment #1: Type: text/plain, Size: 2696 bytes --]

Protect literals from hyphenation.

Such explicit protection of man page cross references will be
unnecessary when the Linux man-pages migrate to the `MR` macro of groff
1.23.0 man(7); that macro disables hyphenation of its first argument.

Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com>
---
 man/man3/getopt.3 | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/man/man3/getopt.3 b/man/man3/getopt.3
index e7518192d..2ed7c7080 100644
--- a/man/man3/getopt.3
+++ b/man/man3/getopt.3
@@ -91,7 +91,7 @@ .SH DESCRIPTION
 A legitimate option character is any visible one byte
 .BR ascii (7)
 character (for which
-.BR isgraph (3)
+.BR \%isgraph (3)
 would return nonzero) that is not \[aq]\-\[aq], \[aq]:\[aq], or \[aq];\[aq].
 If such a
 character is followed by a colon, the option requires an argument, so
@@ -137,14 +137,14 @@ .SH DESCRIPTION
 If the first character of
 .I optstring
 is \[aq]+\[aq] or the environment variable
-.B POSIXLY_CORRECT
+.B \%POSIXLY_CORRECT
 is set, then option processing stops as soon as a nonoption argument is
 encountered.
 If \[aq]+\[aq] is not the first character of
 .IR optstring ,
 it is treated as a normal option.
 If
-.B POSIXLY_CORRECT
+.B \%POSIXLY_CORRECT
 behaviour is required in this case
 .I optstring
 will contain two \[aq]+\[aq] symbols.
@@ -221,7 +221,7 @@ .SH RETURN VALUE
 otherwise \[aq]?\[aq] is returned.
 .SH ENVIRONMENT
 .TP
-.B POSIXLY_CORRECT
+.B \%POSIXLY_CORRECT
 If this is set, then option processing stops as soon as a nonoption
 argument is encountered.
 .SH ATTRIBUTES
@@ -249,7 +249,7 @@ .SH VERSIONS
 .IR const ,
 but these functions permute its elements
 unless the environment variable
-.B POSIXLY_CORRECT
+.B \%POSIXLY_CORRECT
 is set.
 .I const
 is used in the actual prototype to be compatible with other systems;
@@ -284,7 +284,7 @@ .SH HISTORY
 .P
 Very old versions of glibc were affected by a
 .UR https://\:sourceware.org/\:git/\:?p=glibc.git;a=commitdiff;h=bf079e19f50d64aa5e05
-.BI _ PID _GNU_nonoption_argv_flags_
+.BI \%_ PID _GNU_nonoption_argv_flags_
 environment variable
 .UE .
 .SH NOTES
@@ -294,7 +294,7 @@ .SH NOTES
 and \[aq]\-\[aq] at the start of
 .IR optstring ,
 or changes the value of
-.B POSIXLY_CORRECT
+.B \%POSIXLY_CORRECT
 between scans,
 must reinitialize
 .BR getopt ()
@@ -303,7 +303,7 @@ .SH NOTES
 to 0, rather than the traditional value of 1.
 (Resetting to 0 forces the invocation of an internal initialization
 routine that rechecks
-.B POSIXLY_CORRECT
+.B \%POSIXLY_CORRECT
 and checks for GNU extensions in
 .IR optstring .)
 .P
-- 
2.30.2

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH] man/man3/getopt.3: ffix

[Alejandro Colomar]

[-- Attachment #1: Type: text/plain, Size: 3089 bytes --]

Hi Branden,

On Fri, Dec 19, 2025 at 10:31:44AM -0600, G. Branden Robinson wrote:
> Protect literals from hyphenation.
> 
> Such explicit protection of man page cross references will be
> unnecessary when the Linux man-pages migrate to the `MR` macro of groff
> 1.23.0 man(7); that macro disables hyphenation of its first argument.
> 
> Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com>
> ---
>  man/man3/getopt.3 | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/man/man3/getopt.3 b/man/man3/getopt.3
> index e7518192d..2ed7c7080 100644
> --- a/man/man3/getopt.3
> +++ b/man/man3/getopt.3
> @@ -91,7 +91,7 @@ .SH DESCRIPTION
>  A legitimate option character is any visible one byte
>  .BR ascii (7)
>  character (for which
> -.BR isgraph (3)
> +.BR \%isgraph (3)

Please don't include those that will be unnecessary with MR.


Cheers,
Alex

>  would return nonzero) that is not \[aq]\-\[aq], \[aq]:\[aq], or \[aq];\[aq].
>  If such a
>  character is followed by a colon, the option requires an argument, so
> @@ -137,14 +137,14 @@ .SH DESCRIPTION
>  If the first character of
>  .I optstring
>  is \[aq]+\[aq] or the environment variable
> -.B POSIXLY_CORRECT
> +.B \%POSIXLY_CORRECT
>  is set, then option processing stops as soon as a nonoption argument is
>  encountered.
>  If \[aq]+\[aq] is not the first character of
>  .IR optstring ,
>  it is treated as a normal option.
>  If
> -.B POSIXLY_CORRECT
> +.B \%POSIXLY_CORRECT
>  behaviour is required in this case
>  .I optstring
>  will contain two \[aq]+\[aq] symbols.
> @@ -221,7 +221,7 @@ .SH RETURN VALUE
>  otherwise \[aq]?\[aq] is returned.
>  .SH ENVIRONMENT
>  .TP
> -.B POSIXLY_CORRECT
> +.B \%POSIXLY_CORRECT
>  If this is set, then option processing stops as soon as a nonoption
>  argument is encountered.
>  .SH ATTRIBUTES
> @@ -249,7 +249,7 @@ .SH VERSIONS
>  .IR const ,
>  but these functions permute its elements
>  unless the environment variable
> -.B POSIXLY_CORRECT
> +.B \%POSIXLY_CORRECT
>  is set.
>  .I const
>  is used in the actual prototype to be compatible with other systems;
> @@ -284,7 +284,7 @@ .SH HISTORY
>  .P
>  Very old versions of glibc were affected by a
>  .UR https://\:sourceware.org/\:git/\:?p=glibc.git;a=commitdiff;h=bf079e19f50d64aa5e05
> -.BI _ PID _GNU_nonoption_argv_flags_
> +.BI \%_ PID _GNU_nonoption_argv_flags_
>  environment variable
>  .UE .
>  .SH NOTES
> @@ -294,7 +294,7 @@ .SH NOTES
>  and \[aq]\-\[aq] at the start of
>  .IR optstring ,
>  or changes the value of
> -.B POSIXLY_CORRECT
> +.B \%POSIXLY_CORRECT
>  between scans,
>  must reinitialize
>  .BR getopt ()
> @@ -303,7 +303,7 @@ .SH NOTES
>  to 0, rather than the traditional value of 1.
>  (Resetting to 0 forces the invocation of an internal initialization
>  routine that rechecks
> -.B POSIXLY_CORRECT
> +.B \%POSIXLY_CORRECT
>  and checks for GNU extensions in
>  .IR optstring .)
>  .P
> -- 
> 2.30.2



-- 
<https://www.alejandro-colomar.es>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH] man/man3/getopt.3: ffix

[G. Branden Robinson]

[-- Attachment #1: Type: text/plain, Size: 563 bytes --]

At 2025-12-19T17:49:04+0100, Alejandro Colomar wrote:
> > diff --git a/man/man3/getopt.3 b/man/man3/getopt.3
> > index e7518192d..2ed7c7080 100644
> > --- a/man/man3/getopt.3
> > +++ b/man/man3/getopt.3
> > @@ -91,7 +91,7 @@ .SH DESCRIPTION
> >  A legitimate option character is any visible one byte
> >  .BR ascii (7)
> >  character (for which
> > -.BR isgraph (3)
> > +.BR \%isgraph (3)
> 
> Please don't include those that will be unnecessary with MR.

My satanic seddery would have no trouble with removing them, but okay.

Regards,
Branden

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]