summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorent Le Coz <louiz@louiz.org>2011-11-08 19:43:12 +0100
committerFlorent Le Coz <louiz@louiz.org>2011-11-08 12:36:29 +0100
commite8d6c5ccc17313872e3dd99a36eeee291d41257d (patch)
tree7f108035a8f55487dfb023a8f25e5013b6036957
parentfa94e7fbe668b88b20316f6d0900d5321aeb9a70 (diff)
downloadpoezio-e8d6c5ccc17313872e3dd99a36eeee291d41257d.tar.gz
poezio-e8d6c5ccc17313872e3dd99a36eeee291d41257d.tar.bz2
poezio-e8d6c5ccc17313872e3dd99a36eeee291d41257d.tar.xz
poezio-e8d6c5ccc17313872e3dd99a36eeee291d41257d.zip
Complete the keys documentation a little bit more.
-rw-r--r--doc/en/keys.txt90
1 files changed, 73 insertions, 17 deletions
diff --git a/doc/en/keys.txt b/doc/en/keys.txt
index b49540bc..f4b659f7 100644
--- a/doc/en/keys.txt
+++ b/doc/en/keys.txt
@@ -7,12 +7,14 @@ configure them.
By default, most keys manipulating the input (where you type your
messages and commands) behave like emacs does.
-Note that keys are case sensitive. Ctrl-X is not the same than Ctrl-x
+NOTE: keys are case sensitive. Ctrl-X is not the same than Ctrl-x
+
Key bindings listing
--------------------
Some key bindings are available only in some tabs, others are global.
+
Global keys
~~~~~~~~~~~
These keys work in *any* tab.
@@ -21,15 +23,16 @@ These keys work in *any* tab.
*Ctrl-p*:: Go to the previous tab.
-*Alt-number*:: Go to tab number x.
+*Alt-number*:: Go to the tab with that number.
*Alt-j*:: Waits for you to type a two-digits number. Go to tab number xx.
-*Alt-e*:: Go to the tab with a higher priority (highlight = private message > message > non-empty input).
+*Alt-e*:: Go to the tab with a higher priority (private message >
+ highlight > message > non-empty input).
-*Alt-z*:: Go to the previous tab.
+*Alt-z*:: Go to the previously selected tab.
-*Alt-r*:: Go to the roster.
+*Alt-r*:: Go to the roster tab.
*F7*:: Shrink the information buffer.
@@ -37,33 +40,46 @@ These keys work in *any* tab.
*Ctrl-l*:: Refresh the screen.
+
Input keys
~~~~~~~~~~
These keys concern only the inputs.
+NOTE: The clipboard is common to all inputs. This lets you cut a text
+from one input to paste it into an other one.
+
*Ctrl-a*:: Move the cursor to the beginning of line.
*Ctrl-e*:: Move the cursor to the end of line.
+*Ctrl-u*:: Delete the text from the start of the input until the cursor
+ and save it to the clipboard.
+
+*Ctrl-k*:: Delete the text from the cursor until the end of the input
+ and save it to the clipboard.
+
+*Ctrl-y*:: Insert the content of the clipboard at the cursor position.
+
+
Chat tab input keys
~~~~~~~~~~~~~~~~~~~~~
-These keys work in any conversation tab (MultiUserChat, Private or Conversation tabs)
+These keys work in any conversation tab (MultiUserChat, Private or
+Conversation tabs).
*Key Up*:: Use the previous message from the message history.
*Key Down*:: Use the next message from the message history.
-*Page Up*:: Scroll up in the conversation by x lines, where x is the height of the conversation window - 1.
+*Page Up*:: Scroll up in the conversation by x lines, where x is the
+height of the conversation window - 1.
-*Page Down*:: Likfe Page Up, but down.
+*Page Down*:: Like Page Up, but down.
-*Alt-/*:: Complete what you’re typing using the "recent" words from the current conversation, if any.
+*Alt-/*:: Complete what you’re typing using the "recent" words from the
+ current conversation, if any.
*Alt-v*:: Move the separator at the bottom of the tab.
-*PageUp*:: Scroll a page of messages up.
-
-*PageDown*:: Scroll a page of messages down.
MultiUserChat tab input keys
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -76,6 +92,7 @@ These keys work only in the MultiUserChat tab.
*tabulation*:: Complete a nick.
+
MultiUserChat List tab input keys
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
These keys work only in the MultiUserChat List tab (obtained with /list <server>).
@@ -94,6 +111,7 @@ These keys work only in the MultiUserChat List tab (obtained with /list <server>
*PageDown*:: Scroll a page of messages down.
+
Roster tab input keys
~~~~~~~~~~~~~~~~~~~~~
@@ -103,12 +121,16 @@ These keys work only in the Roster tab (the tab number 0).
*s*:: Start a search on the contacts.
+*S*:: Start a (slow) search with approximation on the contacts.
+
*Alt-u*:: Move the cursor to the next group.
*Alt-y*:: Move the cursor to the previous group.
-The following will not work if you can still write things in the input
-(meaning you previously typed "s" or "/"):
+*Ctrl-c*:: Cancel the input (search or command)
+
+NOTE: The following will not work if you can still write things in the
+input (meaning you previously typed _s_ or _/_):
*Space*:: Fold/Unfold the current item.
@@ -123,18 +145,52 @@ The following will not work if you can still write things in the input
*PageDown*:: Scroll a page of contacts down.
+Data Forms tab keys
+~~~~~~~~~~~~~~~~~~~
+*Ctrl+y*:: Validate the form, send it and close the tab.
+
+*Ctrl+g*:: Cancel that form (do not send your changes) and close the
+ tab.
+
+*Up*:: Select the next field.
+
+*Down*:: Select the previous field.
+
+*Right/Left*:: Switch between possible values, in a jid-multi,
+ list-multi, list-single or text-multi field.
+
+*Space*:: Select that option
+
+
+MultiUserChat List tab input keys
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+These keys work only in the MultiUserChat List tab (obtained with /list
+<server>).
+
+*Up*:: Go up one row.
+
+*Down*:: Go down one row.
+
+*j*:: Join the MultiUserChat currently selected.
+
+*J*:: Join the MultiUserChat currently selected, without giving focus to
+ iuts tab.
+
+*Ctrl-M*:: Join the MultiUserChat currently selected (same as _j_).
+
+
Key configuration
-----------------
Bindings are keyboard shortcut aliases. You can use them
to define your own keys to replace the default ones.
-where ^x means Control + x
-and M-x means Alt + x
+where _^x_ means _Control + x_
+and _M-x_ means _Alt + x_
To know exactly what the code of a key is, just run
==================
python3 src/keyboard.py
==================
-And enter any keys
+And enter any key.
.Turn Alt-i into a tab key (completion, etc)
==================