OLD | NEW |
1 Parses raw command-line arguments into a set of options and values. | 1 Parses raw command-line arguments into a set of options and values. |
2 | 2 |
3 This library supports [GNU][] and [POSIX][] style options, and it works | 3 This library supports [GNU][] and [POSIX][] style options, and it works |
4 in both server-side and client-side apps. | 4 in both server-side and client-side apps. |
5 | 5 |
6 ## Defining options | 6 ## Defining options |
7 | 7 |
8 First create an [ArgParser][]: | 8 First create an [ArgParser][]: |
9 | 9 |
10 var parser = new ArgParser(); | 10 var parser = new ArgParser(); |
(...skipping 193 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
204 when you create your options. | 204 when you create your options. |
205 | 205 |
206 To define help text for an entire option, use the `help:` parameter: | 206 To define help text for an entire option, use the `help:` parameter: |
207 | 207 |
208 parser.addOption('mode', help: 'The compiler configuration', | 208 parser.addOption('mode', help: 'The compiler configuration', |
209 allowed: ['debug', 'release']); | 209 allowed: ['debug', 'release']); |
210 parser.addFlag('verbose', help: 'Show additional diagnostic info'); | 210 parser.addFlag('verbose', help: 'Show additional diagnostic info'); |
211 | 211 |
212 For non-flag options, you can also provide a help string for the parameter: | 212 For non-flag options, you can also provide a help string for the parameter: |
213 | 213 |
214 parser.addOption('out', help: 'The output path', helpValue: 'path', | 214 parser.addOption('out', help: 'The output path', valueHelp: 'path', |
215 allowed: ['debug', 'release']); | 215 allowed: ['debug', 'release']); |
216 | 216 |
217 For non-flag options, you can also provide detailed help for each expected value | 217 For non-flag options, you can also provide detailed help for each expected value |
218 by using the `allowedHelp:` parameter: | 218 by using the `allowedHelp:` parameter: |
219 | 219 |
220 parser.addOption('arch', help: 'The architecture to compile for', | 220 parser.addOption('arch', help: 'The architecture to compile for', |
221 allowedHelp: { | 221 allowedHelp: { |
222 'ia32': 'Intel x86', | 222 'ia32': 'Intel x86', |
223 'arm': 'ARM Holding 32-bit chip' | 223 'arm': 'ARM Holding 32-bit chip' |
224 }); | 224 }); |
(...skipping 16 matching lines...) Expand all Loading... |
241 [posix]: http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html
#tag_12_02 | 241 [posix]: http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html
#tag_12_02 |
242 [gnu]: http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfa
ces | 242 [gnu]: http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfa
ces |
243 [ArgParser]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/arg
s/args.ArgParser | 243 [ArgParser]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/arg
s/args.ArgParser |
244 [ArgResults]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/ar
gs/args.ArgResults | 244 [ArgResults]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/ar
gs/args.ArgResults |
245 [addOption]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/arg
s/args.ArgParser#id_addOption | 245 [addOption]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/arg
s/args.ArgParser#id_addOption |
246 [addFlag]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/args/
args.ArgParser#id_addFlag | 246 [addFlag]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/args/
args.ArgParser#id_addFlag |
247 [parse]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/args/ar
gs.ArgParser#id_parse | 247 [parse]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/args/ar
gs.ArgParser#id_parse |
248 [rest]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/args/arg
s.ArgResults#id_rest | 248 [rest]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/args/arg
s.ArgResults#id_rest |
249 [addCommand]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/ar
gs/args.ArgParser#id_addCommand | 249 [addCommand]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/ar
gs/args.ArgParser#id_addCommand |
250 [getUsage]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/args
/args.ArgParser#id_getUsage | 250 [getUsage]: https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/args
/args.ArgParser#id_getUsage |
OLD | NEW |