Kirill Simonov avatar Kirill Simonov committed b2d22e6

Added a man page for htsql-ctl.

Comments (0)

Files changed (4)

 # Package resources.
 recursive-include src *.html *.css *.js
 
-# Generated HTML documentation.
+# Generated HTML documentation and MAN pages.
 recursive-include doc/html *
+recursive-include doc/man *.1
 
    ref/index
    admin/index
    embed
+   man/index
 
 Indices and tables
 ==================

doc/man/htsql-ctl.1.rst

+*****************
+  ``htsql-ctl``
+*****************
+
+:Subtitle: command line interface to HTSQL
+:Manual Section: 1
+:Manual Group: HTSQL Manual
+
+
+SYNOPSIS
+========
+
+::
+
+  htsql-ctl <command> [options] [arguments]
+
+
+DESCRIPTION
+===========
+
+HTSQL is a comprehensive navigational query language for relational databases.
+HTSQL is designed for data analysts and other accidental programmers who have
+complex business inquiries to solve and need a productive tool to write and
+share database queries.
+
+The ``htsql-ctl`` command provides command line interface to HTSQL.
+
+Run ``htsql-ctl help`` for general usage and list of commands.
+Run ``htsql-ctl help <command>`` for help on a specific command.
+
+
+COMMANDS
+========
+
+``help``
+  Describe the usage of the application and its routines.
+``version``
+  Display HTSQL version.
+``shell``
+  Start an HTSQL shell.
+``serve``
+  Start an HTSQL web server.
+
+
+SEE ALSO
+========
+
+For more information, please visit http://htsql.org/.
+
+
+BUGS
+====
+
+Submit bug reports at https://bitbucket.org/prometheus/htsql/issues/new.
+
+

doc/man/index.rst

+****************
+  Manual Pages
+****************
+
+.. toctree::
+   :maxdepth: 2
+
+   htsql-ctl.1
+
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.