Mercurial > irccd

changeset 391:d51a95714abb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: sync html with irccdctl help messages
author David Demelier <markand@malikania.fr>
date Fri, 23 Dec 2016 13:42:26 +0100
parents 2df0f202946c
children 0be0f1b863eb
files doc/html/irccdctl/command/plugin-reload.md doc/html/irccdctl/command/server-cnotice.md doc/html/irccdctl/command/server-connect.md doc/html/irccdctl/command/server-disconnect.md doc/html/irccdctl/command/server-invite.md doc/html/irccdctl/command/server-join.md doc/html/irccdctl/command/server-part.md doc/html/irccdctl/command/watch.md irccdctl/cli.cpp
diffstat 9 files changed, 35 insertions(+), 23 deletions(-) [+]
line wrap: on
line diff
--- a/doc/html/irccdctl/command/plugin-reload.md	Fri Dec 23 13:11:54 2016 +0100
+++ b/doc/html/irccdctl/command/plugin-reload.md	Fri Dec 23 13:42:26 2016 +0100
@@ -5,7 +5,8 @@
 
 # plugin-reload
 
-Reload a plugin by calling the appropriate onReload event, the plugin is not unloaded and must be already loaded.
+Reload a plugin by calling the appropriate onReload event, the plugin is not
+unloaded and must be already loaded.
 
 ## Usage
 
--- a/doc/html/irccdctl/command/server-cnotice.md	Fri Dec 23 13:11:54 2016 +0100
+++ b/doc/html/irccdctl/command/server-cnotice.md	Fri Dec 23 13:42:26 2016 +0100
@@ -5,7 +5,8 @@
 
 # server-cnotice
 
-Send a notice to a public channel. This is a notice that everyone will be notified by.
+Send a notice to a public channel. This is a notice that everyone on the channel
+will receive.
 
 ## Usage
 
--- a/doc/html/irccdctl/command/server-connect.md	Fri Dec 23 13:11:54 2016 +0100
+++ b/doc/html/irccdctl/command/server-connect.md	Fri Dec 23 13:42:26 2016 +0100
@@ -25,6 +25,6 @@
 ## Example
 
 ````nohighlight
-$ irccdctl server-connect wanadoo chat.wanadoo.fr 6667
-$ irccdctl server-connect -s -S -n "undead" wanadoo chat.wanadoo.fr 6697
+$ irccdctl server-connect -n jean example irc.example.org
+$ irccdctl server-connect --ssl example irc.example.org 6697
 ````
--- a/doc/html/irccdctl/command/server-disconnect.md	Fri Dec 23 13:11:54 2016 +0100
+++ b/doc/html/irccdctl/command/server-disconnect.md	Fri Dec 23 13:42:26 2016 +0100
@@ -5,16 +5,18 @@
 
 # server-disconnect
 
-Disconnect from a connected server.
+Disconnect from a server.
+
+If server is not specified, irccd disconnects all servers.
 
 ## Usage
 
 ````nohighlight
-$ irccdctl server-disconnect name
+$ irccdctl server-disconnect [server]
 ````
 
 ## Example
 
 ````nohighlight
-$ irccdctl server-disconnect wanadoo
+$ irccdctl server-disconnect localhost
 ````
--- a/doc/html/irccdctl/command/server-invite.md	Fri Dec 23 13:11:54 2016 +0100
+++ b/doc/html/irccdctl/command/server-invite.md	Fri Dec 23 13:42:26 2016 +0100
@@ -5,7 +5,7 @@
 
 # server-invite
 
-Invite someone to a channel, needed for channel with mode +i
+Invite the specified target on the channel.
 
 ## Usage
 
--- a/doc/html/irccdctl/command/server-join.md	Fri Dec 23 13:11:54 2016 +0100
+++ b/doc/html/irccdctl/command/server-join.md	Fri Dec 23 13:42:26 2016 +0100
@@ -16,5 +16,6 @@
 ## Example
 
 ````nohighlight
-$ irccdctl server-join freenode #staff
+$ irccdctl server-join freenode #test
+$ irccdctl server-join freenode #private-club secret
 ````
