diff options
author | Alejandro Colomar <alx@kernel.org> | 2022-10-30 18:59:09 +0100 |
---|---|---|
committer | Alejandro Colomar <alx@kernel.org> | 2022-10-30 23:50:30 +0100 |
commit | 4c1c52748a06141996fccbf23fb8d9e15cba11e8 (patch) | |
tree | db53f9fd936fcbe72e41f7b2414f60689f25e045 /man8 | |
parent | bd14f1e3236a1f016b7a8a85deb34379c4470687 (diff) |
Many pages: Use correct letter case in page titles (TH)
Scripted change:
$ find man* -type f \
| xargs grep -L '\.so' \
| while read f; do
P=$(basename $f);
T=$(grep '\.TH ' $f | cut -f2,3 -d' ' | sed 's/ /./');
p=$(echo $P | tr '[:upper:]' '[:lower:]');
t=$(echo $T | tr '[:upper:]' '[:lower:]');
Tn=$(echo $T | sed 's/\.[^.]\+$//')
Pn=$(echo $P | sed 's/\.[^.]\+$//')
N=$(man_section $f NAME \
| sed -n '/NAME/,/ - /p' \
| sed 's/ - .*//' \
| grep -v '^NAME$' \
| tr ', ' '\n' \
| grep -i "^$Pn$" \
| head -n1)
test $P = $T \
&& test -n $N \
&& continue;
if test "x$p" != "x$t"; then
echo 1 $P $T $N;
elif test -z "$N"; then
echo 2 $P $T $N;
else
sed -i "/\.TH /s/$Tn/$N/" $f;
fi;
done;
On 10/30/22 23:00, G. Branden Robinson wrote:
> For those to whom this change is coming as an unpleasant surprise, the
> forthcoming groff 1.23.0 features an option that will reverse this
> change at rendering time.
>
> From groff_man(7):
>
> -rCT=1 Capitalize titles, setting the man page title (the first
> argument to .TH) in full capitals in headers and footers.
> This transformation is off by default because it discards
> case distinction information.
>
> This register can also be set in a site-local "man.local" file to force
> it on for all pages. On Debian-based systems, this file is in
> /etc/groff. The following line will do the trick.
>
> .nr CT 1
>
> The groff_man_style(7) man page offers further examples of such
> rendering customization.
>
> /usr/local/share/groff/site-tmac/man.local
> Put site‐local changes and customizations into this file.
>
> .\" Use narrower indentation on terminals and similar.
> .if n .nr IN 4n
> .\" Put only one space after the end of a sentence.
> .ss 12 0 \" See groff(7).
> .\" Keep pages narrow even on wide terminals.
> .if n .if \n[LL]>78n .nr LL 78n
> .\" Ensure hyperlinks are enabled for terminals.
> .nr U 1
>
> On multi‐user systems, it is more considerate to users whose
> preferences may differ from the administrator’s to be less
> aggressive with such settings, or to permit their override
> with a user‐specific man.local file. This can be achieved by
> placing one or both of following requests at the end of the
> site‐local file.
> .soquiet \V[XDG_CONFIG_HOME]/man.local
> .soquiet \V[HOME]/.man.local
> However, a security‐sandboxed man(1) program may lack
> permission to open such files.
Cc: Ingo Schwarze <schwarze@openbsd.org>
Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'man8')
-rw-r--r-- | man8/iconvconfig.8 | 2 | ||||
-rw-r--r-- | man8/intro.8 | 2 | ||||
-rw-r--r-- | man8/nscd.8 | 2 | ||||
-rw-r--r-- | man8/tzselect.8 | 2 | ||||
-rw-r--r-- | man8/zdump.8 | 2 | ||||
-rw-r--r-- | man8/zic.8 | 2 |
6 files changed, 6 insertions, 6 deletions
diff --git a/man8/iconvconfig.8 b/man8/iconvconfig.8 index d739eb75a..83cdfb253 100644 --- a/man8/iconvconfig.8 +++ b/man8/iconvconfig.8 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH ICONVCONFIG 8 (date) "Linux man-pages (unreleased)" +.TH iconvconfig 8 (date) "Linux man-pages (unreleased)" .SH NAME iconvconfig \- create iconv module configuration cache .SH SYNOPSIS diff --git a/man8/intro.8 b/man8/intro.8 index f479f9375..ad6509a91 100644 --- a/man8/intro.8 +++ b/man8/intro.8 @@ -7,7 +7,7 @@ .\" Modified Sat Jul 24 17:35:48 1993 by Rik Faith (faith@cs.unc.edu) .\" 2007-10-23 mtk: minor rewrites, and added paragraph on exit status .\" -.TH INTRO 8 (date) "Linux man-pages (unreleased)" +.TH intro 8 (date) "Linux man-pages (unreleased)" .SH NAME intro \- introduction to administration and privileged commands .SH DESCRIPTION diff --git a/man8/nscd.8 b/man8/nscd.8 index 193320d6b..557d35a4e 100644 --- a/man8/nscd.8 +++ b/man8/nscd.8 @@ -6,7 +6,7 @@ .\" 2008-12-05 Petr Baudis <pasky@suse.cz> .\" Rewrite the NOTES section to reflect modern reality .\" -.TH NSCD 8 (date) "Linux man-pages (unreleased)" +.TH nscd 8 (date) "Linux man-pages (unreleased)" .SH NAME nscd \- name service cache daemon .SH DESCRIPTION diff --git a/man8/tzselect.8 b/man8/tzselect.8 index c33323cc7..2319c6158 100644 --- a/man8/tzselect.8 +++ b/man8/tzselect.8 @@ -2,7 +2,7 @@ .\" This page is in the public domain .\" %%%LICENSE_END .\" -.TH TZSELECT 8 (date) "Linux man-pages (unreleased)" +.TH tzselect 8 (date) "Linux man-pages (unreleased)" .SH NAME tzselect \- select a timezone .SH SYNOPSIS diff --git a/man8/zdump.8 b/man8/zdump.8 index 81c6c64c8..abbead6ef 100644 --- a/man8/zdump.8 +++ b/man8/zdump.8 @@ -2,7 +2,7 @@ .\" This page is in the public domain .\" %%%LICENSE_END .\" -.TH ZDUMP 8 2020-04-27 "" "Linux System Administration" +.TH zdump 8 2020-04-27 "" "Linux System Administration" .SH NAME zdump \- timezone dumper .SH SYNOPSIS diff --git a/man8/zic.8 b/man8/zic.8 index d4720736a..79b06ae7c 100644 --- a/man8/zic.8 +++ b/man8/zic.8 @@ -2,7 +2,7 @@ .\" This page is in the public domain .\" %%%LICENSE_END .\" -.TH ZIC 8 2020-08-13 "" "Linux System Administration" +.TH zic 8 2020-08-13 "" "Linux System Administration" .SH NAME zic \- timezone compiler .SH SYNOPSIS |