Installation
System Install
To install a system-wide version of xml2rfc, simply run:
$ python setup.py install
User Install
If you want to perform a local installation for a specific user, you have a couple of options. You may use python’s default location of user site-packages by specifying the flag --user. These locations are:
UNIX: $HOME/.local/lib/python<ver>/site-packages
OSX: $HOME/Library/Python/<ver>/lib/python/site-packages
Windows: %APPDATA%/Python/Python<ver>/site-packages
You can additionally combine the flag --install-scripts with --user to specify a directory on your PATH to install the xml2rfc executable to. For example, the following command:
$ python setup.py install --user --install-scripts=$HOME/bin
will install the xml2rfc library and data to your local site-packages directory, and an executable python script xml2rfc to $HOME/bin.
Custom Install
The option --prefix allows you to specify the base path for all installation files. The setup.py script will exit with an error if your PYTHONPATH is not correctly configured to contain the library path the script tries to install to.
The command is used as follows:
$ python setup.py install --prefix=<path>
For further fine-tuning of the installation behavior, you can get a list of all available options by running:
$ python setup.py install --help
Usage
xml2rfc accepts a single XML document as input and outputs to one or more conversion formats.
Basic Usage: xml2rfc SOURCE [options] FORMATS...
- Options
The following parameters affect how xml2rfc behaves, however none are required.
Short
Long
Description
-h
--help
show the help message and exit
-v
--verbose
print extra information
-q
--quiet
dont print anything
-c
--cache
specify an alternate cache directory to write to
-n
--no-dtd
disable DTD validation step
-d DTD
--dtd=DTD
specify an alternate dtd file
-b BASENAME
--basename=BASENAME
specify the base name for output files
-f FILENAME
--filename=FILENAME
specify an output filename
(none)
--clear-cache
purge the cache and exit
(none)
--version
display the version number and exit
- Formats
At least one but as many as all of the following output formats must be specified. The destination file will be created according to the argument given to –filename. If no argument was given, it will create the file(s) “output.format”. If no format is specified, xml2rfc will default to paginated text (--text).
Command
Description
--raw
outputs to a text file, unpaginated
--text
outputs to a text file with proper page breaks
--nroff
outputs to an nroff file
--html
outputs to an html file
--exp
outputs to an XML file with all references expanded
- Examples
- xml2rfc draft.xmlxml2rfc draft.xml --dtd=alt.dtd --basename=draft-1.0 --text --nroff --html
Dependencies
xml2rfc depends on the following packages:
lxml (>= 2.2.8)
Metadata
Release files for xml2rfc 2.3.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| xml2rfc-2.3.3.tar.gz | 104.2 kB | Details |
Release files / xml2rfc-2.3.3.tar.gz
| Download URL | xml2rfc-2.3.3.tar.gz |
|---|---|
| Size | 104.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f93aa21b3a3d7c0b66280e5880d354e47f83fb0861eac9ddf12cb2db8821db23
|
|
BLAKE2b-256 checksum How to use checksums |
3c66e739dc1a6ce12e2496560876af6b7fe1d74db13272b87222ae34d6bfb498
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
