fish-shell/doc_src/set.txt

\section set set - Handle environment variables.

\subsection set-synopsis Synopsis
<tt>set [OPTIONS] VARIABLE_NAME [VALUES...]</tt>

The <tt>set</tt> builtin causes fish to assign the variable <tt>VARIABLE_NAME</tt> the values <tt>VALUES...</tt>. 

\subsection set-description Description
- <tt>-e</tt> or <tt>--erase</tt> causes the specified environment variable to be erased
- <tt>-g</tt> or <tt>--global</tt> causes the specified environment variable to be made global. If this option is not supplied, the specified variable will dissapear when the current block ends
- <tt>-l</tt> or <tt>--local</tt> forces the specified environment variable to be made local to the current block, even if the variable already exists and is non-local
- <tt>-n</tt> or <tt>--names</tt> List only the names of all defined variables
- <tt>-q</tt> or <tt>--query</tt> test if the specified variable names are defined. Does not output anything, but the builtins exit status is the number of variables specified that were not defined.
- <tt>-u</tt> or <tt>--unexport</tt> causes the specified environment not to be exported to child processes
- <tt>-U</tt> or <tt>--universal</tt> causes the specified environment variable to be made universal. If this option is supplied, the variable will be shared between all the current users fish instances on the current computer, and will be preserved across restarts of the shell.
- <tt>-x</tt> or <tt>--export</tt> causes the specified environment variable to be exported to child processes

If set is called with no arguments, the names and values of all
environment variables are printed.

If the \c -e or \c --erase option is specified, the variable
specified by the following arguments will be erased

If a variable is set to more than one value, the variable will be an
array with the specified elements. If a variable is set to zero
elements, it will become an array with zero elements.

If the variable name is one or more array elements, such as <tt>PATH[1
3 7]</tt>, only those array elements specified will be changed.

\subsection set-example Example

<tt>set foo hi</tt> sets the value of the variable foo to be hi.

<tt>set -e smurf</tt> removes the variable \c smurf.

<tt>set PATH[4] ~/bin</tt> changes the fourth element of the \c PATH array to \c ~/bin
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00			`\section set set - Handle environment variables.`

			`\subsection set-synopsis Synopsis`
			`<tt>set [OPTIONS] VARIABLE_NAME [VALUES...]</tt>`

			`The <tt>set</tt> builtin causes fish to assign the variable <tt>VARIABLE_NAME</tt> the values <tt>VALUES...</tt>.`

			`\subsection set-description Description`
Event handling and job reaping updates darcs-hash:20051011192343-ac50b-aa3f5ae5e2b34d122f10e3b59ceb6fdd447f4ae3.gz 2005-10-12 03:23:43 +08:00			`- <tt>-e</tt> or <tt>--erase</tt> causes the specified environment variable to be erased`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00			`- <tt>-g</tt> or <tt>--global</tt> causes the specified environment variable to be made global. If this option is not supplied, the specified variable will dissapear when the current block ends`
			`- <tt>-l</tt> or <tt>--local</tt> forces the specified environment variable to be made local to the current block, even if the variable already exists and is non-local`
			`- <tt>-n</tt> or <tt>--names</tt> List only the names of all defined variables`
Spelling fixes darcs-hash:20051008093310-ac50b-077bd66d4b2c3f98de421e04b125f0d89e9d503a.gz 2005-10-08 17:33:10 +08:00			`- <tt>-q</tt> or <tt>--query</tt> test if the specified variable names are defined. Does not output anything, but the builtins exit status is the number of variables specified that were not defined.`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00			`- <tt>-u</tt> or <tt>--unexport</tt> causes the specified environment not to be exported to child processes`
Exportable universal variables darcs-hash:20050922201652-ac50b-f70e7607b4ace24da4020f2d432718dc335e5bdd.gz 2005-09-23 04:16:52 +08:00			`- <tt>-U</tt> or <tt>--universal</tt> causes the specified environment variable to be made universal. If this option is supplied, the variable will be shared between all the current users fish instances on the current computer, and will be preserved across restarts of the shell.`
			`- <tt>-x</tt> or <tt>--export</tt> causes the specified environment variable to be exported to child processes`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
			`If set is called with no arguments, the names and values of all`
			`environment variables are printed.`

Event handling and job reaping updates darcs-hash:20051011192343-ac50b-aa3f5ae5e2b34d122f10e3b59ceb6fdd447f4ae3.gz 2005-10-12 03:23:43 +08:00			`If the \c -e or \c --erase option is specified, the variable`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00			`specified by the following arguments will be erased`

			`If a variable is set to more than one value, the variable will be an`
Correct set help page. The handling of setting a variable to no value has changed. darcs-hash:20051207162924-ac50b-3e3c579b8b932b9a5a11546fb4a042d5e2aa85c5.gz 2005-12-08 00:29:24 +08:00			`array with the specified elements. If a variable is set to zero`
			`elements, it will become an array with zero elements.`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
			`If the variable name is one or more array elements, such as <tt>PATH[1`
			`3 7]</tt>, only those array elements specified will be changed.`

			`\subsection set-example Example`

			`<tt>set foo hi</tt> sets the value of the variable foo to be hi.`

			`<tt>set -e smurf</tt> removes the variable \c smurf.`

			`<tt>set PATH[4] ~/bin</tt> changes the fourth element of the \c PATH array to \c ~/bin`