<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
docbook-to-man $< > $@


The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.

-->

<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Michael</firstname>">
<!ENTITY dhsurname   "<surname>Fladischer</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate      "<date>9 September 2013</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection   "<manvolnum>1</manvolnum>">
<!ENTITY dhemail     "<email>FladischerMichael@fladi.at</email>">
<!ENTITY dhusername  "fladi">
<!ENTITY dhucpackage "<refentrytitle>PYXBGEN</refentrytitle>">
<!ENTITY dhpackage   "pyxbgen-py3">

<!ENTITY debian      "<productname>Debian</productname>">
<!ENTITY gnu         "<acronym>GNU</acronym>">
<!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
    <refentryinfo>
        <address>
            &dhemail;
        </address>
        <author>
            &dhfirstname;
            &dhsurname;
        </author>
        <copyright>
            <year>2013</year>
            <holder>&dhusername;</holder>
        </copyright>
        &dhdate;
    </refentryinfo>
    <refmeta>
        &dhucpackage;
        &dhsection;
    </refmeta>
    <refnamediv>
        <refname>&dhpackage;</refname>
        <refpurpose>Python XML Schema Bindings Generator (Python3 version)</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <cmdsynopsis>
            <command>&dhpackage;</command>
            <arg>command</arg>
            <arg><option>[options]</option></arg>
            <arg><option>[more schema locations...]</option></arg>
        </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
        <title>DESCRIPTION</title>
        <para>
            This manual page documents briefly the <command>&dhpackage;</command> command.
        </para>
        <para>
            This manual page was written for the &debian; distribution because the original program does not have a manual page.
        </para>
        <para>
            <command>&dhpackage;</command> is a program that generates Python bindings from XML schema files or WSDL input.
        </para>
    </refsect1>
    <refsect1>
        <title>Generic Options</title>
        <variablelist>
            <varlistentry>
                <term>
                    <option>--version</option>
                </term>
                <listitem>
                    <para>
                        Show program’s version number and exit.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>--help</option>
                </term>
                <listitem>
                    <para>
                        Show help message and exit.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1>
        <title>Identifying Schema</title>
        <para>Specify and locate schema for which bindings should be generated.</para>
        <variablelist>
            <varlistentry>
                <term>
                    <option>-u <replaceable class="parameter">FILE_or_URL</replaceable></option>
                    <option>--schema-location=<replaceable class="parameter">FILE_or_URL</replaceable></option>
                </term>
                <listitem>
                    <para>
                        Add the location of an entrypoint schema. The provided value should be a URL. If it does not have a URL scheme (e.g., http:), it is
                        assumed to be a file, and if it is not an absolute path is located relative to the schemaRoot.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>--schema-root=<replaceable class="parameter">DIRECTORY</replaceable></option>
                </term>
                <listitem>
                    <para>
                        The directory from which entrypoint schemas specified as relative file paths will be read.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>--schema-stripped-prefix=<replaceable class="parameter">TEXT</replaceable></option>
                </term>
                <listitem>
                    <para>
                        Optional string that is stripped from the beginning of schemaLocation values before loading from them. This applies only to the values
                        of schemaLocation attributes in import and include elements. Its purpose is to convert absolute schema locations into relative ones to
                        allow offline processing when all schema are available in a local directory. See schemaRoot.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>--location-prefix-rewrite=<replaceable class="parameter">TEXT</replaceable></option>
                </term>
                <listitem>
                    <para>
                        Add a rewrite entry for schema locations. Parameter values are strings of the form pfx=sub. The effect is that a schema location that
                        begins with pfx is rewritten so that it instead begins with sub.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>--uri-content-archive-directory=<replaceable class="parameter">DIRECTORY</replaceable></option>
                </term>
                <listitem>
                    <para>
                        The directory path into which any content retrieved by URI will be written. This serves as a local cache, and to give you an opportunity
                        to inspect material retrieved from some other system.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1>
        <title>Configuring Bindings</title>
        <para>
            Specify where generated bindings should be written, and how they will be accessed from Python.
        </para>
        <variablelist>
            <varlistentry>
                <term>
                    <option>-m <replaceable class="parameter">MODULE</replaceable></option>
                    <option>--module=<replaceable class="parameter">MODULE</replaceable></option>
                </term>
                <listitem>
                    <para>
                        Add a module name corresponding to an entrypoint schema. The namespace defined by the corresponding schema will be written to a binding
                        using the given module name, adjusted by modulePrefix.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>--module-prefix=<replaceable class="parameter">MODULE</replaceable></option>
                </term>
                <listitem>
                    <para>
                        The prefix for binding modules. The base name for the module holding a binding is taken from the moduleList, moduleMap, or an XMLNS
                        prefix associated with the namespace in a containing schema. This value, if present, is used as a prefix to allow a deeper module
                        hierarchy.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>--binding-root=<replaceable class="parameter">DIRECTORY</replaceable></option>
                </term>
                <listitem>
                    <para>
                        The directory path into which generated bindings will be written.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>--write-for-customization</option>
                </term>
                <listitem>
                    <para>
                        Indicates whether the binding Python code should be written into a sub-module for customization. If enabled, a module path.to.namespace
                        will be written to the file path/to/raw/namespace.py, so that the file path/to/namespace.py can import it and override behavior. This
                        option turns on the feature.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>--no-write-for-customization</option>
                </term>
                <listitem>
                    <para>
                        Indicates whether the binding Python code should be written into a sub- module for customization. If enabled, a module path.to.namespace
                        will be written to the file path/to/raw/namespace.py, so that the file path/to/namespace.py can import it and override behavior. This
                        option turns off the feature (default).
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1>
        <title>SEE ALSO</title>

        <para>pyxbdump-py3(1), pyxbwsdl-py3(1).</para>
    </refsect1>
    <refsect1>
        <title>AUTHOR</title>

        <para>This manual page was written by &dhusername; &dhemail; for
            the &debian; system (and may be used by others).  Permission is
            granted to copy, distribute and/or modify this document under
            the terms of the &gnu; General Public License, Version 2 any
            later version published by the Free Software Foundation.
        </para>
        <para>
            On Debian systems, the complete text of the GNU General Public
            License can be found in /usr/share/common-licenses/GPL.
        </para>

    </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
