File: lopsubgen.suite

package info (click to toggle)
liblopsub 1.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 284 kB
  • sloc: ansic: 2,558; lex: 775; makefile: 158; sh: 19
file content (118 lines) | stat: -rw-r--r-- 3,278 bytes parent folder | download | duplicates (3)
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# Copyright (C) 2016 Andre Noll <maan@tuebingen.mpg.de>
#
# Licensed under the GPL v3, see http://www.gnu.org/licenses/gpl-3.0.html

[suite lopsubgen]
[supercommand lopsubgen]
	[description]
		The lopsubgen command reads a lobsub suite from stdin and converts
		it to zero or more output formats. If no output format is specified,
		the input is only checked for syntactic correctness.

		The format of the input (the lopsub suite) is described in
		lopsub-suite(5).
	[/description]
	purpose = convert a lobsup suite into C or roff format
	[option ignored]
		summary = General options
		flag ignored
	[option help]
		short_opt = h
		summary = print help and exit (give twice for detailed help)
	[option version]
		short_opt = V
		summary = print version and exit
	[option output-dir]
		short_opt = o
		summary = where to write output file(s)
		arg_info = required_arg
		arg_type = string
		default_val = .
		typestr = dir
		[help]
			The default is to create all output files in the current working
			directory.
		[/help]
	[option gen-c]
		summary = generate C output
		arg_info = optional_arg
		arg_type = string
		typestr = path
		[help]
			This produces a C file containing the definition of a subsub suite
			structure.

			If <path> is absolute, the output is written to this path and the
			argument to --output-dir is ignnored. Otherwise, the output path
			is relative to the value of the --output-dir option.

			If the optional argument is not given, the output file name is
			derived from the suite name by appending the string ".lsg.c".
		[/help]
	[option gen-header]
		summary = generate a .h file
		arg_info = optional_arg
		arg_type = string
		typestr = path
		[help]
			The generated header file is intended to be included from the
			application. It defines handy C enums and preprocessor macros like
			the number of commands defined in the suite.

			The path for the generated header file is determined in the same way
			as for C output, see --gen-c.
		[/help]
	[option ignored]
		summary = Options for man output
		flag ignored
	[option gen-man]
		summary = generate the man page
		arg_info = optional_arg
		arg_type = string
		typestr = path
		[help]
			If this is not given, all subsequent options in this section are
			ignored.

			The path for the output file is determined in the same way as for C
			output, see --gen-c.
		[/help]
	[option version-string]
		summary = override version string
		arg_info = required_arg
		arg_type = string
		typestr = string
		[help]
			If this option is given, its argument is used as the version string
			while the value of the version-string directive of the suite is
			ignored. This is useful for applications which dynamically create
			the version string by running a command like git-describe.
		[/help]

[section copyright]

	Written by Andre Noll
	.br
	Copyright (C) 2016 Andre Noll
	.br
	License: GNU GPL version 3,
	.UR http://www.gnu.org/licenses/gpl-3.0.html
	.UE
	.br
	This is free software: you are free to change and redistribute it.
	.br
	There is NO WARRANTY, to the extent permitted by law.
	.br
	Report bugs to
	.MT <maan@tuebingen.mpg.de>
	Andre Noll
	.ME
[/section]

[section see also]
	lopsub-suite(5), lopsub(7)

	Homepage:
	.UR http://people.tuebingen.mpg.de/~maan/lopsub
	.UE
[/section]