aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorTom Tromey2013-01-16 11:48:32 -0700
committerTom Tromey2013-01-16 11:48:32 -0700
commit6f4de085f065e11f4df3195d47479f28f5ef08ba (patch)
tree1211a00f1afc86c2b73624897993db02a4852943 /doc
parente078a23febca14bc919c5806670479c395e3253e (diff)
parentffe04adc88e546c406f9b050238fb98a7243c7a0 (diff)
downloademacs-6f4de085f065e11f4df3195d47479f28f5ef08ba.tar.gz
emacs-6f4de085f065e11f4df3195d47479f28f5ef08ba.zip
merge from trunk
Diffstat (limited to 'doc')
-rw-r--r--doc/emacs/ChangeLog5
-rw-r--r--doc/emacs/help.texi9
-rw-r--r--doc/lispref/ChangeLog9
-rw-r--r--doc/lispref/commands.texi8
-rw-r--r--doc/lispref/windows.texi9
-rw-r--r--doc/misc/ChangeLog45
-rw-r--r--doc/misc/autotype.texi3
-rw-r--r--doc/misc/cc-mode.texi2
-rw-r--r--doc/misc/htmlfontify.texi49
-rw-r--r--doc/misc/info.texi3
-rw-r--r--doc/misc/org.texi220
-rw-r--r--doc/misc/pgg.texi4
-rw-r--r--doc/misc/tramp.texi16
13 files changed, 225 insertions, 157 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog
index 601949af88e..1b5bdc8fb53 100644
--- a/doc/emacs/ChangeLog
+++ b/doc/emacs/ChangeLog
@@ -1,3 +1,8 @@
12013-01-07 Bastien Guerry <bzg@gnu.org>
2
3 * help.texi (Apropos): Document `apropos-user-option' and update
4 the doc for `apropos-variable'.
5
12013-01-05 Glenn Morris <rgm@gnu.org> 62013-01-05 Glenn Morris <rgm@gnu.org>
2 7
3 * text.texi (HTML Mode): Remove deleted nxml C-RET binding. 8 * text.texi (HTML Mode): Remove deleted nxml C-RET binding.
diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi
index 0a0a3865d2d..75b250d0f40 100644
--- a/doc/emacs/help.texi
+++ b/doc/emacs/help.texi
@@ -295,11 +295,16 @@ search for noninteractive functions too.
295Search for functions and variables. Both interactive functions 295Search for functions and variables. Both interactive functions
296(commands) and noninteractive functions can be found by this. 296(commands) and noninteractive functions can be found by this.
297 297
298@item M-x apropos-variable 298@item M-x apropos-user-option
299@findex apropos-variable 299@findex apropos-user-option
300Search for user-customizable variables. With a prefix argument, 300Search for user-customizable variables. With a prefix argument,
301search for non-customizable variables too. 301search for non-customizable variables too.
302 302
303@item M-x apropos-variable
304@findex apropos-variable
305Search for variables. With a prefix argument, search for
306customizable variables only.
307
303@item M-x apropos-value 308@item M-x apropos-value
304@findex apropos-value 309@findex apropos-value
305Search for variables whose values match the specified pattern. With a 310Search for variables whose values match the specified pattern. With a
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 31c81e62ac1..2631bdf708a 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,12 @@
12013-01-09 Glenn Morris <rgm@gnu.org>
2
3 * commands.texi (Interactive Codes):
4 Whitespace does not terminate interactive "S". (Bug#13393)
5
62013-01-06 Chong Yidong <cyd@gnu.org>
7
8 * windows.texi (Vertical Scrolling): Fix typos (Bug#13267).
9
12013-01-05 Glenn Morris <rgm@gnu.org> 102013-01-05 Glenn Morris <rgm@gnu.org>
2 11
3 * display.texi (Overlay Properties): Mention field. (Bug#13364) 12 * display.texi (Overlay Properties): Mention field. (Bug#13364)
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index f3589fc2edd..846d6f3a4a9 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -471,10 +471,10 @@ Arbitrary text, read in the minibuffer and returned as a string
471these characters in the input.) Prompt. 471these characters in the input.) Prompt.
472 472
473@item S 473@item S
474An interned symbol whose name is read in the minibuffer. Any whitespace 474An interned symbol whose name is read in the minibuffer. Terminate
475character terminates the input. (Use @kbd{C-q} to include whitespace in 475the input with either @kbd{C-j} or @key{RET}. Other characters that
476the string.) Other characters that normally terminate a symbol (e.g., 476normally terminate a symbol (e.g., whitespace, parentheses and
477parentheses and brackets) do not do so here. Prompt. 477brackets) do not do so here. Prompt.
478 478
479@item U 479@item U
480A key sequence or @code{nil}. Can be used after a @samp{k} or 480A key sequence or @code{nil}. Can be used after a @samp{k} or
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index b3c143496dd..792002add81 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -3054,10 +3054,11 @@ pixels. In this case, the return value is @var{lines}.
3054@end defun 3054@end defun
3055 3055
3056@defvar auto-window-vscroll 3056@defvar auto-window-vscroll
3057If this variable is non-@code{nil}, the line-move, scroll-up, and 3057If this variable is non-@code{nil}, the @code{line-move},
3058scroll-down functions will automatically modify the vertical scroll 3058@code{scroll-up}, and @code{scroll-down} functions will automatically
3059position to scroll through display rows that are taller than the height 3059modify the vertical scroll position to scroll through display rows
3060of the window, for example in the presence of large images. 3060that are taller than the height of the window, for example in the
3061presence of large images.
3061@end defvar 3062@end defvar
3062 3063
3063@node Horizontal Scrolling 3064@node Horizontal Scrolling
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index d756f4fd0f0..95c7ac7b233 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,48 @@
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
122013-01-10 Michael Albinus <michael.albinus@gmx.de>
13
14 * tramp.texi (Default Host): Introduce `tramp-default-host-alist'.
15
162013-01-09 Bastien Guerry <bzg@gnu.org>
17
18 * org.texi (Pushing to MobileOrg): Add footnote about using
19 symbolic links in `org-directory'.
20 (Timestamps, Deadlines and scheduling): Use `diary-float' instead
21 of the now obsolete alias `org-float'.
22 (TODO basics): Add `org-use-fast-todo-selection' to the variable
23 index. Fix description of TODO keywords cycling.
24 (Advanced features): Add missing argument for @item.
25 (Storing searches): Add index entries and a note about
26 *-tree agenda views.
27 (Structure editing): Document `org-mark-element' and
28 `org-mark-subtree'.
29 (Tag inheritance): Document `org-agenda-use-tag-inheritance'.
30
312013-01-08 Juri Linkov <juri@jurta.org>
32
33 * info.texi (Go to node): Mention the abbreviated format
34 `(FILENAME)' equal to `(FILENAME)Top'. (Bug#13365)
35
362013-01-06 Andreas Schwab <schwab@linux-m68k.org>
37
38 * autotype.texi: Remove undefined command @subtitlefont.
39 * cc-mode.texi: Likewise.
40
41 * org.texi (Advanced features): Use `@w{ }' instead of `@ ' in
42 @item argument.
43 (Property searches): Use \\ instead of @backslashchar{}.
44 * pgg.texi (VERSION): Move @set below @setfilename.
45
12013-01-05 Andreas Schwab <schwab@linux-m68k.org> 462013-01-05 Andreas Schwab <schwab@linux-m68k.org>
2 47
3 * ada-mode.texi: Remove braces from @title argument. 48 * ada-mode.texi: Remove braces from @title argument.
diff --git a/doc/misc/autotype.texi b/doc/misc/autotype.texi
index ad6a2902b1e..137ed6b43e8 100644
--- a/doc/misc/autotype.texi
+++ b/doc/misc/autotype.texi
@@ -37,8 +37,7 @@ modify this GNU manual.''
37 37
38@center @titlefont{Autotyping} 38@center @titlefont{Autotyping}
39@sp 2 39@sp 2
40@center @subtitlefont{Convenient features for text that you enter 40@center Convenient features for text that you enter frequently in Emacs
41frequently in Emacs}
42@sp 2 41@sp 2
43@center Daniel Pfeiffer 42@center Daniel Pfeiffer
44@center additions by Dave Love 43@center additions by Dave Love
diff --git a/doc/misc/cc-mode.texi b/doc/misc/cc-mode.texi
index f63c6c54a16..55b7028101a 100644
--- a/doc/misc/cc-mode.texi
+++ b/doc/misc/cc-mode.texi
@@ -188,7 +188,7 @@ modify this GNU manual.''
188 188
189@center @titlefont{CC Mode 5.32} 189@center @titlefont{CC Mode 5.32}
190@sp 2 190@sp 2
191@center @subtitlefont{A GNU Emacs mode for editing C and C-like languages} 191@center A GNU Emacs mode for editing C and C-like languages
192@sp 2 192@sp 2
193@center Barry A. Warsaw, Martin Stjernholm, Alan Mackenzie 193@center Barry A. Warsaw, Martin Stjernholm, Alan Mackenzie
194 194
diff --git a/doc/misc/htmlfontify.texi b/doc/misc/htmlfontify.texi
index 911cdd3cd5f..6cb8942bf15 100644
--- a/doc/misc/htmlfontify.texi
+++ b/doc/misc/htmlfontify.texi
@@ -7,7 +7,7 @@
7 7
8@copying 8@copying
9This manual documents Htmlfontify, a source code -> crosslinked + 9This manual documents Htmlfontify, a source code -> crosslinked +
10formatted + syntax colorised html transformer. 10formatted + syntax colorized html transformer.
11 11
12Copyright @copyright{} 2002, 2003, 2013 Free Software Foundation, Inc. 12Copyright @copyright{} 2002, 2003, 2013 Free Software Foundation, Inc.
13 13
@@ -56,7 +56,7 @@ modify this GNU manual.''
56@menu 56@menu
57* Introduction:: About Htmlfontify. 57* Introduction:: About Htmlfontify.
58* Usage & Examples:: How to use Htmlfontify. 58* Usage & Examples:: How to use Htmlfontify.
59* Customisation:: Fine-tuning Htmlfontify's behaviour. 59* Customization:: Fine-tuning Htmlfontify's behaviour.
60* Requirements:: External programs used by Htmlfontify. 60* Requirements:: External programs used by Htmlfontify.
61* GNU Free Documentation License:: The license for this documentation. 61* GNU Free Documentation License:: The license for this documentation.
62* Index:: Index of contents. 62* Index:: Index of contents.
@@ -68,7 +68,7 @@ modify this GNU manual.''
68 68
69Htmlfontify provides a means of converting individual Emacs buffers, 69Htmlfontify provides a means of converting individual Emacs buffers,
70source files, or entire source trees to html, preserving formatting 70source files, or entire source trees to html, preserving formatting
71and Emacs colorisation / syntax highlighting as much as possible 71and Emacs colorization / syntax highlighting as much as possible
72through careful application of CSS stylesheets and html tags. 72through careful application of CSS stylesheets and html tags.
73 73
74It can also turn instances of functions, methods and (for some 74It can also turn instances of functions, methods and (for some
@@ -76,7 +76,7 @@ languages) variables and other constructs and items into links
76to their definitions, and create an index file (or files) of 76to their definitions, and create an index file (or files) of
77all such symbols, also linked to their points of definition. 77all such symbols, also linked to their points of definition.
78 78
79Htmlfontify also provides several customisation items, which should 79Htmlfontify also provides several customization items, which should
80allow it to mesh more-or-less seamlessly with various templating or 80allow it to mesh more-or-less seamlessly with various templating or
81publishing systems (in the event, for instance, that you don't want 81publishing systems (in the event, for instance, that you don't want
82to produce the html pages directly). 82to produce the html pages directly).
@@ -93,7 +93,7 @@ batch mode.
93@menu 93@menu
94* Interactive:: Using Htmlfontify interactively. 94* Interactive:: Using Htmlfontify interactively.
95* Non-interactive:: Using Htmlfontify from elisp. 95* Non-interactive:: Using Htmlfontify from elisp.
96* Variables:: Variables (other than customisation entries). 96* Variables:: Variables (other than customization entries).
97* Data Structures:: Important data structures. 97* Data Structures:: Important data structures.
98* Examples:: Example(s) of Htmlfontify in use. 98* Examples:: Example(s) of Htmlfontify in use.
99@end menu 99@end menu
@@ -236,7 +236,7 @@ color map specified, otherwise it uses Htmlfontify's built in map.
236@end lisp 236@end lisp
237 237
238Return a @code{defface} style alist of possible specifications for 238Return a @code{defface} style alist of possible specifications for
239@var{face}, with any entries resulting from user customisation 239@var{face}, with any entries resulting from user customization
240(@code{custom-set-faces}) taking precedence. 240(@code{custom-set-faces}) taking precedence.
241 241
242See also: @ref{hfy-default-face-def} 242See also: @ref{hfy-default-face-def}
@@ -268,10 +268,10 @@ does things like deferring fontification until a section of the buffer is
268exposed and rendered, or until Emacs is idle for a while. Sometimes, in 268exposed and rendered, or until Emacs is idle for a while. Sometimes, in
269non-interactive circumstances, or if it can't see X, it doesn't bother 269non-interactive circumstances, or if it can't see X, it doesn't bother
270with some of the harder stuff. While this is all great from the perspective 270with some of the harder stuff. While this is all great from the perspective
271of a user waiting for Emacs to load a 20000 line file and colorise it, 271of a user waiting for Emacs to load a 20000 line file and colorize it,
272it's a pain from the point of view from non-interactive code. This function 272it's a pain from the point of view from non-interactive code. This function
273lies, cheats, steals and generally bullies Emacs into fontifying a buffer 273lies, cheats, steals and generally bullies Emacs into fontifying a buffer
274from start to finish, with all the extra frills, whether it thinks it nneds 274from start to finish, with all the extra frills, whether it thinks it needs
275to or not. Oh yes: it operates on the current buffer. 275to or not. Oh yes: it operates on the current buffer.
276 276
277@item hfy-link-style-string 277@item hfy-link-style-string
@@ -861,7 +861,7 @@ As per @ref{hfy-color} but for background colors.
861(hfy-kludge-cperl-mode) 861(hfy-kludge-cperl-mode)
862@end lisp 862@end lisp
863 863
864cperl mode does its damndest not to do some of its fontification when not 864cperl mode does its best to not do some of its fontification when not
865in a windowing system---we try to trick it@dots{} 865in a windowing system---we try to trick it@dots{}
866 866
867@item hfy-href 867@item hfy-href
@@ -1044,7 +1044,7 @@ Convert an Emacs @code{:width} attribute to a CSS font-stretch attribute.
1044@section Variables 1044@section Variables
1045@cindex variables 1045@cindex variables
1046 1046
1047Important variables that are not customisation items: 1047Important variables that are not customization items:
1048 1048
1049@table @code 1049@table @code
1050 1050
@@ -1234,7 +1234,7 @@ main-content <=MAIN_CONTENT;\n" rtfm-section file style rtfm-section file))
1234 1234
1235;; Here's the function I actually call---it asks me for a section label, 1235;; Here's the function I actually call---it asks me for a section label,
1236;; and source and destination directories, and then binds a couple of 1236;; and source and destination directories, and then binds a couple of
1237;; customisation variable in a let before calling htmlfontify: 1237;; customization variable in a let before calling htmlfontify:
1238(defun rtfm-build-source-docs (section srcdir destdir) 1238(defun rtfm-build-source-docs (section srcdir destdir)
1239 (interactive 1239 (interactive
1240 "s section[eg- emacs / p4-blame]:\nD source-dir: \nD output-dir: ") 1240 "s section[eg- emacs / p4-blame]:\nD source-dir: \nD output-dir: ")
@@ -1252,11 +1252,11 @@ main-content <=MAIN_CONTENT;\n" rtfm-section file style rtfm-section file))
1252 (htmlfontify-copy-and-link-dir srcdir destdir ".src" ".html"))) 1252 (htmlfontify-copy-and-link-dir srcdir destdir ".src" ".html")))
1253@end lisp 1253@end lisp
1254 1254
1255@node Customisation 1255@node Customization
1256@chapter Customisation 1256@chapter Customization
1257@cindex variables (customisation) 1257@cindex variables (customization)
1258 1258
1259Htmlfontify provides the following variable and customisation entries: 1259Htmlfontify provides the following variable and customization entries:
1260 1260
1261@table @code 1261@table @code
1262@comment AUTOGENERATED BLOCK 1262@comment AUTOGENERATED BLOCK
@@ -1394,7 +1394,7 @@ when @ref{hfy-display-class} has been set (the normal Htmlfontify way of
1394extracting potentially non-current face information doesn't necessarily 1394extracting potentially non-current face information doesn't necessarily
1395work for @code{default}). 1395work for @code{default}).
1396 1396
1397For example, I customise this to: 1397For example, I customize this to:
1398 1398
1399@lisp 1399@lisp
1400((t :background "black" :foreground "white" :family "misc-fixed")) 1400((t :background "black" :foreground "white" :family "misc-fixed"))
@@ -1405,7 +1405,7 @@ For example, I customise this to:
1405@anchor{hfy-init-kludge-hooks} 1405@anchor{hfy-init-kludge-hooks}
1406 1406
1407List of functions to call when starting htmlfontify-buffer to do any 1407List of functions to call when starting htmlfontify-buffer to do any
1408kludging necessary to get highlighting modes to bahave as you want, even 1408kludging necessary to get highlighting modes to behave as you want, even
1409when not running under a window system. 1409when not running under a window system.
1410 1410
1411@item hfy-shell-file-name 1411@item hfy-shell-file-name
@@ -1421,7 +1421,7 @@ Currently this is only required/used when using GNU etags, see
1421@vindex hfy-optimisations 1421@vindex hfy-optimisations
1422@anchor{hfy-optimisations} 1422@anchor{hfy-optimisations}
1423 1423
1424Optimisations to turn on. So far, the following have been implemented: 1424Optimizations to turn on. So far, the following have been implemented:
1425 1425
1426@table @option 1426@table @option
1427@item merge-adjacent-tags 1427@item merge-adjacent-tags
@@ -1454,7 +1454,8 @@ Suppress hyperlinking between files highlighted by different modes.
1454 1454
1455@end table 1455@end table
1456 1456
1457Note: like compiler optimisations, these optimise the _output_ of the code, 1457Note: like compiler optimizations, these optimize the @emph{output} of
1458the code,
1458not the processing of the source itself, and are therefore likely to slow 1459not the processing of the source itself, and are therefore likely to slow
1459Htmlfontify down, at least a little. Except for skip-refontification, 1460Htmlfontify down, at least a little. Except for skip-refontification,
1460which can never slow you down, but may result in incomplete fontification. 1461which can never slow you down, but may result in incomplete fontification.
@@ -1470,7 +1471,7 @@ Regex to remove from the <style> a variant of an Htmlfontify CSS class.
1470@anchor{hfy-link-extn} 1471@anchor{hfy-link-extn}
1471 1472
1472File extension used for href links---useful where the Htmlfontify 1473File extension used for href links---useful where the Htmlfontify
1473output files are going to be processed again, with a rersulting change 1474output files are going to be processed again, with a resulting change
1474in file extension. If @code{nil}, then any code using this should fall back 1475in file extension. If @code{nil}, then any code using this should fall back
1475to @ref{hfy-extn}. 1476to @ref{hfy-extn}.
1476 1477
@@ -1570,16 +1571,16 @@ money are always welcome.
1570 1571
1571@item 1572@item
1572A copy of etags (exuberant-ctags or GNU etags). Htmlfontify attempts 1573A copy of etags (exuberant-ctags or GNU etags). Htmlfontify attempts
1573to autodetect the version you have and customise itself accordingly, 1574to autodetect the version you have and customize itself accordingly,
1574but you should be able to override this. 1575but you should be able to override this.
1575 1576
1576See: @ref{Customisation} 1577See: @ref{Customization}
1577 1578
1578@item 1579@item
1579A copy of find (e.g., GNU find) that provides the @code{-path} predicate. 1580A copy of find (e.g., GNU find) that provides the @code{-path} predicate.
1580 1581
1581You may be able to work around this with a suitable clever shell 1582You may be able to work around this with a suitable clever shell
1582command and the customisation entry: @ref{hfy-find-cmd} 1583command and the customization entry: @ref{hfy-find-cmd}
1583 1584
1584@item 1585@item
1585A copy of sed (e.g., GNU sed). 1586A copy of sed (e.g., GNU sed).
@@ -1603,7 +1604,7 @@ A copy of the @code{file} command.
1603@item Functions 1604@item Functions
1604@printindex fn 1605@printindex fn
1605 1606
1606@item Variables & Customisation 1607@item Variables & Customization
1607@printindex vr 1608@printindex vr
1608 1609
1609@end table 1610@end table
diff --git a/doc/misc/info.texi b/doc/misc/info.texi
index 70dfffde393..d17a65571f1 100644
--- a/doc/misc/info.texi
+++ b/doc/misc/info.texi
@@ -1079,7 +1079,8 @@ partial node name.
1079node name by putting it at the front, in parentheses. Thus, 1079node name by putting it at the front, in parentheses. Thus,
1080@kbd{g(dir)Top@key{RET}} would go to the Info Directory node, which is 1080@kbd{g(dir)Top@key{RET}} would go to the Info Directory node, which is
1081the node @samp{Top} in the Info file @file{dir}. Likewise, 1081the node @samp{Top} in the Info file @file{dir}. Likewise,
1082@kbd{g(emacs)Top@key{RET}} goes to the top node of the Emacs manual. 1082@kbd{g(emacs)Top@key{RET}} (or just @kbd{g(emacs)@key{RET}}) goes to the
1083top node of the Emacs manual.
1083 1084
1084 The node name @samp{*} specifies the whole file. So you can look at 1085 The node name @samp{*} specifies the whole file. So you can look at
1085all of the current file by typing @kbd{g*@key{RET}} or all of any 1086all of the current file by typing @kbd{g*@key{RET}} or all of any
diff --git a/doc/misc/org.texi b/doc/misc/org.texi
index bea130ccb43..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.2 (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
871the package system with @code{(package-initialize)} before setting any Org
872option. If you want to use Org's package repository, check out the
873@uref{http://orgmode.org/elpa.html, Org ELPA page}.
912 874
913@itemize @bullet 875@subsubheading Downloading Org as an archive
914@item Change into (@code{cd}) the Org repository.
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 876
920Last but not least you can also run Org mode directly from an Org repository 877You can download Org latest release from @uref{http://orgmode.org/, Org's
921without any compilation. Simply replace the last step in the recipe above 878website}. In this case, make sure you set the load-path correctly in your
922with @code{make uncompiled}. 879@file{.emacs}:
923
924Then add the following line to @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
@@ -1470,6 +1421,13 @@ Move subtree up (swap with previous subtree of same
1470level). 1421level).
1471@orgcmd{M-S-@key{down},org-move-subtree-down} 1422@orgcmd{M-S-@key{down},org-move-subtree-down}
1472Move subtree down (swap with next subtree of same level). 1423Move subtree down (swap with next subtree of same level).
1424@orgcmd{M-h,org-mark-element}
1425Mark the element at point. Hitting repeatedly will mark subsequent elements
1426of the one just marked. E.g. hitting @key{M-h} on a paragraph will mark it,
1427hitting @key{M-h} immediately again will mark the next one.
1428@orgcmd{C-c @@,org-mark-subtree}
1429Mark the subtree at point. Hitting repeatedly will mark subsequent subtrees
1430of the same level than the marked subtree.
1473@orgcmd{C-c C-x C-w,org-cut-subtree} 1431@orgcmd{C-c C-x C-w,org-cut-subtree}
1474Kill subtree, i.e., remove it from buffer but save in kill ring. 1432Kill subtree, i.e., remove it from buffer but save in kill ring.
1475With a numeric prefix argument N, kill N sequential subtrees. 1433With a numeric prefix argument N, kill N sequential subtrees.
@@ -3027,7 +2985,7 @@ lines will be left alone by this command.
3027Selects this line for global recalculation with @kbd{C-u C-c *}, but 2985Selects this line for global recalculation with @kbd{C-u C-c *}, but
3028not for automatic recalculation. Use this when automatic 2986not for automatic recalculation. Use this when automatic
3029recalculation slows down editing too much. 2987recalculation slows down editing too much.
3030@item @ 2988@item @w{ }
3031Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}. 2989Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3032All lines that should be recalculated should be marked with @samp{#} 2990All lines that should be recalculated should be marked with @samp{#}
3033or @samp{*}. 2991or @samp{*}.
@@ -3377,13 +3335,16 @@ be the description@footnote{If the headline contains a timestamp, it will be
3377removed 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
3378timestamp in the headline.}. 3336timestamp in the headline.}.
3379 3337
3380@vindex org-link-to-org-use-id 3338@vindex org-id-link-to-org-use-id
3381@cindex property, CUSTOM_ID 3339@cindex property, CUSTOM_ID
3382@cindex property, ID 3340@cindex property, ID
3383If 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
3384will be stored. In addition or alternatively (depending on the value of 3342will be stored. In addition or alternatively (depending on the value of
3385@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
3386created 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
3387buffers will potentially create two links: a human-readable from the custom 3348buffers will potentially create two links: a human-readable from the custom
3388ID, 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
3389file 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
@@ -3747,6 +3708,8 @@ The most important commands to work with TODO entries are:
3747@table @kbd 3708@table @kbd
3748@orgcmd{C-c C-t,org-todo} 3709@orgcmd{C-c C-t,org-todo}
3749@cindex cycling, of TODO states 3710@cindex cycling, of TODO states
3711@vindex org-use-fast-todo-selection
3712
3750Rotate the TODO state of the current item among 3713Rotate the TODO state of the current item among
3751 3714
3752@example 3715@example
@@ -3754,14 +3717,19 @@ Rotate the TODO state of the current item among
3754'--------------------------------' 3717'--------------------------------'
3755@end example 3718@end example
3756 3719
3757The same rotation can also be done ``remotely'' from the timeline and 3720If TODO keywords have fast access keys (see @ref{Fast access to TODO
3758agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}). 3721states}), you will be prompted for a TODO keyword through the fast selection
3722interface; this is the default behavior when
3723@var{org-use-fast-todo-selection} is @code{non-nil}.
3724
3725The same rotation can also be done ``remotely'' from the timeline and agenda
3726buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3759 3727
3760@orgkey{C-u C-c C-t} 3728@orgkey{C-u C-c C-t}
3761Select a specific keyword using completion or (if it has been set up) 3729When TODO keywords have no selection keys, select a specific keyword using
3762the fast selection interface. For the latter, you need to assign keys 3730completion; otherwise force cycling through TODO states with no prompt. When
3763to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for 3731@var{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
3764more information. 3732selection interface.
3765 3733
3766@kindex S-@key{right} 3734@kindex S-@key{right}
3767@kindex S-@key{left} 3735@kindex S-@key{left}
@@ -4617,9 +4585,8 @@ changes in the line.}:
4617@noindent 4585@noindent
4618@vindex org-use-tag-inheritance 4586@vindex org-use-tag-inheritance
4619@vindex org-tags-exclude-from-inheritance 4587@vindex org-tags-exclude-from-inheritance
4620To limit tag inheritance to specific tags, or to turn it off entirely, use 4588To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4621the variables @code{org-use-tag-inheritance} and 4589To turn it off entirely, use @code{org-use-tag-inheritance}.
4622@code{org-tags-exclude-from-inheritance}.
4623 4590
4624@vindex org-tags-match-list-sublevels 4591@vindex org-tags-match-list-sublevels
4625When a headline matches during a tags search while tag inheritance is turned 4592When a headline matches during a tags search while tag inheritance is turned
@@ -4630,6 +4597,15 @@ of matches may then become very long. If you only want to see the first tags
4630match in a subtree, configure the variable 4597match in a subtree, configure the variable
4631@code{org-tags-match-list-sublevels} (not recommended). 4598@code{org-tags-match-list-sublevels} (not recommended).
4632 4599
4600@vindex org-agenda-use-tag-inheritance
4601Tag inheritance is relevant when the agenda search tries to match a tag,
4602either in the @code{tags} or @code{tags-todo} agenda types. In other agenda
4603types, @code{org-use-tag-inheritance} has no effect. Still, you may want to
4604have your tags correctly set in the agenda, so that tag filtering works fine,
4605with inherited tags. Set @code{org-agenda-use-tag-inheritance} to control
4606this: the default value includes all agenda types, but setting this to nil
4607can really speed up agenda generation.
4608
4633@node Setting tags, Tag searches, Tag inheritance, Tags 4609@node Setting tags, Tag searches, Tag inheritance, Tags
4634@section Setting tags 4610@section Setting tags
4635@cindex setting tags 4611@cindex setting tags
@@ -5050,7 +5026,7 @@ FILE @r{The filename the entry is located in.}
5050To create sparse trees and special lists with selection based on properties, 5026To create sparse trees and special lists with selection based on properties,
5051the same commands are used as for tag searches (@pxref{Tag searches}). 5027the same commands are used as for tag searches (@pxref{Tag searches}).
5052@table @kbd 5028@table @kbd
5053@orgcmdkkc{C-c / m,C-c @backslashchar{},org-match-sparse-tree} 5029@orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5054Create a sparse tree with all matching entries. With a 5030Create a sparse tree with all matching entries. With a
5055@kbd{C-u} prefix argument, ignore headlines that are not a TODO line. 5031@kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5056@orgcmd{C-c a m,org-tags-view} 5032@orgcmd{C-c a m,org-tags-view}
@@ -5512,7 +5488,7 @@ example with optional time
5512 5488
5513@example 5489@example
5514* 22:00-23:00 The nerd meeting on every 2nd Thursday of the month 5490* 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5515 <%%(org-float t 4 2)> 5491 <%%(diary-float t 4 2)>
5516@end example 5492@end example
5517 5493
5518@item Time/Date range 5494@item Time/Date range
@@ -5850,7 +5826,7 @@ entries. Org mode will issue early and late warnings based on the
5850assumption that the timestamp represents the @i{nearest instance} of 5826assumption that the timestamp represents the @i{nearest instance} of
5851the repeater. However, the use of diary sexp entries like 5827the repeater. However, the use of diary sexp entries like
5852@c 5828@c
5853@code{<%%(org-float t 42)>} 5829@code{<%%(diary-float t 42)>}
5854@c 5830@c
5855in scheduling and deadline timestamps is limited. Org mode does not 5831in scheduling and deadline timestamps is limited. Org mode does not
5856know enough about the internals of each sexp function to issue early and 5832know enough about the internals of each sexp function to issue early and
@@ -6539,7 +6515,7 @@ suggestion.} for capturing new material.
6539@table @kbd 6515@table @kbd
6540@orgcmd{C-c c,org-capture} 6516@orgcmd{C-c c,org-capture}
6541Call the command @code{org-capture}. Note that this keybinding is global and 6517Call the command @code{org-capture}. Note that this keybinding is global and
6542not active by default; you need to install it. If you have templates 6518not active by default: you need to install it. If you have templates
6543@cindex date tree 6519@cindex date tree
6544defined @pxref{Capture templates}, it will offer these templates for 6520defined @pxref{Capture templates}, it will offer these templates for
6545selection or use a new Org outline node as the default template. It will 6521selection or use a new Org outline node as the default template. It will
@@ -8621,6 +8597,13 @@ buffer, or a sparse tree (the latter covering of course only the current
8621buffer). 8597buffer).
8622@kindex C-c a C 8598@kindex C-c a C
8623@vindex org-agenda-custom-commands 8599@vindex org-agenda-custom-commands
8600@cindex agenda views, main example
8601@cindex tags, as an agenda view
8602@cindex todo, as an agenda view
8603@cindex tags-todo
8604@cindex todo-tree
8605@cindex occur-tree
8606@cindex tags-tree
8624 8607
8625Custom commands are configured in the variable 8608Custom commands are configured in the variable
8626@code{org-agenda-custom-commands}. You can customize this variable, for 8609@code{org-agenda-custom-commands}. You can customize this variable, for
@@ -8681,6 +8664,9 @@ additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8681Peter, or Kim) as additional tag to match. 8664Peter, or Kim) as additional tag to match.
8682@end table 8665@end table
8683 8666
8667Note that the @code{*-tree} agenda views need to be called from an
8668Org buffer as they operate on the current buffer only.
8669
8684@node Block agenda, Setting Options, Storing searches, Custom agenda views 8670@node Block agenda, Setting Options, Storing searches, Custom agenda views
8685@subsection Block agenda 8671@subsection Block agenda
8686@cindex block agenda 8672@cindex block agenda
@@ -16537,14 +16523,18 @@ to the directory @code{org-mobile-directory}. By default this list contains
16537all agenda files (as listed in @code{org-agenda-files}), but additional files 16523all agenda files (as listed in @code{org-agenda-files}), but additional files
16538can be included by customizing @code{org-mobile-files}. File names will be 16524can be included by customizing @code{org-mobile-files}. File names will be
16539staged with paths relative to @code{org-directory}, so all files should be 16525staged with paths relative to @code{org-directory}, so all files should be
16540inside this directory. The push operation also creates a special Org file 16526inside this directory@footnote{Symbolic links in @code{org-directory} need to
16541@file{agendas.org} with all custom agenda view defined by the 16527have the same name than their targets.}.
16542user@footnote{While creating the agendas, Org mode will force ID properties 16528
16543on all referenced entries, so that these entries can be uniquely identified 16529The push operation also creates a special Org file @file{agendas.org} with
16544if @i{MobileOrg} flags them for further action. If you do not want to get 16530all custom agenda view defined by the user@footnote{While creating the
16545these properties in so many entries, you can set the variable 16531agendas, Org mode will force ID properties on all referenced entries, so that
16546@code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then 16532these entries can be uniquely identified if @i{MobileOrg} flags them for
16547rely on outline paths, in the hope that these will be unique enough.}. 16533further action. If you do not want to get these properties in so many
16534entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
16535to @code{nil}. Org mode will then rely on outline paths, in the hope that
16536these will be unique enough.}.
16537
16548Finally, Org writes the file @file{index.org}, containing links to all other 16538Finally, Org writes the file @file{index.org}, containing links to all other
16549files. @i{MobileOrg} first reads this file from the server, and then 16539files. @i{MobileOrg} first reads this file from the server, and then
16550downloads all agendas and Org files listed in it. To speed up the download, 16540downloads all agendas and Org files listed in it. To speed up the download,
diff --git a/doc/misc/pgg.texi b/doc/misc/pgg.texi
index bb40a9f541d..a18a22e649f 100644
--- a/doc/misc/pgg.texi
+++ b/doc/misc/pgg.texi
@@ -2,9 +2,9 @@
2 2
3@include gnus-overrides.texi 3@include gnus-overrides.texi
4 4
5@set VERSION 0.1
6
7@setfilename ../../info/pgg 5@setfilename ../../info/pgg
6
7@set VERSION 0.1
8@settitle PGG @value{VERSION} 8@settitle PGG @value{VERSION}
9 9
10@copying 10@copying
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi
index a683425868a..3a859c62728 100644
--- a/doc/misc/tramp.texi
+++ b/doc/misc/tramp.texi
@@ -1279,8 +1279,8 @@ example, if you always have to use the user @samp{john} in the domain
1279@end lisp 1279@end lisp
1280 1280
1281@noindent 1281@noindent
1282See the documentation for the variable 1282See the documentation for the variable @code{tramp-default-user-alist}
1283@code{tramp-default-user-alist} for more details. 1283for more details.
1284 1284
1285One trap to fall in must be known. If @value{tramp} finds a default 1285One trap to fall in must be known. If @value{tramp} finds a default
1286user, this user will be passed always to the connection command as 1286user, this user will be passed always to the connection command as
@@ -1338,6 +1338,18 @@ Note, however, that the most simplification @samp{/::} won't work,
1338because @samp{/:} is the prefix for quoted file names. 1338because @samp{/:} is the prefix for quoted file names.
1339@end ifset 1339@end ifset
1340 1340
1341@vindex tramp-default-host-alist
1342Like with methods and users, you can also specify different default
1343hosts for certain method/user combinations via the variable
1344@code{tramp-default-host-alist}. Usually, this isn't necessary,
1345because @code{tramp-default-host} should be sufficient. For some
1346methods, like @code{adb}, that default value must be overwritten,
1347which is already the initial value of @code{tramp-default-host-alist}.
1348
1349@noindent
1350See the documentation for the variable @code{tramp-default-host-alist}
1351for more details.
1352
1341 1353
1342@node Multi-hops 1354@node Multi-hops
1343@section Connecting to a remote host using multiple hops 1355@section Connecting to a remote host using multiple hops