NOTE: This is an add-on module for Riece.
-;;; riece-alias.el --- define aliases of names
+;;; riece-alias.el --- define aliases for IRC names
;; Copyright (C) 1998-2003 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
-;; This add-on allows you to define aliases for IRC names.
+;;; Commentary:
+
+;; NOTE: This is an add-on module for Riece.
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-alias)
+;; This add-on allows you to define aliases for IRC names.
-;; For example, if you want to define an alias `#l' for `#Liece', you
+;; For example, if you want to define an alias `#r' for `#riece', you
;; can customize riece-alias-alist as follows:
-;; (setq riece-alias-alist '(("#Liece" . "#l")))
+;; (setq riece-alias-alist '(("#riece" . "#r")))
;;; Code:
(defvar riece-alias-enabled nil)
(defconst riece-alias-description
- "Define aliases of channel/user names")
+ "Define aliases for IRC names.")
(defun riece-alias-abbrev-percent-hack (string)
(if (string-match (concat "^#\\([^ ]+\\):"
;;; Commentary:
+;; NOTE: This is an add-on module for Riece.
+
;; This program allows to connect to an IRC server via local proxy
;; which responds to PING requests from server.
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-async)
-
;; If you want to enable this feature per server, write the server
;; spec like this:
;; (add-to-list 'riece-server-alist
"Command line arguments passed to `riece-async-server-program'.")
(defconst riece-async-description
- "Keep IRC connection with external process")
+ "Connect to IRC server via async proxy.")
;;;###autoload
(defun riece-async-open-network-stream (name buffer host service)
-;;; riece-biff.el --- biff add-on
+;;; riece-biff.el --- be notified if messages arrives
;; Copyright (C) 2004 OHASHI Akira
;; Author: OHASHI Akira <bg66@koka-in.org>
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-biff)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(require 'riece-message)
(defgroup riece-biff nil
- "Biff for new arrival messages."
+ "Be notified if messages arrives."
:prefix "riece-"
:group 'riece)
(defvar riece-biff-enabled nil)
(defconst riece-biff-description
- "Biff for new arrival messages")
+ "Be notified if messages arrives.")
(defun riece-biff-after-display-message-function (message)
(when (and riece-biff-enabled
-;;; riece-button.el --- adding buttons in channel buffers
+;;; riece-button.el --- display useful buttons in IRC buffers
;; Copyright (C) 1998-2003 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-button)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(defvar riece-button-enabled nil)
(defconst riece-button-description
- "Display useful buttons in IRC buffers")
+ "Display useful buttons in IRC buffers.")
(defvar help-echo-owns-message)
(define-widget 'riece-identity-button 'push-button
-;;; riece-ctcp.el --- CTCP add-on
+;;; riece-ctcp.el --- CTCP (Client To Client Protocol) support
;; Copyright (C) 1998-2003 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
+;;; Commentary:
+
+;; NOTE: This is an add-on module for Riece.
+
;;; Code:
(require 'riece-version)
(defvar riece-ctcp-enabled nil)
(defconst riece-ctcp-description
- "CTCP (Client To Client Protocol) support")
+ "CTCP (Client To Client Protocol) support.")
(defun riece-handle-ctcp-request (prefix string)
(when (and riece-ctcp-enabled prefix string
-;;; riece-ctlseq.el --- highlight control sequences in channel buffers
+;;; riece-ctlseq.el --- mark up control sequences in IRC buffers
;; Copyright (C) 1998-2004 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-ctlseq)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(require 'riece-misc)
(defgroup riece-ctlseq nil
- "Control sequences in IRC buffer."
+ "Mark up control sequences in IRC buffer."
:prefix "riece-"
:group 'riece)
(defvar riece-ctlseq-enabled nil)
(defvar riece-ctlseq-description
- "Highlight control sequences in IRC buffers")
+ "Mark up control sequences in IRC buffers.")
(defun riece-ctlseq-compatible-attributes-p (this other)
(let ((pointer this))
-;;; riece-doctor.el --- "become a psychotherapist" add-on
+;;; riece-doctor.el --- pretend to be a psychotherapist
;; Copyright (C) 1998-2003 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
-;; This add-on allows you to become a psychotherapist.
-
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-doctor)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(defvar riece-doctor-enabled nil)
(defconst riece-doctor-description
- "Allow users in channel to talk with the classic pseudo-AI")
+ "Pretend to be a psychotherapist.")
(put 'riece-doctor 'riece-addon-default-disabled t)
-;;; riece-eval-ruby.el --- evaluate Ruby programs in channels
+;;; riece-eval-ruby.el --- evaluate input string as a Ruby program
;; Copyright (C) 1998-2005 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-eval-ruby)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(require 'riece-message)
(defgroup riece-eval-ruby nil
- "Evaluate Ruby programs in channels."
+ "Evaluate input string as a Ruby program."
:prefix "riece-"
:group 'riece)
(defvar riece-eval-ruby-enabled nil)
(defconst riece-eval-ruby-description
- "Evaluate an input string as Ruby program.")
+ "Evaluate input string as a Ruby program.")
(defun riece-eval-ruby-exit-handler (name)
(riece-ruby-inspect name)
-;;; riece-eval.el --- eval add-on
+;;; riece-eval.el --- evaluate input string as an elisp form
;; Copyright (C) 2005 OHASHI Akira
;; Author: OHASHI Akira <bg66@koka-in.org>
;;; Commentary:
-;; This add-on evaluates an input string as lisp object and sends a result
-;; as notice. Note the risky of this add-on.
-
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-eval)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(require 'riece-message)
(defgroup riece-eval nil
- "Evaluate an input string as lisp object."
+ "Evaluate an input string as an elisp form."
:prefix "riece-"
:group 'riece)
(defvar riece-eval-enabled nil)
(defconst riece-eval-description
- "Evaluate an input string as lisp object.")
+ "Evaluate an input string as an elisp form.")
(defun riece-eval-display-message-function (message)
(when (and riece-eval-enabled
;;; Commentary:
-;; This add-on channel miss hold in check
-
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-foolproof)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
-;;; riece-google.el --- Interface to Google API
+;;; riece-google.el --- search keywords by Google
;; Copyright (C) 2005 OHASHI Akira
;; Author: OHASHI Akira <bg66@koka-in.org>
;;; Commentary:
-;; This add-on searches keywords by Google.
+;; NOTE: This is an add-on module for Riece.
;; Ruby code was stolen (and modified) from nadoka.
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-google)
-
;;; Code:
(require 'riece-message)
(defgroup riece-google nil
- "Interface to Google API."
+ "Search keywords by Google."
:prefix "riece-"
:group 'riece)
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
+;;; Commentary:
+
+;; NOTE: This is an add-on module for Riece.
+
;;; Code:
(require 'riece-identity)
(require 'riece-commands)
(defgroup riece-guess nil
- "Guess the next channel to be switched."
+ "Guess the next channel."
:tag "Guess"
:prefix "riece-"
:group 'riece)
(defvar riece-guess-enabled nil)
(defconst riece-guess-description
- "Guess the next channel, using multiple methods")
+ "Guess the next channel, using multiple methods.")
(defvar riece-current-channels)
-;;; riece-hangman.el --- hangman
+;;; riece-hangman.el --- allow channel members to play the hangman game
;; Copyright (C) 1998-2004 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-hangman)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(require 'riece-server)
(defgroup riece-hangman nil
- "Interface to hangman.el."
+ "Allow channel members to play the hangman game."
:prefix "riece-"
:group 'riece)
(defvar riece-hangman-enabled nil)
(defconst riece-hangman-description
- "Allow users in channel to play classic textual game \"hangman\"")
+ "Allow channel members to play the hangman game.")
(put 'riece-hangman 'riece-addon-default-disabled t)
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
+;;; Commentary:
+
+;; NOTE: This is an add-on module for Riece.
+
;;; Code:
(require 'riece-globals)
(defvar riece-highlight-enabled nil)
(defconst riece-highlight-description
- "Highlight IRC buffers")
+ "Highlight IRC buffers.")
(defun riece-highlight-server-match (limit)
(and (re-search-forward "(from [^)]+)$" limit t)
-;;; riece-history.el --- channel history management add-on
+;;; riece-history.el --- manage history of channel shifting
;; Copyright (C) 1998-2003 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
+;; NOTE: This is an add-on module for Riece.
+
;; You can check recently visited channels via `C-c g' in the commands
;; buffer, by adding the following lines to ~/.riece/init.el:
(require 'ring)
(defgroup riece-history nil
- "Channel switch history."
+ "Manage history of channel shifting."
:tag "History"
:prefix "riece-"
:group 'riece)
(defvar riece-history-enabled nil)
(defconst riece-history-description
- "Keep track channel history")
+ "Manage history of channel shifting.")
(defun riece-guess-channel-from-history ()
(let ((length (ring-length riece-channel-history))
-;;; riece-icon.el --- iconify buffer strings
-;; Copyright (C) 1'center8-2003 Daiki Ueno
+;;; riece-icon.el --- display icons in IRC buffers
+;; Copyright (C) 1998-2003 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
-;; Created: 1'center8-09-28
+;; Created: 1998-09-28
;; Keywords: IRC, riece
;; This file is part of Riece.
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-icon)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(defvar riece-icon-enabled nil)
(defconst riece-icon-description
- "Add icon images on IRC buffers")
+ "Display icons in IRC buffers.")
(defun riece-icon-available-p ()
(if (featurep 'xemacs)
-;;; riece-ignore.el --- ignore user
+;;; riece-ignore.el --- ignore messages from some users
;; Copyright (C) 1998-2004 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-ignore)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(require 'riece-message)
(defgroup riece-ignore nil
- "Ignore messages in IRC buffers."
+ "Ignore messages from some users."
:prefix "riece-"
:group 'riece)
(defvar riece-ignore-enabled nil)
(defconst riece-ignore-description
- "Ignore users")
+ "Ignore messages from some users.")
(defvar riece-ignored-user-list nil)
(defun riece-ignore-user-rename-signal-function (signal handback)
-;;; riece-kakasi.el --- convert Japanese to roman string by kakasi
+;;; riece-kakasi.el --- convert Japanese to roman string by KAKASI
;; Copyright (C) 1998-2004 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-kakasi)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(defvar riece-kakasi-enabled nil)
(defvar riece-kakasi-description
- "Convert Japanese to roman string by kakasi")
+ "Convert Japanese to roman string by KAKASI.")
(defvar riece-kakasi-process nil)
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-keepalive)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
-;;; riece-keyword.el --- highlight keywords in channel buffers
+;;; riece-keyword.el --- detect keywords in IRC buffers
;; Copyright (C) 1998-2003 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-keyword)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(require 'riece-message)
(defgroup riece-keyword nil
- "Highlight keyword in IRC buffer."
+ "Detect keywords in IRC buffers."
:prefix "riece-"
:group 'riece)
(defvar riece-keyword-enabled nil)
(defconst riece-keyword-description
- "Highlight keywords in IRC buffers")
+ "Detect keywords in IRC buffers.")
;;; The old XEmacs package doesn't have autoload setting for regexp-opt.
(autoload 'regexp-opt "regexp-opt")
-;;; riece-log.el --- saving irc logs add-on
+;;; riece-log.el --- Save IRC logs
;; Copyright (C) 2003 OHASHI Akira
;; Copyright (C) 2004 Daiki Ueno
;;; Commentary:
-;; This add-on saves irc logs for every channel.
-
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-log)
+;;; NOTE: This is an add-on module for Riece.
;;; Code:
(defvar riece-log-enabled nil)
(defconst riece-log-description
- "Saving IRC logs")
+ "Save IRC logs.")
(defun riece-log-display-message-function (message)
(if riece-log-enabled
-;;; riece-lsdb.el --- interface to LSDB
+;;; riece-lsdb.el --- help register nicknames in LSDB rolodex program
;; Copyright (C) 1998-2003 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-lsdb)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(defvar riece-lsdb-enabled nil)
(defconst riece-lsdb-description
- "Use LSDB (Lovely Sister Database)")
+ "Help register nicknames in LSDB rolodex program.")
(defun riece-lsdb-update-cache (record)
(let ((irc (cdr (assq 'irc record))))
-;;; riece-menu.el --- define command menu on menubar
+;;; riece-menu.el --- setup Riece's command menus
;; Copyright (C) 1998-2003 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-menu)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
"Menu used in command mode.")
(defconst riece-menu-description
- "Setup command menus on menubar")
+ "Setup Riece's command menus.")
(defun riece-menu-create-layouts-menu (menu)
(mapcar (lambda (entry)
-;;; riece-mini.el --- "riece on minibuffer" add-on
+;;; riece-mini.el --- use Riece only on the minibuffer
;; Copyright (C) 2003 OHASHI Akira
;; Author: OHASHI Akira <bg66@koka-in.org>
;;; Commentary:
+;; NOTE: This is an add-on module for Riece.
+
;; This add-on shows arrival messages to minibuffer. And you can send
;; message using minibuffer.
;;
(require 'riece-biff)
(defgroup riece-mini nil
- "Riece on minibuffer."
+ "Use Riece only on the minibuffer."
:group 'riece)
(defcustom riece-mini-backlog-size 5
(defvar riece-mini-enabled nil)
(defconst riece-mini-description
- "Send arrival messages to minibuffer")
+ "Use Riece only on the minibuffer.")
(defun riece-mini-message-no-log (string &rest args)
"Like `message', except that message logging is disabled."
-;;; riece-rdcc.el --- Ruby implementation of DCC add-on
+;;; riece-rdcc.el --- DCC file sending protocol support (written in Ruby)
;; Copyright (C) 1998-2003 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
+;;; Commentary:
+
+;; NOTE: This is an add-on module for Riece.
+
;;; Code:
(require 'riece-globals)
(defvar riece-rdcc-enabled nil)
(defconst riece-rdcc-description
- "DCC file sending extension implemented in Ruby")
+ "DCC file sending protocol support (written in Ruby.)")
(defvar temporary-file-directory)
(defvar jka-compr-compression-info-list)
-;;; riece-skk-kakutei.el --- add-on skk-kakutei
+;;; riece-skk-kakutei.el --- remove SKK's preedit mark before sending messages
;; Copyright (C) 2003 TAKAHASHI Kaoru
;; Author: TAKAHASHI "beatmaria" Kaoru <kaoru@kaisei.org>
;;; Commentary:
-;; This add-on deny SKK's sankaku send.
-
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-skk-kakutei)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(defvar riece-skk-kakutei-enabled nil)
(defconst riece-skk-kakutei-description
- "Deny SKK's sankaku send")
+ "Remove SKK's preedit mark before sending messages.")
(defun riece-skk-kakutei-command-enter-message ()
"Send the current line to the current channel."
-;;; riece-toolbar.el --- show toolbar icons
+;;; riece-toolbar.el --- display toolbar icons
;; Copyright (C) 1998-2004 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-toolbar)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(require 'riece-menu)
(defconst riece-toolbar-description
- "Show toolbar icons.")
+ "Display toolbar icons.")
(defvar riece-toolbar-items
'(riece-command-quit
-;;; riece-unread.el --- "unread message mark" add-on
+;;; riece-unread.el --- mark channels where new messages arrived
;; Copyright (C) 1998-2003 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
-;; This add-on marks channels where new messages are arrived.
+;; NOTE: This is an add-on module for Riece.
+
+;; This add-on marks channels where new messages arrived.
;; You can check the unread channels via `C-c g' in the commands
;; buffer, by adding the following lines to ~/.riece/init.el:
(defvar riece-unread-enabled nil)
(defconst riece-unread-description
- "Mark channels where \"unread\" messages arrived")
+ "Mark channels where new messages arrived.")
(defun riece-unread-after-display-message-function (message)
(if riece-unread-enabled
-;;; riece-url.el --- URL collector add-on
+;;; riece-url.el --- collect URL in IRC buffers
;; Copyright (C) 1998-2003 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-url)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(defvar riece-url-enabled nil)
(defconst riece-url-description
- "Collect URL in IRC buffers")
+ "Collect URL in IRC buffers.")
(autoload 'widget-convert-button "wid-edit")
-;;; riece-xface.el --- display X-Face in user list buffer
+;;; riece-xface.el --- display X-Face in IRC buffers
;; Copyright (C) 1998-2003 Daiki Ueno
;; Author: Daiki Ueno <ueno@unixuser.org>
;;; Commentary:
-;; To use, add the following line to your ~/.riece/init.el:
-;; (add-to-list 'riece-addons 'riece-xface)
+;; NOTE: This is an add-on module for Riece.
;;; Code:
(defvar riece-xface-enabled nil)
(defconst riece-xface-description
- "Display X-Face in user list buffer")
+ "Display X-Face in IRC buffers.")
(defvar lsdb-insert-x-face-function)
-;;; riece-yank.el --- enter the element in kill-ring
+;;; riece-yank.el --- enter the element of kill-ring
;; Copyright (C) 2004 Masatake YAMATO
;; Author: Masatake YAMATO <jet@gyve.org>
;; Boston, MA 02111-1307, USA.
;;; Commentary:
-;;
-;; In riece's command buffer, you can send the top element of kill-ring
-;; by C-c y.
-;; Don't forget do (riece-command-enable-addon 'riece-yank) to test.
-;;
+
+;; NOTE: This is an add-on module for Riece.
+
;;; Code:
(require 'riece-commands)
(defgroup riece-yank nil
- "Enter the element of `kill-ring'."
+ "Enter the element of kill-ring."
:tag "Yank"
:prefix "riece-"
:group 'riece)
:type 'boolean
:group 'riece-yank)
+(defvar riece-yank-description
+ "Enter the element of kill-ring.")
+
(defvar riece-yank-enabled nil)
(defun riece-yank-insinuate ()