build: Support DESTDIR.
[lopsub.git] / lopsubgen.suite
1 # Copyright (C) 2016 Andre Noll <maan@tuebingen.mpg.de>
2 #
3 # Licensed under the GPL v3, see http://www.gnu.org/licenses/gpl-3.0.html
4
5 [suite lopsubgen]
6 [supercommand lopsubgen]
7 [description]
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.
11
12 The format of the input (the lopsub suite) is described in
13 lopsub-suite(5).
14 [/description]
15 purpose = convert a lobsup suite into C or roff format
16 [option ignored]
17 summary = General options
18 flag ignored
19 [option help]
20 short_opt = h
21 summary = print help and exit (give twice for detailed help)
22 [option version]
23 short_opt = V
24 summary = print version and exit
25 [option output-dir]
26 short_opt = o
27 summary = where to write output file(s)
28 arg_info = required_arg
29 arg_type = string
30 default_val = .
31 typestr = dir
32 [help]
33 The default is to create all output files in the current working
34 directory.
35 [/help]
36 [option gen-c]
37 summary = generate C output
38 arg_info = optional_arg
39 arg_type = string
40 typestr = path
41 [help]
42 This produces a C file containing the definition of a subsub suite
43 structure.
44
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.
48
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".
51 [/help]
52 [option gen-header]
53 summary = generate a .h file
54 arg_info = optional_arg
55 arg_type = string
56 typestr = path
57 [help]
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.
61
62 The path for the generated header file is determined in the same way
63 as for C output, see --gen-c.
64 [/help]
65 [option ignored]
66 summary = Options for man output
67 flag ignored
68 [option gen-man]
69 summary = generate the man page
70 arg_info = optional_arg
71 arg_type = string
72 typestr = path
73 [help]
74 If this is not given, all subsequent options in this section are
75 ignored.
76
77 The path for the output file is determined in the same way as for C
78 output, see --gen-c.
79 [/help]
80 [option version-string]
81 summary = override version string
82 arg_info = required_arg
83 arg_type = string
84 typestr = string
85 [help]
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.
90 [/help]
91
92 [section copyright]
93
94 Written by Andre Noll
95 .br
96 Copyright (C) 2016 Andre Noll
97 .br
98 License: GNU GPL version 3,
99 .UR http://www.gnu.org/licenses/gpl-3.0.html
100 .UE
101 .br
102 This is free software: you are free to change and redistribute it.
103 .br
104 There is NO WARRANTY, to the extent permitted by law.
105 .br
106 Report bugs to
107 .MT <maan@tuebingen.mpg.de>
108 Andre Noll
109 .ME
110 [/section]
111
112 [section see also]
113 lopsub-suite(5), lopsub(7)
114
115 Homepage:
116 .UR http://people.tuebingen.mpg.de/~maan/lopsub
117 .UE
118 [/section]