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