diff options
| author |  Mark Griffiths <mark@thebespokepixel.com> | 2014-09-04 10:00:52 +0100 |
|---|---|---|
| committer | Mark Griffiths <mark@thebespokepixel.com> | 2014-09-04 10:00:52 +0100 |
| commit | 0e5ddfd9f5f8c8b7276130588585004408174512 (patch) | |
| tree | d53961feec05cc7f3eb813f03558aaa5e864999f /doc_src/read.txt | |
| parent | 0a249c84cec0f5a52ac70d443a3a04bba31aa841 (diff) | |
| parent | 4b7dc525b854207e627f5eb9d1fe25111eca4dc1 (diff) | |
Merge branch 'master' into documentation-update
Conflicts (fixed):
doc_src/design.hdr
Diffstat (limited to 'doc_src/read.txt')
| -rw-r--r-- | doc_src/read.txt | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc_src/read.txt b/doc_src/read.txt index 845e306d..aee3e85b 100644 --- a/doc_src/read.txt +++ b/doc_src/read.txt @@ -19,6 +19,8 @@ The following options are available: - `-m NAME` or `--mode-name=NAME` 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. +- `-n NCHARS` or `--nchars=NCHARS` causes `read` to return after reading NCHARS characters rather than waiting for a complete line of input. + - `-p PROMPT_CMD` or `--prompt=PROMPT_CMD` uses the output of the shell command `PROMPT_CMD` as the prompt for the interactive mode. The default prompt command is <code>set_color green; echo read; set_color normal; echo "> "</code>. - `-s` or `--shell` enables syntax highlighting, tab completions and command termination suitable for entering shellscript code in the interactive mode. @@ -35,6 +37,8 @@ The following options are available: If `-a` or `--array` is provided, only one variable name is allowed and the tokens are stored as an array in this variable. +See the documentation for `set` for more details on the scoping rules for variables. + \subsection read-example Example |