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
History
Johannes Altmanninger 97db9d5c38 docs synopses: fix alignment of continuation lines 
This corrects what looks like wrong alignment of some synopsis lines.
(I think the alignment is not a bad idea but it makes us do more
manual work, maybe we can automate that in future.  We still need to
figure out how to translate it to HTML.)

"man -l build/user_doc/man/man1/history.1" before:

	string match [-a | --all] [-e | --entire] [-i | --ignore-case]
	            [-r | --regex] [-n | --index] [-q | --quiet] [-v | --invert]
	            PATTERN [STRING…]

and after:

	string match [-a | --all] [-e | --entire] [-i | --ignore-case]
	             [-r | --regex] [-n | --index] [-q | --quiet] [-v | --invert]
	             PATTERN [STRING…]

Also make the lines align the same way in the RST source by carefully
choosing the position of the backslash. I'm not sure why we used
two backslashes per line. Use only one; this gives us no choice
of where to put it so both source and man page output are aligned.
Change tabs to spaces to make the alignment in the source work.
2022-01-16 14:05:47 +01:00
..
_.rst slog through documentation 2021-12-09 03:34:28 -08:00
abbr.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
alias.rst slog through documentation 2021-12-09 03:34:28 -08:00
and.rst Harmonize some idiosyncrancies introduced 2021-12-17 15:20:46 -08:00
argparse.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
begin.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
bg.rst slog through documentation 2021-12-09 03:34:28 -08:00
bind.rst docs synopses: use parenthesis to indicate that short/long option pairs take same args 2022-01-16 14:05:47 +01:00
block.rst docs synopses: use ellipsis with singular words 2022-01-16 14:05:47 +01:00
break.rst Harmonize some idiosyncrancies introduced 2021-12-17 15:20:46 -08:00
breakpoint.rst Commit doc_src progress. 2021-12-17 13:59:39 -08:00
builtin.rst docs synopses: use ellipsis with singular words 2022-01-16 14:05:47 +01:00
case.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
cd.rst Harmonize some idiosyncrancies introduced 2021-12-17 15:20:46 -08:00
cdh.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
command.rst docs synopses: remove unconventional spaces inside [] and () 2022-01-16 14:05:47 +01:00
commandline.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
complete.rst complete.rst: clarify in synopsis that -c/-p take an argument 2022-01-16 14:05:47 +01:00
contains.rst fixup 2021-12-17 15:23:02 -08:00
continue.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
count.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
dirh.rst Commit doc_src progress. 2021-12-17 13:59:39 -08:00
dirs.rst Commit doc_src progress. 2021-12-17 13:59:39 -08:00
disown.rst docs synopses: remove unconventional spaces inside [] and () 2022-01-16 14:05:47 +01:00
echo.rst Commit doc_src progress. 2021-12-17 13:59:39 -08:00
else.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
emit.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
end.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
eval.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
exec.rst Commit doc_src progress. 2021-12-17 13:59:39 -08:00
exit.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
false.rst Long march towards more structured text 2021-11-12 04:22:35 -08:00
fg.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
fish.rst docs synopses: use ellipsis with singular words 2022-01-16 14:05:47 +01:00
fish_add_path.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
fish_breakpoint_prompt.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
fish_command_not_found.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
fish_config.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
fish_git_prompt.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
fish_greeting.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
fish_hg_prompt.rst math.rst: use 4 spaces instead of a tab for indentation 2022-01-16 14:05:47 +01:00
fish_indent.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
fish_is_root_user.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
fish_key_reader.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
fish_mode_prompt.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
fish_opt.rst docs synopses: remove unconventional spaces inside [] and () 2022-01-16 14:05:47 +01:00
fish_prompt.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -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 doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
fish_svn_prompt.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
fish_title.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
fish_update_completions.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
fish_vcs_prompt.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
for.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
funced.rst doc_src: Continue the slog through the letter F. 2021-12-17 15:16:47 -08:00
funcsave.rst funcsave: add documentation for feature added in 3a402b19b 2022-01-03 23:03:38 +08:00
function.rst function.rst: remove ellipsis since there is no repetition 2022-01-16 14:05:47 +01:00
functions.rst docs synopses: do not add markup to the ellipsis character 2022-01-16 14:05:47 +01:00
help.rst help: adjust synopsis. history manpage: indent long synopsis lines 2021-12-17 15:38:49 -08:00
history.rst docs synopses: fix alignment of continuation lines 2022-01-16 14:05:47 +01:00
if.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
isatty.rst Update synopsis of a few stragglers. 2021-12-24 16:15:40 -08:00
jobs.rst docs synopses: remove unconventional spaces inside [] and () 2022-01-16 14:05:47 +01:00
math.rst docs synopses: do not add markup to the ellipsis character 2022-01-16 14:05:47 +01:00
nextd.rst docs synopses: remove unconventional spaces inside [] and () 2022-01-16 14:05:47 +01:00
not.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
open.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
or.rst More synopsis work. 2021-12-21 17:24:47 -08:00
popd.rst More synopsis work. 2021-12-21 17:24:47 -08:00
prevd.rst docs synopses: remove unconventional spaces inside [] and () 2022-01-16 14:05:47 +01:00
printf.rst More synopsis work. 2021-12-21 17:24:47 -08:00
prompt_hostname.rst More synopsis work. 2021-12-21 17:24:47 -08:00
prompt_login.rst More synopsis work. 2021-12-21 17:24:47 -08:00
prompt_pwd.rst More synopsis work. 2021-12-21 17:24:47 -08:00
psub.rst psub.rst: add long option to synopsis 2022-01-16 14:05:47 +01:00
pushd.rst More synopsis work. 2021-12-21 17:24:47 -08:00
pwd.rst More synopsis work. 2021-12-21 17:24:47 -08:00
random.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
read.rst More synopsis work. 2021-12-21 17:24:47 -08:00
realpath.rst docs: Readd note about the command to realpath 2021-11-12 18:28:35 +01:00
return.rst Docs: Switch back to vanilla :ref: for commands that should be linked 2021-11-12 18:02:56 +01:00
set.rst docs synopses: remove unconventional spaces inside [] and () 2022-01-16 14:05:47 +01:00
set_color.rst Update synopsis of a few stragglers. 2021-12-24 16:15:40 -08:00
source.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
status.rst status.rst: fixup 2021-12-21 18:52:45 -08:00
string-collect.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
string-escape.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
string-join.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01: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 synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
string-lower.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
string-match.rst docs synopses: fix alignment of continuation lines 2022-01-16 14:05:47 +01:00
string-pad.rst docs synopses: fix alignment of continuation lines 2022-01-16 14:05:47 +01:00
string-repeat.rst docs synopses: fix alignment of continuation lines 2022-01-16 14:05:47 +01:00
string-replace.rst docs synopses: fix alignment of continuation lines 2022-01-16 14:05:47 +01:00
string-split.rst docs synopses: fix alignment of continuation lines 2022-01-16 14:05:47 +01: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 synopses: fix alignment of continuation lines 2022-01-16 14:05:47 +01:00
string-trim.rst docs synopses: fix alignment of continuation lines 2022-01-16 14:05:47 +01: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 synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
string.rst docs synopses: fix alignment of continuation lines 2022-01-16 14:05:47 +01:00
suspend.rst More synopsis work. 2021-12-21 17:24:47 -08:00
switch.rst docs synopses: add space before ellipsis 2022-01-16 14:05:47 +01:00
test.rst More synopsis work. 2021-12-21 17:24:47 -08:00
time.rst More synopsis work. 2021-12-21 17:24:47 -08:00
trap.rst More synopsis work. 2021-12-21 17:24:47 -08:00
true.rst More synopsis work. 2021-12-21 17:24:47 -08:00
type.rst More synopsis work. 2021-12-21 17:24:47 -08:00
ulimit.rst ulimit.rst: remove spurious backtick 2022-01-02 12:23:39 +01:00
umask.rst More synopsis work. 2021-12-21 17:24:47 -08:00
vared.rst More synopsis work. 2021-12-21 17:24:47 -08:00
wait.rst More synopsis work. 2021-12-21 17:24:47 -08:00
while.rst docs synopses: use ellipsis with singular words 2022-01-16 14:05:47 +01:00