fish-shell/doc_src
Johannes Altmanninger 414d9a1eb1 Reference more non-fish shell builtins that have relevant differences
When writing scripts for other shells, it can be confusing and annoying
that our `man` function shadows other manual pages, for example `exec(1p)`
from [Linux man-pages]. I almost never want to see the fish variant for such
contended cases (which obviuosly don't include fish-specific commands like
`string`, only widely-known shell builtins).

For the contented cases like `exec`, the POSIX documentation is more
substantial and useful, since it describes a (sub)set of languages widely
used for scripting.

Because of this I think we should stop overriding the system's man pages.
Nowadays we offer `exec -h` as intuitive way to show the documentation for
the fish-specific command (note that `help` is not a good replacement because
it uses a web browser).

Looking through the contended commands, it seems like for most of them,
the fish version is not substantially different from the system version.
A notable exception is `read` but I don't think it's a very important one.

So I think we should can sacrifice a bit of the native fish-scripting
experience in exchange for playing nicer with other shells. I think the
latter is more important because scripting is not our focus, the way I see it.
So maybe put our manpath at the end.

In lieu of that, let's at least have `exec.rst` reference the system variant.

[Linux man-pages]: https://www.kernel.org/doc/man-pages/

Closes #10376
2024-04-20 13:34:08 +02:00
..
cmds Reference more non-fish shell builtins that have relevant differences 2024-04-20 13:34:08 +02:00
python_docs_theme doc_src: add print media support to the Sphinx theme 2024-01-12 17:52:43 +01:00
commands.rst docs: Add fish_should_add_to_history to commands list 2024-03-09 12:09:00 +01:00
completions.rst Fix grammar in completion docs 2023-07-09 14:11:01 +08:00
conf.py Enable Sphinx man_show_urls config 2024-04-20 13:34:08 +02:00
contributing.rst Improve CONTRIBUTING and add it to the docs 2023-06-01 18:09:02 +02:00
design.rst docs: Fix typos 2022-09-17 21:31:06 +08:00
faq.rst docs/faq: Remove external tools 2023-05-25 17:46:25 +02:00
fish_for_bash_users.rst docs: Explain globs more in fish-for-bash-users 2024-01-14 11:06:51 +01:00
fish_indent_lexer.py docs: restore default highlighting keywords and options in HTML 2022-01-16 14:07:19 +01:00
fish_synopsis.py Document the ! (not) and . (source) aliases more 2024-04-20 13:34:08 +02:00
index.rst docs: Some slight rewordings 2023-08-23 23:08:56 +02:00
interactive.rst Fix doc formatting 2024-04-02 17:39:39 +02:00
language.rst Document focus events 2024-04-06 18:14:17 +02:00
license.rst Import FindRust from Corrosion 2024-01-30 18:18:55 +08:00
prompt.rst docs/prompt: A few small fixes 2024-02-03 11:12:11 +01:00
relnotes.rst docs: call the CHANGELOG "release notes" 2021-02-25 22:46:24 +08:00
tutorial.rst docs: Some on the tutorial 2023-04-28 17:11:23 +02:00