From a954d2154b9939ef37961765ccca968459537e1d Mon Sep 17 00:00:00 2001 From: mathieui Date: Sat, 5 May 2012 19:46:37 +0200 Subject: Add help for the plugins: admin, alias, amsg, day_change, exec, figlet, mpd_client, rainbow --- doc/en/plugins/admin.txt | 34 +++++++++++++++++++ doc/en/plugins/alias.txt | 77 +++++++++++++++++++++++++++++++++++++++++++ doc/en/plugins/amsg.txt | 24 ++++++++++++++ doc/en/plugins/day_change.txt | 15 +++++++++ doc/en/plugins/exec.txt | 38 +++++++++++++++++++++ doc/en/plugins/figlet.txt | 24 ++++++++++++++ doc/en/plugins/mpd_client.txt | 54 ++++++++++++++++++++++++++++++ doc/en/plugins/rainbow.txt | 22 +++++++++++++ 8 files changed, 288 insertions(+) create mode 100644 doc/en/plugins/admin.txt create mode 100644 doc/en/plugins/alias.txt create mode 100644 doc/en/plugins/amsg.txt create mode 100644 doc/en/plugins/day_change.txt create mode 100644 doc/en/plugins/exec.txt create mode 100644 doc/en/plugins/figlet.txt create mode 100644 doc/en/plugins/mpd_client.txt create mode 100644 doc/en/plugins/rainbow.txt (limited to 'doc/en/plugins') diff --git a/doc/en/plugins/admin.txt b/doc/en/plugins/admin.txt new file mode 100644 index 00000000..c7755fac --- /dev/null +++ b/doc/en/plugins/admin.txt @@ -0,0 +1,34 @@ +Admin aliases +============= + +This plugin adds several aliases, to shorten roles/affiliations management. + +Installation +------------ +You only have to load the plugin. + +================ + + /load admin + +================ + + +Aliases +------ + +Roles +~~~~~ +- _/visitor_ +- _/participant_ +- _/moderator_ +- _/mute_ (same as _/visitor_) +- _/op_ (same as _/moderator_) + +Affiliations +~~~~~~~~~~~~ +- _/admin_ +- _/member_ +- _/noaffiliation_ (sets the affiliation to _none_) +- _/owner_ +- _/voice_ (same as _/member_) diff --git a/doc/en/plugins/alias.txt b/doc/en/plugins/alias.txt new file mode 100644 index 00000000..ee45ae63 --- /dev/null +++ b/doc/en/plugins/alias.txt @@ -0,0 +1,77 @@ +Aliases +======= + +Installation +------------ +You only have to load the plugin: + +============== + + /load alias + +============== + +Usage +----- + +This plugin defines two new global commands: _/alias_ and _/unalias_. + +alias +~~~~~~ +This command is used like this: + +=============== + + /alias my_alias an_existing_command fixed_arg + +================ +This will create a _/my_alias_ command, that when called, will run +_/an_existing_command fixed_arg_. If you give other parameters to the alias, +they will be passed to the existing command as well. + + +You can omit the _fixed_arg_ part if you don’t want to, of course. + + +There is also the possibility to change the order of parameters: + +================ +With + + /alias myalias command "%1 %0" + +The command: + + /myalias foo bar + +Will then run + + /command bar foo + +because the %1 parameter is placed before the %0. + +================ + +The numbers can be from 0 to 9. + +.Possible examples +=================== + + /alias truc say "%1 is AFTER %0 usually" + + /alias q quit + + /alias partauche ban "Partauche \"tg %0\"" + +=================== + +unalias +~~~~~~~~ + +This command removes a defined alias. + +================== + + /unalias defined_alias + +================= diff --git a/doc/en/plugins/amsg.txt b/doc/en/plugins/amsg.txt new file mode 100644 index 00000000..afac32ea --- /dev/null +++ b/doc/en/plugins/amsg.txt @@ -0,0 +1,24 @@ +Amsg +==== + +This plugin broadcasts a message to all your joined rooms. + +Installation +------------ +You only have to load the plugin. + +================ + + /load amsg + +================ + + +Command +------- + +=============== + + /amsg message + +============== diff --git a/doc/en/plugins/day_change.txt b/doc/en/plugins/day_change.txt new file mode 100644 index 00000000..e9c8bf28 --- /dev/null +++ b/doc/en/plugins/day_change.txt @@ -0,0 +1,15 @@ +Day change +========== + +This plugin adds a message at 00:00 in each of your chat tabs saying that the +date has changed. + +Installation +------------ +You only have to load the plugin. + +================ + + /load day_change + +================ diff --git a/doc/en/plugins/exec.txt b/doc/en/plugins/exec.txt new file mode 100644 index 00000000..5ef1d49f --- /dev/null +++ b/doc/en/plugins/exec.txt @@ -0,0 +1,38 @@ +Exec +==== + +This plugin lets you execute a system command through poezio. + +Installation +------------ + +You only have to load the plugin. + +================ + + /load exec + +================ + +Command +------- + +CAUTION: Running commands that start a daemon or an interface is not a good +idea. + +=============== + + /exec command + +Will give you the result in the information buffer. + + /exec -o command + +Will send the result of the command into the current tab, if possible. + + /exec -O command + +Will send the result of the command and the command summary into the current +tab, if possible. + +============== diff --git a/doc/en/plugins/figlet.txt b/doc/en/plugins/figlet.txt new file mode 100644 index 00000000..ece28f11 --- /dev/null +++ b/doc/en/plugins/figlet.txt @@ -0,0 +1,24 @@ +Figlet +====== + +This plugin uses figlet to transform every message into a big ascii-art +message. + +Installation +------------ +You only have to load the plugin (and have _figlet_ installed, of course). + +================ + + /load figlet + +================ + + +Usage +----- + +Say something. + +NOTE: Can create fun things when used with link:rainbow.html[the rainbow +plugin]. diff --git a/doc/en/plugins/mpd_client.txt b/doc/en/plugins/mpd_client.txt new file mode 100644 index 00000000..54c6fb2d --- /dev/null +++ b/doc/en/plugins/mpd_client.txt @@ -0,0 +1,54 @@ +MPD Client +========== + +This plugin is here to display what you are listening to in a chat tab. + + +Installation and configuration +------------------------------ + +Installation +~~~~~~~~~~~~ + +You need https://github.com/Mic92/python-mpd2[python-mpd], in its python3 +version. + +Then you can load the plugin. + +============== + + /load mpd_client + +============== + +Configuration +~~~~~~~~~~~~~ + +You have to put the following into _mpd_client.cfg_, as explained in +link:index.html[the index page]. + +NOTE: If you do not put anything, the plugin will try to connect to +_localhost:6600_ with no password. + +[source,conf] +--------------------------------------------------------------------- +[mpd_client] +host = the_mpd_host +port = 6600 +password = password if necessary +--------------------------------------------------------------------- + +Usage +----- + +======= + + /mpd + +Will show the current song, artist, and album + + /mpd full + +Will show the current song, artist, and album, plus a nice progress bar. + +====== diff --git a/doc/en/plugins/rainbow.txt b/doc/en/plugins/rainbow.txt new file mode 100644 index 00000000..5c72b149 --- /dev/null +++ b/doc/en/plugins/rainbow.txt @@ -0,0 +1,22 @@ +Rainbow +======= + +This plugin colors each character of a message with a random color. + +Installation +------------ +You only have to load the plugin. + +================ + + /load rainbow + +================ + + +Usage +----- + +Say something. + +NOTE: Can create fun things when used with link:figlet.html[the figlet plugin]. -- cgit v1.2.3