Documentation update
[clfswm.git] / doc / keys.txt
blob29c2af8e11b98c9041fbb45e6ad8d43760292f64
1     * CLFSWM Keys *
2       -----------
4 Note: Mod-1 is the Meta or Alt key
6 Main mode keys:
7 --------------
9   Mod-1                F1              Open the help and info window
10   Mod-1 Control Shift  Home            Exit clfswm
11   Mod-1                Right           Select the next brother
12   Mod-1                Left            Select the previous brother
13   Mod-1                Down            Select the previous level in frame
14   Mod-1                Up              Select the next level in frame
15   Mod-1 Control        Left            Select spatially the nearest brother of the current child in the left direction
16   Mod-1 Control        Right           Select spatially the nearest brother of the current child in the right direction
17   Mod-1 Control        Up              Select spatially the nearest brother of the current child in the up direction
18   Mod-1 Control        Down            Select spatially the nearest brother of the current child in the down direction
19   Mod-1                Tab             Select the next child
20   Mod-1 Shift          Tab             Select the previous child
21   Mod-1 Control        Tab             Select the next subchild
22   Mod-1                Return          Enter in the selected frame - ie make it the root frame
23   Mod-1 Shift          Return          Leave the selected frame - ie make its parent the root frame
24   Mod-5                Return          Maximize/Unmaximize the current frame in its parent frame
25   Mod-1                Page_up         Select the previous child in the current frame
26   Mod-1                Page_down       Select the next child in the current frame
27   Mod-1 Control        Page_up         Lower the child in the current frame
28   Mod-1 Control        Page_down       Raise the child in the current frame
29   Mod-1                Home            Switch to the root frame
30   Mod-1 Shift          Home            Switch and select the root frame
31   Mod-1                F10             Switch between two layouts
32   Control Shift        F10             Present all windows in all frames (An expose like)
33                        F10             Present all windows in the current child (An expose like)
34   Control              F10             Present all windows in the current frame (An expose like)
35   Control              L2              Hide/Unhide a terminal
36   Shift                L2              Show all frames info windows until a key is release
37   Mod-1 Shift          L2              Show all frames info windows
38   Mod-1                B               Move the pointer to the lower right corner of the screen
39   Control              Escape          Close or kill the current window (ask before doing anything)
40   Mod-1                T               Switch to editing mode (second mode)
41   Control              Less            Switch to editing mode (second mode)
42   Mod-1                1               Bind or jump to a slot (a frame or a window)
43   Mod-1                2               Bind or jump to a slot (a frame or a window)
44   Mod-1                3               Bind or jump to a slot (a frame or a window)
45   Mod-1                4               Bind or jump to a slot (a frame or a window)
46   Mod-1                5               Bind or jump to a slot (a frame or a window)
47   Mod-1                6               Bind or jump to a slot (a frame or a window)
48   Mod-1                7               Bind or jump to a slot (a frame or a window)
49   Mod-1                8               Bind or jump to a slot (a frame or a window)
50   Mod-1                9               Bind or jump to a slot (a frame or a window)
51   Mod-1                0               Bind or jump to a slot (a frame or a window)
54 Mouse buttons actions in main mode:
55 ----------------------------------
57                        1               Move and focus the current frame or focus the current window parent.
58 Or do actions on corners
59                        2               Do actions on corners
60                        3               Resize and focus the current frame or focus the current window parent.
61 Or do actions on corners
62   Mod-1                1               Move and focus the current child - Create a new frame on the root window
63   Mod-1                3               Resize and focus the current child - Create a new frame on the root window
64   Mod-1 Shift          1               Move (constrained by other frames) and focus the current child - Create a new frame on the root window
65   Mod-1 Shift          3               Resize (constrained by other frames) and focus the current child - Create a new frame on the root window
66   Mod-1 Control        1               Move the child under the mouse cursor to another frame
67                        4               Select the next level in frame
68                        5               Select the previous level in frame
69   Mod-1                4               Enter in the selected frame - ie make it the root frame
70   Mod-1                5               Leave the selected frame - ie make its parent the root frame
73 Second mode keys:
74 ----------------
76   Mod-1                F1              Open the help and info window
77                        M               Open the main menu
78                        Less            Open the main menu
79   Control              Less            Open the main menu
80                        F               Open the frame menu
81                        W               Open the window menu
82                        N               Open the action by name menu
83                        U               Open the action by number menu
84                        P               Open the frame pack menu
85                        L               Open the frame fill menu
86                        R               Open the frame resize menu
87                        X               Update layout managed children position
88   Control              G               Stop all pending actions
89                        Q               Close focus window: Delete the focus window in all frames and workspaces
90                        K               Close or kill the current window (ask before doing anything)
91                        I               Identify a key
92                        Colon           Eval a lisp form from the query input
93                        Exclam          Run a program from the query input
94                        Return          Leave second mode
95                        Escape          Leave second mode
96                        T               Tile the current frame
97   Mod-1 Control Shift  Home            Exit clfswm
98   Mod-1                Right           Select the next brother
99   Mod-1                Left            Select the previous brother
100   Mod-1                Down            Select the previous level in frame
101   Mod-1                Up              Select the next level in frame
102   Mod-1 Control        Left            Select spatially the nearest brother of the current child in the left direction
103   Mod-1 Control        Right           Select spatially the nearest brother of the current child in the right direction
104   Mod-1 Control        Up              Select spatially the nearest brother of the current child in the up direction
105   Mod-1 Control        Down            Select spatially the nearest brother of the current child in the down direction
106                        Right           Speed move mouse to right
107                        Left            Speed move mouse to left
108                        Down            Speed move mouse to down
109                        Up              Speed move mouse to up
110   Control              Left            Undo last speed mouse move
111   Control              Up              Revert to the first speed move mouse
112   Control              Down            Reset speed mouse coordinates
113   Mod-1                Tab             Select the next child
114   Mod-1 Shift          Tab             Select the previous child
115   Mod-1 Control        Tab             Select the next subchild
116                        Tab             Store the current child and switch to the previous one
117   Mod-1                Return          Enter in the selected frame - ie make it the root frame
118   Mod-1 Shift          Return          Leave the selected frame - ie make its parent the root frame
119   Mod-5                Return          Maximize/Unmaximize the current frame in its parent frame
120   Mod-1                Page_up         Lower the child in the current frame
121   Mod-1                Page_down       Raise the child in the current frame
122   Mod-1                Home            Switch to the root frame
123   Mod-1 Shift          Home            Switch and select the root frame
124                        Menu            Show/Hide the root frame
125   Mod-1                B               Move the pointer to the lower right corner of the screen
126                        O               Open the next window in a new frame in the parent frame
127   Control              O               Open the next window in a new frame in the root frame
128                        A               Add a default frame in the current frame
129   Control              Escape          Close or kill the current window (ask before doing anything)
130   Control              X               Cut the current child to the selection
131   Mod-1 Control        X               Clear the current selection
132   Control              C               Copy the current child to the selection
133   Control              V               Paste the selection in the current frame
134   Control Shift        V               Paste the selection in the current frame - Do not clear the selection after paste
135   Control              Delete          Remove the current child from its parent frame
136                        Delete          Delete the current child and its children in all frames
137                        C               start an xterm
138                        E               start emacs
139   Control              E               start an emacs for another user
140                        H               start an xclock
141   Mod-1                F10             Switch between two layouts
142   Control Shift        F10             Present all windows in all frames (An expose like)
143                        F10             Present all windows in the current child (An expose like)
144   Control              F10             Present all windows in the current frame (An expose like)
145   Shift                L2              Show all frames info windows until a key is release
146   Mod-1 Shift          L2              Show all frames info windows
147   Mod-1                1               Bind or jump to a slot (a frame or a window)
148   Mod-1                2               Bind or jump to a slot (a frame or a window)
149   Mod-1                3               Bind or jump to a slot (a frame or a window)
150   Mod-1                4               Bind or jump to a slot (a frame or a window)
151   Mod-1                5               Bind or jump to a slot (a frame or a window)
152   Mod-1                6               Bind or jump to a slot (a frame or a window)
153   Mod-1                7               Bind or jump to a slot (a frame or a window)
154   Mod-1                8               Bind or jump to a slot (a frame or a window)
155   Mod-1                9               Bind or jump to a slot (a frame or a window)
156   Mod-1                0               Bind or jump to a slot (a frame or a window)
159 Mouse buttons actions in second mode:
160 ------------------------------------
162                        1               Move and focus the current child - Create a new frame on the root window.
163 Or do corners actions
164                        2               Do actions on corners
165                        3               Resize and focus the current child - Create a new frame on the root window.
166 Or do corners actions
167   Mod-1                1               Move and focus the current child - Create a new frame on the root window
168   Mod-1                3               Resize and focus the current child - Create a new frame on the root window
169   Mod-1 Shift          1               Move (constrained by other frames) and focus the current child - Create a new frame on the root window
170   Mod-1 Shift          3               Resize (constrained by other frames) and focus the current child - Create a new frame on the root window
171   Mod-1 Control        1               Move the child under the mouse cursor to another frame
172                        4               Select the next level in frame
173                        5               Select the previous level in frame
174   Mod-1                4               Enter in the selected frame - ie make it the root frame
175   Mod-1                5               Leave the selected frame - ie make its parent the root frame
178 Info mode keys:
179 --------------
181                        Q               Leave the info mode
182                        Return          Leave the info mode and valid the selected item
183                        Space           Leave the info mode and valid the selected item
184                        Escape          Leave the info mode
185   Control              G               Leave the info mode
186                        Twosuperior     Move the pointer to the lower right corner of the screen
187                        Down            Move one line down
188                        Up              Move one line up
189                        Left            Move one char left
190                        Right           Move one char right
191                        Home            Move to first line
192                        End             Move to last line
193                        Page_down       Move ten lines down
194                        Page_up         Move ten lines up
197 Mouse buttons actions in info mode:
198 ----------------------------------
200                        1               NIL
201                        2               Leave the info mode
202                        3               Leave the info mode
203                        4               Move one line up
204                        5               Move one line down
205                        Motion          NIL
208 Circulate mode keys:
209 -------------------
211                        Escape          Leave the circulate mode
212   Control              G               Leave the circulate mode
213   Mod-1                Escape          Leave the circulate mode
214   Mod-1 Control        G               Leave the circulate mode
215   Mod-1                Tab             Select the next child
216   Mod-1 Control        Tab             Select the next subchild
217   Mod-1 Shift          Tab             Select the previous child
218   Mod-1 Shift          Iso_left_tab    Select the previous child
219   Mod-1                Right           Select the next brother
220   Mod-1                Left            Select the previous borther
223 Expose windows mode keys:
224 ------------------------
226                        A               Select child 'a' (0)
227                        B               Select child 'b' (1)
228                        C               Select child 'c' (2)
229                        D               Select child 'd' (3)
230                        E               Select child 'e' (4)
231                        F               Select child 'f' (5)
232                        G               Select child 'g' (6)
233                        H               Select child 'h' (7)
234                        I               Select child 'i' (8)
235                        J               Select child 'j' (9)
236                        K               Select child 'k' (10)
237                        L               Select child 'l' (11)
238                        M               Select child 'm' (12)
239                        N               Select child 'n' (13)
240                        O               Select child 'o' (14)
241                        P               Select child 'p' (15)
242                        Q               Select child 'q' (16)
243                        R               Select child 'r' (17)
244                        S               Select child 's' (18)
245                        T               Select child 't' (19)
246                        U               Select child 'u' (20)
247                        V               Select child 'v' (21)
248                        W               Select child 'w' (22)
249                        X               Select child 'x' (23)
250                        Y               Select child 'y' (24)
251                        Z               Select child 'z' (25)
252                        Escape          Leave the expose mode
253   Control              G               Leave the expose mode
254   Mod-1                Escape          Leave the expose mode
255   Mod-1 Control        G               Leave the expose mode
256                        Return          Valid the expose mode
257                        Space           Valid the expose mode
258                        Tab             Valid the expose mode
259                        Right           Speed move mouse to right
260                        Left            Speed move mouse to left
261                        Down            Speed move mouse to down
262                        Up              Speed move mouse to up
263   Control              Left            Undo last speed mouse move
264   Control              Up              Revert to the first speed move mouse
265   Control              Down            Reset speed mouse coordinates
268 Mouse buttons actions in expose windows mode:
269 --------------------------------------------
271                        1               Valid the expose mode
272                        2               Leave the expose mode
273                        3               Leave the expose mode
277 This documentation was produced with the CLFSWM auto-doc functions.
278 To reproduce it, use the produce-doc-in-file or the produce-all-docs
279 function from the Lisp REPL.
281 Something like this:
282 LISP> (in-package :clfswm)
283 CLFSWM> (produce-doc-in-file "my-keys.txt")
285 CLFSWM> (produce-all-docs)