diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/en/configure.txt | 51 | ||||
-rw-r--r-- | doc/en/index.txt | 17 | ||||
-rw-r--r-- | doc/en/keys.txt | 5 | ||||
-rw-r--r-- | doc/en/plugins.txt | 6 | ||||
-rw-r--r-- | doc/en/plugins/otr.txt | 36 | ||||
-rw-r--r-- | doc/en/plugins/simple_notify.txt | 4 |
6 files changed, 103 insertions, 16 deletions
diff --git a/doc/en/configure.txt b/doc/en/configure.txt index 36a49206..e5098da1 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 @@ -420,8 +435,44 @@ 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. + +*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 + 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/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] diff --git a/doc/en/keys.txt b/doc/en/keys.txt index c1b9b7fd..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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -105,6 +106,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 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 ~~~~~~~~~~~~~~~~ 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 +------------- ============================= 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]). |