Разметка mdoc(7) для накопления опций с аргументами
Есть ли "правильная" или "каноническая" разметка для команды (раздел 1), "накапливающей" параметр с аргументом? (или без в этом отношении)
опция накопления может быть дана несколько раз, и эффекты складываются: думаю, что GCC -I
или же -W
,
допустим, я документирую ssh (1). Я хочу SYNOPSIS
отдать это -v
а также -o
накапливаться, это обычно делается с помощью эллипсов:
ssh [-o option]... [-v]...
я хотел бы прикрепить многоточие к идиоматическому
.Op Fl o Ar option
самое близкое, что я могу получить, это
.Oo
. Fl o Ar option
.Oc Ns \&...
как стенография Op
кооптирует это.
что делают другие люди?
1 ответ
Я новичок в man-страницах, но кроме вашего обходного пути, самое близкое, что я могу получить:
.Op [ Fl o Ar option ] No ...
Однако это приводит к:
[[-o option ] ...]
Это не совсем канонично или не совсем то, на что вы надеетесь, но кажется однозначным. (См. http://docopt.org/ для других примеров того, как это можно выразить.)