Correct documentation, adding some content.
[muse-el.git] / muse.texi
blob682826d0edd2702ca9ba717c8203fabb4b169fe6
1 \input texinfo @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename muse.info
4 @settitle Muse
5 @c %**end of header
7 @dircategory Emacs
8 @direntry
9 * Muse: (muse). Authoring and publishing environment for Emacs.
10 @end direntry
12 @syncodeindex fn cp
14 @copying
15 This manual is for Muse version 3.01
17 For a list of the copyright holders, @ref{Contributors}
19 @quotation
20 Permission is granted to copy, distribute and/or modify this document
21 under the terms of the GNU General Public License.
22 @end quotation
23 @end copying
25 @titlepage
26 @title Muse manual
27 @subtitle an authoring and publishing environment
28 @subtitle for GNU Emacs and XEmacs
30 @c The following two commands
31 @c start the copyright page.
32 @page
33 @vskip 0pt plus 1filll
34 @insertcopying
35 @end titlepage
37 @c So the toc is printed at the start
38 @contents
40 @ifnottex
41 @node Top, Preface, (dir), (dir)
42 @comment  node-name,  next,  previous,  up
43 @top Muse
45 @insertcopying
46 @end ifnottex
48 @menu
49 * Preface::                     About the documentation
50 * Introduction::                What is Muse?
51 * Installation::                How to get the stable and development versions
52 * Getting Started::             
53 * Keystroke Summary::           
54 * Getting Help and Reporting Bugs::  
55 * History::                     
56 * Contributors::                Contributors to this documentation
57 * GNU General Public License::  
58 * Concept Index::               
60 @detailmenu
61  --- The Detailed Node Listing ---
63 Installation
65 * Releases::                    Released versions of Muse
66 * Development::                 Latest unreleased changes
68 @end detailmenu
69 @end menu
71 @node Preface, Introduction, Top, Top
72 @comment  node-name,  next,  previous,  up
73 @chapter Preface
75 This document describes Muse, which was written by John Wiegley
76 and is now maintained by Michael Olson.
78 This document is a work in progress, and your contribution will be
79 greatly appreciated.
81 @node Introduction, Installation, Preface, Top
82 @comment  node-name,  next,  previous,  up
83 @chapter Introduction
85 Emacs Muse is an authoring and publishing environment for Emacs.  It
86 simplifies the process of writings documents and publishing them to
87 various output formats.
89 Muse consists of two main parts: an enhanced text-mode for authoring
90 documents and navigating within Muse projects, and a set of publishing
91 styles for generating different kinds of output.
93 This idea is not in any way new. Numerous systems exist -- even one
94 other for Emacs itself (Bhl Mode). What Muse adds to the picture is a
95 more modular environment, with a rather simple core, in which "styles"
96 are derived from to create new styles. Much of Muse's overall
97 functionality is optional. For example, you can use the publisher
98 without the major-mode, or the mode without doing any publishing; or if
99 you don't load the Texinfo or LaTeX modules, those styles won't be
100 available.
102 The Muse codebase is a departure from emacs-wiki.el version 2.44. The
103 code has been restructured and rewritten, especially its publishing
104 functions. The focus in this revision is on the authoring and publishing
105 aspects, and the "wikiness" has been removed as a default behavior (to
106 be offered again as an optional module). CamelCase words are no longer
107 special by default.
109 @node Installation, Getting Started, Introduction, Top
110 @comment  node-name,  next,  previous,  up
111 @chapter Installation
113 @menu
114 * Releases::                    Released versions of Muse
115 * Development::                 Latest unreleased changes
116 @end menu
118 @node Releases, Development, Installation, Installation
119 @comment  node-name,  next,  previous,  up
120 @section Installing a release
122 Choose to install a release if you want to minimize risk.  Currently
123 Muse is in a pre-release stage, so no official releases have been made
124 yet.
126 Errors are corrected in development first.  Once fixes are confirmed, a
127 new release will be made.  User-visible changes will be announced on the
128 @email{emacs-wiki-discuss@@nongnu.org} mailing list.  @pxref{Getting
129 Help and Reporting Bugs}.
131 @cindex Debian package for Muse
133 Debian users can get Muse via apt-get.  @file{Muse} is available only at
134 Michael Olson's Debian repository.
136 @cindex releases, from source
138 You can also install the source distribution.
140 @enumerate
141 @item Download and unpack the latest version from @uref{http://www.mwolson.org/static/dist/muse/} .
142 @item Edit your @file{~/.emacs}.
144 @example
145 ;; Add the directories to your load path
146 (add-to-list 'load-path "/path/to/muse")
147 ;; Load Muse
148 (require 'muse)
149 @end example
151 @end enumerate
153 You can download the archive at the following locations:
155 @itemize
156 @item Current and past releases: @uref{http://www.mwolson.org/static/dist/muse/}
157 @end itemize
159 @node Development,  , Releases, Installation
160 @comment  node-name,  next,  previous,  up
161 @section Installing the development version
162 @cindex development
164 Choose the development version if you want to live on the bleeding
165 edge of Muse development or try out new features before release.
167 @cindex arch revision control system, downloading
168 The Arch revision control system allows you to retrieve previous
169 versions and select specific features and bug fixes.
171 Downloading the modules for the first time:
173 @enumerate
174 @item Install arch. Debian: @kbd{apt-get install tla} .  Other distros: see @uref{http://regexps.srparish.net/www/} .
175 @item Register the archive and download the modules.
177 @example
178 # Register the archive
179 tla register-archive http://www.mwolson.org/archives/2005
181 # Download Muse into the @file{muse/} subdirectory
182 tla get mwolson@@gnu.org--2005/muse--main--1.0 muse
183 @end example
185 @item Open your @file{~/.emacs} and add the @file{Muse/} directory to your load path.
187 @example
188 (add-to-list 'load-path "/path/to/muse")
189 @end example
191 @end enumerate
193 To list upstream changes not in local copy:
195 @example
196 # Change to the source directory you are interested in. Example:
197 cd muse/
199 # Display the summary of changes
200 tla missing --summary
201 @end example
203 @cindex updating Muse with Arch
205 To update to the latest version:
207 @example
208 cd muse
209 tla replay
210 @end example
212 You can also obtain the archive at the following locations on the web:
214 @itemize
215 @item Browse arch repository: @uref{http://www.mwolson.org/archives/}
216 @item Latest development snapshot: @uref{http://www.mwolson.org/static/dist/muse-latest.tar.gz}
217 @end itemize
219 The latest development snapshot will be kept up to date since it is
220 updated at the same time as the Arch repository.
222 @node Getting Started, Keystroke Summary, Installation, Top
223 @comment  node-name,  next,  previous,  up
224 @chapter Getting Started
226 To use Muse, add the directory containing its files to your
227 @file{load-path} variable, in your @file{.emacs} file.  Then, load in
228 the authoring mode, and the styles you wish to publish to.  For
229 example:
231 @lisp
232 (add-to-list 'load-path "<path to Muse>")
234 (require 'muse-mode)     ; load authoring mode
236 (require 'muse-html)     ; load publishing styles I use
237 (require 'muse-latex)
238 (require 'muse-texinfo)
239 (require 'muse-docbook)
240 @end lisp
242 Once loaded, the command @kbd{M-x muse-publish-this-file} will publish
243 an input document to any available style.  If you enable
244 @file{muse-mode} within a buffer, by typing @kbd{M-x muse-mode}, this
245 command will be bound to @kbd{C-c C-t}.
247 You should also type @kbd{M-x customize-group}, and give the name
248 @samp{muse}.  Change it to suit your preferences.  Each of the
249 options has its own documentation.
251 @node Keystroke Summary, Getting Help and Reporting Bugs, Getting Started, Top
252 @chapter Keystroke Summary
254 Here is a summary of keystrokes available in every Muse buffer:
256 @table @kbd
258 @item C-c C-a (`muse-index')
259 Display an index of all known Muse pages.
261 @item C-c C-b (`muse-browse-result')
262 Show the published result of this page.
264 @item C-c C-e (`muse-edit-link-at-point')
265 Edit link at point.
267 @item C-c C-f (`muse-project-find-file'), also C-c C-v
268 Open another Muse page.  Prompt for the name.
270 @item C-c C-l (`font-lock-mode')
271 Highlight/refresh the current buffer.
273 @item C-c C-p (`muse-project-publish')
274 Publish any Muse pages that have changed.
276 @item C-c C-v (`muse-project-find-file'), also C-c C-f
277 Open another Muse page.  Prompt for the name.
279 @item C-c = (`muse-what-changed')
280 Diff this page against the last backup version.
282 @item TAB
283 Move to the next Wiki reference.
285 @item S-TAB
286 Move to the previous Wiki reference.
288 @end table
291 @node Getting Help and Reporting Bugs, History, Keystroke Summary, Top
292 @comment  node-name,  next,  previous,  up
293 @chapter Getting Help and Reporting Bugs
294 @cindex help, getting
295 @cindex bugs, reporting
297 After you have read this guide, if you still have questions about
298 Muse, or if you have bugs to report, there are several places you can
301 @uref{http://www.mwolson.org/projects/MuseMode.html} is the page that
302 Michael Olson made for Muse.  For the duration of his
303 maintainership, it may be considered the official Muse website.
305 You can join the mailing list at
306 @email{emacs-wiki-discuss@@nongnu.org} using the subscription form at
307 @uref{http://mail.nongnu.org/mailman/listinfo/
308 emacs-wiki-discuss}. This mailing list is also available via Gmane
309 (@uref{http://gmane.org/}). The group is called
310 @samp{gmane.emacs.wiki.general}.
312 @uref{http://www.emacswiki.org/cgi-bin/wiki/MuseMode} is the
313 emacswiki.org page, and anyone may add tips and hints to it.
315 You can visit the IRC Freenode channel @samp{#emacs}. Many of the
316 contributors are frequently around and willing to answer your
317 questions.  The @samp{#muse} channel is also available for
318 Muse-specific help, and its current maintainer hangs out there.
320 You can also contact the maintainer of MuseMode, Michael Olson,
321 at @email{mwolson@@gnu.org}.
323 @node History, Contributors, Getting Help and Reporting Bugs, Top
324 @comment  node-name,  next,  previous,  up
325 @chapter History
326 @cindex history, of Muse
328 @itemize
329 @item 2004
331 John Wiegley started Muse upon realizing that EmacsWiki had some serious
332 limitations. Around February 2004, he started making "emacs-wiki version
333 3.00 APLHA", which eventually became known as Muse.
335 Most of those who frequent the emacs-wiki mailing list continued to use
336 emacs-wiki, mainly because Planner hasn't been ported over to it.
338 As of 2004-12-01, Michael Olson became the maintainer of Muse, as per
339 John Wiegley's request.
341 @end itemize
343 @node Contributors, GNU General Public License, History, Top
344 @comment  node-name,  next,  previous,  up
345 @chapter Contributors
346 @cindex contributors
348 @example
349 Copyright @copyright{} 2001, 2002, 2003, 2004 Free Software Foundation
350 @end example
352 The first draft of this document was taken from the emacs-wiki texinfo
353 manual.  Michael Olson adapted it for Muse and began the process of
354 adding content to it.
356 John Sullivan, did a majority of the work on the emacs-wiki texinfo
357 manual.
359 While Sacha Chua maintained emacs-wiki, she worked quite a bit on the
360 emacs-wiki texinfo manual.
362 @node GNU General Public License, Concept Index, Contributors, Top
363 @comment  node-name,  next,  previous,  up
364 @appendix GNU GENERAL PUBLIC LICENSE
365 @center Version 2, June 1991
366 @cindex GPL
367 @cindex GNU General Public License
369 @c This file is intended to be included in another file.
371 @display
372 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
373 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA
375 Everyone is permitted to copy and distribute verbatim copies
376 of this license document, but changing it is not allowed.
377 @end display
379 @appendixsec Preamble
381   The licenses for most software are designed to take away your
382 freedom to share and change it.  By contrast, the GNU General Public
383 License is intended to guarantee your freedom to share and change free
384 software---to make sure the software is free for all its users.  This
385 General Public License applies to most of the Free Software
386 Foundation's software and to any other program whose authors commit to
387 using it.  (Some other Free Software Foundation software is covered by
388 the GNU Library General Public License instead.)  You can apply it to
389 your programs, too.
391   When we speak of free software, we are referring to freedom, not
392 price.  Our General Public Licenses are designed to make sure that you
393 have the freedom to distribute copies of free software (and charge for
394 this service if you wish), that you receive source code or can get it
395 if you want it, that you can change the software or use pieces of it
396 in new free programs; and that you know you can do these things.
398   To protect your rights, we need to make restrictions that forbid
399 anyone to deny you these rights or to ask you to surrender the rights.
400 These restrictions translate to certain responsibilities for you if you
401 distribute copies of the software, or if you modify it.
403   For example, if you distribute copies of such a program, whether
404 gratis or for a fee, you must give the recipients all the rights that
405 you have.  You must make sure that they, too, receive or can get the
406 source code.  And you must show them these terms so they know their
407 rights.
409   We protect your rights with two steps: (1) copyright the software, and
410 (2) offer you this license which gives you legal permission to copy,
411 distribute and/or modify the software.
413   Also, for each author's protection and ours, we want to make certain
414 that everyone understands that there is no warranty for this free
415 software.  If the software is modified by someone else and passed on, we
416 want its recipients to know that what they have is not the original, so
417 that any problems introduced by others will not reflect on the original
418 authors' reputations.
420   Finally, any free program is threatened constantly by software
421 patents.  We wish to avoid the danger that redistributors of a free
422 program will individually obtain patent licenses, in effect making the
423 program proprietary.  To prevent this, we have made it clear that any
424 patent must be licensed for everyone's free use or not licensed at all.
426   The precise terms and conditions for copying, distribution and
427 modification follow.
429 @iftex
430 @appendixsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
431 @end iftex
432 @ifinfo
433 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
434 @end ifinfo
436 @enumerate 0
437 @item
438 This License applies to any program or other work which contains
439 a notice placed by the copyright holder saying it may be distributed
440 under the terms of this General Public License.  The ``Program'', below,
441 refers to any such program or work, and a ``work based on the Program''
442 means either the Program or any derivative work under copyright law:
443 that is to say, a work containing the Program or a portion of it,
444 either verbatim or with modifications and/or translated into another
445 language.  (Hereinafter, translation is included without limitation in
446 the term ``modification''.)  Each licensee is addressed as ``you''.
448 Activities other than copying, distribution and modification are not
449 covered by this License; they are outside its scope.  The act of
450 running the Program is not restricted, and the output from the Program
451 is covered only if its contents constitute a work based on the
452 Program (independent of having been made by running the Program).
453 Whether that is true depends on what the Program does.
455 @item
456 You may copy and distribute verbatim copies of the Program's
457 source code as you receive it, in any medium, provided that you
458 conspicuously and appropriately publish on each copy an appropriate
459 copyright notice and disclaimer of warranty; keep intact all the
460 notices that refer to this License and to the absence of any warranty;
461 and give any other recipients of the Program a copy of this License
462 along with the Program.
464 You may charge a fee for the physical act of transferring a copy, and
465 you may at your option offer warranty protection in exchange for a fee.
467 @item
468 You may modify your copy or copies of the Program or any portion
469 of it, thus forming a work based on the Program, and copy and
470 distribute such modifications or work under the terms of Section 1
471 above, provided that you also meet all of these conditions:
473 @enumerate a
474 @item
475 You must cause the modified files to carry prominent notices
476 stating that you changed the files and the date of any change.
478 @item
479 You must cause any work that you distribute or publish, that in
480 whole or in part contains or is derived from the Program or any
481 part thereof, to be licensed as a whole at no charge to all third
482 parties under the terms of this License.
484 @item
485 If the modified program normally reads commands interactively
486 when run, you must cause it, when started running for such
487 interactive use in the most ordinary way, to print or display an
488 announcement including an appropriate copyright notice and a
489 notice that there is no warranty (or else, saying that you provide
490 a warranty) and that users may redistribute the program under
491 these conditions, and telling the user how to view a copy of this
492 License.  (Exception: if the Program itself is interactive but
493 does not normally print such an announcement, your work based on
494 the Program is not required to print an announcement.)
495 @end enumerate
497 These requirements apply to the modified work as a whole.  If
498 identifiable sections of that work are not derived from the Program,
499 and can be reasonably considered independent and separate works in
500 themselves, then this License, and its terms, do not apply to those
501 sections when you distribute them as separate works.  But when you
502 distribute the same sections as part of a whole which is a work based
503 on the Program, the distribution of the whole must be on the terms of
504 this License, whose permissions for other licensees extend to the
505 entire whole, and thus to each and every part regardless of who wrote it.
507 Thus, it is not the intent of this section to claim rights or contest
508 your rights to work written entirely by you; rather, the intent is to
509 exercise the right to control the distribution of derivative or
510 collective works based on the Program.
512 In addition, mere aggregation of another work not based on the Program
513 with the Program (or with a work based on the Program) on a volume of
514 a storage or distribution medium does not bring the other work under
515 the scope of this License.
517 @item
518 You may copy and distribute the Program (or a work based on it,
519 under Section 2) in object code or executable form under the terms of
520 Sections 1 and 2 above provided that you also do one of the following:
522 @enumerate a
523 @item
524 Accompany it with the complete corresponding machine-readable
525 source code, which must be distributed under the terms of Sections
526 1 and 2 above on a medium customarily used for software interchange; or,
528 @item
529 Accompany it with a written offer, valid for at least three
530 years, to give any third party, for a charge no more than your
531 cost of physically performing source distribution, a complete
532 machine-readable copy of the corresponding source code, to be
533 distributed under the terms of Sections 1 and 2 above on a medium
534 customarily used for software interchange; or,
536 @item
537 Accompany it with the information you received as to the offer
538 to distribute corresponding source code.  (This alternative is
539 allowed only for noncommercial distribution and only if you
540 received the program in object code or executable form with such
541 an offer, in accord with Subsection b above.)
542 @end enumerate
544 The source code for a work means the preferred form of the work for
545 making modifications to it.  For an executable work, complete source
546 code means all the source code for all modules it contains, plus any
547 associated interface definition files, plus the scripts used to
548 control compilation and installation of the executable.  However, as a
549 special exception, the source code distributed need not include
550 anything that is normally distributed (in either source or binary
551 form) with the major components (compiler, kernel, and so on) of the
552 operating system on which the executable runs, unless that component
553 itself accompanies the executable.
555 If distribution of executable or object code is made by offering
556 access to copy from a designated place, then offering equivalent
557 access to copy the source code from the same place counts as
558 distribution of the source code, even though third parties are not
559 compelled to copy the source along with the object code.
561 @item
562 You may not copy, modify, sublicense, or distribute the Program
563 except as expressly provided under this License.  Any attempt
564 otherwise to copy, modify, sublicense or distribute the Program is
565 void, and will automatically terminate your rights under this License.
566 However, parties who have received copies, or rights, from you under
567 this License will not have their licenses terminated so long as such
568 parties remain in full compliance.
570 @item
571 You are not required to accept this License, since you have not
572 signed it.  However, nothing else grants you permission to modify or
573 distribute the Program or its derivative works.  These actions are
574 prohibited by law if you do not accept this License.  Therefore, by
575 modifying or distributing the Program (or any work based on the
576 Program), you indicate your acceptance of this License to do so, and
577 all its terms and conditions for copying, distributing or modifying
578 the Program or works based on it.
580 @item
581 Each time you redistribute the Program (or any work based on the
582 Program), the recipient automatically receives a license from the
583 original licensor to copy, distribute or modify the Program subject to
584 these terms and conditions.  You may not impose any further
585 restrictions on the recipients' exercise of the rights granted herein.
586 You are not responsible for enforcing compliance by third parties to
587 this License.
589 @item
590 If, as a consequence of a court judgment or allegation of patent
591 infringement or for any other reason (not limited to patent issues),
592 conditions are imposed on you (whether by court order, agreement or
593 otherwise) that contradict the conditions of this License, they do not
594 excuse you from the conditions of this License.  If you cannot
595 distribute so as to satisfy simultaneously your obligations under this
596 License and any other pertinent obligations, then as a consequence you
597 may not distribute the Program at all.  For example, if a patent
598 license would not permit royalty-free redistribution of the Program by
599 all those who receive copies directly or indirectly through you, then
600 the only way you could satisfy both it and this License would be to
601 refrain entirely from distribution of the Program.
603 If any portion of this section is held invalid or unenforceable under
604 any particular circumstance, the balance of the section is intended to
605 apply and the section as a whole is intended to apply in other
606 circumstances.
608 It is not the purpose of this section to induce you to infringe any
609 patents or other property right claims or to contest validity of any
610 such claims; this section has the sole purpose of protecting the
611 integrity of the free software distribution system, which is
612 implemented by public license practices.  Many people have made
613 generous contributions to the wide range of software distributed
614 through that system in reliance on consistent application of that
615 system; it is up to the author/donor to decide if he or she is willing
616 to distribute software through any other system and a licensee cannot
617 impose that choice.
619 This section is intended to make thoroughly clear what is believed to
620 be a consequence of the rest of this License.
622 @item
623 If the distribution and/or use of the Program is restricted in
624 certain countries either by patents or by copyrighted interfaces, the
625 original copyright holder who places the Program under this License
626 may add an explicit geographical distribution limitation excluding
627 those countries, so that distribution is permitted only in or among
628 countries not thus excluded.  In such case, this License incorporates
629 the limitation as if written in the body of this License.
631 @item
632 The Free Software Foundation may publish revised and/or new versions
633 of the General Public License from time to time.  Such new versions will
634 be similar in spirit to the present version, but may differ in detail to
635 address new problems or concerns.
637 Each version is given a distinguishing version number.  If the Program
638 specifies a version number of this License which applies to it and ``any
639 later version'', you have the option of following the terms and conditions
640 either of that version or of any later version published by the Free
641 Software Foundation.  If the Program does not specify a version number of
642 this License, you may choose any version ever published by the Free Software
643 Foundation.
645 @item
646 If you wish to incorporate parts of the Program into other free
647 programs whose distribution conditions are different, write to the author
648 to ask for permission.  For software which is copyrighted by the Free
649 Software Foundation, write to the Free Software Foundation; we sometimes
650 make exceptions for this.  Our decision will be guided by the two goals
651 of preserving the free status of all derivatives of our free software and
652 of promoting the sharing and reuse of software generally.
654 @iftex
655 @heading NO WARRANTY
656 @end iftex
657 @ifinfo
658 @center NO WARRANTY
659 @end ifinfo
661 @item
662 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
663 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
664 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
665 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
666 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
667 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
668 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
669 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
670 REPAIR OR CORRECTION.
672 @item
673 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
674 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
675 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
676 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
677 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
678 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
679 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
680 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
681 POSSIBILITY OF SUCH DAMAGES.
682 @end enumerate
684 @iftex
685 @heading END OF TERMS AND CONDITIONS
686 @end iftex
687 @ifinfo
688 @center END OF TERMS AND CONDITIONS
689 @end ifinfo
691 @page
692 @appendixsec Appendix: How to Apply These Terms to Your New Programs
694   If you develop a new program, and you want it to be of the greatest
695 possible use to the public, the best way to achieve this is to make it
696 free software which everyone can redistribute and change under these terms.
698   To do so, attach the following notices to the program.  It is safest
699 to attach them to the start of each source file to most effectively
700 convey the exclusion of warranty; and each file should have at least
701 the ``copyright'' line and a pointer to where the full notice is found.
703 @smallexample
704 @var{one line to give the program's name and a brief idea of what it does.}
705 Copyright (C) @var{yyyy}  @var{name of author}
707 This program is free software; you can redistribute it and/or modify
708 it under the terms of the GNU General Public License as published by
709 the Free Software Foundation; either version 2 of the License, or
710 (at your option) any later version.
712 This program is distributed in the hope that it will be useful,
713 but WITHOUT ANY WARRANTY; without even the implied warranty of
714 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
715 GNU General Public License for more details.
717 You should have received a copy of the GNU General Public License
718 along with this program; if not, write to the Free Software
719 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
720 @end smallexample
722 Also add information on how to contact you by electronic and paper mail.
724 If the program is interactive, make it output a short notice like this
725 when it starts in an interactive mode:
727 @smallexample
728 Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
729 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
730 This is free software, and you are welcome to redistribute it
731 under certain conditions; type `show c' for details.
732 @end smallexample
734 The hypothetical commands @samp{show w} and @samp{show c} should show
735 the appropriate parts of the General Public License.  Of course, the
736 commands you use may be called something other than @samp{show w} and
737 @samp{show c}; they could even be mouse-clicks or menu items---whatever
738 suits your program.
740 You should also get your employer (if you work as a programmer) or your
741 school, if any, to sign a ``copyright disclaimer'' for the program, if
742 necessary.  Here is a sample; alter the names:
744 @example
745 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
746 `Gnomovision' (which makes passes at compilers) written by James Hacker.
748 @var{signature of Ty Coon}, 1 April 1989
749 Ty Coon, President of Vice
750 @end example
752 This General Public License does not permit incorporating your program into
753 proprietary programs.  If your program is a subroutine library, you may
754 consider it more useful to permit linking proprietary applications with the
755 library.  If this is what you want to do, use the GNU Library General
756 Public License instead of this License.
759 @node Concept Index,  , GNU General Public License, Top
760 @comment  node-name,  next,  previous,  up
761 @unnumbered Index
763 @printindex cp
765 @bye
767 @c Local Variables:
768 @c ispell-local-pdict: "ispell-dict"
769 @c End: