.de1 NOP
.  it 1 an-trap
.  if \\n[.$] \,\\$*\/
..
.ie t \
.ds B-Font [CB]
.ds I-Font [CI]
.ds R-Font [CR]
.el \
.ds B-Font B
.ds I-Font I
.ds R-Font R
.TH xml2ag 1 "2022-12-27" "GNU AutoGen (5.19.96)" "User Commands"
.\"
.\" DO NOT EDIT THIS FILE (in-mem file)
.\"
.\" It has been AutoGen-ed
.\" From the definitions ./xmlopts.def
.\" and the template file agman-cmd
.SH NAME
\f\*[B-Font]xml2ag\fP
\- XML to AutoGen Definiton Converter
.SH SYNOPSIS
\f\*[B-Font]xml2ag\fP
.\" Mixture of short (flag) options and long options
[\f\*[B-Font]\-flags\f[]]
[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]]
[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
[ <def-file> ]
.sp \n(Ppu
.ne 2

This program will convert any arbitrary XML file into equivalent
AutoGen definitions, and invoke AutoGen.
.SH "DESCRIPTION"
The template will be derived from either:
.br
*  the \fB--override-tpl\fP command line option
.br
*  a top level XML attribute named, "template"
.br
One or the other \fBmust\fP be provided, or the program will
exit with a failure message.
.sp 1
The \(lqbase-name\(rq for the output will similarly be either:
.br
*  the \fB--base-name\fP command line option
.br
*  the base name of the .xml file
.SH "OPTIONS"
.SS "All other options are derived from autogen"
.TP
.NOP \f\*[B-Font]\-O\f[] \f\*[I-Font]file\f[], \f\*[B-Font]\-\-output\f[]=\f\*[I-Font]file\f[]
Output file in lieu of AutoGen processing.
.sp
By default, the output is handed to an AutoGen for processing.
However, you may save the definitions to a file instead.
.SS "All other options"
These options are \fImostly\fP just passed through to \fBautogen\fP.
The one exception is \fB--override-tpl\fP which replaces the
default template in the output definitions.  It does not get passed
through on the command line.
.TP
.NOP \f\*[B-Font]\-L\f[] \f\*[I-Font]dir\f[], \f\*[B-Font]\-\-templ\-dirs\f[]=\f\*[I-Font]dir\f[]
Search for templates in \fIDIR\fP.
This option may appear an unlimited number of times.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-T\f[] \f\*[I-Font]tpl\-file\f[], \f\*[B-Font]\-\-override\-tpl\f[]=\f\*[I-Font]tpl\-file\f[]
Use \fITPL-FILE\fP for the template.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-\-definitions\f[]=\f\*[I-Font]file\f[]
Read definitions from \fIFILE\fP.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-\-shell\f[]=\f\*[I-Font]shell\f[]
name or path name of shell to use.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-m\f[], \f\*[B-Font]\-\-no\-fmemopen\f[]
Do not use in-mem streams.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-\-equate\f[]=\f\*[I-Font]char\-list\f[]
characters considered equivalent.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-b\f[] \f\*[I-Font]name\f[], \f\*[B-Font]\-\-base\-name\f[]=\f\*[I-Font]name\f[]
Specify \fBNAME\fP as the base name for output.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-\-source\-time\f[]
set mod times to latest source.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-\-writable\f[], \f\*[B-Font]\-\-not\-writable\f[]
Allow output files to be writable.
The \fInot\-writable\fP form will disable the option.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-\-loop\-limit\f[]=\f\*[I-Font]lim\f[]
Limit on increment loops.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]lim\f[]
is constrained to being:
.in +4
.nf
.na
exactly \-1, or
in the range  1 through 0x1000000
.fi
.in -4
The default
\f\*[I-Font]lim\f[]
for this option is:
.ti +4
 256
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-t\f[] \f\*[I-Font]seconds\f[], \f\*[B-Font]\-\-timeout\f[]=\f\*[I-Font]seconds\f[]
Limit server shell operations to \fBSECONDS\fP.
This option takes an integer number as its argument.
The value of
\f\*[I-Font]seconds\f[]
is constrained to being:
.in +4
.nf
.na
in the range  0 through 3600
.fi
.in -4
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-\-trace\f[]=\f\*[I-Font]level\f[]
tracing level of detail.
This option takes a keyword as its argument.  The argument sets an enumeration value that can
be tested by comparing them against the option value macro.
The available keywords are:
.in +4
.nf
.na
nothing       debug-message server-shell
templates     block-macros  expressions
everything
.fi
or their numeric equivalent.
.in -4
.sp
The default
\f\*[I-Font]level\f[]
for this option is:
.ti +4
 nothing
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-\-trace\-out\f[]=\f\*[I-Font]file\f[]
tracing output file or filter.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-\-show\-defs\f[]
Show the definition tree.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-\-used\-defines\f[]
Show the definitions used.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-C\f[], \f\*[B-Font]\-\-core\f[]
Leave a core dump on a failure exit.
.sp
Many systems default to a zero sized core limit.  If the system
has the sys/resource.h header and if this option is supplied,
then in the failure exit path, autogen will attempt to set the
soft core limit to whatever the hard core limit is.  If that
does not work, then an administrator must raise the hard core
size limit.
.TP
.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]suffix\f[], \f\*[B-Font]\-\-skip\-suffix\f[]=\f\*[I-Font]suffix\f[]
Skip the file with this \fISUFFIX\fP.
This option may appear an unlimited number of times.
This option must not appear in combination with any of the following options:
select-suffix.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-o\f[] \f\*[I-Font]suffix\f[], \f\*[B-Font]\-\-select\-suffix\f[]=\f\*[I-Font]suffix\f[]
specify this output suffix.
This option may appear an unlimited number of times.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-D\f[] \f\*[I-Font]value\f[], \f\*[B-Font]\-\-define\f[]=\f\*[I-Font]value\f[]
name to add to definition list.
This option may appear an unlimited number of times.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-U\f[] \f\*[I-Font]name\-pat\f[], \f\*[B-Font]\-\-undefine\f[]=\f\*[I-Font]name\-pat\f[]
definition list removal pattern.
This option may appear an unlimited number of times.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-M\f[] \f\*[I-Font]type\f[], \f\*[B-Font]\-\-make\-dep\f[] [\f\*[I-Font]type\f[]]
emit make dependency file.
This option may appear an unlimited number of times.
.sp
Pass-through AutoGen argument
.TP
.NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[]
Display usage information and exit.
.TP
.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
Pass the extended usage information through a pager.
.TP
.NOP \f\*[B-Font]\-v\f[] [{\f\*[I-Font]v|c|n\f[] \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}]}]
Output version of program and exit.  The default mode is `v', a simple
version.  The `c' mode will print copyright information and `n' will
print the full copyright notice.
.PP
.SH "EXIT STATUS"
One of the following exit values will be returned:
.TP
.NOP 0 " (EXIT_SUCCESS)"
Successful program execution.
.TP
.NOP 1 " (EXIT_FAILURE)"
The operation failed or the command syntax was not valid.
.TP
.NOP 70 " (EX_SOFTWARE)"
libopts had an internal operational error.  Please report
it to autogen-users@lists.sourceforge.net.  Thank you.
.PP
.SH "AUTHORS"
Bruce Korb
.SH "COPYRIGHT"
Copyright (C) 1992-2020 Bruce Korb all rights reserved.
This program is released under the terms of the GNU General Public License, version 3 or later.
.SH "BUGS"
Please send bug reports to: autogen-users@lists.sourceforge.net
.SH "NOTES"
This manual page was \fIAutoGen\fP-erated from the \fBxml2ag\fP
option definitions.