github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-12-02 07:33:54 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
f1c4fbaad8
fish-shell/sphinx_doc_src/cmds/string.rst

316 lines
9.4 KiB
ReStructuredText
Raw Normal View History

docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip]
2019-03-31 17:05:09 +08:00
.. _cmd-string:
Switch command docs from \section to reStructuredText
2018-12-17 09:39:33 +08:00
string - manipulate strings
Fix command section separator line lengths
2019-01-03 12:10:47 +08:00
===========================
Switch command docs from \section to reStructuredText
2018-12-17 09:39:33 +08:00
Migrate the 'synopsis' sections to .rst format
2018-12-18 09:58:24 +08:00
Synopsis
--------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance.
2019-09-17 17:59:04 +08:00
::
string collect [(-N | --no-trim-newlines)] [STRING...]
string escape [(-n | --no-quoted)] [--style=xxx] [STRING...]
string join [(-q | --quiet)] SEP [STRING...]
string join0 [(-q | --quiet)] [STRING...]
string length [(-q | --quiet)] [STRING...]
string lower [(-q | --quiet)] [STRING...]
string match [(-a | --all)] [(-e | --entire)] [(-i | --ignore-case)] [(-r | --regex)] [(-n | --index)] [(-q | --quiet)] [(-v | --invert)] PATTERN [STRING...]
string repeat [(-n | --count) COUNT] [(-m | --max) MAX] [(-N | --no-newline)] [(-q | --quiet)] [STRING...]
string replace [(-a | --all)] [(-f | --filter)] [(-i | --ignore-case)] [(-r | --regex)] [(-q | --quiet)] PATTERN REPLACEMENT [STRING...]
string split [(-m | --max) MAX] [(-n | --no-empty)] [(-q | --quiet)] [(-r | --right)] SEP [STRING...]
string split0 [(-m | --max) MAX] [(-n | --no-empty)] [(-q | --quiet)] [(-r | --right)] [STRING...]
string sub [(-s | --start) START] [(-l | --length) LENGTH] [(-q | --quiet)] [STRING...]
string trim [(-l | --left)] [(-r | --right)] [(-c | --chars CHARS)] [(-q | --quiet)] [STRING...]
string unescape [--style=xxx] [STRING...]
string upper [(-q | --quiet)] [STRING...]
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format
2018-12-19 10:44:30 +08:00
Description
Fix command section separator line lengths
2019-01-03 12:10:47 +08:00
-----------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility
2018-12-20 04:02:45 +08:00
``string`` performs operations on strings.
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
STRING arguments are taken from the command line unless standard input is connected to a pipe or a file, in which case they are read from standard input, one STRING per line. It is an error to supply STRING arguments on the command line and on standard input.
Switch backticks to double backticks for rst compatibility
2018-12-20 04:02:45 +08:00
Arguments beginning with ``-`` are normally interpreted as switches; ``--`` causes the following arguments not to be treated as switches even if they begin with ``-``. Switches and required arguments are recognized only on the command line.
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility
2018-12-20 04:02:45 +08:00
Most subcommands accept a ``-q`` or ``--quiet`` switch, which suppresses the usual output but exits with the documented status.
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
The following subcommands are available.
Add string collect The `string collect` subcommand behaves quite similarly in practice to `string split0 -m 0` in that it doesn't split its output, but it also takes an optional `--trim-newline` flag to trim a single trailing newline off of the output. See issue #159.
2019-06-16 13:30:31 +08:00
"collect" subcommand
--------------------
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
.. include:: string-collect.rst
:start-after: BEGIN SYNOPSIS
:end-before: END SYNOPSIS
Add string collect The `string collect` subcommand behaves quite similarly in practice to `string split0 -m 0` in that it doesn't split its output, but it also takes an optional `--trim-newline` flag to trim a single trailing newline off of the output. See issue #159.
2019-06-16 13:30:31 +08:00
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
.. include:: string-collect.rst
:start-after: BEGIN DESCRIPTION
:end-before: END DESCRIPTION
Add string collect The `string collect` subcommand behaves quite similarly in practice to `string split0 -m 0` in that it doesn't split its output, but it also takes an optional `--trim-newline` flag to trim a single trailing newline off of the output. See issue #159.
2019-06-16 13:30:31 +08:00
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
Examples
^^^^^^^^
Add string collect The `string collect` subcommand behaves quite similarly in practice to `string split0 -m 0` in that it doesn't split its output, but it also takes an optional `--trim-newline` flag to trim a single trailing newline off of the output. See issue #159.
2019-06-16 13:30:31 +08:00
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
.. include:: string-collect.rst
:start-after: BEGIN EXAMPLES
:end-before: END EXAMPLES
Add string collect The `string collect` subcommand behaves quite similarly in practice to `string split0 -m 0` in that it doesn't split its output, but it also takes an optional `--trim-newline` flag to trim a single trailing newline off of the output. See issue #159.
2019-06-16 13:30:31 +08:00
docs/cmds/string: Improve synopsis This both formats it as a code-block, and adds the synopsis of each subcommand to the corresponding section again so you don't need to scroll back-and-forth so much. [ci skip]
2019-03-30 03:05:42 +08:00
"escape" and "unescape" subcommands
-----------------------------------
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
.. include:: string-escape.rst
:start-after: BEGIN SYNOPSIS
:end-before: END SYNOPSIS
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-escape.rst
:start-after: BEGIN DESCRIPTION
:end-before: END DESCRIPTION
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
Examples
^^^^^^^^
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-escape.rst
:start-after: BEGIN EXAMPLES
:end-before: END EXAMPLES
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
"join" and "join0" subcommands
------------------------------
docs/cmds/string: Improve synopsis This both formats it as a code-block, and adds the synopsis of each subcommand to the corresponding section again so you don't need to scroll back-and-forth so much. [ci skip]
2019-03-30 03:05:42 +08:00
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
.. include:: string-join.rst
:start-after: BEGIN SYNOPSIS
:end-before: END SYNOPSIS
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-join.rst
:start-after: BEGIN DESCRIPTION
:end-before: END DESCRIPTION
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
Examples
^^^^^^^^
docs/cmds/string: Improve synopsis This both formats it as a code-block, and adds the synopsis of each subcommand to the corresponding section again so you don't need to scroll back-and-forth so much. [ci skip]
2019-03-30 03:05:42 +08:00
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
.. include:: string-join.rst
:start-after: BEGIN EXAMPLES
:end-before: END EXAMPLES
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format
2018-12-19 10:44:30 +08:00
"length" subcommand
Fix command section separator line lengths
2019-01-03 12:10:47 +08:00
-------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-length.rst
:start-after: BEGIN SYNOPSIS
:end-before: END SYNOPSIS
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-length.rst
:start-after: BEGIN DESCRIPTION
:end-before: END DESCRIPTION
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
Examples
^^^^^^^^
docs/cmds/string: Improve synopsis This both formats it as a code-block, and adds the synopsis of each subcommand to the corresponding section again so you don't need to scroll back-and-forth so much. [ci skip]
2019-03-30 03:05:42 +08:00
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
.. include:: string-length.rst
:start-after: BEGIN EXAMPLES
:end-before: END EXAMPLES
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
"lower" subcommand
Fix command section separator line lengths
2019-01-03 12:10:47 +08:00
------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-lower.rst
:start-after: BEGIN SYNOPSIS
:end-before: END SYNOPSIS
docs/cmds/string: Improve synopsis This both formats it as a code-block, and adds the synopsis of each subcommand to the corresponding section again so you don't need to scroll back-and-forth so much. [ci skip]
2019-03-30 03:05:42 +08:00
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
.. include:: string-lower.rst
:start-after: BEGIN DESCRIPTION
:end-before: END DESCRIPTION
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-lower.rst
:start-after: BEGIN EXAMPLES
:end-before: END EXAMPLES
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
"match" subcommand
------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-match.rst
:start-after: BEGIN SYNOPSIS
:end-before: END SYNOPSIS
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-match.rst
:start-after: BEGIN DESCRIPTION
:end-before: END DESCRIPTION
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-match.rst
:start-after: BEGIN EXAMPLES
:end-before: END EXAMPLES
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format
2018-12-19 10:44:30 +08:00
"repeat" subcommand
Fix command section separator line lengths
2019-01-03 12:10:47 +08:00
-------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-repeat.rst
:start-after: BEGIN SYNOPSIS
:end-before: END SYNOPSIS
docs: whitespace cleanup in source Fixes some lint warnings.
2019-09-17 16:50:52 +08:00
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
.. include:: string-repeat.rst
:start-after: BEGIN DESCRIPTION
:end-before: END DESCRIPTION
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
Examples
^^^^^^^^
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-repeat.rst
:start-after: BEGIN EXAMPLES
:end-before: END EXAMPLES
docs/cmds/string: Improve synopsis This both formats it as a code-block, and adds the synopsis of each subcommand to the corresponding section again so you don't need to scroll back-and-forth so much. [ci skip]
2019-03-30 03:05:42 +08:00
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
"replace" subcommand
--------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-replace.rst
:start-after: BEGIN SYNOPSIS
:end-before: END SYNOPSIS
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-replace.rst
:start-after: BEGIN DESCRIPTION
:end-before: END DESCRIPTION
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-replace.rst
:start-after: BEGIN EXAMPLES
:end-before: END EXAMPLES
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Document string split superpowers more [ci skip]
2019-05-20 01:40:48 +08:00
.. _cmd-string-split:
.. _cmd-string-split0:
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
"split" and "split0" subcommands
--------------------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-split.rst
:start-after: BEGIN SYNOPSIS
:end-before: END SYNOPSIS
docs: whitespace cleanup in source Fixes some lint warnings.
2019-09-17 16:50:52 +08:00
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
.. include:: string-split.rst
:start-after: BEGIN DESCRIPTION
:end-before: END DESCRIPTION
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
Examples
^^^^^^^^
.. include:: string-split.rst
:start-after: BEGIN EXAMPLES
:end-before: END EXAMPLES
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format
2018-12-19 10:44:30 +08:00
"sub" subcommand
Fix command section separator line lengths
2019-01-03 12:10:47 +08:00
----------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-sub.rst
:start-after: BEGIN SYNOPSIS
:end-before: END SYNOPSIS
.. include:: string-sub.rst
:start-after: BEGIN DESCRIPTION
:end-before: END DESCRIPTION
Examples
^^^^^^^^
docs: whitespace cleanup in source Fixes some lint warnings.
2019-09-17 16:50:52 +08:00
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
.. include:: string-sub.rst
:start-after: BEGIN EXAMPLES
:end-before: END EXAMPLES
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format
2018-12-19 10:44:30 +08:00
"trim" subcommand
Fix command section separator line lengths
2019-01-03 12:10:47 +08:00
-----------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-trim.rst
:start-after: BEGIN SYNOPSIS
:end-before: END SYNOPSIS
.. include:: string-trim.rst
:start-after: BEGIN DESCRIPTION
:end-before: END DESCRIPTION
Examples
^^^^^^^^
docs: whitespace cleanup in source Fixes some lint warnings.
2019-09-17 16:50:52 +08:00
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
.. include:: string-trim.rst
:start-after: BEGIN EXAMPLES
:end-before: END EXAMPLES
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format
2018-12-19 10:44:30 +08:00
"upper" subcommand
Fix command section separator line lengths
2019-01-03 12:10:47 +08:00
------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
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
.. include:: string-upper.rst
:start-after: BEGIN SYNOPSIS
:end-before: END SYNOPSIS
docs/cmds/string: Improve synopsis This both formats it as a code-block, and adds the synopsis of each subcommand to the corresponding section again so you don't need to scroll back-and-forth so much. [ci skip]
2019-03-30 03:05:42 +08:00
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
.. include:: string-upper.rst
:start-after: BEGIN DESCRIPTION
:end-before: END DESCRIPTION
.. include:: string-upper.rst
:start-after: BEGIN EXAMPLES
:end-before: END EXAMPLES
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format
2018-12-19 10:44:30 +08:00
Regular Expressions
Fix command section separator line lengths
2019-01-03 12:10:47 +08:00
-------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility
2018-12-20 04:02:45 +08:00
Both the ``match`` and ``replace`` subcommand support regular expressions when used with the ``-r`` or ``--regex`` option. The dialect is that of PCRE2.
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility
2018-12-20 04:02:45 +08:00
In general, special characters are special by default, so ``a+`` matches one or more "a"s, while ``a\+`` matches an "a" and then a "+". ``(a+)`` matches one or more "a"s in a capturing group (``(?:XXXX)`` denotes a non-capturing group). For the replacement parameter of ``replace``, ``$n`` refers to the n-th group of the match. In the match parameter, ``\n`` (e.g. ``\1``) refers back to groups.
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Some features include repetitions:
docs/cmds/string: Fix lists sphinx _really_ likes its empty lines before lists! [ci skip]
2019-03-30 03:12:28 +08:00
Switch backticks to double backticks for rst compatibility
2018-12-20 04:02:45 +08:00
- ``*`` refers to 0 or more repetitions of the previous expression
- ``+`` 1 or more
- ``?`` 0 or 1.
- ``{n}`` to exactly n (where n is a number)
- ``{n,m}`` at least n, no more than m.
- ``{n,}`` n or more
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Character classes, some of the more important:
docs/cmds/string: Fix lists sphinx _really_ likes its empty lines before lists! [ci skip]
2019-03-30 03:12:28 +08:00
Switch backticks to double backticks for rst compatibility
2018-12-20 04:02:45 +08:00
- ``.`` any character except newline
- ``\d`` a decimal digit and ``\D``, not a decimal digit
- ``\s`` whitespace and ``\S``, not whitespace
- ``\w`` a "word" character and ``\W``, a "non-word" character
- ``[...]`` (where "..." is some characters) is a character set
- ``[^...]`` is the inverse of the given character set
- ``[x-y]`` is the range of characters from x-y
- ``[[:xxx:]]`` is a named character set
- ``[[:^xxx:]]`` is the inverse of a named character set
- ``[[:alnum:]]`` : "alphanumeric"
- ``[[:alpha:]]`` : "alphabetic"
- ``[[:ascii:]]`` : "0-127"
- ``[[:blank:]]`` : "space or tab"
- ``[[:cntrl:]]`` : "control character"
- ``[[:digit:]]`` : "decimal digit"
- ``[[:graph:]]`` : "printing, excluding space"
- ``[[:lower:]]`` : "lower case letter"
- ``[[:print:]]`` : "printing, including space"
- ``[[:punct:]]`` : "printing, excluding alphanumeric"
- ``[[:space:]]`` : "white space"
- ``[[:upper:]]`` : "upper case letter"
- ``[[:word:]]`` : "same as \w"
- ``[[:xdigit:]]`` : "hexadecimal digit"
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
Groups:
docs/cmds/string: Fix lists sphinx _really_ likes its empty lines before lists! [ci skip]
2019-03-30 03:12:28 +08:00
Switch backticks to double backticks for rst compatibility
2018-12-20 04:02:45 +08:00
- ``(...)`` is a capturing group
- ``(?:...)`` is a non-capturing group
- ``\n`` is a backreference (where n is the number of the group, starting with 1)
- ``$n`` is a reference from the replacement expression to a group in the match expression.
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
And some other things:
docs/cmds/string: Fix lists sphinx _really_ likes its empty lines before lists! [ci skip]
2019-03-30 03:12:28 +08:00
Switch backticks to double backticks for rst compatibility
2018-12-20 04:02:45 +08:00
- ``\b`` denotes a word boundary, ``\B`` is not a word boundary.
- ``^`` is the start of the string or line, ``$`` the end.
- ``|`` is "alternation", i.e. the "or".
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-17 05:08:41 +08:00
docs/string: Add paragraph on comparison with unix tools [ci skip]
2019-04-02 18:46:23 +08:00
Comparison to other tools
-------------------------
Most operations ``string`` supports can also be done by external tools. Some of these include ``grep``, ``sed`` and ``cut``.
If you are familiar with these, it is useful to know how ``string`` differs from them.
In contrast to these classics, ``string`` reads input either from stdin or as arguments. ``string`` also does not deal with files, so it requires redirections to be used with them.
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
In contrast to ``grep``, ``string``\ s `match` defaults to glob-mode, while `replace` defaults to literal matching. If set to regex-mode, they use PCRE regular expressions, which is comparable to ``grep``\ s `-P` option. `match` defaults to printing just the match, which is like ``grep`` with `-o` (use `--entire` to enable grep-like behavior).
docs/string: Add paragraph on comparison with unix tools [ci skip]
2019-04-02 18:46:23 +08:00
Like ``sed``\ s `s/` command, ``string replace`` still prints strings that don't match. ``sed``\ s `-n` in combination with a `/p` modifier or command is like ``string replace -f``.
docs: Fix typo Also removes a warning. [ci skip]
2019-04-09 19:47:54 +08:00
``string split somedelimiter`` is a replacement for ``tr somedelimiter \\n``.
Reference in New Issue Copy Permalink