diff options
| author | Chong Yidong <cyd@gnu.org> | 2012-04-09 21:05:48 +0800 |
|---|---|---|
| committer | Chong Yidong <cyd@gnu.org> | 2012-04-09 21:05:48 +0800 |
| commit | fb7ada5f94a71d73bf6cfad5cc87fe7fb26125a5 (patch) | |
| tree | eba43d1fa2427a77f1f6b1468838426b33ea5973 /lisp/erc | |
| parent | a18ecafa99e7e7c3caa35ed68dd8a7b9b5d2b8e3 (diff) | |
| download | emacs-fb7ada5f94a71d73bf6cfad5cc87fe7fb26125a5.tar.gz | |
Remove * characters from the front of variable docstrings.
Diffstat (limited to 'lisp/erc')
| -rw-r--r-- | lisp/erc/erc-autoaway.el | 12 | ||||
| -rw-r--r-- | lisp/erc/erc-backend.el | 12 | ||||
| -rw-r--r-- | lisp/erc/erc-button.el | 12 | ||||
| -rw-r--r-- | lisp/erc/erc-dcc.el | 20 | ||||
| -rw-r--r-- | lisp/erc/erc-goodies.el | 4 | ||||
| -rw-r--r-- | lisp/erc/erc-log.el | 16 | ||||
| -rw-r--r-- | lisp/erc/erc-match.el | 10 | ||||
| -rw-r--r-- | lisp/erc/erc-notify.el | 8 | ||||
| -rw-r--r-- | lisp/erc/erc-pcomplete.el | 2 | ||||
| -rw-r--r-- | lisp/erc/erc-sound.el | 2 | ||||
| -rw-r--r-- | lisp/erc/erc-stamp.el | 26 | ||||
| -rw-r--r-- | lisp/erc/erc-track.el | 12 | ||||
| -rw-r--r-- | lisp/erc/erc-truncate.el | 2 | ||||
| -rw-r--r-- | lisp/erc/erc-xdcc.el | 8 | ||||
| -rw-r--r-- | lisp/erc/erc.el | 48 |
15 files changed, 97 insertions, 97 deletions
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: * <nick> is back (gone for <time>) @@ -755,7 +755,7 @@ Many consider it impolite to do so automatically." :type 'boolean) (defcustom erc-away-nickname nil - "*The nickname to take when you are marked as being away." + "The nickname to take when you are marked as being away." :group 'erc :type '(choice (const nil) string)) @@ -796,7 +796,7 @@ If nil, ERC will call `system-name' to get this information." string)) (defcustom erc-ignore-list nil - "*List of regexps matching user identifiers to ignore. + "List of regexps matching user identifiers to ignore. A user identifier has the form \"nick!login@host\". If an identifier matches, the message from the person will not be @@ -806,7 +806,7 @@ processed." (make-variable-buffer-local 'erc-ignore-list) (defcustom erc-ignore-reply-list nil - "*List of regexps matching user identifiers to ignore completely. + "List of regexps matching user identifiers to ignore completely. This differs from `erc-ignore-list' in that it also ignores any messages directed at the user. @@ -824,7 +824,7 @@ people. You can update the ERC internal info using /WHO *." :type '(repeat regexp)) (defvar erc-flood-protect t - "*If non-nil, flood protection is enabled. + "If non-nil, flood protection is enabled. Flooding is sending too much information to the server in too short of an interval, which may cause the server to terminate the connection. @@ -854,7 +854,7 @@ directory in the list." :type '(repeat directory)) (defcustom erc-script-echo t - "*If non-nil, echo the IRC script commands locally." + "If non-nil, echo the IRC script commands locally." :group 'erc-scripts :type 'boolean) @@ -929,7 +929,7 @@ will be used as the part message." :type '(repeat (list regexp (choice (string) (function))))) (defcustom erc-quit-reason 'erc-quit-reason-normal - "*A function which returns the reason for quitting. + "A function which returns the reason for quitting. The function is passed a single argument, the string typed by the user after \"/quit\"." @@ -1480,7 +1480,7 @@ The available choices are: (const :tag "Use current buffer" t))) (defcustom erc-frame-alist nil - "*Alist of frame parameters for creating erc frames. + "Alist of frame parameters for creating erc frames. A value of nil means to use `default-frame-alist'." :group 'erc-buffers :type '(repeat (cons :format "%v" @@ -1488,13 +1488,13 @@ A value of nil means to use `default-frame-alist'." (sexp :tag "Value")))) (defcustom erc-frame-dedicated-flag nil - "*Non-nil means the erc frames are dedicated to that buffer. + "Non-nil means the erc frames are dedicated to that buffer. This only has effect when `erc-join-buffer' is set to `frame'." :group 'erc-buffers :type 'boolean) (defcustom erc-reuse-frames t - "*Determines whether new frames are always created. + "Determines whether new frames are always created. Non-nil means that a new frame is not created to display an ERC buffer if there is already a window displaying it. This only has effect when `erc-join-buffer' is set to `frame'." @@ -1511,7 +1511,7 @@ effect when `erc-join-buffer' is set to `frame'." (t nil))) (defcustom erc-reuse-buffers t - "*If nil, create new buffers on joining a channel/query. + "If nil, create new buffers on joining a channel/query. If non-nil, a new buffer will only be created when you join channels with same names on different servers, or have query buffers open with nicks of the same name on different servers. Otherwise, @@ -3799,7 +3799,7 @@ This places `point' just after the prompt, or at the beginning of the line." (defcustom erc-default-server-hook '(erc-debug-missing-hooks erc-default-server-handler) - "*Default for server messages which aren't covered by `erc-server-hooks'." + "Default for server messages which aren't covered by `erc-server-hooks'." :group 'erc-server-hooks :type 'hook) @@ -4017,7 +4017,7 @@ and as second argument the event parsed as a vector." str)) (defcustom erc-format-nick-function 'erc-format-nick - "*Function to format a nickname for message display." + "Function to format a nickname for message display." :group 'erc-display :type 'function) @@ -4575,7 +4575,7 @@ channel." (run-hooks 'erc-channel-members-changed-hook))) (defcustom erc-channel-members-changed-hook nil - "*This hook is called every time the variable `channel-members' changes. + "This hook is called every time the variable `channel-members' changes. The buffer where the change happened is current while this hook is called." :group 'erc-hooks :type 'hook) @@ -6386,17 +6386,17 @@ See also `format-spec'." (add-hook 'kill-buffer-hook 'erc-kill-buffer-function) (defcustom erc-kill-server-hook '(erc-kill-server) - "*Invoked whenever a server-buffer is killed via `kill-buffer'." + "Invoked whenever a server-buffer is killed via `kill-buffer'." :group 'erc-hooks :type 'hook) (defcustom erc-kill-channel-hook '(erc-kill-channel) - "*Invoked whenever a channel-buffer is killed via `kill-buffer'." + "Invoked whenever a channel-buffer is killed via `kill-buffer'." :group 'erc-hooks :type 'hook) (defcustom erc-kill-buffer-hook nil - "*Hook run whenever a non-server or channel buffer is killed. + "Hook run whenever a non-server or channel buffer is killed. See also `kill-buffer'." :group 'erc-hooks |
