Minor documentation update
[clfswm.git] / doc / keys.txt
blob6fc51286c241534d0c36ffe4c41538d383865f2b
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                Tab             Select the next child
16   Mod-1 Shift          Tab             Select the previouschild
17   Shift                Tab             Store the current child and switch to the previous one
18   Mod-1                Return          Enter in the selected frame - ie make it the root frame
19   Mod-1 Shift          Return          Leave the selected frame - ie make its parent the root frame
20   Mod-5                Return          Maximize/Unmaximize the current frame in its parent frame
21   Mod-1                Page_up         Lower the child in the current frame
22   Mod-1                Page_down       Raise the child in the current frame
23   Mod-1                Home            Switch to the root frame
24   Mod-1 Shift          Home            Switch and select the root frame
25                        Menu            Switch between two layouts
26   Mod-1                Menu            Show all frames info windows until a key is release
27   Shift                Menu            Show all frames info windows
28   Control              Menu            Show/Hide the root frame
29   Mod-1                B               Move the pointer to the lower right corner of the screen
30   Control Shift        Escape          Close focus window: Delete the focus window in all frames and workspaces
31   Mod-1 Control Shift  Escape          Kill focus window: Destroy the focus window in all frames and workspaces
32   Control              Escape          Remove the focus window in the current frame
33   Shift                Escape          Unhide all hidden windows into the current child
34   Mod-1                T               Switch to editing mode
35   Control              Less            Switch to editing mode
36   Mod-1                1               Bind or jump to a slot (a frame or a window)
37   Mod-1                2               Bind or jump to a slot (a frame or a window)
38   Mod-1                3               Bind or jump to a slot (a frame or a window)
39   Mod-1                4               Bind or jump to a slot (a frame or a window)
40   Mod-1                5               Bind or jump to a slot (a frame or a window)
41   Mod-1                6               Bind or jump to a slot (a frame or a window)
42   Mod-1                7               Bind or jump to a slot (a frame or a window)
43   Mod-1                8               Bind or jump to a slot (a frame or a window)
44   Mod-1                9               Bind or jump to a slot (a frame or a window)
45   Mod-1                0               Bind or jump to a slot (a frame or a window)
48 Mouse buttons actions in main mode:
49 ----------------------------------
51                        1               Move and focus the current frame or focus the current window parent.
52 Or do actions on corners
53                        2               Do actions on corners
54                        3               Resize and focus the current frame or focus the current window parent.
55 Or do actions on corners
56   Mod-1                1               Move and focus the current child - Create a new frame on the root window
57   Mod-1                3               Resize and focus the current child - Create a new frame on the root window
58   Mod-1 Control        1               Move the window under the mouse cursor to another frame
59                        4               Select the next level in frame
60                        5               Select the previous level in frame
61   Mod-1                4               Enter in the selected frame - ie make it the root frame
62   Mod-1                5               Leave the selected frame - ie make its parent the root frame
65 Second mode keys:
66 ----------------
68   Mod-1                F1              Open the help and info window for the second mode
69                        M               Open the main menu
70                        Less            Open the main menu
71   Control              Less            Open the main menu
72                        F               Open the frame menu
73                        W               Open the window menu
74                        N               Open the action by name menu
75                        U               Open the action by number menu
76                        P               Open the frame pack menu
77                        L               Open the frame fill menu
78                        R               Open the frame resize menu
79                        I               Identify a key
80                        Colon           Eval a lisp form from the query input
81                        Exclam          Run a program from the query input
82                        Return          Leave second mode
83                        Escape          Leave second mode
84                        T               Tile the current frame
85   Mod-1 Control Shift  Home            Exit clfswm
86   Mod-1                Right           Select the next brother
87   Mod-1                Left            Select the previous brother
88   Mod-1                Down            Select the previous level in frame
89   Mod-1                Up              Select the next level in frame
90   Mod-1                Tab             Select the next child
91   Mod-1 Shift          Tab             Select the previouschild
92   Shift                Tab             Store the current child and switch to the previous one
93   Mod-1                Return          Enter in the selected frame - ie make it the root frame
94   Mod-1 Shift          Return          Leave the selected frame - ie make its parent the root frame
95   Mod-5                Return          Maximize/Unmaximize the current frame in its parent frame
96   Mod-1                Page_up         Lower the child in the current frame
97   Mod-1                Page_down       Raise the child in the current frame
98   Mod-1                Home            Switch to the root frame
99   Mod-1 Shift          Home            Switch and select the root frame
100                        Menu            Show all frames info windows until a key is release
101   Mod-1                B               Move the pointer to the lower right corner of the screen
102                        O               Open the next window in a new frame in the root frame
103   Control              O               Open the next window in a new frame in the parent frame
104                        A               Add a default frame in the current frame
105   Control Shift        Escape          Close focus window: Delete the focus window in all frames and workspaces
106   Mod-1 Control Shift  Escape          Kill focus window: Destroy the focus window in all frames and workspaces
107   Control              Escape          Remove the focus window in the current frame
108   Shift                Escape          Unhide all hidden windows into the current child
109   Control              X               Cut the current child to the selection
110   Mod-1 Control        X               Clear the current selection
111   Control              C               Copy the current child to the selection
112   Control              V               Paste the selection in the current frame
113   Control Shift        V               Paste the selection in the current frame - Do not clear the selection after paste
114                        Delete          Remove the current child from its parent frame
115                        C               start an xterm
116                        E               start emacs
117   Control              E               start an emacs for another user
118                        H               start an xclock
119   Shift                Menu            Show all frames info windows
120   Control              Menu            Show/Hide the root frame
121   Mod-1                1               Bind or jump to a slot (a frame or a window)
122   Mod-1                2               Bind or jump to a slot (a frame or a window)
123   Mod-1                3               Bind or jump to a slot (a frame or a window)
124   Mod-1                4               Bind or jump to a slot (a frame or a window)
125   Mod-1                5               Bind or jump to a slot (a frame or a window)
126   Mod-1                6               Bind or jump to a slot (a frame or a window)
127   Mod-1                7               Bind or jump to a slot (a frame or a window)
128   Mod-1                8               Bind or jump to a slot (a frame or a window)
129   Mod-1                9               Bind or jump to a slot (a frame or a window)
130   Mod-1                0               Bind or jump to a slot (a frame or a window)
133 Mouse buttons actions in second mode:
134 ------------------------------------
136                        1               Move and focus the current child - Create a new frame on the root window.
137 Or do corners actions
138                        2               Do actions on corners
139                        3               Resize and focus the current child - Create a new frame on the root window.
140 Or do corners actions
141   Mod-1                1               Move and focus the current child - Create a new frame on the root window
142   Mod-1                3               Resize and focus the current child - Create a new frame on the root window
143   Mod-1 Control        1               Move the window under the mouse cursor to another frame
144                        4               Select the next level in frame
145                        5               Select the previous level in frame
146   Mod-1                4               Enter in the selected frame - ie make it the root frame
147   Mod-1                5               Leave the selected frame - ie make its parent the root frame
150 Info mode keys:
151 --------------
153                        Q               Leave the info mode
154                        Return          Leave the info mode
155                        Escape          Leave the info mode
156                        Twosuperior     Move the pointer to the lower right corner of the screen
157                        Down            Move one line down
158                        Up              Move one line up
159                        Left            Move one char left
160                        Right           Move one char right
161                        Home            Move to first line
162                        End             Move to last line
163                        Page_down       Move ten lines down
164                        Page_up         Move ten lines up
167 Mouse buttons actions in info mode:
168 ----------------------------------
170                        1               Begin grab text
171                        2               Leave the info mode
172                        4               Move one line up
173                        5               Move one line down
174                        Motion          Grab text
178 This documentation was produced with the CLFSWM auto-doc functions.
179 To reproduce it, use the produce-doc-in-file or the produce-all-docs
180 function from the Lisp REPL.
182 Something like this:
183 LISP> (in-package :clfswm)
184 CLFSWM> (produce-doc-in-file "my-keys.txt")
186 CLFSWM> (produce-all-docs)