--- catgirl.1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/catgirl.1 b/catgirl.1 index 8079445..9dbc6e9 100644 --- a/catgirl.1 +++ b/catgirl.1 @@ -82,7 +82,7 @@ The options are listed below following their corresponding flags. . .Pp -The arguments are as follows: +The options are as follows: .Bl -tag -width Ds .It Fl C Ar util | Cm copy No = Ar util Set the utility used by -- 2.32.0
Really? This is a stock phrase from mdoc(7), and who cares?
On Sun, Jul 04, 2021 at 09:09:45AM -0400, june wrote: > Really? This is a stock phrase from mdoc(7), and who cares? Seems pedantic but i care for the details -- feel free to ignore this. catgirl(1)'s DESCRIPTION talks about "options", so the use of "arguments" is rather inconsistent; you'll find almost all of OpenBSD's base manuals use "options" not "arguments" in that sentence. I think mdoc(7) is wrong, I just sent a patch for that as well, thanks.
On Sun, Jul 04, 2021 at 02:01:16PM +0000, Klemens Nanni wrote: > catgirl(1)'s DESCRIPTION talks about "options", so the use of > "arguments" is rather inconsistent; you'll find almost all of OpenBSD's > base manuals use "options" not "arguments" in that sentence. > > I think mdoc(7) is wrong, I just sent a patch for that as well, thanks. FWIW, I just committed a fix to mdoc(7) to not say arguments when it means options: DESCRIPTION ... It usually follows with a breakdown of the options (if documenting a command), such as: The options are as follows: .Bl -tag -width Ds .It Fl v Print verbose information. .El List the options in alphabetical order, uppercase before lowercase for each letter and with no regard to whether an option takes an argument. Put digits in ascending order before all letter options.
I ended up removing this sentence as redundant. The previous sentence, “The options are listed below following their corresponding flags,” already introduces them as options.