Return to MANPAGE.md CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / cmdline-opts

Annotation of embedaddon/curl/docs/cmdline-opts/MANPAGE.md, revision 1.1.1.1

1.1       misho       1: # curl man page generator
                      2: 
                      3: This is the curl man page generator. It generates a single nroff man page
                      4: output from the set of sources files in this directory.
                      5: 
                      6: There is one source file for each supported command line option. The format is
                      7: described below.
                      8: 
                      9: ## Option files
                     10: 
                     11: Each command line option is described in a file named `<long name>.d`, where
                     12: option name is written without any prefixing dashes. Like the file name for
                     13: the -v, --verbose option is named `verbose.d`.
                     14: 
                     15: Each file has a set of meta-data and a body of text.
                     16: 
                     17: ### Meta-data
                     18: 
                     19:     Short: (single letter, without dash)
                     20:     Long: (long form name, without dashes)
                     21:     Arg: (the argument the option takes)
                     22:     Magic: (description of "magic" options)
                     23:     Tags: (space separated list)
                     24:     Protocols: (space separated list for which protocols this option works)
                     25:     Added: (version number in which this was added)
                     26:     Mutexed: (space separated list of options this overrides, no dashes)
                     27:     Requires: (space separated list of features this requires, no dashes)
                     28:     See-also: (space separated list of related options, no dashes)
                     29:     Help: (short text for the --help output for this option)
                     30:     --- (end of meta-data)
                     31: 
                     32: ### Body
                     33: 
                     34: The body of the description. Only refer to options with their long form option
                     35: version, like --verbose. The output generator will replace such with the
                     36: correct markup that shows both short and long version.
                     37: 
                     38: ## Header
                     39: 
                     40: `page-header` is the nroff formatted file that will be output before the
                     41: generated options output for the master man page.
                     42: 
                     43: ## Generate
                     44: 
                     45: `./gen.pl mainpage`
                     46: 
                     47: This command outputs a single huge nroff file, meant to become `curl.1`. The
                     48: full curl man page.
                     49: 
                     50: `./gen.pl listhelp`
                     51: 
                     52: Generates a full `curl --help` output for all known command line options.