fish-shell/doc_src/cmds/string-length.rst

string-length - print string lengths
====================================

Synopsis
--------

.. BEGIN SYNOPSIS

::

    string length [(-q | --quiet)] [STRING...]

.. END SYNOPSIS

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

.. BEGIN DESCRIPTION

``string length`` reports the length of each string argument in characters. Exit status: 0 if at least one non-empty STRING was given, or 1 otherwise.

.. END DESCRIPTION

Examples
--------

.. BEGIN EXAMPLES

::

    >_ string length 'hello, world'
    12

    >_ set str foo
    >_ string length -q $str; echo $status
    0
    # Equivalent to test -n "$str"

.. 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-length - print string lengths`
			`====================================`

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

			`.. BEGIN SYNOPSIS`

			`::`

			`string length [(-q \| --quiet)] [STRING...]`

			`.. END SYNOPSIS`

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

			`.. BEGIN DESCRIPTION`

			``string length`` reports the length of each string argument in characters. Exit status: 0 if at least one non-empty STRING was given, or 1 otherwise.

			`.. END DESCRIPTION`

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

			`.. BEGIN EXAMPLES`

			`::`

			`>_ string length 'hello, world'`
			`12`

			`>_ set str foo`
			`>_ string length -q $str; echo $status`
			`0`
Fix example in string length docs Technically the equivalence would be something like string length -q $str test -n (string join \n -- $str \| string collect) To handle when str has multiple empty strings; but quoting is easier to remember and enough for most practical purposes. 2020-09-28 03:04:19 +08:00			`# Equivalent to test -n "$str"`
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`