Skip to content

Latest commit

 

History

History
20 lines (16 loc) · 454 Bytes

usage.sh.md

File metadata and controls

20 lines (16 loc) · 454 Bytes
Raw

usage

usage -- Shows a usage message.

usage shows a usage message based on a header comment. A header comment consists of consecutive comment lines. Comment lines starting with "#!" are ignored.

Usage

void sub::usage(string file) > output

Options

  • --format=text
    • Select one fromat from text/markdown/groff.
  • --title=true
    • Treat the first line as title.
  • --markdown_heading=''
    • Prepend a string to every heading.