annotate man/lispref/intro.texi @ 44:8d2a9b52c682 r19-15prefinal

Import from CVS: tag r19-15prefinal
author cvs
date Mon, 13 Aug 2007 08:55:10 +0200
parents 376386a54a3c
children 05472e90ae02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 @c -*-texinfo-*-
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 @c This is part of the XEmacs Lisp Reference Manual.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 @c See the file lispref.texi for copying conditions.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 @setfilename ../../info/intro.info
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 @node Copying, Introduction, Top, Top
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 @unnumbered GNU GENERAL PUBLIC LICENSE
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 @center Version 2, June 1991
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 @display
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 675 Mass Ave, Cambridge, MA 02139, USA
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 Everyone is permitted to copy and distribute verbatim copies
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 of this license document, but changing it is not allowed.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 @end display
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 @unnumberedsec Preamble
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 The licenses for most software are designed to take away your
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 freedom to share and change it. By contrast, the GNU General Public
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 License is intended to guarantee your freedom to share and change free
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 software---to make sure the software is free for all its users. This
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 General Public License applies to most of the Free Software
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 Foundation's software and to any other program whose authors commit to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 using it. (Some other Free Software Foundation software is covered by
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 the GNU Library General Public License instead.) You can apply it to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 your programs, too.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 When we speak of free software, we are referring to freedom, not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 price. Our General Public Licenses are designed to make sure that you
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 have the freedom to distribute copies of free software (and charge for
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 this service if you wish), that you receive source code or can get it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 if you want it, that you can change the software or use pieces of it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 in new free programs; and that you know you can do these things.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 To protect your rights, we need to make restrictions that forbid
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 anyone to deny you these rights or to ask you to surrender the rights.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 These restrictions translate to certain responsibilities for you if you
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 distribute copies of the software, or if you modify it.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 For example, if you distribute copies of such a program, whether
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 gratis or for a fee, you must give the recipients all the rights that
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 you have. You must make sure that they, too, receive or can get the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 source code. And you must show them these terms so they know their
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 rights.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 We protect your rights with two steps: (1) copyright the software, and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 (2) offer you this license which gives you legal permission to copy,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 distribute and/or modify the software.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 Also, for each author's protection and ours, we want to make certain
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 that everyone understands that there is no warranty for this free
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 software. If the software is modified by someone else and passed on, we
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 want its recipients to know that what they have is not the original, so
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 that any problems introduced by others will not reflect on the original
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 authors' reputations.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60 Finally, any free program is threatened constantly by software
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 patents. We wish to avoid the danger that redistributors of a free
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 program will individually obtain patent licenses, in effect making the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 program proprietary. To prevent this, we have made it clear that any
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 patent must be licensed for everyone's free use or not licensed at all.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 The precise terms and conditions for copying, distribution and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 modification follow.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 @iftex
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 @end iftex
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 @ifinfo
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74 @end ifinfo
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76 @enumerate 0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78 This License applies to any program or other work which contains
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79 a notice placed by the copyright holder saying it may be distributed
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80 under the terms of this General Public License. The ``Program'', below,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
81 refers to any such program or work, and a ``work based on the Program''
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
82 means either the Program or any derivative work under copyright law:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83 that is to say, a work containing the Program or a portion of it,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84 either verbatim or with modifications and/or translated into another
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85 language. (Hereinafter, translation is included without limitation in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86 the term ``modification''.) Each licensee is addressed as ``you''.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
87
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88 Activities other than copying, distribution and modification are not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
89 covered by this License; they are outside its scope. The act of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
90 running the Program is not restricted, and the output from the Program
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
91 is covered only if its contents constitute a work based on the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92 Program (independent of having been made by running the Program).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
93 Whether that is true depends on what the Program does.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
94
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96 You may copy and distribute verbatim copies of the Program's
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
97 source code as you receive it, in any medium, provided that you
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
98 conspicuously and appropriately publish on each copy an appropriate
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
99 copyright notice and disclaimer of warranty; keep intact all the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
100 notices that refer to this License and to the absence of any warranty;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
101 and give any other recipients of the Program a copy of this License
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
102 along with the Program.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
103
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
104 You may charge a fee for the physical act of transferring a copy, and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
105 you may at your option offer warranty protection in exchange for a fee.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
106
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
107 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
108 You may modify your copy or copies of the Program or any portion
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
109 of it, thus forming a work based on the Program, and copy and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
110 distribute such modifications or work under the terms of Section 1
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
111 above, provided that you also meet all of these conditions:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
112
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
113 @enumerate a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
114 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
115 You must cause the modified files to carry prominent notices
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
116 stating that you changed the files and the date of any change.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
117
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
118 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
119 You must cause any work that you distribute or publish, that in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
120 whole or in part contains or is derived from the Program or any
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
121 part thereof, to be licensed as a whole at no charge to all third
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
122 parties under the terms of this License.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
123
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
124 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
125 If the modified program normally reads commands interactively
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
126 when run, you must cause it, when started running for such
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
127 interactive use in the most ordinary way, to print or display an
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
128 announcement including an appropriate copyright notice and a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
129 notice that there is no warranty (or else, saying that you provide
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
130 a warranty) and that users may redistribute the program under
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
131 these conditions, and telling the user how to view a copy of this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
132 License. (Exception: if the Program itself is interactive but
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
133 does not normally print such an announcement, your work based on
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
134 the Program is not required to print an announcement.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
135 @end enumerate
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
136
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
137 These requirements apply to the modified work as a whole. If
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
138 identifiable sections of that work are not derived from the Program,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
139 and can be reasonably considered independent and separate works in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
140 themselves, then this License, and its terms, do not apply to those
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
141 sections when you distribute them as separate works. But when you
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
142 distribute the same sections as part of a whole which is a work based
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
143 on the Program, the distribution of the whole must be on the terms of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
144 this License, whose permissions for other licensees extend to the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
145 entire whole, and thus to each and every part regardless of who wrote it.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
146
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
147 Thus, it is not the intent of this section to claim rights or contest
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
148 your rights to work written entirely by you; rather, the intent is to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
149 exercise the right to control the distribution of derivative or
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
150 collective works based on the Program.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
151
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
152 In addition, mere aggregation of another work not based on the Program
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
153 with the Program (or with a work based on the Program) on a volume of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
154 a storage or distribution medium does not bring the other work under
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
155 the scope of this License.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
156
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
157 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
158 You may copy and distribute the Program (or a work based on it,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
159 under Section 2) in object code or executable form under the terms of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
160 Sections 1 and 2 above provided that you also do one of the following:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
161
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
162 @enumerate a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
163 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
164 Accompany it with the complete corresponding machine-readable
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
165 source code, which must be distributed under the terms of Sections
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
166 1 and 2 above on a medium customarily used for software interchange; or,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
167
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
168 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
169 Accompany it with a written offer, valid for at least three
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
170 years, to give any third party, for a charge no more than your
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
171 cost of physically performing source distribution, a complete
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
172 machine-readable copy of the corresponding source code, to be
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
173 distributed under the terms of Sections 1 and 2 above on a medium
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
174 customarily used for software interchange; or,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
175
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
176 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
177 Accompany it with the information you received as to the offer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
178 to distribute corresponding source code. (This alternative is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
179 allowed only for noncommercial distribution and only if you
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
180 received the program in object code or executable form with such
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
181 an offer, in accord with Subsection b above.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
182 @end enumerate
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
183
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
184 The source code for a work means the preferred form of the work for
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
185 making modifications to it. For an executable work, complete source
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
186 code means all the source code for all modules it contains, plus any
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
187 associated interface definition files, plus the scripts used to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
188 control compilation and installation of the executable. However, as a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
189 special exception, the source code distributed need not include
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
190 anything that is normally distributed (in either source or binary
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
191 form) with the major components (compiler, kernel, and so on) of the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
192 operating system on which the executable runs, unless that component
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
193 itself accompanies the executable.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
194
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
195 If distribution of executable or object code is made by offering
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
196 access to copy from a designated place, then offering equivalent
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
197 access to copy the source code from the same place counts as
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
198 distribution of the source code, even though third parties are not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
199 compelled to copy the source along with the object code.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
200
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
201 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
202 You may not copy, modify, sublicense, or distribute the Program
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
203 except as expressly provided under this License. Any attempt
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
204 otherwise to copy, modify, sublicense or distribute the Program is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
205 void, and will automatically terminate your rights under this License.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
206 However, parties who have received copies, or rights, from you under
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
207 this License will not have their licenses terminated so long as such
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
208 parties remain in full compliance.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
209
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
210 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
211 You are not required to accept this License, since you have not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
212 signed it. However, nothing else grants you permission to modify or
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
213 distribute the Program or its derivative works. These actions are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
214 prohibited by law if you do not accept this License. Therefore, by
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
215 modifying or distributing the Program (or any work based on the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
216 Program), you indicate your acceptance of this License to do so, and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
217 all its terms and conditions for copying, distributing or modifying
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
218 the Program or works based on it.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
219
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
220 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
221 Each time you redistribute the Program (or any work based on the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
222 Program), the recipient automatically receives a license from the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
223 original licensor to copy, distribute or modify the Program subject to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
224 these terms and conditions. You may not impose any further
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
225 restrictions on the recipients' exercise of the rights granted herein.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
226 You are not responsible for enforcing compliance by third parties to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
227 this License.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
228
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
229 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
230 If, as a consequence of a court judgment or allegation of patent
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
231 infringement or for any other reason (not limited to patent issues),
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
232 conditions are imposed on you (whether by court order, agreement or
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
233 otherwise) that contradict the conditions of this License, they do not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
234 excuse you from the conditions of this License. If you cannot
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
235 distribute so as to satisfy simultaneously your obligations under this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
236 License and any other pertinent obligations, then as a consequence you
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
237 may not distribute the Program at all. For example, if a patent
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
238 license would not permit royalty-free redistribution of the Program by
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
239 all those who receive copies directly or indirectly through you, then
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
240 the only way you could satisfy both it and this License would be to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
241 refrain entirely from distribution of the Program.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
242
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
243 If any portion of this section is held invalid or unenforceable under
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
244 any particular circumstance, the balance of the section is intended to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
245 apply and the section as a whole is intended to apply in other
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
246 circumstances.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
247
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
248 It is not the purpose of this section to induce you to infringe any
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
249 patents or other property right claims or to contest validity of any
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
250 such claims; this section has the sole purpose of protecting the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
251 integrity of the free software distribution system, which is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
252 implemented by public license practices. Many people have made
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
253 generous contributions to the wide range of software distributed
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
254 through that system in reliance on consistent application of that
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
255 system; it is up to the author/donor to decide if he or she is willing
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
256 to distribute software through any other system and a licensee cannot
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
257 impose that choice.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
258
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
259 This section is intended to make thoroughly clear what is believed to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
260 be a consequence of the rest of this License.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
261
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
262 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
263 If the distribution and/or use of the Program is restricted in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
264 certain countries either by patents or by copyrighted interfaces, the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
265 original copyright holder who places the Program under this License
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
266 may add an explicit geographical distribution limitation excluding
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
267 those countries, so that distribution is permitted only in or among
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
268 countries not thus excluded. In such case, this License incorporates
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
269 the limitation as if written in the body of this License.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
270
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
271 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
272 The Free Software Foundation may publish revised and/or new versions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
273 of the General Public License from time to time. Such new versions will
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
274 be similar in spirit to the present version, but may differ in detail to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
275 address new problems or concerns.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
276
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
277 Each version is given a distinguishing version number. If the Program
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
278 specifies a version number of this License which applies to it and ``any
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
279 later version'', you have the option of following the terms and conditions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
280 either of that version or of any later version published by the Free
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
281 Software Foundation. If the Program does not specify a version number of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
282 this License, you may choose any version ever published by the Free Software
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
283 Foundation.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
284
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
285 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
286 If you wish to incorporate parts of the Program into other free
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
287 programs whose distribution conditions are different, write to the author
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
288 to ask for permission. For software which is copyrighted by the Free
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
289 Software Foundation, write to the Free Software Foundation; we sometimes
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
290 make exceptions for this. Our decision will be guided by the two goals
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
291 of preserving the free status of all derivatives of our free software and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
292 of promoting the sharing and reuse of software generally.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
293
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
294 @iftex
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
295 @heading NO WARRANTY
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
296 @end iftex
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
297 @ifinfo
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
298 @center NO WARRANTY
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
299 @end ifinfo
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
300
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
301 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
302 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
303 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW@. EXCEPT WHEN
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
304 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
305 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
306 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
307 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE@. THE ENTIRE RISK AS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
308 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU@. SHOULD THE
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
309 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
310 REPAIR OR CORRECTION.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
311
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
312 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
313 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
314 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
315 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
316 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
317 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
318 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
319 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
320 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
321 POSSIBILITY OF SUCH DAMAGES.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
322 @end enumerate
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
323
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
324 @iftex
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
325 @heading END OF TERMS AND CONDITIONS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
326 @end iftex
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
327 @ifinfo
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
328 @center END OF TERMS AND CONDITIONS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
329 @end ifinfo
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
330
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
331 @page
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
332 @unnumberedsec How to Apply These Terms to Your New Programs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
333
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
334 If you develop a new program, and you want it to be of the greatest
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
335 possible use to the public, the best way to achieve this is to make it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
336 free software which everyone can redistribute and change under these terms.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
337
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
338 To do so, attach the following notices to the program. It is safest
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
339 to attach them to the start of each source file to most effectively
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
340 convey the exclusion of warranty; and each file should have at least
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
341 the ``copyright'' line and a pointer to where the full notice is found.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
342
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
343 @smallexample
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
344 @var{one line to give the program's name and an idea of what it does.}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
345 Copyright (C) 19@var{yy} @var{name of author}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
346
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
347 This program is free software; you can redistribute it and/or
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
348 modify it under the terms of the GNU General Public License
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
349 as published by the Free Software Foundation; either version 2
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
350 of the License, or (at your option) any later version.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
351
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
352 This program is distributed in the hope that it will be useful,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
353 but WITHOUT ANY WARRANTY; without even the implied warranty of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
354 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
355 GNU General Public License for more details.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
356
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
357 You should have received a copy of the GNU General Public License
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
358 along with this program; if not, write to the Free Software
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
359 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
360 @end smallexample
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
361
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
362 Also add information on how to contact you by electronic and paper mail.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
363
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
364 If the program is interactive, make it output a short notice like this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
365 when it starts in an interactive mode:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
366
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
367 @smallexample
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
368 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
369 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
370 type `show w'. This is free software, and you are welcome
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
371 to redistribute it under certain conditions; type `show c'
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
372 for details.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
373 @end smallexample
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
374
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
375 The hypothetical commands @samp{show w} and @samp{show c} should show
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
376 the appropriate parts of the General Public License. Of course, the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
377 commands you use may be called something other than @samp{show w} and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
378 @samp{show c}; they could even be mouse-clicks or menu items---whatever
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
379 suits your program.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
380
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
381 You should also get your employer (if you work as a programmer) or your
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
382 school, if any, to sign a ``copyright disclaimer'' for the program, if
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
383 necessary. Here is a sample; alter the names:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
384
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
385 @smallexample
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
386 @group
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
387 Yoyodyne, Inc., hereby disclaims all copyright
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
388 interest in the program `Gnomovision'
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
389 (which makes passes at compilers) written
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
390 by James Hacker.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
391
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
392 @var{signature of Ty Coon}, 1 April 1989
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
393 Ty Coon, President of Vice
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
394 @end group
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
395 @end smallexample
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
396
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
397 This General Public License does not permit incorporating your program into
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
398 proprietary programs. If your program is a subroutine library, you may
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
399 consider it more useful to permit linking proprietary applications with the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
400 library. If this is what you want to do, use the GNU Library General
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
401 Public License instead of this License.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
402
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
403 @node Introduction, Lisp Data Types, Copying, Top
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
404 @chapter Introduction
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
405
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
406 Most of the XEmacs text editor is written in the programming
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
407 language called XEmacs Lisp. You can write new code in XEmacs Lisp and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
408 install it as an extension to the editor. However, XEmacs Lisp is more
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
409 than a mere ``extension language''; it is a full computer programming
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
410 language in its own right. You can use it as you would any other
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
411 programming language.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
412
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
413 Because XEmacs Lisp is designed for use in an editor, it has special
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
414 features for scanning and parsing text as well as features for handling
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
415 files, buffers, displays, subprocesses, and so on. XEmacs Lisp is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
416 closely integrated with the editing facilities; thus, editing commands
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
417 are functions that can also conveniently be called from Lisp programs,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
418 and parameters for customization are ordinary Lisp variables.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
419
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
420 This manual describes XEmacs Lisp, presuming considerable familiarity
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
421 with the use of XEmacs for editing. (See @cite{The XEmacs Reference
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
422 Manual}, for this basic information.) Generally speaking, the earlier
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
423 chapters describe features of XEmacs Lisp that have counterparts in many
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
424 programming languages, and later chapters describe features that are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
425 peculiar to XEmacs Lisp or relate specifically to editing.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
426
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
427 This is edition 3.0.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
428
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
429 @menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
430 * Caveats:: Flaws and a request for help.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
431 * Lisp History:: XEmacs Lisp is descended from Maclisp.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
432 * Conventions:: How the manual is formatted.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
433 * Acknowledgements:: The authors, editors, and sponsors of this manual.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
434 @end menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
435
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
436 @node Caveats
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
437 @section Caveats
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
438
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
439 This manual has gone through numerous drafts. It is nearly complete
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
440 but not flawless. There are a few topics that are not covered, either
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
441 because we consider them secondary (such as most of the individual
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
442 modes) or because they are yet to be written. Because we are not able
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
443 to deal with them completely, we have left out several parts
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
444 intentionally. This includes most information about usage on VMS.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
445
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
446 The manual should be fully correct in what it does cover, and it is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
447 therefore open to criticism on anything it says---from specific examples
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
448 and descriptive text, to the ordering of chapters and sections. If
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
449 something is confusing, or you find that you have to look at the sources
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
450 or experiment to learn something not covered in the manual, then perhaps
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
451 the manual should be fixed. Please let us know.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
452
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
453 @iftex
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
454 As you use the manual, we ask that you mark pages with corrections so
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
455 you can later look them up and send them in. If you think of a simple,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
456 real-life example for a function or group of functions, please make an
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
457 effort to write it up and send it in. Please reference any comments to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
458 the chapter name, section name, and function name, as appropriate, since
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
459 page numbers and chapter and section numbers will change and we may have
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
460 trouble finding the text you are talking about. Also state the number
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
461 of the edition you are criticizing.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
462 @end iftex
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
463 @ifinfo
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
464
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
465 As you use this manual, we ask that you send corrections as soon as you
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
466 find them. If you think of a simple, real life example for a function
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
467 or group of functions, please make an effort to write it up and send it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
468 in. Please reference any comments to the node name and function or
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
469 variable name, as appropriate. Also state the number of the edition
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
470 which you are criticizing.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
471 @end ifinfo
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
472
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
473 This manual was originally written for FSF Emacs 19 and was updated by
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
474 Ben Wing (wing@@666.com) for Lucid Emacs 19.10 and later for XEmacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
475 19.12, 19.13, and 19.14. Please send comments and corrections
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
476 relating to XEmacs-specific portions of this manual to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
477 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
478 xemacs@@xemacs.org
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
479 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
480
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
481 or post to the newsgroup
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
482 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
483 comp.emacs.xemacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
484 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
485
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
486 @noindent
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
487 @display
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
488 --Ben Wing
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
489 @end display
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
490
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
491 @node Lisp History
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
492 @section Lisp History
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
493 @cindex Lisp history
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
494
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
495 Lisp (LISt Processing language) was first developed in the late 1950's
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
496 at the Massachusetts Institute of Technology for research in artificial
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
497 intelligence. The great power of the Lisp language makes it superior
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
498 for other purposes as well, such as writing editing commands.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
499
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
500 @cindex Maclisp
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
501 @cindex Common Lisp
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
502 Dozens of Lisp implementations have been built over the years, each
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
503 with its own idiosyncrasies. Many of them were inspired by Maclisp,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
504 which was written in the 1960's at MIT's Project MAC. Eventually the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
505 implementors of the descendants of Maclisp came together and developed a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
506 standard for Lisp systems, called Common Lisp.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
507
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
508 XEmacs Lisp is largely inspired by Maclisp, and a little by Common
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
509 Lisp. If you know Common Lisp, you will notice many similarities.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
510 However, many of the features of Common Lisp have been omitted or
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
511 simplified in order to reduce the memory requirements of XEmacs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
512 Sometimes the simplifications are so drastic that a Common Lisp user
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
513 might be very confused. We will occasionally point out how XEmacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
514 Lisp differs from Common Lisp. If you don't know Common Lisp, don't
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
515 worry about it; this manual is self-contained.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
516
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
517 @node Conventions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
518 @section Conventions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
519
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
520 This section explains the notational conventions that are used in this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
521 manual. You may want to skip this section and refer back to it later.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
522
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
523 @menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
524 * Some Terms:: Explanation of terms we use in this manual.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
525 * nil and t:: How the symbols @code{nil} and @code{t} are used.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
526 * Evaluation Notation:: The format we use for examples of evaluation.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
527 * Printing Notation:: The format we use for examples that print output.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
528 * Error Messages:: The format we use for examples of errors.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
529 * Buffer Text Notation:: The format we use for buffer contents in examples.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
530 * Format of Descriptions:: Notation for describing functions, variables, etc.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
531 @end menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
532
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
533 @node Some Terms
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
534 @subsection Some Terms
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
535
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
536 Throughout this manual, the phrases ``the Lisp reader'' and ``the Lisp
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
537 printer'' are used to refer to those routines in Lisp that convert
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
538 textual representations of Lisp objects into actual Lisp objects, and vice
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
539 versa. @xref{Printed Representation}, for more details. You, the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
540 person reading this manual, are thought of as ``the programmer'' and are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
541 addressed as ``you''. ``The user'' is the person who uses Lisp programs,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
542 including those you write.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
543
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
544 @cindex fonts
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
545 Examples of Lisp code appear in this font or form: @code{(list 1 2
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
546 3)}. Names that represent arguments or metasyntactic variables appear
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
547 in this font or form: @var{first-number}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
548
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
549 @node nil and t
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
550 @subsection @code{nil} and @code{t}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
551 @cindex @code{nil}, uses of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
552 @cindex truth value
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
553 @cindex boolean
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
554 @cindex false
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
555
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
556 In Lisp, the symbol @code{nil} has three separate meanings: it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
557 is a symbol with the name @samp{nil}; it is the logical truth value
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
558 @var{false}; and it is the empty list---the list of zero elements.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
559 When used as a variable, @code{nil} always has the value @code{nil}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
560
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
561 As far as the Lisp reader is concerned, @samp{()} and @samp{nil} are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
562 identical: they stand for the same object, the symbol @code{nil}. The
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
563 different ways of writing the symbol are intended entirely for human
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
564 readers. After the Lisp reader has read either @samp{()} or @samp{nil},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
565 there is no way to determine which representation was actually written
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
566 by the programmer.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
567
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
568 In this manual, we use @code{()} when we wish to emphasize that it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
569 means the empty list, and we use @code{nil} when we wish to emphasize
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
570 that it means the truth value @var{false}. That is a good convention to use
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
571 in Lisp programs also.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
572
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
573 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
574 (cons 'foo ()) ; @r{Emphasize the empty list}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
575 (not nil) ; @r{Emphasize the truth value @var{false}}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
576 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
577
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
578 @cindex @code{t} and truth
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
579 @cindex true
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
580 In contexts where a truth value is expected, any non-@code{nil} value
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
581 is considered to be @var{true}. However, @code{t} is the preferred way
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
582 to represent the truth value @var{true}. When you need to choose a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
583 value which represents @var{true}, and there is no other basis for
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
584 choosing, use @code{t}. The symbol @code{t} always has value @code{t}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
585
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
586 In XEmacs Lisp, @code{nil} and @code{t} are special symbols that always
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
587 evaluate to themselves. This is so that you do not need to quote them
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
588 to use them as constants in a program. An attempt to change their
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
589 values results in a @code{setting-constant} error. @xref{Accessing
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
590 Variables}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
591
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
592 @node Evaluation Notation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
593 @subsection Evaluation Notation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
594 @cindex evaluation notation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
595 @cindex documentation notation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
596
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
597 A Lisp expression that you can evaluate is called a @dfn{form}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
598 Evaluating a form always produces a result, which is a Lisp object. In
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
599 the examples in this manual, this is indicated with @samp{@result{}}:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
600
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
601 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
602 (car '(1 2))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
603 @result{} 1
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
604 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
605
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
606 @noindent
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
607 You can read this as ``@code{(car '(1 2))} evaluates to 1''.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
608
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
609 When a form is a macro call, it expands into a new form for Lisp to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
610 evaluate. We show the result of the expansion with
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
611 @samp{@expansion{}}. We may or may not show the actual result of the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
612 evaluation of the expanded form.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
613
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
614 @example
44
8d2a9b52c682 Import from CVS: tag r19-15prefinal
cvs
parents: 0
diff changeset
615 (news-cadr '(a b c))
8d2a9b52c682 Import from CVS: tag r19-15prefinal
cvs
parents: 0
diff changeset
616 @expansion{} (car (cdr '(a b c)))
8d2a9b52c682 Import from CVS: tag r19-15prefinal
cvs
parents: 0
diff changeset
617 @result{} b
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
618 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
619
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
620 Sometimes to help describe one form we show another form that
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
621 produces identical results. The exact equivalence of two forms is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
622 indicated with @samp{@equiv{}}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
623
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
624 @example
44
8d2a9b52c682 Import from CVS: tag r19-15prefinal
cvs
parents: 0
diff changeset
625 (cons 'a nil) @equiv{} (list 'a)
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
626 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
627
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
628 @node Printing Notation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
629 @subsection Printing Notation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
630 @cindex printing notation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
631
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
632 Many of the examples in this manual print text when they are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
633 evaluated. If you execute example code in a Lisp Interaction buffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
634 (such as the buffer @samp{*scratch*}), the printed text is inserted into
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
635 the buffer. If you execute the example by other means (such as by
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
636 evaluating the function @code{eval-region}), the printed text is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
637 displayed in the echo area. You should be aware that text displayed in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
638 the echo area is truncated to a single line.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
639
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
640 Examples in this manual indicate printed text with @samp{@print{}},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
641 irrespective of where that text goes. The value returned by evaluating
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
642 the form (here @code{bar}) follows on a separate line.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
643
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
644 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
645 @group
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
646 (progn (print 'foo) (print 'bar))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
647 @print{} foo
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
648 @print{} bar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
649 @result{} bar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
650 @end group
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
651 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
652
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
653 @node Error Messages
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
654 @subsection Error Messages
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
655 @cindex error message notation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
656
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
657 Some examples signal errors. This normally displays an error message
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
658 in the echo area. We show the error message on a line starting with
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
659 @samp{@error{}}. Note that @samp{@error{}} itself does not appear in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
660 the echo area.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
661
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
662 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
663 (+ 23 'x)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
664 @error{} Wrong type argument: integer-or-marker-p, x
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
665 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
666
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
667 @node Buffer Text Notation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
668 @subsection Buffer Text Notation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
669 @cindex buffer text notation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
670
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
671 Some examples show modifications to text in a buffer, with ``before''
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
672 and ``after'' versions of the text. These examples show the contents of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
673 the buffer in question between two lines of dashes containing the buffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
674 name. In addition, @samp{@point{}} indicates the location of point.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
675 (The symbol for point, of course, is not part of the text in the buffer;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
676 it indicates the place @emph{between} two characters where point is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
677 located.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
678
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
679 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
680 ---------- Buffer: foo ----------
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
681 This is the @point{}contents of foo.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
682 ---------- Buffer: foo ----------
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
683
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
684 (insert "changed ")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
685 @result{} nil
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
686 ---------- Buffer: foo ----------
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
687 This is the changed @point{}contents of foo.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
688 ---------- Buffer: foo ----------
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
689 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
690
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
691 @node Format of Descriptions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
692 @subsection Format of Descriptions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
693 @cindex description format
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
694
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
695 Functions, variables, macros, commands, user options, and special
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
696 forms are described in this manual in a uniform format. The first
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
697 line of a description contains the name of the item followed by its
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
698 arguments, if any.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
699 @ifinfo
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
700 The category---function, variable, or whatever---appears at the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
701 beginning of the line.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
702 @end ifinfo
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
703 @iftex
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
704 The category---function, variable, or whatever---is printed next to the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
705 right margin.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
706 @end iftex
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
707 The description follows on succeeding lines, sometimes with examples.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
708
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
709 @menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
710 * A Sample Function Description:: A description of an imaginary
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
711 function, @code{foo}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
712 * A Sample Variable Description:: A description of an imaginary
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
713 variable,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
714 @code{electric-future-map}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
715 @end menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
716
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
717 @node A Sample Function Description
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
718 @subsubsection A Sample Function Description
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
719 @cindex function descriptions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
720 @cindex command descriptions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
721 @cindex macro descriptions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
722 @cindex special form descriptions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
723
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
724 In a function description, the name of the function being described
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
725 appears first. It is followed on the same line by a list of parameters.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
726 The names used for the parameters are also used in the body of the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
727 description.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
728
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
729 The appearance of the keyword @code{&optional} in the parameter list
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
730 indicates that the arguments for subsequent parameters may be omitted
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
731 (omitted parameters default to @code{nil}). Do not write
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
732 @code{&optional} when you call the function.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
733
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
734 The keyword @code{&rest} (which will always be followed by a single
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
735 parameter) indicates that any number of arguments can follow. The value
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
736 of the single following parameter will be a list of all these arguments.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
737 Do not write @code{&rest} when you call the function.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
738
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
739 Here is a description of an imaginary function @code{foo}:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
740
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
741 @defun foo integer1 &optional integer2 &rest integers
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
742 The function @code{foo} subtracts @var{integer1} from @var{integer2},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
743 then adds all the rest of the arguments to the result. If @var{integer2}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
744 is not supplied, then the number 19 is used by default.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
745
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
746 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
747 (foo 1 5 3 9)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
748 @result{} 16
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
749 (foo 5)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
750 @result{} 14
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
751 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
752
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
753 More generally,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
754
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
755 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
756 (foo @var{w} @var{x} @var{y}@dots{})
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
757 @equiv{}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
758 (+ (- @var{x} @var{w}) @var{y}@dots{})
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
759 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
760 @end defun
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
761
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
762 Any parameter whose name contains the name of a type (e.g.,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
763 @var{integer}, @var{integer1} or @var{buffer}) is expected to be of that
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
764 type. A plural of a type (such as @var{buffers}) often means a list of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
765 objects of that type. Parameters named @var{object} may be of any type.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
766 (@xref{Lisp Data Types}, for a list of XEmacs object types.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
767 Parameters with other sorts of names (e.g., @var{new-file}) are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
768 discussed specifically in the description of the function. In some
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
769 sections, features common to parameters of several functions are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
770 described at the beginning.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
771
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
772 @xref{Lambda Expressions}, for a more complete description of optional
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
773 and rest arguments.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
774
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
775 Command, macro, and special form descriptions have the same format,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
776 but the word `Function' is replaced by `Command', `Macro', or `Special
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
777 Form', respectively. Commands are simply functions that may be called
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
778 interactively; macros process their arguments differently from functions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
779 (the arguments are not evaluated), but are presented the same way.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
780
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
781 Special form descriptions use a more complex notation to specify
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
782 optional and repeated parameters because they can break the argument
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
783 list down into separate arguments in more complicated ways.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
784 @samp{@code{@r{[}@var{optional-arg}@r{]}}} means that @var{optional-arg} is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
785 optional and @samp{@var{repeated-args}@dots{}} stands for zero or more
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
786 arguments. Parentheses are used when several arguments are grouped into
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
787 additional levels of list structure. Here is an example:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
788
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
789 @defspec count-loop (@var{var} [@var{from} @var{to} [@var{inc}]]) @var{body}@dots{}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
790 This imaginary special form implements a loop that executes the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
791 @var{body} forms and then increments the variable @var{var} on each
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
792 iteration. On the first iteration, the variable has the value
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
793 @var{from}; on subsequent iterations, it is incremented by 1 (or by
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
794 @var{inc} if that is given). The loop exits before executing @var{body}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
795 if @var{var} equals @var{to}. Here is an example:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
796
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
797 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
798 (count-loop (i 0 10)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
799 (prin1 i) (princ " ")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
800 (prin1 (aref vector i)) (terpri))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
801 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
802
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
803 If @var{from} and @var{to} are omitted, then @var{var} is bound to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
804 @code{nil} before the loop begins, and the loop exits if @var{var} is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
805 non-@code{nil} at the beginning of an iteration. Here is an example:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
806
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
807 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
808 (count-loop (done)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
809 (if (pending)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
810 (fixit)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
811 (setq done t)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
812 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
813
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
814 In this special form, the arguments @var{from} and @var{to} are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
815 optional, but must both be present or both absent. If they are present,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
816 @var{inc} may optionally be specified as well. These arguments are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
817 grouped with the argument @var{var} into a list, to distinguish them
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
818 from @var{body}, which includes all remaining elements of the form.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
819 @end defspec
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
820
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
821 @node A Sample Variable Description
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
822 @subsubsection A Sample Variable Description
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
823 @cindex variable descriptions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
824 @cindex option descriptions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
825
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
826 A @dfn{variable} is a name that can hold a value. Although any
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
827 variable can be set by the user, certain variables that exist
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
828 specifically so that users can change them are called @dfn{user
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
829 options}. Ordinary variables and user options are described using a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
830 format like that for functions except that there are no arguments.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
831
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
832 Here is a description of the imaginary @code{electric-future-map}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
833 variable.@refill
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
834
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
835 @defvar electric-future-map
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
836 The value of this variable is a full keymap used by Electric Command
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
837 Future mode. The functions in this map allow you to edit commands you
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
838 have not yet thought about executing.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
839 @end defvar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
840
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
841 User option descriptions have the same format, but `Variable' is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
842 replaced by `User Option'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
843
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
844 @node Acknowledgements
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
845 @section Acknowledgements
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
846
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
847 This manual was based on the GNU Emacs Lisp Reference Manual, version
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
848 2.4, written by Robert Krawitz, Bil Lewis, Dan LaLiberte, Richard
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
849 M. Stallman and Chris Welty, the volunteers of the GNU manual group, in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
850 an effort extending over several years. Robert J. Chassell helped to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
851 review and edit the manual, with the support of the Defense Advanced
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
852 Research Projects Agency, ARPA Order 6082, arranged by Warren A. Hunt,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
853 Jr. of Computational Logic, Inc.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
854
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
855 Ben Wing adapted this manual for XEmacs 19.14, and earlier
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
856 for Lucid Emacs 19.10, XEmacs 19.12, and XEmacs 19.13. He is the sole
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
857 author of many of the manual sections, in particular the XEmacs-specific
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
858 sections: events, faces, extents, glyphs, specifiers, toolbar, menubars,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
859 scrollbars, dialog boxes, devices, consoles, hash tables, range tables,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
860 char tables, databases, and others. The section on annotations was
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
861 originally written by Chuck Thompson.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
862
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
863 Corrections to the original GNU Emacs Lisp Reference Manual were
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
864 supplied by Karl Berry, Jim Blandy, Bard Bloom, Stephane Boucher, David
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
865 Boyes, Alan Carroll, Richard Davis, Lawrence R. Dodd, Peter Doornbosch,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
866 David A. Duff, Chris Eich, Beverly Erlebacher, David Eckelkamp, Ralf
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
867 Fassel, Eirik Fuller, Stephen Gildea, Bob Glickstein, Eric Hanchrow,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
868 George Hartzell, Nathan Hess, Masayuki Ida, Dan Jacobson, Jak Kirman,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
869 Bob Knighten, Frederick M. Korz, Joe Lammens, Glenn M. Lewis, K. Richard
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
870 Magill, Brian Marick, Roland McGrath, Skip Montanaro, John Gardiner
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
871 Myers, Thomas A. Peterson, Francesco Potorti, Friedrich Pukelsheim,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
872 Arnold D. Robbins, Raul Rockwell, Per Starback, Shinichirou Sugou, Kimmo
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
873 Suominen, Edward Tharp, Bill Trost, Rickard Westman, Jean White, Matthew
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
874 Wilding, Carl Witty, Dale Worley, Rusty Wright, and David D. Zuhn.