File: help_output.texinfo

package info (click to toggle)
gengetopt 2.22.6+dfsg0-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 5,732 kB
  • sloc: cpp: 14,709; sh: 11,845; ansic: 8,030; makefile: 689; yacc: 514; lex: 171; sed: 3
file content (68 lines) | stat: -rw-r--r-- 3,685 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
gengetopt 

This program generates a C function that uses getopt_long function
to parse the command line options, validate them and fill a struct.

Usage: gengetopt [OPTIONS]...

  -h, --help                    Print help and exit
      --detailed-help           Print help, including all details and hidden
                                  options, and exit
  -V, --version                 Print version and exit

Main options:

  -i, --input=filename          input file (default std input)
  -f, --func-name=name          name of generated function
                                  (default=`cmdline_parser')
  -a, --arg-struct-name=name    name of generated args info struct
                                  (default=`gengetopt_args_info')
  -F, --file-name=name          name of generated file  (default=`cmdline')
      --output-dir=path         output directory
      --header-output-dir=path  header output directory
      --src-output-dir=path     source output directory
  -c, --c-extension=ext         extension of c file  (default=`c')
  -H, --header-extension=ext    extension of header file  (default=`h')
  -l, --long-help               long usage line in help
      --default-optional        by default, an option is considered optional if
                                  not specified otherwise
  -u, --unamed-opts[=STRING]    accept options without names (e.g., file names)
                                  (default=`FILES')

The parser generated is thought to be used to parse the command line arguments.
However, you can also generate parsers for configuration files, or strings that
contain the arguments to parse, by using the following two options.

  -C, --conf-parser             generate a config file parser
  -S, --string-parser           generate a string parser (the string contains
                                  the command line)

Additional options:
  -G, --include-getopt          adds the code for getopt_long in the generated
                                  C file
  -n, --no-handle-help          do not handle --help|-h automatically
      --no-help                 do not add --help|-h automatically
  -N, --no-handle-version       do not handle --version|-V automatically
      --no-version              do not add --version|-V automatically
  -e, --no-handle-error         do not exit on errors
      --show-required[=STRING]  in the output of help will specify which
                                  options are mandatory, by using the optional
                                  passed string  (default=`(mandatory)')
      --strict-hidden           completely hide hidden options
  -g, --gen-version             put gengetopt version in the generated file
                                  (default=on)
      --set-package=STRING      set the package name (override package defined
                                  in the .ggo file)
      --set-version=STRING      set the version number (override version
                                  defined in the .ggo file)
      --show-help               show the output of --help instead of generating
                                  code
      --show-full-help          show the output of --full-help (i.e., including
                                  hidden options) instead of generating code
      --show-detailed-help      show the output of --detailed-help (i.e.,
                                  including details and hidden options) instead
                                  of generating code
      --show-version            show the output of --version instead of
                                  generating code

Please refer to the info manual for further explanations.