diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/en/configure.txt | 5 | ||||
| -rw-r--r-- | doc/en/plugins/gpg.txt | 2 | ||||
| -rw-r--r-- | doc/en/plugins/simple_notify.txt | 26 | ||||
| -rw-r--r-- | doc/en/usage.txt | 38 | ||||
| -rw-r--r-- | doc/images/simple_notify_example.png | bin | 0 -> 6623 bytes |
5 files changed, 56 insertions, 15 deletions
diff --git a/doc/en/configure.txt b/doc/en/configure.txt index 4e93a2c5..1fca2e36 100644 --- a/doc/en/configure.txt +++ b/doc/en/configure.txt @@ -55,6 +55,11 @@ section of this documentation. It is not recommended to use a resource that is easy to guess, because it can lead to presence leak. +*auto_reconnect*:: false + + Auto-reconnects you when you get disconnected. Should not be necessary, so + the default is false. + *default_nick*:: [empty] diff --git a/doc/en/plugins/gpg.txt b/doc/en/plugins/gpg.txt index 70a6fd15..a39b68a4 100644 --- a/doc/en/plugins/gpg.txt +++ b/doc/en/plugins/gpg.txt @@ -33,7 +33,7 @@ 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,python] +[source,conf] --------------------------------------------------------------------- [gpg] keyid = 091F9C78 diff --git a/doc/en/plugins/simple_notify.txt b/doc/en/plugins/simple_notify.txt new file mode 100644 index 00000000..f9ec0f74 --- /dev/null +++ b/doc/en/plugins/simple_notify.txt @@ -0,0 +1,26 @@ +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" +--------------------------------------------------------------------- + +You can put any command, instead of this one. 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 example shown above will display something like this: +image:../../images/simple_notify_example.png["Simple notify example", +title="Simple notify example"] diff --git a/doc/en/usage.txt b/doc/en/usage.txt index 5f220fd4..4db1d699 100644 --- a/doc/en/usage.txt +++ b/doc/en/usage.txt @@ -14,7 +14,7 @@ On all tabs, you get a line showing the the list of all opened tabs. Each tab has a number, each time you open a new tab, it gets the next available number. -image::../images/tab_bar.png[title="Example of 5 opened tabs"] +image:../images/tab_bar.png[title="Example of 5 opened tabs"] The tab numbered _0_ is always the _roster_ tab, the other tabs can be of any type. @@ -51,7 +51,7 @@ a conversation with one of them. Use the _arrows_ to browse the list, the _space_ key to fold or unfold a group or a contact. -image::../images/roster.png["The roster tab", title="The roster tab"] +image:../images/roster.png["The roster tab", title="The roster tab"] * _1_: The area where information messages are displayed. * _2_: The actual list of contacts. The first level is group, the second is the @@ -63,7 +63,7 @@ MultiUserChat tab This tab contains a multi-users conversation. -image::../images/muc.png["The MUC tab", title="The MUC tab"] +image:../images/muc.png["The MUC tab", title="The MUC tab"] * _1_: The conversation window, this is where all the messages and events related to the muc will be displayed. It can be scrolled up and down with @@ -95,7 +95,7 @@ Private tab This is the tab opened with the _/query_ command, letting you talk in private with a participant of a multi-users chat. -image::../images/private.png["The private tab", title="The private tab"] +image:../images/private.png["The private tab", title="The private tab"] This is just a simple one to one conversation, with a line showing the status, name and chatstate of the participant. @@ -104,7 +104,7 @@ Conversation tab ~~~~~~~~~~~~~~~~ A tab opened from the roster, to talk in private with one of your contacts. -image::../images/conversation.png["The conversation tab", title="The conversation tab"] +image:../images/conversation.png["The conversation tab", title="The conversation tab"] This is also just a simple one to one conversation, with a line showing the status, name and chatstate of the participant, as well as a line at the top showing the @@ -117,7 +117,7 @@ This tab lets you view a form receive from a remote entity, edit the values and send everything back. It is mostly used to configure MUCs with the _/configure_ command but can actually be used for almost anything. -image::../images/data_forms.png["The dataform tab", title="The dataform tab"] +image:../images/data_forms.png["The dataform tab", title="The dataform tab"] Use the _up_ and _down_ keys to go from one field to the other, and edit the value using the _space_, _left_ or _right_ keys, or by entering text. @@ -131,7 +131,7 @@ This tab lists all public rooms on a MUC service. It is currently very limited but will be improved in the future. There currently is no way to search a room or even to sort them. -image::../images/list.png["The list tab", title="The list tab"] +image:../images/list.png["The list tab", title="The list tab"] Use the _up_ and _down_ or _PageUp_ and _PageDown_ keys to browse the list, and use _Enter_ or _j_ to join the selected room. @@ -220,13 +220,14 @@ These commands work in *any* tab. */bookmarks*:: Show the current bookmarks. -*/set <option> [value]*:: Set the value to the option in your configuration - file. You can, for example, change your default nickname by doing "/set - default_nick toto" or your resource with "/set resource blabla". You can also - set an empty value (nothing) by providing no [value] after <option>. - -*/set_plugin <plugin> <option> <value>*:: Set the value of the option in a - plugin configuration file. +*/set [plugin|][section] <option> <value>*:: Set the value to the option in your + configuration file. You can, for example, change your default nickname by + doing "/set default_nick toto" or your resource with "/set resource blabla". + Doing so will write in the main config file, and in the main section + ([Poezio]). But you can also write to another section, with "/set bindings + M-i ^i", to a plugin configuration with "/set mpd_client| host main" (notice + the *|*, it is mandatory to write in a plugin), or even to another section + in a plugin configuration "/set plugin|other_section option value". */theme [theme_name]*:: Reload the theme defined in the config file. If _theme_name_ is given, this command will act like /set theme theme_name then @@ -247,6 +248,13 @@ These commands work in *any* tab. */version <jid>*:: Get the software version of the given JID (usually its XMPP client and Operating System). +*/invite <jid> <room> [reason]*:: Invite _jid_ to _room_ wit _reason_ (if + provided). + +*/decline <room> [reason]*:: Decline invitation to _room_ with _reason_. + +*/invitations*:: Show the pending invitations. + */server_cycle [server.tld] [message]*:: Disconnect and reconnect in all the rooms of server.tld. @@ -296,6 +304,8 @@ MultiUserChat tab commands close the tab. You can specify an optional message if you are still connected. */nick <nickname>*:: Change your nickname in the current room. + *Except for gmail users* because gmail.com sucks and will do weird things + if you change your nickname in a MUC. */recolor [random]*:: Re-assign a color to all the participants in the current room, based on the last time they talked. Use this if the participants diff --git a/doc/images/simple_notify_example.png b/doc/images/simple_notify_example.png Binary files differnew file mode 100644 index 00000000..e9a54399 --- /dev/null +++ b/doc/images/simple_notify_example.png |
