diff options
| author | Glenn Morris | 2020-05-16 10:29:14 -0700 |
|---|---|---|
| committer | Glenn Morris | 2020-05-16 10:29:14 -0700 |
| commit | 788c2480f448e97773172f3e840976dbcdc3e6c8 (patch) | |
| tree | 60d3425a657e682da7790fc5f0d2548995721ef2 /doc | |
| parent | a67415a71a1be5419547ac5e2abe51bc6bb37f1d (diff) | |
| parent | b4937f64cd97ff6bf93538987c014f8ea8ff9d34 (diff) | |
| download | emacs-788c2480f448e97773172f3e840976dbcdc3e6c8.tar.gz emacs-788c2480f448e97773172f3e840976dbcdc3e6c8.zip | |
Merge from origin/emacs-27
b4937f64cd (origin/emacs-27) Improve documentation of manually instal...
efd4e973a4 Reflect the emacs-devel ELPA/MELPA dispute in FAQ
28541674cd Consider face inheritance when checking region face backgr...
e75f6be6cc Fix dired default file operation (bug#41261)
406fb0746c Fix documentation related to 'command-switch-alist'.
747e0a2523 Improve ediff readability in misterioso theme (Bug#41221)
48830c73e7 Fix a crash in handle_display_spec
a37290a6f9 In x_hide_tip reset tip_last_frame for GTK+ tooltips only ...
3d81995692 Fix docstring of flymake-make-diagnostic (bug#40351)
632aa9d57a Go back to “Bahá’í”
e2406ff60f * lisp/dired.el (dired-toggle-marks): Doc fix. (Bug#41097)
# Conflicts:
# doc/emacs/building.texi
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/emacs/building.texi | 32 | ||||
| -rw-r--r-- | doc/emacs/calendar.texi | 2 | ||||
| -rw-r--r-- | doc/emacs/package.texi | 32 | ||||
| -rw-r--r-- | doc/lispref/os.texi | 10 | ||||
| -rw-r--r-- | doc/misc/efaq.texi | 5 |
5 files changed, 69 insertions, 12 deletions
diff --git a/doc/emacs/building.texi b/doc/emacs/building.texi index 77a0e807c2b..7074bd45d71 100644 --- a/doc/emacs/building.texi +++ b/doc/emacs/building.texi | |||
| @@ -1541,6 +1541,11 @@ putting a line like this in your init file (@pxref{Init File}): | |||
| 1541 | (add-to-list 'load-path "/path/to/my/lisp/library") | 1541 | (add-to-list 'load-path "/path/to/my/lisp/library") |
| 1542 | @end example | 1542 | @end example |
| 1543 | 1543 | ||
| 1544 | It is customary to put locally installed libraries in the | ||
| 1545 | @file{site-lisp} directory that is already in the default value of | ||
| 1546 | @code{load-path}, or in some subdirectory of @file{site-lisp}. This | ||
| 1547 | way, you don't need to modify the default value of @code{load-path}. | ||
| 1548 | |||
| 1544 | @cindex autoload | 1549 | @cindex autoload |
| 1545 | Some commands are @dfn{autoloaded}; when you run them, Emacs | 1550 | Some commands are @dfn{autoloaded}; when you run them, Emacs |
| 1546 | automatically loads the associated library first. For instance, the | 1551 | automatically loads the associated library first. For instance, the |
| @@ -1563,6 +1568,33 @@ Automatic loading also occurs when completing names for | |||
| 1563 | prefix being completed. To disable this feature, change the variable | 1568 | prefix being completed. To disable this feature, change the variable |
| 1564 | @code{help-enable-completion-autoload} to @code{nil}. | 1569 | @code{help-enable-completion-autoload} to @code{nil}. |
| 1565 | 1570 | ||
| 1571 | Once you put your library in a directory where Emacs can find and | ||
| 1572 | load it, you may wish to make it available at startup. This is useful | ||
| 1573 | when the library defines features that should be available | ||
| 1574 | automatically on demand, and manually loading the library is thus | ||
| 1575 | inconvenient. In these cases, make sure the library will be loaded by | ||
| 1576 | adding suitable forms to your init file: either @code{load} or | ||
| 1577 | @code{require} (if you always need to load the library at startup), or | ||
| 1578 | @code{autoload} if you need Emacs to load the library when some | ||
| 1579 | command or function is invoked. For example: | ||
| 1580 | |||
| 1581 | @smalllisp | ||
| 1582 | @group | ||
| 1583 | ;; Loads @file{my-shining-package.elc} unconditionally. | ||
| 1584 | (require 'my-shining-package) | ||
| 1585 | @end group | ||
| 1586 | @group | ||
| 1587 | ;; Will load @file{my-shining-package.elc} when @code{my-func} is invoked. | ||
| 1588 | (autoload 'my-func "my-shining-package") | ||
| 1589 | @end group | ||
| 1590 | @end smalllisp | ||
| 1591 | |||
| 1592 | Note that installing a package using @code{package-install} | ||
| 1593 | (@pxref{Package Installation}) takes care of placing the package's | ||
| 1594 | Lisp files in a directory where Emacs will find it, and also writes | ||
| 1595 | the necessary initialization code into your init files, making the | ||
| 1596 | above manual customizations unnecessary. | ||
| 1597 | |||
| 1566 | @node Lisp Eval | 1598 | @node Lisp Eval |
| 1567 | @section Evaluating Emacs Lisp Expressions | 1599 | @section Evaluating Emacs Lisp Expressions |
| 1568 | @cindex Emacs Lisp mode | 1600 | @cindex Emacs Lisp mode |
diff --git a/doc/emacs/calendar.texi b/doc/emacs/calendar.texi index 8dc1a0b2df8..fe51ad35d77 100644 --- a/doc/emacs/calendar.texi +++ b/doc/emacs/calendar.texi | |||
| @@ -532,7 +532,7 @@ holidays centered around a different month, use @kbd{C-u M-x | |||
| 532 | holidays}, which prompts for the month and year. | 532 | holidays}, which prompts for the month and year. |
| 533 | 533 | ||
| 534 | The holidays known to Emacs include United States holidays and the | 534 | The holidays known to Emacs include United States holidays and the |
| 535 | major Bah@'{a}@t{'}@'{i}, Chinese, Christian, Islamic, and Jewish | 535 | major Bahá'í, Chinese, Christian, Islamic, and Jewish |
| 536 | holidays; also the solstices and equinoxes. | 536 | holidays; also the solstices and equinoxes. |
| 537 | 537 | ||
| 538 | @findex list-holidays | 538 | @findex list-holidays |
diff --git a/doc/emacs/package.texi b/doc/emacs/package.texi index 91e44b8eba8..453d9eb4010 100644 --- a/doc/emacs/package.texi +++ b/doc/emacs/package.texi | |||
| @@ -5,23 +5,37 @@ | |||
| 5 | @node Packages | 5 | @node Packages |
| 6 | @chapter Emacs Lisp Packages | 6 | @chapter Emacs Lisp Packages |
| 7 | @cindex Package | 7 | @cindex Package |
| 8 | @cindex Emacs Lisp package archive | ||
| 9 | @cindex Package archive | 8 | @cindex Package archive |
| 10 | 9 | ||
| 11 | Emacs includes a facility that lets you easily download and install | 10 | Emacs is extended by implementing additional features in |
| 12 | @dfn{packages} that implement additional features. Each package is a | 11 | @dfn{packages}, which are Emacs Lisp libraries. These could be |
| 13 | separate Emacs Lisp program, sometimes including other components such | 12 | written by you or provided by someone else. If you want to install |
| 14 | as an Info manual. | 13 | such a package so it is available in your future Emacs session, you |
| 14 | need to compile it and put it in a directory where Emacs looks for | ||
| 15 | Lisp libraries. @xref{Lisp Libraries}, for more details about this | ||
| 16 | manual installation method. Many packages provide installation and | ||
| 17 | usage instructions in the large commentary near the beginning of the | ||
| 18 | Lisp file; you can use those instructions for installing and | ||
| 19 | fine-tuning your use of the package. | ||
| 15 | 20 | ||
| 16 | @kbd{M-x list-packages} brings up a buffer named @file{*Packages*} | 21 | @cindex Emacs Lisp package archive |
| 17 | with a list of all packages. You can install or uninstall packages | 22 | Packages can also be provided by @dfn{package archives}, which are |
| 18 | via this buffer. @xref{Package Menu}. | 23 | large collections of Emacs Lisp packages. Each package is a separate |
| 24 | Emacs Lisp program, sometimes including other components such as an | ||
| 25 | Info manual. Emacs includes a facility that lets you easily download | ||
| 26 | and install packages from such archives. The rest of this chapter | ||
| 27 | describes this facility. | ||
| 28 | |||
| 29 | To list the packages available for installation from package | ||
| 30 | archives, type @w{@kbd{M-x list-packages @key{RET}}}. It brings up a | ||
| 31 | buffer named @file{*Packages*} with a list of all packages. You can | ||
| 32 | install or uninstall packages via this buffer. @xref{Package Menu}. | ||
| 19 | 33 | ||
| 20 | The command @kbd{C-h P} (@code{describe-package}) prompts for the | 34 | The command @kbd{C-h P} (@code{describe-package}) prompts for the |
| 21 | name of a package, and displays a help buffer describing the | 35 | name of a package, and displays a help buffer describing the |
| 22 | attributes of the package and the features that it implements. | 36 | attributes of the package and the features that it implements. |
| 23 | 37 | ||
| 24 | By default, Emacs downloads packages from a @dfn{package archive} | 38 | By default, Emacs downloads packages from a package archive |
| 25 | maintained by the Emacs developers and hosted by the GNU project. | 39 | maintained by the Emacs developers and hosted by the GNU project. |
| 26 | Optionally, you can also download packages from archives maintained by | 40 | Optionally, you can also download packages from archives maintained by |
| 27 | third parties. @xref{Package Installation}. | 41 | third parties. @xref{Package Installation}. |
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 8bf48b1dbba..8f2c7439d9f 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi | |||
| @@ -613,7 +613,7 @@ The elements of the @code{command-switch-alist} look like this: | |||
| 613 | @end example | 613 | @end example |
| 614 | 614 | ||
| 615 | The @sc{car}, @var{option}, is a string, the name of a command-line | 615 | The @sc{car}, @var{option}, is a string, the name of a command-line |
| 616 | option (not including the initial hyphen). The @var{handler-function} | 616 | option (including the initial hyphen). The @var{handler-function} |
| 617 | is called to handle @var{option}, and receives the option name as its | 617 | is called to handle @var{option}, and receives the option name as its |
| 618 | sole argument. | 618 | sole argument. |
| 619 | 619 | ||
| @@ -623,6 +623,14 @@ remaining command-line arguments in the variable | |||
| 623 | @code{command-line-args-left} (see below). (The entire list of | 623 | @code{command-line-args-left} (see below). (The entire list of |
| 624 | command-line arguments is in @code{command-line-args}.) | 624 | command-line arguments is in @code{command-line-args}.) |
| 625 | 625 | ||
| 626 | Note that the handling of @code{command-switch-alist} doesn't treat | ||
| 627 | equals signs in @var{option} specially. That is, if there's an option | ||
| 628 | like @code{--name=value} on the command line, then only a | ||
| 629 | @code{command-switch-alist} member whose @code{car} is literally | ||
| 630 | @code{--name=value} will match this option. If you want to parse such | ||
| 631 | options, you need to use @code{command-line-functions} instead (see | ||
| 632 | below). | ||
| 633 | |||
| 626 | The command-line arguments are parsed by the @code{command-line-1} | 634 | The command-line arguments are parsed by the @code{command-line-1} |
| 627 | function in the @file{startup.el} file. See also @ref{Emacs | 635 | function in the @file{startup.el} file. See also @ref{Emacs |
| 628 | Invocation, , Command Line Arguments for Emacs Invocation, emacs, The | 636 | Invocation, , Command Line Arguments for Emacs Invocation, emacs, The |
diff --git a/doc/misc/efaq.texi b/doc/misc/efaq.texi index 50a208d233b..d3a2f07e254 100644 --- a/doc/misc/efaq.texi +++ b/doc/misc/efaq.texi | |||
| @@ -3478,7 +3478,10 @@ There are other, non-GNU, Emacs Lisp package servers, including: | |||
| 3478 | @uref{https://marmalade-repo.org, Marmalade}. To use additional | 3478 | @uref{https://marmalade-repo.org, Marmalade}. To use additional |
| 3479 | package servers, customize the @code{package-archives} variable. Be | 3479 | package servers, customize the @code{package-archives} variable. Be |
| 3480 | aware that installing a package can run arbitrary code, so only add | 3480 | aware that installing a package can run arbitrary code, so only add |
| 3481 | sources that you trust. | 3481 | sources that you trust. Also, packages hosted on non-GNU package |
| 3482 | servers may encourage or require you to install and use non-free | ||
| 3483 | software; for example, MELPA is known to host some packages that do | ||
| 3484 | this. | ||
| 3482 | 3485 | ||
| 3483 | The @uref{https://lists.gnu.org/mailman/listinfo/gnu-emacs-sources, | 3486 | The @uref{https://lists.gnu.org/mailman/listinfo/gnu-emacs-sources, |
| 3484 | GNU Emacs sources mailing list}, which is gatewayed to the | 3487 | GNU Emacs sources mailing list}, which is gatewayed to the |