sandbox/docbook/test_files/opt_list.rst

   1 .. $Id$
   2
   3 Option lists are two-column lists of command-line options and descriptions, documenting a program's options. For example:
   4
   5 -a         Output all.
   6 -b         Output both (this description is
   7            quite long).
   8 -c arg     Output just arg.
   9 --long     Output all day long.
  10
  11 -p         This option has two paragraphs in the description.
  12            This is the first.
  13
  14            This is the second.  Blank lines may be omitted between
  15            options (as above) or left in (as here and below).
  16
  17 --very-long-option  A VMS-style option.  Note the adjustment for
  18                     the required two spaces.
  19
  20 --an-even-longer-option
  21            The description can also start on the next line.
  22
  23 -2, --two  This option has two variants.
  24
  25 -f FILE, --file=FILE  These two options are synonyms; both have
  26                       arguments.
  27
  28 /V         A VMS/DOS-style option.
  29
  30 There are several types of options recognized by reStructuredText:
  31