[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
man pages: formatting of entries in "SEE ALSO" section
From: |
Bernhard Voelker |
Subject: |
man pages: formatting of entries in "SEE ALSO" section |
Date: |
Sat, 2 Jan 2021 02:03:55 +0100 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.6.0 |
Hi *
cat(1) and tac(1) use bold formatting for the entries in the "SEE ALSO"
section, while all other 'man/*.x' files use the regular font for that.
GIT_PAGER= git grep -A1 'SEE ALSO' -- 'man/*.x' | grep -F '\'
man/cat.x-\fBtac\fP(1)
man/tac.x-\fBrev\fP(1)
man-pages(7) is silent about what style to prefer.
Many other projects use '\fB...\fP' (or '.BR'/'.B').
For the coreutils, I think we should at least be consistent.
But which way? Bold or regular?
FWIW: in my opinion, tac(1) should reference cat(1) as well.
Have a nice day,
Berny
GIT_PAGER= g diff
diff --git a/man/cat.x b/man/cat.x
index b84600fbd..9eb38cf05 100644
--- a/man/cat.x
+++ b/man/cat.x
@@ -3,4 +3,4 @@ cat \- concatenate files and print on the standard output
[DESCRIPTION]
.\" Add any additional description here
[SEE ALSO]
-\fBtac\fP(1)
+tac(1)
diff --git a/man/tac.x b/man/tac.x
index 66bd338ec..677da2f82 100644
--- a/man/tac.x
+++ b/man/tac.x
@@ -3,4 +3,4 @@ tac \- concatenate and print files in reverse
[DESCRIPTION]
.\" Add any additional description here
[SEE ALSO]
-\fBrev\fP(1)
+cat(1), rev(1)
- man pages: formatting of entries in "SEE ALSO" section,
Bernhard Voelker <=