org.texi 382 KB
Newer Older
Glenn Morris's avatar
Glenn Morris committed
1 2
\input texinfo
@c %**start of header
3
@setfilename ../../info/org
4
@settitle The Org Manual
Glenn Morris's avatar
Glenn Morris committed
5

6
@set VERSION 6.06b
Carsten Dominik's avatar
Carsten Dominik committed
7
@set DATE July 2008
Glenn Morris's avatar
Glenn Morris committed
8 9 10 11 12 13 14

@dircategory Emacs
@direntry
* Org Mode: (org).      Outline-based notes management and organizer
@end direntry

@c Version and Contact Info
15
@set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
Glenn Morris's avatar
Glenn Morris committed
16 17
@set AUTHOR Carsten Dominik
@set MAINTAINER Carsten Dominik
18 19
@set MAINTAINEREMAIL @email{carsten at orgmode dot org}
@set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
Glenn Morris's avatar
Glenn Morris committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
@c %**end of header
@finalout

@c Macro definitions

@c Subheadings inside a table.
@macro tsubheading{text}
@ifinfo
@subsubheading \text\
@end ifinfo
@ifnotinfo
@item @b{\text\}
@end ifnotinfo
@end macro

@copying
36
This manual is for Org (version @value{VERSION}).
Glenn Morris's avatar
Glenn Morris committed
37

38
Copyright @copyright{} 2004, 2005, 2006, 2007, 2008 Free Software Foundation
Glenn Morris's avatar
Glenn Morris committed
39 40 41

@quotation
Permission is granted to copy, distribute and/or modify this document
42
under the terms of the GNU Free Documentation License, Version 1.2 or
Glenn Morris's avatar
Glenn Morris committed
43 44
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
Carsten Dominik's avatar
Carsten Dominik committed
45 46 47
and with the Back-Cover Texts as in (a) below.    A copy of the
 license is included in the section entitled ``GNU Free Documentation
-License.''
Glenn Morris's avatar
Glenn Morris committed
48

