Is there a “standard” format for command line/shell help text?

Question

If not, is there a de facto standard? Basically I\'m writing a command line help text like so:

usage: app_name [opti         


        

Answer 1

I think there is no standard syntax for command line usage, but most use this convention:

Microsoft Command-Line Syntax, IBM has similar Command-Line Syntax

---

• Text without brackets or braces

  Items you must type as shown
  
  

• Placeholder for which you must supply a value
  
  

• [Text inside square brackets]

  Optional items
  
  

• {Text inside braces}

  Set of required items; choose one
  
  

• Vertical bar {a|b}

  Separator for mutually exclusive items; choose one
  
  

• Ellipsis …

  Items that can be repeated