fish-shell/doc_src/cmds
David Adam 3a23fdf359 docs: omnibus cleanup
Includes harmonizing the display of options and arguments, standardising
terminology, using the envvar directive more broadly, adding help options to all
commands that support them, simplifying some language, and tidying up multiple
formatting issues.

string documentation is not changed.
2022-03-12 00:21:13 +08:00
..
_.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
abbr.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
alias.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
and.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
argparse.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
begin.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
bg.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
bind.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
block.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
break.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
breakpoint.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
builtin.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
case.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
cd.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
cdh.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
command.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
commandline.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
complete.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
contains.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
continue.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
count.rst docs synopsis: make all placeholder arguments uppercase 2022-01-19 22:56:41 +08:00
dirh.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
dirs.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
disown.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
echo.rst docs: standardise on definition lists for options 2022-03-12 00:21:12 +08:00
else.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
emit.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
end.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
eval.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
exec.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
exit.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
false.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
fg.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
fish_add_path.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
fish_breakpoint_prompt.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
fish_command_not_found.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
fish_config.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
fish_git_prompt.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
fish_greeting.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
fish_hg_prompt.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
fish_indent.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
fish_is_root_user.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
fish_key_reader.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
fish_mode_prompt.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
fish_opt.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
fish_prompt.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
fish_right_prompt.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
fish_status_to_signal.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
fish_svn_prompt.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
fish_title.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
fish_update_completions.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
fish_vcs_prompt.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
fish.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
for.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
funced.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
funcsave.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
function.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
functions.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
help.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
history.rst docs: standardise on definition lists for options 2022-03-12 00:21:12 +08:00
if.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
isatty.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
jobs.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
math.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
nextd.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
not.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
open.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
or.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
popd.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
prevd.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
printf.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
prompt_hostname.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
prompt_login.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
prompt_pwd.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
psub.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
pushd.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
pwd.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
random.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
read.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
realpath.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
return.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
set_color.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
set.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
source.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
status.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
string-collect.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
string-escape.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
string-join.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
string-join0.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
string-length.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
string-lower.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
string-match.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
string-pad.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
string-repeat.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
string-replace.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
string-split.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
string-split0.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
string-sub.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
string-trim.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
string-unescape.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
string-upper.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
string.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
suspend.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
switch.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
test.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
time.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
trap.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
true.rst docs synopsis: add HTML highlighing and automate manpage markup 2022-01-19 22:56:41 +08:00
type.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
ulimit.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
umask.rst docs: standardise on definition lists for options 2022-03-12 00:21:12 +08:00
vared.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
wait.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00
while.rst docs: omnibus cleanup 2022-03-12 00:21:13 +08:00