Re: Prefered manpage idioms?

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 period they were written in.
>
> So, I'd like to ask what your preferred choice is of the following
> common idioms I keep finding:
>

hi.

> 1. Manpage
>
> Is it:
> man page
> man-page
> manpage
> reference
> manual
> UNIX??? Programmers Manual
> ...on second thought, maybe not
>

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 stdout/stderr
> bzcat(1)
>

these are all fine, i think.

> Bonus Round:
> Print to ...
> Write to ...
> Print on ...
> readlink(1)
>
> 3. Program arguments
>
> Is it:
> Argument
> echo(1)
> Operand
> printf(1), also echo(1)?

also fine.

i think we just have to accept that there's more than one way to write
things. we try to keep things consistent where it makes sense, but i
think we need to allow for some variation too.

jmc