diff options
author | Glenn Morris <rgm@gnu.org> | 2018-03-28 09:38:22 -0700 |
---|---|---|
committer | Glenn Morris <rgm@gnu.org> | 2018-03-28 09:38:22 -0700 |
commit | 7d8234c0cb9daac31ae2f660f503a3ede7324549 (patch) | |
tree | 62529bfe7a2ba90f934f416031cbc62930f7124f /doc | |
parent | e6bb547353915b376b663fda32f88d1bf8f24d1f (diff) | |
parent | 9bff405d09f6eeeb577e6e0111e49f35d3b95b52 (diff) | |
download | emacs-7d8234c0cb9daac31ae2f660f503a3ede7324549.tar.gz |
Merge from origin/emacs-26
9bff405 (origin/emacs-26) * doc/misc/org.texi (Installation): Fix clo...
613c9a5 Update Org to v9.1.9
1b075a9 ; Fix some tiny doc typos
441fe20 De-obsolete `if-let' and `when-let'
8696038 * lisp/htmlfontify.el (hfy-begin-span-handler): Doc fix.
930f7b1 * doc/lispref/functions.texi (Defining Functions): Improve in...
95ccf50 Fix crash after frame is freed on macOS (bug#30800)
45d0475 More manual editing
2acb9f0 Minor manual changes changes
d481cba * lisp/calculator.el (calculator-paste-decimals): Add version.
7d6c7d0 ; Use GNU not Gnu in docs
1bc4def More proofreading of the Emacs manual
Conflicts:
doc/misc/org.texi
etc/NEWS
lisp/org/org-clock.el
Diffstat (limited to 'doc')
-rw-r--r-- | doc/emacs/basic.texi | 6 | ||||
-rw-r--r-- | doc/emacs/calendar.texi | 11 | ||||
-rw-r--r-- | doc/emacs/custom.texi | 7 | ||||
-rw-r--r-- | doc/emacs/display.texi | 12 | ||||
-rw-r--r-- | doc/emacs/emacs.texi | 2 | ||||
-rw-r--r-- | doc/emacs/mini.texi | 8 | ||||
-rw-r--r-- | doc/emacs/misc.texi | 226 | ||||
-rw-r--r-- | doc/emacs/picture-xtra.texi | 16 | ||||
-rw-r--r-- | doc/emacs/trouble.texi | 96 | ||||
-rw-r--r-- | doc/lispref/display.texi | 2 | ||||
-rw-r--r-- | doc/lispref/functions.texi | 2 | ||||
-rw-r--r-- | doc/misc/ada-mode.texi | 4 | ||||
-rw-r--r-- | doc/misc/dired-x.texi | 4 | ||||
-rw-r--r-- | doc/misc/info.texi | 10 | ||||
-rw-r--r-- | doc/misc/org.texi | 89 |
15 files changed, 282 insertions, 213 deletions
diff --git a/doc/emacs/basic.texi b/doc/emacs/basic.texi index 3fec5f44deb..f911c673bff 100644 --- a/doc/emacs/basic.texi +++ b/doc/emacs/basic.texi @@ -285,12 +285,18 @@ displays, @kbd{C-@key{END}} does the same. @item C-v @itemx @key{PageDown} @itemx @key{next} +@kindex C-v +@kindex PageDown +@kindex next Scroll the display one screen forward, and move point onscreen if necessary (@code{scroll-up-command}). @xref{Scrolling}. @item M-v @itemx @key{PageUp} @itemx @key{prior} +@kindex M-v +@kindex PageUp +@kindex prior Scroll one screen backward, and move point onscreen if necessary (@code{scroll-down-command}). @xref{Scrolling}. diff --git a/doc/emacs/calendar.texi b/doc/emacs/calendar.texi index c6a84b5ab12..7021146e698 100644 --- a/doc/emacs/calendar.texi +++ b/doc/emacs/calendar.texi @@ -246,9 +246,11 @@ Scroll calendar one month forward (@code{calendar-scroll-left}). @item < Scroll calendar one month backward (@code{calendar-scroll-right}). @item C-v +@itemx @key{PageDown} @itemx @key{next} Scroll forward by three months (@code{calendar-scroll-left-three-months}). @item M-v +@itemx @key{PageUp} @itemx @key{prior} Scroll backward by three months (@code{calendar-scroll-right-three-months}). @end table @@ -264,8 +266,12 @@ calendar contents one month forward in time. @kbd{<} scrolls the contents one month backwards in time. @kindex C-v @r{(Calendar mode)} +@kindex PageDown @r{(Calendar mode)} +@kindex next @r{(Calendar mode)} @findex calendar-scroll-left-three-months @kindex M-v @r{(Calendar mode)} +@kindex PageUp @r{(Calendar mode)} +@kindex prior @r{(Calendar mode)} @findex calendar-scroll-right-three-months The commands @kbd{C-v} and @kbd{M-v} scroll the calendar by an entire screenful---three months---in analogy with the usual meaning of @@ -275,8 +281,9 @@ repeat count; in particular, since @kbd{C-u} multiplies the next command by four, typing @kbd{C-u C-v} scrolls the calendar forward by a year and typing @kbd{C-u M-v} scrolls the calendar backward by a year. - The function keys @key{next} and @key{prior} are equivalent to -@kbd{C-v} and @kbd{M-v}, just as they are in other modes. + The function keys @key{PageDown} (or @key{next}) and @key{PageUp} +(or @key{prior}) are equivalent to @kbd{C-v} and @kbd{M-v}, just as +they are in other modes. @node Counting Days @section Counting Days diff --git a/doc/emacs/custom.texi b/doc/emacs/custom.texi index c3cfaabb8d3..d9844554e0c 100644 --- a/doc/emacs/custom.texi +++ b/doc/emacs/custom.texi @@ -1852,10 +1852,10 @@ the corresponding Lisp symbol. Here are the conventional Lisp names for common function keys: @table @asis -@item @code{LEFT}, @code{UP}, @code{RIGHT}, @code{DOWN} +@item @code{left}, @code{up}, @code{right}, @code{down} Cursor arrow keys. -@item @code{Begin}, @code{End}, @code{Home}, @code{next}, @code{prior} +@item @code{begin}, @code{end}, @code{home}, @code{next}, @code{prior} Other cursor repositioning keys. @item @code{select}, @code{print}, @code{execute}, @code{backtab} @@ -1869,6 +1869,9 @@ Numbered function keys (across the top of the keyboard). @item @code{kp-add}, @code{kp-subtract}, @code{kp-multiply}, @code{kp-divide} @itemx @code{kp-backtab}, @code{kp-space}, @code{kp-tab}, @code{kp-enter} @itemx @code{kp-separator}, @code{kp-decimal}, @code{kp-equal} +@itemx @code{kp-prior}, @code{kp-next}, @code{kp-end}, @code{kp-home} +@itemx @code{kp-left}, @code{kp-up}, @code{kp-right}, @code{kp-down} +@itemx @code{kp-insert }, @code{kp-delete} Keypad keys (to the right of the regular keyboard), with names or punctuation. @item @code{kp-0}, @code{kp-1}, @dots{} @code{kp-9} diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi index 42a52279832..c60cf649146 100644 --- a/doc/emacs/display.texi +++ b/doc/emacs/display.texi @@ -68,21 +68,21 @@ Scrolling}). You can also scroll explicitly with these commands: @table @kbd @item C-v -@itemx @key{next} @itemx @key{PageDown} +@itemx @key{next} Scroll forward by nearly a full window (@code{scroll-up-command}). @item M-v -@itemx @key{prior} @itemx @key{PageUp} +@itemx @key{prior} Scroll backward (@code{scroll-down-command}). @end table @kindex C-v @kindex M-v -@kindex next -@kindex prior @kindex PageDown @kindex PageUp +@kindex next +@kindex prior @findex scroll-up-command @findex scroll-down-command @kbd{C-v} (@code{scroll-up-command}) scrolls forward by nearly the @@ -90,10 +90,10 @@ whole window height. The effect is to take the two lines at the bottom of the window and put them at the top, followed by lines that were not previously visible. If point was in the text that scrolled off the top, it ends up on the window's new topmost line. The -@key{next} (or @key{PageDown}) key is equivalent to @kbd{C-v}. +@key{PageDown} (or @key{next}) key is equivalent to @kbd{C-v}. @kbd{M-v} (@code{scroll-down-command}) scrolls backward in a similar -way. The @key{prior} (or @key{PageUp}) key is equivalent to +way. The @key{PageUp} (or @key{prior}) key is equivalent to @kbd{M-v}. @vindex next-screen-context-lines diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi index f917fa8e1e9..b64a59df707 100644 --- a/doc/emacs/emacs.texi +++ b/doc/emacs/emacs.texi @@ -1186,7 +1186,7 @@ Reporting Bugs Contributing to Emacs Development -* Coding Standards:: Gnu Emacs coding standards. +* Coding Standards:: GNU Emacs coding standards. * Copyright Assignment:: Assigning copyright to the FSF. Command Line Arguments for Emacs Invocation diff --git a/doc/emacs/mini.texi b/doc/emacs/mini.texi index eb2eed0ffb9..6fc28903fc7 100644 --- a/doc/emacs/mini.texi +++ b/doc/emacs/mini.texi @@ -216,9 +216,9 @@ window automatically. The default value is 0.25. The @kbd{C-M-v} command in the minibuffer scrolls the help text from commands that display help text of any sort in another window. You -can also scroll the help text with @kbd{M-@key{prior}} and -@kbd{M-@key{next}} (or, equivalently, @kbd{M-@key{PageUp}} and -@kbd{M-@key{PageDown}}). This is especially useful with long lists of +can also scroll the help text with @kbd{M-@key{PageUp}} and +@kbd{M-@key{PageDown}} (or, equivalently, @kbd{M-@key{prior}} and +@kbd{M-@key{next}}). This is especially useful with long lists of possible completions. @xref{Other Window}. @vindex enable-recursive-minibuffers @@ -824,7 +824,7 @@ File ‘foo.el’ exists; overwrite? (y or n) Because this query does not actually use the minibuffer, the usual minibuffer editing commands cannot be used. However, you can perform some window scrolling operations while the query is active: @kbd{C-l} -recenters the selected window; @kbd{C-v} (or @key{PageDown} or +recenters the selected window; @kbd{C-v} (or @key{PageDown}, or @key{next}) scrolls forward; @kbd{M-v} (or @key{PageUp}, or @key{prior}) scrolls backward; @kbd{C-M-v} scrolls forward in the next window; and @kbd{C-M-S-v} scrolls backward in the next window. Typing diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi index 68bd308983f..23495992fcc 100644 --- a/doc/emacs/misc.texi +++ b/doc/emacs/misc.texi @@ -132,7 +132,8 @@ sessions. @kindex SPC @r{(Gnus Group mode)} @findex gnus-group-read-group @item @key{SPC} -Switch to the summary buffer for the group on the current line. +Switch to the summary buffer for the group on the current line +(@code{gnus-group-read-group}). @kindex l @r{(Gnus Group mode)} @kindex A s @r{(Gnus Group mode)} @@ -140,7 +141,8 @@ Switch to the summary buffer for the group on the current line. @item l @itemx A s In the group buffer, list only the groups to which you subscribe and -which contain unread articles (this is the default listing). +which contain unread articles (@code{gnus-group-list-groups}; this is +the default listing). @kindex L @r{(Gnus Group mode)} @kindex A u @r{(Gnus Group mode)} @@ -148,24 +150,25 @@ which contain unread articles (this is the default listing). @item L @itemx A u List all subscribed and unsubscribed groups, but not killed or zombie -groups. +groups (@code{gnus-group-list-all-groups}). @kindex A k @r{(Gnus Group mode)} @findex gnus-group-list-killed @item A k -List killed groups. +List killed groups (@code{gnus-group-list-killed}). @kindex A z @r{(Gnus Group mode)} @findex gnus-group-list-zombies @item A z -List zombie groups. +List zombie groups (@code{gnus-group-list-zombies}). @kindex u @r{(Gnus Group mode)} @findex gnus-group-unsubscribe-current-group @cindex subscribe groups @cindex unsubscribe groups @item u -Toggle the subscription status of the group on the current line +Toggle the subscription status of the group +(@code{gnus-group-unsubscribe-current-group}) on the current line (i.e., turn a subscribed group into an unsubscribed group, or vice versa). Invoking this on a killed or zombie group turns it into an unsubscribed group. @@ -173,28 +176,31 @@ unsubscribed group. @kindex C-k @r{(Gnus Group mode)} @findex gnus-group-kill-group @item C-k -Kill the group on the current line. Killed groups are not recorded in -the @file{.newsrc} file, and they are not shown in the @kbd{l} or -@kbd{L} listings. +Kill the group on the current line (@code{gnus-group-kill-group}). +Killed groups are not recorded in the @file{.newsrc} file, and they +are not shown in the @kbd{l} or @kbd{L} listings. @kindex DEL @r{(Gnus Group mode)} @item @key{DEL} -Move point to the previous group containing unread articles. +Move point to the previous group containing unread articles +(@code{gnus-group-prev-unread-group}.) @kindex n @r{(Gnus Group mode)} @findex gnus-group-next-unread-group @item n -Move point to the next unread group. +Move point to the next unread group +(@code{gnus-group-next-unread-group}). @kindex p @r{(Gnus Group mode)} @findex gnus-group-prev-unread-group @item p -Move point to the previous unread group. +Move point to the previous unread group +(@code{gnus-group-prev-unread-group}). @kindex q @r{(Gnus Group mode)} @findex gnus-group-exit @item q -Update your Gnus settings, and quit Gnus. +Update your Gnus settings, and quit Gnus (@code{gnus-group-exit}). @end table @node Gnus Summary Buffer @@ -209,7 +215,7 @@ Update your Gnus settings, and quit Gnus. If there is no article selected, select the article on the current line and display its article buffer. Otherwise, try scrolling the selected article buffer in its window; on reaching the end of the -buffer, select the next unread article. +buffer, select the next unread article (@code{gnus-summary-next-page}). Thus, you can read through all articles by repeatedly typing @key{SPC}. @@ -217,33 +223,44 @@ Thus, you can read through all articles by repeatedly typing @kindex DEL @r{(Gnus Summary mode)} @findex gnus-summary-prev-page @item @key{DEL} -Scroll the text of the article backwards. +Scroll the text of the article backwards +(@code{gnus-summary-prev-page}). @kindex n @r{(Gnus Summary mode)} @findex gnus-summary-next-unread-article @item n -Select the next unread article. +Select the next unread article +(@code{gnus-summary-next-unread-article}). @kindex p @r{(Gnus Summary mode)} @findex gnus-summary-prev-unread-article @item p -Select the previous unread article. +Select the previous unread article +(@code{gnus-summary-prev-unread-article}). @kindex s @r{(Gnus Summary mode)} @findex gnus-summary-isearch-article @item s -Do an incremental search on the selected article buffer, as if you -switched to the buffer and typed @kbd{C-s} (@pxref{Incremental -Search}). +Do an incremental search on the selected article buffer +(@code{gnus-summary-isearch-article}), as if you switched to the +buffer and typed @kbd{C-s} (@pxref{Incremental Search}). @kindex M-s @r{(Gnus Summary mode)} @findex gnus-summary-search-article-forward @item M-s @var{regexp} @key{RET} -Search forward for articles containing a match for @var{regexp}. +Search forward for articles containing a match for @var{regexp} +(@code{gnus-summary-search-article-forward}). + +@kindex M-r @r{(Gnus Summary mode)} +@findex gnus-summary-search-article-backward +@item M-r @var{regexp} @key{RET} +Search back for articles containing a match for @var{regexp} +(@code{gnus-summary-search-article-backward}). @kindex q @r{(Gnus Summary mode)} @item q -Exit the summary buffer and return to the group buffer. +Exit the summary buffer and return to the group buffer +(@code{gnus-summary-exit}). @end table @node Host Security @@ -273,12 +290,14 @@ Emacs as part of a larger application. @cindex encryption @cindex SSL @cindex TLS +@cindex Transport Layer Security @cindex STARTTLS Whenever Emacs establishes any network connection, it passes the established connection to the @dfn{Network Security Manager} (@acronym{NSM}). @acronym{NSM} is responsible for enforcing the -network security under your control. +network security under your control. Currently, this works by using +the Transport Layer Security (@acronym{TLS}) features. @vindex network-security-level The @code{network-security-level} variable determines the security @@ -381,7 +400,8 @@ By default, host names will not be saved for non-@code{STARTTLS} connections. Instead a host/port hash is used to identify connections. This means that one can't casually read the settings file to see what servers the user has connected to. If this variable is @code{t}, -@acronym{NSM} will also save host names in the nsm-settings-file. +@acronym{NSM} will also save host names in the +@code{nsm-settings-file}. @end table @@ -411,7 +431,7 @@ is needed. For OpenDocument and Microsoft Office documents, the @findex doc-view-toggle-display @findex doc-view-minor-mode When you visit a document file that can be displayed with DocView -mode, Emacs automatically uses DocView mode @footnote{The needed +mode, Emacs automatically uses that mode @footnote{The needed external tools for the document type must be available, and Emacs must be running in a graphical frame and have PNG image support. If these requirements is not fulfilled, Emacs falls back to another major @@ -426,7 +446,7 @@ underlying file contents. @findex doc-view-open-text When you visit a file which would normally be handled by DocView mode but some requirement is not met (e.g., you operate in a terminal -frame or emacs has no PNG support), you are queried if you want to +frame or Emacs has no PNG support), you are queried if you want to view the document's contents as plain text. If you confirm, the buffer is put in text mode and DocView minor mode is activated. Thus, by typing @kbd{C-c C-c} you switch to the fallback mode. With another @@ -472,12 +492,16 @@ displays the next page if you are at the end of the current page. @findex doc-view-previous-page @kindex n @r{(DocView mode)} @kindex p @r{(DocView mode)} +@kindex PageDown @r{(DocView mode)} +@kindex PageUp @r{(DocView mode)} +@kindex next @r{(DocView mode)} +@kindex prior @r{(DocView mode)} @kindex C-x ] @r{(DocView mode)} @kindex C-x [ @r{(DocView mode)} - You can also display the next page by typing @kbd{n}, @key{next} or -@kbd{C-x ]} (@code{doc-view-next-page}). To display the previous -page, type @kbd{p}, @key{prior} or @kbd{C-x [} -(@code{doc-view-previous-page}). + You can also display the next page by typing @kbd{n}, +@key{PageDown}, @key{next} or @kbd{C-x ]} (@code{doc-view-next-page}). +To display the previous page, type @kbd{p}, @key{PageUp}, @key{prior} +or @kbd{C-x [} (@code{doc-view-previous-page}). @findex doc-view-scroll-up-or-next-page @findex doc-view-scroll-down-or-previous-page @@ -574,7 +598,7 @@ including its entire margins. @vindex doc-view-cache-directory @findex doc-view-clear-cache For efficiency, DocView caches the images produced by @command{gs}. -The name of this directory is given by the variable +The name of the directory where it caches images is given by the variable @code{doc-view-cache-directory}. You can clear the cache directory by typing @kbd{M-x doc-view-clear-cache}. @@ -660,7 +684,9 @@ for that command. Standard input for the command comes from the null device. If the shell command produces any output, the output appears either in the echo area (if it is short), or in an Emacs buffer named @file{*Shell Command Output*}, displayed in another window (if the -output is long). +output is long). The variables @code{resize-mini-windows} and +@code{max-mini-window-height} (@pxref{Minibuffer Edit}) control when +the output is considered too long for the echo area. For instance, one way to decompress a file named @file{foo.gz} is to type @kbd{M-! gunzip foo.gz @key{RET}}. That shell command normally @@ -872,11 +898,12 @@ line---but after @kbd{C-c @key{SPC}} the process mark may be in a previous line.) @item C-c @key{SPC} -Accumulate multiple lines of input, then send them together. This -command inserts a newline before point, but does not send the preceding -text as input to the subshell---at least, not yet. Both lines, the one -before this newline and the one after, will be sent together (along with -the newline that separates them), when you type @key{RET}. +Accumulate multiple lines of input, then send them together +(@code{comint-accumulate}). This command inserts a newline before +point, but does not send the preceding text as input to the +subshell---at least, not yet. Both lines, the one before this newline +and the one after, will be sent together (along with the newline that +separates them), when you type @key{RET}. @item C-c C-u @kindex C-c C-u @r{(Shell mode)} @@ -936,7 +963,7 @@ of the window; also move the cursor there (@code{comint-show-output}). @item C-c C-e @kindex C-c C-e @r{(Shell mode)} @findex comint-show-maximum-output -Scroll to put the end of the buffer at the bottom of the window +Scroll to put the last line of the buffer at the bottom of the window (@code{comint-show-maximum-output}). @item C-c C-f @@ -1027,9 +1054,9 @@ specializations of Shell mode. @cindex prompt, shell A prompt is text output by a program to show that it is ready to accept new user input. Normally, Comint mode (and thus Shell mode) -automatically figures out part of the buffer is a prompt, based on the -output of the subprocess. (Specifically, it assumes that any received -output line which doesn't end with a newline is a prompt.) +automatically figures out which part of the buffer is a prompt, based +on the output of the subprocess. (Specifically, it assumes that any +received output line which doesn't end with a newline is a prompt.) Comint mode divides the buffer into two types of @dfn{fields}: input fields (where user input is typed) and output fields (everywhere @@ -1082,28 +1109,32 @@ resubmit them or copy them to the end. Or you can use a @kindex M-p @r{(Shell mode)} @item M-p @itemx C-@key{UP} -Fetch the next earlier old shell command. +Fetch the next earlier old shell command +(@code{comint-previous-input}). @kindex M-n @r{(Shell mode)} @findex comint-next-input @item M-n @itemx C-@key{DOWN} -Fetch the next later old shell command. +Fetch the next later old shell command (@code{comint-next-input}). @kindex M-r @r{(Shell mode)} @findex comint-history-isearch-backward-regexp @item M-r -Begin an incremental regexp search of old shell commands. +Begin an incremental regexp search of old shell commands +(@code{comint-history-isearch-backward-regexp}). @item C-c C-x @kindex C-c C-x @r{(Shell mode)} @findex comint-get-next-from-history -Fetch the next subsequent command from the history. +Fetch the next subsequent command from the history +(@code{comint-get-next-from-history}). @item C-c . @kindex C-c . @r{(Shell mode)} @findex comint-input-previous-argument -Fetch one argument from an old shell command. +Fetch one argument from an old shell command +(@code{comint-input-previous-argument}). @item C-c C-l @kindex C-c C-l @r{(Shell mode)} @@ -1231,7 +1262,7 @@ typing @key{RET}. when you send them to the shell. To request this, set the variable @code{comint-input-autoexpand} to @code{input}. You can make @key{SPC} perform history expansion by binding @key{SPC} to the -command @code{comint-magic-space}. +command @code{comint-magic-space}. @xref{Rebinding}. Shell mode recognizes history references when they follow a prompt. @xref{Shell Prompts}, for how Shell mode recognizes prompts. @@ -1419,9 +1450,6 @@ examining your input. But some shells can tell Term what the current directory is. This is done automatically by @code{bash} version 1.15 and later. - - - @node Term Mode @subsection Term Mode @cindex Term mode @@ -1448,7 +1476,8 @@ char mode. @table @kbd @item C-c C-c -Send a literal @kbd{C-c} to the sub-shell. +Send a literal @kbd{C-c} to the sub-shell +(@code{term-interrupt-subjob}). @item C-c @var{char} This is equivalent to @kbd{C-x @var{char}} in normal Emacs. For @@ -1464,13 +1493,13 @@ output pause at the end of each screenful: @kindex C-c C-q @r{(Term mode)} @findex term-pager-toggle @item C-c C-q -Toggle the page-at-a-time feature. This command works in both line -and char modes. When the feature is enabled, the mode-line displays -the word @samp{page}, and each time Term receives more than a -screenful of output, it pauses and displays @samp{**MORE**} in the -mode-line. Type @key{SPC} to display the next screenful of output, or -@kbd{?} to see your other options. The interface is similar to the -@code{more} program. +Toggle the page-at-a-time feature (@code{term-pager-toggle}). This +command works in both line and char modes. When the feature is +enabled, the mode-line displays the word @samp{page}, and each time +Term receives more than a screenful of output, it pauses and displays +@samp{**MORE**} in the mode-line. Type @key{SPC} to display the next +screenful of output, or @kbd{?} to see your other options. The +interface is similar to the @code{more} program. @end table @node Remote Host @@ -1481,8 +1510,8 @@ mode-line. Type @key{SPC} to display the next screenful of output, or @cindex Rlogin You can login to a remote computer, using whatever commands you -would from a regular terminal (e.g., using the @code{telnet} or -@code{rlogin} commands), from a Term window. +would from a regular terminal (e.g., using the @code{ssh} or +@code{telnet} or @code{rlogin} commands), from a Term window. A program that asks you for a password will normally suppress echoing of the password, so the password will not show up in the @@ -1621,7 +1650,7 @@ name, using the @samp{-s} option (@pxref{emacsclient Options}). you can give each daemon its own server name like this: @example - emacs --eval "(setq server-name \"foo\")" --daemon + emacs --daemon=foo @end example @findex server-eval-at @@ -1656,7 +1685,7 @@ not support local sockets. @vindex server-host @vindex server-port - If the Emacs server is set to use TCP, it will by default listen to + If the Emacs server is set to use TCP, it will by default listen on a random port on the localhost interface. This can be changed to another interface and/or a fixed port using the variables @code{server-host} and @code{server-port}. @@ -1848,7 +1877,7 @@ evaluate, @emph{not} as a list of files to visit. Specify a server file (@pxref{TCP Emacs server}) for connecting to an Emacs server via TCP. Alternatively, you can set the @env{EMACS_SERVER_FILE} environment variable to point to the server -file. +file. (The command-line option overrides the environment variable.) An Emacs server usually uses a local socket to listen for connections, but also supports connections over TCP. To connect to a TCP Emacs @@ -1904,14 +1933,15 @@ terminal. @item -T @var{tramp-prefix} @itemx --tramp-prefix=@var{tramp-prefix} Set the prefix to add to filenames for Emacs to locate files on remote -machines using TRAMP (@pxref{Top, The Tramp Manual,, tramp, The Tramp -Manual}). This is mostly useful in combination with using the Emacs -server over TCP (@pxref{TCP Emacs server}). By ssh-forwarding the -listening port and making the @var{server-file} available on a remote -machine, programs on the remote machine can use @command{emacsclient} -as the value for the @env{EDITOR} and similar environment variables, -but instead of talking to an Emacs server on the remote machine, the -files will be visited in the local Emacs session using TRAMP. +machines (@pxref{Remote Files}) using TRAMP (@pxref{Top, The Tramp +Manual,, tramp, The Tramp Manual}). This is mostly useful in +combination with using the Emacs server over TCP (@pxref{TCP Emacs +server}). By ssh-forwarding the listening port and making the +@var{server-file} available on a remote machine, programs on the +remote machine can use @command{emacsclient} as the value for the +@env{EDITOR} and similar environment variables, but instead of talking +to an Emacs server on the remote machine, the files will be visited in +the local Emacs session using TRAMP. @vindex EMACSCLIENT_TRAMP@r{, environment variable} Setting the environment variable @env{EMACSCLIENT_TRAMP} has the same @@ -2068,8 +2098,8 @@ buffer; the other, just the region. The commands @code{ps-print-region-with-faces} behave similarly, but use PostScript features to show the faces (fonts and colors) of the buffer text. - Interactively, when you use a prefix argument (@kbd{C-u}), the command -prompts the user for a file name, and saves the PostScript image in that file + Interactively, when you use a prefix argument (@kbd{C-u}), these commands +prompt the user for a file name, and save the PostScript image in that file instead of sending it to the printer. @findex ps-spool-region @@ -2161,7 +2191,9 @@ default is 1. for printing ordinary text. Legitimate values include @code{Courier}, @code{Helvetica}, @code{NewCenturySchlbk}, @code{Palatino} and @code{Times}. The variable @code{ps-font-size} specifies the size of -the font for ordinary text. It defaults to 8.5 points. +the font for ordinary text and defaults to 8.5 points. The value of +@code{ps-font-size} can also be a cons of 2 floats: one for landscape +mode, the other for portrait mode. @vindex ps-multibyte-buffer @cindex Intlfonts for PostScript printing @@ -2229,7 +2261,8 @@ into the order determined by the sort keys. The records are ordered so that their keys are in alphabetical order, or, for numeric sorting, in numeric order. In alphabetic sorting, all upper-case letters @samp{A} through @samp{Z} come before lower-case @samp{a}, in accordance with the -@acronym{ASCII} character sequence. +@acronym{ASCII} character sequence (but @code{sort-fold-case}, +described below, can change that). The various sort commands differ in how they divide the text into sort records and in which part of each record is used as the sort key. Most of @@ -2267,10 +2300,11 @@ in a line constitutes field 1, the second such run constitutes field 2, etc. Specify which field to sort by with a numeric argument: 1 to sort by -field 1, etc. A negative argument means count fields from the right -instead of from the left; thus, minus 1 means sort by the last field. -If several lines have identical contents in the field being sorted, they -keep the same relative order that they had in the original buffer. +field 1, etc.; the default is 1. A negative argument means count +fields from the right instead of from the left; thus, minus 1 means +sort by the last field. If several lines have identical contents in +the field being sorted, they keep the same relative order that they +had in the original buffer. @item M-x sort-numeric-fields Like @kbd{M-x sort-fields} except the specified field is converted @@ -2841,33 +2875,33 @@ functionality in Rmail, Gnus and VM article buffers. @kindex C-x C-f @r{(FFAP)} Find @var{filename}, guessing a default from text around point (@code{find-file-at-point}). -@item C-x C-r +@item C-x C-r @var{filename} @key{RET} @kindex C-x C-r @r{(FFAP)} @code{ffap-read-only}, analogous to @code{find-file-read-only}. -@item C-x C-v +@item C-x C-v @var{filename} @key{RET} @kindex C-x C-v @r{(FFAP)} @code{ffap-alternate-file}, analogous to @code{find-alternate-file}. @item C-x d @var{directory} @key{RET} @kindex C-x d @r{(FFAP)} Start Dired on @var{directory}, defaulting to the directory at point (@code{dired-at-point}). -@item C-x C-d +@item C-x C-d @var{directory} @key{RET} @code{ffap-list-directory}, analogous to @code{list-directory}. -@item C-x 4 f +@item C-x 4 f @var{filename} @key{RET} @kindex C-x 4 f @r{(FFAP)} @code{ffap-other-window}, analogous to @code{find-file-other-window}. -@item C-x 4 r +@item C-x 4 r @var{filename} @key{RET} @code{ffap-read-only-other-window}, analogous to @code{find-file-read-only-other-window}. -@item C-x 4 d +@item C-x 4 d @var{directory} @key{RET} @code{ffap-dired-other-window}, like @code{dired-other-window}. -@item C-x 5 f +@item C-x 5 f @var{filename} @key{RET} @kindex C-x 5 f @r{(FFAP)} @code{ffap-other-frame}, analogous to @code{find-file-other-frame}. -@item C-x 5 r +@item C-x 5 r @var{filename} @key{RET} @code{ffap-read-only-other-frame}, analogous to @code{find-file-read-only-other-frame}. -@item C-x 5 d +@item C-x 5 d @var{directory} @key{RET} @code{ffap-dired-other-frame}, analogous to @code{dired-other-frame}. @item M-x ffap-next Search buffer for next file name or URL, then find that file or URL. @@ -2884,6 +2918,7 @@ find the one you select (@code{ffap-menu}). @node Amusements @section Games and Other Amusements @cindex boredom +@cindex games @findex animate-birthday-present @cindex animate @@ -2902,6 +2937,7 @@ guess---to guess a value, type a letter and then the digit you think it stands for. The aim of @code{5x5} is to fill in all the squares. @findex bubbles +@cindex bubbles @kbd{M-x bubbles} is a game in which the object is to remove as many bubbles as you can in the smallest number of moves. @@ -2926,6 +2962,7 @@ character. Keep dissociwords out of your documentation, if you want it to be well userenced and properbose. @findex dunnet +@cindex dunnet @kbd{M-x dunnet} runs a text-based adventure game. @findex gomoku @@ -2943,13 +2980,6 @@ bored, try an argument of 9. Sit back and watch. @cindex Life @kbd{M-x life} runs Conway's Game of Life cellular automaton. -@findex landmark -@cindex landmark game - @kbd{M-x landmark} runs a relatively non-participatory game in which -a robot attempts to maneuver towards a tree at the center of the -window based on unique olfactory cues from each of the four -directions. - @findex morse-region @findex unmorse-region @findex nato-region @@ -2975,9 +3005,15 @@ implementations of the well-known Pong, Snake and Tetris games. across other pegs. @findex zone +@cindex zone The command @kbd{M-x zone} plays games with the display when Emacs is idle. +@findex butterfly +@cindex butterfly + Real Programmers™ deploy @kbd{M-x butterfly}, which uses butterflies +to flip a bit on the drive platter, see @uref{https://xkcd.com/378}. + @findex doctor @cindex Eliza Finally, if you find yourself frustrated, try describing your diff --git a/doc/emacs/picture-xtra.texi b/doc/emacs/picture-xtra.texi index 39c353b0ff1..288a6e89aa9 100644 --- a/doc/emacs/picture-xtra.texi +++ b/doc/emacs/picture-xtra.texi @@ -136,13 +136,23 @@ Picture}). @findex picture-movement-sw @findex picture-movement-se @kindex C-c < @r{(Picture mode)} +@kindex C-c LEFT @r{(Picture mode)} @kindex C-c > @r{(Picture mode)} +@kindex C-c RIGHT @r{(Picture mode)} @kindex C-c ^ @r{(Picture mode)} +@kindex C-c UP @r{(Picture mode)} @kindex C-c . @r{(Picture mode)} +@kindex C-c DOWN @r{(Picture mode)} @kindex C-c ` @r{(Picture mode)} +@kindex C-c Home @r{(Picture mode)} @kindex C-c ' @r{(Picture mode)} +@kindex C-c PageUp @r{(Picture mode)} +@kindex C-c prior @r{(Picture mode)} @kindex C-c / @r{(Picture mode)} +@kindex C-c End @r{(Picture mode)} @kindex C-c \ @r{(Picture mode)} +@kindex C-c PageDown @r{(Picture mode)} +@kindex C-c next @r{(Picture mode)} Since self-inserting characters in Picture mode overwrite and move point, there is no essential restriction on how point should be moved. Normally point moves right, but you can specify any of the eight @@ -166,6 +176,7 @@ Move down after insertion (@code{picture-movement-down}). @itemx C-c @key{Home} Move up and left (``northwest'') after insertion (@code{picture-movement-nw}). @item C-c ' +@itemx C-c @key{PageUp} @itemx C-c @key{prior} Move up and right (``northeast'') after insertion (@code{picture-movement-ne}). @@ -174,6 +185,7 @@ Move up and right (``northeast'') after insertion Move down and left (``southwest'') after insertion @*(@code{picture-movement-sw}). @item C-c \ +@itemx C-c @key{PageDown} @itemx C-c @key{next} Move down and right (``southeast'') after insertion @*(@code{picture-movement-se}). @@ -199,7 +211,7 @@ C-b} (@code{picture-motion-reverse}) moves in the opposite direction. With no argument, it moves to a point underneath the next ``interesting'' character that follows whitespace in the previous nonblank line. ``Next'' here means ``appearing at a horizontal position -greater than the one point starts out at''. With an argument, as in +greater than the one point starts out at''. With prefix argument, as in @kbd{C-u M-@key{TAB}}, this command moves to the next such interesting character in the current line. @kbd{M-@key{TAB}} does not change the text; it only moves point. ``Interesting'' characters are defined by @@ -250,7 +262,7 @@ Clear out the region-rectangle with spaces text. @item C-c C-w @var{r} Similar, but save rectangle contents in register @var{r} first -(@code{picture-clear-rectangle-to-register}). +(@code{picture-clear-rectangle-to-register}). @xref{Registers}. @item C-c C-y Copy last killed rectangle into the buffer by overwriting, with upper left corner at point (@code{picture-yank-rectangle}). With argument, diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi index fc9a64d375e..37a73041676 100644 --- a/doc/emacs/trouble.texi +++ b/doc/emacs/trouble.texi @@ -185,8 +185,8 @@ command @kbd{M-x normal-erase-is-backspace-mode}. This toggles between the two modes that Emacs supports for handling @key{DEL}, so if Emacs starts in the wrong mode, this should switch to the right mode. On a text terminal, if you want to ask for help when @key{BS} -is treated as @key{DEL}, use @key{F1}; @kbd{C-?} may also work, if it -sends character code 127. +is treated as @key{DEL}, use @key{F1} instead of @kbd{C-h}; @kbd{C-?} +may also work, if it sends character code 127. To fix the problem in every Emacs session, put one of the following lines into your initialization file (@pxref{Init File}). For the @@ -233,10 +233,10 @@ top-level}. @xref{Recursive Edit}. @cindex screen display, wrong If the text on a text terminal looks wrong, the first thing to do is -see whether it is wrong in the buffer. Type @kbd{C-l} to redisplay -the entire screen. If the screen appears correct after this, the -problem was entirely in the previous screen update. (Otherwise, see -the following section.) +see whether it is wrong in the buffer. Type @kbd{C-l} +(@code{recenter-top-bottom}) to redisplay the entire screen. If the +screen appears correct after this, the problem was entirely in the +previous screen update. (Otherwise, see the following section.) Display updating problems often result from an incorrect terminfo entry for the terminal you are using. The file @file{etc/TERMS} in @@ -251,16 +251,17 @@ bug in Emacs that appears for certain terminal types. @cindex garbled text @cindex buffer text garbled - If @kbd{C-l} shows that the text is wrong, first type @kbd{C-h l} to -see what commands you typed to produce the observed results. Then try -undoing the changes step by step using @kbd{C-x u}, until it gets back -to a state you consider correct. + If @kbd{C-l} shows that the text is wrong, first type @kbd{C-h l} +(@code{view-lossage}) to see what commands you typed to produce the +observed results. Then try undoing the changes step by step using +@kbd{C-x u} (@code{undo}), until it gets back to a state you consider +correct. If a large portion of text appears to be missing at the beginning or end of the buffer, check for the word @samp{Narrow} in the mode line. If it appears, the text you don't see is probably still present, but temporarily off-limits. To make it accessible again, type @kbd{C-x n -w}. @xref{Narrowing}. +w} (@code{widen}). @xref{Narrowing}. @node Memory Full @subsection Running out of Memory @@ -268,12 +269,13 @@ w}. @xref{Narrowing}. @cindex out of memory If you get the error message @samp{Virtual memory exceeded}, save -your modified buffers with @kbd{C-x s}. This method of saving them -has the smallest need for additional memory. Emacs keeps a reserve of -memory which it makes available when this error happens; that should -be enough to enable @kbd{C-x s} to complete its work. When the -reserve has been used, @samp{!MEM FULL!} appears at the beginning of -the mode line, indicating there is no more reserve. +your modified buffers with @kbd{C-x s} (@code{save-some-buffers}). +This method of saving them has the smallest need for additional +memory. Emacs keeps a reserve of memory which it makes available when +this error happens; that should be enough to enable @kbd{C-x s} to +complete its work. When the reserve has been used, @samp{!MEM FULL!} +appears at the beginning of the mode line, indicating there is no more +reserve. Once you have saved your modified buffers, you can exit this Emacs session and start another, or you can use @kbd{M-x kill-some-buffers} @@ -589,6 +591,9 @@ important to report documentation bugs as program bugs. If the built-in documentation for a function or variable disagrees with the manual, one of them must be wrong; that is a bug. + For problems with packages that are not part of Emacs, it is better +to begin by reporting them to the package developers. + @node Understanding Bug Reporting @subsection Understanding Bug Reporting @cindex bug reporting @@ -693,7 +698,7 @@ include a valid reply email address, in case we need to ask you for more information about your report. Submissions are moderated, so there may be a delay before your report appears. -You do not need to know how the Gnu Bug Tracker works in order to +You do not need to know how the GNU Bug Tracker works in order to report a bug, but if you want to, you can read the tracker's online documentation to see the various features you can use. @@ -706,7 +711,10 @@ tracker. If your data is more than 500,000 bytes, please don't include it directly in the bug report; instead, offer to send it on request, or -make it available by ftp and say where. +make it available online and say where. + +The GNU Bug Tracker will assign a bug number to your report; please +use it in the following discussions. To enable maintainers to investigate a bug, your report should include all these things: @@ -770,20 +778,21 @@ customizations. @cindex dribble file @cindex logging keystrokes One way to record the input to Emacs precisely is to write a dribble -file. To start the file, use the @kbd{M-x open-dribble-file -@key{RET}} command. From then on, Emacs copies all your input to the -specified dribble file until the Emacs process is killed. Be aware -that sensitive information (such as passwords) may end up recorded in -the dribble file. +file. To start the file, use the @kbd{M-x open-dribble-file} command. +From then on, Emacs copies all your input to the specified dribble +file until the Emacs process is killed. Be aware that sensitive +information (such as passwords) may end up recorded in the dribble +file. @item @findex open-termscript @cindex termscript file @vindex TERM@r{, environment variable, and display bugs} -For possible display bugs, the terminal type (the value of environment -variable @env{TERM}), the complete termcap entry for the terminal from -@file{/etc/termcap} (since that file is not identical on all machines), -and the output that Emacs actually sent to the terminal. +For possible display bugs on text-mode terminals, the terminal type +(the value of environment variable @env{TERM}), the complete termcap +entry for the terminal from @file{/etc/termcap} (since that file is +not identical on all machines), and the output that Emacs actually +sent to the terminal. The way to collect the terminal output is to execute the Lisp expression @@ -926,13 +935,13 @@ However, you need to think when you collect the additional information if you want it to show what causes the bug. @cindex backtrace for bug reports -For example, many people send just a backtrace, but that is not very -useful by itself. A simple backtrace with arguments often conveys -little about what is happening inside GNU Emacs, because most of the -arguments listed in the backtrace are pointers to Lisp objects. The -numeric values of these pointers have no significance whatever; all that -matters is the contents of the objects they point to (and most of the -contents are themselves pointers). +For example, many people send just a C-level backtrace, but that is +not very useful by itself. A simple backtrace with arguments often +conveys little about what is happening inside GNU Emacs, because most +of the arguments listed in the backtrace are pointers to Lisp objects. +The numeric values of these pointers have no significance whatever; +all that matters is the contents of the objects they point to (and +most of the contents are themselves pointers). @findex debug_print To provide useful information, you need to show the values of Lisp @@ -1217,8 +1226,8 @@ answer questions on the Emacs user mailing list @url{https://lists.gnu.org/mailman/listinfo/help-gnu-emacs}. @item -write documentation, either on the wiki, or in the Emacs source -repository (@pxref{Sending Patches}). +write documentation, either on the @uref{https://www.emacswiki.org/, +wiki}, or in the Emacs source repository (@pxref{Sending Patches}). @item check if existing bug reports are fixed in newer versions of Emacs @@ -1237,7 +1246,7 @@ implement a new feature, and submit a patch. @item develop a package that works with Emacs, and publish it on your own -or in Gnu ELPA (@url{https://elpa.gnu.org/}). +or in GNU ELPA (@url{https://elpa.gnu.org/}). @item port Emacs to a new platform, but that is not common nowadays. @@ -1283,7 +1292,7 @@ downloaded the repository source, you should read the file from a normal build). If you would like to make more extensive contributions, see the -@file{./CONTRIBUTE} file in the Emacs distribution for information on +@file{CONTRIBUTE} file in the Emacs distribution for information on how to be an Emacs developer. For documentation on Emacs (to understand how to implement your @@ -1326,7 +1335,7 @@ the Emacs Lisp Reference Manual @end itemize @menu -* Coding Standards:: Gnu Emacs coding standards +* Coding Standards:: GNU Emacs coding standards * Copyright Assignment:: assigning copyright to the FSF @end menu @@ -1385,9 +1394,10 @@ The FSF is a nonprofit with a worldwide mission to promote computer user freedom and to defend the rights of all free software users. For general information, see the website @url{https://www.fsf.org/}. -Generally speaking, for non-trivial contributions to GNU Emacs we -require that the copyright be assigned to the FSF@. For the reasons -behind this, see @url{https://www.gnu.org/licenses/why-assign.html}. +Generally speaking, for non-trivial contributions to GNU Emacs and +packages stored in GNU ELPA, we require that the copyright be assigned +to the FSF@. For the reasons behind this, see +@url{https://www.gnu.org/licenses/why-assign.html}. Copyright assignment is a simple process. Residents of some countries can do it entirely electronically. We can help you get started, and diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 2ac89ba970e..1743a977ec7 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -6968,7 +6968,7 @@ The glyph for the end of a truncated screen line (the default for this is @samp{$}). @xref{Glyphs}. On graphical terminals, Emacs by default uses arrows in the fringes to indicate truncation, so the display table has no effect, unless you disable the fringes -(@pxref{Fringes,, Window Fringes, emacs, the Gnu Emacs Manual}). +(@pxref{Fringes,, Window Fringes, emacs, the GNU Emacs Manual}). @item 1 The glyph for the end of a continued line (the default is @samp{\}). diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi index 2d3d9d7992e..0bb94468440 100644 --- a/doc/lispref/functions.texi +++ b/doc/lispref/functions.texi @@ -611,6 +611,8 @@ Here are some examples: @end group @end example +@cindex override existing functions +@cindex redefine existing functions Be careful not to redefine existing functions unintentionally. @code{defun} redefines even primitive functions such as @code{car} without any hesitation or notification. Emacs does not prevent you diff --git a/doc/misc/ada-mode.texi b/doc/misc/ada-mode.texi index 67d46fae5a9..4a4dbd56a96 100644 --- a/doc/misc/ada-mode.texi +++ b/doc/misc/ada-mode.texi @@ -71,7 +71,7 @@ modify this GNU manual.'' The Emacs mode for programming in Ada helps the user in understanding existing code and facilitates writing new code. -When the Gnu Ada compiler GNAT is used, the cross-reference +When the GNU Ada compiler GNAT is used, the cross-reference information output by the compiler is used to provide powerful code navigation (jump to definition, find all uses, etc.). @@ -221,7 +221,7 @@ is beyond the scope of this manual; see the current definitions in @node Other compiler @section Other compiler -By default, Ada mode is configured to use the Gnu Ada compiler GNAT. +By default, Ada mode is configured to use the GNU Ada compiler GNAT. To use a different Ada compiler, you must specify the command lines used to run that compiler, either in lisp variables or in Emacs diff --git a/doc/misc/dired-x.texi b/doc/misc/dired-x.texi index 60e978c9d91..a502667ab83 100644 --- a/doc/misc/dired-x.texi +++ b/doc/misc/dired-x.texi @@ -338,7 +338,7 @@ inside your @code{dired-mode-hook} to have omitting initially turned on in To enable omitting automatically only in certain directories you can add a directory local setting -(@pxref{Directory Variables,,,emacs,The Gnu Emacs manual}) for Dired mode +(@pxref{Directory Variables,,,emacs,The GNU Emacs manual}) for Dired mode @example ((dired-mode . ((dired-omit-mode . t)))) @@ -487,7 +487,7 @@ in your @code{dired-mode-hook}. @noindent This Dired-X feature is obsolete as of Emacs 24.1. The standard Emacs directory local variables mechanism (@pxref{Directory -Variables,,,emacs,The Gnu Emacs manual}) replaces it. For an example of +Variables,,,emacs,The GNU Emacs manual}) replaces it. For an example of the new mechanisms, @pxref{Omitting Variables}. When Dired visits a directory, it looks for a file whose name is the diff --git a/doc/misc/info.texi b/doc/misc/info.texi index 964a6c69120..3e871936d28 100644 --- a/doc/misc/info.texi +++ b/doc/misc/info.texi @@ -363,13 +363,15 @@ the menu, one by one. Once you reach the end of a node, and have seen all of its subnodes, @key{SPC} takes you to the next node or to the parent's next node. -@kindex PAGEUP @r{(Info mode)} -@kindex PAGEDOWN @r{(Info mode)} +@kindex PageUp @r{(Info mode)} +@kindex PageDown @r{(Info mode)} +@kindex prior @r{(Info mode)} +@kindex next @r{(Info mode)} Many keyboards nowadays have two scroll keys labeled @samp{PageUp} -and @samp{PageDown} (or maybe @samp{Prior} and @samp{Next}). If your +and @samp{PageDown} (or maybe @samp{prior} and @samp{next}). If your keyboard has these keys, you can use them to move forward and backward through the text of one node, like @key{SPC} and @key{BACKSPACE} (or -@key{DEL}). However, @key{PAGEUP} and @key{PAGEDOWN} keys never +@key{DEL}). However, @key{PageUp} and @key{PageDown} keys never scroll beyond the beginning or the end of the current node. @kindex C-l @r{(Info mode)} diff --git a/doc/misc/org.texi b/doc/misc/org.texi index c727cc3f8db..e3bca82ea19 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi @@ -4,11 +4,11 @@ @settitle The Org Manual @include docstyle.texi -@set VERSION 9.1.6 -@set DATE 2018-01-03 +@set VERSION 9.1.9 +@set DATE 2018-03-22 @c Version and Contact Info -@set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page} +@set MAINTAINERSITE @uref{https://orgmode.org,maintainers web page} @set AUTHOR Carsten Dominik @set MAINTAINER Carsten Dominik @set MAINTAINEREMAIL @email{carsten at orgmode dot org} @@ -856,7 +856,7 @@ platform. There is a website for Org which provides links to the newest version of Org, as well as additional information, frequently asked questions (FAQ), links to tutorials, etc. This page is located at -@uref{http://orgmode.org}. +@uref{https://orgmode.org}. @cindex print edition An earlier version (7.3) of this manual is available as a @@ -892,11 +892,11 @@ been visited, i.e., where no Org built-in function have been loaded. Otherwise autoload Org functions will mess up the installation. If you want to use Org's package repository, -check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}. +check out the @uref{https://orgmode.org/elpa.html, Org ELPA page}. @subsubheading Downloading Org as an archive -You can download Org latest release from @uref{http://orgmode.org/, Org's +You can download Org latest release from @uref{https://orgmode.org/, Org's website}. In this case, make sure you set the load-path correctly in your Emacs init file: @@ -921,7 +921,8 @@ You can clone Org's repository and install Org like this: @example $ cd ~/src/ -$ git clone git://orgmode.org/org-mode.git +$ git clone https://code.orgmode.org/bzg/org-mode.git +$ cd org-mode/ $ make autoloads @end example @@ -937,7 +938,7 @@ install Org with @code{make install}. Please run @code{make help} to get the list of compilation/installation options. For more detailed explanations on Org's build system, please check the Org -Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html, +Build System page on @uref{https://orgmode.org/worg/dev/org-build-system.html, Worg}. @node Activation @@ -950,7 +951,7 @@ Worg}. @findex org-agenda @findex org-capture @findex org-store-link -@findex org-iswitchb +@findex org-switchb Org mode buffers need font-lock to be turned on: this is the default in Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer @@ -960,7 +961,7 @@ There are compatibility issues between Org mode and some other Elisp packages, please take the time to check the list (@pxref{Conflicts}). The four Org commands @command{org-store-link}, @command{org-capture}, -@command{org-agenda}, and @command{org-iswitchb} should be accessible through +@command{org-agenda}, and @command{org-switchb} should be accessible through global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are suggested bindings for these keys, please modify the keys to your own liking. @@ -968,7 +969,7 @@ liking. (global-set-key "\C-cl" 'org-store-link) (global-set-key "\C-ca" 'org-agenda) (global-set-key "\C-cc" 'org-capture) -(global-set-key "\C-cb" 'org-iswitchb) +(global-set-key "\C-cb" 'org-switchb) @end lisp @cindex Org mode, turning on @@ -1900,7 +1901,7 @@ marker in square brackets, inside text. Markers always start with @example The Org homepage[fn:1] now looks a lot better than it used to. ... -[fn:1] The link is: http://orgmode.org +[fn:1] The link is: https://orgmode.org @end example Org mode extends the number-based syntax to @emph{named} footnotes and @@ -2030,7 +2031,7 @@ prefix is set, but folding/unfolding will work correctly. @cindex Org syntax A reference document providing a formal description of Org's syntax is -available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on +available as @uref{https://orgmode.org/worg/dev/org-syntax.html, a draft on Worg}, written and maintained by Nicolas Goaziou. It defines Org's core internal concepts such as @code{headlines}, @code{sections}, @code{affiliated keywords}, @code{(greater) elements} and @code{objects}. Each part of an Org @@ -2058,7 +2059,7 @@ You can check syntax in your documents using @code{org-lint} command. Org comes with a fast and intuitive table editor. Spreadsheet-like calculations are supported using the Emacs @file{calc} package -(@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}). +(@pxref{Top, Calc, , calc, GNU Emacs Calculator Manual}). @menu * Built-in table editor:: Simple tables @@ -2278,17 +2279,6 @@ format used by Orgtbl radio tables, see @ref{Translator functions}, for a detailed description. @end table -If you don't like the automatic table editor because it gets in your -way on lines which you would like to start with @samp{|}, you can turn -it off with - -@lisp -(setq org-enable-table-editor nil) -@end lisp - -@noindent Then the only table command that still works is -@kbd{C-c C-c} to do a manual re-align. - @node Column width and alignment @section Column width and alignment @cindex narrow columns in tables @@ -2948,7 +2938,7 @@ element of @code{R-LIST}. These three functions can be used to implement associative arrays, count matching cells, rank results, group data etc. For practical examples -see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this +see @uref{https://orgmode.org/worg/org-tutorials/org-lookups.html, this tutorial on Worg}. @node Editing and debugging formulas @@ -3282,7 +3272,7 @@ Further control over the labels, type, content, and appearance of plots can be exercised through the @code{#+PLOT:} lines preceding a table. See below for a complete list of Org-plot options. The @code{#+PLOT:} lines are optional. For more information and examples see the Org-plot tutorial at -@uref{http://orgmode.org/worg/org-tutorials/org-plot.html}. +@uref{https://orgmode.org/worg/org-tutorials/org-plot.html}. @subsubheading Plot Options @@ -5833,7 +5823,7 @@ An alternative way to capture and process property values into a table is provided by Eric Schulte's @file{org-collector.el} which is a contributed package@footnote{Contributed packages are not part of Emacs, but are distributed with the main distribution of Org (visit -@uref{http://orgmode.org}).}. It provides a general API to collect +@uref{https://orgmode.org}).}. It provides a general API to collect properties from entries in a certain scope, and arbitrary Lisp expressions to process these values before inserting them into a table or a dynamic block. @@ -7060,6 +7050,7 @@ through the customize interface. @table @kbd @orgkey{C-c c C} +@vindex org-capture-templates Customize the variable @code{org-capture-templates}. @end table @@ -7655,13 +7646,13 @@ The variable @code{org-protocol-project-alist} maps URLs to local file names, by stripping URL parameters from the end and replacing the @code{:base-url} with @code{:working-directory} and @code{:online-suffix} with @code{:working-suffix}. For example, assuming you own a local copy of -@url{http://orgmode.org/worg/} contents at @file{/home/user/worg}, you can +@url{https://orgmode.org/worg/} contents at @file{/home/user/worg}, you can set @code{org-protocol-project-alist} to the following @lisp (setq org-protocol-project-alist '(("Worg" - :base-url "http://orgmode.org/worg/" + :base-url "https://orgmode.org/worg/" :working-directory "/home/user/worg/" :online-suffix ".html" :working-suffix ".org"))) @@ -7669,7 +7660,7 @@ set @code{org-protocol-project-alist} to the following @noindent If you are now browsing -@url{http://orgmode.org/worg/org-contrib/org-protocol.html} and find a typo +@url{https://orgmode.org/worg/org-contrib/org-protocol.html} and find a typo or have an idea about how to enhance the documentation, simply click the bookmark and start editing. @@ -8022,7 +8013,7 @@ Remove current file from the list of agenda files. @orgcmd{C-',org-cycle-agenda-files} @itemx C-, Cycle through agenda file list, visiting one file after the other. -@item M-x org-iswitchb @key{RET} +@item M-x org-switchb @key{RET} Command to use an @code{iswitchb}-like interface to switch to and between Org buffers. @end table @@ -9982,7 +9973,7 @@ To turn off fontification for marked up text, you can set available markup syntax, you can customize @code{org-emphasis-alist}. To fine tune what characters are allowed before and after the markup characters, you can tweak @code{org-emphasis-regexp-components}. Beware that changing one of -the above variables will no take effect until you reload Org, for which you +the above variables will not take effect until you reload Org, for which you may need to restart Emacs. @node Horizontal rules @@ -11777,7 +11768,7 @@ to @code{<a>} or @code{<img>} tags. This example shows changing the link's @cindex @code{#+ATTR_HTML} @example #+ATTR_HTML: :title The Org mode homepage :style color:red; -[[http://orgmode.org]] +[[https://orgmode.org]] @end example @node Tables in HTML export @@ -12052,9 +12043,9 @@ program enhances large files in two different ways of viewing. One is an navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys as well, press @kbd{?} for an overview of the available keys). The second one has a @emph{folding} view, much like Org provides inside Emacs. The -script is available at @url{http://orgmode.org/org-info.js} and the -documentation at @url{http://orgmode.org/worg/code/org-info-js/}. The script -is hosted on @url{http://orgmode.org}, but for reliability, prefer installing +script is available at @url{https://orgmode.org/org-info.js} and the +documentation at @url{https://orgmode.org/worg/code/org-info-js/}. The script +is hosted on @url{https://orgmode.org}, but for reliability, prefer installing it on your own web server. To use this program, just add this line to the Org file: @@ -12071,7 +12062,7 @@ below: @example path: @r{The path to the script. The default grabs the script from} - @r{@url{http://orgmode.org/org-info.js}, but you might want to have} + @r{@url{https://orgmode.org/org-info.js}, but you might want to have} @r{a local copy and use a path like @samp{../scripts/org-info.js}.} view: @r{Initial view when the website is first shown. Possible values are:} info @r{Info-like interface with one section per page.} @@ -12991,10 +12982,10 @@ of these examples works: @subsubheading Embedding clickable images For clickable images, provide a link whose description is another link to an image file. For example, to embed an image @file{org-mode-unicorn.png} which -when clicked jumps to @uref{http://Orgmode.org} website, do the following +when clicked jumps to @uref{https://orgmode.org} website, do the following @example -[[http://orgmode.org][./org-mode-unicorn.png]] +[[https://orgmode.org][./org-mode-unicorn.png]] @end example @subsubheading Sizing and scaling of embedded images @@ -15510,7 +15501,7 @@ For more examples of header arguments for @code{#+CALL:} lines, The ``Library of Babel'' is a collection of code blocks. Like a function library, these code blocks can be called from other Org files. A collection of useful code blocks is available on -@uref{http://orgmode.org/worg/library-of-babel.html,Worg}. For remote code +@uref{https://orgmode.org/worg/library-of-babel.html,Worg}. For remote code block evaluation syntax, @pxref{Evaluating code blocks}. @kindex C-c C-v i @@ -15552,7 +15543,7 @@ Org supports the following languages for the @samp{src} code blocks: @end multitable Additional documentation for some languages are at -@uref{http://orgmode.org/worg/org-contrib/babel/languages.html}. +@uref{https://orgmode.org/worg/org-contrib/babel/languages.html}. @vindex org-babel-load-languages By default, only @code{emacs-lisp} is enabled for evaluation. To enable or @@ -15640,7 +15631,7 @@ Org expand @code{:noweb} references by default. Each language can have separate default header arguments by customizing the variable @code{org-babel-default-header-args:<lang>}, where @code{<lang>} is the name of the language. For details, see the language-specific online -documentation at @uref{http://orgmode.org/worg/org-contrib/babel}. +documentation at @uref{https://orgmode.org/worg/org-contrib/babel/}. @node Header arguments in Org mode properties @subsubheading Header arguments in Org mode properties @@ -18223,7 +18214,7 @@ Org. Org has a large number of hook variables for adding functionality. This appendix illustrates using a few. A complete list of hooks with documentation is maintained by the Worg project at -@uref{http://orgmode.org/worg/doc.html#hooks}. +@uref{https://orgmode.org/worg/doc.html#hooks}. @node Add-on packages @section Add-on packages @@ -18232,10 +18223,10 @@ documentation is maintained by the Worg project at Various authors wrote a large number of add-on packages for Org. These packages are not part of Emacs, but they are distributed as contributed -packages with the separate release available at @uref{http://orgmode.org}. +packages with the separate release available at @uref{https://orgmode.org}. See the @file{contrib/README} file in the source code directory for a list of contributed files. Worg page with more information is at: -@uref{http://orgmode.org/worg/org-contrib/}. +@uref{https://orgmode.org/worg/org-contrib/}. @node Adding hyperlink types @section Adding hyperlink types @@ -18356,7 +18347,7 @@ to an alist of export functions. This alist replaces the parent back-end functions. For complete documentation, see -@url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export +@url{https://orgmode.org/worg/dev/org-export-reference.html, the Org Export Reference on Worg}. @node Context-sensitive commands @@ -18867,7 +18858,7 @@ Disable tag inheritance for agendas: These options can be applied to selected agenda views. For more details about generation of agenda views, see the docstrings for the relevant -variables, and this @uref{http://orgmode.org/worg/agenda-optimization.html, +variables, and this @uref{https://orgmode.org/worg/agenda-optimization.html, dedicated Worg page} for agenda optimization. @node Extracting agenda information @@ -19211,7 +19202,7 @@ For a server to host files, consider options like @uref{http://dropbox.com,Dropbox.com} account@footnote{An alternative is to use webdav server. MobileOrg documentation has details of webdav server configuration. Additional help is at -@uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}. +@uref{https://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}. On first connection, MobileOrg creates a directory @file{MobileOrg/} on Dropbox. Pass its location to Emacs through an init file variable as follows: |