fish-shell/doc_src/read.txt

\section read read - read line of input into variables

\subsection read-synopsis Synopsis
<tt>read [OPTIONS] [VARIABLES...]</tt>

\subsection read-description Description

The <tt>read</tt> builtin causes fish to read one line from standard
input and store the result in one or more environment variables.

- <tt>-c CMD</tt> or <tt>--command=CMD</tt> specifies that the initial string in the interactive mode command buffer should be CMD.
- <tt>-g</tt> or <tt>--global</tt> specifies that the variables will be made global.
- <tt>-l</tt> or <tt>--local</tt> specifies that the variables will be made local.
- <tt>-m NAME</tt> or <tt>--mode-name=NAME</tt> specifies that the name NAME should be used to save/load the history file. If NAME is fish, the regular fish history will be available.
- <tt>-p PROMPT_CMD</tt> or <tt>--prompt=PROMPT_CMD</tt> specifies that the output of the shell command PROMPT_CMD should be used as the prompt for the interactive mode prompt. The default prompt command is <tt>set_color green; echo read; set_color normal; echo "> "</tt>.
- <code>-s</code> or <code>--shell</code> Use syntax highlighting, tab completions and command termination suitable for entering shellscript code
- <code>-u</code> or <code>--unexport</code> causes the specified environment not to be exported to child processes
- <code>-U</code> or <code>--universal</code> 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.
- <code>-x</code> or <code>--export</code> causes the specified environment variable to be exported to child processes

Read starts by reading a single line of input from stdin, the line is
then tokenized using the <tt>IFS</tt> environment variable. Each variable
specified in <tt>VARIABLES</tt> is then assigned one tokenized string
element. If there are more tokens than variables, the complete
remainder is assigned to the last variable.

\subsection read-example Example

<tt>echo hello|read foo</tt>

Will cause the variable \$foo to be assigned the value hello.
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 13:31:55 +00:00			`\section read read - read line of input into variables`

			`\subsection read-synopsis Synopsis`
			`<tt>read [OPTIONS] [VARIABLES...]</tt>`

			`\subsection read-description Description`

			`The <tt>read</tt> builtin causes fish to read one line from standard`
remove trialing spaces #2 2010-09-18 02:18:26 +00:00			`input and store the result in one or more environment variables.`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 13:31:55 +00:00
Add missing documentation for the read builtin darcs-hash:20060420150124-ac50b-71a94cea3fedb0265af71718022e54e42567d69e.gz 2006-04-20 15:01:24 +00:00			`- <tt>-c CMD</tt> or <tt>--command=CMD</tt> specifies that the initial string in the interactive mode command buffer should be CMD.`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 13:31:55 +00:00			`- <tt>-g</tt> or <tt>--global</tt> specifies that the variables will be made global.`
Set single-line default prompt Fish now doesn't join the fish_prompt output. This breaks the default fish_prompt. Make default fish_prompt single-line. Fixes #203. Add -l flag to 'read' documentation. Remove ambiguous '-x' description. Fixes #157. 2012-07-07 02:17:24 +00:00			`- <tt>-l</tt> or <tt>--local</tt> specifies that the variables will be made local.`
remove trialing spaces #2 2010-09-18 02:18:26 +00:00			`- <tt>-m NAME</tt> or <tt>--mode-name=NAME</tt> specifies that the name NAME should be used to save/load the history file. If NAME is fish, the regular fish history will be available.`
Add missing documentation for the read builtin darcs-hash:20060420150124-ac50b-71a94cea3fedb0265af71718022e54e42567d69e.gz 2006-04-20 15:01:24 +00:00			`- <tt>-p PROMPT_CMD</tt> or <tt>--prompt=PROMPT_CMD</tt> specifies that the output of the shell command PROMPT_CMD should be used as the prompt for the interactive mode prompt. The default prompt command is <tt>set_color green; echo read; set_color normal; echo "> "</tt>.`
Add support for -s switch to read builtin, enables shell syntax highlighting in the read builtin darcs-hash:20070129162624-ac50b-dff9d9ebf16ce3247b83d917efbffd4942cda83f.gz 2007-01-29 16:26:24 +00:00			`- <code>-s</code> or <code>--shell</code> Use syntax highlighting, tab completions and command termination suitable for entering shellscript code`
Add missing documentation for the read builtin darcs-hash:20060420150124-ac50b-71a94cea3fedb0265af71718022e54e42567d69e.gz 2006-04-20 15:01:24 +00:00			`- <code>-u</code> or <code>--unexport</code> causes the specified environment not to be exported to child processes`
			`- <code>-U</code> or <code>--universal</code> 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.`
			`- <code>-x</code> or <code>--export</code> causes the specified environment variable to be exported to child processes`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 13:31:55 +00:00
			`Read starts by reading a single line of input from stdin, the line is`
			`then tokenized using the <tt>IFS</tt> environment variable. Each variable`
			`specified in <tt>VARIABLES</tt> is then assigned one tokenized string`
			`element. If there are more tokens than variables, the complete`
			`remainder is assigned to the last variable.`

			`\subsection read-example Example`

			`<tt>echo hello\|read foo</tt>`

			`Will cause the variable \$foo to be assigned the value hello.`