Re: Prefered manpage idioms?

2019-06-01 Thread Ingo Schwarze
Hi, while these technicalities do exist in POSIX, it is better if understanding a manual page does not require paying attentions to them. In my opinion, the idiom that is simplest too understand is just the .Ar foo argument and the .Fl x option and then it is usually obvious from the

Re: Prefered manpage idioms?

2019-05-30 Thread Marc Espie
On Thu, May 30, 2019 at 01:37:41PM -0600, Theo de Raadt wrote: > Jason McIntyre wrote: > > > i don;t think we can (or should) attempt to police this. > > Ouch, that typo really triggered my ADD, let's hope you don't make > similar errors in our manual pages. Yep, let's stick to seperate or

Re: Prefered manpage idioms?

2019-05-30 Thread Theo de Raadt
Jason McIntyre wrote: > i don;t think we can (or should) attempt to police this. Ouch, that typo really triggered my ADD, let's hope you don't make similar errors in our manual pages.

Re: Prefered manpage idioms?

2019-05-30 Thread Jason McIntyre
On Thu, May 30, 2019 at 09:09:58PM +0200, Marc Espie wrote: > On Thu, May 30, 2019 at 07:29:55PM +0100, Jason McIntyre wrote: > > i think any of man page, manual page, or manual is fine. > > > > > 2. Standard output > > > > > > Is it: > > > Print to standard output/error > > > tee(1) > > >

Re: Prefered manpage idioms?

2019-05-30 Thread Marc Espie
On Thu, May 30, 2019 at 07:29:55PM +0100, Jason McIntyre wrote: > i think any of man page, manual page, or manual is fine. > > > 2. Standard output > > > > Is it: > > Print to standard output/error > > tee(1) > > Print to the standard output/error > > cat(1), echo(1) > > Print to

Re: Prefered manpage idioms?

2019-05-30 Thread Jason McIntyre
On Thu, May 30, 2019 at 10:16:12PM +1000, Stephen Gregoratto wrote: > When I'm writing new manpages, I like to draw inspiration from the > documentation of similar programs. The problem is that many manpages > have different ways of saying the same thing, probably due to their > authors and time

Re: Prefered manpage idioms?

2019-05-30 Thread Andreas Kusalananda Kähäri
On Thu, May 30, 2019 at 10:16:12PM +1000, Stephen Gregoratto wrote: > When I'm writing new manpages, I like to draw inspiration from the > documentation of similar programs. The problem is that many manpages > have different ways of saying the same thing, probably due to their > authors and time