如何记录需要两个选项之一的命令行?

时间:2015-02-12 11:45:19

标签: command-line documentation

我熟悉如何指定可选和必需的命令行参数,例如:

MyApp <inputPath> [logging]

但是,如果用户必须准确指定两个(或更多)选项中的一个,例如,他们必须指定numRepetitions=<num-reps>stopTime=<stop-time>?如何以明确的方式记录这一点?

1 个答案:

答案 0 :(得分:2)

使用{}大括号。

{ Learn by [an | the | next [self-explanatory]] example }

通过下一个不言自明的例子学习:

=>prompt $Q$G

=>taskkill
ERROR: Invalid syntax. Neither /FI nor /PID nor /IM were specified.
Type "TASKKILL /?" for usage.

=>taskkill /?

TASKKILL [/S system [/U username [/P [password]]]]
         { [/FI filter] [/PID processid | /IM imagename] } [/T] [/F]

<强> Command-Line Syntax Key

  • Notation ​​ 说明
  • Text without brackets or braces​​您必须按所示键入的项目
  • <Text inside angle brackets> ​​您必须提供值的占位符
  • [Text inside square brackets] ​​可选项
  • {Text inside braces} ​​必填项目集;选择一个
  • Vertical bar (|) ​​互斥物品的分隔符;选择一个
  • Ellipsis (…) ​​可以重复的项目