Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-11-14 00:47:30 +00:00
Code Issues Projects Releases Packages Wiki Activity
fish-shell/doc_src/cmds/string.rst

379 lines
11 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 09:05:09 +00:00
.. _cmd-string:
Switch command docs from \section to reStructuredText
2018-12-17 01:39:33 +00:00
string - manipulate strings
Fix command section separator line lengths
2019-01-03 04:10:47 +00:00
===========================
Switch command docs from \section to reStructuredText
2018-12-17 01:39:33 +00:00
Migrate the 'synopsis' sections to .rst format
2018-12-18 01:58:24 +00:00
Synopsis
--------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00:00
docs synopsis: add HTML highlighing and automate manpage markup Recent synopsis changes move from literal code blocks to [RST line blocks]. This does not translate well to HTML: it's not rendered in monospace, so aligment is lost. Additionally, we don't get syntax highlighting in HTML, which adds differences to our code samples which are highlighted. We hard-wrap synopsis lines (like code blocks). To align continuation lines in manpages we need [backslashes in weird places]. Combined with the **, *, and `` markup, it's a bit hard to get the alignment right. Fix these by moving synopsis sources back to code blocks and compute HTML syntax highlighting and manpage markup with a custom Sphinx extension. The new Pygments lexer can tokenize a synopsis and assign the various highlighting roles, which closely matches fish's syntax highlighing: - command/keyword (dark blue) - parameter (light blue) - operator like and/or/not/&&/|| (cyan) - grammar metacharacter (black) For manpage output, we don't project the fish syntax highlighting but follow the markup convention in GNU's man(1): bold text type exactly as shown. italic text replace with appropriate argument. To make it easy to separate these two automatically, formalize that (italic) placeholders must be uppercase; while all lowercase text is interpreted literally (so rendered bold). This makes manpages more consistent, see string-join(1) and and(1). Implementation notes: Since we want manpage formatting but Sphinx's Pygments highlighing plugin does not support manpage output, add our custom "synopsis" directive. This directive parses differently when manpage output is specified. This means that the HTML and manpage build processes must not share a cache, because the parsed doctrees are cached. Work around this by using separate cache locations for build targets "sphinx-docs" (which creates HTML) and "sphinx-manpages". A better solution would be to only override Sphinx's ManualPageBuilder but that would take a bit more code (ideally we could override ManualPageWriter but Sphinx 4.3.2 doesn't really support that). --- Alternative solution: stick with line blocks but use roles like :command: or :option: (or custom ones). While this would make it possible to produce HTML that is consistent with code blocks (by adding a bit of CSS), the source would look uglier and is harder to maintain. (Let's say we want to add custom formatting to the [|] metacharacters in HTML. This is much easier with the proposed patch.) --- [RST line blocks]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks [backslashes in weird places]: https://github.com/fish-shell/fish-shell/pull/8626#discussion_r782837750
2022-01-09 14:09:46 +00:00
.. synopsis::
Fix more lost string documentation - Errors from 14d60ccb328fbff47408e914eb8cb27e887669b8 - See: #8928
2022-05-03 10:30:59 +00:00
string collect [-a | --allow-empty] [-N | --no-trim-newlines] [STRING ...]
docs synopsis: add HTML highlighing and automate manpage markup Recent synopsis changes move from literal code blocks to [RST line blocks]. This does not translate well to HTML: it's not rendered in monospace, so aligment is lost. Additionally, we don't get syntax highlighting in HTML, which adds differences to our code samples which are highlighted. We hard-wrap synopsis lines (like code blocks). To align continuation lines in manpages we need [backslashes in weird places]. Combined with the **, *, and `` markup, it's a bit hard to get the alignment right. Fix these by moving synopsis sources back to code blocks and compute HTML syntax highlighting and manpage markup with a custom Sphinx extension. The new Pygments lexer can tokenize a synopsis and assign the various highlighting roles, which closely matches fish's syntax highlighing: - command/keyword (dark blue) - parameter (light blue) - operator like and/or/not/&&/|| (cyan) - grammar metacharacter (black) For manpage output, we don't project the fish syntax highlighting but follow the markup convention in GNU's man(1): bold text type exactly as shown. italic text replace with appropriate argument. To make it easy to separate these two automatically, formalize that (italic) placeholders must be uppercase; while all lowercase text is interpreted literally (so rendered bold). This makes manpages more consistent, see string-join(1) and and(1). Implementation notes: Since we want manpage formatting but Sphinx's Pygments highlighing plugin does not support manpage output, add our custom "synopsis" directive. This directive parses differently when manpage output is specified. This means that the HTML and manpage build processes must not share a cache, because the parsed doctrees are cached. Work around this by using separate cache locations for build targets "sphinx-docs" (which creates HTML) and "sphinx-manpages". A better solution would be to only override Sphinx's ManualPageBuilder but that would take a bit more code (ideally we could override ManualPageWriter but Sphinx 4.3.2 doesn't really support that). --- Alternative solution: stick with line blocks but use roles like :command: or :option: (or custom ones). While this would make it possible to produce HTML that is consistent with code blocks (by adding a bit of CSS), the source would look uglier and is harder to maintain. (Let's say we want to add custom formatting to the [|] metacharacters in HTML. This is much easier with the proposed patch.) --- [RST line blocks]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks [backslashes in weird places]: https://github.com/fish-shell/fish-shell/pull/8626#discussion_r782837750
2022-01-09 14:09:46 +00:00
string escape [-n | --no-quoted] [--style=] [STRING ...]
New -n flag for string join. (#8774) * New -n flag for string join command. This is an argument that excludes empty result items. Fixes #8351 * New documentation for string-join. The new argument --no-empty was added at string-join manpage. * New completions for the new -n flag for string join. * Remove the documentation of the new -n flag of string join0 The reason to remove this new argument in the join0 is that this flag basically doesn't make any difference in the join0. * Refactor the validation for the string join. The string join command was using the length of the argument, this commit changes the validation to use the empty function. * Revert #4b56ab452 The reason for the revert is thath the build broke on the ubuntu in the Github actions. * Revert #e72e239a1 The reason the compilation on GitHub broke is that the test was weird, it didn't even run it, Common CI systems are typically very very resource-constrained. * Resolve conflicts in the string-join.rst. * Resolve conflicts in the "string-join.rst". commit #1242d0fd7 not fixed all conflicts.
2022-03-13 10:47:33 +00:00
string join [-q | --quiet] [-n | --no-empty] SEP [STRING ...]
docs synopsis: add HTML highlighing and automate manpage markup Recent synopsis changes move from literal code blocks to [RST line blocks]. This does not translate well to HTML: it's not rendered in monospace, so aligment is lost. Additionally, we don't get syntax highlighting in HTML, which adds differences to our code samples which are highlighted. We hard-wrap synopsis lines (like code blocks). To align continuation lines in manpages we need [backslashes in weird places]. Combined with the **, *, and `` markup, it's a bit hard to get the alignment right. Fix these by moving synopsis sources back to code blocks and compute HTML syntax highlighting and manpage markup with a custom Sphinx extension. The new Pygments lexer can tokenize a synopsis and assign the various highlighting roles, which closely matches fish's syntax highlighing: - command/keyword (dark blue) - parameter (light blue) - operator like and/or/not/&&/|| (cyan) - grammar metacharacter (black) For manpage output, we don't project the fish syntax highlighting but follow the markup convention in GNU's man(1): bold text type exactly as shown. italic text replace with appropriate argument. To make it easy to separate these two automatically, formalize that (italic) placeholders must be uppercase; while all lowercase text is interpreted literally (so rendered bold). This makes manpages more consistent, see string-join(1) and and(1). Implementation notes: Since we want manpage formatting but Sphinx's Pygments highlighing plugin does not support manpage output, add our custom "synopsis" directive. This directive parses differently when manpage output is specified. This means that the HTML and manpage build processes must not share a cache, because the parsed doctrees are cached. Work around this by using separate cache locations for build targets "sphinx-docs" (which creates HTML) and "sphinx-manpages". A better solution would be to only override Sphinx's ManualPageBuilder but that would take a bit more code (ideally we could override ManualPageWriter but Sphinx 4.3.2 doesn't really support that). --- Alternative solution: stick with line blocks but use roles like :command: or :option: (or custom ones). While this would make it possible to produce HTML that is consistent with code blocks (by adding a bit of CSS), the source would look uglier and is harder to maintain. (Let's say we want to add custom formatting to the [|] metacharacters in HTML. This is much easier with the proposed patch.) --- [RST line blocks]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks [backslashes in weird places]: https://github.com/fish-shell/fish-shell/pull/8626#discussion_r782837750
2022-01-09 14:09:46 +00:00
string join0 [-q | --quiet] [STRING ...]
string length [-q | --quiet] [STRING ...]
string lower [-q | --quiet] [STRING ...]
string match [-a | --all] [-e | --entire] [-i | --ignore-case]
Fix more lost string documentation - Errors from 14d60ccb328fbff47408e914eb8cb27e887669b8 - See: #8928
2022-05-03 10:30:59 +00:00
[-g | --groups-only] [-r | --regex] [-n | --index]
[-q | --quiet] [-v | --invert]
docs synopsis: add HTML highlighing and automate manpage markup Recent synopsis changes move from literal code blocks to [RST line blocks]. This does not translate well to HTML: it's not rendered in monospace, so aligment is lost. Additionally, we don't get syntax highlighting in HTML, which adds differences to our code samples which are highlighted. We hard-wrap synopsis lines (like code blocks). To align continuation lines in manpages we need [backslashes in weird places]. Combined with the **, *, and `` markup, it's a bit hard to get the alignment right. Fix these by moving synopsis sources back to code blocks and compute HTML syntax highlighting and manpage markup with a custom Sphinx extension. The new Pygments lexer can tokenize a synopsis and assign the various highlighting roles, which closely matches fish's syntax highlighing: - command/keyword (dark blue) - parameter (light blue) - operator like and/or/not/&&/|| (cyan) - grammar metacharacter (black) For manpage output, we don't project the fish syntax highlighting but follow the markup convention in GNU's man(1): bold text type exactly as shown. italic text replace with appropriate argument. To make it easy to separate these two automatically, formalize that (italic) placeholders must be uppercase; while all lowercase text is interpreted literally (so rendered bold). This makes manpages more consistent, see string-join(1) and and(1). Implementation notes: Since we want manpage formatting but Sphinx's Pygments highlighing plugin does not support manpage output, add our custom "synopsis" directive. This directive parses differently when manpage output is specified. This means that the HTML and manpage build processes must not share a cache, because the parsed doctrees are cached. Work around this by using separate cache locations for build targets "sphinx-docs" (which creates HTML) and "sphinx-manpages". A better solution would be to only override Sphinx's ManualPageBuilder but that would take a bit more code (ideally we could override ManualPageWriter but Sphinx 4.3.2 doesn't really support that). --- Alternative solution: stick with line blocks but use roles like :command: or :option: (or custom ones). While this would make it possible to produce HTML that is consistent with code blocks (by adding a bit of CSS), the source would look uglier and is harder to maintain. (Let's say we want to add custom formatting to the [|] metacharacters in HTML. This is much easier with the proposed patch.) --- [RST line blocks]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks [backslashes in weird places]: https://github.com/fish-shell/fish-shell/pull/8626#discussion_r782837750
2022-01-09 14:09:46 +00:00
PATTERN [STRING ...]
Docs: be more consistent about argument formatting
2022-05-03 23:39:04 +00:00
string pad [-r | --right] [(-c | --char) CHAR] [(-w | --width) INTEGER]
docs synopsis: add HTML highlighing and automate manpage markup Recent synopsis changes move from literal code blocks to [RST line blocks]. This does not translate well to HTML: it's not rendered in monospace, so aligment is lost. Additionally, we don't get syntax highlighting in HTML, which adds differences to our code samples which are highlighted. We hard-wrap synopsis lines (like code blocks). To align continuation lines in manpages we need [backslashes in weird places]. Combined with the **, *, and `` markup, it's a bit hard to get the alignment right. Fix these by moving synopsis sources back to code blocks and compute HTML syntax highlighting and manpage markup with a custom Sphinx extension. The new Pygments lexer can tokenize a synopsis and assign the various highlighting roles, which closely matches fish's syntax highlighing: - command/keyword (dark blue) - parameter (light blue) - operator like and/or/not/&&/|| (cyan) - grammar metacharacter (black) For manpage output, we don't project the fish syntax highlighting but follow the markup convention in GNU's man(1): bold text type exactly as shown. italic text replace with appropriate argument. To make it easy to separate these two automatically, formalize that (italic) placeholders must be uppercase; while all lowercase text is interpreted literally (so rendered bold). This makes manpages more consistent, see string-join(1) and and(1). Implementation notes: Since we want manpage formatting but Sphinx's Pygments highlighing plugin does not support manpage output, add our custom "synopsis" directive. This directive parses differently when manpage output is specified. This means that the HTML and manpage build processes must not share a cache, because the parsed doctrees are cached. Work around this by using separate cache locations for build targets "sphinx-docs" (which creates HTML) and "sphinx-manpages". A better solution would be to only override Sphinx's ManualPageBuilder but that would take a bit more code (ideally we could override ManualPageWriter but Sphinx 4.3.2 doesn't really support that). --- Alternative solution: stick with line blocks but use roles like :command: or :option: (or custom ones). While this would make it possible to produce HTML that is consistent with code blocks (by adding a bit of CSS), the source would look uglier and is harder to maintain. (Let's say we want to add custom formatting to the [|] metacharacters in HTML. This is much easier with the proposed patch.) --- [RST line blocks]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks [backslashes in weird places]: https://github.com/fish-shell/fish-shell/pull/8626#discussion_r782837750
2022-01-09 14:09:46 +00:00
[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 REPLACE [STRING ...]
docs: Minor formatting fixes
2022-10-06 19:30:01 +00:00
string shorten [(-c | --char) CHARS] [(-m | --max) INTEGER]
[-N | --no-newline] [-l | --left] [-q | --quiet] [STRING ...]
Docs: be more consistent about argument formatting
2022-05-03 23:39:04 +00:00
string split [(-f | --fields) FIELDS] [(-m | --max) MAX] [-n | --no-empty]
Document `string split --fields` - The parameter-listing appears to have been lost as a part of https://github.com/fish-shell/fish-shell/commit/14d60ccb328fbff47408e914eb8cb27e887669b8
2022-05-02 15:19:37 +00:00
[-q | --quiet] [-r | --right] SEP [STRING ...]
Docs: be more consistent about argument formatting
2022-05-03 23:39:04 +00:00
string split0 [(-f | --fields) FIELDS] [(-m | --max) MAX] [-n | --no-empty]
Document `string split --fields` - The parameter-listing appears to have been lost as a part of https://github.com/fish-shell/fish-shell/commit/14d60ccb328fbff47408e914eb8cb27e887669b8
2022-05-02 15:19:37 +00:00
[-q | --quiet] [-r | --right] [STRING ...]
Fix more lost string documentation - Errors from 14d60ccb328fbff47408e914eb8cb27e887669b8 - See: #8928
2022-05-03 10:30:59 +00:00
string sub [(-s | --start) START] [(-e | --end) END] [(-l | --length) LENGTH]
docs synopsis: add HTML highlighing and automate manpage markup Recent synopsis changes move from literal code blocks to [RST line blocks]. This does not translate well to HTML: it's not rendered in monospace, so aligment is lost. Additionally, we don't get syntax highlighting in HTML, which adds differences to our code samples which are highlighted. We hard-wrap synopsis lines (like code blocks). To align continuation lines in manpages we need [backslashes in weird places]. Combined with the **, *, and `` markup, it's a bit hard to get the alignment right. Fix these by moving synopsis sources back to code blocks and compute HTML syntax highlighting and manpage markup with a custom Sphinx extension. The new Pygments lexer can tokenize a synopsis and assign the various highlighting roles, which closely matches fish's syntax highlighing: - command/keyword (dark blue) - parameter (light blue) - operator like and/or/not/&&/|| (cyan) - grammar metacharacter (black) For manpage output, we don't project the fish syntax highlighting but follow the markup convention in GNU's man(1): bold text type exactly as shown. italic text replace with appropriate argument. To make it easy to separate these two automatically, formalize that (italic) placeholders must be uppercase; while all lowercase text is interpreted literally (so rendered bold). This makes manpages more consistent, see string-join(1) and and(1). Implementation notes: Since we want manpage formatting but Sphinx's Pygments highlighing plugin does not support manpage output, add our custom "synopsis" directive. This directive parses differently when manpage output is specified. This means that the HTML and manpage build processes must not share a cache, because the parsed doctrees are cached. Work around this by using separate cache locations for build targets "sphinx-docs" (which creates HTML) and "sphinx-manpages". A better solution would be to only override Sphinx's ManualPageBuilder but that would take a bit more code (ideally we could override ManualPageWriter but Sphinx 4.3.2 doesn't really support that). --- Alternative solution: stick with line blocks but use roles like :command: or :option: (or custom ones). While this would make it possible to produce HTML that is consistent with code blocks (by adding a bit of CSS), the source would look uglier and is harder to maintain. (Let's say we want to add custom formatting to the [|] metacharacters in HTML. This is much easier with the proposed patch.) --- [RST line blocks]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks [backslashes in weird places]: https://github.com/fish-shell/fish-shell/pull/8626#discussion_r782837750
2022-01-09 14:09:46 +00:00
[-q | --quiet] [STRING ...]
string trim [-l | --left] [-r | --right] [(-c | --chars) CHARS]
[-q | --quiet] [STRING ...]
string unescape [--style=] [STRING ...]
string upper [-q | --quiet] [STRING ...]
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00:00
Convert \\subsection sections into rst format
2018-12-19 02:44:30 +00:00
Description
Fix command section separator line lengths
2019-01-03 04:10:47 +00:00
-----------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility
2018-12-19 20:02:45 +00:00
``string`` performs operations on strings.
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00:00
string docs: format options and arguments in line with other pages There are a number of items which don't fit cleanly into the styles used in the synopses, and have been left alone.
2022-03-12 14:22:00 +00: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.
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility
2018-12-19 20:02:45 +00: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-16 21:08:41 +00:00
string docs: format options and arguments in line with other pages There are a number of items which don't fit cleanly into the styles used in the synopses, and have been left alone.
2022-03-12 14:22:00 +00:00
Most subcommands accept a **-q** or **--quiet** switch, which suppresses the usual output but exits with the documented status. In this case these commands will quit early, without reading all of the available input.
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00:00
The following subcommands are available.
docs: Add string-collect link
2020-06-07 18:00:01 +00:00
.. _cmd-string-collect:
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 05:30:31 +00: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 09:56:24 +00: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 05:30:31 +00: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 09:56:24 +00: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 05:30:31 +00: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 09:56:24 +00: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 05:30:31 +00: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 09:56:24 +00: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 05:30:31 +00: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-29 19:05:42 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00:00
Examples
^^^^^^^^
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00: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-29 19:05:42 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00: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-29 19:05:42 +00: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 09:56:24 +00: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-16 21:08:41 +00:00
Convert \\subsection sections into rst format
2018-12-19 02:44:30 +00:00
"length" subcommand
Fix command section separator line lengths
2019-01-03 04:10:47 +00:00
-------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00: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-29 19:05:42 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00:00
"lower" subcommand
Fix command section separator line lengths
2019-01-03 04:10:47 +00:00
------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00: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 09:56:24 +00: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-29 19:05:42 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00:00
"match" subcommand
------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00: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-16 21:08:41 +00:00
docs/string: Separate "pad" and "shorten" This isn't the same as "join"/"join0", where one is just a special case of the other. These are two different, if basically opposite commands. But more importantly this was a huge mess and the formatting was broken.
2023-04-20 20:17:08 +00:00
"pad" subcommand
----------------
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-27 17:12:42 +00:00
.. include:: string-pad.rst
:start-after: BEGIN SYNOPSIS
:end-before: END SYNOPSIS
.. include:: string-pad.rst
:start-after: BEGIN DESCRIPTION
:end-before: END DESCRIPTION
docs/string: Separate "pad" and "shorten" This isn't the same as "join"/"join0", where one is just a special case of the other. These are two different, if basically opposite commands. But more importantly this was a huge mess and the formatting was broken.
2023-04-20 20:17:08 +00:00
Examples
^^^^^^^^
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-27 17:12:42 +00:00
.. include:: string-pad.rst
:start-after: BEGIN EXAMPLES
:end-before: END EXAMPLES
docs/string: Separate "pad" and "shorten" This isn't the same as "join"/"join0", where one is just a special case of the other. These are two different, if basically opposite commands. But more importantly this was a huge mess and the formatting was broken.
2023-04-20 20:17:08 +00:00
See also
^^^^^^^^
.. include:: string-pad.rst
:start-after: BEGIN SEEALSO
"shorten" subcommand
--------------------
Add string shorten This is essentially the inverse of `string pad`. Where that adds characters to get up to the specified width, this adds an ellipsis to a string if it goes over a specific maximum width. The char can be given, but defaults to our ellipsis string. ("…" if the locale can handle it and "..." otherwise) If the ellipsis string is empty, it just truncates. For arguments given via argv, it goes line-by-line, because otherwise length makes no sense. If "--no-newline" is given, it adds an ellipsis instead and removes all subsequent lines. Like pad and `length --visible`, it goes by visible width, skipping recognized escape sequences, as those have no influence on width. The default target width is the shortest of the given widths that is non-zero. If the ellipsis is already wider than the target width, we truncate instead. This is safer overall, so we don't e.g. move into a new line. This is especially important given our default ellipsis might be width 3.
2022-08-16 15:57:19 +00:00
.. include:: string-shorten.rst
:start-after: BEGIN SYNOPSIS
:end-before: END SYNOPSIS
.. include:: string-shorten.rst
:start-after: BEGIN DESCRIPTION
:end-before: END DESCRIPTION
docs/string: Separate "pad" and "shorten" This isn't the same as "join"/"join0", where one is just a special case of the other. These are two different, if basically opposite commands. But more importantly this was a huge mess and the formatting was broken.
2023-04-20 20:17:08 +00:00
Examples
^^^^^^^^
Add string shorten This is essentially the inverse of `string pad`. Where that adds characters to get up to the specified width, this adds an ellipsis to a string if it goes over a specific maximum width. The char can be given, but defaults to our ellipsis string. ("…" if the locale can handle it and "..." otherwise) If the ellipsis string is empty, it just truncates. For arguments given via argv, it goes line-by-line, because otherwise length makes no sense. If "--no-newline" is given, it adds an ellipsis instead and removes all subsequent lines. Like pad and `length --visible`, it goes by visible width, skipping recognized escape sequences, as those have no influence on width. The default target width is the shortest of the given widths that is non-zero. If the ellipsis is already wider than the target width, we truncate instead. This is safer overall, so we don't e.g. move into a new line. This is especially important given our default ellipsis might be width 3.
2022-08-16 15:57:19 +00:00
.. include:: string-shorten.rst
:start-after: BEGIN EXAMPLES
:end-before: END EXAMPLES
docs/string: Separate "pad" and "shorten" This isn't the same as "join"/"join0", where one is just a special case of the other. These are two different, if basically opposite commands. But more importantly this was a huge mess and the formatting was broken.
2023-04-20 20:17:08 +00:00
See also
^^^^^^^^
.. include:: string-shorten.rst
:start-after: BEGIN SEEALSO
Convert \\subsection sections into rst format
2018-12-19 02:44:30 +00:00
"repeat" subcommand
Fix command section separator line lengths
2019-01-03 04:10:47 +00:00
-------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00: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 09:56:24 +00: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 08:50:52 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00:00
Examples
^^^^^^^^
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00: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 09:56:24 +00: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-29 19:05:42 +00: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 09:56:24 +00:00
"replace" subcommand
--------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00: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-16 21:08:41 +00:00
Document string split superpowers more [ci skip]
2019-05-19 17:40:48 +00: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 09:56:24 +00:00
"split" and "split0" subcommands
--------------------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00: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 09:56:24 +00: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 08:50:52 +00: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 09:56:24 +00: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-16 21:08:41 +00: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 09:56:24 +00: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-16 21:08:41 +00:00
Convert \\subsection sections into rst format
2018-12-19 02:44:30 +00:00
"sub" subcommand
Fix command section separator line lengths
2019-01-03 04:10:47 +00:00
----------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00: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 09:56:24 +00: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 08:50:52 +00: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 09:56:24 +00: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-16 21:08:41 +00:00
Convert \\subsection sections into rst format
2018-12-19 02:44:30 +00:00
"trim" subcommand
Fix command section separator line lengths
2019-01-03 04:10:47 +00:00
-----------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00: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 09:56:24 +00: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 08:50:52 +00: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 09:56:24 +00: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-16 21:08:41 +00:00
Convert \\subsection sections into rst format
2018-12-19 02:44:30 +00:00
"upper" subcommand
Fix command section separator line lengths
2019-01-03 04:10:47 +00:00
------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00: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 09:56:24 +00: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-29 19:05:42 +00: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 09:56:24 +00: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-16 21:08:41 +00:00
Convert \\subsection sections into rst format
2018-12-19 02:44:30 +00:00
Regular Expressions
Fix command section separator line lengths
2019-01-03 04:10:47 +00:00
-------------------
Copy doc_src to sphinx_doc_src and add a TOC
2018-12-16 21:08:41 +00:00
string docs: format options and arguments in line with other pages There are a number of items which don't fit cleanly into the styles used in the synopses, and have been left alone.
2022-03-12 14:22:00 +00: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-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility
2018-12-19 20:02:45 +00: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-16 21:08:41 +00:00
Some features include repetitions:
docs/cmds/string: Fix lists sphinx _really_ likes its empty lines before lists! [ci skip]
2019-03-29 19:12:28 +00:00
Switch backticks to double backticks for rst compatibility
2018-12-19 20:02:45 +00: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-16 21:08:41 +00: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-29 19:12:28 +00:00
Switch backticks to double backticks for rst compatibility
2018-12-19 20:02:45 +00: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-16 21:08:41 +00:00
Groups:
docs/cmds/string: Fix lists sphinx _really_ likes its empty lines before lists! [ci skip]
2019-03-29 19:12:28 +00:00
Switch backticks to double backticks for rst compatibility
2018-12-19 20:02:45 +00: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-16 21:08:41 +00:00
And some other things:
docs/cmds/string: Fix lists sphinx _really_ likes its empty lines before lists! [ci skip]
2019-03-29 19:12:28 +00:00
Switch backticks to double backticks for rst compatibility
2018-12-19 20:02:45 +00: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-16 21:08:41 +00:00
docs/string: Add paragraph on comparison with unix tools [ci skip]
2019-04-02 10:46:23 +00: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.
string docs: format options and arguments in line with other pages There are a number of items which don't fit cleanly into the styles used in the synopses, and have been left alone.
2022-03-12 14:22:00 +00: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 10:46:23 +00:00
docs: use monospace for inline code snippets more consistently
2020-10-26 18:19:05 +00:00
Like ``sed``'s ``s/old/new/`` 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/string: Add paragraph on comparison with unix tools [ci skip]
2019-04-02 10:46:23 +00:00
docs: Use \ instead of \\ in examples (#7286) Instead of informing the bell character (hex 07), the example was using an escaped \ followed by x07. $ echo \\x07 \x07 $ echo \x07 $ echo \x07 | od -a 0000000 bel nl 0000002 $ * docs: Use \u instead of \\u Instead of informing the Unicode character 慡, this example was using an escaped \ followed by u6161. $ echo \\u6161 \u6161 $ echo \u6161 慡 Before: $ string escape --style=var 'a1 b2'\\u6161 | string unescape --style=var a1 b2\u6161 Now: $ string escape --style=var 'a1 b2'\u6161 | string unescape --style=var a1 b2慡
2020-08-26 16:29:03 +00:00
``string split somedelimiter`` is a replacement for ``tr somedelimiter \n``.
Reference in a new issue Copy permalink