h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-05-04 04:31:14 -03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation update

Browse Source 
Rework for Doxygen >1.8. Moved large parts of the documentation to a
simplified format, making use of Markdown enhancements and fixing bad
long options.
This commit is contained in:
Mark Griffiths
2014-08-01 03:37:32 +01:00
parent 1c4223889b
commit d282bc4625
86 changed files with 9212 additions and 4813 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc_src/read.txt
View File

@@ -1,11 +1,13 @@
\section read read - read line of input into variables
\subsection read-synopsis Synopsis
<tt>read [OPTIONS] [VARIABLES...]</tt>
\fish{syn}
read [OPTIONS] [VARIABLES...]
\endfish
\subsection read-description Description
<tt>read</tt> reads one line from standard
`read` reads one line from standard
input and stores the result in one or more shell variables.
The following options are available:
@@ -31,12 +33,12 @@ input is considered a separate token.
If \c -a or \c --array is provided, only one variable name is allowed and the
tokens are stored as an array in this variable.
See the documentation for \c set for more details on the scoping rules for
See the documentation for `set` for more details on the scoping rules for
variables.
\subsection read-example Example
The following code stores the value 'hello' in the shell variable
<tt>$foo</tt>.
`$foo`.
<tt>echo hello|read foo</tt>
`echo hello|read foo`