History

Adrian Todorov a59409f16b add vendoring with go dep		2017-10-25 20:52:40 +00:00
..
Makefile	add vendoring with go dep	2017-10-25 20:52:40 +00:00
README.md	add vendoring with go dep	2017-10-25 20:52:40 +00:00
footer.txt	add vendoring with go dep	2017-10-25 20:52:40 +00:00
influx.txt	add vendoring with go dep	2017-10-25 20:52:40 +00:00
influx_inspect.txt	add vendoring with go dep	2017-10-25 20:52:40 +00:00
influx_stress.txt	add vendoring with go dep	2017-10-25 20:52:40 +00:00
influx_tsm.txt	add vendoring with go dep	2017-10-25 20:52:40 +00:00
influxd-backup.txt	add vendoring with go dep	2017-10-25 20:52:40 +00:00
influxd-config.txt	add vendoring with go dep	2017-10-25 20:52:40 +00:00
influxd-restore.txt	add vendoring with go dep	2017-10-25 20:52:40 +00:00
influxd-run.txt	add vendoring with go dep	2017-10-25 20:52:40 +00:00
influxd-version.txt	add vendoring with go dep	2017-10-25 20:52:40 +00:00
influxd.txt	add vendoring with go dep	2017-10-25 20:52:40 +00:00

README.md

Building the Man Pages

The man pages are created with asciidoc, docbook, and xmlto.

Debian/Ubuntu

This is the easiest since Debian and Ubuntu automatically install the dependencies correctly.

$ sudo apt-get install -y build-essential asciidoc xmlto

You should then be able to run make and the man pages will be produced.

Mac OS X

Mac OS X also has the tools necessary to build the docs, but one of the dependencies gets installed incorrectly and you need an environment variable to run it correctly.

Use Homebrew to install the dependencies. There might be other methods to get the dependencies, but that's left up to the reader if they want to use a different package manager.

If you have Homebrew installed, you should already have the Xcode tools and that should include make.

$ brew install asciidoc xmlto

Then set the following environment variable everytime you run make.

export XML_CATALOG_FILES=/usr/local/etc/xml/catalog