Zsh Mailing List Archive
Messages sorted by:
Reverse Date,
Date,
Thread,
Author
Cross-reference format in man pages
- X-seq: zsh-workers 53815
- From: Jun T <takimoto-j@xxxxxxxxxxxxxxxxx>
- To: zsh-workers@xxxxxxx
- Subject: Cross-reference format in man pages
- Date: Fri, 4 Jul 2025 13:48:48 +0900
- Archived-at: <https://zsh.org/workers/53815>
- List-id: <zsh-workers.zsh.org>
In zsh man pages, there are some places where a SECTION in
another man page is referenced without the name of the
man page. For example, in zshmisc(1), under the description
of the "case" complex command, it just says:
See the section `Filename Generation'
but the section is in zshexpn(1).
I'm now trying to fix these, but while doing so, I also
noticed that section names can appear in a variety of
formats:
the section 'Filename Generation'
em(Filename Generation)
Filename Generation
the section FILENAME GENERATION
FILENAME GENERATION
Since section names in man pages are in bold ALLCAPS, I
will (try to) use
bf(FILENAME GENERATION)
when referring to the section names. Is this OK?
(I will define a new macro for this)
Also, in the current zsh man pages, the man page name, such
aszshexpn(2), is in italic (manref macro in zman.yo). But
it seems using bold is much more common, and I will modify
manref to use bold font. Is this also OK?
Messages sorted by:
Reverse Date,
Date,
Thread,
Author