diff options
| author | Ken Raeburn | 2017-07-31 01:13:53 -0400 |
|---|---|---|
| committer | Ken Raeburn | 2017-07-31 01:13:53 -0400 |
| commit | 13f3370400031e2ac1c9be0932f411370fc6984e (patch) | |
| tree | 06f349b2b0f1cda9e36f7c4390d9d2d9bf49303c /doc | |
| parent | cd0966b33c1fe975520e85e0e7af82c09e4754dc (diff) | |
| parent | dcfcaf40d577808d640016c886d4fae7280a7fd5 (diff) | |
| download | emacs-scratch/raeburn-startup.tar.gz emacs-scratch/raeburn-startup.zip | |
; Merge from branch 'master'scratch/raeburn-startup
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/emacs/custom.texi | 1 | ||||
| -rw-r--r-- | doc/emacs/dired.texi | 20 | ||||
| -rw-r--r-- | doc/emacs/fixit.texi | 1 | ||||
| -rw-r--r-- | doc/emacs/frames.texi | 3 | ||||
| -rw-r--r-- | doc/emacs/help.texi | 9 | ||||
| -rw-r--r-- | doc/emacs/modes.texi | 7 | ||||
| -rw-r--r-- | doc/emacs/regs.texi | 5 | ||||
| -rw-r--r-- | doc/emacs/search.texi | 4 | ||||
| -rw-r--r-- | doc/emacs/xresources.texi | 5 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/loading.texi | 40 | ||||
| -rw-r--r-- | doc/lispref/text.texi | 1 |
12 files changed, 93 insertions, 7 deletions
diff --git a/doc/emacs/custom.texi b/doc/emacs/custom.texi index a756a89e3f8..1c9c14a962a 100644 --- a/doc/emacs/custom.texi +++ b/doc/emacs/custom.texi | |||
| @@ -1701,6 +1701,7 @@ and mouse events: | |||
| 1701 | (global-set-key (kbd "C-c y") 'clipboard-yank) | 1701 | (global-set-key (kbd "C-c y") 'clipboard-yank) |
| 1702 | (global-set-key (kbd "C-M-q") 'query-replace) | 1702 | (global-set-key (kbd "C-M-q") 'query-replace) |
| 1703 | (global-set-key (kbd "<f5>") 'flyspell-mode) | 1703 | (global-set-key (kbd "<f5>") 'flyspell-mode) |
| 1704 | (global-set-key (kbd "C-<f5>") 'display-line-numbers-mode) | ||
| 1704 | (global-set-key (kbd "C-<right>") 'forward-sentence) | 1705 | (global-set-key (kbd "C-<right>") 'forward-sentence) |
| 1705 | (global-set-key (kbd "<mouse-2>") 'mouse-save-then-kill) | 1706 | (global-set-key (kbd "<mouse-2>") 'mouse-save-then-kill) |
| 1706 | @end example | 1707 | @end example |
diff --git a/doc/emacs/dired.texi b/doc/emacs/dired.texi index ddd7229b0c8..150ac8427ab 100644 --- a/doc/emacs/dired.texi +++ b/doc/emacs/dired.texi | |||
| @@ -64,10 +64,22 @@ you to operate on the listed files. @xref{Directories}. | |||
| 64 | directory name using the minibuffer, and opens a @dfn{Dired buffer} | 64 | directory name using the minibuffer, and opens a @dfn{Dired buffer} |
| 65 | listing the files in that directory. You can also supply a wildcard | 65 | listing the files in that directory. You can also supply a wildcard |
| 66 | file name pattern as the minibuffer argument, in which case the Dired | 66 | file name pattern as the minibuffer argument, in which case the Dired |
| 67 | buffer lists all files matching that pattern. The usual history and | 67 | buffer lists all files matching that pattern. A wildcard may appear |
| 68 | completion commands can be used in the minibuffer; in particular, | 68 | in the directory part as well. |
| 69 | @kbd{M-n} puts the name of the visited file (if any) in the minibuffer | 69 | For instance, |
| 70 | (@pxref{Minibuffer History}). | 70 | |
| 71 | @example | ||
| 72 | C-x d ~/foo/*.el @key{RET} | ||
| 73 | C-x d ~/foo/*/*.el @key{RET} | ||
| 74 | @end example | ||
| 75 | |||
| 76 | The former lists all the files with extension @samp{.el} in directory | ||
| 77 | @samp{foo}. The latter lists the files with extension @samp{.el} | ||
| 78 | in subdirectories 2 levels of depth below @samp{foo}. | ||
| 79 | |||
| 80 | The usual history and completion commands can be used in the minibuffer; | ||
| 81 | in particular, @kbd{M-n} puts the name of the visited file (if any) in | ||
| 82 | the minibuffer (@pxref{Minibuffer History}). | ||
| 71 | 83 | ||
| 72 | You can also invoke Dired by giving @kbd{C-x C-f} (@code{find-file}) | 84 | You can also invoke Dired by giving @kbd{C-x C-f} (@code{find-file}) |
| 73 | a directory name. | 85 | a directory name. |
diff --git a/doc/emacs/fixit.texi b/doc/emacs/fixit.texi index 2ba3e26c484..f833f572dfc 100644 --- a/doc/emacs/fixit.texi +++ b/doc/emacs/fixit.texi | |||
| @@ -254,6 +254,7 @@ Restart the Aspell/Ispell/Hunspell process, using @var{dict} as the dictionary. | |||
| 254 | Kill the Aspell/Ispell/Hunspell subprocess. | 254 | Kill the Aspell/Ispell/Hunspell subprocess. |
| 255 | @item M-@key{TAB} | 255 | @item M-@key{TAB} |
| 256 | @itemx @key{ESC} @key{TAB} | 256 | @itemx @key{ESC} @key{TAB} |
| 257 | @itemx C-M-i | ||
| 257 | Complete the word before point based on the spelling dictionary | 258 | Complete the word before point based on the spelling dictionary |
| 258 | (@code{ispell-complete-word}). | 259 | (@code{ispell-complete-word}). |
| 259 | @item M-x flyspell-mode | 260 | @item M-x flyspell-mode |
diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi index e3e59ad43ac..ee33a6848c5 100644 --- a/doc/emacs/frames.texi +++ b/doc/emacs/frames.texi | |||
| @@ -575,7 +575,8 @@ font names in X resource files. | |||
| 575 | If you are running Emacs on the GNOME desktop, you can tell Emacs to | 575 | If you are running Emacs on the GNOME desktop, you can tell Emacs to |
| 576 | use the default system font by setting the variable | 576 | use the default system font by setting the variable |
| 577 | @code{font-use-system-font} to @code{t} (the default is @code{nil}). | 577 | @code{font-use-system-font} to @code{t} (the default is @code{nil}). |
| 578 | For this to work, Emacs must have been compiled with Gconf support. | 578 | For this to work, Emacs must have been compiled with support for |
| 579 | Gsettings (or the older Gconf). | ||
| 579 | 580 | ||
| 580 | @item | 581 | @item |
| 581 | Use the command line option @samp{-fn} (or @samp{--font}). @xref{Font | 582 | Use the command line option @samp{-fn} (or @samp{--font}). @xref{Font |
diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi index fd6df1c7e53..460ced0d21c 100644 --- a/doc/emacs/help.texi +++ b/doc/emacs/help.texi | |||
| @@ -320,12 +320,21 @@ search for non-customizable variables too. | |||
| 320 | Search for variables. With a prefix argument, search for | 320 | Search for variables. With a prefix argument, search for |
| 321 | customizable variables only. | 321 | customizable variables only. |
| 322 | 322 | ||
| 323 | @item M-x apropos-local-variable | ||
| 324 | @findex apropos-local-variable | ||
| 325 | Search for buffer-local variables. | ||
| 326 | |||
| 323 | @item M-x apropos-value | 327 | @item M-x apropos-value |
| 324 | @findex apropos-value | 328 | @findex apropos-value |
| 325 | Search for variables whose values match the specified pattern. With a | 329 | Search for variables whose values match the specified pattern. With a |
| 326 | prefix argument, search also for functions with definitions matching | 330 | prefix argument, search also for functions with definitions matching |
| 327 | the pattern, and Lisp symbols with properties matching the pattern. | 331 | the pattern, and Lisp symbols with properties matching the pattern. |
| 328 | 332 | ||
| 333 | @item M-x apropos-local-value | ||
| 334 | @findex apropos-local-value | ||
| 335 | Search for buffer-local variables whose values match the specified | ||
| 336 | pattern. | ||
| 337 | |||
| 329 | @item C-h d | 338 | @item C-h d |
| 330 | @kindex C-h d | 339 | @kindex C-h d |
| 331 | @findex apropos-documentation | 340 | @findex apropos-documentation |
diff --git a/doc/emacs/modes.texi b/doc/emacs/modes.texi index eb0c88b2901..876431aa9e9 100644 --- a/doc/emacs/modes.texi +++ b/doc/emacs/modes.texi | |||
| @@ -225,6 +225,13 @@ Font-Lock mode automatically highlights certain textual units found in | |||
| 225 | programs. It is enabled globally by default, but you can disable it | 225 | programs. It is enabled globally by default, but you can disable it |
| 226 | in individual buffers. @xref{Faces}. | 226 | in individual buffers. @xref{Faces}. |
| 227 | 227 | ||
| 228 | @findex display-line-numbers-mode | ||
| 229 | @cindex display-line-numbers-mode | ||
| 230 | @item | ||
| 231 | Display Line Numbers mode is a convenience wrapper around | ||
| 232 | @code{display-line-numbers}, setting it using the value of | ||
| 233 | @code{display-line-numbers-type}. @xref{Display Custom}. | ||
| 234 | |||
| 228 | @item | 235 | @item |
| 229 | Outline minor mode provides similar facilities to the major mode | 236 | Outline minor mode provides similar facilities to the major mode |
| 230 | called Outline mode. @xref{Outline Mode}. | 237 | called Outline mode. @xref{Outline Mode}. |
diff --git a/doc/emacs/regs.texi b/doc/emacs/regs.texi index 7369f6b05b6..40e3e2c1c31 100644 --- a/doc/emacs/regs.texi +++ b/doc/emacs/regs.texi | |||
| @@ -15,7 +15,10 @@ jump back to that position once, or many times. | |||
| 15 | Each register has a name that consists of a single character, which | 15 | Each register has a name that consists of a single character, which |
| 16 | we will denote by @var{r}; @var{r} can be a letter (such as @samp{a}) | 16 | we will denote by @var{r}; @var{r} can be a letter (such as @samp{a}) |
| 17 | or a number (such as @samp{1}); case matters, so register @samp{a} is | 17 | or a number (such as @samp{1}); case matters, so register @samp{a} is |
| 18 | not the same as register @samp{A}. | 18 | not the same as register @samp{A}. You can also set a register in |
| 19 | non-alphanumeric characters, for instance @samp{*} or @samp{C-d}. | ||
| 20 | Note, it's not possible to set a register in @samp{C-g} or @samp{ESC}, | ||
| 21 | because these keys are reserved to terminate interactive commands. | ||
| 19 | 22 | ||
| 20 | @findex view-register | 23 | @findex view-register |
| 21 | A register can store a position, a piece of text, a rectangle, a | 24 | A register can store a position, a piece of text, a rectangle, a |
diff --git a/doc/emacs/search.texi b/doc/emacs/search.texi index c9e83da173f..9f7e9a12cd7 100644 --- a/doc/emacs/search.texi +++ b/doc/emacs/search.texi | |||
| @@ -1747,6 +1747,10 @@ at the first match after such line. | |||
| 1747 | You can also run @kbd{M-s o} when an incremental search is active; | 1747 | You can also run @kbd{M-s o} when an incremental search is active; |
| 1748 | this uses the current search string. | 1748 | this uses the current search string. |
| 1749 | 1749 | ||
| 1750 | Note that matches for the regexp you type are extended to include | ||
| 1751 | complete lines, and a match that starts before the previous match ends | ||
| 1752 | is not considered a match. | ||
| 1753 | |||
| 1750 | @kindex RET @r{(Occur mode)} | 1754 | @kindex RET @r{(Occur mode)} |
| 1751 | @kindex o @r{(Occur mode)} | 1755 | @kindex o @r{(Occur mode)} |
| 1752 | @kindex C-o @r{(Occur mode)} | 1756 | @kindex C-o @r{(Occur mode)} |
diff --git a/doc/emacs/xresources.texi b/doc/emacs/xresources.texi index 7e27ddd1d9a..eaefcee21c3 100644 --- a/doc/emacs/xresources.texi +++ b/doc/emacs/xresources.texi | |||
| @@ -250,6 +250,11 @@ specified if @samp{off}. | |||
| 250 | Gamma correction for colors, equivalent to the frame parameter | 250 | Gamma correction for colors, equivalent to the frame parameter |
| 251 | @code{screen-gamma}. | 251 | @code{screen-gamma}. |
| 252 | 252 | ||
| 253 | @item @code{scrollBar} (class @code{ScrollBar}) | ||
| 254 | @cindex tool bar | ||
| 255 | If the value of this resource is @samp{off} or @samp{false} or | ||
| 256 | @samp{0}, Emacs disables Scroll Bar mode at startup (@pxref{Scroll Bars}). | ||
| 257 | |||
| 253 | @item @code{scrollBarWidth} (class @code{ScrollBarWidth}) | 258 | @item @code{scrollBarWidth} (class @code{ScrollBarWidth}) |
| 254 | @cindex scrollbar width | 259 | @cindex scrollbar width |
| 255 | The scroll bar width in pixels, equivalent to the frame parameter | 260 | The scroll bar width in pixels, equivalent to the frame parameter |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index f5c73e55a4f..2ed848adf37 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -2423,7 +2423,9 @@ the values of the @code{:family}, @code{:foundry}, @code{:width}, | |||
| 2423 | The name of a face from which to inherit attributes, or a list of face | 2423 | The name of a face from which to inherit attributes, or a list of face |
| 2424 | names. Attributes from inherited faces are merged into the face like | 2424 | names. Attributes from inherited faces are merged into the face like |
| 2425 | an underlying face would be, with higher priority than underlying | 2425 | an underlying face would be, with higher priority than underlying |
| 2426 | faces (@pxref{Displaying Faces}). If a list of faces is used, | 2426 | faces (@pxref{Displaying Faces}). If the face to inherit from is |
| 2427 | @code{unspecified}, it is treated the same as @code{nil}, since Emacs | ||
| 2428 | never merges @code{:inherit} attributes. If a list of faces is used, | ||
| 2427 | attributes from faces earlier in the list override those from later | 2429 | attributes from faces earlier in the list override those from later |
| 2428 | faces. | 2430 | faces. |
| 2429 | @end table | 2431 | @end table |
diff --git a/doc/lispref/loading.texi b/doc/lispref/loading.texi index d925c8c8f65..80dcb488983 100644 --- a/doc/lispref/loading.texi +++ b/doc/lispref/loading.texi | |||
| @@ -468,6 +468,10 @@ runs the real definition as if it had been loaded all along. | |||
| 468 | Autoloading can also be triggered by looking up the documentation of | 468 | Autoloading can also be triggered by looking up the documentation of |
| 469 | the function or macro (@pxref{Documentation Basics}). | 469 | the function or macro (@pxref{Documentation Basics}). |
| 470 | 470 | ||
| 471 | @menu | ||
| 472 | * When to Autoload:: When to Use Autoload. | ||
| 473 | @end menu | ||
| 474 | |||
| 471 | There are two ways to set up an autoloaded function: by calling | 475 | There are two ways to set up an autoloaded function: by calling |
| 472 | @code{autoload}, and by writing a ``magic'' comment in the | 476 | @code{autoload}, and by writing a ``magic'' comment in the |
| 473 | source before the real definition. @code{autoload} is the low-level | 477 | source before the real definition. @code{autoload} is the low-level |
| @@ -699,6 +703,42 @@ symbol's new function value. If the value of the optional argument | |||
| 699 | function, only a macro. | 703 | function, only a macro. |
| 700 | @end defun | 704 | @end defun |
| 701 | 705 | ||
| 706 | @node When to Autoload | ||
| 707 | @subsection When to Use Autoload | ||
| 708 | @cindex autoload, when to use | ||
| 709 | |||
| 710 | Do not add an autoload comment unless it is really necessary. | ||
| 711 | Autoloading code means it is always globally visible. Once an item is | ||
| 712 | autoloaded, there is no compatible way to transition back to it not | ||
| 713 | being autoloaded (after people become accustomed to being able to use it | ||
| 714 | without an explicit load). | ||
| 715 | |||
| 716 | @itemize | ||
| 717 | @item | ||
| 718 | The most common items to autoload are the interactive entry points to a | ||
| 719 | library. For example, if @file{python.el} is a library defining a | ||
| 720 | major-mode for editing Python code, autoload the definition of the | ||
| 721 | @code{python-mode} function, so that people can simply use @kbd{M-x | ||
| 722 | python-mode} to load the library. | ||
| 723 | |||
| 724 | @item | ||
| 725 | Variables usually don't need to be autoloaded. An exception is if the | ||
| 726 | variable on its own is generally useful without the whole defining | ||
| 727 | library being loaded. (An example of this might be something like | ||
| 728 | @code{find-exec-terminator}.) | ||
| 729 | |||
| 730 | @item | ||
| 731 | Don't autoload a user option just so that a user can set it. | ||
| 732 | |||
| 733 | @item | ||
| 734 | Never add an autoload @emph{comment} to silence a compiler warning in | ||
| 735 | another file. In the file that produces the warning, use | ||
| 736 | @code{(defvar foo)} to silence an undefined variable warning, and | ||
| 737 | @code{declare-function} (@pxref{Declaring Functions}) to silence an | ||
| 738 | undefined function warning; or require the relevant library; or use an | ||
| 739 | explicit autoload @emph{statement}. | ||
| 740 | @end itemize | ||
| 741 | |||
| 702 | @node Repeated Loading | 742 | @node Repeated Loading |
| 703 | @section Repeated Loading | 743 | @section Repeated Loading |
| 704 | @cindex repeated loading | 744 | @cindex repeated loading |
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 7108520e79f..b825b1d790b 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi | |||
| @@ -4236,6 +4236,7 @@ A marker represents a buffer position to jump to. | |||
| 4236 | A string is text saved in the register. | 4236 | A string is text saved in the register. |
| 4237 | 4237 | ||
| 4238 | @item a rectangle | 4238 | @item a rectangle |
| 4239 | @cindex rectangle, as contents of a register | ||
| 4239 | A rectangle is represented by a list of strings. | 4240 | A rectangle is represented by a list of strings. |
| 4240 | 4241 | ||
| 4241 | @item @code{(@var{window-configuration} @var{position})} | 4242 | @item @code{(@var{window-configuration} @var{position})} |