Mercurial > emacs
changeset 100171:d42aff5ca541
* align.el:
* allout.el:
* apropos.el:
* arc-mode.el:
* autoinsert.el:
* avoid.el:
* battery.el:
* bookmark.el:
* buff-menu.el:
* calculator.el:
* chistory.el:
* cmuscheme.el:
* comint.el:
* compare-w.el:
* dabbrev.el:
* delim-col.el:
* desktop.el:
* diff-mode.el:
* diff.el:
* dired-aux.el:
* dired-x.el:
* dired.el:
* dos-vars.el:
* ediff-diff.el:
* ediff-help.el:
* ediff-init.el:
* ediff-merg.el:
* ediff-mult.el:
* ediff-ptch.el:
* ediff-vers.el:
* ediff-wind.el:
* ediff.el:
* emerge.el:
* facemenu.el:
* faces.el:
* ffap.el:
* filecache.el:
* find-dired.el:
* font-core.el:
* font-lock.el:
* forms.el:
* fringe.el:
* help-at-pt.el:
* hippie-exp.el:
* ido.el:
* image-file.el:
* imenu.el:
* indent.el:
* info.el:
* isearchb.el:
* iswitchb.el:
* jit-lock.el:
* jka-compr.el:
* log-edit.el:
* lpr.el:
* ls-lisp.el:
* man.el:
* menu-bar.el:
* midnight.el:
* mouse-sel.el:
* mouse.el:
* msb.el:
* outline.el:
* paren.el:
* pcmpl-cvs.el:
* pcmpl-gnu.el:
* pcomplete.el:
* pcvs-info.el:
* pcvs-parse.el:
* printing.el:
* ps-mule.el:
* ps-print.el:
* replace.el:
* ruler-mode.el:
* saveplace.el:
* sb-image.el:
* scroll-bar.el:
* sha1.el:
* shadowfile.el:
* shell.el:
* sort.el:
* speedbar.el:
* strokes.el:
* tempo.el:
* term.el:
* terminal.el:
* time-stamp.el:
* time.el:
* tree-widget.el:
* type-break.el:
* vc-cvs.el:
* vc-hg.el:
* vc-mcvs.el:
* vc-rcs.el:
* vc-sccs.el:
* vc.el:
* view.el:
* w32-vars.el:
* whitespace.el:
* wid-edit.el: Remove leading * from docstrings of defcustoms,
deffaces, defconsts and defuns.
line wrap: on
line diff
--- a/lisp/ChangeLog Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ChangeLog Wed Dec 03 05:48:14 2008 +0000 @@ -1,3 +1,107 @@ +2008-12-03 Lute Kamstra <lute@gnu.org> + + * align.el: + * allout.el: + * apropos.el: + * arc-mode.el: + * autoinsert.el: + * avoid.el: + * battery.el: + * bookmark.el: + * buff-menu.el: + * calculator.el: + * chistory.el: + * cmuscheme.el: + * comint.el: + * compare-w.el: + * dabbrev.el: + * delim-col.el: + * desktop.el: + * diff-mode.el: + * diff.el: + * dired-aux.el: + * dired-x.el: + * dired.el: + * dos-vars.el: + * ediff-diff.el: + * ediff-help.el: + * ediff-init.el: + * ediff-merg.el: + * ediff-mult.el: + * ediff-ptch.el: + * ediff-vers.el: + * ediff-wind.el: + * ediff.el: + * emerge.el: + * facemenu.el: + * faces.el: + * ffap.el: + * filecache.el: + * find-dired.el: + * font-core.el: + * font-lock.el: + * forms.el: + * fringe.el: + * help-at-pt.el: + * hippie-exp.el: + * ido.el: + * image-file.el: + * imenu.el: + * indent.el: + * info.el: + * isearchb.el: + * iswitchb.el: + * jit-lock.el: + * jka-compr.el: + * log-edit.el: + * lpr.el: + * ls-lisp.el: + * man.el: + * menu-bar.el: + * midnight.el: + * mouse-sel.el: + * mouse.el: + * msb.el: + * outline.el: + * paren.el: + * pcmpl-cvs.el: + * pcmpl-gnu.el: + * pcomplete.el: + * pcvs-info.el: + * pcvs-parse.el: + * printing.el: + * ps-mule.el: + * ps-print.el: + * replace.el: + * ruler-mode.el: + * saveplace.el: + * sb-image.el: + * scroll-bar.el: + * sha1.el: + * shadowfile.el: + * shell.el: + * sort.el: + * speedbar.el: + * strokes.el: + * tempo.el: + * term.el: + * terminal.el: + * time-stamp.el: + * time.el: + * tree-widget.el: + * type-break.el: + * vc-cvs.el: + * vc-hg.el: + * vc-mcvs.el: + * vc-rcs.el: + * vc-sccs.el: + * vc.el: + * view.el: + * w32-vars.el: + * whitespace.el: + * wid-edit.el: Remove leading * from docstrings of defcustoms, + deffaces, defconsts and defuns. + 2008-12-02 Stefan Monnier <monnier@iro.umontreal.ca> * complete.el (PC-do-completion): Fix leftover bug from Emacs-21 when
--- a/lisp/align.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/align.el Wed Dec 03 05:48:14 2008 +0000 @@ -3,7 +3,7 @@ ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc. -;; Author: John Wiegley <johnw@gnu.org> +;; Author: John Wiegley <johnw@gnu.org> ;; Maintainer: FSF ;; Keywords: convenience languages lisp @@ -127,17 +127,17 @@ ;;; User Variables: (defcustom align-load-hook nil - "*Hook that gets run after the aligner has been loaded." + "Hook that gets run after the aligner has been loaded." :type 'hook :group 'align) (defcustom align-indent-before-aligning nil - "*If non-nil, indent the marked region before aligning it." + "If non-nil, indent the marked region before aligning it." :type 'boolean :group 'align) (defcustom align-default-spacing 1 - "*An integer that represents the default amount of padding to use. + "An integer that represents the default amount of padding to use. If `align-to-tab-stop' is non-nil, this will represent the number of tab stops to use for alignment, rather than the number of spaces. Each alignment rule can optionally override both this variable. See @@ -146,13 +146,13 @@ :group 'align) (defcustom align-to-tab-stop 'indent-tabs-mode - "*If non-nil, alignments will always fall on a tab boundary. + "If non-nil, alignments will always fall on a tab boundary. It may also be a symbol, whose value will be taken." :type '(choice (const nil) symbol) :group 'align) (defcustom align-region-heuristic 500 - "*If non-nil, used as a heuristic by `align-current'. + "If non-nil, used as a heuristic by `align-current'. Since each alignment rule can possibly have its own set of alignment sections (whenever `align-region-separate' is non-nil, and not a string), this heuristic is used to determine how far before and after @@ -163,72 +163,72 @@ :group 'align) (defcustom align-highlight-change-face 'highlight - "*The face to highlight with if changes are necessary." + "The face to highlight with if changes are necessary." :type 'face :group 'align) (defcustom align-highlight-nochange-face 'secondary-selection - "*The face to highlight with if no changes are necessary." + "The face to highlight with if no changes are necessary." :type 'face :group 'align) (defcustom align-large-region 10000 - "*If an integer, defines what constitutes a \"large\" region. + "If an integer, defines what constitutes a \"large\" region. If nil,then no messages will ever be printed to the minibuffer." :type 'integer :group 'align) (defcustom align-c++-modes '(c++-mode c-mode java-mode) - "*A list of modes whose syntax resembles C/C++." + "A list of modes whose syntax resembles C/C++." :type '(repeat symbol) :group 'align) (defcustom align-perl-modes '(perl-mode cperl-mode) - "*A list of modes where perl syntax is to be seen." + "A list of modes where perl syntax is to be seen." :type '(repeat symbol) :group 'align) (defcustom align-lisp-modes '(emacs-lisp-mode lisp-interaction-mode lisp-mode scheme-mode) - "*A list of modes whose syntax resembles Lisp." + "A list of modes whose syntax resembles Lisp." :type '(repeat symbol) :group 'align) (defcustom align-tex-modes '(tex-mode plain-tex-mode latex-mode slitex-mode) - "*A list of modes whose syntax resembles TeX (and family)." + "A list of modes whose syntax resembles TeX (and family)." :type '(repeat symbol) :group 'align) (defcustom align-text-modes '(text-mode outline-mode) - "*A list of modes whose content is plain text." + "A list of modes whose content is plain text." :type '(repeat symbol) :group 'align) (defcustom align-dq-string-modes (append align-lisp-modes align-c++-modes align-perl-modes '(python-mode)) - "*A list of modes where double quoted strings should be excluded." + "A list of modes where double quoted strings should be excluded." :type '(repeat symbol) :group 'align) (defcustom align-sq-string-modes (append align-perl-modes '(python-mode)) - "*A list of modes where single quoted strings should be excluded." + "A list of modes where single quoted strings should be excluded." :type '(repeat symbol) :group 'align) (defcustom align-open-comment-modes (append align-lisp-modes align-c++-modes align-perl-modes '(python-mode makefile-mode)) - "*A list of modes with a single-line comment syntax. + "A list of modes with a single-line comment syntax. These are comments as in Lisp, which have a beginning but, end with the line (i.e., `comment-end' is an empty string)." :type '(repeat symbol) :group 'align) (defcustom align-region-separate "^\\s-*[{}]?\\s-*$" - "*Select the method by which alignment sections will be separated. + "Select the method by which alignment sections will be separated. If this is a symbol, that symbol's value will be used. For the sake of clarification, consider the following example, which @@ -581,7 +581,7 @@ (regexp . "^\\s-*\\w+:\\(\\s-*\\).*;") (group . (1)) (modes . '(css-mode html-mode)))) - "*A list describing all of the available alignment rules. + "A list describing all of the available alignment rules. The format is: ((TITLE @@ -779,7 +779,7 @@ (regexp . "^\\s-*#\\s-*\\(if\\w*\\|endif\\)\\(.*\\)$") (group . 2) (modes . align-c++-modes))) - "*A list describing text that should be excluded from alignment. + "A list describing text that should be excluded from alignment. See the documentation for `align-rules-list' for more info." :type align-exclude-rules-list-type :group 'align) @@ -837,7 +837,7 @@ (use-entity (regexp . "\\(\\s-+\\)use\\s-+entity"))) - "*Alignment rules for `vhdl-mode'. See `align-rules-list' for more info." + "Alignment rules for `vhdl-mode'. See `align-rules-list' for more info." :type align-rules-list-type :group 'align)
--- a/lisp/allout.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/allout.el Wed Dec 03 05:48:14 2008 +0000 @@ -109,7 +109,7 @@ ;;;_ = allout-command-prefix (defcustom allout-command-prefix "\C-c " - "*Key sequence to be used as prefix for outline mode command key bindings. + "Key sequence to be used as prefix for outline mode command key bindings. Default is '\C-c<space>'; just '\C-c' is more short-and-sweet, if you're willing to let allout use a bunch of \C-c keybindings." @@ -168,7 +168,7 @@ ;;;_ = allout-auto-activation (defcustom allout-auto-activation nil - "*Regulates auto-activation modality of allout outlines -- see `allout-init'. + "Regulates auto-activation modality of allout outlines -- see `allout-init'. Setq-default by `allout-init' to regulate whether or not allout outline mode is automatically activated when the buffer-specific @@ -197,7 +197,7 @@ :group 'allout) ;;;_ = allout-default-layout (defcustom allout-default-layout '(-2 : 0) - "*Default allout outline layout specification. + "Default allout outline layout specification. This setting specifies the outline exposure to use when `allout-layout' has the local value `t'. This docstring describes the @@ -263,7 +263,7 @@ ;;;_ = allout-inhibit-auto-fill (defcustom allout-inhibit-auto-fill nil - "*If non-nil, auto-fill will be inhibited in the allout buffers. + "If non-nil, auto-fill will be inhibited in the allout buffers. You can customize this setting to set it for all allout buffers, or set it in individual buffers if you want to inhibit auto-fill only in particular @@ -279,7 +279,7 @@ (make-variable-buffer-local 'allout-inhibit-auto-fill) ;;;_ = allout-use-hanging-indents (defcustom allout-use-hanging-indents t - "*If non-nil, topic body text auto-indent defaults to indent of the header. + "If non-nil, topic body text auto-indent defaults to indent of the header. Ie, it is indented to be just past the header prefix. This is relevant mostly for use with `indented-text-mode', or other situations where auto-fill occurs." @@ -292,7 +292,7 @@ ;;;_ = allout-reindent-bodies (defcustom allout-reindent-bodies (if allout-use-hanging-indents 'text) - "*Non-nil enables auto-adjust of topic body hanging indent with depth shifts. + "Non-nil enables auto-adjust of topic body hanging indent with depth shifts. When active, topic body lines that are indented even with or beyond their topic header are reindented to correspond with depth shifts of @@ -311,7 +311,7 @@ ;;;_ = allout-show-bodies (defcustom allout-show-bodies nil - "*If non-nil, show entire body when exposing a topic, rather than + "If non-nil, show entire body when exposing a topic, rather than just the header." :type 'boolean :group 'allout) @@ -322,7 +322,7 @@ ;;;_ = allout-beginning-of-line-cycles (defcustom allout-beginning-of-line-cycles t - "*If non-nil, \\[allout-beginning-of-line] will cycle through smart-placement options. + "If non-nil, \\[allout-beginning-of-line] will cycle through smart-placement options. Cycling only happens on when the command is repeated, not when it follows a different command. @@ -353,7 +353,7 @@ :type 'boolean :group 'allout) ;;;_ = allout-end-of-line-cycles (defcustom allout-end-of-line-cycles t - "*If non-nil, \\[allout-end-of-line] will cycle through smart-placement options. + "If non-nil, \\[allout-end-of-line] will cycle through smart-placement options. Cycling only happens on when the command is repeated, not when it follows a different command. @@ -381,7 +381,7 @@ (defcustom allout-header-prefix "." ;; this string is treated as literal match. it will be `regexp-quote'd, so ;; one cannot use regular expressions to match varying header prefixes. - "*Leading string which helps distinguish topic headers. + "Leading string which helps distinguish topic headers. Outline topic header lines are identified by a leading topic header prefix, which mostly have the value of this var at their front. @@ -411,7 +411,7 @@ (put 'allout-primary-bullet 'safe-local-variable 'stringp) ;;;_ = allout-plain-bullets-string (defcustom allout-plain-bullets-string ".," - "*The bullets normally used in outline topic prefixes. + "The bullets normally used in outline topic prefixes. See `allout-distinctive-bullets-string' for the other kind of bullets. @@ -427,7 +427,7 @@ (put 'allout-plain-bullets-string 'safe-local-variable 'stringp) ;;;_ = allout-distinctive-bullets-string (defcustom allout-distinctive-bullets-string "*+-=>()[{}&!?#%\"X@$~_\\:;^" - "*Persistent outline header bullets used to distinguish special topics. + "Persistent outline header bullets used to distinguish special topics. These bullets are distinguish topics with particular character. They are not used by default in the topic creation routines, but @@ -476,7 +476,7 @@ ;;;_ = allout-use-mode-specific-leader (defcustom allout-use-mode-specific-leader t - "*When non-nil, use mode-specific topic-header prefixes. + "When non-nil, use mode-specific topic-header prefixes. Allout outline mode will use the mode-specific `allout-mode-leaders' or comment-start string, if any, to lead the topic prefix string, so topic @@ -527,7 +527,7 @@ ;;;_ = allout-old-style-prefixes (defcustom allout-old-style-prefixes nil - "*When non-nil, use only old-and-crusty `outline-mode' `*' topic prefixes. + "When non-nil, use only old-and-crusty `outline-mode' `*' topic prefixes. Non-nil restricts the topic creation and modification functions to asterix-padded prefixes, so they look exactly @@ -543,7 +543,7 @@ (if (fboundp 'booleanp) 'booleanp '(lambda (x) (member x '(t nil))))) ;;;_ = allout-stylish-prefixes -- alternating bullets (defcustom allout-stylish-prefixes t - "*Do fancy stuff with topic prefix bullets according to level, etc. + "Do fancy stuff with topic prefix bullets according to level, etc. Non-nil enables topic creation, modification, and repositioning functions to vary the topic bullet char (the char that marks the topic @@ -593,7 +593,7 @@ ;;;_ = allout-numbered-bullet (defcustom allout-numbered-bullet "#" - "*String designating bullet of topics that have auto-numbering; nil for none. + "String designating bullet of topics that have auto-numbering; nil for none. Topics having this bullet have automatic maintenance of a sibling sequence-number tacked on, just after the bullet. Conventionally set @@ -609,7 +609,7 @@ '(lambda (x) (or (stringp x) (null x))))) ;;;_ = allout-file-xref-bullet (defcustom allout-file-xref-bullet "@" - "*Bullet signifying file cross-references, for `allout-resolve-xref'. + "Bullet signifying file cross-references, for `allout-resolve-xref'. Set this var to the bullet you want to use for file cross-references." :type '(choice (const nil) string) @@ -621,7 +621,7 @@ '(lambda (x) (or (stringp x) (null x))))) ;;;_ = allout-presentation-padding (defcustom allout-presentation-padding 2 - "*Presentation-format white-space padding factor, for greater indent." + "Presentation-format white-space padding factor, for greater indent." :type 'integer :group 'allout) @@ -631,7 +631,7 @@ ;;;_ = allout-abbreviate-flattened-numbering (defcustom allout-abbreviate-flattened-numbering nil - "*If non-nil, `allout-flatten-exposed-to-buffer' abbreviates topic + "If non-nil, `allout-flatten-exposed-to-buffer' abbreviates topic numbers to minimal amount with some context. Otherwise, entire numbers are always used." :type 'boolean @@ -640,43 +640,43 @@ ;;;_ + LaTeX formatting ;;;_ - allout-number-pages (defcustom allout-number-pages nil - "*Non-nil turns on page numbering for LaTeX formatting of an outline." + "Non-nil turns on page numbering for LaTeX formatting of an outline." :type 'boolean :group 'allout) ;;;_ - allout-label-style (defcustom allout-label-style "\\large\\bf" - "*Font and size of labels for LaTeX formatting of an outline." + "Font and size of labels for LaTeX formatting of an outline." :type 'string :group 'allout) ;;;_ - allout-head-line-style (defcustom allout-head-line-style "\\large\\sl " - "*Font and size of entries for LaTeX formatting of an outline." + "Font and size of entries for LaTeX formatting of an outline." :type 'string :group 'allout) ;;;_ - allout-body-line-style (defcustom allout-body-line-style " " - "*Font and size of entries for LaTeX formatting of an outline." + "Font and size of entries for LaTeX formatting of an outline." :type 'string :group 'allout) ;;;_ - allout-title-style (defcustom allout-title-style "\\Large\\bf" - "*Font and size of titles for LaTeX formatting of an outline." + "Font and size of titles for LaTeX formatting of an outline." :type 'string :group 'allout) ;;;_ - allout-title (defcustom allout-title '(or buffer-file-name (buffer-name)) - "*Expression to be evaluated to determine the title for LaTeX + "Expression to be evaluated to determine the title for LaTeX formatted copy." :type 'sexp :group 'allout) ;;;_ - allout-line-skip (defcustom allout-line-skip ".05cm" - "*Space between lines for LaTeX formatting of an outline." + "Space between lines for LaTeX formatting of an outline." :type 'string :group 'allout) ;;;_ - allout-indent (defcustom allout-indent ".3cm" - "*LaTeX formatted depth-indent spacing." + "LaTeX formatted depth-indent spacing." :type 'string :group 'allout) @@ -687,13 +687,13 @@ :group 'allout) ;;;_ = allout-topic-encryption-bullet (defcustom allout-topic-encryption-bullet "~" - "*Bullet signifying encryption of the entry's body." + "Bullet signifying encryption of the entry's body." :type '(choice (const nil) string) :version "22.1" :group 'allout-encryption) ;;;_ = allout-passphrase-verifier-handling (defcustom allout-passphrase-verifier-handling t - "*Enable use of symmetric encryption passphrase verifier if non-nil. + "Enable use of symmetric encryption passphrase verifier if non-nil. See the docstring for the `allout-enable-file-variable-adjustment' variable for details about allout ajustment of file variables." @@ -703,7 +703,7 @@ (make-variable-buffer-local 'allout-passphrase-verifier-handling) ;;;_ = allout-passphrase-hint-handling (defcustom allout-passphrase-hint-handling 'always - "*Dictate outline encryption passphrase reminder handling: + "Dictate outline encryption passphrase reminder handling: always -- always show reminder when prompting needed -- show reminder on passphrase entry failure @@ -719,7 +719,7 @@ (make-variable-buffer-local 'allout-passphrase-hint-handling) ;;;_ = allout-encrypt-unencrypted-on-saves (defcustom allout-encrypt-unencrypted-on-saves t - "*When saving, should topics pending encryption be encrypted? + "When saving, should topics pending encryption be encrypted? The idea is to prevent file-system exposure of any un-encrypted stuff, and mostly covers both deliberate file writes and auto-saves. @@ -758,7 +758,7 @@ :group 'allout) ;;;_ = allout-run-unit-tests-on-load (defcustom allout-run-unit-tests-on-load nil - "*When non-nil, unit tests will be run at end of loading the allout module. + "When non-nil, unit tests will be run at end of loading the allout module. Generally, allout code developers are the only ones who'll want to set this. @@ -774,7 +774,7 @@ ;;;_ = allout-enable-file-variable-adjustment (defcustom allout-enable-file-variable-adjustment t - "*If non-nil, some allout outline actions edit Emacs local file var text. + "If non-nil, some allout outline actions edit Emacs local file var text. This can range from changes to existing entries, addition of new ones, and creation of a new local variables section when necessary. @@ -929,14 +929,14 @@ suitably economical.") ;;;_ X allout-reset-header-lead (header-lead) (defun allout-reset-header-lead (header-lead) - "*Reset the leading string used to identify topic headers." + "Reset the leading string used to identify topic headers." (interactive "sNew lead string: ") (setq allout-header-prefix header-lead) (setq allout-header-subtraction (1- (length allout-header-prefix))) (set-allout-regexp)) ;;;_ X allout-lead-with-comment-string (header-lead) (defun allout-lead-with-comment-string (&optional header-lead) - "*Set the topic-header leading string to specified string. + "Set the topic-header leading string to specified string. Useful when for encapsulating outline structure in programming language comments. Returns the leading string."
--- a/lisp/apropos.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/apropos.el Wed Dec 03 05:48:14 2008 +0000 @@ -112,7 +112,7 @@ (const :tag "show scores" verbose))) (defcustom apropos-documentation-sort-by-scores t - "*Non-nil means sort matches by scores; best match is shown first. + "Non-nil means sort matches by scores; best match is shown first. This applies to `apropos-documentation' only. If value is `verbose', the computed score is shown for each match." :group 'apropos
--- a/lisp/arc-mode.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/arc-mode.el Wed Dec 03 05:48:14 2008 +0000 @@ -135,14 +135,14 @@ :group 'archive) (defcustom archive-remote-regexp "^/[^/:]*[^/:.]:" - "*Regexp recognizing archive files names that are not local. + "Regexp recognizing archive files names that are not local. A non-local file is one whose file name is not proper outside Emacs. A local copy of the archive will be used when updating." :type 'regexp :group 'archive) (defcustom archive-extract-hooks nil - "*Hooks to run when an archive member has been extracted." + "Hooks to run when an archive member has been extracted." :type 'hook :group 'archive) ;; ------------------------------ @@ -152,7 +152,7 @@ ;; to extract to stdout without junk getting added. (defcustom archive-arc-extract '("arc" "x") - "*Program and its options to run in order to extract an arc file member. + "Program and its options to run in order to extract an arc file member. Extraction should happen to the current directory. Archive and member name will be added." :type '(list (string :tag "Program") @@ -163,7 +163,7 @@ (defcustom archive-arc-expunge '("arc" "d") - "*Program and its options to run in order to delete arc file members. + "Program and its options to run in order to delete arc file members. Archive and member names will be added." :type '(list (string :tag "Program") (repeat :tag "Options" @@ -173,7 +173,7 @@ (defcustom archive-arc-write-file-member '("arc" "u") - "*Program and its options to run in order to update an arc file member. + "Program and its options to run in order to update an arc file member. Archive and member name will be added." :type '(list (string :tag "Program") (repeat :tag "Options" @@ -185,7 +185,7 @@ (defcustom archive-lzh-extract '("lha" "pq") - "*Program and its options to run in order to extract an lzh file member. + "Program and its options to run in order to extract an lzh file member. Extraction should happen to standard output. Archive and member name will be added." :type '(list (string :tag "Program") @@ -196,7 +196,7 @@ (defcustom archive-lzh-expunge '("lha" "d") - "*Program and its options to run in order to delete lzh file members. + "Program and its options to run in order to delete lzh file members. Archive and member names will be added." :type '(list (string :tag "Program") (repeat :tag "Options" @@ -206,7 +206,7 @@ (defcustom archive-lzh-write-file-member '("lha" "a") - "*Program and its options to run in order to update an lzh file member. + "Program and its options to run in order to update an lzh file member. Archive and member name will be added." :type '(list (string :tag "Program") (repeat :tag "Options" @@ -221,7 +221,7 @@ (executable-find "pkunzip")) '("pkunzip" "-e" "-o-") '("unzip" "-qq" "-c")) - "*Program and its options to run in order to extract a zip file member. + "Program and its options to run in order to extract a zip file member. Extraction should happen to standard output. Archive and member name will be added." :type '(list (string :tag "Program") @@ -240,7 +240,7 @@ (executable-find "pkzip")) '("pkzip" "-d") '("zip" "-d" "-q")) - "*Program and its options to run in order to delete zip file members. + "Program and its options to run in order to delete zip file members. Archive and member names will be added." :type '(list (string :tag "Program") (repeat :tag "Options" @@ -253,7 +253,7 @@ (executable-find "pkzip")) '("pkzip" "-u" "-P") '("zip" "-q")) - "*Program and its options to run in order to update a zip file member. + "Program and its options to run in order to update a zip file member. Options should ensure that specified directory will be put into the zip file. Archive and member name will be added." :type '(list (string :tag "Program") @@ -267,7 +267,7 @@ (executable-find "pkzip")) '("pkzip" "-u" "-P") '("zip" "-q" "-k")) - "*Program and its options to run in order to update a case fiddled zip member. + "Program and its options to run in order to update a case fiddled zip member. Options should ensure that specified directory will be put into the zip file. Archive and member name will be added." :type '(list (string :tag "Program") @@ -277,7 +277,7 @@ :group 'archive-zip) (defcustom archive-zip-case-fiddle t - "*If non-nil then zip file members may be down-cased. + "If non-nil then zip file members may be down-cased. This case fiddling will only happen for members created by a system that uses caseless file names." :type 'boolean @@ -287,7 +287,7 @@ (defcustom archive-zoo-extract '("zoo" "xpq") - "*Program and its options to run in order to extract a zoo file member. + "Program and its options to run in order to extract a zoo file member. Extraction should happen to standard output. Archive and member name will be added." :type '(list (string :tag "Program") @@ -298,7 +298,7 @@ (defcustom archive-zoo-expunge '("zoo" "DqPP") - "*Program and its options to run in order to delete zoo file members. + "Program and its options to run in order to delete zoo file members. Archive and member names will be added." :type '(list (string :tag "Program") (repeat :tag "Options" @@ -308,7 +308,7 @@ (defcustom archive-zoo-write-file-member '("zoo" "a") - "*Program and its options to run in order to update a zoo file member. + "Program and its options to run in order to update a zoo file member. Archive and member name will be added." :type '(list (string :tag "Program") (repeat :tag "Options"
--- a/lisp/autoinsert.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/autoinsert.el Wed Dec 03 05:48:14 2008 +0000 @@ -58,7 +58,7 @@ (defcustom auto-insert 'not-modified - "*Controls automatic insertion into newly found empty files. + "Controls automatic insertion into newly found empty files. Possible values: nil do nothing t insert if possible @@ -76,7 +76,7 @@ :group 'auto-insert) (defcustom auto-insert-query 'function - "*Non-nil means ask user before auto-inserting. + "Non-nil means ask user before auto-inserting. When this is `function', only ask when called non-interactively." :type '(choice (const :tag "Don't ask" nil) (const :tag "Ask if called non-interactively" function) @@ -84,7 +84,7 @@ :group 'auto-insert) (defcustom auto-insert-prompt "Perform %s auto-insertion? " - "*Prompt to use when querying whether to auto-insert. + "Prompt to use when querying whether to auto-insert. If this contains a %s, that will be replaced by the matching rule." :type 'string :group 'auto-insert) @@ -308,7 +308,7 @@ ;; Establish a default value for auto-insert-directory (defcustom auto-insert-directory "~/insert/" - "*Directory from which auto-inserted files are taken. + "Directory from which auto-inserted files are taken. The value must be an absolute directory name; thus, on a GNU or Unix system, it must end in a slash." :type 'directory
--- a/lisp/avoid.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/avoid.el Wed Dec 03 05:48:14 2008 +0000 @@ -94,14 +94,14 @@ (defcustom mouse-avoidance-nudge-dist 15 - "*Average distance that mouse will be moved when approached by cursor. + "Average distance that mouse will be moved when approached by cursor. Only applies in Mouse-Avoidance mode `jump' and its derivatives. For best results make this larger than `mouse-avoidance-threshold'." :type 'integer :group 'avoid) (defcustom mouse-avoidance-nudge-var 10 - "*Variability of `mouse-avoidance-nudge-dist' (which see)." + "Variability of `mouse-avoidance-nudge-dist' (which see)." :type 'integer :group 'avoid) @@ -111,7 +111,7 @@ :group 'avoid) (defcustom mouse-avoidance-threshold 5 - "*Mouse-pointer's flight distance. + "Mouse-pointer's flight distance. If the cursor gets closer than this, the mouse pointer will move away. Only applies in mouse-avoidance-modes `animate' and `jump'." :type 'integer
--- a/lisp/battery.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/battery.el Wed Dec 03 05:48:14 2008 +0000 @@ -60,7 +60,7 @@ 'battery-pmset) ((eq system-type 'windows-nt) 'w32-battery-status)) - "*Function for getting battery status information. + "Function for getting battery status information. The function has to return an alist of conversion definitions. Its cons cells are of the form @@ -80,7 +80,7 @@ "%L power, battery %B (%p%% load, remaining time %t)") (battery-status-function "Power %L, battery %B (%p%% load, remaining time %t)")) - "*Control string formatting the string to display in the echo area. + "Control string formatting the string to display in the echo area. Ordinary characters in the control string are printed as-is, while conversion specifications introduced by a `%' character in the control string are substituted as defined by the current value of the variable @@ -108,7 +108,7 @@ "[%b%p%%,%d°C]") (battery-status-function "[%b%p%%]")) - "*Control string formatting the string to display in the mode line. + "Control string formatting the string to display in the mode line. Ordinary characters in the control string are printed as-is, while conversion specifications introduced by a `%' character in the control string are substituted as defined by the current value of the variable @@ -128,18 +128,18 @@ :group 'battery) (defcustom battery-update-interval 60 - "*Seconds after which the battery status will be updated." + "Seconds after which the battery status will be updated." :type 'integer :group 'battery) (defcustom battery-load-low 25 - "*Upper bound of low battery load percentage. + "Upper bound of low battery load percentage. A battery load percentage below this number is considered low." :type 'integer :group 'battery) (defcustom battery-load-critical 10 - "*Upper bound of critical battery load percentage. + "Upper bound of critical battery load percentage. A battery load percentage below this number is considered critical." :type 'integer :group 'battery)
--- a/lisp/bookmark.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/bookmark.el Wed Dec 03 05:48:14 2008 +0000 @@ -126,7 +126,7 @@ (defconst bookmark-old-default-file "~/.emacs-bkmrks" - "*The `.emacs.bmk' file used to be called this name.") + "The `.emacs.bmk' file used to be called this name.") ;; defvarred to avoid a compilation warning: @@ -893,7 +893,7 @@ ;; Abbreviate the path, both so it's shorter and so it's more ;; portable. E.g., the user's home dir might be a different ;; path on different machines, but "~/" will still reach it. - (abbreviate-file-name + (abbreviate-file-name (cond (buffer-file-name buffer-file-name) ((and (boundp 'dired-directory) dired-directory)
--- a/lisp/buff-menu.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/buff-menu.el Wed Dec 03 05:48:14 2008 +0000 @@ -68,7 +68,7 @@ :group 'convenience) (defcustom Buffer-menu-use-header-line t - "*Non-nil means to use an immovable header-line." + "Non-nil means to use an immovable header-line." :type 'boolean :group 'Buffer-menu) @@ -79,12 +79,12 @@ (put 'Buffer-menu-buffer 'face-alias 'buffer-menu-buffer) (defcustom Buffer-menu-buffer+size-width 26 - "*How wide to jointly make the buffer name and size columns." + "How wide to jointly make the buffer name and size columns." :type 'number :group 'Buffer-menu) (defcustom Buffer-menu-mode-width 16 - "*How wide to make the mode name column." + "How wide to make the mode name column." :type 'number :group 'Buffer-menu) @@ -838,7 +838,7 @@ buffer ,(car buffer) font-lock-face buffer-menu-buffer mouse-face highlight - help-echo + help-echo ,(if (>= (length name) (- Buffer-menu-buffer+size-width (max (length size) 3)
--- a/lisp/calculator.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/calculator.el Wed Dec 03 05:48:14 2008 +0000 @@ -57,31 +57,31 @@ :group 'convenience) (defcustom calculator-electric-mode nil - "*Run `calculator' electrically, in the echo area. + "Run `calculator' electrically, in the echo area. Electric mode saves some place but changes the way you interact with the calculator." :type 'boolean :group 'calculator) (defcustom calculator-use-menu t - "*Make `calculator' create a menu. + "Make `calculator' create a menu. Note that this requires easymenu. Must be set before loading." :type 'boolean :group 'calculator) (defcustom calculator-bind-escape nil - "*If non-nil, set escape to exit the calculator." + "If non-nil, set escape to exit the calculator." :type 'boolean :group 'calculator) (defcustom calculator-unary-style 'postfix - "*Value is either 'prefix or 'postfix. + "Value is either 'prefix or 'postfix. This determines the default behavior of unary operators." :type '(choice (const prefix) (const postfix)) :group 'calculator) (defcustom calculator-prompt "Calc=%s> " - "*The prompt used by the Emacs calculator. + "The prompt used by the Emacs calculator. It should contain a \"%s\" somewhere that will indicate the i/o radixes; this will be a two-character string as described in the documentation for `calculator-mode'." @@ -89,7 +89,7 @@ :group 'calculator) (defcustom calculator-number-digits 3 - "*The calculator's number of digits used for standard display. + "The calculator's number of digits used for standard display. Used by the `calculator-standard-display' function - it will use the format string \"%.NC\" where this number is N and C is a character given at runtime." @@ -97,7 +97,7 @@ :group 'calculator) (defcustom calculator-radix-grouping-mode t - "*Use digit grouping in radix output mode. + "Use digit grouping in radix output mode. If this is set, chunks of `calculator-radix-grouping-digits' characters will be separated by `calculator-radix-grouping-separator' when in radix output mode is active (determined by `calculator-output-radix')." @@ -105,19 +105,19 @@ :group 'calculator) (defcustom calculator-radix-grouping-digits 4 - "*The number of digits used for grouping display in radix modes. + "The number of digits used for grouping display in radix modes. See `calculator-radix-grouping-mode'." :type 'integer :group 'calculator) (defcustom calculator-radix-grouping-separator "'" - "*The separator used in radix grouping display. + "The separator used in radix grouping display. See `calculator-radix-grouping-mode'." :type 'string :group 'calculator) (defcustom calculator-remove-zeros t - "*Non-nil value means delete all redundant zero decimal digits. + "Non-nil value means delete all redundant zero decimal digits. If this value is not t, and not nil, redundant zeros are removed except for one and if it is nil, nothing is removed. Used by the `calculator-remove-zeros' function." @@ -125,7 +125,7 @@ :group 'calculator) (defcustom calculator-displayer '(std ?n) - "*A displayer specification for numerical values. + "A displayer specification for numerical values. This is the displayer used to show all numbers in an expression. Result values will be displayed according to the first element of `calculator-displayers'. @@ -150,7 +150,7 @@ ((std ?f) "Standard display, decimal point") ((std ?e) "Standard display, scientific") ("%S" "Emacs printer")) - "*A list of displayers. + "A list of displayers. Each element is a list of a displayer and a description string. The first element is the one which is currently used, this is for the display of result values not values in expressions. A displayer specification @@ -161,14 +161,14 @@ :group 'calculator) (defcustom calculator-paste-decimals t - "*If non-nil, convert pasted integers so they have a decimal point. + "If non-nil, convert pasted integers so they have a decimal point. This makes it possible to paste big integers since they will be read as floats, otherwise the Emacs reader will fail on them." :type 'boolean :group 'calculator) (defcustom calculator-copy-displayer nil - "*If non-nil, this is any value that can be used for + "If non-nil, this is any value that can be used for `calculator-displayer', to format a string before copying it with `calculator-copy'. If nil, then `calculator-displayer's normal value is used." @@ -176,13 +176,13 @@ :group 'calculator) (defcustom calculator-2s-complement nil - "*If non-nil, show negative numbers in 2s complement in radix modes. + "If non-nil, show negative numbers in 2s complement in radix modes. Otherwise show as a negative number." :type 'boolean :group 'calculator) (defcustom calculator-mode-hook nil - "*List of hook functions for `calculator-mode' to run. + "List of hook functions for `calculator-mode' to run. Note: if `calculator-electric-mode' is on, then this hook will get activated in the minibuffer - in that case it should not do much more than local key settings and other effects that will change things @@ -191,7 +191,7 @@ :group 'calculator) (defcustom calculator-user-registers nil - "*An association list of user-defined register bindings. + "An association list of user-defined register bindings. Each element in this list is a list of a character and a number that will be stored in that character's register. @@ -207,7 +207,7 @@ :group 'calculator) (defcustom calculator-user-operators nil - "*A list of additional operators. + "A list of additional operators. This is a list in the same format as specified in the documentation for `calculator-operators', that you can use to bind additional calculator operators. It is probably not a good idea to modify this value with
--- a/lisp/chistory.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/chistory.el Wed Dec 03 05:48:14 2008 +0000 @@ -67,7 +67,7 @@ '(command-history-mode list-command-history electric-command-history) - "*A list of symbols to be ignored by `default-command-history-filter'. + "A list of symbols to be ignored by `default-command-history-filter'. If that function is given a list whose car is an element of this list, then it will return non-nil (indicating the list should be discarded from the history). @@ -90,7 +90,7 @@ (memq (car frob) default-command-history-filter-garbage))) (defcustom list-command-history-max 32 - "*If non-nil, maximum length of the listing produced by `list-command-history'." + "If non-nil, maximum length of the listing produced by `list-command-history'." :type '(choice integer (const nil)) :group 'chistory)
--- a/lisp/cmuscheme.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/cmuscheme.el Wed Dec 03 05:48:14 2008 +0000 @@ -104,7 +104,7 @@ ;;;============================================================================ (defcustom inferior-scheme-mode-hook nil - "*Hook for customizing inferior-scheme mode." + "Hook for customizing inferior-scheme mode." :type 'hook :group 'cmuscheme) @@ -207,7 +207,7 @@ (setq comint-get-old-input (function scheme-get-old-input))) (defcustom inferior-scheme-filter-regexp "\\`\\s *\\S ?\\S ?\\s *\\'" - "*Input matching this regexp are not saved on the history list. + "Input matching this regexp are not saved on the history list. Defaults to a regexp ignoring all inputs of 0, 1, or 2 letters." :type 'regexp :group 'cmuscheme) @@ -295,7 +295,7 @@ (scheme-send-region (save-excursion (backward-sexp) (point)) (point))) (defcustom scheme-compile-exp-command "(compile '%s)" - "*Template for issuing commands to compile arbitrary Scheme expressions." + "Template for issuing commands to compile arbitrary Scheme expressions." :type 'string :group 'cmuscheme) @@ -318,7 +318,7 @@ (scheme-compile-region (point) end)))) (defcustom scheme-trace-command "(trace %s)" - "*Template for issuing commands to trace a Scheme procedure. + "Template for issuing commands to trace a Scheme procedure. Some Scheme implementations might require more elaborate commands here. For PLT-Scheme, e.g., one should use @@ -329,7 +329,7 @@ :group 'cmuscheme) (defcustom scheme-untrace-command "(untrace %s)" - "*Template for switching off tracing of a Scheme procedure. + "Template for switching off tracing of a Scheme procedure. Scheme 48 and Scsh users should set this variable to \",untrace %s\"." :type 'string @@ -354,7 +354,7 @@ (comint-send-string (scheme-proc) "\n")) (defcustom scheme-macro-expand-command "(expand %s)" - "*Template for macro-expanding a Scheme form. + "Template for macro-expanding a Scheme form. For Scheme 48 and Scsh use \",expand %s\"." :type 'string :group 'cmuscheme) @@ -421,7 +421,7 @@ (switch-to-scheme t)) (defcustom scheme-source-modes '(scheme-mode) - "*Used to determine if a buffer contains Scheme source code. + "Used to determine if a buffer contains Scheme source code. If it's loaded into a buffer that is in one of these major modes, it's considered a scheme source file by `scheme-load-file' and `scheme-compile-file'. Used by these commands to determine defaults."
--- a/lisp/comint.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/comint.el Wed Dec 03 05:48:14 2008 +0000 @@ -206,7 +206,7 @@ This is a good thing to set in mode hooks.") (defcustom comint-input-autoexpand nil - "*If non-nil, expand input command history references on completion. + "If non-nil, expand input command history references on completion. This mirrors the optional behavior of tcsh (its autoexpand and histlist). If the value is `input', then the expansion is seen on input. @@ -233,7 +233,7 @@ :group 'comint) (defcustom comint-input-ignoredups nil - "*If non-nil, don't add input matching the last on the input ring. + "If non-nil, don't add input matching the last on the input ring. This mirrors the optional behavior of bash. This variable is buffer-local." @@ -241,7 +241,7 @@ :group 'comint) (defcustom comint-input-ring-file-name nil - "*If non-nil, name of the file to read/write input history. + "If non-nil, name of the file to read/write input history. See also `comint-read-input-ring' and `comint-write-input-ring'. This variable is buffer-local, and is a good thing to set in mode hooks." @@ -250,7 +250,7 @@ :group 'comint) (defcustom comint-scroll-to-bottom-on-input nil - "*Controls whether input to interpreter causes window to scroll. + "Controls whether input to interpreter causes window to scroll. If nil, then do not scroll. If t or `all', scroll all windows showing buffer. If `this', scroll only the selected window. @@ -264,7 +264,7 @@ :group 'comint) (defcustom comint-move-point-for-output nil - "*Controls whether interpreter output moves point to the end of the output. + "Controls whether interpreter output moves point to the end of the output. If nil, then output never moves point to the output. (If the output occurs at point, it is inserted before point.) If t or `all', move point in all windows showing the buffer. @@ -286,7 +286,7 @@ (defvaralias 'comint-scroll-to-bottom-on-output 'comint-move-point-for-output) (defcustom comint-scroll-show-maximum-output t - "*Controls how to scroll due to interpreter output. + "Controls how to scroll due to interpreter output. This variable applies when point is at the end of the buffer \(either because it was originally there, or because `comint-move-point-for-output' said to move it there) @@ -303,7 +303,7 @@ :group 'comint) (defcustom comint-buffer-maximum-size 1024 - "*The maximum size in lines for Comint buffers. + "The maximum size in lines for Comint buffers. Comint buffers are truncated from the top to be no greater than this number, if the function `comint-truncate-buffer' is on `comint-output-filter-functions'." :type 'integer @@ -319,7 +319,7 @@ "Regexp for history entries that should be ignored when Comint initializes.") (defcustom comint-process-echoes nil - "*If non-nil, assume that the subprocess echoes any input. + "If non-nil, assume that the subprocess echoes any input. If so, delete one copy of the input so that only one copy eventually appears in the buffer. @@ -341,7 +341,7 @@ \[Pp]assword\\( (again)\\)?\\|\ pass phrase\\|\\(Enter \\|Repeat \\|Bad \\)?[Pp]assphrase\\)\ \\(?:, try again\\)?\\(?: for [^:]+\\)?:\\s *\\'" - "*Regexp matching prompts for passwords in the inferior process. + "Regexp matching prompts for passwords in the inferior process. This is used by `comint-watch-for-password-prompt'." :type 'regexp :group 'comint) @@ -400,7 +400,7 @@ This is called from the user command `comint-send-input'.") (defcustom comint-eol-on-send t - "*Non-nil means go to the end of the line before sending input. + "Non-nil means go to the end of the line before sending input. See `comint-send-input'." :type 'boolean :group 'comint) @@ -409,7 +409,7 @@ ;; entirely, searching for uses of this variable will help to identify ;; places that need attention. (defcustom comint-use-prompt-regexp nil - "*If non-nil, use `comint-prompt-regexp' to recognize prompts. + "If non-nil, use `comint-prompt-regexp' to recognize prompts. If nil, then program output and user-input are given different `field' properties, which Emacs commands can use to distinguish them (in particular, common movement commands such as `beginning-of-line' @@ -2627,13 +2627,13 @@ ;; want them present in specific modes. (defcustom comint-completion-autolist nil - "*If non-nil, automatically list possibilities on partial completion. + "If non-nil, automatically list possibilities on partial completion. This mirrors the optional behavior of tcsh." :type 'boolean :group 'comint-completion) (defcustom comint-completion-addsuffix t - "*If non-nil, add a `/' to completed directories, ` ' to file names. + "If non-nil, add a `/' to completed directories, ` ' to file names. If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion. This mirrors the optional behavior of tcsh." @@ -2645,7 +2645,7 @@ :group 'comint-completion) (defcustom comint-completion-recexact nil - "*If non-nil, use shortest completion if characters cannot be added. + "If non-nil, use shortest completion if characters cannot be added. This mirrors the optional behavior of tcsh. A non-nil value is useful if `comint-completion-autolist' is non-nil too." @@ -2653,7 +2653,7 @@ :group 'comint-completion) (defcustom comint-completion-fignore nil - "*List of suffixes to be disregarded during file completion. + "List of suffixes to be disregarded during file completion. This mirrors the optional behavior of bash and tcsh. Note that this applies to `comint-dynamic-complete-filename' only." @@ -3134,7 +3134,7 @@ ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (defcustom comint-redirect-verbose nil - "*If non-nil, print messages each time the redirection filter is invoked. + "If non-nil, print messages each time the redirection filter is invoked. Also print a message when redirection is completed." :group 'comint :type 'boolean)
--- a/lisp/compare-w.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/compare-w.el Wed Dec 03 05:48:14 2008 +0000 @@ -36,7 +36,7 @@ :group 'tools) (defcustom compare-windows-whitespace "\\(\\s-\\|\n\\)+" - "*Regexp or function that defines whitespace sequences for `compare-windows'. + "Regexp or function that defines whitespace sequences for `compare-windows'. That command optionally ignores changes in whitespace. The value of `compare-windows-whitespace' is normally a regexp, but it @@ -53,18 +53,18 @@ :group 'compare-windows) (defcustom compare-ignore-whitespace nil - "*Non-nil means `compare-windows' ignores whitespace." + "Non-nil means `compare-windows' ignores whitespace." :type 'boolean :group 'compare-windows :version "22.1") (defcustom compare-ignore-case nil - "*Non-nil means `compare-windows' ignores case differences." + "Non-nil means `compare-windows' ignores case differences." :type 'boolean :group 'compare-windows) (defcustom compare-windows-sync 'compare-windows-sync-default-function - "*Function or regexp that is used to synchronize points in two + "Function or regexp that is used to synchronize points in two windows if before calling `compare-windows' points are located on mismatched positions. @@ -93,7 +93,7 @@ :version "22.1") (defcustom compare-windows-sync-string-size 32 - "*Size of string from one window that is searched in second window. + "Size of string from one window that is searched in second window. Small number makes difference regions more fine-grained, but it may fail by finding the wrong match. The bigger number makes @@ -105,7 +105,7 @@ :version "22.1") (defcustom compare-windows-recenter nil - "*List of two values, each of which is used as argument of + "List of two values, each of which is used as argument of function `recenter' called in each of two windows to place matching points side-by-side. @@ -116,7 +116,7 @@ :version "22.1") (defcustom compare-windows-highlight t - "*Non-nil means compare-windows highlights the differences. + "Non-nil means compare-windows highlights the differences. The value t removes highlighting immediately after invoking a command other than `compare-windows'. The value `persistent' leaves all highlighted differences. You can clear
--- a/lisp/dabbrev.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/dabbrev.el Wed Dec 03 05:48:14 2008 +0000 @@ -104,18 +104,18 @@ :group 'convenience) (defcustom dabbrev-backward-only nil - "*If non-nil, `dabbrev-expand' only looks backwards." + "If non-nil, `dabbrev-expand' only looks backwards." :type 'boolean :group 'dabbrev) (defcustom dabbrev-limit nil - "*Limits region searched by `dabbrev-expand' to this many chars away." + "Limits region searched by `dabbrev-expand' to this many chars away." :type '(choice (const :tag "off" nil) integer) :group 'dabbrev) (defcustom dabbrev-abbrev-skip-leading-regexp nil - "*Regexp for skipping leading characters of an abbreviation. + "Regexp for skipping leading characters of an abbreviation. Example: Set this to \"\\\\$\" for programming languages in which variable names may appear with or without a leading `$'. @@ -127,13 +127,13 @@ :group 'dabbrev) (defcustom dabbrev-eliminate-newlines t - "*Non-nil means dabbrev should not insert newlines. + "Non-nil means dabbrev should not insert newlines. Instead it converts them to spaces." :type 'boolean :group 'dabbrev) (defcustom dabbrev-case-fold-search 'case-fold-search - "*Control whether dabbrev searches should ignore case. + "Control whether dabbrev searches should ignore case. A value of nil means case is significant. A value of `case-fold-search' means case is significant if `case-fold-search' is nil. @@ -144,7 +144,7 @@ :group 'dabbrev) (defcustom dabbrev-upcase-means-case-search nil - "*The significance of an uppercase character in an abbreviation. + "The significance of an uppercase character in an abbreviation. A nil value means case fold search when searching for possible expansions; non-nil means case sensitive search. @@ -154,7 +154,7 @@ :group 'dabbrev) (defcustom dabbrev-case-distinction 'case-replace - "*Whether dabbrev treats expansions as the same if they differ in case. + "Whether dabbrev treats expansions as the same if they differ in case. A value of nil means treat them as different. A value of `case-replace' means distinguish them if `case-replace' is nil. @@ -169,7 +169,7 @@ :version "22.1") (defcustom dabbrev-case-replace 'case-replace - "*Whether dabbrev applies the abbreviations's case pattern to the expansion. + "Whether dabbrev applies the abbreviations's case pattern to the expansion. A value of nil means preserve the expansion's case pattern. A value of `case-replace' means preserve it if `case-replace' is nil. @@ -184,7 +184,7 @@ :group 'dabbrev) (defcustom dabbrev-abbrev-char-regexp nil - "*Regexp to recognize a character in an abbreviation or expansion. + "Regexp to recognize a character in an abbreviation or expansion. This regexp will be surrounded with \\\\( ... \\\\) when actually used. Set this variable to \"\\\\sw\" if you want ordinary words or @@ -209,7 +209,7 @@ :group 'dabbrev) (defcustom dabbrev-check-all-buffers t - "*Non-nil means dabbrev package should search *all* buffers. + "Non-nil means dabbrev package should search *all* buffers. Dabbrev always searches the current buffer first. Then, if `dabbrev-check-other-buffers' says so, it searches the buffers @@ -222,21 +222,21 @@ :group 'dabbrev) (defcustom dabbrev-ignored-buffer-names '("*Messages*" "*Buffer List*") - "*List of buffer names that dabbrev should not check. + "List of buffer names that dabbrev should not check. See also `dabbrev-ignored-buffer-regexps'." :type '(repeat (string :tag "Buffer name")) :group 'dabbrev :version "20.3") (defcustom dabbrev-ignored-buffer-regexps nil - "*List of regexps matching names of buffers that dabbrev should not check. + "List of regexps matching names of buffers that dabbrev should not check. See also `dabbrev-ignored-buffer-names'." :type '(repeat regexp) :group 'dabbrev :version "21.1") (defcustom dabbrev-check-other-buffers t - "*Should \\[dabbrev-expand] look in other buffers?\ + "Should \\[dabbrev-expand] look in other buffers?\ nil: Don't look in other buffers. t: Also look for expansions in the buffers pointed out by @@ -263,7 +263,7 @@ A mode setting this variable should make it buffer local.") (defcustom dabbrev-friend-buffer-function 'dabbrev--same-major-mode-p - "*A function to decide whether dabbrev should search OTHER-BUFFER. + "A function to decide whether dabbrev should search OTHER-BUFFER. The function should take one argument, OTHER-BUFFER, and return non-nil if that buffer should be searched. Have a look at `dabbrev--same-major-mode-p' for an example.
--- a/lisp/delim-col.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/delim-col.el Wed Dec 03 05:48:14 2008 +0000 @@ -129,37 +129,37 @@ :group 'internal) (defcustom delimit-columns-str-before "" - "*Specify a string to be inserted before all columns." + "Specify a string to be inserted before all columns." :type '(string :tag "Before All Columns") :group 'columns) (defcustom delimit-columns-str-separator ", " - "*Specify a string to be inserted between each column." + "Specify a string to be inserted between each column." :type '(string :tag "Between Each Column") :group 'columns) (defcustom delimit-columns-str-after "" - "*Specify a string to be inserted after all columns." + "Specify a string to be inserted after all columns." :type '(string :tag "After All Columns") :group 'columns) (defcustom delimit-columns-before "" - "*Specify a string to be inserted before each column." + "Specify a string to be inserted before each column." :type '(string :tag "Before Each Column") :group 'columns) (defcustom delimit-columns-after "" - "*Specify a string to be inserted after each column." + "Specify a string to be inserted after each column." :type '(string :tag "After Each Column") :group 'columns) (defcustom delimit-columns-separator "\t" - "*Specify a regexp which separates each column." + "Specify a regexp which separates each column." :type '(regexp :tag "Column Separator") :group 'columns) (defcustom delimit-columns-format t - "*Specify how to format columns. + "Specify how to format columns. For examples below, consider: @@ -200,14 +200,14 @@ :group 'columns) (defcustom delimit-columns-extra t - "*Non-nil means that lines will have the same number of columns. + "Non-nil means that lines will have the same number of columns. This has effect only when there are lines with different number of columns." :type '(boolean :tag "Lines With Same Number Of Column") :group 'columns) (defcustom delimit-columns-start 0 - "*Specify column number to start prettifing. + "Specify column number to start prettifing. See also `delimit-columns-end' for documentation. @@ -222,7 +222,7 @@ :group 'columns) (defcustom delimit-columns-end 1000000 - "*Specify column number to end prettifing. + "Specify column number to end prettifing. See also `delimit-columns-start' for documentation.
--- a/lisp/desktop.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/desktop.el Wed Dec 03 05:48:14 2008 +0000 @@ -165,7 +165,7 @@ (desktop-save-mode 0)) (defcustom desktop-save 'ask-if-new - "*Specifies whether the desktop should be saved when it is killed. + "Specifies whether the desktop should be saved when it is killed. A desktop is killed when the user changes desktop or quits Emacs. Possible values are: t -- always save. @@ -302,7 +302,7 @@ (defcustom desktop-clear-preserve-buffers '("\\*scratch\\*" "\\*Messages\\*" "\\*server\\*" "\\*tramp/.+\\*") - "*List of buffers that `desktop-clear' should not delete. + "List of buffers that `desktop-clear' should not delete. Each element is a regular expression. Buffers with a name matched by any of these won't be deleted." :type '(repeat string) @@ -355,7 +355,7 @@ :group 'desktop) (defcustom desktop-file-name-format 'absolute - "*Format in which desktop file names should be saved. + "Format in which desktop file names should be saved. Possible values are: absolute -- Absolute file name. tilde -- Relative to ~.
--- a/lisp/diff-mode.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/diff-mode.el Wed Dec 03 05:48:14 2008 +0000 @@ -39,7 +39,7 @@ ;; - Improve `diff-add-change-log-entries-other-window', ;; it is very simplistic now. -;; +;; ;; - Add a `delete-after-apply' so C-c C-a automatically deletes hunks. ;; Also allow C-c C-a to delete already-applied hunks. ;; @@ -77,7 +77,7 @@ :group 'diff-mode) (defcustom diff-update-on-the-fly t - "*Non-nil means hunk headers are kept up-to-date on-the-fly. + "Non-nil means hunk headers are kept up-to-date on-the-fly. When editing a diff file, the line numbers in the hunk headers need to be kept consistent with the actual diff. This can either be done on the fly (but this sometimes interacts poorly with the @@ -87,7 +87,7 @@ :group 'diff-mode) (defcustom diff-advance-after-apply-hunk t - "*Non-nil means `diff-apply-hunk' will move to the next hunk after applying." + "Non-nil means `diff-apply-hunk' will move to the next hunk after applying." :type 'boolean :group 'diff-mode) @@ -517,7 +517,7 @@ res (goto-char start) (error "Can't find the beginning of the file"))))) - + (defun diff-end-of-file () (re-search-forward "^[-+#!<>0-9@* \\]" nil t) @@ -571,7 +571,7 @@ ;; "index ", "old mode", "new mode", "new file mode" and ;; "deleted file mode" are output by git-diff. -(defconst diff-file-junk-re +(defconst diff-file-junk-re "diff \\|index \\|\\(?:deleted file\\|new\\(?: file\\)?\\|old\\) mode") (defun diff-beginning-of-file-and-junk () @@ -620,7 +620,7 @@ ;; a file diff but elsewhere. (goto-char orig) (signal (car err) (cdr err))))) - + (defun diff-file-kill () "Kill current file's hunks." (interactive) @@ -1635,7 +1635,7 @@ ;; for diff-goto-source, and is thus confusing. Also when you don't ;; know about it it's pretty surprising. ;; TODO: make it possible to ask explicitly for this behavior. - ;; + ;; ;; This is duplicated in diff-test-hunk. (diff-find-source-location nil reverse) (cond
--- a/lisp/diff.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/diff.el Wed Dec 03 05:48:14 2008 +0000 @@ -35,13 +35,13 @@ ;;;###autoload (defcustom diff-switches "-c" - "*A string or list of strings specifying switches to be passed to diff." + "A string or list of strings specifying switches to be passed to diff." :type '(choice string (repeat string)) :group 'diff) ;;;###autoload (defcustom diff-command "diff" - "*The command to use to run diff." + "The command to use to run diff." :type 'string :group 'diff)
--- a/lisp/dired-aux.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/dired-aux.el Wed Dec 03 05:48:14 2008 +0000 @@ -1166,7 +1166,7 @@ ;;; Copy, move/rename, making hard and symbolic links (defcustom dired-backup-overwrite nil - "*Non-nil if Dired should ask about making backups before overwriting files. + "Non-nil if Dired should ask about making backups before overwriting files. Special value `always' suppresses confirmation." :type '(choice (const :tag "off" nil) (const :tag "suppress" always) @@ -2304,7 +2304,7 @@ ;; Search only in file names in the Dired buffer. (defcustom dired-isearch-filenames nil - "*Non-nil to Isearch in file names only. + "Non-nil to Isearch in file names only. If t, Isearch in Dired always matches only file names. If `dwim', Isearch matches file names when initial point position is on a file name. Otherwise, it searches the whole buffer without restrictions."
--- a/lisp/dired-x.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/dired-x.el Wed Dec 03 05:48:14 2008 +0000 @@ -122,29 +122,29 @@ :group 'dired-x) (defcustom dired-bind-vm nil - "*Non-nil means \"V\" runs `dired-vm', otherwise \"V\" runs `dired-rmail'. + "Non-nil means \"V\" runs `dired-vm', otherwise \"V\" runs `dired-rmail'. Also, RMAIL files contain -*- rmail -*- at the top so \"f\", `dired-advertised-find-file', will run rmail." :type 'boolean :group 'dired-keys) (defcustom dired-bind-jump t - "*Non-nil means bind `dired-jump' to C-x C-j, otherwise do not." + "Non-nil means bind `dired-jump' to C-x C-j, otherwise do not." :type 'boolean :group 'dired-keys) (defcustom dired-bind-man t - "*Non-nil means bind `dired-man' to \"N\" in dired-mode, otherwise do not." + "Non-nil means bind `dired-man' to \"N\" in dired-mode, otherwise do not." :type 'boolean :group 'dired-keys) (defcustom dired-bind-info t - "*Non-nil means bind `dired-info' to \"I\" in dired-mode, otherwise do not." + "Non-nil means bind `dired-info' to \"I\" in dired-mode, otherwise do not." :type 'boolean :group 'dired-keys) (defcustom dired-vm-read-only-folders nil - "*If non-nil, \\[dired-vm] will visit all folders read-only. + "If non-nil, \\[dired-vm] will visit all folders read-only. If neither nil nor t, e.g. the symbol `if-file-read-only', only files not writable by you are visited read-only. @@ -171,7 +171,7 @@ (define-obsolete-variable-alias 'dired-omit-files-p 'dired-omit-mode "22.1") (defcustom dired-omit-files "^\\.?#\\|^\\.$\\|^\\.\\.$" - "*Filenames matching this regexp will not be displayed. + "Filenames matching this regexp will not be displayed. This only has effect when `dired-omit-mode' is t. See interactive function `dired-omit-mode' \(\\[dired-omit-mode]\) and variable `dired-omit-extensions'. The default is to omit `.', `..', auto-save @@ -180,7 +180,7 @@ :group 'dired-x) (defcustom dired-find-subdir nil ; t is pretty near to DWIM... - "*If non-nil, Dired always finds a directory in a buffer of its own. + "If non-nil, Dired always finds a directory in a buffer of its own. If nil, Dired finds the directory as a subdirectory in some other buffer if it is present as one. @@ -194,13 +194,13 @@ :group 'dired-x) (defcustom dired-omit-size-limit 30000 - "*Maximum size for the \"omitting\" feature. + "Maximum size for the \"omitting\" feature. If nil, there is no maximum size." :type '(choice (const :tag "no maximum" nil) integer) :group 'dired-x) (defcustom dired-enable-local-variables t - "*Control use of local-variables lists in Dired. + "Control use of local-variables lists in Dired. The value can be t, nil or something else. A value of t means local-variables lists are obeyed; nil means they are ignored; anything else means query. @@ -213,7 +213,7 @@ (defcustom dired-guess-shell-gnutar (when (or (eq system-type 'gnu) (eq system-type 'gnu/linux)) "tar") - "*If non-nil, name of GNU tar executable. + "If non-nil, name of GNU tar executable. \(E.g., \"tar\" or \"gtar\"). The `z' switch will be used with it for compressed or gzip'ed tar files. If you don't have GNU tar, set this to nil: a pipe using `zcat' or `gunzip -c' will be used." @@ -222,18 +222,18 @@ :group 'dired-x) (defcustom dired-guess-shell-gzip-quiet t - "*Non-nil says pass -q to gzip overriding verbose GZIP environment." + "Non-nil says pass -q to gzip overriding verbose GZIP environment." :type 'boolean :group 'dired-x) (defcustom dired-guess-shell-znew-switches nil - "*If non-nil, then string of switches passed to `znew', example: \"-K\"." + "If non-nil, then string of switches passed to `znew', example: \"-K\"." :type '(choice (const :tag "None" nil) (string :tag "Switches")) :group 'dired-x) (defcustom dired-clean-up-buffers-too t - "*Non-nil means offer to kill buffers visiting files and dirs deleted in Dired." + "Non-nil means offer to kill buffers visiting files and dirs deleted in Dired." :type 'boolean :group 'dired-x)
--- a/lisp/dired.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/dired.el Wed Dec 03 05:48:14 2008 +0000 @@ -50,7 +50,7 @@ ;;;###autoload (defcustom dired-listing-switches "-al" - "*Switches passed to `ls' for Dired. MUST contain the `l' option. + "Switches passed to `ls' for Dired. MUST contain the `l' option. May contain all other options that don't contradict `-l'; may contain even `F', `b', `i' and `s'. See also the variable `dired-ls-F-marks-symlinks' concerning the `F' switch. @@ -88,7 +88,7 @@ ;;;###autoload (defcustom dired-ls-F-marks-symlinks nil - "*Informs Dired about how `ls -lF' marks symbolic links. + "Informs Dired about how `ls -lF' marks symbolic links. Set this to t if `ls' (or whatever program is specified by `insert-directory-program') with `-lF' marks the symbolic link itself with a trailing @ (usually the case under Ultrix). @@ -105,7 +105,7 @@ ;;;###autoload (defcustom dired-trivial-filenames "^\\.\\.?$\\|^#" - "*Regexp of files to skip when finding first file of a directory. + "Regexp of files to skip when finding first file of a directory. A value of nil means move to the subdir line. A value of t means move to first file." :type '(choice (const :tag "Move to subdir" nil) @@ -116,7 +116,7 @@ ;;;###autoload (defcustom dired-keep-marker-rename t ;; Use t as default so that moved files "take their markers with them". - "*Controls marking of renamed files. + "Controls marking of renamed files. If t, files keep their previous marks when they are renamed. If a character, renamed files (whether previously marked or not) are afterward marked with that character." @@ -126,7 +126,7 @@ ;;;###autoload (defcustom dired-keep-marker-copy ?C - "*Controls marking of copied files. + "Controls marking of copied files. If t, copied files are marked if and as the corresponding original files were. If a character, copied files are unconditionally marked with that character." :type '(choice (const :tag "Keep" t) @@ -135,7 +135,7 @@ ;;;###autoload (defcustom dired-keep-marker-hardlink ?H - "*Controls marking of newly made hard links. + "Controls marking of newly made hard links. If t, they are marked if and as the files linked to were marked. If a character, new links are unconditionally marked with that character." :type '(choice (const :tag "Keep" t) @@ -144,7 +144,7 @@ ;;;###autoload (defcustom dired-keep-marker-symlink ?Y - "*Controls marking of newly made symbolic links. + "Controls marking of newly made symbolic links. If t, they are marked if and as the files linked to were marked. If a character, new links are unconditionally marked with that character." :type '(choice (const :tag "Keep" t) @@ -153,7 +153,7 @@ ;;;###autoload (defcustom dired-dwim-target nil - "*If non-nil, Dired tries to guess a default target directory. + "If non-nil, Dired tries to guess a default target directory. This means: if there is a dired buffer displayed in the next window, use its current subdir, instead of the current subdir of this dired buffer. @@ -163,7 +163,7 @@ ;;;###autoload (defcustom dired-copy-preserve-time t - "*If non-nil, Dired preserves the last-modified time in a file copy. + "If non-nil, Dired preserves the last-modified time in a file copy. \(This works on only some systems.)" :type 'boolean :group 'dired) @@ -2497,7 +2497,7 @@ ;; Deleting files (defcustom dired-recursive-deletes 'top - "*Decide whether recursive deletes are allowed. + "Decide whether recursive deletes are allowed. A value of nil means no recursive deletes. `always' means delete recursively without asking. This is DANGEROUS! `top' means ask for each directory at top level, but delete its subdirectories @@ -3325,7 +3325,7 @@ ;;;; Drag and drop support (defcustom dired-recursive-copies 'top - "*Decide whether recursive copies are allowed. + "Decide whether recursive copies are allowed. A value of nil means no recursive copies. `always' means copy recursively without asking. `top' means ask for each directory at top level.
--- a/lisp/dos-vars.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/dos-vars.el Wed Dec 03 05:48:14 2008 +0000 @@ -30,12 +30,12 @@ :group 'environment) (defcustom msdos-shells '("command.com" "4dos.com" "ndos.com") - "*List of shells that use `/c' instead of `-c' and a backslashed command." + "List of shells that use `/c' instead of `-c' and a backslashed command." :type '(repeat string) :group 'dos-fns) (defcustom dos-codepage-setup-hook nil - "*List of functions to be called after the DOS terminal and coding + "List of functions to be called after the DOS terminal and coding systems are set up. This is the place, e.g., to set specific entries in `standard-display-table' as appropriate for your codepage, if `IT-display-table-setup' doesn't do a perfect job."
--- a/lisp/ediff-diff.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ediff-diff.el Wed Dec 03 05:48:14 2008 +0000 @@ -38,11 +38,11 @@ :group 'ediff) (defcustom ediff-diff-program "diff" - "*Program to use for generating the differential of the two files." + "Program to use for generating the differential of the two files." :type 'string :group 'ediff-diff) (defcustom ediff-diff3-program "diff3" - "*Program to be used for three-way comparison. + "Program to be used for three-way comparison. Must produce output compatible with Unix's diff3 program." :type 'string :group 'ediff-diff) @@ -57,7 +57,7 @@ ((memq system-type '(ms-dos windows-nt windows-95)) shell-file-name) ; no standard name on MS-DOS (t "sh")) ; UNIX - "*The shell used to run diff and patch. + "The shell used to run diff and patch. If user's .profile or .cshrc files are set up correctly, any shell will do. However, some people set $prompt or other things incorrectly, which leads to undesirable output messages. These may @@ -67,13 +67,13 @@ :group 'ediff-diff) (defcustom ediff-cmp-program "cmp" - "*Utility to use to determine if two files are identical. + "Utility to use to determine if two files are identical. It must return code 0, if its arguments are identical files." :type 'string :group 'ediff-diff) (defcustom ediff-cmp-options nil - "*Options to pass to `ediff-cmp-program'. + "Options to pass to `ediff-cmp-program'. If GNU diff is used as `ediff-cmp-program', then the most useful options are `-I REGEXP', to ignore changes whose lines match the REGEXP." :type '(repeat string) @@ -85,7 +85,7 @@ (defcustom ediff-diff-options (if (memq system-type '(ms-dos windows-nt windows-95)) "--binary" "") - "*Options to pass to `ediff-diff-program'. + "Options to pass to `ediff-diff-program'. If Unix diff is used as `ediff-diff-program', then a useful option is `-w', to ignore space. Options `-c', `-u', and `-i' are not allowed. Case sensitivity can be @@ -107,12 +107,12 @@ Use `setq-default' if setting it in .emacs") (defcustom ediff-ignore-case-option "-i" - "*Option that causes the diff program to ignore case of letters." + "Option that causes the diff program to ignore case of letters." :type 'string :group 'ediff-diff) (defcustom ediff-ignore-case-option3 "" - "*Option that causes the diff3 program to ignore case of letters. + "Option that causes the diff3 program to ignore case of letters. GNU diff3 doesn't have such an option." :type 'string :group 'ediff-diff) @@ -121,12 +121,12 @@ (ediff-defvar-local ediff-actual-diff-options ediff-diff-options "") (defcustom ediff-custom-diff-program ediff-diff-program - "*Program to use for generating custom diff output for saving it in a file. + "Program to use for generating custom diff output for saving it in a file. This output is not used by Ediff internally." :type 'string :group 'ediff-diff) (defcustom ediff-custom-diff-options "-c" - "*Options to pass to `ediff-custom-diff-program'." + "Options to pass to `ediff-custom-diff-program'." :type 'string :group 'ediff-diff) @@ -135,7 +135,7 @@ (defvar ediff-match-diff3-line "^====\\(.?\\)\C-m?$" "Pattern to match lines produced by diff3 that describe differences.") (defcustom ediff-diff3-options "" - "*Options to pass to `ediff-diff3-program'." + "Options to pass to `ediff-diff3-program'." :set 'ediff-set-diff-options :type 'string :group 'ediff-diff) @@ -145,7 +145,7 @@ (defcustom ediff-diff3-ok-lines-regexp "^\\([1-3]:\\|====\\| \\|.*Warning *:\\|.*No newline\\|.*missing newline\\|^\C-m$\\)" - "*Regexp that matches normal output lines from `ediff-diff3-program'. + "Regexp that matches normal output lines from `ediff-diff3-program'. Lines that do not match are assumed to be error messages." :type 'regexp :group 'ediff-diff)
--- a/lisp/ediff-help.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ediff-help.el Wed Dec 03 05:48:14 2008 +0000 @@ -81,7 +81,7 @@ n,SPC -next diff | h -hilighting | rx -restore buf X's old diff j -jump to diff | @ -auto-refinement | * -refine current region gx -goto X's point| ## -ignore whitespace | ! -update diff regions - C-l -recenter | #c -ignore case | % -narrow/widen buffs + C-l -recenter | #c -ignore case | % -narrow/widen buffs v/V -scroll up/dn | #f/#h -focus/hide regions | wx -save buf X </> -scroll lt/rt | X -read-only in buf X | wd -save diff output ~ -swap variants | m -wide display | @@ -139,7 +139,7 @@ See `ediff-brief-help-message-function' for more.") (defcustom ediff-use-long-help-message nil - "*If t, Ediff displays a long help message. Short help message otherwise." + "If t, Ediff displays a long help message. Short help message otherwise." :type 'boolean :group 'ediff-window)
--- a/lisp/ediff-init.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ediff-init.el Wed Dec 03 05:48:14 2008 +0000 @@ -387,82 +387,82 @@ ;; Hook variables (defcustom ediff-before-setup-hook nil - "*Hooks to run before Ediff begins to set up windows and buffers. + "Hooks to run before Ediff begins to set up windows and buffers. This hook can be used to save the previous window config, which can be restored on ediff-quit or ediff-suspend." :type 'hook :group 'ediff-hook) (defcustom ediff-before-setup-windows-hook nil - "*Hooks to run before Ediff sets its window configuration. + "Hooks to run before Ediff sets its window configuration. This hook is run every time when Ediff arranges its windows. This happens each time Ediff detects that the windows were messed up by the user." :type 'hook :group 'ediff-hook) (defcustom ediff-after-setup-windows-hook nil - "*Hooks to run after Ediff sets its window configuration. + "Hooks to run after Ediff sets its window configuration. This can be used to set up control window or icon in a desired place." :type 'hook :group 'ediff-hook) (defcustom ediff-before-setup-control-frame-hook nil - "*Hooks run before setting up the frame to display Ediff Control Panel. + "Hooks run before setting up the frame to display Ediff Control Panel. Can be used to change control frame parameters to position it where it is desirable." :type 'hook :group 'ediff-hook) (defcustom ediff-after-setup-control-frame-hook nil - "*Hooks run after setting up the frame to display Ediff Control Panel. + "Hooks run after setting up the frame to display Ediff Control Panel. Can be used to move the frame where it is desired." :type 'hook :group 'ediff-hook) (defcustom ediff-startup-hook nil - "*Hooks to run in the control buffer after Ediff has been set up and is ready for the job." + "Hooks to run in the control buffer after Ediff has been set up and is ready for the job." :type 'hook :group 'ediff-hook) (defcustom ediff-select-hook nil - "*Hooks to run after a difference has been selected." + "Hooks to run after a difference has been selected." :type 'hook :group 'ediff-hook) (defcustom ediff-unselect-hook nil - "*Hooks to run after a difference has been unselected." + "Hooks to run after a difference has been unselected." :type 'hook :group 'ediff-hook) (defcustom ediff-prepare-buffer-hook nil - "*Hooks run after buffers A, B, and C are set up. + "Hooks run after buffers A, B, and C are set up. For each buffer, the hooks are run with that buffer made current." :type 'hook :group 'ediff-hook) (defcustom ediff-load-hook nil - "*Hook run after Ediff is loaded. Can be used to change defaults." + "Hook run after Ediff is loaded. Can be used to change defaults." :type 'hook :group 'ediff-hook) (defcustom ediff-mode-hook nil - "*Hook run just after ediff-mode is set up in the control buffer. + "Hook run just after ediff-mode is set up in the control buffer. This is done before any windows or frames are created. One can use it to set local variables that determine how the display looks like." :type 'hook :group 'ediff-hook) (defcustom ediff-keymap-setup-hook nil - "*Hook run just after the default bindings in Ediff keymap are set up." + "Hook run just after the default bindings in Ediff keymap are set up." :type 'hook :group 'ediff-hook) (defcustom ediff-display-help-hook nil - "*Hooks run after preparing the help message." + "Hooks run after preparing the help message." :type 'hook :group 'ediff-hook) (defcustom ediff-suspend-hook nil - "*Hooks to run in the Ediff control buffer when Ediff is suspended." + "Hooks to run in the Ediff control buffer when Ediff is suspended." :type 'hook :group 'ediff-hook) (defcustom ediff-quit-hook nil - "*Hooks to run in the Ediff control buffer after finishing Ediff." + "Hooks to run in the Ediff control buffer after finishing Ediff." :type 'hook :group 'ediff-hook) (defcustom ediff-cleanup-hook nil - "*Hooks to run on exiting Ediff but before killing the control and variant buffers." + "Hooks to run on exiting Ediff but before killing the control and variant buffers." :type 'hook :group 'ediff-hook) @@ -537,24 +537,24 @@ ;; Highlighting (defcustom ediff-before-flag-bol (if (featurep 'xemacs) (make-glyph "->>") "->>") - "*Flag placed before a highlighted block of differences, if block starts at beginning of a line." + "Flag placed before a highlighted block of differences, if block starts at beginning of a line." :type 'string :tag "Region before-flag at beginning of line" :group 'ediff) (defcustom ediff-after-flag-eol (if (featurep 'xemacs) (make-glyph "<<-") "<<-") - "*Flag placed after a highlighted block of differences, if block ends at end of a line." + "Flag placed after a highlighted block of differences, if block ends at end of a line." :type 'string :tag "Region after-flag at end of line" :group 'ediff) (defcustom ediff-before-flag-mol (if (featurep 'xemacs) (make-glyph "->>") "->>") - "*Flag placed before a highlighted block of differences, if block starts in mid-line." + "Flag placed before a highlighted block of differences, if block starts in mid-line." :type 'string :tag "Region before-flag in the middle of line" :group 'ediff) (defcustom ediff-after-flag-mol (if (featurep 'xemacs) (make-glyph "<<-") "<<-") - "*Flag placed after a highlighted block of differences, if block ends in mid-line." + "Flag placed after a highlighted block of differences, if block ends in mid-line." :type 'string :tag "Region after-flag in the middle of line" :group 'ediff) @@ -598,7 +598,7 @@ Actually, Ediff restores the scope of visibility that existed at startup.") (defcustom ediff-keep-variants t - "*nil means prompt to remove unmodified buffers A/B/C at session end. + "nil means prompt to remove unmodified buffers A/B/C at session end. Supplying a prefix argument to the quit command `q' temporarily reverses the meaning of this variable." :type 'boolean @@ -718,7 +718,7 @@ :group 'ediff) (defcustom ediff-coding-system-for-read 'raw-text - "*The coding system for read to use when running the diff program as a subprocess. + "The coding system for read to use when running the diff program as a subprocess. In most cases, the default will do. However, under certain circumstances in MS-Windows you might need to use something like 'raw-text-dos here. So, if the output that your diff program sends to Emacs contains extra ^M's, @@ -728,7 +728,7 @@ :group 'ediff) (defcustom ediff-coding-system-for-write 'emacs-internal - "*The coding system for write to use when writing out difference regions + "The coding system for write to use when writing out difference regions to temp files in buffer jobs and when Ediff needs to find fine differences." :type 'symbol :group 'ediff) @@ -1355,7 +1355,7 @@ control is used, it could be `vc-toggle-read-only' or `rcs-toggle-read-only'.") (defcustom ediff-make-buffers-readonly-at-startup nil - "*Make all variant buffers read-only when Ediff starts up. + "Make all variant buffers read-only when Ediff starts up. This property can be toggled interactively." :type 'boolean :group 'ediff) @@ -1367,7 +1367,7 @@ (defvar ediff-verbose-p t) (defcustom ediff-autostore-merges 'group-jobs-only - "*Save the results of merge jobs automatically. + "Save the results of merge jobs automatically. With value nil, don't save automatically. With value t, always save. Anything else means save automatically only if the merge job is part of a group of jobs, such as `ediff-merge-directory' @@ -1380,12 +1380,12 @@ (ediff-defvar-local ediff-merge-store-file nil "") (defcustom ediff-merge-filename-prefix "merge_" - "*Prefix to be attached to saved merge buffers." + "Prefix to be attached to saved merge buffers." :type 'string :group 'ediff-merge) (defcustom ediff-no-emacs-help-in-control-buffer nil - "*Non-nil means C-h should not invoke Emacs help in control buffer. + "Non-nil means C-h should not invoke Emacs help in control buffer. Instead, C-h would jump to previous difference." :type 'boolean :group 'ediff) @@ -1402,13 +1402,13 @@ ;;; (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp")) ;;; (t ;;; (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp")))) - "*Prefix to put on Ediff temporary file names. + "Prefix to put on Ediff temporary file names. Do not start with `~/' or `~USERNAME/'." :type 'string :group 'ediff) (defcustom ediff-temp-file-mode 384 ; u=rw only - "*Mode for Ediff temporary files." + "Mode for Ediff temporary files." :type 'integer :group 'ediff)
--- a/lisp/ediff-merg.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ediff-merg.el Wed Dec 03 05:48:14 2008 +0000 @@ -39,21 +39,21 @@ (require 'ediff-init) (defcustom ediff-quit-merge-hook 'ediff-maybe-save-and-delete-merge - "*Hooks to run before quitting a merge job. + "Hooks to run before quitting a merge job. The most common use is to save and delete the merge buffer." :type 'hook :group 'ediff-merge) (defcustom ediff-default-variant 'combined - "*The variant to be used as a default for buffer C in merging. + "The variant to be used as a default for buffer C in merging. Valid values are the symbols `default-A', `default-B', and `combined'." :type '(radio (const default-A) (const default-B) (const combined)) :group 'ediff-merge) (defcustom ediff-combination-pattern '("<<<<<<< variant A" A ">>>>>>> variant B" B "####### Ancestor" Ancestor "======= end") - "*Pattern to be used for combining difference regions in buffers A and B. + "Pattern to be used for combining difference regions in buffers A and B. The value must be a list of the form \(STRING1 bufspec1 STRING2 bufspec2 STRING3 bufspec3 STRING4) where bufspec is the symbol A, B, or Ancestor. For instance, if the value is @@ -73,7 +73,7 @@ :group 'ediff-merge) (defcustom ediff-show-clashes-only nil - "*If t, show only those diff regions where both buffers disagree with the ancestor. + "If t, show only those diff regions where both buffers disagree with the ancestor. This means that regions that have status prefer-A or prefer-B will be skipped over. A value of nil means show all regions." :type 'boolean @@ -82,7 +82,7 @@ (make-variable-buffer-local 'ediff-show-clashes-only) (defcustom ediff-skip-merge-regions-that-differ-from-default nil - "*If t, show only the regions that have not been changed by the user. + "If t, show only the regions that have not been changed by the user. A region is considered to have been changed if it is different from the current default (`default-A', `default-B', `combined') and it hasn't been marked as `prefer-A' or `prefer-B'.
--- a/lisp/ediff-mult.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ediff-mult.el Wed Dec 03 05:48:14 2008 +0000 @@ -202,47 +202,47 @@ (defvar ediff-session-registry nil) (defcustom ediff-meta-truncate-filenames t - "*If non-nil, truncate long file names in the session group buffers. + "If non-nil, truncate long file names in the session group buffers. This can be toggled with `ediff-toggle-filename-truncation'." :type 'boolean :group 'ediff-mult) (defcustom ediff-meta-mode-hook nil - "*Hooks run just after setting up meta mode." + "Hooks run just after setting up meta mode." :type 'hook :group 'ediff-mult) (defcustom ediff-registry-setup-hook nil - "*Hooks run just after the registry control panel is set up." + "Hooks run just after the registry control panel is set up." :type 'hook :group 'ediff-mult) (defcustom ediff-before-session-group-setup-hooks nil - "*Hooks to run before Ediff arranges the window for group-level operations. + "Hooks to run before Ediff arranges the window for group-level operations. It is used by commands such as `ediff-directories'. This hook can be used to save the previous window config, which can be restored on `ediff-quit', `ediff-suspend', or `ediff-quit-session-group-hook'." :type 'hook :group 'ediff-hook) (defcustom ediff-after-session-group-setup-hook nil - "*Hooks run just after a meta-buffer controlling a session group, such as + "Hooks run just after a meta-buffer controlling a session group, such as ediff-directories, is run." :type 'hook :group 'ediff-mult) (defcustom ediff-quit-session-group-hook nil - "*Hooks run just before exiting a session group." + "Hooks run just before exiting a session group." :type 'hook :group 'ediff-mult) (defcustom ediff-show-registry-hook nil - "*Hooks run just after the registry buffer is shown." + "Hooks run just after the registry buffer is shown." :type 'hook :group 'ediff-mult) (defcustom ediff-show-session-group-hook '(delete-other-windows) - "*Hooks run just after a session group buffer is shown." + "Hooks run just after a session group buffer is shown." :type 'hook :group 'ediff-mult) (defcustom ediff-meta-buffer-keymap-setup-hook nil - "*Hooks run just after setting up the `ediff-meta-buffer-map'. + "Hooks run just after setting up the `ediff-meta-buffer-map'. This keymap controls key bindings in the meta buffer and is a local variable. This means that you can set different bindings for different kinds of meta buffers."
--- a/lisp/ediff-ptch.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ediff-ptch.el Wed Dec 03 05:48:14 2008 +0000 @@ -41,12 +41,12 @@ (require 'ediff-init) (defcustom ediff-patch-program "patch" - "*Name of the program that applies patches. + "Name of the program that applies patches. It is recommended to use GNU-compatible versions." :type 'string :group 'ediff-ptch) (defcustom ediff-patch-options "-f" - "*Options to pass to ediff-patch-program. + "Options to pass to ediff-patch-program. Note: the `-b' option should be specified in `ediff-backup-specs'. @@ -93,7 +93,7 @@ (t ;; traditional `patch' (format "-b %s" ediff-backup-extension)))) - "*Backup directives to pass to the patch program. + "Backup directives to pass to the patch program. Ediff requires that the old version of the file \(before applying the patch\) be saved in a file named `the-patch-file.extension'. Usually `extension' is `.orig', but this can be changed by the user and may depend on the system. @@ -117,7 +117,7 @@ (defcustom ediff-patch-default-directory nil - "*Default directory to look for patches." + "Default directory to look for patches." :type '(choice (const nil) string) :group 'ediff-ptch) @@ -129,7 +129,7 @@ "\\|" ; GNU unified format diff 2-liner "^--- +\\([^ \t]+\\)[\t ]+.*\n\\+\\+\\+ +\\([^ \t]+\\)" "\\)") - "*Regexp matching filename 2-liners at the start of each context diff. + "Regexp matching filename 2-liners at the start of each context diff. You probably don't want to change that, unless you are using an obscure patch program." :type 'regexp
--- a/lisp/ediff-vers.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ediff-vers.el Wed Dec 03 05:48:14 2008 +0000 @@ -43,7 +43,7 @@ ;; end pacifier (defcustom ediff-keep-tmp-versions nil - "*If t, do not delete temporary previous versions for the files on which + "If t, do not delete temporary previous versions for the files on which comparison or merge operations are being performed." :type 'boolean :group 'ediff-vers
--- a/lisp/ediff-wind.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ediff-wind.el Wed Dec 03 05:48:14 2008 +0000 @@ -68,7 +68,7 @@ 'ediff-setup-windows-plain)) (defcustom ediff-window-setup-function (ediff-choose-window-setup-function-automatically) - "*Function called to set up windows. + "Function called to set up windows. Ediff provides a choice of two functions: `ediff-setup-windows-plain', for doing everything in one frame and `ediff-setup-windows-multiframe', which sets the control panel in a separate frame. By default, the appropriate function is @@ -124,7 +124,7 @@ (defcustom ediff-split-window-function 'split-window-vertically - "*The function used to split the main window between buffer-A and buffer-B. + "The function used to split the main window between buffer-A and buffer-B. You can set it to a horizontal split instead of the default vertical split by setting this variable to `split-window-horizontally'. You can also have your own function to do fancy splits. @@ -137,7 +137,7 @@ :group 'ediff-window) (defcustom ediff-merge-split-window-function 'split-window-horizontally - "*The function used to split the main window between buffer-A and buffer-B. + "The function used to split the main window between buffer-A and buffer-B. You can set it to a vertical split instead of the default horizontal split by setting this variable to `split-window-vertically'. You can also have your own function to do fancy splits. @@ -194,7 +194,7 @@ "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.") (defcustom ediff-grab-mouse t - "*If t, Ediff will always grab the mouse and put it in the control frame. + "If t, Ediff will always grab the mouse and put it in the control frame. If 'maybe, Ediff will do it sometimes, but not after operations that require relatively long time. If nil, the mouse will be entirely user's responsibility." @@ -210,7 +210,7 @@ :group 'ediff-window) (defcustom ediff-control-frame-upward-shift 42 - "*The upward shift of control frame from the top of buffer A's frame. + "The upward shift of control frame from the top of buffer A's frame. Measured in pixels. This is used by the default control frame positioning function, `ediff-make-frame-position'. This variable is provided for easy @@ -219,7 +219,7 @@ :group 'ediff-window) (defcustom ediff-narrow-control-frame-leftward-shift (if (featurep 'xemacs) 7 3) - "*The leftward shift of control frame from the right edge of buf A's frame. + "The leftward shift of control frame from the right edge of buf A's frame. Measured in characters. This is used by the default control frame positioning function, `ediff-make-frame-position' to adjust the position of the control frame @@ -229,7 +229,7 @@ :group 'ediff-window) (defcustom ediff-wide-control-frame-rightward-shift 7 - "*The rightward shift of control frame from the left edge of buf A's frame. + "The rightward shift of control frame from the left edge of buf A's frame. Measured in characters. This is used by the default control frame positioning function, `ediff-make-frame-position' to adjust the position of the control frame @@ -261,7 +261,7 @@ (ediff-defvar-local ediff-control-frame nil "") (defcustom ediff-prefer-iconified-control-frame nil - "*If t, keep control panel iconified when help message is off. + "If t, keep control panel iconified when help message is off. This has effect only on a windowing system. If t, hitting `?' to toggle control panel off iconifies it.
--- a/lisp/ediff.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ediff.el Wed Dec 03 05:48:14 2008 +0000 @@ -133,7 +133,7 @@ (defcustom ediff-use-last-dir nil - "*If t, Ediff will use previous directory as default when reading file name." + "If t, Ediff will use previous directory as default when reading file name." :type 'boolean :group 'ediff)
--- a/lisp/emerge.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/emerge.el Wed Dec 03 05:48:14 2008 +0000 @@ -137,55 +137,55 @@ ;; finicky details of their output, including the somewhat strange ;; way they number lines of a file. (defcustom emerge-diff-program "diff" - "*Name of the program which compares two files." + "Name of the program which compares two files." :type 'string :group 'emerge) (defcustom emerge-diff3-program "diff3" - "*Name of the program which compares three files. + "Name of the program which compares three files. Its arguments are the ancestor file and the two variant files." :type 'string :group 'emerge) (defcustom emerge-diff-options "" - "*Options to pass to `emerge-diff-program' and `emerge-diff3-program'." + "Options to pass to `emerge-diff-program' and `emerge-diff3-program'." :type 'string :group 'emerge) (defcustom emerge-match-diff-line (let ((x "\\([0-9]+\\)\\(\\|,\\([0-9]+\\)\\)")) (concat "^" x "\\([acd]\\)" x "$")) - "*Pattern to match lines produced by diff that describe differences. + "Pattern to match lines produced by diff that describe differences. This is as opposed to lines from the source files." :type 'regexp :group 'emerge) (defcustom emerge-diff-ok-lines-regexp "^\\([0-9,]+[acd][0-9,]+$\\|[<>] \\|---\\)" - "*Regexp that matches normal output lines from `emerge-diff-program'. + "Regexp that matches normal output lines from `emerge-diff-program'. Lines that do not match are assumed to be error messages." :type 'regexp :group 'emerge) (defcustom emerge-diff3-ok-lines-regexp "^\\([1-3]:\\|====\\| \\)" - "*Regexp that matches normal output lines from `emerge-diff3-program'. + "Regexp that matches normal output lines from `emerge-diff3-program'. Lines that do not match are assumed to be error messages." :type 'regexp :group 'emerge) (defcustom emerge-rcs-ci-program "ci" - "*Name of the program that checks in RCS revisions." + "Name of the program that checks in RCS revisions." :type 'string :group 'emerge) (defcustom emerge-rcs-co-program "co" - "*Name of the program that checks out RCS revisions." + "Name of the program that checks out RCS revisions." :type 'string :group 'emerge) (defcustom emerge-process-local-variables nil - "*Non-nil if Emerge should process local-variables lists in merge buffers. + "Non-nil if Emerge should process local-variables lists in merge buffers. \(You can explicitly request processing the local-variables by executing `(hack-local-variables)'.)" :type 'boolean :group 'emerge) (defcustom emerge-execute-line-deletions nil - "*If non-nil: `emerge-execute-line' makes no output if an input was deleted. + "If non-nil: `emerge-execute-line' makes no output if an input was deleted. It concludes that an input version has been deleted when an ancestor entry is present, only one A or B entry is present, and an output entry is present. If nil: In such circumstances, the A or B file that is present will be @@ -194,13 +194,13 @@ :group 'emerge) (defcustom emerge-before-flag "vvvvvvvvvvvvvvvvvvvv\n" - "*Flag placed above the highlighted block of code. Must end with newline. + "Flag placed above the highlighted block of code. Must end with newline. Must be set before Emerge is loaded, or emerge-new-flags must be run after setting." :type 'string :group 'emerge) (defcustom emerge-after-flag "^^^^^^^^^^^^^^^^^^^^\n" - "*Flag placed below the highlighted block of code. Must end with newline. + "Flag placed below the highlighted block of code. Must end with newline. Must be set before Emerge is loaded, or emerge-new-flags must be run after setting." :type 'string @@ -209,16 +209,16 @@ ;; Hook variables (defcustom emerge-startup-hook nil - "*Hook to run in the merge buffer after the merge has been set up." + "Hook to run in the merge buffer after the merge has been set up." :type 'hook :group 'emerge) (defcustom emerge-select-hook nil - "*Hook to run after a difference has been selected. + "Hook to run after a difference has been selected. The variable `n' holds the (internal) number of the difference." :type 'hook :group 'emerge) (defcustom emerge-unselect-hook nil - "*Hook to run after a difference has been unselected. + "Hook to run after a difference has been unselected. The variable `n' holds the (internal) number of the difference." :type 'hook :group 'emerge) @@ -227,7 +227,7 @@ ;; Emerge commands. (defcustom emerge-default-last-directories nil - "*If nil, default dir for filenames in emerge is `default-directory'. + "If nil, default dir for filenames in emerge is `default-directory'. If non-nil, filenames complete in the directory of the last argument of the same type to an `emerge-files...' command." :type 'boolean @@ -292,26 +292,26 @@ (emerge-new-flags) (defcustom emerge-min-visible-lines 3 - "*Number of lines that we want to show above and below the flags when we are + "Number of lines that we want to show above and below the flags when we are displaying a difference." :type 'integer :group 'emerge) (defcustom emerge-temp-file-prefix (expand-file-name "emerge" temporary-file-directory) - "*Prefix to put on Emerge temporary file names. + "Prefix to put on Emerge temporary file names. Do not start with `~/' or `~USERNAME/'." :type 'string :group 'emerge) (defcustom emerge-temp-file-mode 384 ; u=rw only - "*Mode for Emerge temporary files." + "Mode for Emerge temporary files." :type 'integer :group 'emerge) (defcustom emerge-combine-versions-template "#ifdef NEW\n%b#else /* not NEW */\n%a#endif /* not NEW */\n" - "*Template for `emerge-combine-versions' to combine the two versions. + "Template for `emerge-combine-versions' to combine the two versions. The template is inserted as a string, with the following interpolations: %a the A version of the difference %b the B version of the difference @@ -343,7 +343,7 @@ (make-sparse-keymap "Move")) (defcustom emerge-command-prefix "\C-c\C-c" - "*Command prefix for Emerge commands in `edit' mode. + "Command prefix for Emerge commands in `edit' mode. Must be set before Emerge is loaded." :type 'string :group 'emerge)
--- a/lisp/facemenu.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/facemenu.el Wed Dec 03 05:48:14 2008 +0000 @@ -120,7 +120,7 @@ :group 'facemenu) (defcustom facemenu-new-faces-at-end t - "*Where in the menu to insert newly-created faces. + "Where in the menu to insert newly-created faces. This should be nil to put them at the top of the menu, or t to put them just before \"Other\" at the end." :type 'boolean @@ -136,7 +136,7 @@ "22.1,\n and has no effect on the Face menu") (defcustom facemenu-listed-faces nil - "*List of faces to include in the Face menu. + "List of faces to include in the Face menu. Each element should be a symbol, the name of a face. The \"basic \" faces in `facemenu-keybindings' are automatically added to the Face menu, and need not be in this list.
--- a/lisp/faces.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/faces.el Wed Dec 03 05:48:14 2008 +0000 @@ -49,7 +49,7 @@ (defcustom face-font-selection-order '(:width :height :weight :slant) - "*A list specifying how face font selection chooses fonts. + "A list specifying how face font selection chooses fonts. Each of the four symbols `:width', `:height', `:weight', and `:slant' must appear once in the list, and the list must not contain any other elements. Font selection first tries to find a best matching font @@ -73,7 +73,7 @@ ("courier" "CMU Typewriter Text" "fixed") ("Sans Serif" "helv" "helvetica" "arial" "fixed") ("helv" "helvetica" "arial" "fixed")) - "*Alist of alternative font family names. + "Alist of alternative font family names. Each element has the form (FAMILY ALTERNATIVE1 ALTERNATIVE2 ...). If fonts of family FAMILY can't be loaded, try ALTERNATIVE1, then ALTERNATIVE2 etc." @@ -97,7 +97,7 @@ ("jisx0208.1990" "jisx0208.1983" "jisx0208.1978") ("ksc5601.1989" "ksx1001.1992" "ksc5601.1987") ("muletibetan-2" "muletibetan-0"))) - "*Alist of alternative font registry names. + "Alist of alternative font registry names. Each element has the form (REGISTRY ALTERNATIVE1 ALTERNATIVE2 ...). If fonts of registry REGISTRY can be loaded, font selection tries to find a best matching font among all fonts of registry @@ -303,7 +303,7 @@ (:italic (".attributeItalic" . "Face.AttributeItalic")) (:font (".attributeFont" . "Face.AttributeFont")) (:inherit (".attributeInherit" . "Face.AttributeInherit"))) - "*List of X resources and classes for face attributes. + "List of X resources and classes for face attributes. Each element has the form (ATTRIBUTE ENTRY1 ENTRY2...) where ATTRIBUTE is the name of a face attribute, and each ENTRY is a cons of the form \(RESOURCE . CLASS) with RESOURCE being the resource and CLASS being the @@ -1812,7 +1812,7 @@ ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (defcustom frame-background-mode nil - "*The brightness of the background. + "The brightness of the background. Set this to the symbol `dark' if your background color is dark, `light' if your background is light, or nil (automatic by default) if you want Emacs to examine the brightness for you. Don't set this @@ -2016,7 +2016,7 @@ ;; X resouces for the default face are applied during ;; x-create-frame. (and (not (eq face 'default)) - (memq (window-system frame) '(x w32 ns)) + (memq (window-system frame) '(x w32 ns)) (make-face-x-resource-internal face frame)) ;; Apply attributes specified by face-new-frame-defaults (internal-merge-in-global-face face frame))
--- a/lisp/ffap.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ffap.el Wed Dec 03 05:48:14 2008 +0000 @@ -148,7 +148,7 @@ ;; This used to test for ange-ftp or efs being present, but it should be ;; harmless (and simpler) to give it this value unconditionally. "\\`/[^/:]+:" - "*File names matching this regexp are treated as remote ffap. + "File names matching this regexp are treated as remote ffap. If nil, ffap neither recognizes nor generates such names." :type '(choice (const :tag "Disable" nil) (const :tag "Standard" "\\`/[^/:]+:") @@ -156,18 +156,18 @@ :group 'ffap) (defcustom ffap-url-unwrap-local t - "*If non-nil, convert `file:' URL to local file name before prompting." + "If non-nil, convert `file:' URL to local file name before prompting." :type 'boolean :group 'ffap) (defcustom ffap-url-unwrap-remote t - "*If non-nil, convert `ftp:' URL to remote file name before prompting. + "If non-nil, convert `ftp:' URL to remote file name before prompting. This is ignored if `ffap-ftp-regexp' is nil." :type 'boolean :group 'ffap) (defcustom ffap-ftp-default-user "anonymous" - "*User name in ftp file names generated by `ffap-host-to-path'. + "User name in ftp file names generated by `ffap-host-to-path'. Note this name may be omitted if it equals the default \(either `efs-default-user' or `ange-ftp-default-user'\)." :type 'string @@ -177,7 +177,7 @@ ;; Remote file access built into file system? HP rfa or Andrew afs: "\\`/\\(afs\\|net\\)/." ;; afs only: (and (file-exists-p "/afs") "\\`/afs/.") - "*Matching file names are treated as remote. Use nil to disable." + "Matching file names are treated as remote. Use nil to disable." :type 'regexp :group 'ffap) @@ -194,7 +194,7 @@ "Regexp matching URL's. nil to disable URL features in ffap.") (defcustom ffap-foo-at-bar-prefix "mailto" - "*Presumed URL prefix type of strings like \"<foo.9z@bar>\". + "Presumed URL prefix type of strings like \"<foo.9z@bar>\". Sensible values are nil, \"news\", or \"mailto\"." :type '(choice (const "mailto") (const "news") @@ -213,7 +213,7 @@ ;; enabler in your .emacs file. (defcustom ffap-dired-wildcards "[*?][^/]*\\'" - "*A regexp matching filename wildcard characters, or nil. + "A regexp matching filename wildcard characters, or nil. If `find-file-at-point' gets a filename matching this pattern, and `ffap-pass-wildcards-to-dired' is nil, it passes it on to @@ -233,33 +233,33 @@ :group 'ffap) (defcustom ffap-pass-wildcards-to-dired nil - "*If non-nil, pass filenames matching `ffap-dired-wildcards' to dired." + "If non-nil, pass filenames matching `ffap-dired-wildcards' to dired." :type 'boolean :group 'ffap) (defcustom ffap-newfile-prompt nil ;; Suggestion from RHOGEE, 11 Jul 1994. Disabled, I think this is ;; better handled by `find-file-not-found-hooks'. - "*Whether `find-file-at-point' prompts about a nonexistent file." + "Whether `find-file-at-point' prompts about a nonexistent file." :type 'boolean :group 'ffap) (defcustom ffap-require-prefix nil ;; Suggestion from RHOGEE, 20 Oct 1994. - "*If set, reverses the prefix argument to `find-file-at-point'. + "If set, reverses the prefix argument to `find-file-at-point'. This is nil so neophytes notice ffap. Experts may prefer to disable ffap most of the time." :type 'boolean :group 'ffap) (defcustom ffap-file-finder 'find-file - "*The command called by `find-file-at-point' to find a file." + "The command called by `find-file-at-point' to find a file." :type 'function :group 'ffap) (put 'ffap-file-finder 'risky-local-variable t) (defcustom ffap-directory-finder 'dired - "*The command called by `dired-at-point' to find a directory." + "The command called by `dired-at-point' to find a directory." :type 'function :group 'ffap) (put 'ffap-directory-finder 'risky-local-variable t) @@ -271,7 +271,7 @@ ;; Remote control references: ;; http://www.ncsa.uiuc.edu/SDG/Software/XMosaic/remote-control.html ;; http://home.netscape.com/newsref/std/x-remote.html - "*A function of one argument, called by ffap to fetch an URL. + "A function of one argument, called by ffap to fetch an URL. Reasonable choices are `w3-fetch' or a `browse-url-*' function. For a fancy alternative, get `ffap-url.el'." :type '(choice (const w3-fetch) @@ -309,7 +309,7 @@ ;; It pays to put a big fancy regexp here, since ffap-guesser is ;; much more time-consuming than regexp searching: "[/:.~[:alpha:]]/\\|@[[:alpha:]][-[:alnum:]]*\\." - "*Regular expression governing movements of `ffap-next'." + "Regular expression governing movements of `ffap-next'." :type 'regexp :group 'ffap) @@ -375,14 +375,14 @@ ;; particular, if `Pinging...' is broken or takes too long on your ;; machine, try setting these all to accept or reject. (defcustom ffap-machine-p-local 'reject ; this happens often - "*What `ffap-machine-p' does with hostnames that have no domain. + "What `ffap-machine-p' does with hostnames that have no domain. Value should be a symbol, one of `ping', `accept', and `reject'." :type '(choice (const ping) (const accept) (const reject)) :group 'ffap) (defcustom ffap-machine-p-known 'ping ; `accept' for higher speed - "*What `ffap-machine-p' does with hostnames that have a known domain. + "What `ffap-machine-p' does with hostnames that have a known domain. Value should be a symbol, one of `ping', `accept', and `reject'. See `mail-extr.el' for the known domains." :type '(choice (const ping) @@ -390,7 +390,7 @@ (const reject)) :group 'ffap) (defcustom ffap-machine-p-unknown 'reject - "*What `ffap-machine-p' does with hostnames that have an unknown domain. + "What `ffap-machine-p' does with hostnames that have an unknown domain. Value should be a symbol, one of `ping', `accept', and `reject'. See `mail-extr.el' for the known domains." :type '(choice (const ping) @@ -1770,7 +1770,7 @@ (defcustom dired-at-point-require-prefix nil - "*If set, reverses the prefix argument to `dired-at-point'. + "If set, reverses the prefix argument to `dired-at-point'. This is nil so neophytes notice ffap. Experts may prefer to disable ffap most of the time." :type 'boolean
--- a/lisp/filecache.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/filecache.el Wed Dec 03 05:48:14 2008 +0000 @@ -157,7 +157,7 @@ (defcustom file-cache-filter-regexps (list "~$" "\\.o$" "\\.exe$" "\\.a$" "\\.elc$" ",v$" "\\.output$" "\\.$" "#$" "\\.class$") - "*List of regular expressions used as filters by the file cache. + "List of regular expressions used as filters by the file cache. File names which match these expressions will not be added to the cache. Note that the functions `file-cache-add-file' and `file-cache-add-file-list' do not use this variable." @@ -165,12 +165,12 @@ :group 'file-cache) (defcustom file-cache-find-command "find" - "*External program used by `file-cache-add-directory-using-find'." + "External program used by `file-cache-add-directory-using-find'." :type 'string :group 'file-cache) (defcustom file-cache-find-command-posix-flag 'not-defined - "*Set to t, if `file-cache-find-command' handles wildcards POSIX style. + "Set to t, if `file-cache-find-command' handles wildcards POSIX style. This variable is automatically set to nil or non-nil if it has the initial value `not-defined' whenever you first call the `file-cache-add-directory-using-find'. @@ -183,7 +183,7 @@ :group 'file-cache) (defcustom file-cache-locate-command "locate" - "*External program used by `file-cache-add-directory-using-locate'." + "External program used by `file-cache-add-directory-using-locate'." :type 'string :group 'file-cache)
--- a/lisp/find-dired.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/find-dired.el Wed Dec 03 05:48:14 2008 +0000 @@ -40,7 +40,7 @@ (defcustom find-ls-option (if (eq system-type 'berkeley-unix) '("-ls" . "-gilsb") '("-exec ls -ld {} \\;" . "-ld")) - "*Description of the option to `find' to produce an `ls -l'-type listing. + "Description of the option to `find' to produce an `ls -l'-type listing. This is a cons of two strings (FIND-OPTION . LS-SWITCHES). FIND-OPTION gives the option (or options) to `find' that produce the desired output. LS-SWITCHES is a list of `ls' switches to tell dired how to parse the output." @@ -64,7 +64,7 @@ (string-match "solaris2" system-configuration) (string-match "irix" system-configuration)) "-s" "-q") - "*Option to grep to be as silent as possible. + "Option to grep to be as silent as possible. On Berkeley systems, this is `-s'; on Posix, and with GNU grep, `-q' does it. On other systems, the closest you can come is to use `-l'." :type 'string @@ -75,7 +75,7 @@ (if read-file-name-completion-ignore-case "-iname" "-name") - "*Argument used to specify file name pattern. + "Argument used to specify file name pattern. If `read-file-name-completion-ignore-case' is non-nil, -iname is used so that find also ignores case. Otherwise, -name is used." :type 'string
--- a/lisp/font-core.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/font-core.el Wed Dec 03 05:48:14 2008 +0000 @@ -262,7 +262,7 @@ ;; would also be contrary to the Principle of Least Surprise. sm. (defcustom font-lock-global-modes t - "*Modes for which Font Lock mode is automagically turned on. + "Modes for which Font Lock mode is automagically turned on. Global Font Lock mode is controlled by the command `global-font-lock-mode'. If nil, means no modes have Font Lock mode automatically turned on. If t, all modes that support Font Lock mode have it automatically turned on.
--- a/lisp/font-lock.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/font-lock.el Wed Dec 03 05:48:14 2008 +0000 @@ -227,7 +227,7 @@ ;; User variables. (defcustom font-lock-maximum-size 256000 - "*Maximum size of a buffer for buffer fontification. + "Maximum size of a buffer for buffer fontification. Only buffers less than this can be fontified when Font Lock mode is turned on. If nil, means size is irrelevant. If a list, each element should be a cons pair of the form (MAJOR-MODE . SIZE), @@ -249,7 +249,7 @@ :group 'font-lock) (defcustom font-lock-maximum-decoration t - "*Maximum decoration level for fontification. + "Maximum decoration level for fontification. If nil, use the default decoration (typically the minimum available). If t, use the maximum decoration available. If a number, use that level of decoration (or if not available the maximum). @@ -274,7 +274,7 @@ :group 'font-lock) (defcustom font-lock-verbose 0 - "*If non-nil, means show status messages for buffer fontification. + "If non-nil, means show status messages for buffer fontification. If a number, only buffers greater than this size have fontification messages." :type '(choice (const :tag "never" nil) (other :tag "always" t) @@ -851,7 +851,7 @@ ;; themselves. (defcustom font-lock-support-mode 'jit-lock-mode - "*Support mode for Font Lock mode. + "Support mode for Font Lock mode. Support modes speed up Font Lock mode by being choosy about when fontification occurs. The default support mode, Just-in-time Lock mode (symbol `jit-lock-mode'), is recommended.
--- a/lisp/forms.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/forms.el Wed Dec 03 05:48:14 2008 +0000 @@ -319,7 +319,7 @@ ;;; Optional variables with default values. (defcustom forms-check-number-of-fields t - "*If non-nil, warn about records with wrong number of fields." + "If non-nil, warn about records with wrong number of fields." :group 'forms :type 'boolean) @@ -334,13 +334,13 @@ If not nil: use this character to separate multi-line fields (default C-k).") (defcustom forms-forms-scroll nil - "*Non-nil means replace scroll-up/down commands in Forms mode. + "Non-nil means replace scroll-up/down commands in Forms mode. The replacement commands performs forms-next/prev-record." :group 'forms :type 'boolean) (defcustom forms-forms-jump nil - "*Non-nil means redefine beginning/end-of-buffer in Forms mode. + "Non-nil means redefine beginning/end-of-buffer in Forms mode. The replacement commands performs forms-first/last-record." :group 'forms :type 'boolean) @@ -366,13 +366,13 @@ The contents may NOT be modified.") (defcustom forms-use-text-properties t - "*Non-nil means: use text properties. + "Non-nil means: use text properties. Defaults to t if this Emacs is capable of handling text properties." :group 'forms :type 'boolean) (defcustom forms-insert-after nil - "*Non-nil means: inserts of new records go after current record. + "Non-nil means: inserts of new records go after current record. Also, initial position is at last record." :group 'forms :type 'boolean)
--- a/lisp/fringe.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/fringe.el Wed Dec 03 05:48:14 2008 +0000 @@ -135,7 +135,7 @@ (custom-initialize-reset symbol value)))) (defcustom fringe-mode nil - "*Specify appearance of fringes on all frames. + "Specify appearance of fringes on all frames. This variable can be nil (the default) meaning the fringes should have the default width (8 pixels), it can be an integer value specifying the width of both left and right fringe (where 0 means no fringe), or
--- a/lisp/help-at-pt.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/help-at-pt.el Wed Dec 03 05:48:14 2008 +0000 @@ -104,7 +104,7 @@ yourself.") (defcustom help-at-pt-timer-delay 1 - "*Delay before displaying local help. + "Delay before displaying local help. This is used if `help-at-pt-display-when-idle' is enabled. The value may be an integer or floating point number. @@ -146,7 +146,7 @@ ;;;###autoload (defcustom help-at-pt-display-when-idle 'never - "*Automatically show local help on point-over. + "Automatically show local help on point-over. If the value is t, the string obtained from any `kbd-help' or `help-echo' property at point is automatically printed in the echo area, if nothing else is already displayed there, or after a
--- a/lisp/hippie-exp.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/hippie-exp.el Wed Dec 03 05:48:14 2008 +0000 @@ -220,31 +220,31 @@ ;;;###autoload (defcustom hippie-expand-verbose t - "*Non-nil makes `hippie-expand' output which function it is trying." + "Non-nil makes `hippie-expand' output which function it is trying." :type 'boolean :group 'hippie-expand) ;;;###autoload (defcustom hippie-expand-dabbrev-skip-space nil - "*Non-nil means tolerate trailing spaces in the abbreviation to expand." + "Non-nil means tolerate trailing spaces in the abbreviation to expand." :group 'hippie-expand :type 'boolean) ;;;###autoload (defcustom hippie-expand-dabbrev-as-symbol t - "*Non-nil means expand as symbols, i.e. syntax `_' is considered a letter." + "Non-nil means expand as symbols, i.e. syntax `_' is considered a letter." :group 'hippie-expand :type 'boolean) ;;;###autoload (defcustom hippie-expand-no-restriction t - "*Non-nil means that narrowed buffers are widened during search." + "Non-nil means that narrowed buffers are widened during search." :group 'hippie-expand :type 'boolean) ;;;###autoload (defcustom hippie-expand-max-buffers () - "*The maximum number of buffers (apart from the current) searched. + "The maximum number of buffers (apart from the current) searched. If nil, all buffers are searched." :type '(choice (const :tag "All" nil) integer) @@ -252,7 +252,7 @@ ;;;###autoload (defcustom hippie-expand-ignore-buffers '("^ \\*.*\\*$" dired-mode) - "*A list specifying which buffers not to search (if not current). + "A list specifying which buffers not to search (if not current). Can contain both regexps matching buffer names (as strings) and major modes \(as atoms)" :type '(repeat (choice regexp (symbol :tag "Major Mode"))) @@ -260,7 +260,7 @@ ;;;###autoload (defcustom hippie-expand-only-buffers () - "*A list specifying the only buffers to search (in addition to current). + "A list specifying the only buffers to search (in addition to current). Can contain both regexps matching buffer names (as strings) and major modes \(as atoms). If non-nil, this variable overrides the variable `hippie-expand-ignore-buffers'."
--- a/lisp/ido.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ido.el Wed Dec 03 05:48:14 2008 +0000 @@ -377,13 +377,13 @@ :group 'ido) (defcustom ido-case-fold case-fold-search - "*Non-nil if searching of buffer and file names should ignore case." + "Non-nil if searching of buffer and file names should ignore case." :type 'boolean :group 'ido) (defcustom ido-ignore-buffers '("\\` ") - "*List of regexps or functions matching buffer names to ignore. + "List of regexps or functions matching buffer names to ignore. For example, traditional behavior is not to list buffers whose names begin with a space, for which the regexp is `\\` '. See the source file for example functions that filter buffer names." @@ -392,7 +392,7 @@ (defcustom ido-ignore-files '("\\`CVS/" "\\`#" "\\`.#" "\\`\\.\\./" "\\`\\./") - "*List of regexps or functions matching file names to ignore. + "List of regexps or functions matching file names to ignore. For example, traditional behavior is not to list files whose names begin with a #, for which the regexp is `\\`#'. See the source file for example functions that filter filenames." @@ -400,18 +400,18 @@ :group 'ido) (defcustom ido-ignore-extensions t - "*Non-nil means ignore files in `completion-ignored-extensions' list." + "Non-nil means ignore files in `completion-ignored-extensions' list." :type 'boolean :group 'ido) (defcustom ido-show-dot-for-dired nil - "*Non-nil means to always put . as the first item in file name lists. + "Non-nil means to always put . as the first item in file name lists. This allows the current directory to be opened immediately with `dired'." :type 'boolean :group 'ido) (defcustom ido-file-extensions-order nil - "*List of file extensions specifying preferred order of file selections. + "List of file extensions specifying preferred order of file selections. Each element is either a string with `.' as the first char, an empty string matching files without extension, or t which is the default order for files with an unlisted file extension." @@ -421,12 +421,12 @@ (defcustom ido-ignore-directories '("\\`CVS/" "\\`\\.\\./" "\\`\\./") - "*List of regexps or functions matching sub-directory names to ignore." + "List of regexps or functions matching sub-directory names to ignore." :type '(repeat (choice regexp function)) :group 'ido) (defcustom ido-ignore-directories-merge nil - "*List of regexps or functions matching directory names to ignore during merge. + "List of regexps or functions matching directory names to ignore during merge. Directory names matched by one of the regexps in this list are not inserted in merged file and directory lists." :type '(repeat (choice regexp function)) @@ -444,7 +444,7 @@ ;;(setq ido-ignore-files '("^ " "\\.c\\'" "\\.h\\'")) (defcustom ido-default-file-method 'raise-frame - "*How to visit a new file when using `ido-find-file'. + "How to visit a new file when using `ido-find-file'. Possible values: `selected-window' Show new file in selected window `other-window' Show new file in another window (same frame) @@ -464,7 +464,7 @@ :group 'ido) (defcustom ido-default-buffer-method 'raise-frame - "*How to switch to new buffer when using `ido-switch-buffer'. + "How to switch to new buffer when using `ido-switch-buffer'. See `ido-default-file-method' for details." :type '(choice (const :tag "Show in selected window" selected-window) (const :tag "Show in other window" other-window) @@ -481,7 +481,7 @@ :group 'ido) (defcustom ido-enable-flex-matching nil - "*Non-nil means that `ido' will do flexible string matching. + "Non-nil means that `ido' will do flexible string matching. Flexible matching means that if the entered string does not match any item, any item containing the entered characters in the given sequence will match." @@ -490,13 +490,13 @@ (defcustom ido-enable-regexp nil - "*Non-nil means that `ido' will do regexp matching. + "Non-nil means that `ido' will do regexp matching. Value can be toggled within `ido' using `ido-toggle-regexp'." :type 'boolean :group 'ido) (defcustom ido-enable-prefix nil - "*Non-nil means only match if the entered text is a prefix of file name. + "Non-nil means only match if the entered text is a prefix of file name. This behavior is like the standard Emacs completion. If nil, match if the entered text is an arbitrary substring. Value can be toggled within `ido' using `ido-toggle-prefix'." @@ -504,21 +504,21 @@ :group 'ido) (defcustom ido-enable-dot-prefix nil - "*Non-nil means to match leading dot as prefix. + "Non-nil means to match leading dot as prefix. I.e. hidden files and buffers will match only if you type a dot as first char even if `ido-enable-prefix' is nil." :type 'boolean :group 'ido) (defcustom ido-confirm-unique-completion nil - "*Non-nil means that even a unique completion must be confirmed. + "Non-nil means that even a unique completion must be confirmed. This means that \\[ido-complete] must always be followed by \\[ido-exit-minibuffer] even when there is only one unique completion." :type 'boolean :group 'ido) (defcustom ido-cannot-complete-command 'ido-completion-help - "*Command run when `ido-complete' can't complete any more. + "Command run when `ido-complete' can't complete any more. The most useful values are `ido-completion-help', which pops up a window with completion alternatives, or `ido-next-match' or `ido-prev-match', which cycle the buffer list." @@ -527,20 +527,20 @@ (defcustom ido-record-commands t - "*Non-nil means that `ido' will record commands in command history. + "Non-nil means that `ido' will record commands in command history. Note that the non-ido equivalent command is recorded." :type 'boolean :group 'ido) (defcustom ido-max-prospects 12 - "*Non-zero means that the prospect list will be limited to that number of items. + "Non-zero means that the prospect list will be limited to that number of items. For a long list of prospects, building the full list for the minibuffer can take a non-negligible amount of time; setting this variable reduces that time." :type 'integer :group 'ido) (defcustom ido-max-file-prompt-width 0.35 - "*Non-zero means that the prompt string be limited to that number of characters. + "Non-zero means that the prompt string be limited to that number of characters. If value is a floating point number, it specifies a fraction of the frame width." :type '(choice (integer :tag "Characters" :value 20) @@ -550,7 +550,7 @@ :group 'ido) (defcustom ido-max-window-height nil - "*Non-nil specifies a value to override `max-mini-window-height'." + "Non-nil specifies a value to override `max-mini-window-height'." :type '(choice (const :tag "Don't override" nil) (integer :tag "Number of lines" :value 1) @@ -561,20 +561,20 @@ :group 'ido) (defcustom ido-enable-last-directory-history t - "*Non-nil means that `ido' will remember latest selected directory names. + "Non-nil means that `ido' will remember latest selected directory names. See `ido-last-directory-list' and `ido-save-directory-list-file'." :type 'boolean :group 'ido) (defcustom ido-max-work-directory-list 50 - "*Maximum number of working directories to record. + "Maximum number of working directories to record. This is the list of directories where files have most recently been opened. See `ido-work-directory-list' and `ido-save-directory-list-file'." :type 'integer :group 'ido) (defcustom ido-work-directory-list-ignore-regexps nil - "*List of regexps matching directories which should not be recorded. + "List of regexps matching directories which should not be recorded. Directory names matched by one of the regexps in this list are not inserted in the `ido-work-directory-list' list." :type '(repeat regexp) @@ -582,7 +582,7 @@ (defcustom ido-use-filename-at-point nil - "*Non-nil means that ido shall look for a filename at point. + "Non-nil means that ido shall look for a filename at point. May use `ffap-guesser' to guess whether text at point is a filename. If found, use that as the starting point for filename selection." :type '(choice @@ -593,44 +593,44 @@ (defcustom ido-use-url-at-point nil - "*Non-nil means that ido shall look for a URL at point. + "Non-nil means that ido shall look for a URL at point. If found, call `find-file-at-point' to visit it." :type 'boolean :group 'ido) (defcustom ido-enable-tramp-completion t - "*Non-nil means that ido shall perform tramp method and server name completion. + "Non-nil means that ido shall perform tramp method and server name completion. A tramp file name uses the following syntax: /method:user@host:filename." :type 'boolean :group 'ido) (defcustom ido-record-ftp-work-directories t - "*Non-nil means record ftp file names in the work directory list." + "Non-nil means record ftp file names in the work directory list." :type 'boolean :group 'ido) (defcustom ido-merge-ftp-work-directories nil - "*If nil, merging ignores ftp file names in the work directory list." + "If nil, merging ignores ftp file names in the work directory list." :type 'boolean :group 'ido) (defcustom ido-cache-ftp-work-directory-time 1.0 - "*Maximum time to cache contents of an ftp directory (in hours). + "Maximum time to cache contents of an ftp directory (in hours). Use C-l in prompt to refresh list. If zero, ftp directories are not cached." :type 'number :group 'ido) (defcustom ido-slow-ftp-hosts nil - "*List of slow ftp hosts where ido prompting should not be used. + "List of slow ftp hosts where ido prompting should not be used. If an ftp host is on this list, ido automatically switches to the non-ido equivalent function, e.g. `find-file' rather than `ido-find-file'." :type '(repeat string) :group 'ido) (defcustom ido-slow-ftp-host-regexps nil - "*List of regexps matching slow ftp hosts (see `ido-slow-ftp-hosts')." + "List of regexps matching slow ftp hosts (see `ido-slow-ftp-hosts')." :type '(repeat regexp) :group 'ido) @@ -638,7 +638,7 @@ "Cached value from `ido-unc-hosts' function.") (defcustom ido-unc-hosts nil - "*List of known UNC host names to complete after initial //. + "List of known UNC host names to complete after initial //. If value is a function, that function is called to search network for hosts on first use of UNC path." :type '(choice (repeat :tag "List of UNC host names" string) @@ -651,32 +651,32 @@ :group 'ido) (defcustom ido-downcase-unc-hosts t - "*Non-nil if UNC host names should be downcased." + "Non-nil if UNC host names should be downcased." :type 'boolean :group 'ido) (defcustom ido-ignore-unc-host-regexps nil - "*List of regexps matching UNC hosts to ignore. + "List of regexps matching UNC hosts to ignore. Case is ignored if `ido-downcase-unc-hosts' is set." :type '(repeat regexp) :group 'ido) (defcustom ido-cache-unc-host-shares-time 8.0 - "*Maximum time to cache shares of an UNC host (in hours). + "Maximum time to cache shares of an UNC host (in hours). Use C-l in prompt to refresh list. If zero, UNC host shares are not cached." :type 'number :group 'ido) (defcustom ido-max-work-file-list 10 - "*Maximum number of names of recently opened files to record. + "Maximum number of names of recently opened files to record. This is the list of the file names (sans directory) which have most recently been opened. See `ido-work-file-list' and `ido-save-directory-list-file'." :type 'integer :group 'ido) (defcustom ido-work-directory-match-only t - "*Non-nil means to skip non-matching directories in the directory history. + "Non-nil means to skip non-matching directories in the directory history. When some text is already entered at the `ido-find-file' prompt, using \\[ido-prev-work-directory] or \\[ido-next-work-directory] will skip directories without any matching entries." @@ -684,7 +684,7 @@ :group 'ido) (defcustom ido-auto-merge-work-directories-length 0 - "*Automatically switch to merged work directories during file name input. + "Automatically switch to merged work directories during file name input. The value is number of characters to type before switching to merged mode. If zero, the switch happens when no matches are found in the current directory. Automatic merging is disabled if the value is negative." @@ -692,12 +692,12 @@ :group 'ido) (defcustom ido-auto-merge-delay-time 0.70 - "*Delay in seconds to wait for more input before doing auto merge." + "Delay in seconds to wait for more input before doing auto merge." :type 'number :group 'ido) (defcustom ido-auto-merge-inhibit-characters-regexp "[][*?~]" - "*Regexp matching characters which should inhibit automatic merging. + "Regexp matching characters which should inhibit automatic merging. When a (partial) file name matches this regexp, merging is inhibited." :type 'regexp :group 'ido) @@ -708,7 +708,7 @@ :group 'ido) (defcustom ido-max-dir-file-cache 100 - "*Maximum number of working directories to be cached. + "Maximum number of working directories to be cached. This is the size of the cache of `file-name-all-completions' results. Each cache entry is time stamped with the modification time of the directory. Some systems, like Windows, have unreliable directory @@ -720,7 +720,7 @@ :group 'ido) (defcustom ido-max-directory-size 30000 - "*Maximum size (in bytes) for directories to use ido completion. + "Maximum size (in bytes) for directories to use ido completion. If you enter a directory with a size larger than this size, ido will not provide the normal completion. To show the completions, use C-a." :type '(choice (const :tag "No limit" nil) @@ -728,12 +728,12 @@ :group 'ido) (defcustom ido-rotate-file-list-default nil - "*Non-nil means that `ido' will always rotate file list to get default in front." + "Non-nil means that `ido' will always rotate file list to get default in front." :type 'boolean :group 'ido) (defcustom ido-enter-matching-directory 'only - "*Additional methods to enter sub-directory of first/only matching item. + "Additional methods to enter sub-directory of first/only matching item. If value is 'first, enter first matching sub-directory when typing a slash. If value is 'only, typing a slash only enters the sub-directory if it is the only matching item. @@ -746,7 +746,7 @@ :group 'ido) (defcustom ido-create-new-buffer 'prompt - "*Specify whether a new buffer is created if no buffer matches substring. + "Specify whether a new buffer is created if no buffer matches substring. Choices are 'always to create new buffers unconditionally, 'prompt to ask user whether to create buffer, or 'never to never create new buffer." :type '(choice (const always) @@ -755,7 +755,7 @@ :group 'ido) (defcustom ido-setup-hook nil - "*Hook run after the ido variables and keymap have been setup. + "Hook run after the ido variables and keymap have been setup. The dynamic variable `ido-cur-item' contains the current type of item that is read by ido; possible values are file, dir, buffer, and list. Additional keys can be defined in `ido-completion-map'." @@ -763,13 +763,13 @@ :group 'ido) (defcustom ido-separator nil - "*String used by ido to separate the alternatives in the minibuffer. + "String used by ido to separate the alternatives in the minibuffer. Obsolete. Set 3rd element of `ido-decorations' instead." :type '(choice string (const nil)) :group 'ido) (defcustom ido-decorations '( "{" "}" " | " " | ..." "[" "]" " [No match]" " [Matched]" " [Not readable]" " [Too big]") - "*List of strings used by ido to display the alternatives in the minibuffer. + "List of strings used by ido to display the alternatives in the minibuffer. There are 10 elements in this list: 1st and 2nd elements are used as brackets around the prospect list, 3rd element is the separator between prospects (ignored if `ido-separator' is set), @@ -784,19 +784,19 @@ :group 'ido) (defcustom ido-use-faces t - "*Non-nil means use ido faces to highlighting first match, only match and + "Non-nil means use ido faces to highlighting first match, only match and subdirs in the alternatives." :type 'boolean :group 'ido) (defface ido-first-match '((t (:bold t))) - "*Face used by ido for highlighting first match." + "Face used by ido for highlighting first match." :group 'ido) (defface ido-only-match '((((class color)) (:foreground "ForestGreen")) (t (:italic t))) - "*Face used by ido for highlighting only match." + "Face used by ido for highlighting only match." :group 'ido) (defface ido-subdir '((((min-colors 88) (class color)) @@ -804,7 +804,7 @@ (((class color)) (:foreground "red")) (t (:underline t))) - "*Face used by ido for highlighting subdirs in the alternatives." + "Face used by ido for highlighting subdirs in the alternatives." :group 'ido) (defface ido-indicator '((((min-colors 88) (class color)) @@ -816,7 +816,7 @@ :background "red" :width condensed)) (t (:inverse-video t))) - "*Face used by ido for highlighting its indicators." + "Face used by ido for highlighting its indicators." :group 'ido) (defface ido-incomplete-regexp @@ -826,28 +826,28 @@ :group 'ido) (defcustom ido-make-file-list-hook nil - "*List of functions to run when the list of matching files is created. + "List of functions to run when the list of matching files is created. Each function on the list may modify the dynamically bound variable `ido-temp-list' which contains the current list of matching files." :type 'hook :group 'ido) (defcustom ido-make-dir-list-hook nil - "*List of functions to run when the list of matching directories is created. + "List of functions to run when the list of matching directories is created. Each function on the list may modify the dynamically bound variable `ido-temp-list' which contains the current list of matching directories." :type 'hook :group 'ido) (defcustom ido-make-buffer-list-hook nil - "*List of functions to run when the list of matching buffers is created. + "List of functions to run when the list of matching buffers is created. Each function on the list may modify the dynamically bound variable `ido-temp-list' which contains the current list of matching buffer names." :type 'hook :group 'ido) (defcustom ido-rewrite-file-prompt-functions nil - "*List of functions to run when the find-file prompt is created. + "List of functions to run when the find-file prompt is created. Each function on the list may modify the following dynamically bound variables: dirname - the (abbreviated) directory name @@ -875,13 +875,13 @@ `ido-rewrite-file-prompt-functions'.") (defcustom ido-completion-buffer "*Ido Completions*" - "*Name of completion buffer used by ido. + "Name of completion buffer used by ido. Set to nil to disable completion buffers popping up." :type 'string :group 'ido) (defcustom ido-completion-buffer-all-completions nil - "*Non-nil means to show all completions in completion buffer. + "Non-nil means to show all completions in completion buffer. Otherwise, only the current list of matches is shown." :type 'boolean :group 'ido) @@ -891,7 +891,7 @@ See documentation of `walk-windows' for useful values.") (defcustom ido-minibuffer-setup-hook nil - "*Ido-specific customization of minibuffer setup. + "Ido-specific customization of minibuffer setup. This hook is run during minibuffer setup if `ido' is active. It is intended for use in customizing ido for interoperation
--- a/lisp/image-file.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/image-file.el Wed Dec 03 05:48:14 2008 +0000 @@ -38,7 +38,7 @@ ;;;###autoload (defcustom image-file-name-extensions '("png" "jpeg" "jpg" "gif" "tiff" "tif" "xbm" "xpm" "pbm" "pgm" "ppm" "pnm" "svg") - "*A list of image-file filename extensions. + "A list of image-file filename extensions. Filenames having one of these extensions are considered image files, in addition to those matching `image-file-name-regexps'. @@ -57,7 +57,7 @@ ;;;###autoload (defcustom image-file-name-regexps nil - "*List of regexps matching image-file filenames. + "List of regexps matching image-file filenames. Filenames matching one of these regexps are considered image files, in addition to those with an extension in `image-file-name-extensions'.
--- a/lisp/imenu.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/imenu.el Wed Dec 03 05:48:14 2008 +0000 @@ -76,7 +76,7 @@ :link '(custom-manual "(elisp)Imenu")) (defcustom imenu-use-markers t - "*Non-nil means use markers instead of integers for Imenu buffer positions. + "Non-nil means use markers instead of integers for Imenu buffer positions. Setting this to nil makes Imenu work a little faster but editing the buffer will make the generated index positions wrong. @@ -87,18 +87,18 @@ (defcustom imenu-max-item-length 60 - "*If a number, truncate Imenu entries to that length." + "If a number, truncate Imenu entries to that length." :type '(choice integer (const :tag "Unlimited")) :group 'imenu) (defcustom imenu-auto-rescan nil - "*Non-nil means Imenu should always rescan the buffers." + "Non-nil means Imenu should always rescan the buffers." :type 'boolean :group 'imenu) (defcustom imenu-auto-rescan-maxout 60000 - "*Imenu auto-rescan is disabled in buffers larger than this size (in bytes). + "Imenu auto-rescan is disabled in buffers larger than this size (in bytes). This variable is buffer-local." :type 'integer :group 'imenu) @@ -128,7 +128,7 @@ :version "22.1") (defcustom imenu-after-jump-hook nil - "*Hooks called after jumping to a place in the buffer. + "Hooks called after jumping to a place in the buffer. Useful things to use here include `reposition-window', `recenter', and \(lambda () (recenter 0)) to show at top of screen." @@ -137,7 +137,7 @@ ;;;###autoload (defcustom imenu-sort-function nil - "*The function to use for sorting the index mouse-menu. + "The function to use for sorting the index mouse-menu. Affects only the mouse index menu. @@ -156,7 +156,7 @@ :group 'imenu) (defcustom imenu-max-items 25 - "*Maximum number of elements in a mouse menu for Imenu." + "Maximum number of elements in a mouse menu for Imenu." :type 'integer :group 'imenu) @@ -173,14 +173,14 @@ ;; :group 'imenu) (defcustom imenu-space-replacement "." - "*The replacement string for spaces in index names. + "The replacement string for spaces in index names. Used when presenting the index in a completion buffer to make the names work as tokens." :type '(choice string (const nil)) :group 'imenu) (defcustom imenu-level-separator ":" - "*The separator between index names of different levels. + "The separator between index names of different levels. Used for making mouse-menu titles and for flattening nested indexes with name concatenation." :type 'string @@ -665,7 +665,7 @@ (make-variable-buffer-local 'imenu-syntax-alist) (defun imenu-default-create-index-function () - "*Default function to create an index alist of the current buffer. + "Default function to create an index alist of the current buffer. The most general method is to move point to end of buffer, then repeatedly call `imenu-prev-index-position-function' and `imenu-extract-index-name-function'.
--- a/lisp/indent.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/indent.el Wed Dec 03 05:48:14 2008 +0000 @@ -32,7 +32,7 @@ :group 'editing) (defcustom standard-indent 4 - "*Default number of columns for margin-changing functions to indent." + "Default number of columns for margin-changing functions to indent." :group 'indent :type 'integer) @@ -45,7 +45,7 @@ Don't rebind TAB unless you really need to.") (defcustom tab-always-indent t - "*Controls the operation of the TAB key. + "Controls the operation of the TAB key. If t, hitting TAB always just indents the current line. If nil, hitting TAB indents the current line if point is at the left margin or in the line's indentation, otherwise it inserts a \"real\" TAB character. @@ -467,7 +467,7 @@ (defcustom tab-stop-list '(8 16 24 32 40 48 56 64 72 80 88 96 104 112 120) - "*List of tab stop positions used by `tab-to-tab-stop'. + "List of tab stop positions used by `tab-to-tab-stop'. This should be a list of integers, ordered from smallest to largest." :group 'indent :type '(repeat integer))
--- a/lisp/info.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/info.el Wed Dec 03 05:48:14 2008 +0000 @@ -55,7 +55,7 @@ Each element of the list is a list (FILENAME NODENAME).") (defcustom Info-enable-edit nil - "*Non-nil means the \\<Info-mode-map>\\[Info-edit] command in Info can edit the current node. + "Non-nil means the \\<Info-mode-map>\\[Info-edit] command in Info can edit the current node. This is convenient if you want to write Info files by hand. However, we recommend that you not do this. It is better to write a Texinfo file and generate the Info file from that, @@ -139,19 +139,19 @@ :group 'info) (defcustom Info-fontify-visited-nodes t - "*Non-nil to fontify references to visited nodes in `info-xref-visited' face." + "Non-nil to fontify references to visited nodes in `info-xref-visited' face." :version "22.1" :type 'boolean :group 'info) (defcustom Info-fontify-maximum-menu-size 100000 - "*Maximum size of menu to fontify if `font-lock-mode' is non-nil. + "Maximum size of menu to fontify if `font-lock-mode' is non-nil. Set to nil to disable node fontification." :type 'integer :group 'info) (defcustom Info-use-header-line t - "*Non-nil means to put the beginning-of-node links in an Emacs header-line. + "Non-nil means to put the beginning-of-node links in an Emacs header-line. A header-line does not scroll with the rest of the buffer." :type 'boolean :group 'info) @@ -203,7 +203,7 @@ :group 'info) (defcustom Info-scroll-prefer-subnodes nil - "*If non-nil, \\<Info-mode-map>\\[Info-scroll-up] in a menu visits subnodes. + "If non-nil, \\<Info-mode-map>\\[Info-scroll-up] in a menu visits subnodes. If this is non-nil, and you scroll far enough in a node that its menu appears on the screen, the next \\<Info-mode-map>\\[Info-scroll-up] @@ -218,7 +218,7 @@ :group 'info) (defcustom Info-hide-note-references t - "*If non-nil, hide the tag and section reference in *note and * menu items. + "If non-nil, hide the tag and section reference in *note and * menu items. If value is non-nil but not `hide', also replaces the \"*note\" with \"see\". If value is non-nil but not t or `hide', the reference section is still shown. `nil' completely disables this feature. If this is non-nil, you might @@ -231,7 +231,7 @@ :group 'info) (defcustom Info-refill-paragraphs nil - "*If non-nil, attempt to refill paragraphs with hidden references. + "If non-nil, attempt to refill paragraphs with hidden references. This refilling may accidentally remove explicit line breaks in the Info file, so be prepared for a few surprises if you enable this feature. This only has an effect if `Info-hide-note-references' is non-nil." @@ -245,7 +245,7 @@ :type 'integer) (defcustom Info-search-whitespace-regexp "\\s-+" - "*If non-nil, regular expression to match a sequence of whitespace chars. + "If non-nil, regular expression to match a sequence of whitespace chars. This applies to Info search for regular expressions. You might want to use something like \"[ \\t\\r\\n]+\" instead. In the Customization buffer, that is `[' followed by a space, @@ -254,7 +254,7 @@ :group 'info) (defcustom Info-isearch-search t - "*If non-nil, isearch in Info searches through multiple nodes. + "If non-nil, isearch in Info searches through multiple nodes. Before leaving the initial Info node, where isearch was started, it fails once with the error message [initial node], and with subsequent C-s/C-r continues through other nodes without failing
--- a/lisp/isearchb.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/isearchb.el Wed Dec 03 05:48:14 2008 +0000 @@ -82,14 +82,14 @@ :group 'iswitchb) (defcustom isearchb-idle-timeout nil - "*Number of idle seconds before isearchb turns itself off. + "Number of idle seconds before isearchb turns itself off. If nil, don't use a timeout." :type '(choice (integer :tag "Seconds") (const :tag "Disable" nil)) :group 'isearchb) (defcustom isearchb-show-completions t - "*If non-nil, show possible completions in the minibuffer." + "If non-nil, show possible completions in the minibuffer." :type 'boolean :group 'isearchb)
--- a/lisp/iswitchb.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/iswitchb.el Wed Dec 03 05:48:14 2008 +0000 @@ -257,7 +257,7 @@ :link '(emacs-library-link :tag "Lisp File" "iswitchb.el")) (defcustom iswitchb-case case-fold-search - "*Non-nil if searching of buffer names should ignore case. + "Non-nil if searching of buffer names should ignore case. If this is non-nil but the user input has any upper case letters, matching is temporarily case sensitive." :type 'boolean @@ -265,7 +265,7 @@ (defcustom iswitchb-buffer-ignore '("^ ") - "*List of regexps or functions matching buffer names to ignore. + "List of regexps or functions matching buffer names to ignore. For example, traditional behavior is not to list buffers whose names begin with a space, for which the regexp is `^ '. See the source file for example functions that filter buffer names." @@ -274,7 +274,7 @@ (put 'iswitchb-buffer-ignore 'risky-local-variable t) (defcustom iswitchb-max-to-show nil - "*If non-nil, limit the number of names shown in the minibuffer. + "If non-nil, limit the number of names shown in the minibuffer. If this value is N, and N is greater than the number of matching buffers, the first N/2 and the last N/2 matching buffers are shown. This can greatly speed up iswitchb if you have a @@ -283,7 +283,7 @@ :group 'iswitchb) (defcustom iswitchb-use-virtual-buffers nil - "*If non-nil, refer to past buffers when none match. + "If non-nil, refer to past buffers when none match. This feature relies upon the `recentf' package, which will be enabled if this variable is configured to a non-nil value." :type 'boolean @@ -297,7 +297,7 @@ (defvar iswitchb-virtual-buffers nil) (defcustom iswitchb-cannot-complete-hook 'iswitchb-completion-help - "*Hook run when `iswitchb-complete' can't complete any more. + "Hook run when `iswitchb-complete' can't complete any more. The most useful values are `iswitchb-completion-help', which pops up a window with completion alternatives, or `iswitchb-next-match' or `iswitchb-prev-match', which cycle the buffer list." @@ -314,7 +314,7 @@ ;;(setq iswitchb-buffer-ignore '("^ " "\\.c\\'" "\\.h\\'")) (defcustom iswitchb-default-method 'always-frame - "*How to switch to new buffer when using `iswitchb-buffer'. + "How to switch to new buffer when using `iswitchb-buffer'. Possible values: `samewindow' Show new buffer in same window `otherwindow' Show new buffer in another window (same frame) @@ -334,19 +334,19 @@ :group 'iswitchb) (defcustom iswitchb-regexp nil - "*Non-nil means that `iswitchb' will do regexp matching. + "Non-nil means that `iswitchb' will do regexp matching. Value can be toggled within `iswitchb' using `iswitchb-toggle-regexp'." :type 'boolean :group 'iswitchb) (defcustom iswitchb-newbuffer t - "*Non-nil means create new buffer if no buffer matches substring. + "Non-nil means create new buffer if no buffer matches substring. See also `iswitchb-prompt-newbuffer'." :type 'boolean :group 'iswitchb) (defcustom iswitchb-prompt-newbuffer t - "*Non-nil means prompt user to confirm before creating new buffer. + "Non-nil means prompt user to confirm before creating new buffer. See also `iswitchb-newbuffer'." :type 'boolean :group 'iswitchb) @@ -354,12 +354,12 @@ (define-obsolete-variable-alias 'iswitchb-use-fonts 'iswitchb-use-faces "22.1") (defcustom iswitchb-use-faces t - "*Non-nil means use font-lock faces for showing first match." + "Non-nil means use font-lock faces for showing first match." :type 'boolean :group 'iswitchb) (defcustom iswitchb-use-frame-buffer-list nil - "*Non-nil means use the currently selected frame's buffer list." + "Non-nil means use the currently selected frame's buffer list." :type 'boolean :group 'iswitchb)
--- a/lisp/jit-lock.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/jit-lock.el Wed Dec 03 05:48:14 2008 +0000 @@ -65,7 +65,7 @@ :group 'font-lock) (defcustom jit-lock-chunk-size 500 - "*Jit-lock fontifies chunks of at most this many characters at a time. + "Jit-lock fontifies chunks of at most this many characters at a time. This variable controls both display-time and stealth fontification." :type 'integer @@ -73,7 +73,7 @@ (defcustom jit-lock-stealth-time nil - "*Time in seconds to wait before beginning stealth fontification. + "Time in seconds to wait before beginning stealth fontification. Stealth fontification occurs if there is no input within this time. If nil, stealth fontification is never performed. @@ -84,7 +84,7 @@ (defcustom jit-lock-stealth-nice 0.5 - "*Time in seconds to pause between chunks of stealth fontification. + "Time in seconds to pause between chunks of stealth fontification. Each iteration of stealth fontification is separated by this amount of time, thus reducing the demand that stealth fontification makes on the system. If nil, means stealth fontification is never paused. @@ -98,7 +98,7 @@ (defcustom jit-lock-stealth-load (if (condition-case nil (load-average) (error)) 200) - "*Load in percentage above which stealth fontification is suspended. + "Load in percentage above which stealth fontification is suspended. Stealth fontification pauses when the system short-term load average (as returned by the function `load-average' if supported) goes above this level, thus reducing the demand that stealth fontification makes on the system. @@ -114,14 +114,14 @@ (defcustom jit-lock-stealth-verbose nil - "*If non-nil, means stealth fontification should show status messages." + "If non-nil, means stealth fontification should show status messages." :type 'boolean :group 'jit-lock) (defvaralias 'jit-lock-defer-contextually 'jit-lock-contextually) (defcustom jit-lock-contextually 'syntax-driven - "*If non-nil, means fontification should be syntactically true. + "If non-nil, means fontification should be syntactically true. If nil, means fontification occurs only on those lines modified. This means where modification on a line causes syntactic change on subsequent lines, those subsequent lines are not refontified to reflect their new context.
--- a/lisp/jka-compr.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/jka-compr.el Wed Dec 03 05:48:14 2008 +0000 @@ -93,7 +93,7 @@ (require 'jka-cmpr-hook) (defcustom jka-compr-shell "sh" - "*Shell to be used for calling compression programs. + "Shell to be used for calling compression programs. NOTE: Not used in MS-DOS and Windows systems." :type 'string :group 'jka-compr)
--- a/lisp/log-edit.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/log-edit.el Wed Dec 03 05:48:14 2008 +0000 @@ -95,14 +95,14 @@ :help "Search backwards through comment history for substring match of str"])) (defcustom log-edit-confirm 'changed - "*If non-nil, `log-edit-done' will request confirmation. + "If non-nil, `log-edit-done' will request confirmation. If 'changed, only request confirmation if the list of files has changed since the beginning of the log-edit session." :group 'log-edit :type '(choice (const changed) (const t) (const nil))) (defcustom log-edit-keep-buffer nil - "*If non-nil, don't hide the buffer after `log-edit-done'." + "If non-nil, don't hide the buffer after `log-edit-done'." :group 'log-edit :type 'boolean) @@ -113,20 +113,20 @@ (defcustom log-edit-require-final-newline cvs-commit-buffer-require-final-newline - "*Enforce a newline at the end of commit log messages. + "Enforce a newline at the end of commit log messages. Enforce it silently if t, query if non-nil and don't do anything if nil." :group 'log-edit :type '(choice (const ask) (const t) (const nil))) (defcustom log-edit-setup-invert nil - "*Non-nil means `log-edit' should invert the meaning of its SETUP arg. + "Non-nil means `log-edit' should invert the meaning of its SETUP arg. If SETUP is 'force, this variable has no effect." :group 'log-edit :type 'boolean) (defcustom log-edit-hook '(log-edit-insert-cvs-template log-edit-insert-changelog) - "*Hook run at the end of `log-edit'." + "Hook run at the end of `log-edit'." :group 'log-edit :type '(hook :options (log-edit-insert-changelog log-edit-insert-cvs-rcstemplate @@ -134,12 +134,12 @@ log-edit-insert-filenames))) (defcustom log-edit-mode-hook (if (boundp 'vc-log-mode-hook) vc-log-mode-hook) - "*Hook run when entering `log-edit-mode'." + "Hook run when entering `log-edit-mode'." :group 'log-edit :type 'hook) (defcustom log-edit-done-hook nil - "*Hook run before doing the actual commit. + "Hook run before doing the actual commit. This hook can be used to cleanup the message, enforce various conventions, or to allow recording the message in some other database, such as a bug-tracking system. The list of files about to be committed
--- a/lisp/lpr.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/lpr.el Wed Dec 03 05:48:14 2008 +0000 @@ -46,7 +46,7 @@ ;;;###autoload (defcustom printer-name (and (memq system-type '(emx ms-dos)) "PRN") - "*The name of a local printer to which data is sent for printing. + "The name of a local printer to which data is sent for printing. \(Note that PostScript files are sent to `ps-printer-name', which see.\) On Unix-like systems, a string value should be a name understood by @@ -68,7 +68,7 @@ ;;;###autoload (defcustom lpr-switches nil - "*List of strings to pass as extra options for the printer program. + "List of strings to pass as extra options for the printer program. It is recommended to set `printer-name' instead of including an explicit switch on this list. See `lpr-command'." @@ -76,7 +76,7 @@ :group 'lpr) (defcustom lpr-add-switches (memq system-type '(berkeley-unix gnu/linux)) - "*Non-nil means construct `-T' and `-J' options for the printer program. + "Non-nil means construct `-T' and `-J' options for the printer program. These are made assuming that the program is `lpr'; if you are using some other incompatible printer program, this variable should be nil." @@ -87,7 +87,7 @@ (if lpr-lp-system "-d " "-P") - "*Printer switch, that is, something like \"-P\", \"-d \", \"/D:\", etc. + "Printer switch, that is, something like \"-P\", \"-d \", \"/D:\", etc. This switch is used in conjunction with `printer-name'." :type '(choice :menu-tag "Printer Name Switch" :tag "Printer Name Switch" @@ -104,7 +104,7 @@ "lp") (t "lpr")) - "*Name of program for printing a file. + "Name of program for printing a file. On MS-DOS and MS-Windows systems, if the value is an empty string then Emacs will write directly to the printer port named by `printer-name'. @@ -119,7 +119,7 @@ ;; Default is nil, because that enables us to use pr -f ;; which is more reliable than pr with no args, which is what lpr -p does. (defcustom lpr-headers-switches nil - "*List of strings of options to request page headings in the printer program. + "List of strings of options to request page headings in the printer program. If nil, we run `lpr-page-header-program' to make page headings and print the result." :type '(repeat (string :tag "Argument")) @@ -132,14 +132,14 @@ :group 'lpr) (defcustom lpr-page-header-program "pr" - "*Name of program for adding page headers to a file." + "Name of program for adding page headers to a file." :type 'string :group 'lpr) ;; Berkeley systems support -F, and GNU pr supports both -f and -F, ;; So it looks like -F is a better default. (defcustom lpr-page-header-switches '("-h" "%s" "-F") - "*List of strings to use as options for the page-header-generating program. + "List of strings to use as options for the page-header-generating program. If `%s' appears in any of the strings, it is substituted by the page title. Note that for correct quoting, `%s' should normally be a separate element. The variable `lpr-page-header-program' specifies the program to use."
--- a/lisp/ls-lisp.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ls-lisp.el Wed Dec 03 05:48:14 2008 +0000 @@ -76,7 +76,7 @@ '(hpux usg-unix-v unisoft-unix irix berkeley-unix)) 'UNIX)) ; very similar to GNU ;; Anything else defaults to nil, meaning GNU. - "*Platform to emulate: GNU (default), MacOS, MS-Windows, UNIX. + "Platform to emulate: GNU (default), MacOS, MS-Windows, UNIX. Corresponding value is one of the atoms: nil, MacOS, MS-Windows, UNIX. Sets default values for: `ls-lisp-ignore-case', `ls-lisp-dirs-first', `ls-lisp-verbosity'. Need not match actual platform. Changing this @@ -91,12 +91,12 @@ ;; Name change for consistency with other option names. (or (memq ls-lisp-emulation '(MS-Windows MacOS)) (and (boundp 'ls-lisp-dired-ignore-case) ls-lisp-dired-ignore-case)) - "*Non-nil causes ls-lisp alphabetic sorting to ignore case." + "Non-nil causes ls-lisp alphabetic sorting to ignore case." :type 'boolean :group 'ls-lisp) (defcustom ls-lisp-dirs-first (eq ls-lisp-emulation 'MS-Windows) - "*Non-nil causes ls-lisp to sort directories first in any ordering. + "Non-nil causes ls-lisp to sort directories first in any ordering. \(Or last if it is reversed.) Follows Microsoft Windows Explorer." ;; Functionality suggested by Chris McMahan <cmcmahan@one.net> :type 'boolean @@ -109,7 +109,7 @@ '(links))) ; distinguish NT/2K from 9x ((eq ls-lisp-emulation 'UNIX) '(links uid)) ; UNIX ls (t '(links uid gid))) ; GNU ls - "*A list of optional file attributes that ls-lisp should display. + "A list of optional file attributes that ls-lisp should display. It should contain none or more of the symbols: links, uid, gid. A value of nil (or an empty list) means display none of them. @@ -130,7 +130,7 @@ (defcustom ls-lisp-use-insert-directory-program (not (memq system-type '(macos ms-dos windows-nt))) - "*Non-nil causes ls-lisp to revert back to using `insert-directory-program'. + "Non-nil causes ls-lisp to revert back to using `insert-directory-program'. This is useful on platforms where ls-lisp is dumped into Emacs, such as Microsoft Windows, but you would still like to use a program to list the contents of a directory." @@ -140,7 +140,7 @@ ;;; Autoloaded because it is let-bound in `recover-session', `mail-recover-1'. ;;;###autoload (defcustom ls-lisp-support-shell-wildcards t - "*Non-nil means ls-lisp treats file patterns as shell wildcards. + "Non-nil means ls-lisp treats file patterns as shell wildcards. Otherwise they are treated as Emacs regexps (for backward compatibility)." :type 'boolean :group 'ls-lisp) @@ -148,7 +148,7 @@ (defcustom ls-lisp-format-time-list '("%b %e %H:%M" "%b %e %Y") - "*List of `format-time-string' specs to display file time stamps. + "List of `format-time-string' specs to display file time stamps. These specs are used ONLY if a valid locale can not be determined. If `ls-lisp-use-localized-time-format' is non-nil, these specs are used @@ -168,7 +168,7 @@ :group 'ls-lisp) (defcustom ls-lisp-use-localized-time-format nil - "*Non-nil causes ls-lisp to use `ls-lisp-format-time-list' even if + "Non-nil causes ls-lisp to use `ls-lisp-format-time-list' even if a valid locale is specified. WARNING: Using localized date/time format might cause Dired columns
--- a/lisp/man.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/man.el Wed Dec 03 05:48:14 2008 +0000 @@ -108,7 +108,7 @@ (defvar Man-notify) (defcustom Man-filter-list nil - "*Manpage cleaning filter command phrases. + "Manpage cleaning filter command phrases. This variable contains a list of the following form: '((command-string phrase-string*)*) @@ -425,9 +425,9 @@ 'func nil 'action #'Man-xref-button-action) -(defun Man-xref-button-action (button) +(defun Man-xref-button-action (button) (let ((target (button-get button 'Man-target-string))) - (funcall + (funcall (button-get button 'func) (cond ((null target) (button-label button)) @@ -435,7 +435,7 @@ (funcall target (button-start button))) (t target))))) -(define-button-type 'Man-xref-man-page +(define-button-type 'Man-xref-man-page :supertype 'Man-abstract-xref-man-page 'func 'man-follow) @@ -1011,7 +1011,7 @@ (Man-highlight-references0 nil Man-apropos-regexp 1 'Man-default-man-entry (or xref-man-type 'Man-xref-man-page))) - (Man-highlight-references0 Man-see-also-regexp Man-reference-regexp 1 + (Man-highlight-references0 Man-see-also-regexp Man-reference-regexp 1 'Man-default-man-entry (or xref-man-type 'Man-xref-man-page)) (Man-highlight-references0 Man-synopsis-regexp Man-header-regexp 0 2 @@ -1038,7 +1038,7 @@ (match-end button-pos) 'type type 'Man-target-string (cond - ((numberp target) + ((numberp target) (match-string target)) ((functionp target) target)
--- a/lisp/menu-bar.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/menu-bar.el Wed Dec 03 05:48:14 2008 +0000 @@ -1590,7 +1590,7 @@ (> count 1))) (defcustom yank-menu-length 20 - "*Maximum length to display in the yank-menu." + "Maximum length to display in the yank-menu." :type 'integer :group 'menu) @@ -1632,7 +1632,7 @@ ;;; Buffers Menu (defcustom buffers-menu-max-size 10 - "*Maximum number of entries which may appear on the Buffers menu. + "Maximum number of entries which may appear on the Buffers menu. If this is 10, then only the ten most-recently-selected buffers are shown. If this is nil, then all buffers are shown. A large number or nil slows down menu responsiveness." @@ -1641,7 +1641,7 @@ :group 'menu) (defcustom buffers-menu-buffer-name-length 30 - "*Maximum length of the buffer name on the Buffers menu. + "Maximum length of the buffer name on the Buffers menu. If this is a number, then buffer names are truncated to this length. If this is nil, then buffer names are shown in full. A large number or nil makes the menu too wide."
--- a/lisp/midnight.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/midnight.el Wed Dec 03 05:48:14 2008 +0000 @@ -53,7 +53,7 @@ the time when it is run.") (defcustom midnight-mode nil - "*Non-nil means run `midnight-hook' at midnight. + "Non-nil means run `midnight-hook' at midnight. Setting this variable outside customize has no effect; call `cancel-timer' or `timer-activate' on `midnight-timer' instead." :type 'boolean @@ -81,7 +81,7 @@ ;;; clean-buffer-list stuff (defcustom clean-buffer-list-delay-general 3 - "*The number of days before any buffer becomes eligible for autokilling. + "The number of days before any buffer becomes eligible for autokilling. The autokilling is done by `clean-buffer-list' when is it in `midnight-hook'. Currently displayed and/or modified (unsaved) buffers, as well as buffers matching `clean-buffer-list-kill-never-buffer-names' and @@ -90,7 +90,7 @@ :group 'midnight) (defcustom clean-buffer-list-delay-special 3600 - "*The number of seconds before some buffers become eligible for autokilling. + "The number of seconds before some buffers become eligible for autokilling. Buffers matched by `clean-buffer-list-kill-regexps' and `clean-buffer-list-kill-buffer-names' are killed if they were last displayed more than this many seconds ago." @@ -98,7 +98,7 @@ :group 'midnight) (defcustom clean-buffer-list-kill-regexps nil - "*List of regexps saying which buffers will be killed at midnight. + "List of regexps saying which buffers will be killed at midnight. If buffer name matches a regexp in the list and the buffer was not displayed in the last `clean-buffer-list-delay-special' seconds, it is killed by `clean-buffer-list' when is it in `midnight-hook'. @@ -113,7 +113,7 @@ (defcustom clean-buffer-list-kill-buffer-names '("*Help*" "*Apropos*" "*Man " "*Buffer List*" "*Compile-Log*" "*info*" "*vc*" "*vc-diff*" "*diff*") - "*List of strings saying which buffers will be killed at midnight. + "List of strings saying which buffers will be killed at midnight. Buffers with names in this list, which were not displayed in the last `clean-buffer-list-delay-special' seconds, are killed by `clean-buffer-list' when is it in `midnight-hook'. @@ -127,7 +127,7 @@ (defcustom clean-buffer-list-kill-never-buffer-names '("*scratch*" "*Messages*" "*server*") - "*List of buffer names which will never be killed by `clean-buffer-list'. + "List of buffer names which will never be killed by `clean-buffer-list'. See also `clean-buffer-list-kill-never-regexps'. Note that this does override `clean-buffer-list-kill-regexps' and `clean-buffer-list-kill-buffer-names' so a buffer matching any of these @@ -136,7 +136,7 @@ :group 'midnight) (defcustom clean-buffer-list-kill-never-regexps '("^ \\*Minibuf-.*\\*$") - "*List of regexp saying which buffers will never be killed at midnight. + "List of regexp saying which buffers will never be killed at midnight. See also `clean-buffer-list-kill-never-buffer-names'. Killing is done by `clean-buffer-list'. Note that this does override `clean-buffer-list-kill-regexps' and @@ -222,7 +222,7 @@ midnight-period 'run-hooks 'midnight-hook))) (defcustom midnight-delay 3600 - "*The number of seconds after the midnight when the `midnight-timer' is run. + "The number of seconds after the midnight when the `midnight-timer' is run. You should set this variable before loading midnight.el, or set it by calling `midnight-delay-set', or use `custom'. If you wish, you can use a string instead, it will be passed as the
--- a/lisp/mouse-sel.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/mouse-sel.el Wed Dec 03 05:48:14 2008 +0000 @@ -150,7 +150,7 @@ :group 'mouse) (defcustom mouse-sel-leave-point-near-mouse t - "*Leave point near last mouse position. + "Leave point near last mouse position. If non-nil, \\[mouse-select] and \\[mouse-extend] will leave point at the end of the region nearest to where the mouse last was. If nil, point will always be placed at the beginning of the region." @@ -158,12 +158,12 @@ :group 'mouse-sel) (defcustom mouse-sel-cycle-clicks t - "*If non-nil, \\[mouse-select] cycles the click-counts after 4 clicks." + "If non-nil, \\[mouse-select] cycles the click-counts after 4 clicks." :type 'boolean :group 'mouse-sel) (defcustom mouse-sel-default-bindings t - "*Control mouse bindings." + "Control mouse bindings." :type '(choice (const :tag "none" nil) (const :tag "cut and paste" interprogram-cut-paste) (other :tag "default bindings" t))
--- a/lisp/mouse.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/mouse.el Wed Dec 03 05:48:14 2008 +0000 @@ -37,12 +37,12 @@ (put 'track-mouse 'lisp-indent-function 0) (defcustom mouse-yank-at-point nil - "*If non-nil, mouse yank commands yank at point instead of at click." + "If non-nil, mouse yank commands yank at point instead of at click." :type 'boolean :group 'mouse) (defcustom mouse-drag-copy-region t - "*If non-nil, mouse drag copies region to kill-ring." + "If non-nil, mouse drag copies region to kill-ring." :type 'boolean :version "22.1" :group 'mouse) @@ -81,7 +81,7 @@ :group 'mouse) (defcustom mouse-1-click-in-non-selected-windows t - "*If non-nil, a Mouse-1 click also follows links in non-selected windows. + "If non-nil, a Mouse-1 click also follows links in non-selected windows. If nil, a Mouse-1 click on a link in a non-selected window performs the normal mouse-1 binding, typically selects the window and sets @@ -699,7 +699,7 @@ (setq mouse-last-region-tick (buffer-modified-tick))) (defcustom mouse-scroll-delay 0.25 - "*The pause between scroll steps caused by mouse drags, in seconds. + "The pause between scroll steps caused by mouse drags, in seconds. If you drag the mouse beyond the edge of a window, Emacs scrolls the window to bring the text beyond that edge into view, with a delay of this many seconds between scroll steps. Scrolling stops when you move @@ -710,7 +710,7 @@ :group 'mouse) (defcustom mouse-scroll-min-lines 1 - "*The minimum number of lines scrolled by dragging mouse out of window. + "The minimum number of lines scrolled by dragging mouse out of window. Moving the mouse out the top or bottom edge of the window begins scrolling repeatedly. The number of lines scrolled per repetition is normally equal to the number of lines beyond the window edge that @@ -1799,14 +1799,14 @@ (overlay-end mouse-secondary-overlay))))))) (defcustom mouse-buffer-menu-maxlen 20 - "*Number of buffers in one pane (submenu) of the buffer menu. + "Number of buffers in one pane (submenu) of the buffer menu. If we have lots of buffers, divide them into groups of `mouse-buffer-menu-maxlen' and make a pane (or submenu) for each one." :type 'integer :group 'mouse) (defcustom mouse-buffer-menu-mode-mult 4 - "*Group the buffers by the major mode groups on \\[mouse-buffer-menu]? + "Group the buffers by the major mode groups on \\[mouse-buffer-menu]? This number which determines (in a hairy way) whether \\[mouse-buffer-menu] will split the buffer menu by the major modes (see `mouse-buffer-menu-mode-groups') or just by menu length.
--- a/lisp/msb.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/msb.el Wed Dec 03 05:48:14 2008 +0000 @@ -206,7 +206,7 @@ (msb-menu-bar-update-buffers t))) (defcustom msb-menu-cond msb--very-many-menus - "*List of criteria for splitting the mouse buffer menu. + "List of criteria for splitting the mouse buffer menu. The elements in the list should be of this type: (CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLING-FN ITEM-SORT-FN). @@ -264,7 +264,7 @@ :version "20.3") (defcustom msb-separator-diff 100 - "*Non-nil means use separators. + "Non-nil means use separators. The separators will appear between all menus that have a sorting key that differs by this value or more." :type '(choice integer (const nil)) @@ -275,7 +275,7 @@ "*The sort key for files sorted by directory.") (defcustom msb-max-menu-items 15 - "*The maximum number of items in a menu. + "The maximum number of items in a menu. If this variable is set to 15 for instance, then the submenu will be split up in minor parts, 15 items each. A value of nil means no limit." :type '(choice integer (const nil)) @@ -283,7 +283,7 @@ :group 'msb) (defcustom msb-max-file-menu-items 10 - "*The maximum number of items from different directories. + "The maximum number of items from different directories. When the menu is of type `file by directory', this is the maximum number of buffers that are clumped together from different @@ -298,20 +298,20 @@ :group 'msb) (defcustom msb-most-recently-used-sort-key -1010 - "*Where should the menu with the most recently used buffers be placed?" + "Where should the menu with the most recently used buffers be placed?" :type 'integer :set 'msb-custom-set :group 'msb) (defcustom msb-display-most-recently-used 15 - "*How many buffers should be in the most-recently-used menu. + "How many buffers should be in the most-recently-used menu. No buffers at all if less than 1 or nil (or any non-number)." :type 'integer :set 'msb-custom-set :group 'msb) (defcustom msb-most-recently-used-title "Most recently used (%d)" - "*The title for the most-recently-used menu." + "The title for the most-recently-used menu." :type 'string :set 'msb-custom-set :group 'msb) @@ -320,7 +320,7 @@ "*Function that specifies how many pixels to shift the top menu leftwards.") (defcustom msb-display-invisible-buffers-p nil - "*Show invisible buffers or not. + "Show invisible buffers or not. Non-nil means that the buffer menu should include buffers that have names that starts with a space character." :type 'boolean @@ -342,7 +342,7 @@ information.") (defcustom msb-item-sort-function 'msb-sort-by-name - "*The order of items in a buffer menu. + "The order of items in a buffer menu. The default function to call for handling the order of items in a menu item. This function is called like a sort function. The items look @@ -359,7 +359,7 @@ :group 'msb) (defcustom msb-files-by-directory nil - "*Non-nil means that files should be sorted by directory. + "Non-nil means that files should be sorted by directory. This is instead of the groups in `msb-menu-cond'." :type 'boolean :set 'msb-custom-set
--- a/lisp/outline.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/outline.el Wed Dec 03 05:48:14 2008 +0000 @@ -347,7 +347,7 @@ (add-hook 'change-major-mode-hook 'show-all nil t)) (defcustom outline-minor-mode-prefix "\C-c@" - "*Prefix key to use for Outline commands in Outline minor mode. + "Prefix key to use for Outline commands in Outline minor mode. The value of this variable is checked as part of loading Outline mode. After that, changing the prefix key requires manipulating keymaps." :type 'string
--- a/lisp/paren.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/paren.el Wed Dec 03 05:48:14 2008 +0000 @@ -44,7 +44,7 @@ (defvar show-paren-overlay-1 nil) (defcustom show-paren-style 'parenthesis - "*Style used when showing a matching paren. + "Style used when showing a matching paren. Valid styles are `parenthesis' (meaning show the matching paren), `expression' (meaning show the entire expression enclosed by the paren) and `mixed' (meaning show the matching paren if it is visible, and the expression @@ -54,18 +54,18 @@ (defcustom show-paren-delay (if (featurep 'lisp-float-type) (/ (float 1) (float 8)) 1) - "*Time in seconds to delay before showing a matching paren." + "Time in seconds to delay before showing a matching paren." :type '(number :tag "seconds") :group 'paren-showing) (defcustom show-paren-priority 1000 - "*Priority of paren highlighting overlays." + "Priority of paren highlighting overlays." :type 'integer :group 'paren-showing :version "21.1") (defcustom show-paren-ring-bell-on-mismatch nil - "*If non-nil, beep if mismatched paren is detected." + "If non-nil, beep if mismatched paren is detected." :type 'boolean :group 'paren-showing :version "20.3")
--- a/lisp/pcmpl-cvs.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/pcmpl-cvs.el Wed Dec 03 05:48:14 2008 +0000 @@ -38,7 +38,7 @@ ;; User Variables: (defcustom pcmpl-cvs-binary (or (executable-find "cvs") "cvs") - "*The full path of the 'cvs' binary." + "The full path of the 'cvs' binary." :type 'file :group 'pcmpl-cvs)
--- a/lisp/pcmpl-gnu.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/pcmpl-gnu.el Wed Dec 03 05:48:14 2008 +0000 @@ -35,7 +35,7 @@ (defcustom pcmpl-gnu-makefile-regexps '("\\`GNUmakefile" "\\`Makefile" "\\.mak\\'") - "*A list of regexps that will match Makefile names." + "A list of regexps that will match Makefile names." :type '(repeat regexp) :group 'pcmpl-gnu) @@ -128,7 +128,7 @@ (defcustom pcmpl-gnu-tarfile-regexp "\\.t\\(ar\\(\\.\\(gz\\|bz2\\|Z\\)\\)?\\|gz\\|a[zZ]\\|z2\\)\\'" - "*A regexp which matches any tar archive." + "A regexp which matches any tar archive." :type 'regexp :group 'pcmpl-gnu)
--- a/lisp/pcomplete.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/pcomplete.el Wed Dec 03 05:48:14 2008 +0000 @@ -128,33 +128,33 @@ ;;; User Variables: (defcustom pcomplete-file-ignore nil - "*A regexp of filenames to be disregarded during file completion." + "A regexp of filenames to be disregarded during file completion." :type '(choice regexp (const :tag "None" nil)) :group 'pcomplete) (defcustom pcomplete-dir-ignore nil - "*A regexp of names to be disregarded during directory completion." + "A regexp of names to be disregarded during directory completion." :type '(choice regexp (const :tag "None" nil)) :group 'pcomplete) (defcustom pcomplete-ignore-case (memq system-type '(ms-dos windows-nt cygwin)) - "*If non-nil, ignore case when doing filename completion." + "If non-nil, ignore case when doing filename completion." :type 'boolean :group 'pcomplete) (defcustom pcomplete-autolist nil - "*If non-nil, automatically list possibilities on partial completion. + "If non-nil, automatically list possibilities on partial completion. This mirrors the optional behavior of tcsh." :type 'boolean :group 'pcomplete) (defcustom pcomplete-suffix-list (list ?/ ?:) - "*A list of characters which constitute a proper suffix." + "A list of characters which constitute a proper suffix." :type '(repeat character) :group 'pcomplete) (defcustom pcomplete-recexact nil - "*If non-nil, use shortest completion if characters cannot be added. + "If non-nil, use shortest completion if characters cannot be added. This mirrors the optional behavior of tcsh. A non-nil value is useful if `pcomplete-autolist' is non-nil too." @@ -162,13 +162,13 @@ :group 'pcomplete) (defcustom pcomplete-arg-quote-list nil - "*List of characters to quote when completing an argument." + "List of characters to quote when completing an argument." :type '(choice (repeat character) (const :tag "Don't quote" nil)) :group 'pcomplete) (defcustom pcomplete-quote-arg-hook nil - "*A hook which is run to quote a character within a filename. + "A hook which is run to quote a character within a filename. Each function is passed both the filename to be quoted, and the index to be considered. If the function wishes to provide an alternate quoted form, it need only return the replacement string. If no @@ -179,13 +179,13 @@ :group 'pcomplete) (defcustom pcomplete-man-function 'man - "*A function to that will be called to display a manual page. + "A function to that will be called to display a manual page. It will be passed the name of the command to document." :type 'function :group 'pcomplete) (defcustom pcomplete-compare-entry-function 'string-lessp - "*This function is used to order file entries for completion. + "This function is used to order file entries for completion. The behavior of most all shells is to sort alphabetically." :type '(radio (function-item string-lessp) (function-item file-newer-than-file-p) @@ -193,7 +193,7 @@ :group 'pcomplete) (defcustom pcomplete-help nil - "*A string or function (or nil) used for context-sensitive help. + "A string or function (or nil) used for context-sensitive help. If a string, it should name an Info node that will be jumped to. If non-nil, it must a sexp that will be evaluated, and whose result will be shown in the minibuffer. @@ -203,7 +203,7 @@ :group 'pcomplete) (defcustom pcomplete-expand-before-complete nil - "*If non-nil, expand the current argument before completing it. + "If non-nil, expand the current argument before completing it. This means that typing something such as '$HOME/bi' followed by \\[pcomplete-argument] will cause the variable reference to be resolved first, and the resultant value that will be completed against @@ -215,7 +215,7 @@ (defcustom pcomplete-parse-arguments-function 'pcomplete-parse-buffer-arguments - "*A function to call to parse the current line's arguments. + "A function to call to parse the current line's arguments. It should be called with no parameters, and with point at the position of the argument that is to be completed. @@ -233,7 +233,7 @@ :group 'pcomplete) (defcustom pcomplete-cycle-completions t - "*If non-nil, hitting the TAB key cycles through the completion list. + "If non-nil, hitting the TAB key cycles through the completion list. Typical Emacs behavior is to complete as much as possible, then pause waiting for further input. Then if TAB is hit again, show a list of possible completions. When `pcomplete-cycle-completions' is non-nil, @@ -245,7 +245,7 @@ :group 'pcomplete) (defcustom pcomplete-cycle-cutoff-length 5 - "*If the number of completions is greater than this, don't cycle. + "If the number of completions is greater than this, don't cycle. This variable is a compromise between the traditional Emacs style of completion, and the \"cycling\" style. Basically, if there are more than this number of completions possible, don't automatically pick the @@ -261,7 +261,7 @@ :group 'pcomplete) (defcustom pcomplete-restore-window-delay 1 - "*The number of seconds to wait before restoring completion windows. + "The number of seconds to wait before restoring completion windows. Once the completion window has been displayed, if the user then goes on to type something else, that completion window will be removed from the display (actually, the original window configuration before it was @@ -273,7 +273,7 @@ :group 'pcomplete) (defcustom pcomplete-try-first-hook nil - "*A list of functions which are called before completing an argument. + "A list of functions which are called before completing an argument. This can be used, for example, for completing things which might apply to all arguments, such as variable names after a $." :type 'hook @@ -287,12 +287,12 @@ (function (lambda () (pcomplete-here (pcomplete-executables)))) - "*Function called for completing the initial command argument." + "Function called for completing the initial command argument." :type 'function :group 'pcomplete) (defcustom pcomplete-command-name-function 'pcomplete-command-name - "*Function called for determining the current command name." + "Function called for determining the current command name." :type 'function :group 'pcomplete) @@ -300,13 +300,13 @@ (function (lambda () (while (pcomplete-here (pcomplete-entries))))) - "*Function called when no completion rule can be found. + "Function called when no completion rule can be found. This function is used to generate completions for every argument." :type 'function :group 'pcomplete) (defcustom pcomplete-use-paring t - "*If t, pare alternatives that have already been used. + "If t, pare alternatives that have already been used. If nil, you will always see the completion set of possible options, no matter which of those options have already been used in previous command arguments." @@ -314,7 +314,7 @@ :group 'pcomplete) (defcustom pcomplete-termination-string " " - "*A string that is inserted after any completion or expansion. + "A string that is inserted after any completion or expansion. This is usually a space character, useful when completing lists of words separated by spaces. However, if your list uses a different separator character, or if the completion occurs in a word that is
--- a/lisp/pcvs-info.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/pcvs-info.el Wed Dec 03 05:48:14 2008 +0000 @@ -44,14 +44,14 @@ 'cvs-display-full-name "22.1") (defcustom cvs-display-full-name t - "*Specifies how the filenames should be displayed in the listing. + "Specifies how the filenames should be displayed in the listing. If non-nil, their full filename name will be displayed, else only the non-directory part." :group 'pcl-cvs :type '(boolean)) (defcustom cvs-allow-dir-commit nil - "*Allow `cvs-mode-commit' on directories. + "Allow `cvs-mode-commit' on directories. If you commit without any marked file and with the cursor positioned on a directory entry, cvs would commit the whole directory. This seems to confuse some users sometimes."
--- a/lisp/pcvs-parse.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/pcvs-parse.el Wed Dec 03 05:48:14 2008 +0000 @@ -43,7 +43,7 @@ ;; parse vars (defcustom cvs-update-prog-output-skip-regexp "$" - "*A regexp that matches the end of the output from all cvs update programs. + "A regexp that matches the end of the output from all cvs update programs. That is, output from any programs that are run by CVS (by the flag -u in the `modules' file - see cvs(5)) when `cvs update' is performed should terminate with a line that this regexp matches. It is enough that @@ -56,7 +56,7 @@ (defcustom cvs-parse-ignored-messages '("Executing ssh-askpass to query the password.*$" ".*Remote host denied X11 forwarding.*$") - "*A list of regexps matching messages that should be ignored by the parser. + "A list of regexps matching messages that should be ignored by the parser. Each regexp should match a whole set of lines and should hence be terminated by `$'." :group 'pcl-cvs
--- a/lisp/printing.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/printing.el Wed Dec 03 05:48:14 2008 +0000 @@ -1683,7 +1683,7 @@ ps-windows-system) 'windows 'unix) - "*Specify which path style to use for external commands. + "Specify which path style to use for external commands. Valid values are: @@ -1700,7 +1700,7 @@ '((unix PATH) (cygwin PATH) (windows PATH)) - "*Specify an alist for command paths. + "Specify an alist for command paths. It's used to find commands used for printing package, like gv, gs, gsview.exe, mpage, print.exe, etc. See also `pr-command' function. @@ -1775,7 +1775,7 @@ (defcustom pr-txt-name 'default - "*Specify a printer for printing a text file. + "Specify a printer for printing a text file. The printer name symbol should be defined on `pr-txt-printer-alist' (see it for documentation). @@ -1805,7 +1805,7 @@ ;; (PRN "" nil "PRN") ;; (standard "redpr.exe" nil "") ;; ) - "*Specify an alist of all text printers (text printer database). + "Specify an alist of all text printers (text printer database). The alist element has the form: @@ -1921,7 +1921,7 @@ (defcustom pr-ps-name 'default - "*Specify a printer for printing a PostScript file. + "Specify a printer for printing a PostScript file. This printer name symbol should be defined on `pr-ps-printer-alist' (see it for documentation). @@ -1956,7 +1956,7 @@ ;; (PRN "" nil "" "PRN") ;; (standard "redpr.exe" nil "" "") ;; ) - "*Specify an alist for all PostScript printers (PostScript printer database). + "Specify an alist for all PostScript printers (PostScript printer database). The alist element has the form: @@ -2216,7 +2216,7 @@ (cond (ps-windows-system "c:/temp") (t "/tmp") ))))) - "*Specify a directory for temporary files during printing. + "Specify a directory for temporary files during printing. See also `pr-ps-temp-file' and `pr-file-modes'." :type '(directory :tag "Temporary Directory") @@ -2224,7 +2224,7 @@ (defcustom pr-ps-temp-file "prspool-" - "*Specify PostScript temporary file name prefix. + "Specify PostScript temporary file name prefix. See also `pr-temp-dir' and `pr-file-modes'." :type '(file :tag "PostScript Temporary File Name") @@ -2235,7 +2235,7 @@ ;; So, by default, only the session owner have permission to deal with files ;; generated by `printing'. (defcustom pr-file-modes ?\600 - "*Specify the file permission bits for newly created files. + "Specify the file permission bits for newly created files. It should be an integer; only the low 9 bits are used. @@ -2248,7 +2248,7 @@ (if ps-windows-system "gsview32.exe" "gv") - "*Specify path and name of the gsview/gv utility. + "Specify path and name of the gsview/gv utility. See also `pr-path-alist'. @@ -2289,7 +2289,7 @@ (if ps-windows-system "gswin32.exe" "gs") - "*Specify path and name of the ghostscript utility. + "Specify path and name of the ghostscript utility. See also `pr-path-alist'. @@ -2315,7 +2315,7 @@ (if ps-windows-system '("-q -dNOPAUSE -Ic:/gs/gs5.50;c:/gs/gs5.50/fonts") '("-q -dNOPAUSE -I/usr/share/ghostscript/5.10")) - "*Specify ghostscript switches. See the documentation on GS for more info. + "Specify ghostscript switches. See the documentation on GS for more info. It's a list of strings, where each string is one or more ghostscript switches. @@ -2357,7 +2357,7 @@ (if ps-windows-system "mswinpr2" "uniprint") - "*Specify the ghostscript device switch value (-sDEVICE=). + "Specify the ghostscript device switch value (-sDEVICE=). A note on the gs switches: @@ -2370,7 +2370,7 @@ (defcustom pr-gs-resolution 300 - "*Specify ghostscript resolution switch value (-r). + "Specify ghostscript resolution switch value (-r). A note on the gs switches: @@ -2383,7 +2383,7 @@ (defcustom pr-print-using-ghostscript nil - "*Non-nil means print using ghostscript. + "Non-nil means print using ghostscript. This is useful if you don't have a PostScript printer, so you could use the ghostscript to print a PostScript file. @@ -2395,31 +2395,31 @@ (defcustom pr-faces-p nil - "*Non-nil means print with face attributes." + "Non-nil means print with face attributes." :type 'boolean :group 'printing) (defcustom pr-spool-p nil - "*Non-nil means spool printing in a buffer." + "Non-nil means spool printing in a buffer." :type 'boolean :group 'printing) (defcustom pr-file-landscape nil - "*Non-nil means print PostScript file in landscape orientation." + "Non-nil means print PostScript file in landscape orientation." :type 'boolean :group 'printing) (defcustom pr-file-duplex nil - "*Non-nil means print PostScript file in duplex mode." + "Non-nil means print PostScript file in duplex mode." :type 'boolean :group 'printing) (defcustom pr-file-tumble nil - "*Non-nil means print PostScript file in tumble mode. + "Non-nil means print PostScript file in tumble mode. If tumble is off, produces a printing suitable for binding on the left or right. @@ -2430,7 +2430,7 @@ (defcustom pr-auto-region t - "*Non-nil means region is automagically detected. + "Non-nil means region is automagically detected. Note that this will only work if you're using transient mark mode. @@ -2442,7 +2442,7 @@ (defcustom pr-auto-mode t - "*Non-nil means major-mode specific printing is prefered over normal printing. + "Non-nil means major-mode specific printing is prefered over normal printing. That is, if current major-mode is declared in `pr-mode-alist', the `*-buffer*' and `*-region*' commands will behave like `*-mode*' commands; otherwise, @@ -2510,7 +2510,7 @@ nil ) ) - "*Specify an alist for a major-mode and printing functions. + "Specify an alist for a major-mode and printing functions. To customize a major mode printing, just declare the customization in `pr-mode-alist' and invoke some of `*-mode*' commands. An example for major @@ -2653,7 +2653,7 @@ (defcustom pr-ps-utility 'mpage - "*Specify PostScript utility symbol. + "Specify PostScript utility symbol. This utility symbol should be defined on `pr-ps-utility-alist' (see it for documentation). @@ -2684,7 +2684,7 @@ ;; '((psnup "c:/psutils/psnup" ("-q") "-P%s" "-%d" "-l" nil nil " " nil ;; (pr-file-duplex . nil) (pr-file-tumble . nil)) ;; ) - "*Specify an alist for PostScript utility processing (PS utility database). + "Specify an alist for PostScript utility processing (PS utility database). The alist element has the form: @@ -2882,7 +2882,7 @@ (defcustom pr-menu-lock t - "*Non-nil means menu is locked while selecting toggle options. + "Non-nil means menu is locked while selecting toggle options. See also `pr-menu-char-height' and `pr-menu-char-width'." :type 'boolean @@ -2890,7 +2890,7 @@ (defcustom pr-menu-char-height (pr-menu-char-height) - "*Specify menu char height in pixels. + "Specify menu char height in pixels. This variable is used to guess which vertical position should be locked the menu, so don't forget to adjust it if menu position is not ok. @@ -2901,7 +2901,7 @@ (defcustom pr-menu-char-width (pr-menu-char-width) - "*Specify menu char width in pixels. + "Specify menu char width in pixels. This variable is used to guess which horizontal position should be locked the menu, so don't forget to adjust it if menu position is not ok. @@ -2917,7 +2917,7 @@ (pr-file-duplex . nil) ; settings (pr-file-tumble . nil)) ) - "*Specify an alist for settings in general. + "Specify an alist for settings in general. The elements have the following form: @@ -3029,7 +3029,7 @@ (defcustom pr-visible-entry-list '(postscript text postscript-options postscript-process printing help) - "*Specify a list of Printing menu visible entries. + "Specify a list of Printing menu visible entries. Valid values with the corresponding menu parts are: @@ -3081,7 +3081,7 @@ (defcustom pr-delete-temp-file t - "*Non-nil means delete temporary files. + "Non-nil means delete temporary files. Set `pr-delete-temp-file' to nil, if the following message (or a similar) happens when printing: @@ -3092,7 +3092,7 @@ (defcustom pr-list-directory nil - "*Non-nil means list directory when processing a directory. + "Non-nil means list directory when processing a directory. That is, any subdirectories (and the superdirectory) of the directory (given as argument of functions below) are also printed (as dired-mode listings). @@ -3105,7 +3105,7 @@ (defcustom pr-buffer-name "*Printing Interface*" - "*Specify the name of the buffer interface for printing package. + "Specify the name of the buffer interface for printing package. It's used by `pr-interface'." :type 'string @@ -3115,7 +3115,7 @@ (defcustom pr-buffer-name-ignore (list (regexp-quote pr-buffer-name) ; ignore printing interface buffer "^ .*$") ; ignore invisible buffers - "*Specify a regexp list for buffer names to be ignored in interface buffer. + "Specify a regexp list for buffer names to be ignored in interface buffer. NOTE: Case is important for matching, that is, `case-fold-search' is always nil. @@ -3126,7 +3126,7 @@ (defcustom pr-buffer-verbose t - "*Non-nil means to be verbose when editing a field in interface buffer. + "Non-nil means to be verbose when editing a field in interface buffer. It's used by `pr-interface'." :type 'boolean
--- a/lisp/ps-mule.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ps-mule.el Wed Dec 03 05:48:14 2008 +0000 @@ -94,7 +94,7 @@ ;;;###autoload (defcustom ps-multibyte-buffer nil - "*Specifies the multi-byte buffer handling. + "Specifies the multi-byte buffer handling. Valid values are: @@ -188,7 +188,7 @@ (defcustom ps-mule-font-info-database-default ps-mule-font-info-database-latin - "*The default setting to use when `ps-multibyte-buffer' is nil." + "The default setting to use when `ps-multibyte-buffer' is nil." :type '(symbol :tag "Multi-Byte Buffer Database Font Default") :group 'ps-print-font)
--- a/lisp/ps-print.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ps-print.el Wed Dec 03 05:48:14 2008 +0000 @@ -1095,7 +1095,7 @@ ;; foreground colors to be used when text foreground and background colors are ;; equals. It'll be used the first foreground color in `ps-fg-list' which is ;; different from the background color. If `ps-fg-list' is nil, the default -;; foreground color is used. +;; foreground color is used. ;; ;; ;; How Ps-Print Maps Faces @@ -1591,7 +1591,7 @@ (defcustom ps-error-handler-message 'paper - "*Specify where the error handler message should be sent. + "Specify where the error handler message should be sent. Valid values are: @@ -1617,7 +1617,7 @@ :group 'ps-print-miscellany) (defcustom ps-user-defined-prologue nil - "*User defined PostScript prologue code inserted before all prologue code. + "User defined PostScript prologue code inserted before all prologue code. `ps-user-defined-prologue' may be a string or a symbol function which returns a string. Note that this string is inserted after `ps-adobe-tag' and PostScript @@ -1649,7 +1649,7 @@ :group 'ps-print-miscellany) (defcustom ps-print-prologue-header nil - "*PostScript prologue header comments besides that ps-print generates. + "PostScript prologue header comments besides that ps-print generates. `ps-print-prologue-header' may be a string or a symbol function which returns a string. Note that this string is inserted on PostScript prologue header @@ -1680,7 +1680,7 @@ (defcustom ps-printer-name (and (boundp 'printer-name) (symbol-value 'printer-name)) - "*The name of a local printer for printing PostScript files. + "The name of a local printer for printing PostScript files. On Unix-like systems, a string value should be a name understood by lpr's -P option; a value of nil means use the value of `printer-name' instead. @@ -1717,7 +1717,7 @@ "-d") (t "-P" )) - "*Option for `ps-printer-name' variable (see it). + "Option for `ps-printer-name' variable (see it). On Unix-like systems, if `lpr' is in use, this should be the string \"-P\"; if `lp' is in use, this should be the string \"-d\". @@ -1742,7 +1742,7 @@ :group 'ps-print-printer) (defcustom ps-lpr-command lpr-command - "*Name of program for printing a PostScript file. + "Name of program for printing a PostScript file. On MS-DOS and MS-Windows systems, if the value is an empty string then Emacs will write directly to the printer port named by `ps-printer-name'. The @@ -1755,7 +1755,7 @@ :group 'ps-print-printer) (defcustom ps-lpr-switches lpr-switches - "*List of extra switches to pass to `ps-lpr-command'. + "List of extra switches to pass to `ps-lpr-command'. The list element can be: @@ -1785,7 +1785,7 @@ :group 'ps-print-printer) (defcustom ps-print-region-function nil - "*Specify a function to print the region on a PostScript printer. + "Specify a function to print the region on a PostScript printer. See definition of `call-process-region' for calling conventions. The fourth and the sixth arguments are both nil." :type '(choice (const nil) function) @@ -1793,7 +1793,7 @@ :group 'ps-print-printer) (defcustom ps-manual-feed nil - "*Non-nil means the printer will manually feed paper. + "Non-nil means the printer will manually feed paper. If it's nil, automatic feeding takes place." :type 'boolean @@ -1801,7 +1801,7 @@ :group 'ps-print-printer) (defcustom ps-end-with-control-d (and ps-windows-system t) - "*Non-nil means insert C-d at end of PostScript file generated." + "Non-nil means insert C-d at end of PostScript file generated." :version "21.1" :type 'boolean :version "20" @@ -1866,7 +1866,7 @@ '(vhsface 205.0 127.0 "VHSFace") '(vhsspine 400.0 50.0 "VHSSpine") '(zipdisk 156.0 136.0 "ZipDisk")) - "*List associating a symbolic paper type to its width, height and doc media. + "List associating a symbolic paper type to its width, height and doc media. See `ps-paper-type'." :type '(repeat (list :tag "Paper Type" (symbol :tag "Symbol Name") @@ -1878,7 +1878,7 @@ ;;;###autoload (defcustom ps-paper-type 'letter - "*Specify the size of paper to format for. + "Specify the size of paper to format for. Should be one of the paper types defined in `ps-page-dimensions-database', for example `letter', `legal' or `a4'." :type '(symbol :validate (lambda (wid) @@ -1891,7 +1891,7 @@ :group 'ps-print-page) (defcustom ps-warn-paper-type t - "*Non-nil means give an error if paper size is not equal to `ps-paper-type'. + "Non-nil means give an error if paper size is not equal to `ps-paper-type'. It's used when `ps-spool-config' is set to `setpagedevice'." :type 'boolean @@ -1899,19 +1899,19 @@ :group 'ps-print-page) (defcustom ps-landscape-mode nil - "*Non-nil means print in landscape mode." + "Non-nil means print in landscape mode." :type 'boolean :version "20" :group 'ps-print-page) (defcustom ps-print-upside-down nil - "*Non-nil means print upside-down (that is, rotated by 180 degrees)." + "Non-nil means print upside-down (that is, rotated by 180 degrees)." :type 'boolean :version "21.1" :group 'ps-print-page) (defcustom ps-selected-pages nil - "*Specify which pages to print. + "Specify which pages to print. If nil, print all pages. @@ -1938,7 +1938,7 @@ :group 'ps-print-page) (defcustom ps-even-or-odd-pages nil - "*Specify if it prints even/odd pages. + "Specify if it prints even/odd pages. Valid values are: @@ -1997,7 +1997,7 @@ :group 'ps-print-page) (defcustom ps-print-control-characters 'control-8-bit - "*Specify the printable form for control and 8-bit characters. + "Specify the printable form for control and 8-bit characters. That is, instead of sending, for example, a ^D (\\004) to printer, it is sent the string \"^D\". @@ -2029,7 +2029,7 @@ :group 'ps-print-miscellany) (defcustom ps-n-up-printing 1 - "*Specify the number of pages per sheet paper." + "Specify the number of pages per sheet paper." :type '(integer :tag "N Up Printing" :validate @@ -2045,19 +2045,19 @@ :group 'ps-print-n-up) (defcustom ps-n-up-margin (/ (* 72 1.0) 2.54) ; 1 cm - "*Specify the margin in points between the sheet border and n-up printing." + "Specify the margin in points between the sheet border and n-up printing." :type 'number :version "20" :group 'ps-print-n-up) (defcustom ps-n-up-border-p t - "*Non-nil means a border is drawn around each page." + "Non-nil means a border is drawn around each page." :type 'boolean :version "20" :group 'ps-print-n-up) (defcustom ps-n-up-filling 'left-top - "*Specify how page matrix is filled on each sheet of paper. + "Specify how page matrix is filled on each sheet of paper. Following are the valid values for `ps-n-up-filling' with a filling example using a 3x4 page matrix: @@ -2089,27 +2089,27 @@ :group 'ps-print-n-up) (defcustom ps-number-of-columns (if ps-landscape-mode 2 1) - "*Specify the number of columns." + "Specify the number of columns." :type 'number :version "20" :group 'ps-print-miscellany) (defcustom ps-zebra-stripes nil - "*Non-nil means print zebra stripes. + "Non-nil means print zebra stripes. See also documentation for `ps-zebra-stripe-height' and `ps-zebra-color'." :type 'boolean :version "20" :group 'ps-print-zebra) (defcustom ps-zebra-stripe-height 3 - "*Number of zebra stripe lines. + "Number of zebra stripe lines. See also documentation for `ps-zebra-stripes' and `ps-zebra-color'." :type 'number :version "20" :group 'ps-print-zebra) (defcustom ps-zebra-color 0.95 - "*Zebra stripe gray scale or RGB color. + "Zebra stripe gray scale or RGB color. See also documentation for `ps-zebra-stripes' and `ps-zebra-stripe-height'." :type '(choice :menu-tag "Zebra Gray/Color" :tag "Zebra Gray/Color" @@ -2123,7 +2123,7 @@ :group 'ps-print-zebra) (defcustom ps-zebra-stripe-follow nil - "*Specify how zebra stripes continue on next page. + "Specify how zebra stripes continue on next page. Visually, valid values are (the character `+' at right of each column indicates that a line is printed): @@ -2167,13 +2167,13 @@ :group 'ps-print-zebra) (defcustom ps-line-number nil - "*Non-nil means print line number." + "Non-nil means print line number." :type 'boolean :version "20" :group 'ps-print-miscellany) (defcustom ps-line-number-step 1 - "*Specify the interval that line number is printed. + "Specify the interval that line number is printed. For example, `ps-line-number-step' is set to 2, the printing will look like: @@ -2203,7 +2203,7 @@ :group 'ps-print-miscellany) (defcustom ps-line-number-start 1 - "*Specify the starting point in the interval given by `ps-line-number-step'. + "Specify the starting point in the interval given by `ps-line-number-step'. For example, if `ps-line-number-step' is set to 3 and `ps-line-number-start' is set to 3, the printing will look like: @@ -2233,7 +2233,7 @@ :group 'ps-print-miscellany) (defcustom ps-print-background-image nil - "*EPS image list to be printed on background. + "EPS image list to be printed on background. The elements are: @@ -2280,7 +2280,7 @@ :group 'ps-print-background) (defcustom ps-print-background-text nil - "*Text list to be printed on background. + "Text list to be printed on background. The elements are: @@ -2340,19 +2340,19 @@ ;; ------------------------------------------ (defcustom ps-left-margin (/ (* 72 2.0) 2.54) ; 2 cm - "*Left margin in points (1/72 inch)." + "Left margin in points (1/72 inch)." :type 'number :version "20" :group 'ps-print-horizontal) (defcustom ps-right-margin (/ (* 72 2.0) 2.54) ; 2 cm - "*Right margin in points (1/72 inch)." + "Right margin in points (1/72 inch)." :type 'number :version "20" :group 'ps-print-horizontal) (defcustom ps-inter-column (/ (* 72 2.0) 2.54) ; 2 cm - "*Horizontal space between columns in points (1/72 inch)." + "Horizontal space between columns in points (1/72 inch)." :type 'number :version "20" :group 'ps-print-horizontal) @@ -2372,25 +2372,25 @@ ;; |--------| (defcustom ps-bottom-margin (/ (* 72 1.5) 2.54) ; 1.5 cm - "*Bottom margin in points (1/72 inch)." + "Bottom margin in points (1/72 inch)." :type 'number :version "20" :group 'ps-print-vertical) (defcustom ps-top-margin (/ (* 72 1.5) 2.54) ; 1.5 cm - "*Top margin in points (1/72 inch)." + "Top margin in points (1/72 inch)." :type 'number :version "20" :group 'ps-print-vertical) (defcustom ps-header-offset (/ (* 72 1.0) 2.54) ; 1.0 cm - "*Vertical space in points (1/72 inch) between the main text and the header." + "Vertical space in points (1/72 inch) between the main text and the header." :type 'number :version "20" :group 'ps-print-vertical) (defcustom ps-header-line-pad 0.15 - "*Portion of a header title line height to insert. + "Portion of a header title line height to insert. The insertion is done between the header frame and the text it contains, both in the vertical and horizontal directions." :type 'number @@ -2398,13 +2398,13 @@ :group 'ps-print-vertical) (defcustom ps-footer-offset (/ (* 72 1.0) 2.54) ; 1.0 cm - "*Vertical space in points (1/72 inch) between the main text and the footer." + "Vertical space in points (1/72 inch) between the main text and the footer." :type 'number :version "20" :group 'ps-print-vertical) (defcustom ps-footer-line-pad 0.15 - "*Portion of a footer title line height to insert. + "Portion of a footer title line height to insert. The insertion is done between the footer frame and the text it contains, both in the vertical and horizontal directions." :type 'number @@ -2414,7 +2414,7 @@ ;;; Header/Footer setup (defcustom ps-print-header t - "*Non-nil means print a header at the top of each page. + "Non-nil means print a header at the top of each page. By default, the header displays the buffer name, page number, and, if the buffer is visiting a file, the file's directory. Headers are customizable by changing variables `ps-left-header' and `ps-right-header'." @@ -2423,7 +2423,7 @@ :group 'ps-print-headers) (defcustom ps-print-header-frame t - "*Non-nil means draw a gaudy frame around the header." + "Non-nil means draw a gaudy frame around the header." :type 'boolean :version "20" :group 'ps-print-headers) @@ -2434,7 +2434,7 @@ (border-width . 0.4) (border-color . 0.0) (shadow-color . 0.0)) - "*Specify header frame properties alist. + "Specify header frame properties alist. Valid frame properties are: @@ -2509,13 +2509,13 @@ :group 'ps-print-headers) (defcustom ps-header-lines 2 - "*Number of lines to display in page header, when generating PostScript." + "Number of lines to display in page header, when generating PostScript." :type 'integer :version "20" :group 'ps-print-headers) (defcustom ps-print-footer nil - "*Non-nil means print a footer at the bottom of each page. + "Non-nil means print a footer at the bottom of each page. By default, the footer displays page number. Footers are customizable by changing variables `ps-left-footer' and `ps-right-footer'." @@ -2524,7 +2524,7 @@ :group 'ps-print-headers) (defcustom ps-print-footer-frame t - "*Non-nil means draw a gaudy frame around the footer." + "Non-nil means draw a gaudy frame around the footer." :type 'boolean :version "21.1" :group 'ps-print-headers) @@ -2535,7 +2535,7 @@ (border-width . 0.4) (border-color . 0.0) (shadow-color . 0.0)) - "*Specify footer frame properties alist. + "Specify footer frame properties alist. Don't change this alist directly, instead use customization, or `ps-value', `ps-get', `ps-put' and `ps-del' functions (see them for documentation). @@ -2591,13 +2591,13 @@ :group 'ps-print-headers) (defcustom ps-footer-lines 2 - "*Number of lines to display in page footer, when generating PostScript." + "Number of lines to display in page footer, when generating PostScript." :type 'integer :version "21.1" :group 'ps-print-headers) (defcustom ps-print-only-one-header nil - "*Non-nil means print only one header/footer at the top/bottom of each page. + "Non-nil means print only one header/footer at the top/bottom of each page. This is useful when printing more than one column, so it is possible to have only one header/footer over all columns or one header/footer per column. See also `ps-print-header' and `ps-print-footer'." @@ -2606,7 +2606,7 @@ :group 'ps-print-headers) (defcustom ps-switch-header 'duplex - "*Specify if headers/footers are switched or not. + "Specify if headers/footers are switched or not. Valid values are: @@ -2629,7 +2629,7 @@ :group 'ps-print-headers) (defcustom ps-show-n-of-n t - "*Non-nil means show page numbers as N/M, meaning page N of M. + "Non-nil means show page numbers as N/M, meaning page N of M. NOTE: page numbers are displayed as part of headers, see variable `ps-print-header'." :type 'boolean @@ -2640,7 +2640,7 @@ (if ps-windows-system nil 'lpr-switches) - "*Specify who is responsible for setting duplex and page size. + "Specify who is responsible for setting duplex and page size. Valid values are: @@ -2674,7 +2674,7 @@ (defcustom ps-spool-duplex nil ; Not many people have duplex printers, ; so default to nil. - "*Non-nil generates PostScript for a two-sided printer. + "Non-nil generates PostScript for a two-sided printer. For a duplex printer, the `ps-spool-*' and `ps-print-*' commands will insert blank pages as needed between print jobs so that the next buffer printed will start on the right page. Also, if headers are turned on, the headers will be @@ -2687,7 +2687,7 @@ :group 'ps-print-headers) (defcustom ps-spool-tumble nil - "*Specify how the page images on opposite sides of a sheet are oriented. + "Specify how the page images on opposite sides of a sheet are oriented. If `ps-spool-tumble' is nil, produces output suitable for binding on the left or right. If `ps-spool-tumble' is non-nil, produces output suitable for binding at the top or bottom. @@ -2811,7 +2811,7 @@ (space-width . 2.2) (avg-char-width . 4.10811)) ) - "*Font info database. + "Font info database. Each element comprises: font family (the key), name, bold, italic, bold-italic, reference size, line height, space width, average character width. To get the info for another specific font (say Helvetica), do the following: @@ -2857,13 +2857,13 @@ :group 'ps-print-font) (defcustom ps-font-family 'Courier - "*Font family name for ordinary text, when generating PostScript." + "Font family name for ordinary text, when generating PostScript." :type 'symbol :version "20" :group 'ps-print-font) (defcustom ps-font-size '(7 . 8.5) - "*Font size, in points, for ordinary text, when generating PostScript. + "Font size, in points, for ordinary text, when generating PostScript. Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)." :type '(choice :menu-tag "Ordinary Text Font Size" :tag "Ordinary Text Font Size" @@ -2875,13 +2875,13 @@ :group 'ps-print-font) (defcustom ps-header-font-family 'Helvetica - "*Font family name for text in the header, when generating PostScript." + "Font family name for text in the header, when generating PostScript." :type 'symbol :version "20" :group 'ps-print-font) (defcustom ps-header-font-size '(10 . 12) - "*Font size, in points, for text in the header, when generating PostScript. + "Font size, in points, for text in the header, when generating PostScript. Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)." :type '(choice :menu-tag "Header Font Size" :tag "Header Font Size" @@ -2893,7 +2893,7 @@ :group 'ps-print-font) (defcustom ps-header-title-font-size '(12 . 14) - "*Font size, in points, for the top line of text in header, in PostScript. + "Font size, in points, for the top line of text in header, in PostScript. Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)." :type '(choice :menu-tag "Header Title Font Size" :tag "Header Title Font Size" @@ -2905,13 +2905,13 @@ :group 'ps-print-font) (defcustom ps-footer-font-family 'Helvetica - "*Font family name for text in the footer, when generating PostScript." + "Font family name for text in the footer, when generating PostScript." :type 'symbol :version "21.1" :group 'ps-print-font) (defcustom ps-footer-font-size '(10 . 12) - "*Font size, in points, for text in the footer, when generating PostScript. + "Font size, in points, for text in the footer, when generating PostScript. Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)." :type '(choice :menu-tag "Footer Font Size" :tag "Footer Font Size" @@ -2923,7 +2923,7 @@ :group 'ps-print-font) (defcustom ps-line-number-color "black" - "*Specify color for line-number, when generating PostScript." + "Specify color for line-number, when generating PostScript." :type '(choice :menu-tag "Line Number Color" :tag "Line Number Color" (number :tag "Gray Scale" :value 0) @@ -2937,14 +2937,14 @@ :group 'ps-print-miscellany) (defcustom ps-line-number-font "Times-Italic" - "*Font for line-number, when generating PostScript." + "Font for line-number, when generating PostScript." :type 'string :version "20" :group 'ps-print-font :group 'ps-print-miscellany) (defcustom ps-line-number-font-size 6 - "*Font size, in points, for line number, when generating PostScript. + "Font size, in points, for line number, when generating PostScript. Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)." :type '(choice :menu-tag "Line Number Font Size" :tag "Line Number Font Size" @@ -2966,7 +2966,7 @@ (or (fboundp 'x-color-values) ; Emacs (fboundp 'color-instance-rgb-components)) ; XEmacs - "*Specify how buffer's text color is printed. + "Specify how buffer's text color is printed. Valid values are: @@ -2987,7 +2987,7 @@ :group 'ps-print-color) (defcustom ps-default-fg nil - "*RGB values of the default foreground color. + "RGB values of the default foreground color. The `ps-default-fg' variable contains the default foreground color used by ps-print, that is, if there is a face in a text that doesn't have a foreground @@ -3031,7 +3031,7 @@ :group 'ps-print-color) (defcustom ps-default-bg nil - "*RGB values of the default background color. + "RGB values of the default background color. The `ps-default-bg' variable contains the default background color used by ps-print, that is, if there is a face in a text that doesn't have a background @@ -3077,7 +3077,7 @@ :group 'ps-print-color) (defcustom ps-fg-list nil - "*Specify foreground color list. + "Specify foreground color list. This list is used to chose a text foreground color which is different than the background color. It'll be used the first foreground color in `ps-fg-list' @@ -3119,7 +3119,7 @@ :group 'ps-print-color) (defcustom ps-fg-validate-p t - "*Non-nil means validate if foreground color is different than background. + "Non-nil means validate if foreground color is different than background. If text foreground and background colors are equals, no text will appear. @@ -3129,7 +3129,7 @@ :group 'ps-print-color) (defcustom ps-auto-font-detect t - "*Non-nil means automatically detect bold/italic/underline face attributes. + "Non-nil means automatically detect bold/italic/underline face attributes. If nil, we rely solely on the lists `ps-bold-faces', `ps-italic-faces', and `ps-underlined-faces'." :type 'boolean @@ -3146,7 +3146,7 @@ (font-lock-type-face "black" nil italic) (font-lock-variable-name-face "black" nil bold italic) (font-lock-warning-face "black" nil bold italic)) - "*Specify list of face attributes to print colors on black/white printers. + "Specify list of face attributes to print colors on black/white printers. The list elements are the same as defined on `ps-extend-face' (which see). @@ -3183,7 +3183,7 @@ font-lock-variable-name-face font-lock-keyword-face font-lock-warning-face)) - "*A list of the \(non-bold\) faces that should be printed in bold font. + "A list of the \(non-bold\) faces that should be printed in bold font. This applies to generating PostScript." :type '(repeat face) :version "20" @@ -3196,7 +3196,7 @@ font-lock-string-face font-lock-comment-face font-lock-warning-face)) - "*A list of the \(non-italic\) faces that should be printed in italic font. + "A list of the \(non-italic\) faces that should be printed in italic font. This applies to generating PostScript." :type '(repeat face) :version "20" @@ -3207,14 +3207,14 @@ '(font-lock-function-name-face font-lock-constant-face font-lock-warning-face)) - "*A list of the \(non-underlined\) faces that should be printed underlined. + "A list of the \(non-underlined\) faces that should be printed underlined. This applies to generating PostScript." :type '(repeat face) :version "20" :group 'ps-print-face) (defcustom ps-use-face-background nil - "*Specify if face background should be used. + "Specify if face background should be used. Valid values are: @@ -3235,7 +3235,7 @@ (defcustom ps-left-header (list 'ps-get-buffer-name 'ps-header-dirpart) - "*The items to display (each on a line) on the left part of the page header. + "The items to display (each on a line) on the left part of the page header. This applies to generating PostScript. The value should be a list of strings and symbols, each representing an entry @@ -3260,7 +3260,7 @@ (defcustom ps-right-header (list "/pagenumberstring load" 'ps-time-stamp-locale-default 'ps-time-stamp-hh:mm:ss) - "*The items to display (each on a line) on the right part of the page header. + "The items to display (each on a line) on the right part of the page header. This applies to generating PostScript. See the variable `ps-left-header' for a description of the format of this @@ -3290,7 +3290,7 @@ (defcustom ps-left-footer (list 'ps-get-buffer-name 'ps-header-dirpart) - "*The items to display (each on a line) on the left part of the page footer. + "The items to display (each on a line) on the left part of the page footer. This applies to generating PostScript. The value should be a list of strings and symbols, each representing an entry @@ -3315,7 +3315,7 @@ (defcustom ps-right-footer (list "/pagenumberstring load" 'ps-time-stamp-locale-default 'ps-time-stamp-hh:mm:ss) - "*The items to display (each on a line) on the right part of the page footer. + "The items to display (each on a line) on the right part of the page footer. This applies to generating PostScript. See the variable `ps-left-footer' for a description of the format of this @@ -3344,13 +3344,13 @@ :group 'ps-print-headers) (defcustom ps-razzle-dazzle t - "*Non-nil means report progress while formatting buffer." + "Non-nil means report progress while formatting buffer." :type 'boolean :version "20" :group 'ps-print-miscellany) (defcustom ps-adobe-tag "%!PS-Adobe-3.0\n" - "*Contains the header line identifying the output as PostScript. + "Contains the header line identifying the output as PostScript. By default, `ps-adobe-tag' contains the standard identifier. Some printers require slightly different versions of this line." :type 'string @@ -3358,7 +3358,7 @@ :group 'ps-print-miscellany) (defcustom ps-build-face-reference t - "*Non-nil means build the reference face lists. + "Non-nil means build the reference face lists. ps-print sets this value to nil after it builds its internal reference lists of bold and italic faces. By setting its value back to t, you can force ps-print @@ -3373,7 +3373,7 @@ :group 'ps-print-face) (defcustom ps-always-build-face-reference nil - "*Non-nil means always rebuild the reference face lists. + "Non-nil means always rebuild the reference face lists. If this variable is non-nil, ps-print will rebuild its internal reference lists of bold and italic faces *every* time one of the ...-with-faces commands is @@ -3383,7 +3383,7 @@ :group 'ps-print-face) (defcustom ps-banner-page-when-duplexing nil - "*Non-nil means the very first page is skipped. + "Non-nil means the very first page is skipped. It's like the very first character of buffer (or region) is ^L (\\014)." :type 'boolean :version "20" @@ -3399,14 +3399,14 @@ nil)) data-directory) ; Emacs (error "`ps-postscript-code-directory' isn't set properly")) - "*Directory where it's located the PostScript prologue file used by ps-print. + "Directory where it's located the PostScript prologue file used by ps-print. By default, this directory is the same as in the variable `data-directory'." :type 'directory :version "20" :group 'ps-print-miscellany) (defcustom ps-line-spacing 0 - "*Specify line spacing, in points, for ordinary text. + "Specify line spacing, in points, for ordinary text. Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE). @@ -3424,7 +3424,7 @@ :group 'ps-print-miscellany) (defcustom ps-paragraph-spacing 0 - "*Specify paragraph spacing, in points, for ordinary text. + "Specify paragraph spacing, in points, for ordinary text. Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE). @@ -3442,7 +3442,7 @@ :group 'ps-print-miscellany) (defcustom ps-paragraph-regexp "[ \t]*$" - "*Specify paragraph delimiter. + "Specify paragraph delimiter. It should be a regexp or nil. @@ -3454,7 +3454,7 @@ :group 'ps-print-miscellany) (defcustom ps-begin-cut-regexp nil - "*Specify regexp which is start of a region to cut out when printing. + "Specify regexp which is start of a region to cut out when printing. As an example, variables `ps-begin-cut-regexp' and `ps-end-cut-regexp' may be set to \"^Local Variables:\" and \"^End:\", respectively, in order to leave out @@ -3472,7 +3472,7 @@ :group 'ps-print-miscellany) (defcustom ps-end-cut-regexp nil - "*Specify regexp which is end of the region to cut out when printing. + "Specify regexp which is end of the region to cut out when printing. See `ps-begin-cut-regexp' for more information." :type '(choice (const :tag "No Delimiter" nil) @@ -6652,11 +6652,11 @@ ;; But autoload them here to make the separation invisible. ;;;### (autoloads (ps-mule-end-job ps-mule-begin-job ps-mule-initialize -;;;;;; ps-multibyte-buffer) "ps-mule" "ps-mule.el" "a17af1e83e9b0292c042c259cdccdde3") +;;;;;; ps-multibyte-buffer) "ps-mule" "ps-mule.el" "8611812e601bd374ad6c457dcedc9675") ;;; Generated autoloads from ps-mule.el (defvar ps-multibyte-buffer nil "\ -*Specifies the multi-byte buffer handling. +Specifies the multi-byte buffer handling. Valid values are:
--- a/lisp/replace.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/replace.el Wed Dec 03 05:48:14 2008 +0000 @@ -28,7 +28,7 @@ ;;; Code: (defcustom case-replace t - "*Non-nil means `query-replace' should preserve case in replacements." + "Non-nil means `query-replace' should preserve case in replacements." :type 'boolean :group 'matching) @@ -62,24 +62,24 @@ :version "20.3") (defcustom query-replace-skip-read-only nil - "*Non-nil means `query-replace' and friends ignore read-only matches." + "Non-nil means `query-replace' and friends ignore read-only matches." :type 'boolean :group 'matching :version "22.1") (defcustom query-replace-show-replacement t - "*Non-nil means to show what actual replacement text will be." + "Non-nil means to show what actual replacement text will be." :type 'boolean :group 'matching :version "23.1") (defcustom query-replace-highlight t - "*Non-nil means to highlight matches during query replacement." + "Non-nil means to highlight matches during query replacement." :type 'boolean :group 'matching) (defcustom query-replace-lazy-highlight t - "*Controls the lazy-highlighting during query replacements. + "Controls the lazy-highlighting during query replacements. When non-nil, all text in the buffer matching the current match is highlighted lazily using isearch lazy highlighting (see `lazy-highlight-initial-delay' and `lazy-highlight-interval')." @@ -773,19 +773,19 @@ "Auto Occurrence Display" "Display another occurrence when moving the cursor")) (define-key map [separator-1] '("--")) - (define-key map [kill-this-buffer] + (define-key map [kill-this-buffer] '(menu-item "Kill occur buffer" kill-this-buffer :help "Kill the current *Occur* buffer")) - (define-key map [quit-window] + (define-key map [quit-window] '(menu-item "Quit occur window" quit-window :help "Quit the current *Occur* buffer. Bury it, and maybe delete the selected frame")) - (define-key map [revert-buffer] + (define-key map [revert-buffer] '(menu-item "Revert occur buffer" revert-buffer :help "Replace the text in the *Occur* buffer with the results of rerunning occur")) - (define-key map [clone-buffer] + (define-key map [clone-buffer] '(menu-item "Clone occur buffer" clone-buffer :help "Create and return a twin copy of the current *Occur* buffer")) - (define-key map [occur-rename-buffer] + (define-key map [occur-rename-buffer] '(menu-item "Rename occur buffer" occur-rename-buffer :help "Rename the current *Occur* buffer to *Occur: original-buffer-name*.")) (define-key map [separator-2] '("--")) @@ -798,10 +798,10 @@ (define-key map [occur-mode-display-occurrence] '(menu-item "Display Occurrence" occur-mode-display-occurrence :help "Display in another window the occurrence the current line describes")) - (define-key map [occur-next] + (define-key map [occur-next] '(menu-item "Move to next match" occur-next :help "Move to the Nth (default 1) next match in an Occur mode buffer")) - (define-key map [occur-prev] + (define-key map [occur-prev] '(menu-item "Move to previous match" occur-prev :help "Move to the Nth (default 1) previous match in an Occur mode buffer")) map) @@ -970,7 +970,7 @@ :version "22.1") (defcustom list-matching-lines-default-context-lines 0 - "*Default number of context lines included around `list-matching-lines' matches. + "Default number of context lines included around `list-matching-lines' matches. A negative number means to include that many lines before the match. A positive number means to include that many lines both before and after." :type 'integer @@ -979,13 +979,13 @@ (defalias 'list-matching-lines 'occur) (defcustom list-matching-lines-face 'match - "*Face used by \\[list-matching-lines] to show the text that matches. + "Face used by \\[list-matching-lines] to show the text that matches. If the value is nil, don't highlight the matching portions specially." :type 'face :group 'matching) (defcustom list-matching-lines-buffer-name-face 'underline - "*Face used by \\[list-matching-lines] to show the names of buffers. + "Face used by \\[list-matching-lines] to show the names of buffers. If the value is nil, don't highlight the buffer names specially." :type 'face :group 'matching) @@ -993,7 +993,7 @@ (defcustom occur-excluded-properties '(read-only invisible intangible field mouse-face help-echo local-map keymap yank-handler follow-link) - "*Text properties to discard when copying lines to the *Occur* buffer. + "Text properties to discard when copying lines to the *Occur* buffer. The value should be a list of text properties to discard or t, which means to discard all text properties." :type '(choice (const :tag "All" t) (repeat symbol))
--- a/lisp/ruler-mode.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/ruler-mode.el Wed Dec 03 05:48:14 2008 +0000 @@ -119,7 +119,7 @@ :group 'convenience) (defcustom ruler-mode-show-tab-stops nil - "*If non-nil the ruler shows tab stop positions. + "If non-nil the ruler shows tab stop positions. Also allowing to visually change `tab-stop-list' setting using <C-down-mouse-1> and <C-down-mouse-3> on the ruler to respectively add or remove a tab stop. \\[ruler-mode-toggle-show-tab-stops] or @@ -141,7 +141,7 @@ (defcustom ruler-mode-fill-column-char (if (char-displayable-p ?¶) ?\¶ ?\|) - "*Character used at the `fill-column' location." + "Character used at the `fill-column' location." :group 'ruler-mode :type '(choice (character :tag "Character") @@ -149,7 +149,7 @@ :validate ruler-mode-character-validate))) (defcustom ruler-mode-comment-column-char ?\# - "*Character used at the `comment-column' location." + "Character used at the `comment-column' location." :group 'ruler-mode :type '(choice (character :tag "Character") @@ -157,7 +157,7 @@ :validate ruler-mode-character-validate))) (defcustom ruler-mode-goal-column-char ?G - "*Character used at the `goal-column' location." + "Character used at the `goal-column' location." :group 'ruler-mode :type '(choice (character :tag "Character") @@ -167,7 +167,7 @@ (defcustom ruler-mode-current-column-char (if (char-displayable-p ?¦) ?\¦ ?\@) - "*Character used at the `current-column' location." + "Character used at the `current-column' location." :group 'ruler-mode :type '(choice (character :tag "Character") @@ -175,7 +175,7 @@ :validate ruler-mode-character-validate))) (defcustom ruler-mode-tab-stop-char ?\T - "*Character used at `tab-stop-list' locations." + "Character used at `tab-stop-list' locations." :group 'ruler-mode :type '(choice (character :tag "Character") @@ -183,7 +183,7 @@ :validate ruler-mode-character-validate))) (defcustom ruler-mode-basic-graduation-char ?\. - "*Character used for basic graduations." + "Character used for basic graduations." :group 'ruler-mode :type '(choice (character :tag "Character") @@ -191,7 +191,7 @@ :validate ruler-mode-character-validate))) (defcustom ruler-mode-inter-graduation-char ?\! - "*Character used for intermediate graduations." + "Character used for intermediate graduations." :group 'ruler-mode :type '(choice (character :tag "Character") @@ -199,7 +199,7 @@ :validate ruler-mode-character-validate))) (defcustom ruler-mode-set-goal-column-ding-flag t - "*Non-nil means do `ding' when `goal-column' is set." + "Non-nil means do `ding' when `goal-column' is set." :group 'ruler-mode :type 'boolean) @@ -664,7 +664,7 @@ ;; Create an "clean" ruler. (ruler (propertize - (string-to-multibyte + (string-to-multibyte (make-string w ruler-mode-basic-graduation-char)) 'face 'ruler-mode-default 'local-map ruler-mode-map
--- a/lisp/saveplace.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/saveplace.el Wed Dec 03 05:48:14 2008 +0000 @@ -52,7 +52,7 @@ This alist is saved between Emacs sessions.") (defcustom save-place nil - "*Non-nil means automatically save place in each file. + "Non-nil means automatically save place in each file. This means when you visit a file, point goes to the last place where it was when you previously visited the same file. This variable is automatically buffer-local. @@ -71,12 +71,12 @@ (make-variable-buffer-local 'save-place) (defcustom save-place-file (convert-standard-filename "~/.emacs-places") - "*Name of the file that records `save-place-alist' value." + "Name of the file that records `save-place-alist' value." :type 'file :group 'save-place) (defcustom save-place-version-control nil - "*Controls whether to make numbered backups of master save-place file. + "Controls whether to make numbered backups of master save-place file. It can have four values: t, nil, `never', and `nospecial'. The first three have the same meaning that they do for the variable `version-control', and the final value `nospecial' means just use the
--- a/lisp/sb-image.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/sb-image.el Wed Dec 03 05:48:14 2008 +0000 @@ -37,7 +37,7 @@ ;;; Code: (defcustom speedbar-use-images ezimage-use-images - "*Non-nil if speedbar should display icons." + "Non-nil if speedbar should display icons." :group 'speedbar :version "21.1" :type 'boolean)
--- a/lisp/scroll-bar.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/scroll-bar.el Wed Dec 03 05:48:14 2008 +0000 @@ -94,7 +94,7 @@ scroll-bar-mode))))) (defcustom scroll-bar-mode default-frame-scroll-bars - "*Specify whether to have vertical scroll bars, and on which side. + "Specify whether to have vertical scroll bars, and on which side. Possible values are nil (no scroll bars), `left' (scroll bars on left) and `right' (scroll bars on right). To set this variable in a Lisp program, use `set-scroll-bar-mode' @@ -122,7 +122,7 @@ (interactive "P") ;; Tweedle the variable according to the argument. - (set-scroll-bar-mode (if (if (null flag) + (set-scroll-bar-mode (if (if (null flag) (not scroll-bar-mode) (setq flag (prefix-numeric-value flag)) (or (not (numberp flag)) (>= flag 0)))
--- a/lisp/sha1.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/sha1.el Wed Dec 03 05:48:14 2008 +0000 @@ -63,7 +63,7 @@ :group 'extensions) (defcustom sha1-maximum-internal-length 500 - "*Maximum length of message to use Lisp version of SHA1 function. + "Maximum length of message to use Lisp version of SHA1 function. If message is longer than this, `sha1-program' is used instead. If this variable is set to 0, use external program only. @@ -72,7 +72,7 @@ :group 'sha1) (defcustom sha1-program '("sha1sum") - "*Name of program to compute SHA1. + "Name of program to compute SHA1. It must be a string \(program name\) or list of strings \(name and its args\)." :type '(repeat string) :group 'sha1) @@ -80,7 +80,7 @@ (defcustom sha1-use-external (condition-case () (executable-find (car sha1-program)) (error)) - "*Use external SHA1 program. + "Use external SHA1 program. If this variable is set to nil, use internal function only." :type 'boolean :group 'sha1)
--- a/lisp/shadowfile.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/shadowfile.el Wed Dec 03 05:48:14 2008 +0000 @@ -88,14 +88,14 @@ :group 'files) (defcustom shadow-noquery nil - "*If t, always copy shadow files without asking. + "If t, always copy shadow files without asking. If nil \(the default), always ask. If not nil and not t, ask only if there is no buffer currently visiting the file." :type '(choice (const t) (const nil) (other :tag "Ask if no buffer" maybe)) :group 'shadow) (defcustom shadow-inhibit-message nil - "*If non-nil, do not display a message when a file needs copying." + "If non-nil, do not display a message when a file needs copying." :type 'boolean :group 'shadow)
--- a/lisp/shell.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/shell.el Wed Dec 03 05:48:14 2008 +0000 @@ -355,7 +355,7 @@ 'complete-expand))) (defcustom shell-mode-hook '() - "*Hook for customising Shell mode." + "Hook for customising Shell mode." :type 'hook :group 'shell)
--- a/lisp/sort.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/sort.el Wed Dec 03 05:48:14 2008 +0000 @@ -34,7 +34,7 @@ :group 'data) (defcustom sort-fold-case nil - "*Non-nil if the buffer sort functions should ignore case." + "Non-nil if the buffer sort functions should ignore case." :group 'sort :type 'boolean) ;;;###autoload(put 'sort-fold-case 'safe-local-variable 'booleanp) @@ -256,7 +256,7 @@ (setq sort-fields-syntax-table table))) (defcustom sort-numeric-base 10 - "*The default base used by `sort-numeric-fields'." + "The default base used by `sort-numeric-fields'." :group 'sort :type 'integer) ;;;###autoload(put 'sort-numeric-base 'safe-local-variable 'integerp)
--- a/lisp/speedbar.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/speedbar.el Wed Dec 03 05:48:14 2008 +0000 @@ -244,14 +244,14 @@ functionality individually.") (defcustom speedbar-mode-specific-contents-flag t - "*Non-nil means speedbar will show special mode contents. + "Non-nil means speedbar will show special mode contents. This permits some modes to create customized contents for the speedbar frame." :group 'speedbar :type 'boolean) (defcustom speedbar-query-confirmation-method 'all - "*Query control for file operations. + "Query control for file operations. The 'always flag means to always query before file operations. The 'none-but-delete flag means to not query before any file operations, except before a file deletion." @@ -277,24 +277,24 @@ effective when its display is shown.") (defcustom speedbar-before-visiting-file-hook '(push-mark) - "*Hooks run before speedbar visits a file in the selected frame. + "Hooks run before speedbar visits a file in the selected frame. The default buffer is the buffer in the selected window in the attached frame." :group 'speedbar :type 'hook) (defcustom speedbar-visiting-file-hook nil - "*Hooks run when speedbar visits a file in the selected frame." + "Hooks run when speedbar visits a file in the selected frame." :group 'speedbar :type 'hook) (defcustom speedbar-before-visiting-tag-hook '(push-mark) - "*Hooks run before speedbar visits a tag in the selected frame. + "Hooks run before speedbar visits a tag in the selected frame. The default buffer is the buffer in the selected window in the attached frame." :group 'speedbar :type 'hook) (defcustom speedbar-visiting-tag-hook '(speedbar-highlight-one-tag-line) - "*Hooks run when speedbar visits a tag in the selected frame." + "Hooks run when speedbar visits a tag in the selected frame." :group 'speedbar :type 'hook :options '(speedbar-highlight-one-tag-line @@ -303,17 +303,17 @@ )) (defcustom speedbar-load-hook nil - "*Hooks run when speedbar is loaded." + "Hooks run when speedbar is loaded." :group 'speedbar :type 'hook) (defcustom speedbar-reconfigure-keymaps-hook nil - "*Hooks run when the keymaps are regenerated." + "Hooks run when the keymaps are regenerated." :group 'speedbar :type 'hook) (defcustom speedbar-show-unknown-files nil - "*Non-nil show files we can't expand with a ? in the expand button. + "Non-nil show files we can't expand with a ? in the expand button. A nil value means don't show the file in the list." :group 'speedbar :type 'boolean) @@ -342,7 +342,7 @@ (unsplittable . t) (left-fringe . 0) ) - "*Parameters to use when creating the speedbar frame in Emacs. + "Parameters to use when creating the speedbar frame in Emacs. Any parameter supported by a frame may be added. The parameter `height' will be initialized to the height of the frame speedbar is attached to and added to this list before the new frame is initialized." @@ -359,7 +359,7 @@ menubar-visible-p nil default-gutter-visible-p nil ) - "*Parameters to use when creating the speedbar frame in XEmacs. + "Parameters to use when creating the speedbar frame in XEmacs. Parameters not listed here which will be added automatically are `height' which will be initialized to the height of the frame speedbar is attached to." @@ -369,7 +369,7 @@ (sexp :tag "Value")))) (defcustom speedbar-use-imenu-flag (fboundp 'imenu) - "*Non-nil means use imenu for file parsing, nil to use etags. + "Non-nil means use imenu for file parsing, nil to use etags. XEmacs prior to 20.4 doesn't support imenu, therefore the default is to use etags instead. Etags support is not as robust as imenu support." :tag "Use Imenu for tags" @@ -396,12 +396,12 @@ :type 'boolean) (defcustom speedbar-track-mouse-flag (not speedbar-use-tool-tips-flag) - "*Non-nil means to display info about the line under the mouse." + "Non-nil means to display info about the line under the mouse." :group 'speedbar :type 'boolean) (defcustom speedbar-default-position 'left-right - "*Default position of the speedbar frame. + "Default position of the speedbar frame. Possible values are 'left, 'right or 'left-right. If value is 'left-right, the most suitable location is determined automatically." @@ -411,7 +411,7 @@ (const :tag "Right" right))) (defcustom speedbar-sort-tags nil - "*If non-nil, sort tags in the speedbar display. *Obsolete*. + "If non-nil, sort tags in the speedbar display. *Obsolete*. Use `semantic-tag-hierarchy-method' instead." :group 'speedbar :type 'boolean) @@ -419,7 +419,7 @@ (defcustom speedbar-tag-hierarchy-method '(speedbar-prefix-group-tag-hierarchy speedbar-trim-words-tag-hierarchy) - "*List of hooks which speedbar will use to organize tags into groups. + "List of hooks which speedbar will use to organize tags into groups. Groups are defined as expandable meta-tags. Imenu supports such things in some languages, such as separating variables from functions. Each hook takes one argument LST, and may destructively @@ -439,7 +439,7 @@ ) (defcustom speedbar-tag-group-name-minimum-length 4 - "*The minimum length of a prefix group name before expanding. + "The minimum length of a prefix group name before expanding. Thus, if the `speedbar-tag-hierarchy-method' includes `prefix-group' and one such groups common characters is less than this number of characters, then the group name will be changed to the form of: @@ -451,14 +451,14 @@ :type 'integer) (defcustom speedbar-tag-split-minimum-length 20 - "*Minimum length before we stop trying to create sub-lists in tags. + "Minimum length before we stop trying to create sub-lists in tags. This is used by all tag-hierarchy methods that break large lists into sub-lists." :group 'speedbar :type 'integer) (defcustom speedbar-tag-regroup-maximum-length 10 - "*Maximum length of submenus that are regrouped. + "Maximum length of submenus that are regrouped. If the regrouping option is used, then if two or more short subgroups are next to each other, then they are combined until this number of items is reached." @@ -466,7 +466,7 @@ :type 'integer) (defcustom speedbar-directory-button-trim-method 'span - "*Indicates how the directory button will be displayed. + "Indicates how the directory button will be displayed. Possible values are: 'span - span large directories over multiple lines. 'trim - trim large directories to only show the last few. @@ -479,7 +479,7 @@ (const :tag "No trimming." nil))) (defcustom speedbar-smart-directory-expand-flag t - "*Non-nil means speedbar should use smart expansion. + "Non-nil means speedbar should use smart expansion. Smart expansion only affects when speedbar wants to display a directory for a file in the attached frame. When smart expansion is enabled, new directories which are children of a displayed directory @@ -489,42 +489,42 @@ :type 'boolean) (defcustom speedbar-indentation-width 1 - "*When sub-nodes are expanded, the number of spaces used for indentation." + "When sub-nodes are expanded, the number of spaces used for indentation." :group 'speedbar :type 'integer) (defcustom speedbar-hide-button-brackets-flag nil - "*Non-nil means speedbar will hide the brackets around the + or -." + "Non-nil means speedbar will hide the brackets around the + or -." :group 'speedbar :type 'boolean) (defcustom speedbar-before-popup-hook nil - "*Hooks called before popping up the speedbar frame." + "Hooks called before popping up the speedbar frame." :group 'speedbar :type 'hook) (defcustom speedbar-after-create-hook '(speedbar-frame-reposition-smartly) - "*Hooks called after popping up the speedbar frame." + "Hooks called after popping up the speedbar frame." :group 'speedbar :type 'hook) (defcustom speedbar-before-delete-hook nil - "*Hooks called before deleting the speedbar frame." + "Hooks called before deleting the speedbar frame." :group 'speedbar :type 'hook) (defcustom speedbar-mode-hook nil - "*Hooks called after creating a speedbar buffer." + "Hooks called after creating a speedbar buffer." :group 'speedbar :type 'hook) (defcustom speedbar-timer-hook nil - "*Hooks called after running the speedbar timer function." + "Hooks called after running the speedbar timer function." :group 'speedbar :type 'hook) (defcustom speedbar-verbosity-level 1 - "*Verbosity level of the speedbar. + "Verbosity level of the speedbar. 0 means say nothing. 1 means medium level verbosity. 2 and higher are higher levels of verbosity." @@ -535,7 +535,7 @@ "String separating file text from indicator characters.") (defcustom speedbar-vc-do-check t - "*Non-nil check all files in speedbar to see if they have been checked out. + "Non-nil check all files in speedbar to see if they have been checked out. Any file checked out is marked with `speedbar-vc-indicator'." :group 'speedbar-vc :type 'boolean) @@ -546,14 +546,14 @@ `speedbar-vc-directory-enable-hook' and `speedbar-vc-in-control-hook'.") (defcustom speedbar-vc-directory-enable-hook nil - "*Return non-nil if the current directory should be checked for Version Control. + "Return non-nil if the current directory should be checked for Version Control. Functions in this hook must accept one parameter which is the directory being checked." :group 'speedbar-vc :type 'hook) (defcustom speedbar-vc-in-control-hook nil - "*Return non-nil if the specified file is under Version Control. + "Return non-nil if the specified file is under Version Control. Functions in this hook must accept two parameters. The DIRECTORY of the current file, and the FILENAME of the file being checked." :group 'speedbar-vc @@ -563,7 +563,7 @@ "Local variable maintaining the current version control check position.") (defcustom speedbar-obj-do-check t - "*Non-nil check all files in speedbar to see if they have an object file. + "Non-nil check all files in speedbar to see if they have an object file. Any file checked out is marked with `speedbar-obj-indicator', and the marking is based on `speedbar-obj-alist'" :group 'speedbar-vc @@ -609,7 +609,7 @@ Permits stripping of indicator characters from a line.") (defcustom speedbar-scanner-reset-hook nil - "*Hook called whenever generic scanners are reset. + "Hook called whenever generic scanners are reset. Set this to implement your own scanning / rescan safe functions with state data." :group 'speedbar @@ -649,7 +649,7 @@ (defcustom speedbar-ignored-directory-expressions '("[/\\]logs?[/\\]\\'") - "*List of regular expressions matching directories speedbar will ignore. + "List of regular expressions matching directories speedbar will ignore. They should included directories which are notoriously very large and take a long time to load in. Use the function `speedbar-add-ignored-directory-regexp' to add new items to this list after @@ -663,7 +663,7 @@ (speedbar-extension-list-to-regex val)))) (defcustom speedbar-directory-unshown-regexp "^\\(\\..*\\)\\'" - "*Regular expression matching directories not to show in speedbar. + "Regular expression matching directories not to show in speedbar. They should include commonly existing directories which are not useful. It is no longer necessary to include version-control directories here; see `vc-directory-exclusion-list'." @@ -697,7 +697,7 @@ ;; is available. Also, html files are nice to be able to see. ".s?html" ".ma?k" "[Mm]akefile\\(\\.in\\)?"))) - "*List of regular expressions which will match files supported by tagging. + "List of regular expressions which will match files supported by tagging. Do not prefix the `.' char with a double \\ to quote it, as the period will be stripped by a simplified optimizer when compiled into a singular expression. This variable will be turned into @@ -3501,7 +3501,7 @@ ;;; Loading files into the attached frame. ;; (defcustom speedbar-select-frame-method 'attached - "*Specify how to select a frame for displaying a file. + "Specify how to select a frame for displaying a file. A value of 'attached means to use the attached frame (the frame that speedbar was started from.) A number such as 1 or -1 means to pass that number to `other-frame' while selecting a frame from speedbar."
--- a/lisp/strokes.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/strokes.el Wed Dec 03 05:48:14 2008 +0000 @@ -214,18 +214,18 @@ :group 'mouse) (defcustom strokes-modeline-string " Strokes" - "*Modeline identification when Strokes mode is on \(default is \" Strokes\"\)." + "Modeline identification when Strokes mode is on \(default is \" Strokes\"\)." :type 'string :group 'strokes) (defcustom strokes-character ?@ - "*Character used when drawing strokes in the strokes buffer. + "Character used when drawing strokes in the strokes buffer. \(The default is `@', which works well.\)" :type 'character :group 'strokes) (defcustom strokes-minimum-match-score 1000 - "*Minimum score for a stroke to be considered a possible match. + "Minimum score for a stroke to be considered a possible match. Setting this variable to 0 would require a perfectly precise match. The default value is 1000, but it's mostly dependent on how precisely you manage to replicate your user-defined strokes. It also depends on @@ -242,7 +242,7 @@ :group 'strokes) (defcustom strokes-grid-resolution 9 - "*Integer defining dimensions of the stroke grid. + "Integer defining dimensions of the stroke grid. The grid is a square grid, where `strokes-grid-resolution' defaults to `9', making a 9x9 grid whose coordinates go from (0 . 0) on the top left to ((strokes-grid-resolution - 1) . (strokes-grid-resolution - 1)) @@ -259,7 +259,7 @@ :group 'strokes) (defcustom strokes-file (convert-standard-filename "~/.strokes") - "*File containing saved strokes for Strokes mode (default is ~/.strokes)." + "File containing saved strokes for Strokes mode (default is ~/.strokes)." :type 'file :group 'strokes) @@ -267,7 +267,7 @@ "The name of the buffer that the strokes take place in.") (defcustom strokes-use-strokes-buffer t - "*If non-nil, the strokes buffer is used and strokes are displayed. + "If non-nil, the strokes buffer is used and strokes are displayed. If nil, strokes will be read the same, however the user will not be able to see the strokes. This be helpful for people who don't like the delay in switching to the strokes buffer."
--- a/lisp/tempo.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/tempo.el Wed Dec 03 05:48:14 2008 +0000 @@ -114,14 +114,14 @@ :group 'tools) (defcustom tempo-interactive nil - "*Prompt user for strings in templates. + "Prompt user for strings in templates. If this variable is non-nil, `tempo-insert' prompts the user for text to insert in the templates." :type 'boolean :group 'tempo) (defcustom tempo-insert-region nil - "*Automatically insert current region when there is a `r' in the template + "Automatically insert current region when there is a `r' in the template If this variable is nil, `r' elements will be treated just like `p' elements, unless the template function is given a prefix (or a non-nil argument). If this variable is non-nil, the behavior is reversed. @@ -131,13 +131,13 @@ :group 'tempo) (defcustom tempo-show-completion-buffer t - "*If non-nil, show a buffer with possible completions, when only + "If non-nil, show a buffer with possible completions, when only a partial completion can be found." :type 'boolean :group 'tempo) (defcustom tempo-leave-completion-buffer nil - "*If nil, a completion buffer generated by \\[tempo-complete-tag] + "If nil, a completion buffer generated by \\[tempo-complete-tag] disappears at the next keypress; otherwise, it remains forever." :type 'boolean :group 'tempo)
--- a/lisp/term.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/term.el Wed Dec 03 05:48:14 2008 +0000 @@ -478,7 +478,7 @@ (defvar term-pager-old-filter) ;; Saved process-filter while paging. (defcustom explicit-shell-file-name nil - "*If non-nil, is file name to use for explicitly requested inferior shell." + "If non-nil, is file name to use for explicitly requested inferior shell." :type '(choice (const nil) file) :group 'term) @@ -508,7 +508,7 @@ This is a good thing to set in mode hooks.") (defcustom term-input-autoexpand nil - "*If non-nil, expand input command history references on completion. + "If non-nil, expand input command history references on completion. This mirrors the optional behavior of tcsh (its autoexpand and histlit). If the value is `input', then the expansion is seen on input. @@ -521,7 +521,7 @@ :group 'term) (defcustom term-input-ignoredups nil - "*If non-nil, don't add input matching the last on the input ring. + "If non-nil, don't add input matching the last on the input ring. This mirrors the optional behavior of bash. This variable is buffer-local." @@ -529,7 +529,7 @@ :group 'term) (defcustom term-input-ring-file-name nil - "*If non-nil, name of the file to read/write input history. + "If non-nil, name of the file to read/write input history. See also `term-read-input-ring' and `term-write-input-ring'. This variable is buffer-local, and is a good thing to set in mode hooks." @@ -537,7 +537,7 @@ :group 'term) (defcustom term-scroll-to-bottom-on-output nil - "*Controls whether interpreter output causes window to scroll. + "Controls whether interpreter output causes window to scroll. If nil, then do not scroll. If t or `all', scroll all windows showing buffer. If `this', scroll only the selected window. If `others', scroll only those that are not the selected window. @@ -550,7 +550,7 @@ :group 'term) (defcustom term-scroll-show-maximum-output nil - "*Controls how interpreter output causes window to scroll. + "Controls how interpreter output causes window to scroll. If non-nil, then show the maximum output when the window is scrolled. See variable `term-scroll-to-bottom-on-output'. @@ -599,7 +599,7 @@ the string plus a newline.") (defcustom term-eol-on-send t - "*Non-nil means go to the end of the line before sending input. + "Non-nil means go to the end of the line before sending input. See `term-send-input'." :type 'boolean :group 'term) @@ -619,7 +619,7 @@ :type 'hook :group 'term) -(defvar term-mode-map +(defvar term-mode-map (let ((map (make-sparse-keymap))) (define-key map "\ep" 'term-previous-input) (define-key map "\en" 'term-next-input)
--- a/lisp/terminal.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/terminal.el Wed Dec 03 05:48:14 2008 +0000 @@ -50,7 +50,7 @@ (defcustom terminal-escape-char ?\C-^ - "*All characters except for this are passed verbatim through the + "All characters except for this are passed verbatim through the terminal-emulator. This character acts as a prefix for commands to the emulator program itself. Type this character twice to send it through the emulator. Type ? after typing it for a list of @@ -60,7 +60,7 @@ :group 'terminal) (defcustom terminal-scrolling t ;;>> Setting this to t sort-of defeats my whole aim in writing this package... - "*If non-nil, the terminal-emulator will losingly `scroll' when output occurs + "If non-nil, the terminal-emulator will losingly `scroll' when output occurs past the bottom of the screen. If nil, output will win and `wrap' to the top of the screen. This variable is local to each terminal-emulator buffer." @@ -68,7 +68,7 @@ :group 'terminal) (defcustom terminal-more-processing t - "*If non-nil, do more-processing. + "If non-nil, do more-processing. This variable is local to each terminal-emulator buffer." :type 'boolean :group 'terminal) @@ -77,7 +77,7 @@ ;; and expects to actually see anything, you should probably set this to ;; around 400 (defcustom terminal-redisplay-interval 5000 - "*Maximum number of characters which will be processed by the + "Maximum number of characters which will be processed by the terminal-emulator before a screen redisplay is forced. Set this to a large value for greater throughput, set it smaller for more frequent updates but overall slower @@ -1062,7 +1062,7 @@ ;; and it's apparently not needed in BSD. (defcustom explicit-shell-file-name nil - "*If non-nil, is file name to use for explicitly requested inferior shell." + "If non-nil, is file name to use for explicitly requested inferior shell." :type '(choice (const :tag "None" nil) file) :group 'terminal)
--- a/lisp/time-stamp.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/time-stamp.el Wed Dec 03 05:48:14 2008 +0000 @@ -44,7 +44,7 @@ :group 'extensions) (defcustom time-stamp-format "%:y-%02m-%02d %02H:%02M:%02S %u" - "*Format of the string inserted by \\[time-stamp]. + "Format of the string inserted by \\[time-stamp]. The value may be a string or a list. Lists are supported only for backward compatibility; see variable `time-stamp-old-format-warn'. @@ -94,7 +94,7 @@ ;;;###autoload(put 'time-stamp-format 'safe-local-variable 'stringp) (defcustom time-stamp-active t - "*Non-nil to enable time-stamping of buffers by \\[time-stamp]. + "Non-nil to enable time-stamping of buffers by \\[time-stamp]. Can be toggled by \\[time-stamp-toggle-active]. See also the variable `time-stamp-warn-inactive'." :type 'boolean @@ -267,7 +267,7 @@ The format of the time stamp is set by the variable `time-stamp-pattern' or `time-stamp-format'. The variables `time-stamp-pattern', `time-stamp-line-limit', `time-stamp-start', `time-stamp-end', -`time-stamp-count', and `time-stamp-inserts-lines' control finding +`time-stamp-count', and `time-stamp-inserts-lines' control finding the template." (interactive) (let ((line-limit time-stamp-line-limit)
--- a/lisp/time.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/time.el Wed Dec 03 05:48:14 2008 +0000 @@ -37,7 +37,7 @@ (defcustom display-time-mail-file nil - "*File name of mail inbox file, for indicating existence of new mail. + "File name of mail inbox file, for indicating existence of new mail. Non-nil and not a string means don't check for mail; nil means use default, which is system-dependent, and is the same as used by Rmail." :type '(choice (const :tag "None" none) @@ -46,7 +46,7 @@ :group 'display-time) (defcustom display-time-mail-directory nil - "*Name of mail inbox directory, for indicating existence of new mail. + "Name of mail inbox directory, for indicating existence of new mail. Any nonempty regular file in the directory is regarded as newly arrived mail. If nil, do not check a directory for arriving mail." :type '(choice (const :tag "None" nil) @@ -54,7 +54,7 @@ :group 'display-time) (defcustom display-time-mail-function nil - "*Function to call, for indicating existence of new mail. + "Function to call, for indicating existence of new mail. If nil, that means use the default method: check that the file specified by `display-time-mail-file' is nonempty or that the directory `display-time-mail-directory' contains nonempty files." @@ -63,7 +63,7 @@ :group 'display-time) (defcustom display-time-default-load-average 0 - "*Which load average value will be shown in the mode line. + "Which load average value will be shown in the mode line. Almost every system can provide values of load for past 1 minute, past 5 or past 15 minutes. The default is to display 1 minute load average." :type '(choice (const :tag "1 minute load" 0) @@ -76,7 +76,7 @@ "Load average currently being shown in mode line.") (defcustom display-time-load-average-threshold 0.1 - "*Load-average values below this value won't be shown in the mode line." + "Load-average values below this value won't be shown in the mode line." :type 'number :group 'display-time) @@ -89,12 +89,12 @@ (defvar display-time-timer nil) (defcustom display-time-interval 60 - "*Seconds between updates of time in the mode line." + "Seconds between updates of time in the mode line." :type 'integer :group 'display-time) (defcustom display-time-24hr-format nil - "*Non-nil indicates time should be displayed as hh:mm, 0 <= hh <= 23. + "Non-nil indicates time should be displayed as hh:mm, 0 <= hh <= 23. A value of nil means 1 <= hh <= 12, and an AM/PM suffix is used." :type 'boolean :group 'display-time) @@ -102,7 +102,7 @@ (defvar display-time-string nil) (defcustom display-time-hook nil - "*List of functions to be called when the time is updated on the mode line." + "List of functions to be called when the time is updated on the mode line." :type 'hook :group 'display-time) @@ -251,7 +251,7 @@ string)) (defcustom display-time-format nil - "*String specifying format for displaying the time in the mode line. + "String specifying format for displaying the time in the mode line. See the function `format-time-string' for an explanation of how to write this string. If this is nil, the defaults depend on `display-time-day-and-date' and `display-time-24hr-format'." @@ -294,7 +294,7 @@ 'local-map (make-mode-line-mouse-map 'mouse-2 read-mail-command))) "")) - "*List of expressions governing display of the time in the mode line. + "List of expressions governing display of the time in the mode line. For most purposes, you can control the time format using `display-time-format' which is a more standard interface.
--- a/lisp/tree-widget.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/tree-widget.el Wed Dec 03 05:48:14 2008 +0000 @@ -149,7 +149,7 @@ XEmacs.") (defcustom tree-widget-themes-directory "tree-widget" - "*Name of the directory in which to look for an image theme. + "Name of the directory in which to look for an image theme. When nil use the directory where the tree-widget library is located. When it is a relative name, search in all occurrences of that sub directory in the path specified by `tree-widget-themes-load-path'. @@ -160,7 +160,7 @@ :group 'tree-widget) (defcustom tree-widget-theme nil - "*Name of the theme in which to look for images. + "Name of the theme in which to look for images. This is a sub directory of the themes directory specified by the `tree-widget-themes-directory' option. The default theme is \"default\". When an image is not found in a @@ -197,13 +197,13 @@ (defcustom tree-widget-image-properties-emacs '(:ascent center :mask (heuristic t)) - "*Default properties of Emacs images." + "Default properties of Emacs images." :type 'plist :group 'tree-widget) (defcustom tree-widget-image-properties-xemacs nil - "*Default properties of XEmacs images." + "Default properties of XEmacs images." :type 'plist :group 'tree-widget)
--- a/lisp/type-break.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/type-break.el Wed Dec 03 05:48:14 2008 +0000 @@ -86,13 +86,13 @@ ;;;###autoload (defcustom type-break-interval (* 60 60) - "*Number of seconds between scheduled typing breaks." + "Number of seconds between scheduled typing breaks." :type 'integer :group 'type-break) ;;;###autoload (defcustom type-break-good-rest-interval (/ type-break-interval 6) - "*Number of seconds of idle time considered to be an adequate typing rest. + "Number of seconds of idle time considered to be an adequate typing rest. When this variable is non-nil, Emacs checks the idle time between keystrokes. If this idle time is long enough to be considered a \"good\" @@ -105,7 +105,7 @@ ;;;###autoload (defcustom type-break-good-break-interval nil - "*Number of seconds considered to be an adequate explicit typing rest. + "Number of seconds considered to be an adequate explicit typing rest. When this variable is non-nil, its value is considered to be a \"good\" length (in seconds) for a break initiated by the command `type-break', @@ -129,7 +129,7 @@ (upper (* wpm avg-word-length (/ type-break-interval 60))) (lower (/ upper 5))) (cons lower upper)) - "*Upper and lower bound on number of keystrokes for considering typing break. + "Upper and lower bound on number of keystrokes for considering typing break. This structure is a pair of numbers (MIN . MAX). The first number is the minimum number of keystrokes that must have been @@ -153,14 +153,14 @@ :group 'type-break) (defcustom type-break-query-mode t - "*Non-nil means ask whether or not to prompt user for breaks. + "Non-nil means ask whether or not to prompt user for breaks. If so, call the function specified in the value of the variable `type-break-query-function' to do the asking." :type 'boolean :group 'type-break) (defcustom type-break-query-function 'yes-or-no-p - "*Function to use for making query for a typing break. + "Function to use for making query for a typing break. It should take a string as an argument, the prompt. Usually this should be set to `yes-or-no-p' or `y-or-n-p'. @@ -171,21 +171,21 @@ :group 'type-break) (defcustom type-break-query-interval 60 - "*Number of seconds between queries to take a break, if put off. + "Number of seconds between queries to take a break, if put off. The user will continue to be prompted at this interval until he or she finally submits to taking a typing break." :type 'integer :group 'type-break) (defcustom type-break-time-warning-intervals '(300 120 60 30) - "*List of time intervals for warnings about upcoming typing break. + "List of time intervals for warnings about upcoming typing break. At each of the intervals (specified in seconds) away from a scheduled typing break, print a warning in the echo area." :type '(repeat integer) :group 'type-break) (defcustom type-break-keystroke-warning-intervals '(300 200 100 50) - "*List of keystroke measurements for warnings about upcoming typing break. + "List of keystroke measurements for warnings about upcoming typing break. At each of the intervals (specified in keystrokes) away from the upper keystroke threshold, print a warning in the echo area. If either this variable or the upper threshold is set, then no warnings @@ -194,21 +194,21 @@ :group 'type-break) (defcustom type-break-warning-repeat 40 - "*Number of keystrokes for which warnings should be repeated. + "Number of keystrokes for which warnings should be repeated. That is, for each of this many keystrokes the warning is redisplayed in the echo area to make sure it's really seen." :type 'integer :group 'type-break) (defcustom type-break-time-stamp-format "[%H:%M] " - "*Timestamp format used to prefix messages. + "Timestamp format used to prefix messages. Format specifiers are as used by `format-time-string'." :type 'string :group 'type-break) (defcustom type-break-demo-functions '(type-break-demo-boring type-break-demo-life type-break-demo-hanoi) - "*List of functions to consider running as demos during typing breaks. + "List of functions to consider running as demos during typing breaks. When a typing break begins, one of these functions is selected randomly to have Emacs do something interesting. @@ -218,17 +218,17 @@ :group 'type-break) (defcustom type-break-demo-boring-stats nil - "*Show word per minute and keystroke figures in the Boring demo." + "Show word per minute and keystroke figures in the Boring demo." :type 'boolean :group 'type-break) (defcustom type-break-terse-messages nil - "*Use slightly terser messages." + "Use slightly terser messages." :type 'boolean :group 'type-break) (defcustom type-break-file-name (convert-standard-filename "~/.type-break") - "*Name of file used to save state across sessions. + "Name of file used to save state across sessions. If this is nil, no data will be saved across sessions." :type 'file :group 'type-break) @@ -246,7 +246,7 @@ ;; Mode line frobs (defcustom type-break-mode-line-message-mode nil - "*Non-nil means put type-break related messages in the mode line. + "Non-nil means put type-break related messages in the mode line. Otherwise, messages typically go in the echo area. See also `type-break-mode-line-format' and its members."
--- a/lisp/vc-cvs.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/vc-cvs.el Wed Dec 03 05:48:14 2008 +0000 @@ -60,7 +60,7 @@ ;;; (defcustom vc-cvs-global-switches nil - "*Global switches to pass to any CVS command." + "Global switches to pass to any CVS command." :type '(choice (const :tag "None" nil) (string :tag "Argument String") (repeat :tag "Argument List" @@ -70,7 +70,7 @@ :group 'vc) (defcustom vc-cvs-register-switches nil - "*Extra switches for registering a file into CVS. + "Extra switches for registering a file into CVS. A string or list of strings passed to the checkin program by \\[vc-register]." :type '(choice (const :tag "None" nil) @@ -82,7 +82,7 @@ :group 'vc) (defcustom vc-cvs-diff-switches nil - "*A string or list of strings specifying extra switches for cvs diff under VC." + "A string or list of strings specifying extra switches for cvs diff under VC." :type '(choice (const :tag "None" nil) (string :tag "Argument String") (repeat :tag "Argument List" @@ -92,13 +92,13 @@ :group 'vc) (defcustom vc-cvs-header (or (cdr (assoc 'CVS vc-header-alist)) '("\$Id\$")) - "*Header keywords to be inserted by `vc-insert-headers'." + "Header keywords to be inserted by `vc-insert-headers'." :version "21.1" :type '(repeat string) :group 'vc) (defcustom vc-cvs-use-edit t - "*Non-nil means to use `cvs edit' to \"check out\" a file. + "Non-nil means to use `cvs edit' to \"check out\" a file. This is only meaningful if you don't use the implicit checkout model \(i.e. if you have $CVSREAD set)." :type 'boolean @@ -106,7 +106,7 @@ :group 'vc) (defcustom vc-cvs-stay-local 'only-file - "*Non-nil means use local operations when possible for remote repositories. + "Non-nil means use local operations when possible for remote repositories. This avoids slow queries over the network and instead uses heuristics and past information to determine the current status of a file. @@ -131,7 +131,7 @@ :group 'vc) (defcustom vc-cvs-sticky-date-format-string "%c" - "*Format string for mode-line display of sticky date. + "Format string for mode-line display of sticky date. Format is according to `format-time-string'. Only used if `vc-cvs-sticky-tag-display' is t." :type '(string) @@ -139,7 +139,7 @@ :group 'vc) (defcustom vc-cvs-sticky-tag-display t - "*Specify the mode-line display of sticky tags. + "Specify the mode-line display of sticky tags. Value t means default display, nil means no display at all. If the value is a function or macro, it is called with the sticky tag and its' type as parameters, in that order. TYPE can have three different
--- a/lisp/vc-hg.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/vc-hg.el Wed Dec 03 05:48:14 2008 +0000 @@ -117,7 +117,7 @@ ;;; Customization options (defcustom vc-hg-global-switches nil - "*Global switches to pass to any Hg command." + "Global switches to pass to any Hg command." :type '(choice (const :tag "None" nil) (string :tag "Argument String") (repeat :tag "Argument List"
--- a/lisp/vc-mcvs.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/vc-mcvs.el Wed Dec 03 05:48:14 2008 +0000 @@ -61,7 +61,7 @@ ;;; (defcustom vc-mcvs-global-switches nil - "*Global switches to pass to any Meta-CVS command." + "Global switches to pass to any Meta-CVS command." :type '(choice (const :tag "None" nil) (string :tag "Argument String") (repeat :tag "Argument List" @@ -71,7 +71,7 @@ :group 'vc) (defcustom vc-mcvs-register-switches nil - "*Extra switches for registering a file into Meta-CVS. + "Extra switches for registering a file into Meta-CVS. A string or list of strings passed to the checkin program by \\[vc-register]." :type '(choice (const :tag "None" nil) @@ -83,7 +83,7 @@ :group 'vc) (defcustom vc-mcvs-diff-switches nil - "*A string or list of strings specifying extra switches for cvs diff under VC." + "A string or list of strings specifying extra switches for cvs diff under VC." :type '(choice (const :tag "None" nil) (string :tag "Argument String") (repeat :tag "Argument List" @@ -94,13 +94,13 @@ (defcustom vc-mcvs-header (or (cdr (assoc 'MCVS vc-header-alist)) vc-cvs-header) - "*Header keywords to be inserted by `vc-insert-headers'." + "Header keywords to be inserted by `vc-insert-headers'." :version "22.1" :type '(repeat string) :group 'vc) (defcustom vc-mcvs-use-edit vc-cvs-use-edit - "*Non-nil means to use `cvs edit' to \"check out\" a file. + "Non-nil means to use `cvs edit' to \"check out\" a file. This is only meaningful if you don't use the implicit checkout model \(i.e. if you have $CVSREAD set)." :type 'boolean @@ -410,7 +410,7 @@ (message "Merging changes into %s...done" file)))) (defun vc-mcvs-modify-change-comment (files rev comment) - "Modify the change comments for FILES on a specified REV. + "Modify the change comments for FILES on a specified REV. Will fail unless you have administrative privileges on the repo." (vc-mcvs-command nil 0 files "rcs" (concat "-m" comment ":" rev)))
--- a/lisp/vc-rcs.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/vc-rcs.el Wed Dec 03 05:48:14 2008 +0000 @@ -38,7 +38,7 @@ (require 'vc)) (defcustom vc-rcs-release nil - "*The release number of your RCS installation, as a string. + "The release number of your RCS installation, as a string. If nil, VC itself computes this value when it is first needed." :type '(choice (const :tag "Auto" nil) (string :tag "Specified") @@ -46,7 +46,7 @@ :group 'vc) (defcustom vc-rcs-register-switches nil - "*Extra switches for registering a file in RCS. + "Extra switches for registering a file in RCS. A string or list of strings. These are passed to the checkin program by \\[vc-rcs-register]." :type '(choice (const :tag "None" nil) @@ -58,7 +58,7 @@ :group 'vc) (defcustom vc-rcs-diff-switches nil - "*A string or list of strings specifying extra switches for rcsdiff under VC." + "A string or list of strings specifying extra switches for rcsdiff under VC." :type '(choice (const :tag "None" nil) (string :tag "Argument String") (repeat :tag "Argument List" @@ -68,13 +68,13 @@ :group 'vc) (defcustom vc-rcs-header (or (cdr (assoc 'RCS vc-header-alist)) '("\$Id\$")) - "*Header keywords to be inserted by `vc-insert-headers'." + "Header keywords to be inserted by `vc-insert-headers'." :type '(repeat string) :version "21.1" :group 'vc) (defcustom vc-rcsdiff-knows-brief nil - "*Indicates whether rcsdiff understands the --brief option. + "Indicates whether rcsdiff understands the --brief option. The value is either `yes', `no', or nil. If it is nil, VC tries to use --brief and sets this variable to remember whether it worked." :type '(choice (const :tag "Work out" nil) (const yes) (const no)) @@ -83,7 +83,7 @@ ;;;###autoload (defcustom vc-rcs-master-templates '("%sRCS/%s,v" "%s%s,v" "%sRCS/%s") - "*Where to look for RCS master files. + "Where to look for RCS master files. For a description of possible values, see `vc-check-master-templates'." :type '(choice (const :tag "Use standard RCS file names" '("%sRCS/%s,v" "%s%s,v" "%sRCS/%s"))
--- a/lisp/vc-sccs.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/vc-sccs.el Wed Dec 03 05:48:14 2008 +0000 @@ -57,7 +57,7 @@ :group 'vc) (defcustom vc-sccs-diff-switches nil - "*A string or list of strings specifying extra switches for `vcdiff', + "A string or list of strings specifying extra switches for `vcdiff', the diff utility used for SCCS under VC." :type '(choice (const :tag "None" nil) (string :tag "Argument String") @@ -68,14 +68,14 @@ :group 'vc) (defcustom vc-sccs-header (or (cdr (assoc 'SCCS vc-header-alist)) '("%W%")) - "*Header keywords to be inserted by `vc-insert-headers'." + "Header keywords to be inserted by `vc-insert-headers'." :type '(repeat string) :group 'vc) ;;;###autoload (defcustom vc-sccs-master-templates '("%sSCCS/s.%s" "%ss.%s" vc-sccs-search-project-dir) - "*Where to look for SCCS master files. + "Where to look for SCCS master files. For a description of possible values, see `vc-check-master-templates'." :type '(choice (const :tag "Use standard SCCS file names" ("%sSCCS/s.%s" "%ss.%s" vc-sccs-search-project-dir))
--- a/lisp/vc.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/vc.el Wed Dec 03 05:48:14 2008 +0000 @@ -711,7 +711,7 @@ :version "21.1") (defcustom vc-diff-knows-L nil - "*Indicates whether diff understands the -L option. + "Indicates whether diff understands the -L option. The value is either `yes', `no', or nil. If it is nil, VC tries to use -L and sets this variable to remember whether it worked." :type '(choice (const :tag "Work out" nil) (const yes) (const no)) @@ -754,7 +754,7 @@ (defcustom vc-static-header-alist '(("\\.c\\'" . "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n")) - "*Associate static header string templates with file types. + "Associate static header string templates with file types. A \%s in the template is replaced with the first string associated with the file's version control type in `vc-header-alist'." :type '(repeat (cons :format "%v" @@ -764,7 +764,7 @@ (defcustom vc-comment-alist '((nroff-mode ".\\\"" "")) - "*Special comment delimiters for generating VC headers. + "Special comment delimiters for generating VC headers. Add an entry in this list if you need to override the normal `comment-start' and `comment-end' variables. This will only be necessary if the mode language is sensitive to blank lines." @@ -775,7 +775,7 @@ :group 'vc) (defcustom vc-checkout-carefully (= (user-uid) 0) - "*Non-nil means be extra-careful in checkout. + "Non-nil means be extra-careful in checkout. Verify that the file really is not locked and that its contents match what the master file says." :type 'boolean @@ -1402,12 +1402,12 @@ BACKEND is a symbol such as `CVS', which will be downcased. OP is a symbol such as `diff'. -In decreasing order of preference, returns the value of: +In decreasing order of preference, return the value of: vc-BACKEND-OP-switches (e.g. `vc-cvs-diff-switches'); vc-OP-switches (e.g. `vc-diff-switches'); or, in the case of diff only, `diff-switches'. -If the chosen value is not a string or a list, returns nil. +If the chosen value is not a string or a list, return nil. This is so that you may set, e.g. `vc-svn-diff-switches' to t in order to override the value of `vc-diff-switches' and `diff-switches'." (let ((switches
--- a/lisp/view.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/view.el Wed Dec 03 05:48:14 2008 +0000 @@ -52,7 +52,7 @@ :group 'editing) (defcustom view-highlight-face 'highlight - "*The face used for highlighting the match found by View mode search." + "The face used for highlighting the match found by View mode search." :type 'face :group 'view) @@ -61,14 +61,14 @@ ;; doesn't say if leaving view mode should restore windows or not. The latter ;; is now controlled by the presence of a value in `view-return-to-alist'. (defcustom view-scroll-auto-exit nil - "*Non-nil means scrolling past the end of buffer exits View mode. + "Non-nil means scrolling past the end of buffer exits View mode. A value of nil means attempting to scroll past the end of the buffer, only rings the bell and gives a message on how to leave." :type 'boolean :group 'view) (defcustom view-try-extend-at-buffer-end nil - "*Non-nil means try to load more of file when reaching end of buffer. + "Non-nil means try to load more of file when reaching end of buffer. This variable is mainly intended to be temporarily set to non-nil by the F command in view-mode, but you can set it to t if you want the action for all scroll commands in view mode." @@ -77,7 +77,7 @@ ;;;###autoload (defcustom view-remove-frame-by-deleting t - "*Determine how View mode removes a frame no longer needed. + "Determine how View mode removes a frame no longer needed. If nil, make an icon of the frame. If non-nil, delete the frame." :type 'boolean :group 'view @@ -86,7 +86,7 @@ :version "23.1") (defcustom view-exits-all-viewing-windows nil - "*Non-nil means restore all windows used to view buffer. + "Non-nil means restore all windows used to view buffer. Commands that restore windows when finished viewing a buffer, apply to all windows that display the buffer and have restore information in `view-return-to-alist'. @@ -96,7 +96,7 @@ :group 'view) (defcustom view-inhibit-help-message nil - "*Non-nil inhibits the help message shown upon entering View mode." + "Non-nil inhibits the help message shown upon entering View mode." :type 'boolean :group 'view :version "22.1")
--- a/lisp/w32-vars.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/w32-vars.el Wed Dec 03 05:48:14 2008 +0000 @@ -33,26 +33,26 @@ ;; Redefine the font selection to use the standard W32 dialog (defcustom w32-use-w32-font-dialog t - "*Use the standard font dialog. + "Use the standard font dialog. If nil, pop up a menu of a fixed set of fonts including fontsets, like X does. See `w32-fixed-font-alist' for the font menu definition." :type 'boolean :group 'w32) (defcustom w32-list-proportional-fonts nil - "*Include proportional fonts in the default font dialog." + "Include proportional fonts in the default font dialog." :type 'boolean :group 'w32) (defcustom w32-allow-system-shell nil - "*Disable startup warning when using \"system\" shells." + "Disable startup warning when using \"system\" shells." :type 'boolean :group 'w32) (defcustom w32-system-shells '("cmd" "cmd.exe" "command" "command.com" "4nt" "4nt.exe" "4dos" "4dos.exe" "tcc" "tcc.exe" "ndos" "ndos.exe") - "*List of strings recognized as Windows NT/9X system shells." + "List of strings recognized as Windows NT/9X system shells." :type '(repeat string) :group 'w32) @@ -130,7 +130,7 @@ ("11 bold italic" "-*-Courier New-bold-i-*-*-15-*-*-*-c-*-iso8859-1") ("12 bold italic" "-*-Courier New-bold-i-*-*-16-*-*-*-c-*-iso8859-1") )) - "*Fonts suitable for use in Emacs. + "Fonts suitable for use in Emacs. Initially this is a list of some fixed width fonts that most people will have like Terminal and Courier. These fonts are used in the font menu if the variable `w32-use-w32-font-dialog' is nil." @@ -148,7 +148,7 @@ :group 'w32) (defcustom x-select-enable-clipboard t - "*Non-nil means cutting and pasting uses the clipboard. + "Non-nil means cutting and pasting uses the clipboard. This is in addition to the primary selection." :type 'boolean :group 'killing)
--- a/lisp/whitespace.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/whitespace.el Wed Dec 03 05:48:14 2008 +0000 @@ -381,7 +381,7 @@ '(tabs spaces trailing lines space-before-tab newline indentation empty space-after-tab space-mark tab-mark newline-mark) - "*Specify which kind of blank is visualized. + "Specify which kind of blank is visualized. It's a list containing some or all of the following values: @@ -508,7 +508,7 @@ (defcustom whitespace-space 'whitespace-space - "*Symbol face used to visualize SPACE. + "Symbol face used to visualize SPACE. Used when `whitespace-style' includes the value `spaces'." :type 'face @@ -526,7 +526,7 @@ (defcustom whitespace-hspace 'whitespace-hspace - "*Symbol face used to visualize HARD SPACE. + "Symbol face used to visualize HARD SPACE. Used when `whitespace-style' includes the value `spaces'." :type 'face @@ -544,7 +544,7 @@ (defcustom whitespace-tab 'whitespace-tab - "*Symbol face used to visualize TAB. + "Symbol face used to visualize TAB. Used when `whitespace-style' includes the value `tabs'." :type 'face @@ -562,7 +562,7 @@ (defcustom whitespace-newline 'whitespace-newline - "*Symbol face used to visualize NEWLINE char mapping. + "Symbol face used to visualize NEWLINE char mapping. See `whitespace-display-mappings'. @@ -585,7 +585,7 @@ (defcustom whitespace-trailing 'whitespace-trailing - "*Symbol face used to visualize trailing blanks. + "Symbol face used to visualize trailing blanks. Used when `whitespace-style' includes the value `trailing'." :type 'face @@ -600,7 +600,7 @@ (defcustom whitespace-line 'whitespace-line - "*Symbol face used to visualize \"long\" lines. + "Symbol face used to visualize \"long\" lines. See `whitespace-line-column'. @@ -619,7 +619,7 @@ (defcustom whitespace-space-before-tab 'whitespace-space-before-tab - "*Symbol face used to visualize SPACEs before TAB. + "Symbol face used to visualize SPACEs before TAB. Used when `whitespace-style' includes the value `space-before-tab'." :type 'face @@ -634,7 +634,7 @@ (defcustom whitespace-indentation 'whitespace-indentation - "*Symbol face used to visualize 8 or more SPACEs at beginning of line. + "Symbol face used to visualize 8 or more SPACEs at beginning of line. Used when `whitespace-style' includes the value `indentation'." :type 'face @@ -649,7 +649,7 @@ (defcustom whitespace-empty 'whitespace-empty - "*Symbol face used to visualize empty lines at beginning and/or end of buffer. + "Symbol face used to visualize empty lines at beginning and/or end of buffer. Used when `whitespace-style' includes the value `empty'." :type 'face @@ -664,7 +664,7 @@ (defcustom whitespace-space-after-tab 'whitespace-space-after-tab - "*Symbol face used to visualize 8 or more SPACEs after TAB. + "Symbol face used to visualize 8 or more SPACEs after TAB. Used when `whitespace-style' includes the value `space-after-tab'." :type 'face @@ -680,7 +680,7 @@ (defcustom whitespace-hspace-regexp "\\(\\(\xA0\\|\x8A0\\|\x920\\|\xE20\\|\xF20\\)+\\)" - "*Specify HARD SPACE characters regexp. + "Specify HARD SPACE characters regexp. If you're using `mule' package, there may be other characters besides: @@ -708,7 +708,7 @@ (defcustom whitespace-space-regexp "\\( +\\)" - "*Specify SPACE characters regexp. + "Specify SPACE characters regexp. If you're using `mule' package, there may be other characters besides \" \" that should be considered SPACE. @@ -730,7 +730,7 @@ (defcustom whitespace-tab-regexp "\\(\t+\\)" - "*Specify TAB characters regexp. + "Specify TAB characters regexp. If you're using `mule' package, there may be other characters besides \"\\t\" that should be considered TAB. @@ -753,7 +753,7 @@ (defcustom whitespace-trailing-regexp "\\(\\(\t\\| \\|\xA0\\|\x8A0\\|\x920\\|\xE20\\|\xF20\\)+\\)$" - "*Specify trailing characters regexp. + "Specify trailing characters regexp. If you're using `mule' package, there may be other characters besides: @@ -771,7 +771,7 @@ (defcustom whitespace-space-before-tab-regexp "\\( +\\)\\(\t+\\)" - "*Specify SPACEs before TAB regexp. + "Specify SPACEs before TAB regexp. If you're using `mule' package, there may be other characters besides: @@ -789,7 +789,7 @@ (defcustom whitespace-indentation-regexp '("^\t*\\(\\( \\{%d\\}\\)+\\)[^\n\t]" . "^ *\\(\t+\\)[^\n]") - "*Specify regexp for 8 or more SPACEs at beginning of line. + "Specify regexp for 8 or more SPACEs at beginning of line. It is a cons where the cons car is used for SPACEs visualization and the cons cdr is used for TABs visualization. @@ -809,7 +809,7 @@ (defcustom whitespace-empty-at-bob-regexp "\\`\\(\\([ \t]*\n\\)+\\)" - "*Specify regexp for empty lines at beginning of buffer. + "Specify regexp for empty lines at beginning of buffer. If you're using `mule' package, there may be other characters besides: @@ -824,7 +824,7 @@ (defcustom whitespace-empty-at-eob-regexp "^\\([ \t\n]+\\)\\'" - "*Specify regexp for empty lines at end of buffer. + "Specify regexp for empty lines at end of buffer. If you're using `mule' package, there may be other characters besides: @@ -841,7 +841,7 @@ (defcustom whitespace-space-after-tab-regexp '("\t+\\(\\( \\{%d\\}\\)+\\)" . "\\(\t+\\) +") - "*Specify regexp for 8 or more SPACEs after TAB. + "Specify regexp for 8 or more SPACEs after TAB. It is a cons where the cons car is used for SPACEs visualization and the cons cdr is used for TABs visualization. @@ -860,7 +860,7 @@ (defcustom whitespace-line-column 80 - "*Specify column beyond which the line is highlighted. + "Specify column beyond which the line is highlighted. Used when `whitespace-style' includes `lines' or `lines-tail'." :type '(integer :tag "Line Length") @@ -891,7 +891,7 @@ ;; If this is a problem for you, please, comment the line below. (tab-mark ?\t [?\xBB ?\t] [?\\ ?\t]) ; tab - left quote mark ) - "*Specify an alist of mappings for displaying characters. + "Specify an alist of mappings for displaying characters. Each element has the following form: @@ -936,7 +936,7 @@ (defcustom whitespace-global-modes t - "*Modes for which global `whitespace-mode' is automagically turned on. + "Modes for which global `whitespace-mode' is automagically turned on. Global `whitespace-mode' is controlled by the command `global-whitespace-mode'. @@ -967,7 +967,7 @@ (defcustom whitespace-action nil - "*Specify which action is taken when a buffer is visited or written. + "Specify which action is taken when a buffer is visited or written. It's a list containing some or all of the following values:
--- a/lisp/wid-edit.el Wed Dec 03 05:48:11 2008 +0000 +++ b/lisp/wid-edit.el Wed Dec 03 05:48:14 2008 +0000 @@ -198,7 +198,7 @@ :type 'integer) (defcustom widget-menu-minibuffer-flag nil - "*Control how to ask for a choice from the keyboard. + "Control how to ask for a choice from the keyboard. Non-nil means use the minibuffer; nil means read a single character." :group 'widgets @@ -3045,7 +3045,7 @@ (message "Only match")) ((null completion) (error "No match")) - ((not (eq t (compare-strings prefix nil nil completion nil nil + ((not (eq t (compare-strings prefix nil nil completion nil nil completion-ignore-case))) (when completion-ignore-case ;; Replace field with completion in case its case is different.