From fb7ada5f94a71d73bf6cfad5cc87fe7fb26125a5 Mon Sep 17 00:00:00 2001 From: Chong Yidong Date: Mon, 9 Apr 2012 21:05:48 +0800 Subject: [PATCH] Remove * characters from the front of variable docstrings. --- lisp/allout-widgets.el | 18 +-- lisp/allout.el | 22 ++-- lisp/calc/calc-units.el | 2 +- lisp/calc/calc.el | 2 +- lisp/cedet/data-debug.el | 2 +- lisp/cedet/pulse.el | 4 +- lisp/cedet/semantic.el | 4 +- lisp/completion.el | 8 +- lisp/dframe.el | 8 +- lisp/dos-w32.el | 4 +- lisp/emacs-lisp/chart.el | 2 +- lisp/emacs-lisp/edebug.el | 2 +- lisp/emacs-lisp/eieio.el | 6 +- lisp/emacs-lisp/ert.el | 2 +- lisp/emacs-lisp/timer.el | 2 +- lisp/emulation/viper-cmd.el | 2 +- lisp/emulation/viper-ex.el | 4 +- lisp/emulation/viper-init.el | 58 +++++----- lisp/emulation/viper-keym.el | 8 +- lisp/emulation/viper-mous.el | 8 +- lisp/emulation/viper-util.el | 2 +- lisp/emulation/viper.el | 4 +- lisp/epa.el | 6 +- lisp/erc/erc-autoaway.el | 12 +- lisp/erc/erc-backend.el | 12 +- lisp/erc/erc-button.el | 12 +- lisp/erc/erc-dcc.el | 20 ++-- lisp/erc/erc-goodies.el | 4 +- lisp/erc/erc-log.el | 16 +-- lisp/erc/erc-match.el | 10 +- lisp/erc/erc-notify.el | 8 +- lisp/erc/erc-pcomplete.el | 2 +- lisp/erc/erc-sound.el | 2 +- lisp/erc/erc-stamp.el | 26 ++--- lisp/erc/erc-track.el | 12 +- lisp/erc/erc-truncate.el | 2 +- lisp/erc/erc-xdcc.el | 8 +- lisp/erc/erc.el | 48 ++++---- lisp/facemenu.el | 2 +- lisp/faces.el | 2 +- lisp/ffap.el | 2 +- lisp/find-file.el | 2 +- lisp/follow.el | 4 +- lisp/font-lock.el | 8 +- lisp/forms.el | 2 +- lisp/ido.el | 4 +- lisp/iswitchb.el | 2 +- lisp/kmacro.el | 4 +- lisp/language/ethio-util.el | 16 +-- lisp/language/korea-util.el | 2 +- lisp/language/tibet-util.el | 2 +- lisp/mail/binhex.el | 6 +- lisp/mail/feedmail.el | 8 +- lisp/mail/footnote.el | 2 +- lisp/mail/hashcash.el | 16 +-- lisp/mail/mail-extr.el | 12 +- lisp/mail/mail-hist.el | 6 +- lisp/mail/mailabbrev.el | 4 +- lisp/mail/metamail.el | 8 +- lisp/mail/mspools.el | 10 +- lisp/mail/rmail.el | 6 +- lisp/mail/sendmail.el | 2 +- lisp/mail/undigest.el | 2 +- lisp/mail/uudecode.el | 6 +- lisp/minibuf-eldef.el | 2 +- lisp/mouse-drag.el | 2 +- lisp/msb.el | 6 +- lisp/net/ange-ftp.el | 10 +- lisp/net/goto-addr.el | 6 +- lisp/net/imap.el | 4 +- lisp/net/quickurl.el | 18 +-- lisp/net/rcirc.el | 20 ++-- lisp/net/snmp-mode.el | 4 +- lisp/net/socks.el | 6 +- lisp/net/tramp-ftp.el | 2 +- lisp/net/tramp-gvfs.el | 4 +- lisp/net/tramp-gw.el | 8 +- lisp/net/tramp-sh.el | 12 +- lisp/net/tramp-smb.el | 8 +- lisp/net/tramp.el | 102 ++++++++--------- lisp/net/webjump.el | 2 +- lisp/newcomment.el | 6 +- lisp/nxml/nxml-glyph.el | 2 +- lisp/nxml/rng-nxml.el | 2 +- lisp/obsolete/erc-hecomplete.el | 4 +- lisp/obsolete/fast-lock.el | 10 +- lisp/obsolete/iso-acc.el | 6 +- lisp/obsolete/resume.el | 2 +- lisp/obsolete/scribe.el | 6 +- lisp/org/org-ctags.el | 2 +- lisp/org/org-protocol.el | 2 +- lisp/outline.el | 6 +- lisp/paren.el | 2 +- lisp/play/animate.el | 2 +- lisp/play/gomoku.el | 10 +- lisp/play/landmark.el | 12 +- lisp/play/zone.el | 4 +- lisp/progmodes/ada-mode.el | 66 +++++------ lisp/progmodes/ada-xref.el | 28 ++--- lisp/progmodes/antlr-mode.el | 26 ++--- lisp/progmodes/asm-mode.el | 2 +- lisp/progmodes/cfengine.el | 2 +- lisp/progmodes/cmacexp.el | 6 +- lisp/progmodes/compile.el | 8 +- lisp/progmodes/cpp.el | 12 +- lisp/progmodes/cwarn.el | 2 +- lisp/progmodes/dcl-mode.el | 42 +++---- lisp/progmodes/delphi.el | 22 ++-- lisp/progmodes/ebnf2ps.el | 128 ++++++++++----------- lisp/progmodes/ebrowse.el | 44 ++++---- lisp/progmodes/etags.el | 22 ++-- lisp/progmodes/executable.el | 14 +-- lisp/progmodes/f90.el | 2 +- lisp/progmodes/glasses.el | 2 +- lisp/progmodes/grep.el | 12 +- lisp/progmodes/gud.el | 6 +- lisp/progmodes/hideshow.el | 18 +-- lisp/progmodes/icon.el | 14 +-- lisp/progmodes/idlw-help.el | 10 +- lisp/progmodes/idlw-shell.el | 66 +++++------ lisp/progmodes/idlwave.el | 118 ++++++++++---------- lisp/progmodes/inf-lisp.el | 10 +- lisp/progmodes/m4-mode.el | 2 +- lisp/progmodes/make-mode.el | 40 +++---- lisp/progmodes/modula2.el | 4 +- lisp/progmodes/octave-inf.el | 2 +- lisp/progmodes/pascal.el | 22 ++-- lisp/progmodes/perl-mode.el | 18 +-- lisp/progmodes/prolog.el | 4 +- lisp/progmodes/ps-mode.el | 22 ++-- lisp/progmodes/python.el | 6 +- lisp/progmodes/scheme.el | 4 +- lisp/progmodes/sh-script.el | 6 +- lisp/progmodes/simula.el | 22 ++-- lisp/progmodes/tcl.el | 24 ++-- lisp/progmodes/vera-mode.el | 6 +- lisp/progmodes/verilog-mode.el | 164 +++++++++++++-------------- lisp/progmodes/vhdl-mode.el | 242 ++++++++++++++++++++-------------------- lisp/progmodes/xscheme.el | 6 +- lisp/simple.el | 4 +- lisp/skeleton.el | 10 +- lisp/subr.el | 2 +- lisp/textmodes/artist.el | 6 +- lisp/textmodes/bib-mode.el | 2 +- lisp/textmodes/bibtex.el | 6 +- lisp/textmodes/flyspell.el | 2 +- lisp/textmodes/ispell.el | 54 ++++----- lisp/textmodes/refbib.el | 8 +- lisp/textmodes/reftex-dcr.el | 2 +- lisp/textmodes/reftex-vars.el | 114 +++++++++---------- lisp/textmodes/sgml-mode.el | 8 +- lisp/textmodes/table.el | 2 +- lisp/textmodes/tex-mode.el | 2 +- lisp/textmodes/texinfmt.el | 8 +- lisp/textmodes/texnfo-upd.el | 8 +- lisp/timezone.el | 2 +- lisp/type-break.el | 2 +- lisp/url/url-dav.el | 2 +- lisp/url/url-handlers.el | 2 +- lisp/url/url-ldap.el | 4 +- lisp/url/url-nfs.el | 2 +- lisp/url/url-vars.el | 8 +- lisp/vc/add-log.el | 6 +- lisp/vc/cvs-status.el | 2 +- lisp/vc/ediff-diff.el | 18 +-- lisp/vc/ediff-init.el | 2 +- lisp/vc/emerge.el | 4 +- lisp/vc/log-edit.el | 2 +- lisp/vc/pcvs-defs.el | 10 +- src/alloc.c | 4 +- src/buffer.c | 48 ++++---- src/callint.c | 2 +- src/callproc.c | 6 +- src/charset.c | 2 +- src/dosfns.c | 8 +- src/eval.c | 12 +- src/fileio.c | 4 +- src/fns.c | 4 +- src/fontset.c | 2 +- src/fringe.c | 2 +- src/indent.c | 2 +- src/lread.c | 2 +- src/msdos.c | 2 +- src/print.c | 4 +- src/process.c | 2 +- src/syntax.c | 2 +- src/w32term.c | 4 +- src/xdisp.c | 46 ++++---- src/xfaces.c | 4 +- src/xfns.c | 10 +- src/xsettings.c | 2 +- src/xterm.c | 4 +- 192 files changed, 1283 insertions(+), 1283 deletions(-) diff --git a/lisp/allout-widgets.el b/lisp/allout-widgets.el index 86d567bcdde..16420d8af27 100644 --- a/lisp/allout-widgets.el +++ b/lisp/allout-widgets.el @@ -153,7 +153,7 @@ See `allout-widgets-mode' for allout widgets mode features." ) ;; ;;;_ = allout-widgets-allow-unruly-edits ;; (defcustom allout-widgets-allow-unruly-edits nil -;; "*Control whether manual edits are restricted to maintain outline integrity. +;; "Control whether manual edits are restricted to maintain outline integrity. ;; When nil, manual edits must either be within an item's body or encompass ;; one or more items completely - eg, killing topics as entities, rather than @@ -203,21 +203,21 @@ See `allout-widgets-mode' for allout widgets mode features." ;;;_ = allout-widgets-item-image-properties-emacs (defcustom allout-widgets-item-image-properties-emacs '(:ascent center :mask (heuristic t)) - "*Default properties item widget images in mainline Emacs." + "Default properties item widget images in mainline Emacs." :version "24.1" :type 'plist :group 'allout-widgets) ;;;_ = allout-widgets-item-image-properties-xemacs (defcustom allout-widgets-item-image-properties-xemacs nil - "*Default properties item widget images in XEmacs." + "Default properties item widget images in XEmacs." :version "24.1" :type 'plist :group 'allout-widgets) ;;;_ . Developer ;;;_ = allout-widgets-run-unit-tests-on-load (defcustom allout-widgets-run-unit-tests-on-load nil - "*When non-nil, unit tests will be run at end of loading allout-widgets. + "When non-nil, unit tests will be run at end of loading allout-widgets. Generally, allout widgets code developers are the only ones who'll want to set this. @@ -232,7 +232,7 @@ See `allout-widgets-run-unit-tests' to see what's run." :group 'allout-widgets-developer) ;;;_ = allout-widgets-time-decoration-activity (defcustom allout-widgets-time-decoration-activity nil - "*Retain timing info of the last cooperative redecoration. + "Retain timing info of the last cooperative redecoration. The details are retained as the value of `allout-widgets-last-decoration-timing'. @@ -244,7 +244,7 @@ set this." :group 'allout-widgets-developer) ;;;_ = allout-widgets-hook-error-post-time 0 (defcustom allout-widgets-hook-error-post-time 0 - "*Amount of time to sit showing hook error messages. + "Amount of time to sit showing hook error messages. 0 is minimal, or nil to not post to the message area. @@ -254,7 +254,7 @@ This is for debugging purposes." :group 'allout-widgets-developer) ;;;_ = allout-widgets-maintain-tally nil (defcustom allout-widgets-maintain-tally nil - "*If non-nil, maintain a collection of widgets, `allout-widgets-tally'. + "If non-nil, maintain a collection of widgets, `allout-widgets-tally'. This is for debugging purposes. @@ -290,7 +290,7 @@ The number varies according to the evanescence of objects on a (format ":%s" (hash-table-count allout-widgets-tally)))) ;;;_ = allout-widgets-track-decoration nil (defcustom allout-widgets-track-decoration nil - "*If non-nil, show cursor position of each item decoration. + "If non-nil, show cursor position of each item decoration. This is for debugging purposes, and generally set at need in a buffer rather than as a prevailing configuration \(but it's handy @@ -416,7 +416,7 @@ onto the front.") ;;;_ , Widget-specific outline text format ;;;_ = allout-escaped-prefix-regexp (defvar allout-escaped-prefix-regexp "" - "*Regular expression for body text that would look like an item prefix if + "Regular expression for body text that would look like an item prefix if not altered with an escape sequence.") (make-variable-buffer-local 'allout-escaped-prefix-regexp) ;;;_ , Widget element formatting diff --git a/lisp/allout.el b/lisp/allout.el index 3eed3c7d23e..4883e4244a8 100644 --- a/lisp/allout.el +++ b/lisp/allout.el @@ -945,7 +945,7 @@ case the value of `allout-default-layout' is used.") ;;;_ : Topic header format ;;;_ = allout-regexp (defvar allout-regexp "" - "*Regular expression to match the beginning of a heading line. + "Regular expression to match the beginning of a heading line. Any line whose beginning matches this regexp is considered a heading. This var is set according to the user configuration vars @@ -965,7 +965,7 @@ and `allout-distinctive-bullets-string'.") (make-variable-buffer-local 'allout-bullets-string-len) ;;;_ = allout-depth-specific-regexp (defvar allout-depth-specific-regexp "" - "*Regular expression to match a heading line prefix for a particular depth. + "Regular expression to match a heading line prefix for a particular depth. This expression is used to search for depth-specific topic headers at depth 2 and greater. Use `allout-depth-one-regexp' @@ -978,7 +978,7 @@ topic prefix to be matched.") (make-variable-buffer-local 'allout-depth-specific-regexp) ;;;_ = allout-depth-one-regexp (defvar allout-depth-one-regexp "" - "*Regular expression to match a heading line prefix for depth one. + "Regular expression to match a heading line prefix for depth one. This var is set according to the user configuration vars by `set-allout-regexp'. It is prepared with format strings for two @@ -1403,10 +1403,10 @@ their settings before allout-mode was started." ,expr)) ;;;_ = allout-mode-hook (defvar allout-mode-hook nil - "*Hook that's run when allout mode starts.") + "Hook that's run when allout mode starts.") ;;;_ = allout-mode-deactivate-hook (defvar allout-mode-deactivate-hook nil - "*Hook that's run when allout mode ends.") + "Hook that's run when allout mode ends.") (define-obsolete-variable-alias 'allout-mode-deactivate-hook 'allout-mode-off-hook "24.1") ;;;_ = allout-exposure-category @@ -1414,7 +1414,7 @@ their settings before allout-mode was started." "Symbol for use as allout invisible-text overlay category.") ;;;_ = allout-exposure-change-hook (defvar allout-exposure-change-hook nil - "*Hook that's run after allout outline subtree exposure changes. + "Hook that's run after allout outline subtree exposure changes. It is run at the conclusion of `allout-flag-region'. @@ -1427,7 +1427,7 @@ Functions on the hook must take three arguments: This hook might be invoked multiple times by a single command.") ;;;_ = allout-structure-added-hook (defvar allout-structure-added-hook nil - "*Hook that's run after addition of items to the outline. + "Hook that's run after addition of items to the outline. Functions on the hook should take two arguments: @@ -1437,7 +1437,7 @@ Functions on the hook should take two arguments: This hook might be invoked multiple times by a single command.") ;;;_ = allout-structure-deleted-hook (defvar allout-structure-deleted-hook nil - "*Hook that's run after disciplined deletion of subtrees from the outline. + "Hook that's run after disciplined deletion of subtrees from the outline. Functions on the hook must take two arguments: @@ -1450,7 +1450,7 @@ specifically edits that native allout routines do not control. This hook might be invoked multiple times by a single command.") ;;;_ = allout-structure-shifted-hook (defvar allout-structure-shifted-hook nil - "*Hook that's run after shifting of items in the outline. + "Hook that's run after shifting of items in the outline. Functions on the hook should take two arguments: @@ -1463,12 +1463,12 @@ that native allout routines do not control. This hook might be invoked multiple times by a single command.") ;;;_ = allout-after-copy-or-kill-hook (defvar allout-after-copy-or-kill-hook nil - "*Hook that's run after copying outline text. + "Hook that's run after copying outline text. Functions on the hook should not require any arguments.") ;;;_ = allout-post-undo-hook (defvar allout-post-undo-hook nil - "*Hook that's run after undo activity. + "Hook that's run after undo activity. The item that's current when the hook is run *may* be the one that was affected by the undo. diff --git a/lisp/calc/calc-units.el b/lisp/calc/calc-units.el index dcbf845c371..9d2583085a2 100644 --- a/lisp/calc/calc-units.el +++ b/lisp/calc/calc-units.el @@ -302,7 +302,7 @@ (defvar math-additional-units nil - "*Additional units table for user-defined units. + "Additional units table for user-defined units. Must be formatted like `math-standard-units'. If you change this, be sure to set `math-units-table' to nil to ensure that the combined units table will be rebuilt.") diff --git a/lisp/calc/calc.el b/lisp/calc/calc.el index 41cdb491cfa..5224d1aa4f8 100644 --- a/lisp/calc/calc.el +++ b/lisp/calc/calc.el @@ -817,7 +817,7 @@ If nil, selections displayed but ignored.") Used by `calc-user-invocation'.") (defcalcmodevar calc-show-banner t - "*If non-nil, show a friendly greeting above the stack.") + "If non-nil, show a friendly greeting above the stack.") (defconst calc-local-var-list '(calc-stack calc-stack-top diff --git a/lisp/cedet/data-debug.el b/lisp/cedet/data-debug.el index d930a20fba5..03dca6ceccc 100644 --- a/lisp/cedet/data-debug.el +++ b/lisp/cedet/data-debug.el @@ -872,7 +872,7 @@ If PARENT is non-nil, it is somehow related as a parent to thing." "Keymap used in data-debug.") (defcustom data-debug-mode-hook nil - "*Hook run when data-debug starts." + "Hook run when data-debug starts." :group 'data-debug :type 'hook) diff --git a/lisp/cedet/pulse.el b/lisp/cedet/pulse.el index 746ee0b89af..8f367d918dc 100644 --- a/lisp/cedet/pulse.el +++ b/lisp/cedet/pulse.el @@ -77,7 +77,7 @@ this flag is ignored." (:background "#AAAA33")) (((class color) (background light)) (:background "#FFFFAA"))) - "*Face used at beginning of a highlight." + "Face used at beginning of a highlight." :group 'pulse) (defface pulse-highlight-face @@ -85,7 +85,7 @@ this flag is ignored." (:background "#AAAA33")) (((class color) (background light)) (:background "#FFFFAA"))) - "*Face used during a pulse for display. *DO NOT CUSTOMIZE* + "Face used during a pulse for display. *DO NOT CUSTOMIZE* Face used for temporary highlighting of tags for effect." :group 'pulse) diff --git a/lisp/cedet/semantic.el b/lisp/cedet/semantic.el index 0ed031019be..aeb5241b2d0 100644 --- a/lisp/cedet/semantic.el +++ b/lisp/cedet/semantic.el @@ -550,14 +550,14 @@ is requested." ) (defvar semantic-working-type 'percent - "*The type of working message to use when parsing. + "The type of working message to use when parsing. 'percent means we are doing a linear parse through the buffer. 'dynamic means we are reparsing specific tags.") (semantic-varalias-obsolete 'semantic-bovination-working-type 'semantic-working-type "23.2") (defvar semantic-minimum-working-buffer-size (* 1024 5) - "*The minimum size of a buffer before working messages are displayed. + "The minimum size of a buffer before working messages are displayed. Buffers smaller than this will parse silently. Buffers larger than this will display the working progress bar.") diff --git a/lisp/completion.el b/lisp/completion.el index ceb272fad6d..9c6cd60c96c 100644 --- a/lisp/completion.el +++ b/lisp/completion.el @@ -344,18 +344,18 @@ are automatically added to the completion database." :group 'completion) ;;(defvar *record-cmpl-statistics-p* nil -;; "*If non-nil, record completion statistics.") +;; "If non-nil, record completion statistics.") ;;(defvar *completion-auto-save-period* 1800 -;; "*The period in seconds to wait for emacs to be idle before autosaving +;; "The period in seconds to wait for emacs to be idle before autosaving ;;the completions. Default is a 1/2 hour.") (defvar completion-min-length 6 - "*The minimum length of a stored completion. + "The minimum length of a stored completion. DON'T CHANGE WITHOUT RECOMPILING ! This is used by macros.") (defvar completion-max-length 200 - "*The maximum length of a stored completion. + "The maximum length of a stored completion. DON'T CHANGE WITHOUT RECOMPILING ! This is used by macros.") (defvar completion-prefix-min-length 3 diff --git a/lisp/dframe.el b/lisp/dframe.el index d3356197a2b..2cdf4784eb0 100644 --- a/lisp/dframe.el +++ b/lisp/dframe.el @@ -157,22 +157,22 @@ selected frame and the focus will change to that frame." :type 'hook) (defvar dframe-track-mouse-function nil - "*A function to call when the mouse is moved in the given frame. + "A function to call when the mouse is moved in the given frame. Typically used to display info about the line under the mouse.") (make-variable-buffer-local 'dframe-track-mouse-function) (defvar dframe-help-echo-function nil - "*A function to call when help-echo is used in newer versions of Emacs. + "A function to call when help-echo is used in newer versions of Emacs. Typically used to display info about the line under the mouse.") (make-variable-buffer-local 'dframe-help-echo-function) (defvar dframe-mouse-click-function nil - "*A function to call when the mouse is clicked. + "A function to call when the mouse is clicked. Valid clicks are mouse 2, our double mouse 1.") (make-variable-buffer-local 'dframe-mouse-click-function) (defvar dframe-mouse-position-function nil - "*A function to call to position the cursor for a mouse click.") + "A function to call to position the cursor for a mouse click.") (make-variable-buffer-local 'dframe-mouse-position-function) (defvar dframe-power-click nil diff --git a/lisp/dos-w32.el b/lisp/dos-w32.el index d84e3737c91..071c7b71263 100644 --- a/lisp/dos-w32.el +++ b/lisp/dos-w32.el @@ -55,7 +55,7 @@ ("\\.tp[ulpw]$" . t) ; borland Pascal stuff ("[:/]tags$" . nil) ; emacs TAGS file ) - "*Alist for distinguishing text files from binary files. + "Alist for distinguishing text files from binary files. Each element has the form (REGEXP . TYPE), where REGEXP is matched against the file name, and TYPE is nil for text, t for binary.") @@ -283,7 +283,7 @@ filesystem mounted on drive Z:, FILESYSTEM could be \"Z:\"." ;;; Support for printing under DOS/Windows, see lpr.el and ps-print.el. (defvar direct-print-region-use-command-dot-com t - "*Control whether command.com is used to print on Windows 9x.") + "Control whether command.com is used to print on Windows 9x.") ;; Function to actually send data to the printer port. ;; Supports writing directly, and using various programs. diff --git a/lisp/emacs-lisp/chart.el b/lisp/emacs-lisp/chart.el index 19766feac5a..2e3abb2e9d3 100644 --- a/lisp/emacs-lisp/chart.el +++ b/lisp/emacs-lisp/chart.el @@ -82,7 +82,7 @@ Colors will be the background color.") Useful if new Emacs is used on B&W display.") (defcustom chart-face-use-pixmaps nil - "*Non-nil to use fancy pixmaps in the background of chart face colors." + "Non-nil to use fancy pixmaps in the background of chart face colors." :group 'eieio :type 'boolean) diff --git a/lisp/emacs-lisp/edebug.el b/lisp/emacs-lisp/edebug.el index 67ffd6d5d31..f47feebe5d2 100644 --- a/lisp/emacs-lisp/edebug.el +++ b/lisp/emacs-lisp/edebug.el @@ -3744,7 +3744,7 @@ This prints the value into current buffer." ;; FIXME eh? (defvar gud-inhibit-global-bindings - "*Non-nil means don't do global rebindings of C-x C-a subcommands.") + "Non-nil means don't do global rebindings of C-x C-a subcommands.") ;; Global GUD bindings for all emacs-lisp-mode buffers. (unless gud-inhibit-global-bindings diff --git a/lisp/emacs-lisp/eieio.el b/lisp/emacs-lisp/eieio.el index cdf7237b766..f1c1bf8965c 100644 --- a/lisp/emacs-lisp/eieio.el +++ b/lisp/emacs-lisp/eieio.el @@ -79,7 +79,7 @@ ;; (defvar eieio-hook nil - "*This hook is executed, then cleared each time `defclass' is called.") + "This hook is executed, then cleared each time `defclass' is called.") (defvar eieio-error-unsupported-class-tags nil "Non-nil to throw an error if an encountered tag is unsupported. @@ -87,7 +87,7 @@ This may prevent classes from CLOS applications from being used with EIEIO since EIEIO does not support all CLOS tags.") (defvar eieio-skip-typecheck nil - "*If non-nil, skip all slot typechecking. + "If non-nil, skip all slot typechecking. Set this to t permanently if a program is functioning well to get a small speed increase. This variable is also used internally to handle default setting for optimization purposes.") @@ -2044,7 +2044,7 @@ During executions, the list is first generated, then as each next method is called, the next method is popped off the stack.") (defvar eieio-pre-method-execution-hooks nil - "*Hooks run just before a method is executed. + "Hooks run just before a method is executed. The hook function must accept one argument, the list of forms about to be executed.") diff --git a/lisp/emacs-lisp/ert.el b/lisp/emacs-lisp/ert.el index 9cbe29bf322..ad5e20cb8a4 100644 --- a/lisp/emacs-lisp/ert.el +++ b/lisp/emacs-lisp/ert.el @@ -1405,7 +1405,7 @@ RESULT must be an `ert-test-result-with-condition'." ;;; Running tests in batch mode. (defvar ert-batch-backtrace-right-margin 70 - "*The maximum line length for printing backtraces in `ert-run-tests-batch'.") + "The maximum line length for printing backtraces in `ert-run-tests-batch'.") ;;;###autoload (defun ert-run-tests-batch (&optional selector) diff --git a/lisp/emacs-lisp/timer.el b/lisp/emacs-lisp/timer.el index b6b7c266263..87b6cceb24b 100644 --- a/lisp/emacs-lisp/timer.el +++ b/lisp/emacs-lisp/timer.el @@ -241,7 +241,7 @@ and idle timers such as are scheduled by `run-with-idle-timer'." "Third-to-last timer that was run.") (defvar timer-max-repeats 10 - "*Maximum number of times to repeat a timer, if many repeats are delayed. + "Maximum number of times to repeat a timer, if many repeats are delayed. Timer invocations can be delayed because Emacs is suspended or busy, or because the system's time changes. If such an occurrence makes it appear that many invocations are overdue, this variable controls diff --git a/lisp/emulation/viper-cmd.el b/lisp/emulation/viper-cmd.el index 68f40349454..111ce34dc1a 100644 --- a/lisp/emulation/viper-cmd.el +++ b/lisp/emulation/viper-cmd.el @@ -2119,7 +2119,7 @@ Undo previous insertion and inserts new." (defcustom viper-smart-suffix-list '("" "tex" "c" "cc" "C" "java" "el" "html" "htm" "xml" "pl" "flr" "P" "p" "h" "H") - "*List of suffixes that Viper tries to append to filenames ending with a `.'. + "List of suffixes that Viper tries to append to filenames ending with a `.'. This is useful when the current directory contains files with the same prefix and many different suffixes. Usually, only one of the suffixes represents an editable file. However, file completion will stop at the `.' diff --git a/lisp/emulation/viper-ex.el b/lisp/emulation/viper-ex.el index 3d538f1bd0d..acaedde3004 100644 --- a/lisp/emulation/viper-ex.el +++ b/lisp/emulation/viper-ex.el @@ -368,14 +368,14 @@ corresponding function symbol." (defvar viper-keep-reading-filename nil) (defcustom ex-cycle-other-window t - "*If t, :n and :b cycles through files and buffers in other window. + "If t, :n and :b cycles through files and buffers in other window. Then :N and :B cycles in the current window. If nil, this behavior is reversed." :type 'boolean :group 'viper-ex) (defcustom ex-cycle-through-non-files nil - "*Cycle through *scratch* and other buffers that don't visit any file." + "Cycle through *scratch* and other buffers that don't visit any file." :type 'boolean :group 'viper-ex) diff --git a/lisp/emulation/viper-init.el b/lisp/emulation/viper-init.el index f8ab5a1f805..76a8c410676 100644 --- a/lisp/emulation/viper-init.el +++ b/lisp/emulation/viper-init.el @@ -372,7 +372,7 @@ Use `M-x viper-set-expert-level' to change this.") (defconst viper-buffer-undo-list-mark 'viper) (defcustom viper-keep-point-on-undo nil - "*Non-nil means not to move point while undoing commands. + "Non-nil means not to move point while undoing commands. This style is different from Emacs and Vi. Try it to see if it better fits your working style." :type 'boolean @@ -403,7 +403,7 @@ delete the text being replaced, as in standard Vi." :group 'viper) (defcustom viper-replace-overlay-cursor-color "Red" - "*Cursor color when Viper is in Replace state." + "Cursor color when Viper is in Replace state." :type 'string :group 'viper) @@ -450,7 +450,7 @@ is non-nil." (defcustom viper-use-replace-region-delimiters (or (not (viper-has-face-support-p)) (and (featurep 'xemacs) (eq (viper-device-type) 'tty))) - "*If non-nil, Viper will always use `viper-replace-region-end-delimiter' and + "If non-nil, Viper will always use `viper-replace-region-end-delimiter' and `viper-replace-region-start-delimiter' to delimit replacement regions, even on color displays. By default, the delimiters are used only on TTYs." :type 'boolean @@ -519,7 +519,7 @@ text." ;; Fast keyseq and ESC keyseq timeouts (defcustom viper-fast-keyseq-timeout 200 - "*Key sequence separated by no more than this many milliseconds is viewed as a Vi-style macro, if such a macro is defined. + "Key sequence separated by no more than this many milliseconds is viewed as a Vi-style macro, if such a macro is defined. Setting this too high may slow down your typing. Setting this value too low will make it hard to use Vi-style timeout macros." :type 'integer @@ -549,14 +549,14 @@ will make it hard to use Vi-style timeout macros." (viper-deflocalvar viper-auto-indent nil "") (defcustom viper-auto-indent nil - "*Enable autoindent, if t. + "Enable autoindent, if t. This is a buffer-local variable." :type 'boolean :group 'viper) (viper-deflocalvar viper-electric-mode t "") (defcustom viper-electric-mode t - "*If t, electrify Viper. + "If t, electrify Viper. Currently, this only electrifies auto-indentation, making it appropriate to the mode of the buffer. This means that auto-indentation will depart from standard Vi and will indent @@ -566,7 +566,7 @@ programs and LaTeX documents." :group 'viper) (defcustom viper-shift-width 8 - "*The value of the shiftwidth. + "The value of the shiftwidth. This determines the number of columns by which the Ctl-t moves the cursor in the Insert state." :type 'integer @@ -575,7 +575,7 @@ the Insert state." ;; Variables for repeating destructive commands (defcustom viper-keep-point-on-repeat t - "*If t, don't move point when repeating previous command. + "If t, don't move point when repeating previous command. This is useful for doing repeated changes with the '.' key. The user can change this to nil, if she likes when the cursor moves to a new place after repeating previous Vi command." @@ -668,18 +668,18 @@ to a new place after repeating previous Vi command." (defvar viper-s-forward nil) (defcustom viper-case-fold-search nil - "*If not nil, search ignores cases." + "If not nil, search ignores cases." :type 'boolean :group 'viper-search) (defcustom viper-re-search t - "*If not nil, search is regexp search, otherwise vanilla search." + "If not nil, search is regexp search, otherwise vanilla search." :type 'boolean :tag "Regexp Search" :group 'viper-search) (defcustom viper-search-scroll-threshold 2 - "*If search lands within this threshold from the window top/bottom, + "If search lands within this threshold from the window top/bottom, the window will be scrolled up or down appropriately, to reveal context. If you want Viper search to behave as usual in Vi, set this variable to a negative number." @@ -687,32 +687,32 @@ negative number." :group 'viper-search) (defcustom viper-re-query-replace t - "*If t then do regexp replace, if nil then do string replace." + "If t then do regexp replace, if nil then do string replace." :type 'boolean :tag "Regexp Query Replace" :group 'viper-search) (defcustom viper-re-replace t - "*If t, do regexp replace. nil means do string replace." + "If t, do regexp replace. nil means do string replace." :type 'boolean :tag "Regexp Replace" :group 'viper-search) (defcustom viper-parse-sexp-ignore-comments t - "*If t, `%' ignores the parentheses that occur inside comments." + "If t, `%' ignores the parentheses that occur inside comments." :type 'boolean :group 'viper) (viper-deflocalvar viper-ex-style-motion t "") (defcustom viper-ex-style-motion t - "*If t, the commands l,h do not cross lines, etc (Ex-style). + "If t, the commands l,h do not cross lines, etc (Ex-style). If nil, these commands cross line boundaries." :type 'boolean :group 'viper) (viper-deflocalvar viper-ex-style-editing t "") (defcustom viper-ex-style-editing t - "*If t, Ex-style behavior while editing in Vi command and insert states. + "If t, Ex-style behavior while editing in Vi command and insert states. `Backspace' and `Delete' don't cross line boundaries in insert. `X' and `x' can't delete characters across line boundary in Vi, etc. Note: this doesn't preclude `Backspace' and `Delete' from deleting characters @@ -724,32 +724,32 @@ If nil, the above commands can work across lines." (viper-deflocalvar viper-ESC-moves-cursor-back viper-ex-style-editing "") (defcustom viper-ESC-moves-cursor-back nil - "*If t, ESC moves cursor back when changing from insert to vi state. + "If t, ESC moves cursor back when changing from insert to vi state. If nil, the cursor stays where it was when ESC was hit." :type 'boolean :group 'viper) (viper-deflocalvar viper-delete-backwards-in-replace nil "") (defcustom viper-delete-backwards-in-replace nil - "*If t, DEL key will delete characters while moving the cursor backwards. + "If t, DEL key will delete characters while moving the cursor backwards. If nil, the cursor will move backwards without deleting anything." :type 'boolean :group 'viper) (defcustom viper-buffer-search-char nil - "*Key used for buffer-searching. Must be a character type, e.g., ?g." + "Key used for buffer-searching. Must be a character type, e.g., ?g." :type '(choice (const nil) character) :group 'viper-search) (defcustom viper-search-wrap-around t - "*If t, search wraps around." + "If t, search wraps around." :type 'boolean :tag "Search Wraps Around" :group 'viper-search) (viper-deflocalvar viper-related-files-and-buffers-ring nil "") (defcustom viper-related-files-and-buffers-ring nil - "*List of file and buffer names that are considered to be related to the current buffer. + "List of file and buffer names that are considered to be related to the current buffer. Related buffers can be cycled through via :R and :P commands." :type 'boolean :group 'viper-misc) @@ -771,7 +771,7 @@ Related buffers can be cycled through via :R and :P commands." "^\\\\[sb][a-z]*{.*}\\s-*$\\|" ; latex "^@node\\|@table\\|^@m?enu\\|^@itemize\\|^@if\\|" ; texinfo "^.+:-") ; prolog - "*Regexps for Headings. Used by \[\[ and \]\].") + "Regexps for Headings. Used by \[\[ and \]\].") (defvar viper-heading-end (concat "^}\\|" ; C/C++ @@ -826,7 +826,7 @@ Related buffers can be cycled through via :R and :P commands." (defface viper-search '((((class color)) (:foreground "Black" :background "khaki")) (t (:underline t :stipple "gray3"))) - "*Face used to flash out the search pattern." + "Face used to flash out the search pattern." :group 'viper-highlighting) ;; An internal variable. Viper takes the face from here. (defvar viper-search-face 'viper-search @@ -838,7 +838,7 @@ this variable represents.") (defface viper-replace-overlay '((((class color)) (:foreground "Black" :background "darkseagreen2")) (t (:underline t :stipple "gray3"))) - "*Face for highlighting replace regions on a window display." + "Face for highlighting replace regions on a window display." :group 'viper-highlighting) ;; An internal variable. Viper takes the face from here. (defvar viper-replace-overlay-face 'viper-replace-overlay @@ -946,19 +946,19 @@ Should be set in `~/.viper' file." :group 'viper) (defcustom viper-vi-state-hook 'viper-restore-cursor-type - "*Hooks run just before the switch to Vi mode is completed." + "Hooks run just before the switch to Vi mode is completed." :type 'hook :group 'viper-hooks) (defcustom viper-insert-state-hook 'viper-set-insert-cursor-type - "*Hooks run just before the switch to Insert mode is completed." + "Hooks run just before the switch to Insert mode is completed." :type 'hook :group 'viper-hooks) (defcustom viper-replace-state-hook 'viper-restore-cursor-type - "*Hooks run just before the switch to Replace mode is completed." + "Hooks run just before the switch to Replace mode is completed." :type 'hook :group 'viper-hooks) (defcustom viper-emacs-state-hook 'viper-restore-cursor-type - "*Hooks run just before the switch to Emacs mode is completed." + "Hooks run just before the switch to Emacs mode is completed." :type 'hook :group 'viper-hooks) @@ -980,7 +980,7 @@ Should be set in `~/.viper' file." (setq cursor-type '(bar . 2)))) (defun viper-ESC-keyseq-timeout () - "*Key sequence beginning with ESC and separated by no more than this many milliseconds is considered to be generated by a keyboard function key. + "Key sequence beginning with ESC and separated by no more than this many milliseconds is considered to be generated by a keyboard function key. Setting this too high may slow down switching from insert to vi state. Setting this value too low will make it impossible to use function keys in insert mode on a dumb terminal." diff --git a/lisp/emulation/viper-keym.el b/lisp/emulation/viper-keym.el index 65638dfff3c..ad1e32b5546 100644 --- a/lisp/emulation/viper-keym.el +++ b/lisp/emulation/viper-keym.el @@ -48,19 +48,19 @@ ;;; Emacs keys in other states. (defcustom viper-want-emacs-keys-in-insert t - "*Set to nil if you want complete Vi compatibility in insert mode. + "Set to nil if you want complete Vi compatibility in insert mode. Complete compatibility with Vi is not recommended for power use of Viper." :type 'boolean :group 'viper) (defcustom viper-want-emacs-keys-in-vi t - "*Set to nil if you want complete Vi compatibility in Vi mode. + "Set to nil if you want complete Vi compatibility in Vi mode. Full Vi compatibility is not recommended for power use of Viper." :type 'boolean :group 'viper) (defcustom viper-no-multiple-ESC t - "*If true, multiple ESC in Vi mode will cause bell to ring. + "If true, multiple ESC in Vi mode will cause bell to ring. This is set to t on a windowing terminal and to 'twice on a dumb terminal (unless the user level is 1, 2, or 5). On a dumb terminal, this enables cursor keys and is generally more convenient, as terminals usually @@ -71,7 +71,7 @@ as is allowed by the major mode in effect." :group 'viper) (defcustom viper-want-ctl-h-help nil - "*If non-nil, C-h gets bound to help-command; otherwise, C-h gets the usual Vi bindings." + "If non-nil, C-h gets bound to help-command; otherwise, C-h gets the usual Vi bindings." :type 'boolean :group 'viper) diff --git a/lisp/emulation/viper-mous.el b/lisp/emulation/viper-mous.el index 58d8fb45b92..eda1a7ec937 100644 --- a/lisp/emulation/viper-mous.el +++ b/lisp/emulation/viper-mous.el @@ -63,7 +63,7 @@ (defvar viper-current-frame-saved (selected-frame)) (defcustom viper-surrounding-word-function 'viper-surrounding-word - "*Function that determines what constitutes a word for clicking events. + "Function that determines what constitutes a word for clicking events. Takes two parameters: a COUNT, indicating how many words to return, and CLICK-COUNT, telling whether this is the first click, a double-click, or a triple-click." @@ -77,7 +77,7 @@ or a triple-click." mouse-track-multi-click-time double-click-time) 500) - "*Time interval in millisecond within which successive mouse clicks are + "Time interval in millisecond within which successive mouse clicks are considered related." :type 'integer :group 'viper-mouse) @@ -624,7 +624,7 @@ bindings in the Viper manual." (defcustom viper-mouse-search-key '(meta shift 1) - "*Key used to click-search in Viper. + "Key used to click-search in Viper. This must be a list that specifies the mouse button and modifiers. The supported modifiers are `meta', `shift', and `control'. For instance, `(meta shift 1)' means that holding the meta and shift @@ -640,7 +640,7 @@ This buffer may be different from the one where the click occurred." :group 'viper-mouse) (defcustom viper-mouse-insert-key '(meta shift 2) - "*Key used to click-insert in Viper. + "Key used to click-insert in Viper. Must be a list that specifies the mouse button and modifiers. The supported modifiers are `meta', `shift', and `control'. For instance, `(meta shift 2)' means that holding the meta and shift keys diff --git a/lisp/emulation/viper-util.el b/lisp/emulation/viper-util.el index cdeef733bc5..4afa379f389 100644 --- a/lisp/emulation/viper-util.el +++ b/lisp/emulation/viper-util.el @@ -1323,7 +1323,7 @@ sets the default value." (viper-update-syntax-classes)) (defcustom viper-syntax-preference 'reformed-vi - "*Syntax type characterizing Viper's alphanumeric symbols. + "Syntax type characterizing Viper's alphanumeric symbols. Affects movement and change commands that deal with Vi-style words. Works best when set in the hooks to various major modes. diff --git a/lisp/emulation/viper.el b/lisp/emulation/viper.el index 12c186e234e..9cf6c91265e 100644 --- a/lisp/emulation/viper.el +++ b/lisp/emulation/viper.el @@ -435,7 +435,7 @@ widget." view-mode vm-mode vm-summary-mode) - "*A list of major modes that should come up in Emacs state. + "A list of major modes that should come up in Emacs state. Normally, Viper would bring buffers up in Emacs state, unless the corresponding major mode has been placed on `viper-vi-state-mode-list' or `viper-insert-state-mode-list'. So, don't place a new mode on this list, @@ -451,7 +451,7 @@ unless it is coming up in a wrong Viper state." erc-mode eshell-mode shell-mode) - "*A list of major modes that should come up in Vi Insert state." + "A list of major modes that should come up in Vi Insert state." :type '(repeat symbol) :group 'viper-misc) diff --git a/lisp/epa.el b/lisp/epa.el index 3b9933f6984..58f4026a773 100644 --- a/lisp/epa.el +++ b/lisp/epa.el @@ -177,18 +177,18 @@ the separate window." (20 . ?G))) (defvar epa-protocol 'OpenPGP - "*The default protocol. + "The default protocol. The value can be either OpenPGP or CMS. You should bind this variable with `let', but do not set it globally.") (defvar epa-armor nil - "*If non-nil, epa commands create ASCII armored output. + "If non-nil, epa commands create ASCII armored output. You should bind this variable with `let', but do not set it globally.") (defvar epa-textmode nil - "*If non-nil, epa commands treat input files as text. + "If non-nil, epa commands treat input files as text. You should bind this variable with `let', but do not set it globally.") diff --git a/lisp/erc/erc-autoaway.el b/lisp/erc/erc-autoaway.el index 699c4e20552..ab429a12589 100644 --- a/lisp/erc/erc-autoaway.el +++ b/lisp/erc/erc-autoaway.el @@ -138,7 +138,7 @@ Related variables: `erc-public-away-p' and `erc-away-nickname'." (remove-hook 'erc-server-305-functions 'erc-autoaway-reset-indicators)))) (defcustom erc-autoaway-idle-method 'user - "*The method used to determine how long you have been idle. + "The method used to determine how long you have been idle. If 'user, the time of the last command sent to Emacs is used. If 'emacs, the idle time in Emacs is used. If 'irc, the time of the last IRC command is used. @@ -160,7 +160,7 @@ definitions of being idle." (set sym val)))) (defcustom erc-auto-set-away t - "*If non-nil, set away after `erc-autoaway-idle-seconds' seconds of idling. + "If non-nil, set away after `erc-autoaway-idle-seconds' seconds of idling. ERC autoaway mode can set you away when you idle, and set you no longer away when you type something. This variable controls whether you will be set away when you idle. See `erc-auto-discard-away' for @@ -169,7 +169,7 @@ the other half." :type 'boolean) (defcustom erc-auto-discard-away t - "*If non-nil, sending anything when away automatically discards away state. + "If non-nil, sending anything when away automatically discards away state. ERC autoaway mode can set you away when you idle, and set you no longer away when you type something. This variable controls whether you will be set no longer away when you type something. See @@ -179,13 +179,13 @@ See also `erc-autoaway-no-auto-discard-regexp'." :type 'boolean) (defcustom erc-autoaway-no-auto-discard-regexp "^/g?away.*$" - "*Input that matches this will not automatically discard away status. + "Input that matches this will not automatically discard away status. See `erc-auto-discard-away'." :group 'erc-autoaway :type 'regexp) (defcustom erc-autoaway-idle-seconds 1800 - "*Number of seconds after which ERC will set you automatically away. + "Number of seconds after which ERC will set you automatically away. If you are changing this variable using lisp instead of customizing it, you have to run `erc-autoaway-reestablish-idletimer' afterwards." :group 'erc-autoaway @@ -197,7 +197,7 @@ you have to run `erc-autoaway-reestablish-idletimer' afterwards." (defcustom erc-autoaway-message "I'm gone (autoaway after %i seconds of idletime)" - "*Message ERC will use when setting you automatically away. + "Message ERC will use when setting you automatically away. It is used as a `format' string with the argument of the idletime in seconds." :group 'erc-autoaway diff --git a/lisp/erc/erc-backend.el b/lisp/erc/erc-backend.el index 7bc56584eaf..62f524ed001 100644 --- a/lisp/erc/erc-backend.el +++ b/lisp/erc/erc-backend.el @@ -311,7 +311,7 @@ If a key is pressed while ERC is waiting, it will stop waiting." :type 'number) (defcustom erc-split-line-length 440 - "*The maximum length of a single message. + "The maximum length of a single message. If a message exceeds this size, it is broken into multiple ones. IRC allows for lines up to 512 bytes. Two of them are CR LF. @@ -379,14 +379,14 @@ It should take same arguments as `open-network-stream' does." :type 'function) (defcustom erc-server-prevent-duplicates '("301") - "*Either nil or a list of strings. + "Either nil or a list of strings. Each string is a IRC message type, like PRIVMSG or NOTICE. All Message types in that list of subjected to duplicate prevention." :type '(choice (const nil) (list string)) :group 'erc-server) (defcustom erc-server-duplicate-timeout 60 - "*The time allowed in seconds between duplicate messages. + "The time allowed in seconds between duplicate messages. If two identical messages arrive within this value of one another, the second isn't displayed." @@ -399,7 +399,7 @@ isn't displayed." ;; (http://www.nongnu.org/circe) (defcustom erc-server-flood-margin 10 - "*A margin on how much excess data we send. + "A margin on how much excess data we send. The flood protection algorithm of ERC works like the one detailed in RFC 2813, section 5.8 \"Flood control of clients\". @@ -423,14 +423,14 @@ protection algorithm." ;; Ping handling (defcustom erc-server-send-ping-interval 30 - "*Interval of sending pings to the server, in seconds. + "Interval of sending pings to the server, in seconds. If this is set to nil, pinging the server is disabled." :group 'erc-server :type '(choice (const :tag "Disabled" nil) (integer :tag "Seconds"))) (defcustom erc-server-send-ping-timeout 120 - "*If the time between ping and response is greater than this, reconnect. + "If the time between ping and response is greater than this, reconnect. The time is in seconds. This must be greater than or equal to the value for diff --git a/lisp/erc/erc-button.el b/lisp/erc/erc-button.el index 17b8c457f38..727e3de58e8 100644 --- a/lisp/erc/erc-button.el +++ b/lisp/erc/erc-button.el @@ -115,13 +115,13 @@ longer than `erc-fill-column'." :type 'boolean) (defcustom erc-button-rfc-url "http://www.faqs.org/rfcs/rfc%s.html" - "*URL used to browse rfc references. + "URL used to browse rfc references. %s is replaced by the number." :group 'erc-button :type 'string) (defcustom erc-button-google-url "http://www.google.com/search?q=%s" - "*URL used to browse Google search references. + "URL used to browse Google search references. %s is replaced by the search string." :group 'erc-button :type 'string) @@ -155,7 +155,7 @@ longer than `erc-fill-column'." 1) ;; other ("\\s-\\(@\\([0-9][0-9][0-9]\\)\\)" 1 t erc-button-beats-to-time 2)) - "*Alist of regexps matching buttons in ERC buffers. + "Alist of regexps matching buttons in ERC buffers. Each entry has the form (REGEXP BUTTON FORM CALLBACK PAR...), where REGEXP is the string matching text around the button or a symbol @@ -198,12 +198,12 @@ PAR is a number of a regexp grouping whose text will be passed to (integer :tag "Regexp section number"))))) (defcustom erc-emacswiki-url "http://www.emacswiki.org/cgi-bin/wiki.pl?" - "*URL of the EmacsWiki Homepage." + "URL of the EmacsWiki Homepage." :group 'erc-button :type 'string) (defcustom erc-emacswiki-lisp-url "http://www.emacswiki.org/elisp/" - "*URL of the EmacsWiki ELisp area." + "URL of the EmacsWiki ELisp area." :group 'erc-button :type 'string) @@ -488,7 +488,7 @@ For use on `completion-at-point-functions'." ("Query" . (erc-cmd-QUERY nick)) ("Whois" . (erc-cmd-WHOIS nick)) ("Lastlog" . (erc-cmd-LASTLOG nick))) - "*An alist of possible actions to take on a nickname. + "An alist of possible actions to take on a nickname. An entry looks like (\"Action\" . SEXP) where SEXP is evaluated with the variable `nick' bound to the nick in question. diff --git a/lisp/erc/erc-dcc.el b/lisp/erc/erc-dcc.el index f68b3591fbb..ba87cf63993 100644 --- a/lisp/erc/erc-dcc.el +++ b/lisp/erc/erc-dcc.el @@ -75,7 +75,7 @@ IRC users." :group 'erc) (defcustom erc-dcc-verbose nil - "*If non-nil, be verbose about DCC activity reporting." + "If non-nil, be verbose about DCC activity reporting." :group 'erc-dcc :type 'boolean) @@ -316,7 +316,7 @@ Should be set to a string or nil. If nil, use the value of :valid-regexp erc-dcc-ipv4-regexp))) (defcustom erc-dcc-send-request 'ask - "*How to treat incoming DCC Send requests. + "How to treat incoming DCC Send requests. 'ask - Report the Send request, and wait for the user to manually accept it You might want to set `erc-dcc-auto-masks' for this. 'auto - Automatically accept the request and begin downloading the file @@ -405,7 +405,7 @@ the accepted connection." ;;; Interactive command handling (defcustom erc-dcc-get-default-directory nil - "*Default directory for incoming DCC file transfers. + "Default directory for incoming DCC file transfers. If this is nil, then the current value of `default-directory' is used." :group 'erc-dcc :type '(choice (const nil :tag "Default directory") directory)) @@ -719,7 +719,7 @@ match, returns that regexp and nil otherwise." "^DCC CHAT +chat +\\([0-9]+\\) +\\([0-9]+\\)") (defcustom erc-dcc-chat-request 'ask - "*How to treat incoming DCC Chat requests. + "How to treat incoming DCC Chat requests. 'ask - Report the Chat request, and wait for the user to manually accept it 'auto - Automatically accept the request and open a new chat window 'ignore - Ignore incoming DCC chat requests completely." @@ -777,12 +777,12 @@ match, returns that regexp and nil otherwise." ;;; SEND handling (defcustom erc-dcc-block-size 1024 - "*Block size to use for DCC SEND sessions." + "Block size to use for DCC SEND sessions." :group 'erc-dcc :type 'integer) (defcustom erc-dcc-pump-bytes nil - "*If set to an integer, keep sending until that number of bytes are + "If set to an integer, keep sending until that number of bytes are unconfirmed." :group 'erc-dcc :type '(choice (const nil) integer)) @@ -856,7 +856,7 @@ bytes sent." (defcustom erc-dcc-send-connect-hook '(erc-dcc-display-send erc-dcc-send-block) - "*Hook run whenever the remote end of a DCC SEND offer connected to your + "Hook run whenever the remote end of a DCC SEND offer connected to your listening port." :group 'erc-dcc :type 'hook) @@ -1046,12 +1046,12 @@ transfer is complete." ;;; CHAT handling (defcustom erc-dcc-chat-buffer-name-format "DCC-CHAT-%s" - "*Format to use for DCC Chat buffer names." + "Format to use for DCC Chat buffer names." :group 'erc-dcc :type 'string) (defcustom erc-dcc-chat-mode-hook nil - "*Hook calls when `erc-dcc-chat-mode' finished setting up the buffer." + "Hook calls when `erc-dcc-chat-mode' finished setting up the buffer." :group 'erc-dcc :type 'hook) @@ -1100,7 +1100,7 @@ Possible values are: ask, auto, ignore." (defalias 'pcomplete/erc-mode/SREQ 'pcomplete/erc-mode/CREQ) (defvar erc-dcc-chat-filter-hook '(erc-dcc-chat-parse-output) - "*Hook to run after doing parsing (and possible insertion) of DCC messages.") + "Hook to run after doing parsing (and possible insertion) of DCC messages.") (defvar erc-dcc-chat-mode-map (let ((map (make-sparse-keymap))) diff --git a/lisp/erc/erc-goodies.el b/lisp/erc/erc-goodies.el index bf74ed7be87..acff76beb16 100644 --- a/lisp/erc/erc-goodies.el +++ b/lisp/erc/erc-goodies.el @@ -183,7 +183,7 @@ themselves." :group 'erc) (defcustom erc-interpret-controls-p t - "*If non-nil, display IRC colors and other highlighting effects. + "If non-nil, display IRC colors and other highlighting effects. If this is set to the symbol `remove', ERC removes all IRC colors and highlighting effects. When this variable is non-nil, it can cause Emacs to run @@ -196,7 +196,7 @@ emergency (message flood) it can be turned off to save processing time. See (const :tag "Display raw control characters" nil))) (defcustom erc-interpret-mirc-color nil - "*If non-nil, ERC will interpret mIRC color codes." + "If non-nil, ERC will interpret mIRC color codes." :group 'erc-control-characters :type 'boolean) diff --git a/lisp/erc/erc-log.el b/lisp/erc/erc-log.el index 9f50a1d117c..eefe51ae706 100644 --- a/lisp/erc/erc-log.el +++ b/lisp/erc/erc-log.el @@ -101,7 +101,7 @@ :group 'erc) (defcustom erc-generate-log-file-name-function 'erc-generate-log-file-name-long - "*A function to generate a log filename. + "A function to generate a log filename. The function must take five arguments: BUFFER, TARGET, NICK, SERVER and PORT. BUFFER is the buffer to be saved, TARGET is the name of the channel, or the target of the query, @@ -157,12 +157,12 @@ arguments." (const :tag "Disable logging" nil))) (defcustom erc-log-insert-log-on-open nil - "*Insert log file contents into the buffer if a log file exists." + "Insert log file contents into the buffer if a log file exists." :group 'erc-log :type 'boolean) (defcustom erc-save-buffer-on-part t - "*Save the channel buffer content using `erc-save-buffer-in-logs' on PART. + "Save the channel buffer content using `erc-save-buffer-in-logs' on PART. If you set this to nil, you may want to enable both `erc-log-write-after-send' and `erc-log-write-after-insert'." @@ -170,7 +170,7 @@ If you set this to nil, you may want to enable both :type 'boolean) (defcustom erc-save-queries-on-quit t - "*Save all query (also channel) buffers of the server on QUIT. + "Save all query (also channel) buffers of the server on QUIT. If you set this to nil, you may want to enable both `erc-log-write-after-send' and `erc-log-write-after-insert'." @@ -178,7 +178,7 @@ If you set this to nil, you may want to enable both :type 'boolean) (defcustom erc-log-write-after-send nil - "*If non-nil, write to log file after every message you send. + "If non-nil, write to log file after every message you send. If you set this to nil, you may want to enable both `erc-save-buffer-on-part' and `erc-save-queries-on-quit'." @@ -186,7 +186,7 @@ If you set this to nil, you may want to enable both :type 'boolean) (defcustom erc-log-write-after-insert nil - "*If non-nil, write to log file when new text is added to a + "If non-nil, write to log file when new text is added to a logged ERC buffer. If you set this to nil, you may want to enable both @@ -197,14 +197,14 @@ If you set this to nil, you may want to enable both (defcustom erc-log-file-coding-system (if (featurep 'xemacs) 'binary 'emacs-mule) - "*The coding system ERC should use for writing log files. + "The coding system ERC should use for writing log files. This should ideally, be a \"catch-all\" coding system, like `emacs-mule', or `iso-2022-7bit'." :group 'erc-log) (defcustom erc-log-filter-function nil - "*If non-nil, pass text through the given function before writing it to + "If non-nil, pass text through the given function before writing it to a log file. The function should take one argument, which is the text to filter." diff --git a/lisp/erc/erc-match.el b/lisp/erc/erc-match.el index 2a61247307f..dd9e02dfab5 100644 --- a/lisp/erc/erc-match.el +++ b/lisp/erc/erc-match.el @@ -83,7 +83,7 @@ Useful to mark nicks from dangerous hosts." :type '(repeat regexp)) (defcustom erc-current-nick-highlight-type 'keyword - "*Determines how to highlight text in which your current nickname appears + "Determines how to highlight text in which your current nickname appears \(does not apply to text sent by you\). The following values are allowed: @@ -105,7 +105,7 @@ Any other value disables highlighting of current nickname altogether." (const all))) (defcustom erc-pal-highlight-type 'nick - "*Determines how to highlight messages by pals. + "Determines how to highlight messages by pals. See `erc-pals'. The following values are allowed: @@ -121,7 +121,7 @@ Any other value disables pal highlighting altogether." (const all))) (defcustom erc-fool-highlight-type 'nick - "*Determines how to highlight messages by fools. + "Determines how to highlight messages by fools. See `erc-fools'. The following values are allowed: @@ -137,7 +137,7 @@ Any other value disables fool highlighting altogether." (const all))) (defcustom erc-keyword-highlight-type 'keyword - "*Determines how to highlight messages containing keywords. + "Determines how to highlight messages containing keywords. See variable `erc-keywords'. The following values are allowed: @@ -152,7 +152,7 @@ Any other value disables keyword highlighting altogether." (const all))) (defcustom erc-dangerous-host-highlight-type 'nick - "*Determines how to highlight messages by nicks from dangerous-hosts. + "Determines how to highlight messages by nicks from dangerous-hosts. See `erc-dangerous-hosts'. The following values are allowed: diff --git a/lisp/erc/erc-notify.el b/lisp/erc/erc-notify.el index d1a33405765..3bf82c13f19 100644 --- a/lisp/erc/erc-notify.el +++ b/lisp/erc/erc-notify.el @@ -40,19 +40,19 @@ :group 'erc) (defcustom erc-notify-list nil - "*List of nicknames you want to be notified about online/offline + "List of nicknames you want to be notified about online/offline status change." :group 'erc-notify :type '(repeat string)) (defcustom erc-notify-interval 60 - "*Time interval (in seconds) for checking online status of notified + "Time interval (in seconds) for checking online status of notified people." :group 'erc-notify :type 'integer) (defcustom erc-notify-signon-hook nil - "*Hook run after someone on `erc-notify-list' has signed on. + "Hook run after someone on `erc-notify-list' has signed on. Two arguments are passed to the function, SERVER and NICK, both strings." :group 'erc-notify @@ -60,7 +60,7 @@ strings." :options '(erc-notify-signon)) (defcustom erc-notify-signoff-hook nil - "*Hook run after someone on `erc-notify-list' has signed off. + "Hook run after someone on `erc-notify-list' has signed off. Two arguments are passed to the function, SERVER and NICK, both strings." :group 'erc-notify diff --git a/lisp/erc/erc-pcomplete.el b/lisp/erc/erc-pcomplete.el index ba27b0374aa..d3cbe8a5804 100644 --- a/lisp/erc/erc-pcomplete.el +++ b/lisp/erc/erc-pcomplete.el @@ -49,7 +49,7 @@ :group 'erc) (defcustom erc-pcomplete-nick-postfix ":" - "*When `pcomplete' is used in the first word after the prompt, + "When `pcomplete' is used in the first word after the prompt, add this string to nicks completed." :group 'erc-pcomplete :type 'string) diff --git a/lisp/erc/erc-sound.el b/lisp/erc/erc-sound.el index 569abad2a08..8b44cb5146c 100644 --- a/lisp/erc/erc-sound.el +++ b/lisp/erc/erc-sound.el @@ -62,7 +62,7 @@ and play sound files as requested." :group 'erc) (defcustom erc-play-sound t - "*Play sounds when you receive CTCP SOUND requests." + "Play sounds when you receive CTCP SOUND requests." :group 'erc-sound :type 'boolean) diff --git a/lisp/erc/erc-stamp.el b/lisp/erc/erc-stamp.el index e02b045ebd2..4d55e21da72 100644 --- a/lisp/erc/erc-stamp.el +++ b/lisp/erc/erc-stamp.el @@ -47,7 +47,7 @@ in your .emacs file or interactively using `load-library'." :group 'erc) (defcustom erc-timestamp-format "[%H:%M]" - "*If set to a string, messages will be timestamped. + "If set to a string, messages will be timestamped. This string is processed using `format-time-string'. Good examples are \"%T\" and \"%H:%M\". @@ -57,7 +57,7 @@ If nil, timestamping is turned off." (string))) (defcustom erc-timestamp-format-left "\n[%a %b %e %Y]\n" - "*If set to a string, messages will be timestamped. + "If set to a string, messages will be timestamped. This string is processed using `format-time-string'. Good examples are \"%T\" and \"%H:%M\". @@ -71,7 +71,7 @@ If nil, timestamping is turned off." (string))) (defcustom erc-timestamp-format-right " [%H:%M]" - "*If set to a string, messages will be timestamped. + "If set to a string, messages will be timestamped. This string is processed using `format-time-string'. Good examples are \"%T\" and \"%H:%M\". @@ -85,7 +85,7 @@ If nil, timestamping is turned off." (string))) (defcustom erc-insert-timestamp-function 'erc-insert-timestamp-left-and-right - "*Function to use to insert timestamps. + "Function to use to insert timestamps. It takes a single argument STRING which is the final string which all text-properties already appended. This function only cares about @@ -102,7 +102,7 @@ You will probably want to set function)) (defcustom erc-away-timestamp-format "<%H:%M>" - "*Timestamp format used when marked as being away. + "Timestamp format used when marked as being away. If nil, timestamping is turned off when away unless `erc-timestamp-format' is set. @@ -114,7 +114,7 @@ If `erc-timestamp-format' is set, this will not be used." (defcustom erc-insert-away-timestamp-function 'erc-insert-timestamp-left-and-right - "*Function to use to insert the away timestamp. + "Function to use to insert the away timestamp. See `erc-insert-timestamp-function' for details." :group 'erc-stamp @@ -124,7 +124,7 @@ See `erc-insert-timestamp-function' for details." function)) (defcustom erc-hide-timestamps nil - "*If non-nil, timestamps will be invisible. + "If non-nil, timestamps will be invisible. This is useful for logging, because, although timestamps will be hidden, they will still be present in the logs." @@ -132,7 +132,7 @@ hidden, they will still be present in the logs." :type 'boolean) (defcustom erc-echo-timestamps nil - "*If non-nil, print timestamp in the minibuffer when point is moved. + "If non-nil, print timestamp in the minibuffer when point is moved. Using this variable, you can turn off normal timestamping, and simply move point to an irc message to see its timestamp printed in the minibuffer." @@ -140,14 +140,14 @@ printed in the minibuffer." :type 'boolean) (defcustom erc-echo-timestamp-format "Timestamped %A, %H:%M:%S" - "*Format string to be used when `erc-echo-timestamps' is non-nil. + "Format string to be used when `erc-echo-timestamps' is non-nil. This string specifies the format of the timestamp being echoed in the minibuffer." :group 'erc-stamp :type 'string) (defcustom erc-timestamp-intangible t - "*Whether the timestamps should be intangible, i.e. prevent the point + "Whether the timestamps should be intangible, i.e. prevent the point from entering them and instead jump over them." :group 'erc-stamp :type 'boolean) @@ -205,7 +205,7 @@ This is used when `erc-insert-timestamp-function' is set to (make-variable-buffer-local 'erc-timestamp-last-inserted-right) (defcustom erc-timestamp-only-if-changed-flag t - "*Insert timestamp only if its value changed since last insertion. + "Insert timestamp only if its value changed since last insertion. If `erc-insert-timestamp-function' is `erc-insert-timestamp-left', a string of spaces which is the same size as the timestamp is added to the beginning of the line in its place. If you use @@ -215,7 +215,7 @@ timestamp." :type 'boolean) (defcustom erc-timestamp-right-column nil - "*If non-nil, the column at which the timestamp is inserted, + "If non-nil, the column at which the timestamp is inserted, if the timestamp is to be printed to the right. If nil, `erc-insert-timestamp-right' will use other means to determine the correct column." @@ -227,7 +227,7 @@ the correct column." (defcustom erc-timestamp-use-align-to (and (not (featurep 'xemacs)) (>= emacs-major-version 22) (eq window-system 'x)) - "*If non-nil, use the :align-to display property to align the stamp. + "If non-nil, use the :align-to display property to align the stamp. This gives better results when variable-width characters (like Asian language characters and math symbols) precede a timestamp. Unfortunately, it only works in Emacs 22 and when using the X diff --git a/lisp/erc/erc-track.el b/lisp/erc/erc-track.el index ac899302c3c..e4a41089539 100644 --- a/lisp/erc/erc-track.el +++ b/lisp/erc/erc-track.el @@ -93,13 +93,13 @@ Activity means that there was no user input in the last 10 seconds." :type '(repeat string)) (defcustom erc-track-remove-disconnected-buffers nil - "*If true, remove buffers associated with a server that is + "If true, remove buffers associated with a server that is disconnected from `erc-modified-channels-alist'." :group 'erc-track :type 'boolean) (defcustom erc-track-exclude-types '("NICK" "333" "353") - "*List of message types to be ignored. + "List of message types to be ignored. This list could look like '(\"JOIN\" \"PART\"). By default, exclude changes of nicknames (NICK), display of who @@ -109,7 +109,7 @@ channel (353)." :type 'erc-message-type) (defcustom erc-track-exclude-server-buffer nil - "*If true, don't perform tracking on the server buffer; this is + "If true, don't perform tracking on the server buffer; this is useful for excluding all the things like MOTDs from the server and other miscellaneous functions." :group 'erc-track @@ -127,7 +127,7 @@ the mode-line should be reduced to." :type 'number) (defcustom erc-track-shorten-aggressively nil - "*If non-nil, channel names will be shortened more aggressively. + "If non-nil, channel names will be shortened more aggressively. Usually, names are not shortened if this will save only one character. Example: If there are two channels, #linux-de and #linux-fr, then normally these will not be shortened. When shortening aggressively, @@ -150,7 +150,7 @@ This setting is used by `erc-track-shorten-names'." (const :tag "Max" max))) (defcustom erc-track-shorten-function 'erc-track-shorten-names - "*This function will be used to reduce the channel names before display. + "This function will be used to reduce the channel names before display. It takes one argument, CHANNEL-NAMES which is a list of strings. It should return a list of strings of the same number of elements. If nil instead of a function, shortening is disabled." @@ -169,7 +169,7 @@ notification of channel activity." :type 'hook) (defcustom erc-track-use-faces t - "*Use faces in the mode-line. + "Use faces in the mode-line. The faces used are the same as used for text in the buffers. \(e.g. `erc-pal-face' is used if a pal sent a message to that channel.)" :group 'erc-track diff --git a/lisp/erc/erc-truncate.el b/lisp/erc/erc-truncate.el index 6aa4e718d0a..dd47c601ea8 100644 --- a/lisp/erc/erc-truncate.el +++ b/lisp/erc/erc-truncate.el @@ -36,7 +36,7 @@ :group 'erc) (defcustom erc-max-buffer-size 30000 - "*Maximum size in chars of each ERC buffer. + "Maximum size in chars of each ERC buffer. Used only when auto-truncation is enabled. \(see `erc-truncate-buffer' and `erc-insert-post-hook')." :group 'erc-truncate diff --git a/lisp/erc/erc-xdcc.el b/lisp/erc/erc-xdcc.el index 98e26dd9af0..0328c407aa0 100644 --- a/lisp/erc/erc-xdcc.el +++ b/lisp/erc/erc-xdcc.el @@ -29,13 +29,13 @@ (require 'erc-dcc) (defcustom erc-xdcc-files nil - "*List of files to offer via XDCC. + "List of files to offer via XDCC. Your friends should issue \"/ctcp yournick XDCC list\" to see this." :group 'erc-dcc :type '(repeat file)) (defcustom erc-xdcc-verbose-flag t - "*Report XDCC CTCP requests in the server buffer." + "Report XDCC CTCP requests in the server buffer." :group 'erc-dcc :type 'boolean) @@ -43,7 +43,7 @@ Your friends should issue \"/ctcp yournick XDCC list\" to see this." '(("help" . erc-xdcc-help) ("list" . erc-xdcc-list) ("send" . erc-xdcc-send)) - "*Sub-command handler alist for XDCC CTCP queries." + "Sub-command handler alist for XDCC CTCP queries." :group 'erc-dcc :type '(alist :key-type (string :tag "Sub-command") :value-type function)) @@ -54,7 +54,7 @@ Your friends should issue \"/ctcp yournick XDCC list\" to see this." ("Type \"/ctcp " (erc-current-nick) " XDCC list\" to see the list of offered files, then type \"/ctcp " (erc-current-nick) " XDCC send #\" to get a particular file number.")) - "*Help text sent in response to XDCC help command. + "Help text sent in response to XDCC help command. A list of messages, each consisting of strings and expressions, expressions being evaluated and should return strings." :group 'erc-dcc diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index 63777fb3897..62b701204d1 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -255,7 +255,7 @@ If nil, only \"> \" will be shown." (repeat :inline t :tag "Others" (string :tag "IRC Message Type")))) (defcustom erc-hide-list nil - "*List of IRC type messages to hide. + "List of IRC type messages to hide. A typical value would be '(\"JOIN\" \"PART\" \"QUIT\")." :group 'erc-ignore :type 'erc-message-type) @@ -653,12 +653,12 @@ This only has any meaning if the variable `erc-command-indicator' is non-nil." prompt)))) (defcustom erc-notice-prefix "*** " - "*Prefix for all notices." + "Prefix for all notices." :group 'erc-display :type 'string) (defcustom erc-notice-highlight-type 'all - "*Determines how to highlight notices. + "Determines how to highlight notices. See `erc-notice-prefix'. The following values are allowed: @@ -673,7 +673,7 @@ Any other value disables notice's highlighting altogether." (const :tag "don't highlight notices at all" nil))) (defcustom erc-echo-notice-hook nil - "*Specifies a list of functions to call to echo a private + "Specifies a list of functions to call to echo a private notice. Each function is called with four arguments, the string to display, the parsed server message, the target buffer (or nil), and the sender. The functions are called in order, until a @@ -704,7 +704,7 @@ See also: `erc-echo-notice-always-hook', (defcustom erc-echo-notice-always-hook '(erc-echo-notice-in-default-buffer) - "*Specifies a list of functions to call to echo a private + "Specifies a list of functions to call to echo a private notice. Each function is called with four arguments, the string to display, the parsed server message, the target buffer (or nil), and the sender. The functions are called in order, and all @@ -736,17 +736,17 @@ See also: `erc-echo-notice-hook', ;; other tunable parameters (defcustom erc-whowas-on-nosuchnick nil - "*If non-nil, do a whowas on a nick if no such nick." + "If non-nil, do a whowas on a nick if no such nick." :group 'erc :type 'boolean) (defcustom erc-verbose-server-ping nil - "*If non-nil, show every time you get a PING or PONG from the server." + "If non-nil, show every time you get a PING or PONG from the server." :group 'erc-paranoia :type 'boolean) (defcustom erc-public-away-p nil - "*Let others know you are back when you are no longer marked away. + "Let others know you are back when you are no longer marked away. This happens in this form: * is back (gone for