Forma correcta de documentar opciones de longitud variable en páginas man

Forma correcta de documentar opciones de longitud variable en páginas man

A veces veo información de uso como

some_utility [arg [arg [...]]]

o

some_utility [arg[, arg[...]]]

eso indica que puedes pasar más de uno del mismo argumento.

yo tambien lo he visto asi

some_utility [args]

o

some_utility [arg][, arg][...]

¿Existe una forma estándar de hacer esto?

Respuesta1

No, noen realidad, pero la mayoría de las veces es bastante consistente. La mayoría de los manuales enumerarían argumentos opcionales con corchetes ( [foo]), obligatorios con corchetes angulares o sin corchetes ( <bar>, baz, este último a menudo subrayado).

Además, en casi todos los casos, si el número de argumentos es variable, tendrás algún tipo de lista (como mencionaste, [quux ...]o [quux[, quux[...]]]...), donde de manera similar [quuz]la mayoría de las veces denota exactamenteunoargumento. En casos raros, [quuz]también podría significar "uno o más argumentos", pero la mayoría de los manuales se ajustan a la elipsis de la forma de listado.

Es casi un estándar, pero definitivamente no se puede confiar en él. Pero en mi experiencia está bien en el 95% de los casos.

El punto es que hay cientos de proveedores de software de cualquier color, no sólo "grandes jugadores" sino que también hay software escrito por personas individuales que demostraron ser útiles. Todos ellos (con suerte) escriben sus páginas de manual de alguna manera individual... la mayoría de ellos saben lo suficiente como para cuidar las convenciones comunes, pero también hay algunos a quienes no les importa o tienen algún tipo de defecto mental con respecto al gusto de estilo, etc.; )

información relacionada