github-mirror/fish-shell
github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2025-03-12 05:15:24 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Document string split superpowers more

Browse Source 
[ci skip]
This commit is contained in:
Fabian Homborg 2019-05-19 19:40:48 +02:00
parent 3efa2ad93b
commit 257c72d8be
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
sphinx_doc_src/cmds/string.rst
View File

@ -132,6 +132,8 @@ If you specify the ``-f`` or ``--filter`` flag then each input string is printed
Exit status: 0 if at least one replacement was performed, or 1 otherwise. Exit status: 0 if at least one replacement was performed, or 1 otherwise.
.. _cmd-string-split:
"split" subcommand "split" subcommand
------------------ ------------------
@ -141,6 +143,8 @@ Exit status: 0 if at least one replacement was performed, or 1 otherwise.
See also ``read --delimiter``. See also ``read --delimiter``.
.. _cmd-string-split0:
"split0" subcommand "split0" subcommand
------------------- -------------------

4
sphinx_doc_src/index.rst
View File

@ -739,6 +739,8 @@ Command substitution
The output of a series of commands can be used as the parameters to another command. If a parameter contains a set of parenthesis, the text enclosed by the parenthesis will be interpreted as a list of commands. On expansion, this list is executed, and substituted by the output. If the output is more than one line long, each line will be expanded to a new parameter. Setting ``IFS`` to the empty string will disable line splitting. The output of a series of commands can be used as the parameters to another command. If a parameter contains a set of parenthesis, the text enclosed by the parenthesis will be interpreted as a list of commands. On expansion, this list is executed, and substituted by the output. If the output is more than one line long, each line will be expanded to a new parameter. Setting ``IFS`` to the empty string will disable line splitting.
If the output is piped to :ref:`string split <cmd-string-split>` or `string split0 <cmd-string-split0>` as the last step, those splits are used as they appear and no additional splitting on newlines takes place.
The exit status of the last run command substitution is available in the `status <#variables-status>`_ variable if the substitution occurs in the context of a ``set`` command. The exit status of the last run command substitution is available in the `status <#variables-status>`_ variable if the substitution occurs in the context of a ``set`` command.
Only part of the output can be used, see `index range expansion <#expand-index-range>`_ for details. Only part of the output can be used, see `index range expansion <#expand-index-range>`_ for details.
@ -758,6 +760,8 @@ Examples::
# Set the ``data`` variable to the contents of 'data.txt' # Set the ``data`` variable to the contents of 'data.txt'
# without splitting it into a list. # without splitting it into a list.
set data (cat data | string split0)
# Set ``$data`` to the contents of data, splitting on NUL-bytes.
.. _expand-brace: .. _expand-brace: