Man page - xml2rfc(1)

Manual

XML2RFC(1) User Commands XML2RFC(1)

xml2rfc - format RFCs using XML markup

usage: xml2rfc [OPTIONS] SOURCE [OPTIONS]... Example: xml2rfc draft.xml -b draft-foo-19 --text --html

Input XML file to render to one or more of the available formats.

Some options to generate built-in documentation.
show a help message and exit
generate a documentation XML file ready for formatting
show paged text documentation
show the recognized <country> strings
show pdf generation requirements
directory to pull the doc.xml and doc.yaml templates from. The default is the "templates" directory of the xml2rfc package
show option values and from where they come
display the version number and exit
Warn use of bare Unicode in tags where bare use of Unicode should be closely inspected

One or more of the following output formats may be specified. The default is --text. The destination filename will be based on the input filename, unless --out=FILE or --basename=BASE is used.
outputs formatted text to file, with proper page breaks
outputs formatted HTML to file
outputs formatted nroff to file (only v2 input)
(unavailable due to missing external library)
outputs formatted text to file, unpaginated (only v2 input)
outputs XML to file with all references expanded
convert vocabulary version 2 XML to version 3
run preptool on the input
reduce prepped xml to unprepped
generate a JSON file with anchor to section lookup information

purge the cache and exit
Show debugging output
disable DTD validation step
don't use the network to resolve references
don't show author organization info on page one (legacy only)
don't print anything while working
ignore config file settings
Allow local file system references
Remove XML processing instructions
generate utf8 output
print extra information

specify the base name for output files
specify a primary cache directory to write to; default: try [ /var/cache/xml2rfc, ~/.cache/xml2rfc ]
specify a configuration file
specify an alternate dtd file
run as if the date is DATE (format: yyyy-mm-dd). Default: Today's date
Deprecated. The same as -o
With some v3 formatters: Indentation to use when pretty-printing XML
specify an explicit output filename
specify the directory path for output files
Silence any warning beginning with the given string

with --text and --html: use the v3 formatter, rather than the legacy one
with --text and --html: use the legacy output formatters, rather than the v3 ones
in references, refer to Internet-Drafts as "Work in Progress"

calculate page breaks, and emit form feeds and page top spacing, but omit headers and footers from the paginated format
use the legacy list bullet symbols, rather than the new ones
use the legacy date format, rather than the new one
don't use the legacy date format
use the characters given as list bullet symbols
Add a BOM (unicode byte order mark) to the start of text files
do pagination
don't do pagination of v3 draft text format
More easily do line breaks after hyphens in table cells to give a more compact table
The style of table borders to use for text output; one of full/light/minimal

Use the given CSS file instead of the builtin
place css in external files
place css in external files
place js in external files
place js in external files
Base URL for RFC links
Base URL for Internet-Draft links
Base URL for RFC reference targets, replacing the target="..." value given in the reference entry
Base URL for I-D reference targets
URL for the metadata script
Do not link to rfc-local.css

replace reference elements with RFC and Internet-Draft seriesInfo with the appropriate XInclude element
Reference explicit draft revisions when inserting XIncludes for draft references
be strict about stripping some deprecated attributes

accept already prepped input
August 2024 xml2rfc 3.23.0