Initial work creating man pages

.gitignore

@@ -77,3 +77,7 @@ integration/migration_data/
 
 // Ingnore SourceGraph directory
 .srclib-store/
+
+# man outputs
+man/*.xml
+man/*.1

man/Makefile

@@ -0,0 +1,31 @@
+#!/usr/bin/make -f
+
+MAN1_TXT =
+MAN1_TXT += influxd.txt
+MAN1_TXT += influxd-backup.txt
+MAN1_TXT += influxd-config.txt
+MAN1_TXT += influxd-restore.txt
+MAN1_TXT += influxd-run.txt
+MAN1_TXT += influxd-version.txt
+MAN1_TXT += influx.txt
+
+MAN_TXT = $(MAN1_TXT)
+MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
+
+DOC_MAN1 = $(patsubst %.txt,%.1,$(MAN1_TXT))
+
+build: $(DOC_MAN1)
+
+clean:
+	rm -f $(MAN_XML) $(DOC_MAN1)
+
+%.xml : %.txt
+	@echo '  ASCIIDOC $@' && rm -f $@+ && \
+	asciidoc -d manpage -b docbook -o $@+ $< && \
+	mv $@+ $@
+
+%.1 : %.xml
+	@echo '  XMLTO $@' && \
+	xmlto man $< 2> /dev/null
+
+.PHONY: build clean

man/footer.txt

@@ -0,0 +1,13 @@
+BUGS
+----
+Report bugs to the GitHub issue tracker <https://github.com/influxdata/influxdb>.
+
+AUTHORS
+-------
+InfluxDB is written and maintained by InfluxData <https://influxdata.com>.
+
+COPYRIGHT
+---------
+InfluxDB is released under the MIT license.
+
+This man page is released under Creative Commons Attribution 4.0 International License.

man/influx.txt

@@ -0,0 +1,81 @@
+influx(1)
+=========
+
+NAME
+----
+influx - InfluxDB client
+
+SYNOPSIS
+--------
+[verse]
+'influx' [options]
+'influx' -execute <command> [options]
+'influx' -import -path <path> (-compressed) [options]
+'influx' -version
+
+DESCRIPTION
+-----------
+'influx' is the command line program for interacting with an InfluxDB server.
+
+In the first form, the program starts a CLI that can be used to write data or query the database. The command line is described in *COMMAND LINE*.
+
+In the second form, this will execute a single command, usually a query. This is the equivalent of starting the command line, running one command, and then exiting.
+
+In the third form, this imports a previously exported database to the database.
+
+The fourth form outputs the version of the command line and then immediately exits.
+
+OPTIONS
+-------
+-host <host>::
+  Host to connect to. Default is localhost.
+
+-port <port>::
+  Port to use when connecting to the host. Default is 8086.
+
+-database <database>::
+  Database to use when connecting to the database.
+
+-username <username>::
+  Username to connect to the server.
+
+-password <password>::
+  Password to connect to the server. If left blank, this will prompt for a password.
+
+-ssl:
+  Use https for requests.
+
+-unsafeSsl::
+  Set this with '-ssl' to allow unsafe connections.
+
+-execute <command>::
+  Executes the command and exits.
+
+-format <json|csv|column>::
+  Sets the format of the server responses. Default is column.
+
+-precision <rfc3339|h|m|s|ms|u|ns>::
+  Specifies the format of the timestamp. Default is ns.
+
+-consistency <any|one|quorum|all>::
+  Set the write consistency level. Default is one.
+
+-pretty::
+  Turns on pretty print format for the JSON format.
+
+-import::
+  Import a previous database export from a file. If specified, '-path <path>' must also be specified.
+
+-path <path>::
+  Path to the database export file to import. Must be used with '-import'.
+
+-pps <n>:
+  How many points per second the import will allow. By default, it is zero and will not throttle importing.
+
+-compressed::
+  Set if the import file is compressed. Must be used with '-import'.
+
+-version::
+  Outputs the version of the influx client.
+
+include::footer.txt[]

man/influxd-backup.txt

@@ -0,0 +1,37 @@
+influxd-backup(1)
+=================
+
+NAME
+----
+influxd-backup - Downloads a snapshot of a data node and saves it to disk
+
+SYNOPSIS
+--------
+'influxd backup' [options]
+
+DESCRIPTION
+-----------
+Downloads a snapshot of a data node and saves it to disk.
+
+OPTIONS
+-------
+-host <host:port>::
+  The host to connect to and perform a snapshot of. Defaults to '127.0.0.1:8088'.
+
+-database <name>::
+  The database to backup. Required.
+
+-retention <name>::
+  The retention policy to backup. Optional.
+
+-shard <id>::
+  The shard id to backup. Optional. If specified, '-retention <name>' is required.
+
+-since <2015-12-24T08:12:13>::
+  Do an incremental backup since the passed in time. The time needs to be in the RFC3339 format. Optional.
+
+SEE ALSO
+--------
+*influxd-restore*(1)
+
+include::footer.txt[]

man/influxd-config.txt

@@ -0,0 +1,40 @@
+influxd-config(1)
+=================
+
+NAME
+----
+influxd-config - Generate configuration files for InfluxDB
+
+SYNOPSIS
+--------
+[verse]
+'influxd' config (-config <path>)
+'influxd config' -config /dev/null
+
+DESCRIPTION
+-----------
+'influxd config' will generate a configuration file for InfluxDB. The configuration file will be output to standard output and can be written to a file by redirecting the shell output to another file.
+
+When a configuration file is specified using '-config <path>', this configuration file will be read and will overwrite the default values for any values that are present. It can be used to provide a configuration fragment with only the options you want to customize and generate a new configuration file from that file. If '-config <path>' is not specified, the command will look for a default configuration file using the same method as *influxd-run*(1).
+
+When using this command to regenerate a configuration file in place, be sure to use a temporary file as the output. This command will not work:
+
+===
+# DO NOT USE!
+$ influxd config -config influxdb.conf > influxdb.conf
+
+# PROPER METHOD!
+$ influxd config -config influxdb.conf > influxdb.conf.tmp && \
+      mv influxdb.conf.tmp influxdb.conf
+===
+
+The shell will truncate the configuration file before 'influxd config' can read it and you will lose all of your custom options. For safety, redirect output to a temporary file instead and use 'mv' to move the file afterwards.
+
+The second command version will force 'influxd config' to output the default configuration file. Setting the configuration file to */dev/null* will cause the command to output only the defaults and will not read any values from any existing configuration files.
+
+OPTIONS
+-------
+-config <path>::
+  Customize the default configuration file to load. Disables automatic loading when the path is */dev/null*.
+
+include::footer.txt[]

