aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar axel <axel@liljencrantz.se>2006-11-01 01:36:14 +1000
committerGravatar axel <axel@liljencrantz.se>2006-11-01 01:36:14 +1000
commit0099c3c42089fd6f564fab147a267fb6a34cdf64 (patch)
treed9f8e89f764b527f160c6968331a8069e8fa0743
parent885d16fcd65c8d0bb74922746119bfb15551e578 (diff)
Add table of contents to begining of documentation. This involves some restructuring of the documentation files.
darcs-hash:20061031153614-ac50b-7a6e97e30ae759591028227466e76c574b931fd5.gz
-rw-r--r--Makefile.in67
-rw-r--r--doc_src/design.hdr155
-rw-r--r--doc_src/faq.hdr136
-rw-r--r--doc_src/index.hdr (renamed from doc_src/doc.hdr)1378
-rw-r--r--doc_src/license.hdr989
-rw-r--r--user_doc.head.html4
6 files changed, 1378 insertions, 1351 deletions
diff --git a/Makefile.in b/Makefile.in
index 9afbfd64..a9492491 100644
--- a/Makefile.in
+++ b/Makefile.in
@@ -156,6 +156,7 @@ BUILTIN_DOC_SRC := doc_src/source.txt doc_src/and.txt \
BUILTIN_DOC_HDR := $(BUILTIN_DOC_SRC:.txt=.doxygen)
+HDR_FILES := doc_src/index.hdr doc_src/commands.hdr doc_src/design.hdr doc_src/license.hdr doc_src/faq.hdr
#
# Files containing documentation for external commands.
@@ -311,7 +312,7 @@ debug:
# User documentation, describing the features of the fish shell.
#
-user_doc: doc_src/doc.hdr Doxyfile.user user_doc.head.html $(CMD_DOC_SRC) $(BUILTIN_DOC_SRC)
+user_doc: $(HDR_FILES) Doxyfile.user user_doc.head.html $(CMD_DOC_SRC) $(BUILTIN_DOC_SRC)
$(MAKE) doc.h # Depend on the source (doc.hdr) and manually make the intermediate as needed
doxygen Doxyfile.user
touch user_doc
@@ -358,27 +359,45 @@ xsel-0.9.6/xsel: xsel-0.9.6
#
+# commands.hdr collects documentation on all commands, functions and
+# builtins
+#
+
+doc_src/commands.hdr:$(BUILTIN_DOC_SRC) $(CMD_DOC_SRC)
+ rm -f commands.tmp;
+ echo "/** \page commands Commands" >>commands.tmp;
+ echo "Fish ships with a large number of builtin commands, shellscript functions and external commandss. These are all described below. " >>commands.tmp;
+ for i in `printf "%s\n" $(BUILTIN_DOC_SRC) $(CMD_DOC_SRC)|sort`; do \
+ echo "<hr>" >>commands.tmp; \
+ cat $$i >>commands.tmp; \
+ echo >>commands.tmp; \
+ echo >>commands.tmp; \
+ echo "Back to <a href='index.html#toc-commands'>index</a>". >>commands.tmp; \
+ done
+ echo "*/" >>commands.tmp
+ mv commands.tmp doc_src/commands.hdr
+
+
+#
# doc.h is a compilation of the various snipptes of text used both for
# the user documentation and for internal help functions into a single
# file that can be parsed dy Doxygen to generate the user
# documentation.
#
-doc.h:$(BUILTIN_DOC_SRC) $(CMD_DOC_SRC) doc_src/doc.hdr
- cat doc_src/doc.hdr >doc.h;
- echo "/** \page builtins Builtin commands" >>doc.h;
- for i in `printf "%s\n" $(BUILTIN_DOC_SRC)|sort`; do \
- echo "<hr>" >>doc.h; \
- cat $$i >>doc.h; \
- done
- echo "*/" >>doc.h
- echo "/** \page commands External commands and functions" >>doc.h;
- echo "\c fish is shipped with commands which do not use any internal parts of the shell, and are therefore not written as builtins, but separate commands. Fish also features a large number of shellscript functions." >>doc.h
- for i in `printf "%s\n" $(CMD_DOC_SRC)|sort`; do \
- echo "<hr>" >>doc.h; \
- cat $$i >>doc.h; \
- done
- echo "*/" >>doc.h
+doc.h:$(HDR_FILES)
+ rm -f doc.h
+ echo "/** \mainpage Fish user documentation" >doc.tmp
+ echo "\section toc Table of contents" >>doc.tmp
+ echo '- <a href="index.html" name="toc-index">Fish user documentation</a>' >>doc.tmp
+ for i in $(HDR_FILES); do\
+ sed <$$i >>doc.tmp -n \
+ -e 's,.*\\page *\([^ ]*\) *\(.*\)$$,- <a href="'`basename $$i .hdr`'.html" name="toc-'`basename $$i .hdr`'">\2</a>,p' \
+ -e 's,.*\\section *\([^ ]*\) *\(.*\)$$, - <a href="'`basename $$i .hdr`'.html#\1" name="toc-'`basename $$i .hdr`'">\2</a>,p' \
+# -e 's,.*\\subsection *\([^ ]*\) *\(.*\)$$, - <a href="'`basename $$i .hdr`'.html#\1" name="toc-'`basename $$i .hdr`'">\2</a>,p'; \
+ done
+ cat $(HDR_FILES) >>doc.tmp;
+ mv doc.tmp doc.h
#
@@ -860,18 +879,29 @@ rpm: fish-@PACKAGE_VERSION@.tar.bz2 fish.spec
mv /usr/src/redhat/SRPMS/fish*@PACKAGE_VERSION@*.src.rpm .
.PHONY: rpm
+
#
# Cleanup targets
#
+#
+# distclean should restore the tree to the state right after extracting a tarball.
+#
+
distclean: clean
rm -f fish.spec doc_src/Doxyfile
- rm -f etc/fish etc/fish_interactive.fish seq share/fish
+ rm -f etc/config.fish share/config_interactive.fish seq share/config.fish
rm -f config.status config.log config.h Makefile
.PHONY: distclean
+
+#
+# clean removes everything built by the makefile, but not things that
+# are created by the configure script.
+#
+
clean:
- rm -f *.o doc.h doc_src/*.doxygen doc_src/*.c doc_src/*.o
+ rm -f *.o doc.h doc.tmp doc_src/*.doxygen doc_src/*.c doc_src/*.o doc_src/commands.hdr
rm -f tests/tmp.err tests/tmp.out tests/tmp.status tests/foo.txt
rm -f tokenizer_test fish key_reader set_color gen_hdr2 mimedb
rm -f fishd fish_pager count fish_tests
@@ -884,6 +914,7 @@ clean:
rm -f $(TRANSLATIONS)
.PHONY: clean
+
# DO NOT DELETE THIS LINE -- make depend depends on it.
builtin.o: config.h fallback.h util.h wutil.h builtin.h function.h complete.h
diff --git a/doc_src/design.hdr b/doc_src/design.hdr
new file mode 100644
index 00000000..963a2ab0
--- /dev/null
+++ b/doc_src/design.hdr
@@ -0,0 +1,155 @@
+/** \page design Design document
+
+\section design-overview Overview
+
+This is a description of the design principles that have been used to
+design fish. The fish design has three high level goals. These are:
+
+-# Everything that can be done in other shell languages should be
+possible to do in fish, though fish may rely on external commands in
+doing so.
+-# Fish should be user friendly, but not at the expense of expressiveness.
+Most tradeoffs between power and ease of use can be avoided with careful design.
+-# Whenever possible without breaking the above goals, fish should
+follow the Posix syntax.
+
+To achive these high-level goals, the fish design relies on a number
+of more specific design principles. These are presented below,
+together with a rationale and a few examples for each.
+
+\section ortho The law of orthogonality
+
+The shell language should have a small set of orthogonal features. Any
+situation where two features are related but not identical, one of them
+should be removed, and the other should be made powerful and general
+enough to handle all common use cases of either feature.
+
+Rationale:
+
+Related features make the language larger, which makes it harder to
+learn. It also increases the size of the sourcecode, making the
+program harder to maintain and update.
+
+Examples:
+
+- Here documents are too similar to using echo inside of a pipeline.
+- Subshells, command substitution and process substitution are strongly related. \c fish only supports command substitution, the others can be achived either using a block or the psub shellscript function.
+- Having both aliases and functions is confusing, especially since both of them have limitations and problems. \c fish functions have none of the drawbacks of either syntax.
+- The many Posix quoting styles are silly, especially \$''.
+
+
+\section sep The law of minimalism
+
+The shell should only contain features that cannot be implemented in
+a reasonable way outside of the shell. A large performance decrease,
+as well as some program complexity increase is acceptable in order to
+improve separation.
+
+Rationale:
+
+A modular project is easier to maintain since smaller programs are far
+easier to understand than larger ones. A modular project is also more
+future proof since the modules can be individually
+replaced. Modularity also decreases the severity of bugs, since there
+is good hope that a bug, even a serious one, in one module, does not
+take the whole system down.
+
+Examples:
+
+- Builtin commands should only be created when it cannot be
+avoided. \c echo, \c kill, \c printf and \c time are among the commands
+that fish does not implement internally since they can be provided as
+external commands. Several other commands that are commonly implemented
+as builtins and can not be implemented as external commands,
+including \c type, \c vared, \c pushd and \c popd are implemented as shellscript
+functions in fish.
+- Mathematical calculations, regex matching, generating lists of numbers
+and many other funtions can easily be done in external programs. They
+should not be supported internally by the shell.
+
+The law of minimalism does not imply that a large feature set is
+bad. So long as a feature is not part of the shell itself, but a
+separate command or at least a shellscript function, bloat is fine.
+
+\section conf Configurability is the root of all evil
+
+Every configuration option in a program is a place where the program
+is too stupid to figure out for itself what the user really wants, and
+should be considered a failiure of both the program and the programmer
+who implemented it.
+
+Rationale:
+
+Different configuration options are a nightmare to maintain, since the
+number of potential bugs caused by specific configuration combinations
+quickly becomes an issue. Configuration options often imply
+assumptions about the code which change when reimplementing the code,
+causing issues with backwards compatibility. But mostly, configuration
+options should be avoided since they simply should not exist, as the
+program should be smart enough to do what is best, or at least a good
+enough approximation of it.
+
+Examples:
+
+- Fish allows the user to set various syntax highlighting colors. This is needed because fish does not know what colors the terminal uses by default, which might make some things unreadable. The proper solution would be for text color preferences to be defined centrally by the user for all programs, and for the terminal emulator to send these color properties to fish.
+- Fish does not allow you to set the history filename, the number of history entries, different language substyles or any number of other common shell configuration options.
+
+A special note on the evils of configurability is the long list of
+very useful features found in some shells, that are not turned on by
+default. Both zsh and bash support command specific completions, but
+no such completions are shipped with bash by default, and they are
+turned of by default in zsh. Other features that zsh support that are
+disabled by default include tab-completion of strings containing
+wildcards, a sane completion pager and a history file.
+
+\section user The law of user focus
+
+When designing a program, one should first think about how to make a
+intuitive and powerful program. Implementation issues should only be
+considered once a user interface has been designed.
+
+Rationale:
+
+This design rule is different than the others, since it describes how
+one should go about designing new features, not what the features
+should be. The problem with focusing on what can be done, and what is
+easy to do, is that to much of the implementation is exposed. This
+means that the user must know a great deal about the underlying system
+to be able to guess how the shell works, it also means that the
+language will often be rather low-level.
+
+Examples:
+
+- There should only be one type of input to the shell, lists of commands. Loops, conditionals and variable assignments are all performed through regular commands.
+- The differences between builtin commands, shellscript functions and builtin commands should be made as small as possible. Builtins and shellscript functions should have exactly the same types of argument expansion as other commands, should be possible to use in any position in a pipeline, and should support any io redirection.
+- Instead of forking when performing command substitution to provide a fake variable scope, all fish commands are performed from the same process, and fish instead supports true scoping
+- All blocks end with the \c end builtin
+
+\section disc The law of discoverability
+
+A program should be designed to make its features as
+easy as possible to discover for the user.
+
+Rationale:
+
+A program whose features are discoverable turns a new user into an
+expert in a shorter span of time, since the user will become an expert
+on the program simply by using it.
+
+The main benefit of a graphical program over a command line-based
+program is discoverability. In a graphical program, one can discover
+all the common features by simply looking at the user interface and
+guessing what the different buttons, menus and other widgets do. The
+traditional way to discover features in commandline programs is
+through manual pages. This requires both that the user starts to use a
+different program, and the she/he then remembers the new information
+until the next time she/he uses the same program.
+
+Examples:
+
+- Everything should be tab-completable, and every tab completion should have a description
+- Every syntax error and error in a builtin command should contain an error message describing what went wrong and a relevant help page. Whenever possible, errors should be flagged red by the syntax highlighter.
+- The help manual should be easy to read, easily available from the shell, complete and contain many examples
+- The language should be uniform, so that once the user understands the command/argument syntax, he will know the whole language, and be able to use tab-completion to discover new featues.
+
+*/
diff --git a/doc_src/faq.hdr b/doc_src/faq.hdr
new file mode 100644
index 00000000..04961a8a
--- /dev/null
+++ b/doc_src/faq.hdr
@@ -0,0 +1,136 @@
+/** \page faq Frequently asked questions
+
+- <a href='#faq-cwd-symlink'>Why does cd, pwd and other fish commands always resolve symlinked directories to their canonical path?</a>
+- <a href='#faq-cd-autocomplete'>Why does the cd command autocompletion list the subdirectories of my home directory as completions?</a>
+- <a href='#faq-cd-implicit'>I accidentally entered a directory path and fish changed directory. What happened?</a>
+- <a href='#faq-open'>The open command doesn't work.</a>
+- <a href='#faq-default'>How do I make fish my default shell?</a>
+- <a href='#faq-titlebar'>I'm seeing weird output before each prompt when using screen. What's wrong?</a>
+- <a href='#faq-greeting'>How do I change the greeting message?</a>
+
+<hr>
+
+\section faq-cwd-symlink Why does cd, $PWD and and various fish commands always resolve symlinked directories to their canonical path?
+
+<i>
+For example if ~/images is a symlink to ~/Documents/Images, if I write
+'cd images', my prompt will say ~/D/Images, not ~/images.
+</i>
+
+Because it is impossible to consistently keep symlinked directories
+unresolved. It is indeed possible to do this partially, and many other
+shells do so. But it was felt there are enough serious corner cases
+that this is a bad idea. Most such issues have to do with how '..' is
+handled, and are varitations of the following example:
+
+Writing <code>cd images; ls ..</code> given the above directory
+structure would list the contents of ~/Documents, not of ~, even
+though using <code>cd ..</code> changes the current direcotry to ~,
+and the prompt, the pwd builtin and many other directory information
+sources suggest that the the current directory is ~/images and it's
+parent is ~. This issue is not possible to fix without either making
+every single command into a builtin, breaking Unix semantics or
+implementing kludges in every single command.
+
+This issue can also be seen when doing IO redirection.
+
+Another related issue is that many programs that operate on recursive
+directory trees, like the find command, silently ignore symlinked
+directories. For example, <code>find $PWD -name '*.txt'</code>
+silently fails in shells that don't resolve symlinked paths.
+
+<hr>
+
+\section faq-cd-autocomplete Why does the cd command autocompletion list the subdirectories of my home directory as completions?
+
+Because they are completions. In fish, if you specify a relative
+directory to the cd command, i.e. any path that does not start with
+either './' or '/', the environment variable CDPATH will be examined, and any
+directories in this path is used as a base direcotry. To disable this
+feature, write <code>set CDPATH .</code> on the commandline.
+
+<hr>
+
+\section faq-cd-implicit I accidentally entered a directory path and fish changed directory. What happened?
+
+If fish is unable to locate a command with a given name, fish will
+test if a directory of that name exists. If it does, it is implicitly
+assumed that you want to change working directory. For example, the
+fastest way to switch to your home directory is to simply type
+<code>~</code>.
+
+<hr>
+
+\section faq-open The open command doesn't work.
+
+The open command uses the mimetype database and the .desktop files
+used by Gnome and KDE to identify filetypes and default actions. If
+at least one of these two desktops are installed, but the open command is
+not working, this probably means that the relevant files are installed
+in a nonstandard location. Please contact the <a
+href='mailto:fish-users@lists.sf.net'>fish mailing list</a>, and
+hopefully this can be resolved.
+
+\section faq-default How do I make fish my default shell?
+
+If you installed fish manually (e.g. by compiling it, not by using a
+package manager), you first need to add fish to the list of shells by
+executing the following command (assuming you installed fish in
+/usr/local) as root:
+
+\section faq-titlebar I'm seeing weird output before each prompt when using screen. What's wrong?
+
+Quick answer:
+
+Run the following command in fish:
+
+<pre>
+echo function fish_title;end ~/.config/fish/config.fish
+</pre>
+
+Problem solved!
+
+The long answer:
+
+Fish is trying to set the titlebar message of your terminal. While
+screen itself supports this feature, your terminal does
+not. Unfortuntaly, when the underlying terminal doesn't support
+setting the titlebar, screen simply passes through the escape codes
+and text to the underlying terminal instead of ignoring them. It is
+impossible detect and resolve this problem from inside fish since fish
+has no way of knowing what the underlying terminal type is. For now,
+the only way to fix this is to unset the titlebar message, as
+suggested above.
+
+Note that fish has a default titlebar message, which will be used if
+the fish_title function is undefined. So simply unsetting the
+fish_title function will not work.
+
+
+<code>echo /usr/local/bin/fish >>/etc/shells</code>
+
+If you installed a prepackaged version of fish, the package manager
+should have already done this for you.
+
+In order to change your default shell, type:
+
+<code>chsh -s /usr/bin/fish</code>
+
+You may need to adjust the above path to e.g. /usr/local/bin/fish.
+
+You will need to log out and back in again for the change to take
+effect.
+
+<hr>
+
+\section faq-greeting How do I change the greeting message?
+
+Change the value of the variable fish_greeting. For example, to remove
+the greeting use:
+
+<pre>
+set fish_greeting
+</pre>
+
+
+*/
diff --git a/doc_src/doc.hdr b/doc_src/index.hdr
index a04d1592..f1c15ff2 100644
--- a/doc_src/doc.hdr
+++ b/doc_src/index.hdr
@@ -1,6 +1,5 @@
-/** \mainpage Fish user documentation
-\section introduction The friendly interactive shell
+\section introduction Introduction
This is the documentation for \c fish, the friendly interactive
shell. \c fish is a user friendly commandline shell intended
@@ -232,14 +231,14 @@ Most programs allow you to suspend the programs execution and return
control to \c fish by Pressing ^Z (Press and hold the Control key and
press 'z'). Once back at the \c fish commandline, you can start other
programs and do anything you want. If you then want to go back to the
-suspended command by using the <a href="builtins.html#fg">fg</a>
+suspended command by using the <a href="commands.html#fg">fg</a>
command.
If you instead want to put a suspended job into the background, use
-the <a href="builtins.html#bg">bg</a> command.
+the <a href="commands.html#bg">bg</a> command.
To get a listing of all currently started jobs, use the <a
-href="builtins.html#jobs">jobs</a> command.
+href="commands.html#jobs">jobs</a> command.
\subsection syntax-function Shellscript functions
@@ -262,7 +261,7 @@ $argv</code> should be called when ll is invoked. $argv is an array
variable, which always contains all arguments sent to the function. In
the example above, these are simply passed on to the ls command. For
more information on functions, see the documentation for the <a
-href='builtins.html#function'>function</a> builtin.
+href='commands.html#function'>function</a> builtin.
\subsubsection Autoloading functions
@@ -388,7 +387,7 @@ an argument, to disable filename completion, to create completions
that are only available in some combinations, etc.. For a complete
description of the various switches accepted by the \c complete
command, see the documentation for the <a
-href="builtins.html#complete">complete</a> builtin, or write 'complete
+href="commands.html#complete">complete</a> builtin, or write 'complete
--help' inside the \c fish shell.
For examples of how to write your own complex completions, study the
@@ -444,8 +443,6 @@ Examples:
<code>**</code> matches any files and directories in the current directory and all of its subdirectories.
-<code>**/</code> matches any directories in the current directory and all of its subdirectories.
-
If no matches are found for a specific wildcard, it will expand into
zero arguments, i.e. to nothing. If none of the wildcarded arguments
sent to a command result in any matches, the command will not be
@@ -612,7 +609,7 @@ and used by the user. For information on how to use the current value
of a variable, see the section on <a href='#expand-variable'>variable
expansion</a>.
-To set a variable value, use the <a href="builtins.html#set"> \c set
+To set a variable value, use the <a href="commands.html#set"> \c set
command</a>.
Example:
@@ -902,53 +899,53 @@ actions which cannot be performed by a regular command.
The following commands are distributed with fish. Many of them are
builtins or shellscript functions, and can only be used inside fish.
-- <a href="builtins.html#source">.</a>, read and execute the commands in a file
-- <a href="builtins.html#and">and</a>, execute command if previous command suceeded
-- <a href="builtins.html#bg">bg</a>, set a command to the background
-- <a href="builtins.html#begin">begin</a>, execute a block of commands
-- <a href="builtins.html#bind">bind</a>, change keyboard bindings
-- <a href="builtins.html#break">break</a>, stop the execution of a loop
-- <a href="builtins.html#block">block</a>, Temporarily block delivery of events
-- <a href="builtins.html#builtin">builtin</a>, execute a builtin command
-- <a href="builtins.html#case">case</a>, conditionally execute a block of commands
-- <a href="builtins.html#cd">cd</a>, change the current directory
-- <a href="builtins.html#command">command</a>, execute an external program
-- <a href="builtins.html#commandline">commandline</a>, set or get the contents of the commandline buffer
-- <a href="builtins.html#complete">complete</a>, add and remove completions
-- <a href="builtins.html#continue">continue</a>, skip the rest of the current lap of a loop
+- <a href="commands.html#source">.</a>, read and execute the commands in a file
+- <a href="commands.html#and">and</a>, execute command if previous command suceeded
+- <a href="commands.html#bg">bg</a>, set a command to the background
+- <a href="commands.html#begin">begin</a>, execute a block of commands
+- <a href="commands.html#bind">bind</a>, change keyboard bindings
+- <a href="commands.html#break">break</a>, stop the execution of a loop
+- <a href="commands.html#block">block</a>, Temporarily block delivery of events
+- <a href="commands.html#builtin">builtin</a>, execute a builtin command
+- <a href="commands.html#case">case</a>, conditionally execute a block of commands
+- <a href="commands.html#cd">cd</a>, change the current directory
+- <a href="commands.html#command">command</a>, execute an external program
+- <a href="commands.html#commandline">commandline</a>, set or get the contents of the commandline buffer
+- <a href="commands.html#complete">complete</a>, add and remove completions
+- <a href="commands.html#continue">continue</a>, skip the rest of the current lap of a loop
- <a href="commands.html#count">count</a>, count the number of arguments
- <a href="commands.html#dirh">dirh</a>, view the directory history
- <a href="commands.html#dirs">dirs</a>, view the directory stack
-- <a href="builtins.html#end">end</a>, end a block of commands
-- <a href="builtins.html#else">else</a>, conditionally execute a block of commands
-- <a href="builtins.html#eval">eval</a>, evaluate a string as a command
-- <a href="builtins.html#exec">exec</a>, replace the current process image with a new command
-- <a href="builtins.html#exit">exit</a>, causes \c fish to quit
-- <a href="builtins.html#fg">fg</a>, set a command to the foreground
+- <a href="commands.html#end">end</a>, end a block of commands
+- <a href="commands.html#else">else</a>, conditionally execute a block of commands
+- <a href="commands.html#eval">eval</a>, evaluate a string as a command
+- <a href="commands.html#exec">exec</a>, replace the current process image with a new command
+- <a href="commands.html#exit">exit</a>, causes \c fish to quit
+- <a href="commands.html#fg">fg</a>, set a command to the foreground
- <a href="commands.html#fishd">fishd</a>, the universal variable daemon
-- <a href="builtins.html#for">for</a>, perform a block of commands once for every element in a list
-- <a href="builtins.html#function">function</a>, define a new function
-- <a href="builtins.html#functions">functions</a>, print or erase functions
+- <a href="commands.html#for">for</a>, perform a block of commands once for every element in a list
+- <a href="commands.html#function">function</a>, define a new function
+- <a href="commands.html#functions">functions</a>, print or erase functions
- <a href="commands.html#help">help</a>, show the fish documentation
-- <a href="builtins.html#if">if</a>, conditionally execute a block of commands
-- <a href="builtins.html#jobs">jobs</a>, print the currently running jobs
+- <a href="commands.html#if">if</a>, conditionally execute a block of commands
+- <a href="commands.html#jobs">jobs</a>, print the currently running jobs
- <a href="commands.html#mimedb">mimedb</a>, view mimedata about a file
- <a href="commands.html#nextd">nextd</a>, move forward in the directory history
-- <a href="builtins.html#not">not</a>, negates the exit status of any command
-- <a href="builtins.html#or">or</a>, execute a command if previous command failed
+- <a href="commands.html#not">not</a>, negates the exit status of any command
+- <a href="commands.html#or">or</a>, execute a command if previous command failed
- <a href="commands.html#popd">popd</a>, move to the topmost directory on the directory stack
- <a href="commands.html#prevd">prevd</a>, move backwards in the direcotry stack
- <a href="commands.html#pushd">pushd</a>, push the surrent directory onto the directory stack
-- <a href="builtins.html#random">random</a>, calculate a pseudo-random number
-- <a href="builtins.html#return">return</a>, return from a function
-- <a href="builtins.html#read">read</a>, read from a stream into an environment variable
-- <a href="builtins.html#set">set</a>, set environment variables
+- <a href="commands.html#random">random</a>, calculate a pseudo-random number
+- <a href="commands.html#return">return</a>, return from a function
+- <a href="commands.html#read">read</a>, read from a stream into an environment variable
+- <a href="commands.html#set">set</a>, set environment variables
- <a href="commands.html#set_color">set_color</a>, change the terminal colors
-- <a href="builtins.html#switch">switch</a>, conditionally execute a block of commands
+- <a href="commands.html#switch">switch</a>, conditionally execute a block of commands
- <a href="commands.html#tokenize">tokenize</a>, split a string up into multiple tokens
-- <a href="builtins.html#ulimit">ulimit</a>, set or get the shells resurce usage limits
+- <a href="commands.html#ulimit">ulimit</a>, set or get the shells resurce usage limits
- <a href="commands.html#umask">umask</a>, set or get the file creation mask
-- <a href="builtins.html#while">while</a>, perform a block of commands while a condition is met
+- <a href="commands.html#while">while</a>, perform a block of commands while a condition is met
For more information about these commands, use the <code>--help</code>
option of the command to display a longer explanation.
@@ -1083,7 +1080,7 @@ which the user can change <code>fish</code>'s behaviour.
-# By ending a command with the \& (ampersand) symbol, the user tells \c fish to put the specified command into the background. A background process will be run simultaneous with \c fish. \c fish will retain control of the terminal, so the program will not be able to read from the keyboard.
-# By pressing ^Z, the user stops a currently running foreground program and returns control to \c fish. Some programs do not support this feature, or remap it to another key. Gnu emacs uses ^X z to stop running.
--# By using the <a href="builtins.html#fg">fg</a> and <a href="builtins.html#bg">bg</a> builtin commands, the user can send any currently running job into the foreground or background.
+-# By using the <a href="commands.html#fg">fg</a> and <a href="commands.html#bg">bg</a> builtin commands, the user can send any currently running job into the foreground or background.
\section initialization Initialization files
@@ -1223,7 +1220,7 @@ end
</pre>
For more information on how to define new event handlers, see the
-documentation for the <a href='builtins.html#function'>function</a>
+documentation for the <a href='commands.html#function'>function</a>
command.
\section issues Common issues with fish
@@ -1316,7 +1313,6 @@ g++, javac, java, gcj, lpr, doxygen, whois, find)
\subsection todo-possible Possible features
-- Multiline editing
- tab completion could use smart casing
- Completions could support options beginning with a plus (like xterm
+fbx) and options without dashes (like top p) Do we really want to
@@ -1347,12 +1343,16 @@ g++, javac, java, gcj, lpr, doxygen, whois, find)
- The code validation functions should be moved from the parser to parse_util.
- The parser_is_* functions should be moved to parse_util. Possibly, they should be made into a single function, i.e. parse_util_classify( "begin", BLOCK_COMMAND);
- Try to remove more malloc calls to reduce memory usage. The time_t arrays used by the autoloader sound like a good candidate.
+- The code validator should warn about unknown commands.
+- The large number of interned strings means that autounloading frees less memory than it should. Completion strings should probably be either refcounted or not shared at all.
+
\subsection bugs Known bugs
- Completion for gcc -\#\#\# option doesn't work.
- Suspending and then resuming pipelines containing a builtin is broken. How should this be handled?
-- screen handling code can't handle tabs in input
+- screen handling code can't handle tabs in input.
+- begining-of-line and end-of-line move to begining/end of buffer, and there are no macros for moving to beginning/end of buffer.
If you think you have found a bug not described here, please send a
@@ -1367,1285 +1367,3 @@ cause the builtin help to render incorrectly. Version 1.2.14 is known
to have this problem.
*/
-/** \page design Design document
-
-\section design-overview Design document
-
-\subsection design-overview Overview
-
-This is a description of the design principles that have been used to
-design fish. The fish design has three high level goals. These are:
-
--# Everything that can be done in other shell languages should be
-possible to do in fish, though fish may rely on external commands in
-doing so.
--# Fish should be user friendly, but not at the expense of expressiveness.
-Most tradeoffs between power and ease of use can be avoided with careful design.
--# Whenever possible without breaking the above goals, fish should
-follow the Posix syntax.
-
-To achive these high-level goals, the fish design relies on a number
-of more specific design principles. These are presented below,
-together with a rationale and a few examples for each.
-
-\subsection ortho The law of orthogonality
-
-The shell language should have a small set of orthogonal features. Any
-situation where two features are related but not identical, one of them
-should be removed, and the other should be made powerful and general
-enough to handle all common use cases of either feature.
-
-Rationale:
-
-Related features make the language larger, which makes it harder to
-learn. It also increases the size of the sourcecode, making the
-program harder to maintain and update.
-
-Examples:
-
-- Here documents are too similar to using echo inside of a pipeline.
-- Subshells, command substitution and process substitution are strongly related. \c fish only supports command substitution, the others can be achived either using a block or the psub shellscript function.
-- Having both aliases and functions is confusing, especially since both of them have limitations and problems. \c fish functions have none of the drawbacks of either syntax.
-- The many Posix quoting styles are silly, especially \$''.
-
-
-\subsection sep The law of minimalism
-
-The shell should only contain features that cannot be implemented in
-a reasonable way outside of the shell. A large performance decrease,
-as well as some program complexity increase is acceptable in order to
-improve separation.
-
-Rationale:
-
-A modular project is easier to maintain since smaller programs are far
-easier to understand than larger ones. A modular project is also more
-future proof since the modules can be individually
-replaced. Modularity also decreases the severity of bugs, since there
-is good hope that a bug, even a serious one, in one module, does not
-take the whole system down.
-
-Examples:
-
-- Builtin commands should only be created when it cannot be
-avoided. \c echo, \c kill, \c printf and \c time are among the commands
-that fish does not implement internally since they can be provided as
-external commands. Several other commands that are commonly implemented
-as builtins and can not be implemented as external commands,
-including \c type, \c vared, \c pushd and \c popd are implemented as shellscript
-functions in fish.
-- Mathematical calculations, regex matching, generating lists of numbers
-and many other funtions can easily be done in external programs. They
-should not be supported internally by the shell.
-
-The law of minimalism does not imply that a large feature set is
-bad. So long as a feature is not part of the shell itself, but a
-separate command or at least a shellscript function, bloat is fine.
-
-\subsection conf Configurability is the root of all evil
-
-Every configuration option in a program is a place where the program
-is too stupid to figure out for itself what the user really wants, and
-should be considered a failiure of both the program and the programmer
-who implemented it.
-
-Rationale:
-
-Different configuration options are a nightmare to maintain, since the
-number of potential bugs caused by specific configuration combinations
-quickly becomes an issue. Configuration options often imply
-assumptions about the code which change when reimplementing the code,
-causing issues with backwards compatibility. But mostly, configuration
-options should be avoided since they simply should not exist, as the
-program should be smart enough to do what is best, or at least a good
-enough approximation of it.
-
-Examples:
-
-- Fish allows the user to set various syntax highlighting colors. This is needed because fish does not know what colors the terminal uses by default, which might make some things unreadable. The proper solution would be for text color preferences to be defined centrally by the user for all programs, and for the terminal emulator to send these color properties to fish.
-- Fish does not allow you to set the history filename, the number of history entries, different language substyles or any number of other common shell configuration options.
-
-A special note on the evils of configurability is the long list of
-very useful features found in some shells, that are not turned on by
-default. Both zsh and bash support command specific completions, but
-no such completions are shipped with bash by default, and they are
-turned of by default in zsh. Other features that zsh support that are
-disabled by default include tab-completion of strings containing
-wildcards, a sane completion pager and a history file.
-
-\subsection user The law of user focus
-
-When designing a program, one should first think about how to make a
-intuitive and powerful program. Implementation issues should only be
-considered once a user interface has been designed.
-
-Rationale:
-
-This design rule is different than the others, since it describes how
-one should go about designing new features, not what the features
-should be. The problem with focusing on what can be done, and what is
-easy to do, is that to much of the implementation is exposed. This
-means that the user must know a great deal about the underlying system
-to be able to guess how the shell works, it also means that the
-language will often be rather low-level.
-
-Examples:
-
-- There should only be one type of input to the shell, lists of commands. Loops, conditionals and variable assignments are all performed through regular commands.
-- The differences between builtin commands, shellscript functions and builtin commands should be made as small as possible. Builtins and shellscript functions should have exactly the same types of argument expansion as other commands, should be possible to use in any position in a pipeline, and should support any io redirection.
-- Instead of forking when performing command substitution to provide a fake variable scope, all fish commands are performed from the same process, and fish instead supports true scoping
-- All blocks end with the \c end builtin
-
-\subsection disc The law of discoverability
-
-A program should be designed to make its features as
-easy as possible to discover for the user.
-
-Rationale:
-
-A program whose features are discoverable turns a new user into an
-expert in a shorter span of time, since the user will become an expert
-on the program simply by using it.
-
-The main benefit of a graphical program over a command line-based
-program is discoverability. In a graphical program, one can discover
-all the common features by simply looking at the user interface and
-guessing what the different buttons, menus and other widgets do. The
-traditional way to discover features in commandline programs is
-through manual pages. This requires both that the user starts to use a
-different program, and the she/he then remembers the new information
-until the next time she/he uses the same program.
-
-Examples:
-
-- Everything should be tab-completable, and every tab completion should have a description
-- Every syntax error and error in a builtin command should contain an error message describing what went wrong and a relevant help page. Whenever possible, errors should be flagged red by the syntax highlighter.
-- The help manual should be easy to read, easily available from the shell, complete and contain many examples
-- The language should be uniform, so that once the user understands the command/argument syntax, he will know the whole language, and be able to use tab-completion to discover new featues.
-
-*/
-/** \page license Licenses
-
-Fish Copyright (C) 2005 Axel Liljencrantz. Fish is released under the
-GNU General Public License, version 2. The license agreement is
-included below.
-
-Fish contains code under the BSD license, namely versions of the
-two functions strlcat and strlcpy, modified for use with wide
-character strings. This code is copyrighted by Todd C. Miller. The
-license agreement is included below.
-
-The XSel command, written and copyrighted by Conrad Parker, is
-distributed together with, and used by fish. It is released under the MIT
-license. The license agreement is included below.
-
-The xdgmime library, written and copyrighted by Red Hat, Inc, is used
-by the mimedb command, which is a part of fish. It is released under
-the LGPL. The license agreement is included below.
-
-Fish contains code from the glibc library, namely the wcstok
-function. This code is licensed under the LGPL. The license agreement
-is included below.
-
-
-<HR>
-
-<H2><A NAME="SEC1" HREF="gpl.html#TOC1">GNU GENERAL PUBLIC LICENSE</A></H2>
-<P>
-Version 2, June 1991
-
-</P>
-
-<PRE>
-Copyright (C) 1989, 1991 Free Software Foundation, Inc.
-59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
-
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
-</PRE>
-
-
-<H2><A NAME="SEC2" HREF="gpl.html#TOC2">Preamble</A></H2>
-
-<P>
-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.
-
-</P>
-<P>
-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.
-
-</P>
-<P>
-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.
-
-</P>
-<P>
-
-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.
-
-</P>
-<P>
-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.
-
-</P>
-<P>
-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.
-
-</P>
-<P>
-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.
-
-</P>
-<P>
-The precise terms and conditions for copying, distribution and
-modification follow.
-
-
-</P>
-
-
-<H2><A NAME="SEC3" HREF="gpl.html#TOC3">TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</A></H2>
-
-
-<P>
-
-<STRONG>0.</STRONG>
-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".
-<P>
-
-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.
-
-<P>
-
-<STRONG>1.</STRONG>
-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.
-<P>
-
-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.
-<P>
-
-<STRONG>2.</STRONG>
-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:
-<P>
-
-<DL>
-
-<DT>
-<DD>
-<STRONG>a)</STRONG>
-You must cause the modified files to carry prominent notices
-stating that you changed the files and the date of any change.
-</DD>
-</DT>
-</DL>
-<P>
-<DL>
-<DT>
-<DD>
-<STRONG>b)</STRONG>
-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.
-
-</DD>
-</DT>
-</DL>
-<P>
-<DL>
-<DT>
-<DD>
-<STRONG>c)</STRONG>
-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.)
-</DD>
-</DT>
-</DL>
-<P>
-
-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.
-
-<P>
-
-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.
-<P>
-
-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.
-
-<P>
-
-<STRONG>3.</STRONG>
-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:
-
-
-<!-- we use this doubled UL to get the sub-sections indented, -->
-<!-- while making the bullets as unobvious as possible. -->
-
-<DL>
-<DT>
-
-<DD>
-<STRONG>a)</STRONG>
-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,
-</DD>
-</DT>
-</DL>
-<P>
-<DL>
-<DT>
-<DD>
-<STRONG>b)</STRONG>
-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,
-</DD>
-
-</DT>
-</DL>
-<P>
-<DL>
-<DT>
-<DD>
-<STRONG>c)</STRONG>
-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.)
-</DD>
-</DT>
-</DL>
-<P>
-
-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.
-<P>
-
-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.
-<P>
-
-<STRONG>4.</STRONG>
-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.
-
-<P>
-
-<STRONG>5.</STRONG>
-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.
-
-<P>
-
-<STRONG>6.</STRONG>
-
-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.
-
-<P>
-
-<STRONG>7.</STRONG>
-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.
-<P>
-
-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.
-<P>
-
-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.
-<P>
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
-
-<P>
-
-<STRONG>8.</STRONG>
-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.
-
-<P>
-
-<STRONG>9.</STRONG>
-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.
-<P>
-
-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.
-
-<P>
-
-<STRONG>10.</STRONG>
-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.
-
-
-
-<P><STRONG>NO WARRANTY</STRONG></P>
-
-<P>
-
-<STRONG>11.</STRONG>
-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.
-
-<P>
-
-<STRONG>12.</STRONG>
-
-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.
-
-<P>
-
-<HR>
-
-<h2>License for wcslcat and wcslcpy</h2>
-
-\c fish also contains small amounts of code under the BSD
-license, namely versions of the two functions strlcat and strlcpy,
-modified for use with wide character strings. This code is copyrighted
-by Todd C. Miller.
-
-Permission to use, copy, modify, and distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
-WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
-AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
-DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
-PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
-TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-
-<HR>
-
-<h2>License for XSel</h2>
-
-The XSel command, written and copyrighted by Conrad Parker, is
-distributed together with \c fish.
-
-
-It is Copyright (C) 2001 Conrad Parker <conrad@vergenet.net>
-
-Permission to use, copy, modify, distribute, and sell this software
-and its documentation for any purpose is hereby granted without fee,
-provided that the above copyright notice appear in all copies and that
-both that copyright notice and this permission notice appear in
-supporting documentation. No representations are made about the
-suitability of this software for any purpose. It is provided "as is"
-without express or implied warranty.
-
-
-<HR>
-
-<H2><A NAME="SEC1" HREF="#TOC1">GNU LESSER GENERAL PUBLIC LICENSE</A></H2>
-
-<P>
-Version 2.1, February 1999
-
-<P>
-<PRE>
-Copyright (C) 1991, 1999 Free Software Foundation, Inc.
-51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
-
-[This is the first released version of the Lesser GPL. It also counts
- as the successor of the GNU Library Public License, version 2, hence
- the version number 2.1.]
-</PRE>
-
-
-<H2><A NAME="SEC2" HREF="#TOC2">Preamble</A></H2>
-
-<P>
- The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
-Licenses are intended to guarantee your freedom to share and change
-free software--to make sure the software is free for all its users.
-<P>
- This license, the Lesser General Public License, applies to some
-specially designated software packages--typically libraries--of the
-Free Software Foundation and other authors who decide to use it. You
-can use it too, but we suggest you first think carefully about whether
-this license or the ordinary General Public License is the better
-strategy to use in any particular case, based on the explanations below.
-
-<P>
- When we speak of free software, we are referring to freedom of use,
-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 and use pieces of
-it in new free programs; and that you are informed that you can do
-these things.
-<P>
- To protect your rights, we need to make restrictions that forbid
-distributors to deny you these rights or to ask you to surrender these
-rights. These restrictions translate to certain responsibilities for
-you if you distribute copies of the library or if you modify it.
-<P>
- For example, if you distribute copies of the library, whether gratis
-or for a fee, you must give the recipients all the rights that we gave
-you. You must make sure that they, too, receive or can get the source
-code. If you link other code with the library, you must provide
-complete object files to the recipients, so that they can relink them
-with the library after making changes to the library and recompiling
-it. And you must show them these terms so they know their rights.
-<P>
- We protect your rights with a two-step method: (1) we copyright the
-library, and (2) we offer you this license, which gives you legal
-permission to copy, distribute and/or modify the library.
-<P>
- To protect each distributor, we want to make it very clear that
-there is no warranty for the free library. Also, if the library is
-modified by someone else and passed on, the recipients should know
-that what they have is not the original version, so that the original
-author's reputation will not be affected by problems that might be
-introduced by others.
-<P>
- Finally, software patents pose a constant threat to the existence of
-any free program. We wish to make sure that a company cannot
-effectively restrict the users of a free program by obtaining a
-restrictive license from a patent holder. Therefore, we insist that
-any patent license obtained for a version of the library must be
-consistent with the full freedom of use specified in this license.
-
-<P>
- Most GNU software, including some libraries, is covered by the
-ordinary GNU General Public License. This license, the GNU Lesser
-General Public License, applies to certain designated libraries, and
-is quite different from the ordinary General Public License. We use
-this license for certain libraries in order to permit linking those
-libraries into non-free programs.
-<P>
- When a program is linked with a library, whether statically or using
-a shared library, the combination of the two is legally speaking a
-combined work, a derivative of the original library. The ordinary
-General Public License therefore permits such linking only if the
-entire combination fits its criteria of freedom. The Lesser General
-Public License permits more lax criteria for linking other code with
-the library.
-<P>
- We call this license the "Lesser" General Public License because it
-does Less to protect the user's freedom than the ordinary General
-Public License. It also provides other free software developers Less
-of an advantage over competing non-free programs. These disadvantages
-are the reason we use the ordinary General Public License for many
-libraries. However, the Lesser license provides advantages in certain
-special circumstances.
-<P>
- For example, on rare occasions, there may be a special need to
-encourage the widest possible use of a certain library, so that it becomes
-a de-facto standard. To achieve this, non-free programs must be
-allowed to use the library. A more frequent case is that a free
-library does the same job as widely used non-free libraries. In this
-case, there is little to gain by limiting the free library to free
-software only, so we use the Lesser General Public License.
-<P>
- In other cases, permission to use a particular library in non-free
-programs enables a greater number of people to use a large body of
-free software. For example, permission to use the GNU C Library in
-non-free programs enables many more people to use the whole GNU
-operating system, as well as its variant, the GNU/Linux operating
-system.
-<P>
- Although the Lesser General Public License is Less protective of the
-users' freedom, it does ensure that the user of a program that is
-linked with the Library has the freedom and the wherewithal to run
-that program using a modified version of the Library.
-
-<P>
- The precise terms and conditions for copying, distribution and
-modification follow. Pay close attention to the difference between a
-"work based on the library" and a "work that uses the library". The
-former contains code derived from the library, whereas the latter must
-be combined with the library in order to run.
-<P>
-
-<H2><A NAME="SEC3" HREF="#TOC3">TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</A></H2>
-
-
-<P>
-<STRONG>0.</STRONG>
-This License Agreement applies to any software library or other
-program which contains a notice placed by the copyright holder or
-other authorized party saying it may be distributed under the terms of
-this Lesser General Public License (also called "this License").
-Each licensee is addressed as "you".
-<P>
- A "library" means a collection of software functions and/or data
-prepared so as to be conveniently linked with application programs
-(which use some of those functions and data) to form executables.
-<P>
-
- The "Library", below, refers to any such software library or work
-which has been distributed under these terms. A "work based on the
-Library" means either the Library or any derivative work under
-copyright law: that is to say, a work containing the Library or a
-portion of it, either verbatim or with modifications and/or translated
-straightforwardly into another language. (Hereinafter, translation is
-included without limitation in the term "modification".)
-<P>
- "Source code" for a work means the preferred form of the work for
-making modifications to it. For a library, 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 library.
-<P>
- Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running a program using the Library is not restricted, and output from
-such a program is covered only if its contents constitute a work based
-on the Library (independent of the use of the Library in a tool for
-writing it). Whether that is true depends on what the Library does
-and what the program that uses the Library does.
-<P>
-<STRONG>1.</STRONG>
-You may copy and distribute verbatim copies of the Library's
-complete 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 distribute a copy of this License along with the
-Library.
-<P>
- 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.
-<P>
-<STRONG>2.</STRONG>
-
-You may modify your copy or copies of the Library or any portion
-of it, thus forming a work based on the Library, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-<P>
-<UL>
- <LI><STRONG>a)</STRONG>
- The modified work must itself be a software library.
- <LI><STRONG>b)</STRONG>
- You must cause the files modified to carry prominent notices
- stating that you changed the files and the date of any change.
-
- <LI><STRONG>c)</STRONG>
- You must cause the whole of the work to be licensed at no
- charge to all third parties under the terms of this License.
-
- <LI><STRONG>d)</STRONG>
-
- If a facility in the modified Library refers to a function or a
- table of data to be supplied by an application program that uses
- the facility, other than as an argument passed when the facility
- is invoked, then you must make a good faith effort to ensure that,
- in the event an application does not supply such function or
- table, the facility still operates, and performs whatever part of
- its purpose remains meaningful.
- <P>
- (For example, a function in a library to compute square roots has
- a purpose that is entirely well-defined independent of the
- application. Therefore, Subsection 2d requires that any
- application-supplied function or table used by this function must
- be optional: if the application does not supply it, the square
- root function must still compute square roots.)
- <P>
- These requirements apply to the modified work as a whole. If
- identifiable sections of that work are not derived from the Library,
- 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 Library, 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.
- <P>
- 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 Library.
- <P>
- In addition, mere aggregation of another work not based on the Library
- with the Library (or with a work based on the Library) on a volume of
- a storage or distribution medium does not bring the other work under
- the scope of this License.
-</UL>
-<P>
-<STRONG>3.</STRONG>
-
-You may opt to apply the terms of the ordinary GNU General Public
-License instead of this License to a given copy of the Library. To do
-this, you must alter all the notices that refer to this License, so
-that they refer to the ordinary GNU General Public License, version 2,
-instead of to this License. (If a newer version than version 2 of the
-ordinary GNU General Public License has appeared, then you can specify
-that version instead if you wish.) Do not make any other change in
-these notices.
-<P>
- Once this change is made in a given copy, it is irreversible for
-that copy, so the ordinary GNU General Public License applies to all
-subsequent copies and derivative works made from that copy.
-<P>
- This option is useful when you wish to copy part of the code of
-the Library into a program that is not a library.
-<P>
-<STRONG>4.</STRONG>
-You may copy and distribute the Library (or a portion or
-derivative of it, under Section 2) in object code or executable form
-under the terms of Sections 1 and 2 above provided that you 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.
-<P>
- If distribution of 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 satisfies the requirement to
-distribute the source code, even though third parties are not
-compelled to copy the source along with the object code.
-<P>
-<STRONG>5.</STRONG>
-
-A program that contains no derivative of any portion of the
-Library, but is designed to work with the Library by being compiled or
-linked with it, is called a "work that uses the Library". Such a
-work, in isolation, is not a derivative work of the Library, and
-therefore falls outside the scope of this License.
-<P>
- However, linking a "work that uses the Library" with the Library
-creates an executable that is a derivative of the Library (because it
-contains portions of the Library), rather than a "work that uses the
-library". The executable is therefore covered by this License.
-Section 6 states terms for distribution of such executables.
-<P>
- When a "work that uses the Library" uses material from a header file
-that is part of the Library, the object code for the work may be a
-derivative work of the Library even though the source code is not.
-Whether this is true is especially significant if the work can be
-linked without the Library, or if the work is itself a library. The
-threshold for this to be true is not precisely defined by law.
-<P>
- If such an object file uses only numerical parameters, data
-structure layouts and accessors, and small macros and small inline
-functions (ten lines or less in length), then the use of the object
-file is unrestricted, regardless of whether it is legally a derivative
-work. (Executables containing this object code plus portions of the
-Library will still fall under Section 6.)
-<P>
- Otherwise, if the work is a derivative of the Library, you may
-distribute the object code for the work under the terms of Section 6.
-Any executables containing that work also fall under Section 6,
-whether or not they are linked directly with the Library itself.
-<P>
-<STRONG>6.</STRONG>
-As an exception to the Sections above, you may also combine or
-link a "work that uses the Library" with the Library to produce a
-work containing portions of the Library, and distribute that work
-under terms of your choice, provided that the terms permit
-modification of the work for the customer's own use and reverse
-engineering for debugging such modifications.
-
-<P>
- You must give prominent notice with each copy of the work that the
-Library is used in it and that the Library and its use are covered by
-this License. You must supply a copy of this License. If the work
-during execution displays copyright notices, you must include the
-copyright notice for the Library among them, as well as a reference
-directing the user to the copy of this License. Also, you must do one
-of these things:
-<P>
-<UL>
- <LI><STRONG>a)</STRONG> Accompany the work with the complete corresponding
- machine-readable source code for the Library including whatever
- changes were used in the work (which must be distributed under
- Sections 1 and 2 above); and, if the work is an executable linked
- with the Library, with the complete machine-readable "work that
- uses the Library", as object code and/or source code, so that the
- user can modify the Library and then relink to produce a modified
- executable containing the modified Library. (It is understood
- that the user who changes the contents of definitions files in the
- Library will not necessarily be able to recompile the application
- to use the modified definitions.)
-
- <LI><STRONG>b)</STRONG> Use a suitable shared library mechanism for linking with the
- Library. A suitable mechanism is one that (1) uses at run time a
- copy of the library already present on the user's computer system,
- rather than copying library functions into the executable, and (2)
- will operate properly with a modified version of the library, if
- the user installs one, as long as the modified version is
- interface-compatible with the version that the work was made with.
-
- <LI><STRONG>c)</STRONG> Accompany the work with a written offer, valid for at
- least three years, to give the same user the materials
- specified in Subsection 6a, above, for a charge no more
- than the cost of performing this distribution.
-
- <LI><STRONG>d)</STRONG> If distribution of the work is made by offering access to copy
- from a designated place, offer equivalent access to copy the above
- specified materials from the same place.
-
- <LI><STRONG>e)</STRONG> Verify that the user has already received a copy of these
- materials or that you have already sent this user a copy.
-
-</UL>
-<P>
- For an executable, the required form of the "work that uses the
-Library" must include any data and utility programs needed for
-reproducing the executable from it. However, as a special exception,
-the materials to be 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.
-<P>
- It may happen that this requirement contradicts the license
-restrictions of other proprietary libraries that do not normally
-accompany the operating system. Such a contradiction means you cannot
-use both them and the Library together in an executable that you
-distribute.
-<P>
-<STRONG>7.</STRONG> You may place library facilities that are a work based on the
-Library side-by-side in a single library together with other library
-facilities not covered by this License, and distribute such a combined
-library, provided that the separate distribution of the work based on
-the Library and of the other library facilities is otherwise
-permitted, and provided that you do these two things:
-<P>
-<UL>
- <LI><STRONG>a)</STRONG> Accompany the combined library with a copy of the same work
- based on the Library, uncombined with any other library
- facilities. This must be distributed under the terms of the
- Sections above.
-
- <LI><STRONG>b)</STRONG> Give prominent notice with the combined library of the fact
- that part of it is a work based on the Library, and explaining
- where to find the accompanying uncombined form of the same work.
-
-</UL>
-<P>
-<STRONG>8.</STRONG> You may not copy, modify, sublicense, link with, or distribute
-the Library except as expressly provided under this License. Any
-attempt otherwise to copy, modify, sublicense, link with, or
-distribute the Library 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.
-<P>
-<STRONG>9.</STRONG>
-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 Library or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Library (or any work based on the
-Library), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Library or works based on it.
-<P>
-<STRONG>10.</STRONG>
-Each time you redistribute the Library (or any work based on the
-Library), the recipient automatically receives a license from the
-original licensor to copy, distribute, link with or modify the Library
-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 with
-this License.
-<P>
-<STRONG>11.</STRONG>
-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 Library at all. For example, if a patent
-license would not permit royalty-free redistribution of the Library 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 Library.
-
-<P>
-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.
-<P>
-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.
-<P>
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-<P>
-<STRONG>12.</STRONG>
-If the distribution and/or use of the Library is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Library 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.
-<P>
-<STRONG>13.</STRONG>
-The Free Software Foundation may publish revised and/or new
-versions of the Lesser 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.
-<P>
-Each version is given a distinguishing version number. If the Library
-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 Library does not specify a
-license version number, you may choose any version ever published by
-the Free Software Foundation.
-<P>
-
-<STRONG>14.</STRONG>
-If you wish to incorporate parts of the Library into other free
-programs whose distribution conditions are incompatible with these,
-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.
-<P>
-<STRONG>NO WARRANTY</STRONG>
-<P>
-<STRONG>15.</STRONG>
-BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
-WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
-EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
-OTHER PARTIES PROVIDE THE LIBRARY "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
-LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
-THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-<P>
-<STRONG>16.</STRONG>
-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 LIBRARY 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
-LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
-SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-<P>
-
-
-
-*/
-/** \page faq Frequently asked questions
-
-- <a href='#faq-cwd-symlink'>Why does cd, pwd and other fish commands always resolve symlinked directories to their canonical path?</a>
-- <a href='#faq-cd-autocomplete'>Why does the cd command autocompletion list the subdirectories of my home directory as completions?</a>
-- <a href='#faq-cd-implicit'>I accidentally entered a directory path and fish changed directory. What happened?</a>
-- <a href='#faq-open'>The open command doesn't work.</a>
-- <a href='#faq-default'>How do I make fish my default shell?</a>
-- <a href='#faq-titlebar'>I'm seeing weird output before each prompt when using screen. What's wrong?</a>
-- <a href='#faq-greeting'>How do I change the greeting message?</a>
-
-<hr>
-
-\section faq-cwd-symlink Why does cd, $PWD and and various fish commands always resolve symlinked directories to their canonical path?
-
-<i>
-For example if ~/images is a symlink to ~/Documents/Images, if I write
-'cd images', my prompt will say ~/D/Images, not ~/images.
-</i>
-
-Because it is impossible to consistently keep symlinked directories
-unresolved. It is indeed possible to do this partially, and many other
-shells do so. But it was felt there are enough serious corner cases
-that this is a bad idea. Most such issues have to do with how '..' is
-handled, and are varitations of the following example:
-
-Writing <code>cd images; ls ..</code> given the above directory
-structure would list the contents of ~/Documents, not of ~, even
-though using <code>cd ..</code> changes the current direcotry to ~,
-and the prompt, the pwd builtin and many other directory information
-sources suggest that the the current directory is ~/images and it's
-parent is ~. This issue is not possible to fix without either making
-every single command into a builtin, breaking Unix semantics or
-implementing kludges in every single command.
-
-This issue can also be seen when doing IO redirection.
-
-Another related issue is that many programs that operate on recursive
-directory trees, like the find command, silently ignore symlinked
-directories. For example, <code>find $PWD -name '*.txt'</code>
-silently fails in shells that don't resolve symlinked paths.
-
-<hr>
-
-\section faq-cd-autocomplete Why does the cd command autocompletion list the subdirectories of my home directory as completions?
-
-Because they are completions. In fish, if you specify a relative
-directory to the cd command, i.e. any path that does not start with
-either './' or '/', the environment variable CDPATH will be examined, and any
-directories in this path is used as a base direcotry. To disable this
-feature, write <code>set CDPATH .</code> on the commandline.
-
-<hr>
-
-\section faq-cd-implicit I accidentally entered a directory path and fish changed directory. What happened?
-
-If fish is unable to locate a command with a given name, fish will
-test if a directory of that name exists. If it does, it is implicitly
-assumed that you want to change working directory. For example, the
-fastest way to switch to your home directory is to simply type
-<code>~</code>.
-
-<hr>
-
-\section faq-open The open command doesn't work.
-
-The open command uses the mimetype database and the .desktop files
-used by Gnome and KDE to identify filetypes and default actions. If
-at least one of these two desktops are installed, but the open command is
-not working, this probably means that the relevant files are installed
-in a nonstandard location. Please contact the <a
-href='mailto:fish-users@lists.sf.net'>fish mailing list</a>, and
-hopefully this can be resolved.
-
-\section faq-default How do I make fish my default shell?
-
-If you installed fish manually (e.g. by compiling it, not by using a
-package manager), you first need to add fish to the list of shells by
-executing the following command (assuming you installed fish in
-/usr/local) as root:
-
-\section faq-titlebar I'm seeing weird output before each prompt when using screen. What's wrong?
-
-Quick answer:
-
-Run the following command in fish:
-
-<pre>
-echo function fish_title;end ~/.config/fish/config.fish
-</pre>
-
-Problem solved!
-
-The long answer:
-
-Fish is trying to set the titlebar message of your terminal. While
-screen itself supports this feature, your terminal does
-not. Unfortuntaly, when the underlying terminal doesn't support
-setting the titlebar, screen simply passes through the escape codes
-and text to the underlying terminal instead of ignoring them. It is
-impossible detect and resolve this problem from inside fish since fish
-has no way of knowing what the underlying terminal type is. For now,
-the only way to fix this is to unset the titlebar message, as
-suggested above.
-
-Note that fish has a default titlebar message, which will be used if
-the fish_title function is undefined. So simply unsetting the
-fish_title function will not work.
-
-
-<code>echo /usr/local/bin/fish >>/etc/shells</code>
-
-If you installed a prepackaged version of fish, the package manager
-should have already done this for you.
-
-In order to change your default shell, type:
-
-<code>chsh -s /usr/bin/fish</code>
-
-You may need to adjust the above path to e.g. /usr/local/bin/fish.
-
-You will need to log out and back in again for the change to take
-effect.
-
-<hr>
-
-\section faq-greeting How do I change the greeting message?
-
-Change the value of the variable fish_greeting. For example, to remove
-the greeting use:
-
-<pre>
-set fish_greeting
-</pre>
-
-
-*/
diff --git a/doc_src/license.hdr b/doc_src/license.hdr
new file mode 100644
index 00000000..c7b93126
--- /dev/null
+++ b/doc_src/license.hdr
@@ -0,0 +1,989 @@
+/** \page license Licenses
+
+Fish Copyright (C) 2005 Axel Liljencrantz. Fish is released under the
+GNU General Public License, version 2. The license agreement is
+included below.
+
+Fish contains code under the BSD license, namely versions of the
+two functions strlcat and strlcpy, modified for use with wide
+character strings. This code is copyrighted by Todd C. Miller. The
+license agreement is included below.
+
+The XSel command, written and copyrighted by Conrad Parker, is
+distributed together with, and used by fish. It is released under the MIT
+license. The license agreement is included below.
+
+The xdgmime library, written and copyrighted by Red Hat, Inc, is used
+by the mimedb command, which is a part of fish. It is released under
+the LGPL. The license agreement is included below.
+
+Fish contains code from the glibc library, namely the wcstok
+function. This code is licensed under the LGPL. The license agreement
+is included below.
+
+
+<HR>
+
+<H2><A NAME="SEC1" HREF="gpl.html#TOC1">GNU GENERAL PUBLIC LICENSE</A></H2>
+<P>
+Version 2, June 1991
+
+</P>
+
+<PRE>
+Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+</PRE>
+
+
+<H2><A NAME="SEC2" HREF="gpl.html#TOC2">Preamble</A></H2>
+
+<P>
+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.
+
+</P>
+<P>
+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.
+
+</P>
+<P>
+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.
+
+</P>
+<P>
+
+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.
+
+</P>
+<P>
+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.
+
+</P>
+<P>
+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.
+
+</P>
+<P>
+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.
+
+</P>
+<P>
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+
+</P>
+
+
+<H2><A NAME="SEC3" HREF="gpl.html#TOC3">TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</A></H2>
+
+
+<P>
+
+<STRONG>0.</STRONG>
+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".
+<P>
+
+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.
+
+<P>
+
+<STRONG>1.</STRONG>
+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.
+<P>
+
+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.
+<P>
+
+<STRONG>2.</STRONG>
+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:
+<P>
+
+<DL>
+
+<DT>
+<DD>
+<STRONG>a)</STRONG>
+You must cause the modified files to carry prominent notices
+stating that you changed the files and the date of any change.
+</DD>
+</DT>
+</DL>
+<P>
+<DL>
+<DT>
+<DD>
+<STRONG>b)</STRONG>
+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.
+
+</DD>
+</DT>
+</DL>
+<P>
+<DL>
+<DT>
+<DD>
+<STRONG>c)</STRONG>
+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.)
+</DD>
+</DT>
+</DL>
+<P>
+
+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.
+
+<P>
+
+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.
+<P>
+
+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.
+
+<P>
+
+<STRONG>3.</STRONG>
+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:
+
+
+<!-- we use this doubled UL to get the sub-sections indented, -->
+<!-- while making the bullets as unobvious as possible. -->
+
+<DL>
+<DT>
+
+<DD>
+<STRONG>a)</STRONG>
+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,
+</DD>
+</DT>
+</DL>
+<P>
+<DL>
+<DT>
+<DD>
+<STRONG>b)</STRONG>
+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,
+</DD>
+
+</DT>
+</DL>
+<P>
+<DL>
+<DT>
+<DD>
+<STRONG>c)</STRONG>
+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.)
+</DD>
+</DT>
+</DL>
+<P>
+
+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.
+<P>
+
+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.
+<P>
+
+<STRONG>4.</STRONG>
+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.
+
+<P>
+
+<STRONG>5.</STRONG>
+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.
+
+<P>
+
+<STRONG>6.</STRONG>
+
+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.
+
+<P>
+
+<STRONG>7.</STRONG>
+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.
+<P>
+
+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.
+<P>
+
+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.
+<P>
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+
+<P>
+
+<STRONG>8.</STRONG>
+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.
+
+<P>
+
+<STRONG>9.</STRONG>
+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.
+<P>
+
+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.
+
+<P>
+
+<STRONG>10.</STRONG>
+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.
+
+
+
+<P><STRONG>NO WARRANTY</STRONG></P>
+
+<P>
+
+<STRONG>11.</STRONG>
+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.
+
+<P>
+
+<STRONG>12.</STRONG>
+
+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.
+
+<P>
+
+<HR>
+
+<h2>License for wcslcat and wcslcpy</h2>
+
+\c fish also contains small amounts of code under the BSD
+license, namely versions of the two functions strlcat and strlcpy,
+modified for use with wide character strings. This code is copyrighted
+by Todd C. Miller.
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
+PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+
+<HR>
+
+<h2>License for XSel</h2>
+
+The XSel command, written and copyrighted by Conrad Parker, is
+distributed together with \c fish.
+
+
+It is Copyright (C) 2001 Conrad Parker <conrad@vergenet.net>
+
+Permission to use, copy, modify, distribute, and sell this software
+and its documentation for any purpose is hereby granted without fee,
+provided that the above copyright notice appear in all copies and that
+both that copyright notice and this permission notice appear in
+supporting documentation. No representations are made about the
+suitability of this software for any purpose. It is provided "as is"
+without express or implied warranty.
+
+
+<HR>
+
+<H2><A NAME="SEC1" HREF="#TOC1">GNU LESSER GENERAL PUBLIC LICENSE</A></H2>
+
+<P>
+Version 2.1, February 1999
+
+<P>
+<PRE>
+Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL. It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+</PRE>
+
+
+<H2><A NAME="SEC2" HREF="#TOC2">Preamble</A></H2>
+
+<P>
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+<P>
+ This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it. You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+<P>
+ When we speak of free software, we are referring to freedom of use,
+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 and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+<P>
+ To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights. These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+<P>
+ For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you. You must make sure that they, too, receive or can get the source
+code. If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it. And you must show them these terms so they know their rights.
+<P>
+ We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+<P>
+ To protect each distributor, we want to make it very clear that
+there is no warranty for the free library. Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+<P>
+ Finally, software patents pose a constant threat to the existence of
+any free program. We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder. Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+<P>
+ Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License. This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License. We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+<P>
+ When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library. The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom. The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+<P>
+ We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License. It also provides other free software developers Less
+of an advantage over competing non-free programs. These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries. However, the Lesser license provides advantages in certain
+special circumstances.
+<P>
+ For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard. To achieve this, non-free programs must be
+allowed to use the library. A more frequent case is that a free
+library does the same job as widely used non-free libraries. In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+<P>
+ In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software. For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+<P>
+ Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+<P>
+ The precise terms and conditions for copying, distribution and
+modification follow. Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library". The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+<P>
+
+<H2><A NAME="SEC3" HREF="#TOC3">TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</A></H2>
+
+
+<P>
+<STRONG>0.</STRONG>
+This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+<P>
+ A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+<P>
+
+ The "Library", below, refers to any such software library or work
+which has been distributed under these terms. A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language. (Hereinafter, translation is
+included without limitation in the term "modification".)
+<P>
+ "Source code" for a work means the preferred form of the work for
+making modifications to it. For a library, 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 library.
+<P>
+ Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it). Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+<P>
+<STRONG>1.</STRONG>
+You may copy and distribute verbatim copies of the Library's
+complete 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 distribute a copy of this License along with the
+Library.
+<P>
+ 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.
+<P>
+<STRONG>2.</STRONG>
+
+You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+<P>
+<UL>
+ <LI><STRONG>a)</STRONG>
+ The modified work must itself be a software library.
+ <LI><STRONG>b)</STRONG>
+ You must cause the files modified to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ <LI><STRONG>c)</STRONG>
+ You must cause the whole of the work to be licensed at no
+ charge to all third parties under the terms of this License.
+
+ <LI><STRONG>d)</STRONG>
+
+ If a facility in the modified Library refers to a function or a
+ table of data to be supplied by an application program that uses
+ the facility, other than as an argument passed when the facility
+ is invoked, then you must make a good faith effort to ensure that,
+ in the event an application does not supply such function or
+ table, the facility still operates, and performs whatever part of
+ its purpose remains meaningful.
+ <P>
+ (For example, a function in a library to compute square roots has
+ a purpose that is entirely well-defined independent of the
+ application. Therefore, Subsection 2d requires that any
+ application-supplied function or table used by this function must
+ be optional: if the application does not supply it, the square
+ root function must still compute square roots.)
+ <P>
+ These requirements apply to the modified work as a whole. If
+ identifiable sections of that work are not derived from the Library,
+ 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 Library, 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.
+ <P>
+ 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 Library.
+ <P>
+ In addition, mere aggregation of another work not based on the Library
+ with the Library (or with a work based on the Library) on a volume of
+ a storage or distribution medium does not bring the other work under
+ the scope of this License.
+</UL>
+<P>
+<STRONG>3.</STRONG>
+
+You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library. To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License. (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.) Do not make any other change in
+these notices.
+<P>
+ Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+<P>
+ This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+<P>
+<STRONG>4.</STRONG>
+You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you 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.
+<P>
+ If distribution of 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 satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+<P>
+<STRONG>5.</STRONG>
+
+A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library". Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+<P>
+ However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library". The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+<P>
+ When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library. The
+threshold for this to be true is not precisely defined by law.
+<P>
+ If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work. (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+<P>
+ Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+<P>
+<STRONG>6.</STRONG>
+As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+<P>
+ You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License. You must supply a copy of this License. If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License. Also, you must do one
+of these things:
+<P>
+<UL>
+ <LI><STRONG>a)</STRONG> Accompany the work with the complete corresponding
+ machine-readable source code for the Library including whatever
+ changes were used in the work (which must be distributed under
+ Sections 1 and 2 above); and, if the work is an executable linked
+ with the Library, with the complete machine-readable "work that
+ uses the Library", as object code and/or source code, so that the
+ user can modify the Library and then relink to produce a modified
+ executable containing the modified Library. (It is understood
+ that the user who changes the contents of definitions files in the
+ Library will not necessarily be able to recompile the application
+ to use the modified definitions.)
+
+ <LI><STRONG>b)</STRONG> Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (1) uses at run time a
+ copy of the library already present on the user's computer system,
+ rather than copying library functions into the executable, and (2)
+ will operate properly with a modified version of the library, if
+ the user installs one, as long as the modified version is
+ interface-compatible with the version that the work was made with.
+
+ <LI><STRONG>c)</STRONG> Accompany the work with a written offer, valid for at
+ least three years, to give the same user the materials
+ specified in Subsection 6a, above, for a charge no more
+ than the cost of performing this distribution.
+
+ <LI><STRONG>d)</STRONG> If distribution of the work is made by offering access to copy
+ from a designated place, offer equivalent access to copy the above
+ specified materials from the same place.
+
+ <LI><STRONG>e)</STRONG> Verify that the user has already received a copy of these
+ materials or that you have already sent this user a copy.
+
+</UL>
+<P>
+ For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it. However, as a special exception,
+the materials to be 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.
+<P>
+ It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system. Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+<P>
+<STRONG>7.</STRONG> You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+<P>
+<UL>
+ <LI><STRONG>a)</STRONG> Accompany the combined library with a copy of the same work
+ based on the Library, uncombined with any other library
+ facilities. This must be distributed under the terms of the
+ Sections above.
+
+ <LI><STRONG>b)</STRONG> Give prominent notice with the combined library of the fact
+ that part of it is a work based on the Library, and explaining
+ where to find the accompanying uncombined form of the same work.
+
+</UL>
+<P>
+<STRONG>8.</STRONG> You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License. Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library 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.
+<P>
+<STRONG>9.</STRONG>
+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 Library or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+<P>
+<STRONG>10.</STRONG>
+Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+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 with
+this License.
+<P>
+<STRONG>11.</STRONG>
+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 Library at all. For example, if a patent
+license would not permit royalty-free redistribution of the Library 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 Library.
+
+<P>
+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.
+<P>
+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.
+<P>
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+<P>
+<STRONG>12.</STRONG>
+If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library 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.
+<P>
+<STRONG>13.</STRONG>
+The Free Software Foundation may publish revised and/or new
+versions of the Lesser 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.
+<P>
+Each version is given a distinguishing version number. If the Library
+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 Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+<P>
+
+<STRONG>14.</STRONG>
+If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+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.
+<P>
+<STRONG>NO WARRANTY</STRONG>
+<P>
+<STRONG>15.</STRONG>
+BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "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
+LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+<P>
+<STRONG>16.</STRONG>
+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 LIBRARY 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
+LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+<P>
+
+
+
+*/
diff --git a/user_doc.head.html b/user_doc.head.html
index d721bd20..f5ee9ab1 100644
--- a/user_doc.head.html
+++ b/user_doc.head.html
@@ -26,9 +26,7 @@ H3
|
<a class="qindex" href="design.html">Design document</a>
|
-<a class="qindex" href="commands.html">External commands</a>
-|
-<a class="qindex" href="builtins.html">Builtin commands</a>
+<a class="qindex" href="commands.html">Commands</a>
|
<a class="qindex" href="faq.html">FAQ</a>
|