Add: rudimentary icktool manpage

1 files changed, 43 insertions, 0 deletions

diff --git a/icktool.1.in b/icktool.1.in
new file mode 100644
index 0000000..e8cc1f5
--- /dev/null
+++ b/icktool.1.in
@@ -0,0 +1,43 @@
+.\" Copyright 2017  Lars Wirzenius
+.\"
+.\" This program is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU Affero General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU Affero General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU Affero General Public License
+.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
+.TH ICKTOOL 1
+.SH NAME
+icktool \- use the Ick2 controller API
+.SH SYNOPSIS
+.SH DESCRIPTION
+.B icktool
+makes calls to the RESTful HTTP JSON API that the Ick2 controller
+provides.
+Ick2 is a continuous integration system.
+The
+.B icktool
+command line syntax consists of a
+.I command
+possibly followed by arguments.
+.PP
+The commands are listed with the
+.B help
+subcommand.
+Many commands read a project or worker description,
+which is JSON format,
+and will be documented when it stabilises.
+Ick2 is currently under heavy developemnt.
+.SH OPTIONS
+.SH FILES
+Run
+.B icktool
+with the option
+.B \-\-list\-configs
+for a list of all configuruation files it looks for.