aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCarsten Dominik2006-08-15 11:58:05 +0000
committerCarsten Dominik2006-08-15 11:58:05 +0000
commit22a616f7afff613bd378eac51d56bca748fecdbf (patch)
tree81c95e17de79a65326aac6cd2dee31f00e0d462d
parent5137195a6228c57f41de7d40c1439dc2ba9d56a2 (diff)
downloademacs-22a616f7afff613bd378eac51d56bca748fecdbf.tar.gz
emacs-22a616f7afff613bd378eac51d56bca748fecdbf.zip
(Installation, Activation): Split from Installation and
Activation. (Clocking work time): Documented new features.
-rw-r--r--man/org.texi154
1 files changed, 114 insertions, 40 deletions
diff --git a/man/org.texi b/man/org.texi
index 3e327279726..7897ba32867 100644
--- a/man/org.texi
+++ b/man/org.texi
@@ -3,8 +3,8 @@
3@setfilename ../info/org 3@setfilename ../info/org
4@settitle Org Mode Manual 4@settitle Org Mode Manual
5 5
6@set VERSION 4.43 6@set VERSION 4.44
7@set DATE July 2006 7@set DATE August 2006
8 8
9@dircategory Emacs 9@dircategory Emacs
10@direntry 10@direntry
@@ -98,7 +98,8 @@ Software Foundation raise funds for GNU development.''
98Introduction 98Introduction
99 99
100* Summary:: Brief summary of what Org-mode does 100* Summary:: Brief summary of what Org-mode does
101* Installation:: How to install Org-mode 101* Installation:: How to install a downloaded version of Org-mode
102* Activation:: How to activate Org-mode for certain buffers.
102* Feedback:: Bug reports, ideas, patches etc. 103* Feedback:: Bug reports, ideas, patches etc.
103 104
104Document Structure 105Document Structure
@@ -270,7 +271,8 @@ Extensions, Hooks and Hacking
270 271
271@menu 272@menu
272* Summary:: Brief summary of what Org-mode does 273* Summary:: Brief summary of what Org-mode does
273* Installation:: How to install Org-mode 274* Installation:: How to install a downloaded version of Org-mode
275* Activation:: How to activate Org-mode for certain buffers.
274* Feedback:: Bug reports, ideas, patches etc. 276* Feedback:: Bug reports, ideas, patches etc.
275@end menu 277@end menu
276 278
@@ -323,18 +325,68 @@ questions (FAQ), links to tutorials etc. This page is located at
323 325
324@page 326@page
325 327
326@node Installation, Feedback, Summary, Introduction 328@node Installation, Activation, Summary, Introduction
327@section Installation and Activation 329@section Installation
328@cindex installation 330@cindex installation
331@cindex XEmacs
332
333@b{Important:} If Org-mode is part of the Emacs distribution or an
334XEmacs package, please skip this section and go directly to
335@ref{Activation}.
336
337If you have downloaded Org-mode from the Web, you must take the
338following steps to install it: Go into the Org-mode distribution
339directory and edit the top section of the file @file{Makefile}. You
340must set the name of the Emacs binary (likely either @file{emacs} or
341@file{xemacs}), and the paths to the directories where local Lisp and
342Info files are kept. If you don't have access to the system-wide
343directories, create your own two directories for these files, enter them
344into the Makefile, and make sure Emacs finds the Lisp files by adding
345the following line to @file{.emacs}:
346
347@example
348(setq load-path (cons "~/path/to/lispdir" load-path))
349@end example
350
351@b{XEmacs users now need to install the file @file{noutline.el} from
352the @file{xemacs} subdirectory of the Org-mode distribution. Use the
353command:}
354
355@example
356@b{make install-noutline}
357@end example
358
359@noindent Now byte-compile and install the Lisp files with the shell
360commands:
361
362@example
363make
364make install
365@end example
366
367@noindent If you want to install the info documentation, use this command:
368
369@example
370make install-info
371@end example
372
373@noindent Then add to @file{.emacs}:
374
375@lisp
376;; This line only if org-mode is not part of the X/Emacs distribution.
377(require 'org-install)
378@end lisp
379
380@node Activation, Feedback, Installation, Introduction
381@section Activation
382@cindex activation
329@cindex autoload 383@cindex autoload
330@cindex global keybindings 384@cindex global keybindings
331@cindex keybindings, global 385@cindex keybindings, global
332 386
333If Org-mode is part of the Emacs distribution or an XEmacs package, 387Add the following lines to your @file{.emacs} file. The last two lines
334you only need to copy the following lines to your @file{.emacs} file. 388define @emph{global} keys for the commands @command{org-store-link} and
335The last two lines define @emph{global} keys for the commands 389@command{org-agenda} - please choose suitable keys yourself.
336@command{org-store-link} and @command{org-agenda} - please
337choose suitable keys yourself.
338 390
339@lisp 391@lisp
340;; The following lines are always needed. Choose your own keys. 392;; The following lines are always needed. Choose your own keys.
@@ -345,30 +397,17 @@ choose suitable keys yourself.
345 397
346Furthermore, you must activate @code{font-lock-mode} in org-mode 398Furthermore, you must activate @code{font-lock-mode} in org-mode
347buffers, because significant functionality depends on font-locking being 399buffers, because significant functionality depends on font-locking being
348active. You can do this with either one of the following two lines: 400active. You can do this with either one of the following two lines
401(XEmacs user must use the second option):
349@lisp 402@lisp
350(global-font-lock-mode 1) ; for all buffers 403(global-font-lock-mode 1) ; for all buffers
351(add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only 404(add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
352@end lisp 405@end lisp
353 406
354If you have downloaded Org-mode from the Web, you must take additional
355action: Byte-compile @file{org.el} and @file{org-publish.el} and put
356them together with @file{org-install.el} on your load path. Then add to
357@file{.emacs}:
358
359@lisp
360;; This line only if org-mode is not part of the X/Emacs distribution.
361(require 'org-install)
362@end lisp
363
364If you use Org-mode with XEmacs, you also need to install the file
365@file{noutline.el} from the @file{xemacs} subdirectory of the Org-mode
366distribution.
367
368@cindex org-mode, turning on 407@cindex org-mode, turning on
369With this setup, all files with extension @samp{.org} will be put into 408With this setup, all files with extension @samp{.org} will be put
370Org-mode. As an alternative, make the first line of a file look like 409into Org-mode. As an alternative, make the first line of a file look
371this: 410like this:
372 411
373@example 412@example
374MY PROJECTS -*- mode: org; -*- 413MY PROJECTS -*- mode: org; -*-
@@ -378,7 +417,7 @@ MY PROJECTS -*- mode: org; -*-
378the file's name is. See also the variable 417the file's name is. See also the variable
379@code{org-insert-mode-line-in-empty-file}. 418@code{org-insert-mode-line-in-empty-file}.
380 419
381@node Feedback, , Installation, Introduction 420@node Feedback, , Activation, Introduction
382@section Feedback 421@section Feedback
383@cindex feedback 422@cindex feedback
384@cindex bug reports 423@cindex bug reports
@@ -826,8 +865,14 @@ But in the end, not individual scenes matter but the film as a whole.
826@end group 865@end group
827@end example 866@end example
828 867
829Org-mode supports these lists by tuning filling and wrapping commands 868Org-mode supports these lists by tuning filling and wrapping commands to
830to deal with them correctly. 869deal with them correctly@footnote{Org-mode only changes the filling
870settings for Emacs. For XEmacs, you should use Kyle E. Jones'
871@file{filladapt.el}. To turn is on, put into @file{.emacs}:
872@example
873(require 'filladapt)
874@end example
875}.
831 876
832The following commands act on items when the cursor is in the first line 877The following commands act on items when the cursor is in the first line
833of an item (the line with the bullet or number). 878of an item (the line with the bullet or number).
@@ -2160,7 +2205,7 @@ If you define many keywords, you can use in-buffer completion (see
2160 2205
2161The second possibility is to use TODO keywords to indicate different 2206The second possibility is to use TODO keywords to indicate different
2162types of action items. For example, you might want to indicate that 2207types of action items. For example, you might want to indicate that
2163items are for ``work'' or ``home.'' If you are into David Allen's 2208items are for ``work'' or ``home''. If you are into David Allen's
2164@emph{Getting Things DONE}, you might want to use todo types 2209@emph{Getting Things DONE}, you might want to use todo types
2165@samp{NEXTACTION}, @samp{WAITING}, @samp{MAYBE}. Or, when you work 2210@samp{NEXTACTION}, @samp{WAITING}, @samp{MAYBE}. Or, when you work
2166with several people on a single project, you might want to assign 2211with several people on a single project, you might want to assign
@@ -2547,7 +2592,12 @@ keyword together with a timestamp.
2547Stop the clock (clock-out). The inserts another timestamp at the same 2592Stop the clock (clock-out). The inserts another timestamp at the same
2548location where the clock was last started. It also directly computes 2593location where the clock was last started. It also directly computes
2549the resulting time in inserts it after the time range as @samp{=> 2594the resulting time in inserts it after the time range as @samp{=>
2550HH:MM}. 2595HH:MM}.
2596@kindex C-c C-y
2597@item C-c C-y
2598Recompute the time interval after changing one of the time stamps. This
2599is only necessary if you edit the time stamps directly. If you change
2600them with @kbd{S-@key{cursor}} keys, the update is automatic.
2551@kindex C-c C-t 2601@kindex C-c C-t
2552@item C-c C-t 2602@item C-c C-t
2553Changing the TODO state of an item to DONE automatically stops the clock 2603Changing the TODO state of an item to DONE automatically stops the clock
@@ -2565,8 +2615,8 @@ can use visibility cycling to study the tree, but the overlays disappear
2565automatically when the buffer is changed. 2615automatically when the buffer is changed.
2566@kindex C-c C-x C-r 2616@kindex C-c C-x C-r
2567@item C-c C-x C-r 2617@item C-c C-x C-r
2568Insert a dynamic block containing a clock report as an org-mode table 2618Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
2569into the current file. 2619report as an org-mode table into the current file.
2570@example 2620@example
2571#+BEGIN: clocktable :maxlevel 2 :emphasize nil 2621#+BEGIN: clocktable :maxlevel 2 :emphasize nil
2572 2622
@@ -2578,7 +2628,32 @@ table. The @samp{BEGIN} line can specify options:
2578@example 2628@example
2579:maxlevels @r{Maximum level depth to which times are listed in the table.} 2629:maxlevels @r{Maximum level depth to which times are listed in the table.}
2580:emphasize @r{When @code{t}, emphasize level one and level two items} 2630:emphasize @r{When @code{t}, emphasize level one and level two items}
2631:block @r{The time block to consider. This block is specified relative}
2632 @r{to the current time and may be any of these keywords:}
2633 @r{@code{today}, @code{yesterday}, @code{thisweek}, @code{lastweek},}
2634 @r{@code{thismonth}, @code{lastmonth}, @code{thisyear}, or @code{lastyear}}.
2635:tstart @r{A time string specifying when to start considering times}
2636:tend @r{A time string specifying when to stop considering times}
2637@end example
2638So to get a clock summary for the current day, you could write
2639@example
2640#+BEGIN: clocktable :maxlevel 2 :block today
2641
2642#+END: clocktable
2581@end example 2643@end example
2644and to use a specific time range you could write@footnote{Note that all
2645parameters must be specified in a single line - the line is broken here
2646only to fit it onto the manual.}
2647@example
2648#+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
2649 :tend "<2006-08-10 Thu 12:00>"
2650
2651#+END: clocktable
2652@end example
2653@kindex C-u C-c C-x C-u
2654@item C-u C-c C-x C-u
2655Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
2656you have several clocktable blocks in a buffer.
2582@end table 2657@end table
2583 2658
2584The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in 2659The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
@@ -4653,8 +4728,7 @@ setup. See the installation instructions in the file
4653@item @file{cdlatex.el} by Carsten Dominik 4728@item @file{cdlatex.el} by Carsten Dominik
4654@cindex @file{cdlatex.el} 4729@cindex @file{cdlatex.el}
4655Org-mode can make use of the cdlatex package to efficiently enter 4730Org-mode can make use of the cdlatex package to efficiently enter
4656La@TeX{} fragments into Org-mode files. 4731La@TeX{} fragments into Org-mode files. See @ref{CDLaTeX mode}.
4657@file{cdlatex.el} is not part of Emacs, find it on the web.
4658@item @file{remember.el} by John Wiegley 4732@item @file{remember.el} by John Wiegley
4659@cindex @file{remember.el} 4733@cindex @file{remember.el}
4660Org mode cooperates with remember, see @ref{Remember}. 4734Org mode cooperates with remember, see @ref{Remember}.
@@ -4784,7 +4858,7 @@ caused by the preparations for the 22.1 release. In the mean time,
4784@url{http://dto.freeshell.org/e/org-publish.el}. 4858@url{http://dto.freeshell.org/e/org-publish.el}.
4785@cindex @file{org-blog.el} 4859@cindex @file{org-blog.el}
4786@item @file{org-blog.el} by David O'Toole 4860@item @file{org-blog.el} by David O'Toole
4787A blogging plug-in for @file{org-publish.el}. 4861A blogging plug-in for @file{org-publish.el}.@*
4788@url{http://dto.freeshell.org/notebook/OrgMode.html}. 4862@url{http://dto.freeshell.org/notebook/OrgMode.html}.
4789@cindex @file{org-blogging.el} 4863@cindex @file{org-blogging.el}
4790@item @file{org-blogging.el} by Bastien Guerry 4864@item @file{org-blogging.el} by Bastien Guerry
@@ -4805,7 +4879,7 @@ to the block and can also specify parameters for the function producing
4805the content of the block. 4879the content of the block.
4806 4880
4807@example 4881@example
4808#+BEGIN: myblock :parameter1 value1 :parameter2 value2 ..... 4882#+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
4809 4883
4810#+END: 4884#+END:
4811@end example 4885@end example