influxdb/man
Adam 938db68198
Update restore functionality to run in online mode, consume Enterprise backup files. (#9207)
* Live Restore + Enterprise data format compatability

* Extended ImportData to import all DB's if no db name given

* Added a new enterprise data test, and backup command now prints the backup file paths at conclusion

* Added whole-system backup test

* Update to use protobuf in all enterprise data cases

* Update to test to do cross-testing with enterprise version

* incremental enterprise backup format support
2018-01-10 13:59:18 -05: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
influx.txt Allow setting the node id in the influx cli program 2018-01-02 11:15:19 -06: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 Pulled in backup-relevant code for review (#9193) 2017-12-07 11:35:20 -05:00
influxd-config.txt
influxd-restore.txt Update restore functionality to run in online mode, consume Enterprise backup files. (#9207) 2018-01-10 13:59:18 -05:00
influxd-run.txt
influxd-version.txt
influxd.txt

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