diff options
author | mathieui <mathieui@mathieui.net> | 2012-05-06 22:09:27 +0200 |
---|---|---|
committer | mathieui <mathieui@mathieui.net> | 2012-05-06 22:09:27 +0200 |
commit | 0d21c1b74b7218a4f7a58cb0c42b89926c7b3583 (patch) | |
tree | 569130fb3499fd95a0661f4c63d617bda293649e /doc/en/plugins | |
parent | 39a61486de399ccab77ce8da683a27ce7476f9cd (diff) | |
download | poezio-0d21c1b74b7218a4f7a58cb0c42b89926c7b3583.tar.gz poezio-0d21c1b74b7218a4f7a58cb0c42b89926c7b3583.tar.bz2 poezio-0d21c1b74b7218a4f7a58cb0c42b89926c7b3583.tar.xz poezio-0d21c1b74b7218a4f7a58cb0c42b89926c7b3583.zip |
Add the missing plugin docs
Diffstat (limited to 'doc/en/plugins')
-rw-r--r-- | doc/en/plugins/index.txt | 16 | ||||
-rw-r--r-- | doc/en/plugins/pacokick.txt | 27 | ||||
-rw-r--r-- | doc/en/plugins/ping.txt | 26 | ||||
-rw-r--r-- | doc/en/plugins/quote.txt | 35 | ||||
-rw-r--r-- | doc/en/plugins/reminder.txt | 76 | ||||
-rw-r--r-- | doc/en/plugins/screen_detach.txt | 15 | ||||
-rw-r--r-- | doc/en/plugins/send_delayed.txt | 34 | ||||
-rw-r--r-- | doc/en/plugins/status.txt | 25 | ||||
-rw-r--r-- | doc/en/plugins/tell.txt | 40 | ||||
-rw-r--r-- | doc/en/plugins/uptime.txt | 35 |
10 files changed, 321 insertions, 8 deletions
diff --git a/doc/en/plugins/index.txt b/doc/en/plugins/index.txt index a6ce1191..92558c30 100644 --- a/doc/en/plugins/index.txt +++ b/doc/en/plugins/index.txt @@ -97,15 +97,15 @@ Plugins index Allows encrypted and deniable exchanges using OTR. -*PacoKick*:: Random kick plugin +*PacoKick*:: link:pacokick.html[Random kick plugin] Kicks a random user in the room. -*Ping*:: XMPP Ping +*Ping*:: link:ping.html[XMPP Ping plugin] Sends a ping probe to an entity (XEP-0199) -*Quote*:: Quoting plugin +*Quote*:: link:quote.html[Quoting plugin] Adds a /quote command to quote a message at HH:MM:SS and put it in the input (to prevent painful copy/pastes). @@ -114,11 +114,11 @@ Plugins index Sends your messages in rainbow colors using XHTML-IM. -*Reminder*:: Reminder plugin +*Reminder*:: link:reminder.html[Reminder plugin] Reminds you to do something every now and then. -*Screen Detach*:: Screen status plugin +*Screen Detach*:: link:screen_detach.html[Screen status plugin] Changes your status to _away_ if the screen poezio is in is detached. @@ -126,11 +126,11 @@ Plugins index Sends a notification with a command of your choice on (non-MUC) messages. -*Status*:: Status aliases +*Status*:: link:status.html[Status aliases plugin] Adds convenient aliases to /status (/away, etc). -*Tell*:: Automatic delayed messages +*Tell*:: link:tell.html[Automated delayed messages plugin] Tells a message to a nick when he connects to a MUC. @@ -139,7 +139,7 @@ Plugins index Translates everything that is said in the poezio room into english (useful for non-french speakers). Can of course be tweaked to apply to other rooms. -*Uptime*:: Uptime plugin +*Uptime*:: link:uptime.html[Uptime plugin] Gets the uptime of a XMPP server or a component. diff --git a/doc/en/plugins/pacokick.txt b/doc/en/plugins/pacokick.txt new file mode 100644 index 00000000..a3a1b851 --- /dev/null +++ b/doc/en/plugins/pacokick.txt @@ -0,0 +1,27 @@ +PacoKick +======== + +This plugin adds a _/pacokick_ command, which is a random kick. + +Installation +------------ +You only have to load the plugin. + +================ + + /load pacokick + +================ + +Usage +----- + +If you are a moderator in a room, do + +============= + + /pacokick + +============ + +to kick someone randomly. diff --git a/doc/en/plugins/ping.txt b/doc/en/plugins/ping.txt new file mode 100644 index 00000000..b19ca314 --- /dev/null +++ b/doc/en/plugins/ping.txt @@ -0,0 +1,26 @@ +Ping +==== + +This plugin allows you to ping an entity. + +Installation +------------ +You only have to load the plugin. + +================ + + /load ping + +================ + + +Command +------- + +Globally, you can do _/ping jid@example.com_ to get a ping. + +In a MUC, you can either do it to a JID or a nick (_/ping nick_ or _/ping +jid@example.com_). + +In a private or a direct conversation, you can do _/ping_ to ping the current +interlocutor. diff --git a/doc/en/plugins/quote.txt b/doc/en/plugins/quote.txt new file mode 100644 index 00000000..526e3aa7 --- /dev/null +++ b/doc/en/plugins/quote.txt @@ -0,0 +1,35 @@ +Quote +===== + +This plugin allows you to quote messages easily. + +Installation +------------ +You only have to load the plugin. + +================ + + /load quote + +================ + +Usage +------- + +=============== + + /quote <timestamp> + +============== + +Timestamp is HH:MM:SS, and can be completed with [tab]. + +.Command example +========== + + /quote 21:12:23 + +========= + +If there is a message at 21:12:23, it will be put in the input. If there +isn’t, you will get a warning. diff --git a/doc/en/plugins/reminder.txt b/doc/en/plugins/reminder.txt new file mode 100644 index 00000000..5fec9bd0 --- /dev/null +++ b/doc/en/plugins/reminder.txt @@ -0,0 +1,76 @@ +Reminder +======== + +Installation +------------ +You only have to load the plugin: + +============== + + /load reminder + +============== + +Usage +----- +This plugin defines three new global commands: _/remind_, _/done_, and +_/tasks_. + +remind +~~~~~~ +================ + + /remind <time> <todo> + +================ + +Will remind you to do _<todo>_ every _<time>_. + + +.Time in seconds +================ + + /remind 600 Work! + +Will remind you to work every 10 minutes + +================ + +Defining the time in seconds is not really usable, so you can describe it +with days, hours, and minutes, e.g: + +.Time in a string +======================= + + /remind 1h23m "Get up" + +Will remind you to get up every 1 hour 23 minutes + +======================= + + +done +~~~~ + +Removes a reminder. + +============ + + /done <id> + +=========== + +The _id_ is found using _/tasks_. + +tasks +~~~~~ + +=============== + + /tasks + +================ + +Will print a list of the tasks, their ids, and their frequency, into the +information buffer. + diff --git a/doc/en/plugins/screen_detach.txt b/doc/en/plugins/screen_detach.txt new file mode 100644 index 00000000..3277ae4d --- /dev/null +++ b/doc/en/plugins/screen_detach.txt @@ -0,0 +1,15 @@ +Screen detach +============= + +This plugin will set your status to _away_ if you detach your screen. + +Installation +------------ +You only have to load the plugin. + +================ + + /load screen_detach + +================ + diff --git a/doc/en/plugins/send_delayed.txt b/doc/en/plugins/send_delayed.txt new file mode 100644 index 00000000..02321441 --- /dev/null +++ b/doc/en/plugins/send_delayed.txt @@ -0,0 +1,34 @@ +Send delayed +============ + +This plugin sends a message after a given time. + +Installation +------------ +You only have to load the plugin: + +============== + + /load send_delayed + +============== + +Usage +----- +This plugin defines one new command for chat tabs: _/send_delayed_. + +================ + + /send_delayed <delay> <message> + +================ + +_delay_ can be seconds, or a time-string (as in the +link:reminder.html[reminder plugin]). + +.Time in a string +======================= + + /send_delayed 5h "Hey, did you know that it’s 6AM and I’m sleeping?" + +======================= diff --git a/doc/en/plugins/status.txt b/doc/en/plugins/status.txt new file mode 100644 index 00000000..63568a71 --- /dev/null +++ b/doc/en/plugins/status.txt @@ -0,0 +1,25 @@ +Status aliases +============== + +This plugin adds several aliases, to shorten status changes. + +Installation +------------ +You only have to load the plugin. + +================ + + /load status + +================ + +Aliases +------ + +- _/afk_ (same as _/away_) +- _/available_ +- _/away_ +- _/dnd_ +- _/busy_ +- _/chat_ +- _/xa_ diff --git a/doc/en/plugins/tell.txt b/doc/en/plugins/tell.txt new file mode 100644 index 00000000..5bcda499 --- /dev/null +++ b/doc/en/plugins/tell.txt @@ -0,0 +1,40 @@ +Tell +==== + +This plugin sends a message to someone when he next joins. + +Installation +------------ +You only have to load the plugin: + +============== + + /load tell + +============== + +Usage +----- +This plugin defines two new commands for MUC tabs: _/tell_ and _/untell_. + +tell +~~~~ + +================ + + /tell <nick> <message> + +================ + + +untell +~~~~~~ + +============== + + /untell <nick> + +============= + +Will remove all the messages poezio should have sent to _<nick>_ on his next +join. diff --git a/doc/en/plugins/uptime.txt b/doc/en/plugins/uptime.txt new file mode 100644 index 00000000..95c8ad10 --- /dev/null +++ b/doc/en/plugins/uptime.txt @@ -0,0 +1,35 @@ +Uptime +====== + +This plugin retrieves the uptime of a server. + +Installation +------------ +You only have to load the plugin. + +================ + + /load uptime + +================ + + +Command +------- + +=============== + + /uptime <jid> + +============== + +Will retrieve the uptime of the server of _<jid>_. + +.Example usage +============== + + /uptime example.com + +21:54:45 Info> Server example.com online since 1d6h31m42s + +============= |