0d5403e5e2e5cf826332bde7732265fb04e9c72d
[geiser.git] / doc / cheat.texi
blob0d5403e5e2e5cf826332bde7732265fb04e9c72d
1 @node Cheat sheet, No hacker is an island, Between the parens, Top
2 @chapter Cheat sheet
4 In the tables below, triple chords always accept a variant with the
5 third key not modified by @key{Control}; e.g.,
6 @code{geiser-autodoc-show} is bound both to @kbd{C-c C-d C-s} and
7 @kbd{C-c C-d s}.
9 @menu
10 * Scheme buffers::
11 * REPL::
12 * Documentation browser::
13 @end menu
15 @node Scheme buffers, REPL, Cheat sheet, Cheat sheet
16 @section Scheme buffers
18 @multitable @columnfractions .20 .4 .4
19 @headitem Key @tab Command @tab Description
20 @item C-c C-z
21 @tab @code{geiser-mode-switch-to-repl}
22 @tab Switch to REPL
23 @item C-c C-a
24 @tab @code{geiser-mode-switch-to-repl-and-enter}
25 @tab Switch to REPL and current module (also @kbd{C-u C-c C-z})
26 @item C-c C-s
27 @tab @code{geiser-set-scheme}
28 @tab Specify Scheme implementation for buffer
29 @item @tab @tab
30 @item M-.
31 @tab @code{geiser-edit-symbol-at-point}
32 @tab Go to definition of identifier at point
33 @item M-,
34 @tab @code{geiser-pop-symbol-stack}
35 @tab Go back to where M-. was last invoked
36 @item C-c C-e C-m
37 @tab @code{geiser-edit-module}
38 @tab Ask for a module and open its file
39 @item C-c C-e C-l
40 @tab @code{geiser-add-to-load-path}
41 @tab Ask for a directory and add to Scheme load path
42 @item C-c C-e C-[
43 @tab @code{geiser-squarify}
44 @tab Toggle between () and [] for current form
45 @item @tab @tab
46 @item C-M-x
47 @tab @code{geiser-eval-definition}
48 @tab Eval definition around point
49 @item C-c M-e
50 @tab @code{geiser-eval-definition-and-go}
51 @tab Eval definition around point and switch to REPL
52 @item C-x C-e
53 @tab @code{geiser-eval-last-sexp}
54 @tab Eval sexp before point
55 @item C-c C-r
56 @tab @code{geiser-eval-region}
57 @tab Eval region
58 @item C-c M-r
59 @tab @code{geiser-eval-region-and-go}
60 @tab Eval region and switch to REPL
61 @item @tab @tab
62 @item C-c C-m C-x
63 @tab @code{geiser-expand-definition}
64 @tab Macro-expand definition around point
65 @item C-c C-m C-e
66 @tab @code{geiser-expand-last-sexp}
67 @tab Macro-expand sexp before point
68 @item C-c C-m C-r
69 @tab @code{geiser-expand-region}
70 @tab Macro-expand region
71 @item @tab @tab
72 @item C-c C-k
73 @tab @code{geiser-compile-current-buffer}
74 @tab Compile and load current file
75 @item M-g n, C-x `
76 @tab @code{next-error}
77 @tab Jump to the location of next error
78 @item M-g p
79 @tab @code{previous-error}
80 @tab Jump to the location of previous error
81 @item @tab @tab
82 @item C-c C-d C-d
83 @tab @code{geiser-doc-symbol-at-point}
84 @tab See documentation for identifier at point
85 @item C-c C-d C-s
86 @tab @code{geiser-autodoc-show}
87 @tab Show signature or value for identifier at point in echo area
88 @item C-c C-d C-m
89 @tab @code{geiser-doc-module}
90 @tab See a list of a module's exported identifiers
91 @item C-c C-d C-i
92 @tab @code{geiser-doc-look-up-manual}
93 @tab Look up manual for symbol at point
94 @item C-c C-d C-a
95 @tab @code{geiser-autodoc-mode}
96 @tab Toggle autodoc mode
97 @item @tab @tab
98 @item C-c <
99 @tab @code{geiser-xref-callers}
100 @tab Show callers of procedure at point
101 @item C-c >
102 @tab @code{geiser-xref-callees}
103 @tab Show callees of procedure at point
104 @item @tab @tab
105 @item M-TAB
106 @tab @code{completion-at-point}
107 @tab Complete identifier at point
108 @item M-`, C-.
109 @tab @code{geiser-completion--complete-module}
110 @tab Complete module name at point
111 @end multitable
113 @node REPL, Documentation browser, Scheme buffers, Cheat sheet
114 @section REPL
116 @multitable @columnfractions .20 .4 .4
117 @headitem Key @tab Command @tab Description
118 @item C-c C-z
119 @tab @code{switch-to-geiser}
120 @tab Start Scheme REPL, or jump to previous buffer
121 @item C-c C-q
122 @tab @code{geiser-repl-exit}
123 @tab Kill Scheme process
124 @item M-.
125 @tab @code{geiser-edit-symbol-at-point}
126 @tab Edit identifier at point
127 @item TAB
128 @tab @code{geiser-repl-tab-dwim}
129 @tab Complete, indent, or go to next error
130 @item S-TAB (backtab)
131 @tab @code{geiser-repl--previous-error}
132 @tab Go to previous error in the REPL buffer
133 @item M-TAB
134 @tab @code{completion-at-point}
135 @tab Complete indentifier at point
136 @item M-`, C-.
137 @tab @code{geiser-completion--complete-module}
138 @tab Complete module name at point
139 @item C-c C-r
140 @tab @code{geiser-add-to-load-path}
141 @tab Ask for a directory and add to Scheme load path
142 @item M-p, M-n
143 @tab (comint commands)
144 @tab Prompt history, matching current prefix
145 @item C-c M-p, C-c M-n
146 @tab (comint commands)
147 @tab Previous/next prompt inputs
148 @item C-c C-m
149 @tab @code{switch-to-geiser-module}
150 @tab Set current module
151 @item C-c C-i
152 @tab @code{geiser-repl-import-module}
153 @tab Import module into current namespace
154 @item C-c C-d C-d
155 @tab @code{geiser-doc-symbol-at-point}
156 @tab See documentation for symbol at point
157 @item C-c C-d C-i
158 @tab @code{geiser-doc-look-up-manual}
159 @tab Look up manual for symbol at point
160 @item C-c C-d C-m
161 @tab @code{geiser-repl--doc-module}
162 @tab See documentation for module
163 @item C-c C-d C-a
164 @tab @code{geiser-autodoc-mode}
165 @tab Toggle autodoc mode
166 @end multitable
168 @node Documentation browser,  , REPL, Cheat sheet
169 @section Documentation browser
171 @multitable @columnfractions .20 .4 .4
172 @headitem Key @tab Command @tab Description
173 @item TAB, n
174 @tab @code{forward-button}
175 @tab Next link
176 @item S-TAB, p
177 @tab @code{backward-button}
178 @tab Previous link
179 @item N
180 @tab @code{geiser-doc-next-section}
181 @tab Next section
182 @item P
183 @tab @code{geiser-doc-previous-section}
184 @tab Previous section
185 @item f
186 @tab @code{geiser-doc-next}
187 @tab Next page
188 @item b
189 @tab @code{geiser-doc-previous}
190 @tab Previous page
191 @item k
192 @tab @code{geiser-doc-kill-page}
193 @tab Kill current page and go to previous or next
194 @item g, r
195 @tab @code{geiser-doc-refresh}
196 @tab Refresh page
197 @item c
198 @tab @code{geiser-doc-clean-history}
199 @tab Clear browsing history
200 @item ., M-.
201 @tab @code{geiser-doc-edit-symbol-at-point}
202 @tab Edit identifier at point
203 @item z
204 @tab @code{geiser-doc-switch-to-repl}
205 @tab Switch to REPL
206 @item q
207 @tab @code{View-quit}
208 @tab Bury buffer
209 @end multitable
211 @ifhtml
212 @html
213 <hr>
214 @end html
215 @end ifhtml