49 50 51
(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
modify this GNU manual.  Buying copies from the FSF supports it in
developing GNU and promoting software freedom.''
52 53 54 55 56

This document is part of a collection distributed under the GNU Free
Documentation License.  If you want to distribute this document
separately from the collection, you can do so by adding a copy of the
license to the document, as described in section 6 of the license.
Glenn Morris's avatar
Glenn Morris committed
57 58 59 60
@end quotation
@end copying

@titlepage
61
@title The Org Manual
Glenn Morris's avatar
Glenn Morris committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83

@subtitle Release @value{VERSION}
@author by Carsten Dominik

@c The following two commands start the copyright page.
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage

@c Output the table of contents at the beginning.
@contents

@ifnottex
@node Top, Introduction, (dir), (dir)
@top Org Mode Manual

@insertcopying
@end ifnottex

@menu
* Introduction::                Getting started
84
* Document Structure::          A tree works like your brain
Glenn Morris's avatar
Glenn Morris committed
85 86
* Tables::                      Pure magic for quick formatting
* Hyperlinks::                  Notes in context
87
* TODO Items::                  Every tree branch can be a TODO item
Glenn Morris's avatar
Glenn Morris committed
88
* Tags::                        Tagging headlines and matching sets of tags
89 90
* Properties and Columns::      Storing information about an entry
* Dates and Times::             Making items useful for planning
91
* Remember::                    Quickly adding nodes to the outline tree
92
* Agenda Views::                Collecting information into views
Glenn Morris's avatar
Glenn Morris committed
93 94
* Embedded LaTeX::              LaTeX fragments and formulas
* Exporting::                   Sharing and publishing of notes
95
* Publishing::                  Create a web site of linked Org files
Glenn Morris's avatar
Glenn Morris committed
96
* Miscellaneous::               All the rest which did not fit elsewhere
Carsten Dominik's avatar
Carsten Dominik committed
97 98
* Extensions::                  Add-ons for Org mode
* Hacking::                     How hack your way around
99 100
* History and Acknowledgments::  How Org came into being
* Main Index::                  An index of Org's concepts and features
Glenn Morris's avatar
Glenn Morris committed
101 102 103 104 105 106 107
* Key Index::                   Key bindings and where they are described

@detailmenu
 --- The Detailed Node Listing ---

Introduction

108 109 110
* Summary::                     Brief summary of what Org does
* Installation::                How to install a downloaded version of Org
* Activation::                  How to activate Org for certain buffers
Glenn Morris's avatar
Glenn Morris committed
111
* Feedback::                    Bug reports, ideas, patches etc.
112
* Conventions::                 Type-setting conventions in the manual
Glenn Morris's avatar
Glenn Morris committed
113 114 115

Document Structure

116 117
* Outlines::                    Org is based on Outline mode
* Headlines::                   How to typeset Org tree headlines
Glenn Morris's avatar
Glenn Morris committed
118 119 120 121 122 123 124
* Visibility cycling::          Show and hide, much simplified
* Motion::                      Jumping to other headlines
* Structure editing::           Changing sequence and level of headlines
* Archiving::                   Move done task trees to a different place
* Sparse trees::                Matches embedded in context
* Plain lists::                 Additional structure within an entry
* Drawers::                     Tucking stuff away
125
* Orgstruct mode::              Structure editing outside Org
Glenn Morris's avatar
Glenn Morris committed
126 127 128 129 130 131 132 133 134

Archiving

* ARCHIVE tag::                 Marking a tree as inactive
* Moving subtrees::             Moving a tree to an archive file

Tables

* Built-in table editor::       Simple tables
135
* Narrow columns::              Stop wasting space in tables
Glenn Morris's avatar
Glenn Morris committed
136
* Column groups::               Grouping to trigger vertical lines
137 138
* Orgtbl mode::                 The table editor as minor mode
* The spreadsheet::             The table editor has spreadsheet capabilities
Glenn Morris's avatar
Glenn Morris committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152

The spreadsheet

* References::                  How to refer to another field or range
* Formula syntax for Calc::     Using Calc to compute stuff
* Formula syntax for Lisp::     Writing formulas in Emacs Lisp
* Field formulas::              Formulas valid for a single field
* Column formulas::             Formulas valid for an entire column
* Editing and debugging formulas::  Fixing formulas
* Updating the table::          Recomputing all dependent fields
* Advanced features::           Field names, parameters and automatic recalc

Hyperlinks

153
* Link format::                 How links in Org are formatted
Glenn Morris's avatar
Glenn Morris committed
154 155 156
* Internal links::              Links to other places in the current file
* External links::              URL-like links to the world
* Handling links::              Creating, inserting and following
157
* Using links outside Org::     Linking from my C source code?
Glenn Morris's avatar
Glenn Morris committed
158 159 160 161 162 163
* Link abbreviations::          Shortcuts for writing complex links
* Search options::              Linking to a specific location
* Custom searches::             When the default search is not enough

Internal links

164
* Radio targets::               Make targets trigger links in plain text
Glenn Morris's avatar
Glenn Morris committed
165

166
TODO Items
Glenn Morris's avatar
Glenn Morris committed
167 168 169

* TODO basics::                 Marking and displaying TODO entries
* TODO extensions::             Workflow and assignments
170
* Progress logging::            Dates and notes for progress
Glenn Morris's avatar
Glenn Morris committed
171 172 173 174 175 176 177
* Priorities::                  Some things are more important than others
* Breaking down tasks::         Splitting a task into manageable pieces
* Checkboxes::                  Tick-off lists

Extended use of TODO keywords

* Workflow states::             From TODO to DONE in steps
178
* TODO types::                  I do this, Fred does the rest
Glenn Morris's avatar
Glenn Morris committed
179
* Multiple sets in one file::   Mixing it all, and still finding your way
180 181 182 183
* Fast access to TODO states::  Single letter selection of a state
* Per-file keywords::           Different files, different requirements
* Faces for TODO keywords::     Highlighting states

184
Progress logging
185 186 187

* Closing items::               When was this entry marked DONE?
* Tracking TODO state changes::  When did the status change?
Glenn Morris's avatar
Glenn Morris committed
188 189 190 191 192 193 194 195 196 197

Tags

* Tag inheritance::             Tags use the tree structure of the outline
* Setting tags::                How to assign tags to a headline
* Tag searches::                Searching for combinations of tags

Properties and Columns

* Property syntax::             How properties are spelled out
198
* Special properties::          Access to other Org mode features
Glenn Morris's avatar
Glenn Morris committed
199
* Property searches::           Matching property values
200
* Property inheritance::        Passing values down the tree
Glenn Morris's avatar
Glenn Morris committed
201 202 203
* Column view::                 Tabular viewing and editing
* Property API::                Properties for Lisp programmers

204
Column view
Glenn Morris's avatar
Glenn Morris committed
205 206 207

* Defining columns::            The COLUMNS format property
* Using column view::           How to create and use column view
208
* Capturing column view::       A dynamic block for column view
Glenn Morris's avatar
Glenn Morris committed
209

210
Defining columns
Glenn Morris's avatar
Glenn Morris committed
211 212 213 214

* Scope of column definitions::  Where defined, where valid?
* Column attributes::           Appearance and content of a column

215
Dates and Times
Glenn Morris's avatar
Glenn Morris committed
216

217
* Timestamps::                  Assigning a time to a tree entry
Glenn Morris's avatar
Glenn Morris committed
218 219
* Creating timestamps::         Commands which insert timestamps
* Deadlines and scheduling::    Planning your work
220 221
* Clocking work time::          Tracking how long you spend on a task
* Effort estimates::            Planning work effort in advance
Glenn Morris's avatar
Glenn Morris committed
222 223 224

Creating timestamps

225 226
* The date/time prompt::        How Org mode helps you entering date and time
* Custom time format::          Making dates look different
Glenn Morris's avatar
Glenn Morris committed
227

228
Deadlines and scheduling
Glenn Morris's avatar
Glenn Morris committed
229 230 231 232

* Inserting deadline/schedule::  Planning items
* Repeated tasks::              Items that show up again and again

233
Remember
Glenn Morris's avatar
Glenn Morris committed
234

235
* Setting up Remember::         Some code for .emacs to get things going
236 237 238
* Remember templates::          Define the outline of different note types
* Storing notes::               Directly get the note to where it belongs
* Refiling notes::              Moving a note or task to a project
Glenn Morris's avatar
Glenn Morris committed
239 240 241 242 243 244 245

Agenda Views

* Agenda files::                Files being searched for agenda information
* Agenda dispatcher::           Keyboard access to agenda views
* Built-in agenda views::       What is available out of the box?
* Presentation and sorting::    How agenda items are prepared for display
246
* Agenda commands::             Remote editing of Org trees
Glenn Morris's avatar
Glenn Morris committed
247
* Custom agenda views::         Defining special searches and views
248
* Agenda column view::          Using column view for collected entries
Glenn Morris's avatar
Glenn Morris committed
249 250 251

The built-in agenda views

252
* Weekly/daily agenda::         The calendar page with current tasks
Glenn Morris's avatar
Glenn Morris committed
253 254 255
* Global TODO list::            All unfinished action items
* Matching tags and properties::  Structured information with fine-tuned search
* Timeline::                    Time-sorted view for single file
256
* Keyword search::              Finding entries by keyword
Glenn Morris's avatar
Glenn Morris committed
257 258 259 260 261 262 263 264 265 266 267 268 269
* Stuck projects::              Find projects you need to review

Presentation and sorting

* Categories::                  Not all tasks are equal
* Time-of-day specifications::  How the agenda knows the time
* Sorting of agenda items::     The order of things

Custom agenda views

* Storing searches::            Type once, use often
* Block agenda::                All the stuff you need in a single buffer
* Setting Options::             Changing the rules
270 271
* Exporting Agenda Views::      Writing agendas to files
* Using the agenda elsewhere::  Using agenda information in other programs
Glenn Morris's avatar
Glenn Morris committed
272 273 274 275

Embedded LaTeX

* Math symbols::                TeX macros for symbols and Greek letters
276
* Subscripts and superscripts::  Simple syntax for raising/lowering text
Glenn Morris's avatar
Glenn Morris committed
277 278 279 280 281 282
* LaTeX fragments::             Complex formulas made easy
* Processing LaTeX fragments::  Previewing LaTeX processing
* CDLaTeX mode::                Speed up entering of formulas

Exporting

283 284 285
* Markup rules::                Which structures are recognized?
* Export options::              Per-file export settings
* The export dispatcher::       How to access exporter commands
Glenn Morris's avatar
Glenn Morris committed
286 287 288 289 290
* ASCII export::                Exporting to plain ASCII
* HTML export::                 Exporting to HTML
* LaTeX export::                Exporting to LaTeX
* XOXO export::                 Exporting to XOXO
* iCalendar export::            Exporting in iCalendar format
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307

Markup rules

* Document title::              How the document title is determined
* Headings and sections::       The main structure of the exported document
* Table of contents::           If, where, how to create a table of contents
* Initial text::                Text before the first headline
* Lists::                       Plain lists are exported
* Paragraphs::                  What determines beginning and ending
* Literal examples::            Source code and other examples
* Include files::               Include the contents of a file during export
* Tables exported::             Tables are exported richly
* Footnotes::                   Numbers like [1]
* Emphasis and monospace::      To bold or not to bold
* TeX macros and LaTeX fragments::  Create special, rich export.
* Horizontal rules::            A line across the page
* Comment lines::               Some lines will not be exported
Glenn Morris's avatar
Glenn Morris committed
308 309 310

HTML export

311
* HTML Export commands::        How to invoke HTML export
312
* Quoting HTML tags::           Using direct HTML in Org mode
Glenn Morris's avatar
Glenn Morris committed
313 314
* Links::                       Transformation of links for HTML
* Images::                      How to include images
315 316
* CSS support::                 Changing the appearance of the output
* Javascript support::          Info and Folding in a web browser
Glenn Morris's avatar
Glenn Morris committed
317 318 319 320 321

LaTeX export

* LaTeX export commands::       How to invoke LaTeX export
* Quoting LaTeX code::          Incorporating literal LaTeX code
322
* Sectioning structure::        Changing sectioning in LaTeX output
Glenn Morris's avatar
Glenn Morris committed
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347

Publishing

* Configuration::               Defining projects
* Sample configuration::        Example projects
* Triggering publication::      Publication commands

Configuration

* Project alist::               The central configuration variable
* Sources and destinations::    From here to there
* Selecting files::             What files are part of the project?
* Publishing action::           Setting the function doing the publishing
* Publishing options::          Tweaking HTML export
* Publishing links::            Which links keep working after publishing?
* Project page index::          Publishing a list of project files

Sample configuration

* Simple example::              One-component publishing
* Complex example::             A multi-component publishing example

Miscellaneous

* Completion::                  M-TAB knows what you need
348
* Customization::               Adapting Org to your taste
Glenn Morris's avatar
Glenn Morris committed
349 350 351
* In-buffer settings::          Overview of the #+KEYWORDS
* The very busy C-c C-c key::   When in doubt, press C-c C-c
* Clean view::                  Getting rid of leading stars in the outline
352
* TTY keys::                    Using Org on a tty
Glenn Morris's avatar
Glenn Morris committed
353 354 355 356 357
* Interaction::                 Other Emacs packages
* Bugs::                        Things which do not work perfectly

Interaction with other packages

358
* Cooperation::                 Packages Org cooperates with
Glenn Morris's avatar
Glenn Morris committed
359 360
* Conflicts::                   Packages that lead to conflicts

361 362 363 364 365 366
Extensions

* Extensions in the contrib directory::  These come with the Org distro
* Other extensions::            These you have to find on the web.

Hacking
Glenn Morris's avatar
Glenn Morris committed
367 368 369 370 371 372

* Adding hyperlink types::      New custom link types
* Tables in arbitrary syntax::  Orgtbl for LaTeX and other programs
* Dynamic blocks::              Automatically filled blocks
* Special agenda views::        Customized views
* Using the property API::      Writing programs that use entry properties
373
* Using the mapping API::       Mapping over all or selected entries
Glenn Morris's avatar
Glenn Morris committed
374

375
Tables and lists in arbitrary syntax
Glenn Morris's avatar
Glenn Morris committed
376 377 378 379

* Radio tables::                Sending and receiving
* A LaTeX example::             Step by step, almost a tutorial
* Translator functions::        Copy and modify
380
* Radio lists::                 Doing the same for lists
Glenn Morris's avatar
Glenn Morris committed
381 382 383 384

@end detailmenu
@end menu

385
@node Introduction, Document Structure, Top, Top
Glenn Morris's avatar
Glenn Morris committed
386 387 388 389
@chapter Introduction
@cindex introduction

@menu
390 391 392
* Summary::                     Brief summary of what Org does
* Installation::                How to install a downloaded version of Org
* Activation::                  How to activate Org for certain buffers
Glenn Morris's avatar
Glenn Morris committed
393
* Feedback::                    Bug reports, ideas, patches etc.
394
* Conventions::                 Type-setting conventions in the manual
Glenn Morris's avatar
Glenn Morris committed
395 396 397 398 399 400
@end menu

@node Summary, Installation, Introduction, Introduction
@section Summary
@cindex summary

401
Org is a mode for keeping notes, maintaining TODO lists, and doing
Glenn Morris's avatar
Glenn Morris committed
402 403
project planning with a fast and effective plain-text system.

404 405 406
Org develops organizational tasks around NOTES files that contain
lists or information about projects as plain text.  Org is
implemented on top of Outline mode, which makes it possible to keep the
Glenn Morris's avatar
Glenn Morris committed
407 408
content of large files well structured.  Visibility cycling and
structure editing help to work with the tree.  Tables are easily created
409
with a built-in table editor.  Org supports TODO items, deadlines,
Glenn Morris's avatar
Glenn Morris committed
410 411 412 413
time stamps, and scheduling.  It dynamically compiles entries into an
agenda that utilizes and smoothly integrates much of the Emacs calendar
and diary.  Plain text URL-like links connect to websites, emails,
Usenet messages, BBDB entries, and any files related to the projects.
414
For printing and sharing of notes, an Org file can be exported as a
415
structured ASCII file, as HTML, or (TODO and agenda items only) as an
Glenn Morris's avatar
Glenn Morris committed
416
iCalendar file.  It can also serve as a publishing tool for a set of
417
linked web pages.
Glenn Morris's avatar
Glenn Morris committed
418

419
An important design aspect that distinguishes Org from for example
Glenn Morris's avatar
Glenn Morris committed
420 421
Planner/Muse is that it encourages to store every piece of information
only once.  In Planner, you have project pages, day pages and possibly
422
other files, duplicating some information such as tasks.  In Org,
Glenn Morris's avatar
Glenn Morris committed
423 424 425 426 427
you only have notes files.  In your notes you mark entries as tasks,
label them with tags and timestamps.  All necessary lists like a
schedule for the day, the agenda for a meeting, tasks lists selected by
tags etc are created dynamically when you need them.

428
Org keeps simple things simple.  When first fired up, it should
Glenn Morris's avatar
Glenn Morris committed
429 430
feel like a straightforward, easy to use outliner.  Complexity is not
imposed, but a large amount of functionality is available when you need
431
it.  Org is a toolbox and can be used in different ways, for
Glenn Morris's avatar
Glenn Morris committed
432 433 434 435 436 437 438 439 440 441
example as:

@example
@r{@bullet{} outline extension with visibility cycling and structure editing}
@r{@bullet{} ASCII system and table editor for taking structured notes}
@r{@bullet{} ASCII table editor with spreadsheet-like capabilities}
@r{@bullet{} TODO list editor}
@r{@bullet{} full agenda and planner with deadlines and work scheduling}
@r{@bullet{} environment to implement David Allen's GTD system}
@r{@bullet{} a basic database application}
442
@r{@bullet{} simple hypertext system, with HTML and LaTeX export}
Glenn Morris's avatar
Glenn Morris committed
443 444 445
@r{@bullet{} publishing tool to create a set of interlinked webpages}
@end example

446
Org's automatic, context sensitive table editor with spreadsheet
Glenn Morris's avatar
Glenn Morris committed
447
capabilities can be integrated into any major mode by activating the
448
minor Orgtbl mode.  Using a translation step, it can be used to maintain
Glenn Morris's avatar
Glenn Morris committed
449
tables in arbitrary file types, for example in La@TeX{}.  The structure
450 451
editing and list creation capabilities can be used outside Org with
the minor Orgstruct mode.
Glenn Morris's avatar
Glenn Morris committed
452 453

@cindex FAQ
454 455
There is a website for Org which provides links to the newest
version of Org, as well as additional information, frequently asked
Glenn Morris's avatar
Glenn Morris committed
456
questions (FAQ), links to tutorials etc.  This page is located at
457
@uref{http://orgmode.org}.
Glenn Morris's avatar
Glenn Morris committed
458 459 460 461 462 463 464 465 466

@page


@node Installation, Activation, Summary, Introduction
@section Installation
@cindex installation
@cindex XEmacs

467
@b{Important:} @i{If Org is part of the Emacs distribution or an
Glenn Morris's avatar
Glenn Morris committed
468 469 470
XEmacs package, please skip this section and go directly to
@ref{Activation}.}

471 472 473 474 475 476 477 478 479
If you have downloaded Org from the Web, either as a distribution @file{.zip}
or @file{.tar} file, or as a GIT archive, you must take the following steps
to install it: Go into the unpacked Org distribution directory and edit the
top section of the file @file{Makefile}.  You must set the name of the Emacs
binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
directories where local Lisp and Info files are kept.  If you don't have
access to the system-wide directories, you can simply run Org directly from
the distribution directory by adding the @file{lisp} subdirectory to the
Emacs load path.  To do this, add the following line to @file{.emacs}:
Glenn Morris's avatar
Glenn Morris committed
480 481

@example
482 483 484 485 486 487 488 489 490
(setq load-path (cons "~/path/to/orgdir/lisp" load-path))
@end example

@noindent
If you plan to use code from the @file{contrib} subdirectory, do a similar
step for this directory:

@example
(setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
Glenn Morris's avatar
Glenn Morris committed
491 492 493
@end example

@b{XEmacs users now need to install the file @file{noutline.el} from
494
the @file{xemacs} sub-directory of the Org distribution.  Use the
Glenn Morris's avatar
Glenn Morris committed
495 496 497 498 499 500
command:}

@example
@b{make install-noutline}
@end example

501
@noindent Now byte-compile the Lisp files with the shell command:
Glenn Morris's avatar
Glenn Morris committed
502 503 504 505 506

@example
make
@end example

507 508
@noindent If you are running Org from the distribution directory, this is
all.  If you want to install into the system directories, use
Glenn Morris's avatar
Glenn Morris committed
509 510

@example
511
make install
Glenn Morris's avatar
Glenn Morris committed
512 513 514 515 516 517
make install-info
@end example

@noindent Then add to @file{.emacs}:

@lisp
518
;; This line only if Org is not part of the X/Emacs distribution.
Glenn Morris's avatar
Glenn Morris committed
519 520 521
(require 'org-install)
@end lisp

522

Glenn Morris's avatar
Glenn Morris committed
523 524 525 526
@node Activation, Feedback, Installation, Introduction
@section Activation
@cindex activation
@cindex autoload
527 528
@cindex global key bindings
@cindex key bindings, global
Glenn Morris's avatar
Glenn Morris committed
529 530 531

@iftex
@b{Important:} @i{If you use copy-and-paste to copy lisp code from the
Carsten Dominik's avatar
Carsten Dominik committed
532
PDF documentation as viewed by some PDF viewers to your .emacs file, the
Glenn Morris's avatar
Glenn Morris committed
533 534 535 536 537 538
single quote character comes out incorrectly and the code will not work.
You need to fix the single quotes by hand, or copy from Info
documentation.}
@end iftex

Add the following lines to your @file{.emacs} file.  The last two lines
539 540 541
define @emph{global} keys for the commands @command{org-store-link},
@command{org-agenda}, and @command{org-iswitchb} - please choose suitable
keys yourself.
Glenn Morris's avatar
Glenn Morris committed
542 543 544 545 546 547

@lisp
;; The following lines are always needed.  Choose your own keys.
(add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
(global-set-key "\C-cl" 'org-store-link)
(global-set-key "\C-ca" 'org-agenda)
548
(global-set-key "\C-cb" 'org-iswitchb)
Glenn Morris's avatar
Glenn Morris committed
549 550
@end lisp

551
Furthermore, you must activate @code{font-lock-mode} in Org
Glenn Morris's avatar
Glenn Morris committed
552 553 554 555 556
buffers, because significant functionality depends on font-locking being
active.  You can do this with either one of the following two lines
(XEmacs user must use the second option):
@lisp
(global-font-lock-mode 1)                     ; for all buffers
557
(add-hook 'org-mode-hook 'turn-on-font-lock)  ; Org buffers only
Glenn Morris's avatar
Glenn Morris committed
558 559
@end lisp

560
@cindex Org mode, turning on
Glenn Morris's avatar
Glenn Morris committed
561
With this setup, all files with extension @samp{.org} will be put
562
into Org mode.  As an alternative, make the first line of a file look
Glenn Morris's avatar
Glenn Morris committed
563 564 565 566 567 568
like this:

@example
MY PROJECTS    -*- mode: org; -*-
@end example

569
@noindent which will select Org mode for this buffer no matter what
Glenn Morris's avatar
Glenn Morris committed
570 571 572
the file's name is.  See also the variable
@code{org-insert-mode-line-in-empty-file}.

573
@node Feedback, Conventions, Activation, Introduction
Glenn Morris's avatar
Glenn Morris committed
574 575 576 577 578 579
@section Feedback
@cindex feedback
@cindex bug reports
@cindex maintainer
@cindex author

580 581 582 583
If you find problems with Org, or if you have questions, remarks, or ideas
about it, please mail to the Org mailing list @code{emacs-orgmode@@gnu.org}.
If you are not a member of the mailing list, your mail will be reviewed by a
moderator and then passed through to the list.
Glenn Morris's avatar
Glenn Morris committed
584 585 586

For bug reports, please provide as much information as possible,
including the version information of Emacs (@kbd{C-h v emacs-version
587 588
@key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as
the Org related setup in @file{.emacs}.  If an error occurs, a
Glenn Morris's avatar
Glenn Morris committed
589 590 591 592 593 594 595 596 597 598 599 600 601
backtrace can be very useful (see below on how to create one).  Often a
small example file helps, along with clear information about:

@enumerate
@item What exactly did you do?
@item What did you expect to happen?
@item What happened instead?
@end enumerate
@noindent Thank you for helping to improve this mode.

@subsubheading How to create a useful backtrace

@cindex backtrace of an error
602
If working with Org produces an error with a message you don't
Glenn Morris's avatar
Glenn Morris committed
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
understand, you may have hit a bug.  The best way to report this is by
providing, in addition to what was mentioned above, a @emph{Backtrace}.
This is information from the built-in debugger about where and how the
error occurred.  Here is how to produce a useful backtrace:

@enumerate
@item
Start a fresh Emacs or XEmacs, and make sure that it will load the
original Lisp code in @file{org.el} instead of the compiled version in
@file{org.elc}.  The backtrace contains much more information if it is
produced with uncompiled code.  To do this, either rename @file{org.elc}
to something else before starting Emacs, or ask Emacs explicitly to load
@file{org.el} by using the command line
@example
emacs -l /path/to/org.el
@end example
@item
Go to the @code{Options} menu and select @code{Enter Debugger on Error}
(XEmacs has this option in the @code{Troubleshooting} sub-menu).
@item
Do whatever you have to do to hit the error.  Don't forget to
document the steps you take.
@item
When you hit the error, a @file{*Backtrace*} buffer will appear on the
screen.  Save this buffer to a file (for example using @kbd{C-x C-w}) and
attach it to your bug report.
@end enumerate

631 632 633
@node Conventions,  , Feedback, Introduction
@section Typesetting conventions used in this manual

634
Org uses three types of keywords: TODO keywords, tags, and property
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
names.  In this manual we use the following conventions:

@table @code
@item TODO
@itemx WAITING
TODO keywords are written with all capitals, even if they are
user-defined.
@item boss
@itemx ARCHIVE
User-defined tags are written in lowercase; built-in tags with special
meaning are written with all capitals.
@item Release
@itemx PRIORITY
User-defined properties are capitalized; built-in properties with
special meaning are written with all capitals.
@end table

652
@node Document Structure, Tables, Introduction, Top
Glenn Morris's avatar
Glenn Morris committed
653 654 655 656
@chapter Document Structure
@cindex document structure
@cindex structure of document

657
Org is based on outline mode and provides flexible commands to
Glenn Morris's avatar
Glenn Morris committed
658 659 660
edit the structure of the document.

@menu
661 662
* Outlines::                    Org is based on Outline mode
* Headlines::                   How to typeset Org tree headlines
Glenn Morris's avatar
Glenn Morris committed
663 664 665 666 667 668 669
* Visibility cycling::          Show and hide, much simplified
* Motion::                      Jumping to other headlines
* Structure editing::           Changing sequence and level of headlines
* Archiving::                   Move done task trees to a different place
* Sparse trees::                Matches embedded in context
* Plain lists::                 Additional structure within an entry
* Drawers::                     Tucking stuff away
670
* Orgstruct mode::              Structure editing outside Org
Glenn Morris's avatar
Glenn Morris committed
671 672
@end menu

673
@node Outlines, Headlines, Document Structure, Document Structure
Glenn Morris's avatar
Glenn Morris committed
674 675
@section Outlines
@cindex outlines
676
@cindex Outline mode
Glenn Morris's avatar
Glenn Morris committed
677

678
Org is implemented on top of Outline mode.  Outlines allow a
Glenn Morris's avatar
Glenn Morris committed
679 680 681 682
document to be organized in a hierarchical structure, which (at least
for me) is the best representation of notes and thoughts.  An overview
of this structure is achieved by folding (hiding) large parts of the
document to show only the general document structure and the parts
683
currently being worked on.  Org greatly simplifies the use of
Glenn Morris's avatar
Glenn Morris committed
684 685 686
outlines by compressing the entire show/hide functionality into a single
command @command{org-cycle}, which is bound to the @key{TAB} key.

687
@node Headlines, Visibility cycling, Outlines, Document Structure
Glenn Morris's avatar
Glenn Morris committed
688 689 690 691 692
@section Headlines
@cindex headlines
@cindex outline tree

Headlines define the structure of an outline tree.  The headlines in
693
Org start with one or more stars, on the left margin@footnote{See
Glenn Morris's avatar
Glenn Morris committed
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
the variable @code{org-special-ctrl-a/e} to configure special behavior
of @kbd{C-a} and @kbd{C-e} in headlines.}.  For example:

@example
* Top level headline
** Second level
*** 3rd level
    some text
*** 3rd level
    more text

* Another top level headline
@end example

@noindent Some people find the many stars too noisy and would prefer an
outline that has whitespace followed by a single star as headline
starters.  @ref{Clean view} describes a setup to realize this.

An empty line after the end of a subtree is considered part of it and
will be hidden when the subtree is folded.  However, if you leave at
least two empty lines, one empty line will remain visible after folding
the subtree, in order to structure the collapsed view.  See the
variable @code{org-cycle-separator-lines} to modify this behavior.

718
@node Visibility cycling, Motion, Headlines, Document Structure
Glenn Morris's avatar
Glenn Morris committed
719 720 721 722 723 724 725 726
@section Visibility cycling
@cindex cycling, visibility
@cindex visibility cycling
@cindex trees, visibility
@cindex show hidden text
@cindex hide text

Outlines make it possible to hide parts of the text in the buffer.
727
Org uses just two commands, bound to @key{TAB} and
Glenn Morris's avatar
Glenn Morris committed
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
@kbd{S-@key{TAB}} to change the visibility in the buffer.

@cindex subtree visibility states
@cindex subtree cycling
@cindex folded, subtree visibility state
@cindex children, subtree visibility state
@cindex subtree, subtree visibility state
@table @kbd
@kindex @key{TAB}
@item @key{TAB}
@emph{Subtree cycling}: Rotate current subtree among the states

@example
,-> FOLDED -> CHILDREN -> SUBTREE --.
'-----------------------------------'
@end example

The cursor must be on a headline for this to work@footnote{see, however,
the option @code{org-cycle-emulate-tab}.}.  When the cursor is at the
beginning of the buffer and the first line is not a headline, then
@key{TAB} actually runs global cycling (see below)@footnote{see the
option @code{org-cycle-global-at-bob}.}.  Also when called with a prefix
argument (@kbd{C-u @key{TAB}}), global cycling is invoked.

@cindex global visibility states
@cindex global cycling
@cindex overview, global visibility state
@cindex contents, global visibility state
@cindex show all, global visibility state
@kindex S-@key{TAB}
@item S-@key{TAB}
@itemx C-u @key{TAB}
@emph{Global cycling}: Rotate the entire buffer among the states

@example
,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
'--------------------------------------'
@end example

767 768 769
When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
CONTENTS view up to headlines of level N will be shown.  Note that inside
tables, @kbd{S-@key{TAB}} jumps to the previous field.
Glenn Morris's avatar
Glenn Morris committed
770 771 772 773 774 775 776

@cindex show all, command
@kindex C-c C-a
@item C-c C-a
Show all.
@kindex C-c C-r
@item C-c C-r
777 778 779 780
Reveal context around point, showing the current entry, the following heading
and the hierarchy above.  Useful for working near a location that has been
exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
(@pxref{Agenda commands}).  With a prefix argument show, on each
Glenn Morris's avatar
Glenn Morris committed
781 782 783 784 785 786 787 788 789 790 791 792 793
level, all sibling headings.
@kindex C-c C-x b
@item C-c C-x b
Show the current subtree in an indirect buffer@footnote{The indirect
buffer
@ifinfo
(@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
@end ifinfo
@ifnotinfo
(see the Emacs manual for more information about indirect buffers)
@end ifnotinfo
will contain the entire buffer, but will be narrowed to the current
tree.  Editing the indirect buffer will also change the original buffer,
794 795 796
but without affecting visibility in that buffer.}.  With a numeric
prefix argument N, go up to level N and then take that tree.  If N is
negative then go up that many levels.  With a @kbd{C-u} prefix, do not remove
Glenn Morris's avatar
Glenn Morris committed
797 798 799
the previously used indirect buffer.
@end table

800
When Emacs first visits an Org file, the global state is set to
Glenn Morris's avatar
Glenn Morris committed
801 802 803 804 805 806 807 808 809 810 811
OVERVIEW, i.e. only the top level headlines are visible.  This can be
configured through the variable @code{org-startup-folded}, or on a
per-file basis by adding one of the following lines anywhere in the
buffer:

@example
#+STARTUP: overview
#+STARTUP: content
#+STARTUP: showall
@end example

812 813 814 815 816 817 818 819 820 821 822 823 824
@noindent
Forthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
and Columns}) will get their visibility adapted accordingly.  Allowed values
for this property are @code{folded}, @code{children}, @code{content}, and
@code{all}.
@table @kbd
@kindex C-u C-u @key{TAB}
@item C-u C-u @key{TAB}
Switch back to the startup visibility of the buffer, i.e. whatever is
requested by startup options and @samp{VISIBILITY} properties in individual
entries.
@end table

825
@node Motion, Structure editing, Visibility cycling, Document Structure
Glenn Morris's avatar
Glenn Morris committed
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
@section Motion
@cindex motion, between headlines
@cindex jumping, to headlines
@cindex headline navigation
The following commands jump to other headlines in the buffer.

@table @kbd
@kindex C-c C-n
@item C-c C-n
Next heading.
@kindex C-c C-p
@item C-c C-p
Previous heading.
@kindex C-c C-f
@item C-c C-f
Next heading same level.
@kindex C-c C-b
@item C-c C-b
Previous heading same level.
@kindex C-c C-u
@item C-c C-u
Backward to higher level heading.
@kindex C-c C-j
@item C-c C-j
Jump to a different place without changing the current outline
visibility.  Shows the document structure in a temporary buffer, where
you can use the following keys to find your destination:
@example
@key{TAB}         @r{Cycle visibility.}
@key{down} / @key{up}   @r{Next/previous visible headline.}
n / p        @r{Next/previous visible headline.}
f / b        @r{Next/previous headline same level.}
u            @r{One level up.}
0-9          @r{Digit argument.}
@key{RET}         @r{Select this location.}
@end example
@end table

864
@node Structure editing, Archiving, Motion, Document Structure
Glenn Morris's avatar
Glenn Morris committed
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
@section Structure editing
@cindex structure editing
@cindex headline, promotion and demotion
@cindex promotion, of subtrees
@cindex demotion, of subtrees
@cindex subtree, cut and paste
@cindex pasting, of subtrees
@cindex cutting, of subtrees
@cindex copying, of subtrees
@cindex subtrees, cut and paste

@table @kbd
@kindex M-@key{RET}
@item M-@key{RET}
Insert new heading with same level as current.  If the cursor is in a
plain list item, a new item is created (@pxref{Plain lists}).  To force
881
creation of a new headline, use a prefix argument, or first press @key{RET}
Glenn Morris's avatar
Glenn Morris committed
882 883
to get to the beginning of the next line.  When this command is used in
the middle of a line, the line is split and the rest of the line becomes
884 885 886 887 888 889 890 891
the new headline@footnote{If you do not want the line to be split,
customize the variable @code{org-M-RET-may-split-line}.}.  If the
command is used at the beginning of a headline, the new headline is
created before the current line.  If at the beginning of any other line,
the content of that line is made the new heading.  If the command is
used at the end of a folded subtree (i.e. behind the ellipses at the end
of a headline), then a headline like the current one will be inserted
after the end of the subtree.
892 893 894 895
@kindex C-@key{RET}
@item C-@key{RET}
Insert a new heading after the current subtree, same level as the
current headline.  This command works from anywhere in the entry.
Glenn Morris's avatar
Glenn Morris committed
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
@kindex M-S-@key{RET}
@item M-S-@key{RET}
Insert new TODO entry with same level as current heading.
@kindex M-@key{left}
@item M-@key{left}
Promote current heading by one level.
@kindex M-@key{right}
@item M-@key{right}
Demote current heading by one level.
@kindex M-S-@key{left}
@item M-S-@key{left}
Promote the current subtree by one level.
@kindex M-S-@key{right}
@item M-S-@key{right}
Demote the current subtree by one level.
@kindex M-S-@key{up}
@item M-S-@key{up}
Move subtree up (swap with previous subtree of same
level).
@kindex M-S-@key{down}
@item M-S-@key{down}
Move subtree down (swap with next subtree of same level).
@kindex C-c C-x C-w
@kindex C-c C-x C-k
@item C-c C-x C-w
@itemx C-c C-x C-k
Kill subtree, i.e. remove it from buffer but save in kill ring.
923
With a numeric prefix argument N, kill N sequential subtrees.
Glenn Morris's avatar
Glenn Morris committed
924 925
@kindex C-c C-x M-w
@item C-c C-x M-w
926 927
Copy subtree to kill ring.  With a numeric prefix argument N, copy the N
sequential subtrees.
Glenn Morris's avatar
Glenn Morris committed
928 929 930
@kindex C-c C-x C-y
@item C-c C-x C-y
Yank subtree from kill ring.  This does modify the level of the subtree to
931 932
make sure the tree fits in nicely at the yank position.  The yank level can
also be specified with a numeric prefix argument, or by yanking after a
Glenn Morris's avatar
Glenn Morris committed
933
headline marker like @samp{****}.
934 935 936
@kindex C-c C-w
@item C-c C-w
Refile entry to a different location.  @xref{Refiling notes}.
Glenn Morris's avatar
Glenn Morris committed
937 938
@kindex C-c ^
@item C-c ^
939 940 941 942 943 944 945 946 947
Sort same-level entries.  When there is an active region, all entries in the
region will be sorted.  Otherwise the children of the current headline are
sorted.  The command prompts for the sorting method, which can be
alphabetically, numerically, by time (using the first time stamp in each
entry), by priority, or by TODO keyword (in the sequence the keywords have
been defined in the setup).  Reverse sorting is possible as well.  You can
also supply your own function to extract the sorting key.  With a @kbd{C-u}
prefix, sorting will be case-sensitive.  With two @kbd{C-u C-u} prefixes,
duplicate entries will also be removed.
948 949 950 951 952 953
@kindex C-x n s
@item C-x n s
Narrow buffer to current subtree.
@kindex C-x n w
@item C-x n w
Widen buffer to remove a narrowing.
954 955 956 957 958 959 960
@kindex C-c *
@item C-c *
Turn a normal line or plain list item into a headline (so that it
becomes a subheading at its location).  Also turn a headline into a
normal line by removing the stars.  If there is an active region, turn
all lines in the region into headlines.  Or, if the first line is a
headline, remove the stars from all headlines in the region.
Glenn Morris's avatar
Glenn Morris committed
961 962 963 964
@end table

@cindex region, active
@cindex active region
965 966
@cindex Transient mark mode
When there is an active region (Transient mark mode), promotion and
Glenn Morris's avatar
Glenn Morris committed
967 968 969 970 971 972 973
demotion work on all headlines in the region.  To select a region of
headlines, it is best to place both point and mark at the beginning of a
line, mark at the beginning of the first headline, and point at the line
just after the last headline to change.  Note that when the cursor is
inside a table (@pxref{Tables}), the Meta-Cursor keys have different
functionality.

974
@node Archiving, Sparse trees, Structure editing, Document Structure
Glenn Morris's avatar
Glenn Morris committed
975 976 977 978 979
@section Archiving
@cindex archiving

When a project represented by a (sub)tree is finished, you may want
to move the tree out of the way and to stop it from contributing to the
980
agenda.  Org mode knows two ways of archiving.  You can mark a tree with
Glenn Morris's avatar
Glenn Morris committed
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
the ARCHIVE tag, or you can move an entire (sub)tree to a different
location.

@menu
* ARCHIVE tag::                 Marking a tree as inactive
* Moving subtrees::             Moving a tree to an archive file
@end menu

@node ARCHIVE tag, Moving subtrees, Archiving, Archiving
@subsection The ARCHIVE tag
@cindex internal archiving

A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
its location in the outline tree, but behaves in the following way:
@itemize @minus
@item
It does not open when you attempt to do so with a visibility cycling
command (@pxref{Visibility cycling}).  You can force cycling archived
subtrees with @kbd{C-@key{TAB}}, or by setting the option
@code{org-cycle-open-archived-trees}.  Also normal outline commands like
@code{show-all} will open archived subtrees.
@item
During sparse tree construction (@pxref{Sparse trees}), matches in
archived subtrees are not exposed, unless you configure the option
@code{org-sparse-tree-open-archived-trees}.
@item
1007
During agenda view construction (@pxref{Agenda Views}), the content of
Glenn Morris's avatar
Glenn Morris committed
1008
archived trees is ignored unless you configure the option
Carsten Dominik's avatar
Carsten Dominik committed
1009 1010 1011
@code{org-agenda-skip-archived-trees}, in which case these trees will always
be included.  In the agenda you can press the @kbd{v} key to get archives
temporarily included.
Glenn Morris's avatar
Glenn Morris committed
1012 1013 1014 1015 1016 1017 1018 1019 1020
@item
Archived trees are not exported (@pxref{Exporting}), only the headline
is.  Configure the details using the variable
@code{org-export-with-archived-trees}.
@end itemize

The following commands help managing the ARCHIVE tag:

@table @kbd
1021 1022
@kindex C-c C-x a
@item C-c C-x a
Glenn Morris's avatar
Glenn Morris committed
1023
Toggle the ARCHIVE tag for the current headline.  When the tag is set,
1024
the headline changes to a shadowed face, and the subtree below it is
Glenn Morris's avatar
Glenn Morris committed
1025
hidden.
1026 1027
@kindex C-u C-c C-x a
@item C-u C-c C-x a
Glenn Morris's avatar
Glenn Morris committed
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
Check if any direct children of the current headline should be archived.
To do this, each subtree is checked for open TODO entries.  If none are
found, the command offers to set the ARCHIVE tag for the child.  If the
cursor is @emph{not} on a headline when this command is invoked, the
level 1 trees will be checked.
@kindex C-@kbd{TAB}
@item C-@kbd{TAB}
Cycle a tree even if it is tagged with ARCHIVE.
@end table

@node Moving subtrees,  , ARCHIVE tag, Archiving
@subsection Moving subtrees
@cindex external archiving

1042
Once an entire project is finished, you may want to move it to a different
Carsten Dominik's avatar
Carsten Dominik committed
1043
location.  Org can move it to an @emph{Archive Sibling} in the same tree, to a
1044
different tree in the current file, or to a different file, the archive file.
Glenn Morris's avatar
Glenn Morris committed
1045 1046

@table @kbd
1047 1048
@kindex C-c C-x A
@item C-c C-x A
Carsten Dominik's avatar
Carsten Dominik committed
1049 1050
Move the current entry to the @emph{Archive Sibling}.  This is a sibling of
the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}
1051 1052 1053
(@pxref{ARCHIVE tag}).  The entry becomes a child of that sibling and in this
way retains a lot of its original context, including inherited tags and
approximate position in the outline.
Glenn Morris's avatar
Glenn Morris committed
1054 1055 1056 1057
@kindex C-c C