Back to files

Atox README

To install, run

python setup.py install

To install the atox script in a specific directory, such as /usr/local/bin, run

python setup.py install --install-scripts=/usr/local/bin

For help on various install options, run

python setup.py install --help

For general help on the distutils script, run

python setup.py --help

To uninstall atox, run

python setup.py uninstall

Note: The uninstall command is experimental (and not part of the standard distutils package). If you used the --install-scripts option you may have to remove the script manually.

To use Atox, run

atox -f format.xml input.txt > output.xml

where format.xml is an Atox format description.

See doc/atox.txt (or atox.html or atox.pdf) for more info. To recreate pdf and html versions of the documentation (you will need to have xmlproc installed for both, and pdflatex for the pdf version) run make in the doc directory.