명령 개요를 작성하기위한 표준이 있습니까?

모든 사람이 최종 사용자의 명령 사용법 을 설명 하는 시놉시스 를 작성하는 방법에 대한 자신의 아이디어를 가지고있는 것으로 보입니다 .

예를 들어,이 형식은 man grep다음 과 같습니다.

grep [OPTIONS] PATTERN [FILE...]
grep [OPTIONS] [-e PATTERN | -f FILE] [FILE...]

이제 다른 맨 페이지에 나타나는 구문이 있습니다. []옵션으로 인식되며 ...동일한 입력의 배수로 의미가 있습니다.

그러나 사람들 은 OR을 사용 |하거나 의미 /를 바꾸는 다른 사람들이 있습니다 []. 또는 그들은 어디로 [OPTIONS]가는지에 대한 표시를하지 않습니다 .

나는 내가 쓰는 것에 대한 표준을 따르고 싶지만, 내가 보는 모든 웹 사이트는 나에게 다른 것을 알려줍니다.

시놉시스를 작성 하는 실제 표준 방법이 있습니까?

command-line man

— 토 미스트
소스

하나를 고르세요.

— Kevin

어떤 이유로 든 도움이되지 않을 것이라고 생각합니다. 모든 사람은 자신의 표준을 가지고있을 것이며, 그에 대해서는 아무것도 할 수 없습니다.

— Tormyst

이것이 표준의 종류입니까? pubs.opengroup.org/onlinepubs/009695399/basedefs/…

— Mark Plotnick

예, 이것이 바로 내가 찾던 것입니다. 감사합니다.

— Tormyst

@MarkPlotnick-OP가 수락 할 수 있도록 A를 만들었습니다. 그것이 있다면 표준입니다. illuminÉ가 참조한 링크를 참조하십시오.

— slm

이에 대한 기본 표준은 POSIX, Utility Argument Syntax (업데이트 된 링크에 @ illuminÉ 덕분)입니다. 예를 들어 매뉴얼 페이지에서 사용되는 구문을 설명합니다.

utility_name[-a][-b][-c option_argument]
    [-d|-e][-f[option_argument]][operand...]

고전적이기 때문에 -W공급 업체가 권장하는 단일 문자 옵션 을 사용하는 것이 좋습니다. 이는 다중 문자 옵션을 수용하는 방법입니다 (예 : gcc 옵션 요약 참조 ).

GNU 소프트웨어는로 시작하는 다중 문자 옵션을 도입했습니다 --. 이러한 옵션으로 매뉴얼 페이지를 형식화하기위한 GNU의 일부 지침은 help2man 참조 에서 찾을 수 있습니다 .

— 마크 플로트 닉
소스