NAME

       xml2rfc - format RFCs using XML markup

SYNOPSIS

       xml2rfc SOURCE [OPTIONS] ...

DESCRIPTION

       Example: xml2rfc draft.xml -o Draft-1.0 --text --html

OPTIONS

       -h, --help
              show this help message and exit

              Formats:

              Any  or  all  of  the  following  output  formats  may  be  specified.  The default is --text. The
              destination filename will be based  on  the  input  filename,  unless  an  argument  is  given  to
              --basename.

       --text outputs to a text file with proper page breaks

       --html outputs to an html file

       --nroff
              outputs to an nroff file

       --pdf  (unavailable due to missing external library)

       --raw  outputs to a text file, unpaginated

       --expand
              outputs to an XML file with all references expanded

       --v2v3 convert vocabulary version 2 XML to version 3

       --preptool
              run preptool on the input

       --info generate a JSON file with anchor to section lookup information

              Generic Options:

       -C, --clear-cache
              purge the cache and exit

       --debug
              Show debugging output

       --country-help
              show the recognized <country> strings

       --pdf-help
              show pdf generation requirements

       --pi-help
              show the names and default values of PIs

       -n, --no-dtd
              disable DTD validation step

       -N, --no-network
              don't use the network to resolve references

       -O, --no-org-info
              don't show author orgainzation info on page one (legacy only)

       -q, --quiet
              don't print anything

       -r, --remove-pis
              Remove XML processing instructions

       -u, --utf8
              generate utf8 output

       -v, --verbose
              print extra information

       -V, --version
              display the version number and exit

              Generic Options with Values:

       -b NAME, --basename=NAME
              specify the base name for output files

       -c CACHE, --cache=CACHE
              specify a primary cache directory to write to; default: try [ /var/cache/xml2rfc, ~/.cache/xml2rfc
              ]

       -d DTD, --dtd=DTD
              specify an alternate dtd file

       -D DATE, --date=DATE
              run as if the date is DATE (format: yyyy-mm-dd)

       -f FILE, --filename=FILE
              Deprecated.  The same as -o.

       -i INDENT, --indent=INDENT
              With some v3 formatters: Indentation to use when pretty-printing XML

       -o FILE, --out=FILE
              specify an explicit output filename

       -p PATH, --path=PATH
              specify the directory path for output files

       -s SILENCE, --silence=SILENCE
              Silence any warning beginning with the given string

              Generic Format Options:

       --v3   with --text and --html: use the v3 formatter, rather than the legacy one.

       --legacy
              with --text and --html: use the legacy text formatter, rather than the v3 one.

       --id-is-work-in-progress
              in references, refer to InternetDrafts as "Work in Progress".

              Text Format Options:

       --no-headers
              calculate page breaks, and emit form feeds and page top spacing, but omit headers and footers from
              the paginated format

       --legacy-list-symbols
              use the legacy list bullet symbols, rather than the new ones.

       --legacy-date-format
              use the legacy date format, rather than the new one.

       --no-legacy-date-format
              don't use the legacy date format.

       --list-symbols=4*CHAR
              use the characters given as list bullet symbols.

       --bom, --BOM
              Add a BOM (unicode byte order mark) to the start of text files

       -P, --no-pagination
              don't do pagination of v3 draft text format.  V3 RFC text output is never paginated.

              Html Format Options:

       --css=CSS
              Use the given CSS file instead of the builtin

       --external-css
              place css in external files

       --no-external-css
              place css in external files

       --external-js
              place js in external files

       --no-external-js
              place js in external files

       --rfc-base-url=RFC_BASE_URL
              Base URL for RFC links

       --id-base-url=ID_BASE_URL
              Base URL for Internet-Draft links

       --rfc-reference-base-url=RFC_REFERENCE_BASE_URL
              Base URL for RFC reference targets, replacing the target="..." value given in the reference entry

       --id-reference-base-url=ID_REFERENCE_BASE_URL
              Base URL for I-D reference targets

       --metadata-js-url=METADATA_JS_URL
              URL for the metadata script

              V2-V3 Converter Options:

       --add-xinclude
              replace  reference  elements  with RFC and Internet-Draft seriesInfo with the appropriate XInclude
              element

       --strict
              be strict about stripping some deprecated attributes

              Preptool Options:

       --accept-prepped
              accept already prepped input