view lispref/intro.texi @ 13048:6c21adf788d5

Minor fixes.

+
鐃緒申��申鐃緒申@c -*-texinfo-*-
+
鐃緒申��申鐃緒申@c This is part of the GNU Emacs Lisp Reference Manual.
+
鐃緒申��申鐃緒申@c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. 
+
鐃緒申��申鐃緒申@c See the file elisp.texi for copying conditions.
+
鐃緒申��申鐃緒申@setfilename ../info/intro
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node Copying, Introduction, Top, Top
+
鐃緒申��申鐃緒申@comment  node-name,  next,  previous,  up
+
鐃緒申��申鐃緒申@unnumbered GNU GENERAL PUBLIC LICENSE
+
鐃緒申��申鐃緒申@center Version 2, June 1991
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@display
+
鐃緒申��申鐃緒申Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
+
鐃緒申��申鐃緒申675 Mass Ave, Cambridge, MA 02139, USA
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申Everyone is permitted to copy and distribute verbatim copies
+
鐃緒申��申鐃緒申of this license document, but changing it is not allowed.
+
鐃緒申��申鐃緒申@end display
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@unnumberedsec Preamble
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  The licenses for most software are designed to take away your
+
鐃緒申��申鐃緒申freedom to share and change it.  By contrast, the GNU General Public
+
鐃緒申��申鐃緒申License is intended to guarantee your freedom to share and change free
+
鐃緒申��申鐃緒申software---to make sure the software is free for all its users.  This
+
鐃緒申��申鐃緒申General Public License applies to most of the Free Software
+
鐃緒申��申鐃緒申Foundation's software and to any other program whose authors commit to
+
鐃緒申��申鐃緒申using it.  (Some other Free Software Foundation software is covered by
+
鐃緒申��申鐃緒申the GNU Library General Public License instead.)  You can apply it to
+
鐃緒申��申鐃緒申your programs, too.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  When we speak of free software, we are referring to freedom, not
+
鐃緒申��申鐃緒申price.  Our General Public Licenses are designed to make sure that you
+
鐃緒申��申鐃緒申have the freedom to distribute copies of free software (and charge for
+
鐃緒申��申鐃緒申this service if you wish), that you receive source code or can get it
+
鐃緒申��申鐃緒申if you want it, that you can change the software or use pieces of it
+
鐃緒申��申鐃緒申in new free programs; and that you know you can do these things.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  To protect your rights, we need to make restrictions that forbid
+
鐃緒申��申鐃緒申anyone to deny you these rights or to ask you to surrender the rights.
+
鐃緒申��申鐃緒申These restrictions translate to certain responsibilities for you if you
+
鐃緒申��申鐃緒申distribute copies of the software, or if you modify it.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  For example, if you distribute copies of such a program, whether
+
鐃緒申��申鐃緒申gratis or for a fee, you must give the recipients all the rights that
+
鐃緒申��申鐃緒申you have.  You must make sure that they, too, receive or can get the
+
鐃緒申��申鐃緒申source code.  And you must show them these terms so they know their
+
鐃緒申��申鐃緒申rights.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  We protect your rights with two steps: (1) copyright the software, and
+
鐃緒申��申鐃緒申(2) offer you this license which gives you legal permission to copy,
+
鐃緒申��申鐃緒申distribute and/or modify the software.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Also, for each author's protection and ours, we want to make certain
+
鐃緒申��申鐃緒申that everyone understands that there is no warranty for this free
+
鐃緒申��申鐃緒申software.  If the software is modified by someone else and passed on, we
+
鐃緒申��申鐃緒申want its recipients to know that what they have is not the original, so
+
鐃緒申��申鐃緒申that any problems introduced by others will not reflect on the original
+
鐃緒申��申鐃緒申authors' reputations.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Finally, any free program is threatened constantly by software
+
鐃緒申��申鐃緒申patents.  We wish to avoid the danger that redistributors of a free
+
鐃緒申��申鐃緒申program will individually obtain patent licenses, in effect making the
+
鐃緒申��申鐃緒申program proprietary.  To prevent this, we have made it clear that any
+
鐃緒申��申鐃緒申patent must be licensed for everyone's free use or not licensed at all.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  The precise terms and conditions for copying, distribution and
+
鐃緒申��申鐃緒申modification follow.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@iftex
+
鐃緒申��申鐃緒申@unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
鐃緒申��申鐃緒申@end iftex
+
鐃緒申��申鐃緒申@ifinfo
+
鐃緒申��申鐃緒申@center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
鐃緒申��申鐃緒申@end ifinfo
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@enumerate 0
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申This License applies to any program or other work which contains
+
鐃緒申��申鐃緒申a notice placed by the copyright holder saying it may be distributed
+
鐃緒申��申鐃緒申under the terms of this General Public License.  The ``Program'', below,
+
鐃緒申��申鐃緒申refers to any such program or work, and a ``work based on the Program''
+
鐃緒申��申鐃緒申means either the Program or any derivative work under copyright law:
+
鐃緒申��申鐃緒申that is to say, a work containing the Program or a portion of it,
+
鐃緒申��申鐃緒申either verbatim or with modifications and/or translated into another
+
鐃緒申��申鐃緒申language.  (Hereinafter, translation is included without limitation in
+
鐃緒申��申鐃緒申the term ``modification''.)  Each licensee is addressed as ``you''.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申Activities other than copying, distribution and modification are not
+
鐃緒申��申鐃緒申covered by this License; they are outside its scope.  The act of
+
鐃緒申��申鐃緒申running the Program is not restricted, and the output from the Program
+
鐃緒申��申鐃緒申is covered only if its contents constitute a work based on the
+
鐃緒申��申鐃緒申Program (independent of having been made by running the Program).
+
鐃緒申��申鐃緒申Whether that is true depends on what the Program does.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申You may copy and distribute verbatim copies of the Program's
+
鐃緒申��申鐃緒申source code as you receive it, in any medium, provided that you
+
鐃緒申��申鐃緒申conspicuously and appropriately publish on each copy an appropriate
+
鐃緒申��申鐃緒申copyright notice and disclaimer of warranty; keep intact all the
+
鐃緒申��申鐃緒申notices that refer to this License and to the absence of any warranty;
+
鐃緒申��申鐃緒申and give any other recipients of the Program a copy of this License
+
鐃緒申��申鐃緒申along with the Program.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申You may charge a fee for the physical act of transferring a copy, and
+
鐃緒申��申鐃緒申you may at your option offer warranty protection in exchange for a fee.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申You may modify your copy or copies of the Program or any portion
+
鐃緒申��申鐃緒申of it, thus forming a work based on the Program, and copy and
+
鐃緒申��申鐃緒申distribute such modifications or work under the terms of Section 1
+
鐃緒申��申鐃緒申above, provided that you also meet all of these conditions:
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@enumerate a
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申You must cause the modified files to carry prominent notices
+
鐃緒申��申鐃緒申stating that you changed the files and the date of any change.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申You must cause any work that you distribute or publish, that in
+
鐃緒申��申鐃緒申whole or in part contains or is derived from the Program or any
+
鐃緒申��申鐃緒申part thereof, to be licensed as a whole at no charge to all third
+
鐃緒申��申鐃緒申parties under the terms of this License.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申If the modified program normally reads commands interactively
+
鐃緒申��申鐃緒申when run, you must cause it, when started running for such
+
鐃緒申��申鐃緒申interactive use in the most ordinary way, to print or display an
+
鐃緒申��申鐃緒申announcement including an appropriate copyright notice and a
+
鐃緒申��申鐃緒申notice that there is no warranty (or else, saying that you provide
+
鐃緒申��申鐃緒申a warranty) and that users may redistribute the program under
+
鐃緒申��申鐃緒申these conditions, and telling the user how to view a copy of this
+
鐃緒申��申鐃緒申License.  (Exception: if the Program itself is interactive but
+
鐃緒申��申鐃緒申does not normally print such an announcement, your work based on
+
鐃緒申��申鐃緒申the Program is not required to print an announcement.)
+
鐃緒申��申鐃緒申@end enumerate
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申These requirements apply to the modified work as a whole.  If
+
鐃緒申��申鐃緒申identifiable sections of that work are not derived from the Program,
+
鐃緒申��申鐃緒申and can be reasonably considered independent and separate works in
+
鐃緒申��申鐃緒申themselves, then this License, and its terms, do not apply to those
+
鐃緒申��申鐃緒申sections when you distribute them as separate works.  But when you
+
鐃緒申��申鐃緒申distribute the same sections as part of a whole which is a work based
+
鐃緒申��申鐃緒申on the Program, the distribution of the whole must be on the terms of
+
鐃緒申��申鐃緒申this License, whose permissions for other licensees extend to the
+
鐃緒申��申鐃緒申entire whole, and thus to each and every part regardless of who wrote it.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申Thus, it is not the intent of this section to claim rights or contest
+
鐃緒申��申鐃緒申your rights to work written entirely by you; rather, the intent is to
+
鐃緒申��申鐃緒申exercise the right to control the distribution of derivative or
+
鐃緒申��申鐃緒申collective works based on the Program.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申In addition, mere aggregation of another work not based on the Program
+
鐃緒申��申鐃緒申with the Program (or with a work based on the Program) on a volume of
+
鐃緒申��申鐃緒申a storage or distribution medium does not bring the other work under
+
鐃緒申��申鐃緒申the scope of this License.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申You may copy and distribute the Program (or a work based on it,
+
鐃緒申��申鐃緒申under Section 2) in object code or executable form under the terms of
+
鐃緒申��申鐃緒申Sections 1 and 2 above provided that you also do one of the following:
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@enumerate a
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申Accompany it with the complete corresponding machine-readable
+
鐃緒申��申鐃緒申source code, which must be distributed under the terms of Sections
+
鐃緒申��申鐃緒申1 and 2 above on a medium customarily used for software interchange; or,
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申Accompany it with a written offer, valid for at least three
+
鐃緒申��申鐃緒申years, to give any third party, for a charge no more than your
+
鐃緒申��申鐃緒申cost of physically performing source distribution, a complete
+
鐃緒申��申鐃緒申machine-readable copy of the corresponding source code, to be
+
鐃緒申��申鐃緒申distributed under the terms of Sections 1 and 2 above on a medium
+
鐃緒申��申鐃緒申customarily used for software interchange; or,
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申Accompany it with the information you received as to the offer
+
鐃緒申��申鐃緒申to distribute corresponding source code.  (This alternative is
+
鐃緒申��申鐃緒申allowed only for noncommercial distribution and only if you
+
鐃緒申��申鐃緒申received the program in object code or executable form with such
+
鐃緒申��申鐃緒申an offer, in accord with Subsection b above.)
+
鐃緒申��申鐃緒申@end enumerate
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申The source code for a work means the preferred form of the work for
+
鐃緒申��申鐃緒申making modifications to it.  For an executable work, complete source
+
鐃緒申��申鐃緒申code means all the source code for all modules it contains, plus any
+
鐃緒申��申鐃緒申associated interface definition files, plus the scripts used to
+
鐃緒申��申鐃緒申control compilation and installation of the executable.  However, as a
+
鐃緒申��申鐃緒申special exception, the source code distributed need not include
+
鐃緒申��申鐃緒申anything that is normally distributed (in either source or binary
+
鐃緒申��申鐃緒申form) with the major components (compiler, kernel, and so on) of the
+
鐃緒申��申鐃緒申operating system on which the executable runs, unless that component
+
鐃緒申��申鐃緒申itself accompanies the executable.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申If distribution of executable or object code is made by offering
+
鐃緒申��申鐃緒申access to copy from a designated place, then offering equivalent
+
鐃緒申��申鐃緒申access to copy the source code from the same place counts as
+
鐃緒申��申鐃緒申distribution of the source code, even though third parties are not
+
鐃緒申��申鐃緒申compelled to copy the source along with the object code.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申You may not copy, modify, sublicense, or distribute the Program
+
鐃緒申��申鐃緒申except as expressly provided under this License.  Any attempt
+
鐃緒申��申鐃緒申otherwise to copy, modify, sublicense or distribute the Program is
+
鐃緒申��申鐃緒申void, and will automatically terminate your rights under this License.
+
鐃緒申��申鐃緒申However, parties who have received copies, or rights, from you under
+
鐃緒申��申鐃緒申this License will not have their licenses terminated so long as such
+
鐃緒申��申鐃緒申parties remain in full compliance.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申You are not required to accept this License, since you have not
+
鐃緒申��申鐃緒申signed it.  However, nothing else grants you permission to modify or
+
鐃緒申��申鐃緒申distribute the Program or its derivative works.  These actions are
+
鐃緒申��申鐃緒申prohibited by law if you do not accept this License.  Therefore, by
+
鐃緒申��申鐃緒申modifying or distributing the Program (or any work based on the
+
鐃緒申��申鐃緒申Program), you indicate your acceptance of this License to do so, and
+
鐃緒申��申鐃緒申all its terms and conditions for copying, distributing or modifying
+
鐃緒申��申鐃緒申the Program or works based on it.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申Each time you redistribute the Program (or any work based on the
+
鐃緒申��申鐃緒申Program), the recipient automatically receives a license from the
+
鐃緒申��申鐃緒申original licensor to copy, distribute or modify the Program subject to
+
鐃緒申��申鐃緒申these terms and conditions.  You may not impose any further
+
鐃緒申��申鐃緒申restrictions on the recipients' exercise of the rights granted herein.
+
鐃緒申��申鐃緒申You are not responsible for enforcing compliance by third parties to
+
鐃緒申��申鐃緒申this License.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申If, as a consequence of a court judgment or allegation of patent
+
鐃緒申��申鐃緒申infringement or for any other reason (not limited to patent issues),
+
鐃緒申��申鐃緒申conditions are imposed on you (whether by court order, agreement or
+
鐃緒申��申鐃緒申otherwise) that contradict the conditions of this License, they do not
+
鐃緒申��申鐃緒申excuse you from the conditions of this License.  If you cannot
+
鐃緒申��申鐃緒申distribute so as to satisfy simultaneously your obligations under this
+
鐃緒申��申鐃緒申License and any other pertinent obligations, then as a consequence you
+
鐃緒申��申鐃緒申may not distribute the Program at all.  For example, if a patent
+
鐃緒申��申鐃緒申license would not permit royalty-free redistribution of the Program by
+
鐃緒申��申鐃緒申all those who receive copies directly or indirectly through you, then
+
鐃緒申��申鐃緒申the only way you could satisfy both it and this License would be to
+
鐃緒申��申鐃緒申refrain entirely from distribution of the Program.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申If any portion of this section is held invalid or unenforceable under
+
鐃緒申��申鐃緒申any particular circumstance, the balance of the section is intended to
+
鐃緒申��申鐃緒申apply and the section as a whole is intended to apply in other
+
鐃緒申��申鐃緒申circumstances.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申It is not the purpose of this section to induce you to infringe any
+
鐃緒申��申鐃緒申patents or other property right claims or to contest validity of any
+
鐃緒申��申鐃緒申such claims; this section has the sole purpose of protecting the
+
鐃緒申��申鐃緒申integrity of the free software distribution system, which is
+
鐃緒申��申鐃緒申implemented by public license practices.  Many people have made
+
鐃緒申��申鐃緒申generous contributions to the wide range of software distributed
+
鐃緒申��申鐃緒申through that system in reliance on consistent application of that
+
鐃緒申��申鐃緒申system; it is up to the author/donor to decide if he or she is willing
+
鐃緒申��申鐃緒申to distribute software through any other system and a licensee cannot
+
鐃緒申��申鐃緒申impose that choice.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申This section is intended to make thoroughly clear what is believed to
+
鐃緒申��申鐃緒申be a consequence of the rest of this License.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申If the distribution and/or use of the Program is restricted in
+
鐃緒申��申鐃緒申certain countries either by patents or by copyrighted interfaces, the
+
鐃緒申��申鐃緒申original copyright holder who places the Program under this License
+
鐃緒申��申鐃緒申may add an explicit geographical distribution limitation excluding
+
鐃緒申��申鐃緒申those countries, so that distribution is permitted only in or among
+
鐃緒申��申鐃緒申countries not thus excluded.  In such case, this License incorporates
+
鐃緒申��申鐃緒申the limitation as if written in the body of this License.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申The Free Software Foundation may publish revised and/or new versions
+
鐃緒申��申鐃緒申of the General Public License from time to time.  Such new versions will
+
鐃緒申��申鐃緒申be similar in spirit to the present version, but may differ in detail to
+
鐃緒申��申鐃緒申address new problems or concerns.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申Each version is given a distinguishing version number.  If the Program
+
鐃緒申��申鐃緒申specifies a version number of this License which applies to it and ``any
+
鐃緒申��申鐃緒申later version'', you have the option of following the terms and conditions
+
鐃緒申��申鐃緒申either of that version or of any later version published by the Free
+
鐃緒申��申鐃緒申Software Foundation.  If the Program does not specify a version number of
+
鐃緒申��申鐃緒申this License, you may choose any version ever published by the Free Software
+
鐃緒申��申鐃緒申Foundation.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申If you wish to incorporate parts of the Program into other free
+
鐃緒申��申鐃緒申programs whose distribution conditions are different, write to the author
+
鐃緒申��申鐃緒申to ask for permission.  For software which is copyrighted by the Free
+
鐃緒申��申鐃緒申Software Foundation, write to the Free Software Foundation; we sometimes
+
鐃緒申��申鐃緒申make exceptions for this.  Our decision will be guided by the two goals
+
鐃緒申��申鐃緒申of preserving the free status of all derivatives of our free software and
+
鐃緒申��申鐃緒申of promoting the sharing and reuse of software generally.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@iftex
+
鐃緒申��申鐃緒申@heading NO WARRANTY
+
鐃緒申��申鐃緒申@end iftex
+
鐃緒申��申鐃緒申@ifinfo
+
鐃緒申��申鐃緒申@center NO WARRANTY
+
鐃緒申��申鐃緒申@end ifinfo
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+
鐃緒申��申鐃緒申FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW@.  EXCEPT WHEN
+
鐃緒申��申鐃緒申OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+
鐃緒申��申鐃緒申PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+
鐃緒申��申鐃緒申OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+
鐃緒申��申鐃緒申MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE@.  THE ENTIRE RISK AS
+
鐃緒申��申鐃緒申TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU@.  SHOULD THE
+
鐃緒申��申鐃緒申PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+
鐃緒申��申鐃緒申REPAIR OR CORRECTION.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@item
+
鐃緒申��申鐃緒申IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+
鐃緒申��申鐃緒申WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+
鐃緒申��申鐃緒申REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+
鐃緒申��申鐃緒申INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+
鐃緒申��申鐃緒申OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+
鐃緒申��申鐃緒申TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+
鐃緒申��申鐃緒申YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+
鐃緒申��申鐃緒申PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+
鐃緒申��申鐃緒申POSSIBILITY OF SUCH DAMAGES.
+
鐃緒申��申鐃緒申@end enumerate
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@iftex
+
鐃緒申��申鐃緒申@heading END OF TERMS AND CONDITIONS
+
鐃緒申��申鐃緒申@end iftex
+
鐃緒申��申鐃緒申@ifinfo
+
鐃緒申��申鐃緒申@center END OF TERMS AND CONDITIONS
+
鐃緒申��申鐃緒申@end ifinfo
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@page
+
鐃緒申��申鐃緒申@unnumberedsec How to Apply These Terms to Your New Programs
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  If you develop a new program, and you want it to be of the greatest
+
鐃緒申��申鐃緒申possible use to the public, the best way to achieve this is to make it
+
鐃緒申��申鐃緒申free software which everyone can redistribute and change under these terms.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  To do so, attach the following notices to the program.  It is safest
+
鐃緒申��申鐃緒申to attach them to the start of each source file to most effectively
+
鐃緒申��申鐃緒申convey the exclusion of warranty; and each file should have at least
+
鐃緒申��申鐃緒申the ``copyright'' line and a pointer to where the full notice is found.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@smallexample
+
鐃緒申��申鐃緒申@var{one line to give the program's name and an idea of what it does.}
+
鐃緒申��申鐃緒申Copyright (C) 19@var{yy}  @var{name of author}
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申This program is free software; you can redistribute it and/or
+
鐃緒申��申鐃緒申modify it under the terms of the GNU General Public License
+
鐃緒申��申鐃緒申as published by the Free Software Foundation; either version 2
+
鐃緒申��申鐃緒申of the License, or (at your option) any later version.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申This program is distributed in the hope that it will be useful,
+
鐃緒申��申鐃緒申but WITHOUT ANY WARRANTY; without even the implied warranty of
+
鐃緒申��申鐃緒申MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@.  See the
+
鐃緒申��申鐃緒申GNU General Public License for more details.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申You should have received a copy of the GNU General Public License
+
鐃緒申��申鐃緒申along with this program; if not, write to the Free Software
+
鐃緒申��申鐃緒申Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
鐃緒申��申鐃緒申@end smallexample
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申Also add information on how to contact you by electronic and paper mail.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申If the program is interactive, make it output a short notice like this
+
鐃緒申��申鐃緒申when it starts in an interactive mode:
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@smallexample
+
鐃緒申��申鐃緒申Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
+
鐃緒申��申鐃緒申Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
+
鐃緒申��申鐃緒申type `show w'.  This is free software, and you are welcome
+
鐃緒申��申鐃緒申to redistribute it under certain conditions; type `show c' 
+
鐃緒申��申鐃緒申for details.
+
鐃緒申��申鐃緒申@end smallexample
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申The hypothetical commands @samp{show w} and @samp{show c} should show
+
鐃緒申��申鐃緒申the appropriate parts of the General Public License.  Of course, the
+
鐃緒申��申鐃緒申commands you use may be called something other than @samp{show w} and
+
鐃緒申��申鐃緒申@samp{show c}; they could even be mouse-clicks or menu items---whatever
+
鐃緒申��申鐃緒申suits your program.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申You should also get your employer (if you work as a programmer) or your
+
鐃緒申��申鐃緒申school, if any, to sign a ``copyright disclaimer'' for the program, if
+
鐃緒申��申鐃緒申necessary.  Here is a sample; alter the names:
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@smallexample
+
鐃緒申��申鐃緒申@group
+
鐃緒申��申鐃緒申Yoyodyne, Inc., hereby disclaims all copyright
+
鐃緒申��申鐃緒申interest in the program `Gnomovision'
+
鐃緒申��申鐃緒申(which makes passes at compilers) written 
+
鐃緒申��申鐃緒申by James Hacker.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@var{signature of Ty Coon}, 1 April 1989
+
鐃緒申��申鐃緒申Ty Coon, President of Vice
+
鐃緒申��申鐃緒申@end group
+
鐃緒申��申鐃緒申@end smallexample
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申This General Public License does not permit incorporating your program into
+
鐃緒申��申鐃緒申proprietary programs.  If your program is a subroutine library, you may
+
鐃緒申��申鐃緒申consider it more useful to permit linking proprietary applications with the
+
鐃緒申��申鐃緒申library.  If this is what you want to do, use the GNU Library General
+
鐃緒申��申鐃緒申Public License instead of this License.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node Introduction, Lisp Data Types, Copying, Top
+
鐃緒申��申鐃緒申@chapter Introduction
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Most of the GNU Emacs text editor is written in the programming
+
鐃緒申��申鐃緒申language called Emacs Lisp.  You can write new code in Emacs Lisp and
+
鐃緒申��申鐃緒申install it as an extension to the editor.  However, Emacs Lisp is more
+
鐃緒申��申鐃緒申than a mere ``extension language''; it is a full computer programming
+
鐃緒申��申鐃緒申language in its own right.  You can use it as you would any other
+
鐃緒申��申鐃緒申programming language.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Because Emacs Lisp is designed for use in an editor, it has special
+
鐃緒申��申鐃緒申features for scanning and parsing text as well as features for handling
+
鐃緒申��申鐃緒申files, buffers, displays, subprocesses, and so on.  Emacs Lisp is
+
鐃緒申��申鐃緒申closely integrated with the editing facilities; thus, editing commands
+
鐃緒申��申鐃緒申are functions that can also conveniently be called from Lisp programs,
+
鐃緒申��申鐃緒申and parameters for customization are ordinary Lisp variables.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  This manual describes Emacs Lisp, presuming considerable familiarity
+
鐃緒申��申鐃緒申with the use of Emacs for editing.  (See @cite{The GNU Emacs Manual}
+
鐃緒申��申鐃緒申for this basic information.)  Generally speaking, the earlier chapters
+
鐃緒申��申鐃緒申describe features of Emacs Lisp that have counterparts in many
+
鐃緒申��申鐃緒申programming languages, and later chapters describe features that are
+
鐃緒申��申鐃緒申peculiar to Emacs Lisp or relate specifically to editing.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  This is edition 2.4.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@menu
+
鐃緒申��申鐃緒申* Caveats::             Flaws and a request for help.
+
鐃緒申��申鐃緒申* Lisp History::        Emacs Lisp is descended from Maclisp.
+
鐃緒申��申鐃緒申* Conventions::         How the manual is formatted.
+
鐃緒申��申鐃緒申* Acknowledgements::    The authors, editors, and sponsors of this manual.
+
鐃緒申��申鐃緒申@end menu
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node Caveats
+
鐃緒申��申鐃緒申@section Caveats
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  This manual has gone through numerous drafts.  It is nearly complete
+
鐃緒申��申鐃緒申but not flawless.  There are a few topics that are not covered, either
+
鐃緒申��申鐃緒申because we consider them secondary (such as most of the individual
+
鐃緒申��申鐃緒申modes) or because they are yet to be written.  Because we are not able
+
鐃緒申��申鐃緒申to deal with them completely, we have left out several parts
+
鐃緒申��申鐃緒申intentionally.  This includes most information about usage on VMS.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  The manual should be fully correct in what it does cover, and it is
+
鐃緒申��申鐃緒申therefore open to criticism on anything it says---from specific examples
+
鐃緒申��申鐃緒申and descriptive text, to the ordering of chapters and sections.  If
+
鐃緒申��申鐃緒申something is confusing, or you find that you have to look at the sources
+
鐃緒申��申鐃緒申or experiment to learn something not covered in the manual, then perhaps
+
鐃緒申��申鐃緒申the manual should be fixed.  Please let us know.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@iftex
+
鐃緒申��申鐃緒申  As you use the manual, we ask that you mark pages with corrections so
+
鐃緒申��申鐃緒申you can later look them up and send them in.  If you think of a simple,
+
鐃緒申��申鐃緒申real-life example for a function or group of functions, please make an
+
鐃緒申��申鐃緒申effort to write it up and send it in.  Please reference any comments to
+
鐃緒申��申鐃緒申the chapter name, section name, and function name, as appropriate, since
+
鐃緒申��申鐃緒申page numbers and chapter and section numbers will change and we may have
+
鐃緒申��申鐃緒申trouble finding the text you are talking about.  Also state the number
+
鐃緒申��申鐃緒申of the edition you are criticizing.
+
鐃緒申��申鐃緒申@end iftex
+
鐃緒申��申鐃緒申@ifinfo
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申As you use this manual, we ask that you send corrections as soon as you
+
鐃緒申��申鐃緒申find them.  If you think of a simple, real life example for a function
+
鐃緒申��申鐃緒申or group of functions, please make an effort to write it up and send it
+
鐃緒申��申鐃緒申in.  Please reference any comments to the node name and function or
+
鐃緒申��申鐃緒申variable name, as appropriate.  Also state the number of the edition
+
鐃緒申��申鐃緒申which you are criticizing.
+
鐃緒申��申鐃緒申@end ifinfo
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申Please mail comments and corrections to
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@example
+
鐃緒申��申鐃緒申bug-lisp-manual@@prep.ai.mit.edu
+
鐃緒申��申鐃緒申@end example
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@noindent
+
鐃緒申��申鐃緒申We let mail to this list accumulate unread until someone decides to
+
鐃緒申��申鐃緒申apply the corrections.  Months, and sometimes years, go by between
+
鐃緒申��申鐃緒申updates.  So please attach no significance to the lack of a reply---your
+
鐃緒申��申鐃緒申mail @emph{will} be acted on in due time.  If you want to contact the
+
鐃緒申��申鐃緒申Emacs maintainers more quickly, send mail to
+
鐃緒申��申鐃緒申@code{bug-gnu-emacs@@prep.ai.mit.edu}.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@display
+
鐃緒申��申鐃緒申 --Bil Lewis, Dan LaLiberte, Richard Stallman
+
鐃緒申��申鐃緒申@end display
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node Lisp History
+
鐃緒申��申鐃緒申@section Lisp History
+
鐃緒申��申鐃緒申@cindex Lisp history
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Lisp (LISt Processing language) was first developed in the late 1950's
+
鐃緒申��申鐃緒申at the Massachusetts Institute of Technology for research in artificial
+
鐃緒申��申鐃緒申intelligence.  The great power of the Lisp language makes it superior
+
鐃緒申��申鐃緒申for other purposes as well, such as writing editing commands.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@cindex Maclisp
+
鐃緒申��申鐃緒申@cindex Common Lisp
+
鐃緒申��申鐃緒申  Dozens of Lisp implementations have been built over the years, each
+
鐃緒申��申鐃緒申with its own idiosyncrasies.  Many of them were inspired by Maclisp,
+
鐃緒申��申鐃緒申which was written in the 1960's at MIT's Project MAC.  Eventually the
+
鐃緒申��申鐃緒申implementors of the descendants of Maclisp came together and developed a
+
鐃緒申��申鐃緒申standard for Lisp systems, called Common Lisp.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  GNU Emacs Lisp is largely inspired by Maclisp, and a little by Common
+
鐃緒申��申鐃緒申Lisp.  If you know Common Lisp, you will notice many similarities.
+
鐃緒申��申鐃緒申However, many of the features of Common Lisp have been omitted or
+
鐃緒申��申鐃緒申simplified in order to reduce the memory requirements of GNU Emacs.
+
鐃緒申��申鐃緒申Sometimes the simplifications are so drastic that a Common Lisp user
+
鐃緒申��申鐃緒申might be very confused.  We will occasionally point out how GNU Emacs
+
鐃緒申��申鐃緒申Lisp differs from Common Lisp.  If you don't know Common Lisp, don't
+
鐃緒申��申鐃緒申worry about it; this manual is self-contained.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node Conventions
+
鐃緒申��申鐃緒申@section Conventions
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申This section explains the notational conventions that are used in this
+
鐃緒申��申鐃緒申manual.  You may want to skip this section and refer back to it later.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@menu
+
鐃緒申��申鐃緒申* Some Terms::               Explanation of terms we use in this manual.
+
鐃緒申��申鐃緒申* nil and t::                How the symbols @code{nil} and @code{t} are used.
+
鐃緒申��申鐃緒申* Evaluation Notation::      The format we use for examples of evaluation.
+
鐃緒申��申鐃緒申* Printing Notation::        The format we use for examples that print output.
+
鐃緒申��申鐃緒申* Error Messages::           The format we use for examples of errors.
+
鐃緒申��申鐃緒申* Buffer Text Notation::     The format we use for buffer contents in examples.
+
鐃緒申��申鐃緒申* Format of Descriptions::   Notation for describing functions, variables, etc.
+
鐃緒申��申鐃緒申@end menu
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node Some Terms
+
鐃緒申��申鐃緒申@subsection Some Terms
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Throughout this manual, the phrases ``the Lisp reader'' and ``the Lisp
+
鐃緒申��申鐃緒申printer'' are used to refer to those routines in Lisp that convert
+
鐃緒申��申鐃緒申textual representations of Lisp objects into actual Lisp objects, and vice
+
鐃緒申��申鐃緒申versa.  @xref{Printed Representation}, for more details.  You, the
+
鐃緒申��申鐃緒申person reading this manual, are thought of as ``the programmer'' and are
+
鐃緒申��申鐃緒申addressed as ``you''.  ``The user'' is the person who uses Lisp programs,
+
鐃緒申��申鐃緒申including those you write.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@cindex fonts
+
鐃緒申��申鐃緒申  Examples of Lisp code appear in this font or form: @code{(list 1 2
+
鐃緒申��申鐃緒申3)}.  Names that represent arguments or metasyntactic variables appear
+
鐃緒申��申鐃緒申in this font or form: @var{first-number}.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node nil and t
+
鐃緒申��申鐃緒申@subsection @code{nil} and @code{t}
+
鐃緒申��申鐃緒申@cindex @code{nil}, uses of
+
鐃緒申��申鐃緒申@cindex truth value
+
鐃緒申��申鐃緒申@cindex boolean
+
鐃緒申��申鐃緒申@cindex false
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  In Lisp, the symbol @code{nil} has three separate meanings: it
+
鐃緒申��申鐃緒申is a symbol with the name @samp{nil}; it is the logical truth value
+
鐃緒申��申鐃緒申@var{false}; and it is the empty list---the list of zero elements.
+
鐃緒申��申鐃緒申When used as a variable, @code{nil} always has the value @code{nil}.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  As far as the Lisp reader is concerned, @samp{()} and @samp{nil} are
+
鐃緒申��申鐃緒申identical: they stand for the same object, the symbol @code{nil}.  The
+
鐃緒申��申鐃緒申different ways of writing the symbol are intended entirely for human
+
鐃緒申��申鐃緒申readers.  After the Lisp reader has read either @samp{()} or @samp{nil},
+
鐃緒申��申鐃緒申there is no way to determine which representation was actually written
+
鐃緒申��申鐃緒申by the programmer.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  In this manual, we use @code{()} when we wish to emphasize that it
+
鐃緒申��申鐃緒申means the empty list, and we use @code{nil} when we wish to emphasize
+
鐃緒申��申鐃緒申that it means the truth value @var{false}.  That is a good convention to use
+
鐃緒申��申鐃緒申in Lisp programs also.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@example
+
鐃緒申��申鐃緒申(cons 'foo ())                ; @r{Emphasize the empty list}
+
鐃緒申��申鐃緒申(not nil)                     ; @r{Emphasize the truth value @var{false}}
+
鐃緒申��申鐃緒申@end example
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@cindex @code{t} and truth
+
鐃緒申��申鐃緒申@cindex true
+
鐃緒申��申鐃緒申  In contexts where a truth value is expected, any non-@code{nil} value
+
鐃緒申��申鐃緒申is considered to be @var{true}.  However, @code{t} is the preferred way
+
鐃緒申��申鐃緒申to represent the truth value @var{true}.  When you need to choose a
+
鐃緒申��申鐃緒申value which represents @var{true}, and there is no other basis for
+
鐃緒申��申鐃緒申choosing, use @code{t}.  The symbol @code{t} always has value @code{t}.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  In Emacs Lisp, @code{nil} and @code{t} are special symbols that always
+
鐃緒申��申鐃緒申evaluate to themselves.  This is so that you do not need to quote them
+
鐃緒申��申鐃緒申to use them as constants in a program.  An attempt to change their
+
鐃緒申��申鐃緒申values results in a @code{setting-constant} error.  @xref{Accessing
+
鐃緒申��申鐃緒申Variables}.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node Evaluation Notation
+
鐃緒申��申鐃緒申@subsection Evaluation Notation
+
鐃緒申��申鐃緒申@cindex evaluation notation
+
鐃緒申��申鐃緒申@cindex documentation notation
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  A Lisp expression that you can evaluate is called a @dfn{form}.
+
鐃緒申��申鐃緒申Evaluating a form always produces a result, which is a Lisp object.  In
+
鐃緒申��申鐃緒申the examples in this manual, this is indicated with @samp{@result{}}:
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@example
+
鐃緒申��申鐃緒申(car '(1 2))
+
鐃緒申��申鐃緒申     @result{} 1
+
鐃緒申��申鐃緒申@end example
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@noindent
+
鐃緒申��申鐃緒申You can read this as ``@code{(car '(1 2))} evaluates to 1''.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  When a form is a macro call, it expands into a new form for Lisp to
+
鐃緒申��申鐃緒申evaluate.  We show the result of the expansion with
+
鐃緒申��申鐃緒申@samp{@expansion{}}.  We may or may not show the actual result of the
+
鐃緒申��申鐃緒申evaluation of the expanded form.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@example
+
鐃緒申��申鐃緒申(third '(a b c))
+
鐃緒申��申鐃緒申     @expansion{} (car (cdr (cdr '(a b c))))
+
鐃緒申��申鐃緒申     @result{} c
+
鐃緒申��申鐃緒申@end example
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Sometimes to help describe one form we show another form that
+
鐃緒申��申鐃緒申produces identical results.  The exact equivalence of two forms is
+
鐃緒申��申鐃緒申indicated with @samp{@equiv{}}.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@example
+
鐃緒申��申鐃緒申(make-sparse-keymap) @equiv{} (list 'keymap)
+
鐃緒申��申鐃緒申@end example
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node Printing Notation
+
鐃緒申��申鐃緒申@subsection Printing Notation
+
鐃緒申��申鐃緒申@cindex printing notation
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Many of the examples in this manual print text when they are
+
鐃緒申��申鐃緒申evaluated.  If you execute example code in a Lisp Interaction buffer
+
鐃緒申��申鐃緒申(such as the buffer @samp{*scratch*}), the printed text is inserted into
+
鐃緒申��申鐃緒申the buffer.  If you execute the example by other means (such as by
+
鐃緒申��申鐃緒申evaluating the function @code{eval-region}), the printed text is
+
鐃緒申��申鐃緒申displayed in the echo area.  You should be aware that text displayed in
+
鐃緒申��申鐃緒申the echo area is truncated to a single line.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Examples in this manual indicate printed text with @samp{@print{}},
+
鐃緒申��申鐃緒申irrespective of where that text goes.  The value returned by evaluating
+
鐃緒申��申鐃緒申the form (here @code{bar}) follows on a separate line.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@example
+
鐃緒申��申鐃緒申@group
+
鐃緒申��申鐃緒申(progn (print 'foo) (print 'bar))
+
鐃緒申��申鐃緒申     @print{} foo
+
鐃緒申��申鐃緒申     @print{} bar
+
鐃緒申��申鐃緒申     @result{} bar
+
鐃緒申��申鐃緒申@end group
+
鐃緒申��申鐃緒申@end example
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node Error Messages
+
鐃緒申��申鐃緒申@subsection Error Messages
+
鐃緒申��申鐃緒申@cindex error message notation
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Some examples signal errors.  This normally displays an error message
+
鐃緒申��申鐃緒申in the echo area.  We show the error message on a line starting with
+
鐃緒申��申鐃緒申@samp{@error{}}.  Note that @samp{@error{}} itself does not appear in
+
鐃緒申��申鐃緒申the echo area.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@example
+
鐃緒申��申鐃緒申(+ 23 'x)
+
鐃緒申��申鐃緒申@error{} Wrong type argument: integer-or-marker-p, x
+
鐃緒申��申鐃緒申@end example
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node Buffer Text Notation
+
鐃緒申��申鐃緒申@subsection Buffer Text Notation
+
鐃緒申��申鐃緒申@cindex buffer text notation
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Some examples show modifications to text in a buffer, with ``before''
+
鐃緒申��申鐃緒申and ``after'' versions of the text.  These examples show the contents of
+
鐃緒申��申鐃緒申the buffer in question between two lines of dashes containing the buffer
+
鐃緒申��申鐃緒申name.  In addition, @samp{@point{}} indicates the location of point.
+
鐃緒申��申鐃緒申(The symbol for point, of course, is not part of the text in the buffer;
+
鐃緒申��申鐃緒申it indicates the place @emph{between} two characters where point is
+
鐃緒申��申鐃緒申located.)
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@example
+
鐃緒申��申鐃緒申---------- Buffer: foo ----------
+
鐃緒申��申鐃緒申This is the @point{}contents of foo.
+
鐃緒申��申鐃緒申---------- Buffer: foo ----------
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申(insert "changed ")
+
鐃緒申��申鐃緒申     @result{} nil
+
鐃緒申��申鐃緒申---------- Buffer: foo ----------
+
鐃緒申��申鐃緒申This is the changed @point{}contents of foo.
+
鐃緒申��申鐃緒申---------- Buffer: foo ----------
+
鐃緒申��申鐃緒申@end example
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node Format of Descriptions
+
鐃緒申��申鐃緒申@subsection Format of Descriptions
+
鐃緒申��申鐃緒申@cindex description format
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Functions, variables, macros, commands, user options, and special
+
鐃緒申��申鐃緒申forms are described in this manual in a uniform format.  The first
+
鐃緒申��申鐃緒申line of a description contains the name of the item followed by its
+
鐃緒申��申鐃緒申arguments, if any.
+
鐃緒申��申鐃緒申@ifinfo
+
鐃緒申��申鐃緒申The category---function, variable, or whatever---appears at the
+
鐃緒申��申鐃緒申beginning of the line.
+
鐃緒申��申鐃緒申@end ifinfo
+
鐃緒申��申鐃緒申@iftex
+
鐃緒申��申鐃緒申The category---function, variable, or whatever---is printed next to the
+
鐃緒申��申鐃緒申right margin.
+
鐃緒申��申鐃緒申@end iftex
+
鐃緒申��申鐃緒申The description follows on succeeding lines, sometimes with examples.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@menu
+
鐃緒申��申鐃緒申* A Sample Function Description::       A description of an imaginary
+
鐃緒申��申鐃緒申                                          function, @code{foo}.
+
鐃緒申��申鐃緒申* A Sample Variable Description::       A description of an imaginary
+
鐃緒申��申鐃緒申                                          variable,
+
鐃緒申��申鐃緒申                                          @code{electric-future-map}.  
+
鐃緒申��申鐃緒申@end menu
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node A Sample Function Description
+
鐃緒申��申鐃緒申@subsubsection A Sample Function Description
+
鐃緒申��申鐃緒申@cindex function descriptions
+
鐃緒申��申鐃緒申@cindex command descriptions
+
鐃緒申��申鐃緒申@cindex macro descriptions
+
鐃緒申��申鐃緒申@cindex special form descriptions
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  In a function description, the name of the function being described
+
鐃緒申��申鐃緒申appears first.  It is followed on the same line by a list of parameters.
+
鐃緒申��申鐃緒申The names used for the parameters are also used in the body of the
+
鐃緒申��申鐃緒申description.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  The appearance of the keyword @code{&optional} in the parameter list
+
鐃緒申��申鐃緒申indicates that the arguments for subsequent parameters may be omitted
+
鐃緒申��申鐃緒申(omitted parameters default to @code{nil}).  Do not write
+
鐃緒申��申鐃緒申@code{&optional} when you call the function.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  The keyword @code{&rest} (which will always be followed by a single
+
鐃緒申��申鐃緒申parameter) indicates that any number of arguments can follow.  The value
+
鐃緒申��申鐃緒申of the single following parameter will be a list of all these arguments.
+
鐃緒申��申鐃緒申Do not write @code{&rest} when you call the function.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Here is a description of an imaginary function @code{foo}:
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@defun foo integer1 &optional integer2 &rest integers
+
鐃緒申��申鐃緒申The function @code{foo} subtracts @var{integer1} from @var{integer2},
+
鐃緒申��申鐃緒申then adds all the rest of the arguments to the result.  If @var{integer2}
+
鐃緒申��申鐃緒申is not supplied, then the number 19 is used by default.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@example
+
鐃緒申��申鐃緒申(foo 1 5 3 9)
+
鐃緒申��申鐃緒申     @result{} 16
+
鐃緒申��申鐃緒申(foo 5)
+
鐃緒申��申鐃緒申     @result{} 14
+
鐃緒申��申鐃緒申@end example
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申More generally,
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@example
+
鐃緒申��申鐃緒申(foo @var{w} @var{x} @var{y}@dots{})
+
鐃緒申��申鐃緒申@equiv{}
+
鐃緒申��申鐃緒申(+ (- @var{x} @var{w}) @var{y}@dots{})
+
鐃緒申��申鐃緒申@end example
+
鐃緒申��申鐃緒申@end defun
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Any parameter whose name contains the name of a type (e.g.,
+
鐃緒申��申鐃緒申@var{integer}, @var{integer1} or @var{buffer}) is expected to be of that
+
鐃緒申��申鐃緒申type.  A plural of a type (such as @var{buffers}) often means a list of
+
鐃緒申��申鐃緒申objects of that type.  Parameters named @var{object} may be of any type.
+
鐃緒申��申鐃緒申(@xref{Lisp Data Types}, for a list of Emacs object types.)
+
鐃緒申��申鐃緒申Parameters with other sorts of names (e.g., @var{new-file}) are
+
鐃緒申��申鐃緒申discussed specifically in the description of the function.  In some
+
鐃緒申��申鐃緒申sections, features common to parameters of several functions are
+
鐃緒申��申鐃緒申described at the beginning.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  @xref{Lambda Expressions}, for a more complete description of optional
+
鐃緒申��申鐃緒申and rest arguments.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Command, macro, and special form descriptions have the same format,
+
鐃緒申��申鐃緒申but the word `Function' is replaced by `Command', `Macro', or `Special
+
鐃緒申��申鐃緒申Form', respectively.  Commands are simply functions that may be called
+
鐃緒申��申鐃緒申interactively; macros process their arguments differently from functions
+
鐃緒申��申鐃緒申(the arguments are not evaluated), but are presented the same way.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Special form descriptions use a more complex notation to specify
+
鐃緒申��申鐃緒申optional and repeated parameters because they can break the argument
+
鐃緒申��申鐃緒申list down into separate arguments in more complicated ways.
+
鐃緒申��申鐃緒申@samp{@code{@r{[}@var{optional-arg}@r{]}}} means that @var{optional-arg} is
+
鐃緒申��申鐃緒申optional and @samp{@var{repeated-args}@dots{}} stands for zero or more
+
鐃緒申��申鐃緒申arguments.  Parentheses are used when several arguments are grouped into
+
鐃緒申��申鐃緒申additional levels of list structure.  Here is an example:
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@defspec count-loop (@var{var} [@var{from} @var{to} [@var{inc}]]) @var{body}@dots{}
+
鐃緒申��申鐃緒申This imaginary special form implements a loop that executes the
+
鐃緒申��申鐃緒申@var{body} forms and then increments the variable @var{var} on each
+
鐃緒申��申鐃緒申iteration.  On the first iteration, the variable has the value
+
鐃緒申��申鐃緒申@var{from}; on subsequent iterations, it is incremented by 1 (or by
+
鐃緒申��申鐃緒申@var{inc} if that is given).  The loop exits before executing @var{body}
+
鐃緒申��申鐃緒申if @var{var} equals @var{to}.  Here is an example:
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@example
+
鐃緒申��申鐃緒申(count-loop (i 0 10)
+
鐃緒申��申鐃緒申  (prin1 i) (princ " ")
+
鐃緒申��申鐃緒申  (prin1 (aref vector i)) (terpri))
+
鐃緒申��申鐃緒申@end example
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申If @var{from} and @var{to} are omitted, then @var{var} is bound to
+
鐃緒申��申鐃緒申@code{nil} before the loop begins, and the loop exits if @var{var} is
+
鐃緒申��申鐃緒申non-@code{nil} at the beginning of an iteration.  Here is an example:
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@example
+
鐃緒申��申鐃緒申(count-loop (done)
+
鐃緒申��申鐃緒申  (if (pending)
+
鐃緒申��申鐃緒申      (fixit)
+
鐃緒申��申鐃緒申    (setq done t)))
+
鐃緒申��申鐃緒申@end example
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申In this special form, the arguments @var{from} and @var{to} are
+
鐃緒申��申鐃緒申optional, but must both be present or both absent.  If they are present,
+
鐃緒申��申鐃緒申@var{inc} may optionally be specified as well.  These arguments are
+
鐃緒申��申鐃緒申grouped with the argument @var{var} into a list, to distinguish them
+
鐃緒申��申鐃緒申from @var{body}, which includes all remaining elements of the form.
+
鐃緒申��申鐃緒申@end defspec
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node A Sample Variable Description
+
鐃緒申��申鐃緒申@subsubsection A Sample Variable Description
+
鐃緒申��申鐃緒申@cindex variable descriptions
+
鐃緒申��申鐃緒申@cindex option descriptions
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  A @dfn{variable} is a name that can hold a value.  Although any
+
鐃緒申��申鐃緒申variable can be set by the user, certain variables that exist
+
鐃緒申��申鐃緒申specifically so that users can change them are called @dfn{user
+
鐃緒申��申鐃緒申options}.  Ordinary variables and user options are described using a
+
鐃緒申��申鐃緒申format like that for functions except that there are no arguments.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Here is a description of the imaginary @code{electric-future-map}
+
鐃緒申��申鐃緒申variable.@refill
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@defvar electric-future-map
+
鐃緒申��申鐃緒申The value of this variable is a full keymap used by Electric Command
+
鐃緒申��申鐃緒申Future mode.  The functions in this map allow you to edit commands you
+
鐃緒申��申鐃緒申have not yet thought about executing.
+
鐃緒申��申鐃緒申@end defvar
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  User option descriptions have the same format, but `Variable' is
+
鐃緒申��申鐃緒申replaced by `User Option'.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申@node Acknowledgements
+
鐃緒申��申鐃緒申@section Acknowledgements
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  This manual was written by Robert Krawitz, Bil Lewis, Dan LaLiberte,
+
鐃緒申��申鐃緒申Richard M. Stallman and Chris Welty, the volunteers of the GNU manual
+
鐃緒申��申鐃緒申group, in an effort extending over several years.  Robert J. Chassell
+
鐃緒申��申鐃緒申helped to review and edit the manual, with the support of the Defense
+
鐃緒申��申鐃緒申Advanced Research Projects Agency, ARPA Order 6082, arranged by Warren
+
鐃緒申��申鐃緒申A. Hunt, Jr. of Computational Logic, Inc.
+
鐃緒申��申鐃緒申
+
鐃緒申��申鐃緒申  Corrections were supplied by Karl Berry, Jim Blandy, Bard Bloom,
+
鐃緒申��申鐃緒申Stephane Boucher, David Boyes, Alan Carroll, Richard Davis, Lawrence
+
鐃緒申��申鐃緒申R. Dodd, Peter Doornbosch, David A. Duff, Chris Eich, Beverly
+
鐃緒申��申鐃緒申Erlebacher, David Eckelkamp, Ralf Fassel, Eirik Fuller, Stephen Gildea,
+
鐃緒申��申鐃緒申Bob Glickstein, Eric Hanchrow, George Hartzell, Nathan Hess, Masayuki
+
鐃緒申��申鐃緒申Ida, Dan Jacobson, Jak Kirman, Bob Knighten, Frederick M. Korz, Joe
+
鐃緒申��申鐃緒申Lammens, Glenn M. Lewis, K. Richard Magill, Brian Marick, Roland
+
鐃緒申��申鐃緒申McGrath, Skip Montanaro, John Gardiner Myers, Thomas A. Peterson,
+
鐃緒申��申鐃緒申Francesco Potorti, Friedrich Pukelsheim, Arnold D. Robbins, Raul
+
鐃緒申��申鐃緒申Rockwell, Per Starback, Shinichirou Sugou, Kimmo Suominen, Edward Tharp,
+
鐃緒申��申鐃緒申Bill Trost, Rickard Westman, Jean White, Matthew Wilding, Carl Witty,
+
鐃緒申��申鐃緒申Dale Worley, Rusty Wright, and David D. Zuhn.