Re: Man page titles, identifers, capitalization, and hyphens therein

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Branden,

On Tue, Jan 14, 2025 at 09:52:14AM -0600, G. Branden Robinson wrote:
> Hi Alex,
> 
> Thanks for clarifying a couple of points.  I have...
> 
> ...counter-clarifications!  :P

:P

> > For consistency with "TH" (title heading?), I think I prefer "title".
> 
> Except in *roff(7), "titles" are the term given to headers and footers
> collectively; the content of these is precisely what the `TH` macro
> configures; and arguments beyond its first are just determinative of
> "title" content.

Hmmm, makes sense.

> > filename is the file name.
> 
> No disagreement here.  I would say that "filename" is an excellent C
> identifier, but it is not English.  Novice man page authors have a
> terrible habit of porting C identifiers into English prose as if they
> were the same language.  Possibly this practice arises from a feeling
> of greater confidence and a self-assessment of more experience
> expressing themselves in C than in English.

I have been tempted to do a reform, and change man-pages(7) to recommend
using file name and file system (etc.) instead of filename and
filesystem.  I find it inconsistent that it recommends filename but
recommends user space.  I would either use a neologism in all of them or
in none of them, but find the status quo arbitrary.

So far, I've had more important food in my plate, but at some point I
might take a fork and a knive and start with it.

> > > > if the name is something like UTF-8,
> > > 
> > > (by which you mean "uses code points outside the Basic Latin range")
> > 
> > Nope.  I meant UTF-8(7):
> 
> Oh, ha!  I'd have quoted it in that case -- use/mention distinction. ;-)

Thanks!  Indeed, I should have.


Have a lovely night!
Alex

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

Attachment: signature.asc
Description: PGP signature


[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux