맨 페이지의 시놉시스 이해


27

명령 맨 페이지의 SYNOPSIS 섹션을 이해할 수 없었습니다. 예를 들어, 맨 페이지를 보자 man. 작성자 man man:

SYNOPSIS
       man  [-C  file]  [-d]  [-D]  [--warnings[=warnings]]  [-R encoding] [-L
       locale] [-m system[,...]] [-M path] [-S list]  [-e  extension]  [-i|-I]
       [--regex|--wildcard]   [--names-only]  [-a]  [-u]  [--no-subpages]  [-P
       pager] [-r prompt] [-7] [-E encoding] [--no-hyphenation] [--no-justifi‐
       cation]  [-p  string]  [-t]  [-T[device]]  [-H[browser]] [-X[dpi]] [-Z]
       [[section] page ...] ...
       man -k [apropos options] regexp ...
       man -K [-w|-W] [-S list] [-i|-I] [--regex] [section] term ...
       man -f [whatis options] page ...
       man -l [-C file] [-d] [-D] [--warnings[=warnings]]  [-R  encoding]  [-L
       locale]  [-P  pager]  [-r  prompt]  [-7] [-E encoding] [-p string] [-t]
       [-T[device]] [-H[browser]] [-X[dpi]] [-Z] file ...
       man -w|-W [-C file] [-d] [-D] page ...
       man -c [-C file] [-d] [-D] page ...
       man [-hV]
  1. SYNOPSIS 섹션은 명령 구문을 설명합니까?
  2. 그것들 [...][...]내부 [...] 는 무엇을 의미합니까? 그들은 선택적인 것을 의미합니까?
  3. |OR을 의미 합니까 ?
  4. 무엇을 ,의미 [-m system[,...]]합니까?
  5. SYNOPSIS 섹션은 정규식에 사용되는 규칙을 준수합니까?

관련 : POSIX 표준의 "유틸리티 규약": pubs.opengroup.org/onlinepubs/9699919799/basedefs/…
Kusalananda

답변:


25
  1. 시놉시스 섹션은 일반적으로 몇 가지 사용 사례를 제공합니다. 때때로 하위 명령에는 다른 옵션이 있으므로 몇 가지 예가 표시 될 수 있습니다.
  2. 대괄호는 []항상 선택적 스위치, 인수, 옵션 등을 나타냅니다.
  3. 예, 파이프 |는 특히 괄호 나 괄호 안에있을 때를 의미합니다.
  4. 대괄호 안의 대괄호는 두 번째 부분이 첫 번째 부분에 의존하고 선택 사항이기도합니다. 일부 스위치는 자체적으로 사용하거나 값을 추가 할 수 있습니다. 대괄호 시작시 쉼표는 여러 개의 쉼표로 구분 된 값이있을 수 있음을 나타냅니다.
  5. 그들은 Regex 개념에 의존하지만 사람이 읽을 수 있어야하므로 모든 탈출 규칙 등을 따르지 마십시오.

감사! 시놉시스의 구문을 설명하는 참고 자료가 있습니까?
Tim

@Tim : 제가 본 것 중에 가장 끔찍한 것 중 하나입니다. 몇 가지를 더 읽으면 문제가 해결 될 것입니다. 마법이 아니라 관습 일뿐입니다.
Caleb

9

참조를 원하면 EBNF 기반으로 느슨하게 참조 됩니다.


3

에서 man매뉴얼 페이지


다음 규칙은 SYNOPSIS 섹션에 적용되며 다른 섹션에서 가이드로 사용할 수 있습니다. 남자 시놉시스 설명

정확한 렌더링은 출력 장치에 따라 다를 수 있습니다. 예를 들어, man은 일반적으로 터미널에서 실행할 때 기울임 꼴을 렌더링 할 수 없으며 일반적으로 밑줄이나 컬러 텍스트를 사용합니다.

명령 또는 함수 그림은 가능한 모든 호출과 일치해야하는 패턴입니다. 경우에 따라이 매뉴얼 페이지의 SYNOPSIS 섹션에 표시된대로 몇 가지 독점 호출을 설명하는 것이 좋습니다.


3

명령 줄 유틸리티 인수 구문의 의미를 이해하는 또 다른 소스는 12 장에 설명 된 유틸리티 인수 구문 규칙 과 POSIX.1-2008 (2013 Edition) 표준의 9 장에 설명 된 정규 표현식 입니다.

당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.