github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-25 09:39:52 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

__fish_print_help: Make formatting more man-like

Browse Source 
1. Leave the indentation
2. Leave the "NAME" header - without the first line would be
unindented
3. Leave the "SYNOPSIS" header

We use $MANPAGER here, so it should be formatted like a manpage.

The alternative is to write special docs for this use-case, which
would be shorter and point towards the full man page.

Fixes #10625
This commit is contained in:
Fabian Boehm 2024-10-03 11:19:30 +02:00
parent 07bc54f406
commit 0fea1dae8c
1 changed files with 22 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
share/functions/__fish_print_help.fish
View File

@ -92,9 +92,7 @@ function __fish_print_help --description "Print help message for the specified f
# Remove man's bolding # Remove man's bolding
set -l name (string replace -ra '(.)'\b'.' '$1' -- $line) set -l name (string replace -ra '(.)'\b'.' '$1' -- $line)
# We start after we have the name # We start after we have the name
contains -- $name NAME; and set have_name 1; and continue contains -- $name NAME; and set have_name 1
# We ignore the SYNOPSIS header
contains -- $name SYNOPSIS; and continue
# Everything after COPYRIGHT is useless # Everything after COPYRIGHT is useless
contains -- $name COPYRIGHT; and break contains -- $name COPYRIGHT; and break
@ -123,28 +121,27 @@ function __fish_print_help --description "Print help message for the specified f
end end
end end
end end
end | string replace -ra '^ ' '' | end | begin
begin set -l pager (__fish_anypager --with-manpager)
set -l pager (__fish_anypager --with-manpager) and isatty stdout
and isatty stdout or set pager cat # cannot use a builtin here
or set pager cat # cannot use a builtin here
# similar to man, but add -F to quit paging when the help output is brief (#6227) # similar to man, but add -F to quit paging when the help output is brief (#6227)
# Also set -X for less < v530, see #8157. # Also set -X for less < v530, see #8157.
set -l lessopts isRF set -l lessopts isRF
if type -q less; and test (less --version | string match -r 'less (\d+)')[2] -lt 530 2>/dev/null if type -q less; and test (less --version | string match -r 'less (\d+)')[2] -lt 530 2>/dev/null
set lessopts "$lessopts"X set lessopts "$lessopts"X
end
not set -qx LESS
and set -xl LESS $lessopts
# less options:
# -i (--ignore-case) search case-insensitively, like man
# -s (--squeeze-blank-lines) not strictly necessary since we already do that above
# -R (--RAW-CONTROL-CHARS) to display colors and such
# -F (--quit-if-one-screen) to maintain the non-paging behavior for small outputs
# -X (--no-init) do not clear the screen, necessary for less < v530 or else short output is dropped
$pager
end end
not set -qx LESS
and set -xl LESS $lessopts
# less options:
# -i (--ignore-case) search case-insensitively, like man
# -s (--squeeze-blank-lines) not strictly necessary since we already do that above
# -R (--RAW-CONTROL-CHARS) to display colors and such
# -F (--quit-if-one-screen) to maintain the non-paging behavior for small outputs
# -X (--no-init) do not clear the screen, necessary for less < v530 or else short output is dropped
$pager
end
end end