Zsh Mailing List Archive Messages sorted by: Reverse Date, Date, Thread, Author

Re: Cross-reference format in man pages

X-seq: zsh-workers 53816
From: Peter Stephenson <p.w.stephenson@xxxxxxxxxxxx>
To: zsh-workers@xxxxxxx
Subject: Re: Cross-reference format in man pages
Date: Fri, 4 Jul 2025 10:08:06 +0100 (BST)
Archived-at: <https://zsh.org/workers/53816>
Feedback-id: 20250704-p.w.stephenson@xxxxxxxxxxxx:oxsmtp-prd-nl-vmo:Authrelay:p.w.stephenson@xxxxxxxxxxxx
Importance: Normal
In-reply-to: <CAE1FF68-40A0-46E0-AED1-E1FB62A57D72@kba.biglobe.ne.jp>
List-id: <zsh-workers.zsh.org>
References: <CAE1FF68-40A0-46E0-AED1-E1FB62A57D72@kba.biglobe.ne.jp>

> On 04/07/2025 05:48 BST Jun T <takimoto-j@xxxxxxxxxxxxxxxxx> wrote:
> 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?

Thanks, I think any improvement in consistency is a good thing, and if
you're turning these into specific macros it's easy to change the output
anyway, so I think you can just go ahead for now even if people do come
up with further suggestions.

cheers
pws

References:
- Cross-reference format in man pages
  - From: Jun T

Messages sorted by: Reverse Date, Date, Thread, Author