描述消息中的命令语法

本节将显示用法语句中的命令语法。

  • 在用法语句中显示命令语法。 例如,rm 命令可能的用法语句为:
    Usage: rm [-firRe] [--] File ...
  • 在用法语句消息中,请将诸如 File DirectoryString 以及 Number 之类的单词的第一个字母大写。
  • 不要在命令行上缩写参数。 例如,可以更轻松地翻译 Num 拼写 as Number
  • 在用法语句消息中仅使用以下定界符:
    定界符 描述
    [] 括住可选参数。
    {} 括住多个参数,其中一个参数是必需的。
    | 分隔不可同时选择的参数。 例如, [a|b] 指示您可以选择 a b ,或者既不能选择 a 也不能选择 b ; 而 {a|b} 指示您必须选择 ab
    ... 跟在可在命令行上重复使用的参数后面。 请注意在该省略号前有一个空格。
    - 表示标准输入。
  • 不要为唯一可选的必需参数使用任何定界符。 例如:
    banner String
  • 在命令行上必须相互隔开的标志之间放置一个空格字符。 例如:
    unget [-n] [-rSID] [-s] {File|-}
  • 不要分开可在命令行上一起使用的标志。 例如:
    wc [-cwl] {File ...|-}
  • 如果标志在命令行上的顺序无关紧要,那么按照字母表顺序放置标志。 小写标志置于大写标志之前。 例如:
    get -aAijlmM
  • 使用最佳判断来确定用法语句消息应在何处断行。 下例显示了一条很长的用法语句消息:
    Usage: get [-e|-k] [-c Cutoff] [-i List] [-r SID] [-w String]
     [-x List] [-b] [-gmnpst] ...
    如有必要,在下一行续写这条用法信息。 例如:
    Usage: get [-e|-k] [-c Cutoff] [-i List] [-r SID] [-w String] 
               [-x List] [-b] [-gmnpst] [-l[p]] File ...