A file not ending in newline, oh the horror
[geiser.git] / doc / cheat.texi
blobf027b641ef462e2e2fc5d78adac4b31b1db61159
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 C-c C-\
46 @tab @code{geiser-insert-lambda}
47 @tab Insert greek lambda or, with prefix, a lambda form
48 @item @tab @tab
49 @item C-M-x
50 @tab @code{geiser-eval-definition}
51 @tab Eval definition around point
52 @item C-c M-e
53 @tab @code{geiser-eval-definition-and-go}
54 @tab Eval definition around point and switch to REPL
55 @item C-x C-e
56 @tab @code{geiser-eval-last-sexp}
57 @tab Eval sexp before point
58 @item C-c C-r
59 @tab @code{geiser-eval-region}
60 @tab Eval region
61 @item C-c M-r
62 @tab @code{geiser-eval-region-and-go}
63 @tab Eval region and switch to REPL
64 @item C-c C-b
65 @tab @code{geiser-eval-buffer}
66 @tab Eval buffer
67 @item C-c M-b
68 @tab @code{geiser-eval-buffer-and-go}
69 @tab Eval buffer and switch to REPL
70 @item @tab @tab
71 @item C-c C-m C-x
72 @tab @code{geiser-expand-definition}
73 @tab Macro-expand definition around point
74 @item C-c C-m C-e
75 @tab @code{geiser-expand-last-sexp}
76 @tab Macro-expand sexp before point
77 @item C-c C-m C-r
78 @tab @code{geiser-expand-region}
79 @tab Macro-expand region
80 @item @tab @tab
81 @item C-c C-k
82 @tab @code{geiser-compile-current-buffer}
83 @tab Compile and load current file
84 @item M-g n, C-x `
85 @tab @code{next-error}
86 @tab Jump to the location of next error
87 @item M-g p
88 @tab @code{previous-error}
89 @tab Jump to the location of previous error
90 @item @tab @tab
91 @item C-c C-d C-d
92 @tab @code{geiser-doc-symbol-at-point}
93 @tab See documentation for identifier at point
94 @item C-c C-d C-s
95 @tab @code{geiser-autodoc-show}
96 @tab Show signature or value for identifier at point in echo area
97 @item C-c C-d C-m
98 @tab @code{geiser-doc-module}
99 @tab See a list of a module's exported identifiers
100 @item C-c C-d C-i
101 @tab @code{geiser-doc-look-up-manual}
102 @tab Look up manual for symbol at point
103 @item C-c C-d C-a
104 @tab @code{geiser-autodoc-mode}
105 @tab Toggle autodoc mode
106 @item @tab @tab
107 @item C-c <
108 @tab @code{geiser-xref-callers}
109 @tab Show callers of procedure at point
110 @item C-c >
111 @tab @code{geiser-xref-callees}
112 @tab Show callees of procedure at point
113 @item @tab @tab
114 @item M-TAB
115 @tab @code{completion-at-point}
116 @tab Complete identifier at point
117 @item M-`, C-.
118 @tab @code{geiser-completion--complete-module}
119 @tab Complete module name at point
120 @end multitable
122 @node REPL, Documentation browser, Scheme buffers, Cheat sheet
123 @section REPL
125 @multitable @columnfractions .20 .4 .4
126 @headitem Key @tab Command @tab Description
127 @item C-c C-z
128 @tab @code{switch-to-geiser}
129 @tab Start Scheme REPL, or jump to previous buffer
130 @item C-c M-o
131 @tab @code{geiser-repl-clear-buffer}
132 @tab Clear REPL buffer
133 @item C-c C-q
134 @tab @code{geiser-repl-exit}
135 @tab Kill Scheme process
136 @item M-.
137 @tab @code{geiser-edit-symbol-at-point}
138 @tab Edit identifier at point
139 @item TAB
140 @tab @code{geiser-repl-tab-dwim}
141 @tab Complete, indent, or go to next error
142 @item S-TAB (backtab)
143 @tab @code{geiser-repl--previous-error}
144 @tab Go to previous error in the REPL buffer
145 @item M-TAB
146 @tab @code{completion-at-point}
147 @tab Complete indentifier at point
148 @item M-`, C-.
149 @tab @code{geiser-completion--complete-module}
150 @tab Complete module name at point
151 @item C-c C-r
152 @tab @code{geiser-add-to-load-path}
153 @tab Ask for a directory and add to Scheme load path
154 @item M-p, M-n
155 @tab (comint commands)
156 @tab Prompt history, matching current prefix
157 @item C-c M-p, C-c M-n
158 @tab (comint commands)
159 @tab Previous/next prompt inputs
160 @item C-c C-m
161 @tab @code{switch-to-geiser-module}
162 @tab Set current module
163 @item C-c C-i
164 @tab @code{geiser-repl-import-module}
165 @tab Import module into current namespace
166 @item C-c C-d C-d
167 @tab @code{geiser-doc-symbol-at-point}
168 @tab See documentation for symbol at point
169 @item C-c C-d C-i
170 @tab @code{geiser-doc-look-up-manual}
171 @tab Look up manual for symbol at point
172 @item C-c C-d C-m
173 @tab @code{geiser-repl--doc-module}
174 @tab See documentation for module
175 @item C-c C-d C-a
176 @tab @code{geiser-autodoc-mode}
177 @tab Toggle autodoc mode
178 @end multitable
180 @node Documentation browser,  , REPL, Cheat sheet
181 @section Documentation browser
183 @multitable @columnfractions .20 .4 .4
184 @headitem Key @tab Command @tab Description
185 @item TAB, n
186 @tab @code{forward-button}
187 @tab Next link
188 @item S-TAB, p
189 @tab @code{backward-button}
190 @tab Previous link
191 @item N
192 @tab @code{geiser-doc-next-section}
193 @tab Next section
194 @item P
195 @tab @code{geiser-doc-previous-section}
196 @tab Previous section
197 @item f
198 @tab @code{geiser-doc-next}
199 @tab Next page
200 @item b
201 @tab @code{geiser-doc-previous}
202 @tab Previous page
203 @item k
204 @tab @code{geiser-doc-kill-page}
205 @tab Kill current page and go to previous or next
206 @item g, r
207 @tab @code{geiser-doc-refresh}
208 @tab Refresh page
209 @item c
210 @tab @code{geiser-doc-clean-history}
211 @tab Clear browsing history
212 @item ., M-.
213 @tab @code{geiser-doc-edit-symbol-at-point}
214 @tab Edit identifier at point
215 @item z
216 @tab @code{geiser-doc-switch-to-repl}
217 @tab Switch to REPL
218 @item q
219 @tab @code{View-quit}
220 @tab Bury buffer
221 @end multitable
223 @ifhtml
224 @html
225 <hr>
226 @end html
227 @end ifhtml