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

EXIT STATUS

195       One of the following exit values will be returned:
196
197       0  (EXIT_SUCCESS)
198              Successful program execution.
199
200       1  (EXIT_FAILURE)
201              The operation failed or the command syntax was not valid.
202
203       70  (EX_SOFTWARE)
204              libopts had an internal operational error.  Please report it to
205              autogen-users@lists.sourceforge.net.  Thank you.
206

AUTHORS

208       Bruce Korb
209
211       Copyright (C) 1992-2018 Bruce Korb all rights reserved.  This program
212       is released under the terms of the GNU General Public License, version
213       3 or later.
214

BUGS

216       Please send bug reports to: autogen-users@lists.sourceforge.net
217

NOTES

219       This manual page was AutoGen-erated from the xml2ag option definitions.
220
221
222
223GNU AutoGen (5.18.14)             31 Jul 2018                        xml2ag(1)
Impressum