github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-26 02:13:38 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
21ddffb9e0
fish-shell/doc_src/cmds/string-collect.rst

59 lines
1.8 KiB
ReStructuredText
Raw Normal View History

Add individual documentation pages for string's subcommands This adds string-x.rst for each subcommand x of string. The main page (string.rst) is not changed, except that examples are shown directly after each subcommand. The subcommand sections in string.rst are created by textual inclusion of parts of the string-x.rst files. Subcommand man pages can be viewed with either of: ``` man string collect man string-collect string collect <press F1 or Alt-h> string collect -h ``` While `string -h ...` still prints the full help. Closes #5968
2019-10-27 17:56:24 +08:00
string-collect - join strings into one
======================================
Synopsis
--------
.. BEGIN SYNOPSIS
::
string: Allow `collect --allow-empty` to avoid empty ellision (#8054) * string: Allow `collect --no-empty` to avoid empty ellision Currently we still have that issue where test -n (thing | string collect) can return true if `thing` doesn't print anything, because the collected argument will still be removed. So, what we do is allow `--no-empty` to be used, in which case we print one empty argument. This means test -n (thing | string collect -n) can now be safely used. "no-empty" isn't the best name for this flag, but string's design really incentivizes reusing names, and it's not *terrible*. * Switch to `--allow-empty` `--no-empty` does the exact opposite for `string split` and split0. Since `-a`/`--allow-empty` already exists, use it.
2021-07-10 03:20:58 +08:00
string collect [(-a | --allow-empty)] [(-N | --no-trim-newlines)] [STRING...]
Add individual documentation pages for string's subcommands This adds string-x.rst for each subcommand x of string. The main page (string.rst) is not changed, except that examples are shown directly after each subcommand. The subcommand sections in string.rst are created by textual inclusion of parts of the string-x.rst files. Subcommand man pages can be viewed with either of: ``` man string collect man string-collect string collect <press F1 or Alt-h> string collect -h ``` While `string -h ...` still prints the full help. Closes #5968
2019-10-27 17:56:24 +08:00
.. END SYNOPSIS
Description
-----------
.. BEGIN DESCRIPTION
``string collect`` collects its input into a single output argument, without splitting the output when used in a command substitution. This is useful when trying to collect multiline output from another command into a variable. Exit status: 0 if any output argument is non-empty, or 1 otherwise.
Docs for "$(cmd)" and $(cmd)
2021-07-03 05:11:03 +08:00
A command like ``echo (cmd | string collect)`` is mostly equivalent to a quoted command substitution (``echo "$(cmd)"``). The main difference is that the former evaluates to zero or one elements whereas the quoted command substitution always evaluates to one element due to string interpolation.
Add individual documentation pages for string's subcommands This adds string-x.rst for each subcommand x of string. The main page (string.rst) is not changed, except that examples are shown directly after each subcommand. The subcommand sections in string.rst are created by textual inclusion of parts of the string-x.rst files. Subcommand man pages can be viewed with either of: ``` man string collect man string-collect string collect <press F1 or Alt-h> string collect -h ``` While `string -h ...` still prints the full help. Closes #5968
2019-10-27 17:56:24 +08:00
If invoked with multiple arguments instead of input, ``string collect`` preserves each argument separately, where the number of output arguments is equal to the number of arguments given to ``string collect``.
Docs for "$(cmd)" and $(cmd)
2021-07-03 05:11:03 +08:00
Any trailing newlines on the input are trimmed, just as with ``"$(cmd)"`` substitution. Use ``--no-trim-newlines`` to disable this behavior, which may be useful when running a command such as ``set contents (cat filename | string collect -N)``.
Add individual documentation pages for string's subcommands This adds string-x.rst for each subcommand x of string. The main page (string.rst) is not changed, except that examples are shown directly after each subcommand. The subcommand sections in string.rst are created by textual inclusion of parts of the string-x.rst files. Subcommand man pages can be viewed with either of: ``` man string collect man string-collect string collect <press F1 or Alt-h> string collect -h ``` While `string -h ...` still prints the full help. Closes #5968
2019-10-27 17:56:24 +08:00
string: Allow `collect --allow-empty` to avoid empty ellision (#8054) * string: Allow `collect --no-empty` to avoid empty ellision Currently we still have that issue where test -n (thing | string collect) can return true if `thing` doesn't print anything, because the collected argument will still be removed. So, what we do is allow `--no-empty` to be used, in which case we print one empty argument. This means test -n (thing | string collect -n) can now be safely used. "no-empty" isn't the best name for this flag, but string's design really incentivizes reusing names, and it's not *terrible*. * Switch to `--allow-empty` `--no-empty` does the exact opposite for `string split` and split0. Since `-a`/`--allow-empty` already exists, use it.
2021-07-10 03:20:58 +08:00
With ``--allow-empty``, ``string collect`` always prints one (empty) argument. This can be used to prevent an argument from disappearing.
Add individual documentation pages for string's subcommands This adds string-x.rst for each subcommand x of string. The main page (string.rst) is not changed, except that examples are shown directly after each subcommand. The subcommand sections in string.rst are created by textual inclusion of parts of the string-x.rst files. Subcommand man pages can be viewed with either of: ``` man string collect man string-collect string collect <press F1 or Alt-h> string collect -h ``` While `string -h ...` still prints the full help. Closes #5968
2019-10-27 17:56:24 +08:00
.. END DESCRIPTION
Examples
--------
.. BEGIN EXAMPLES
::
Docs for "$(cmd)" and $(cmd)
2021-07-03 05:11:03 +08:00
>_ echo "zero $(echo one\ntwo\nthree) four"
zero one
two
three four
Add individual documentation pages for string's subcommands This adds string-x.rst for each subcommand x of string. The main page (string.rst) is not changed, except that examples are shown directly after each subcommand. The subcommand sections in string.rst are created by textual inclusion of parts of the string-x.rst files. Subcommand man pages can be viewed with either of: ``` man string collect man string-collect string collect <press F1 or Alt-h> string collect -h ``` While `string -h ...` still prints the full help. Closes #5968
2019-10-27 17:56:24 +08:00
>_ echo \"(echo one\ntwo\nthree | string collect)\"
"one
two
Fix string collect examples collect -N leaves the trailing newline, not the other way around.
2020-06-08 00:51:34 +08:00
three"
Add individual documentation pages for string's subcommands This adds string-x.rst for each subcommand x of string. The main page (string.rst) is not changed, except that examples are shown directly after each subcommand. The subcommand sections in string.rst are created by textual inclusion of parts of the string-x.rst files. Subcommand man pages can be viewed with either of: ``` man string collect man string-collect string collect <press F1 or Alt-h> string collect -h ``` While `string -h ...` still prints the full help. Closes #5968
2019-10-27 17:56:24 +08:00
>_ echo \"(echo one\ntwo\nthree | string collect -N)\"
"one
two
Fix string collect examples collect -N leaves the trailing newline, not the other way around.
2020-06-08 00:51:34 +08:00
three
"
Add individual documentation pages for string's subcommands This adds string-x.rst for each subcommand x of string. The main page (string.rst) is not changed, except that examples are shown directly after each subcommand. The subcommand sections in string.rst are created by textual inclusion of parts of the string-x.rst files. Subcommand man pages can be viewed with either of: ``` man string collect man string-collect string collect <press F1 or Alt-h> string collect -h ``` While `string -h ...` still prints the full help. Closes #5968
2019-10-27 17:56:24 +08:00
string: Allow `collect --allow-empty` to avoid empty ellision (#8054) * string: Allow `collect --no-empty` to avoid empty ellision Currently we still have that issue where test -n (thing | string collect) can return true if `thing` doesn't print anything, because the collected argument will still be removed. So, what we do is allow `--no-empty` to be used, in which case we print one empty argument. This means test -n (thing | string collect -n) can now be safely used. "no-empty" isn't the best name for this flag, but string's design really incentivizes reusing names, and it's not *terrible*. * Switch to `--allow-empty` `--no-empty` does the exact opposite for `string split` and split0. Since `-a`/`--allow-empty` already exists, use it.
2021-07-10 03:20:58 +08:00
>_ echo foo(true | string collect --allow-empty)bar
foobar
Add individual documentation pages for string's subcommands This adds string-x.rst for each subcommand x of string. The main page (string.rst) is not changed, except that examples are shown directly after each subcommand. The subcommand sections in string.rst are created by textual inclusion of parts of the string-x.rst files. Subcommand man pages can be viewed with either of: ``` man string collect man string-collect string collect <press F1 or Alt-h> string collect -h ``` While `string -h ...` still prints the full help. Closes #5968
2019-10-27 17:56:24 +08:00
.. END EXAMPLES
Reference in New Issue Copy Permalink