From 8e2e1fcd4e59f67aed8cd248f3202fc10971cbde Mon Sep 17 00:00:00 2001 From: Florent Le Coz Date: Mon, 28 Nov 2011 22:32:44 +0100 Subject: We can now configure each conversation independently, for some options. Fixed #2039. --- doc/en/configure.txt | 56 ++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 52 insertions(+), 4 deletions(-) (limited to 'doc/en') diff --git a/doc/en/configure.txt b/doc/en/configure.txt index cad24be3..4e93a2c5 100644 --- a/doc/en/configure.txt +++ b/doc/en/configure.txt @@ -11,8 +11,9 @@ in the _keys_ documentation file. That file is read at each startup and the configuration is saved when poezio is closed. -This configuration file *requires* all the options to be in a section -named [Poezio]. +This configuration file *requires* all global options to be in a section +named [Poezio]. Some other options can be in optional sections and will +apply only to tabs having the option’s name. An option is formatted with the form ====================== @@ -29,6 +30,13 @@ and their default value. Configuration options --------------------- +Global section options +~~~~~~~~~~~~~~~~~~~~~~ + +These option have a sense when they are in the global section. Some of +them can also be in an optional configuration section, see the next +section of this documentation. + [horizontal] *server*:: anon.louiz.org @@ -67,8 +75,6 @@ Configuration options A password is needed only if you specified a jid. It will be ignored otherwise If you leave this empty, the password will be asked at each startup - - *rooms*:: poezio@muc.poezio.eu the rooms you will join automatically on startup, with associated nickname or not @@ -137,6 +143,10 @@ Configuration options Default setting means: - all quit and join notices will be displayed +*display_user_color_in_join_part*:: false + + If set to true, the color of the nick will be used in MUCs information + messages, instead of the default color from the theme. *information_buffer_popup_on*:: error roster warning help info @@ -309,3 +319,41 @@ Configuration options You can specify another directory to use. It will be created if it does not exist. +Optional section options +~~~~~~~~~~~~~~~~~~~~~~~~ +These option can appear in optional sections. These section are named +after a JID. These option will apply only for the given JID. For example +if an option appears in a section named [user@example.com], it will +apply only for the conversations with user@example.com. + +Note that some of these options can also appear in the global section, +they will be used as a fallback value when no JID-specific option is +found. + +.foo is _true_ for *user@example.com* but is _false_ for everyone else +============================================ +[source,conf] +------------- +[Poezio] +foo = false +[user@example.com] +foo = true +------------- +============================================ + +*disable_beep*:: false + + Disable the beeps triggered by this conversation. Works in MucTab, + PrivateTab and ConversationTab. + +*send_chat_states*:: true + + Lets you disable/enable chatstates per-JID. Works in MucTab, PrivateTab and ConversationTab. + +*display_user_color_in_join_part*:: false + +*hide_exit_join*:: -1 + +*hide_status_change*:: 120 + +*highlight_on*:: [empty] -- cgit v1.2.3 From c59f1b2aa27bb34b0ae82d9e66fb8fa200c0562a Mon Sep 17 00:00:00 2001 From: mathieui Date: Sun, 18 Dec 2011 20:38:09 +0100 Subject: Doc for invitations --- doc/en/usage.txt | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'doc/en') diff --git a/doc/en/usage.txt b/doc/en/usage.txt index 5f220fd4..c1d67bcf 100644 --- a/doc/en/usage.txt +++ b/doc/en/usage.txt @@ -247,6 +247,13 @@ These commands work in *any* tab. */version *:: Get the software version of the given JID (usually its XMPP client and Operating System). +*/invite [reason]*:: Invite _jid_ to _room_ wit _reason_ (if + provided). + +*/decline [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. -- cgit v1.2.3 From 83abd9f19666eea8edfcd30f80fbd08388bc8816 Mon Sep 17 00:00:00 2001 From: Florent Le Coz Date: Tue, 10 Jan 2012 16:30:59 +0100 Subject: Add a simple_notify plugin And also fix some issues, like the split of the exec_command arguments. And the doc for the plugin, too. --- doc/en/plugins/gpg.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/en') 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 -- cgit v1.2.3 From fa6a283b5fd8fbc5f51da7715fc546aefc2ec8f6 Mon Sep 17 00:00:00 2001 From: Florent Le Coz Date: Tue, 10 Jan 2012 16:35:53 +0100 Subject: And the simple_notify documentation --- doc/en/plugins/simple_notify.txt | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 doc/en/plugins/simple_notify.txt (limited to 'doc/en') diff --git a/doc/en/plugins/simple_notify.txt b/doc/en/plugins/simple_notify.txt new file mode 100644 index 00000000..63b7fe93 --- /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"] -- cgit v1.2.3 From 08bf7647439793b7c87c521efe0a462be85cbbcc Mon Sep 17 00:00:00 2001 From: Florent Le Coz Date: Tue, 10 Jan 2012 16:42:35 +0100 Subject: Fix image: syntax in the doc --- doc/en/plugins/simple_notify.txt | 2 +- doc/en/usage.txt | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) (limited to 'doc/en') diff --git a/doc/en/plugins/simple_notify.txt b/doc/en/plugins/simple_notify.txt index 63b7fe93..f9ec0f74 100644 --- a/doc/en/plugins/simple_notify.txt +++ b/doc/en/plugins/simple_notify.txt @@ -22,5 +22,5 @@ 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", +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 c1d67bcf..6a261f1a 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. -- cgit v1.2.3 From bbcd9c631ca6b47ad07eedc3ded9909045d6cc9e Mon Sep 17 00:00:00 2001 From: mathieui Date: Thu, 26 Jan 2012 17:21:13 +0100 Subject: Add an auto_reconnect option --- doc/en/configure.txt | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'doc/en') 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] -- cgit v1.2.3 From 383bb02f0bf0a2618de6c196d4056affbfc896d7 Mon Sep 17 00:00:00 2001 From: mathieui Date: Thu, 9 Feb 2012 16:21:21 +0100 Subject: Documentation for the new /set command --- doc/en/usage.txt | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) (limited to 'doc/en') diff --git a/doc/en/usage.txt b/doc/en/usage.txt index 6a261f1a..95c25427 100644 --- a/doc/en/usage.txt +++ b/doc/en/usage.txt @@ -220,13 +220,14 @@ These commands work in *any* tab. */bookmarks*:: Show the current bookmarks. -*/set