diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/asciidoc/fluxbox-keys.txt | 22 | ||||
-rw-r--r-- | doc/fluxbox-keys.5.in | 31 |
2 files changed, 40 insertions, 13 deletions
diff --git a/doc/asciidoc/fluxbox-keys.txt b/doc/asciidoc/fluxbox-keys.txt index ed69a57..3f3431d 100644 --- a/doc/asciidoc/fluxbox-keys.txt +++ b/doc/asciidoc/fluxbox-keys.txt | |||
@@ -55,7 +55,7 @@ are most commonly used: | |||
55 | where *Mod1* is the Alt key on the PC keyboard and *Mod4* is usually a key | 55 | where *Mod1* is the Alt key on the PC keyboard and *Mod4* is usually a key |
56 | branded with a familiar company logo. | 56 | branded with a familiar company logo. |
57 | 57 | ||
58 | There are also some special modifiers that refer to mouse button presses::: | 58 | There are also some special modifiers that refer to mouse button events::: |
59 | *OnDesktop*;; | 59 | *OnDesktop*;; |
60 | The mouse cursor is over the desktop (root window), and not any | 60 | The mouse cursor is over the desktop (root window), and not any |
61 | window. | 61 | window. |
@@ -84,13 +84,21 @@ the key, and see the name in the output. If you have some "special" keys that | |||
84 | do not produce a key name in the output of *xev(1)*, you can just use the | 84 | do not produce a key name in the output of *xev(1)*, you can just use the |
85 | keycode (NOT the keysym!) in your keys file. | 85 | keycode (NOT the keysym!) in your keys file. |
86 | 86 | ||
87 | Commands can also be bound to mouse button presses, for which the proper "key" | 87 | Commands can also be bound to mouse events ('N' denotes the number of the |
88 | name is *Mouse*'n' where 'n' is the number of the mouse button. For example, | 88 | button, eg. '1' is the primary button, '4'/'5' are the wheel buttons): |
89 | *Mouse1* is the primary button, and *Mouse4* / *Mouse5* are the scroll wheel | 89 | |
90 | events, in normal configurations. *xev(1)* can also be used to tell the button | 90 | *MouseN*;; |
91 | number. | 91 | The mouse button 'N' is pressed down and holded. |
92 | *ClickN*;; | ||
93 | The mouse button 'N' is clicked (pressed and released with no | ||
94 | movement in between) | ||
95 | *MoveN*;; | ||
96 | The mouse button 'N' is currently holded, the binded action is triggered | ||
97 | as often as the mouse moves. | ||
98 | |||
99 | |||
100 | There are some special "keys" that let you bind events to non-keyboard events: | ||
92 | 101 | ||
93 | There are some special "keys" that let you bind events to non-keyboard events::: | ||
94 | *ChangeWorkspace*;; | 102 | *ChangeWorkspace*;; |
95 | Fires when the workspace changes. This can be used to change backgrounds or | 103 | Fires when the workspace changes. This can be used to change backgrounds or |
96 | do anything else you like when you switch to a new workspace. See the | 104 | do anything else you like when you switch to a new workspace. See the |
diff --git a/doc/fluxbox-keys.5.in b/doc/fluxbox-keys.5.in index 6e641f9..2b29891 100644 --- a/doc/fluxbox-keys.5.in +++ b/doc/fluxbox-keys.5.in | |||
@@ -2,12 +2,12 @@ | |||
2 | .\" Title: fluxbox-keys | 2 | .\" Title: fluxbox-keys |
3 | .\" Author: [see the "AUTHORS" section] | 3 | .\" Author: [see the "AUTHORS" section] |
4 | .\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/> | 4 | .\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/> |
5 | .\" Date: 12/14/2009 | 5 | .\" Date: 12/17/2009 |
6 | .\" Manual: Fluxbox Manual | 6 | .\" Manual: Fluxbox Manual |
7 | .\" Source: fluxbox-keys.txt | 7 | .\" Source: fluxbox-keys.txt |
8 | .\" Language: English | 8 | .\" Language: English |
9 | .\" | 9 | .\" |
10 | .TH "FLUXBOX\-KEYS" "5" "12/14/2009" "fluxbox\-keys\&.txt" "Fluxbox Manual" | 10 | .TH "FLUXBOX\-KEYS" "5" "12/17/2009" "fluxbox\-keys\&.txt" "Fluxbox Manual" |
11 | .\" ----------------------------------------------------------------- | 11 | .\" ----------------------------------------------------------------- |
12 | .\" * set default formatting | 12 | .\" * set default formatting |
13 | .\" ----------------------------------------------------------------- | 13 | .\" ----------------------------------------------------------------- |
@@ -53,7 +53,7 @@ You can get a list of possible modifiers by calling \(oqxmodmap \-pm\(cq\&. This | |||
53 | .sp | 53 | .sp |
54 | where \fBMod1\fR is the Alt key on the PC keyboard and \fBMod4\fR is usually a key branded with a familiar company logo\&. | 54 | where \fBMod1\fR is the Alt key on the PC keyboard and \fBMod4\fR is usually a key branded with a familiar company logo\&. |
55 | .PP | 55 | .PP |
56 | There are also some special modifiers that refer to mouse button presses | 56 | There are also some special modifiers that refer to mouse button events |
57 | .RS 4 | 57 | .RS 4 |
58 | .PP | 58 | .PP |
59 | \fBOnDesktop\fR | 59 | \fBOnDesktop\fR |
@@ -90,10 +90,30 @@ You may specify a key by its key name (for example, \fBa\fR or \fBspace\fR) or b | |||
90 | .sp | 90 | .sp |
91 | If you don\(cqt know the name of a key, you can run \fBxev(1)\fR in a terminal, push the key, and see the name in the output\&. If you have some "special" keys that do not produce a key name in the output of \fBxev(1)\fR, you can just use the keycode (NOT the keysym!) in your keys file\&. | 91 | If you don\(cqt know the name of a key, you can run \fBxev(1)\fR in a terminal, push the key, and see the name in the output\&. If you have some "special" keys that do not produce a key name in the output of \fBxev(1)\fR, you can just use the keycode (NOT the keysym!) in your keys file\&. |
92 | .sp | 92 | .sp |
93 | Commands can also be bound to mouse button presses, for which the proper "key" name is \fBMouse\fR\fIn\fR where \fIn\fR is the number of the mouse button\&. For example, \fBMouse1\fR is the primary button, and \fBMouse4\fR / \fBMouse5\fR are the scroll wheel events, in normal configurations\&. \fBxev(1)\fR can also be used to tell the button number\&. | 93 | Commands can also be bound to mouse events (\fIN\fR denotes the number of the button, eg\&. \fI1\fR is the primary button, \fI4\fR/\fI5\fR are the wheel buttons): |
94 | .PP | 94 | .PP |
95 | There are some special "keys" that let you bind events to non\-keyboard events | 95 | \fBMouseN\fR |
96 | .RS 4 | 96 | .RS 4 |
97 | The mouse button | ||
98 | \fIN\fR | ||
99 | is pressed down and holded\&. | ||
100 | .RE | ||
101 | .PP | ||
102 | \fBClickN\fR | ||
103 | .RS 4 | ||
104 | The mouse button | ||
105 | \fIN\fR | ||
106 | is clicked (pressed and released with no movement in between) | ||
107 | .RE | ||
108 | .PP | ||
109 | \fBMoveN\fR | ||
110 | .RS 4 | ||
111 | The mouse button | ||
112 | \fIN\fR | ||
113 | is currently holded, the binded action is triggered as often as the mouse moves\&. | ||
114 | .RE | ||
115 | .sp | ||
116 | There are some special "keys" that let you bind events to non\-keyboard events: | ||
97 | .PP | 117 | .PP |
98 | \fBChangeWorkspace\fR | 118 | \fBChangeWorkspace\fR |
99 | .RS 4 | 119 | .RS 4 |
@@ -101,7 +121,6 @@ Fires when the workspace changes\&. This can be used to change backgrounds or do | |||
101 | \fBEXAMPLES\fR | 121 | \fBEXAMPLES\fR |
102 | below for one idea\&. | 122 | below for one idea\&. |
103 | .RE | 123 | .RE |
104 | .RE | ||
105 | .if n \{\ | 124 | .if n \{\ |
106 | .sp | 125 | .sp |
107 | .\} | 126 | .\} |