Johannes Altmanninger
5e67a299ae
string-match.rst: fix wrong RST directive
...
This would show up in the rendered version.
2022-01-02 12:23:39 +01:00
Johannes Altmanninger
89b38e87bd
ulimit.rst: remove spurious backtick
2022-01-02 12:23:39 +01:00
Johannes Altmanninger
b5a95317f0
index.rst: don't mention current page under "Other help pages"
...
This is the list of pages at the end of the introduction; no need to
link to the introduction, we're already there.
2022-01-02 12:23:39 +01:00
Johannes Altmanninger
41080c4f41
math.rst: fix typo
2022-01-02 10:14:46 +01:00
Aaron Gyes
4efb1b1644
math.rst: use definition lists.
...
Also, follow the one-line per sentence rule as that has semantic
meaning for man/groff.
2021-12-24 16:39:47 -08:00
Aaron Gyes
a16fd0baa4
Update synopsis of a few stragglers.
2021-12-24 16:15:40 -08:00
Aaron Gyes
6e426cefbd
HTML docs theme: increase line spacing for synopsis section
2021-12-24 16:02:52 -08:00
Aaron Gyes
45b302839b
status.rst: fixup
2021-12-21 18:52:45 -08:00
Aaron Gyes
14d60ccb32
More synopsis work.
...
A great leap forward
2021-12-21 17:24:47 -08:00
Aaron Gyes
461facb42e
History: adjust description entries
2021-12-17 15:44:05 -08:00
Aaron Gyes
5ae7bc1443
help: adjust synopsis. history manpage: indent long synopsis lines
2021-12-17 15:38:49 -08:00
Aaron Gyes
50d65ace34
fixup
2021-12-17 15:23:02 -08:00
Aaron Gyes
4c6da2091d
Harmonize some idiosyncrancies introduced
...
For now, we are going with ``command`` for builtins and fish scripts,
and **keyword** for parser keywords like if or and.
2021-12-17 15:20:46 -08:00
Aaron Gyes
af61ea1325
doc_src: Continue the slog through the letter F.
...
We are using only :: in a synopsis for fishscript examples given
of the command being documented.
2021-12-17 15:16:47 -08:00
Aaron Gyes
5e880bb1c3
Commit doc_src progress.
...
This is continuing the work I've been doing to remove the ::
formatting for the synopsis sections of our manual pages.
2021-12-17 13:59:39 -08:00
Johannes Altmanninger
b98f71c16f
fish_config.rst: make the synopsis imply that "browse" is the default
2021-12-13 20:41:45 +01:00
Aaron Gyes
196b42e4eb
pygments lexer: use the token type intended for CLI output
...
and squash an unused import
2021-12-12 12:00:23 -08:00
Aaron Gyes
57119fb84d
conf.py: two unused imports, an unused local variable.
2021-12-12 10:45:50 -08:00
Aaron Gyes
5e96f817a6
Update command.rst
2021-12-12 00:17:16 -08:00
Andrey Mishchenko
45dbfda5cc
Add documentation for nextd-or-forward-word and prevd-or-backward-word readline functions
2021-12-11 10:19:18 +01:00
Andrey Mishchenko
f88bb35204
Fix delete-or-exit doc wording for local consistency
2021-12-11 10:19:18 +01:00
Andrey Mishchenko
bb1955ccf9
Remove delete-or-exit function, which has a C++ implementation
2021-12-11 10:19:18 +01:00
Andrey Mishchenko
fb73a4b2e2
Implement nextd-or-forward-word and prevd-or-backward-word in C++
2021-12-11 10:19:18 +01:00
Aaron Gyes
4746137a61
complete synopsis should just be a synopsis.
2021-12-11 00:41:09 -08:00
Aaron Gyes
124734cbaa
cd, cdh, command, commandline
...
Documentation.
2021-12-09 04:45:10 -08:00
Aaron Gyes
3b629d29aa
More documentation work
2021-12-09 03:53:13 -08:00
Aaron Gyes
79d1b3e085
slog through documentation
...
I did.. a and b today.
2021-12-09 03:34:28 -08:00
thibault
ceade1629d
builtin commandline: add option to determine if pager is fully disclosed
...
Use the remaining_to_disclose count to determine if all completions
are shown (allows consistent behavior between short and long completion
lists).
Closes #8485
2021-12-04 22:43:39 +01:00
Andrey Mishchenko
e79617f4b7
Add documentation for prompt_hostname
2021-12-04 10:37:49 +01:00
Andrey Mishchenko
bea86f04c7
Lowercase command description for consistency
2021-12-04 10:37:49 +01:00
Andrey Mishchenko
7f4b71e533
Delete trailing whitespace
2021-12-04 10:37:49 +01:00
Andrey Mishchenko
a3bf41223e
Reword documentation for filename
in man status
2021-12-04 10:32:15 +01:00
Fabian Homborg
be43e95ac9
docs: Expand path variable section
2021-12-01 19:03:40 +01:00
Fabian Homborg
47e45704b1
Allow set --query to check for pathvarness ( #8494 )
...
Currently,
set -q --unpath PATH
simply ignores the "--unpath" bit (and same for "--path").
This changes it, so just like exportedness you can check pathness.
2021-11-26 18:29:10 +01:00
Johannes Altmanninger
41be9fa9fd
Clarify that optional option arguments must have no separating space
...
Unless we use "complete --require-parameter", we must say "-w32",
not "-w 32", because the second "32" is a positional argument.
Notably, old options do not have this behavior, which is a bit weird,
see #8465
Taken from a discussion in #8459
2021-11-26 18:05:29 +01:00
Fabian Homborg
0d309b0d9e
docs/for-bash-users: Some cosmetic changes
2021-11-25 21:52:03 +01:00
Fabian Homborg
f2fd30df03
Make fish_key_reader's output simpler ( #8467 )
...
* fish_key_reader: Simplify default output
It now only prints the bind statement. Timing information and such is
relegated to a separate "verbose" mode.
* Adjust fish_key_reader docs
* Adjust tests
2021-11-22 17:22:22 +01:00
Johannes Altmanninger
4657ac0a7c
builtin complete: document that old-style option args can be given after =
...
Fixes #8457
2021-11-19 05:59:17 +01:00
Johannes Altmanninger
0d3d84a39c
Fix typos in documentation
2021-11-18 15:06:12 +01:00
Johannes Altmanninger
0acbbfe2ca
Document that a for-loop passes through any exit status
...
Unlike in other shells, for-loops do not set $status if
1. the loop count is zero, or if
2. the loop body consists of only commands like "set" that don't
set $status.
POSIX for-loops always set an exit status (they set 0 if no loop
iterations). Following that would be awkward because it would add a
lot of complexity in combination with the 2 special cases above.
Document that "for" behaves the same as "set": it will pass through
existing $status, and also the last child's $status.
See the discussion in #8409
2021-11-18 15:06:12 +01:00
Emily Seville
3c4969fc38
Change "while" command title to match "for" one
...
Closes #8409
2021-11-18 14:54:46 +01:00
ridiculousfish
88a89d0a52
docs: remove an errant space
2021-11-14 13:40:02 -08:00
Fabian Homborg
0f1bc5335a
docs: :envvar: the rest of the variables
...
Just a quick mechanical translation
2021-11-12 19:43:00 +01:00
Fabian Homborg
6b7fe49858
docs: Restrict underlining links to the body
...
Adding the underline in the list of sections makes them bleed
together, making it hard to discern where one ends and the other
begins.
In the body of the text we don't have that issue - multiple links are
rarely next to each other.
Fixes #8439
2021-11-12 18:47:56 +01:00
Fabian Homborg
57eccb7e1e
docs: Readd note about the command to realpath
2021-11-12 18:28:35 +01:00
Fabian Homborg
9a9cd5172d
docs: Don't make envvar names so large and in a different font
...
They're still bold, so still quite noticeable.
But not *IN YOUR FACE*.
2021-11-12 18:21:38 +01:00
Fabian Homborg
02553d8fa6
Docs: Don't use seealso
...
This is too eye catching and almost unreadable in the dark theme.
2021-11-12 18:13:36 +01:00
Fabian Homborg
edc09c8419
Docs: Switch back to vanilla :ref: for commands that should be linked
...
Unfortunately, currently :program: doesn't link to the program's page.
So we use the old-school :ref: again where we should link, i.e. for
everything that's not the program the current page is about.
Fixes #8438
2021-11-12 18:02:56 +01:00
Fabian Homborg
2e9e94f17e
Fix broken envvar link
...
Apparently you can't use spaces here.
2021-11-12 17:57:11 +01:00
Aaron Gyes
7a8fce6941
Thwart more dastardly schemes
...
thanks @faho
2021-11-12 04:52:38 -08:00