improve makefile and move info/ into doc/

Signed-off-by: Mattias Andrée <maandree@operamail.com>

2 files changed, 1156 insertions, 0 deletions

diff --git a/doc/info/auto-auto-complete.texinfo b/doc/info/auto-auto-complete.texinfo
new file mode 100644
index 0000000..0931933
--- /dev/null
+++ b/doc/info/auto-auto-complete.texinfo
@@ -0,0 +1,651 @@
+\input texinfo   @c -*-texinfo-*-
+
+@c %**start of header
+@setfilename auto-auto-complete.info
+@settitle auto-auto-complete
+@afourpaper
+@documentencoding UTF-8
+@documentlanguage en
+@finalout
+@c %**end of header
+
+
+@dircategory Development
+@direntry
+* auto-auto-complete: (auto-auto-complete).        Autogenerate shell auto-completion scripts
+@end direntry
+
+
+@copying
+Copyright @copyright{} 2014, 2015 Mattias Andrée
+
+@quotation
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
+Texts. A copy of the license is included in the section entitled
+``GNU Free Documentation License''.
+@end quotation
+@end copying
+
+@ifnottex
+@node Top
+@top auto-auto-complete -- Autogenerate shell auto-completion scripts
+@insertcopying
+@end ifnottex
+
+@titlepage
+@title auto-auto-complete
+@subtitle Autogenerate shell auto-completion scripts
+@author by Mattias Andrée (maandree)
+
+@page
+@c @center `'
+@vskip 0pt plus 1filll
+@insertcopying
+@end titlepage
+
+@contents
+
+
+
+@menu
+* Overview::                        Brief overview of @command{auto-auto-complete}.
+* Invoking::                        Invocation of @command{auto-auto-complete}.
+* Syntax::                          The auto-auto-complete syntax.
+* GNU Free Documentation License::  Copying and sharing this manual.
+@end menu
+
+
+
+@node Overview
+@chapter Overview
+
+@command{auto-auto-complete} provides a LISP-like
+@footnote{A sane alternative to using XML.} declarative
+language for creating auto-completion scripts for commands
+in a shell-agnostic way. The current version of
+@command{auto-auto-complete} can use such files to generate
+auto-completion scripts for the @command{bash}, @command{zsh}
+and @command{fish} shells.
+
+@command{auto-auto-complete}'s language limited in comparsion
+to for example raw auto-completion scripts for the @command{bash}
+shell, however it is well enough for most projects.
+
+
+
+@node Invoking
+@chapter Invoking
+
+@command{auto-auto-complete} recognises two options:
+
+@table @option
+@item -o
+@itemx --output OUTPUT_FILE
+Specifies the pathname of the generated file.
+
+@item -s
+@itemx -f
+@itemx --file
+@itemx --source SOURCE_FILE
+Specifies the pathname of the auto-auto-complete script.
+@end table
+
+Both of these options must be used. Additionally
+the shell that the generate file should be generated
+for must be specified; this is done by adding name
+of the shell as a stand-along argument, for example
+@command{auto-auto-complete bash --output mycmd.bash --source mycmd.autocomplete}
+
+It is also possible to define variables that can be
+used the auto-auto-complete script. If you, for example,
+want to give the variable @var{command} the value
+@code{mycmd}, add the argument @option{command=mycmd}.
+It is also possible to define arrays, for example
+if you want the variable @var{srcopt} to be an array
+of the for values @code{-s}, @code{-f}, @code{--source}
+and @code{--file}, add the arguments @option{srcopt=-s},
+@option{srcopt=-f}, @option{srcopt=--source} and
+@option{srcopt=--file}. It is not possible to have
+variable whose name begin with a dash (`-').
+
+Alternatively you can run
+@command{auto-auto-complete SHELL --where COMMAND}
+(alternatively with @option{-w} instead of
+@option{--where}). This will print the pathname
+you should use for the generated file when installing
+it. However the path prefix will not be included,
+so if your package is installed to @file{/usr}
+@footnote{The command being installed to @file{/usr/bin}
+or @file{/usr/sbin}.}, you sould prepend @file{/usr}
+to the output.
+
+
+
+@node Syntax
+@chapter Syntax
+
+@command{auto-auto-complete} uses a LISP-like free form
+syntax. Valid whitespace is normal blank space, horizontal
+tab space@footnote{Also know simply as tab.},
+carriage return@footnote{The first character in a new line
+in for example the HTTP protocol and in Window's encoding
+for new lines, it was the new line character in the classical
+Mac operating systems}, line feed (new line) and form feed
+(new page). Comments can be started with either a semicolon
+(;) or a hash (#). Comments end at the next following
+new line, which may either be a carriage return, line feed
+or form feed. Comments cannot be started inside quotes.
+
+The backslash character (\) can be used to force the
+following character to be parsed verbatim, this is called
+escaping. It is highly discourage to use this to escape
+new lines, especially if the new line encoding used in the
+document is carrige return–line feed, as that would only
+escape the carrige return. There is also a set of characters
+that have a special meaning when they are escaped:
+
+@table @asis
+@item a
+Audible bell character.
+@item b
+Backspace character.
+@item e
+Escape character.
+@item f
+Form feed character.
+@item n
+Line feed character.
+@item r
+Carriage character.
+@item t
+Horizontal tab space character.
+@item v
+Vertical tab space character.
+@item 0
+Null character.
+@end table
+
+Quotes, either simple quotes (') or double quotes (")
+can be used to parse all character verbatim except
+backslash (\). A quote ends at the next quote character
+that is not escaped by a backslash (\) and is identical
+to the opening quote character. This is especially useful
+for escaping whitespace and round brackets.
+
+The rest of this chapter will demonstrate how to write a
+script by example of @command{ponysay} (because it uses
+most of the syntax).
+
+The first thing we do is to declare which command the
+script is for. We do this by creating the root brackets
+and put the name of the command as the first element.
+
+@example
+(ponysay)
+@end example
+
+However, @command{ponysay} has a very similar command
+called @command{ponythink}. It is sensible to let the
+same script be used for auto-complete for both commands,
+to do this we utilise that we can define variables
+when we invoke @command{auto-auto-complete}.
+
+@example
+((value command))
+@end example
+
+Now when we compile this script we need invoke
+@command{auto-auto-complete} with either
+@option{command=ponysay} or @option{command=ponythink}.
+If we want @command{ponysay} to be used if we
+do not specify a value for @var{command} we instead
+write:
+
+@example
+((value command ponysay))
+@end example
+
+Remember that we could give a variable multiple values.
+This can also be done here. However in this example
+we only want one value. For example, @command{((value var a b))}
+would generate @command{(a b)} if @var{var} has not been set.
+
+@command{ponysay} recognises the options @option{-h} and
+@option{--help} for printing a summary of recognised options.
+These options does not take any arguments and hence are specified
+with @code{(unargumented)}.
+
+@example
+((value command ponysay)
+  (unargumented (options -h --help)
+                (desc 'Show summary of options'))
+)
+@end example
+
+This only specifies that these option exists, if we also want
+the generated scripts to suggest @option{--help} we need to
+add @code{(complete --help)}.
+
+@example
+((value command ponysay)
+  (unargumented (options -h --help)
+                (complete --help)
+                (desc 'Show summary of options'))
+)
+@end example
+
+Now that we have our first option, lets add a few others, to
+keep the example short, we will skip the most of the options.
+
+@example
+((value command ponysay)
+  (unargumented (options -h --help)
+                (complete --help)
+                (desc 'Show summary of options'))
+  (unargumented (options -l --list)
+                (complete --list)
+                (desc 'List all MLP:FiM ponies'))
+  (unargumented (options +l ++list)
+                (complete ++list)
+                (desc 'List all non-MLP:FiM ponies'))
+  (unargumented (options -X --256-colours --256colours --x-colours)
+                (desc 'Use xterm colours'))
+)
+@end example
+
+Now (especially if we had added all options) we have many
+@code{(unargumented)} blocks. We can use @code{(multiple)}
+so we do not have to write @code{unargumented} so many times.
+
+@example
+((value command ponysay)
+  (multiple unargumented
+    ((options -h --help) (complete --help)
+     (desc 'Show summary of options'))
+    ((options -l --list) (complete --list)
+     (desc 'List all MLP:FiM ponies'))
+    ((options +l ++list) (complete ++list)
+     (desc 'List all non-MLP:FiM ponies'))
+    ((options -X --256-colours --256colours --x-colours)
+     (desc 'Use xterm colours'))
+  )
+)
+@end example
+
+To keep this example short we will truncate this to:
+
+@example
+((value command ponysay)
+  (multiple unargumented ...) ;We have cut out the options.
+)
+@end example
+
+@command{ponysay} also have a number of options that does
+take an argument. We will add a few of them.
+
+@example
+((value command ponysay)
+  (multiple unargumented ...) ;We have cut out the options.
+  (multiple argumented
+    ((options -f --file --pony) (complete --file --pony)
+     (desc 'Specify the pony that should printed'))
+    ((options -b --bubble --balloon) (complete --balloon)
+     (desc 'Specify message balloon style'))
+    ((options -W --wrap) (complete --wrap)
+     (desc 'Specify wrapping column'))
+    ((options +c --colour) (complete --colour)
+     (desc 'Specify colour of the balloon, balloon link and message'))
+  )
+)
+@end example
+
+Just like @command{ponysay --help} prints @code{--wrap COLUMN}
+to indicate that the argument for @option{--wrap} is is an
+index of the column where the message printed by @command{ponysay}
+is wrapped, shells could display the text @code{COLUMN} as
+a placeholder for the next argument when you have typed
+@option{--wrap}. To enable this in shells that support it,
+we use @code{(arg)}.
+
+@example
+((value command ponysay)
+  (multiple unargumented ...) ;We have cut out the options.
+  (multiple argumented
+    ((options -f --file --pony) (complete --file --pony) (arg PONY)
+     (desc 'Specify the pony that should printed'))
+    ((options -b --bubble --balloon) (complete --balloon) (arg STYLE)
+     (desc 'Specify message balloon style'))
+    ((options -W --wrap) (complete --wrap) (arg COLUMN)
+     (desc 'Specify wrapping column)')
+    ((options +c --colour) (complete --colour) (arg ANSI-COLOUR)
+     (desc 'Specify colour of the balloon, balloon link and message'))
+  )
+)
+@end example
+
+The next step now is to specify the type of argument the options
+want. To do this we use @code{(files)}. The elements in @code{(files)}
+specify what type of file the shell should suggest. Multiple
+type can be used. Tehe recognsied ones are:
+
+@table @code
+@item -0
+Do not suggest files, or do not suggest files of types specified
+after @code{-0}.
+@item -a
+Suggest all files.
+@item -f
+Suggest regular files and pipes.
+@item -r
+Suggest regular files but not pipes.
+@item -d
+Suggest directories.
+@item -l
+Suggest symlinks. This is suggest by default,
+but @code{-0} can be used to stop this.
+@item -s
+Suggest sockets.
+@item -D
+Suggest doors.
+@end table
+
+@example
+((value command ponysay)
+  (multiple unargumented ...) ;We have cut out the options.
+  (multiple argumented
+    ((options -f --file --pony) (complete --file --pony) (arg PONY)
+     (files -f)
+     (desc 'Specify the pony that should printed'))
+    ((options -b --bubble --balloon) (complete --balloon) (arg STYLE)
+     (files -f)
+     (desc 'Specify message balloon style'))
+    ((options -W --wrap) (complete --wrap) (arg COLUMN)
+     (files -0)
+     (desc Specify wrapping column))
+    ((options +c --colour) (complete --colour) (arg ANSI-COLOUR)
+     (files -0)
+     (desc 'Specify colour of the balloon, balloon link and message'))
+  )
+)
+@end example
+
+@code{(files)} can also be used to specify patterns (using
+@code{sh}-globbing) for the filenames of the files to suggest.
+For example @code{--pony} in @command{ponysay} should only,
+in respect to files, suggest files that end with @code{.pony}.
+
+@example
+((value command ponysay)
+  (multiple unargumented ...) ;We have cut out the options.
+  (multiple argumented
+    ((options -f --file --pony) (complete --file --pony) (arg PONY)
+     (files -f *.pony)
+     (desc 'Specify the pony that should printed'))
+    ((options -b --bubble --balloon) (complete --balloon) (arg STYLE)
+     (files -f *.say)
+     (desc 'Specify message balloon style'))
+    ((options -W --wrap) (complete --wrap) (arg COLUMN)
+     (files -0)
+     (desc Specify wrapping column))
+    ((options +c --colour) (complete --colour) (arg ANSI-COLOUR)
+     (files -0)
+     (desc 'Specify colour of the balloon, balloon link and message'))
+  )
+)
+@end example
+
+For @option{--balloon} files ending with @code{.say} should be
+suggested if the completion is for @command{ponysay}, but for
+@command{ponythink} @code{.think}-files should be suggest.
+We can use @code{(case)} to select this based on the value of
+the first element in the root block, which is the name of the command.
+
+@example
+((value command ponysay)
+  (multiple unargumented ...) ;We have cut out the options.
+  (multiple argumented
+    ((options -f --file --pony) (complete --file --pony) (arg PONY)
+     (files -f *.pony)
+     (desc 'Specify the pony that should printed'))
+    ((options -b --bubble --balloon) (complete --balloon) (arg STYLE)
+     (files -f (case (ponysay *.say) (ponythink *.think)))
+     (desc 'Specify message balloon style'))
+    ((options -W --wrap) (complete --wrap) (arg COLUMN)
+     (files -0)
+     (desc Specify wrapping column))
+    ((options +c --colour) (complete --colour) (arg ANSI-COLOUR)
+     (files -0)
+     (desc 'Specify colour of the balloon, balloon link and message'))
+  )
+)
+@end example
+
+Another part of options with arguments is suggestions that are not
+based on filenames.
+
+@example
+((value command ponysay)
+  (multiple unargumented ...) ;We have cut out the options.
+  (multiple argumented
+    ((options -f --file --pony) (complete --file --pony) (arg PONY)
+     (suggest pony-f) (files -f *.pony)
+     (desc 'Specify the pony that should printed'))
+    ((options -b --bubble --balloon) (complete --balloon) (arg STYLE)
+     (suggest balloon)
+     (files -f (case (ponysay *.say) (ponythink *.think)))
+     (desc 'Specify message balloon style'))
+    ((options -W --wrap) (complete --wrap) (arg COLUMN)
+     (suggest wrap) (files -0)
+     (desc Specify wrapping column))
+    ((options +c --colour) (complete --colour) (arg ANSI-COLOUR)
+     (files -0)
+     (desc 'Specify colour of the balloon, balloon link and message'))
+  )
+  (suggestion pony-f)  ;We will fill this in later...
+  (suggestion balloon) ;We will fill this in later...
+  (suggestion wrap)    ;We will fill this in later...
+)
+@end example
+
+Lets cut out the options again to make this shorter.
+
+@example
+((value command ponysay)
+  (multiple unargumented ...) ;We have cut out the options.
+  (multiple argumented ...)   ;We have cut out the options.
+  (suggestion pony-f)  ;We will fill this in later...
+  (suggestion balloon) ;We will fill this in later...
+  (suggestion wrap)    ;We will fill this in later...
+)
+@end example
+
+Another part of ponysay is that it will take also
+argument that are not associated with an option make
+make a message it prints out of thiat.
+
+@example
+((value command ponysay)
+  (default (arg MESSAGE) (files -0) (suggest message)
+   (desc 'Message spoken by the pony'))
+  (multiple unargumented ...) ;We have cut out the options.
+  (multiple argumented ...)   ;We have cut out the options.
+  (suggestion message) ;We will fill this in later...
+  (suggestion pony-f)  ;We will fill this in later...
+  (suggestion balloon) ;We will fill this in later...
+  (suggestion wrap)    ;We will fill this in later...
+)
+@end example
+
+A rather unusual part of @command{ponysay} is that
+it has variadic options. A variadic option is a option
+that takes all following arguments, unconditionally.
+For example, in @command{ponysay} you can write
+@code{--ponies twilight trixie} instead of
+@code{--pony twilight --pony trixie}. @code{(variadic)}
+is used to declare a variadic option. @code{(bind)}
+becomes interesting here; because @command{ponysay}'s
+variadic options have non-variadic counterparts, it
+is pleasant to reuse the non-variadic options'
+configurations. @code{(bind)} will copy everything
+that is missing except @code{(options)} and
+@code{(complete)}. In this example we will not
+use @code{(complete)} because we do not want variadic
+options to be suggest but we will use @code{(desc)}
+because we want to adjust the descriptions.
+
+@example
+((value command ponysay)
+  (default (arg MESSAGE) (files -0) (suggest message)
+   (desc 'Message spoken by the pony'))
+  (multiple unargumented ...) ;We have cut out the options.
+  (multiple argumented ...)   ;We have cut out the options.
+  (variadic (options --f --files --ponies) (bind -f)
+            (desc 'Specify the ponies that may be printed'))
+  (suggestion message) ;We will fill this in later...
+  (suggestion pony-f)  ;We will fill this in later...
+  (suggestion balloon) ;We will fill this in later...
+  (suggestion wrap)    ;We will fill this in later...
+)
+@end example
+
+Notice that we used @code{-f} for the element in @code{(bind)},
+this is because we want @option{--f}, @option{--files} and
+@code{--ponies} to have the same configurations (with exception
+for the description) as the @option{-f} option.
+
+Once again, to make the example shorter we will cut out
+some parts.
+
+@example
+( ;We have cut out everything but the (suggestion):s.
+  (suggestion message) ;We will fill this in later...
+  (suggestion pony-f)  ;We will fill this in later...
+  (suggestion balloon) ;We will fill this in later...
+  (suggestion wrap)    ;We will fill this in later...
+)
+@end example
+
+For @code{(suggestion message)} we want the word
+`MESSAGE' to be suggested to let the user know
+that the non-option arguments make up the message
+that is printed (if used).
+
+@example
+( ;We have cut out everything but the (suggestion):s.
+  (suggestion message (verbatim MESSAGE))
+  (suggestion pony-f)  ;We will fill this in later...
+  (suggestion balloon) ;We will fill this in later...
+  (suggestion wrap)    ;We will fill this in later...
+)
+@end example
+
+For @code{(suggestion pony-f)} we want, in addition
+to the .pony-files which as already been configured,
+.pony-files from @file{/usr/share/ponysay/ponies}
+to be suggested without the .pony-suffix.
+
+@example
+( ;We have cut out everything but the (suggestion):s.
+  (suggestion message (verbatim MESSAGE))
+  (suggestion pony-f (ls "'/usr/share/ponysay/ponies'" .pony))
+  (suggestion balloon) ;We will fill this in later...
+  (suggestion wrap)    ;We will fill this in later...
+)
+@end example
+
+However, if the shell supports executing comments to
+get suggetions we want to utilise this.
+
+@example
+( ;We have cut out everything but the (suggestion):s.
+  (suggestion message (verbatim MESSAGE))
+  (suggestion pony-f (exec "'/usr/bin/ponysay'" --onelist)
+                     (noexec ls "'/usr/share/ponysay/ponies'" .pony))
+  (suggestion balloon) ;We will fill this in later...
+  (suggestion wrap)    ;We will fill this in later...
+)
+@end example
+
+@code{(suggestion balloon)} will work very similarly.
+
+@example
+( ;We have cut out everything but the (suggestion):s.
+  (suggestion message (verbatim MESSAGE))
+  (suggestion pony-f (exec "'/usr/bin/ponysay'" --onelist)
+                     (noexec ls "'/usr/share/ponysay/ponies'" .pony))
+  (suggestion balloon (exec "'/usr/bin/ponysay'" --balloonlist)
+                      (no-exec ls "'/usr/share/ponysay/balloons'"
+                       (case (ponysay .say) (ponythink .think))))
+  (suggestion wrap) ;We will fill this in later...
+)
+@end example
+
+The first thing we want to do for @option{--wrap}
+is to give it some default suggestion.
+
+@example
+( ;We have cut out everything but (suggestion wrap).
+  (suggestion wrap (verbatim none inherit 100 60))
+)
+@end example
+
+The next step is to suggest the terminal's
+width minus 10 columns. In the Bash shell this
+can be calculated with
+@command{$(( $(stty size <&2 | cut -d ' ' -f 2) - 10 ))}.
+
+@example
+( ;We have cut out everything but (suggestion wrap).
+  (suggestion wrap
+     (verbatim none inherit 100 60)
+     (calc (pipe (stdin-fd (stty size) (stderr)) (cut -d ' ' -f 2)) - 10)
+  )
+)
+@end example
+
+As seen here @code{(pipe (a) (b) (c))} translates into
+@code{(a | b | c)}. There are a few similar blocks that
+can be used.
+
+@table @code
+@item (fullpipe (a) (b) (c))
+@code{(a |& b |& c)}, or equivalently:
+@code{(a 2>&1 | b 2>&1 | c)}
+@item (cat (a) (b) (c))
+@code{(a ; b ; c)}
+@item (and (a) (b) (c))
+@code{(a && b && c)}
+@item (or (a) (b) (c))
+@code{(a || b || c)}
+@end table
+
+It was also shown that @code{(stdin-fd (a) (stderr))} translates
+into @code{a <&2}. @code{(stdin)}, @code{(stdout)} and @code{(stderr)}
+translates into @code{0}, @code{1} and @code{2}, respectively.
+Additional @code{(stdin-fd a b)} translates into @code{a <&b},
+@code{(stdout-fd a b)} into @code{a >&b}, @code{(stderr-fd a b)} into @code{a 2>&b}
+and @code{(fd-fd a b c)} into @code{a b<>&c}.
+You can also redirect to files:
+
+@table @code
+@item (stdin a b)
+@code{a < b}
+@item (stdout a b)
+@code{a > b}
+@item (stderr a b)
+@code{a 2> b}
+@item (fd a b c)
+@code{a b> c}
+@end table
+
+
+
+@node GNU Free Documentation License
+@appendix GNU Free Documentation License
+@include fdl.texinfo
+
+@bye
+
diff --git a/doc/info/fdl.texinfo b/doc/info/fdl.texinfo
new file mode 100644
index 0000000..cb71f05
--- /dev/null
+++ b/doc/info/fdl.texinfo
@@ -0,0 +1,505 @@
+@c The GNU Free Documentation License.
+@center Version 1.3, 3 November 2008
+
+@c This file is intended to be included within another document,
+@c hence no sectioning command or @node.
+
+@display
+Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
+@uref{http://fsf.org/}
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+@end display
+
+@enumerate 0
+@item
+PREAMBLE
+
+The purpose of this License is to make a manual, textbook, or other
+functional and useful document @dfn{free} in the sense of freedom: to
+assure everyone the effective freedom to copy and redistribute it,
+with or without modifying it, either commercially or noncommercially.
+Secondarily, this License preserves for the author and publisher a way
+to get credit for their work, while not being considered responsible
+for modifications made by others.
+
+This License is a kind of ``copyleft'', which means that derivative
+works of the document must themselves be free in the same sense.  It
+complements the GNU General Public License, which is a copyleft
+license designed for free software.
+
+We have designed this License in order to use it for manuals for free
+software, because free software needs free documentation: a free
+program should come with manuals providing the same freedoms that the
+software does.  But this License is not limited to software manuals;
+it can be used for any textual work, regardless of subject matter or
+whether it is published as a printed book.  We recommend this License
+principally for works whose purpose is instruction or reference.
+
+@item
+APPLICABILITY AND DEFINITIONS
+
+This License applies to any manual or other work, in any medium, that
+contains a notice placed by the copyright holder saying it can be
+distributed under the terms of this License.  Such a notice grants a
+world-wide, royalty-free license, unlimited in duration, to use that
+work under the conditions stated herein.  The ``Document'', below,
+refers to any such manual or work.  Any member of the public is a
+licensee, and is addressed as ``you''.  You accept the license if you
+copy, modify or distribute the work in a way requiring permission
+under copyright law.
+
+A ``Modified Version'' of the Document means any work containing the
+Document or a portion of it, either copied verbatim, or with
+modifications and/or translated into another language.
+
+A ``Secondary Section'' is a named appendix or a front-matter section
+of the Document that deals exclusively with the relationship of the
+publishers or authors of the Document to the Document's overall
+subject (or to related matters) and contains nothing that could fall
+directly within that overall subject.  (Thus, if the Document is in
+part a textbook of mathematics, a Secondary Section may not explain
+any mathematics.)  The relationship could be a matter of historical
+connection with the subject or with related matters, or of legal,
+commercial, philosophical, ethical or political position regarding
+them.
+
+The ``Invariant Sections'' are certain Secondary Sections whose titles
+are designated, as being those of Invariant Sections, in the notice
+that says that the Document is released under this License.  If a
+section does not fit the above definition of Secondary then it is not
+allowed to be designated as Invariant.  The Document may contain zero
+Invariant Sections.  If the Document does not identify any Invariant
+Sections then there are none.
+
+The ``Cover Texts'' are certain short passages of text that are listed,
+as Front-Cover Texts or Back-Cover Texts, in the notice that says that
+the Document is released under this License.  A Front-Cover Text may
+be at most 5 words, and a Back-Cover Text may be at most 25 words.
+
+A ``Transparent'' copy of the Document means a machine-readable copy,
+represented in a format whose specification is available to the
+general public, that is suitable for revising the document
+straightforwardly with generic text editors or (for images composed of
+pixels) generic paint programs or (for drawings) some widely available
+drawing editor, and that is suitable for input to text formatters or
+for automatic translation to a variety of formats suitable for input
+to text formatters.  A copy made in an otherwise Transparent file
+format whose markup, or absence of markup, has been arranged to thwart
+or discourage subsequent modification by readers is not Transparent.
+An image format is not Transparent if used for any substantial amount
+of text.  A copy that is not ``Transparent'' is called ``Opaque''.
+
+Examples of suitable formats for Transparent copies include plain
+ASCII without markup, Texinfo input format, La@TeX{} input
+format, SGML or XML using a publicly available
+DTD, and standard-conforming simple HTML,
+PostScript or PDF designed for human modification.  Examples
+of transparent image formats include PNG, XCF and
+JPG.  Opaque formats include proprietary formats that can be
+read and edited only by proprietary word processors, SGML or
+XML for which the DTD and/or processing tools are
+not generally available, and the machine-generated HTML,
+PostScript or PDF produced by some word processors for
+output purposes only.
+
+The ``Title Page'' means, for a printed book, the title page itself,
+plus such following pages as are needed to hold, legibly, the material
+this License requires to appear in the title page.  For works in
+formats which do not have any title page as such, ``Title Page'' means
+the text near the most prominent appearance of the work's title,
+preceding the beginning of the body of the text.
+
+The ``publisher'' means any person or entity that distributes copies
+of the Document to the public.
+
+A section ``Entitled XYZ'' means a named subunit of the Document whose
+title either is precisely XYZ or contains XYZ in parentheses following
+text that translates XYZ in another language.  (Here XYZ stands for a
+specific section name mentioned below, such as ``Acknowledgements'',
+``Dedications'', ``Endorsements'', or ``History''.)  To ``Preserve the Title''
+of such a section when you modify the Document means that it remains a
+section ``Entitled XYZ'' according to this definition.
+
+The Document may include Warranty Disclaimers next to the notice which
+states that this License applies to the Document.  These Warranty
+Disclaimers are considered to be included by reference in this
+License, but only as regards disclaiming warranties: any other
+implication that these Warranty Disclaimers may have is void and has
+no effect on the meaning of this License.
+
+@item
+VERBATIM COPYING
+
+You may copy and distribute the Document in any medium, either
+commercially or noncommercially, provided that this License, the
+copyright notices, and the license notice saying this License applies
+to the Document are reproduced in all copies, and that you add no other
+conditions whatsoever to those of this License.  You may not use
+technical measures to obstruct or control the reading or further
+copying of the copies you make or distribute.  However, you may accept
+compensation in exchange for copies.  If you distribute a large enough
+number of copies you must also follow the conditions in section 3.
+
+You may also lend copies, under the same conditions stated above, and
+you may publicly display copies.
+
+@item
+COPYING IN QUANTITY
+
+If you publish printed copies (or copies in media that commonly have
+printed covers) of the Document, numbering more than 100, and the
+Document's license notice requires Cover Texts, you must enclose the
+copies in covers that carry, clearly and legibly, all these Cover
+Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
+the back cover.  Both covers must also clearly and legibly identify
+you as the publisher of these copies.  The front cover must present
+the full title with all words of the title equally prominent and
+visible.  You may add other material on the covers in addition.
+Copying with changes limited to the covers, as long as they preserve
+the title of the Document and satisfy these conditions, can be treated
+as verbatim copying in other respects.
+
+If the required texts for either cover are too voluminous to fit
+legibly, you should put the first ones listed (as many as fit
+reasonably) on the actual cover, and continue the rest onto adjacent
+pages.
+
+If you publish or distribute Opaque copies of the Document numbering
+more than 100, you must either include a machine-readable Transparent
+copy along with each Opaque copy, or state in or with each Opaque copy
+a computer-network location from which the general network-using
+public has access to download using public-standard network protocols
+a complete Transparent copy of the Document, free of added material.
+If you use the latter option, you must take reasonably prudent steps,
+when you begin distribution of Opaque copies in quantity, to ensure
+that this Transparent copy will remain thus accessible at the stated
+location until at least one year after the last time you distribute an
+Opaque copy (directly or through your agents or retailers) of that
+edition to the public.
+
+It is requested, but not required, that you contact the authors of the
+Document well before redistributing any large number of copies, to give
+them a chance to provide you with an updated version of the Document.
+
+@item
+MODIFICATIONS
+
+You may copy and distribute a Modified Version of the Document under
+the conditions of sections 2 and 3 above, provided that you release
+the Modified Version under precisely this License, with the Modified
+Version filling the role of the Document, thus licensing distribution
+and modification of the Modified Version to whoever possesses a copy
+of it.  In addition, you must do these things in the Modified Version:
+
+@enumerate A
+@item
+Use in the Title Page (and on the covers, if any) a title distinct
+from that of the Document, and from those of previous versions
+(which should, if there were any, be listed in the History section
+of the Document).  You may use the same title as a previous version
+if the original publisher of that version gives permission.
+
+@item
+List on the Title Page, as authors, one or more persons or entities
+responsible for authorship of the modifications in the Modified
+Version, together with at least five of the principal authors of the
+Document (all of its principal authors, if it has fewer than five),
+unless they release you from this requirement.
+
+@item
+State on the Title page the name of the publisher of the
+Modified Version, as the publisher.
+
+@item
+Preserve all the copyright notices of the Document.
+
+@item
+Add an appropriate copyright notice for your modifications
+adjacent to the other copyright notices.
+
+@item
+Include, immediately after the copyright notices, a license notice
+giving the public permission to use the Modified Version under the
+terms of this License, in the form shown in the Addendum below.
+
+@item
+Preserve in that license notice the full lists of Invariant Sections
+and required Cover Texts given in the Document's license notice.
+
+@item
+Include an unaltered copy of this License.
+
+@item
+Preserve the section Entitled ``History'', Preserve its Title, and add
+to it an item stating at least the title, year, new authors, and
+publisher of the Modified Version as given on the Title Page.  If
+there is no section Entitled ``History'' in the Document, create one
+stating the title, year, authors, and publisher of the Document as
+given on its Title Page, then add an item describing the Modified
+Version as stated in the previous sentence.
+
+@item
+Preserve the network location, if any, given in the Document for
+public access to a Transparent copy of the Document, and likewise
+the network locations given in the Document for previous versions
+it was based on.  These may be placed in the ``History'' section.
+You may omit a network location for a work that was published at
+least four years before the Document itself, or if the original
+publisher of the version it refers to gives permission.
+
+@item
+For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve
+the Title of the section, and preserve in the section all the
+substance and tone of each of the contributor acknowledgements and/or
+dedications given therein.
+
+@item
+Preserve all the Invariant Sections of the Document,
+unaltered in their text and in their titles.  Section numbers
+or the equivalent are not considered part of the section titles.
+
+@item
+Delete any section Entitled ``Endorsements''.  Such a section
+may not be included in the Modified Version.
+
+@item
+Do not retitle any existing section to be Entitled ``Endorsements'' or
+to conflict in title with any Invariant Section.
+
+@item
+Preserve any Warranty Disclaimers.
+@end enumerate
+
+If the Modified Version includes new front-matter sections or
+appendices that qualify as Secondary Sections and contain no material
+copied from the Document, you may at your option designate some or all
+of these sections as invariant.  To do this, add their titles to the
+list of Invariant Sections in the Modified Version's license notice.
+These titles must be distinct from any other section titles.
+
+You may add a section Entitled ``Endorsements'', provided it contains
+nothing but endorsements of your Modified Version by various
+parties---for example, statements of peer review or that the text has
+been approved by an organization as the authoritative definition of a
+standard.
+
+You may add a passage of up to five words as a Front-Cover Text, and a
+passage of up to 25 words as a Back-Cover Text, to the end of the list
+of Cover Texts in the Modified Version.  Only one passage of
+Front-Cover Text and one of Back-Cover Text may be added by (or
+through arrangements made by) any one entity.  If the Document already
+includes a cover text for the same cover, previously added by you or
+by arrangement made by the same entity you are acting on behalf of,
+you may not add another; but you may replace the old one, on explicit
+permission from the previous publisher that added the old one.
+
+The author(s) and publisher(s) of the Document do not by this License
+give permission to use their names for publicity for or to assert or
+imply endorsement of any Modified Version.
+
+@item
+COMBINING DOCUMENTS
+
+You may combine the Document with other documents released under this
+License, under the terms defined in section 4 above for modified
+versions, provided that you include in the combination all of the
+Invariant Sections of all of the original documents, unmodified, and
+list them all as Invariant Sections of your combined work in its
+license notice, and that you preserve all their Warranty Disclaimers.
+
+The combined work need only contain one copy of this License, and
+multiple identical Invariant Sections may be replaced with a single
+copy.  If there are multiple Invariant Sections with the same name but
+different contents, make the title of each such section unique by
+adding at the end of it, in parentheses, the name of the original
+author or publisher of that section if known, or else a unique number.
+Make the same adjustment to the section titles in the list of
+Invariant Sections in the license notice of the combined work.
+
+In the combination, you must combine any sections Entitled ``History''
+in the various original documents, forming one section Entitled
+``History''; likewise combine any sections Entitled ``Acknowledgements'',
+and any sections Entitled ``Dedications''.  You must delete all
+sections Entitled ``Endorsements.''
+
+@item
+COLLECTIONS OF DOCUMENTS
+
+You may make a collection consisting of the Document and other documents
+released under this License, and replace the individual copies of this
+License in the various documents with a single copy that is included in
+the collection, provided that you follow the rules of this License for
+verbatim copying of each of the documents in all other respects.
+
+You may extract a single document from such a collection, and distribute
+it individually under this License, provided you insert a copy of this
+License into the extracted document, and follow this License in all
+other respects regarding verbatim copying of that document.
+
+@item
+AGGREGATION WITH INDEPENDENT WORKS
+
+A compilation of the Document or its derivatives with other separate
+and independent documents or works, in or on a volume of a storage or
+distribution medium, is called an ``aggregate'' if the copyright
+resulting from the compilation is not used to limit the legal rights
+of the compilation's users beyond what the individual works permit.
+When the Document is included in an aggregate, this License does not
+apply to the other works in the aggregate which are not themselves
+derivative works of the Document.
+
+If the Cover Text requirement of section 3 is applicable to these
+copies of the Document, then if the Document is less than one half of
+the entire aggregate, the Document's Cover Texts may be placed on
+covers that bracket the Document within the aggregate, or the
+electronic equivalent of covers if the Document is in electronic form.
+Otherwise they must appear on printed covers that bracket the whole
+aggregate.
+
+@item
+TRANSLATION
+
+Translation is considered a kind of modification, so you may
+distribute translations of the Document under the terms of section 4.
+Replacing Invariant Sections with translations requires special
+permission from their copyright holders, but you may include
+translations of some or all Invariant Sections in addition to the
+original versions of these Invariant Sections.  You may include a
+translation of this License, and all the license notices in the
+Document, and any Warranty Disclaimers, provided that you also include
+the original English version of this License and the original versions
+of those notices and disclaimers.  In case of a disagreement between
+the translation and the original version of this License or a notice
+or disclaimer, the original version will prevail.
+
+If a section in the Document is Entitled ``Acknowledgements'',
+``Dedications'', or ``History'', the requirement (section 4) to Preserve
+its Title (section 1) will typically require changing the actual
+title.
+
+@item
+TERMINATION
+
+You may not copy, modify, sublicense, or distribute the Document
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense, or distribute it is void, and
+will automatically terminate your rights under this License.
+
+However, if you cease all violation of this License, then your license
+from a particular copyright holder is reinstated (a) provisionally,
+unless and until the copyright holder explicitly and finally
+terminates your license, and (b) permanently, if the copyright holder
+fails to notify you of the violation by some reasonable means prior to
+60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, receipt of a copy of some or all of the same material does
+not give you any rights to use it.
+
+@item
+FUTURE REVISIONS OF THIS LICENSE
+
+The Free Software Foundation may publish new, revised versions
+of the GNU Free Documentation 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.  See
+@uref{http://www.gnu.org/copyleft/}.
+
+Each version of the License is given a distinguishing version number.
+If the Document specifies that a particular numbered version of this
+License ``or any later version'' applies to it, you have the option of
+following the terms and conditions either of that specified version or
+of any later version that has been published (not as a draft) by the
+Free Software Foundation.  If the Document does not specify a version
+number of this License, you may choose any version ever published (not
+as a draft) by the Free Software Foundation.  If the Document
+specifies that a proxy can decide which future versions of this
+License can be used, that proxy's public statement of acceptance of a
+version permanently authorizes you to choose that version for the
+Document.
+
+@item
+RELICENSING
+
+``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any
+World Wide Web server that publishes copyrightable works and also
+provides prominent facilities for anybody to edit those works.  A
+public wiki that anybody can edit is an example of such a server.  A
+``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the
+site means any set of copyrightable works thus published on the MMC
+site.
+
+``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0
+license published by Creative Commons Corporation, a not-for-profit
+corporation with a principal place of business in San Francisco,
+California, as well as future copyleft versions of that license
+published by that same organization.
+
+``Incorporate'' means to publish or republish a Document, in whole or
+in part, as part of another Document.
+
+An MMC is ``eligible for relicensing'' if it is licensed under this
+License, and if all works that were first published under this License
+somewhere other than this MMC, and subsequently incorporated in whole
+or in part into the MMC, (1) had no cover texts or invariant sections,
+and (2) were thus incorporated prior to November 1, 2008.
+
+The operator of an MMC Site may republish an MMC contained in the site
+under CC-BY-SA on the same site at any time before August 1, 2009,
+provided the MMC is eligible for relicensing.
+
+@end enumerate
+
+@page
+@heading ADDENDUM: How to use this License for your documents
+
+To use this License in a document you have written, include a copy of
+the License in the document and put the following copyright and
+license notices just after the title page:
+
+@smallexample
+@group
+  Copyright (C)  @var{year}  @var{your name}.
+  Permission is granted to copy, distribute and/or modify this document
+  under the terms of the GNU Free Documentation License, Version 1.3
+  or any later version published by the Free Software Foundation;
+  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
+  Texts.  A copy of the license is included in the section entitled ``GNU
+  Free Documentation License''.
+@end group
+@end smallexample
+
+If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
+replace the ``with@dots{}Texts.''@: line with this:
+
+@smallexample
+@group
+    with the Invariant Sections being @var{list their titles}, with
+    the Front-Cover Texts being @var{list}, and with the Back-Cover Texts
+    being @var{list}.
+@end group
+@end smallexample
+
+If you have Invariant Sections without Cover Texts, or some other
+combination of the three, merge those two alternatives to suit the
+situation.
+
+If your document contains nontrivial examples of program code, we
+recommend releasing these examples in parallel under your choice of
+free software license, such as the GNU General Public License,
+to permit their use in free software.
+
+@c Local Variables:
+@c ispell-local-pdict: "ispell-dict"
+@c End: