Fix up comment convention on the arch-tag lines.
[bpt/emacs.git] / lisp / play / bruce.el
1 ;;; bruce.el --- bruce phrase utility for overloading the Communications -*- no-byte-compile: t -*-
2 ;;; Decency Act snoops, if any.
3
4 ;; Copyright (C) 1988, 1993, 1997, 2001, 2002, 2003, 2004,
5 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6
7 ;; Maintainer: FSF
8 ;; Keywords: games
9 ;; Created: Jan 1997
10
11 ;; This file is part of GNU Emacs.
12
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 3, or (at your option)
16 ;; any later version.
17
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
22
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
27
28 ;;; Commentary:
29
30 ;; This program was written to protest the miss-named "Communications
31 ;; Decency Act of 1996. This Act bans "indecent speech", whatever that is,
32 ;; from the Internet. For more on the CDA, see Richard Stallman's essay on
33 ;; censorship, included in the etc directory of emacs distributions 19.34
34 ;; and up. See also http://www.eff.org/blueribbon.html.
35
36 ;; For many years, emacs has included a program called Spook. This program
37 ;; adds a series of "keywords" to email just before it goes out. On the
38 ;; theory that the NSA monitors people's email, the keywords would be
39 ;; picked up by the NSA's snoop computers, causing them to waste time
40 ;; reading your meeting schedule notices or other email boring to everyone
41 ;; but you and (you hope) the recipient. See below (I left in the original
42 ;; writeup when I made this conversion), or the emacs documentation at
43 ;; ftp://prep.ai.mit.edu/pub/gnu/emacs-manual*.
44
45 ;; Bruce is a direct copy of spook, with the word "spook" replaced with
46 ;; the word "bruce". Thanks to "esr", whoever he, she or it may be, this
47 ;; conversion was an extremely easy piece of editing, suitable for a first
48 ;; essay at elisp programming.
49
50 ;; You may think of the name as having been derived from a certain Monty
51 ;; Python routine. Or from Lenny Bruce, who opposed censorship in his own
52 ;; inimitable way. Bruce does exactly what Spook does: it throws keywords
53 ;; into your email messages or other documents.
54
55 ;; However, in order to comply with the CDA as interpreted by Richard
56 ;; Stallman (see the essay on censorship), bruce is distributed without a
57 ;; data file from which to select words at random. Sorry about that. I
58 ;; believe the average user will be able to come up with a few words on
59 ;; his or her own. If that is a problem, feel free to ask any American
60 ;; teenager, preferably one who attends a government school. Failing
61 ;; that, you might write to Mr. Clinton or Ms Reno or their successors and
62 ;; ask them for suggestions. Think of it as a public spirited act: the
63 ;; time they spend answering you is time not spent persecuting someone
64 ;; else. However, do ask them to respond by snail mail, where their
65 ;; suggestions would be legal.
66
67 ;; To build the data file, just start a file called bruce.lines in the etc
68 ;; directory of your emacs distribution. Note that each phrase or word has
69 ;; to be followed by an ascii 0, control-@. See the file spook.lines in
70 ;; the etc directory for an example. In emacs, use c-q c-@ to insert the
71 ;; ascii 0s.
72
73 ;; Once you have edited up a data file, you have to tell emacs how to find
74 ;; the program bruce. Add the following two lines to your .emacs file. Be
75 ;; sure to uncomment the second line.
76
77 ;; for bruce mode
78 ;; (autoload 'bruce "bruce" "Use the Bruce program to protest the CDA" t)
79
80 ;; Shut down emacs and fire it up again. Then "M-x bruce" should put some
81 ;; shocking words in the current buffer.
82
83
84 ;; Please note that I am not suggesting that you actually use this program
85 ;; to add "illegal" words to your email, or any other purpose. First, you
86 ;; don't really need a program to do it, and second, it would be illegal
87 ;; for me to suggest or advise that you actually break the law. This
88 ;; program was written as a demonstration only, and as an act of political
89 ;; protest and free expression protected by the First Amendment, or
90 ;; whatever is left of it.
91
92
93 ;; We now return to the original writeup for spook:
94
95 ;; Steve Strassmann <straz@media-lab.media.mit.edu> didn't write the
96 ;; program spook, from which this was adapted, and even if he did, he
97 ;; really didn't mean for you to use it in an anarchistic way.
98 ;;
99 ;; To use this:
100 ;; Just before sending mail, do M-x spook.
101 ;; A number of phrases will be inserted into your buffer, to help
102 ;; give your message that extra bit of attractiveness for automated
103 ;; keyword scanners. Help defeat the NSA trunk trawler!
104
105 ;;; Code:
106
107 (require 'cookie1)
108
109 ; Variables
110 (defgroup bruce nil
111 "Insert phrases selected at random from a file into a buffer."
112 :prefix "bruce-"
113 :group 'games)
114
115 (defcustom bruce-phrases-file "~/bruce.lines"
116 "Keep your favourite phrases here."
117 :type 'file
118 :group 'bruce)
119
120 (defcustom bruce-phrase-default-count 15
121 "Default number of phrases to insert."
122 :type 'integer
123 :group 'bruce)
124
125 ;;;###autoload
126 (defun bruce ()
127 "Adds that special touch of class to your outgoing mail."
128 (interactive)
129 (or (file-exists-p bruce-phrases-file)
130 (error "You need to create %s" bruce-phrases-file))
131 (cookie-insert bruce-phrases-file
132 bruce-phrase-default-count
133 "Checking authorization..."
134 "Checking authorization...Approved"))
135
136 ;;;###autoload
137 (defun snarf-bruces ()
138 "Return a vector containing the lines from `bruce-phrases-file'."
139 (or (file-exists-p bruce-phrases-file)
140 (error "You need to create %s" bruce-phrases-file))
141 (cookie-snarf bruce-phrases-file
142 "Checking authorization..."
143 "Checking authorization...Approved"))
144
145 ;; Note: the implementation that used to take up most of this file has been
146 ;; cleaned up, generalized, gratuitously broken by esr, and now resides in
147 ;; cookie1.el.
148
149 (provide 'bruce)
150
151 ;; arch-tag: b83ded51-4ccb-41ef-8bd6-3b521e81dd9b
152 ;;; bruce.el ends here