Skip to content

Instantly share code, notes, and snippets.

@rmg

rmg/usage.md

Last active August 29, 2015 14:08
Show Gist options
  • Save rmg/e7f7513396c62997c5ef to your computer and use it in GitHub Desktop.
Save rmg/e7f7513396c62997c5ef to your computer and use it in GitHub Desktop.
Download ZIP
CLI usage conventions
Raw
usage.md

CLI usage is documented using the following conventions:

  • required parameters are indicated with angle brackets or all-caps:
    • ping <hostname>
    • ping HOSTNAME
  • optional parameters are indicated with square brackets:
    • mkdir [-p] <dirname>
  • repeated items are indicated with elipses:
    • cp <source1> [source2...] <dest>
  • mutually exclusive options are indicated with a vertical bar:
    • netstat {-t|-u}

Inspiration:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment