짧은 옵션이나 긴 옵션을 강제로 적용하는 명령 호출을 어떻게 지정합니까?

짧은 옵션이나 긴 옵션을 강제로 적용하는 명령 호출을 어떻게 지정합니까?

필수 매개변수가 있는 /options가 필요한 도구에 대한 사양을 작성 중입니다 -f. 예를 들어 다음은 유효한 호출입니다.--fooBAR

tool -f BAR
tool --foo BAR

맨페이지나 기타 공식적으로 정의된 호출 섹션에서 이 구문을 어떻게 지정할 수 있습니까?

이는 다음 옵션이 필요하지 않음을 의미하며 이는 내 의도가 아닙니다.

tool [-f BAR | --foo BAR]

그러나 단순히 브래킷을 생략하는 것은 의미가 없습니다. 파이프가 실제 쉘 파이프로 오인될 수 있기 때문입니다.

POSIX긴 선택이 아닙니다, GNU 참조 자료도 찾을 수 없습니다.

답변1

tool -f BAR | --foo BARtool -f BAR나는 그것을 " 명령으로 파이프 출력"으로 해석하는 것이 일반적이라고 생각하지 않습니다 --foo BAR. 그래서 나는 단순히

tool -f BAR | --foo BAR

특히 호출이 더 복잡한 경우 더 명확하게 만들기 위해 추가 마크업을 사용할 수 있는 다른 가능성이 있습니다. 선택적 매개변수와 달리 []이들 중 어느 것도 다음과 같이 보편적으로 이해되지 않습니다.강요된 주장,예를 들어:

tool {-f BAR | --foo BAR}

또는

tool <-f BAR | --foo BAR>

그리고 심지어

tool (-f BAR | --foo BAR)

호출 사양을 잘못 읽는 사람이 없는지 확인하려면 복사하면 됩니다.

tool -f BAR
tool --foo BAR

이 다중 접근 방식을 사용하는 많은 매뉴얼 페이지와 프로그램 도움말을 볼 수 있지만 일반적으로 동등한 호출이 아닌 다른 호출에 사용됩니다.

관련 정보