Mercurial > irccd
changeset 360:55bf5c5a65db
Docs: split irccdctl commands, closes #592
line wrap: on
line diff
--- a/doc/html/CMakeLists.txt Wed Nov 30 12:59:08 2016 +0100 +++ b/doc/html/CMakeLists.txt Wed Nov 30 13:20:23 2016 +0100 @@ -144,10 +144,33 @@ ${html_SOURCE_DIR}/dev/socket-protocol.md ${html_SOURCE_DIR}/irccd/configuring.md ${html_SOURCE_DIR}/irccd/index.md - ${html_SOURCE_DIR}/irccdctl/commands.md ${html_SOURCE_DIR}/irccdctl/configuring.md ${html_SOURCE_DIR}/irccdctl/index.md ${html_SOURCE_DIR}/irccdctl/usage.md + ${html_SOURCE_DIR}/irccdctl/command/index.md + ${html_SOURCE_DIR}/irccdctl/command/help.md + ${html_SOURCE_DIR}/irccdctl/command/plugin-info.md + ${html_SOURCE_DIR}/irccdctl/command/plugin-list.md + ${html_SOURCE_DIR}/irccdctl/command/plugin-load.md + ${html_SOURCE_DIR}/irccdctl/command/plugin-reload.md + ${html_SOURCE_DIR}/irccdctl/command/plugin-unload.md + ${html_SOURCE_DIR}/irccdctl/command/server-cmode.md + ${html_SOURCE_DIR}/irccdctl/command/server-cnotice.md + ${html_SOURCE_DIR}/irccdctl/command/server-connect.md + ${html_SOURCE_DIR}/irccdctl/command/server-disconnect.md + ${html_SOURCE_DIR}/irccdctl/command/server-invite.md + ${html_SOURCE_DIR}/irccdctl/command/server-join.md + ${html_SOURCE_DIR}/irccdctl/command/server-kick.md + ${html_SOURCE_DIR}/irccdctl/command/server-list.md + ${html_SOURCE_DIR}/irccdctl/command/server-me.md + ${html_SOURCE_DIR}/irccdctl/command/server-message.md + ${html_SOURCE_DIR}/irccdctl/command/server-mode.md + ${html_SOURCE_DIR}/irccdctl/command/server-nick.md + ${html_SOURCE_DIR}/irccdctl/command/server-notice.md + ${html_SOURCE_DIR}/irccdctl/command/server-part.md + ${html_SOURCE_DIR}/irccdctl/command/server-reconnect.md + ${html_SOURCE_DIR}/irccdctl/command/server-topic.md + ${html_SOURCE_DIR}/irccdctl/command/watch.md ${html_SOURCE_DIR}/misc/common-patterns-and-formatting.md ${html_SOURCE_DIR}/misc/configuration-syntax.md ${html_SOURCE_DIR}/misc/index.md
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/help.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: help +guide: yes +--- + +# help + +Get the help. + +## Usage + +````nohighlight +$ irccdctl help subject +```` + +## Example + +````nohighlight +$ irccdctl help server-message +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/index.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,28 @@ +--- +title: Irccdctl commands +guide: yes +--- + + - [help](help.html) + - [plugin-info](plugin-info.html) + - [plugin-list](plugin-list.html) + - [plugin-load](plugin-load.html) + - [plugin-reload](plugin-reload.html) + - [plugin-unload](plugin-unload.html) + - [server-cmode](server-cmode.html) + - [server-cnotice](server-cnotice.html) + - [server-connect](server-connect.html) + - [server-disconnect](server-disconnect.html) + - [server-invite](server-invite.html) + - [server-join](server-join.html) + - [server-kick](server-kick.html) + - [server-list](server-list.html) + - [server-me](server-me.html) + - [server-message](server-message.html) + - [server-mode](server-mode.html) + - [server-nick](server-nick.html) + - [server-notice](server-notice.html) + - [server-part](server-part.html) + - [server-reconnect](server-reconnect.html) + - [server-topic](server-topic.html) + - [watch](watch.html)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/plugin-info.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: plugin-info +guide: yes +--- + +# plugin-info + +Get plugin information. + +## Usage + +````nohighlight +$ irccdctl plugin-info name +```` + +## Example + +````nohighlight +$ irccdctl plugin-info ask +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/plugin-list.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,14 @@ +--- +title: plugin-list +guide: yes +--- + +# plugin-list + +Get the list of all loaded plugins. + +## Usage + +````nohighlight +$ irccdctl plugin-list +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/plugin-load.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: plugin-load +guide: yes +--- + +# plugin-load + +Load a plugin into the irccd instance. + +## Usage + +````nohighlight +$ irccdctl plugin-load plugin +```` + +## Example + +````nohighlight +$ irccdctl load ask +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/plugin-reload.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: plugin-reload +guide: yes +--- + +# plugin-reload + +Reload a plugin by calling the appropriate onReload event, the plugin is not unloaded and must be already loaded. + +## Usage + +````nohighlight +$ irccdctl plugin-reload name +```` + +## Example + +````nohighlight +$ irccdctl plugin-reload logger +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/plugin-unload.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: plugin-unload +guide: yes +--- + +# plugin-unload + +Unload a loaded plugin from the irccd instance. + +## Usage + +````nohighlight +$ irccdctl plugin-unload name +```` + +## Example + +````nohighlight +$ irccdctl plugin-unload logger +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-cmode.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: server-cmode +guide: yes +--- + +# server-cmode + +Change the mode of the specified channel. + +## Usage + +````nohighlight +$ irccdctl server-cmode server channel mode +```` + +## Example + +````nohighlight +$ irccdctl server-cmode freenode #staff +t +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-cnotice.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: server-cnotice +guide: yes +--- + +# server-cnotice + +Send a notice to a public channel. This is a notice that everyone will be notified by. + +## Usage + +````nohighlight +$ irccdctl server-cnotice server channel message +```` + +## Example + +````nohighlight +$ irccdctl server-cnotice freenode #staff "Don't flood" +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-connect.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,30 @@ +--- +title: server-connect +guide: yes +--- + +# server-connect + +Connect to a new IRC server. + +## Usage + +````nohighlight +$ irccdctl server-connect [options] name host port +```` + +Available options: + +- **-c, --command**: specify the command char +- **-n, --nickname**: specify a nickname +- **-r, --realname**: specify a real name +- **-S, --ssl-verify**: verify SSL +- **-s, --ssl**: connect using SSL +- **-u, --username**: specify a user name + +## Example + +````nohighlight +$ irccdctl server-connect wanadoo chat.wanadoo.fr 6667 +$ irccdctl server-connect -s -S -n "undead" wanadoo chat.wanadoo.fr 6697 +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-disconnect.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: server-disconnect +guide: yes +--- + +# server-disconnect + +Disconnect from a connected server. + +## Usage + +````nohighlight +$ irccdctl server-disconnect name +```` + +## Example + +````nohighlight +$ irccdctl server-disconnect wanadoo +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-invite.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: server-invite +guide: yes +--- + +# server-invite + +Invite someone to a channel, needed for channel with mode +i + +## Usage + +````nohighlight +$ irccdctl server-invite server nickname channel +```` + +## Example + +````nohighlight +$ irccdctl server-invite freenode xorg62 #staff +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-join.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: server-join +guide: yes +--- + +# server-join + +Join the specified channel, the password is optional. + +## Usage + +````nohighlight +$ irccdctl server-join server channel [password] +```` + +## Example + +````nohighlight +$ irccdctl server-join freenode #staff +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-kick.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: server-kick +guide: yes +--- + +# server-kick + +Kick the specified target from the channel, the reason is optional. + +## Usage + +````nohighlight +$ irccdctl server-kick server target channel [reason] +```` + +## Example + +````nohighlight +$ irccdctl kick freenode jean #staff "Stop flooding" +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-list.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,14 @@ +--- +title: server-list +guide: yes +--- + +# server-list + +Get the list of all connected servers. + +## Usage + +````nohighlight +$ irccdctl server-list +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-me.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: server-me +guide: yes +--- + +# server-me + +Send an action emote. + +## Usage + +````nohighlight +$ irccdctl server-me server target message +```` + +## Example + +````nohighlight +$ irccdctl server-me freenode #staff "going back soon" +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-message.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: server-message +guide: yes +--- + +# server-message + +Send a message to the specified target or channel. + +## Usage + +````nohighlight +$ irccdctl server-message server target message +```` + +## Example + +````nohighlight +$ irccdctl server-message freenode #staff "Hello from irccd" +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-mode.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: server-mode +guide: yes +--- + +# server-mode + +Set the irccd's user mode. + +**Usage** + +````nohighlight +$ server-mode server mode +```` + +**Example** + +````nohighlight +$ irccdctl server-mode +i +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-nick.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: server-nick +guide: yes +--- + +# server-nick + +Change irccd's nickname. + +## Usage + +````nohighlight +$ irccdctl server-nick server nickname +```` + +## Example + +````nohighlight +$ irccdctl server-nick freenode david +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-notice.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: server-notice +guide: yes +--- + +# server-notice + +Send a private notice to the specified target. + +## Usage + +````nohighlight +$ irccdctl server-notice server target message +```` + +## Example + +````nohighlight +$ irccdctl server-notice freenode jean "I know you are here." +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-part.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,25 @@ +--- +title: server-part +guide: yes +--- + +# server-part + +Leave the specified channel, the reason is optional. + +<div class="alert alert-warning" role="alert"> +**Warning**: not all IRC servers support giving a reason to leave a channel, do not specify it if this is a concern. +</div> + +## Usage + +````nohighlight +$ irccdctl server-part server channel [reason] +```` + +## Example + +````nohighlight +$ irccdctl server-part freenode #staff +$ irccdctl server-part freenode #botwar "too noisy" +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-reconnect.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,23 @@ +--- +title: server-reconnect +guide: yes +--- + +# server-reconnect + +Force reconnection of one or all servers. + +If server is not specified, all servers will try to reconnect. + +## Usage + +````nohighlight +$ irccdctl server-reconnect [server] +```` + +## Example + +````nohighlight +$ irccdctl server-reconnect +$ irccdctl server-reconnect wanadoo +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/server-topic.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,20 @@ +--- +title: server-topic +guide: yes +--- + +# server-topic + +Change the topic of the specified channel. + +## Usage + +````nohighlight +$ irccdctl server-topic server channel topic +```` + +## Example + +````nohighlight +$ irccdctl server-topic freenode #wmfs "This is the best channel" +````
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/command/watch.md Wed Nov 30 13:20:23 2016 +0100 @@ -0,0 +1,22 @@ +--- +title: watch +guide: yes +--- + +# watch + +Start watching irccd events. You can use different output formats, native is human readable format, json is pretty +formatted json. + +## Usage + +````nohighlight +$ irccdctl watch [-f|--format native|json] +```` + +## Example + +````nohighlight +$ irccdctl watch +$ irccdctl watch -f json +````
--- a/doc/html/irccdctl/commands.md Wed Nov 30 12:59:08 2016 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,380 +0,0 @@ ---- -title: Irccdctl commands -guide: yes ---- - -# help - -Get the help. - -**Usage** - -````nohighlight -$ irccdctl help subject -```` - -**Example** - -````nohighlight -$ irccdctl help server-message -```` - -# plugin-info - -Get plugin information. - -**Usage** - -````nohighlight -$ irccdctl plugin-info name -```` - -**Example** - -````nohighlight -$ irccdctl plugin-info ask -```` - -# plugin-list - -Get the list of all loaded plugins. - -**Usage** - -````nohighlight -$ irccdctl plugin-list -```` - -# plugin-load - -Load a plugin into the irccd instance. - -**Usage** - -````nohighlight -$ irccdctl plugin-load plugin -```` - -**Example** - -````nohighlight -$ irccdctl load ask -```` - -# plugin-reload - -Reload a plugin by calling the appropriate onReload event, the plugin is not unloaded and must be already loaded. - -**Usage** - -````nohighlight -$ irccdctl plugin-reload name -```` - -**Example** - -````nohighlight -$ irccdctl plugin-reload logger -```` - -# plugin-unload - -Unload a loaded plugin from the irccd instance. - -**Usage** - -````nohighlight -$ irccdctl plugin-unload name -```` - -**Example** - -````nohighlight -$ irccdctl plugin-unload logger -```` - -# server-cmode - -Change the mode of the specified channel. - -**Usage** - -````nohighlight -$ irccdctl server-cmode server channel mode -```` - -**Example** - -````nohighlight -$ irccdctl server-cmode freenode #staff +t -```` - -# server-cnotice - -Send a notice to a public channel. This is a notice that everyone will be notified by. - -**Usage** - -````nohighlight -$ irccdctl server-cnotice server channel message -```` - -**Usage** - -````nohighlight -$ irccdctl server-cnotice freenode #staff "Don't flood" -```` - -# server-connect - -Connect to a new IRC server. - -**Usage** - -````nohighlight -$ irccdctl server-connect [options] name host port -```` - -Available options: - -- **-c, --command**: specify the command char -- **-n, --nickname**: specify a nickname -- **-r, --realname**: specify a real name -- **-S, --ssl-verify**: verify SSL -- **-s, --ssl**: connect using SSL -- **-u, --username**: specify a user name - -**Example** - -````nohighlight -$ irccdctl server-connect wanadoo chat.wanadoo.fr 6667 -$ irccdctl server-connect -s -S -n "undead" wanadoo chat.wanadoo.fr 6697 -```` - -# server-disconnect - -Disconnect from a connected server. - -**Usage** - -````nohighlight -$ irccdctl server-disconnect name -```` - -**Example** - -````nohighlight -$ irccdctl server-disconnect wanadoo -```` - -# server-invite - -Invite someone to a channel, needed for channel with mode +i - -**Usage** - -````nohighlight -$ irccdctl server-invite server nickname channel -```` - -**Example** - -````nohighlight -$ irccdctl server-invite freenode xorg62 #staff -```` - -# server-join - -Join the specified channel, the password is optional. - -**Usage** - -````nohighlight -$ irccdctl server-join server channel [password] -```` - -**Example** - -````nohighlight -$ irccdctl server-join freenode #staff -```` - -# server-kick - -Kick the specified target from the channel, the reason is optional. - -**Usage** - -````nohighlight -$ irccdctl server-kick server target channel [reason] -```` - -**Example** - -````nohighlight -$ irccdctl kick freenode jean #staff "Stop flooding" -```` - -# server-list - -Get the list of all connected servers. - -**Usage** - -````nohighlight -$ irccdctl server-list -```` - -# server-me - -Send an action emote. - -**Usage** - -````nohighlight -$ irccdctl server-me server target message -```` - -**Example** - -````nohighlight -$ irccdctl server-me freenode #staff "going back soon" -```` - -# server-message - -Send a message to the specified target or channel. - -**Usage** - -````nohighlight -$ irccdctl server-message server target message -```` - -**Example** - -````nohighlight -$ irccdctl server-message freenode #staff "Hello from irccd" -```` - -# server-mode - -Set the irccd's user mode. - -**Usage** - -````nohighlight -$ server-mode server mode -```` - -**Example** - -````nohighlight -$ irccdctl server-mode +i -```` - -# server-nick - -Change irccd's nickname. - -**Usage** - -````nohighlight -$ irccdctl server-nick server nickname -```` - -**Example** - -````nohighlight -$ irccdctl server-nick freenode david -```` - -# server-notice - -Send a private notice to the specified target. - -**Usage** - -````nohighlight -$ irccdctl server-notice server target message -```` - -**Example** - -````nohighlight -$ irccdctl server-notice freenode jean "I know you are here." -```` - -# server-part - -Leave the specified channel, the reason is optional. - -<div class="alert alert-warning" role="alert"> -**Warning**: not all IRC servers support giving a reason to leave a channel, do not specify it if this is a concern. -</div> - -**Usage** - -````nohighlight -$ irccdctl server-part server channel [reason] -```` - -**Example** - -````nohighlight -$ irccdctl server-part freenode #staff -$ irccdctl server-part freenode #botwar "too noisy" -```` - -# server-reconnect - -Force reconnection of one or all servers. - -If server is not specified, all servers will try to reconnect. - -**Usage** - -````nohighlight -$ irccdctl server-reconnect [server] -```` - -**Example** - -````nohighlight -$ irccdctl server-reconnect -$ irccdctl server-reconnect wanadoo -```` - -# server-topic - -Change the topic of the specified channel. - -**Usage** - -````nohighlight -$ irccdctl server-topic server channel topic -```` - -**Example** - -````nohighlight -$ irccdctl server-topic freenode #wmfs "This is the best channel" -```` - -# watch - -Start watching irccd events. You can use different output formats, native is human readable format, json is pretty -formatted json. - -**Usage** - -````nohighlight -$ irccdctl watch [-f|--format native|json] -```` - -**Example** - -````nohighlight -$ irccdctl watch -$ irccdctl watch -f json -````
--- a/doc/html/irccdctl/index.md Wed Nov 30 12:59:08 2016 +0100 +++ b/doc/html/irccdctl/index.md Wed Nov 30 13:20:23 2016 +0100 @@ -4,6 +4,33 @@ guide: yes --- +# General documentation + - [Configure irccdctl](configuring.html) - - [List of irccdctl commands](commands.html) - [Irccdctl command line usage](usage.html) + +# List of support commands + + - [help](command/help.html) + - [plugin-info](command/plugin-info.html) + - [plugin-list](command/plugin-list.html) + - [plugin-load](command/plugin-load.html) + - [plugin-reload](command/plugin-reload.html) + - [plugin-unload](command/plugin-unload.html) + - [server-cmode](command/server-cmode.html) + - [server-cnotice](command/server-cnotice.html) + - [server-connect](command/server-connect.html) + - [server-disconnect](command/server-disconnect.html) + - [server-invite](command/server-invite.html) + - [server-join](command/server-join.html) + - [server-kick](command/server-kick.html) + - [server-list](command/server-list.html) + - [server-me](command/server-me.html) + - [server-message](command/server-message.html) + - [server-mode](command/server-mode.html) + - [server-nick](command/server-nick.html) + - [server-notice](command/server-notice.html) + - [server-part](command/server-part.html) + - [server-reconnect](command/server-reconnect.html) + - [server-topic](command/server-topic.html) + - [watch](command/watch.html)