1xml2ag(1)                        User Commands                       xml2ag(1)
2
3
4

NAME

6       xml2ag - XML to AutoGen Definiton Converter
7

SYNOPSIS

9       xml2ag  [-flags]  [-flag  [value]]  [--option-name[[=| ]value]] [ <def-
10       file> ]
11
12       This program will convert any arbitrary XML file into equivalent  Auto‐
13       Gen definitions, and invoke AutoGen.
14

DESCRIPTION

16       The template will be derived from either:
17       *  the --override-tpl command line option
18       *  a top level XML attribute named, "template"
19       One  or  the  other  must  be provided, or the program will exit with a
20       failure message.
21
22       The “base-name” for the output will similarly be either:
23       *  the --base-name command line option
24       *  the base name of the .xml file
25

OPTIONS

27   All other options are derived from autogen
28       -O file, --output=file
29              Output file in lieu of AutoGen processing.
30
31              By default, the output is handed to an AutoGen  for  processing.
32              However, you may save the definitions to a file instead.
33
34   All other options
35       These options are mostly just passed throug to autogen.  The one excep‐
36       tion is --override-tpl which replaces the default template in the  out‐
37       put definitions.  It does not get passed through on the command line.
38
39       -L dir, --templ-dirs=dir
40              Search  for  templates in DIR.  This option may appear an unlim‐
41              ited number of times.
42
43              Pass-through AutoGen argument
44
45       -T tpl-file, --override-tpl=tpl-file
46              Use TPL-FILE for the template.
47
48              Pass-through AutoGen argument
49
50       --definitions=file
51              Read definitions from FILE.
52
53              Pass-through AutoGen argument
54
55       --shell=shell
56              name or path name of shell to use.
57
58              Pass-through AutoGen argument
59
60       -m, --no-fmemopen
61              Do not use in-mem streams.
62
63              Pass-through AutoGen argument
64
65       --equate=char-list
66              characters considered equivalent.
67
68              Pass-through AutoGen argument
69
70       -b name, --base-name=name
71              Specify NAME as the base name for output.
72
73              Pass-through AutoGen argument
74
75       --source-time
76              set mod times to latest source.
77
78              Pass-through AutoGen argument
79
80       --writable, --not-writable
81              Allow output files to be writable.  The not-writable  form  will
82              disable the option.
83
84              Pass-through AutoGen argument
85
86       --loop-limit=lim
87              Limit  on  increment loops.  This option takes an integer number
88              as its argument.  The value of lim is constrained to being:
89                  exactly -1, or
90                  in the range  1 through 0x1000000
91              The default lim for this option is:
92                   256
93
94              Pass-through AutoGen argument
95
96       -t seconds, --timeout=seconds
97              Limit server shell operations to SECONDS.  This option takes an
98              integer number as its argument.  The value of seconds is con‐
99              strained to being:
100                  in the range  0 through 3600
101
102              Pass-through AutoGen argument
103
104       --trace=level
105              tracing level of detail.  This option takes a keyword as its
106              argument.  The argument sets an enumeration value that can be
107              tested by comparing them against the option value macro.  The
108              available keywords are:
109                  nothing       debug-message server-shell
110                  templates     block-macros  expressions
111                  everything
112                  or their numeric equivalent.
113
114              The default level for this option is:
115                   nothing
116
117              Pass-through AutoGen argument
118
119       --trace-out=file
120              tracing output file or filter.
121
122              Pass-through AutoGen argument
123
124       --show-defs
125              Show the definition tree.
126
127              Pass-through AutoGen argument
128
129       --used-defines
130              Show the definitions used.
131
132              Pass-through AutoGen argument
133
134       -C, --core
135              Leave a core dump on a failure exit.
136
137              Many systems default to a zero sized core limit.  If the system
138              has the sys/resource.h header and if this option is supplied,
139              then in the failure exit path, autogen will attempt to set the
140              soft core limit to whatever the hard core limit is.  If that
141              does not work, then an administrator must raise the hard core
142              size limit.
143
144       -s suffix, --skip-suffix=suffix
145              Skip the file with this SUFFIX.  This option may appear an
146              unlimited number of times.  This option must not appear in com‐
147              bination with any of the following options: select-suffix.
148
149              Pass-through AutoGen argument
150
151       -o suffix, --select-suffix=suffix
152              specify this output suffix.  This option may appear an unlimited
153              number of times.
154
155              Pass-through AutoGen argument
156
157       -D value, --define=value
158              name to add to definition list.  This option may appear an
159              unlimited number of times.
160
161              Pass-through AutoGen argument
162
163       -U name-pat, --undefine=name-pat
164              definition list removal pattern.  This option may appear an
165              unlimited number of times.
166
167              Pass-through AutoGen argument
168
169       -M type, --make-dep [type]
170              emit make dependency file.  This option may appear an unlimited
171              number of times.
172
173              Pass-through AutoGen argument
174
175       -?, --help
176              Display usage information and exit.
177
178       -!, --more-help
179              Pass the extended usage information through a pager.
180
181       -v [{v|c|n --version [{v|c|n}]}]
182              Output version of program and exit.  The default mode is `v', a
183              simple version.  The `c' mode will print copyright information
184              and `n' will print the full copyright notice.
185

EXIT STATUS

187       One of the following exit values will be returned:
188
189       0  (EXIT_SUCCESS)
190              Successful program execution.
191
192       1  (EXIT_FAILURE)
193              The operation failed or the command syntax was not valid.
194
195       70  (EX_SOFTWARE)
196              libopts had an internal operational error.  Please report it to
197              autogen-users@lists.sourceforge.net.  Thank you.
198

AUTHORS

200       Bruce Korb
201
203       Copyright (C) 1992-2018 Bruce Korb all rights reserved.  This program
204       is released under the terms of the GNU General Public License, version
205       3 or later.
206

BUGS

208       Please send bug reports to: autogen-users@lists.sourceforge.net
209

NOTES

211       This manual page was AutoGen-erated from the xml2ag option definitions.
212
213
214
215GNU AutoGen (5.18.16)             28 Jan 2020                        xml2ag(1)
Impressum