man/influxd-restore.txt

@@ -0,0 +1,37 @@
+influxd-restore(1)
+==================
+
+NAME
+----
+influxd-restore - Restores the metastore, databases, retention policies, or specific shards
+
+SYNOPSIS
+--------
+'influxd restore' [options] PATH
+
+DESCRIPTION
+-----------
+Uses backups from the PATH to restore the metastore, databases, retention policies, or specific shards. The InfluxDB process must not be running during a restore.
+
+OPTIONS
+-------
+-metadir <path>::
+  If set, the metastore will be recovered to the given path. Optional.
+
+-datadir <path>::
+  If set, the restore process will recover the specified database, retention policy, or shard to the given directory. Optional.
+
+-database <name>::
+  Will restore the database TSM files. Required if no metadir is given. Optional.
+
+-retention <name>::
+  Will restore the retention policy's TSM files. If given, database is required. Optional.
+
+-shard <id>::
+  Will restore the shard's TSM files. If given, database and retention are required. Optional.
+
+SEE ALSO
+--------
+*influxd-backup*(1)
+
+include::footer.txt[]

man/influxd-run.txt

@@ -0,0 +1,32 @@
+influxd-run(1)
+==============
+
+NAME
+----
+influxd-run - Configure and start an InfluxDB server
+
+SYNOPSIS
+--------
+[verse]
+'influxd' [-config <path>] [-pidfile <path>] [-cpuprofile <path>] [-memprofile <path>]
+'influxd run' [-config <path>] [-pidfile <path>] [-cpuprofile <path>] [-memprofile <path>]
+
+DESCRIPTION
+-----------
+Runs the InfluxDB server.
+
+OPTIONS
+-------
+-config <path>::
+  Sets the path to the configuration file. This defaults to the environment variable *INFLUXDB_CONFIG_PATH*, *~/.influxdb/influxdb.conf*, or */etc/influxdb/influxdb.conf* if a file is present at any of these locations. Disable the automatic loading of a configuration file by using the null device as the path (such as /dev/null on Linux or Mac OS X).
+
+-pidfile <path>::
+  Write process ID to a file.
+
+-cpuprofile <path>::
+  Write CPU profiling information to a file.
+
+-memprofile <path>::
+  Write memory usage information to a file.
+
+include::footer.txt[]

man/influxd-version.txt

@@ -0,0 +1,17 @@
+influxd-version(1)
+==================
+
+NAME
+----
+influxd-version - Display the version of influxdb
+
+SYNOPSIS
+--------
+[verse]
+'influxd version'
+
+DESCRIPTION
+-----------
+'influxd version' will output the version of the InfluxDB server.
+
+include::footer.txt[]

man/influxd.txt

@@ -0,0 +1,40 @@
+influxd(1)
+==========
+
+NAME
+----
+influxd - InfluxDB server daemon
+
+SYNOPSIS
+--------
+[verse]
+'influxd' [command] [options]
+
+DESCRIPTION
+-----------
+'influxd' is the server daemon for InfluxDB.
+
+COMMANDS
+--------
+These commands can be invoked using the 'influxd' program. The default is 'run' if the command parameter is skipped.
+
+backup::
+  Downloads a snapshot of a data node and saves it to disk.
+
+config::
+  Displays the default configuration. This can also read an existing configuration file and output the default values for any missing fields. Default values and existing entries in a configuration file can be customized through environment variables.
+
+restore::
+  Uses backups to restore the metastore, databases, retention policies, or specific shards. The InfluxDB process must not be running during a restore.
+
+run::
+  Runs the InfluxDB server. This is the default command if none is specified.
+
+version::
+  Displays the InfluxDB version, build branch, and git commit hash.
+
+SEE ALSO
+--------
+*influxd-backup*(1), *influxd-config*(1), *influxd-restore*(1), *influxd-run*(1), *influxd-version*(1)
+
+include::footer.txt[]