Command line syntax format commonly used symbols of meaning

In describing the command-line parameter, including some format convention of writing, there are differences between the various systems. Using the following general format:

  Command <Required Parameter 1 | mandatory parameter 2> [-option {Required parameter 1 | mandatory parameter 2 | 3 mandatory parameters}] [optional ...] {(default parameters) | parameters |} Parameter

 

Command format commonly used in several symbols have the following meanings :

  Angle brackets <>: Required parameter should be replaced with the actual parameters required

  Braces {}: Required parameters used internally, included here allowed parameters

  Square brackets []: an optional parameter in the command to be necessary to choose

  Parentheses (): indicates the default value of the parameter, used only in {}

  Vertical line |: used to separate multiple parameters mutually exclusive, meaning "or" can only choose a use

  Ellipsis ...: any number of parameters

 

Description:

The difference between the angle brackets and braces to: select only braces recited mandatory parameter (or one), but the angle brackets according to the actual replacement mandatory parameters

Example 1:

  Command syntax: git help <name>

  Actual Use: git help config or git help branch or ... (name is replaced with the actual content)

Example Two:

  Command syntax: git stash {apply | pop}

  Actual use: git stash apply or git stash pop (only mandatory parameters apply or select a pop)

Guess you like

Origin www.cnblogs.com/uakora/p/11809501.html