1 # Copyright (C) 2016 Andre Noll <maan@tuebingen.mpg.de>
3 # Licensed under the GPL v3, see https://www.gnu.org/licenses/gpl-3.0.html
6 [supercommand lopsubgen]
8 The lopsubgen command reads a lobsub suite from stdin and converts
9 it to zero or more output formats. If no output format is specified,
10 the input is only checked for syntactic correctness.
12 The format of the input (the lopsub suite) is described in
15 purpose = convert a lobsup suite into C or roff format
17 summary = General options
21 summary = print help and exit (give twice for detailed help)
24 summary = print version and exit
27 summary = where to write output file(s)
28 arg_info = required_arg
33 The default is to create all output files in the current working
37 summary = generate C output
38 arg_info = optional_arg
42 This produces a C file containing the definition of a subsub suite
45 If <path> is absolute, the output is written to this path and the
46 argument to --output-dir is ignnored. Otherwise, the output path
47 is relative to the value of the --output-dir option.
49 If the optional argument is not given, the output file name is
50 derived from the suite name by appending the string ".lsg.c".
53 summary = generate a .h file
54 arg_info = optional_arg
58 The generated header file is intended to be included from the
59 application. It defines handy C enums and preprocessor macros like
60 the number of commands defined in the suite.
62 The path for the generated header file is determined in the same way
63 as for C output, see --gen-c.
66 summary = Options for man output
69 summary = generate the man page
70 arg_info = optional_arg
74 If this is not given, all subsequent options in this section are
77 The path for the output file is determined in the same way as for C
80 [option version-string]
81 summary = override version string
82 arg_info = required_arg
86 If this option is given, its argument is used as the version string
87 while the value of the version-string directive of the suite is
88 ignored. This is useful for applications which dynamically create
89 the version string by running a command like git-describe.
96 Copyright (C) 2016 Andre Noll
98 License: GNU GPL version 3,
99 .UR https://www.gnu.org/licenses/gpl-3.0.html
102 This is free software: you are free to change and redistribute it.
104 There is NO WARRANTY, to the extent permitted by law.
107 .MT <maan@tuebingen.mpg.de>
113 lopsub-suite(5), lopsub(7)
116 .UR https://people.tuebingen.mpg.de/maan/lopsub