Mercurial > irccd

comparison irccdctl/cli.cpp @ 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 b81c6fdec22e
children c6fbb6e0e06d
comparison
equal deleted inserted replaced
390:2df0f202946c 391:d51a95714abb
166 166
167 PluginInfoCli::PluginInfoCli() 167 PluginInfoCli::PluginInfoCli()
168 : Cli("plugin-info", 168 : Cli("plugin-info",
169 "get plugin information", 169 "get plugin information",
170 "plugin-info plugin", 170 "plugin-info plugin",
171 "Get plugin information\n\n" 171 "Get plugin information.\n\n"
172 "Example:\n" 172 "Example:\n"
173 "\tirccdctl plugin-info ask" 173 "\tirccdctl plugin-info ask"
174 ) 174 )
175 { 175 {
176 } 176 }
243 243
244 PluginReloadCli::PluginReloadCli() 244 PluginReloadCli::PluginReloadCli()
245 : Cli("plugin-reload", 245 : Cli("plugin-reload",
246 "reload a plugin", 246 "reload a plugin",
247 "plugin-reload plugin", 247 "plugin-reload plugin",
248 "Call the onReload event on the specified plugin.") 248 "Reload a plugin by calling the appropriate onReload event, the plugin is not\n"
249 "unloaded and must be already loaded.\n\n"
250 "Example:\n"
251 "\tirccdctl plugin-reload logger")
249 { 252 {
250 } 253 }
251 254
252 void PluginReloadCli::exec(Irccdctl &irccdctl, const std::vector<std::string> &args) 255 void PluginReloadCli::exec(Irccdctl &irccdctl, const std::vector<std::string> &args)
253 { 256 {
266 : Cli("plugin-unload", 269 : Cli("plugin-unload",
267 "unload a plugin", 270 "unload a plugin",
268 "plugin-unload plugin", 271 "plugin-unload plugin",
269 "Unload a loaded plugin from the irccd instance.\n\n" 272 "Unload a loaded plugin from the irccd instance.\n\n"
270 "Example:\n" 273 "Example:\n"
271 "tirccdctl plugin-unload logger") 274 "\tirccdctl plugin-unload logger")
272 { 275 {
273 } 276 }
274 277
275 void PluginUnloadCli::exec(Irccdctl &irccdctl, const std::vector<std::string> &args) 278 void PluginUnloadCli::exec(Irccdctl &irccdctl, const std::vector<std::string> &args)
276 { 279 {
315 318
316 ServerChannelNoticeCli::ServerChannelNoticeCli() 319 ServerChannelNoticeCli::ServerChannelNoticeCli()
317 : Cli("server-cnotice", 320 : Cli("server-cnotice",
318 "send a channel notice", 321 "send a channel notice",
319 "server-cnotice server channel message", 322 "server-cnotice server channel message",
320 "Send a message notice on a channel.\n\n" 323 "Send a notice to a public channel. This is a notice that everyone on the channel\n"
324 "will receive.\n\n"
321 "Example:\n" 325 "Example:\n"
322 "\tirccdctl server-cnotice freenode #staff \"Don't flood!\"") 326 "\tirccdctl server-cnotice freenode #staff \"Don't flood!\"")
323 { 327 {
324 } 328 }
325 329
367 371
368 ServerConnectCli::ServerConnectCli() 372 ServerConnectCli::ServerConnectCli()
369 : Cli("server-connect", 373 : Cli("server-connect",
370 "add a server", 374 "add a server",
371 "server-connect [options] id host [port]", 375 "server-connect [options] id host [port]",
372 "Connect to a server.\n\n" 376 "Connect to a new IRC server.\n\n"
373 "Available options:\n" 377 "Available options:\n"
374 " -c, --command\t\tspecify the command char\n" 378 " -c, --command\t\tspecify the command char\n"
375 " -n, --nickname\tspecify a nickname\n" 379 " -n, --nickname\tspecify a nickname\n"
376 " -r, --realname\tspecify a real name\n" 380 " -r, --realname\tspecify a real name\n"
377 " -S, --ssl-verify\tverify SSL\n" 381 " -S, --ssl-verify\tverify SSL\n"
753 ServerPartCli::ServerPartCli() 757 ServerPartCli::ServerPartCli()
754 : Cli("server-part", 758 : Cli("server-part",
755 "leave a channel", 759 "leave a channel",
756 "server-part server channel [reason]", 760 "server-part server channel [reason]",
757 "Leave the specified channel, the reason is optional.\n\n" 761 "Leave the specified channel, the reason is optional.\n\n"
758 "Not all IRC servers support giving a reason to leave a channel, do not " 762 "Not all IRC servers support giving a reason to leave a channel, do not specify\n"
759 "specify it if this is a concern.\n\n" 763 "it if this is a concern.\n\n"
760 "Example:\n" 764 "Example:\n"
761 "\tirccdctl server-part freenode #staff" 765 "\tirccdctl server-part freenode #staff\n"
762 "\tirccdctl server-part freenode #botwar \"too noisy\"") 766 "\tirccdctl server-part freenode #botwar \"too noisy\"")
763 { 767 {
764 } 768 }
765 769
766 void ServerPartCli::exec(Irccdctl &irccdctl, const std::vector<std::string> &args) 770 void ServerPartCli::exec(Irccdctl &irccdctl, const std::vector<std::string> &args)
1017 WatchCli::WatchCli() 1021 WatchCli::WatchCli()
1018 : Cli("watch", 1022 : Cli("watch",
1019 "watch irccd events", 1023 "watch irccd events",
1020 "watch [-f|--format json|native]", 1024 "watch [-f|--format json|native]",
1021 "Start watching irccd events.\n\n" 1025 "Start watching irccd events.\n\n"
1022 "You can use different output formats, native is human readable format, json is pretty" 1026 "You can use different output formats, native is human readable format, json is\n"
1023 "formatted json.\n\n" 1027 "pretty formatted json.\n\n"
1024 "Example:\n" 1028 "Example:\n"
1025 "\tirccdctl watch\n" 1029 "\tirccdctl watch\n"
1026 "\tirccdctl watch -f json\n") 1030 "\tirccdctl watch -f json")
1027 { 1031 {
1028 } 1032 }
1029 1033
1030 void WatchCli::exec(Irccdctl& client, const std::vector<std::string>& args) 1034 void WatchCli::exec(Irccdctl& client, const std::vector<std::string>& args)
1031 { 1035 {