Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2025-01-14 05:53:59 +00:00
Code Issues Projects Releases Packages Wiki Activity

Minor documentation edits

Browse source 
darcs-hash:20060729173123-ac50b-9b895afc355cf5dc342fca3c276cfbf10c286bc2.gz
This commit is contained in:
axel 2006-07-30 03:31:23 +10:00
parent aa895c6740
commit db369a9ad7
1 changed files with 27 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
doc_src/doc.hdr
View file

@ -261,20 +261,36 @@ the example above, these are simply passed on to the ls command. For
more information on functions, see the documentation for the <a more information on functions, see the documentation for the <a
href='builtin.html#function'>function</a> builtin. href='builtin.html#function'>function</a> builtin.
\subsubsection Autoloading functions
Functions can be defined on the commandline or in a configuration Functions can be defined on the commandline or in a configuration
file, but they can also be automatically loaded. Fish automatically file, but they can also be automatically loaded. This method of
searches through any directories in the array variable defining functions has several advantages. An autoloaded function
\$fish_function_path, and any functions defined are automatically becomes avaialble automatically to all running shells, if the function
loaded when needed. A function definition file must have a filename definition is changed, all running shells will automatically reload
consisting of the name of the function plus the suffix '.fish'. the altered version, startup time and memory usage is improved, etc.
Fish automatically searches through any directories in the array
variable \$fish_function_path, and any functions defined are
automatically loaded when needed. A function definition file must have
a filename consisting of the name of the function plus the suffix
'.fish'.
The default value for \$fish_function_path is \c ~/.fish.d/functions The default value for \$fish_function_path is \c ~/.fish.d/functions
\c /etc/fish.d/functions \c /usr/share/fish/functions. The exact path to the \c /etc/fish.d/functions \c /usr/share/fish/functions. The exact path
last two of these may be slighly different depending on what install to the last two of these may be slighly different depending on what
path prefix was chosen at configuration time. The rationale behind install path prefix was chosen at configuration time. The rationale
having three different directories is that the first one is for user behind having three different directories is that the first one is for
specific functions, the second one is for system-wide additional user specific functions, the second one is for system-wide additional
functions and the last one is for default fish functions. functions and the last one is for default fish functions. The path
list is searched in order, meaning that by default, the system
administrator can override default fish functions, and the user can
override functions defined by the system administrator.
It is very important that function definition files only contain the
definition for the specified function and nothing else, otherwise it
is possible that autoloading a function files requires that the
function already be loaded, i.e. a circular dependency.
\subsection syntax-words Some common words \subsection syntax-words Some common words