fish-shell/sphinx_doc_src/cmds/string-join.rst

string-join - join strings with delimiter
=========================================

Synopsis
--------

.. BEGIN SYNOPSIS

::

    string join [(-q | --quiet)] SEP [STRING...]
    string join0 [(-q | --quiet)] [STRING...]

.. END SYNOPSIS

Description
-----------

.. BEGIN DESCRIPTION

``string join`` joins its STRING arguments into a single string separated by SEP, which can be an empty string. Exit status: 0 if at least one join was performed, or 1 otherwise.

``string join0`` joins its STRING arguments into a single string separated by the zero byte (NUL), and adds a trailing NUL. This is most useful in conjunction with tools that accept NUL-delimited input, such as ``sort -z``. Exit status: 0 if at least one join was performed, or 1 otherwise.

.. END DESCRIPTION

Examples
--------

.. BEGIN EXAMPLES

::

    >_ seq 3 | string join ...
    1...2...3

.. END EXAMPLES
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-join - join strings with delimiter`
			`=========================================`

			`Synopsis`
			`--------`

			`.. BEGIN SYNOPSIS`

			`::`

			`string join [(-q \| --quiet)] SEP [STRING...]`
			`string join0 [(-q \| --quiet)] [STRING...]`

			`.. END SYNOPSIS`

			`Description`
			`-----------`

			`.. BEGIN DESCRIPTION`

			``string join`` joins its STRING arguments into a single string separated by SEP, which can be an empty string. Exit status: 0 if at least one join was performed, or 1 otherwise.

			``string join0`` joins its STRING arguments into a single string separated by the zero byte (NUL), and adds a trailing NUL. This is most useful in conjunction with tools that accept NUL-delimited input, such as ``sort -z``. Exit status: 0 if at least one join was performed, or 1 otherwise.

			`.. END DESCRIPTION`

			`Examples`
			`--------`

			`.. BEGIN EXAMPLES`

			`::`

			`>_ seq 3 \| string join ...`
			`1...2...3`

			`.. END EXAMPLES`