aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorCarsten Dominik2005-09-23 15:49:13 +0000
committerCarsten Dominik2005-09-23 15:49:13 +0000
commitbc07911a4be5cbb60f4019067fc60249020c78b2 (patch)
tree50a7bb804a773912d71e19cdfb0466df8f7b0fd0 /man
parentde07af382e7e22af657c526ba2a44324d651df52 (diff)
downloademacs-bc07911a4be5cbb60f4019067fc60249020c78b2.tar.gz
emacs-bc07911a4be5cbb60f4019067fc60249020c78b2.zip
Version 3.16
Diffstat (limited to 'man')
-rw-r--r--man/org.texi146
1 files changed, 105 insertions, 41 deletions
diff --git a/man/org.texi b/man/org.texi
index 4e47bea2d04..92248c91e87 100644
--- a/man/org.texi
+++ b/man/org.texi
@@ -4,7 +4,7 @@
4@setfilename ../info/org 4@setfilename ../info/org
5@settitle Org Mode Manual 5@settitle Org Mode Manual
6 6
7@set VERSION 3.15 7@set VERSION 3.16
8@set DATE September 2005 8@set DATE September 2005
9 9
10@dircategory Emacs 10@dircategory Emacs
@@ -39,7 +39,7 @@ Copyright @copyright{} 2004, 2005 Free Software Foundation
39 39
40@quotation 40@quotation
41Permission is granted to copy, distribute and/or modify this document 41Permission is granted to copy, distribute and/or modify this document
42under the terms of the GNU Free Documentation License, Version 1.2 or 42under the terms of the GNU Free Documentation License, Version 1.1 or
43any later version published by the Free Software Foundation; with no 43any later version published by the Free Software Foundation; with no
44Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' 44Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
45and with the Back-Cover Texts as in (a) below. A copy of the 45and with the Back-Cover Texts as in (a) below. A copy of the
@@ -100,7 +100,7 @@ Document Structure
100 100
101* Outlines:: Org-mode is based on outline-mode 101* Outlines:: Org-mode is based on outline-mode
102* Headlines:: How to typeset org-tree headlines 102* Headlines:: How to typeset org-tree headlines
103* Visibility cycling:: Show ad hide, much simplified 103* Visibility cycling:: Show and hide, much simplified
104* Motion:: Jumping to other headlines 104* Motion:: Jumping to other headlines
105* Structure editing:: Changing sequence and level of headlines 105* Structure editing:: Changing sequence and level of headlines
106* Archiving:: Move done task trees to a different place 106* Archiving:: Move done task trees to a different place
@@ -120,7 +120,7 @@ Calculations in tables
120* Advanced features:: Field names, parameters and automatic recalc 120* Advanced features:: Field names, parameters and automatic recalc
121* Named-field formulas:: Formulas valid in single fields 121* Named-field formulas:: Formulas valid in single fields
122* Editing/debugging formulas:: Changing a stored formula 122* Editing/debugging formulas:: Changing a stored formula
123* Appetizer:: 123* Appetizer:: Taste the power of calc
124 124
125Hyperlinks 125Hyperlinks
126 126
@@ -169,6 +169,7 @@ Miscellaneous
169* Customization:: Adapting Org-mode to your taste 169* Customization:: Adapting Org-mode to your taste
170* FAQ:: Frequently asked questions 170* FAQ:: Frequently asked questions
171* Interaction:: Other Emacs packages 171* Interaction:: Other Emacs packages
172* TTY keys:: Using Org-mode on a tty
172* Bugs:: Things which do not work perfectly 173* Bugs:: Things which do not work perfectly
173* Acknowledgments:: These people provided feedback and more 174* Acknowledgments:: These people provided feedback and more
174 175
@@ -312,7 +313,7 @@ edit the structure of the document.
312@menu 313@menu
313* Outlines:: Org-mode is based on outline-mode 314* Outlines:: Org-mode is based on outline-mode
314* Headlines:: How to typeset org-tree headlines 315* Headlines:: How to typeset org-tree headlines
315* Visibility cycling:: Show ad hide, much simplified 316* Visibility cycling:: Show and hide, much simplified
316* Motion:: Jumping to other headlines 317* Motion:: Jumping to other headlines
317* Structure editing:: Changing sequence and level of headlines 318* Structure editing:: Changing sequence and level of headlines
318* Archiving:: Move done task trees to a different place 319* Archiving:: Move done task trees to a different place
@@ -475,14 +476,14 @@ Move subtree up (swap with previous subtree of same level)
475@kindex M-S-@key{down} 476@kindex M-S-@key{down}
476@item M-S-@key{down} 477@item M-S-@key{down}
477Move subtree down (swap with next subtree of same level) 478Move subtree down (swap with next subtree of same level)
478@kindex C-c C-h C-w 479@kindex C-c C-x C-w
479@item C-c C-h C-w 480@item C-c C-x C-w
480Kill subtree, i.e. remove it from buffer but save in kill ring. 481Kill subtree, i.e. remove it from buffer but save in kill ring.
481@kindex C-c C-h M-w 482@kindex C-c C-x M-w
482@item C-c C-h M-w 483@item C-c C-x M-w
483Copy subtree to kill ring. 484Copy subtree to kill ring.
484@kindex C-c C-h C-y 485@kindex C-c C-x C-y
485@item C-c C-h C-y 486@item C-c C-x C-y
486Yank subtree from kill ring. This does modify the level of the subtree to 487Yank subtree from kill ring. This does modify the level of the subtree to
487make sure the tree fits in nicely at the yank position. The yank 488make sure the tree fits in nicely at the yank position. The yank
488level can also be specified with a prefix arg, or by yanking after a 489level can also be specified with a prefix arg, or by yanking after a
@@ -610,10 +611,18 @@ create the above table, you would only type
610|Name|Phone|Age 611|Name|Phone|Age
611|- 612|-
612@end example 613@end example
613
614@noindent and then press @key{TAB} to align the table and start filling in 614@noindent and then press @key{TAB} to align the table and start filling in
615fields. 615fields.
616 616
617When typing text into a field, Org-mode treats @key{DEL},
618@key{Backspace}, and all character keys in a special way, so that
619inserting and deleting avoids shifting other fields. Also, when
620typing @emph{immediately after the cursor was moved into a new field
621with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
622field is automatically made blank. If this behavior is too
623unpredictable for you, configure the variables
624@code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
625
617@table @kbd 626@table @kbd
618@tsubheading{Creation and conversion} 627@tsubheading{Creation and conversion}
619@item M-x org-table-create 628@item M-x org-table-create
@@ -684,17 +693,17 @@ Insert a horizontal line below current row. With prefix arg, the line
684is created above the current line. 693is created above the current line.
685 694
686@tsubheading{Regions} 695@tsubheading{Regions}
687@kindex C-c C-h M-w 696@kindex C-c C-x M-w
688@item C-c C-h M-w 697@item C-c C-x M-w
689Copy a rectangular region from a table to a special clipboard. Point 698Copy a rectangular region from a table to a special clipboard. Point
690and mark determine edge fields of the rectangle. The process ignores 699and mark determine edge fields of the rectangle. The process ignores
691horizontal separator lines. 700horizontal separator lines.
692@kindex C-c C-h C-w 701@kindex C-c C-x C-w
693@item C-c C-h C-w 702@item C-c C-x C-w
694Copy a rectangular region from a table to a special clipboard, and 703Copy a rectangular region from a table to a special clipboard, and
695blank all fields in the rectangle. So this is the ``cut'' operation. 704blank all fields in the rectangle. So this is the ``cut'' operation.
696@kindex C-c C-h C-y 705@kindex C-c C-x C-y
697@item C-c C-h C-y 706@item C-c C-x C-y
698Paste a rectangular region into a table. 707Paste a rectangular region into a table.
699The upper right corner ends up in the current field. All involved fields 708The upper right corner ends up in the current field. All involved fields
700will be overwritten. If the rectangle does not fit into the present table, 709will be overwritten. If the rectangle does not fit into the present table,
@@ -802,16 +811,16 @@ it off with
802@section Calculations in tables 811@section Calculations in tables
803@cindex calculations, in tables 812@cindex calculations, in tables
804 813
805The table editor has some spreadsheet-like capabilities. The Emacs 814The table editor makes use of the Emacs @file{calc} package to
806@file{calc} package is required for this feature to work. There are 815implement spreadsheet-like capabilities. Org-mode has two levels of
807basically two levels of complexity for table calculations in Org-mode. 816complexity for table calculations. On the basic level, tables do only
808On the basic level, tables do only horizontal computations, so a field 817horizontal computations, so a field can be computed from other fields
809can be computed from other fields @emph{in the same row}, and Org-mode 818@emph{in the same row}, and Org-mode assumes that there is only one
810assumes that there is only one formula for each column. This is very 819formula for each column. This is very efficient to work with and
811efficient to work with and enough for many tasks. On the complex 820enough for many tasks. On the complex level, columns and individual
812level, columns and individual fields can be named for easier 821fields can be named for easier referencing in formulas, individual
813referencing in formulas, individual named fields can have their own 822named fields can have their own formula associated with them, and
814formula associated with them, and recalculation can be automated. 823recalculation can be automated.
815 824
816@menu 825@menu
817* Formula syntax:: How to write a formula 826* Formula syntax:: How to write a formula
@@ -859,8 +868,8 @@ A formula can contain an optional mode string after a semicolon. This
859string consists of flags to influence calc's modes@footnote{By 868string consists of flags to influence calc's modes@footnote{By
860default, Org-mode uses the standard calc modes (precision 12, angular 869default, Org-mode uses the standard calc modes (precision 12, angular
861units degrees, fraction and symbolic modes off). However, the display 870units degrees, fraction and symbolic modes off). However, the display
862format which has been changed to @code{(float 5)} to keep tables 871format has been changed to @code{(float 5)} to keep tables compact.
863compact. The default settings can be configured using the variable 872The default settings can be configured using the variable
864@code{org-calc-default-modes}.} during execution, e.g. @samp{p20} to 873@code{org-calc-default-modes}.} during execution, e.g. @samp{p20} to
865switch the internal precision to 20 digits, @samp{n3}, @samp{s3}, 874switch the internal precision to 20 digits, @samp{n3}, @samp{s3},
866@samp{e2} or @samp{f4} to switch to normal, scientific, engineering, 875@samp{e2} or @samp{f4} to switch to normal, scientific, engineering,
@@ -1357,8 +1366,9 @@ of working on an item, for example
1357@end lisp 1366@end lisp
1358 1367
1359@cindex completion, of TODO keywords 1368@cindex completion, of TODO keywords
1369Changing these variables becomes only effective in a new Emacs session.
1360With this setup, the command @kbd{C-c C-t} will cycle an entry from 1370With this setup, the command @kbd{C-c C-t} will cycle an entry from
1361TODO to FEEDBACK, then to VERIFY, and finally too DONE. You may also 1371TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may also
1362use a prefix argument to quickly select a specific state. For example 1372use a prefix argument to quickly select a specific state. For example
1363@kbd{C-3 C-c C-t} will change the state immediately to VERIFY. 1373@kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
1364If you define many keywords, you can use in-buffer completion (see 1374If you define many keywords, you can use in-buffer completion (see
@@ -1388,7 +1398,7 @@ one type to another. Therefore, in this case the behavior of the
1388command @kbd{C-c C-t} is changed slightly@footnote{This is also true 1398command @kbd{C-c C-t} is changed slightly@footnote{This is also true
1389for the @kbd{t} command in the timeline and agenda buffers.}. When 1399for the @kbd{t} command in the timeline and agenda buffers.}. When
1390used several times in succession, it will still cycle through all 1400used several times in succession, it will still cycle through all
1391names. But when when you return to the item after some time and 1401names. But when you return to the item after some time and
1392execute @kbd{C-c C-t} again, it will switch from each name directly to 1402execute @kbd{C-c C-t} again, it will switch from each name directly to
1393DONE. Use prefix arguments or completion to quickly select a specific 1403DONE. Use prefix arguments or completion to quickly select a specific
1394name. 1404name.
@@ -1423,7 +1433,7 @@ only one of the two aspects of TODO keywords can be used. After
1423changing one of these lines, use @kbd{C-c C-c} with the cursor still 1433changing one of these lines, use @kbd{C-c C-c} with the cursor still
1424in the line to make the changes known to Org-mode@footnote{Org-mode 1434in the line to make the changes known to Org-mode@footnote{Org-mode
1425parses these lines only when Org-mode is activated after visiting a 1435parses these lines only when Org-mode is activated after visiting a
1426file. @kbd{C-c C-c} with the cursor in a line starting with @samp{#-} 1436file. @kbd{C-c C-c} with the cursor in a line starting with @samp{#+}
1427is simply restarting Org-mode, making sure that these changes will be 1437is simply restarting Org-mode, making sure that these changes will be
1428respected.}. 1438respected.}.
1429 1439
@@ -1565,6 +1575,11 @@ this command is used twice in succession, a time range is inserted.
1565Like @kbd{C-c .}, but use the alternative format which contains date 1575Like @kbd{C-c .}, but use the alternative format which contains date
1566and time. 1576and time.
1567 1577
1578@kindex C-c !
1579@item C-c !
1580Like @kbd{C-c .}, but insert an inactive time stamp not triggering the
1581agenda.
1582
1568@kindex C-c < 1583@kindex C-c <
1569@item C-c < 1584@item C-c <
1570Insert a time stamp corresponding to the cursor date in the Calendar. 1585Insert a time stamp corresponding to the cursor date in the Calendar.
@@ -2171,15 +2186,15 @@ warning.
2171@kindex C-c C-x h 2186@kindex C-c C-x h
2172@item C-c C-x h 2187@item C-c C-x h
2173Export as HTML file @file{myfile.html}. 2188Export as HTML file @file{myfile.html}.
2174@kindex C-c C-x C-h 2189@kindex C-c C-x b
2175@item C-c C-x C-h 2190@item C-c C-x b
2176Export as HTML file and open it with a browser. 2191Export as HTML file and open it with a browser.
2177@kindex C-c C-x t 2192@kindex C-c C-x t
2178@item C-c C-x t 2193@item C-c C-x t
2179Insert template with export options, see below. 2194Insert template with export options, see below.
2180@kindex C-c : 2195@kindex C-c :
2181@item C-c : 2196@item C-c :
2182Toggle fixed-width for line or region, see below. 2197Toggle fixed-width for entry (QUOTE) or region, see below.
2183@end table 2198@end table
2184 2199
2185@node HTML formatting, Export options, Export commands, Exporting 2200@node HTML formatting, Export options, Export commands, Exporting
@@ -2242,7 +2257,7 @@ The exporter recognizes special lines in the buffer which provide
2242additional information. These lines may be put anywhere in the file. 2257additional information. These lines may be put anywhere in the file.
2243The whole set of lines can be inserted into the buffer with @kbd{C-c 2258The whole set of lines can be inserted into the buffer with @kbd{C-c
2244C-x t}. For individual lines, a good way to make sure the keyword is 2259C-x t}. For individual lines, a good way to make sure the keyword is
2245correct it to type @samp{#+} and then use @kbd{M-@key{TAB}} completion 2260correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
2246(@pxref{Completion}). 2261(@pxref{Completion}).
2247 2262
2248@example 2263@example
@@ -2304,6 +2319,7 @@ Toggle the COMMENT keyword at the beginning of an entry.
2304* Customization:: Adapting Org-mode to your taste 2319* Customization:: Adapting Org-mode to your taste
2305* FAQ:: Frequently asked questions 2320* FAQ:: Frequently asked questions
2306* Interaction:: Other Emacs packages 2321* Interaction:: Other Emacs packages
2322* TTY keys:: Using Org-mode on a tty
2307* Bugs:: Things which do not work perfectly 2323* Bugs:: Things which do not work perfectly
2308* Acknowledgments:: These people provided feedback and more 2324* Acknowledgments:: These people provided feedback and more
2309@end menu 2325@end menu
@@ -2436,7 +2452,7 @@ indentation of the first line and realign with @key{TAB}.
2436@end enumerate 2452@end enumerate
2437 2453
2438 2454
2439@node Interaction, Bugs, FAQ, Miscellaneous 2455@node Interaction, TTY keys, FAQ, Miscellaneous
2440@section Interaction with other packages 2456@section Interaction with other packages
2441@cindex packages, interaction with other 2457@cindex packages, interaction with other
2442Org-mode can cooperate with the following packages: 2458Org-mode can cooperate with the following packages:
@@ -2498,7 +2514,44 @@ Integrate org files into the diary as described above, and then turn
2498on the diary support of planner. 2514on the diary support of planner.
2499@end table 2515@end table
2500 2516
2501@node Bugs, Acknowledgments, Interaction, Miscellaneous 2517@node TTY keys, Bugs, Interaction, Miscellaneous
2518@section Using org-mode on a tty
2519
2520Org-mode uses a number of keys that are not accessible on a tty. This
2521applies to most special keys like cursor keys, @key{TAB} and
2522@key{RET}, when these are combined with modifier keys like @key{Meta}
2523and/or @key{Shift}. Org-mode uses these bindings because it needs to
2524provide keys for a large number of commands, and because these keys
2525appeared particularly easy to remember. In order to still be able to
2526access the core functionality of Org-mode on a tty, alternative
2527bindings are provided. Here is a complete list of these bindings,
2528which are obviously more cumbersome to use. Note that sometimes a
2529work-around can be better. For example changing a time stamp is
2530really only fun with @kbd{S-@key{cursor}} keys. On a tty you would
2531rather use @kbd{C-c .} to re-insert the timestamp.
2532
2533@page
2534@multitable @columnfractions 0.15 0.2 0.2
2535@item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
2536@item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab
2537@item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}
2538@item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
2539@item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}}
2540@item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab
2541@item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}
2542@item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab
2543@item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}}
2544@item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab
2545@item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab
2546@item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}}
2547@item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab
2548@item @kbd{S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab
2549@item @kbd{S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
2550@item @kbd{S-@key{up}} @tab @kbd{C-c C-x @key{up}} @tab
2551@item @kbd{S-@key{down}} @tab @kbd{C-c C-x @key{down}} @tab
2552@end multitable
2553
2554@node Bugs, Acknowledgments, TTY keys, Miscellaneous
2502@section Bugs 2555@section Bugs
2503@cindex bugs 2556@cindex bugs
2504 2557
@@ -2514,13 +2567,21 @@ filling is correctly disabled. However, if some text directly
2514normal text. Also, @code{fill-region} does bypass the 2567normal text. Also, @code{fill-region} does bypass the
2515@code{fill-paragraph} code and will fill tables like normal text. 2568@code{fill-paragraph} code and will fill tables like normal text.
2516@item 2569@item
2570Text in an entry protected with the @samp{QUOTE} keyword should not
2571autowrap.
2572@item
2517When the application called by @kbd{C-c C-o} to open a file link fails 2573When the application called by @kbd{C-c C-o} to open a file link fails
2518(for example because the application does not exits or refuses to open 2574(for example because the application does not exits or refuses to open
2519the file), it does so silently. No error message is displayed. 2575the file), it does so silently. No error message is displayed.
2520@item 2576@item
2577The remote-editing commands in the agenda buffer cannot be undone with
2578@code{undo} called from within the agenda buffer. But you can go to
2579the corresponding buffer (using @key{TAB} or @key{RET} and execute
2580@code{undo} there.
2581@item
2521Recalculating a table line applies the formulas from left to right. 2582Recalculating a table line applies the formulas from left to right.
2522If a formula calculated fields further down the row, multiple 2583If a formula uses @emph{calculated} fields further down the row,
2523recalculation may be needed to get all fields consistent. 2584multiple recalculation may be needed to get all fields consistent.
2524@item 2585@item
2525Under XEmacs, if Org-mode entries are included into the diary, it is 2586Under XEmacs, if Org-mode entries are included into the diary, it is
2526not possible to jump back from the diary to the org file. Apparently, 2587not possible to jump back from the diary to the org file. Apparently,
@@ -2592,6 +2653,9 @@ Emacs-Lisp compiler happy.
2592@item 2653@item
2593Kai Grossjohann pointed out that a number of key bindings in Org-mode 2654Kai Grossjohann pointed out that a number of key bindings in Org-mode
2594conflict with other packages. 2655conflict with other packages.
2656@item
2657Roland Winkler pointed out that additional keybindings are need to use
2658Org-mode on a tty.
2595@end itemize 2659@end itemize
2596 2660
2597@node Index, Key Index, Miscellaneous, Top 2661@node Index, Key Index, Miscellaneous, Top