Influxdata
/
influxdb
mirror of https://github.com/influxdata/influxdb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
influxdb/man
History
Sam Arnold 23c3d35aab
chore: update protobuf library versions and remove influx_tsm (#21882) 
* chore: update protobufs

* fix: run codegen during build

* fix: fully remove influx_tsm
 		2021-07-20 09:42:52 -04:00
..
Makefile chore: update protobuf library versions and remove influx_tsm (#21882) 2021-07-20 09:42:52 -04: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 Support proxy environment variables in the influx client 2018-02-11 21:51:58 -06:00
influx_inspect.txt Fix the influx_inspect man page 2018-05-25 09:36:20 -05:00
influxd-backup.txt Backup continue on errors (#10307) 2018-09-26 14:44:14 -04:00
influxd-config.txt Initial work creating man pages 2016-07-22 10:34:40 -05:00
influxd-restore.txt Update backup flags to have long/short versions (#9713) 2018-04-25 10:49:46 -04: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