]> code.delx.au - gnu-emacs/blobdiff - lisp/play/fortune.el
Merge from emacs--rel--22
[gnu-emacs] / lisp / play / fortune.el
index 4977ff8274fc2da72cf05b22211feeec9aeab80b..7e0bdc27068bcb89776eff219d966f9849cbe8a1 100644 (file)
@@ -1,14 +1,16 @@
-;;; fortune.el --- Use fortune to create signatures
-;; Copyright (C) 1999, 2001 Free Software Foundation, Inc.
+;;; fortune.el --- use fortune to create signatures
+
+;; Copyright (C) 1999, 2001, 2002, 2003, 2004,
+;;   2005, 2006, 2007 Free Software Foundation, Inc.
 
 ;; Author: Holger Schauer <Holger.Schauer@gmx.de>
 ;; Keywords: games utils mail
 
-;; This file is part of Emacs.
+;; This file is part of GNU Emacs.
 
 ;; GNU Emacs is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
+;; the Free Software Foundation; either version 3, or (at your option)
 ;; any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
@@ -18,8 +20,8 @@
 
 ;; You should have received a copy of the GNU General Public License
 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
 
 ;;; Commentary:
 ;; This utility allows you to automatically cut regions to a fortune
@@ -33,8 +35,8 @@
 
 ;;; Installation:
 
-;; Please check the customize settings - you will at least have to modify the
-;; values of `fortune-dir' and `fortune-file'.
+;; Please check the customize settings -- you will at least have to
+;; modify the values of `fortune-dir' and `fortune-file'.
 
 ;; I then use this in my .gnus:
 ;;(message "Making new signature: %s" (fortune-to-signature "~/fortunes/"))
@@ -44,9 +46,7 @@
 
 ;; If you like to get a new signature for every message, you can also hook
 ;; it into message-mode:
-;; (add-hook 'message-setup-hook
-;;           '(lambda ()
-;;              (fortune-to-signature)))
+;; (add-hook 'message-setup-hook 'fortune-to-signature)
 ;; This time no fortune-file is specified, so fortune-to-signature would use
 ;; the default-file as specified by fortune-file.
 
@@ -63,9 +63,9 @@
 ;;; Customizable Settings
 (defgroup fortune nil
   "Settings for fortune."
+  :link '(emacs-commentary-link "fortune.el")
   :version "21.1"
   :group 'games)
-
 (defgroup fortune-signature nil
   "Settings for use of fortune for signatures."
   :group 'fortune
 
 (defcustom fortune-dir "~/docs/ascii/misc/fortunes/"
   "*The directory to look in for local fortune cookies files."
-  :group 'fortune
-  :type 'directory)
-
-(defcustom fortune-file (expand-file-name "usenet" fortune-dir)
+  :type 'directory
+  :group 'fortune)
+(defcustom fortune-file
+  (expand-file-name "usenet" fortune-dir)
   "*The file in which local fortune cookies will be stored."
-  :group 'fortune
-  :type 'file)
-
+  :type 'file
+  :group 'fortune)
 (defcustom fortune-database-extension  ".dat"
   "The extension of the corresponding fortune database.
 Normally you won't have a reason to change it."
-  :group 'fortune
-  :type 'string)
-
+  :type 'string
+  :group 'fortune)
 (defcustom fortune-program "fortune"
   "Program to select a fortune cookie."
-  :group 'fortune
-  :type 'file)
-
+  :type 'string
+  :group 'fortune)
 (defcustom fortune-program-options ""
-  "Options to pass to the fortune program."
-  :group 'fortune
-  :type 'string)
-
+  "Options to pass to the fortune program (a string)."
+  :type 'string
+  :group 'fortune)
 (defcustom fortune-strfile "strfile"
   "Program to compute a new fortune database."
-  :group 'fortune
-  :type 'file)
-
+  :type 'string
+  :group 'fortune)
 (defcustom fortune-strfile-options ""
-  "Options to pass to the strfile program."
-  :group 'fortune
-  :type 'string)
-
+  "Options to pass to the strfile program (a string)."
+  :type 'string
+  :group 'fortune)
 (defcustom fortune-quiet-strfile-options "> /dev/null"
   "Text added to the command for running `strfile'.
 By default it discards the output produced by `strfile'.
 Set this to \"\" if you would like to see the output."
-  :group 'fortune
-  :type 'string)
+  :type 'string
+  :group 'fortune)
 
 (defcustom fortune-always-compile t
   "*Non-nil means automatically compile fortune files.
 If nil, you must invoke `fortune-compile' manually to do that."
-  :group 'fortune
-  :type 'boolean)
-
+  :type 'boolean
+  :group 'fortune)
 (defcustom fortune-author-line-prefix "                  -- "
   "Prefix to put before the author name of a fortunate."
-  :group 'fortune-signature
-  :type 'string)
-
+  :type 'string
+  :group 'fortune-signature)
 (defcustom fortune-fill-column fill-column
   "Fill column for fortune files."
-  :group 'fortune-signature
-  :type 'integer)
-
+  :type 'integer
+  :group 'fortune-signature)
 (defcustom fortune-from-mail "private e-mail"
   "String to use to characterize that the fortune comes from an e-mail.
 No need to add an `in'."
   :type 'string
   :group 'fortune-signature)
-
 (defcustom fortune-sigstart ""
   "*Some text to insert before the fortune cookie, in a mail signature."
-  :group 'fortune-signature
-  :type 'string)
-
+  :type 'string
+  :group 'fortune-signature)
 (defcustom fortune-sigend ""
   "*Some text to insert after the fortune cookie, in a mail signature."
-  :group 'fortune-signature
-  :type 'string)
+  :type 'string
+  :group 'fortune-signature)
 
 
 ;; not customizable settings
@@ -265,8 +254,8 @@ the value of `fortune-file'.  This currently cannot handle directories."
                     (concat fortune-strfile fortune-strfile-options
                             " " fortune-file fortune-quiet-strfile-options))))))
        (t (error "Can't compile fortune file %s" fortune-file)))))
-  
-        
+
+
 ;;; **************
 ;;; Use fortune for signature
 ;;;###autoload
@@ -283,7 +272,7 @@ and choose the directory as the fortune-file."
         (fortune-ask-file)
        fortune-file)))
    (save-excursion
-    (fortune-in-buffer (interactive-p) file)
+    (fortune-in-buffer t file)
     (set-buffer fortune-buffer-name)
     (let* ((fortune (buffer-string))
           (signature (concat fortune-sigstart fortune fortune-sigend)))
@@ -297,7 +286,7 @@ and choose the directory as the fortune-file."
 (defun fortune-in-buffer (interactive &optional file)
   "Put a fortune cookie in the *fortune* buffer.
 
-When INTERACTIVE is nil, don't display it.  Optional argument FILE,
+INTERACTIVE is ignored.  Optional argument FILE,
 when supplied, specifies the file to choose the fortune from."
   (let ((fortune-buffer (or (get-buffer fortune-buffer-name)
                            (generate-new-buffer fortune-buffer-name)))
@@ -339,5 +328,5 @@ and choose the directory as the fortune-file."
 ;;; Provide ourselves.
 (provide 'fortune)
 
+;;; arch-tag: a1e4cb8a-3792-40e7-86a7-fc75ce094bcc
 ;;; fortune.el ends here
-