summaryrefslogtreecommitdiff
path: root/doc/en/keys.txt
diff options
context:
space:
mode:
authorFlorent Le Coz <louiz@louiz.org>2011-11-03 00:09:09 +0100
committerFlorent Le Coz <louiz@louiz.org>2011-11-03 00:09:09 +0100
commitaf64505feb73592053beeb13e784379e6626b376 (patch)
tree378a70af661a498589c63ba4f9ded067aea8cedc /doc/en/keys.txt
parent0872d69eb4180d8266e12299bccd08f813807bd7 (diff)
parent027b2e2148eb79b314bb9b632c823b6d814e07f3 (diff)
downloadpoezio-af64505feb73592053beeb13e784379e6626b376.tar.gz
poezio-af64505feb73592053beeb13e784379e6626b376.tar.bz2
poezio-af64505feb73592053beeb13e784379e6626b376.tar.xz
poezio-af64505feb73592053beeb13e784379e6626b376.zip
Merge remote-tracking branch 'myrtille/doc' into doc
Conflicts: doc/en/configure.txt
Diffstat (limited to 'doc/en/keys.txt')
-rw-r--r--doc/en/keys.txt66
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/en/keys.txt b/doc/en/keys.txt
new file mode 100644
index 00000000..eaae961d
--- /dev/null
+++ b/doc/en/keys.txt
@@ -0,0 +1,66 @@
+Keys
+====
+
+This file describes the default keys of poezio and explains how to
+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
+
+Key bindings listing
+--------------------
+Some key bindings are available only in some tabs, others are global.
+
+Global keys
+~~~~~~~~~~~
+These keys work in *any* tab.
+
+*Ctrl-n*:: Go to the next tab.
+
+*Ctrl-p*:: Go to the previous tab.
+
+*Alt-number*:: Go to tab number x.
+
+*Alt-j*:: Waits for you to type a two-digits number. Go to tab number xx.
+
+Input keys
+~~~~~~~~~~
+These keys concern only the inputs.
+
+*Ctrl-a*:: Move the cursor to the beginning of line.
+
+*Ctrl-e*:: Move the cursor to the end of line.
+
+Chat tab input keys
+~~~~~~~~~~~~~~~~~~~~~
+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 Down*:: Likfe Page Up, but down.
+
+*Alt-/*:: Complete what you’re typing using the "recent" words from the current conversation, if any.
+
+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
+
+To know exactly what the code of a key is, just run
+==================
+python3 src/keyboard.py
+==================
+And enter any keys
+
+.Turn Alt-i into a tab key (completion, etc)
+==================
+M-i = ^I
+==================