diff options
Diffstat (limited to 'doc/en/plugins')
26 files changed, 0 insertions, 1274 deletions
diff --git a/doc/en/plugins/.translate.txt b/doc/en/plugins/.translate.txt deleted file mode 100644 index cb605699..00000000 --- a/doc/en/plugins/.translate.txt +++ /dev/null @@ -1,51 +0,0 @@ -Translate -========= - -This plugin translates what is said in the groupchats using google translate. - -Installation ------------- -You only have to load the plugin. - -================ - - /load translate - -================ - -Configuration -------------- - -You can set the rooms you want to be translated in the configuration file, -with their associated language. If no language is specified, the _default_ -option is used, and if no option is set, _en_ is used as a target language. - -.No default set -===================== -[source,conf] ------------- -[translate] -poezio@muc.poezio.eu = en ------------- -===================== - -.Default set -===================== -[source,conf] -------------- -[translate] -default = fr -prosody@conference.prosody.im = -jabberfr@chat.jabberfr.org = en -------------- -===================== - -You can of course also set the options with _/set_: - -============================ - - /set translate| default jp - - /set translate|translate poezio@muc.poezio.eu en - -============================ diff --git a/doc/en/plugins/admin.txt b/doc/en/plugins/admin.txt deleted file mode 100644 index c7755fac..00000000 --- a/doc/en/plugins/admin.txt +++ /dev/null @@ -1,34 +0,0 @@ -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 deleted file mode 100644 index ee45ae63..00000000 --- a/doc/en/plugins/alias.txt +++ /dev/null @@ -1,77 +0,0 @@ -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 deleted file mode 100644 index afac32ea..00000000 --- a/doc/en/plugins/amsg.txt +++ /dev/null @@ -1,24 +0,0 @@ -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 deleted file mode 100644 index e9c8bf28..00000000 --- a/doc/en/plugins/day_change.txt +++ /dev/null @@ -1,15 +0,0 @@ -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/display_corrections.txt b/doc/en/plugins/display_corrections.txt deleted file mode 100644 index dff55afe..00000000 --- a/doc/en/plugins/display_corrections.txt +++ /dev/null @@ -1,32 +0,0 @@ -Display corrections -=================== - -Lists old versions of a corrected message. - -Installation ------------- - -============================ - - /load display_corrections - -============================ - - -Usage ------ -This plugin adds a _/display_corrections_ command that will display a list of -old versions of a message. - - -_display_corrections_ without argument will list the last corrected message, -if any is found. If an integer argument is given, _display_corrections_ will -go back gradually in the buffer to list the previous corrected messages, and so -on. - - -If you are scrolling in the buffer, poezio will list the corrected messages -starting from the first you can see. (although there are some problems with -multiline messages). - - diff --git a/doc/en/plugins/exec.txt b/doc/en/plugins/exec.txt deleted file mode 100644 index 5ef1d49f..00000000 --- a/doc/en/plugins/exec.txt +++ /dev/null @@ -1,38 +0,0 @@ -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 deleted file mode 100644 index ece28f11..00000000 --- a/doc/en/plugins/figlet.txt +++ /dev/null @@ -1,24 +0,0 @@ -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/gpg.txt b/doc/en/plugins/gpg.txt deleted file mode 100644 index a39b68a4..00000000 --- a/doc/en/plugins/gpg.txt +++ /dev/null @@ -1,101 +0,0 @@ -GPG -=== - -This plugin implements the -link:http://xmpp.org/extensions/xep-0027.html[XEP-0027] “Current Jabber OpenPGP -Usage”. - -This is a plugin used to encrypt one-to-one conversation using the PGP -encryption method. You can use it if you want really good privacy. Without this -encryption, your messages are encrypted *at least* from your client (poezio) to -your server. The message is decrypted by your server and you cannot control the -encryption method of your messages from your server to your contact’s server -(unless you are your own server’s administrator), nor from your contact’s -server to your contact’s client. - -This plugin does end-to-end encryption. This means that *only* your contact can -decrypt your messages, and it is fully encrypted during *all* its travel -through the internet. - -Note that if you are having an encrypted conversation with a contact, you can -*not* send XHTML-IM messages to him. They will be remove and be replaced by -plain text messages. - -Installation and configuration ------------------------------- - -You should autoload this plugin, as it will send your signed presence directly -on login, making it easier for your contact’s clients to know that you are -supporting GPG encryption. To do that, use the _plugins_autoload_ configuration -option. - -You need to create a plugin configuration file. Create a file named _gpg.cfg_ -into your plugins configuration directory (_~/.config/poezio/plugins_ by -default), and fill it like this: - -[source,conf] ---------------------------------------------------------------------- -[gpg] -keyid = 091F9C78 -passphrase = your OPTIONAL passphrase - -[keys] -example@jabber.org = E3CFCDE2 -juliet@xmpp.org = EF27ABCD ---------------------------------------------------------------------- - -The *Poezio* section is about your key. You need to specify the keyid, for the -key you want to use. You can as well provide a passphrase. If you don’t, you -should use a gpg agent or something like that that will ask your passphrase -whenever you need it. - -The *keys* section contains your contact’s id keys. For each contact you want -to have encrypted conversations with, add her/his JID associated with the keyid -of his/her key. - -And that’s it, now you need to talk directly to the *full* jid of your -contacts. Poezio doesn’t let you encrypt messages whom recipients is a bare -JID. - -Additionnal information on GnuPG --------------------------------- - -Create a key -~~~~~~~~~~~~ - -To create a personal key, use -================== -gpg --gen-key -================== -and fill the instructions - - -Keyid -~~~~~ -The keyid (required in the gpg.cfg configuration file) is a 8 character-long -key. You can get the ones you created or imported by using the command -======================= -gpg --list-keys -======================= -You will get something like - ---------------------------------------------------------------------- -pub 4096R/01234567 2011-11-11 -uid Your Name Here (comment) <email@example.org> -sub 4096R/AAFFBBCC 2011-11-11 - -pub 2048R/12345678 2011-11-12 [expire: 2011-11-22] -uid A contact’s name (comment) <fake@fake.fr> -sub 2048R/FFBBAACC 2011-11-12 [expire: 2011-11-22] ---------------------------------------------------------------------- - -In this example, the keyids are *01234567* and *12345678*. - -Share your key -~~~~~~~~~~~~~~ -Use -=========================== -gpg --send-keys --keyserver pgp.mit.edu <keyid> -=========================== -to upload you public key on a public server. - diff --git a/doc/en/plugins/index.txt b/doc/en/plugins/index.txt deleted file mode 100644 index 1c009998..00000000 --- a/doc/en/plugins/index.txt +++ /dev/null @@ -1,155 +0,0 @@ -Poezio plugins -============== - -Starting from the 0.7.5 version, poezio supports plugins. -Here is a quick howto and a plugin index. - - -Setting up plugins ------------------- -Poezio seeks the plugins in the _~/.local/share/poezio/plugins/_ dir (more -generally, the _$XDG_DATA_HOME/poezio/plugins/_ dir), but that can be changed -by setting the _plugins_dir_ option in the -link:../configure.html[configuration file] to the directory where you want to -put your plugins. - -This means that if you want to use a plugin, you have to copy it (the .py file or the directory) into _plugins_dir_. - - -Plugins autostart ------------------ -Use the _plugins_autoload_ option (from the -link:../configure.html[configuration file]) to select which plugins should be -loaded on startup. The value is a list of plugin names separated by spaces, -e.g. - -.plugins_autoload example ---------- -plugins_autoload = "gpg tell exec" ---------- - -Plugins configuration ---------------------- -Most plugins will manage their configuration internally, and you do not (and -should not) have to edit it, but some (e.g. mpd_client or gpg) require manual -editing (the _/set_ command can be used, but it is not pleasant to set -multiple values with it). - -The plugin configuration directory is located in _~/.config/poezio/plugins/_ -(or _$XDG_CONFIG_HOME/poezio/plugins/_) and the file related to a specific -plugin is named _plugin_name.cfg_. The configuration options should usually be -inside a section named after the plugin (sections are delimited with _[]_). - -.section example --------------- -[plugin_name] -key = value -other_key = other_value --------------- - - -Plugins index -------------- - -[horizontal] -*Admin*:: link:admin.html[Room administration plugin] - - Creates convenient aliases for MUC administration. - -*Alias*:: link:alias.html[Custom aliases plugin] - - Allows you to create your own aliases. - -*Amsg*:: link:amsg.html[Message broadcast plugin] - - Allows a message to be broadcasted on all the rooms your arein. - Caution: do not overuse. - -*Day Change*:: link:day_change.html[Day change plugin] - - Logs the day change inside the buffers, to keep track of the days when - backlogging. - -*Display corrections*:: link:display_corrections.html[Display corrections -plugin] - - Lists old versions of a corrected message. - -*Exec*:: link:exec.html[System command plugin] - - Runs a system command an optionally sends the output as a message. - -*Figlet*:: link:figlet.html[Figlet plugin] - - Ascii-art writing (requires the _figlet_ package on your system). - -*GPG*:: link:gpg.html[GnuPG plugin] - - Allows encrypted exchanges and presence signing using GnuPG. - -*IQ Show*:: IQ showing plugin - - Shows the received IQs, for debugging purposes. - -*Link*:: link:link.html[Link opener plugin] - - Opens links in a web browser, locally or remotely using a FIFO and SSH. - -*MPD Client*:: link:mpd_client.html[MPD client plugin] - - Sends the current song (and optionally the progress inside the song) to - the current (chat) tab. - -*OTR*:: link:otr.html[Off-The-Record plugin] - - Allows encrypted and deniable exchanges using OTR. - -*PacoKick*:: link:pacokick.html[Random kick plugin] - - Kicks a random user in the room. - -*Ping*:: link:ping.html[XMPP Ping plugin] - - Sends a ping probe to an entity (XEP-0199) - -*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). - -*Rainbow*:: link:rainbow.html[Rainbow plugin] - - Sends your messages in rainbow colors using XHTML-IM. - -*Reminder*:: link:reminder.html[Reminder plugin] - - Reminds you to do something every now and then. - -*Screen Detach*:: link:screen_detach.html[Screen status plugin] - - Changes your status to _away_ if the screen poezio is in is detached. - -*Simple notify*:: link:simple_notify.html[Simple notification plugin] - - Sends a notification with a command of your choice on (non-MUC) messages. - -*Status*:: link:status.html[Status aliases plugin] - - Adds convenient aliases to /status (/away, etc). - -*Tell*:: link:tell.html[Automated delayed messages plugin] - - Tells a message to a nick when he connects to a MUC. - -*Uptime*:: link:uptime.html[Uptime plugin] - - Gets the uptime of a XMPP server or a component. - -*Replace*:: link:replace.html[Replace plugin] - - Replace some patterns in your messages. - -*Time Marker*:: link:time_marker.html[Time marker plugin] - - Display the time between two messages. - diff --git a/doc/en/plugins/link.txt b/doc/en/plugins/link.txt deleted file mode 100644 index 830a206b..00000000 --- a/doc/en/plugins/link.txt +++ /dev/null @@ -1,71 +0,0 @@ -Link -==== - -Opens links in a browser. - -Installation ------------- - -First use case: local use -~~~~~~~~~~~~~~~~~~~~~~~~~ -If you use poezio on your workstation, this is for you. -You only have to load the plugin: - -============== - - /load link - -============== - -Second use case: remote use -~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If you use poezio through SSH, this is for you. - -NOTE: Small explanation: Poezio will create a -https://en.wikipedia.org/wiki/Named_pipe[Unix FIFO] and send the commands in, -and you will have to run a dæmon locally with ssh, to get those commands. - -First, set the _exec_remote_ option in the config file to _true_. Then select -the directory you want to put the fifo in (default is the current - directory, _./_), the _poezio.fifo_ file will be created there. - -After that, load the plugin: - -============ - - /load link - -============ - -And open a link with _/link_ (as described below), this will create the FIFO. - -You need to grab poezio’s sources on your client computer, or at least the -http://gitweb.louiz.org/?p=poezio;a=blob_plain;f=src/daemon.py;hb=HEAD[daemon.py] -file. - -Finally, on your client computer, run the ssh command: - -============ - - ssh toto@example.org "cat ~/poezio/poezio.fifo" | python3 daemon.py - -=========== - - -Usage ------ -This plugin adds a _/link_ command that will open the links in _firefox_. If -you want to use another browser, you can use the _/set_ command to change the -_browser_ option in the config file. - - -_/link_ without argument will open the last received link, if any is found. -If an integer argument is given, /link will go back gradually in the buffer -to open the previous link, and so on. - - -If you are scrolling in the buffer, poezio will open the links starting from -the first you can see. (although there are some problems with multiline -messages). - - diff --git a/doc/en/plugins/mpd_client.txt b/doc/en/plugins/mpd_client.txt deleted file mode 100644 index c657e314..00000000 --- a/doc/en/plugins/mpd_client.txt +++ /dev/null @@ -1,55 +0,0 @@ -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/otr.txt b/doc/en/plugins/otr.txt deleted file mode 100644 index 533f6b4b..00000000 --- a/doc/en/plugins/otr.txt +++ /dev/null @@ -1,113 +0,0 @@ -OTR -=== - -*DISCLAIMER: THE OTR LIB IS IN AN EXPERIMENTAL STATE AND SHOULD NOT BE -CONSIDERED AS ENTIRELY RELIABLE* - -('though it works pretty well') - -This plugin implements http://wiki.xmpp.org/web/OTR[Off The Record messaging]. - -This is a plugin used to encrypt one-to-one conversation using the OTR -encryption method. You can use it if you want good privacy, deniability, -authentication, and strong secrecy. Without this -encryption, your messages are encrypted *at least* from your client (poezio) to -your server. The message is decrypted by your server and you cannot control the -encryption method of your messages from your server to your contact’s server -(unless you are your own server’s administrator), nor from your contact’s -server to your contact’s client. - -This plugin does end-to-end encryption. This means that *only* your contact can -decrypt your messages, and it is fully encrypted during *all* its travel -through the internet. - -Note that if you are having an encrypted conversation with a contact, you can -*not* send XHTML-IM messages to him. They will be removed and be replaced by -plain text messages. - -Installation and configuration ------------------------------- - -To use the OTR plugin, you must first install libopenotr. - -If you use Archlinux, there is a https://aur.archlinux.org/packages.php?ID=57957[libopenotr-git] package on the AUR. - -If not, then you will have to install it by hand. - -First, clone the repo and go inside the created directory: - -============================================== -[source,bash] -------------- -git clone https://github.com/teisenbe/libopenotr.git - -cd libopenotr -------------- -============================================== - -then run autogen.sh and configure - -============ -[source,bash] -------------- -sh autogen.sh - -./configure --enable-gaping-security-hole -------------- -============ - -Then compile & install the lib: - -============ -[source,bash] -------------- -make - -sudo make install -------------- -============ - -Finally, install the python module: - -============================= -[source,bash] -------------- -python3 setup.py build - -sudo python3 setup.py install -------------- -============================= - - - -Usage ------ - -To use OTR, make sure the plugin is loaded (if not, then do /load otr). - -Once you are in a private conversation, you have to do a: - -========== - - /otr start - -========== - -The status of the OTR encryption should appear in the bar between the chat and -the input "OTR: encrypted". - - -Once you’re done, end the OTR session with - -========== - - /otr end - -========== - - -Known problems --------------- - - -Empty messages send when changing status. diff --git a/doc/en/plugins/pacokick.txt b/doc/en/plugins/pacokick.txt deleted file mode 100644 index a3a1b851..00000000 --- a/doc/en/plugins/pacokick.txt +++ /dev/null @@ -1,27 +0,0 @@ -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 deleted file mode 100644 index b19ca314..00000000 --- a/doc/en/plugins/ping.txt +++ /dev/null @@ -1,26 +0,0 @@ -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 deleted file mode 100644 index 526e3aa7..00000000 --- a/doc/en/plugins/quote.txt +++ /dev/null @@ -1,35 +0,0 @@ -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/rainbow.txt b/doc/en/plugins/rainbow.txt deleted file mode 100644 index 5c72b149..00000000 --- a/doc/en/plugins/rainbow.txt +++ /dev/null @@ -1,22 +0,0 @@ -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]. diff --git a/doc/en/plugins/reminder.txt b/doc/en/plugins/reminder.txt deleted file mode 100644 index 5fec9bd0..00000000 --- a/doc/en/plugins/reminder.txt +++ /dev/null @@ -1,76 +0,0 @@ -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/replace.txt b/doc/en/plugins/replace.txt deleted file mode 100644 index 3a17ff20..00000000 --- a/doc/en/plugins/replace.txt +++ /dev/null @@ -1,71 +0,0 @@ -Replace -======= - -Replace some patterns in a message before sending it. - - -Installation ------------- -You only have to load the plugin. - -============== - - /load replace - -============== - -Usage ------ -Insert a pattern in the form - -========= - -%pattern% - -========= - -in your message, and it will be replaced by the corresponding text. - -The list of provided patterns is: - -- _time_: Insert the current time -- _date_: Insert the current date -- _datetime_: Insert the current date and time -- _random_nick_: Insert a random nick from the current MUC -- _dice_: Insert a random number between 1 and 6 - - -Add your own pattern --------------------- - -You can easily edit this plugin to add your own patterns. For example if -don’t want to search for an insult everytime you’re angry, you can create a -curse pattern this way: - -- In the init(self) method of the Plugin class, add something like - -================ -[source,python] - self.patterns['curse'] = replace_curse -================ - -- then define a function (not a method of the Plugin class) at the bottom -of the file. For example: - - -========================================================== -[source,python] -def replace_curse(message, tab): - return random.choice(['dumb shit', 'idiot', 'moron']) -========================================================== - -and you can now use something like - -==================== -Shut up, %curse%! -==================== - -in your everyday-conversations. - -For more conveniance, you can read your nice words from a file, do whatever -you want in that function, as long as it returns a string. diff --git a/doc/en/plugins/screen_detach.txt b/doc/en/plugins/screen_detach.txt deleted file mode 100644 index 3277ae4d..00000000 --- a/doc/en/plugins/screen_detach.txt +++ /dev/null @@ -1,15 +0,0 @@ -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 deleted file mode 100644 index 02321441..00000000 --- a/doc/en/plugins/send_delayed.txt +++ /dev/null @@ -1,34 +0,0 @@ -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/simple_notify.txt b/doc/en/plugins/simple_notify.txt deleted file mode 100644 index b12e7525..00000000 --- a/doc/en/plugins/simple_notify.txt +++ /dev/null @@ -1,47 +0,0 @@ -Simple Notify -============= - -This plugin lets you execute a command, to notify you from new important -messages. - -Installation and configuration ------------------------------- - -You need to create a plugin configuration file. Create a file named _simple_notify.cfg_ -into your plugins configuration directory (_~/.config/poezio/plugins_ by -default), and fill it like this: - -[source,conf] ---------------------------------------------------------------------- -[simple_notify] -command = notify-send -i /path/to/poezio/data/poezio_80.png "New message from %(from)s" "%(body)s" ---------------------------------------------------------------------- - -[source,conf] ---------------------------------------------------------------------- -[simple_notify] -command = echo \\<%{from}s\\> %{body}s >> some.fifo -delay = 3 -after_command = echo >> some.fifo ---------------------------------------------------------------------- - -You can put any command, instead of these ones. You can also use the -special keywords _%(from)s_ and _%(body)s_ that will be replaced -directly in the command line by the author of the message, and the body. - -The first example shown above will display something like this: -image:../../images/simple_notify_example.png["Simple notify example", -title="Simple notify example"] - -The second example will first write the author and the message in a -fifo, that fifo can locally be read by some other program (was tested -with the xmobar PipeReader command, which displays what is read from a -fifo into a status bar. Be careful, you have two different fifos in -that case, don’t get confused). The delay and command_after options -are used to erase/delete/kill the notification after a certain -delay. In our example it is used to display an empty message in our -xmobar, erasing the notification after 3 seconds. - -NOTE: If you set the _exec_remote_ option to _true_ into the -link:../configure.html[main configuration file], the command will be executed -remotely (as explained in the link:link.html[/link help]). diff --git a/doc/en/plugins/status.txt b/doc/en/plugins/status.txt deleted file mode 100644 index 63568a71..00000000 --- a/doc/en/plugins/status.txt +++ /dev/null @@ -1,25 +0,0 @@ -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 deleted file mode 100644 index 5bcda499..00000000 --- a/doc/en/plugins/tell.txt +++ /dev/null @@ -1,40 +0,0 @@ -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/time_marker.txt b/doc/en/plugins/time_marker.txt deleted file mode 100644 index ad171b0d..00000000 --- a/doc/en/plugins/time_marker.txt +++ /dev/null @@ -1,31 +0,0 @@ -Time Marker -=========== - -Display the time between two messages. - -Installation ------------- - -You only have to load the plugin. - -================ - - /load amsg - -================ - -Configuration -------------- - -You can configure the minimum delay between two messages, to display the time marker, in seconds. The default is 10 minutes (aka 600 seconds). - -[source,conf] ---------------------------------------------------------------------- -[time_marker] -delay = 600 ---------------------------------------------------------------------- - -Usage ------ - -Messages like “2 hours, 25 minutes passed…” are automatically displayed into the converstation. You don’t need to (and can’t) do anything. diff --git a/doc/en/plugins/uptime.txt b/doc/en/plugins/uptime.txt deleted file mode 100644 index 95c8ad10..00000000 --- a/doc/en/plugins/uptime.txt +++ /dev/null @@ -1,35 +0,0 @@ -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 - -============= |