diff irccdctl/cli.cpp @ 391:d51a95714abb

Docs: sync html with irccdctl help messages
author David Demelier <markand@malikania.fr>
date Fri, 23 Dec 2016 13:42:26 +0100
parents b81c6fdec22e
children c6fbb6e0e06d
line wrap: on
line diff
--- 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")
 {
 }