| blob | cc7aff3ac2870bad260373e816c62889cf2e42f4 |
1 ================================================================================
2 Org-Mode Reference Card (for version 4.79)
3 ================================================================================
5 ================================================================================
6 Getting Started
7 ================================================================================
9 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
10 (define-key global-map "\C-cl" 'org-store-link) [1]
11 (define-key global-map "\C-ca" 'org-agenda) [1]
13 For the many customization options try M-x org-customize
14 To read the on-line documentation try M-x org-info
16 ================================================================================
17 Visibility Cycling
18 ================================================================================
20 rotate current subtree between states TAB
21 rotate entire buffer between states S-TAB
22 show the whole file C-c C-a
23 reveal context around point C-c C-r
24 show subtree in indirect buffer, ded. frame C-c C-k
26 ================================================================================
27 Motion
28 ================================================================================
30 next/previous heading C-c C-n/p
31 next/previous heading, same level C-c C-f/b
32 backward to higher level heading C-c C-u
33 jump to another place in document C-c C-j
34 previous/next plain list item S-UP/DOWN [3]
36 ================================================================================
37 Structure Editing
38 ================================================================================
40 insert new heading/item at current level M-RET
41 insert new TODO entry/checkbox item M-S-RET
42 promote current heading up one level M-LEFT
43 demote current heading down one level M-RIGHT
44 promote current subtree up one level M-S-LEFT
45 demote current subtree down one level M-S-RIGHT
46 move subtree/list item up/down M-S-UP/DOWN
47 kill subtree C-c C-x C-w
48 copy subtree C-c C-x M-w
49 yank subtree C-c C-x C-y
50 narrow buffer to current subtree C-x n s
52 ================================================================================
53 Archiving
54 ================================================================================
56 toggle ARCHIVE tag C-c C-x C-a
57 force cycling of an ARCHIVEd tree C-TAB
58 move subtree to archive file C-c C-x C-s
60 ================================================================================
61 Filtering and Sparse Trees
62 ================================================================================
64 show sparse tree for all matches of a regexp C-c /
65 view TODO's in sparse tree C-c C-v
66 global TODO list in agenda mode C-c t [1]
67 create sparse tree with all deadlines due C-c C-w
68 time sorted view of current org file C-c a L
70 ================================================================================
71 Tables
72 ================================================================================
74 --------------------------------------------------------------------------------
75 Creating a table
76 --------------------------------------------------------------------------------
78 just start typing, e.g. |Name|Phone|Age RET |- TAB
79 convert region to table C-c |
80 ... separator at least 3 spaces C-3 C-c |
82 --------------------------------------------------------------------------------
83 Commands available inside tables
84 --------------------------------------------------------------------------------
86 The following commands work when the cursor is inside a table. Outside of
87 tables, the same keys may have other functionality.
89 --------------------------------------------------------------------------------
90 Re-aligning and field motion
91 --------------------------------------------------------------------------------
93 re-align the table without moving the cursor C-c C-c
94 re-align the table, move to next field TAB
95 move to previous field S-TAB
96 re-align the table, move to next row RET
98 --------------------------------------------------------------------------------
99 Row and column editing
100 --------------------------------------------------------------------------------
102 move the current column left M-LEFT/RIGHT
103 kill the current column M-S-LEFT
104 insert new column to left of cursor position M-S-RIGHT
105 move the current row up/down M-UP/DOWN
106 kill the current row or horizontal line M-S-UP
107 insert new row above the current row M-S-DOWN
108 insert hline below (C-u : above) current row C-c -
109 sort lines in region C-c ^
111 --------------------------------------------------------------------------------
112 Regions
113 --------------------------------------------------------------------------------
115 cut rectangular region C-c C-x C-w
116 copy rectangular region C-c C-x M-w
117 paste rectangular region C-c C-x C-y
118 fill paragraph across selected cells C-c C-q
120 --------------------------------------------------------------------------------
121 Miscellaneous
122 --------------------------------------------------------------------------------
124 to limit column width to N characters, use ...| <N> |...
125 edit the current field in a separate window C-c `
126 make current field fully visible C-u TAB
127 export as tab-separated file M-x org-table-export
128 import tab-separated file M-x org-table-import
129 sum numbers in current column/rectangle C-c +
131 --------------------------------------------------------------------------------
132 Tables created with the table.el package
133 --------------------------------------------------------------------------------
135 insert a new table.el table C-c ~
136 recognize existing table.el table C-c C-c
137 convert table (Org-mode <-> table.el) C-c ~
139 --------------------------------------------------------------------------------
140 Spreadsheet
141 --------------------------------------------------------------------------------
143 Formulas typed in field are executed by TAB, RET and C-c C-c. = introduces a
144 column formula, := a field formula.
146 Example: Add Col1 and Col2 |=$1+$2 |
147 ... with printf format specification |=$1+$2;%.2f|
148 ... with constants from constants.el |=$1/$c/$cm |
149 sum from 2nd to 3rd hline |:=vsum(@II..@III)|
150 apply current column formula | = |
151 set and eval column formula C-c =
152 set and eval field formula C-u C-c =
153 re-apply all stored equations to current line C-c *
154 re-apply all stored equations to entire table C-u C-c *
155 iterate table to stability C-u C-u C-c *
156 rotate calculation mark through # * ! $ C-#
157 show line, column, formula reference C-c ?
158 toggle coordinate grid C-c }
159 toggle formula debugger C-c {
161 --------------------------------------------------------------------------------
162 Formula Editor
163 --------------------------------------------------------------------------------
165 edit formulas in separate buffer C-c '
166 exit and install new formulas C-c C-c
167 exit, install, and apply new formulas C-u C-c C-c
168 abort C-c C-q
169 toggle reference style C-c C-r
170 pretty-print Lisp formula TAB
171 complete Lisp symbol M-TAB
172 shift reference point S-cursor
173 shift test line for column references M-up/down
174 scroll the window showing the table M-S-up/down
175 toggle table coordinate grid C-c }
177 ================================================================================
178 Links
179 ================================================================================
181 globally store link to the current location C-c l [1]
182 insert a link (TAB completes stored links) C-c C-l
183 insert file link with file name completion C-u C-c C-l
184 edit (also hidden part of) link at point C-c C-l
185 open file links in emacs C-c C-o
186 ... force open in emacs/other window C-u C-c C-o
187 open link at point mouse-1/2
188 ... force open in emacs/other window mouse-3
189 record a position in mark ring C-c %
190 jump back to last followed link(s) C-c &
191 find next link C-c C-x C-n
192 find previous link C-c C-x C-p
194 --------------------------------------------------------------------------------
195 Internal Links
196 --------------------------------------------------------------------------------
198 <<My Target>> target
199 <<<My Target>>> radio target [2]
200 [[*this text]] find headline
201 [[this text]] find target or text in buffer
202 [[this text][description]] optional link text
204 --------------------------------------------------------------------------------
205 External Links
206 --------------------------------------------------------------------------------
208 file:/home/dominik/img/mars.jpg file, absolute
209 file:papers/last.pdf file, relative
210 file:projects.org::*that text find headline
211 file:projects.org::find me find trgt/string
212 http://www.astro.uva.nl/dominik on the web
213 mailto:adent@galaxy.net Email address
214 news:comp.emacs Usenet group
215 bbdb:Richard Stallman BBDB person
216 gnus:group GNUS group
217 gnus:group#id GNUS message
218 vm|wl|mhe|rmail:folder Mail folder
219 vm|wl|mhe|rmail:folder#id Mail message
220 info:emacs:Regexps Info file:node
221 shell:ls *.org shell command
222 elisp:(calendar) elisp form
223 [[external link][description]] optional link text
225 ================================================================================
226 Completion
227 ================================================================================
229 In-buffer completion completes TODO keywords at headline start, TeX macros
230 after `\', option keywords after `#-â', TAGS after `:', and dictionary words
231 elsewhere.
233 complete word at point M-TAB
235 ================================================================================
236 TODO Items and Checkboxes
237 ================================================================================
239 rotate the state of the current item C-c C-t
240 select next/previous state S-LEFT/RIGHT
241 select next/previous set C-S-LEFT/RIGHT
242 view TODO items in a sparse tree C-c C-v
243 view 3rd TODO keyword's sparse tree C-3 C-c C-v
244 set the priority of the current item C-c , [ABC]
245 remove priority cookie from current item C-c , SPC
246 raise/lower priority of current item S-UP/DOWN [3]
247 insert new checkbox item in plain list M-S-RET
248 toggle checkbox(es) in region/entry/at point C-c C-x C-b
249 toggle checkbox at point C-c C-c
250 checkbox statistics cookies insert [/] or [%]
251 update checkbox statistics (C-u : whole file) C-c #
253 ================================================================================
254 Tags
255 ================================================================================
257 set tags for current heading C-c C-c
258 realign tags in all headings C-u C-c C-c
259 create sparse tree with matching tags C-c \
260 globally (agenda) match tags at cursor C-c C-o
262 ================================================================================
263 Timestamps
264 ================================================================================
266 prompt for date and insert timestamp C-c .
267 like C-c . but insert date and time format C-u C-c .
268 like C-c . but make stamp inactive C-c !
269 insert DEADLINE timestamp C-c C-d
270 insert SCHEDULED timestamp C-c C-s
271 create sparse tree with all deadlines due C-c C-w
272 the time between 2 dates in a time range C-c C-y
273 change timestamp at cursor by ±1 day S-RIGHT/LEFT [3]
274 change year/month/day at cursor by ±1 S-UP/DOWN [3]
275 access the calendar for the current date C-c >
276 insert timestamp matching date in calendar C-c <
277 access agenda for current date C-c C-o
278 select date while prompted mouse-1/RET
279 toggle custom format display for dates/times C-c C-x C-t
281 --------------------------------------------------------------------------------
282 Clocking time
283 --------------------------------------------------------------------------------
285 start clock on current item C-c C-x C-i
286 stop clock on current item C-c C-x C-o
287 cancel current clock C-c C-x C-x
288 display total subtree times C-c C-x C-d
289 remove displayed times C-c C-c
290 insert/update table with clock report C-c C-x C-r
292 ================================================================================
293 LaTeX and cdlatex-mode
294 ================================================================================
296 preview LaTeX fragment C-c C-x C-l
297 expand abbreviation (cdlatex-mode) TAB
298 insert/modify math symbol (cdlatex-mode) ` / '
300 ================================================================================
301 Agenda Views
302 ================================================================================
304 add/move current file to front of agenda C-c [
305 remove current file from your agenda C-c ]
306 cycle through agenda file list C-'
307 compile agenda for the current week C-c a a [1]
308 compile global TODO list C-c a t [1]
309 compile TODO list for specific keyword C-c a T [1]
310 match tags in agenda files C-c a m [1]
311 match tags in TODO entries C-c a M [1]
312 find stuck projects C-c a # [1]
313 show timeline of current org file C-c a L [1]
314 configure custom commands C-c a C [1]
315 configure stuck projects C-c a ! [1]
316 agenda for date at cursor C-c C-o
318 To set categories, add lines like [2]:
319 #+CATEGORY: MyCateg
321 --------------------------------------------------------------------------------
322 Commands available in an agenda buffer
323 --------------------------------------------------------------------------------
325 --------------------------------------------------------------------------------
326 View Org file
327 --------------------------------------------------------------------------------
329 show original location of item SPC/mouse-3
330 show and recenter window L
331 goto original location in other window TAB/mouse-2
332 goto original location, delete other windows RET
333 show subtree in indirect buffer, ded. frame b
334 toggle follow-mode f
336 --------------------------------------------------------------------------------
337 Change display
338 --------------------------------------------------------------------------------
340 delete other windows o
341 switch to daily / weekly view d / w
342 toggle inclusion of diary entries D
343 toggle time grid for daily schedule g
344 toggle display of logbook entries l
345 refresh agenda buffer with any changes r
346 save all org-mode buffers s
347 display the following org-agenda-ndays RIGHT
348 display the previous org-agenda-ndays LEFT
349 goto today .
351 --------------------------------------------------------------------------------
352 Remote editing
353 --------------------------------------------------------------------------------
355 digit argument 0-9
356 change state of current TODO item t
357 kill item and source C-k
358 archive the subtree $
359 show tags of current headline T
360 set tags for current headline :
361 toggle ARCHIVE tag a
362 set priority of current item p
363 raise/lower priority of current item S-UP/DOWN [3]
364 display weighted priority of current item P
365 schedule/set deadline for this item C-c C-s/d
366 change timestamp to one day earlier/later S-LEFT/RIGHT [3]
367 change timestamp to today >
368 insert new entry into diary i
369 start the clock on current item (clock-in) I
370 stop the clock (clock-out) O
371 cancel current clock X
373 --------------------------------------------------------------------------------
374 Misc
375 --------------------------------------------------------------------------------
377 Open link in current line C-c C-o
379 --------------------------------------------------------------------------------
380 Calendar commands
381 --------------------------------------------------------------------------------
383 find agenda cursor date in calendar c
384 compute agenda for calendar cursor date c
385 show phases of the moon M
386 show sunrise/sunset times S
387 show holidays H
388 convert date to other calendars C
390 --------------------------------------------------------------------------------
391 Quit and Exit
392 --------------------------------------------------------------------------------
394 quit agenda, remove agenda buffer q
395 exit agenda, remove all agenda buffers x
397 ================================================================================
398 Calendar and Diary Integration
399 ================================================================================
401 Include Emacs diary entries into Org-mode agenda with:
402 (setq org-agenda-include-diary t)
404 ================================================================================
405 Exporting and Publishing
406 ================================================================================
408 Exporting creates files with extensions .txt and .html in the current
409 directory. Publishing puts the resulting file into some other place.
411 export/publish dispatcher C-c C-e
412 export visible part only C-c C-e v
413 insert template of export options C-c C-x t
414 toggle fixed width for entry or region C-c :
416 --------------------------------------------------------------------------------
417 HTML formatting
418 --------------------------------------------------------------------------------
420 make words bold *bold*
421 make words italic /italic/
422 make words underlined _underlined_
423 sub- and superscripts x^3, J_dust
424 TeX-like macros \alpha, \to
425 typeset lines in fixed width font start with :
426 tables are exported as HTML tables start with |
427 links become HTML links http:... etc
428 include html tags @<b>...@</b>
430 --------------------------------------------------------------------------------
431 Comments: Text not being exported
432 --------------------------------------------------------------------------------
434 Text before the first headline is not considered part of the document and is
435 therefore never exported. Lines starting with # are comments and are not
436 exported. Subtrees whose header starts with COMMENT are never exported.
438 toggle COMMENT keyword on entry C-c ;
440 ================================================================================
441 Dynamic Blocks
442 ================================================================================
444 update dynamic block at point C-c C-x C-u
445 update all dynamic blocks C-u C-c C-x C-u
447 ================================================================================
448 Notes
449 ================================================================================
451 [1] This is only a suggestion for a binding of this command. Choose you own
452 key as shown under INSTALLATION.
454 [2] After changing a #+KEYWORD or <<<target>>> line, press C-c C-c with the
455 cursor still in the line to update.
457 [3] Keybinding affected by org-CUA-compatibility.