~ubuntu-branches/ubuntu/hardy/gengetopt/hardy

« back to all changes in this revision

Viewing changes to src/cmdline.ggo

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2008-01-29 14:55:40 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20080129145540-bkah1bl330gpelmh
Tags: 2.22-1ubuntu1
* Merge with Debian; remaining changes:
  - Fix build failures with g++-4.3.

Show diffs side-by-side

added added

removed removed

Lines of Context:
71
71
option  "arg-struct-name" a "name of generated args info struct" string typestr="name"  default="gengetopt_args_info"   optional
72
72
option  "file-name"     F "name of generated file"  string typestr="name"  default="cmdline"     optional
73
73
option  "output-dir"     - "output directory"  string typestr="path"  optional
 
74
        details="\nif this option is not specified, the \
 
75
files are generated in the current directory.\n"
74
76
option  "c-extension"   c "extension of c file" string typestr="ext" default="c" optional
75
77
option  "header-extension"   H "extension of header file" string typestr="ext" default="h" optional
76
78
option  "long-help"     l "long usage line in help" optional
 
79
        details="\nThe usage line will print all the options, e.g.,
 
80
 
 
81
sample1 -iINT|--int-opt=INT [-h|--help]\n"
77
82
option  "default-optional"     - "by default, an option is considered optional if not specified otherwise" optional
78
83
option  "unamed-opts"   u "accept options without names (e.g., file names)" string default="FILES" optional argoptional
79
84
 
91
96
option  "include-getopt" G "adds the code for getopt_long in the generated C file" optional
92
97
 
93
98
option  "no-handle-help"   n "do not handle --help|-h automatically" optional
 
99
        details="\nIf --no-handle-help is specified, the command line option \
 
100
--help|-h will not be handled automatically, so the programmer will be able \
 
101
to print some \
 
102
other information; then the function for printing the standard help \
 
103
output can be used; this function is called \
 
104
<parser-name>_print_help.\n\nNotice \
 
105
that, although the programmer can handle --help|-h manually, the \
 
106
parser will return after finding such option: the other command \
 
107
line options, if any, will be ignored.  In case you want to have full \
 
108
control on --help|-h, you should use --ho-help.\n"
 
109
        
 
110
option  "no-help"   - "do not add --help|-h automatically" optional
 
111
        details="\nWith this option you can disable the \
 
112
automatic addition of options --help|-h. The programmer \ 
 
113
will then be able to add this option in \
 
114
the input file and handle it as he sees fit.  Notice that \
 
115
--no-help will also disable the automatic options \
 
116
--detailed-help and --full-help.
 
117
 
 
118
The programmer can still \
 
119
define options with short character h as he wants, \
 
120
but he cannot define options help, unless he \
 
121
specifies --no-help \
 
122
(otherwise an error will be printed).\n"
 
123
 
94
124
option  "no-handle-version"  N  "do not handle --version|-V automatically" optional
 
125
option  "no-version"  -  "do not add --version|-V automatically" optional
 
126
        details="\nSee above the details about \
 
127
--no-handle-help and --no-help, respectively.\n"
 
128
 
95
129
option  "no-handle-error" e "do not exit on errors" optional
 
130
        details="\nWith this option, if the generated parser encounters an error \
 
131
(e.g., an unknown option) it does not make the main program exit; instead, the parser \
 
132
function returns a value different 0, and the main program can print a help message.\n"
 
133
 
96
134
option  "show-required"   - "in the output of help will specify which options are mandatory, \
97
135
by using the optional passed string" string default="(mandatory)" optional argoptional
98
136
 
100
138
option  "set-package" - "set the package name (override package defined in the .ggo file)" string optional
101
139
option  "set-version" - "set the version number (override version defined in the .ggo file)" string optional
102
140
option  "show-help" - "show the output of --help instead of generating code" optional
103
 
option  "show-full-help" - "show the output of --help (including hidden options) instead of generating code" optional
 
141
option  "show-full-help" - "show the output of --full-help (i.e., including hidden options) instead of generating code" optional
 
142
option  "show-detailed-help" - "show the output of --detailed-help (i.e., including details and hidden options) instead of generating code" optional
104
143
option  "show-version" - "show the output of --version instead of generating code" optional
105
144
 
106
145
text "\nPlease refer to the info manual for further explanations."