aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorBastien Guerry2013-01-13 11:33:16 +0100
committerBastien Guerry2013-01-13 11:33:16 +0100
commita89c8ef024113dbf993db0d379fabbfb06c86520 (patch)
tree94b70d44c096cec75cf0dd10686042ef4574928c /doc
parentf5e9cbd447d2af41da420a5dde2f28ba75892a37 (diff)
downloademacs-a89c8ef024113dbf993db0d379fabbfb06c86520.tar.gz
emacs-a89c8ef024113dbf993db0d379fabbfb06c86520.zip
Merge Org 7.9.3d (commit e8f5b0ad).
Diffstat (limited to 'doc')
-rw-r--r--doc/misc/ChangeLog11
-rw-r--r--doc/misc/org.texi140
2 files changed, 58 insertions, 93 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index 8d88336183d..e3ee947fe24 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,14 @@
12013-01-13 Bastien Guerry <bzg@gnu.org>
2
3 * org.texi (Installation): Simplify.
4
52013-01-13 François Allisson <francois@allisson.co> (tiny change)
6
7 * org.texi (Handling links): Update the mention to the obsolete
8 variable `org-link-to-org-use-id' with a mention to the newer
9 variable `org-id-link-to-org-use-id'. Mention the need to load
10 the org-id library.
11
12013-01-08 Bastien Guerry <bzg@gnu.org> 122013-01-08 Bastien Guerry <bzg@gnu.org>
2 13
3 * org.texi (Pushing to MobileOrg): Add footnote about using 14 * org.texi (Pushing to MobileOrg): Add footnote about using
diff --git a/doc/misc/org.texi b/doc/misc/org.texi
index 75298db29fe..d41d2848cc6 100644
--- a/doc/misc/org.texi
+++ b/doc/misc/org.texi
@@ -2,7 +2,7 @@
2@c %**start of header 2@c %**start of header
3@setfilename ../../info/org 3@setfilename ../../info/org
4@settitle The Org Manual 4@settitle The Org Manual
5@set VERSION 7.9.3+ (GNU Emacs 24.3) 5@set VERSION 7.9.3d (GNU Emacs 24.3)
6 6
7@c Use proper quote and backtick for code sections in PDF output 7@c Use proper quote and backtick for code sections in PDF output
8@c Cf. Texinfo manual 14.2 8@c Cf. Texinfo manual 14.2
@@ -339,7 +339,7 @@ with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison,
339Introduction 339Introduction
340 340
341* Summary:: Brief summary of what Org does 341* Summary:: Brief summary of what Org does
342* Installation:: How to install a downloaded version of Org 342* Installation:: Installing Org
343* Activation:: How to activate Org for certain buffers 343* Activation:: How to activate Org for certain buffers
344* Feedback:: Bug reports, ideas, patches etc. 344* Feedback:: Bug reports, ideas, patches etc.
345* Conventions:: Typesetting conventions in the manual 345* Conventions:: Typesetting conventions in the manual
@@ -771,7 +771,7 @@ MobileOrg
771 771
772@menu 772@menu
773* Summary:: Brief summary of what Org does 773* Summary:: Brief summary of what Org does
774* Installation:: How to install a downloaded version of Org 774* Installation:: Installing Org
775* Activation:: How to activate Org for certain buffers 775* Activation:: How to activate Org for certain buffers
776* Feedback:: Bug reports, ideas, patches etc. 776* Feedback:: Bug reports, ideas, patches etc.
777* Conventions:: Typesetting conventions in the manual 777* Conventions:: Typesetting conventions in the manual
@@ -851,118 +851,69 @@ Theory Ltd.}
851@cindex installation 851@cindex installation
852@cindex XEmacs 852@cindex XEmacs
853 853
854@b{Important:} @i{If you the version of Org that comes with Emacs or as a 854Org is part of recent distributions of GNU Emacs, so you normally don't need
855XEmacs package, please skip this section and go directly to @ref{Activation}. 855to install it. If, for one reason or another, you want to install Org on top
856If you downloaded Org as an ELPA package, please read the instructions on the 856of this pre-packaged version, there are three ways to do it:
857@uref{http://orgmode.org/elpa.html, Org ELPA page}. To see what version of Org
858(if any) is part of your Emacs distribution, type @kbd{M-x org-version} (if
859your Emacs distribution does not come with Org, this function will not be
860defined).}
861
862Installation of Org mode uses a build system, which is described in more
863detail on @uref{http://orgmode.org/worg/dev/org-build-system.html, Worg}.
864
865If you have downloaded Org from the Web as a distribution @file{.zip} or
866@file{.tar.gz} archive, take the following steps to install it:
867 857
868@itemize @bullet 858@itemize @bullet
869@item Unpack the distribution archive. 859@item By using Emacs package system.
870@item Change into (@code{cd}) the Org directory. 860@item By downloading Org as an archive.
871@item Run @code{make help config} 861@item By using Org's git repository.
872and then check and edit the file @file{local.mk} if the default configuration
873does not match your system. Set the name of the Emacs binary (likely either
874@file{emacs} or @file{xemacs}), and the paths to the directories where local
875Lisp and Info files will be installed. If the Emacs binary is not in your
876path, give the full path to the executable. Avoid spaces in any path names.
877@item Run @code{make config}
878again to check the configuration.
879@item Run @code{make install} or @code{sudo make install}
880to build and install Org mode on your system.
881@end itemize 862@end itemize
882 863
883If you use a cloned Git repository, then the procedure is slightly different. 864We @b{strongly recommend} to stick to a single installation method.
884The following description assumes that you are using the @code{master} branch
885(where the development is done). You could also use the @code{maint} branch
886instead, where the release versions are published, just replace @code{master}
887with @code{maint} in the description below.
888 865
889@itemize @bullet 866@subsubheading Using Emacs packaging system
890@item Change into (@code{cd}) the Org repository.
891@item Run @code{git checkout master}
892to switch to the @code{master} branch of the Org repository.
893@item Run @code{make help}
894and then check and edit the file @file{local.mk}. You must set the name of
895the Emacs binary (likely either @file{emacs} or @file{xemacs}), and the paths
896to the directories where local Lisp and Info files will be installed. If the
897Emacs binary is not in your path, you must give the full path to the
898executable. Avoid spaces in any path names.
899@item Run @code{make config}
900to check the configuration.
901@item Optionally run @code{make test}
902to build Org mode and then run the full testsuite.
903@item Run @code{make update2} or @code{make up2}
904to update the Git repository and build and install Org mode. The latter
905invocation runs the complete test suite before installation and installs only
906if the build passes all tests.
907@end itemize
908 867
909If you don't have access to the system-wide directories and you don't want to 868Recent Emacs distributions include a packaging system which lets you install
910install somewhere into your home directory, you can run Org directly from the 869Elisp libraries. You can install Org with @kbd{M-x package-install RET org}.
911distribution directory or Org repository by compiling Org mode in place: 870To make sure your Org configuration is well taken into account, initialize
912 871the package system with @code{(package-initialize)} before setting any Org
913@itemize @bullet 872option. If you want to use Org's package repository, check out the
914@item Change into (@code{cd}) the Org repository. 873@uref{http://orgmode.org/elpa.html, Org ELPA page}.
915@item Run @code{git checkout master}
916to switch to the @code{master} branch of the Org repository.
917@item Run @code{make compile}
918@end itemize
919 874
920Last but not least you can also run Org mode directly from an Org repository 875@subsubheading Downloading Org as an archive
921without any compilation. Simply replace the last step in the recipe above
922with @code{make uncompiled}.
923 876
924Then add the following line to @file{.emacs}: 877You can download Org latest release from @uref{http://orgmode.org/, Org's
878website}. In this case, make sure you set the load-path correctly in your
879@file{.emacs}:
925 880
926@example 881@example
927(add-to-list 'load-path "~/path/to/orgdir/lisp") 882(add-to-list 'load-path "~/path/to/orgdir/lisp")
928@end example 883@end example
929 884
930@noindent 885The downloaded archive contains contributed libraries that are not included
931If you plan to use code from the @file{contrib} subdirectory without 886in Emacs. If you want to use them, add the @file{contrib} directory to your
932compiling them, do a similar step for this directory: 887load-path:
933 888
934@example 889@example
935(add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t) 890(add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
936@end example 891@end example
937 892
938If you want to include those files with the build and install, please 893Optionally, you can compile the files and/or install them in your system.
939customize the variable @code{ORG_ADD_CONTRIB} instead in your @code{local.mk} 894Run @code{make help} to list compilation and installation options.
940file, for more details please see this
941@uref{http://orgmode.org/worg/dev/org-build-system.html#sec-4-1-2,
942description on Worg}.
943 895
944Installing Info files is system dependent, because of differences in the 896@subsubheading Using Org's git repository
945@file{install-info} program. The Info documentation is installed together 897
946with the rest of Org mode. If you don't install Org mode, it is possible to 898You can clone Org's repository and install Org like this:
947install the Info documentation separately (you need to have
948install-info@footnote{The output from install-info (if any) is system
949dependent. In particular Debian and its derivatives use two different
950versions of install-info and you may see the message:
951 899
952@example 900@example
953This is not dpkg install-info anymore, but GNU install-info 901$ cd ~/src/
954See the man page for ginstall-info for command line arguments 902$ git clone git://orgmode.org/org-mode.git
903$ make autoloads
955@end example 904@end example
956 905
957@noindent which can be safely ignored.} 906Note that @code{make autoloads} is mandatory: it defines Org's version and
958on your system). 907Org's autoloaded functions, respectively in @file{org-version.el} and in
908@file{org-loaddefs.el}.
959 909
960@example 910Remember to add the correct load-path as described in the method above.
961make install-info
962@end example
963 911
964Do not forget to activate Org as described in the following section. 912You can also compile and install Org from this git repository: check
965@page 913@code{make help} to get the list of compilation/installation options.
914
915For more detailed explanations on Org's build system, please check the Org
916Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html, Worg}.
966 917
967@node Activation, Feedback, Installation, Introduction 918@node Activation, Feedback, Installation, Introduction
968@section Activation 919@section Activation
@@ -3384,13 +3335,16 @@ be the description@footnote{If the headline contains a timestamp, it will be
3384removed from the link and result in a wrong link---you should avoid putting 3335removed from the link and result in a wrong link---you should avoid putting
3385timestamp in the headline.}. 3336timestamp in the headline.}.
3386 3337
3387@vindex org-link-to-org-use-id 3338@vindex org-id-link-to-org-use-id
3388@cindex property, CUSTOM_ID 3339@cindex property, CUSTOM_ID
3389@cindex property, ID 3340@cindex property, ID
3390If the headline has a @code{CUSTOM_ID} property, a link to this custom ID 3341If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3391will be stored. In addition or alternatively (depending on the value of 3342will be stored. In addition or alternatively (depending on the value of
3392@code{org-link-to-org-use-id}), a globally unique @code{ID} property will be 3343@code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3393created and/or used to construct a link. So using this command in Org 3344be created and/or used to construct a link@footnote{The library @code{org-id}
3345must first be loaded, either through @code{org-customize} by enabling
3346@code{id} in @code{org-modules} , or by adding @code{(require 'org-id)} in
3347your @file{.emacs}.}. So using this command in Org
3394buffers will potentially create two links: a human-readable from the custom 3348buffers will potentially create two links: a human-readable from the custom
3395ID, and one that is globally unique and works even if the entry is moved from 3349ID, and one that is globally unique and works even if the entry is moved from
3396file to file. Later, when inserting the link, you need to decide which one 3350file to file. Later, when inserting the link, you need to decide which one