History

Eric Heydrick 810c183963 Add a timezone component to the example backup command to make it RFC3339 compliant		2017-06-16 15:43:33 -07:00
..
Makefile	More man pages for the other tools we package	2016-09-15 08:35:05 -05:00
README.md	More man pages for the other tools we package	2016-09-15 08:35:05 -05:00
footer.txt	Initial work creating man pages	2016-07-22 10:34:40 -05:00
influx.txt	Initial work creating man pages	2016-07-22 10:34:40 -05:00
influx_inspect.txt	Merge pull request #7492 from influxdata/mr-influx_inspect-help-verify	2016-11-07 13:23:39 -08:00
influx_stress.txt	More man pages for the other tools we package	2016-09-15 08:35:05 -05:00
influx_tsm.txt	More man pages for the other tools we package	2016-09-15 08:35:05 -05:00
influxd-backup.txt	Add a timezone component to the example backup command to make it	2017-06-16 15:43:33 -07:00
influxd-config.txt	Initial work creating man pages	2016-07-22 10:34:40 -05:00
influxd-restore.txt	Initial work creating man pages	2016-07-22 10:34:40 -05:00
influxd-run.txt	Initial work creating man pages	2016-07-22 10:34:40 -05:00
influxd-version.txt	Initial work creating man pages	2016-07-22 10:34:40 -05:00
influxd.txt	Initial work creating man pages	2016-07-22 10:34:40 -05: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