h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-06-05 08:11:15 -03:00
Code Issues Packages Projects Releases Wiki Activity

docs/string: Document shorten return value and --quiet

Browse Source
This commit is contained in:
Fabian Boehm
2022-10-04 18:47:37 +02:00
parent cb28b39b24
commit 8deab8d9ce
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc_src/cmds/string-shorten.rst
View File

@@ -8,7 +8,7 @@ Synopsis
.. synopsis::
string shorten [(-c | --char) CHARS] [(-m | --max) INTEGER] [(-N | --no-newline)] [(-l | --left)]
string shorten [(-c | --char) CHARS] [(-m | --max) INTEGER] [(-N | --no-newline)] [(-l | --left)] [(-q | --quiet)]
[STRING ...]
.. END SYNOPSIS
@@ -30,8 +30,12 @@ If **-c** or **--char** is given, add *CHAR* instead of an ellipsis. This can al
If **-l** or **--left** is given, remove text from the left on instead, so this prints the longest *suffix* of the string that fits. With **--no-newline**, this will take from the last line instead of the first.
If **-q** or **--quiet** is given, ``string shorten`` only runs for the return value - if anything would be shortened, it returns 0, else 1.
The default ellipsis is ``…``. If fish thinks your system is incapable because of your locale, it will use ``...`` instead.
The return value is 0 if any shortening occured, 1 otherwise.
.. END DESCRIPTION
Examples