From 0c6a0abe8609b870570a623348b4deb62a89cd6f Mon Sep 17 00:00:00 2001 From: mathieui Date: Thu, 10 May 2012 19:25:32 +0200 Subject: Document some more options --- doc/en/configure.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'doc/en') diff --git a/doc/en/configure.txt b/doc/en/configure.txt index 36a49206..6bbf52cc 100644 --- a/doc/en/configure.txt +++ b/doc/en/configure.txt @@ -275,6 +275,10 @@ section of this documentation. the contact names). If there is no contact name, the JID will still be displayed. +*roster_show_offline*:: false + + Set this to true if you want to display the offline contacts too. + *beep_on*:: highlight private The terminal can beep on various event. Put the event you want in a list @@ -387,6 +391,17 @@ section of this documentation. You can specify another directory to use. It will be created if it does not exist. +*exec_remote*:: false + + If this is set to true, poezio will try to send the commands to a FIFO + instead of executing them locally. This is to be used in conjunction with + ssh and the daemon.py file. See the /link documentation for details. + +*remote_fifo_path*:: ./poezio.fifo + + The path of the FIFO used to send the commands (see the exec_remote option). + + Optional section options ~~~~~~~~~~~~~~~~~~~~~~~~ These option can appear in optional sections. These section are named -- cgit v1.2.3 From 28c15a889e006769d343e729b55de66df3a00526 Mon Sep 17 00:00:00 2001 From: mathieui Date: Sat, 12 May 2012 20:44:38 +0200 Subject: Add the ignore_private and private_auto_response options MUC-specific options. private_auto_response is empty by default. + new event ignored_private --- doc/en/configure.txt | 32 ++++++++++++++++++++++++++++++++ doc/en/plugins.txt | 6 ++++++ 2 files changed, 38 insertions(+) (limited to 'doc/en') diff --git a/doc/en/configure.txt b/doc/en/configure.txt index 6bbf52cc..e18b4fbb 100644 --- a/doc/en/configure.txt +++ b/doc/en/configure.txt @@ -435,8 +435,40 @@ foo = true *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. + *hide_exit_join*:: -1 + Exact same thing than hide_status_change, except that it concerns + the quit message, and that it will be hidden only if the value is 0. + Default setting means: + - all quit and join notices will be displayed + *hide_status_change*:: 120 + Set a number for this setting. + The join OR status-change notices will be + displayed according to this number. + -1: the notices will ALWAYS be displayed + 0: the notices will NEVER be displayed + n: On any other number, the notices will only be displayed + if the user involved has talked since the last n seconds + if the value is incorrect, -1 is assumed + Default setting means : + - status changes won't be displayed unless + the user talked in the last 2 minutes + *highlight_on*:: [empty] + + a list of words (separated by a colon (:)) that will be + highlighted if said by someone on a room + +*ignore_private*:: false + + Ignore private messages sent from this room. + +*private_auto_response*:: "Not in private, please." + + The message you want to be sent when someone tries to message you. + diff --git a/doc/en/plugins.txt b/doc/en/plugins.txt index 9d81ad66..3e8a0447 100644 --- a/doc/en/plugins.txt +++ b/doc/en/plugins.txt @@ -337,6 +337,12 @@ The handlers for this event are called when someone gets kicked in a MUC. * _presence_: Presence received. * _tab_: Tab of the concerned MUC. +*ignored_private*:: +message+ +tab+ + +The handlers for this event are called when a private message gets ignored. + +* _message_: Message received. +* _tab_: Tab of the concerned message. + SleekXMPP events ~~~~~~~~~~~~~~~~ -- cgit v1.2.3 From 43d43c69317e8f77f93ffaf2c099c320c63a5f85 Mon Sep 17 00:00:00 2001 From: mathieui Date: Sun, 13 May 2012 18:52:34 +0200 Subject: Add a documentation index --- doc/en/index.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 doc/en/index.txt (limited to 'doc/en') diff --git a/doc/en/index.txt b/doc/en/index.txt new file mode 100644 index 00000000..beb80d69 --- /dev/null +++ b/doc/en/index.txt @@ -0,0 +1,17 @@ +Poezio Documentation +==================== + +Welcome to the english documentation, here is a list of the availalble pages. + +Available pages +--------------- + + +* link:install.html[Installation] +* link:configure.html[Configuration] +* link:usage.html[Usage] +* link:themes.html[Theming] +* link:keys.html[Keys] +* link:plugins/index.html[Available Plugins] +* link:plugins.html[Developing plugins] +* link:xep.html[Current XEP support] -- cgit v1.2.3 From 4d7c01f8d0a544849c060cdc9df23cfc2fbc29ac Mon Sep 17 00:00:00 2001 From: mathieui Date: Sun, 13 May 2012 18:57:58 +0200 Subject: Mention exec_remote in the simple_notify plugin help --- doc/en/plugins/simple_notify.txt | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc/en') diff --git a/doc/en/plugins/simple_notify.txt b/doc/en/plugins/simple_notify.txt index f9ec0f74..c210f703 100644 --- a/doc/en/plugins/simple_notify.txt +++ b/doc/en/plugins/simple_notify.txt @@ -24,3 +24,7 @@ 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"] + +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]). -- cgit v1.2.3 From 1263b9be835868367d44fe442346dfc0e57c3261 Mon Sep 17 00:00:00 2001 From: mathieui Date: Wed, 16 May 2012 16:53:33 +0200 Subject: Update the OTR documentation --- doc/en/plugins/otr.txt | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) (limited to 'doc/en') diff --git a/doc/en/plugins/otr.txt b/doc/en/plugins/otr.txt index 26a6ed4e..533f6b4b 100644 --- a/doc/en/plugins/otr.txt +++ b/doc/en/plugins/otr.txt @@ -37,41 +37,45 @@ 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 - git clone https://git.teisen.be/repo/libopenotr.git - - cd libopenotr - +cd libopenotr +------------- ============================================== then run autogen.sh and configure ============ +[source,bash] +------------- +sh autogen.sh - sh autogen.sh - - ./configure --enable-gaping-security-hole - +./configure --enable-gaping-security-hole +------------- ============ Then compile & install the lib: ============ +[source,bash] +------------- +make - make - - sudo make install - +sudo make install +------------- ============ Finally, install the python module: ============================= +[source,bash] +------------- +python3 setup.py build - python3 setup.py build - - sudo python3 setup.py install - +sudo python3 setup.py install +------------- ============================= -- cgit v1.2.3 From 0f7bda20b8b89bf334d67da45f4fc3e4dc8117f9 Mon Sep 17 00:00:00 2001 From: mathieui Date: Thu, 17 May 2012 01:00:35 +0200 Subject: Add a way to review room highlights - Fixes #1673 This new features is available with M-p and M-n (previous/next). It saves the last highlight viewed, meaning that if you scroll in the buffer, M-n or M-p will take you to the next or previous hl compared to the one before you started scrolling. For convenience, going to the previous highlight of the first highlight will take you to the bottom of the buffer, and going to the next highlight of the last highlight will do *the same*. If there are several highlights in one message, only the first line will be considered a highlight. --- doc/en/keys.txt | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc/en') diff --git a/doc/en/keys.txt b/doc/en/keys.txt index c1b9b7fd..07fd7d17 100644 --- a/doc/en/keys.txt +++ b/doc/en/keys.txt @@ -105,6 +105,10 @@ These keys work only in the MultiUserChat tab. *Alt-y*:: Scroll the user list up. +*Alt-p*:: Scroll to the previous highlight. + +*Alt-n*:: Scroll to the next highlight. + *tabulation*:: Complete a nick. *Ctrl-c*:: Insert xhtml formatting. You have to press Ctrl-c then a character -- cgit v1.2.3 From 0f8a5abdc0818b4071bf4623a12ee95223b11ba3 Mon Sep 17 00:00:00 2001 From: mathieui Date: Thu, 17 May 2012 16:55:31 +0200 Subject: Add an option to always show the separator - Fixes #2240 --- doc/en/configure.txt | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc/en') diff --git a/doc/en/configure.txt b/doc/en/configure.txt index e18b4fbb..e5098da1 100644 --- a/doc/en/configure.txt +++ b/doc/en/configure.txt @@ -438,6 +438,10 @@ foo = true If set to true, the color of the nick will be used in MUCs information messages, instead of the default color from the theme. +*show_useless_separator*:: false + + If true, show the separator in a chat room, even if no one spoke. + *hide_exit_join*:: -1 Exact same thing than hide_status_change, except that it concerns -- cgit v1.2.3 From 3411d8ca83591adf9a92b3c1c78fbd74a4612fe7 Mon Sep 17 00:00:00 2001 From: mathieui Date: Thu, 17 May 2012 17:15:15 +0200 Subject: Add a shortcut to go to the first unread message (separator) with M-p --- doc/en/keys.txt | 1 + 1 file changed, 1 insertion(+) (limited to 'doc/en') diff --git a/doc/en/keys.txt b/doc/en/keys.txt index 07fd7d17..874614df 100644 --- a/doc/en/keys.txt +++ b/doc/en/keys.txt @@ -95,6 +95,7 @@ height of the conversation window - 1. *Alt-v*:: Move the separator at the bottom of the tab. +*Alt-h*:: Scroll to the separator, if there is one. MultiUserChat tab input keys ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.3