changeset 380:edd873d583eb

Docs: improve irccd and irccdctl documentation
author David Demelier <markand@malikania.fr>
date Sun, 18 Dec 2016 16:26:36 +0100
parents 4507a0895cd3
children 60545793499e
files doc/html/CMakeLists.txt doc/html/index.md doc/html/irccd/usage.md doc/html/irccdctl/usage.md
diffstat 4 files changed, 56 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/html/CMakeLists.txt	Sun Dec 18 16:22:18 2016 +0100
+++ b/doc/html/CMakeLists.txt	Sun Dec 18 16:26:36 2016 +0100
@@ -145,6 +145,7 @@
     ${html_SOURCE_DIR}/irccd/configuring.md
     ${html_SOURCE_DIR}/irccd/index.md
     ${html_SOURCE_DIR}/irccd/paths.md
+    ${html_SOURCE_DIR}/irccd/usage.md
     ${html_SOURCE_DIR}/irccdctl/configuring.md
     ${html_SOURCE_DIR}/irccdctl/index.md
     ${html_SOURCE_DIR}/irccdctl/usage.md
--- a/doc/html/index.md	Sun Dec 18 16:22:18 2016 +0100
+++ b/doc/html/index.md	Sun Dec 18 16:26:36 2016 +0100
@@ -27,6 +27,7 @@
 Configure and run `irccd` daemon.
 
   - [Configure irccd](irccd/configuring.html)
+  - [Irccd command line usage](irccd/usage.html)
 
 ## Irccdctl
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/html/irccd/usage.md	Sun Dec 18 16:26:36 2016 +0100
@@ -0,0 +1,24 @@
+---
+header: Irccd usage and options
+guide: yes
+---
+
+# Usage
+
+Usage of irccd.
+
+## Synopsis
+
+````nohighlight
+$ irccd [options...]
+````
+
+## Options
+
+The following options are available:
+
+  - `-c, --config file`: specify the configuration file,
+  - `-f, --foreground`: do not run as a daemon,
+  - `-h, --help`: show this help,
+  - `-v, --verbose`: be verbose,
+  - `--version`: show the version.
--- a/doc/html/irccdctl/usage.md	Sun Dec 18 16:22:18 2016 +0100
+++ b/doc/html/irccdctl/usage.md	Sun Dec 18 16:26:36 2016 +0100
@@ -7,6 +7,36 @@
 
 Usage of irccdctl.
 
+## Synopsis
+
+````nohighlight
+usage: irccdctl plugin-config plugin [variable] [value]
+       irccdctl plugin-info plugin
+       irccdctl plugin-list
+       irccdctl plugin-load logger
+       irccdctl plugin-reload plugin
+       irccdctl plugin-unload plugin
+       irccdctl server-cmode server channel mode
+       irccdctl server-cnotice server channel message
+       irccdctl server-connect [options] id host [port]
+       irccdctl server-disconnect [server]
+       irccdctl server-info server
+       irccdctl server-invite server nickname channel
+       irccdctl server-join server channel [password]
+       irccdctl server-kick server target channel [reason]
+       irccdctl server-list
+       irccdctl server-me server target message
+       irccdctl server-message server target message
+       irccdctl server-mode server mode
+       irccdctl server-nick server nickname
+       irccdctl server-notice server target message
+       irccdctl server-part server channel [reason]
+       irccdctl server-reconnect [server]
+       irccdctl server-topic server channel topic
+       irccdctl watch [-f|--format json|native]
+
+````
+
 ## Syntax
 
 The general syntax for running an irccdctl command is: