사용방법 메시지
Usage message | 이 기사는 독자들에게 혼란스럽거나 불분명할 수 있다.(2008년 4월 (이를에 대해 합니다) |
컴퓨터 프로그래밍에서 사용 메시지 또는 도움말 메시지는 실행을 위해 명령줄 인터페이스를 사용하는 프로그램에 의해 표시되는 간단한 메시지를 말합니다.이 메시지는 보통 프로그램의 올바른 명령줄 사용으로 구성되며 해당 프로그램에서 허용되는 올바른 명령줄 인수 또는 옵션 목록이 포함됩니다.
사용 메시지는 프로그램이 사용자에게 올바른 명령어 구문을 알리기 위한 빠른 방법으로 사용되며 적절한 오류 메시지나 man 페이지 등의 상세 문서 대신 사용할 수 없습니다.
양식
Unix 와 같은 플랫폼에서는, 통상은 같은 일반적인 패턴을 따릅니다.
- 명령어인 "Usage:"로 시작하여 인수 목록이 이어지는 경우가 많습니다.
- 옵션의 인수를 나타내려면 일반적으로 각 괄호를 사용합니다.또, 함께 지정할 필요가 있는 파라미터를 그룹화하기 위해서도 사용할 수 있습니다.
- 필요한 인수를 나타내기 위해 대괄호와 동일한 그룹화 규칙에 따라 각 괄호가 일반적으로 사용됩니다.
- 배타적 파라미터는 그룹 내에서 수직 막대로 구분하여 표시할 수 있습니다.
예
NetBSD 소스 코드 스타일가이드에 근거한 예를 다음에 나타냅니다.
사용방법: 프로그램 [-aDe][-f -g][-n number][-b b_arg - c c_arg] req1 req2 [opt1 [opt2]이것은, 「프로그램」이 다음과 같이 호출되는 것을 나타냅니다.
- 옵션: a, D, d, e(모두 생략할 수 있습니다.이 경우 일부 파라미터는 대소문자를 구분합니다.
- 전용 옵션: f, g(수직 막대로 표시)
- 오퍼랜드를 사용한 옵션: n
- 오퍼랜드를 사용한 배타적 옵션: b, c
- 필수 인수: req1, req2
- 옵션 인수 opt1 - opt2의 유무에 관계없이 사용할 수 있습니다(다른 대괄호 세트를 사용하여 그룹 내에서 옵션 마크가 붙어 있습니다).
- 옵션 인수 opt2(opt1이 필요)
실행
셸 스크립트로 사용 현황문을 인쇄하려면 다음과 같이 쓸 수 있습니다.
대소문자 "$120"...h) printf '사용방법: %s parameter1 parameter2 ...\n' "$(기본명 "$0")" 종료 0; ... esac안티패턴
사용현황 스테이트먼트는 오류 메시지가 아니지만 유용한 오류 메시지가 인쇄되지 않도록 하기 위해 자주 사용됩니다.때 특별히 사용자(via—help, 또는 -h, 또는-?가 비슷한 깃발이나 논쟁)가 협조 요청 시 사용 내역만과 표준 출력에 써져야 한다;[1][2] 찍혀 있어야 합니다 만약 사용자가 제대로 된 명령줄 프로그램은 정확한 오류를 설명하는 간결한 오류 메시지 인쇄할 것이다 부정확한 명령줄에 들어갔다. 만든사용자가 사용 명세서를 인쇄하여 사용자에게 무엇이 실수인지 알아내도록 요구하는 대신 사용자가 직접 조작합니다.예를 들어 사용자가 올바른 수의 인수를 전달하지 못한 경우 인수가 누락되었음을 나타내는 단일 행이 일반적인 사용법을 제공하는 여러 페이지의 출력보다 훨씬 유용합니다.
