diff options
| author | Glenn Morris | 2018-02-24 07:50:30 -0800 |
|---|---|---|
| committer | Glenn Morris | 2018-02-24 07:50:30 -0800 |
| commit | 80c2bf6e1684a05b7cdc00f4c4eba89841911c76 (patch) | |
| tree | 317b80c1b824e123480292100c7b2454f0f49779 | |
| parent | 8a23dc15077c6bbe3d80ccfcef64397e71f5765d (diff) | |
| parent | 7e7f2ea644388d6d06a4ab6690344f7f7c128141 (diff) | |
| download | emacs-80c2bf6e1684a05b7cdc00f4c4eba89841911c76.tar.gz emacs-80c2bf6e1684a05b7cdc00f4c4eba89841911c76.zip | |
Merge from origin/emacs-26
7e7f2ea (origin/emacs-26) * src/keyboard.c (syms_of_keyboard): Doc fi...
c0676d4 Improve documentation of X resources
d806d69 ; Use @minus for negative numbers in some texi files
4a8ea7d * lisp/international/mule.el (keyboard-coding-system): Doc fix.
8a73b80 Minor doc fixes, mostly for timestamp issues
361a8b9 * doc/emacs/mini.texi (Completion Styles): Improve indexing.
2dc24d5 Fix @findex and @vindex entries in manuals
76f5242 Document, in the Elisp manual, how to get a character's raw s...
5fb2957 Improvements in the Emacs manual
de17b8e Tiny doc/misc markup fixes
34 files changed, 668 insertions, 618 deletions
diff --git a/doc/emacs/building.texi b/doc/emacs/building.texi index 549ccaf3ae7..8e2fdf11370 100644 --- a/doc/emacs/building.texi +++ b/doc/emacs/building.texi | |||
| @@ -302,7 +302,7 @@ And here's how to do it in csh: | |||
| 302 | if ($?prompt) set prompt = @dots{} | 302 | if ($?prompt) set prompt = @dots{} |
| 303 | @end example | 303 | @end example |
| 304 | 304 | ||
| 305 | @vindex TERM, environment variable, in compilation mode | 305 | @vindex TERM@r{, environment variable, in compilation mode} |
| 306 | If you want to customize the value of the @env{TERM} environment | 306 | If you want to customize the value of the @env{TERM} environment |
| 307 | variable passed to the compilation subshell, customize the variable | 307 | variable passed to the compilation subshell, customize the variable |
| 308 | @code{comint-terminfo-terminal} (@pxref{Shell Options}). | 308 | @code{comint-terminfo-terminal} (@pxref{Shell Options}). |
diff --git a/doc/emacs/calendar.texi b/doc/emacs/calendar.texi index be5af998e7e..c6a84b5ab12 100644 --- a/doc/emacs/calendar.texi +++ b/doc/emacs/calendar.texi | |||
| @@ -1507,7 +1507,8 @@ to the main diary file, if these are different files. | |||
| 1507 | @end ifnottex | 1507 | @end ifnottex |
| 1508 | 1508 | ||
| 1509 | 1509 | ||
| 1510 | @findex icalendar-export-file, icalendar-export-region | 1510 | @findex icalendar-export-file |
| 1511 | @findex icalendar-export-region | ||
| 1511 | Use @code{icalendar-export-file} to interactively export an entire | 1512 | Use @code{icalendar-export-file} to interactively export an entire |
| 1512 | Emacs diary file to iCalendar format. To export only a part of a diary | 1513 | Emacs diary file to iCalendar format. To export only a part of a diary |
| 1513 | file, mark the relevant area, and call @code{icalendar-export-region}. | 1514 | file, mark the relevant area, and call @code{icalendar-export-region}. |
diff --git a/doc/emacs/cmdargs.texi b/doc/emacs/cmdargs.texi index d18de8e7a02..733919a374a 100644 --- a/doc/emacs/cmdargs.texi +++ b/doc/emacs/cmdargs.texi | |||
| @@ -464,25 +464,25 @@ variables to be set, but it uses their values if they are set. | |||
| 464 | @c might be confused with general-purpose phrases. | 464 | @c might be confused with general-purpose phrases. |
| 465 | @table @env | 465 | @table @env |
| 466 | @item CDPATH | 466 | @item CDPATH |
| 467 | @vindex CDPATH, environment variable | 467 | @vindex CDPATH@r{, environment variable} |
| 468 | Used by the @code{cd} command to search for the directory you specify, | 468 | Used by the @code{cd} command to search for the directory you specify, |
| 469 | when you specify a relative directory, | 469 | when you specify a relative directory, |
| 470 | @item DBUS_SESSION_BUS_ADDRESS | 470 | @item DBUS_SESSION_BUS_ADDRESS |
| 471 | @vindex DBUS_SESSION_BUS_ADDRESS, environment variable | 471 | @vindex DBUS_SESSION_BUS_ADDRESS@r{, environment variable} |
| 472 | Used by D-Bus when Emacs is compiled with it. Usually, there is no | 472 | Used by D-Bus when Emacs is compiled with it. Usually, there is no |
| 473 | need to change it. Setting it to a dummy address, like | 473 | need to change it. Setting it to a dummy address, like |
| 474 | @samp{unix:path=/dev/null}, suppresses connections to the D-Bus session | 474 | @samp{unix:path=/dev/null}, suppresses connections to the D-Bus session |
| 475 | bus as well as autolaunching the D-Bus session bus if not running yet. | 475 | bus as well as autolaunching the D-Bus session bus if not running yet. |
| 476 | @item EMACSDATA | 476 | @item EMACSDATA |
| 477 | @vindex EMACSDATA, environment variable | 477 | @vindex EMACSDATA@r{, environment variable} |
| 478 | Directory for the architecture-independent files that come with Emacs. | 478 | Directory for the architecture-independent files that come with Emacs. |
| 479 | This is used to initialize the variable @code{data-directory}. | 479 | This is used to initialize the variable @code{data-directory}. |
| 480 | @item EMACSDOC | 480 | @item EMACSDOC |
| 481 | @vindex EMACSDOC, environment variable | 481 | @vindex EMACSDOC@r{, environment variable} |
| 482 | Directory for the documentation string file, which is used to | 482 | Directory for the documentation string file, which is used to |
| 483 | initialize the Lisp variable @code{doc-directory}. | 483 | initialize the Lisp variable @code{doc-directory}. |
| 484 | @item EMACSLOADPATH | 484 | @item EMACSLOADPATH |
| 485 | @vindex EMACSLOADPATH, environment variable | 485 | @vindex EMACSLOADPATH@r{, environment variable} |
| 486 | A colon-separated list of directories@footnote{Here and below, | 486 | A colon-separated list of directories@footnote{Here and below, |
| 487 | whenever we say ``colon-separated list of directories'', it pertains | 487 | whenever we say ``colon-separated list of directories'', it pertains |
| 488 | to Unix and GNU/Linux systems. On MS-DOS and MS-Windows, the | 488 | to Unix and GNU/Linux systems. On MS-DOS and MS-Windows, the |
| @@ -496,28 +496,28 @@ the default @code{load-path}. To specify an empty element in the | |||
| 496 | middle of the list, use 2 colons in a row, as in | 496 | middle of the list, use 2 colons in a row, as in |
| 497 | @samp{EMACSLOADPATH="/tmp::/foo"}. | 497 | @samp{EMACSLOADPATH="/tmp::/foo"}. |
| 498 | @item EMACSPATH | 498 | @item EMACSPATH |
| 499 | @vindex EMACSPATH, environment variable | 499 | @vindex EMACSPATH@r{, environment variable} |
| 500 | A colon-separated list of directories to search for executable files. | 500 | A colon-separated list of directories to search for executable files. |
| 501 | If set, Emacs uses this in addition to @env{PATH} (see below) when | 501 | If set, Emacs uses this in addition to @env{PATH} (see below) when |
| 502 | initializing the variable @code{exec-path} (@pxref{Shell}). | 502 | initializing the variable @code{exec-path} (@pxref{Shell}). |
| 503 | @item EMAIL | 503 | @item EMAIL |
| 504 | @vindex EMAIL, environment variable | 504 | @vindex EMAIL@r{, environment variable} |
| 505 | @vindex user-mail-address@r{, initialization} | 505 | @vindex user-mail-address@r{, initialization} |
| 506 | Your email address; used to initialize the Lisp variable | 506 | Your email address; used to initialize the Lisp variable |
| 507 | @code{user-mail-address}, which the Emacs mail interface puts into the | 507 | @code{user-mail-address}, which the Emacs mail interface puts into the |
| 508 | @samp{From} header of outgoing messages (@pxref{Mail Headers}). | 508 | @samp{From} header of outgoing messages (@pxref{Mail Headers}). |
| 509 | @item ESHELL | 509 | @item ESHELL |
| 510 | @vindex ESHELL, environment variable | 510 | @vindex ESHELL@r{, environment variable} |
| 511 | Used for shell-mode to override the @env{SHELL} environment variable | 511 | Used for shell-mode to override the @env{SHELL} environment variable |
| 512 | (@pxref{Interactive Shell}). | 512 | (@pxref{Interactive Shell}). |
| 513 | @item HISTFILE | 513 | @item HISTFILE |
| 514 | @vindex HISTFILE, environment variable | 514 | @vindex HISTFILE@r{, environment variable} |
| 515 | The name of the file that shell commands are saved in between logins. | 515 | The name of the file that shell commands are saved in between logins. |
| 516 | This variable defaults to @file{~/.bash_history} if you use Bash, to | 516 | This variable defaults to @file{~/.bash_history} if you use Bash, to |
| 517 | @file{~/.sh_history} if you use ksh, and to @file{~/.history} | 517 | @file{~/.sh_history} if you use ksh, and to @file{~/.history} |
| 518 | otherwise. | 518 | otherwise. |
| 519 | @item HOME | 519 | @item HOME |
| 520 | @vindex HOME, environment variable | 520 | @vindex HOME@r{, environment variable} |
| 521 | The location of your files in the directory tree; used for | 521 | The location of your files in the directory tree; used for |
| 522 | expansion of file names starting with a tilde (@file{~}). On MS-DOS, | 522 | expansion of file names starting with a tilde (@file{~}). On MS-DOS, |
| 523 | it defaults to the directory from which Emacs was started, with | 523 | it defaults to the directory from which Emacs was started, with |
| @@ -529,7 +529,7 @@ where @var{username} is your user name), though for backwards | |||
| 529 | compatibility @file{C:/} will be used instead if a @file{.emacs} file | 529 | compatibility @file{C:/} will be used instead if a @file{.emacs} file |
| 530 | is found there. | 530 | is found there. |
| 531 | @item HOSTNAME | 531 | @item HOSTNAME |
| 532 | @vindex HOSTNAME, environment variable | 532 | @vindex HOSTNAME@r{, environment variable} |
| 533 | The name of the machine that Emacs is running on. | 533 | The name of the machine that Emacs is running on. |
| 534 | @c complete.el is obsolete since 24.1. | 534 | @c complete.el is obsolete since 24.1. |
| 535 | @ignore | 535 | @ignore |
| @@ -538,24 +538,24 @@ A colon-separated list of directories. Used by the @code{complete} package | |||
| 538 | to search for files. | 538 | to search for files. |
| 539 | @end ignore | 539 | @end ignore |
| 540 | @item INFOPATH | 540 | @item INFOPATH |
| 541 | @vindex INFOPATH, environment variable | 541 | @vindex INFOPATH@r{, environment variable} |
| 542 | A colon-separated list of directories in which to search for Info files. | 542 | A colon-separated list of directories in which to search for Info files. |
| 543 | @item LC_ALL | 543 | @item LC_ALL |
| 544 | @vindex LC_ALL, environment variable | 544 | @vindex LC_ALL@r{, environment variable} |
| 545 | @itemx LC_COLLATE | 545 | @itemx LC_COLLATE |
| 546 | @vindex LC_COLLATE, environment variable | 546 | @vindex LC_COLLATE@r{, environment variable} |
| 547 | @itemx LC_CTYPE | 547 | @itemx LC_CTYPE |
| 548 | @vindex LC_CTYPE, environment variable | 548 | @vindex LC_CTYPE@r{, environment variable} |
| 549 | @itemx LC_MESSAGES | 549 | @itemx LC_MESSAGES |
| 550 | @vindex LC_MESSAGES, environment variable | 550 | @vindex LC_MESSAGES@r{, environment variable} |
| 551 | @itemx LC_MONETARY | 551 | @itemx LC_MONETARY |
| 552 | @vindex LC_MONETARY, environment variable | 552 | @vindex LC_MONETARY@r{, environment variable} |
| 553 | @itemx LC_NUMERIC | 553 | @itemx LC_NUMERIC |
| 554 | @vindex LC_NUMERIC, environment variable | 554 | @vindex LC_NUMERIC@r{, environment variable} |
| 555 | @itemx LC_TIME | 555 | @itemx LC_TIME |
| 556 | @vindex LC_TIME, environment variable | 556 | @vindex LC_TIME@r{, environment variable} |
| 557 | @itemx LANG | 557 | @itemx LANG |
| 558 | @vindex LANG, environment variable | 558 | @vindex LANG@r{, environment variable} |
| 559 | The user's preferred locale. The locale has six categories, specified | 559 | The user's preferred locale. The locale has six categories, specified |
| 560 | by the environment variables @env{LC_COLLATE} for sorting, | 560 | by the environment variables @env{LC_COLLATE} for sorting, |
| 561 | @env{LC_CTYPE} for character encoding, @env{LC_MESSAGES} for system | 561 | @env{LC_CTYPE} for character encoding, @env{LC_MESSAGES} for system |
| @@ -578,70 +578,70 @@ matched against entries in @code{locale-language-names}, | |||
| 578 | @code{locale-preferred-coding-systems}, to select a default language | 578 | @code{locale-preferred-coding-systems}, to select a default language |
| 579 | environment and coding system. @xref{Language Environments}. | 579 | environment and coding system. @xref{Language Environments}. |
| 580 | @item LOGNAME | 580 | @item LOGNAME |
| 581 | @vindex LOGNAME, environment variable | 581 | @vindex LOGNAME@r{, environment variable} |
| 582 | The user's login name. See also @env{USER}. | 582 | The user's login name. See also @env{USER}. |
| 583 | @item MAIL | 583 | @item MAIL |
| 584 | @vindex MAIL, environment variable | 584 | @vindex MAIL@r{, environment variable} |
| 585 | The name of your system mail inbox. | 585 | The name of your system mail inbox. |
| 586 | @ifnottex | 586 | @ifnottex |
| 587 | @item MH | 587 | @item MH |
| 588 | @vindex MH, environment variable | 588 | @vindex MH@r{, environment variable} |
| 589 | Name of setup file for the mh system. @xref{Top,,MH-E,mh-e, The Emacs | 589 | Name of setup file for the mh system. @xref{Top,,MH-E,mh-e, The Emacs |
| 590 | Interface to MH}. | 590 | Interface to MH}. |
| 591 | @end ifnottex | 591 | @end ifnottex |
| 592 | @item NAME | 592 | @item NAME |
| 593 | @vindex NAME, environment variable | 593 | @vindex NAME@r{, environment variable} |
| 594 | Your real-world name. This is used to initialize the variable | 594 | Your real-world name. This is used to initialize the variable |
| 595 | @code{user-full-name} (@pxref{Mail Headers}). | 595 | @code{user-full-name} (@pxref{Mail Headers}). |
| 596 | @item NNTPSERVER | 596 | @item NNTPSERVER |
| 597 | @vindex NNTPSERVER, environment variable | 597 | @vindex NNTPSERVER@r{, environment variable} |
| 598 | The name of the news server. Used by the mh and Gnus packages. | 598 | The name of the news server. Used by the mh and Gnus packages. |
| 599 | @item ORGANIZATION | 599 | @item ORGANIZATION |
| 600 | @vindex ORGANIZATION, environment variable | 600 | @vindex ORGANIZATION@r{, environment variable} |
| 601 | The name of the organization to which you belong. Used for setting the | 601 | The name of the organization to which you belong. Used for setting the |
| 602 | @samp{Organization:} header in your posts from the Gnus package. | 602 | @samp{Organization:} header in your posts from the Gnus package. |
| 603 | @item PATH | 603 | @item PATH |
| 604 | @vindex PATH, environment variable | 604 | @vindex PATH@r{, environment variable} |
| 605 | A colon-separated list of directories containing executable files. | 605 | A colon-separated list of directories containing executable files. |
| 606 | This is used to initialize the variable @code{exec-path} | 606 | This is used to initialize the variable @code{exec-path} |
| 607 | (@pxref{Shell}). | 607 | (@pxref{Shell}). |
| 608 | @item PWD | 608 | @item PWD |
| 609 | @vindex PWD, environment variable | 609 | @vindex PWD@r{, environment variable} |
| 610 | If set, this should be the default directory when Emacs was started. | 610 | If set, this should be the default directory when Emacs was started. |
| 611 | @item REPLYTO | 611 | @item REPLYTO |
| 612 | @vindex REPLYTO, environment variable | 612 | @vindex REPLYTO@r{, environment variable} |
| 613 | If set, this specifies an initial value for the variable | 613 | If set, this specifies an initial value for the variable |
| 614 | @code{mail-default-reply-to} (@pxref{Mail Headers}). | 614 | @code{mail-default-reply-to} (@pxref{Mail Headers}). |
| 615 | @item SAVEDIR | 615 | @item SAVEDIR |
| 616 | @vindex SAVEDIR, environment variable | 616 | @vindex SAVEDIR@r{, environment variable} |
| 617 | The name of a directory in which news articles are saved by default. | 617 | The name of a directory in which news articles are saved by default. |
| 618 | Used by the Gnus package. | 618 | Used by the Gnus package. |
| 619 | @item SHELL | 619 | @item SHELL |
| 620 | @vindex SHELL, environment variable | 620 | @vindex SHELL@r{, environment variable} |
| 621 | The name of an interpreter used to parse and execute programs run from | 621 | The name of an interpreter used to parse and execute programs run from |
| 622 | inside Emacs. | 622 | inside Emacs. |
| 623 | @item SMTPSERVER | 623 | @item SMTPSERVER |
| 624 | @vindex SMTPSERVER, environment variable | 624 | @vindex SMTPSERVER@r{, environment variable} |
| 625 | The name of the outgoing mail server. This is used to initialize the | 625 | The name of the outgoing mail server. This is used to initialize the |
| 626 | variable @code{smtpmail-smtp-server} (@pxref{Mail Sending}). | 626 | variable @code{smtpmail-smtp-server} (@pxref{Mail Sending}). |
| 627 | @cindex background mode, on @command{xterm} | 627 | @cindex background mode, on @command{xterm} |
| 628 | @item TERM | 628 | @item TERM |
| 629 | @vindex TERM, environment variable | 629 | @vindex TERM@r{, environment variable} |
| 630 | The type of the terminal that Emacs is using. This variable must be | 630 | The type of the terminal that Emacs is using. This variable must be |
| 631 | set unless Emacs is run in batch mode. On MS-DOS, it defaults to | 631 | set unless Emacs is run in batch mode. On MS-DOS, it defaults to |
| 632 | @samp{internal}, which specifies a built-in terminal emulation that | 632 | @samp{internal}, which specifies a built-in terminal emulation that |
| 633 | handles the machine's own display. | 633 | handles the machine's own display. |
| 634 | @item TERMCAP | 634 | @item TERMCAP |
| 635 | @vindex TERMCAP, environment variable | 635 | @vindex TERMCAP@r{, environment variable} |
| 636 | The name of the termcap library file describing how to program the | 636 | The name of the termcap library file describing how to program the |
| 637 | terminal specified by @env{TERM}. This defaults to | 637 | terminal specified by @env{TERM}. This defaults to |
| 638 | @file{/etc/termcap}. | 638 | @file{/etc/termcap}. |
| 639 | @item TMPDIR | 639 | @item TMPDIR |
| 640 | @vindex TMPDIR, environment variable | 640 | @vindex TMPDIR@r{, environment variable} |
| 641 | @itemx TMP | 641 | @itemx TMP |
| 642 | @vindex TMP, environment variable | 642 | @vindex TMP@r{, environment variable} |
| 643 | @itemx TEMP | 643 | @itemx TEMP |
| 644 | @vindex TEMP, environment variable | 644 | @vindex TEMP@r{, environment variable} |
| 645 | These environment variables are used to initialize the variable | 645 | These environment variables are used to initialize the variable |
| 646 | @code{temporary-file-directory}, which specifies a directory in which | 646 | @code{temporary-file-directory}, which specifies a directory in which |
| 647 | to put temporary files (@pxref{Backup}). Emacs tries to use | 647 | to put temporary files (@pxref{Backup}). Emacs tries to use |
| @@ -649,7 +649,7 @@ to put temporary files (@pxref{Backup}). Emacs tries to use | |||
| 649 | @file{/tmp}, but on MS-Windows and MS-DOS it instead falls back on | 649 | @file{/tmp}, but on MS-Windows and MS-DOS it instead falls back on |
| 650 | @env{TMP}, then @env{TEMP}, and finally @file{c:/temp}. | 650 | @env{TMP}, then @env{TEMP}, and finally @file{c:/temp}. |
| 651 | @item TZ | 651 | @item TZ |
| 652 | @vindex TZ, environment variable | 652 | @vindex TZ@r{, environment variable} |
| 653 | This specifies the default time zone and possibly also daylight | 653 | This specifies the default time zone and possibly also daylight |
| 654 | saving time information. @xref{Time Zone Rules,,, elisp, The GNU | 654 | saving time information. @xref{Time Zone Rules,,, elisp, The GNU |
| 655 | Emacs Lisp Reference Manual}. On MS-DOS, if @env{TZ} is not set in the | 655 | Emacs Lisp Reference Manual}. On MS-DOS, if @env{TZ} is not set in the |
| @@ -657,11 +657,11 @@ environment when Emacs starts, Emacs defines a default value as | |||
| 657 | appropriate for the country code returned by DOS@. On MS-Windows, Emacs | 657 | appropriate for the country code returned by DOS@. On MS-Windows, Emacs |
| 658 | does not use @env{TZ} at all. | 658 | does not use @env{TZ} at all. |
| 659 | @item USER | 659 | @item USER |
| 660 | @vindex USER, environment variable | 660 | @vindex USER@r{, environment variable} |
| 661 | The user's login name. See also @env{LOGNAME}. On MS-DOS, this | 661 | The user's login name. See also @env{LOGNAME}. On MS-DOS, this |
| 662 | defaults to @samp{root}. | 662 | defaults to @samp{root}. |
| 663 | @item VERSION_CONTROL | 663 | @item VERSION_CONTROL |
| 664 | @vindex VERSION_CONTROL, environment variable | 664 | @vindex VERSION_CONTROL@r{, environment variable} |
| 665 | Used to initialize the @code{version-control} variable (@pxref{Backup | 665 | Used to initialize the @code{version-control} variable (@pxref{Backup |
| 666 | Names}). | 666 | Names}). |
| 667 | @end table | 667 | @end table |
| @@ -913,7 +913,7 @@ colored display. | |||
| 913 | Turn on the color support unconditionally, and use color commands | 913 | Turn on the color support unconditionally, and use color commands |
| 914 | specified by the ANSI escape sequences for the 8 standard colors. | 914 | specified by the ANSI escape sequences for the 8 standard colors. |
| 915 | @item @var{num} | 915 | @item @var{num} |
| 916 | Use color mode for @var{num} colors. If @var{num} is -1, turn off | 916 | Use color mode for @var{num} colors. If @var{num} is @minus{}1, turn off |
| 917 | color support (equivalent to @samp{never}); if it is 0, use the | 917 | color support (equivalent to @samp{never}); if it is 0, use the |
| 918 | default color support for this terminal (equivalent to @samp{auto}); | 918 | default color support for this terminal (equivalent to @samp{auto}); |
| 919 | otherwise use an appropriate standard mode for @var{num} colors. | 919 | otherwise use an appropriate standard mode for @var{num} colors. |
diff --git a/doc/emacs/custom.texi b/doc/emacs/custom.texi index 3a66f216027..86e27b64243 100644 --- a/doc/emacs/custom.texi +++ b/doc/emacs/custom.texi | |||
| @@ -83,7 +83,7 @@ top-level @code{Emacs} group. It looks like this, in part: | |||
| 83 | @c @page | 83 | @c @page |
| 84 | @smallexample | 84 | @smallexample |
| 85 | @group | 85 | @group |
| 86 | For help, see [Easy Customization] in the [Emacs manual]. | 86 | For help using this buffer, see [Easy Customization] in the [Emacs manual]. |
| 87 | 87 | ||
| 88 | ________________________________________ [ Search ] | 88 | ________________________________________ [ Search ] |
| 89 | 89 | ||
| @@ -95,10 +95,10 @@ Emacs group: Customization of the One True Editor. | |||
| 95 | [State]: visible group members are all at standard values. | 95 | [State]: visible group members are all at standard values. |
| 96 | See also [Manual]. | 96 | See also [Manual]. |
| 97 | 97 | ||
| 98 | [Editing] : Basic text editing facilities. | 98 | [Editing] Basic text editing facilities. |
| 99 | [Convenience] : Convenience features for faster editing. | 99 | [Convenience] Convenience features for faster editing. |
| 100 | 100 | ||
| 101 | @var{more second-level groups} | 101 | @var{...more second-level groups...} |
| 102 | @end group | 102 | @end group |
| 103 | @end smallexample | 103 | @end smallexample |
| 104 | 104 | ||
| @@ -119,7 +119,7 @@ has been edited, set, or saved. @xref{Changing a Variable}. | |||
| 119 | the customization buffer is an editable field for searching for | 119 | the customization buffer is an editable field for searching for |
| 120 | settings (@pxref{Browsing Custom}). There are also @dfn{buttons} and | 120 | settings (@pxref{Browsing Custom}). There are also @dfn{buttons} and |
| 121 | @dfn{links}, which you can activate by either clicking with the mouse, | 121 | @dfn{links}, which you can activate by either clicking with the mouse, |
| 122 | or moving point there and typing @key{RET}. For example, the group | 122 | or moving point there and typing @kbd{@key{RET}}. For example, the group |
| 123 | names like @samp{[Editing]} are links; activating one of these links | 123 | names like @samp{[Editing]} are links; activating one of these links |
| 124 | brings up the customization buffer for that group. | 124 | brings up the customization buffer for that group. |
| 125 | 125 | ||
| @@ -127,7 +127,7 @@ brings up the customization buffer for that group. | |||
| 127 | @kindex S-TAB @r{(customization buffer)} | 127 | @kindex S-TAB @r{(customization buffer)} |
| 128 | @findex widget-forward | 128 | @findex widget-forward |
| 129 | @findex widget-backward | 129 | @findex widget-backward |
| 130 | In the customization buffer, you can type @key{TAB} | 130 | In the customization buffer, you can type @kbd{@key{TAB}} |
| 131 | (@code{widget-forward}) to move forward to the next button or editable | 131 | (@code{widget-forward}) to move forward to the next button or editable |
| 132 | field. @kbd{S-@key{TAB}} (@code{widget-backward}) moves back to the | 132 | field. @kbd{S-@key{TAB}} (@code{widget-backward}) moves back to the |
| 133 | previous button or editable field. | 133 | previous button or editable field. |
| @@ -146,16 +146,16 @@ settings that you want to customize. | |||
| 146 | 146 | ||
| 147 | If you are interested in customizing a particular setting or | 147 | If you are interested in customizing a particular setting or |
| 148 | customization group, you can go straight there with the commands | 148 | customization group, you can go straight there with the commands |
| 149 | @kbd{M-x customize-option}, @kbd{M-x customize-face}, or @kbd{M-x | 149 | @kbd{M-x customize-option}, @kbd{M-x customize-face}, or @w{@kbd{M-x |
| 150 | customize-group}. @xref{Specific Customization}. | 150 | customize-group}}. @xref{Specific Customization}. |
| 151 | 151 | ||
| 152 | @vindex custom-search-field | 152 | @vindex custom-search-field |
| 153 | If you don't know exactly what groups or settings you want to | 153 | If you don't know exactly what groups or settings you want to |
| 154 | customize, you can search for them using the editable search field at | 154 | customize, you can search for them using the editable search field at |
| 155 | the top of each customization buffer. Here, you can type in a search | 155 | the top of each customization buffer. Here, you can type in a search |
| 156 | term---either one or more words separated by spaces, or a regular | 156 | term---either one or more words separated by spaces, or a regular |
| 157 | expression (@pxref{Regexps}). Then type @key{RET} in the field, or | 157 | expression (@pxref{Regexps}). Then type @kbd{@key{RET}} in the field, |
| 158 | activate the @samp{Search} button next to it, to switch to a | 158 | or activate the @samp{Search} button next to it, to switch to a |
| 159 | customization buffer containing groups and settings that match those | 159 | customization buffer containing groups and settings that match those |
| 160 | terms. Note, however, that this feature only finds groups and | 160 | terms. Note, however, that this feature only finds groups and |
| 161 | settings that are loaded in the current Emacs session. | 161 | settings that are loaded in the current Emacs session. |
| @@ -252,11 +252,11 @@ names, and Emacs command names, you can perform completion with | |||
| 252 | @kbd{M-@key{TAB}} or @kbd{@key{ESC} @key{TAB}}. This behaves much | 252 | @kbd{M-@key{TAB}} or @kbd{@key{ESC} @key{TAB}}. This behaves much |
| 253 | like minibuffer completion (@pxref{Completion}). | 253 | like minibuffer completion (@pxref{Completion}). |
| 254 | 254 | ||
| 255 | Typing @key{RET} on an editable value field moves point forward to | 255 | Typing @kbd{@key{RET}} on an editable value field moves point |
| 256 | the next field or button, like @key{TAB}. You can thus type @key{RET} | 256 | forward to the next field or button, like @kbd{@key{TAB}}. You can |
| 257 | when you are finished editing a field, to move on to the next button | 257 | thus type @kbd{@key{RET}} when you are finished editing a field, to |
| 258 | or field. To insert a newline within an editable field, use @kbd{C-o} | 258 | move on to the next button or field. To insert a newline within an |
| 259 | or @kbd{C-q C-j}. | 259 | editable field, use @kbd{C-o} or @kbd{C-q C-j}. |
| 260 | 260 | ||
| 261 | For some variables, there is only a fixed set of legitimate values, | 261 | For some variables, there is only a fixed set of legitimate values, |
| 262 | and you are not allowed to edit the value directly. Instead, a | 262 | and you are not allowed to edit the value directly. Instead, a |
| @@ -306,9 +306,10 @@ operation. There are actually four reset operations: | |||
| 306 | If you have modified but not yet set the variable, this restores the | 306 | If you have modified but not yet set the variable, this restores the |
| 307 | text in the customization buffer to match the actual value. | 307 | text in the customization buffer to match the actual value. |
| 308 | 308 | ||
| 309 | @item Reset to Saved | 309 | @item Revert This Session's Customizations |
| 310 | This restores the value of the variable to the last saved value, | 310 | This restores the value of the variable to the last saved value, if |
| 311 | and updates the text accordingly. | 311 | there was one. Otherwise it restores the standard value. It updates |
| 312 | the text accordingly. | ||
| 312 | 313 | ||
| 313 | @item Erase Customization | 314 | @item Erase Customization |
| 314 | This sets the variable to its standard value. Any saved value that | 315 | This sets the variable to its standard value. Any saved value that |
| @@ -329,15 +330,17 @@ customization. Use the @samp{Add Comment} item from the | |||
| 329 | Near the top of the customization buffer are two lines of buttons: | 330 | Near the top of the customization buffer are two lines of buttons: |
| 330 | 331 | ||
| 331 | @smallexample | 332 | @smallexample |
| 332 | [Set for Current Session] [Save for Future Sessions] | 333 | Operate on all settings in this buffer: |
| 333 | [Undo Edits] [Reset to Saved] [Erase Customization] [Exit] | 334 | [Revert...] [Apply] [Apply and Save] |
| 334 | @end smallexample | 335 | @end smallexample |
| 335 | 336 | ||
| 336 | @noindent | 337 | @noindent |
| 337 | Each of the first five buttons performs the stated operation---set, | 338 | The @samp{[Revert...]} button drops a menu with the first 3 reset |
| 338 | save, reset, etc.---on all the settings in the buffer that could | 339 | operations described above. The @samp{[Apply]} button applies the |
| 339 | meaningfully be affected. They do not operate on settings that are | 340 | settings for the current session. The @samp{[Apply and Save]} button |
| 340 | hidden, nor on subgroups that are hidden or not visible in the buffer. | 341 | applies the settings and saves them for future sessions; this button |
| 342 | does not appear if Emacs was started with the @option{-q} or | ||
| 343 | @option{-Q} option (@pxref{Initial Options}). | ||
| 341 | 344 | ||
| 342 | @kindex C-c C-c @r{(customization buffer)} | 345 | @kindex C-c C-c @r{(customization buffer)} |
| 343 | @kindex C-x C-c @r{(customization buffer)} | 346 | @kindex C-x C-c @r{(customization buffer)} |
| @@ -360,8 +363,8 @@ kill the customization buffer instead, change the variable | |||
| 360 | In the customization buffer, you can @dfn{save} a customization | 363 | In the customization buffer, you can @dfn{save} a customization |
| 361 | setting by choosing the @samp{Save for Future Sessions} choice from | 364 | setting by choosing the @samp{Save for Future Sessions} choice from |
| 362 | its @samp{[State]} button. The @kbd{C-x C-s} (@code{Custom-save}) | 365 | its @samp{[State]} button. The @kbd{C-x C-s} (@code{Custom-save}) |
| 363 | command, or the @samp{[Save for Future Sessions]} button at the top of | 366 | command, or the @samp{[Apply and Save]} button at the top of the |
| 364 | the customization buffer, saves all applicable settings in the buffer. | 367 | customization buffer, saves all applicable settings in the buffer. |
| 365 | 368 | ||
| 366 | Saving works by writing code to a file, usually your initialization | 369 | Saving works by writing code to a file, usually your initialization |
| 367 | file (@pxref{Init File}). Future Emacs sessions automatically read | 370 | file (@pxref{Init File}). Future Emacs sessions automatically read |
| @@ -427,7 +430,8 @@ both variables and faces. | |||
| 427 | 430 | ||
| 428 | For example, in programming language modes, source code comments are | 431 | For example, in programming language modes, source code comments are |
| 429 | shown with @code{font-lock-comment-face} (@pxref{Font Lock}). In a | 432 | shown with @code{font-lock-comment-face} (@pxref{Font Lock}). In a |
| 430 | customization buffer, that face appears like this: | 433 | customization buffer, that face appears like this, after you click on |
| 434 | the @samp{[Show All Attributes]} link: | ||
| 431 | 435 | ||
| 432 | @smallexample | 436 | @smallexample |
| 433 | [Hide] Font Lock Comment Face:[sample] | 437 | [Hide] Font Lock Comment Face:[sample] |
| @@ -469,7 +473,7 @@ Any unspecified attribute is taken from the special face named | |||
| 469 | have an explicitly-assigned face; furthermore, its background color | 473 | have an explicitly-assigned face; furthermore, its background color |
| 470 | attribute serves as the background color of the frame. | 474 | attribute serves as the background color of the frame. |
| 471 | 475 | ||
| 472 | The @samp{Hide Unused Attributes} button, at the end of the | 476 | The @samp{[Hide Unused Attributes]} button, at the end of the |
| 473 | attribute list, hides the unspecified attributes of the face. When | 477 | attribute list, hides the unspecified attributes of the face. When |
| 474 | attributes are being hidden, the button changes to @samp{[Show All | 478 | attributes are being hidden, the button changes to @samp{[Show All |
| 475 | Attributes]}, which reveals the entire attribute list. The | 479 | Attributes]}, which reveals the entire attribute list. The |
| @@ -482,8 +486,8 @@ usual ways. | |||
| 482 | Foreground and background colors can be specified using either color | 486 | Foreground and background colors can be specified using either color |
| 483 | names or RGB triplets (@pxref{Colors}). You can also use the | 487 | names or RGB triplets (@pxref{Colors}). You can also use the |
| 484 | @samp{[Choose]} button to switch to a list of color names; select a | 488 | @samp{[Choose]} button to switch to a list of color names; select a |
| 485 | color with @key{RET} in that buffer to put the color name in the value | 489 | color with @kbd{@key{RET}} in that buffer to put the color name in the |
| 486 | field. | 490 | value field. |
| 487 | 491 | ||
| 488 | Setting, saving and resetting a face work like the same operations for | 492 | Setting, saving and resetting a face work like the same operations for |
| 489 | variables (@pxref{Changing a Variable}). | 493 | variables (@pxref{Changing a Variable}). |
| @@ -501,19 +505,29 @@ menu you get from invoking @samp{[State]}. | |||
| 501 | @item M-x customize-option @key{RET} @var{option} @key{RET} | 505 | @item M-x customize-option @key{RET} @var{option} @key{RET} |
| 502 | @itemx M-x customize-variable @key{RET} @var{option} @key{RET} | 506 | @itemx M-x customize-variable @key{RET} @var{option} @key{RET} |
| 503 | Set up a customization buffer for just one user option, @var{option}. | 507 | Set up a customization buffer for just one user option, @var{option}. |
| 508 | |||
| 504 | @item M-x customize-face @key{RET} @var{face} @key{RET} | 509 | @item M-x customize-face @key{RET} @var{face} @key{RET} |
| 505 | Set up a customization buffer for just one face, @var{face}. | 510 | Set up a customization buffer for just one face, @var{face}. |
| 511 | |||
| 506 | @item M-x customize-group @key{RET} @var{group} @key{RET} | 512 | @item M-x customize-group @key{RET} @var{group} @key{RET} |
| 507 | Set up a customization buffer for just one group, @var{group}. | 513 | Set up a customization buffer for just one group, @var{group}. |
| 514 | |||
| 508 | @item M-x customize-apropos @key{RET} @var{regexp} @key{RET} | 515 | @item M-x customize-apropos @key{RET} @var{regexp} @key{RET} |
| 509 | Set up a customization buffer for all the settings and groups that | 516 | Set up a customization buffer for all the settings and groups that |
| 510 | match @var{regexp}. | 517 | match @var{regexp}. |
| 518 | |||
| 511 | @item M-x customize-changed @key{RET} @var{version} @key{RET} | 519 | @item M-x customize-changed @key{RET} @var{version} @key{RET} |
| 512 | Set up a customization buffer with all the settings and groups | 520 | Set up a customization buffer with all the settings and groups |
| 513 | whose meaning has changed since Emacs version @var{version}. | 521 | whose meaning has changed since Emacs version @var{version}. |
| 522 | |||
| 523 | @item M-x customize-changed-options @key{RET} @var{version} @key{RET} | ||
| 524 | Set up a customization buffer with all the options whose meaning or | ||
| 525 | default values have changed since Emacs version @var{version}. | ||
| 526 | |||
| 514 | @item M-x customize-saved | 527 | @item M-x customize-saved |
| 515 | Set up a customization buffer containing all settings that you | 528 | Set up a customization buffer containing all settings that you |
| 516 | have saved with customization buffers. | 529 | have saved with customization buffers. |
| 530 | |||
| 517 | @item M-x customize-unsaved | 531 | @item M-x customize-unsaved |
| 518 | Set up a customization buffer containing all settings that you have | 532 | Set up a customization buffer containing all settings that you have |
| 519 | set but not saved. | 533 | set but not saved. |
| @@ -759,6 +773,7 @@ expects (@pxref{Examining}). | |||
| 759 | @item C-h v @var{var} @key{RET} | 773 | @item C-h v @var{var} @key{RET} |
| 760 | Display the value and documentation of variable @var{var} | 774 | Display the value and documentation of variable @var{var} |
| 761 | (@code{describe-variable}). | 775 | (@code{describe-variable}). |
| 776 | |||
| 762 | @item M-x set-variable @key{RET} @var{var} @key{RET} @var{value} @key{RET} | 777 | @item M-x set-variable @key{RET} @var{var} @key{RET} @var{value} @key{RET} |
| 763 | Change the value of variable @var{var} to @var{value}. | 778 | Change the value of variable @var{var} to @var{value}. |
| 764 | @end table | 779 | @end table |
| @@ -951,8 +966,10 @@ be run as well. | |||
| 951 | @table @kbd | 966 | @table @kbd |
| 952 | @item M-x make-local-variable @key{RET} @var{var} @key{RET} | 967 | @item M-x make-local-variable @key{RET} @var{var} @key{RET} |
| 953 | Make variable @var{var} have a local value in the current buffer. | 968 | Make variable @var{var} have a local value in the current buffer. |
| 969 | |||
| 954 | @item M-x kill-local-variable @key{RET} @var{var} @key{RET} | 970 | @item M-x kill-local-variable @key{RET} @var{var} @key{RET} |
| 955 | Make variable @var{var} use its global value in the current buffer. | 971 | Make variable @var{var} use its global value in the current buffer. |
| 972 | |||
| 956 | @item M-x make-variable-buffer-local @key{RET} @var{var} @key{RET} | 973 | @item M-x make-variable-buffer-local @key{RET} @var{var} @key{RET} |
| 957 | Mark variable @var{var} so that setting it will make it local to the | 974 | Mark variable @var{var} so that setting it will make it local to the |
| 958 | buffer that is current at that time. | 975 | buffer that is current at that time. |
| @@ -1200,7 +1217,7 @@ keyword with a Lisp expression that runs the mode command | |||
| 1200 | list enables Eldoc mode (@pxref{Lisp Doc}) by calling | 1217 | list enables Eldoc mode (@pxref{Lisp Doc}) by calling |
| 1201 | @code{eldoc-mode} with no argument (calling it with an argument of 1 | 1218 | @code{eldoc-mode} with no argument (calling it with an argument of 1 |
| 1202 | would do the same), and disables Font Lock mode (@pxref{Font Lock}) by | 1219 | would do the same), and disables Font Lock mode (@pxref{Font Lock}) by |
| 1203 | calling @code{font-lock-mode} with an argument of -1. | 1220 | calling @code{font-lock-mode} with an argument of @minus{}1. |
| 1204 | 1221 | ||
| 1205 | @example | 1222 | @example |
| 1206 | ;; Local Variables: | 1223 | ;; Local Variables: |
diff --git a/doc/emacs/mini.texi b/doc/emacs/mini.texi index 03e371f4999..579697f47bd 100644 --- a/doc/emacs/mini.texi +++ b/doc/emacs/mini.texi | |||
| @@ -464,12 +464,14 @@ Lisp symbol). The default completion styles are (in order): | |||
| 464 | 464 | ||
| 465 | @table @code | 465 | @table @code |
| 466 | @item basic | 466 | @item basic |
| 467 | @cindex @code{basic}, completion style | ||
| 467 | A matching completion alternative must have the same beginning as the | 468 | A matching completion alternative must have the same beginning as the |
| 468 | text in the minibuffer before point. Furthermore, if there is any | 469 | text in the minibuffer before point. Furthermore, if there is any |
| 469 | text in the minibuffer after point, the rest of the completion | 470 | text in the minibuffer after point, the rest of the completion |
| 470 | alternative must contain that text as a substring. | 471 | alternative must contain that text as a substring. |
| 471 | 472 | ||
| 472 | @findex partial completion | 473 | @cindex partial completion |
| 474 | @cindex @code{partial-completion}, completion style | ||
| 473 | @item partial-completion | 475 | @item partial-completion |
| 474 | This aggressive completion style divides the minibuffer text into | 476 | This aggressive completion style divides the minibuffer text into |
| 475 | words separated by hyphens or spaces, and completes each word | 477 | words separated by hyphens or spaces, and completes each word |
| @@ -481,6 +483,7 @@ Furthermore, a @samp{*} in the minibuffer text is treated as a | |||
| 481 | corresponding position in the completion alternative. | 483 | corresponding position in the completion alternative. |
| 482 | 484 | ||
| 483 | @item emacs22 | 485 | @item emacs22 |
| 486 | @cindex @code{emacs22}, completion style | ||
| 484 | This completion style is similar to @code{basic}, except that it | 487 | This completion style is similar to @code{basic}, except that it |
| 485 | ignores the text in the minibuffer after point. It is so-named | 488 | ignores the text in the minibuffer after point. It is so-named |
| 486 | because it corresponds to the completion behavior in Emacs 22. | 489 | because it corresponds to the completion behavior in Emacs 22. |
| @@ -493,6 +496,7 @@ can add them to @code{completion-styles} if you wish | |||
| 493 | 496 | ||
| 494 | @table @code | 497 | @table @code |
| 495 | @item substring | 498 | @item substring |
| 499 | @cindex @code{substring}, completion style | ||
| 496 | A matching completion alternative must contain the text in the | 500 | A matching completion alternative must contain the text in the |
| 497 | minibuffer before point, and the text in the minibuffer after point, | 501 | minibuffer before point, and the text in the minibuffer after point, |
| 498 | as substrings (in that same order). | 502 | as substrings (in that same order). |
| @@ -503,6 +507,7 @@ between @samp{foo} and @samp{bar}, that matches | |||
| 503 | @var{c} can be any string including the empty string. | 507 | @var{c} can be any string including the empty string. |
| 504 | 508 | ||
| 505 | @item initials | 509 | @item initials |
| 510 | @cindex @code{initials}, completion style | ||
| 506 | This very aggressive completion style attempts to complete acronyms | 511 | This very aggressive completion style attempts to complete acronyms |
| 507 | and initialisms. For example, when completing command names, it | 512 | and initialisms. For example, when completing command names, it |
| 508 | matches @samp{lch} to @samp{list-command-history}. | 513 | matches @samp{lch} to @samp{list-command-history}. |
diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi index 9610ed4dd89..d8f202f6845 100644 --- a/doc/emacs/misc.texi +++ b/doc/emacs/misc.texi | |||
| @@ -1359,7 +1359,7 @@ directory stack if they are not already on it | |||
| 1359 | underlying shell, of course. | 1359 | underlying shell, of course. |
| 1360 | 1360 | ||
| 1361 | @vindex comint-terminfo-terminal | 1361 | @vindex comint-terminfo-terminal |
| 1362 | @vindex TERM, environment variable, in sub-shell | 1362 | @vindex TERM@r{, environment variable, in sub-shell} |
| 1363 | Comint mode sets the @env{TERM} environment variable to a safe default | 1363 | Comint mode sets the @env{TERM} environment variable to a safe default |
| 1364 | value, but this value disables some useful features. For example, | 1364 | value, but this value disables some useful features. For example, |
| 1365 | color is disabled in applications that use @env{TERM} to determine if | 1365 | color is disabled in applications that use @env{TERM} to determine if |
diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi index 330497c4ea9..9712cc73de0 100644 --- a/doc/emacs/trouble.texi +++ b/doc/emacs/trouble.texi | |||
| @@ -779,7 +779,7 @@ the dribble file. | |||
| 779 | @item | 779 | @item |
| 780 | @findex open-termscript | 780 | @findex open-termscript |
| 781 | @cindex termscript file | 781 | @cindex termscript file |
| 782 | @vindex TERM, environment variable, and display bugs | 782 | @vindex TERM@r{, environment variable, and display bugs} |
| 783 | For possible display bugs, the terminal type (the value of environment | 783 | For possible display bugs, the terminal type (the value of environment |
| 784 | variable @env{TERM}), the complete termcap entry for the terminal from | 784 | variable @env{TERM}), the complete termcap entry for the terminal from |
| 785 | @file{/etc/termcap} (since that file is not identical on all machines), | 785 | @file{/etc/termcap} (since that file is not identical on all machines), |
diff --git a/doc/emacs/windows.texi b/doc/emacs/windows.texi index 9f3b1b6a079..7dbd680b9b2 100644 --- a/doc/emacs/windows.texi +++ b/doc/emacs/windows.texi | |||
| @@ -379,7 +379,7 @@ Several of these commands are bound in the @kbd{C-x 5} prefix key. | |||
| 379 | 379 | ||
| 380 | @node Window Choice | 380 | @node Window Choice |
| 381 | @subsection How @code{display-buffer} works | 381 | @subsection How @code{display-buffer} works |
| 382 | @findex display-buffer, detailed description | 382 | @findex display-buffer@r{, detailed description} |
| 383 | 383 | ||
| 384 | The @code{display-buffer} command (as well as commands that call it | 384 | The @code{display-buffer} command (as well as commands that call it |
| 385 | internally) chooses a window to display by following the steps given | 385 | internally) chooses a window to display by following the steps given |
diff --git a/doc/emacs/xresources.texi b/doc/emacs/xresources.texi index ee59551a6a6..a0de3134db7 100644 --- a/doc/emacs/xresources.texi +++ b/doc/emacs/xresources.texi | |||
| @@ -216,6 +216,14 @@ Width of the internal frame border, in pixels. | |||
| 216 | @cindex line spacing | 216 | @cindex line spacing |
| 217 | Additional space between lines, in pixels. | 217 | Additional space between lines, in pixels. |
| 218 | 218 | ||
| 219 | @ifnottex | ||
| 220 | @item @code{menuBackground} (class @code{Background}) | ||
| 221 | @cindex background for menus | ||
| 222 | The background color of the menus in non-toolkit versions of Emacs. | ||
| 223 | (For toolkit versions, see @ref{Lucid Resources}, also see @ref{Motif | ||
| 224 | Resources}, and see @ref{GTK Resources}.) | ||
| 225 | @end ifnottex | ||
| 226 | |||
| 219 | @item @code{menuBar} (class @code{MenuBar}) | 227 | @item @code{menuBar} (class @code{MenuBar}) |
| 220 | @cindex menu bar (X resource) | 228 | @cindex menu bar (X resource) |
| 221 | If the value of this resource is @samp{off} or @samp{false} or | 229 | If the value of this resource is @samp{off} or @samp{false} or |
| @@ -229,6 +237,14 @@ will use a separate minibuffer frame instead. | |||
| 229 | @item @code{paneFont} (class @code{Font}) | 237 | @item @code{paneFont} (class @code{Font}) |
| 230 | @cindex font for menus | 238 | @cindex font for menus |
| 231 | Font name for menu pane titles, in non-toolkit versions of Emacs. | 239 | Font name for menu pane titles, in non-toolkit versions of Emacs. |
| 240 | (For toolkit versions, see @ref{Lucid Resources}, also see @ref{Motif | ||
| 241 | Resources}, and see @ref{GTK Resources}.) | ||
| 242 | |||
| 243 | @item @code{paneForeground} (class @code{Foreground}) | ||
| 244 | @cindex foreground for menus | ||
| 245 | Foreground color for menu pane titles, in non-toolkit versions of | ||
| 246 | Emacs. (For toolkit versions, see @ref{Lucid Resources}, also see | ||
| 247 | @ref{Motif Resources}, and see @ref{GTK Resources}.) | ||
| 232 | @end ifnottex | 248 | @end ifnottex |
| 233 | 249 | ||
| 234 | @item @code{pointerColor} (class @code{Foreground}) | 250 | @item @code{pointerColor} (class @code{Foreground}) |
| @@ -266,7 +282,12 @@ compiled with GTK+ support. | |||
| 266 | @item @code{selectionFont} (class @code{SelectionFont}) | 282 | @item @code{selectionFont} (class @code{SelectionFont}) |
| 267 | Font name for pop-up menu items, in non-toolkit versions of Emacs. (For | 283 | Font name for pop-up menu items, in non-toolkit versions of Emacs. (For |
| 268 | toolkit versions, see @ref{Lucid Resources}, also see @ref{Motif | 284 | toolkit versions, see @ref{Lucid Resources}, also see @ref{Motif |
| 269 | Resources}.) | 285 | Resources}, and see @ref{GTK Resources}.) |
| 286 | |||
| 287 | @item @code{selectionForeground} (class @code{SelectionForeground}) | ||
| 288 | Foreground color for pop-up menu items, in non-toolkit versions of | ||
| 289 | Emacs. (For toolkit versions, see @ref{Lucid Resources}, also see | ||
| 290 | @ref{Motif Resources}, and see @ref{GTK Resources}.) | ||
| 270 | 291 | ||
| 271 | @item @code{selectionTimeout} (class @code{SelectionTimeout}) | 292 | @item @code{selectionTimeout} (class @code{SelectionTimeout}) |
| 272 | Number of milliseconds to wait for a selection reply. | 293 | Number of milliseconds to wait for a selection reply. |
diff --git a/doc/lispintro/emacs-lisp-intro.texi b/doc/lispintro/emacs-lisp-intro.texi index 137ccfe4a98..16216bb774c 100644 --- a/doc/lispintro/emacs-lisp-intro.texi +++ b/doc/lispintro/emacs-lisp-intro.texi | |||
| @@ -1716,7 +1716,7 @@ function definition, and vice versa. | |||
| 1716 | @unnumberedsubsec @code{fill-column}, an Example Variable | 1716 | @unnumberedsubsec @code{fill-column}, an Example Variable |
| 1717 | @end ifnottex | 1717 | @end ifnottex |
| 1718 | 1718 | ||
| 1719 | @findex fill-column, @r{an example variable} | 1719 | @findex fill-column@r{, an example variable} |
| 1720 | @cindex Example variable, @code{fill-column} | 1720 | @cindex Example variable, @code{fill-column} |
| 1721 | @cindex Variable, example of, @code{fill-column} | 1721 | @cindex Variable, example of, @code{fill-column} |
| 1722 | The variable @code{fill-column} illustrates a symbol with a value | 1722 | The variable @code{fill-column} illustrates a symbol with a value |
| @@ -3839,7 +3839,7 @@ message @samp{5 is greater than 4!} will be printed. | |||
| 3839 | @noindent | 3839 | @noindent |
| 3840 | (The function @code{>} tests whether its first argument is greater than | 3840 | (The function @code{>} tests whether its first argument is greater than |
| 3841 | its second argument and returns true if it is.) | 3841 | its second argument and returns true if it is.) |
| 3842 | @findex > (greater than) | 3842 | @findex > @r{(greater than)} |
| 3843 | 3843 | ||
| 3844 | Of course, in actual use, the test in an @code{if} expression will not | 3844 | Of course, in actual use, the test in an @code{if} expression will not |
| 3845 | be fixed for all time as it is by the expression @code{(> 5 4)}. | 3845 | be fixed for all time as it is by the expression @code{(> 5 4)}. |
| @@ -4552,7 +4552,7 @@ buffers. Later, we will study other functions. | |||
| 4552 | @node Finding More | 4552 | @node Finding More |
| 4553 | @section Finding More Information | 4553 | @section Finding More Information |
| 4554 | 4554 | ||
| 4555 | @findex describe-function, @r{introduced} | 4555 | @findex describe-function@r{, introduced} |
| 4556 | @cindex Find function documentation | 4556 | @cindex Find function documentation |
| 4557 | In this walk-through, I will describe each new function as we come to | 4557 | In this walk-through, I will describe each new function as we come to |
| 4558 | it, sometimes in detail and sometimes briefly. If you are interested, | 4558 | it, sometimes in detail and sometimes briefly. If you are interested, |
| @@ -5564,7 +5564,7 @@ outline of the function: | |||
| 5564 | 5564 | ||
| 5565 | @node insert-buffer interactive | 5565 | @node insert-buffer interactive |
| 5566 | @subsection The Interactive Expression in @code{insert-buffer} | 5566 | @subsection The Interactive Expression in @code{insert-buffer} |
| 5567 | @findex interactive, @r{example use of} | 5567 | @findex interactive@r{, example use of} |
| 5568 | 5568 | ||
| 5569 | In @code{insert-buffer}, the argument to the @code{interactive} | 5569 | In @code{insert-buffer}, the argument to the @code{interactive} |
| 5570 | declaration has two parts, an asterisk, @samp{*}, and @samp{bInsert | 5570 | declaration has two parts, an asterisk, @samp{*}, and @samp{bInsert |
| @@ -5881,8 +5881,8 @@ find and use again and again. | |||
| 5881 | 5881 | ||
| 5882 | @node New insert-buffer | 5882 | @node New insert-buffer |
| 5883 | @subsection New Body for @code{insert-buffer} | 5883 | @subsection New Body for @code{insert-buffer} |
| 5884 | @findex insert-buffer, new version body | 5884 | @findex insert-buffer@r{, new version body} |
| 5885 | @findex new version body for insert-buffer | 5885 | @cindex new version body for insert-buffer |
| 5886 | 5886 | ||
| 5887 | The body in the GNU Emacs 22 version is more confusing than the original. | 5887 | The body in the GNU Emacs 22 version is more confusing than the original. |
| 5888 | 5888 | ||
| @@ -6734,8 +6734,8 @@ Or can you write the function without them? | |||
| 6734 | 6734 | ||
| 6735 | @node car cdr & cons | 6735 | @node car cdr & cons |
| 6736 | @chapter @code{car}, @code{cdr}, @code{cons}: Fundamental Functions | 6736 | @chapter @code{car}, @code{cdr}, @code{cons}: Fundamental Functions |
| 6737 | @findex car, @r{introduced} | 6737 | @findex car@r{, introduced} |
| 6738 | @findex cdr, @r{introduced} | 6738 | @findex cdr@r{, introduced} |
| 6739 | 6739 | ||
| 6740 | In Lisp, @code{car}, @code{cdr}, and @code{cons} are fundamental | 6740 | In Lisp, @code{car}, @code{cdr}, and @code{cons} are fundamental |
| 6741 | functions. The @code{cons} function is used to construct lists, and | 6741 | functions. The @code{cons} function is used to construct lists, and |
| @@ -6900,7 +6900,7 @@ Emacs Lisp Reference Manual}.) | |||
| 6900 | 6900 | ||
| 6901 | @node cons | 6901 | @node cons |
| 6902 | @section @code{cons} | 6902 | @section @code{cons} |
| 6903 | @findex cons, @r{introduced} | 6903 | @findex cons@r{, introduced} |
| 6904 | 6904 | ||
| 6905 | The @code{cons} function constructs lists; it is the inverse of | 6905 | The @code{cons} function constructs lists; it is the inverse of |
| 6906 | @code{car} and @code{cdr}. For example, @code{cons} can be used to make | 6906 | @code{car} and @code{cdr}. For example, @code{cons} can be used to make |
| @@ -8715,7 +8715,7 @@ example-list | |||
| 8715 | @noindent | 8715 | @noindent |
| 8716 | Now, we can add a new element on to this list by evaluating the | 8716 | Now, we can add a new element on to this list by evaluating the |
| 8717 | following expression: | 8717 | following expression: |
| 8718 | @findex push, @r{example} | 8718 | @findex push@r{, example} |
| 8719 | 8719 | ||
| 8720 | @smallexample | 8720 | @smallexample |
| 8721 | (push "a third clause" example-list) | 8721 | (push "a third clause" example-list) |
| @@ -8762,13 +8762,13 @@ element of the kill ring---this means that since the @sc{cdr} of the | |||
| 8762 | next to last element is the last element of the kill ring, it will set | 8762 | next to last element is the last element of the kill ring, it will set |
| 8763 | the last element of the kill ring. | 8763 | the last element of the kill ring. |
| 8764 | 8764 | ||
| 8765 | @findex nthcdr, @r{example} | 8765 | @findex nthcdr@r{, example} |
| 8766 | The @code{nthcdr} function works by repeatedly taking the @sc{cdr} of a | 8766 | The @code{nthcdr} function works by repeatedly taking the @sc{cdr} of a |
| 8767 | list---it takes the @sc{cdr} of the @sc{cdr} of the @sc{cdr} | 8767 | list---it takes the @sc{cdr} of the @sc{cdr} of the @sc{cdr} |
| 8768 | @dots{} It does this @var{N} times and returns the results. | 8768 | @dots{} It does this @var{N} times and returns the results. |
| 8769 | (@xref{nthcdr, , @code{nthcdr}}.) | 8769 | (@xref{nthcdr, , @code{nthcdr}}.) |
| 8770 | 8770 | ||
| 8771 | @findex setcdr, @r{example} | 8771 | @findex setcdr@r{, example} |
| 8772 | Thus, if we had a four element list that was supposed to be three | 8772 | Thus, if we had a four element list that was supposed to be three |
| 8773 | elements long, we could set the @sc{cdr} of the next to last element | 8773 | elements long, we could set the @sc{cdr} of the next to last element |
| 8774 | to @code{nil}, and thereby shorten the list. (If you set the last | 8774 | to @code{nil}, and thereby shorten the list. (If you set the last |
| @@ -17177,8 +17177,8 @@ file, as I intended, I accidentally set the width for filled text, | |||
| 17177 | almost always to a width I did not want. Since I hardly ever reset my | 17177 | almost always to a width I did not want. Since I hardly ever reset my |
| 17178 | default width, I simply unbound the key. | 17178 | default width, I simply unbound the key. |
| 17179 | 17179 | ||
| 17180 | @findex list-buffers, @r{rebound} | 17180 | @findex list-buffers@r{, rebound} |
| 17181 | @findex buffer-menu, @r{bound to key} | 17181 | @findex buffer-menu@r{, bound to key} |
| 17182 | @need 1250 | 17182 | @need 1250 |
| 17183 | The following rebinds an existing key: | 17183 | The following rebinds an existing key: |
| 17184 | 17184 | ||
diff --git a/doc/lispref/buffers.texi b/doc/lispref/buffers.texi index 3750fa60534..a72e1eb69fc 100644 --- a/doc/lispref/buffers.texi +++ b/doc/lispref/buffers.texi | |||
| @@ -647,7 +647,7 @@ visiting a file or if the time has been explicitly cleared by | |||
| 647 | too. For instance, in a Dired buffer listing a directory, it returns | 647 | too. For instance, in a Dired buffer listing a directory, it returns |
| 648 | the last modification time of that directory, as recorded by Dired. | 648 | the last modification time of that directory, as recorded by Dired. |
| 649 | 649 | ||
| 650 | If the buffer is not visiting a file, this function returns -1. | 650 | If the buffer is not visiting a file, this function returns @minus{}1. |
| 651 | @end defun | 651 | @end defun |
| 652 | 652 | ||
| 653 | @defun set-visited-file-modtime &optional time | 653 | @defun set-visited-file-modtime &optional time |
| @@ -656,7 +656,8 @@ of the visited file, to the value specified by @var{time} if @var{time} | |||
| 656 | is not @code{nil}, and otherwise to the last modification time of the | 656 | is not @code{nil}, and otherwise to the last modification time of the |
| 657 | visited file. | 657 | visited file. |
| 658 | 658 | ||
| 659 | If @var{time} is neither @code{nil} nor zero, it should have the form | 659 | If @var{time} is neither @code{nil} nor an integer flag returned |
| 660 | by @code{visited-file-modtime}, it should have the form | ||
| 660 | @code{(@var{high} @var{low} @var{microsec} @var{picosec})}, | 661 | @code{(@var{high} @var{low} @var{microsec} @var{picosec})}, |
| 661 | the format used by @code{current-time} (@pxref{Time of Day}). | 662 | the format used by @code{current-time} (@pxref{Time of Day}). |
| 662 | 663 | ||
diff --git a/doc/lispref/edebug.texi b/doc/lispref/edebug.texi index 031fe65266e..b9cc1d5afc2 100644 --- a/doc/lispref/edebug.texi +++ b/doc/lispref/edebug.texi | |||
| @@ -158,7 +158,7 @@ display a list of all Edebug commands. | |||
| 158 | into it, to invoke Edebug at the proper places. | 158 | into it, to invoke Edebug at the proper places. |
| 159 | 159 | ||
| 160 | @kindex C-M-x | 160 | @kindex C-M-x |
| 161 | @findex eval-defun (Edebug) | 161 | @findex eval-defun @r{(Edebug)} |
| 162 | When you invoke command @kbd{C-M-x} (@code{eval-defun}) with a | 162 | When you invoke command @kbd{C-M-x} (@code{eval-defun}) with a |
| 163 | prefix argument on a function definition, it instruments the | 163 | prefix argument on a function definition, it instruments the |
| 164 | definition before evaluating it. (This does not modify the source | 164 | definition before evaluating it. (This does not modify the source |
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index 70d6ec9cdb3..9fbdb628205 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi | |||
| @@ -1894,8 +1894,7 @@ all. | |||
| 1894 | This function sets the access and modification times of @var{filename} | 1894 | This function sets the access and modification times of @var{filename} |
| 1895 | to @var{time}. The return value is @code{t} if the times are successfully | 1895 | to @var{time}. The return value is @code{t} if the times are successfully |
| 1896 | set, otherwise it is @code{nil}. @var{time} defaults to the current | 1896 | set, otherwise it is @code{nil}. @var{time} defaults to the current |
| 1897 | time and must be in the format returned by @code{current-time} | 1897 | time and must be a time value (@pxref{Time of Day}). |
| 1898 | (@pxref{Time of Day}). | ||
| 1899 | @end defun | 1898 | @end defun |
| 1900 | 1899 | ||
| 1901 | @defun set-file-extended-attributes filename attribute-alist | 1900 | @defun set-file-extended-attributes filename attribute-alist |
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 43fdd8f9d54..2f9bb398865 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -1391,20 +1391,20 @@ text terminals. | |||
| 1391 | frame. @code{title} and @code{name} are meaningful on all terminals. | 1391 | frame. @code{title} and @code{name} are meaningful on all terminals. |
| 1392 | 1392 | ||
| 1393 | @table @code | 1393 | @table @code |
| 1394 | @vindex display, a frame parameter | 1394 | @vindex display@r{, a frame parameter} |
| 1395 | @item display | 1395 | @item display |
| 1396 | The display on which to open this frame. It should be a string of the | 1396 | The display on which to open this frame. It should be a string of the |
| 1397 | form @samp{@var{host}:@var{dpy}.@var{screen}}, just like the | 1397 | form @samp{@var{host}:@var{dpy}.@var{screen}}, just like the |
| 1398 | @env{DISPLAY} environment variable. @xref{Multiple Terminals}, for | 1398 | @env{DISPLAY} environment variable. @xref{Multiple Terminals}, for |
| 1399 | more details about display names. | 1399 | more details about display names. |
| 1400 | 1400 | ||
| 1401 | @vindex display-type, a frame parameter | 1401 | @vindex display-type@r{, a frame parameter} |
| 1402 | @item display-type | 1402 | @item display-type |
| 1403 | This parameter describes the range of possible colors that can be used | 1403 | This parameter describes the range of possible colors that can be used |
| 1404 | in this frame. Its value is @code{color}, @code{grayscale} or | 1404 | in this frame. Its value is @code{color}, @code{grayscale} or |
| 1405 | @code{mono}. | 1405 | @code{mono}. |
| 1406 | 1406 | ||
| 1407 | @vindex title, a frame parameter | 1407 | @vindex title@r{, a frame parameter} |
| 1408 | @item title | 1408 | @item title |
| 1409 | If a frame has a non-@code{nil} title, it appears in the window | 1409 | If a frame has a non-@code{nil} title, it appears in the window |
| 1410 | system's title bar at the top of the frame, and also in the mode line | 1410 | system's title bar at the top of the frame, and also in the mode line |
| @@ -1413,7 +1413,7 @@ of windows in that frame if @code{mode-line-frame-identification} uses | |||
| 1413 | Emacs is not using a window system, and can only display one frame at | 1413 | Emacs is not using a window system, and can only display one frame at |
| 1414 | a time. @xref{Frame Titles}. | 1414 | a time. @xref{Frame Titles}. |
| 1415 | 1415 | ||
| 1416 | @vindex name, a frame parameter | 1416 | @vindex name@r{, a frame parameter} |
| 1417 | @item name | 1417 | @item name |
| 1418 | The name of the frame. The frame name serves as a default for the frame | 1418 | The name of the frame. The frame name serves as a default for the frame |
| 1419 | title, if the @code{title} parameter is unspecified or @code{nil}. If | 1419 | title, if the @code{title} parameter is unspecified or @code{nil}. If |
| @@ -1424,7 +1424,7 @@ If you specify the frame name explicitly when you create the frame, the | |||
| 1424 | name is also used (instead of the name of the Emacs executable) when | 1424 | name is also used (instead of the name of the Emacs executable) when |
| 1425 | looking up X resources for the frame. | 1425 | looking up X resources for the frame. |
| 1426 | 1426 | ||
| 1427 | @vindex explicit-name, a frame parameter | 1427 | @vindex explicit-name@r{, a frame parameter} |
| 1428 | @item explicit-name | 1428 | @item explicit-name |
| 1429 | If the frame name was specified explicitly when the frame was created, | 1429 | If the frame name was specified explicitly when the frame was created, |
| 1430 | this parameter will be that name. If the frame wasn't explicitly | 1430 | this parameter will be that name. If the frame wasn't explicitly |
| @@ -1446,7 +1446,7 @@ frame's parent frame. (Note that none of these parameters is meaningful | |||
| 1446 | on TTY frames.) | 1446 | on TTY frames.) |
| 1447 | 1447 | ||
| 1448 | @table @code | 1448 | @table @code |
| 1449 | @vindex left, a frame parameter | 1449 | @vindex left@r{, a frame parameter} |
| 1450 | @item left | 1450 | @item left |
| 1451 | The position, in pixels, of the left outer edge of the frame with | 1451 | The position, in pixels, of the left outer edge of the frame with |
| 1452 | respect to the left edge of the frame's display or parent frame. It can | 1452 | respect to the left edge of the frame's display or parent frame. It can |
| @@ -1521,13 +1521,13 @@ of the display, workarea or parent frame edge. They are also returned | |||
| 1521 | as such by functions like @code{frame-parameters} and restored as such | 1521 | as such by functions like @code{frame-parameters} and restored as such |
| 1522 | by the desktop saving routines. | 1522 | by the desktop saving routines. |
| 1523 | 1523 | ||
| 1524 | @vindex top, a frame parameter | 1524 | @vindex top@r{, a frame parameter} |
| 1525 | @item top | 1525 | @item top |
| 1526 | The screen position of the top (or bottom) edge, in pixels, with respect | 1526 | The screen position of the top (or bottom) edge, in pixels, with respect |
| 1527 | to the top (or bottom) edge of the display or parent frame. It works | 1527 | to the top (or bottom) edge of the display or parent frame. It works |
| 1528 | just like @code{left}, except vertically instead of horizontally. | 1528 | just like @code{left}, except vertically instead of horizontally. |
| 1529 | 1529 | ||
| 1530 | @vindex icon-left, a frame parameter | 1530 | @vindex icon-left@r{, a frame parameter} |
| 1531 | @item icon-left | 1531 | @item icon-left |
| 1532 | The screen position of the left edge of the frame's icon, in pixels, | 1532 | The screen position of the left edge of the frame's icon, in pixels, |
| 1533 | counting from the left edge of the screen. This takes effect when the | 1533 | counting from the left edge of the screen. This takes effect when the |
| @@ -1535,13 +1535,13 @@ frame is iconified, if the window manager supports this feature. If | |||
| 1535 | you specify a value for this parameter, then you must also specify a | 1535 | you specify a value for this parameter, then you must also specify a |
| 1536 | value for @code{icon-top} and vice versa. | 1536 | value for @code{icon-top} and vice versa. |
| 1537 | 1537 | ||
| 1538 | @vindex icon-top, a frame parameter | 1538 | @vindex icon-top@r{, a frame parameter} |
| 1539 | @item icon-top | 1539 | @item icon-top |
| 1540 | The screen position of the top edge of the frame's icon, in pixels, | 1540 | The screen position of the top edge of the frame's icon, in pixels, |
| 1541 | counting from the top edge of the screen. This takes effect when the | 1541 | counting from the top edge of the screen. This takes effect when the |
| 1542 | frame is iconified, if the window manager supports this feature. | 1542 | frame is iconified, if the window manager supports this feature. |
| 1543 | 1543 | ||
| 1544 | @vindex user-position, a frame parameter | 1544 | @vindex user-position@r{, a frame parameter} |
| 1545 | @item user-position | 1545 | @item user-position |
| 1546 | When you create a frame and specify its screen position with the | 1546 | When you create a frame and specify its screen position with the |
| 1547 | @code{left} and @code{top} parameters, use this parameter to say whether | 1547 | @code{left} and @code{top} parameters, use this parameter to say whether |
| @@ -1562,7 +1562,7 @@ value for this parameter if the values of the @code{left} and @code{top} | |||
| 1562 | parameters represent the user's stated preference; otherwise, use | 1562 | parameters represent the user's stated preference; otherwise, use |
| 1563 | @code{nil}. | 1563 | @code{nil}. |
| 1564 | 1564 | ||
| 1565 | @vindex z-group, a frame parameter | 1565 | @vindex z-group@r{, a frame parameter} |
| 1566 | @item z-group | 1566 | @item z-group |
| 1567 | This parameter specifies a relative position of the frame's | 1567 | This parameter specifies a relative position of the frame's |
| 1568 | window-system window in the stacking (Z-) order of the frame's display. | 1568 | window-system window in the stacking (Z-) order of the frame's display. |
| @@ -1589,7 +1589,7 @@ graphical displays, the @code{default} face determines the actual pixel | |||
| 1589 | sizes of these character units (@pxref{Face Attributes}). | 1589 | sizes of these character units (@pxref{Face Attributes}). |
| 1590 | 1590 | ||
| 1591 | @table @code | 1591 | @table @code |
| 1592 | @vindex width, a frame parameter | 1592 | @vindex width@r{, a frame parameter} |
| 1593 | @item width | 1593 | @item width |
| 1594 | This parameter specifies the width of the frame. It can be specified as | 1594 | This parameter specifies the width of the frame. It can be specified as |
| 1595 | in the following ways: | 1595 | in the following ways: |
| @@ -1635,19 +1635,19 @@ width of the frame's text area in characters as an integer rounded, if | |||
| 1635 | necessary, to a multiple of the frame's default character width. That | 1635 | necessary, to a multiple of the frame's default character width. That |
| 1636 | value is also used by the desktop saving routines. | 1636 | value is also used by the desktop saving routines. |
| 1637 | 1637 | ||
| 1638 | @vindex height, a frame parameter | 1638 | @vindex height@r{, a frame parameter} |
| 1639 | @item height | 1639 | @item height |
| 1640 | This parameter specifies the height of the frame. It works just like | 1640 | This parameter specifies the height of the frame. It works just like |
| 1641 | @code{width}, except vertically instead of horizontally. | 1641 | @code{width}, except vertically instead of horizontally. |
| 1642 | 1642 | ||
| 1643 | @vindex user-size, a frame parameter | 1643 | @vindex user-size@r{, a frame parameter} |
| 1644 | @item user-size | 1644 | @item user-size |
| 1645 | This does for the size parameters @code{height} and @code{width} what | 1645 | This does for the size parameters @code{height} and @code{width} what |
| 1646 | the @code{user-position} parameter (@pxref{Position Parameters, | 1646 | the @code{user-position} parameter (@pxref{Position Parameters, |
| 1647 | user-position}) does for the position parameters @code{top} and | 1647 | user-position}) does for the position parameters @code{top} and |
| 1648 | @code{left}. | 1648 | @code{left}. |
| 1649 | 1649 | ||
| 1650 | @vindex min-width, a frame parameter | 1650 | @vindex min-width@r{, a frame parameter} |
| 1651 | @item min-width | 1651 | @item min-width |
| 1652 | This parameter specifies the minimum native width (@pxref{Frame | 1652 | This parameter specifies the minimum native width (@pxref{Frame |
| 1653 | Geometry}) of the frame, in characters. Normally, the functions that | 1653 | Geometry}) of the frame, in characters. Normally, the functions that |
| @@ -1658,7 +1658,7 @@ non-@code{nil} allows to make a frame narrower than that with the | |||
| 1658 | consequence that any components that do not fit will be clipped by the | 1658 | consequence that any components that do not fit will be clipped by the |
| 1659 | window manager. | 1659 | window manager. |
| 1660 | 1660 | ||
| 1661 | @vindex min-height, a frame parameter | 1661 | @vindex min-height@r{, a frame parameter} |
| 1662 | @item min-height | 1662 | @item min-height |
| 1663 | This parameter specifies the minimum native height (@pxref{Frame | 1663 | This parameter specifies the minimum native height (@pxref{Frame |
| 1664 | Geometry}) of the frame, in characters. Normally, the functions that | 1664 | Geometry}) of the frame, in characters. Normally, the functions that |
| @@ -1673,7 +1673,7 @@ fit will be clipped by the window manager. | |||
| 1673 | @cindex fullheight frames | 1673 | @cindex fullheight frames |
| 1674 | @cindex fullwidth frames | 1674 | @cindex fullwidth frames |
| 1675 | @cindex maximized frames | 1675 | @cindex maximized frames |
| 1676 | @vindex fullscreen, a frame parameter | 1676 | @vindex fullscreen@r{, a frame parameter} |
| 1677 | @item fullscreen | 1677 | @item fullscreen |
| 1678 | This parameter specifies whether to maximize the frame's width, height | 1678 | This parameter specifies whether to maximize the frame's width, height |
| 1679 | or both. Its value can be @code{fullwidth}, @code{fullheight}, | 1679 | or both. Its value can be @code{fullwidth}, @code{fullheight}, |
| @@ -1704,7 +1704,7 @@ Full-screen on macOS hides both the tool-bar and the menu-bar, however | |||
| 1704 | both will be displayed if the mouse pointer is moved to the top of the | 1704 | both will be displayed if the mouse pointer is moved to the top of the |
| 1705 | screen. | 1705 | screen. |
| 1706 | 1706 | ||
| 1707 | @vindex fullscreen-restore, a frame parameter | 1707 | @vindex fullscreen-restore@r{, a frame parameter} |
| 1708 | @item fullscreen-restore | 1708 | @item fullscreen-restore |
| 1709 | This parameter specifies the desired fullscreen state of the frame | 1709 | This parameter specifies the desired fullscreen state of the frame |
| 1710 | after invoking the @code{toggle-frame-fullscreen} command (@pxref{Frame | 1710 | after invoking the @code{toggle-frame-fullscreen} command (@pxref{Frame |
| @@ -1723,14 +1723,14 @@ file as, for example | |||
| 1723 | This will give a new frame full height after typing in it @key{F11} for | 1723 | This will give a new frame full height after typing in it @key{F11} for |
| 1724 | the first time. | 1724 | the first time. |
| 1725 | 1725 | ||
| 1726 | @vindex fit-frame-to-buffer-margins, a frame parameter | 1726 | @vindex fit-frame-to-buffer-margins@r{, a frame parameter} |
| 1727 | @item fit-frame-to-buffer-margins | 1727 | @item fit-frame-to-buffer-margins |
| 1728 | This parameter allows to override the value of the option | 1728 | This parameter allows to override the value of the option |
| 1729 | @code{fit-frame-to-buffer-margins} when fitting this frame to the buffer | 1729 | @code{fit-frame-to-buffer-margins} when fitting this frame to the buffer |
| 1730 | of its root window with @code{fit-frame-to-buffer} (@pxref{Resizing | 1730 | of its root window with @code{fit-frame-to-buffer} (@pxref{Resizing |
| 1731 | Windows}). | 1731 | Windows}). |
| 1732 | 1732 | ||
| 1733 | @vindex fit-frame-to-buffer-sizes, a frame parameter | 1733 | @vindex fit-frame-to-buffer-sizes@r{, a frame parameter} |
| 1734 | @item fit-frame-to-buffer-sizes | 1734 | @item fit-frame-to-buffer-sizes |
| 1735 | This parameter allows to override the value of the option | 1735 | This parameter allows to override the value of the option |
| 1736 | @code{fit-frame-to-buffer-sizes} when fitting this frame to the buffer | 1736 | @code{fit-frame-to-buffer-sizes} when fitting this frame to the buffer |
| @@ -1748,38 +1748,38 @@ Windows}). | |||
| 1748 | frame, or control their sizes. | 1748 | frame, or control their sizes. |
| 1749 | 1749 | ||
| 1750 | @table @code | 1750 | @table @code |
| 1751 | @vindex border-width, a frame parameter | 1751 | @vindex border-width@r{, a frame parameter} |
| 1752 | @item border-width | 1752 | @item border-width |
| 1753 | The width in pixels of the frame's outer border (@pxref{Frame Geometry}). | 1753 | The width in pixels of the frame's outer border (@pxref{Frame Geometry}). |
| 1754 | 1754 | ||
| 1755 | @vindex internal-border-width, a frame parameter | 1755 | @vindex internal-border-width@r{, a frame parameter} |
| 1756 | @item internal-border-width | 1756 | @item internal-border-width |
| 1757 | The width in pixels of the frame's internal border (@pxref{Frame | 1757 | The width in pixels of the frame's internal border (@pxref{Frame |
| 1758 | Geometry}). | 1758 | Geometry}). |
| 1759 | 1759 | ||
| 1760 | @vindex vertical-scroll-bars, a frame parameter | 1760 | @vindex vertical-scroll-bars@r{, a frame parameter} |
| 1761 | @item vertical-scroll-bars | 1761 | @item vertical-scroll-bars |
| 1762 | Whether the frame has scroll bars (@pxref{Scroll Bars}) for vertical | 1762 | Whether the frame has scroll bars (@pxref{Scroll Bars}) for vertical |
| 1763 | scrolling, and which side of the frame they should be on. The possible | 1763 | scrolling, and which side of the frame they should be on. The possible |
| 1764 | values are @code{left}, @code{right}, and @code{nil} for no scroll bars. | 1764 | values are @code{left}, @code{right}, and @code{nil} for no scroll bars. |
| 1765 | 1765 | ||
| 1766 | @vindex horizontal-scroll-bars, a frame parameter | 1766 | @vindex horizontal-scroll-bars@r{, a frame parameter} |
| 1767 | @item horizontal-scroll-bars | 1767 | @item horizontal-scroll-bars |
| 1768 | Whether the frame has scroll bars for horizontal scrolling (@code{t} and | 1768 | Whether the frame has scroll bars for horizontal scrolling (@code{t} and |
| 1769 | @code{bottom} mean yes, @code{nil} means no). | 1769 | @code{bottom} mean yes, @code{nil} means no). |
| 1770 | 1770 | ||
| 1771 | @vindex scroll-bar-width, a frame parameter | 1771 | @vindex scroll-bar-width@r{, a frame parameter} |
| 1772 | @item scroll-bar-width | 1772 | @item scroll-bar-width |
| 1773 | The width of vertical scroll bars, in pixels, or @code{nil} meaning to | 1773 | The width of vertical scroll bars, in pixels, or @code{nil} meaning to |
| 1774 | use the default width. | 1774 | use the default width. |
| 1775 | 1775 | ||
| 1776 | @vindex scroll-bar-height, a frame parameter | 1776 | @vindex scroll-bar-height@r{, a frame parameter} |
| 1777 | @item scroll-bar-height | 1777 | @item scroll-bar-height |
| 1778 | The height of horizontal scroll bars, in pixels, or @code{nil} meaning | 1778 | The height of horizontal scroll bars, in pixels, or @code{nil} meaning |
| 1779 | to use the default height. | 1779 | to use the default height. |
| 1780 | 1780 | ||
| 1781 | @vindex left-fringe, a frame parameter | 1781 | @vindex left-fringe@r{, a frame parameter} |
| 1782 | @vindex right-fringe, a frame parameter | 1782 | @vindex right-fringe@r{, a frame parameter} |
| 1783 | @item left-fringe | 1783 | @item left-fringe |
| 1784 | @itemx right-fringe | 1784 | @itemx right-fringe |
| 1785 | The default width of the left and right fringes of windows in this | 1785 | The default width of the left and right fringes of windows in this |
| @@ -1791,19 +1791,19 @@ these two frame parameters, the return value is always an integer. | |||
| 1791 | When using @code{set-frame-parameter}, passing a @code{nil} value | 1791 | When using @code{set-frame-parameter}, passing a @code{nil} value |
| 1792 | imposes an actual default value of 8 pixels. | 1792 | imposes an actual default value of 8 pixels. |
| 1793 | 1793 | ||
| 1794 | @vindex right-divider-width, a frame parameter | 1794 | @vindex right-divider-width@r{, a frame parameter} |
| 1795 | @item right-divider-width | 1795 | @item right-divider-width |
| 1796 | The width (thickness) reserved for the right divider (@pxref{Window | 1796 | The width (thickness) reserved for the right divider (@pxref{Window |
| 1797 | Dividers}) of any window on the frame, in pixels. A value of zero means | 1797 | Dividers}) of any window on the frame, in pixels. A value of zero means |
| 1798 | to not draw right dividers. | 1798 | to not draw right dividers. |
| 1799 | 1799 | ||
| 1800 | @vindex bottom-divider-width, a frame parameter | 1800 | @vindex bottom-divider-width@r{, a frame parameter} |
| 1801 | @item bottom-divider-width | 1801 | @item bottom-divider-width |
| 1802 | The width (thickness) reserved for the bottom divider (@pxref{Window | 1802 | The width (thickness) reserved for the bottom divider (@pxref{Window |
| 1803 | Dividers}) of any window on the frame, in pixels. A value of zero means | 1803 | Dividers}) of any window on the frame, in pixels. A value of zero means |
| 1804 | to not draw bottom dividers. | 1804 | to not draw bottom dividers. |
| 1805 | 1805 | ||
| 1806 | @vindex menu-bar-lines frame parameter | 1806 | @vindex menu-bar-lines@r{, a frame parameter} |
| 1807 | @item menu-bar-lines | 1807 | @item menu-bar-lines |
| 1808 | The number of lines to allocate at the top of the frame for a menu bar | 1808 | The number of lines to allocate at the top of the frame for a menu bar |
| 1809 | (@pxref{Menu Bar}). The default is one if Menu Bar mode is enabled and | 1809 | (@pxref{Menu Bar}). The default is one if Menu Bar mode is enabled and |
| @@ -1814,25 +1814,25 @@ even when the menu bar wraps to two or more lines. In that case, the | |||
| 1814 | (@pxref{Frame Geometry}) allows to derive whether the menu bar actually | 1814 | (@pxref{Frame Geometry}) allows to derive whether the menu bar actually |
| 1815 | occupies one or more lines. | 1815 | occupies one or more lines. |
| 1816 | 1816 | ||
| 1817 | @vindex tool-bar-lines frame parameter | 1817 | @vindex tool-bar-lines@r{, a frame parameter} |
| 1818 | @item tool-bar-lines | 1818 | @item tool-bar-lines |
| 1819 | The number of lines to use for the tool bar (@pxref{Tool Bar}). The | 1819 | The number of lines to use for the tool bar (@pxref{Tool Bar}). The |
| 1820 | default is one if Tool Bar mode is enabled and zero otherwise. | 1820 | default is one if Tool Bar mode is enabled and zero otherwise. |
| 1821 | @xref{Tool Bars,,,emacs, The GNU Emacs Manual}. This value may change | 1821 | @xref{Tool Bars,,,emacs, The GNU Emacs Manual}. This value may change |
| 1822 | whenever the tool bar wraps (@pxref{Frame Layout}). | 1822 | whenever the tool bar wraps (@pxref{Frame Layout}). |
| 1823 | 1823 | ||
| 1824 | @vindex tool-bar-position frame parameter | 1824 | @vindex tool-bar-position@r{, a frame parameter} |
| 1825 | @item tool-bar-position | 1825 | @item tool-bar-position |
| 1826 | The position of the tool bar when Emacs was built with GTK+. Its value | 1826 | The position of the tool bar when Emacs was built with GTK+. Its value |
| 1827 | can be one of @code{top}, @code{bottom} @code{left}, @code{right}. The | 1827 | can be one of @code{top}, @code{bottom} @code{left}, @code{right}. The |
| 1828 | default is @code{top}. | 1828 | default is @code{top}. |
| 1829 | 1829 | ||
| 1830 | @vindex line-spacing, a frame parameter | 1830 | @vindex line-spacing@r{, a frame parameter} |
| 1831 | @item line-spacing | 1831 | @item line-spacing |
| 1832 | Additional space to leave below each text line, in pixels (a positive | 1832 | Additional space to leave below each text line, in pixels (a positive |
| 1833 | integer). @xref{Line Height}, for more information. | 1833 | integer). @xref{Line Height}, for more information. |
| 1834 | 1834 | ||
| 1835 | @vindex no-special-glyphs, a frame parameter | 1835 | @vindex no-special-glyphs@r{, a frame parameter} |
| 1836 | @item no-special-glyphs | 1836 | @item no-special-glyphs |
| 1837 | If this is non-@code{nil}, it suppresses the display of any truncation | 1837 | If this is non-@code{nil}, it suppresses the display of any truncation |
| 1838 | and continuation glyphs (@pxref{Truncation}) for all buffers displayed | 1838 | and continuation glyphs (@pxref{Truncation}) for all buffers displayed |
| @@ -1851,7 +1851,7 @@ Windows}). | |||
| 1851 | with which buffers have been, or should, be displayed in the frame. | 1851 | with which buffers have been, or should, be displayed in the frame. |
| 1852 | 1852 | ||
| 1853 | @table @code | 1853 | @table @code |
| 1854 | @vindex minibuffer, a frame parameter | 1854 | @vindex minibuffer@r{, a frame parameter} |
| 1855 | @item minibuffer | 1855 | @item minibuffer |
| 1856 | Whether this frame has its own minibuffer. The value @code{t} means | 1856 | Whether this frame has its own minibuffer. The value @code{t} means |
| 1857 | yes, @code{nil} means no, @code{only} means this frame is just a | 1857 | yes, @code{nil} means no, @code{only} means this frame is just a |
| @@ -1867,7 +1867,7 @@ minibuffer window to @code{t} and vice-versa, or from @code{t} to | |||
| 1867 | @code{nil}. If the parameter specifies a minibuffer window already, | 1867 | @code{nil}. If the parameter specifies a minibuffer window already, |
| 1868 | setting it to @code{nil} has no effect. | 1868 | setting it to @code{nil} has no effect. |
| 1869 | 1869 | ||
| 1870 | @vindex buffer-predicate, a frame parameter | 1870 | @vindex buffer-predicate@r{, a frame parameter} |
| 1871 | @item buffer-predicate | 1871 | @item buffer-predicate |
| 1872 | The buffer-predicate function for this frame. The function | 1872 | The buffer-predicate function for this frame. The function |
| 1873 | @code{other-buffer} uses this predicate (from the selected frame) to | 1873 | @code{other-buffer} uses this predicate (from the selected frame) to |
| @@ -1876,12 +1876,12 @@ decide which buffers it should consider, if the predicate is not | |||
| 1876 | each buffer; if the predicate returns a non-@code{nil} value, it | 1876 | each buffer; if the predicate returns a non-@code{nil} value, it |
| 1877 | considers that buffer. | 1877 | considers that buffer. |
| 1878 | 1878 | ||
| 1879 | @vindex buffer-list, a frame parameter | 1879 | @vindex buffer-list@r{, a frame parameter} |
| 1880 | @item buffer-list | 1880 | @item buffer-list |
| 1881 | A list of buffers that have been selected in this frame, ordered | 1881 | A list of buffers that have been selected in this frame, ordered |
| 1882 | most-recently-selected first. | 1882 | most-recently-selected first. |
| 1883 | 1883 | ||
| 1884 | @vindex unsplittable, a frame parameter | 1884 | @vindex unsplittable@r{, a frame parameter} |
| 1885 | @item unsplittable | 1885 | @item unsplittable |
| 1886 | If non-@code{nil}, this frame's window is never split automatically. | 1886 | If non-@code{nil}, this frame's window is never split automatically. |
| 1887 | @end table | 1887 | @end table |
| @@ -1895,40 +1895,40 @@ If non-@code{nil}, this frame's window is never split automatically. | |||
| 1895 | These parameters supply forms of interactions between different frames. | 1895 | These parameters supply forms of interactions between different frames. |
| 1896 | 1896 | ||
| 1897 | @table @code | 1897 | @table @code |
| 1898 | @vindex parent-frame, a frame parameter | 1898 | @vindex parent-frame@r{, a frame parameter} |
| 1899 | @item parent-frame | 1899 | @item parent-frame |
| 1900 | If non-@code{nil}, this means that this frame is a child frame | 1900 | If non-@code{nil}, this means that this frame is a child frame |
| 1901 | (@pxref{Child Frames}), and this parameter specifies its parent frame. | 1901 | (@pxref{Child Frames}), and this parameter specifies its parent frame. |
| 1902 | If @code{nil}, this means that this frame is a normal, top-level frame. | 1902 | If @code{nil}, this means that this frame is a normal, top-level frame. |
| 1903 | 1903 | ||
| 1904 | @vindex delete-before, a frame parameter | 1904 | @vindex delete-before@r{, a frame parameter} |
| 1905 | @item delete-before | 1905 | @item delete-before |
| 1906 | If non-@code{nil}, this parameter specifies another frame whose deletion | 1906 | If non-@code{nil}, this parameter specifies another frame whose deletion |
| 1907 | will automatically trigger the deletion of this frame. @xref{Deleting | 1907 | will automatically trigger the deletion of this frame. @xref{Deleting |
| 1908 | Frames}. | 1908 | Frames}. |
| 1909 | 1909 | ||
| 1910 | @vindex mouse-wheel-frame, a frame parameter | 1910 | @vindex mouse-wheel-frame@r{, a frame parameter} |
| 1911 | @item mouse-wheel-frame | 1911 | @item mouse-wheel-frame |
| 1912 | If non-@code{nil}, this parameter specifies the frame whose windows will | 1912 | If non-@code{nil}, this parameter specifies the frame whose windows will |
| 1913 | be scrolled whenever the mouse wheel is scrolled with the mouse pointer | 1913 | be scrolled whenever the mouse wheel is scrolled with the mouse pointer |
| 1914 | hovering over this frame, see @ref{Mouse Commands,,, emacs, The GNU | 1914 | hovering over this frame, see @ref{Mouse Commands,,, emacs, The GNU |
| 1915 | Emacs Manual}. | 1915 | Emacs Manual}. |
| 1916 | 1916 | ||
| 1917 | @vindex no-other-frame, a frame parameter | 1917 | @vindex no-other-frame@r{, a frame parameter} |
| 1918 | @item no-other-frame | 1918 | @item no-other-frame |
| 1919 | If this is non-@code{nil}, then this frame is not eligible as candidate | 1919 | If this is non-@code{nil}, then this frame is not eligible as candidate |
| 1920 | for the functions @code{next-frame}, @code{previous-frame} | 1920 | for the functions @code{next-frame}, @code{previous-frame} |
| 1921 | (@pxref{Finding All Frames}) and @code{other-frame}, see @ref{Frame | 1921 | (@pxref{Finding All Frames}) and @code{other-frame}, see @ref{Frame |
| 1922 | Commands,,, emacs, The GNU Emacs Manual}. | 1922 | Commands,,, emacs, The GNU Emacs Manual}. |
| 1923 | 1923 | ||
| 1924 | @vindex auto-hide-function, a frame parameter | 1924 | @vindex auto-hide-function@r{, a frame parameter} |
| 1925 | @item auto-hide-function | 1925 | @item auto-hide-function |
| 1926 | When this parameter specifies a function, that function will be called | 1926 | When this parameter specifies a function, that function will be called |
| 1927 | instead of the function specified by the variable | 1927 | instead of the function specified by the variable |
| 1928 | @code{frame-auto-hide-function} when quitting the frame's only window | 1928 | @code{frame-auto-hide-function} when quitting the frame's only window |
| 1929 | (@pxref{Quitting Windows}) and there are other frames left. | 1929 | (@pxref{Quitting Windows}) and there are other frames left. |
| 1930 | 1930 | ||
| 1931 | @vindex minibuffer-exit, a frame parameter | 1931 | @vindex minibuffer-exit@r{, a frame parameter} |
| 1932 | @item minibuffer-exit | 1932 | @item minibuffer-exit |
| 1933 | When this parameter is non-@code{nil}, Emacs will by default make this | 1933 | When this parameter is non-@code{nil}, Emacs will by default make this |
| 1934 | frame invisible whenever the minibuffer (@pxref{Minibuffers}) is exited. | 1934 | frame invisible whenever the minibuffer (@pxref{Minibuffers}) is exited. |
| @@ -1937,7 +1937,7 @@ Alternatively, it can specify the functions @code{iconify-frame} and | |||
| 1937 | disappear automatically (similar to how Emacs deals with a window) when | 1937 | disappear automatically (similar to how Emacs deals with a window) when |
| 1938 | exiting the minibuffer. | 1938 | exiting the minibuffer. |
| 1939 | 1939 | ||
| 1940 | @vindex keep-ratio, a frame parameter | 1940 | @vindex keep-ratio@r{, a frame parameter} |
| 1941 | @item keep-ratio | 1941 | @item keep-ratio |
| 1942 | This parameter is currently meaningful for child frames (@pxref{Child | 1942 | This parameter is currently meaningful for child frames (@pxref{Child |
| 1943 | Frames}) only. If it is non-@code{nil}, then Emacs will try to keep the | 1943 | Frames}) only. If it is non-@code{nil}, then Emacs will try to keep the |
| @@ -1977,29 +1977,29 @@ Frames}) that come without window manager decorations. If necessary, | |||
| 1977 | they can be used for undecorated top-level frames as well. | 1977 | they can be used for undecorated top-level frames as well. |
| 1978 | 1978 | ||
| 1979 | @table @code | 1979 | @table @code |
| 1980 | @vindex drag-internal-border, a frame parameter | 1980 | @vindex drag-internal-border@r{, a frame parameter} |
| 1981 | @item drag-internal-border | 1981 | @item drag-internal-border |
| 1982 | If non-@code{nil}, the frame can be resized by dragging its internal | 1982 | If non-@code{nil}, the frame can be resized by dragging its internal |
| 1983 | borders, if present, with the mouse. | 1983 | borders, if present, with the mouse. |
| 1984 | 1984 | ||
| 1985 | @vindex drag-with-header-line, a frame parameter | 1985 | @vindex drag-with-header-line@r{, a frame parameter} |
| 1986 | @item drag-with-header-line | 1986 | @item drag-with-header-line |
| 1987 | If non-@code{nil}, the frame can be moved with the mouse by dragging the | 1987 | If non-@code{nil}, the frame can be moved with the mouse by dragging the |
| 1988 | header line of its topmost window. | 1988 | header line of its topmost window. |
| 1989 | 1989 | ||
| 1990 | @vindex drag-with-mode-line, a frame parameter | 1990 | @vindex drag-with-mode-line@r{, a frame parameter} |
| 1991 | @item drag-with-mode-line | 1991 | @item drag-with-mode-line |
| 1992 | If non-@code{nil}, the frame can be moved with the mouse by dragging the | 1992 | If non-@code{nil}, the frame can be moved with the mouse by dragging the |
| 1993 | mode line of its bottommost window. Note that such a frame is not | 1993 | mode line of its bottommost window. Note that such a frame is not |
| 1994 | allowed to have its own minibuffer window. | 1994 | allowed to have its own minibuffer window. |
| 1995 | 1995 | ||
| 1996 | @vindex snap-width, a frame parameter | 1996 | @vindex snap-width@r{, a frame parameter} |
| 1997 | @item snap-width | 1997 | @item snap-width |
| 1998 | A frame that is moved with the mouse will ``snap'' at the border(s) of | 1998 | A frame that is moved with the mouse will ``snap'' at the border(s) of |
| 1999 | the display or its parent frame whenever it is dragged as near to such | 1999 | the display or its parent frame whenever it is dragged as near to such |
| 2000 | an edge as the number of pixels specified by this parameter. | 2000 | an edge as the number of pixels specified by this parameter. |
| 2001 | 2001 | ||
| 2002 | @vindex top-visible, a frame parameter | 2002 | @vindex top-visible@r{, a frame parameter} |
| 2003 | @item top-visible | 2003 | @item top-visible |
| 2004 | If this parameter is a number, the top edge of the frame never appears | 2004 | If this parameter is a number, the top edge of the frame never appears |
| 2005 | above the top edge of its display or parent frame. Moreover, as many | 2005 | above the top edge of its display or parent frame. Moreover, as many |
| @@ -2010,7 +2010,7 @@ dragging a child frame with a non-@code{nil} | |||
| 2010 | @code{drag-with-header-line} parameter completely out of the area | 2010 | @code{drag-with-header-line} parameter completely out of the area |
| 2011 | of its parent frame. | 2011 | of its parent frame. |
| 2012 | 2012 | ||
| 2013 | @vindex bottom-visible, a frame parameter | 2013 | @vindex bottom-visible@r{, a frame parameter} |
| 2014 | @item bottom-visible | 2014 | @item bottom-visible |
| 2015 | If this parameter is a number, the bottom edge of the frame never | 2015 | If this parameter is a number, the bottom edge of the frame never |
| 2016 | appears below the bottom edge of its display or parent frame. Moreover, | 2016 | appears below the bottom edge of its display or parent frame. Moreover, |
| @@ -2032,66 +2032,66 @@ interaction with the window manager or window system. They have no | |||
| 2032 | effect on text terminals. | 2032 | effect on text terminals. |
| 2033 | 2033 | ||
| 2034 | @table @code | 2034 | @table @code |
| 2035 | @vindex visibility, a frame parameter | 2035 | @vindex visibility@r{, a frame parameter} |
| 2036 | @item visibility | 2036 | @item visibility |
| 2037 | The state of visibility of the frame. There are three possibilities: | 2037 | The state of visibility of the frame. There are three possibilities: |
| 2038 | @code{nil} for invisible, @code{t} for visible, and @code{icon} for | 2038 | @code{nil} for invisible, @code{t} for visible, and @code{icon} for |
| 2039 | iconified. @xref{Visibility of Frames}. | 2039 | iconified. @xref{Visibility of Frames}. |
| 2040 | 2040 | ||
| 2041 | @vindex auto-raise, a frame parameter | 2041 | @vindex auto-raise@r{, a frame parameter} |
| 2042 | @item auto-raise | 2042 | @item auto-raise |
| 2043 | If non-@code{nil}, Emacs automatically raises the frame when it is | 2043 | If non-@code{nil}, Emacs automatically raises the frame when it is |
| 2044 | selected. Some window managers do not allow this. | 2044 | selected. Some window managers do not allow this. |
| 2045 | 2045 | ||
| 2046 | @vindex auto-lower, a frame parameter | 2046 | @vindex auto-lower@r{, a frame parameter} |
| 2047 | @item auto-lower | 2047 | @item auto-lower |
| 2048 | If non-@code{nil}, Emacs automatically lowers the frame when it is | 2048 | If non-@code{nil}, Emacs automatically lowers the frame when it is |
| 2049 | deselected. Some window managers do not allow this. | 2049 | deselected. Some window managers do not allow this. |
| 2050 | 2050 | ||
| 2051 | @vindex icon-type, a frame parameter | 2051 | @vindex icon-type@r{, a frame parameter} |
| 2052 | @item icon-type | 2052 | @item icon-type |
| 2053 | The type of icon to use for this frame. If the value is a string, | 2053 | The type of icon to use for this frame. If the value is a string, |
| 2054 | that specifies a file containing a bitmap to use; @code{nil} specifies | 2054 | that specifies a file containing a bitmap to use; @code{nil} specifies |
| 2055 | no icon (in which case the window manager decides what to show); any | 2055 | no icon (in which case the window manager decides what to show); any |
| 2056 | other non-@code{nil} value specifies the default Emacs icon. | 2056 | other non-@code{nil} value specifies the default Emacs icon. |
| 2057 | 2057 | ||
| 2058 | @vindex icon-name, a frame parameter | 2058 | @vindex icon-name@r{, a frame parameter} |
| 2059 | @item icon-name | 2059 | @item icon-name |
| 2060 | The name to use in the icon for this frame, when and if the icon | 2060 | The name to use in the icon for this frame, when and if the icon |
| 2061 | appears. If this is @code{nil}, the frame's title is used. | 2061 | appears. If this is @code{nil}, the frame's title is used. |
| 2062 | 2062 | ||
| 2063 | @vindex window-id, a frame parameter | 2063 | @vindex window-id@r{, a frame parameter} |
| 2064 | @item window-id | 2064 | @item window-id |
| 2065 | The ID number which the graphical display uses for this frame. Emacs | 2065 | The ID number which the graphical display uses for this frame. Emacs |
| 2066 | assigns this parameter when the frame is created; changing the | 2066 | assigns this parameter when the frame is created; changing the |
| 2067 | parameter has no effect on the actual ID number. | 2067 | parameter has no effect on the actual ID number. |
| 2068 | 2068 | ||
| 2069 | @vindex outer-window-id, a frame parameter | 2069 | @vindex outer-window-id@r{, a frame parameter} |
| 2070 | @item outer-window-id | 2070 | @item outer-window-id |
| 2071 | The ID number of the outermost window-system window in which the frame | 2071 | The ID number of the outermost window-system window in which the frame |
| 2072 | exists. As with @code{window-id}, changing this parameter has no | 2072 | exists. As with @code{window-id}, changing this parameter has no |
| 2073 | actual effect. | 2073 | actual effect. |
| 2074 | 2074 | ||
| 2075 | @vindex wait-for-wm, a frame parameter | 2075 | @vindex wait-for-wm@r{, a frame parameter} |
| 2076 | @item wait-for-wm | 2076 | @item wait-for-wm |
| 2077 | If non-@code{nil}, tell Xt to wait for the window manager to confirm | 2077 | If non-@code{nil}, tell Xt to wait for the window manager to confirm |
| 2078 | geometry changes. Some window managers, including versions of Fvwm2 | 2078 | geometry changes. Some window managers, including versions of Fvwm2 |
| 2079 | and KDE, fail to confirm, so Xt hangs. Set this to @code{nil} to | 2079 | and KDE, fail to confirm, so Xt hangs. Set this to @code{nil} to |
| 2080 | prevent hanging with those window managers. | 2080 | prevent hanging with those window managers. |
| 2081 | 2081 | ||
| 2082 | @vindex sticky, a frame parameter | 2082 | @vindex sticky@r{, a frame parameter} |
| 2083 | @item sticky | 2083 | @item sticky |
| 2084 | If non-@code{nil}, the frame is visible on all virtual desktops on systems | 2084 | If non-@code{nil}, the frame is visible on all virtual desktops on systems |
| 2085 | with virtual desktops. | 2085 | with virtual desktops. |
| 2086 | 2086 | ||
| 2087 | @vindex inhibit-double-buffering, a frame parameter | 2087 | @vindex inhibit-double-buffering@r{, a frame parameter} |
| 2088 | @item inhibit-double-buffering | 2088 | @item inhibit-double-buffering |
| 2089 | If non-@code{nil}, the frame is drawn to the screen without double | 2089 | If non-@code{nil}, the frame is drawn to the screen without double |
| 2090 | buffering. Emacs normally attempts to use double buffering, where | 2090 | buffering. Emacs normally attempts to use double buffering, where |
| 2091 | available, to reduce flicker. Set this property if you experience | 2091 | available, to reduce flicker. Set this property if you experience |
| 2092 | display bugs or pine for that retro, flicker-y feeling. | 2092 | display bugs or pine for that retro, flicker-y feeling. |
| 2093 | 2093 | ||
| 2094 | @vindex skip-taskbar, a frame parameter | 2094 | @vindex skip-taskbar@r{, a frame parameter} |
| 2095 | @item skip-taskbar | 2095 | @item skip-taskbar |
| 2096 | If non-@code{nil}, this tells the window manager to remove the frame's | 2096 | If non-@code{nil}, this tells the window manager to remove the frame's |
| 2097 | icon from the taskbar associated with the frame's display and inhibit | 2097 | icon from the taskbar associated with the frame's display and inhibit |
| @@ -2100,13 +2100,13 @@ On MS-Windows, iconifying such a frame will "roll in" its window-system | |||
| 2100 | window at the bottom of the desktop. Some window managers may not honor | 2100 | window at the bottom of the desktop. Some window managers may not honor |
| 2101 | this parameter. | 2101 | this parameter. |
| 2102 | 2102 | ||
| 2103 | @vindex no-focus-on-map, a frame parameter | 2103 | @vindex no-focus-on-map@r{, a frame parameter} |
| 2104 | @item no-focus-on-map | 2104 | @item no-focus-on-map |
| 2105 | If non-@code{nil}, this means that the frame does not want to receive | 2105 | If non-@code{nil}, this means that the frame does not want to receive |
| 2106 | input focus when it is mapped (@pxref{Visibility of Frames}). Some | 2106 | input focus when it is mapped (@pxref{Visibility of Frames}). Some |
| 2107 | window managers may not honor this parameter. | 2107 | window managers may not honor this parameter. |
| 2108 | 2108 | ||
| 2109 | @vindex no-accept-focus, a frame parameter | 2109 | @vindex no-accept-focus@r{, a frame parameter} |
| 2110 | @item no-accept-focus | 2110 | @item no-accept-focus |
| 2111 | If non-@code{nil}, this means that the frame does not want to receive | 2111 | If non-@code{nil}, this means that the frame does not want to receive |
| 2112 | input focus via explicit mouse clicks or when moving the mouse into it | 2112 | input focus via explicit mouse clicks or when moving the mouse into it |
| @@ -2116,7 +2116,7 @@ This may have the unwanted side-effect that a user cannot scroll a | |||
| 2116 | non-selected frame with the mouse. Some window managers may not honor | 2116 | non-selected frame with the mouse. Some window managers may not honor |
| 2117 | this parameter. | 2117 | this parameter. |
| 2118 | 2118 | ||
| 2119 | @vindex undecorated, a frame parameter | 2119 | @vindex undecorated@r{, a frame parameter} |
| 2120 | @item undecorated | 2120 | @item undecorated |
| 2121 | If non-@code{nil}, this frame's window-system window is drawn without | 2121 | If non-@code{nil}, this frame's window-system window is drawn without |
| 2122 | decorations, like the title, minimize/maximize boxes and external | 2122 | decorations, like the title, minimize/maximize boxes and external |
| @@ -2131,7 +2131,7 @@ decorations. Some window managers may not honor these hints. | |||
| 2131 | NS builds consider the tool bar to be a decoration, and therefore hide | 2131 | NS builds consider the tool bar to be a decoration, and therefore hide |
| 2132 | it on an undecorated frame. | 2132 | it on an undecorated frame. |
| 2133 | 2133 | ||
| 2134 | @vindex override-redirect, a frame parameter | 2134 | @vindex override-redirect@r{, a frame parameter} |
| 2135 | @item override-redirect | 2135 | @item override-redirect |
| 2136 | @cindex override redirect frames | 2136 | @cindex override redirect frames |
| 2137 | If non-@code{nil}, this means that this is an @dfn{override redirect} | 2137 | If non-@code{nil}, this means that this is an @dfn{override redirect} |
| @@ -2142,7 +2142,7 @@ usually drawn on top of all other frames. Setting this parameter has | |||
| 2142 | no effect on MS-Windows. | 2142 | no effect on MS-Windows. |
| 2143 | 2143 | ||
| 2144 | @ignore | 2144 | @ignore |
| 2145 | @vindex parent-id, a frame parameter | 2145 | @vindex parent-id@r{, a frame parameter} |
| 2146 | @item parent-id | 2146 | @item parent-id |
| 2147 | @c ??? Not yet working. | 2147 | @c ??? Not yet working. |
| 2148 | The X window number of the window that should be the parent of this one. | 2148 | The X window number of the window that should be the parent of this one. |
| @@ -2151,7 +2151,7 @@ application's window. (It is not certain this will be implemented; try | |||
| 2151 | it and see if it works.) | 2151 | it and see if it works.) |
| 2152 | @end ignore | 2152 | @end ignore |
| 2153 | 2153 | ||
| 2154 | @vindex ns-appearance, a frame parameter | 2154 | @vindex ns-appearance@r{, a frame parameter} |
| 2155 | @item ns-appearance | 2155 | @item ns-appearance |
| 2156 | Only available on macOS, if set to @code{dark} draw this frame's | 2156 | Only available on macOS, if set to @code{dark} draw this frame's |
| 2157 | window-system window using the ``vibrant dark'' theme, otherwise use | 2157 | window-system window using the ``vibrant dark'' theme, otherwise use |
| @@ -2159,7 +2159,7 @@ the system default. The ``vibrant dark'' theme can be used to set the | |||
| 2159 | toolbar and scrollbars to a dark appearance when using an Emacs theme | 2159 | toolbar and scrollbars to a dark appearance when using an Emacs theme |
| 2160 | with a dark background. | 2160 | with a dark background. |
| 2161 | 2161 | ||
| 2162 | @vindex ns-transparent-titlebar, a frame parameter | 2162 | @vindex ns-transparent-titlebar@r{, a frame parameter} |
| 2163 | @item ns-transparent-titlebar | 2163 | @item ns-transparent-titlebar |
| 2164 | Only available on macOS, if non-@code{nil}, set the titlebar and | 2164 | Only available on macOS, if non-@code{nil}, set the titlebar and |
| 2165 | toolbar to be transparent. This effectively sets the background color | 2165 | toolbar to be transparent. This effectively sets the background color |
| @@ -2174,7 +2174,7 @@ of both to match the Emacs background color. | |||
| 2174 | This frame parameter controls the way the cursor looks. | 2174 | This frame parameter controls the way the cursor looks. |
| 2175 | 2175 | ||
| 2176 | @table @code | 2176 | @table @code |
| 2177 | @vindex cursor-type, a frame parameter | 2177 | @vindex cursor-type@r{, a frame parameter} |
| 2178 | @item cursor-type | 2178 | @item cursor-type |
| 2179 | How to display the cursor. Legitimate values are: | 2179 | How to display the cursor. Legitimate values are: |
| 2180 | 2180 | ||
| @@ -2252,7 +2252,7 @@ variable do not take effect immediately, only when you specify the | |||
| 2252 | These frame parameters control the use of fonts and colors. | 2252 | These frame parameters control the use of fonts and colors. |
| 2253 | 2253 | ||
| 2254 | @table @code | 2254 | @table @code |
| 2255 | @vindex font-backend, a frame parameter | 2255 | @vindex font-backend@r{, a frame parameter} |
| 2256 | @item font-backend | 2256 | @item font-backend |
| 2257 | A list of symbols, specifying the @dfn{font backends} to use for | 2257 | A list of symbols, specifying the @dfn{font backends} to use for |
| 2258 | drawing fonts in the frame, in order of priority. On X, there are | 2258 | drawing fonts in the frame, in order of priority. On X, there are |
| @@ -2263,12 +2263,12 @@ currently two available font backends: @code{gdi} and | |||
| 2263 | Manual}). On other systems, there is only one available font backend, | 2263 | Manual}). On other systems, there is only one available font backend, |
| 2264 | so it does not make sense to modify this frame parameter. | 2264 | so it does not make sense to modify this frame parameter. |
| 2265 | 2265 | ||
| 2266 | @vindex background-mode, a frame parameter | 2266 | @vindex background-mode@r{, a frame parameter} |
| 2267 | @item background-mode | 2267 | @item background-mode |
| 2268 | This parameter is either @code{dark} or @code{light}, according | 2268 | This parameter is either @code{dark} or @code{light}, according |
| 2269 | to whether the background color is a light one or a dark one. | 2269 | to whether the background color is a light one or a dark one. |
| 2270 | 2270 | ||
| 2271 | @vindex tty-color-mode, a frame parameter | 2271 | @vindex tty-color-mode@r{, a frame parameter} |
| 2272 | @item tty-color-mode | 2272 | @item tty-color-mode |
| 2273 | @cindex standard colors for character terminals | 2273 | @cindex standard colors for character terminals |
| 2274 | This parameter overrides the terminal's color support as given by the | 2274 | This parameter overrides the terminal's color support as given by the |
| @@ -2277,14 +2277,14 @@ specifies the color mode to use on a text terminal. The value can be | |||
| 2277 | either a symbol or a number. A number specifies the number of colors | 2277 | either a symbol or a number. A number specifies the number of colors |
| 2278 | to use (and, indirectly, what commands to issue to produce each | 2278 | to use (and, indirectly, what commands to issue to produce each |
| 2279 | color). For example, @code{(tty-color-mode . 8)} specifies use of the | 2279 | color). For example, @code{(tty-color-mode . 8)} specifies use of the |
| 2280 | ANSI escape sequences for 8 standard text colors. A value of -1 turns | 2280 | ANSI escape sequences for 8 standard text colors. A value of @minus{}1 turns |
| 2281 | off color support. | 2281 | off color support. |
| 2282 | 2282 | ||
| 2283 | If the parameter's value is a symbol, it specifies a number through | 2283 | If the parameter's value is a symbol, it specifies a number through |
| 2284 | the value of @code{tty-color-mode-alist}, and the associated number is | 2284 | the value of @code{tty-color-mode-alist}, and the associated number is |
| 2285 | used instead. | 2285 | used instead. |
| 2286 | 2286 | ||
| 2287 | @vindex screen-gamma, a frame parameter | 2287 | @vindex screen-gamma@r{, a frame parameter} |
| 2288 | @item screen-gamma | 2288 | @item screen-gamma |
| 2289 | @cindex gamma correction | 2289 | @cindex gamma correction |
| 2290 | If this is a number, Emacs performs gamma correction which adjusts | 2290 | If this is a number, Emacs performs gamma correction which adjusts |
| @@ -2304,7 +2304,7 @@ If your monitor displays colors too light, you should specify a | |||
| 2304 | that makes colors darker. A screen gamma value of 1.5 may give good | 2304 | that makes colors darker. A screen gamma value of 1.5 may give good |
| 2305 | results for LCD color displays. | 2305 | results for LCD color displays. |
| 2306 | 2306 | ||
| 2307 | @vindex alpha, a frame parameter | 2307 | @vindex alpha@r{, a frame parameter} |
| 2308 | @item alpha | 2308 | @item alpha |
| 2309 | @cindex opacity, frame | 2309 | @cindex opacity, frame |
| 2310 | @cindex transparency, frame | 2310 | @cindex transparency, frame |
| @@ -2335,45 +2335,45 @@ automatically equivalent to particular face attributes of particular | |||
| 2335 | faces (@pxref{Standard Faces,,, emacs, The Emacs Manual}): | 2335 | faces (@pxref{Standard Faces,,, emacs, The Emacs Manual}): |
| 2336 | 2336 | ||
| 2337 | @table @code | 2337 | @table @code |
| 2338 | @vindex font, a frame parameter | 2338 | @vindex font@r{, a frame parameter} |
| 2339 | @item font | 2339 | @item font |
| 2340 | The name of the font for displaying text in the frame. This is a | 2340 | The name of the font for displaying text in the frame. This is a |
| 2341 | string, either a valid font name for your system or the name of an Emacs | 2341 | string, either a valid font name for your system or the name of an Emacs |
| 2342 | fontset (@pxref{Fontsets}). It is equivalent to the @code{font} | 2342 | fontset (@pxref{Fontsets}). It is equivalent to the @code{font} |
| 2343 | attribute of the @code{default} face. | 2343 | attribute of the @code{default} face. |
| 2344 | 2344 | ||
| 2345 | @vindex foreground-color, a frame parameter | 2345 | @vindex foreground-color@r{, a frame parameter} |
| 2346 | @item foreground-color | 2346 | @item foreground-color |
| 2347 | The color to use for the image of a character. It is equivalent to | 2347 | The color to use for the image of a character. It is equivalent to |
| 2348 | the @code{:foreground} attribute of the @code{default} face. | 2348 | the @code{:foreground} attribute of the @code{default} face. |
| 2349 | 2349 | ||
| 2350 | @vindex background-color, a frame parameter | 2350 | @vindex background-color@r{, a frame parameter} |
| 2351 | @item background-color | 2351 | @item background-color |
| 2352 | The color to use for the background of characters. It is equivalent to | 2352 | The color to use for the background of characters. It is equivalent to |
| 2353 | the @code{:background} attribute of the @code{default} face. | 2353 | the @code{:background} attribute of the @code{default} face. |
| 2354 | 2354 | ||
| 2355 | @vindex mouse-color, a frame parameter | 2355 | @vindex mouse-color@r{, a frame parameter} |
| 2356 | @item mouse-color | 2356 | @item mouse-color |
| 2357 | The color for the mouse pointer. It is equivalent to the @code{:background} | 2357 | The color for the mouse pointer. It is equivalent to the @code{:background} |
| 2358 | attribute of the @code{mouse} face. | 2358 | attribute of the @code{mouse} face. |
| 2359 | 2359 | ||
| 2360 | @vindex cursor-color, a frame parameter | 2360 | @vindex cursor-color@r{, a frame parameter} |
| 2361 | @item cursor-color | 2361 | @item cursor-color |
| 2362 | The color for the cursor that shows point. It is equivalent to the | 2362 | The color for the cursor that shows point. It is equivalent to the |
| 2363 | @code{:background} attribute of the @code{cursor} face. | 2363 | @code{:background} attribute of the @code{cursor} face. |
| 2364 | 2364 | ||
| 2365 | @vindex border-color, a frame parameter | 2365 | @vindex border-color@r{, a frame parameter} |
| 2366 | @item border-color | 2366 | @item border-color |
| 2367 | The color for the border of the frame. It is equivalent to the | 2367 | The color for the border of the frame. It is equivalent to the |
| 2368 | @code{:background} attribute of the @code{border} face. | 2368 | @code{:background} attribute of the @code{border} face. |
| 2369 | 2369 | ||
| 2370 | @vindex scroll-bar-foreground, a frame parameter | 2370 | @vindex scroll-bar-foreground@r{, a frame parameter} |
| 2371 | @item scroll-bar-foreground | 2371 | @item scroll-bar-foreground |
| 2372 | If non-@code{nil}, the color for the foreground of scroll bars. It is | 2372 | If non-@code{nil}, the color for the foreground of scroll bars. It is |
| 2373 | equivalent to the @code{:foreground} attribute of the | 2373 | equivalent to the @code{:foreground} attribute of the |
| 2374 | @code{scroll-bar} face. | 2374 | @code{scroll-bar} face. |
| 2375 | 2375 | ||
| 2376 | @vindex scroll-bar-background, a frame parameter | 2376 | @vindex scroll-bar-background@r{, a frame parameter} |
| 2377 | @item scroll-bar-background | 2377 | @item scroll-bar-background |
| 2378 | If non-@code{nil}, the color for the background of scroll bars. It is | 2378 | If non-@code{nil}, the color for the background of scroll bars. It is |
| 2379 | equivalent to the @code{:background} attribute of the | 2379 | equivalent to the @code{:background} attribute of the |
diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi index 9090956d837..db59463235f 100644 --- a/doc/lispref/functions.texi +++ b/doc/lispref/functions.texi | |||
| @@ -1634,7 +1634,7 @@ anonymous function. | |||
| 1634 | This specifies how to order the advice, should several pieces of | 1634 | This specifies how to order the advice, should several pieces of |
| 1635 | advice be present. By default, the depth is 0. A depth of 100 | 1635 | advice be present. By default, the depth is 0. A depth of 100 |
| 1636 | indicates that this piece of advice should be kept as deep as | 1636 | indicates that this piece of advice should be kept as deep as |
| 1637 | possible, whereas a depth of -100 indicates that it should stay as the | 1637 | possible, whereas a depth of @minus{}100 indicates that it should stay as the |
| 1638 | outermost piece. When two pieces of advice specify the same depth, | 1638 | outermost piece. When two pieces of advice specify the same depth, |
| 1639 | the most recently added one will be outermost. | 1639 | the most recently added one will be outermost. |
| 1640 | 1640 | ||
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index be2d148a1e2..0e30ad519a8 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi | |||
| @@ -1322,7 +1322,7 @@ or rounding errors occur. | |||
| 1322 | @section Time Zone Rules | 1322 | @section Time Zone Rules |
| 1323 | @cindex time zone rules | 1323 | @cindex time zone rules |
| 1324 | 1324 | ||
| 1325 | @vindex TZ, environment variable | 1325 | @vindex TZ@r{, environment variable} |
| 1326 | The default time zone is determined by the @env{TZ} environment | 1326 | The default time zone is determined by the @env{TZ} environment |
| 1327 | variable. @xref{System Environment}. For example, you can tell Emacs | 1327 | variable. @xref{System Environment}. For example, you can tell Emacs |
| 1328 | to default to Universal Time with @code{(setenv "TZ" "UTC0")}. If | 1328 | to default to Universal Time with @code{(setenv "TZ" "UTC0")}. If |
| @@ -1478,7 +1478,8 @@ on others, years as early as 1901 do work. | |||
| 1478 | @cindex formatting time values | 1478 | @cindex formatting time values |
| 1479 | 1479 | ||
| 1480 | These functions convert time values to text in a string, and vice versa. | 1480 | These functions convert time values to text in a string, and vice versa. |
| 1481 | Time values are lists of two to four integers (@pxref{Time of Day}). | 1481 | Time values include @code{nil}, numbers, and lists of two to four |
| 1482 | integers (@pxref{Time of Day}). | ||
| 1482 | 1483 | ||
| 1483 | @defun date-to-time string | 1484 | @defun date-to-time string |
| 1484 | This function parses the time-string @var{string} and returns the | 1485 | This function parses the time-string @var{string} and returns the |
diff --git a/doc/lispref/positions.texi b/doc/lispref/positions.texi index c89a87c2bb8..0a03e246c01 100644 --- a/doc/lispref/positions.texi +++ b/doc/lispref/positions.texi | |||
| @@ -602,7 +602,7 @@ line @var{count} screen lines from the top of the window; zero means | |||
| 602 | the topmost line. If @var{count} is negative, that specifies a | 602 | the topmost line. If @var{count} is negative, that specifies a |
| 603 | position @w{@minus{}@var{count}} lines from the bottom (or the last | 603 | position @w{@minus{}@var{count}} lines from the bottom (or the last |
| 604 | line of the buffer, if the buffer ends above the specified screen | 604 | line of the buffer, if the buffer ends above the specified screen |
| 605 | position); thus, @var{count} of -1 specifies the last fully visible | 605 | position); thus, @var{count} of @minus{}1 specifies the last fully visible |
| 606 | screen line of the window. | 606 | screen line of the window. |
| 607 | 607 | ||
| 608 | If @var{count} is @code{nil}, then point moves to the beginning of the | 608 | If @var{count} is @code{nil}, then point moves to the beginning of the |
diff --git a/doc/lispref/strings.texi b/doc/lispref/strings.texi index c8261e316f2..5452ea68790 100644 --- a/doc/lispref/strings.texi +++ b/doc/lispref/strings.texi | |||
| @@ -927,7 +927,7 @@ floating-point number. | |||
| 927 | @item %g | 927 | @item %g |
| 928 | Replace the specification with notation for a floating-point number, | 928 | Replace the specification with notation for a floating-point number, |
| 929 | using either exponential notation or decimal-point notation. The | 929 | using either exponential notation or decimal-point notation. The |
| 930 | exponential notation is used if the exponent would be less than -4 or | 930 | exponential notation is used if the exponent would be less than @minus{}4 or |
| 931 | greater than or equal to the precision (default: 6). By default, | 931 | greater than or equal to the precision (default: 6). By default, |
| 932 | trailing zeros are removed from the fractional portion of the result | 932 | trailing zeros are removed from the fractional portion of the result |
| 933 | and a decimal-point character appears only if it is followed by a | 933 | and a decimal-point character appears only if it is followed by a |
diff --git a/doc/lispref/syntax.texi b/doc/lispref/syntax.texi index fd461b755c0..3327d7855c4 100644 --- a/doc/lispref/syntax.texi +++ b/doc/lispref/syntax.texi | |||
| @@ -972,6 +972,10 @@ encodes the syntax class and syntax flags, according to the table | |||
| 972 | below. @var{matching-char}, if non-@code{nil}, specifies a matching | 972 | below. @var{matching-char}, if non-@code{nil}, specifies a matching |
| 973 | character (similar to the second character in a syntax descriptor). | 973 | character (similar to the second character in a syntax descriptor). |
| 974 | 974 | ||
| 975 | @cindex syntax tables (accessing elements of) | ||
| 976 | Use @code{aref} (@pxref{Array Functions}) to get the raw syntax | ||
| 977 | descriptor of a character, e.g. @w{@code{(aref (syntax-table) ch)}}. | ||
| 978 | |||
| 975 | Here are the syntax codes corresponding to the various syntax | 979 | Here are the syntax codes corresponding to the various syntax |
| 976 | classes: | 980 | classes: |
| 977 | 981 | ||
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 687d5971920..75651b99fde 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -5014,43 +5014,43 @@ code: | |||
| 5014 | 5014 | ||
| 5015 | @table @code | 5015 | @table @code |
| 5016 | @item delete-window | 5016 | @item delete-window |
| 5017 | @vindex delete-window, a window parameter | 5017 | @vindex delete-window@r{, a window parameter} |
| 5018 | This parameter affects the execution of @code{delete-window} | 5018 | This parameter affects the execution of @code{delete-window} |
| 5019 | (@pxref{Deleting Windows}). | 5019 | (@pxref{Deleting Windows}). |
| 5020 | 5020 | ||
| 5021 | @item delete-other-windows | 5021 | @item delete-other-windows |
| 5022 | @vindex delete-other-windows, a window parameter | 5022 | @vindex delete-other-windows@r{, a window parameter} |
| 5023 | This parameter affects the execution of @code{delete-other-windows} | 5023 | This parameter affects the execution of @code{delete-other-windows} |
| 5024 | (@pxref{Deleting Windows}). | 5024 | (@pxref{Deleting Windows}). |
| 5025 | 5025 | ||
| 5026 | @item no-delete-other-windows | 5026 | @item no-delete-other-windows |
| 5027 | @vindex no-delete-other-windows, a window parameter | 5027 | @vindex no-delete-other-windows@r{, a window parameter} |
| 5028 | This parameter marks the window as not deletable by | 5028 | This parameter marks the window as not deletable by |
| 5029 | @code{delete-other-windows} (@pxref{Deleting Windows}). | 5029 | @code{delete-other-windows} (@pxref{Deleting Windows}). |
| 5030 | 5030 | ||
| 5031 | @item split-window | 5031 | @item split-window |
| 5032 | @vindex split-window, a window parameter | 5032 | @vindex split-window@r{, a window parameter} |
| 5033 | This parameter affects the execution of @code{split-window} | 5033 | This parameter affects the execution of @code{split-window} |
| 5034 | (@pxref{Splitting Windows}). | 5034 | (@pxref{Splitting Windows}). |
| 5035 | 5035 | ||
| 5036 | @item other-window | 5036 | @item other-window |
| 5037 | @vindex other-window, a window parameter | 5037 | @vindex other-window@r{, a window parameter} |
| 5038 | This parameter affects the execution of @code{other-window} | 5038 | This parameter affects the execution of @code{other-window} |
| 5039 | (@pxref{Cyclic Window Ordering}). | 5039 | (@pxref{Cyclic Window Ordering}). |
| 5040 | 5040 | ||
| 5041 | @item no-other-window | 5041 | @item no-other-window |
| 5042 | @vindex no-other-window, a window parameter | 5042 | @vindex no-other-window@r{, a window parameter} |
| 5043 | This parameter marks the window as not selectable by @code{other-window} | 5043 | This parameter marks the window as not selectable by @code{other-window} |
| 5044 | (@pxref{Cyclic Window Ordering}). | 5044 | (@pxref{Cyclic Window Ordering}). |
| 5045 | 5045 | ||
| 5046 | @item clone-of | 5046 | @item clone-of |
| 5047 | @vindex clone-of, a window parameter | 5047 | @vindex clone-of@r{, a window parameter} |
| 5048 | This parameter specifies the window that this one has been cloned | 5048 | This parameter specifies the window that this one has been cloned |
| 5049 | from. It is installed by @code{window-state-get} (@pxref{Window | 5049 | from. It is installed by @code{window-state-get} (@pxref{Window |
| 5050 | Configurations}). | 5050 | Configurations}). |
| 5051 | 5051 | ||
| 5052 | @item window-preserved-size | 5052 | @item window-preserved-size |
| 5053 | @vindex window-preserved-size, a window parameter | 5053 | @vindex window-preserved-size@r{, a window parameter} |
| 5054 | This parameter specifies a buffer, a direction where @code{nil} means | 5054 | This parameter specifies a buffer, a direction where @code{nil} means |
| 5055 | vertical and @code{t} horizontal, and a size in pixels. If this window | 5055 | vertical and @code{t} horizontal, and a size in pixels. If this window |
| 5056 | displays the specified buffer and its size in the indicated direction | 5056 | displays the specified buffer and its size in the indicated direction |
| @@ -5060,7 +5060,7 @@ parameter is installed and updated by the function | |||
| 5060 | @code{window-preserve-size} (@pxref{Preserving Window Sizes}). | 5060 | @code{window-preserve-size} (@pxref{Preserving Window Sizes}). |
| 5061 | 5061 | ||
| 5062 | @item quit-restore | 5062 | @item quit-restore |
| 5063 | @vindex quit-restore, a window parameter | 5063 | @vindex quit-restore@r{, a window parameter} |
| 5064 | This parameter is installed by the buffer display functions | 5064 | This parameter is installed by the buffer display functions |
| 5065 | (@pxref{Choosing Window}) and consulted by @code{quit-restore-window} | 5065 | (@pxref{Choosing Window}) and consulted by @code{quit-restore-window} |
| 5066 | (@pxref{Quitting Windows}). It contains four elements: | 5066 | (@pxref{Quitting Windows}). It contains four elements: |
| @@ -5092,18 +5092,18 @@ See the description of @code{quit-restore-window} in @ref{Quitting | |||
| 5092 | Windows} for details. | 5092 | Windows} for details. |
| 5093 | 5093 | ||
| 5094 | @item window-side window-slot | 5094 | @item window-side window-slot |
| 5095 | @vindex window-side, a window parameter | 5095 | @vindex window-side@r{, a window parameter} |
| 5096 | @vindex window-slot, a window parameter | 5096 | @vindex window-slot@r{, a window parameter} |
| 5097 | These parameters are used for implementing side windows (@pxref{Side | 5097 | These parameters are used for implementing side windows (@pxref{Side |
| 5098 | Windows}). | 5098 | Windows}). |
| 5099 | 5099 | ||
| 5100 | @item window-atom | 5100 | @item window-atom |
| 5101 | @vindex window-atom, a window parameter | 5101 | @vindex window-atom@r{, a window parameter} |
| 5102 | This parameter is used for implementing atomic windows, see @ref{Atomic | 5102 | This parameter is used for implementing atomic windows, see @ref{Atomic |
| 5103 | Windows}. | 5103 | Windows}. |
| 5104 | 5104 | ||
| 5105 | @item mode-line-format | 5105 | @item mode-line-format |
| 5106 | @vindex mode-line-format, a window parameter | 5106 | @vindex mode-line-format@r{, a window parameter} |
| 5107 | This parameter replaces the value of the buffer-local variable | 5107 | This parameter replaces the value of the buffer-local variable |
| 5108 | @code{mode-line-format} (@pxref{Mode Line Basics}) of this window's | 5108 | @code{mode-line-format} (@pxref{Mode Line Basics}) of this window's |
| 5109 | buffer whenever this window is displayed. The symbol @code{none} means | 5109 | buffer whenever this window is displayed. The symbol @code{none} means |
| @@ -5112,7 +5112,7 @@ contents of the mode line on other windows showing this buffer are not | |||
| 5112 | affected. | 5112 | affected. |
| 5113 | 5113 | ||
| 5114 | @item header-line-format | 5114 | @item header-line-format |
| 5115 | @vindex header-line-format, a window parameter | 5115 | @vindex header-line-format@r{, a window parameter} |
| 5116 | This parameter replaces the value of the buffer-local variable | 5116 | This parameter replaces the value of the buffer-local variable |
| 5117 | @code{header-line-format} (@pxref{Mode Line Basics}) of this window's | 5117 | @code{header-line-format} (@pxref{Mode Line Basics}) of this window's |
| 5118 | buffer whenever this window is displayed. The symbol @code{none} means | 5118 | buffer whenever this window is displayed. The symbol @code{none} means |
| @@ -5121,7 +5121,7 @@ contents of the header line on other windows showing this buffer are not | |||
| 5121 | affected. | 5121 | affected. |
| 5122 | 5122 | ||
| 5123 | @item min-margins | 5123 | @item min-margins |
| 5124 | @vindex min-margins, a window parameter | 5124 | @vindex min-margins@r{, a window parameter} |
| 5125 | The value of this parameter is a cons cell whose @sc{car} and @sc{cdr}, | 5125 | The value of this parameter is a cons cell whose @sc{car} and @sc{cdr}, |
| 5126 | if non-@code{nil}, specify the minimum values (in columns) for the left | 5126 | if non-@code{nil}, specify the minimum values (in columns) for the left |
| 5127 | and right margin of this window. When present, Emacs will use these | 5127 | and right margin of this window. When present, Emacs will use these |
diff --git a/doc/misc/calc.texi b/doc/misc/calc.texi index 40b16b0f3c9..a4a091f243a 100644 --- a/doc/misc/calc.texi +++ b/doc/misc/calc.texi | |||
| @@ -14242,7 +14242,7 @@ format in @TeX{} mode and in | |||
| 14242 | @samp{\begin@{pmatrix@} a & b \\ c & d \end@{pmatrix@}} format in | 14242 | @samp{\begin@{pmatrix@} a & b \\ c & d \end@{pmatrix@}} format in |
| 14243 | @LaTeX{} mode; you may need to edit this afterwards to change to your | 14243 | @LaTeX{} mode; you may need to edit this afterwards to change to your |
| 14244 | preferred matrix form. If you invoke @kbd{d T} or @kbd{d L} with an | 14244 | preferred matrix form. If you invoke @kbd{d T} or @kbd{d L} with an |
| 14245 | argument of 2 or -2, then matrices will be displayed in two-dimensional | 14245 | argument of 2 or @minus{}2, then matrices will be displayed in two-dimensional |
| 14246 | form, such as | 14246 | form, such as |
| 14247 | 14247 | ||
| 14248 | @example | 14248 | @example |
diff --git a/doc/misc/cc-mode.texi b/doc/misc/cc-mode.texi index 2de56fa05c0..a506213ea2d 100644 --- a/doc/misc/cc-mode.texi +++ b/doc/misc/cc-mode.texi | |||
| @@ -576,7 +576,7 @@ for the latest information on Emacs version and package compatibility | |||
| 576 | (@pxref{Updating CC Mode}). | 576 | (@pxref{Updating CC Mode}). |
| 577 | 577 | ||
| 578 | @deffn Command c-version | 578 | @deffn Command c-version |
| 579 | @findex version (c-) | 579 | @findex version @r{(c-)} |
| 580 | You can find out what version of @ccmode{} you are using by visiting a C | 580 | You can find out what version of @ccmode{} you are using by visiting a C |
| 581 | file and entering @kbd{M-x c-version RET}. You should see this message in | 581 | file and entering @kbd{M-x c-version RET}. You should see this message in |
| 582 | the echo area: | 582 | the echo area: |
| @@ -673,7 +673,7 @@ These commands indent code: | |||
| 673 | @item @kbd{@key{TAB}} (@code{c-indent-command}) | 673 | @item @kbd{@key{TAB}} (@code{c-indent-command}) |
| 674 | @kindex TAB | 674 | @kindex TAB |
| 675 | @findex c-indent-command | 675 | @findex c-indent-command |
| 676 | @findex indent-command (c-) | 676 | @findex indent-command @r{(c-)} |
| 677 | This command indents the current line. That is all you need to know | 677 | This command indents the current line. That is all you need to know |
| 678 | about it for normal use. | 678 | about it for normal use. |
| 679 | 679 | ||
| @@ -693,7 +693,7 @@ that begins at the line's left margin. | |||
| 693 | @item | 693 | @item |
| 694 | When it's @code{nil}, the command indents the line by an extra | 694 | When it's @code{nil}, the command indents the line by an extra |
| 695 | @code{c-basic-offset} columns. A prefix argument acts as a | 695 | @code{c-basic-offset} columns. A prefix argument acts as a |
| 696 | multiplier. A bare prefix (@kbd{C-u @key{TAB}}) is equivalent to -1, | 696 | multiplier. A bare prefix (@kbd{C-u @key{TAB}}) is equivalent to @minus{}1, |
| 697 | removing @code{c-basic-offset} columns from the indentation. | 697 | removing @code{c-basic-offset} columns from the indentation. |
| 698 | @end itemize | 698 | @end itemize |
| 699 | 699 | ||
| @@ -707,7 +707,7 @@ you want only spaces. @xref{Just Spaces,,,@emacsman{}, | |||
| 707 | @emacsmantitle{}}. | 707 | @emacsmantitle{}}. |
| 708 | 708 | ||
| 709 | @defopt c-tab-always-indent | 709 | @defopt c-tab-always-indent |
| 710 | @vindex tab-always-indent (c-) | 710 | @vindex tab-always-indent @r{(c-)} |
| 711 | @cindex literal | 711 | @cindex literal |
| 712 | This variable modifies how @key{TAB} operates. | 712 | This variable modifies how @key{TAB} operates. |
| 713 | @itemize @bullet | 713 | @itemize @bullet |
| @@ -726,7 +726,7 @@ is within a string or comment, some whitespace is inserted. | |||
| 726 | @end defopt | 726 | @end defopt |
| 727 | 727 | ||
| 728 | @defopt c-insert-tab-function | 728 | @defopt c-insert-tab-function |
| 729 | @vindex insert-tab-function (c-) | 729 | @vindex insert-tab-function @r{(c-)} |
| 730 | @findex tab-to-tab-stop | 730 | @findex tab-to-tab-stop |
| 731 | When ``some whitespace'' is inserted as described above, what actually | 731 | When ``some whitespace'' is inserted as described above, what actually |
| 732 | happens is that the function stored in @code{c-insert-tab-function} is | 732 | happens is that the function stored in @code{c-insert-tab-function} is |
| @@ -756,7 +756,7 @@ very useful in this case. | |||
| 756 | @item @kbd{C-M-q} (@code{c-indent-exp}) | 756 | @item @kbd{C-M-q} (@code{c-indent-exp}) |
| 757 | @kindex C-M-q | 757 | @kindex C-M-q |
| 758 | @findex c-indent-exp | 758 | @findex c-indent-exp |
| 759 | @findex indent-exp (c-) | 759 | @findex indent-exp @r{(c-)} |
| 760 | Indents an entire balanced brace or parenthesis expression. Note that | 760 | Indents an entire balanced brace or parenthesis expression. Note that |
| 761 | point must be on the opening brace or parenthesis of the expression | 761 | point must be on the opening brace or parenthesis of the expression |
| 762 | you want to indent. | 762 | you want to indent. |
| @@ -764,7 +764,7 @@ you want to indent. | |||
| 764 | @item @kbd{C-c C-q} (@code{c-indent-defun}) | 764 | @item @kbd{C-c C-q} (@code{c-indent-defun}) |
| 765 | @kindex C-c C-q | 765 | @kindex C-c C-q |
| 766 | @findex c-indent-defun | 766 | @findex c-indent-defun |
| 767 | @findex indent-defun (c-) | 767 | @findex indent-defun @r{(c-)} |
| 768 | Indents the entire top-level function, class or macro definition | 768 | Indents the entire top-level function, class or macro definition |
| 769 | encompassing point. It leaves point unchanged. This function can't be | 769 | encompassing point. It leaves point unchanged. This function can't be |
| 770 | used to reindent a nested brace construct, such as a nested class or | 770 | used to reindent a nested brace construct, such as a nested class or |
| @@ -782,7 +782,7 @@ and mark must delineate the region you want to indent. | |||
| 782 | @item @kbd{C-M-h} (@code{c-mark-function}) | 782 | @item @kbd{C-M-h} (@code{c-mark-function}) |
| 783 | @kindex C-M-h | 783 | @kindex C-M-h |
| 784 | @findex c-mark-function | 784 | @findex c-mark-function |
| 785 | @findex mark-function (c-) | 785 | @findex mark-function @r{(c-)} |
| 786 | While not strictly an indentation command, this is useful for marking | 786 | While not strictly an indentation command, this is useful for marking |
| 787 | the current top-level function or class definition as the current | 787 | the current top-level function or class definition as the current |
| 788 | region. As with @code{c-indent-defun}, this command operates on | 788 | region. As with @code{c-indent-defun}, this command operates on |
| @@ -798,7 +798,7 @@ indentation, otherwise only spaces are used. | |||
| 798 | @end defopt | 798 | @end defopt |
| 799 | 799 | ||
| 800 | @defopt c-progress-interval | 800 | @defopt c-progress-interval |
| 801 | @vindex progress-interval (c-) | 801 | @vindex progress-interval @r{(c-)} |
| 802 | When indenting large regions of code, this variable controls how often a | 802 | When indenting large regions of code, this variable controls how often a |
| 803 | progress message is displayed. Set this variable to @code{nil} to | 803 | progress message is displayed. Set this variable to @code{nil} to |
| 804 | inhibit the progress messages, or set it to an integer which is how | 804 | inhibit the progress messages, or set it to an integer which is how |
| @@ -845,7 +845,7 @@ together with any whitespace before it. This is a standard Emacs | |||
| 845 | command, but @ccmode{} enhances it a bit with two variables: | 845 | command, but @ccmode{} enhances it a bit with two variables: |
| 846 | 846 | ||
| 847 | @defopt c-indent-comment-alist | 847 | @defopt c-indent-comment-alist |
| 848 | @vindex indent-comment-alist (c-) | 848 | @vindex indent-comment-alist @r{(c-)} |
| 849 | @vindex comment-column | 849 | @vindex comment-column |
| 850 | This style variable allows you to vary the column that @kbd{M-;} puts | 850 | This style variable allows you to vary the column that @kbd{M-;} puts |
| 851 | the comment at, depending on what sort of code is on the line, and | 851 | the comment at, depending on what sort of code is on the line, and |
| @@ -860,7 +860,7 @@ variable (use @kbd{C-h v c-indent-comment-alist}). | |||
| 860 | @end defopt | 860 | @end defopt |
| 861 | 861 | ||
| 862 | @defopt c-indent-comments-syntactically-p | 862 | @defopt c-indent-comments-syntactically-p |
| 863 | @vindex indent-comments-syntactically-p (c-) | 863 | @vindex indent-comments-syntactically-p @r{(c-)} |
| 864 | Normally, when this style variable is @code{nil}, @kbd{M-;} will | 864 | Normally, when this style variable is @code{nil}, @kbd{M-;} will |
| 865 | indent comment-only lines according to @code{c-indent-comment-alist}, | 865 | indent comment-only lines according to @code{c-indent-comment-alist}, |
| 866 | just as it does with lines where other code precede the comments. | 866 | just as it does with lines where other code precede the comments. |
| @@ -889,7 +889,7 @@ lines. | |||
| 889 | @findex c-beginning-of-defun | 889 | @findex c-beginning-of-defun |
| 890 | @findex c-end-of-defun | 890 | @findex c-end-of-defun |
| 891 | @vindex c-defun-tactic | 891 | @vindex c-defun-tactic |
| 892 | @vindex defun-tactic (c-) | 892 | @vindex defun-tactic @r{(c-)} |
| 893 | 893 | ||
| 894 | Move to the beginning or end of the current or next function. Other | 894 | Move to the beginning or end of the current or next function. Other |
| 895 | constructs (such as a structs or classes) which have a brace block | 895 | constructs (such as a structs or classes) which have a brace block |
| @@ -923,9 +923,9 @@ must be in column zero. See @ref{Defuns,,,@emacsman{}, | |||
| 923 | @kindex C-M-a (AWK Mode) | 923 | @kindex C-M-a (AWK Mode) |
| 924 | @kindex C-M-e (AWK Mode) | 924 | @kindex C-M-e (AWK Mode) |
| 925 | @findex c-awk-beginning-of-defun | 925 | @findex c-awk-beginning-of-defun |
| 926 | @findex awk-beginning-of-defun (c-) | 926 | @findex awk-beginning-of-defun @r{(c-)} |
| 927 | @findex c-awk-end-of-defun | 927 | @findex c-awk-end-of-defun |
| 928 | @findex awk-end-of-defun (c-) | 928 | @findex awk-end-of-defun @r{(c-)} |
| 929 | Move to the beginning or end of the current or next AWK defun. These | 929 | Move to the beginning or end of the current or next AWK defun. These |
| 930 | commands can take prefix-arguments, their functionality being entirely | 930 | commands can take prefix-arguments, their functionality being entirely |
| 931 | equivalent to @code{beginning-of-defun} and @code{end-of-defun}. | 931 | equivalent to @code{beginning-of-defun} and @code{end-of-defun}. |
| @@ -941,8 +941,8 @@ modes, is neither necessary nor helpful in AWK mode. | |||
| 941 | @kindex M-e | 941 | @kindex M-e |
| 942 | @findex c-beginning-of-statement | 942 | @findex c-beginning-of-statement |
| 943 | @findex c-end-of-statement | 943 | @findex c-end-of-statement |
| 944 | @findex beginning-of-statement (c-) | 944 | @findex beginning-of-statement @r{(c-)} |
| 945 | @findex end-of-statement (c-) | 945 | @findex end-of-statement @r{(c-)} |
| 946 | Move to the beginning or end of the innermost C statement. If point | 946 | Move to the beginning or end of the innermost C statement. If point |
| 947 | is already there, move to the next beginning or end of a statement, | 947 | is already there, move to the next beginning or end of a statement, |
| 948 | even if that means moving into a block. (Use @kbd{C-M-b} or | 948 | even if that means moving into a block. (Use @kbd{C-M-b} or |
| @@ -961,7 +961,7 @@ strings. | |||
| 961 | @item @kbd{C-c C-u} (@code{c-up-conditional}) | 961 | @item @kbd{C-c C-u} (@code{c-up-conditional}) |
| 962 | @kindex C-c C-u | 962 | @kindex C-c C-u |
| 963 | @findex c-up-conditional | 963 | @findex c-up-conditional |
| 964 | @findex up-conditional (c-) | 964 | @findex up-conditional @r{(c-)} |
| 965 | Move back to the containing preprocessor conditional, leaving the mark | 965 | Move back to the containing preprocessor conditional, leaving the mark |
| 966 | behind. A prefix argument acts as a repeat count. With a negative | 966 | behind. A prefix argument acts as a repeat count. With a negative |
| 967 | argument, move forward to the end of the containing preprocessor | 967 | argument, move forward to the end of the containing preprocessor |
| @@ -976,13 +976,13 @@ preprocessor statements. | |||
| 976 | 976 | ||
| 977 | @item @kbd{M-x c-up-conditional-with-else} | 977 | @item @kbd{M-x c-up-conditional-with-else} |
| 978 | @findex c-up-conditional-with-else | 978 | @findex c-up-conditional-with-else |
| 979 | @findex up-conditional-with-else (c-) | 979 | @findex up-conditional-with-else @r{(c-)} |
| 980 | A variety of @code{c-up-conditional} that also stops at @samp{#else} | 980 | A variety of @code{c-up-conditional} that also stops at @samp{#else} |
| 981 | lines. Normally those lines are ignored. | 981 | lines. Normally those lines are ignored. |
| 982 | 982 | ||
| 983 | @item @kbd{M-x c-down-conditional} | 983 | @item @kbd{M-x c-down-conditional} |
| 984 | @findex c-down-conditional | 984 | @findex c-down-conditional |
| 985 | @findex down-conditional (c-) | 985 | @findex down-conditional @r{(c-)} |
| 986 | Move forward into the next nested preprocessor conditional, leaving | 986 | Move forward into the next nested preprocessor conditional, leaving |
| 987 | the mark behind. A prefix argument acts as a repeat count. With a | 987 | the mark behind. A prefix argument acts as a repeat count. With a |
| 988 | negative argument, move backward into the previous nested preprocessor | 988 | negative argument, move backward into the previous nested preprocessor |
| @@ -993,7 +993,7 @@ function stops at them when going forward, but not when going backward. | |||
| 993 | 993 | ||
| 994 | @item @kbd{M-x c-down-conditional-with-else} | 994 | @item @kbd{M-x c-down-conditional-with-else} |
| 995 | @findex c-down-conditional-with-else | 995 | @findex c-down-conditional-with-else |
| 996 | @findex down-conditional-with-else (c-) | 996 | @findex down-conditional-with-else @r{(c-)} |
| 997 | A variety of @code{c-down-conditional} that also stops at @samp{#else} | 997 | A variety of @code{c-down-conditional} that also stops at @samp{#else} |
| 998 | lines. Normally those lines are ignored. | 998 | lines. Normally those lines are ignored. |
| 999 | 999 | ||
| @@ -1003,8 +1003,8 @@ lines. Normally those lines are ignored. | |||
| 1003 | @kindex C-c C-n | 1003 | @kindex C-c C-n |
| 1004 | @findex c-backward-conditional | 1004 | @findex c-backward-conditional |
| 1005 | @findex c-forward-conditional | 1005 | @findex c-forward-conditional |
| 1006 | @findex backward-conditional (c-) | 1006 | @findex backward-conditional @r{(c-)} |
| 1007 | @findex forward-conditional (c-) | 1007 | @findex forward-conditional @r{(c-)} |
| 1008 | Move backward or forward across a preprocessor conditional, leaving | 1008 | Move backward or forward across a preprocessor conditional, leaving |
| 1009 | the mark behind. A prefix argument acts as a repeat count. With a | 1009 | the mark behind. A prefix argument acts as a repeat count. With a |
| 1010 | negative argument, move in the opposite direction. | 1010 | negative argument, move in the opposite direction. |
| @@ -1016,8 +1016,8 @@ preprocessor statements. | |||
| 1016 | @itemx @kbd{M-x c-forward-into-nomenclature} | 1016 | @itemx @kbd{M-x c-forward-into-nomenclature} |
| 1017 | @findex c-backward-into-nomenclature | 1017 | @findex c-backward-into-nomenclature |
| 1018 | @findex c-forward-into-nomenclature | 1018 | @findex c-forward-into-nomenclature |
| 1019 | @findex backward-into-nomenclature (c-) | 1019 | @findex backward-into-nomenclature @r{(c-)} |
| 1020 | @findex forward-into-nomenclature (c-) | 1020 | @findex forward-into-nomenclature @r{(c-)} |
| 1021 | A popular programming style, especially for object-oriented languages | 1021 | A popular programming style, especially for object-oriented languages |
| 1022 | such as C++ is to write symbols in a mixed case format, where the | 1022 | such as C++ is to write symbols in a mixed case format, where the |
| 1023 | first letter of each word is capitalized, and not separated by | 1023 | first letter of each word is capitalized, and not separated by |
| @@ -1070,7 +1070,7 @@ and @pxref{Customizing Indentation})}. | |||
| 1070 | @item @kbd{M-q} (@code{c-fill-paragraph}) | 1070 | @item @kbd{M-q} (@code{c-fill-paragraph}) |
| 1071 | @kindex M-q | 1071 | @kindex M-q |
| 1072 | @findex c-fill-paragraph | 1072 | @findex c-fill-paragraph |
| 1073 | @findex fill-paragraph (c-) | 1073 | @findex fill-paragraph @r{(c-)} |
| 1074 | @cindex Javadoc markup | 1074 | @cindex Javadoc markup |
| 1075 | @cindex Pike autodoc markup | 1075 | @cindex Pike autodoc markup |
| 1076 | This command fills multiline string literals and both block | 1076 | This command fills multiline string literals and both block |
| @@ -1090,7 +1090,7 @@ buffers. | |||
| 1090 | @item @kbd{M-j} (@code{c-indent-new-comment-line}) | 1090 | @item @kbd{M-j} (@code{c-indent-new-comment-line}) |
| 1091 | @kindex M-j | 1091 | @kindex M-j |
| 1092 | @findex c-indent-new-comment-line | 1092 | @findex c-indent-new-comment-line |
| 1093 | @findex indent-new-comment-line (c-) | 1093 | @findex indent-new-comment-line @r{(c-)} |
| 1094 | This breaks the current line at point and indents the new line. If | 1094 | This breaks the current line at point and indents the new line. If |
| 1095 | point was in a comment, the new line gets the proper comment line | 1095 | point was in a comment, the new line gets the proper comment line |
| 1096 | prefix. If point was inside a macro, a backslash is inserted before | 1096 | prefix. If point was inside a macro, a backslash is inserted before |
| @@ -1099,7 +1099,7 @@ the line break. It is the replacement for | |||
| 1099 | 1099 | ||
| 1100 | @item @kbd{M-x c-context-line-break} | 1100 | @item @kbd{M-x c-context-line-break} |
| 1101 | @findex c-context-line-break | 1101 | @findex c-context-line-break |
| 1102 | @findex context-line-break (c-) | 1102 | @findex context-line-break @r{(c-)} |
| 1103 | Insert a line break suitable to the context: If the point is inside a | 1103 | Insert a line break suitable to the context: If the point is inside a |
| 1104 | comment, the new line gets the suitable indentation and comment line | 1104 | comment, the new line gets the suitable indentation and comment line |
| 1105 | prefix like @code{c-indent-new-comment-line}. In normal code it's | 1105 | prefix like @code{c-indent-new-comment-line}. In normal code it's |
| @@ -1118,7 +1118,7 @@ this function. @xref{Sample Init File}. | |||
| 1118 | 1118 | ||
| 1119 | @item @kbd{M-x c-context-open-line} | 1119 | @item @kbd{M-x c-context-open-line} |
| 1120 | @findex c-context-open-line | 1120 | @findex c-context-open-line |
| 1121 | @findex context-open-line (c-) | 1121 | @findex context-open-line @r{(c-)} |
| 1122 | This is to @kbd{C-o} (@kbd{M-x open-line}) as | 1122 | This is to @kbd{C-o} (@kbd{M-x open-line}) as |
| 1123 | @code{c-context-line-break} is to @kbd{RET}. I.e., it works just like | 1123 | @code{c-context-line-break} is to @kbd{RET}. I.e., it works just like |
| 1124 | @code{c-context-line-break} but leaves the point before the inserted | 1124 | @code{c-context-line-break} but leaves the point before the inserted |
| @@ -1196,7 +1196,7 @@ Here are the commands to toggle these modes: | |||
| 1196 | @item @kbd{C-c C-k} (@code{c-toggle-comment-style}) | 1196 | @item @kbd{C-c C-k} (@code{c-toggle-comment-style}) |
| 1197 | @kindex C-c C-k | 1197 | @kindex C-c C-k |
| 1198 | @findex c-toggle-comment-style | 1198 | @findex c-toggle-comment-style |
| 1199 | @findex toggle-comment-style (c-) | 1199 | @findex toggle-comment-style @r{(c-)} |
| 1200 | Toggle the comment style between line style and block style. In modes | 1200 | Toggle the comment style between line style and block style. In modes |
| 1201 | (such as AWK Mode) which only have one of these styles, this function | 1201 | (such as AWK Mode) which only have one of these styles, this function |
| 1202 | does nothing. | 1202 | does nothing. |
| @@ -1204,25 +1204,25 @@ does nothing. | |||
| 1204 | @item @kbd{C-c C-l} (@code{c-toggle-electric-state}) | 1204 | @item @kbd{C-c C-l} (@code{c-toggle-electric-state}) |
| 1205 | @kindex C-c C-l | 1205 | @kindex C-c C-l |
| 1206 | @findex c-toggle-electric-state | 1206 | @findex c-toggle-electric-state |
| 1207 | @findex toggle-electric-state (c-) | 1207 | @findex toggle-electric-state @r{(c-)} |
| 1208 | Toggle electric minor mode. When the command turns the mode off, it | 1208 | Toggle electric minor mode. When the command turns the mode off, it |
| 1209 | also suppresses auto-newline mode. | 1209 | also suppresses auto-newline mode. |
| 1210 | 1210 | ||
| 1211 | @item @kbd{C-c C-a} (@code{c-toggle-auto-newline}) | 1211 | @item @kbd{C-c C-a} (@code{c-toggle-auto-newline}) |
| 1212 | @kindex C-c C-a | 1212 | @kindex C-c C-a |
| 1213 | @findex c-toggle-auto-newline | 1213 | @findex c-toggle-auto-newline |
| 1214 | @findex toggle-auto-newline (c-) | 1214 | @findex toggle-auto-newline @r{(c-)} |
| 1215 | Toggle auto-newline minor mode. When the command turns the mode on, | 1215 | Toggle auto-newline minor mode. When the command turns the mode on, |
| 1216 | it also enables electric minor mode. | 1216 | it also enables electric minor mode. |
| 1217 | 1217 | ||
| 1218 | @item @kbd{M-x c-toggle-hungry-state}@footnote{Prior to @ccmode{} 5.31, this command was bound to @kbd{C-c C-d}.} | 1218 | @item @kbd{M-x c-toggle-hungry-state}@footnote{Prior to @ccmode{} 5.31, this command was bound to @kbd{C-c C-d}.} |
| 1219 | @findex c-toggle-hungry-state | 1219 | @findex c-toggle-hungry-state |
| 1220 | @findex toggle-hungry-state (c-) | 1220 | @findex toggle-hungry-state @r{(c-)} |
| 1221 | Toggle hungry-delete minor mode. | 1221 | Toggle hungry-delete minor mode. |
| 1222 | 1222 | ||
| 1223 | @item @kbd{M-x c-toggle-auto-hungry-state}@footnote{Prior to @ccmode{} 5.31, this command was bound to @kbd{C-c C-t}.} | 1223 | @item @kbd{M-x c-toggle-auto-hungry-state}@footnote{Prior to @ccmode{} 5.31, this command was bound to @kbd{C-c C-t}.} |
| 1224 | @findex c-toggle-auto-hungry-state | 1224 | @findex c-toggle-auto-hungry-state |
| 1225 | @findex toggle-auto-hungry-state (c-) | 1225 | @findex toggle-auto-hungry-state @r{(c-)} |
| 1226 | Toggle both auto-newline and hungry delete minor modes. | 1226 | Toggle both auto-newline and hungry delete minor modes. |
| 1227 | 1227 | ||
| 1228 | @item @kbd{C-c C-w} (@code{M-x subword-mode}) | 1228 | @item @kbd{C-c C-w} (@code{M-x subword-mode}) |
| @@ -1232,7 +1232,7 @@ Toggle subword mode. | |||
| 1232 | 1232 | ||
| 1233 | @item @kbd{M-x c-toggle-syntactic-indentation} | 1233 | @item @kbd{M-x c-toggle-syntactic-indentation} |
| 1234 | @findex c-toggle-syntactic-indentation | 1234 | @findex c-toggle-syntactic-indentation |
| 1235 | @findex toggle-syntactic-indentation (c-) | 1235 | @findex toggle-syntactic-indentation @r{(c-)} |
| 1236 | Toggle syntactic-indentation mode. | 1236 | Toggle syntactic-indentation mode. |
| 1237 | @end table | 1237 | @end table |
| 1238 | 1238 | ||
| @@ -1276,9 +1276,9 @@ These keys and keywords are: | |||
| 1276 | @item # | 1276 | @item # |
| 1277 | @kindex # | 1277 | @kindex # |
| 1278 | @findex c-electric-pound | 1278 | @findex c-electric-pound |
| 1279 | @findex electric-pound (c-) | 1279 | @findex electric-pound @r{(c-)} |
| 1280 | @vindex c-electric-pound-behavior | 1280 | @vindex c-electric-pound-behavior |
| 1281 | @vindex electric-pound-behavior (c-) | 1281 | @vindex electric-pound-behavior @r{(c-)} |
| 1282 | Pound (bound to @code{c-electric-pound}) is electric when typed as the | 1282 | Pound (bound to @code{c-electric-pound}) is electric when typed as the |
| 1283 | first non-whitespace character on a line and not within a macro | 1283 | first non-whitespace character on a line and not within a macro |
| 1284 | definition. In this case, the variable @code{c-electric-pound-behavior} | 1284 | definition. In this case, the variable @code{c-electric-pound-behavior} |
| @@ -1298,9 +1298,9 @@ character. | |||
| 1298 | @itemx / | 1298 | @itemx / |
| 1299 | @kindex / | 1299 | @kindex / |
| 1300 | @findex c-electric-star | 1300 | @findex c-electric-star |
| 1301 | @findex electric-star (c-) | 1301 | @findex electric-star @r{(c-)} |
| 1302 | @findex c-electric-slash | 1302 | @findex c-electric-slash |
| 1303 | @findex electric-slash (c-) | 1303 | @findex electric-slash @r{(c-)} |
| 1304 | A star (bound to @code{c-electric-star}) or a slash | 1304 | A star (bound to @code{c-electric-star}) or a slash |
| 1305 | (@code{c-electric-slash}) causes reindentation when you type it as the | 1305 | (@code{c-electric-slash}) causes reindentation when you type it as the |
| 1306 | second component of a C style block comment opener (@samp{/*}) or a | 1306 | second component of a C style block comment opener (@samp{/*}) or a |
| @@ -1321,7 +1321,7 @@ electric. | |||
| 1321 | @itemx > | 1321 | @itemx > |
| 1322 | @kindex > | 1322 | @kindex > |
| 1323 | @findex c-electric-lt-gt | 1323 | @findex c-electric-lt-gt |
| 1324 | @findex electric-lt-gt (c-) | 1324 | @findex electric-lt-gt @r{(c-)} |
| 1325 | A less-than or greater-than sign (bound to @code{c-electric-lt-gt}) is | 1325 | A less-than or greater-than sign (bound to @code{c-electric-lt-gt}) is |
| 1326 | electric in two circumstances: when it is an angle bracket in a C++ | 1326 | electric in two circumstances: when it is an angle bracket in a C++ |
| 1327 | @samp{template} declaration (and similar constructs in other | 1327 | @samp{template} declaration (and similar constructs in other |
| @@ -1335,7 +1335,7 @@ electric. | |||
| 1335 | @itemx ) | 1335 | @itemx ) |
| 1336 | @kindex ) | 1336 | @kindex ) |
| 1337 | @findex c-electric-paren | 1337 | @findex c-electric-paren |
| 1338 | @findex electric-paren (c-) | 1338 | @findex electric-paren @r{(c-)} |
| 1339 | The normal parenthesis characters @samp{(} and @samp{)} (bound to | 1339 | The normal parenthesis characters @samp{(} and @samp{)} (bound to |
| 1340 | @code{c-electric-paren}) reindent the current line. This is useful | 1340 | @code{c-electric-paren}) reindent the current line. This is useful |
| 1341 | for getting the closing parenthesis of an argument list aligned | 1341 | for getting the closing parenthesis of an argument list aligned |
| @@ -1352,7 +1352,7 @@ get these actions. @xref{Clean-ups}. | |||
| 1352 | @itemx @} | 1352 | @itemx @} |
| 1353 | @kindex @} | 1353 | @kindex @} |
| 1354 | @findex c-electric-brace | 1354 | @findex c-electric-brace |
| 1355 | @findex electric-brace (c-) | 1355 | @findex electric-brace @r{(c-)} |
| 1356 | Typing a brace (bound to @code{c-electric-brace}) reindents the | 1356 | Typing a brace (bound to @code{c-electric-brace}) reindents the |
| 1357 | current line. Also, one or more newlines might be inserted if | 1357 | current line. Also, one or more newlines might be inserted if |
| 1358 | auto-newline minor mode is enabled. @xref{Auto-newlines}. | 1358 | auto-newline minor mode is enabled. @xref{Auto-newlines}. |
| @@ -1363,7 +1363,7 @@ inserted by auto-newline mode in certain circumstances. | |||
| 1363 | @item : | 1363 | @item : |
| 1364 | @kindex : | 1364 | @kindex : |
| 1365 | @findex c-electric-colon | 1365 | @findex c-electric-colon |
| 1366 | @findex electric-colon (c-) | 1366 | @findex electric-colon @r{(c-)} |
| 1367 | Typing a colon (bound to @code{c-electric-colon}) reindents the | 1367 | Typing a colon (bound to @code{c-electric-colon}) reindents the |
| 1368 | current line. Additionally, one or more newlines might be inserted if | 1368 | current line. Additionally, one or more newlines might be inserted if |
| 1369 | auto-newline minor mode is enabled. @xref{Auto-newlines}. If you | 1369 | auto-newline minor mode is enabled. @xref{Auto-newlines}. If you |
| @@ -1380,7 +1380,7 @@ avoiding all these spurious reindentations, newlines, and clean-ups. | |||
| 1380 | @itemx , | 1380 | @itemx , |
| 1381 | @kindex , | 1381 | @kindex , |
| 1382 | @findex c-electric-semi&comma | 1382 | @findex c-electric-semi&comma |
| 1383 | @findex electric-semi&comma (c-) | 1383 | @findex electric-semi&comma @r{(c-)} |
| 1384 | Typing a semicolon or comma (bound to @code{c-electric-semi&comma}) | 1384 | Typing a semicolon or comma (bound to @code{c-electric-semi&comma}) |
| 1385 | reindents the current line. Also, a newline might be inserted if | 1385 | reindents the current line. Also, a newline might be inserted if |
| 1386 | auto-newline minor mode is enabled. @xref{Auto-newlines}. | 1386 | auto-newline minor mode is enabled. @xref{Auto-newlines}. |
| @@ -1391,7 +1391,7 @@ when you type a semicolon or comma just after it. @xref{Clean-ups}. | |||
| 1391 | @end table | 1391 | @end table |
| 1392 | 1392 | ||
| 1393 | @deffn Command c-electric-continued-statement | 1393 | @deffn Command c-electric-continued-statement |
| 1394 | @findex electric-continued-statement (c-) | 1394 | @findex electric-continued-statement @r{(c-)} |
| 1395 | 1395 | ||
| 1396 | Certain keywords are electric, causing reindentation when they are | 1396 | Certain keywords are electric, causing reindentation when they are |
| 1397 | preceded only by whitespace on the line. The keywords are those that | 1397 | preceded only by whitespace on the line. The keywords are those that |
| @@ -1520,7 +1520,7 @@ deletion. | |||
| 1520 | @item @kbd{@key{DEL}} (@code{c-electric-backspace}) | 1520 | @item @kbd{@key{DEL}} (@code{c-electric-backspace}) |
| 1521 | @kindex DEL | 1521 | @kindex DEL |
| 1522 | @findex c-electric-backspace | 1522 | @findex c-electric-backspace |
| 1523 | @findex electric-backspace (c-) | 1523 | @findex electric-backspace @r{(c-)} |
| 1524 | This command is run by default when you hit the @kbd{DEL} key. When | 1524 | This command is run by default when you hit the @kbd{DEL} key. When |
| 1525 | hungry delete mode is enabled, it deletes any amount of whitespace in | 1525 | hungry delete mode is enabled, it deletes any amount of whitespace in |
| 1526 | the backwards direction. Otherwise, or when used with a prefix | 1526 | the backwards direction. Otherwise, or when used with a prefix |
| @@ -1531,7 +1531,7 @@ passing it the prefix argument, if any.) | |||
| 1531 | 1531 | ||
| 1532 | @item @code{c-backspace-function} | 1532 | @item @code{c-backspace-function} |
| 1533 | @vindex c-backspace-function | 1533 | @vindex c-backspace-function |
| 1534 | @vindex backspace-function (c-) | 1534 | @vindex backspace-function @r{(c-)} |
| 1535 | @findex backward-delete-char-untabify | 1535 | @findex backward-delete-char-untabify |
| 1536 | Hook that gets called by @code{c-electric-backspace} when it doesn't | 1536 | Hook that gets called by @code{c-electric-backspace} when it doesn't |
| 1537 | do an ``electric'' deletion of the preceding whitespace. The default | 1537 | do an ``electric'' deletion of the preceding whitespace. The default |
| @@ -1542,7 +1542,7 @@ deletes a single character. | |||
| 1542 | @item @kbd{C-d} (@code{c-electric-delete-forward}) | 1542 | @item @kbd{C-d} (@code{c-electric-delete-forward}) |
| 1543 | @kindex C-d | 1543 | @kindex C-d |
| 1544 | @findex c-electric-delete-forward | 1544 | @findex c-electric-delete-forward |
| 1545 | @findex electric-delete-forward (c-) | 1545 | @findex electric-delete-forward @r{(c-)} |
| 1546 | This function, which is bound to @kbd{C-d} by default, works just like | 1546 | This function, which is bound to @kbd{C-d} by default, works just like |
| 1547 | @code{c-electric-backspace} but in the forward direction. When it | 1547 | @code{c-electric-backspace} but in the forward direction. When it |
| 1548 | doesn't do an ``electric'' deletion of the following whitespace, it | 1548 | doesn't do an ``electric'' deletion of the following whitespace, it |
| @@ -1552,7 +1552,7 @@ argument.) | |||
| 1552 | 1552 | ||
| 1553 | @item @code{c-delete-function} | 1553 | @item @code{c-delete-function} |
| 1554 | @vindex c-delete-function | 1554 | @vindex c-delete-function |
| 1555 | @vindex delete-function (c-) | 1555 | @vindex delete-function @r{(c-)} |
| 1556 | @findex delete-char | 1556 | @findex delete-char |
| 1557 | Hook that gets called by @code{c-electric-delete-forward} when it | 1557 | Hook that gets called by @code{c-electric-delete-forward} when it |
| 1558 | doesn't do an ``electric'' deletion of the following whitespace. The | 1558 | doesn't do an ``electric'' deletion of the following whitespace. The |
| @@ -1572,7 +1572,7 @@ rather than using the minor mode toggling. | |||
| 1572 | @kindex C-c C-DEL | 1572 | @kindex C-c C-DEL |
| 1573 | @kindex C-c DEL | 1573 | @kindex C-c DEL |
| 1574 | @findex c-hungry-delete-backwards | 1574 | @findex c-hungry-delete-backwards |
| 1575 | @findex hungry-delete-backwards (c-) | 1575 | @findex hungry-delete-backwards @r{(c-)} |
| 1576 | Delete any amount of whitespace in the backwards direction (regardless | 1576 | Delete any amount of whitespace in the backwards direction (regardless |
| 1577 | whether hungry-delete mode is enabled or not). This command is bound | 1577 | whether hungry-delete mode is enabled or not). This command is bound |
| 1578 | to both @kbd{C-c C-@key{DEL}} and @kbd{C-c @key{DEL}}, since the more | 1578 | to both @kbd{C-c C-@key{DEL}} and @kbd{C-c @key{DEL}}, since the more |
| @@ -1584,7 +1584,7 @@ a character terminal. | |||
| 1584 | @kindex C-c C-<DELETE> | 1584 | @kindex C-c C-<DELETE> |
| 1585 | @kindex C-c <DELETE> | 1585 | @kindex C-c <DELETE> |
| 1586 | @findex c-hungry-delete-forward | 1586 | @findex c-hungry-delete-forward |
| 1587 | @findex hungry-delete-forward (c-) | 1587 | @findex hungry-delete-forward @r{(c-)} |
| 1588 | Delete any amount of whitespace in the forward direction (regardless | 1588 | Delete any amount of whitespace in the forward direction (regardless |
| 1589 | whether hungry-delete mode is enabled or not). This command is bound | 1589 | whether hungry-delete mode is enabled or not). This command is bound |
| 1590 | to both @kbd{C-c C-@key{DELETE}} and @kbd{C-c @key{DELETE}} for the | 1590 | to both @kbd{C-c C-@key{DELETE}} and @kbd{C-c @key{DELETE}} for the |
| @@ -1601,9 +1601,9 @@ known as @key{Backspace} and @key{Delete}. The default bindings to | |||
| 1601 | those two keys depends on the flavor of (X)Emacs you are using. | 1601 | those two keys depends on the flavor of (X)Emacs you are using. |
| 1602 | 1602 | ||
| 1603 | @findex c-electric-delete | 1603 | @findex c-electric-delete |
| 1604 | @findex electric-delete (c-) | 1604 | @findex electric-delete @r{(c-)} |
| 1605 | @findex c-hungry-delete | 1605 | @findex c-hungry-delete |
| 1606 | @findex hungry-delete (c-) | 1606 | @findex hungry-delete @r{(c-)} |
| 1607 | @vindex delete-key-deletes-forward | 1607 | @vindex delete-key-deletes-forward |
| 1608 | In XEmacs 20.3 and beyond, the @key{Backspace} key is bound to | 1608 | In XEmacs 20.3 and beyond, the @key{Backspace} key is bound to |
| 1609 | @code{c-electric-backspace} and the @key{Delete} key is bound to | 1609 | @code{c-electric-backspace} and the @key{Delete} key is bound to |
| @@ -1678,23 +1678,23 @@ editing commands with variants that recognize subwords in a | |||
| 1678 | nomenclature and treat them as separate words: | 1678 | nomenclature and treat them as separate words: |
| 1679 | 1679 | ||
| 1680 | @findex c-forward-subword | 1680 | @findex c-forward-subword |
| 1681 | @findex forward-subword (c-) | 1681 | @findex forward-subword @r{(c-)} |
| 1682 | @findex c-backward-subword | 1682 | @findex c-backward-subword |
| 1683 | @findex backward-subword (c-) | 1683 | @findex backward-subword @r{(c-)} |
| 1684 | @findex c-mark-subword | 1684 | @findex c-mark-subword |
| 1685 | @findex mark-subword (c-) | 1685 | @findex mark-subword @r{(c-)} |
| 1686 | @findex c-kill-subword | 1686 | @findex c-kill-subword |
| 1687 | @findex kill-subword (c-) | 1687 | @findex kill-subword @r{(c-)} |
| 1688 | @findex c-backward-kill-subword | 1688 | @findex c-backward-kill-subword |
| 1689 | @findex backward-kill-subword (c-) | 1689 | @findex backward-kill-subword @r{(c-)} |
| 1690 | @findex c-transpose-subwords | 1690 | @findex c-transpose-subwords |
| 1691 | @findex transpose-subwords (c-) | 1691 | @findex transpose-subwords @r{(c-)} |
| 1692 | @findex c-capitalize-subword | 1692 | @findex c-capitalize-subword |
| 1693 | @findex capitalize-subword (c-) | 1693 | @findex capitalize-subword @r{(c-)} |
| 1694 | @findex c-upcase-subword | 1694 | @findex c-upcase-subword |
| 1695 | @findex upcase-subword (c-) | 1695 | @findex upcase-subword @r{(c-)} |
| 1696 | @findex c-downcase-subword | 1696 | @findex c-downcase-subword |
| 1697 | @findex downcase-subword (c-) | 1697 | @findex downcase-subword @r{(c-)} |
| 1698 | @multitable @columnfractions .20 .40 .40 | 1698 | @multitable @columnfractions .20 .40 .40 |
| 1699 | @c This could be converted to @headitem when we require Texinfo 4.7 | 1699 | @c This could be converted to @headitem when we require Texinfo 4.7 |
| 1700 | @iftex | 1700 | @iftex |
| @@ -1744,7 +1744,7 @@ Here are the various other commands that didn't fit anywhere else: | |||
| 1744 | @item @kbd{C-c .} (@code{c-set-style}) | 1744 | @item @kbd{C-c .} (@code{c-set-style}) |
| 1745 | @kindex C-c . | 1745 | @kindex C-c . |
| 1746 | @findex c-set-style | 1746 | @findex c-set-style |
| 1747 | @findex set-style (c-) | 1747 | @findex set-style @r{(c-)} |
| 1748 | Switch to the specified style in the current buffer. Use like this: | 1748 | Switch to the specified style in the current buffer. Use like this: |
| 1749 | 1749 | ||
| 1750 | @example | 1750 | @example |
| @@ -1764,7 +1764,7 @@ For details of the @ccmode{} style system, see @ref{Styles}. | |||
| 1764 | @item @kbd{C-c :} (@code{c-scope-operator}) | 1764 | @item @kbd{C-c :} (@code{c-scope-operator}) |
| 1765 | @kindex C-c : | 1765 | @kindex C-c : |
| 1766 | @findex c-scope-operator | 1766 | @findex c-scope-operator |
| 1767 | @findex scope-operator (c-) | 1767 | @findex scope-operator @r{(c-)} |
| 1768 | In C++, it is also sometimes desirable to insert the double-colon scope | 1768 | In C++, it is also sometimes desirable to insert the double-colon scope |
| 1769 | operator without performing the electric behavior of colon insertion. | 1769 | operator without performing the electric behavior of colon insertion. |
| 1770 | @kbd{C-c :} does just this. | 1770 | @kbd{C-c :} does just this. |
| @@ -1772,7 +1772,7 @@ operator without performing the electric behavior of colon insertion. | |||
| 1772 | @item @kbd{C-c C-z} (@code{c-display-defun-name}) | 1772 | @item @kbd{C-c C-z} (@code{c-display-defun-name}) |
| 1773 | @kindex C-c C-z | 1773 | @kindex C-c C-z |
| 1774 | @findex c-display-defun-name | 1774 | @findex c-display-defun-name |
| 1775 | @findex display-defun-name (c-) | 1775 | @findex display-defun-name @r{(c-)} |
| 1776 | Display the current function name, if any, in the minibuffer. | 1776 | Display the current function name, if any, in the minibuffer. |
| 1777 | Additionally, if a prefix argument is given, push the function name to | 1777 | Additionally, if a prefix argument is given, push the function name to |
| 1778 | the kill ring. If there is no current function, | 1778 | the kill ring. If there is no current function, |
| @@ -1784,7 +1784,7 @@ customizable option @code{isearch-allow-scroll} to non-@code{nil}. | |||
| 1784 | @item @kbd{C-c C-\} (@code{c-backslash-region}) | 1784 | @item @kbd{C-c C-\} (@code{c-backslash-region}) |
| 1785 | @kindex C-c C-\ | 1785 | @kindex C-c C-\ |
| 1786 | @findex c-backslash-region | 1786 | @findex c-backslash-region |
| 1787 | @findex backslash-region (c-) | 1787 | @findex backslash-region @r{(c-)} |
| 1788 | This function inserts and aligns or deletes end-of-line backslashes in | 1788 | This function inserts and aligns or deletes end-of-line backslashes in |
| 1789 | the current region. These are typically used in multi-line macros. | 1789 | the current region. These are typically used in multi-line macros. |
| 1790 | 1790 | ||
| @@ -1814,7 +1814,7 @@ with the trailing backslashes. | |||
| 1814 | @item @kbd{C-c C-e} (@code{c-macro-expand}) | 1814 | @item @kbd{C-c C-e} (@code{c-macro-expand}) |
| 1815 | @kindex C-c C-e | 1815 | @kindex C-c C-e |
| 1816 | @findex c-macro-expand | 1816 | @findex c-macro-expand |
| 1817 | @findex macro-expand (c-) | 1817 | @findex macro-expand @r{(c-)} |
| 1818 | This command expands C, C++, Objective C or Pike macros in the region, | 1818 | This command expands C, C++, Objective C or Pike macros in the region, |
| 1819 | using an appropriate external preprocessor program. Normally it | 1819 | using an appropriate external preprocessor program. Normally it |
| 1820 | displays its output in a temporary buffer, but if you give it a prefix | 1820 | displays its output in a temporary buffer, but if you give it a prefix |
| @@ -2046,7 +2046,7 @@ or @code{font-lock-reference-face}, for lack of a closer equivalent. | |||
| 2046 | @item | 2046 | @item |
| 2047 | @vindex font-lock-warning-face | 2047 | @vindex font-lock-warning-face |
| 2048 | @vindex c-invalid-face | 2048 | @vindex c-invalid-face |
| 2049 | @vindex invalid-face (c-) | 2049 | @vindex invalid-face @r{(c-)} |
| 2050 | Some kinds of syntactic errors are fontified with | 2050 | Some kinds of syntactic errors are fontified with |
| 2051 | @code{font-lock-warning-face} in Emacs. In older XEmacs versions | 2051 | @code{font-lock-warning-face} in Emacs. In older XEmacs versions |
| 2052 | there's no corresponding standard face, so there a special | 2052 | there's no corresponding standard face, so there a special |
| @@ -2071,7 +2071,7 @@ specially structured comments, e.g., the standard Javadoc tool in Java. | |||
| 2071 | the special markup inside them. | 2071 | the special markup inside them. |
| 2072 | 2072 | ||
| 2073 | @defopt c-doc-comment-style | 2073 | @defopt c-doc-comment-style |
| 2074 | @vindex doc-comment-style (c-) | 2074 | @vindex doc-comment-style @r{(c-)} |
| 2075 | This is a style variable that specifies which documentation comment | 2075 | This is a style variable that specifies which documentation comment |
| 2076 | style to recognize, e.g., @code{javadoc} for Javadoc comments. | 2076 | style to recognize, e.g., @code{javadoc} for Javadoc comments. |
| 2077 | 2077 | ||
| @@ -2096,7 +2096,7 @@ to do @kbd{M-x java-mode} (or whatever mode you're currently using) to | |||
| 2096 | reinitialize. | 2096 | reinitialize. |
| 2097 | 2097 | ||
| 2098 | @findex c-setup-doc-comment-style | 2098 | @findex c-setup-doc-comment-style |
| 2099 | @findex setup-doc-comment-style (c-) | 2099 | @findex setup-doc-comment-style @r{(c-)} |
| 2100 | Note also that when @ccmode{} starts up, the other variables are | 2100 | Note also that when @ccmode{} starts up, the other variables are |
| 2101 | modified before the mode hooks are run. If you change this variable in | 2101 | modified before the mode hooks are run. If you change this variable in |
| 2102 | a mode hook, you'll have to call @code{c-setup-doc-comment-style} | 2102 | a mode hook, you'll have to call @code{c-setup-doc-comment-style} |
| @@ -2163,7 +2163,7 @@ foo& bar | |||
| 2163 | @code{c-asymmetry-fontification-flag}. | 2163 | @code{c-asymmetry-fontification-flag}. |
| 2164 | 2164 | ||
| 2165 | @defvar c-asymmetry-fontification-flag | 2165 | @defvar c-asymmetry-fontification-flag |
| 2166 | @vindex asymmetry-fontification-flag (c-) | 2166 | @vindex asymmetry-fontification-flag @r{(c-)} |
| 2167 | When @code{c-asymmetry-fontification-flag} is non-nil (which it is by | 2167 | When @code{c-asymmetry-fontification-flag} is non-nil (which it is by |
| 2168 | default), code like the above, with white space either before or after | 2168 | default), code like the above, with white space either before or after |
| 2169 | the operator, but not both, is fontified as a declaration. When the | 2169 | the operator, but not both, is fontified as a declaration. When the |
| @@ -2461,14 +2461,14 @@ hook. Thus, any style settings done in these hooks will override | |||
| 2461 | those set by @code{c-default-style}. | 2461 | those set by @code{c-default-style}. |
| 2462 | 2462 | ||
| 2463 | @defvar c-initialization-hook | 2463 | @defvar c-initialization-hook |
| 2464 | @vindex initialization-hook (c-) | 2464 | @vindex initialization-hook @r{(c-)} |
| 2465 | Hook run only once per Emacs session, when @ccmode{} is initialized. | 2465 | Hook run only once per Emacs session, when @ccmode{} is initialized. |
| 2466 | This is a good place to change key bindings (or add new ones) in any | 2466 | This is a good place to change key bindings (or add new ones) in any |
| 2467 | of the @ccmode{} key maps. @xref{Sample Init File}. | 2467 | of the @ccmode{} key maps. @xref{Sample Init File}. |
| 2468 | @end defvar | 2468 | @end defvar |
| 2469 | 2469 | ||
| 2470 | @defvar c-mode-common-hook | 2470 | @defvar c-mode-common-hook |
| 2471 | @vindex mode-common-hook (c-) | 2471 | @vindex mode-common-hook @r{(c-)} |
| 2472 | Common hook across all languages. It's run immediately before the | 2472 | Common hook across all languages. It's run immediately before the |
| 2473 | language specific hook. | 2473 | language specific hook. |
| 2474 | @end defvar | 2474 | @end defvar |
| @@ -2528,7 +2528,7 @@ initialized. | |||
| 2528 | 2528 | ||
| 2529 | @item | 2529 | @item |
| 2530 | @vindex c-old-style-variable-behavior | 2530 | @vindex c-old-style-variable-behavior |
| 2531 | @vindex old-style-variable-behavior (c-) | 2531 | @vindex old-style-variable-behavior @r{(c-)} |
| 2532 | The default global binding of any style variable (with two exceptions | 2532 | The default global binding of any style variable (with two exceptions |
| 2533 | - see below) is the special symbol @code{set-from-style}. When the | 2533 | - see below) is the special symbol @code{set-from-style}. When the |
| 2534 | style system initializes a buffer-local copy of a style variable for a | 2534 | style system initializes a buffer-local copy of a style variable for a |
| @@ -2724,7 +2724,7 @@ To set a buffer's style interactively, use the command @kbd{C-c .} | |||
| 2724 | list, @ref{File Styles}. | 2724 | list, @ref{File Styles}. |
| 2725 | 2725 | ||
| 2726 | @defopt c-default-style | 2726 | @defopt c-default-style |
| 2727 | @vindex default-style (c-) | 2727 | @vindex default-style @r{(c-)} |
| 2728 | This variable specifies which style to install by default in new | 2728 | This variable specifies which style to install by default in new |
| 2729 | buffers. It takes either a style name string, or an association list | 2729 | buffers. It takes either a style name string, or an association list |
| 2730 | of major mode symbols to style names: | 2730 | of major mode symbols to style names: |
| @@ -2757,7 +2757,7 @@ The standard value of @code{c-default-style} is @w{@code{((java-mode | |||
| 2757 | @end defopt | 2757 | @end defopt |
| 2758 | 2758 | ||
| 2759 | @defvar c-indentation-style | 2759 | @defvar c-indentation-style |
| 2760 | @vindex indentation-style (c-) | 2760 | @vindex indentation-style @r{(c-)} |
| 2761 | This variable always contains the buffer's current style name, as a | 2761 | This variable always contains the buffer's current style name, as a |
| 2762 | string. | 2762 | string. |
| 2763 | @end defvar | 2763 | @end defvar |
| @@ -2827,7 +2827,7 @@ should never modify this variable directly. Instead, @ccmode{} | |||
| 2827 | provides the function @code{c-add-style} for this purpose. | 2827 | provides the function @code{c-add-style} for this purpose. |
| 2828 | 2828 | ||
| 2829 | @defun c-add-style stylename description &optional set-p | 2829 | @defun c-add-style stylename description &optional set-p |
| 2830 | @findex add-style (c-) | 2830 | @findex add-style @r{(c-)} |
| 2831 | Add or update a style called @var{stylename}, a string. | 2831 | Add or update a style called @var{stylename}, a string. |
| 2832 | @var{description} is the new style definition in the form described | 2832 | @var{description} is the new style definition in the form described |
| 2833 | above. If @var{stylename} already exists in @code{c-style-alist} then | 2833 | above. If @var{stylename} already exists in @code{c-style-alist} then |
| @@ -2845,7 +2845,7 @@ style can be added and automatically set. @xref{Sample Init File}. | |||
| 2845 | @end defun | 2845 | @end defun |
| 2846 | 2846 | ||
| 2847 | @defvar c-style-alist | 2847 | @defvar c-style-alist |
| 2848 | @vindex style-alist (c-) | 2848 | @vindex style-alist @r{(c-)} |
| 2849 | This is the variable that holds the definitions for the styles. It | 2849 | This is the variable that holds the definitions for the styles. It |
| 2850 | should not be changed directly; use @code{c-add-style} instead. | 2850 | should not be changed directly; use @code{c-add-style} instead. |
| 2851 | @end defvar | 2851 | @end defvar |
| @@ -2881,9 +2881,9 @@ You can then set the guessed style in any @ccmode{} buffer with | |||
| 2881 | @findex c-guess-no-install | 2881 | @findex c-guess-no-install |
| 2882 | @findex c-guess-buffer-no-install | 2882 | @findex c-guess-buffer-no-install |
| 2883 | @findex c-guess-region-no-install | 2883 | @findex c-guess-region-no-install |
| 2884 | @findex guess-no-install (c-) | 2884 | @findex guess-no-install @r{(c-)} |
| 2885 | @findex guess-buffer-no-install (c-) | 2885 | @findex guess-buffer-no-install @r{(c-)} |
| 2886 | @findex guess-region-no-install (c-) | 2886 | @findex guess-region-no-install @r{(c-)} |
| 2887 | These commands analyze a part of the current buffer and guess the | 2887 | These commands analyze a part of the current buffer and guess the |
| 2888 | style from it. | 2888 | style from it. |
| 2889 | 2889 | ||
| @@ -2904,9 +2904,9 @@ guesses before forming the guessed style. | |||
| 2904 | @findex c-guess | 2904 | @findex c-guess |
| 2905 | @findex c-guess-buffer | 2905 | @findex c-guess-buffer |
| 2906 | @findex c-guess-region | 2906 | @findex c-guess-region |
| 2907 | @findex guess (c-) | 2907 | @findex guess @r{(c-)} |
| 2908 | @findex guess-buffer (c-) | 2908 | @findex guess-buffer @r{(c-)} |
| 2909 | @findex guess-region (c-) | 2909 | @findex guess-region @r{(c-)} |
| 2910 | These commands analyze a part of the current buffer, guess the style | 2910 | These commands analyze a part of the current buffer, guess the style |
| 2911 | from it, then install the guessed style on the buffer. The guessed | 2911 | from it, then install the guessed style on the buffer. The guessed |
| 2912 | style is given a name based on the buffer's absolute file name, and | 2912 | style is given a name based on the buffer's absolute file name, and |
| @@ -2922,14 +2922,14 @@ guesses before forming the guessed style. | |||
| 2922 | @end table | 2922 | @end table |
| 2923 | 2923 | ||
| 2924 | @defopt c-guess-region-max | 2924 | @defopt c-guess-region-max |
| 2925 | @vindex guess-region-max (c-) | 2925 | @vindex guess-region-max @r{(c-)} |
| 2926 | This variable, default 50000, is the size in bytes of the buffer | 2926 | This variable, default 50000, is the size in bytes of the buffer |
| 2927 | portion examined by c-guess and c-guess-no-install. If set to | 2927 | portion examined by c-guess and c-guess-no-install. If set to |
| 2928 | @code{nil}, the entire buffer is examined. | 2928 | @code{nil}, the entire buffer is examined. |
| 2929 | @end defopt | 2929 | @end defopt |
| 2930 | 2930 | ||
| 2931 | @defopt c-guess-offset-threshold | 2931 | @defopt c-guess-offset-threshold |
| 2932 | @vindex guess-offset-threshold (c-) | 2932 | @vindex guess-offset-threshold @r{(c-)} |
| 2933 | This variable, default 10, is the maximum offset, either outwards or | 2933 | This variable, default 10, is the maximum offset, either outwards or |
| 2934 | inwards, which will be taken into account by the analysis process. | 2934 | inwards, which will be taken into account by the analysis process. |
| 2935 | Any offset bigger than this will be ignored. For no limit, set this | 2935 | Any offset bigger than this will be ignored. For no limit, set this |
| @@ -2939,7 +2939,7 @@ variable to a large number. | |||
| 2939 | @table @asis | 2939 | @table @asis |
| 2940 | @item @kbd{M-x c-guess-install} | 2940 | @item @kbd{M-x c-guess-install} |
| 2941 | @findex c-guess-install | 2941 | @findex c-guess-install |
| 2942 | @findex guess-install (c-) | 2942 | @findex guess-install @r{(c-)} |
| 2943 | 2943 | ||
| 2944 | Set the current buffer's style to the guessed style. This prompts you | 2944 | Set the current buffer's style to the guessed style. This prompts you |
| 2945 | to enter an optional new style name to give to the guessed style. By | 2945 | to enter an optional new style name to give to the guessed style. By |
| @@ -2948,7 +2948,7 @@ can then use this style like any other. | |||
| 2948 | 2948 | ||
| 2949 | @item @kbd{M-x c-guess-view} | 2949 | @item @kbd{M-x c-guess-view} |
| 2950 | @findex c-guess-view | 2950 | @findex c-guess-view |
| 2951 | @findex guess-view (c-) | 2951 | @findex guess-view @r{(c-)} |
| 2952 | Display the most recently guessed style in a temporary buffer. This | 2952 | Display the most recently guessed style in a temporary buffer. This |
| 2953 | display is in the form of a @code{c-add-style} form (@pxref{Adding | 2953 | display is in the form of a @code{c-add-style} form (@pxref{Adding |
| 2954 | Styles}) which can be easily copied to your @file{.emacs}. You will | 2954 | Styles}) which can be easily copied to your @file{.emacs}. You will |
| @@ -2994,14 +2994,14 @@ Don't use them anywhere else! These allow you to customize the style | |||
| 2994 | on a per-file basis: | 2994 | on a per-file basis: |
| 2995 | 2995 | ||
| 2996 | @defvar c-file-style | 2996 | @defvar c-file-style |
| 2997 | @vindex file-style (c-) | 2997 | @vindex file-style @r{(c-)} |
| 2998 | Set this variable to a style name string in the Local Variables list. | 2998 | Set this variable to a style name string in the Local Variables list. |
| 2999 | From now on, when you visit the file, @ccmode{} will automatically set | 2999 | From now on, when you visit the file, @ccmode{} will automatically set |
| 3000 | the file's style to this one using @code{c-set-style}. | 3000 | the file's style to this one using @code{c-set-style}. |
| 3001 | @end defvar | 3001 | @end defvar |
| 3002 | 3002 | ||
| 3003 | @defvar c-file-offsets | 3003 | @defvar c-file-offsets |
| 3004 | @vindex file-offsets (c-) | 3004 | @vindex file-offsets @r{(c-)} |
| 3005 | Set this variable (in the Local Variables list) to an association list | 3005 | Set this variable (in the Local Variables list) to an association list |
| 3006 | of the same format as @code{c-offsets-alist}. From now on, when you | 3006 | of the same format as @code{c-offsets-alist}. From now on, when you |
| 3007 | visit the file, @ccmode{} will automatically institute these offsets | 3007 | visit the file, @ccmode{} will automatically institute these offsets |
| @@ -3034,7 +3034,7 @@ this by hooking in on the different line breaking functions and tuning | |||
| 3034 | relevant variables as necessary. | 3034 | relevant variables as necessary. |
| 3035 | 3035 | ||
| 3036 | @vindex c-comment-prefix-regexp | 3036 | @vindex c-comment-prefix-regexp |
| 3037 | @vindex comment-prefix-regexp (c-) | 3037 | @vindex comment-prefix-regexp @r{(c-)} |
| 3038 | @cindex comment line prefix | 3038 | @cindex comment line prefix |
| 3039 | @vindex comment-start | 3039 | @vindex comment-start |
| 3040 | @vindex comment-end | 3040 | @vindex comment-end |
| @@ -3055,7 +3055,7 @@ variables@footnote{@code{comment-start}, @code{comment-end}, | |||
| 3055 | according to the language syntax and the comment line prefix. | 3055 | according to the language syntax and the comment line prefix. |
| 3056 | 3056 | ||
| 3057 | @defopt c-comment-prefix-regexp | 3057 | @defopt c-comment-prefix-regexp |
| 3058 | @vindex comment-prefix-regexp (c-) | 3058 | @vindex comment-prefix-regexp @r{(c-)} |
| 3059 | This style variable contains the regexp used to recognize the | 3059 | This style variable contains the regexp used to recognize the |
| 3060 | @dfn{comment line prefix}, which is the line decoration that starts | 3060 | @dfn{comment line prefix}, which is the line decoration that starts |
| 3061 | every line in a comment. The variable is either the comment line | 3061 | every line in a comment. The variable is either the comment line |
| @@ -3092,7 +3092,7 @@ this variable, please make sure it still matches the comment starter | |||
| 3092 | block comments. | 3092 | block comments. |
| 3093 | 3093 | ||
| 3094 | @findex c-setup-paragraph-variables | 3094 | @findex c-setup-paragraph-variables |
| 3095 | @findex setup-paragraph-variables (c-) | 3095 | @findex setup-paragraph-variables @r{(c-)} |
| 3096 | Also note that since @ccmode{} uses the value of | 3096 | Also note that since @ccmode{} uses the value of |
| 3097 | @code{c-comment-prefix-regexp} to set up several other variables at | 3097 | @code{c-comment-prefix-regexp} to set up several other variables at |
| 3098 | mode initialization, there won't be any effect if you just change it | 3098 | mode initialization, there won't be any effect if you just change it |
| @@ -3128,7 +3128,7 @@ margins of the texts kept intact: | |||
| 3128 | @end example | 3128 | @end example |
| 3129 | 3129 | ||
| 3130 | @findex c-setup-filladapt | 3130 | @findex c-setup-filladapt |
| 3131 | @findex setup-filladapt (c-) | 3131 | @findex setup-filladapt @r{(c-)} |
| 3132 | @findex filladapt-mode | 3132 | @findex filladapt-mode |
| 3133 | @vindex filladapt-mode | 3133 | @vindex filladapt-mode |
| 3134 | @cindex Filladapt mode | 3134 | @cindex Filladapt mode |
| @@ -3153,9 +3153,9 @@ something like this in your @file{.emacs}: | |||
| 3153 | @end example | 3153 | @end example |
| 3154 | 3154 | ||
| 3155 | @defopt c-block-comment-prefix | 3155 | @defopt c-block-comment-prefix |
| 3156 | @vindex block-comment-prefix (c-) | 3156 | @vindex block-comment-prefix @r{(c-)} |
| 3157 | @vindex c-comment-continuation-stars | 3157 | @vindex c-comment-continuation-stars |
| 3158 | @vindex comment-continuation-stars (c-) | 3158 | @vindex comment-continuation-stars @r{(c-)} |
| 3159 | Normally the comment line prefix inserted for a new line inside a | 3159 | Normally the comment line prefix inserted for a new line inside a |
| 3160 | comment is deduced from other lines in it. However there's one | 3160 | comment is deduced from other lines in it. However there's one |
| 3161 | situation when there's no hint about what the prefix should look like, | 3161 | situation when there's no hint about what the prefix should look like, |
| @@ -3193,7 +3193,7 @@ most common comment styles, see @ref{Line-Up Functions}. | |||
| 3193 | @end defopt | 3193 | @end defopt |
| 3194 | 3194 | ||
| 3195 | @defopt c-ignore-auto-fill | 3195 | @defopt c-ignore-auto-fill |
| 3196 | @vindex ignore-auto-fill (c-) | 3196 | @vindex ignore-auto-fill @r{(c-)} |
| 3197 | When auto fill mode is enabled, @ccmode{} can selectively ignore it | 3197 | When auto fill mode is enabled, @ccmode{} can selectively ignore it |
| 3198 | depending on the context the line break would occur in, e.g., to never | 3198 | depending on the context the line break would occur in, e.g., to never |
| 3199 | break a line automatically inside a string literal. This variable | 3199 | break a line automatically inside a string literal. This variable |
| @@ -3346,7 +3346,7 @@ newline both before and after the brace. In place of a | |||
| 3346 | is useful when the auto newlines depend on the code around the brace. | 3346 | is useful when the auto newlines depend on the code around the brace. |
| 3347 | 3347 | ||
| 3348 | @defopt c-hanging-braces-alist | 3348 | @defopt c-hanging-braces-alist |
| 3349 | @vindex hanging-braces-alist (c-) | 3349 | @vindex hanging-braces-alist @r{(c-)} |
| 3350 | 3350 | ||
| 3351 | This variable is an association list which maps syntactic symbols to | 3351 | This variable is an association list which maps syntactic symbols to |
| 3352 | lists of places to insert a newline. @xref{Association | 3352 | lists of places to insert a newline. @xref{Association |
| @@ -3454,7 +3454,7 @@ themselves. | |||
| 3454 | @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | 3454 | @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 3455 | 3455 | ||
| 3456 | @vindex c-hanging-braces-alist | 3456 | @vindex c-hanging-braces-alist |
| 3457 | @vindex hanging-braces-alist (c-) | 3457 | @vindex hanging-braces-alist @r{(c-)} |
| 3458 | @cindex action functions | 3458 | @cindex action functions |
| 3459 | Syntactic symbols aren't the only place where you can customize | 3459 | Syntactic symbols aren't the only place where you can customize |
| 3460 | @ccmode{} with the lisp equivalent of callback functions. Remember | 3460 | @ccmode{} with the lisp equivalent of callback functions. Remember |
| @@ -3475,7 +3475,7 @@ some combination of @code{before} and @code{after}, including neither | |||
| 3475 | of them (i.e., @code{nil}). | 3475 | of them (i.e., @code{nil}). |
| 3476 | 3476 | ||
| 3477 | @defvar c-syntactic-context | 3477 | @defvar c-syntactic-context |
| 3478 | @vindex syntactic-context (c-) | 3478 | @vindex syntactic-context @r{(c-)} |
| 3479 | During the call to the indentation or brace hanging @var{action} | 3479 | During the call to the indentation or brace hanging @var{action} |
| 3480 | function, this variable is bound to the full syntactic analysis list. | 3480 | function, this variable is bound to the full syntactic analysis list. |
| 3481 | This might be, for example, @samp{((block-close 73))}. Don't ever | 3481 | This might be, for example, @samp{((block-close 73))}. Don't ever |
| @@ -3528,7 +3528,7 @@ associate the @code{block-close} symbol with the @var{action} function | |||
| 3528 | @end example | 3528 | @end example |
| 3529 | 3529 | ||
| 3530 | @findex c-snug-do-while | 3530 | @findex c-snug-do-while |
| 3531 | @findex snug-do-while (c-) | 3531 | @findex snug-do-while @r{(c-)} |
| 3532 | This function simply looks to see if the brace closes a ``do-while'' | 3532 | This function simply looks to see if the brace closes a ``do-while'' |
| 3533 | clause and if so, returns the list @samp{(before)} indicating | 3533 | clause and if so, returns the list @samp{(before)} indicating |
| 3534 | that a newline should be inserted before the brace, but not after it. | 3534 | that a newline should be inserted before the brace, but not after it. |
| @@ -3544,7 +3544,7 @@ that the brace appears on a line by itself. | |||
| 3544 | 3544 | ||
| 3545 | @cindex customization, colon hanging | 3545 | @cindex customization, colon hanging |
| 3546 | @vindex c-hanging-colons-alist | 3546 | @vindex c-hanging-colons-alist |
| 3547 | @vindex hanging-colons-alist (c-) | 3547 | @vindex hanging-colons-alist @r{(c-)} |
| 3548 | 3548 | ||
| 3549 | Using a mechanism similar to brace hanging (@pxref{Hanging Braces}), | 3549 | Using a mechanism similar to brace hanging (@pxref{Hanging Braces}), |
| 3550 | colons can also be made to hang using the style variable | 3550 | colons can also be made to hang using the style variable |
| @@ -3556,7 +3556,7 @@ syntactic symbol in the alist, no newlines are inserted around the | |||
| 3556 | newly typed colon. | 3556 | newly typed colon. |
| 3557 | 3557 | ||
| 3558 | @defopt c-hanging-colons-alist | 3558 | @defopt c-hanging-colons-alist |
| 3559 | @vindex hanging-colons-alist (c-) | 3559 | @vindex hanging-colons-alist @r{(c-)} |
| 3560 | 3560 | ||
| 3561 | @table @asis | 3561 | @table @asis |
| 3562 | @item The Key: the syntactic symbol | 3562 | @item The Key: the syntactic symbol |
| @@ -3589,7 +3589,7 @@ them are controlled by a different mechanism, called @dfn{clean-ups} in | |||
| 3589 | @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | 3589 | @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 3590 | 3590 | ||
| 3591 | @defopt c-hanging-semi&comma-criteria | 3591 | @defopt c-hanging-semi&comma-criteria |
| 3592 | @vindex hanging-semi&comma-criteria (c-) | 3592 | @vindex hanging-semi&comma-criteria @r{(c-)} |
| 3593 | This style variable takes a list of functions; these get called when | 3593 | This style variable takes a list of functions; these get called when |
| 3594 | you type a semicolon or comma. The functions are called in order | 3594 | you type a semicolon or comma. The functions are called in order |
| 3595 | without arguments. When these functions are entered, point is just | 3595 | without arguments. When these functions are entered, point is just |
| @@ -3624,7 +3624,7 @@ semicolons, apart from those separating @code{for}-clause statements. | |||
| 3624 | @end defopt | 3624 | @end defopt |
| 3625 | 3625 | ||
| 3626 | @defun c-semi&comma-no-newlines-before-nonblanks | 3626 | @defun c-semi&comma-no-newlines-before-nonblanks |
| 3627 | @findex semi&comma-no-newlines-before-nonblanks (c-) | 3627 | @findex semi&comma-no-newlines-before-nonblanks @r{(c-)} |
| 3628 | This is an example of a criteria function, provided by @ccmode{}. It | 3628 | This is an example of a criteria function, provided by @ccmode{}. It |
| 3629 | prevents newlines from being inserted after semicolons when there is a | 3629 | prevents newlines from being inserted after semicolons when there is a |
| 3630 | non-blank following line. Otherwise, it makes no determination. To | 3630 | non-blank following line. Otherwise, it makes no determination. To |
| @@ -3644,9 +3644,9 @@ use, add this function to the front of the | |||
| 3644 | @end defun | 3644 | @end defun |
| 3645 | 3645 | ||
| 3646 | @defun c-semi&comma-inside-parenlist | 3646 | @defun c-semi&comma-inside-parenlist |
| 3647 | @findex semi&comma-inside-parenlist (c-) | 3647 | @findex semi&comma-inside-parenlist @r{(c-)} |
| 3648 | @defunx c-semi&comma-no-newlines-for-oneline-inliners | 3648 | @defunx c-semi&comma-no-newlines-for-oneline-inliners |
| 3649 | @findex semi&comma-no-newlines-for-oneline-inliners (c-) | 3649 | @findex semi&comma-no-newlines-for-oneline-inliners @r{(c-)} |
| 3650 | The function @code{c-semi&comma-inside-parenlist} is what prevents | 3650 | The function @code{c-semi&comma-inside-parenlist} is what prevents |
| 3651 | newlines from being inserted inside the parenthesis list of @code{for} | 3651 | newlines from being inserted inside the parenthesis list of @code{for} |
| 3652 | statements. In addition to | 3652 | statements. In addition to |
| @@ -3687,7 +3687,7 @@ of the construct, and (apart from @code{comment-close-slash}) when the | |||
| 3687 | construct does not occur within a literal (@pxref{Auto-newlines}). | 3687 | construct does not occur within a literal (@pxref{Auto-newlines}). |
| 3688 | 3688 | ||
| 3689 | @defopt c-cleanup-list | 3689 | @defopt c-cleanup-list |
| 3690 | @vindex cleanup-list (c-) | 3690 | @vindex cleanup-list @r{(c-)} |
| 3691 | @cindex literal | 3691 | @cindex literal |
| 3692 | 3692 | ||
| 3693 | You configure @ccmode{}'s clean-ups by setting the style variable | 3693 | You configure @ccmode{}'s clean-ups by setting the style variable |
| @@ -3870,7 +3870,7 @@ BEGIN @{FS = "\t"@} # use <TAB> as a field separator | |||
| 3870 | @end example | 3870 | @end example |
| 3871 | 3871 | ||
| 3872 | @defopt c-max-one-liner-length | 3872 | @defopt c-max-one-liner-length |
| 3873 | @vindex max-one-liner-length (c-) | 3873 | @vindex max-one-liner-length @r{(c-)} |
| 3874 | The maximum length of the resulting line for which the clean-up | 3874 | The maximum length of the resulting line for which the clean-up |
| 3875 | @code{one-liner-defun} will be triggered. This length is that of the entire | 3875 | @code{one-liner-defun} will be triggered. This length is that of the entire |
| 3876 | line, including any leading whitespace and any trailing comment. Its | 3876 | line, including any leading whitespace and any trailing comment. Its |
| @@ -3953,7 +3953,7 @@ it by setting @code{c-syntactic-indentation} to @code{nil}. (To set | |||
| 3953 | the variable interactively, @ref{Minor Modes}). | 3953 | the variable interactively, @ref{Minor Modes}). |
| 3954 | 3954 | ||
| 3955 | @defopt c-syntactic-indentation | 3955 | @defopt c-syntactic-indentation |
| 3956 | @vindex syntactic-indentation (c-) | 3956 | @vindex syntactic-indentation @r{(c-)} |
| 3957 | When this is non-@code{nil} (which it is by default), the indentation | 3957 | When this is non-@code{nil} (which it is by default), the indentation |
| 3958 | of code is done according to its syntactic structure. When it's | 3958 | of code is done according to its syntactic structure. When it's |
| 3959 | @code{nil}, every line is just indented to the same level as the | 3959 | @code{nil}, every line is just indented to the same level as the |
| @@ -3988,7 +3988,7 @@ Line-up functions (@pxref{Custom Line-Up}) or in functions on | |||
| 3988 | @code{c-special-indent-hook} (@pxref{Other Indentation}). | 3988 | @code{c-special-indent-hook} (@pxref{Other Indentation}). |
| 3989 | 3989 | ||
| 3990 | @defun c-guess-basic-syntax | 3990 | @defun c-guess-basic-syntax |
| 3991 | @findex guess-basic-syntax (c-) | 3991 | @findex guess-basic-syntax @r{(c-)} |
| 3992 | Determine the syntactic context of the current line. | 3992 | Determine the syntactic context of the current line. |
| 3993 | @end defun | 3993 | @end defun |
| 3994 | 3994 | ||
| @@ -4042,7 +4042,7 @@ report what the syntactic analysis is for the current line: | |||
| 4042 | @item @kbd{C-c C-s} (@code{c-show-syntactic-information}) | 4042 | @item @kbd{C-c C-s} (@code{c-show-syntactic-information}) |
| 4043 | @kindex C-c C-s | 4043 | @kindex C-c C-s |
| 4044 | @findex c-show-syntactic-information | 4044 | @findex c-show-syntactic-information |
| 4045 | @findex show-syntactic-information (c-) | 4045 | @findex show-syntactic-information @r{(c-)} |
| 4046 | This command calculates the syntactic analysis of the current line and | 4046 | This command calculates the syntactic analysis of the current line and |
| 4047 | displays it in the minibuffer. The command also highlights the anchor | 4047 | displays it in the minibuffer. The command also highlights the anchor |
| 4048 | position(s). | 4048 | position(s). |
| @@ -4138,7 +4138,7 @@ anchor position. | |||
| 4138 | 4138 | ||
| 4139 | @cindex syntactic symbols, brief list | 4139 | @cindex syntactic symbols, brief list |
| 4140 | @vindex c-offsets-alist | 4140 | @vindex c-offsets-alist |
| 4141 | @vindex offsets-alist (c-) | 4141 | @vindex offsets-alist @r{(c-)} |
| 4142 | This section is a complete list of the syntactic symbols which appear | 4142 | This section is a complete list of the syntactic symbols which appear |
| 4143 | in the @code{c-offsets-alist} style variable, along with brief | 4143 | in the @code{c-offsets-alist} style variable, along with brief |
| 4144 | descriptions. The previous section (@pxref{Syntactic Analysis}) | 4144 | descriptions. The previous section (@pxref{Syntactic Analysis}) |
| @@ -5284,7 +5284,7 @@ The simplest and most used kind of ``offset'' setting in | |||
| 5284 | @code{c-basic-offset}: | 5284 | @code{c-basic-offset}: |
| 5285 | 5285 | ||
| 5286 | @defopt c-basic-offset | 5286 | @defopt c-basic-offset |
| 5287 | @vindex basic-offset (c-) | 5287 | @vindex basic-offset @r{(c-)} |
| 5288 | This style variable holds the basic offset between indentation levels. | 5288 | This style variable holds the basic offset between indentation levels. |
| 5289 | It's factory default is 4, but all the built-in styles set it | 5289 | It's factory default is 4, but all the built-in styles set it |
| 5290 | themselves, to some value between 2 (for @code{gnu} style) and 8 (for | 5290 | themselves, to some value between 2 (for @code{gnu} style) and 8 (for |
| @@ -5322,7 +5322,7 @@ indentation. Details of how to set it up, and its relationship to | |||
| 5322 | @ccmode{}'s style system are given in @ref{Style Variables}. | 5322 | @ccmode{}'s style system are given in @ref{Style Variables}. |
| 5323 | 5323 | ||
| 5324 | @defopt c-offsets-alist | 5324 | @defopt c-offsets-alist |
| 5325 | @vindex offsets-alist (c-) | 5325 | @vindex offsets-alist @r{(c-)} |
| 5326 | This is an alist which associates an offset with each syntactic | 5326 | This is an alist which associates an offset with each syntactic |
| 5327 | symbol. This @dfn{offset} is a rule specifying how to indent a line | 5327 | symbol. This @dfn{offset} is a rule specifying how to indent a line |
| 5328 | whose syntactic context matches the symbol. @xref{Syntactic | 5328 | whose syntactic context matches the symbol. @xref{Syntactic |
| @@ -5355,7 +5355,7 @@ of these kinds of offsets: | |||
| 5355 | @end defopt | 5355 | @end defopt |
| 5356 | 5356 | ||
| 5357 | @deffn Command c-set-offset (@kbd{C-c C-o}) | 5357 | @deffn Command c-set-offset (@kbd{C-c C-o}) |
| 5358 | @findex set-offset (c-) | 5358 | @findex set-offset @r{(c-)} |
| 5359 | @kindex C-c C-o | 5359 | @kindex C-c C-o |
| 5360 | This command changes the entry for a syntactic symbol in the current | 5360 | This command changes the entry for a syntactic symbol in the current |
| 5361 | binding of @code{c-offsets-alist}, or it inserts a new entry if there | 5361 | binding of @code{c-offsets-alist}, or it inserts a new entry if there |
| @@ -5470,7 +5470,7 @@ will be combined according to the method @code{first}. | |||
| 5470 | @end table | 5470 | @end table |
| 5471 | 5471 | ||
| 5472 | @vindex c-strict-syntax-p | 5472 | @vindex c-strict-syntax-p |
| 5473 | @vindex strict-syntax-p (c-) | 5473 | @vindex strict-syntax-p @r{(c-)} |
| 5474 | If an offset specification evaluates to @code{nil}, then a relative | 5474 | If an offset specification evaluates to @code{nil}, then a relative |
| 5475 | offset of 0 (zero) is used@footnote{There is however a variable | 5475 | offset of 0 (zero) is used@footnote{There is however a variable |
| 5476 | @code{c-strict-syntax-p} that when set to non-@code{nil} will cause an | 5476 | @code{c-strict-syntax-p} that when set to non-@code{nil} will cause an |
| @@ -5575,7 +5575,7 @@ adjustments. | |||
| 5575 | 5575 | ||
| 5576 | @c Move this bit to "Styles" (2005/10/7) | 5576 | @c Move this bit to "Styles" (2005/10/7) |
| 5577 | @deffn Command c-set-offset symbol offset | 5577 | @deffn Command c-set-offset symbol offset |
| 5578 | @findex set-offset (c-) | 5578 | @findex set-offset @r{(c-)} |
| 5579 | @kindex C-c C-o | 5579 | @kindex C-c C-o |
| 5580 | This is the command bound to @kbd{C-c C-o}. It provides a convenient | 5580 | This is the command bound to @kbd{C-c C-o}. It provides a convenient |
| 5581 | way to set offsets on @code{c-offsets-alist} both interactively (see | 5581 | way to set offsets on @code{c-offsets-alist} both interactively (see |
| @@ -5671,7 +5671,7 @@ The line-up functions here calculate the indentation for braces, | |||
| 5671 | parentheses and statements within brace blocks. | 5671 | parentheses and statements within brace blocks. |
| 5672 | 5672 | ||
| 5673 | @defun c-lineup-close-paren | 5673 | @defun c-lineup-close-paren |
| 5674 | @findex lineup-close-paren (c-) | 5674 | @findex lineup-close-paren @r{(c-)} |
| 5675 | Line up the closing paren under its corresponding open paren if the | 5675 | Line up the closing paren under its corresponding open paren if the |
| 5676 | open paren is followed by code. If the open paren ends its line, no | 5676 | open paren is followed by code. If the open paren ends its line, no |
| 5677 | indentation is added. E.g.: | 5677 | indentation is added. E.g.: |
| @@ -5707,7 +5707,7 @@ open parenthesis of the argument list, the indentation is | |||
| 5707 | 5707 | ||
| 5708 | @anchor{c-lineup-arglist-close-under-paren} | 5708 | @anchor{c-lineup-arglist-close-under-paren} |
| 5709 | @defun c-lineup-arglist-close-under-paren | 5709 | @defun c-lineup-arglist-close-under-paren |
| 5710 | @findex lineup-arglist-close-under-paren (c-) | 5710 | @findex lineup-arglist-close-under-paren @r{(c-)} |
| 5711 | Set your @code{arglist-close} syntactic symbol to this line-up function | 5711 | Set your @code{arglist-close} syntactic symbol to this line-up function |
| 5712 | so that parentheses that close argument lists will line up under the | 5712 | so that parentheses that close argument lists will line up under the |
| 5713 | parenthesis that opened the argument list. It can also be used with | 5713 | parenthesis that opened the argument list. It can also be used with |
| @@ -5727,7 +5727,7 @@ discussion of this ``DWIM'' measure. | |||
| 5727 | @comment ------------------------------------------------------------ | 5727 | @comment ------------------------------------------------------------ |
| 5728 | 5728 | ||
| 5729 | @defun c-indent-one-line-block | 5729 | @defun c-indent-one-line-block |
| 5730 | @findex indent-one-line-block (c-) | 5730 | @findex indent-one-line-block @r{(c-)} |
| 5731 | Indent a one line block @code{c-basic-offset} extra. E.g.: | 5731 | Indent a one line block @code{c-basic-offset} extra. E.g.: |
| 5732 | 5732 | ||
| 5733 | @example | 5733 | @example |
| @@ -5761,7 +5761,7 @@ which makes the function usable in list expressions. | |||
| 5761 | @comment ------------------------------------------------------------ | 5761 | @comment ------------------------------------------------------------ |
| 5762 | 5762 | ||
| 5763 | @defun c-indent-multi-line-block | 5763 | @defun c-indent-multi-line-block |
| 5764 | @findex indent-multi-line-block (c-) | 5764 | @findex indent-multi-line-block @r{(c-)} |
| 5765 | Indent a multiline block @code{c-basic-offset} extra. E.g.: | 5765 | Indent a multiline block @code{c-basic-offset} extra. E.g.: |
| 5766 | 5766 | ||
| 5767 | @example | 5767 | @example |
| @@ -5797,7 +5797,7 @@ block, which makes the function usable in list expressions. | |||
| 5797 | @comment ------------------------------------------------------------ | 5797 | @comment ------------------------------------------------------------ |
| 5798 | 5798 | ||
| 5799 | @defun c-lineup-runin-statements | 5799 | @defun c-lineup-runin-statements |
| 5800 | @findex lineup-runin-statements (c-) | 5800 | @findex lineup-runin-statements @r{(c-)} |
| 5801 | Line up statements for coding standards which place the first statement | 5801 | Line up statements for coding standards which place the first statement |
| 5802 | in a block on the same line as the block opening brace@footnote{Run-in | 5802 | in a block on the same line as the block opening brace@footnote{Run-in |
| 5803 | style doesn't really work too well. You might need to write your own | 5803 | style doesn't really work too well. You might need to write your own |
| @@ -5822,7 +5822,7 @@ expressions. | |||
| 5822 | @comment ------------------------------------------------------------ | 5822 | @comment ------------------------------------------------------------ |
| 5823 | 5823 | ||
| 5824 | @defun c-lineup-inexpr-block | 5824 | @defun c-lineup-inexpr-block |
| 5825 | @findex lineup-inexpr-block (c-) | 5825 | @findex lineup-inexpr-block @r{(c-)} |
| 5826 | This can be used with the in-expression block symbols to indent the | 5826 | This can be used with the in-expression block symbols to indent the |
| 5827 | whole block to the column where the construct is started. E.g., for Java | 5827 | whole block to the column where the construct is started. E.g., for Java |
| 5828 | anonymous classes, this lines up the class under the @samp{new} keyword, | 5828 | anonymous classes, this lines up the class under the @samp{new} keyword, |
| @@ -5837,7 +5837,7 @@ construct. | |||
| 5837 | @comment ------------------------------------------------------------ | 5837 | @comment ------------------------------------------------------------ |
| 5838 | 5838 | ||
| 5839 | @defun c-lineup-after-whitesmith-blocks | 5839 | @defun c-lineup-after-whitesmith-blocks |
| 5840 | @findex lineup-after-whitesmith-blocks (c-) | 5840 | @findex lineup-after-whitesmith-blocks @r{(c-)} |
| 5841 | Compensate for Whitesmith style indentation of blocks. Due to the way | 5841 | Compensate for Whitesmith style indentation of blocks. Due to the way |
| 5842 | @ccmode{} calculates anchor positions for normal lines inside blocks, | 5842 | @ccmode{} calculates anchor positions for normal lines inside blocks, |
| 5843 | this function is necessary for those lines to get correct Whitesmith | 5843 | this function is necessary for those lines to get correct Whitesmith |
| @@ -5882,7 +5882,7 @@ indents relative to the surrounding block just like | |||
| 5882 | @comment ------------------------------------------------------------ | 5882 | @comment ------------------------------------------------------------ |
| 5883 | 5883 | ||
| 5884 | @defun c-lineup-whitesmith-in-block | 5884 | @defun c-lineup-whitesmith-in-block |
| 5885 | @findex lineup-whitesmith-in-block (c-) | 5885 | @findex lineup-whitesmith-in-block @r{(c-)} |
| 5886 | Line up lines inside a block in Whitesmith style. It's done in a way | 5886 | Line up lines inside a block in Whitesmith style. It's done in a way |
| 5887 | that works both when the opening brace hangs and when it doesn't. E.g.: | 5887 | that works both when the opening brace hangs and when it doesn't. E.g.: |
| 5888 | 5888 | ||
| @@ -5932,7 +5932,7 @@ for indenting a close parenthesis, is also useful for the lines | |||
| 5932 | contained within parentheses. | 5932 | contained within parentheses. |
| 5933 | 5933 | ||
| 5934 | @defun c-lineup-arglist | 5934 | @defun c-lineup-arglist |
| 5935 | @findex lineup-arglist (c-) | 5935 | @findex lineup-arglist @r{(c-)} |
| 5936 | Line up the current argument line under the first argument. | 5936 | Line up the current argument line under the first argument. |
| 5937 | 5937 | ||
| 5938 | As a special case, if an argument on the same line as the open | 5938 | As a special case, if an argument on the same line as the open |
| @@ -5960,7 +5960,7 @@ indent such cases this way. | |||
| 5960 | @comment ------------------------------------------------------------ | 5960 | @comment ------------------------------------------------------------ |
| 5961 | 5961 | ||
| 5962 | @defun c-lineup-arglist-intro-after-paren | 5962 | @defun c-lineup-arglist-intro-after-paren |
| 5963 | @findex lineup-arglist-intro-after-paren (c-) | 5963 | @findex lineup-arglist-intro-after-paren @r{(c-)} |
| 5964 | Line up a line to just after the open paren of the surrounding paren or | 5964 | Line up a line to just after the open paren of the surrounding paren or |
| 5965 | brace block. | 5965 | brace block. |
| 5966 | 5966 | ||
| @@ -5972,7 +5972,7 @@ brace block. | |||
| 5972 | @comment ------------------------------------------------------------ | 5972 | @comment ------------------------------------------------------------ |
| 5973 | 5973 | ||
| 5974 | @defun c-lineup-multi-inher | 5974 | @defun c-lineup-multi-inher |
| 5975 | @findex lineup-multi-inher (c-) | 5975 | @findex lineup-multi-inher @r{(c-)} |
| 5976 | Line up the classes in C++ multiple inheritance clauses and member | 5976 | Line up the classes in C++ multiple inheritance clauses and member |
| 5977 | initializers under each other. E.g.: | 5977 | initializers under each other. E.g.: |
| 5978 | 5978 | ||
| @@ -6012,7 +6012,7 @@ Foo::Foo (int a, int b) | |||
| 6012 | @comment ------------------------------------------------------------ | 6012 | @comment ------------------------------------------------------------ |
| 6013 | 6013 | ||
| 6014 | @defun c-lineup-java-inher | 6014 | @defun c-lineup-java-inher |
| 6015 | @findex lineup-java-inher (c-) | 6015 | @findex lineup-java-inher @r{(c-)} |
| 6016 | Line up Java implements and extends declarations. If class names | 6016 | Line up Java implements and extends declarations. If class names |
| 6017 | follow on the same line as the @samp{implements}/@samp{extends} | 6017 | follow on the same line as the @samp{implements}/@samp{extends} |
| 6018 | keyword, they are lined up under each other. Otherwise, they are | 6018 | keyword, they are lined up under each other. Otherwise, they are |
| @@ -6045,7 +6045,7 @@ class Foo | |||
| 6045 | @comment ------------------------------------------------------------ | 6045 | @comment ------------------------------------------------------------ |
| 6046 | 6046 | ||
| 6047 | @defun c-lineup-java-throws | 6047 | @defun c-lineup-java-throws |
| 6048 | @findex lineup-java-throws (c-) | 6048 | @findex lineup-java-throws @r{(c-)} |
| 6049 | Line up Java throws declarations. If exception names follow on the | 6049 | Line up Java throws declarations. If exception names follow on the |
| 6050 | same line as the throws keyword, they are lined up under each other. | 6050 | same line as the throws keyword, they are lined up under each other. |
| 6051 | Otherwise, they are indented by adding @code{c-basic-offset} to the | 6051 | Otherwise, they are indented by adding @code{c-basic-offset} to the |
| @@ -6079,7 +6079,7 @@ int foo() throws Cyphr, | |||
| 6079 | @comment ------------------------------------------------------------ | 6079 | @comment ------------------------------------------------------------ |
| 6080 | 6080 | ||
| 6081 | @defun c-lineup-template-args | 6081 | @defun c-lineup-template-args |
| 6082 | @findex lineup-template-args (c-) | 6082 | @findex lineup-template-args @r{(c-)} |
| 6083 | Line up the arguments of a template argument list under each other, but | 6083 | Line up the arguments of a template argument list under each other, but |
| 6084 | only in the case where the first argument is on the same line as the | 6084 | only in the case where the first argument is on the same line as the |
| 6085 | opening @samp{<}. | 6085 | opening @samp{<}. |
| @@ -6093,7 +6093,7 @@ returned if there's no template argument on the first line. | |||
| 6093 | @comment ------------------------------------------------------------ | 6093 | @comment ------------------------------------------------------------ |
| 6094 | 6094 | ||
| 6095 | @defun c-lineup-ObjC-method-call | 6095 | @defun c-lineup-ObjC-method-call |
| 6096 | @findex lineup-ObjC-method-call (c-) | 6096 | @findex lineup-ObjC-method-call @r{(c-)} |
| 6097 | For Objective-C code, line up selector args as Emacs Lisp mode does | 6097 | For Objective-C code, line up selector args as Emacs Lisp mode does |
| 6098 | with function args: go to the position right after the message receiver, | 6098 | with function args: go to the position right after the message receiver, |
| 6099 | and if you are at the end of the line, indent the current line | 6099 | and if you are at the end of the line, indent the current line |
| @@ -6107,7 +6107,7 @@ lineup the current line with it. | |||
| 6107 | @comment ------------------------------------------------------------ | 6107 | @comment ------------------------------------------------------------ |
| 6108 | 6108 | ||
| 6109 | @defun c-lineup-ObjC-method-args | 6109 | @defun c-lineup-ObjC-method-args |
| 6110 | @findex lineup-ObjC-method-args (c-) | 6110 | @findex lineup-ObjC-method-args @r{(c-)} |
| 6111 | For Objective-C code, line up the colons that separate args. The colon | 6111 | For Objective-C code, line up the colons that separate args. The colon |
| 6112 | on the current line is aligned with the one on the first line. | 6112 | on the current line is aligned with the one on the first line. |
| 6113 | 6113 | ||
| @@ -6117,7 +6117,7 @@ on the current line is aligned with the one on the first line. | |||
| 6117 | @comment ------------------------------------------------------------ | 6117 | @comment ------------------------------------------------------------ |
| 6118 | 6118 | ||
| 6119 | @defun c-lineup-ObjC-method-args-2 | 6119 | @defun c-lineup-ObjC-method-args-2 |
| 6120 | @findex lineup-ObjC-method-args-2 (c-) | 6120 | @findex lineup-ObjC-method-args-2 @r{(c-)} |
| 6121 | Similar to @code{c-lineup-ObjC-method-args} but lines up the colon on | 6121 | Similar to @code{c-lineup-ObjC-method-args} but lines up the colon on |
| 6122 | the current line with the colon on the previous line. | 6122 | the current line with the colon on the previous line. |
| 6123 | 6123 | ||
| @@ -6135,7 +6135,7 @@ start with an operator, by lining it up with something on the previous | |||
| 6135 | line. | 6135 | line. |
| 6136 | 6136 | ||
| 6137 | @defun c-lineup-argcont | 6137 | @defun c-lineup-argcont |
| 6138 | @findex lineup-argcont (c-) | 6138 | @findex lineup-argcont @r{(c-)} |
| 6139 | Line up a continued argument. E.g.: | 6139 | Line up a continued argument. E.g.: |
| 6140 | 6140 | ||
| 6141 | @example | 6141 | @example |
| @@ -6158,7 +6158,7 @@ expressions for the operands. | |||
| 6158 | @comment ------------------------------------------------------------ | 6158 | @comment ------------------------------------------------------------ |
| 6159 | 6159 | ||
| 6160 | @defun c-lineup-arglist-operators | 6160 | @defun c-lineup-arglist-operators |
| 6161 | @findex lineup-arglist-operators (c-) | 6161 | @findex lineup-arglist-operators @r{(c-)} |
| 6162 | Line up lines starting with an infix operator under the open paren. | 6162 | Line up lines starting with an infix operator under the open paren. |
| 6163 | Return @code{nil} on lines that don't start with an operator, to leave | 6163 | Return @code{nil} on lines that don't start with an operator, to leave |
| 6164 | those cases to other line-up functions. Example: | 6164 | those cases to other line-up functions. Example: |
| @@ -6192,7 +6192,7 @@ suggestion to get a consistent style): | |||
| 6192 | @comment ------------------------------------------------------------ | 6192 | @comment ------------------------------------------------------------ |
| 6193 | 6193 | ||
| 6194 | @defun c-lineup-assignments | 6194 | @defun c-lineup-assignments |
| 6195 | @findex lineup-assignments (c-) | 6195 | @findex lineup-assignments @r{(c-)} |
| 6196 | Line up the current line after the assignment operator on the first line | 6196 | Line up the current line after the assignment operator on the first line |
| 6197 | in the statement. If there isn't any, return @code{nil} to allow stacking with | 6197 | in the statement. If there isn't any, return @code{nil} to allow stacking with |
| 6198 | other line-up functions. If the current line contains an assignment | 6198 | other line-up functions. If the current line contains an assignment |
| @@ -6206,7 +6206,7 @@ operator too, try to align it with the first one. | |||
| 6206 | @comment ------------------------------------------------------------ | 6206 | @comment ------------------------------------------------------------ |
| 6207 | 6207 | ||
| 6208 | @defun c-lineup-math | 6208 | @defun c-lineup-math |
| 6209 | @findex lineup-math (c-) | 6209 | @findex lineup-math @r{(c-)} |
| 6210 | Like @code{c-lineup-assignments} but indent with @code{c-basic-offset} | 6210 | Like @code{c-lineup-assignments} but indent with @code{c-basic-offset} |
| 6211 | if no assignment operator was found on the first line. I.e., this | 6211 | if no assignment operator was found on the first line. I.e., this |
| 6212 | function is the same as specifying a list @code{(c-lineup-assignments | 6212 | function is the same as specifying a list @code{(c-lineup-assignments |
| @@ -6219,7 +6219,7 @@ function is the same as specifying a list @code{(c-lineup-assignments | |||
| 6219 | @comment ------------------------------------------------------------ | 6219 | @comment ------------------------------------------------------------ |
| 6220 | 6220 | ||
| 6221 | @defun c-lineup-cascaded-calls | 6221 | @defun c-lineup-cascaded-calls |
| 6222 | @findex lineup-cascaded-calls (c-) | 6222 | @findex lineup-cascaded-calls @r{(c-)} |
| 6223 | Line up ``cascaded calls'' under each other. If the line begins with | 6223 | Line up ``cascaded calls'' under each other. If the line begins with |
| 6224 | @code{->} or @code{.} and the preceding line ends with one or more | 6224 | @code{->} or @code{.} and the preceding line ends with one or more |
| 6225 | function calls preceded by the same token, then the arrow is lined up | 6225 | function calls preceded by the same token, then the arrow is lined up |
| @@ -6243,7 +6243,7 @@ expressions. | |||
| 6243 | @comment ------------------------------------------------------------ | 6243 | @comment ------------------------------------------------------------ |
| 6244 | 6244 | ||
| 6245 | @defun c-lineup-streamop | 6245 | @defun c-lineup-streamop |
| 6246 | @findex lineup-streamop (c-) | 6246 | @findex lineup-streamop @r{(c-)} |
| 6247 | Line up C++ stream operators (i.e., @samp{<<} and @samp{>>}). | 6247 | Line up C++ stream operators (i.e., @samp{<<} and @samp{>>}). |
| 6248 | 6248 | ||
| 6249 | @workswith @code{stream-op}. | 6249 | @workswith @code{stream-op}. |
| @@ -6252,7 +6252,7 @@ Line up C++ stream operators (i.e., @samp{<<} and @samp{>>}). | |||
| 6252 | @comment ------------------------------------------------------------ | 6252 | @comment ------------------------------------------------------------ |
| 6253 | 6253 | ||
| 6254 | @defun c-lineup-string-cont | 6254 | @defun c-lineup-string-cont |
| 6255 | @findex lineup-string-cont (c-) | 6255 | @findex lineup-string-cont @r{(c-)} |
| 6256 | Line up a continued string under the one it continues. A continued | 6256 | Line up a continued string under the one it continues. A continued |
| 6257 | string in this sense is where a string literal follows directly after | 6257 | string in this sense is where a string literal follows directly after |
| 6258 | another one. E.g.: | 6258 | another one. E.g.: |
| @@ -6282,7 +6282,7 @@ The lineup functions here calculate the indentation for several types | |||
| 6282 | of comment structure. | 6282 | of comment structure. |
| 6283 | 6283 | ||
| 6284 | @defun c-lineup-C-comments | 6284 | @defun c-lineup-C-comments |
| 6285 | @findex lineup-C-comments (c-) | 6285 | @findex lineup-C-comments @r{(c-)} |
| 6286 | Line up C block comment continuation lines. Various heuristics are used | 6286 | Line up C block comment continuation lines. Various heuristics are used |
| 6287 | to handle most of the common comment styles. Some examples: | 6287 | to handle most of the common comment styles. Some examples: |
| 6288 | 6288 | ||
| @@ -6334,13 +6334,13 @@ line inside a comment. | |||
| 6334 | @comment ------------------------------------------------------------ | 6334 | @comment ------------------------------------------------------------ |
| 6335 | 6335 | ||
| 6336 | @defun c-lineup-comment | 6336 | @defun c-lineup-comment |
| 6337 | @findex lineup-comment (c-) | 6337 | @findex lineup-comment @r{(c-)} |
| 6338 | Line up a comment-only line according to the style variable | 6338 | Line up a comment-only line according to the style variable |
| 6339 | @code{c-comment-only-line-offset}. If the comment is lined up with a | 6339 | @code{c-comment-only-line-offset}. If the comment is lined up with a |
| 6340 | comment starter on the previous line, that alignment is preserved. | 6340 | comment starter on the previous line, that alignment is preserved. |
| 6341 | 6341 | ||
| 6342 | @defopt c-comment-only-line-offset | 6342 | @defopt c-comment-only-line-offset |
| 6343 | @vindex comment-only-line-offset (c-) | 6343 | @vindex comment-only-line-offset @r{(c-)} |
| 6344 | This style variable specifies the extra offset for the line. It can | 6344 | This style variable specifies the extra offset for the line. It can |
| 6345 | contain an integer or a cons cell of the form | 6345 | contain an integer or a cons cell of the form |
| 6346 | 6346 | ||
| @@ -6361,7 +6361,7 @@ is equivalent to @code{(@r{@var{value}} . -1000)}. | |||
| 6361 | @comment ------------------------------------------------------------ | 6361 | @comment ------------------------------------------------------------ |
| 6362 | 6362 | ||
| 6363 | @defun c-lineup-knr-region-comment | 6363 | @defun c-lineup-knr-region-comment |
| 6364 | @findex lineup-knr-region-comment (c-) | 6364 | @findex lineup-knr-region-comment @r{(c-)} |
| 6365 | Line up a comment in the ``K&R region'' with the declaration. That is | 6365 | Line up a comment in the ``K&R region'' with the declaration. That is |
| 6366 | the region between the function or class header and the beginning of the | 6366 | the region between the function or class header and the beginning of the |
| 6367 | block. E.g.: | 6367 | block. E.g.: |
| @@ -6392,7 +6392,7 @@ The line-up functions here are the odds and ends which didn't fit into | |||
| 6392 | any earlier category. | 6392 | any earlier category. |
| 6393 | 6393 | ||
| 6394 | @defun c-lineup-dont-change | 6394 | @defun c-lineup-dont-change |
| 6395 | @findex lineup-dont-change (c-) | 6395 | @findex lineup-dont-change @r{(c-)} |
| 6396 | This lineup function makes the line stay at whatever indentation it | 6396 | This lineup function makes the line stay at whatever indentation it |
| 6397 | already has; think of it as an identity function for lineups. | 6397 | already has; think of it as an identity function for lineups. |
| 6398 | 6398 | ||
| @@ -6413,7 +6413,7 @@ disregarded. | |||
| 6413 | @comment ------------------------------------------------------------ | 6413 | @comment ------------------------------------------------------------ |
| 6414 | 6414 | ||
| 6415 | @defun c-lineup-cpp-define | 6415 | @defun c-lineup-cpp-define |
| 6416 | @findex lineup-cpp-define (c-) | 6416 | @findex lineup-cpp-define @r{(c-)} |
| 6417 | Line up macro continuation lines according to the indentation of the | 6417 | Line up macro continuation lines according to the indentation of the |
| 6418 | construct preceding the macro. E.g.: | 6418 | construct preceding the macro. E.g.: |
| 6419 | 6419 | ||
| @@ -6502,7 +6502,7 @@ described above. | |||
| 6502 | @comment ------------------------------------------------------------ | 6502 | @comment ------------------------------------------------------------ |
| 6503 | 6503 | ||
| 6504 | @defun c-lineup-gcc-asm-reg | 6504 | @defun c-lineup-gcc-asm-reg |
| 6505 | @findex lineup-gcc-asm-reg (c-) | 6505 | @findex lineup-gcc-asm-reg @r{(c-)} |
| 6506 | Line up a gcc asm register under one on a previous line. | 6506 | Line up a gcc asm register under one on a previous line. |
| 6507 | 6507 | ||
| 6508 | @example | 6508 | @example |
| @@ -6534,7 +6534,7 @@ arglist lineups, e.g.: | |||
| 6534 | @comment ------------------------------------------------------------ | 6534 | @comment ------------------------------------------------------------ |
| 6535 | 6535 | ||
| 6536 | @defun c-lineup-topmost-intro-cont | 6536 | @defun c-lineup-topmost-intro-cont |
| 6537 | @findex lineup-topmost-intro-cont (c-) | 6537 | @findex lineup-topmost-intro-cont @r{(c-)} |
| 6538 | Line up declaration continuation lines zero or one indentation | 6538 | Line up declaration continuation lines zero or one indentation |
| 6539 | step@footnote{This function is mainly provided to mimic the behavior of | 6539 | step@footnote{This function is mainly provided to mimic the behavior of |
| 6540 | CC Mode 5.28 and earlier where this case wasn't handled consistently so | 6540 | CC Mode 5.28 and earlier where this case wasn't handled consistently so |
| @@ -6644,9 +6644,9 @@ your setup for this by using the access functions | |||
| 6644 | (@code{c-langelem-sym}, etc.)@: described below. | 6644 | (@code{c-langelem-sym}, etc.)@: described below. |
| 6645 | 6645 | ||
| 6646 | @vindex c-syntactic-element | 6646 | @vindex c-syntactic-element |
| 6647 | @vindex syntactic-element (c-) | 6647 | @vindex syntactic-element @r{(c-)} |
| 6648 | @vindex c-syntactic-context | 6648 | @vindex c-syntactic-context |
| 6649 | @vindex syntactic-context (c-) | 6649 | @vindex syntactic-context @r{(c-)} |
| 6650 | Some syntactic symbols, e.g., @code{arglist-cont-nonempty}, have more | 6650 | Some syntactic symbols, e.g., @code{arglist-cont-nonempty}, have more |
| 6651 | info in the syntactic element: typically other positions that can be | 6651 | info in the syntactic element: typically other positions that can be |
| 6652 | interesting besides the anchor position. That info can't be accessed | 6652 | interesting besides the anchor position. That info can't be accessed |
| @@ -6664,24 +6664,24 @@ used in the line-up function argument and the new list form used in | |||
| 6664 | @code{c-syntactic-element} and everywhere else. The functions are: | 6664 | @code{c-syntactic-element} and everywhere else. The functions are: |
| 6665 | 6665 | ||
| 6666 | @defun c-langelem-sym langelem | 6666 | @defun c-langelem-sym langelem |
| 6667 | @findex langelem-sym (c-) | 6667 | @findex langelem-sym @r{(c-)} |
| 6668 | Return the syntactic symbol in @var{langelem}. | 6668 | Return the syntactic symbol in @var{langelem}. |
| 6669 | @end defun | 6669 | @end defun |
| 6670 | 6670 | ||
| 6671 | @defun c-langelem-pos langelem | 6671 | @defun c-langelem-pos langelem |
| 6672 | @findex langelem-pos (c-) | 6672 | @findex langelem-pos @r{(c-)} |
| 6673 | Return the anchor position in @var{langelem}, or @code{nil} if there is none. | 6673 | Return the anchor position in @var{langelem}, or @code{nil} if there is none. |
| 6674 | @end defun | 6674 | @end defun |
| 6675 | 6675 | ||
| 6676 | @defun c-langelem-col langelem &optional preserve-point | 6676 | @defun c-langelem-col langelem &optional preserve-point |
| 6677 | @findex langelem-col (c-) | 6677 | @findex langelem-col @r{(c-)} |
| 6678 | Return the column of the anchor position in @var{langelem}. Also move | 6678 | Return the column of the anchor position in @var{langelem}. Also move |
| 6679 | the point to that position unless @var{preserve-point} is | 6679 | the point to that position unless @var{preserve-point} is |
| 6680 | non-@code{nil}. | 6680 | non-@code{nil}. |
| 6681 | @end defun | 6681 | @end defun |
| 6682 | 6682 | ||
| 6683 | @defun c-langelem-2nd-pos langelem | 6683 | @defun c-langelem-2nd-pos langelem |
| 6684 | @findex langelem-2nd-pos (c-) | 6684 | @findex langelem-2nd-pos @r{(c-)} |
| 6685 | Return the secondary position in @var{langelem}, or @code{nil} if there | 6685 | Return the secondary position in @var{langelem}, or @code{nil} if there |
| 6686 | is none. | 6686 | is none. |
| 6687 | 6687 | ||
| @@ -6712,20 +6712,20 @@ see @xref{Macros with ;}. | |||
| 6712 | Here are the remaining odds and ends regarding indentation: | 6712 | Here are the remaining odds and ends regarding indentation: |
| 6713 | 6713 | ||
| 6714 | @defopt c-label-minimum-indentation | 6714 | @defopt c-label-minimum-indentation |
| 6715 | @vindex label-minimum-indentation (c-) | 6715 | @vindex label-minimum-indentation @r{(c-)} |
| 6716 | In @samp{gnu} style (@pxref{Built-in Styles}), a minimum indentation is | 6716 | In @samp{gnu} style (@pxref{Built-in Styles}), a minimum indentation is |
| 6717 | imposed on lines inside code blocks. This minimum indentation is | 6717 | imposed on lines inside code blocks. This minimum indentation is |
| 6718 | controlled by this style variable. The default value is 1. | 6718 | controlled by this style variable. The default value is 1. |
| 6719 | 6719 | ||
| 6720 | @findex c-gnu-impose-minimum | 6720 | @findex c-gnu-impose-minimum |
| 6721 | @findex gnu-impose-minimum (c-) | 6721 | @findex gnu-impose-minimum @r{(c-)} |
| 6722 | It's the function @code{c-gnu-impose-minimum} that enforces this minimum | 6722 | It's the function @code{c-gnu-impose-minimum} that enforces this minimum |
| 6723 | indentation. It must be present on @code{c-special-indent-hook} to | 6723 | indentation. It must be present on @code{c-special-indent-hook} to |
| 6724 | work. | 6724 | work. |
| 6725 | @end defopt | 6725 | @end defopt |
| 6726 | 6726 | ||
| 6727 | @defopt c-special-indent-hook | 6727 | @defopt c-special-indent-hook |
| 6728 | @vindex special-indent-hook (c-) | 6728 | @vindex special-indent-hook @r{(c-)} |
| 6729 | This style variable is a standard hook variable that is called after | 6729 | This style variable is a standard hook variable that is called after |
| 6730 | every line is indented by @ccmode{}. It is called only if | 6730 | every line is indented by @ccmode{}. It is called only if |
| 6731 | @code{c-syntactic-indentation} is non-@code{nil} (which it is by | 6731 | @code{c-syntactic-indentation} is non-@code{nil} (which it is by |
| @@ -6772,7 +6772,7 @@ each other as though they were code. You can suppress this behavior | |||
| 6772 | by setting the following user option: | 6772 | by setting the following user option: |
| 6773 | 6773 | ||
| 6774 | @defopt c-syntactic-indentation-in-macros | 6774 | @defopt c-syntactic-indentation-in-macros |
| 6775 | @vindex syntactic-indentation-in-macros (c-) | 6775 | @vindex syntactic-indentation-in-macros @r{(c-)} |
| 6776 | Enable syntactic analysis inside macros, which is the default. If this | 6776 | Enable syntactic analysis inside macros, which is the default. If this |
| 6777 | is @code{nil}, all lines inside macro definitions are analyzed as | 6777 | is @code{nil}, all lines inside macro definitions are analyzed as |
| 6778 | @code{cpp-macro-cont}. | 6778 | @code{cpp-macro-cont}. |
| @@ -6808,9 +6808,9 @@ backslashes in macros neat and tidy. Their precise action is | |||
| 6808 | customized with these variables: | 6808 | customized with these variables: |
| 6809 | 6809 | ||
| 6810 | @defopt c-backslash-column | 6810 | @defopt c-backslash-column |
| 6811 | @vindex backslash-column (c-) | 6811 | @vindex backslash-column @r{(c-)} |
| 6812 | @defoptx c-backslash-max-column | 6812 | @defoptx c-backslash-max-column |
| 6813 | @vindex backslash-max-column (c-) | 6813 | @vindex backslash-max-column @r{(c-)} |
| 6814 | These variables control the alignment columns for line continuation | 6814 | These variables control the alignment columns for line continuation |
| 6815 | backslashes in multiline macros. They are used by the functions that | 6815 | backslashes in multiline macros. They are used by the functions that |
| 6816 | automatically insert or align such backslashes, | 6816 | automatically insert or align such backslashes, |
| @@ -6831,7 +6831,7 @@ the automatic alignment of backslashes, use | |||
| 6831 | @end defopt | 6831 | @end defopt |
| 6832 | 6832 | ||
| 6833 | @defopt c-auto-align-backslashes | 6833 | @defopt c-auto-align-backslashes |
| 6834 | @vindex auto-align-backslashes (c-) | 6834 | @vindex auto-align-backslashes @r{(c-)} |
| 6835 | Align automatically inserted line continuation backslashes if | 6835 | Align automatically inserted line continuation backslashes if |
| 6836 | non-@code{nil}. When line continuation backslashes are inserted | 6836 | non-@code{nil}. When line continuation backslashes are inserted |
| 6837 | automatically for line breaks in multiline macros, e.g., by | 6837 | automatically for line breaks in multiline macros, e.g., by |
| @@ -6862,7 +6862,7 @@ You can prevent these by specifying which macros have semicolons. It | |||
| 6862 | doesn't matter whether or not such a macro has a parameter list: | 6862 | doesn't matter whether or not such a macro has a parameter list: |
| 6863 | 6863 | ||
| 6864 | @defopt c-macro-names-with-semicolon | 6864 | @defopt c-macro-names-with-semicolon |
| 6865 | @vindex macro-names-with-semicolon (c-) | 6865 | @vindex macro-names-with-semicolon @r{(c-)} |
| 6866 | This buffer-local variable specifies which macros have semicolons. | 6866 | This buffer-local variable specifies which macros have semicolons. |
| 6867 | After setting its value, you need to call | 6867 | After setting its value, you need to call |
| 6868 | @code{c-make-macro-with-semi-re} for it to take effect. It should be | 6868 | @code{c-make-macro-with-semi-re} for it to take effect. It should be |
| @@ -6894,7 +6894,7 @@ example: | |||
| 6894 | @end defopt | 6894 | @end defopt |
| 6895 | 6895 | ||
| 6896 | @defun c-make-macro-with-semi-re | 6896 | @defun c-make-macro-with-semi-re |
| 6897 | @findex make-macro-with-semi-re (c-) | 6897 | @findex make-macro-with-semi-re @r{(c-)} |
| 6898 | Call this (non-interactive) function, which sets internal variables, | 6898 | Call this (non-interactive) function, which sets internal variables, |
| 6899 | each time you change the value of @code{c-macro-names-with-semicolon} | 6899 | each time you change the value of @code{c-macro-names-with-semicolon} |
| 6900 | after the major mode function has run. It takes no arguments, and its | 6900 | after the major mode function has run. It takes no arguments, and its |
| @@ -6921,7 +6921,7 @@ can prevent this confusion by specifying the identifiers which | |||
| 6921 | constitute noise macros. | 6921 | constitute noise macros. |
| 6922 | 6922 | ||
| 6923 | @defopt c-noise-macro-names | 6923 | @defopt c-noise-macro-names |
| 6924 | @vindex noise-macro-names (c-) | 6924 | @vindex noise-macro-names @r{(c-)} |
| 6925 | This variable is a list of names of noise macros which never have | 6925 | This variable is a list of names of noise macros which never have |
| 6926 | parenthesized arguments. Each element is a string, and must be a | 6926 | parenthesized arguments. Each element is a string, and must be a |
| 6927 | valid identifier. An element in @code{c-noise-macro-names} must not | 6927 | valid identifier. An element in @code{c-noise-macro-names} must not |
| @@ -6930,7 +6930,7 @@ treated as whitespace by @ccmode{}. | |||
| 6930 | @end defopt | 6930 | @end defopt |
| 6931 | 6931 | ||
| 6932 | @defopt c-noise-macro-with-parens-names | 6932 | @defopt c-noise-macro-with-parens-names |
| 6933 | @vindex noise-macro-with-parens-names (c-) | 6933 | @vindex noise-macro-with-parens-names @r{(c-)} |
| 6934 | This variable is a list of names of noise macros which optionally have | 6934 | This variable is a list of names of noise macros which optionally have |
| 6935 | arguments in parentheses. Each element of the list is a string, and | 6935 | arguments in parentheses. Each element of the list is a string, and |
| 6936 | must be a valid identifier. An element in | 6936 | must be a valid identifier. An element in |
| @@ -6949,7 +6949,7 @@ but doing so is OK. | |||
| 6949 | @end defopt | 6949 | @end defopt |
| 6950 | 6950 | ||
| 6951 | @defun c-make-noise-macro-regexps | 6951 | @defun c-make-noise-macro-regexps |
| 6952 | @findex make-noise-macro-regexps (c-) | 6952 | @findex make-noise-macro-regexps @r{(c-)} |
| 6953 | Call this (non-interactive) function, which sets internal variables, | 6953 | Call this (non-interactive) function, which sets internal variables, |
| 6954 | on changing the value of @code{c-noise-macro-names} or | 6954 | on changing the value of @code{c-noise-macro-names} or |
| 6955 | @code{c-noise-macro-with-parens-names} after the major mode's function | 6955 | @code{c-noise-macro-with-parens-names} after the major mode's function |
| @@ -6966,7 +6966,7 @@ after the mode hooks have run. | |||
| 6966 | The stuff that didn't fit in anywhere else is documented here. | 6966 | The stuff that didn't fit in anywhere else is documented here. |
| 6967 | 6967 | ||
| 6968 | @defopt c-require-final-newline | 6968 | @defopt c-require-final-newline |
| 6969 | @vindex require-final-newline (c-) | 6969 | @vindex require-final-newline @r{(c-)} |
| 6970 | Controls whether a final newline is enforced when the file is saved. | 6970 | Controls whether a final newline is enforced when the file is saved. |
| 6971 | The value is an association list that for each language mode specifies | 6971 | The value is an association list that for each language mode specifies |
| 6972 | the value to give to @code{require-final-newline} (@pxref{Saving | 6972 | the value to give to @code{require-final-newline} (@pxref{Saving |
| @@ -6980,7 +6980,7 @@ These are C, C++ and Objective-C. | |||
| 6980 | @end defopt | 6980 | @end defopt |
| 6981 | 6981 | ||
| 6982 | @defopt c-echo-syntactic-information-p | 6982 | @defopt c-echo-syntactic-information-p |
| 6983 | @vindex echo-syntactic-information-p (c-) | 6983 | @vindex echo-syntactic-information-p @r{(c-)} |
| 6984 | If non-@code{nil}, the syntactic analysis for the current line is shown | 6984 | If non-@code{nil}, the syntactic analysis for the current line is shown |
| 6985 | in the echo area when it's indented (unless | 6985 | in the echo area when it's indented (unless |
| 6986 | @code{c-syntactic-indentation} is @code{nil}). That's useful when | 6986 | @code{c-syntactic-indentation} is @code{nil}). That's useful when |
| @@ -6989,7 +6989,7 @@ want. | |||
| 6989 | @end defopt | 6989 | @end defopt |
| 6990 | 6990 | ||
| 6991 | @defopt c-report-syntactic-errors | 6991 | @defopt c-report-syntactic-errors |
| 6992 | @vindex report-syntactic-errors (c-) | 6992 | @vindex report-syntactic-errors @r{(c-)} |
| 6993 | If non-@code{nil}, certain syntactic errors are reported with a ding and | 6993 | If non-@code{nil}, certain syntactic errors are reported with a ding and |
| 6994 | a message, for example when an @code{else} is indented for which there | 6994 | a message, for example when an @code{else} is indented for which there |
| 6995 | is no corresponding @code{if}. | 6995 | is no corresponding @code{if}. |
| @@ -7106,7 +7106,7 @@ except perhaps when you've just moved a long way inside the file. | |||
| 7106 | 7106 | ||
| 7107 | @findex defun-prompt-regexp | 7107 | @findex defun-prompt-regexp |
| 7108 | @vindex c-Java-defun-prompt-regexp | 7108 | @vindex c-Java-defun-prompt-regexp |
| 7109 | @vindex Java-defun-prompt-regexp (c-) | 7109 | @vindex Java-defun-prompt-regexp @r{(c-)} |
| 7110 | A special note about @code{defun-prompt-regexp} in Java mode: The common | 7110 | A special note about @code{defun-prompt-regexp} in Java mode: The common |
| 7111 | style is to hang the opening braces of functions and classes on the | 7111 | style is to hang the opening braces of functions and classes on the |
| 7112 | right side of the line, and that doesn't work well with the Emacs | 7112 | right side of the line, and that doesn't work well with the Emacs |
| @@ -7132,7 +7132,7 @@ typically gives good performance even when the code doesn't fit the | |||
| 7132 | Emacs approach to finding the defun starts. | 7132 | Emacs approach to finding the defun starts. |
| 7133 | 7133 | ||
| 7134 | @vindex c-enable-xemacs-performance-kludge-p | 7134 | @vindex c-enable-xemacs-performance-kludge-p |
| 7135 | @vindex enable-xemacs-performance-kludge-p (c-) | 7135 | @vindex enable-xemacs-performance-kludge-p @r{(c-)} |
| 7136 | XEmacs users can set the variable | 7136 | XEmacs users can set the variable |
| 7137 | @code{c-enable-xemacs-performance-kludge-p} to non-@code{nil}. This | 7137 | @code{c-enable-xemacs-performance-kludge-p} to non-@code{nil}. This |
| 7138 | tells @ccmode{} to use XEmacs-specific built-in functions which, in some | 7138 | tells @ccmode{} to use XEmacs-specific built-in functions which, in some |
| @@ -7390,7 +7390,7 @@ compatibility, etc.@: are all available on the web site: | |||
| 7390 | 7390 | ||
| 7391 | @kindex C-c C-b | 7391 | @kindex C-c C-b |
| 7392 | @findex c-submit-bug-report | 7392 | @findex c-submit-bug-report |
| 7393 | @findex submit-bug-report (c-) | 7393 | @findex submit-bug-report @r{(c-)} |
| 7394 | To report bugs, use the @kbd{C-c C-b} (bound to | 7394 | To report bugs, use the @kbd{C-c C-b} (bound to |
| 7395 | @code{c-submit-bug-report}) command. This provides vital information | 7395 | @code{c-submit-bug-report}) command. This provides vital information |
| 7396 | we need to reproduce your problem. Make sure you include a concise, | 7396 | we need to reproduce your problem. Make sure you include a concise, |
diff --git a/doc/misc/dired-x.texi b/doc/misc/dired-x.texi index 8c613080c3f..130c06b40e8 100644 --- a/doc/misc/dired-x.texi +++ b/doc/misc/dired-x.texi | |||
| @@ -640,7 +640,7 @@ A non-@code{nil} value means that @samp{-q} is passed to @code{gzip} | |||
| 640 | overriding a verbose option in the @env{GZIP} environment variable. | 640 | overriding a verbose option in the @env{GZIP} environment variable. |
| 641 | 641 | ||
| 642 | @item dired-guess-shell-znew-switches nil | 642 | @item dired-guess-shell-znew-switches nil |
| 643 | @vindex dired-guess-shell-znew-switches nil | 643 | @vindex dired-guess-shell-znew-switches |
| 644 | @cindex @code{znew} | 644 | @cindex @code{znew} |
| 645 | Default: @code{nil} | 645 | Default: @code{nil} |
| 646 | 646 | ||
| @@ -649,7 +649,7 @@ A string of switches passed to @code{znew}. An example is | |||
| 649 | smaller than the @file{.gz} file. | 649 | smaller than the @file{.gz} file. |
| 650 | 650 | ||
| 651 | @item dired-shell-command-history nil | 651 | @item dired-shell-command-history nil |
| 652 | @vindex dired-shell-command-history nil | 652 | @vindex dired-shell-command-history |
| 653 | 653 | ||
| 654 | History list for commands that read dired-shell commands. | 654 | History list for commands that read dired-shell commands. |
| 655 | @end table | 655 | @end table |
diff --git a/doc/misc/ediff.texi b/doc/misc/ediff.texi index 3547af3e4f5..e488fc07f8e 100644 --- a/doc/misc/ediff.texi +++ b/doc/misc/ediff.texi | |||
| @@ -345,7 +345,7 @@ file name will be appended to that directory. In addition, if the variable | |||
| 345 | @code{ediff-use-last-dir} is not @code{nil}, Ediff will offer | 345 | @code{ediff-use-last-dir} is not @code{nil}, Ediff will offer |
| 346 | previously entered directories as defaults (which will be maintained | 346 | previously entered directories as defaults (which will be maintained |
| 347 | separately for each type of file, A, B, or C). | 347 | separately for each type of file, A, B, or C). |
| 348 | @vindex @code{ediff-use-last-dir} | 348 | @vindex ediff-use-last-dir |
| 349 | 349 | ||
| 350 | All the above functions use the POSIX @code{diff} or @code{diff3} programs | 350 | All the above functions use the POSIX @code{diff} or @code{diff3} programs |
| 351 | to find differences between two files. They process the @code{diff} output | 351 | to find differences between two files. They process the @code{diff} output |
| @@ -1924,7 +1924,7 @@ versions only permit @option{-b}, which (usually) assumes the | |||
| 1924 | extension @file{.orig}. Yet others force you to use | 1924 | extension @file{.orig}. Yet others force you to use |
| 1925 | @option{-z@var{extension}}. | 1925 | @option{-z@var{extension}}. |
| 1926 | 1926 | ||
| 1927 | Both @code{ediff-backup-extension} and @var{ediff-backup-specs} must | 1927 | Both @code{ediff-backup-extension} and @code{ediff-backup-specs} must |
| 1928 | be properly set. If your patch program takes the option @option{-b}, | 1928 | be properly set. If your patch program takes the option @option{-b}, |
| 1929 | but not @option{-b @var{extension}}, the variable | 1929 | but not @option{-b @var{extension}}, the variable |
| 1930 | @code{ediff-backup-extension} must still be set so Ediff will know | 1930 | @code{ediff-backup-extension} must still be set so Ediff will know |
| @@ -2304,7 +2304,7 @@ version control, Ediff first tries to check the file out. | |||
| 2304 | If @code{t}, all variant buffers are made read-only at Ediff startup. | 2304 | If @code{t}, all variant buffers are made read-only at Ediff startup. |
| 2305 | 2305 | ||
| 2306 | @item ediff-keep-variants | 2306 | @item ediff-keep-variants |
| 2307 | @vindex @code{ediff-keep-variants} | 2307 | @vindex ediff-keep-variants |
| 2308 | The default is @code{t}, meaning that the buffers being compared or merged will | 2308 | The default is @code{t}, meaning that the buffers being compared or merged will |
| 2309 | be preserved when Ediff quits. Setting this to @code{nil} causes Ediff to | 2309 | be preserved when Ediff quits. Setting this to @code{nil} causes Ediff to |
| 2310 | offer the user a chance to delete these buffers (if they are not modified). | 2310 | offer the user a chance to delete these buffers (if they are not modified). |
| @@ -2323,14 +2323,14 @@ Using @code{ediff-cleanup-hook}, one can make Ediff delete the variants | |||
| 2323 | unconditionally (e.g., by making @code{ediff-janitor} into one of these hooks). | 2323 | unconditionally (e.g., by making @code{ediff-janitor} into one of these hooks). |
| 2324 | 2324 | ||
| 2325 | @item ediff-keep-tmp-versions | 2325 | @item ediff-keep-tmp-versions |
| 2326 | @vindex @code{ediff-keep-tmp-versions} | 2326 | @vindex ediff-keep-tmp-versions |
| 2327 | Default is @code{nil}. If @code{t}, the versions of the files being | 2327 | Default is @code{nil}. If @code{t}, the versions of the files being |
| 2328 | compared or merged using operations such as @code{ediff-revision} or | 2328 | compared or merged using operations such as @code{ediff-revision} or |
| 2329 | @code{ediff-merge-revisions} are not deleted on exit. The normal action is | 2329 | @code{ediff-merge-revisions} are not deleted on exit. The normal action is |
| 2330 | to clean up and delete these version files. | 2330 | to clean up and delete these version files. |
| 2331 | 2331 | ||
| 2332 | @item ediff-grab-mouse | 2332 | @item ediff-grab-mouse |
| 2333 | @vindex @code{ediff-grab-mouse} | 2333 | @vindex ediff-grab-mouse |
| 2334 | Default is @code{t}. Normally, Ediff grabs mouse and puts it in its | 2334 | Default is @code{t}. Normally, Ediff grabs mouse and puts it in its |
| 2335 | control frame. This is useful since the user can be sure that when he | 2335 | control frame. This is useful since the user can be sure that when he |
| 2336 | needs to type an Ediff command the focus will be in an appropriate Ediff's | 2336 | needs to type an Ediff command the focus will be in an appropriate Ediff's |
diff --git a/doc/misc/gnus-faq.texi b/doc/misc/gnus-faq.texi index 26135b81de7..4175c88754e 100644 --- a/doc/misc/gnus-faq.texi +++ b/doc/misc/gnus-faq.texi | |||
| @@ -915,7 +915,7 @@ You want Scoring. Scoring means, that you define rules | |||
| 915 | which assign each message an integer value. Depending on | 915 | which assign each message an integer value. Depending on |
| 916 | the value the message is highlighted in summary buffer (if | 916 | the value the message is highlighted in summary buffer (if |
| 917 | it's high, say +2000) or automatically marked read (if the | 917 | it's high, say +2000) or automatically marked read (if the |
| 918 | value is low, say -800) or some other action happens. | 918 | value is low, say @minus{}800) or some other action happens. |
| 919 | 919 | ||
| 920 | There are basically three ways of setting up rules which assign | 920 | There are basically three ways of setting up rules which assign |
| 921 | the scoring-value to messages. The first and easiest way is to set | 921 | the scoring-value to messages. The first and easiest way is to set |
diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi index da455f3a9dd..17fbe0e3e39 100644 --- a/doc/misc/gnus.texi +++ b/doc/misc/gnus.texi | |||
| @@ -20281,13 +20281,13 @@ will be applied to each article. | |||
| 20281 | 20281 | ||
| 20282 | To take @code{gnus-del-mark} as an example---this alist says that all | 20282 | To take @code{gnus-del-mark} as an example---this alist says that all |
| 20283 | articles that have that mark (i.e., are marked with @samp{e}) will have a | 20283 | articles that have that mark (i.e., are marked with @samp{e}) will have a |
| 20284 | score entry added to lower based on the @code{From} header by -4, and | 20284 | score entry added to lower based on the @code{From} header by @minus{}4, and |
| 20285 | lowered by @code{Subject} by -1. Change this to fit your prejudices. | 20285 | lowered by @code{Subject} by @minus{}1. Change this to fit your prejudices. |
| 20286 | 20286 | ||
| 20287 | If you have marked 10 articles with the same subject with | 20287 | If you have marked 10 articles with the same subject with |
| 20288 | @code{gnus-del-mark}, the rule for that mark will be applied ten times. | 20288 | @code{gnus-del-mark}, the rule for that mark will be applied ten times. |
| 20289 | That means that that subject will get a score of ten times -1, which | 20289 | That means that that subject will get a score of ten times @minus{}1, which |
| 20290 | should be, unless I'm much mistaken, -10. | 20290 | should be, unless I'm much mistaken, @minus{}10. |
| 20291 | 20291 | ||
| 20292 | If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all | 20292 | If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all |
| 20293 | the read articles will be marked with the @samp{E} mark. This'll | 20293 | the read articles will be marked with the @samp{E} mark. This'll |
| @@ -20302,7 +20302,7 @@ on the @code{References} header using the @code{Message-ID} of the | |||
| 20302 | current article, thereby matching the following thread. | 20302 | current article, thereby matching the following thread. |
| 20303 | 20303 | ||
| 20304 | If you use this scheme, you should set the score file atom @code{mark} | 20304 | If you use this scheme, you should set the score file atom @code{mark} |
| 20305 | to something small---like -300, perhaps, to avoid having small random | 20305 | to something small---like @minus{}300, perhaps, to avoid having small random |
| 20306 | changes result in articles getting marked as read. | 20306 | changes result in articles getting marked as read. |
| 20307 | 20307 | ||
| 20308 | After using adaptive scoring for a week or so, Gnus should start to | 20308 | After using adaptive scoring for a week or so, Gnus should start to |
| @@ -21078,7 +21078,7 @@ and `gnus-score-decay-scale'." | |||
| 21078 | 21078 | ||
| 21079 | @enumerate | 21079 | @enumerate |
| 21080 | @item | 21080 | @item |
| 21081 | Scores between -3 and 3 will be set to 0 when this function is called. | 21081 | Scores between @minus{}3 and 3 will be set to 0 when this function is called. |
| 21082 | 21082 | ||
| 21083 | @item | 21083 | @item |
| 21084 | Scores with magnitudes between 3 and 60 will be shrunk by 3. | 21084 | Scores with magnitudes between 3 and 60 will be shrunk by 3. |
diff --git a/doc/misc/mh-e.texi b/doc/misc/mh-e.texi index 29caefd9f07..5f0cc32cc48 100644 --- a/doc/misc/mh-e.texi +++ b/doc/misc/mh-e.texi | |||
| @@ -1163,7 +1163,7 @@ your initials. (Unless, of course, your initials happen to be @emph{mh}!) | |||
| 1163 | @cindex customizing MH-E | 1163 | @cindex customizing MH-E |
| 1164 | @cindex setting options | 1164 | @cindex setting options |
| 1165 | @findex customize-option | 1165 | @findex customize-option |
| 1166 | @vindex mh-lpr-command-format, example | 1166 | @vindex mh-lpr-command-format@r{, example} |
| 1167 | 1167 | ||
| 1168 | Many string or integer options are easy to modify using @kbd{M-x | 1168 | Many string or integer options are easy to modify using @kbd{M-x |
| 1169 | customize-option}. For example, to modify the option that controls | 1169 | customize-option}. For example, to modify the option that controls |
| @@ -1181,7 +1181,7 @@ Sessions}. To read more about @code{mh-lpr-command-format}, see | |||
| 1181 | @cindex option, turning on and off | 1181 | @cindex option, turning on and off |
| 1182 | @cindex t | 1182 | @cindex t |
| 1183 | @findex customize-option | 1183 | @findex customize-option |
| 1184 | @vindex mh-bury-show-buffer-flag, example | 1184 | @vindex mh-bury-show-buffer-flag@r{, example} |
| 1185 | 1185 | ||
| 1186 | Options can also hold boolean values. In Emacs Lisp, the boolean | 1186 | Options can also hold boolean values. In Emacs Lisp, the boolean |
| 1187 | values are @code{nil}, which means false, and @code{t}, which means | 1187 | values are @code{nil}, which means false, and @code{t}, which means |
| @@ -1196,7 +1196,7 @@ the @samp{Erase Customization} menu item to reset the option to the | |||
| 1196 | default, which places the MH-Show buffer at the bottom of the buffer | 1196 | default, which places the MH-Show buffer at the bottom of the buffer |
| 1197 | stack. | 1197 | stack. |
| 1198 | 1198 | ||
| 1199 | @vindex mh-mhl-format-file, example | 1199 | @vindex mh-mhl-format-file@r{, example} |
| 1200 | 1200 | ||
| 1201 | The text usually says to turn on an option by setting it to a | 1201 | The text usually says to turn on an option by setting it to a |
| 1202 | @emph{non-@code{nil}} value, because sometimes values other than | 1202 | @emph{non-@code{nil}} value, because sometimes values other than |
| @@ -1520,9 +1520,9 @@ after running @kbd{M-x mh-rmail} the first time or when you've changed | |||
| 1520 | the message numbers from outside of MH-E. | 1520 | the message numbers from outside of MH-E. |
| 1521 | 1521 | ||
| 1522 | @findex mh-execute-commands | 1522 | @findex mh-execute-commands |
| 1523 | @findex mh-rescan-folder, example | 1523 | @findex mh-rescan-folder@r{, example} |
| 1524 | @findex mh-show, example | 1524 | @findex mh-show@r{, example} |
| 1525 | @vindex mh-inc-folder-hook, example | 1525 | @vindex mh-inc-folder-hook@r{, example} |
| 1526 | 1526 | ||
| 1527 | @smalllisp | 1527 | @smalllisp |
| 1528 | @group | 1528 | @group |
| @@ -3175,7 +3175,7 @@ code to @file{~/.emacs}. | |||
| 3175 | @filbreak | 3175 | @filbreak |
| 3176 | @end iftex | 3176 | @end iftex |
| 3177 | 3177 | ||
| 3178 | @findex mh-rmail, example | 3178 | @findex mh-rmail@r{, example} |
| 3179 | 3179 | ||
| 3180 | @smalllisp | 3180 | @smalllisp |
| 3181 | @group | 3181 | @group |
| @@ -3490,7 +3490,7 @@ The hook @code{mh-folder-mode-hook} is called when visiting a new | |||
| 3490 | folder in MH-Folder mode. This could be used to set your own key | 3490 | folder in MH-Folder mode. This could be used to set your own key |
| 3491 | bindings, for example: | 3491 | bindings, for example: |
| 3492 | 3492 | ||
| 3493 | @vindex mh-folder-mode-hook, example | 3493 | @vindex mh-folder-mode-hook@r{, example} |
| 3494 | 3494 | ||
| 3495 | @smalllisp | 3495 | @smalllisp |
| 3496 | @group | 3496 | @group |
| @@ -3810,9 +3810,9 @@ again. | |||
| 3810 | @findex mh-execute-commands | 3810 | @findex mh-execute-commands |
| 3811 | @kindex q | 3811 | @kindex q |
| 3812 | @vindex mh-before-quit-hook | 3812 | @vindex mh-before-quit-hook |
| 3813 | @vindex mh-before-quit-hook, example | 3813 | @vindex mh-before-quit-hook@r{, example} |
| 3814 | @vindex mh-quit-hook | 3814 | @vindex mh-quit-hook |
| 3815 | @vindex mh-quit-hook, example | 3815 | @vindex mh-quit-hook@r{, example} |
| 3816 | 3816 | ||
| 3817 | The two hooks @code{mh-before-quit-hook} and @code{mh-quit-hook} are | 3817 | The two hooks @code{mh-before-quit-hook} and @code{mh-quit-hook} are |
| 3818 | called by @kbd{q}. The former one is called before the quit occurs, so | 3818 | called by @kbd{q}. The former one is called before the quit occurs, so |
| @@ -4099,7 +4099,7 @@ may have a complicated @file{components} file and need to tell MH-E | |||
| 4099 | where the cursor should go. Here's an example of how you would use | 4099 | where the cursor should go. Here's an example of how you would use |
| 4100 | this hook. | 4100 | this hook. |
| 4101 | 4101 | ||
| 4102 | @findex mh-insert-signature, example | 4102 | @findex mh-insert-signature@r{, example} |
| 4103 | 4103 | ||
| 4104 | @smalllisp | 4104 | @smalllisp |
| 4105 | @group | 4105 | @group |
| @@ -8478,7 +8478,7 @@ message according to MH; it also uses that column for notations. | |||
| 8478 | 8478 | ||
| 8479 | @vindex mh-adaptive-cmd-note-flag | 8479 | @vindex mh-adaptive-cmd-note-flag |
| 8480 | @vindex mh-scan-format-file | 8480 | @vindex mh-scan-format-file |
| 8481 | @vindex mh-scan-format-file, example | 8481 | @vindex mh-scan-format-file@r{, example} |
| 8482 | 8482 | ||
| 8483 | The first thing you have to do is tell MH-E to use this file. | 8483 | The first thing you have to do is tell MH-E to use this file. |
| 8484 | Customize @code{mh-scan-format-file} and set its value to @samp{Use | 8484 | Customize @code{mh-scan-format-file} and set its value to @samp{Use |
| @@ -8488,7 +8488,7 @@ Default scan Format}. If you didn't get already turn off | |||
| 8488 | Next, tell MH-E what a valid scan line looks like so that you can at | 8488 | Next, tell MH-E what a valid scan line looks like so that you can at |
| 8489 | least display the output of scan in your MH-Folder buffer. | 8489 | least display the output of scan in your MH-Folder buffer. |
| 8490 | 8490 | ||
| 8491 | @vindex mh-scan-valid-regexp, example | 8491 | @vindex mh-scan-valid-regexp@r{, example} |
| 8492 | 8492 | ||
| 8493 | @smalllisp | 8493 | @smalllisp |
| 8494 | (setq mh-scan-valid-regexp "[0-9]+[+D^ ]$") | 8494 | (setq mh-scan-valid-regexp "[0-9]+[+D^ ]$") |
| @@ -8499,8 +8499,8 @@ message, you need to tell MH-E how to access the message number. You | |||
| 8499 | should also see why MH-E requires that you include a message number in | 8499 | should also see why MH-E requires that you include a message number in |
| 8500 | the first place. | 8500 | the first place. |
| 8501 | 8501 | ||
| 8502 | @vindex mh-scan-msg-number-regexp, example | 8502 | @vindex mh-scan-msg-number-regexp@r{, example} |
| 8503 | @vindex mh-scan-msg-search-regexp, example | 8503 | @vindex mh-scan-msg-search-regexp@r{, example} |
| 8504 | 8504 | ||
| 8505 | @smalllisp | 8505 | @smalllisp |
| 8506 | (setq mh-scan-msg-number-regexp "^.* \\([0-9]+\\)[+D^ ]$") | 8506 | (setq mh-scan-msg-number-regexp "^.* \\([0-9]+\\)[+D^ ]$") |
| @@ -8509,7 +8509,7 @@ the first place. | |||
| 8509 | 8509 | ||
| 8510 | In order to get the next and previous commands working, add this. | 8510 | In order to get the next and previous commands working, add this. |
| 8511 | 8511 | ||
| 8512 | @vindex mh-scan-good-msg-regexp, example | 8512 | @vindex mh-scan-good-msg-regexp@r{, example} |
| 8513 | 8513 | ||
| 8514 | @smalllisp | 8514 | @smalllisp |
| 8515 | (setq mh-scan-good-msg-regexp "^.* \\([0-9]+\\)[+D^ ]$") | 8515 | (setq mh-scan-good-msg-regexp "^.* \\([0-9]+\\)[+D^ ]$") |
| @@ -8519,8 +8519,8 @@ Note that the current message isn't marked with a @samp{+} when moving | |||
| 8519 | between the next and previous messages. Here is the code required to | 8519 | between the next and previous messages. Here is the code required to |
| 8520 | get this working. | 8520 | get this working. |
| 8521 | 8521 | ||
| 8522 | @vindex set-mh-cmd-note, example | 8522 | @vindex set-mh-cmd-note@r{, example} |
| 8523 | @vindex mh-scan-cur-msg-number-regexp, example | 8523 | @vindex mh-scan-cur-msg-number-regexp@r{, example} |
| 8524 | 8524 | ||
| 8525 | @smalllisp | 8525 | @smalllisp |
| 8526 | (set-mh-cmd-note 76) | 8526 | (set-mh-cmd-note 76) |
| @@ -8529,8 +8529,8 @@ get this working. | |||
| 8529 | 8529 | ||
| 8530 | Finally, add the following to delete and refile messages. | 8530 | Finally, add the following to delete and refile messages. |
| 8531 | 8531 | ||
| 8532 | @vindex mh-scan-deleted-msg-regexp, example | 8532 | @vindex mh-scan-deleted-msg-regexp@r{, example} |
| 8533 | @vindex mh-scan-refiled-msg-regexp, example | 8533 | @vindex mh-scan-refiled-msg-regexp@r{, example} |
| 8534 | 8534 | ||
| 8535 | @smalllisp | 8535 | @smalllisp |
| 8536 | (setq mh-scan-deleted-msg-regexp "^.* \\([0-9]+\\)D$") | 8536 | (setq mh-scan-deleted-msg-regexp "^.* \\([0-9]+\\)D$") |
diff --git a/doc/misc/pcl-cvs.texi b/doc/misc/pcl-cvs.texi index d0427eb5aa5..1163530e7a2 100644 --- a/doc/misc/pcl-cvs.texi +++ b/doc/misc/pcl-cvs.texi | |||
| @@ -1331,13 +1331,13 @@ default. | |||
| 1331 | 1331 | ||
| 1332 | @node Customizing Faces | 1332 | @node Customizing Faces |
| 1333 | @section Customizing Faces | 1333 | @section Customizing Faces |
| 1334 | @vindex cvs-header (face) | 1334 | @vindex cvs-header @r{(face)} |
| 1335 | @vindex cvs-filename (face) | 1335 | @vindex cvs-filename @r{(face)} |
| 1336 | @vindex cvs-unknown (face) | 1336 | @vindex cvs-unknown @r{(face)} |
| 1337 | @vindex cvs-handled (face) | 1337 | @vindex cvs-handled @r{(face)} |
| 1338 | @vindex cvs-need-action (face) | 1338 | @vindex cvs-need-action @r{(face)} |
| 1339 | @vindex cvs-marked (face) | 1339 | @vindex cvs-marked @r{(face)} |
| 1340 | @vindex cvs-msg (face) | 1340 | @vindex cvs-msg @r{(face)} |
| 1341 | 1341 | ||
| 1342 | PCL-CVS adds a few extra features, including menus, mouse bindings, and | 1342 | PCL-CVS adds a few extra features, including menus, mouse bindings, and |
| 1343 | fontification of the @file{*cvs*} buffer. The faces defined for | 1343 | fontification of the @file{*cvs*} buffer. The faces defined for |
diff --git a/doc/misc/reftex.texi b/doc/misc/reftex.texi index 86329652ee0..55060d09b8c 100644 --- a/doc/misc/reftex.texi +++ b/doc/misc/reftex.texi | |||
| @@ -1732,8 +1732,8 @@ seems inconvenient to you.@footnote{You could, e.g., bind | |||
| 1732 | @cindex LaTeX packages, @code{varioref} | 1732 | @cindex LaTeX packages, @code{varioref} |
| 1733 | @cindex @code{fancyref}, LaTeX package | 1733 | @cindex @code{fancyref}, LaTeX package |
| 1734 | @cindex LaTeX packages, @code{fancyref} | 1734 | @cindex LaTeX packages, @code{fancyref} |
| 1735 | @vindex reftex-vref-is-default (deprecated) | 1735 | @vindex reftex-vref-is-default @r{(deprecated)} |
| 1736 | @vindex reftex-fref-is-default (deprecated) | 1736 | @vindex reftex-fref-is-default @r{(deprecated)} |
| 1737 | In former versions of @RefTeX{} only support for @code{varioref} and | 1737 | In former versions of @RefTeX{} only support for @code{varioref} and |
| 1738 | @code{fancyref} was included. @code{varioref} is a @LaTeX{} package to | 1738 | @code{fancyref} was included. @code{varioref} is a @LaTeX{} package to |
| 1739 | create cross-references with page information. @code{fancyref} is a | 1739 | create cross-references with page information. @code{fancyref} is a |
| @@ -3295,11 +3295,11 @@ The following list describes the individual parts of the interface. | |||
| 3295 | @itemize @bullet | 3295 | @itemize @bullet |
| 3296 | @item | 3296 | @item |
| 3297 | @findex reftex-label | 3297 | @findex reftex-label |
| 3298 | @vindex LaTeX-label-function, @r{AUCTeX} | 3298 | @vindex LaTeX-label-function@r{, AUCTeX} |
| 3299 | @kindex C-c C-e | 3299 | @kindex C-c C-e |
| 3300 | @kindex C-c C-s | 3300 | @kindex C-c C-s |
| 3301 | @findex LaTeX-section, @r{AUCTeX} | 3301 | @findex LaTeX-section@r{, AUCTeX} |
| 3302 | @findex TeX-insert-macro, @r{AUCTeX} | 3302 | @findex TeX-insert-macro@r{, AUCTeX} |
| 3303 | @b{@AUCTeX{} calls @code{reftex-label} to insert labels}@* | 3303 | @b{@AUCTeX{} calls @code{reftex-label} to insert labels}@* |
| 3304 | When a new section is created with @kbd{C-c C-s}, or a new environment | 3304 | When a new section is created with @kbd{C-c C-s}, or a new environment |
| 3305 | is inserted with @kbd{C-c C-e}, @AUCTeX{} normally prompts for a label to | 3305 | is inserted with @kbd{C-c C-e}, @AUCTeX{} normally prompts for a label to |
| @@ -3327,14 +3327,14 @@ have to rescan the buffer in order to see it. | |||
| 3327 | 3327 | ||
| 3328 | @item | 3328 | @item |
| 3329 | @findex reftex-arg-label | 3329 | @findex reftex-arg-label |
| 3330 | @findex TeX-arg-label, @r{AUCTeX function} | 3330 | @findex TeX-arg-label@r{, AUCTeX function} |
| 3331 | @findex reftex-arg-ref | 3331 | @findex reftex-arg-ref |
| 3332 | @findex TeX-arg-ref, @r{AUCTeX function} | 3332 | @findex TeX-arg-ref@r{, AUCTeX function} |
| 3333 | @findex reftex-arg-cite | 3333 | @findex reftex-arg-cite |
| 3334 | @findex TeX-arg-cite, @r{AUCTeX function} | 3334 | @findex TeX-arg-cite@r{, AUCTeX function} |
| 3335 | @findex reftex-arg-index | 3335 | @findex reftex-arg-index |
| 3336 | @findex TeX-arg-index, @r{AUCTeX function} | 3336 | @findex TeX-arg-index@r{, AUCTeX function} |
| 3337 | @findex TeX-insert-macro, @r{AUCTeX function} | 3337 | @findex TeX-insert-macro@r{, AUCTeX function} |
| 3338 | @kindex C-c @key{RET} | 3338 | @kindex C-c @key{RET} |
| 3339 | @b{@RefTeX{} supplies macro arguments}@* When you insert a macro | 3339 | @b{@RefTeX{} supplies macro arguments}@* When you insert a macro |
| 3340 | interactively with @kbd{C-c @key{RET}}, @AUCTeX{} normally prompts for | 3340 | interactively with @kbd{C-c @key{RET}}, @AUCTeX{} normally prompts for |
| @@ -3357,7 +3357,7 @@ Labels}). | |||
| 3357 | @node Style Files | 3357 | @node Style Files |
| 3358 | @subsection Style Files | 3358 | @subsection Style Files |
| 3359 | @cindex Style files, AUCTeX | 3359 | @cindex Style files, AUCTeX |
| 3360 | @findex TeX-add-style-hook, @r{AUCTeX} | 3360 | @findex TeX-add-style-hook@r{, AUCTeX} |
| 3361 | Style files are Emacs Lisp files which are evaluated by @AUCTeX{} in | 3361 | Style files are Emacs Lisp files which are evaluated by @AUCTeX{} in |
| 3362 | association with the @code{\documentclass} and @code{\usepackage} | 3362 | association with the @code{\documentclass} and @code{\usepackage} |
| 3363 | commands of a document (@pxref{Style Files,,,auctex}). Support for | 3363 | commands of a document (@pxref{Style Files,,,auctex}). Support for |
| @@ -3396,7 +3396,7 @@ style file of @AUCTeX{} for example contains the following: | |||
| 3396 | @end lisp | 3396 | @end lisp |
| 3397 | 3397 | ||
| 3398 | @noindent | 3398 | @noindent |
| 3399 | @findex LaTeX-add-environments, @r{AUCTeX} | 3399 | @findex LaTeX-add-environments@r{, AUCTeX} |
| 3400 | while a package @code{myprop} defining a @code{proposition} environment | 3400 | while a package @code{myprop} defining a @code{proposition} environment |
| 3401 | with @code{\newtheorem} might use | 3401 | with @code{\newtheorem} might use |
| 3402 | 3402 | ||
diff --git a/doc/misc/sc.texi b/doc/misc/sc.texi index f214152b5f4..03ca842cd07 100644 --- a/doc/misc/sc.texi +++ b/doc/misc/sc.texi | |||
| @@ -274,7 +274,7 @@ Notice here that my inclusion of Jane's inclusion of John's original | |||
| 274 | message did not result in a line cited with @samp{Jane>John>}. | 274 | message did not result in a line cited with @samp{Jane>John>}. |
| 275 | 275 | ||
| 276 | @vindex sc-nested-citation-p | 276 | @vindex sc-nested-citation-p |
| 277 | @vindex nested-citation-p (sc-) | 277 | @vindex nested-citation-p @r{(sc-)} |
| 278 | Supercite supports both styles of citation, and the variable | 278 | Supercite supports both styles of citation, and the variable |
| 279 | @code{sc-nested-citation-p} controls which style it will use when | 279 | @code{sc-nested-citation-p} controls which style it will use when |
| 280 | citing previously uncited text. When this variable is @code{nil} (the | 280 | citing previously uncited text. When this variable is @code{nil} (the |
| @@ -292,7 +292,7 @@ directly user definable. The elements are concatenated together, in | |||
| 292 | this order: | 292 | this order: |
| 293 | 293 | ||
| 294 | @cindex citation leader | 294 | @cindex citation leader |
| 295 | @vindex citation-leader (sc-) | 295 | @vindex citation-leader @r{(sc-)} |
| 296 | @vindex sc-citation-leader | 296 | @vindex sc-citation-leader |
| 297 | @enumerate | 297 | @enumerate |
| 298 | @item | 298 | @item |
| @@ -309,7 +309,7 @@ headers, though you may be asked to confirm Supercite's choice. | |||
| 309 | 309 | ||
| 310 | @cindex citation delimiter | 310 | @cindex citation delimiter |
| 311 | @vindex sc-citation-delimiter | 311 | @vindex sc-citation-delimiter |
| 312 | @vindex citation-delimiter (sc-) | 312 | @vindex citation-delimiter @r{(sc-)} |
| 313 | @item | 313 | @item |
| 314 | The @dfn{citation delimiter}. This string, contained in the variable | 314 | The @dfn{citation delimiter}. This string, contained in the variable |
| 315 | @code{sc-citation-delimiter} visually separates the citation from the | 315 | @code{sc-citation-delimiter} visually separates the citation from the |
| @@ -317,7 +317,7 @@ text of the line. This variable has a default value of @code{">"} and | |||
| 317 | for best results, the string should consist of only a single character. | 317 | for best results, the string should consist of only a single character. |
| 318 | 318 | ||
| 319 | @cindex citation separator | 319 | @cindex citation separator |
| 320 | @vindex citation-separator (sc-) | 320 | @vindex citation-separator @r{(sc-)} |
| 321 | @vindex sc-citation-separator | 321 | @vindex sc-citation-separator |
| 322 | @item | 322 | @item |
| 323 | The @dfn{citation separator}. The citation separator is contained in | 323 | The @dfn{citation separator}. The citation separator is contained in |
| @@ -348,15 +348,15 @@ Recognition of cited lines is controlled by variables analogous to | |||
| 348 | those that make up the citation string as mentioned previously. | 348 | those that make up the citation string as mentioned previously. |
| 349 | 349 | ||
| 350 | @vindex sc-citation-leader-regexp | 350 | @vindex sc-citation-leader-regexp |
| 351 | @vindex citation-leader-regexp (sc-) | 351 | @vindex citation-leader-regexp @r{(sc-)} |
| 352 | @vindex sc-citation-delimiter-regexp | 352 | @vindex sc-citation-delimiter-regexp |
| 353 | @vindex citation-delimiter-regexp (sc-) | 353 | @vindex citation-delimiter-regexp @r{(sc-)} |
| 354 | @vindex sc-citation-separator-regexp | 354 | @vindex sc-citation-separator-regexp |
| 355 | @vindex citation-separator-regexp (sc-) | 355 | @vindex citation-separator-regexp @r{(sc-)} |
| 356 | @vindex sc-citation-root-regexp | 356 | @vindex sc-citation-root-regexp |
| 357 | @vindex citation-root-regexp (sc-) | 357 | @vindex citation-root-regexp @r{(sc-)} |
| 358 | @vindex sc-citation-nonnested-root-regexp | 358 | @vindex sc-citation-nonnested-root-regexp |
| 359 | @vindex citation-nonnested-root-regexp (sc-) | 359 | @vindex citation-nonnested-root-regexp @r{(sc-)} |
| 360 | 360 | ||
| 361 | The variable @code{sc-citation-leader-regexp} describes how citation | 361 | The variable @code{sc-citation-leader-regexp} describes how citation |
| 362 | leaders can look, by default it matches any number of spaces or tabs. | 362 | leaders can look, by default it matches any number of spaces or tabs. |
| @@ -388,7 +388,7 @@ change @code{sc-citation-root-regexp} you should always also change | |||
| 388 | @cindex Info Alist | 388 | @cindex Info Alist |
| 389 | @cindex information extracted from mail fields | 389 | @cindex information extracted from mail fields |
| 390 | @findex sc-mail-field | 390 | @findex sc-mail-field |
| 391 | @findex mail-field (sc-) | 391 | @findex mail-field @r{(sc-)} |
| 392 | 392 | ||
| 393 | @dfn{Mail header information keys} are nuggets of information that | 393 | @dfn{Mail header information keys} are nuggets of information that |
| 394 | Supercite extracts from the various mail headers of the original | 394 | Supercite extracts from the various mail headers of the original |
| @@ -409,7 +409,7 @@ Subject:@: Better get out your asbestos suit | |||
| 409 | @end example | 409 | @end example |
| 410 | 410 | ||
| 411 | @vindex sc-mumble | 411 | @vindex sc-mumble |
| 412 | @vindex mumble (sc-) | 412 | @vindex mumble @r{(sc-)} |
| 413 | @noindent | 413 | @noindent |
| 414 | then, the following lisp constructs return: | 414 | then, the following lisp constructs return: |
| 415 | 415 | ||
| @@ -513,7 +513,7 @@ header. | |||
| 513 | 513 | ||
| 514 | @cindex header rewrite functions | 514 | @cindex header rewrite functions |
| 515 | @vindex sc-rewrite-header-list | 515 | @vindex sc-rewrite-header-list |
| 516 | @vindex rewrite-header-list (sc-) | 516 | @vindex rewrite-header-list @r{(sc-)} |
| 517 | There are a number of built-in @dfn{header rewrite functions} supplied | 517 | There are a number of built-in @dfn{header rewrite functions} supplied |
| 518 | by Supercite, but you can write your own custom header rewrite | 518 | by Supercite, but you can write your own custom header rewrite |
| 519 | functions (perhaps using the built-in ones as examples). The variable | 519 | functions (perhaps using the built-in ones as examples). The variable |
| @@ -523,7 +523,7 @@ reference header, and when displaying @dfn{electric references}. | |||
| 523 | @xref{Electric References}. | 523 | @xref{Electric References}. |
| 524 | 524 | ||
| 525 | @vindex sc-preferred-header-style | 525 | @vindex sc-preferred-header-style |
| 526 | @vindex preferred-header-style (sc-) | 526 | @vindex preferred-header-style @r{(sc-)} |
| 527 | When Supercite is initially run on a reply buffer (via | 527 | When Supercite is initially run on a reply buffer (via |
| 528 | @code{sc-cite-original}), it will automatically call one of these | 528 | @code{sc-cite-original}), it will automatically call one of these |
| 529 | functions. The one it uses is defined in the variable | 529 | functions. The one it uses is defined in the variable |
| @@ -544,7 +544,7 @@ below, @var{date} and @var{from} correspond to the values of the | |||
| 544 | @samp{Date:@:} and @samp{From:@:} mail headers respectively. | 544 | @samp{Date:@:} and @samp{From:@:} mail headers respectively. |
| 545 | 545 | ||
| 546 | @vindex sc-reference-tag-string | 546 | @vindex sc-reference-tag-string |
| 547 | @vindex reference-tag-string (sc-) | 547 | @vindex reference-tag-string @r{(sc-)} |
| 548 | Also, the string @code{">>>>>"} below is really the value of the | 548 | Also, the string @code{">>>>>"} below is really the value of the |
| 549 | variable @code{sc-reference-tag-string}. This variable is used in all | 549 | variable @code{sc-reference-tag-string}. This variable is used in all |
| 550 | built-in header rewrite functions, and you can customize its value to | 550 | built-in header rewrite functions, and you can customize its value to |
| @@ -559,7 +559,7 @@ problem either in your MUA or in Supercite's installation). | |||
| 559 | 559 | ||
| 560 | @table @code | 560 | @table @code |
| 561 | @findex sc-no-header | 561 | @findex sc-no-header |
| 562 | @findex no-header (sc-) | 562 | @findex no-header @r{(sc-)} |
| 563 | @item sc-no-header | 563 | @item sc-no-header |
| 564 | This function produces no header. It should be used instead of | 564 | This function produces no header. It should be used instead of |
| 565 | @code{nil} to produce a blank header. This header can possibly | 565 | @code{nil} to produce a blank header. This header can possibly |
| @@ -567,38 +567,38 @@ contain a blank line after the @code{mail-header-separator} line. | |||
| 567 | 567 | ||
| 568 | @item sc-no-blank-line-or-header | 568 | @item sc-no-blank-line-or-header |
| 569 | @findex sc-no-blank-line-or-header | 569 | @findex sc-no-blank-line-or-header |
| 570 | @findex no-blank-line-or-header (sc-) | 570 | @findex no-blank-line-or-header @r{(sc-)} |
| 571 | This function is similar to @code{sc-no-header} except that any blank | 571 | This function is similar to @code{sc-no-header} except that any blank |
| 572 | line after the @code{mail-header-separator} line will be removed. | 572 | line after the @code{mail-header-separator} line will be removed. |
| 573 | 573 | ||
| 574 | @item sc-header-on-said | 574 | @item sc-header-on-said |
| 575 | @findex sc-header-on-said | 575 | @findex sc-header-on-said |
| 576 | @findex header-on-said (sc-) | 576 | @findex header-on-said @r{(sc-)} |
| 577 | @code{>>>>> On @var{date}, @var{from} said:} | 577 | @code{>>>>> On @var{date}, @var{from} said:} |
| 578 | 578 | ||
| 579 | @item sc-header-inarticle-writes | 579 | @item sc-header-inarticle-writes |
| 580 | @findex sc-header-inarticle-writes | 580 | @findex sc-header-inarticle-writes |
| 581 | @findex header-inarticle-writes (sc-) | 581 | @findex header-inarticle-writes @r{(sc-)} |
| 582 | @code{>>>>> In article @var{message-id}, @var{from} writes:} | 582 | @code{>>>>> In article @var{message-id}, @var{from} writes:} |
| 583 | 583 | ||
| 584 | @item sc-header-regarding-adds | 584 | @item sc-header-regarding-adds |
| 585 | @findex sc-header-regarding-adds | 585 | @findex sc-header-regarding-adds |
| 586 | @findex header-regarding-adds (sc-) | 586 | @findex header-regarding-adds @r{(sc-)} |
| 587 | @code{>>>>> Regarding @var{subject}; @var{from} adds:} | 587 | @code{>>>>> Regarding @var{subject}; @var{from} adds:} |
| 588 | 588 | ||
| 589 | @item sc-header-attributed-writes | 589 | @item sc-header-attributed-writes |
| 590 | @findex sc-header-attributed-writes | 590 | @findex sc-header-attributed-writes |
| 591 | @findex header-attributed-writes (sc-) | 591 | @findex header-attributed-writes @r{(sc-)} |
| 592 | @code{>>>>> "@var{sc-attribution}" == @var{sc-author} <@var{sc-reply-address}> writes:} | 592 | @code{>>>>> "@var{sc-attribution}" == @var{sc-author} <@var{sc-reply-address}> writes:} |
| 593 | 593 | ||
| 594 | @item sc-header-author-writes | 594 | @item sc-header-author-writes |
| 595 | @findex sc-header-author-writes | 595 | @findex sc-header-author-writes |
| 596 | @findex header-author-writes (sc-) | 596 | @findex header-author-writes @r{(sc-)} |
| 597 | @code{>>>>> @var{sc-author} writes:} | 597 | @code{>>>>> @var{sc-author} writes:} |
| 598 | 598 | ||
| 599 | @item sc-header-verbose | 599 | @item sc-header-verbose |
| 600 | @findex sc-header-verbose | 600 | @findex sc-header-verbose |
| 601 | @findex header-verbose (sc-) | 601 | @findex header-verbose @r{(sc-)} |
| 602 | @code{>>>>> On @var{date},}@* | 602 | @code{>>>>> On @var{date},}@* |
| 603 | @code{>>>>> @var{sc-author}}@* | 603 | @code{>>>>> @var{sc-author}}@* |
| 604 | @code{>>>>> from the organization of @var{organization}}@* | 604 | @code{>>>>> from the organization of @var{organization}}@* |
| @@ -624,7 +624,7 @@ not. Supercite provides an optional @dfn{electric reference} mode | |||
| 624 | which you can drop into to give you this functionality. | 624 | which you can drop into to give you this functionality. |
| 625 | 625 | ||
| 626 | @vindex sc-electric-references-p | 626 | @vindex sc-electric-references-p |
| 627 | @vindex electric-references-p (sc-) | 627 | @vindex electric-references-p @r{(sc-)} |
| 628 | If the variable @code{sc-electric-references-p} is non-@code{nil}, | 628 | If the variable @code{sc-electric-references-p} is non-@code{nil}, |
| 629 | Supercite will bring up an electric reference mode buffer and place you | 629 | Supercite will bring up an electric reference mode buffer and place you |
| 630 | into a recursive edit. The electric reference buffer is read-only, so | 630 | into a recursive edit. The electric reference buffer is read-only, so |
| @@ -644,10 +644,10 @@ The following commands are available while in electric reference mode | |||
| 644 | @table @asis | 644 | @table @asis |
| 645 | @item @code{sc-eref-next} (@kbd{n}) | 645 | @item @code{sc-eref-next} (@kbd{n}) |
| 646 | @findex sc-eref-next | 646 | @findex sc-eref-next |
| 647 | @findex eref-next (sc-) | 647 | @findex eref-next @r{(sc-)} |
| 648 | @kindex n | 648 | @kindex n |
| 649 | @vindex sc-electric-circular-p | 649 | @vindex sc-electric-circular-p |
| 650 | @vindex electric-circular-p (sc-) | 650 | @vindex electric-circular-p @r{(sc-)} |
| 651 | Displays the next reference header in the electric reference buffer. If | 651 | Displays the next reference header in the electric reference buffer. If |
| 652 | the variable @code{sc-electric-circular-p} is non-@code{nil}, invoking | 652 | the variable @code{sc-electric-circular-p} is non-@code{nil}, invoking |
| 653 | @code{sc-eref-next} while viewing the last reference header in the list | 653 | @code{sc-eref-next} while viewing the last reference header in the list |
| @@ -655,7 +655,7 @@ will wrap around to the first header. | |||
| 655 | 655 | ||
| 656 | @item @code{sc-eref-prev} (@kbd{p}) | 656 | @item @code{sc-eref-prev} (@kbd{p}) |
| 657 | @findex sc-eref-prev | 657 | @findex sc-eref-prev |
| 658 | @findex eref-prev (sc-) | 658 | @findex eref-prev @r{(sc-)} |
| 659 | @kindex p | 659 | @kindex p |
| 660 | Displays the previous reference header in the electric reference buffer. | 660 | Displays the previous reference header in the electric reference buffer. |
| 661 | If the variable @code{sc-electric-circular-p} is non-@code{nil}, | 661 | If the variable @code{sc-electric-circular-p} is non-@code{nil}, |
| @@ -663,7 +663,7 @@ invoking @code{sc-eref-prev} will wrap around to the last header. | |||
| 663 | 663 | ||
| 664 | @item @code{sc-eref-goto} (@kbd{g}) | 664 | @item @code{sc-eref-goto} (@kbd{g}) |
| 665 | @findex sc-eref-goto | 665 | @findex sc-eref-goto |
| 666 | @findex eref-goto (sc-) | 666 | @findex eref-goto @r{(sc-)} |
| 667 | @kindex g | 667 | @kindex g |
| 668 | Goes to a specified reference header. The index (into the | 668 | Goes to a specified reference header. The index (into the |
| 669 | @code{sc-rewrite-header-list}) can be specified as a numeric argument to | 669 | @code{sc-rewrite-header-list}) can be specified as a numeric argument to |
| @@ -672,14 +672,14 @@ minibuffer. | |||
| 672 | 672 | ||
| 673 | @item @code{sc-eref-jump} (@kbd{j}) | 673 | @item @code{sc-eref-jump} (@kbd{j}) |
| 674 | @findex sc-eref-jump | 674 | @findex sc-eref-jump |
| 675 | @findex eref-jump (sc-) | 675 | @findex eref-jump @r{(sc-)} |
| 676 | @kindex j | 676 | @kindex j |
| 677 | Display the preferred reference header, i.e., the one indexed by the current | 677 | Display the preferred reference header, i.e., the one indexed by the current |
| 678 | value of @code{sc-preferred-header-style}. | 678 | value of @code{sc-preferred-header-style}. |
| 679 | 679 | ||
| 680 | @item @code{sc-eref-setn} (@kbd{s}) | 680 | @item @code{sc-eref-setn} (@kbd{s}) |
| 681 | @findex sc-eref-setn | 681 | @findex sc-eref-setn |
| 682 | @findex eref-setn (sc-) | 682 | @findex eref-setn @r{(sc-)} |
| 683 | @kindex s | 683 | @kindex s |
| 684 | Set the preferred reference header (i.e., | 684 | Set the preferred reference header (i.e., |
| 685 | @code{sc-preferred-header-style}) to the currently displayed header. | 685 | @code{sc-preferred-header-style}) to the currently displayed header. |
| @@ -689,19 +689,19 @@ Set the preferred reference header (i.e., | |||
| 689 | @kindex C-j | 689 | @kindex C-j |
| 690 | @kindex q | 690 | @kindex q |
| 691 | @findex sc-eref-exit | 691 | @findex sc-eref-exit |
| 692 | @findex eref-exit (sc-) | 692 | @findex eref-exit @r{(sc-)} |
| 693 | Exit from electric reference mode and insert the current header into the | 693 | Exit from electric reference mode and insert the current header into the |
| 694 | reply buffer. | 694 | reply buffer. |
| 695 | 695 | ||
| 696 | @item @code{sc-eref-abort} (@kbd{q}, @kbd{x}) | 696 | @item @code{sc-eref-abort} (@kbd{q}, @kbd{x}) |
| 697 | @findex sc-eref-abort | 697 | @findex sc-eref-abort |
| 698 | @findex eref-abort (sc-) | 698 | @findex eref-abort @r{(sc-)} |
| 699 | @kindex x | 699 | @kindex x |
| 700 | Exit from electric reference mode without inserting the current header. | 700 | Exit from electric reference mode without inserting the current header. |
| 701 | @end table | 701 | @end table |
| 702 | 702 | ||
| 703 | @vindex sc-electric-mode-hook | 703 | @vindex sc-electric-mode-hook |
| 704 | @vindex electric-mode-hook (sc-) | 704 | @vindex electric-mode-hook @r{(sc-)} |
| 705 | @noindent | 705 | @noindent |
| 706 | Supercite will execute the hook @code{sc-electric-mode-hook} before | 706 | Supercite will execute the hook @code{sc-electric-mode-hook} before |
| 707 | entering electric reference mode. | 707 | entering electric reference mode. |
| @@ -747,7 +747,7 @@ interface specifications, or if you are writing or maintaining an MUA, | |||
| 747 | @cindex autoload | 747 | @cindex autoload |
| 748 | @cindex .emacs file | 748 | @cindex .emacs file |
| 749 | @findex sc-cite-original | 749 | @findex sc-cite-original |
| 750 | @findex cite-original (sc-) | 750 | @findex cite-original @r{(sc-)} |
| 751 | The first thing that everyone should do, regardless of the MUA you are | 751 | The first thing that everyone should do, regardless of the MUA you are |
| 752 | using is to set up Emacs so it will load Supercite at the appropriate | 752 | using is to set up Emacs so it will load Supercite at the appropriate |
| 753 | time. This happens automatically if Supercite is distributed with your | 753 | time. This happens automatically if Supercite is distributed with your |
| @@ -789,7 +789,7 @@ message from an MUA. | |||
| 789 | @node Reply Buffer Initialization | 789 | @node Reply Buffer Initialization |
| 790 | @section Reply Buffer Initialization | 790 | @section Reply Buffer Initialization |
| 791 | @findex sc-cite-original | 791 | @findex sc-cite-original |
| 792 | @findex cite-original (sc-) | 792 | @findex cite-original @r{(sc-)} |
| 793 | 793 | ||
| 794 | Executing @code{sc-cite-original} performs the following steps as it | 794 | Executing @code{sc-cite-original} performs the following steps as it |
| 795 | initializes the reply buffer: | 795 | initializes the reply buffer: |
| @@ -797,7 +797,7 @@ initializes the reply buffer: | |||
| 797 | @enumerate | 797 | @enumerate |
| 798 | @item | 798 | @item |
| 799 | @vindex sc-pre-hook | 799 | @vindex sc-pre-hook |
| 800 | @vindex pre-hook (sc-) | 800 | @vindex pre-hook @r{(sc-)} |
| 801 | @emph{Runs @code{sc-pre-hook}.} | 801 | @emph{Runs @code{sc-pre-hook}.} |
| 802 | This hook variable is run before @code{sc-cite-original} does any other | 802 | This hook variable is run before @code{sc-cite-original} does any other |
| 803 | work. You could conceivably use this hook to set certain Supercite | 803 | work. You could conceivably use this hook to set certain Supercite |
| @@ -808,7 +808,7 @@ an article). | |||
| 808 | @item | 808 | @item |
| 809 | @emph{Inserts Supercite's keymap.} | 809 | @emph{Inserts Supercite's keymap.} |
| 810 | @vindex sc-mode-map-prefix | 810 | @vindex sc-mode-map-prefix |
| 811 | @vindex mode-map-prefix (sc-) | 811 | @vindex mode-map-prefix @r{(sc-)} |
| 812 | @kindex C-c C-p | 812 | @kindex C-c C-p |
| 813 | @cindex keymap prefix | 813 | @cindex keymap prefix |
| 814 | Supercite provides a number of commands for performing post-yank | 814 | Supercite provides a number of commands for performing post-yank |
| @@ -842,9 +842,9 @@ affect alternative citing styles. | |||
| 842 | @item | 842 | @item |
| 843 | @emph{Processes the mail headers.} | 843 | @emph{Processes the mail headers.} |
| 844 | @vindex sc-confirm-always-p | 844 | @vindex sc-confirm-always-p |
| 845 | @vindex confirm-always-p (sc-) | 845 | @vindex confirm-always-p @r{(sc-)} |
| 846 | @vindex sc-mail-warn-if-non-rfc822-p | 846 | @vindex sc-mail-warn-if-non-rfc822-p |
| 847 | @vindex mail-warn-if-non-rfc822-p (sc-) | 847 | @vindex mail-warn-if-non-rfc822-p @r{(sc-)} |
| 848 | All previously retrieved info key-value pairs are deleted from the info | 848 | All previously retrieved info key-value pairs are deleted from the info |
| 849 | alist, then the mail headers in the body of the yanked message are | 849 | alist, then the mail headers in the body of the yanked message are |
| 850 | scanned. Info key-value pairs are created for each header found. Also, | 850 | scanned. Info key-value pairs are created for each header found. Also, |
| @@ -857,8 +857,8 @@ transport agent) along the way. | |||
| 857 | 857 | ||
| 858 | @vindex sc-nuke-mail-headers | 858 | @vindex sc-nuke-mail-headers |
| 859 | @vindex sc-nuke-mail-header-list | 859 | @vindex sc-nuke-mail-header-list |
| 860 | @vindex nuke-mail-headers (sc-) | 860 | @vindex nuke-mail-headers @r{(sc-)} |
| 861 | @vindex nuke-mail-header-list (sc-) | 861 | @vindex nuke-mail-header-list @r{(sc-)} |
| 862 | Once the info keys have been extracted from the mail headers, the | 862 | Once the info keys have been extracted from the mail headers, the |
| 863 | headers are nuked from the reply buffer. You can control exactly which | 863 | headers are nuked from the reply buffer. You can control exactly which |
| 864 | headers are removed or kept, but by default, all headers are removed. | 864 | headers are removed or kept, but by default, all headers are removed. |
| @@ -881,7 +881,7 @@ The line is matched against the regexp using @code{looking-at} rooted at | |||
| 881 | the beginning of the line. | 881 | the beginning of the line. |
| 882 | 882 | ||
| 883 | @vindex sc-blank-lines-after-headers | 883 | @vindex sc-blank-lines-after-headers |
| 884 | @vindex blank-lines-after-headers (sc-) | 884 | @vindex blank-lines-after-headers @r{(sc-)} |
| 885 | If the variable @code{sc-blank-lines-after-headers} is non-@code{nil}, | 885 | If the variable @code{sc-blank-lines-after-headers} is non-@code{nil}, |
| 886 | it contains the number of blank lines remaining in the buffer after mail | 886 | it contains the number of blank lines remaining in the buffer after mail |
| 887 | headers are nuked. By default, only one blank line is left in the buffer. | 887 | headers are nuked. By default, only one blank line is left in the buffer. |
| @@ -895,7 +895,7 @@ original message. @xref{Selecting an Attribution}, for details. | |||
| 895 | @item | 895 | @item |
| 896 | @emph{Cites the message body.} | 896 | @emph{Cites the message body.} |
| 897 | @vindex sc-cite-region-limit | 897 | @vindex sc-cite-region-limit |
| 898 | @vindex cite-region-limit (sc-)b | 898 | @vindex cite-region-limit @r{(sc-)} |
| 899 | After the selection of the attribution and citation strings, Supercite | 899 | After the selection of the attribution and citation strings, Supercite |
| 900 | cites the original message by inserting the citation string prefix in | 900 | cites the original message by inserting the citation string prefix in |
| 901 | front of every uncited line. You may not want Supercite to | 901 | front of every uncited line. You may not want Supercite to |
| @@ -918,7 +918,7 @@ automatically. Use this if you always want to be able to edit and cite | |||
| 918 | the message manually. | 918 | the message manually. |
| 919 | 919 | ||
| 920 | @vindex sc-cite-blank-lines-p | 920 | @vindex sc-cite-blank-lines-p |
| 921 | @vindex cite-blank-lines-p (sc-) | 921 | @vindex cite-blank-lines-p @r{(sc-)} |
| 922 | The variable @code{sc-cite-blank-lines-p} controls whether blank lines | 922 | The variable @code{sc-cite-blank-lines-p} controls whether blank lines |
| 923 | in the original message should be cited or not. If this variable is | 923 | in the original message should be cited or not. If this variable is |
| 924 | non-@code{nil}, blank lines will be cited just like non-blank lines. | 924 | non-@code{nil}, blank lines will be cited just like non-blank lines. |
| @@ -936,7 +936,7 @@ recognize those styles you see often. | |||
| 936 | @item | 936 | @item |
| 937 | @emph{Runs @code{sc-post-hook}.} | 937 | @emph{Runs @code{sc-post-hook}.} |
| 938 | @vindex sc-post-hook | 938 | @vindex sc-post-hook |
| 939 | @vindex post-hook (sc-) | 939 | @vindex post-hook @r{(sc-)} |
| 940 | This variable is very similar to @code{sc-pre-hook}, except that it runs | 940 | This variable is very similar to @code{sc-pre-hook}, except that it runs |
| 941 | after @code{sc-cite-original} is finished. This hook is provided mostly | 941 | after @code{sc-cite-original} is finished. This hook is provided mostly |
| 942 | for completeness and backward compatibility. Perhaps it could be used to | 942 | for completeness and backward compatibility. Perhaps it could be used to |
| @@ -947,11 +947,11 @@ reset certain variables set in @code{sc-pre-hook}. | |||
| 947 | @section Filling Cited Text | 947 | @section Filling Cited Text |
| 948 | @cindex filling paragraphs | 948 | @cindex filling paragraphs |
| 949 | @vindex sc-auto-fill-region-p | 949 | @vindex sc-auto-fill-region-p |
| 950 | @vindex auto-fill-region-p (sc-) | 950 | @vindex auto-fill-region-p @r{(sc-)} |
| 951 | @cindex filladapt | 951 | @cindex filladapt |
| 952 | @cindex gin-mode | 952 | @cindex gin-mode |
| 953 | @findex sc-setup-filladapt | 953 | @findex sc-setup-filladapt |
| 954 | @findex setup-filladapt (sc-) | 954 | @findex setup-filladapt @r{(sc-)} |
| 955 | 955 | ||
| 956 | Supercite will automatically fill newly cited text from the original | 956 | Supercite will automatically fill newly cited text from the original |
| 957 | message unless the variable @code{sc-auto-fill-region-p} has a | 957 | message unless the variable @code{sc-auto-fill-region-p} has a |
| @@ -971,7 +971,7 @@ makes @dfn{filladapt} a little more Supercite savvy than its default | |||
| 971 | setup. | 971 | setup. |
| 972 | 972 | ||
| 973 | @vindex sc-fixup-whitespace-p | 973 | @vindex sc-fixup-whitespace-p |
| 974 | @vindex fixup-whitespace-p (sc-) | 974 | @vindex fixup-whitespace-p @r{(sc-)} |
| 975 | Also, Supercite will collapse leading whitespace between the citation | 975 | Also, Supercite will collapse leading whitespace between the citation |
| 976 | string and the text on a line when the variable | 976 | string and the text on a line when the variable |
| 977 | @code{sc-fixup-whitespace-p} is non-@code{nil}. The default value for | 977 | @code{sc-fixup-whitespace-p} is non-@code{nil}. The default value for |
| @@ -1025,7 +1025,7 @@ fill cited text. | |||
| 1025 | @chapter Selecting an Attribution | 1025 | @chapter Selecting an Attribution |
| 1026 | @cindex attribution list | 1026 | @cindex attribution list |
| 1027 | @vindex sc-preferred-attribution-list | 1027 | @vindex sc-preferred-attribution-list |
| 1028 | @vindex preferred-attribution-list (sc-) | 1028 | @vindex preferred-attribution-list @r{(sc-)} |
| 1029 | 1029 | ||
| 1030 | As you know, the attribution string is the part of the author's name | 1030 | As you know, the attribution string is the part of the author's name |
| 1031 | that will be used to composed a non-nested citation string. Supercite | 1031 | that will be used to composed a non-nested citation string. Supercite |
| @@ -1080,7 +1080,7 @@ recite paragraphs in the reply. | |||
| 1080 | 1080 | ||
| 1081 | @item "sc-consult" | 1081 | @item "sc-consult" |
| 1082 | @vindex sc-attrib-selection-list | 1082 | @vindex sc-attrib-selection-list |
| 1083 | @vindex attrib-selection-list (sc-) | 1083 | @vindex attrib-selection-list @r{(sc-)} |
| 1084 | consults the customizable list @code{sc-attrib-selection-list} which can | 1084 | consults the customizable list @code{sc-attrib-selection-list} which can |
| 1085 | be used to select special attributions based on the value of any info | 1085 | be used to select special attributions based on the value of any info |
| 1086 | key. See below for details. | 1086 | key. See below for details. |
| @@ -1114,7 +1114,7 @@ suggested that if you change the order of the keys in this list, that | |||
| 1114 | @code{"sc-lastchoice"}. This latter is the default. | 1114 | @code{"sc-lastchoice"}. This latter is the default. |
| 1115 | 1115 | ||
| 1116 | @vindex sc-attrib-selection-list | 1116 | @vindex sc-attrib-selection-list |
| 1117 | @vindex attrib-selection-list (sc-) | 1117 | @vindex attrib-selection-list @r{(sc-)} |
| 1118 | The value @code{"sc-consult"} in @code{sc-preferred-attribution-list} | 1118 | The value @code{"sc-consult"} in @code{sc-preferred-attribution-list} |
| 1119 | has a special meaning during attribution selection. When Supercite | 1119 | has a special meaning during attribution selection. When Supercite |
| 1120 | encounters this preference, it begins processing a customizable list of | 1120 | encounters this preference, it begins processing a customizable list of |
| @@ -1131,7 +1131,7 @@ Each element in this list contains lists of the following form: | |||
| 1131 | 1131 | ||
| 1132 | @noindent | 1132 | @noindent |
| 1133 | @findex sc-mail-field | 1133 | @findex sc-mail-field |
| 1134 | @findex mail-field (sc-) | 1134 | @findex mail-field @r{(sc-)} |
| 1135 | where @var{infokey} is a key for @code{sc-mail-field} and @var{regexp} | 1135 | where @var{infokey} is a key for @code{sc-mail-field} and @var{regexp} |
| 1136 | is a regular expression to match against the @var{infokey}'s value. If | 1136 | is a regular expression to match against the @var{infokey}'s value. If |
| 1137 | @var{regexp} matches the @var{infokey}'s value, the @var{attribution} is | 1137 | @var{regexp} matches the @var{infokey}'s value, the @var{attribution} is |
| @@ -1148,9 +1148,9 @@ to cite your friend's message with the appropriate attribution. | |||
| 1148 | @node Anonymous Attributions | 1148 | @node Anonymous Attributions |
| 1149 | @section Anonymous Attributions | 1149 | @section Anonymous Attributions |
| 1150 | @vindex sc-default-author-name | 1150 | @vindex sc-default-author-name |
| 1151 | @vindex default-author-name (sc-) | 1151 | @vindex default-author-name @r{(sc-)} |
| 1152 | @vindex sc-default-attribution | 1152 | @vindex sc-default-attribution |
| 1153 | @vindex default-attribution (sc-) | 1153 | @vindex default-attribution @r{(sc-)} |
| 1154 | 1154 | ||
| 1155 | When the author's name cannot be found in the @samp{From:@:} mail | 1155 | When the author's name cannot be found in the @samp{From:@:} mail |
| 1156 | header, a fallback author name and attribution string must be supplied. | 1156 | header, a fallback author name and attribution string must be supplied. |
| @@ -1163,7 +1163,7 @@ author name or attribution is a sign that something is set up | |||
| 1163 | incorrectly. | 1163 | incorrectly. |
| 1164 | 1164 | ||
| 1165 | @vindex sc-use-only-preference-p | 1165 | @vindex sc-use-only-preference-p |
| 1166 | @vindex use-only-preference-p (sc-) | 1166 | @vindex use-only-preference-p @r{(sc-)} |
| 1167 | Also, if the preferred attribution, which you specified in your | 1167 | Also, if the preferred attribution, which you specified in your |
| 1168 | @code{sc-preferred-attribution-list} variable cannot be found, a | 1168 | @code{sc-preferred-attribution-list} variable cannot be found, a |
| 1169 | secondary method can be employed to find a valid attribution string. The | 1169 | secondary method can be employed to find a valid attribution string. The |
| @@ -1199,7 +1199,7 @@ attribution alist. | |||
| 1199 | @end enumerate | 1199 | @end enumerate |
| 1200 | 1200 | ||
| 1201 | @vindex sc-confirm-always-p | 1201 | @vindex sc-confirm-always-p |
| 1202 | @vindex confirm-always-p (sc-) | 1202 | @vindex confirm-always-p @r{(sc-)} |
| 1203 | Once the attribution string has been automatically selected, a number of | 1203 | Once the attribution string has been automatically selected, a number of |
| 1204 | things can happen. If the variable @code{sc-confirm-always-p} is | 1204 | things can happen. If the variable @code{sc-confirm-always-p} is |
| 1205 | non-@code{nil}, you are queried for confirmation of the chosen | 1205 | non-@code{nil}, you are queried for confirmation of the chosen |
| @@ -1210,15 +1210,15 @@ you enter becomes the value associated with the @code{"sc-lastchoice"} | |||
| 1210 | key in the attribution alist. | 1210 | key in the attribution alist. |
| 1211 | 1211 | ||
| 1212 | @vindex sc-downcase-p | 1212 | @vindex sc-downcase-p |
| 1213 | @vindex downcase-p (sc-) | 1213 | @vindex downcase-p @r{(sc-)} |
| 1214 | Once an attribution string has been selected, Supercite will force the | 1214 | Once an attribution string has been selected, Supercite will force the |
| 1215 | string to lower case if the variable @code{sc-downcase-p} is | 1215 | string to lower case if the variable @code{sc-downcase-p} is |
| 1216 | non-@code{nil}. | 1216 | non-@code{nil}. |
| 1217 | 1217 | ||
| 1218 | @vindex sc-attribs-preselect-hook | 1218 | @vindex sc-attribs-preselect-hook |
| 1219 | @vindex attribs-preselect-hook (sc-) | 1219 | @vindex attribs-preselect-hook @r{(sc-)} |
| 1220 | @vindex sc-attribs-postselect-hook | 1220 | @vindex sc-attribs-postselect-hook |
| 1221 | @vindex attribs-postselect-hook (sc-) | 1221 | @vindex attribs-postselect-hook @r{(sc-)} |
| 1222 | 1222 | ||
| 1223 | Two hook variables provide even greater control of the attribution | 1223 | Two hook variables provide even greater control of the attribution |
| 1224 | selection process. The hook @code{sc-attribs-preselect-hook} is run | 1224 | selection process. The hook @code{sc-attribs-preselect-hook} is run |
| @@ -1245,7 +1245,7 @@ formats in use. If you encounter a @samp{From:@:} field that Supercite | |||
| 1245 | cannot parse, please report this bug using @kbd{M-x report-emacs-bug}. | 1245 | cannot parse, please report this bug using @kbd{M-x report-emacs-bug}. |
| 1246 | 1246 | ||
| 1247 | @vindex sc-titlecue-regexp | 1247 | @vindex sc-titlecue-regexp |
| 1248 | @vindex titlecue-regexp (sc-) | 1248 | @vindex titlecue-regexp @r{(sc-)} |
| 1249 | There are a number of Supercite variables that control how author names | 1249 | There are a number of Supercite variables that control how author names |
| 1250 | are extracted from the @samp{From:@:} header. Some headers may contain a | 1250 | are extracted from the @samp{From:@:} header. Some headers may contain a |
| 1251 | descriptive title as in: | 1251 | descriptive title as in: |
| @@ -1263,7 +1263,7 @@ This variable has the default value of @code{"\\\\s +-+\\\\s +"}. Any | |||
| 1263 | text after this regexp is encountered is ignored as noise. | 1263 | text after this regexp is encountered is ignored as noise. |
| 1264 | 1264 | ||
| 1265 | @vindex sc-name-filter-alist | 1265 | @vindex sc-name-filter-alist |
| 1266 | @vindex name-filter-alist (sc-) | 1266 | @vindex name-filter-alist @r{(sc-)} |
| 1267 | Some @samp{From:@:} headers may contain extra titles in the name fields | 1267 | Some @samp{From:@:} headers may contain extra titles in the name fields |
| 1268 | not separated by a title cue, but which are nonetheless not part of the | 1268 | not separated by a title cue, but which are nonetheless not part of the |
| 1269 | author's name proper. Examples include the titles ``Dr.'', ``Mr.'', | 1269 | author's name proper. Examples include the titles ``Dr.'', ``Mr.'', |
| @@ -1497,7 +1497,7 @@ is not found from the alist, then the appropriate default frame is used. | |||
| 1497 | @node Post-yank Formatting Commands | 1497 | @node Post-yank Formatting Commands |
| 1498 | @chapter Post-yank Formatting Commands | 1498 | @chapter Post-yank Formatting Commands |
| 1499 | @vindex sc-mode-map-prefix | 1499 | @vindex sc-mode-map-prefix |
| 1500 | @vindex mode-map-prefix (sc-) | 1500 | @vindex mode-map-prefix @r{(sc-)} |
| 1501 | @kindex C-c C-p | 1501 | @kindex C-c C-p |
| 1502 | 1502 | ||
| 1503 | Once the original message has been yanked into the reply buffer, and | 1503 | Once the original message has been yanked into the reply buffer, and |
| @@ -1540,10 +1540,10 @@ Here is the list of Supercite citing commands: | |||
| 1540 | 1540 | ||
| 1541 | @table @asis | 1541 | @table @asis |
| 1542 | @findex sc-cite-region | 1542 | @findex sc-cite-region |
| 1543 | @findex cite-region (sc-) | 1543 | @findex cite-region @r{(sc-)} |
| 1544 | @kindex C-c C-p c | 1544 | @kindex C-c C-p c |
| 1545 | @vindex sc-pre-cite-hook | 1545 | @vindex sc-pre-cite-hook |
| 1546 | @vindex pre-cite-hook (sc-) | 1546 | @vindex pre-cite-hook @r{(sc-)} |
| 1547 | @vindex sc-confirm-always-p | 1547 | @vindex sc-confirm-always-p |
| 1548 | @vindex confirm-always-p | 1548 | @vindex confirm-always-p |
| 1549 | @kindex C-u | 1549 | @kindex C-u |
| @@ -1558,7 +1558,7 @@ attribution string for a single manual citing. | |||
| 1558 | @xref{Configuring the Citation Engine}. | 1558 | @xref{Configuring the Citation Engine}. |
| 1559 | 1559 | ||
| 1560 | @findex sc-uncite-region | 1560 | @findex sc-uncite-region |
| 1561 | @findex uncite-region (sc-) | 1561 | @findex uncite-region @r{(sc-)} |
| 1562 | @kindex C-c C-p u | 1562 | @kindex C-c C-p u |
| 1563 | @item @code{sc-uncite-region} (@kbd{C-c C-p u}) | 1563 | @item @code{sc-uncite-region} (@kbd{C-c C-p u}) |
| 1564 | This command removes any citation strings from the beginning of each | 1564 | This command removes any citation strings from the beginning of each |
| @@ -1569,7 +1569,7 @@ cited line in the region by interpreting the selected frame from | |||
| 1569 | @xref{Configuring the Citation Engine}. | 1569 | @xref{Configuring the Citation Engine}. |
| 1570 | 1570 | ||
| 1571 | @findex sc-recite-region | 1571 | @findex sc-recite-region |
| 1572 | @findex recite-region (sc-) | 1572 | @findex recite-region @r{(sc-)} |
| 1573 | @kindex C-c C-p r | 1573 | @kindex C-c C-p r |
| 1574 | @item @code{sc-recite-region} (@kbd{C-c C-p r}) | 1574 | @item @code{sc-recite-region} (@kbd{C-c C-p r}) |
| 1575 | This command recites each line the region by interpreting the selected | 1575 | This command recites each line the region by interpreting the selected |
| @@ -1579,7 +1579,7 @@ frame from @code{sc-recite-frame-alist}, or the default reciting frame | |||
| 1579 | @xref{Configuring the Citation Engine}. | 1579 | @xref{Configuring the Citation Engine}. |
| 1580 | 1580 | ||
| 1581 | @vindex sc-confirm-always-p | 1581 | @vindex sc-confirm-always-p |
| 1582 | @vindex confirm-always-p (sc-) | 1582 | @vindex confirm-always-p @r{(sc-)} |
| 1583 | Supercite will always ask you to confirm the attribution when reciting a | 1583 | Supercite will always ask you to confirm the attribution when reciting a |
| 1584 | region, regardless of the value of @code{sc-confirm-always-p}. | 1584 | region, regardless of the value of @code{sc-confirm-always-p}. |
| 1585 | @end table | 1585 | @end table |
| @@ -1591,11 +1591,11 @@ These two functions insert various strings into the reply buffer. | |||
| 1591 | 1591 | ||
| 1592 | @table @asis | 1592 | @table @asis |
| 1593 | @findex sc-insert-reference | 1593 | @findex sc-insert-reference |
| 1594 | @findex insert-reference (sc-) | 1594 | @findex insert-reference @r{(sc-)} |
| 1595 | @kindex C-c C-p w | 1595 | @kindex C-c C-p w |
| 1596 | @item @code{sc-insert-reference} (@kbd{C-c C-p w}) | 1596 | @item @code{sc-insert-reference} (@kbd{C-c C-p w}) |
| 1597 | @vindex sc-preferred-header-style | 1597 | @vindex sc-preferred-header-style |
| 1598 | @vindex preferred-header-style (sc-) | 1598 | @vindex preferred-header-style @r{(sc-)} |
| 1599 | Inserts a reference header into the reply buffer at @samp{point}. With | 1599 | Inserts a reference header into the reply buffer at @samp{point}. With |
| 1600 | no arguments, the header indexed by @code{sc-preferred-header-style} is | 1600 | no arguments, the header indexed by @code{sc-preferred-header-style} is |
| 1601 | inserted. An optional numeric argument is the index into | 1601 | inserted. An optional numeric argument is the index into |
| @@ -1606,7 +1606,7 @@ With just the universal argument (@kbd{C-u}), electric reference mode is | |||
| 1606 | entered, regardless of the value of @code{sc-electric-references-p}. | 1606 | entered, regardless of the value of @code{sc-electric-references-p}. |
| 1607 | 1607 | ||
| 1608 | @findex sc-insert-citation | 1608 | @findex sc-insert-citation |
| 1609 | @findex insert-citation (sc-) | 1609 | @findex insert-citation @r{(sc-)} |
| 1610 | @kindex C-c C-p i | 1610 | @kindex C-c C-p i |
| 1611 | @item @code{sc-insert-citation} (@kbd{C-c C-p i}) | 1611 | @item @code{sc-insert-citation} (@kbd{C-c C-p i}) |
| 1612 | Inserts the current citation string at the beginning of the line that | 1612 | Inserts the current citation string at the beginning of the line that |
| @@ -1704,7 +1704,7 @@ of information from the info alist. | |||
| 1704 | @table @asis | 1704 | @table @asis |
| 1705 | @kindex C-c C-p f | 1705 | @kindex C-c C-p f |
| 1706 | @findex sc-mail-field-query | 1706 | @findex sc-mail-field-query |
| 1707 | @findex mail-field-query (sc-) | 1707 | @findex mail-field-query @r{(sc-)} |
| 1708 | @kindex C-c C-p f | 1708 | @kindex C-c C-p f |
| 1709 | @item @code{sc-mail-field-query} (@kbd{C-c C-p f}) | 1709 | @item @code{sc-mail-field-query} (@kbd{C-c C-p f}) |
| 1710 | Allows you to interactively view, modify, add, and delete info alist | 1710 | Allows you to interactively view, modify, add, and delete info alist |
| @@ -1732,7 +1732,7 @@ will override any old value. It will not replace it though; if you | |||
| 1732 | subsequently delete the key-value pair, the old value will reappear. | 1732 | subsequently delete the key-value pair, the old value will reappear. |
| 1733 | 1733 | ||
| 1734 | @findex sc-mail-process-headers | 1734 | @findex sc-mail-process-headers |
| 1735 | @findex mail-process-headers (sc-) | 1735 | @findex mail-process-headers @r{(sc-)} |
| 1736 | @kindex C-c C-p g | 1736 | @kindex C-c C-p g |
| 1737 | @item @code{sc-mail-process-headers} (@kbd{C-c C-p g}) | 1737 | @item @code{sc-mail-process-headers} (@kbd{C-c C-p g}) |
| 1738 | This command lets you re-initialize Supercite's info alist from any set | 1738 | This command lets you re-initialize Supercite's info alist from any set |
| @@ -1749,7 +1749,7 @@ old information is lost. | |||
| 1749 | 1749 | ||
| 1750 | @table @asis | 1750 | @table @asis |
| 1751 | @findex sc-open-line | 1751 | @findex sc-open-line |
| 1752 | @findex open-line (sc-) | 1752 | @findex open-line @r{(sc-)} |
| 1753 | @findex open-line | 1753 | @findex open-line |
| 1754 | @kindex C-c C-p o | 1754 | @kindex C-c C-p o |
| 1755 | @item @code{sc-open-line} (@kbd{C-c C-p o}) | 1755 | @item @code{sc-open-line} (@kbd{C-c C-p o}) |
diff --git a/doc/misc/vhdl-mode.texi b/doc/misc/vhdl-mode.texi index cf3909c67b3..e94fba6fc6d 100644 --- a/doc/misc/vhdl-mode.texi +++ b/doc/misc/vhdl-mode.texi | |||
| @@ -147,7 +147,7 @@ your personal coding style. | |||
| 147 | @cindex Syntactic Analysis | 147 | @cindex Syntactic Analysis |
| 148 | 148 | ||
| 149 | @vindex vhdl-offsets-alist | 149 | @vindex vhdl-offsets-alist |
| 150 | @vindex offsets-alist (vhdl-) | 150 | @vindex offsets-alist @r{(vhdl-)} |
| 151 | @cindex relative buffer position | 151 | @cindex relative buffer position |
| 152 | @cindex syntactic symbol | 152 | @cindex syntactic symbol |
| 153 | @cindex syntactic component | 153 | @cindex syntactic component |
| @@ -186,7 +186,7 @@ in this and future examples don't actually appear in the buffer.}: | |||
| 186 | 186 | ||
| 187 | @kindex C-c C-x | 187 | @kindex C-c C-x |
| 188 | @findex vhdl-show-syntactic-information | 188 | @findex vhdl-show-syntactic-information |
| 189 | @findex show-syntactic-information (vhdl-) | 189 | @findex show-syntactic-information @r{(vhdl-)} |
| 190 | We can use the command @kbd{C-c C-x} | 190 | We can use the command @kbd{C-c C-x} |
| 191 | (@code{vhdl-show-syntactic-information}) to simply report what the | 191 | (@code{vhdl-show-syntactic-information}) to simply report what the |
| 192 | syntactic analysis is for the current line. Running this command on | 192 | syntactic analysis is for the current line. Running this command on |
| @@ -241,7 +241,7 @@ components. Also notice that the first component, | |||
| 241 | @cindex Indentation Calculation | 241 | @cindex Indentation Calculation |
| 242 | 242 | ||
| 243 | @vindex vhdl-offsets-alist | 243 | @vindex vhdl-offsets-alist |
| 244 | @vindex offsets-alist (vhdl-) | 244 | @vindex offsets-alist @r{(vhdl-)} |
| 245 | Indentation for the current line is calculated using the syntactic | 245 | Indentation for the current line is calculated using the syntactic |
| 246 | component list derived in step 1 above (see @ref{Syntactic | 246 | component list derived in step 1 above (see @ref{Syntactic |
| 247 | Analysis}). Each component contributes to the final total indentation | 247 | Analysis}). Each component contributes to the final total indentation |
| @@ -301,7 +301,7 @@ indentation, it's helpful to understand the general indentation model | |||
| 301 | being used. | 301 | being used. |
| 302 | 302 | ||
| 303 | @vindex vhdl-echo-syntactic-information-p | 303 | @vindex vhdl-echo-syntactic-information-p |
| 304 | @vindex echo-syntactic-information-p (vhdl-) | 304 | @vindex echo-syntactic-information-p @r{(vhdl-)} |
| 305 | @cindex TAB | 305 | @cindex TAB |
| 306 | To help you configure VHDL Mode, you can set the variable | 306 | To help you configure VHDL Mode, you can set the variable |
| 307 | @code{vhdl-echo-syntactic-information-p} to non-@code{nil} so that the | 307 | @code{vhdl-echo-syntactic-information-p} to non-@code{nil} so that the |
| @@ -428,7 +428,7 @@ line. Hitting @kbd{C-c C-x} on line 3 yields: | |||
| 428 | @end example | 428 | @end example |
| 429 | 429 | ||
| 430 | @findex vhdl-set-offset | 430 | @findex vhdl-set-offset |
| 431 | @findex set-offset (vhdl-) | 431 | @findex set-offset @r{(vhdl-)} |
| 432 | @kindex C-c O | 432 | @kindex C-c O |
| 433 | @noindent | 433 | @noindent |
| 434 | So we know that to change the offset of the first signal assignment, we need to | 434 | So we know that to change the offset of the first signal assignment, we need to |
| @@ -447,7 +447,7 @@ basic indent with the syntactic symbol @code{statement-block-intro} in | |||
| 447 | the @code{vhdl-offsets-alist} variable. | 447 | the @code{vhdl-offsets-alist} variable. |
| 448 | 448 | ||
| 449 | @findex vhdl-indent-defun | 449 | @findex vhdl-indent-defun |
| 450 | @findex indent-defun (vhdl-) | 450 | @findex indent-defun @r{(vhdl-)} |
| 451 | To check your changes quickly, just enter @kbd{M-x vhdl-indent-defun} to | 451 | To check your changes quickly, just enter @kbd{M-x vhdl-indent-defun} to |
| 452 | reindent the entire function. The example should now look like: | 452 | reindent the entire function. The example should now look like: |
| 453 | @example | 453 | @example |
| @@ -546,7 +546,7 @@ already built-in. These include: | |||
| 546 | @end itemize | 546 | @end itemize |
| 547 | 547 | ||
| 548 | @findex vhdl-set-style | 548 | @findex vhdl-set-style |
| 549 | @findex set-style (vhdl-) | 549 | @findex set-style @r{(vhdl-)} |
| 550 | If you'd like to experiment with these built-in styles you can simply | 550 | If you'd like to experiment with these built-in styles you can simply |
| 551 | type @kbd{M-x vhdl-set-style RET} in a VHDL Mode buffer. | 551 | type @kbd{M-x vhdl-set-style RET} in a VHDL Mode buffer. |
| 552 | 552 | ||
| @@ -583,9 +583,9 @@ files. You would add this: | |||
| 583 | @cindex Adding Styles | 583 | @cindex Adding Styles |
| 584 | 584 | ||
| 585 | @vindex vhdl-style-alist | 585 | @vindex vhdl-style-alist |
| 586 | @vindex style-alist (vhdl-) | 586 | @vindex style-alist @r{(vhdl-)} |
| 587 | @findex vhdl-add-style | 587 | @findex vhdl-add-style |
| 588 | @findex add-style (vhdl-) | 588 | @findex add-style @r{(vhdl-)} |
| 589 | If none of the built-in styles is appropriate, you'll probably want to | 589 | If none of the built-in styles is appropriate, you'll probably want to |
| 590 | add a new style definition. Styles are kept in the @code{vhdl-style-alist} | 590 | add a new style definition. Styles are kept in the @code{vhdl-style-alist} |
| 591 | variable, but you probably won't want to modify this variable directly. | 591 | variable, but you probably won't want to modify this variable directly. |
| @@ -615,9 +615,9 @@ block. VHDL Mode provides two variables that make it easier for | |||
| 615 | you to customize your style on a per-file basis. | 615 | you to customize your style on a per-file basis. |
| 616 | 616 | ||
| 617 | @vindex vhdl-file-style | 617 | @vindex vhdl-file-style |
| 618 | @vindex file-style (vhdl-) | 618 | @vindex file-style @r{(vhdl-)} |
| 619 | @vindex vhdl-file-offsets | 619 | @vindex vhdl-file-offsets |
| 620 | @vindex file-offsets (vhdl-) | 620 | @vindex file-offsets @r{(vhdl-)} |
| 621 | 621 | ||
| 622 | The variable @code{vhdl-file-style} can be set to a style name string as | 622 | The variable @code{vhdl-file-style} can be set to a style name string as |
| 623 | described in @ref{Built-in Styles}. When the file is visited, | 623 | described in @ref{Built-in Styles}. When the file is visited, |
| @@ -625,9 +625,9 @@ VHDL Mode will automatically set the file's style to this style | |||
| 625 | using @code{vhdl-set-style}. | 625 | using @code{vhdl-set-style}. |
| 626 | 626 | ||
| 627 | @vindex vhdl-offsets-alist | 627 | @vindex vhdl-offsets-alist |
| 628 | @vindex offsets-alist (vhdl-) | 628 | @vindex offsets-alist @r{(vhdl-)} |
| 629 | @findex vhdl-set-offset | 629 | @findex vhdl-set-offset |
| 630 | @findex set-offset (vhdl-) | 630 | @findex set-offset @r{(vhdl-)} |
| 631 | Another variable, @code{vhdl-file-offsets}, takes an association list | 631 | Another variable, @code{vhdl-file-offsets}, takes an association list |
| 632 | similar to what is allowed in @code{vhdl-offsets-alist}. When the file is | 632 | similar to what is allowed in @code{vhdl-offsets-alist}. When the file is |
| 633 | visited, VHDL Mode will automatically institute these offsets using | 633 | visited, VHDL Mode will automatically institute these offsets using |
| @@ -642,9 +642,9 @@ before file offset settings (i.e., @code{vhdl-file-offsets}). | |||
| 642 | @cindex Advanced Customizations | 642 | @cindex Advanced Customizations |
| 643 | 643 | ||
| 644 | @vindex vhdl-style-alist | 644 | @vindex vhdl-style-alist |
| 645 | @vindex style-alist (vhdl-) | 645 | @vindex style-alist @r{(vhdl-)} |
| 646 | @vindex vhdl-basic-offset | 646 | @vindex vhdl-basic-offset |
| 647 | @vindex basic-offset (vhdl-) | 647 | @vindex basic-offset @r{(vhdl-)} |
| 648 | For most users, VHDL Mode will support their coding styles with | 648 | For most users, VHDL Mode will support their coding styles with |
| 649 | very little need for customizations. Usually, one of the standard | 649 | very little need for customizations. Usually, one of the standard |
| 650 | styles defined in @code{vhdl-style-alist} will do the trick. Sometimes, | 650 | styles defined in @code{vhdl-style-alist} will do the trick. Sometimes, |
| @@ -743,7 +743,7 @@ don't want that value added into the final total twice. | |||
| 743 | 743 | ||
| 744 | @cindex statement-cont syntactic symbol | 744 | @cindex statement-cont syntactic symbol |
| 745 | @findex vhdl-lineup-statement-cont | 745 | @findex vhdl-lineup-statement-cont |
| 746 | @findex lineup-statement-cont (vhdl-) | 746 | @findex lineup-statement-cont @r{(vhdl-)} |
| 747 | Now, to associate the function @code{vhdl-lineup-statement-cont} with the | 747 | Now, to associate the function @code{vhdl-lineup-statement-cont} with the |
| 748 | @code{statement-cont} syntactic symbol, we can add something like the | 748 | @code{statement-cont} syntactic symbol, we can add something like the |
| 749 | following to our @code{vhdl-mode-hook}: | 749 | following to our @code{vhdl-mode-hook}: |
| @@ -765,7 +765,7 @@ vhdl-indent-defun}): | |||
| 765 | @end example | 765 | @end example |
| 766 | 766 | ||
| 767 | @vindex vhdl-offsets-alist | 767 | @vindex vhdl-offsets-alist |
| 768 | @vindex offsets-alist (vhdl-) | 768 | @vindex offsets-alist @r{(vhdl-)} |
| 769 | Custom indentation functions can be as simple or as complex as you like, | 769 | Custom indentation functions can be as simple or as complex as you like, |
| 770 | and any syntactic symbol that appears in @code{vhdl-offsets-alist} can have | 770 | and any syntactic symbol that appears in @code{vhdl-offsets-alist} can have |
| 771 | a custom indentation function associated with it. Note however that | 771 | a custom indentation function associated with it. Note however that |
| @@ -777,7 +777,7 @@ VHDL Mode. | |||
| 777 | @cindex Other Special Indentations | 777 | @cindex Other Special Indentations |
| 778 | 778 | ||
| 779 | @vindex vhdl-special-indent-hook | 779 | @vindex vhdl-special-indent-hook |
| 780 | @vindex special-indent-hook (vhdl-) | 780 | @vindex special-indent-hook @r{(vhdl-)} |
| 781 | One other variable is available for you to customize VHDL Mode: | 781 | One other variable is available for you to customize VHDL Mode: |
| 782 | @code{vhdl-special-indent-hook}. This is a standard hook variable that | 782 | @code{vhdl-special-indent-hook}. This is a standard hook variable that |
| 783 | is called after every line is indented by VHDL Mode. You can use | 783 | is called after every line is indented by VHDL Mode. You can use |
| @@ -956,7 +956,7 @@ The index menu does not work on my XEmacs installation (don't know why). | |||
| 956 | 956 | ||
| 957 | @kindex C-c C-b | 957 | @kindex C-c C-b |
| 958 | @findex vhdl-submit-bug-report | 958 | @findex vhdl-submit-bug-report |
| 959 | @findex submit-bug-report (vhdl-) | 959 | @findex submit-bug-report @r{(vhdl-)} |
| 960 | @cindex beta testers mailing list | 960 | @cindex beta testers mailing list |
| 961 | @cindex announcement mailing list | 961 | @cindex announcement mailing list |
| 962 | To report bugs, use the @kbd{C-c C-b} (@code{vhdl-submit-bug-report}) | 962 | To report bugs, use the @kbd{C-c C-b} (@code{vhdl-submit-bug-report}) |
diff --git a/doc/misc/viper.texi b/doc/misc/viper.texi index f45f2a03b9d..8948437632b 100644 --- a/doc/misc/viper.texi +++ b/doc/misc/viper.texi | |||
| @@ -376,8 +376,8 @@ toggles Viperization of Emacs on and off. | |||
| 376 | @cindex Insert state | 376 | @cindex Insert state |
| 377 | @cindex Replace state | 377 | @cindex Replace state |
| 378 | @cindex Ex commands | 378 | @cindex Ex commands |
| 379 | @findex @code{viper-go-away} | 379 | @findex viper-go-away |
| 380 | @findex @code{toggle-viper-mode} | 380 | @findex toggle-viper-mode |
| 381 | 381 | ||
| 382 | Viper has four states, Emacs, Vi, Insert, and Replace. | 382 | Viper has four states, Emacs, Vi, Insert, and Replace. |
| 383 | 383 | ||
| @@ -1182,7 +1182,7 @@ variable that controls how search patterns are highlighted is | |||
| 1182 | @example | 1182 | @example |
| 1183 | (copy-face 'default 'viper-search-face) | 1183 | (copy-face 'default 'viper-search-face) |
| 1184 | @end example | 1184 | @end example |
| 1185 | @vindex @code{viper-search-face} | 1185 | @vindex viper-search-face |
| 1186 | @noindent | 1186 | @noindent |
| 1187 | in your Viper customization file. If you want to change how patterns are | 1187 | in your Viper customization file. If you want to change how patterns are |
| 1188 | highlighted, you will have to change @code{viper-search-face} to your liking. | 1188 | highlighted, you will have to change @code{viper-search-face} to your liking. |
| @@ -1240,7 +1240,7 @@ watch out for is that it is possible to be on the end-of-line character. | |||
| 1240 | The keys @kbd{x} and @kbd{%} will still work correctly, i.e., as if they | 1240 | The keys @kbd{x} and @kbd{%} will still work correctly, i.e., as if they |
| 1241 | were on the last character. | 1241 | were on the last character. |
| 1242 | 1242 | ||
| 1243 | @vindex @code{viper-syntax-preference} | 1243 | @vindex viper-syntax-preference |
| 1244 | @cindex syntax table | 1244 | @cindex syntax table |
| 1245 | 1245 | ||
| 1246 | The word-movement commands @kbd{w}, @kbd{e}, etc., and the associated | 1246 | The word-movement commands @kbd{w}, @kbd{e}, etc., and the associated |
| @@ -1278,7 +1278,7 @@ the following example: | |||
| 1278 | (viper-set-syntax-preference nil "emacs") | 1278 | (viper-set-syntax-preference nil "emacs") |
| 1279 | @end example | 1279 | @end example |
| 1280 | 1280 | ||
| 1281 | @findex @code{viper-set-syntax-preference} | 1281 | @findex viper-set-syntax-preference |
| 1282 | 1282 | ||
| 1283 | The above discussion of the meaning of Viper's words concerns only Viper's | 1283 | The above discussion of the meaning of Viper's words concerns only Viper's |
| 1284 | movement commands. In regular expressions, words remain the same as in | 1284 | movement commands. In regular expressions, words remain the same as in |
| @@ -1369,7 +1369,7 @@ character(s) appropriate for the current major mode. | |||
| 1369 | Check spelling of words in the region (@code{spell-region}). | 1369 | Check spelling of words in the region (@code{spell-region}). |
| 1370 | The function used for spelling is determined from the variable | 1370 | The function used for spelling is determined from the variable |
| 1371 | @code{viper-spell-function}. | 1371 | @code{viper-spell-function}. |
| 1372 | @vindex @code{viper-spell-function} | 1372 | @vindex viper-spell-function |
| 1373 | @item * | 1373 | @item * |
| 1374 | @kindex @kbd{*} | 1374 | @kindex @kbd{*} |
| 1375 | Call last keyboard macro. | 1375 | Call last keyboard macro. |
| @@ -1775,7 +1775,7 @@ Use @code{viper-glob-unix-files} and @code{viper-glob-mswindows-files} in | |||
| 1775 | This feature is used to expand wildcards in the Ex command @kbd{:e}. | 1775 | This feature is used to expand wildcards in the Ex command @kbd{:e}. |
| 1776 | Note that Viper doesn't support wildcards in the @kbd{:r} and @kbd{:w} | 1776 | Note that Viper doesn't support wildcards in the @kbd{:r} and @kbd{:w} |
| 1777 | commands, because file completion is a better mechanism. | 1777 | commands, because file completion is a better mechanism. |
| 1778 | @findex @code{viper-glob-function} | 1778 | @findex viper-glob-function |
| 1779 | 1779 | ||
| 1780 | @item ex-cycle-other-window t | 1780 | @item ex-cycle-other-window t |
| 1781 | If not @code{nil}, @kbd{:n} and @kbd{:b} will cycle through files in another | 1781 | If not @code{nil}, @kbd{:n} and @kbd{:b} will cycle through files in another |
| @@ -1845,16 +1845,16 @@ For a complete list of colors available to you, evaluate the expression | |||
| 1845 | hit the @kbd{C-j} key. | 1845 | hit the @kbd{C-j} key. |
| 1846 | 1846 | ||
| 1847 | @item viper-replace-overlay-cursor-color "Red" | 1847 | @item viper-replace-overlay-cursor-color "Red" |
| 1848 | @vindex @code{viper-replace-overlay-cursor-color} | 1848 | @vindex viper-replace-overlay-cursor-color |
| 1849 | Cursor color when it is inside the replacement region. | 1849 | Cursor color when it is inside the replacement region. |
| 1850 | This has effect only on color displays and only when Emacs runs as an X | 1850 | This has effect only on color displays and only when Emacs runs as an X |
| 1851 | application. | 1851 | application. |
| 1852 | @item viper-insert-state-cursor-color nil | 1852 | @item viper-insert-state-cursor-color nil |
| 1853 | @vindex @code{viper-insert-state-cursor-color} | 1853 | @vindex viper-insert-state-cursor-color |
| 1854 | If set to a valid color, this will be the cursor color when Viper is in | 1854 | If set to a valid color, this will be the cursor color when Viper is in |
| 1855 | insert state. | 1855 | insert state. |
| 1856 | @item viper-emacs-state-cursor-color nil | 1856 | @item viper-emacs-state-cursor-color nil |
| 1857 | @vindex @code{viper-emacs-state-cursor-color} | 1857 | @vindex viper-emacs-state-cursor-color |
| 1858 | If set to a valid color, this will be the cursor color when Viper is in | 1858 | If set to a valid color, this will be the cursor color when Viper is in |
| 1859 | emacs state. | 1859 | emacs state. |
| 1860 | @item viper-replace-region-end-delimiter "$" | 1860 | @item viper-replace-region-end-delimiter "$" |
| @@ -1913,45 +1913,45 @@ can include a line like this in your Viper customization file: | |||
| 1913 | @example | 1913 | @example |
| 1914 | (setq viper-case-fold-search t) | 1914 | (setq viper-case-fold-search t) |
| 1915 | @end example | 1915 | @end example |
| 1916 | @vindex @code{viper-auto-indent} | 1916 | @vindex viper-auto-indent |
| 1917 | @vindex @code{viper-electric-mode} | 1917 | @vindex viper-electric-mode |
| 1918 | @vindex @code{viper-case-fold-search} | 1918 | @vindex viper-case-fold-search |
| 1919 | @vindex @code{viper-re-search} | 1919 | @vindex viper-re-search |
| 1920 | @vindex @code{viper-shift-width} | 1920 | @vindex viper-shift-width |
| 1921 | @vindex @code{buffer-read-only} | 1921 | @vindex buffer-read-only |
| 1922 | @vindex @code{viper-search-wrap-around} | 1922 | @vindex viper-search-wrap-around |
| 1923 | @vindex @code{viper-search-scroll-threshold} | 1923 | @vindex viper-search-scroll-threshold |
| 1924 | @vindex @code{viper-search-face} | 1924 | @vindex viper-search-face |
| 1925 | @vindex @code{viper-tags-file-name} | 1925 | @vindex viper-tags-file-name |
| 1926 | @vindex @code{viper-re-query-replace} | 1926 | @vindex viper-re-query-replace |
| 1927 | @vindex @code{viper-want-ctl-h-help} | 1927 | @vindex viper-want-ctl-h-help |
| 1928 | @vindex @code{viper-vi-style-in-minibuffer} | 1928 | @vindex viper-vi-style-in-minibuffer |
| 1929 | @vindex @code{viper-no-multiple-ESC} | 1929 | @vindex viper-no-multiple-ESC |
| 1930 | @vindex @code{viper-always} | 1930 | @vindex viper-always |
| 1931 | @vindex @code{viper-fast-keyseq-timeout} | 1931 | @vindex viper-fast-keyseq-timeout |
| 1932 | @vindex @code{viper-ex-style-motion} | 1932 | @vindex viper-ex-style-motion |
| 1933 | @vindex @code{viper-ex-style-editing} | 1933 | @vindex viper-ex-style-editing |
| 1934 | @vindex @code{viper-ESC-moves-cursor-back} | 1934 | @vindex viper-ESC-moves-cursor-back |
| 1935 | @vindex @code{viper-custom-file-name} | 1935 | @vindex viper-custom-file-name |
| 1936 | @vindex @code{viper-spell-function} | 1936 | @vindex viper-spell-function |
| 1937 | @vindex @code{ex-cycle-other-window} | 1937 | @vindex ex-cycle-other-window |
| 1938 | @vindex @code{ex-cycle-through-non-files} | 1938 | @vindex ex-cycle-through-non-files |
| 1939 | @vindex @code{viper-want-emacs-keys-in-insert} | 1939 | @vindex viper-want-emacs-keys-in-insert |
| 1940 | @vindex @code{viper-want-emacs-keys-in-vi} | 1940 | @vindex viper-want-emacs-keys-in-vi |
| 1941 | @vindex @code{viper-keep-point-on-repeat} | 1941 | @vindex viper-keep-point-on-repeat |
| 1942 | @vindex @code{viper-keep-point-on-undo} | 1942 | @vindex viper-keep-point-on-undo |
| 1943 | @vindex @code{viper-delete-backwards-in-replace} | 1943 | @vindex viper-delete-backwards-in-replace |
| 1944 | @vindex @code{viper-replace-overlay-face} | 1944 | @vindex viper-replace-overlay-face |
| 1945 | @vindex @code{viper-replace-region-end-symbol} | 1945 | @vindex viper-replace-region-end-symbol |
| 1946 | @vindex @code{viper-replace-region-start-symbol} | 1946 | @vindex viper-replace-region-start-symbol |
| 1947 | @vindex @code{viper-allow-multiline-replace-regions} | 1947 | @vindex viper-allow-multiline-replace-regions |
| 1948 | @vindex @code{viper-toggle-key} | 1948 | @vindex viper-toggle-key |
| 1949 | @vindex @code{viper-buffer-search-char} | 1949 | @vindex viper-buffer-search-char |
| 1950 | @vindex @code{viper-surrounding-word-function} | 1950 | @vindex viper-surrounding-word-function |
| 1951 | @vindex @code{viper-vi-state-hook} | 1951 | @vindex viper-vi-state-hook |
| 1952 | @vindex @code{viper-insert-state-hook} | 1952 | @vindex viper-insert-state-hook |
| 1953 | @vindex @code{viper-replace-state-hook} | 1953 | @vindex viper-replace-state-hook |
| 1954 | @vindex @code{viper-emacs-state-hook} | 1954 | @vindex viper-emacs-state-hook |
| 1955 | 1955 | ||
| 1956 | @node Key Bindings | 1956 | @node Key Bindings |
| 1957 | @section Key Bindings | 1957 | @section Key Bindings |
| @@ -2059,7 +2059,7 @@ Viper users can also change bindings on a per major mode basis. As with | |||
| 2059 | global bindings, this can be done separately for each of the three main Viper | 2059 | global bindings, this can be done separately for each of the three main Viper |
| 2060 | states. To this end, Viper provides the function | 2060 | states. To this end, Viper provides the function |
| 2061 | @code{viper-modify-major-mode}. | 2061 | @code{viper-modify-major-mode}. |
| 2062 | @findex @code{viper-modify-major-mode} | 2062 | @findex viper-modify-major-mode |
| 2063 | 2063 | ||
| 2064 | To modify keys in Emacs state for @code{my-favorite-major-mode}, the user | 2064 | To modify keys in Emacs state for @code{my-favorite-major-mode}, the user |
| 2065 | needs to create a sparse keymap, say, @code{my-fancy-map}, bind whatever | 2065 | needs to create a sparse keymap, say, @code{my-fancy-map}, bind whatever |
| @@ -2099,7 +2099,7 @@ Dired functions, the trick can be accomplished via the following code: | |||
| 2099 | 2099 | ||
| 2100 | Yet another way to customize key bindings in a major mode is to edit the | 2100 | Yet another way to customize key bindings in a major mode is to edit the |
| 2101 | list @code{viper-major-mode-modifier-list} using the customization widget. | 2101 | list @code{viper-major-mode-modifier-list} using the customization widget. |
| 2102 | @vindex @code{viper-major-mode-modifier-list} | 2102 | @vindex viper-major-mode-modifier-list |
| 2103 | (This variable is in the Viper-misc customization group.) | 2103 | (This variable is in the Viper-misc customization group.) |
| 2104 | The elements of this list are triples of the form: (major-mode viper-state | 2104 | The elements of this list are triples of the form: (major-mode viper-state |
| 2105 | keymap), where the keymap contains bindings that are supposed to be active | 2105 | keymap), where the keymap contains bindings that are supposed to be active |
| @@ -2184,13 +2184,13 @@ So much about Viper-specific bindings. | |||
| 2184 | Manual}, and the Emacs quick reference card for the general info on key | 2184 | Manual}, and the Emacs quick reference card for the general info on key |
| 2185 | bindings in Emacs. | 2185 | bindings in Emacs. |
| 2186 | 2186 | ||
| 2187 | @vindex @code{input-decode-map} | 2187 | @vindex input-decode-map |
| 2188 | @vindex @code{function-key-map} | 2188 | @vindex function-key-map |
| 2189 | @vindex @code{viper-vi-global-user-map} | 2189 | @vindex viper-vi-global-user-map |
| 2190 | @vindex @code{viper-insert-global-user-map} | 2190 | @vindex viper-insert-global-user-map |
| 2191 | @vindex @code{viper-emacs-global-user-map} | 2191 | @vindex viper-emacs-global-user-map |
| 2192 | @findex @code{viper-add-local-keys} | 2192 | @findex viper-add-local-keys |
| 2193 | @findex @code{viper-zap-local-keys} | 2193 | @findex viper-zap-local-keys |
| 2194 | 2194 | ||
| 2195 | @node Packages that Change Keymaps | 2195 | @node Packages that Change Keymaps |
| 2196 | @section Packages that Change Keymaps | 2196 | @section Packages that Change Keymaps |
| @@ -2261,9 +2261,9 @@ on the @code{viper-emacs-state-mode-list} list and delete them from | |||
| 2261 | @code{viper-vi-state-mode-list}. | 2261 | @code{viper-vi-state-mode-list}. |
| 2262 | Likewise, you can force Viper's Insert state on a major mode by putting it | 2262 | Likewise, you can force Viper's Insert state on a major mode by putting it |
| 2263 | in @code{viper-insert-state-mode-list}. | 2263 | in @code{viper-insert-state-mode-list}. |
| 2264 | @vindex @code{viper-emacs-state-mode-list} | 2264 | @vindex viper-emacs-state-mode-list |
| 2265 | @vindex @code{viper-insert-state-mode-list} | 2265 | @vindex viper-insert-state-mode-list |
| 2266 | @vindex @code{viper-vi-state-mode-list} | 2266 | @vindex viper-vi-state-mode-list |
| 2267 | 2267 | ||
| 2268 | It is also possible to impose Vi on some major modes, even though they may | 2268 | It is also possible to impose Vi on some major modes, even though they may |
| 2269 | bind common keys to specialized commands. This might make sense for modes | 2269 | bind common keys to specialized commands. This might make sense for modes |
| @@ -2312,14 +2312,14 @@ compatible with Viper is to have the file @file{my-mode.el} include the followin | |||
| 2312 | (viper-harness-minor-mode lib))) | 2312 | (viper-harness-minor-mode lib))) |
| 2313 | @end lisp | 2313 | @end lisp |
| 2314 | 2314 | ||
| 2315 | @vindex @code{viper-want-emacs-keys-in-vi} | 2315 | @vindex viper-want-emacs-keys-in-vi |
| 2316 | @vindex @code{viper-want-emacs-keys-in-insert} | 2316 | @vindex viper-want-emacs-keys-in-insert |
| 2317 | @vindex @code{viper-always} | 2317 | @vindex viper-always |
| 2318 | @findex @code{viper-set-hooks} | 2318 | @findex viper-set-hooks |
| 2319 | @findex @code{viper-mode} | 2319 | @findex viper-mode |
| 2320 | @findex @code{viper-harness-minor-mode} | 2320 | @findex viper-harness-minor-mode |
| 2321 | @findex @code{remove-hook} | 2321 | @findex remove-hook |
| 2322 | @findex @code{add-hook} | 2322 | @findex add-hook |
| 2323 | 2323 | ||
| 2324 | @node Viper Specials | 2324 | @node Viper Specials |
| 2325 | @section Viper Specials | 2325 | @section Viper Specials |
| @@ -2339,8 +2339,8 @@ sets @code{viper-buffer-search-char} to @kbd{g}. Alternatively, the user can | |||
| 2339 | set @code{viper-buffer-search-char} in his/her Viper customization file to a key | 2339 | set @code{viper-buffer-search-char} in his/her Viper customization file to a key |
| 2340 | sequence to be used for buffer search. There is no need to call | 2340 | sequence to be used for buffer search. There is no need to call |
| 2341 | @code{viper-buffer-search-enable} in that case. | 2341 | @code{viper-buffer-search-enable} in that case. |
| 2342 | @findex @code{viper-buffer-search-enable} | 2342 | @findex viper-buffer-search-enable |
| 2343 | @vindex @code{viper-buffer-search-char} | 2343 | @vindex viper-buffer-search-char |
| 2344 | @item viper-toggle-search-style | 2344 | @item viper-toggle-search-style |
| 2345 | This function, bound to @kbd{C-c /}, lets one toggle case-sensitive and | 2345 | This function, bound to @kbd{C-c /}, lets one toggle case-sensitive and |
| 2346 | case-insensitive search, and also switch between plain vanilla search and | 2346 | case-insensitive search, and also switch between plain vanilla search and |
| @@ -2365,7 +2365,7 @@ feature, put this in the file: | |||
| 2365 | @example | 2365 | @example |
| 2366 | (viper-set-searchstyle-toggling-macros 'undefine) | 2366 | (viper-set-searchstyle-toggling-macros 'undefine) |
| 2367 | @end example | 2367 | @end example |
| 2368 | @findex @code{viper-set-searchstyle-toggling-macros} | 2368 | @findex viper-set-searchstyle-toggling-macros |
| 2369 | 2369 | ||
| 2370 | If you don't like this feature as a default, but would still like to have | 2370 | If you don't like this feature as a default, but would still like to have |
| 2371 | it in some major modes, you can do so by first unsetting it globally, as | 2371 | it in some major modes, you can do so by first unsetting it globally, as |
| @@ -2389,8 +2389,8 @@ case-insensitivity and regexp-search. | |||
| 2389 | If you don't like these features---which I don't really understand---you | 2389 | If you don't like these features---which I don't really understand---you |
| 2390 | can unbind @kbd{/} and @kbd{:} in @code{viper-dired-modifier-map} (for | 2390 | can unbind @kbd{/} and @kbd{:} in @code{viper-dired-modifier-map} (for |
| 2391 | Dired) or in @code{viper-slash-and-colon-map}, for other modes. | 2391 | Dired) or in @code{viper-slash-and-colon-map}, for other modes. |
| 2392 | @vindex @code{viper-slash-and-colon-map} | 2392 | @vindex viper-slash-and-colon-map |
| 2393 | @vindex @code{viper-dired-modifier-map} | 2393 | @vindex viper-dired-modifier-map |
| 2394 | 2394 | ||
| 2395 | To unbind the macros @kbd{//} and @kbd{///} for a major mode where you | 2395 | To unbind the macros @kbd{//} and @kbd{///} for a major mode where you |
| 2396 | feel they | 2396 | feel they |
| @@ -2400,7 +2400,7 @@ prefix argument, or by placing | |||
| 2400 | @example | 2400 | @example |
| 2401 | (viper-set-emacs-state-searchstyle-macros 'undefine) | 2401 | (viper-set-emacs-state-searchstyle-macros 'undefine) |
| 2402 | @end example | 2402 | @end example |
| 2403 | @findex @code{viper-set-emacs-state-searchstyle-macros} | 2403 | @findex viper-set-emacs-state-searchstyle-macros |
| 2404 | in the hook to the major mode (e.g., @code{dired-mode-hook}). | 2404 | in the hook to the major mode (e.g., @code{dired-mode-hook}). |
| 2405 | @xref{Vi Macros}, for more information on Vi macros. | 2405 | @xref{Vi Macros}, for more information on Vi macros. |
| 2406 | 2406 | ||
| @@ -2414,10 +2414,10 @@ Regular Expressions for @kbd{[[} and @kbd{]]}. Note that Emacs defines | |||
| 2414 | Regexps for paragraphs and sentences. @xref{Paragraphs,,Paragraphs and | 2414 | Regexps for paragraphs and sentences. @xref{Paragraphs,,Paragraphs and |
| 2415 | Sentences,emacs,The GNU Emacs Manual}, for details. | 2415 | Sentences,emacs,The GNU Emacs Manual}, for details. |
| 2416 | @item M-x viper-set-expert-level | 2416 | @item M-x viper-set-expert-level |
| 2417 | @findex @code{viper-set-expert-level} | 2417 | @findex viper-set-expert-level |
| 2418 | Change your user level interactively. | 2418 | Change your user level interactively. |
| 2419 | @item viper-smart-suffix-list '("" "tex" "c" "cc" "el" "p") | 2419 | @item viper-smart-suffix-list '("" "tex" "c" "cc" "el" "p") |
| 2420 | @vindex @code{viper-smart-suffix-list} | 2420 | @vindex viper-smart-suffix-list |
| 2421 | Viper supports Emacs-style file completion when it prompts the user for a | 2421 | Viper supports Emacs-style file completion when it prompts the user for a |
| 2422 | file name. However, in many cases, the same directory may contain files | 2422 | file name. However, in many cases, the same directory may contain files |
| 2423 | with identical prefix but different suffixes, e.g., prog.c, prog.o, | 2423 | with identical prefix but different suffixes, e.g., prog.c, prog.o, |
| @@ -2437,7 +2437,7 @@ the intended file name, hitting return will accept it. | |||
| 2437 | To turn this feature off, set the above variable to @code{nil}. | 2437 | To turn this feature off, set the above variable to @code{nil}. |
| 2438 | 2438 | ||
| 2439 | @item viper-insertion-ring-size 14 | 2439 | @item viper-insertion-ring-size 14 |
| 2440 | @vindex @code{viper-insertion-ring-size} | 2440 | @vindex viper-insertion-ring-size |
| 2441 | @cindex Insertion ring | 2441 | @cindex Insertion ring |
| 2442 | Viper remembers what was previously inserted in Insert and Replace states. | 2442 | Viper remembers what was previously inserted in Insert and Replace states. |
| 2443 | Several such recent insertions are kept in a special ring of strings of size | 2443 | Several such recent insertions are kept in a special ring of strings of size |
| @@ -2470,7 +2470,7 @@ this will interfere with the minibuffer histories and, possibly, other | |||
| 2470 | major modes. | 2470 | major modes. |
| 2471 | 2471 | ||
| 2472 | @item viper-command-ring-size 14 | 2472 | @item viper-command-ring-size 14 |
| 2473 | @vindex @code{viper-command-ring-size} | 2473 | @vindex viper-command-ring-size |
| 2474 | @cindex Destructive command ring | 2474 | @cindex Destructive command ring |
| 2475 | @cindex Destructive command history | 2475 | @cindex Destructive command history |
| 2476 | Viper keeps track of the recent history of destructive | 2476 | Viper keeps track of the recent history of destructive |
| @@ -2527,11 +2527,11 @@ indication of the current Viper state in the minibuffer. (This is important | |||
| 2527 | if the user accidentally switches to another Viper state by typing @key{ESC} or | 2527 | if the user accidentally switches to another Viper state by typing @key{ESC} or |
| 2528 | @kbd{C-z}). | 2528 | @kbd{C-z}). |
| 2529 | @item M-x viper-go-away | 2529 | @item M-x viper-go-away |
| 2530 | @findex @code{viper-go-away} | 2530 | @findex viper-go-away |
| 2531 | Make Viper disappear from the face of your running Emacs instance. If your | 2531 | Make Viper disappear from the face of your running Emacs instance. If your |
| 2532 | fingers start aching again, @kbd{M-x viper-mode} might save your day. | 2532 | fingers start aching again, @kbd{M-x viper-mode} might save your day. |
| 2533 | @item M-x toggle-viper-mode | 2533 | @item M-x toggle-viper-mode |
| 2534 | @findex @code{toggle-viper-mode} | 2534 | @findex toggle-viper-mode |
| 2535 | Toggle Viperization of Emacs on and off. | 2535 | Toggle Viperization of Emacs on and off. |
| 2536 | @end table | 2536 | @end table |
| 2537 | 2537 | ||
| @@ -2581,7 +2581,7 @@ is available). Clicking the mouse when Emacs is invoked in an Xterm window | |||
| 2581 | @cindex mouse | 2581 | @cindex mouse |
| 2582 | @cindex mouse-search | 2582 | @cindex mouse-search |
| 2583 | @item viper-mouse-search-key (meta shift 1) | 2583 | @item viper-mouse-search-key (meta shift 1) |
| 2584 | @vindex @code{viper-mouse-insert-key} | 2584 | @vindex viper-mouse-insert-key |
| 2585 | This variable controls the @emph{mouse-search} feature of Viper. The | 2585 | This variable controls the @emph{mouse-search} feature of Viper. The |
| 2586 | default value | 2586 | default value |
| 2587 | states that holding Meta and Shift keys while clicking mouse button 1 | 2587 | states that holding Meta and Shift keys while clicking mouse button 1 |
| @@ -2636,7 +2636,7 @@ occurred with all leading and trailing spaces and tabs removed. | |||
| 2636 | 2636 | ||
| 2637 | @cindex mouse-insert | 2637 | @cindex mouse-insert |
| 2638 | @item viper-mouse-insert-key (meta shift 2) | 2638 | @item viper-mouse-insert-key (meta shift 2) |
| 2639 | @vindex @code{viper-mouse-insert-key} | 2639 | @vindex viper-mouse-insert-key |
| 2640 | This variable controls the @emph{mouse-insert} feature of Viper. | 2640 | This variable controls the @emph{mouse-insert} feature of Viper. |
| 2641 | The above default value states that | 2641 | The above default value states that |
| 2642 | holding Meta and Shift keys while clicking mouse button 2 | 2642 | holding Meta and Shift keys while clicking mouse button 2 |
| @@ -2673,9 +2673,9 @@ purpose of mouse search and mouse insert. By default, this is set to | |||
| 2673 | @kindex @kbd{S-mouse-2} | 2673 | @kindex @kbd{S-mouse-2} |
| 2674 | @kindex @kbd{meta shift button1up} | 2674 | @kindex @kbd{meta shift button1up} |
| 2675 | @kindex @kbd{meta shift button2up} | 2675 | @kindex @kbd{meta shift button2up} |
| 2676 | @vindex @code{viper-multiclick-timeout} | 2676 | @vindex viper-multiclick-timeout |
| 2677 | @findex @code{viper-mouse-click-insert-word} | 2677 | @findex viper-mouse-click-insert-word |
| 2678 | @findex @code{viper-mouse-click-search-word} | 2678 | @findex viper-mouse-click-search-word |
| 2679 | 2679 | ||
| 2680 | Note: The above functions search and insert in the selected window of | 2680 | Note: The above functions search and insert in the selected window of |
| 2681 | the latest active frame. This means that you can click in another window or | 2681 | the latest active frame. This means that you can click in another window or |
| @@ -2852,7 +2852,7 @@ The latter is more powerful, since it can delete macros even in | |||
| 2852 | needed only when the user needs to get rid of the macros that are already | 2852 | needed only when the user needs to get rid of the macros that are already |
| 2853 | predefined in Viper. | 2853 | predefined in Viper. |
| 2854 | The syntax is: | 2854 | The syntax is: |
| 2855 | @findex @code{viper-unrecord-kbd-macro} | 2855 | @findex viper-unrecord-kbd-macro |
| 2856 | @example | 2856 | @example |
| 2857 | (viper-unrecord-kbd-macro macro state) | 2857 | (viper-unrecord-kbd-macro macro state) |
| 2858 | @end example | 2858 | @end example |
| @@ -2992,7 +2992,7 @@ keys have to be redefined for TTY's (and possibly for every type of TTY you | |||
| 2992 | may be using). To do this, start Emacs on an appropriate TTY device and | 2992 | may be using). To do this, start Emacs on an appropriate TTY device and |
| 2993 | define the macro using @kbd{:map}, as usual. | 2993 | define the macro using @kbd{:map}, as usual. |
| 2994 | 2994 | ||
| 2995 | @findex @code{viper-describe-kbd-macros} | 2995 | @findex viper-describe-kbd-macros |
| 2996 | Finally, Viper provides a function that conveniently displays all macros | 2996 | Finally, Viper provides a function that conveniently displays all macros |
| 2997 | currently defined. To see all macros along with their definitions, type | 2997 | currently defined. To see all macros along with their definitions, type |
| 2998 | @kbd{M-x viper-describe-kbd-macros}. | 2998 | @kbd{M-x viper-describe-kbd-macros}. |
| @@ -3199,8 +3199,8 @@ modes, you should execute, for example, | |||
| 3199 | 3199 | ||
| 3200 | in the appropriate major mode hooks. | 3200 | in the appropriate major mode hooks. |
| 3201 | 3201 | ||
| 3202 | @vindex @code{viper-syntax-preference} | 3202 | @vindex viper-syntax-preference |
| 3203 | @findex @code{viper-set-syntax-preference} | 3203 | @findex viper-set-syntax-preference |
| 3204 | @cindex syntax table | 3204 | @cindex syntax table |
| 3205 | 3205 | ||
| 3206 | 3206 | ||
| @@ -3378,7 +3378,7 @@ don't want this macro, put | |||
| 3378 | @example | 3378 | @example |
| 3379 | (viper-set-parsing-style-toggling-macro 'undefine) | 3379 | (viper-set-parsing-style-toggling-macro 'undefine) |
| 3380 | @end example | 3380 | @end example |
| 3381 | @findex @code{viper-set-parsing-style-toggling-macro} | 3381 | @findex viper-set-parsing-style-toggling-macro |
| 3382 | 3382 | ||
| 3383 | in your Viper customization file. | 3383 | in your Viper customization file. |
| 3384 | 3384 | ||
| @@ -3437,7 +3437,7 @@ in your Viper customization file. | |||
| 3437 | @kindex @kbd{j} | 3437 | @kindex @kbd{j} |
| 3438 | @kindex @kbd{k} | 3438 | @kindex @kbd{k} |
| 3439 | @kindex @kbd{l} | 3439 | @kindex @kbd{l} |
| 3440 | @vindex @code{viper-parse-sexp-ignore-comments} | 3440 | @vindex viper-parse-sexp-ignore-comments |
| 3441 | 3441 | ||
| 3442 | @node Marking | 3442 | @node Marking |
| 3443 | @subsection Marking | 3443 | @subsection Marking |
| @@ -4061,7 +4061,7 @@ List files not shown anywhere with counts for next | |||
| 4061 | Edit <count> file, or edit files. The count comes from @kbd{:args}. | 4061 | Edit <count> file, or edit files. The count comes from @kbd{:args}. |
| 4062 | @item :N [count] [+<cmd>] [<files>] | 4062 | @item :N [count] [+<cmd>] [<files>] |
| 4063 | Like @kbd{:n}, but the meaning of the variable | 4063 | Like @kbd{:n}, but the meaning of the variable |
| 4064 | @var{ex-cycle-other-window} is reversed. | 4064 | @code{ex-cycle-other-window} is reversed. |
| 4065 | @item :b | 4065 | @item :b |
| 4066 | Switch to another buffer. If @code{ex-cycle-other-window} is @code{t}, | 4066 | Switch to another buffer. If @code{ex-cycle-other-window} is @code{t}, |
| 4067 | switch in another window. Buffer completion is supported. | 4067 | switch in another window. Buffer completion is supported. |
| @@ -4069,7 +4069,7 @@ The variable @code{viper-read-buffer-function} controls which function is | |||
| 4069 | actually used to read the buffer name. The default is @code{read-buffer}, | 4069 | actually used to read the buffer name. The default is @code{read-buffer}, |
| 4070 | but better alternatives are also available in Emacs (e.g., | 4070 | but better alternatives are also available in Emacs (e.g., |
| 4071 | @code{ido-read-buffer}). | 4071 | @code{ido-read-buffer}). |
| 4072 | @vindex @var{viper-read-buffer-function} | 4072 | @vindex viper-read-buffer-function |
| 4073 | @item :B | 4073 | @item :B |
| 4074 | Like @kbd{:b}, but the meaning of @code{ex-cycle-other-window} is reversed. | 4074 | Like @kbd{:b}, but the meaning of @code{ex-cycle-other-window} is reversed. |
| 4075 | @item :<address>r <name> | 4075 | @item :<address>r <name> |
diff --git a/lisp/international/mule.el b/lisp/international/mule.el index 3be1e9e2877..a5e7477e758 100644 --- a/lisp/international/mule.el +++ b/lisp/international/mule.el | |||
| @@ -1492,7 +1492,7 @@ If you set this on a terminal which can't distinguish Meta keys from | |||
| 1492 | 8-bit characters, you will have to use ESC to type Meta characters. | 1492 | 8-bit characters, you will have to use ESC to type Meta characters. |
| 1493 | See Info node `Terminal Coding' and Info node `Unibyte Mode'. | 1493 | See Info node `Terminal Coding' and Info node `Unibyte Mode'. |
| 1494 | 1494 | ||
| 1495 | On non-windowing terminals, this is set from the locale by default. | 1495 | This is set at startup based on the locale. |
| 1496 | 1496 | ||
| 1497 | Setting this variable directly does not take effect; | 1497 | Setting this variable directly does not take effect; |
| 1498 | use either \\[customize] or \\[set-keyboard-coding-system]." | 1498 | use either \\[customize] or \\[set-keyboard-coding-system]." |
diff --git a/src/keyboard.c b/src/keyboard.c index 75fbe459b2b..9b8d275d0fd 100644 --- a/src/keyboard.c +++ b/src/keyboard.c | |||
| @@ -11735,8 +11735,9 @@ immediately after running `post-command-hook'. */); | |||
| 11735 | 11735 | ||
| 11736 | DEFVAR_LISP ("input-method-function", Vinput_method_function, | 11736 | DEFVAR_LISP ("input-method-function", Vinput_method_function, |
| 11737 | doc: /* If non-nil, the function that implements the current input method. | 11737 | doc: /* If non-nil, the function that implements the current input method. |
| 11738 | It's called with one argument, a printing character that was just read. | 11738 | It's called with one argument, which must be a single-byte |
| 11739 | \(That means a character with code 040...0176.) | 11739 | character that was just read. Any single-byte character is |
| 11740 | acceptable, except the DEL character, codepoint 127 decimal, 177 octal. | ||
| 11740 | Typically this function uses `read-event' to read additional events. | 11741 | Typically this function uses `read-event' to read additional events. |
| 11741 | When it does so, it should first bind `input-method-function' to nil | 11742 | When it does so, it should first bind `input-method-function' to nil |
| 11742 | so it will not be called recursively. | 11743 | so it will not be called recursively. |