--- a/doc/html/irccdctl/command/server-part.md	Fri Dec 23 13:11:54 2016 +0100
+++ b/doc/html/irccdctl/command/server-part.md	Fri Dec 23 13:42:26 2016 +0100
@@ -8,7 +8,8 @@
 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.
+**Warning**: not all IRC servers support giving a reason to leave a channel, do
+not specify it if this is a concern.
 </div>
 
 ## Usage
--- a/doc/html/irccdctl/command/watch.md	Fri Dec 23 13:11:54 2016 +0100
+++ b/doc/html/irccdctl/command/watch.md	Fri Dec 23 13:42:26 2016 +0100
@@ -5,8 +5,10 @@
 
 # watch
 
-Start watching irccd events. You can use different output formats, native is human readable format, json is pretty
-formatted json.
+Start watching irccd events.
+
+You can use different output formats, native is human readable format, json is
+pretty formatted json.
 
 ## Usage
 
--- a/irccdctl/cli.cpp	Fri Dec 23 13:11:54 2016 +0100
+++ b/irccdctl/cli.cpp	Fri Dec 23 13:42:26 2016 +0100
@@ -168,7 +168,7 @@
     : Cli("plugin-info",
           "get plugin information",
           "plugin-info plugin",
-          "Get plugin information\n\n"
+          "Get plugin information.\n\n"
           "Example:\n"
           "\tirccdctl plugin-info ask"
     )
@@ -245,7 +245,10 @@
     : Cli("plugin-reload",
           "reload a plugin",
           "plugin-reload plugin",
-          "Call the onReload event on the specified plugin.")
+          "Reload a plugin by calling the appropriate onReload event, the plugin is not\n"
+          "unloaded and must be already loaded.\n\n"
+          "Example:\n"
+          "\tirccdctl plugin-reload logger")
 {
 }
 
@@ -268,7 +271,7 @@
           "plugin-unload plugin",
           "Unload a loaded plugin from the irccd instance.\n\n"
           "Example:\n"
-          "tirccdctl plugin-unload logger")
+          "\tirccdctl plugin-unload logger")
 {
 }
 
@@ -317,7 +320,8 @@
     : Cli("server-cnotice",
           "send a channel notice",
           "server-cnotice server channel message",
-          "Send a message notice on a channel.\n\n"
+          "Send a notice to a public channel. This is a notice that everyone on the channel\n"
+          "will receive.\n\n"
           "Example:\n"
           "\tirccdctl server-cnotice freenode #staff \"Don't flood!\"")
 {
@@ -369,7 +373,7 @@
     : Cli("server-connect",
           "add a server",
           "server-connect [options] id host [port]",
-          "Connect to a server.\n\n"
+          "Connect to a new IRC server.\n\n"
           "Available options:\n"
           "  -c, --command\t\tspecify the command char\n"
           "  -n, --nickname\tspecify a nickname\n"
@@ -755,10 +759,10 @@
           "leave a channel",
           "server-part server channel [reason]",
           "Leave the specified channel, the reason is optional.\n\n"
-          "Not all IRC servers support giving a reason to leave a channel, do not "
-          "specify it if this is a concern.\n\n"
+          "Not all IRC servers support giving a reason to leave a channel, do not specify\n"
+          "it if this is a concern.\n\n"
           "Example:\n"
-          "\tirccdctl server-part freenode #staff"
+          "\tirccdctl server-part freenode #staff\n"
           "\tirccdctl server-part freenode #botwar \"too noisy\"")
 {
 }
@@ -1019,11 +1023,11 @@
           "watch irccd events",
           "watch [-f|--format json|native]",
           "Start watching irccd events.\n\n"
-          "You can use different output formats, native is human readable format, json is pretty"
-          "formatted json.\n\n"
+          "You can use different output formats, native is human readable format, json is\n"
+          "pretty formatted json.\n\n"
           "Example:\n"
           "\tirccdctl watch\n"
-          "\tirccdctl watch -f json\n")
+          "\tirccdctl watch -f json")
 {
 }