Fabian Boehm
ebb8368464
docs/read: Some reorganization
...
This just had *all the options* in one gigantic list, and some very
stuffy wording - "prompt-str" sounded like it was discouraged for some reason?
2023-09-13 17:18:19 +02:00
Fabian Boehm
ad54f07328
docs/set: Correct some errors
2023-09-13 17:08:52 +02:00
Fabian Boehm
778f4e6732
docs: Improve quoting variables section
...
This now specifically explains quoting with `set`, and the contrast to bash.
2023-09-11 17:31:00 +02:00
Fabian Boehm
0e81d25b36
docs/commandline: Add more on the -oc/-ct thing
...
This was the remaining immediately actionable part of #7375 .
It's not definitely the last word, but a change here would require a
bigger plan.
Fixes #7375
2023-09-08 18:27:34 +02:00
Fabian Boehm
f9b51cf8a6
docs: Add key timeout
2023-08-30 23:13:09 +02:00
Fabian Boehm
55c425a0dd
fish_key_reader: Humanize key descriptions
...
This used to print all codepoints outside of the ASCII range (i.e.
above 0x80) in \uXXXX or \UYYYYYYYY notation.
That's quite awkward, considering that this is about keys that are
being pressed, and many keyboards have actual symbols for these on
them - I have an "ö" key, so I would like to use `bind ö` and not
`bind \u00F6`. So we go by iswgraph.
On a slightly different note, `\e` was written as `\c[ (or \e)`. I do
not believe anyone really uses `\c[` (the `[` would need to
be escaped!), and it's confusing and unnecessary to even mention that.
2023-08-26 10:43:42 +02:00
Fabian Boehm
d803ebbff9
docs: Some teensy bits on if/while
...
The ``test`` thing was just duplicated, and ``while`` linked to the
if-*command* page, where the syntax section is probably nicer
2023-08-26 09:32:05 +02:00
Fabian Boehm
b48fa1f1a0
Css refresh ( #9982 )
...
This cleans up the CSS, reduces the number of different colors and special settings we use.
It increases contrast so we now pass WCAG AAA (according to chromium), and switches to css variables for colors to make dark mode simpler to implement.
2023-08-25 17:13:35 +02:00
Fabian Boehm
e555f1b235
math: Fix docs on --scale
...
Fixes #9983
2023-08-25 16:17:59 +02:00
Fabian Boehm
b3ff982ad7
docs: Remove some jquery leftovers
2023-08-24 21:55:57 +02:00
Fabian Boehm
e3b1d327f1
docs: Remove reference to nonexistent style.css
2023-08-24 21:55:57 +02:00
Fabian Boehm
0aa21440d1
docs/path: Remove incorrect status comments
...
During development, for a while `path change-extension` would return 0
when it found an extension to change.
This was later changed to returning 0 if there are any path arguments.
Neither of which is *super* useful, I admit, but we've picked one and
the docs shouldn't contradict it.
2023-08-24 18:06:03 +02:00
Fabian Boehm
8abd0319fb
docs: Some slight rewordings
2023-08-23 23:08:56 +02:00
Kevin Cali
716001789b
docs: correct insert mode key
2023-08-21 17:50:45 +02:00
Fabian Boehm
79aeb1656c
docs/type: Correct "--no-functions"
...
This was accidentally changed in 3.2.0, when type was made a builtin.
Since it's been 4 releases and nobody has noticed, rather than
breaking things again let's leave it as it is, especially because the
option is named "--no-functions", not "--no-functions-or-builtins".
2023-08-21 17:44:21 +02:00
Fabian Boehm
53598d6a21
docs: More on if-conditions
2023-08-21 17:43:43 +02:00
Fabian Boehm
3711d0e06c
docs: Clarify a sentence in the test docs
2023-08-20 22:10:30 +02:00
Fabian Boehm
2f86b31bd3
docs: More on scopes
...
Let's start with an example to motivate the rest
2023-08-19 12:26:27 +02:00
Fabian Boehm
c07136e8d3
docs: Mention fish_cursor_replace
...
Fixes #9956
2023-08-15 19:11:03 +02:00
Pavel savchenko
c56f9e1981
Docs: correct small grammatical error in read.rst
2023-07-26 09:20:49 +02:00
Adam J. Stewart
72de1dc201
Docs: fix code block
2023-07-10 18:31:46 +02:00
Adam J. Stewart
e31c0ebb05
Fix grammar in completion docs
2023-07-09 14:11:01 +08:00
Fabian Boehm
1a52f79c24
docs/test: More on THE PROBLEM
2023-07-06 18:39:42 +02:00
Johannes Altmanninger
052823c120
history pager: delete selected history entry with Shift-Delete
...
After accidentally running a command that includes a pasted password, I want
to delete command from history. Today we need to recall or type (part of)
that command and type "history delete". Let's maybe add a shortcut to do
this from the history pager.
The current shortcut is Shift+Delete. I don't think that's very discoverable,
maybe we should use Delete instead (but only if the cursor is at the end of
the commandline, otherwise delete a char).
Closes #9454
2023-07-04 18:42:11 +02:00
Fabian Boehm
92551e1818
docs/abbr: Explain saving abbrs
2023-07-04 18:30:28 +02:00
Fabian Boehm
9bcb4dcf70
docs: Remove some needless margins for nested lists
...
This double-indented a nested list *and* added some gaps at the
bottom.
Other lists are unaffected
2023-06-28 16:32:55 +02:00
Fabian Boehm
22f2926185
docs/prompt: Fix nested list formatting
...
Sphinx needs three spaces here at least
2023-06-28 16:13:00 +02:00
David Adam
a75de42f4b
docs: use consistent spelling of color
...
i miss u
2023-06-21 21:13:03 +08:00
David Adam
229f19a6e9
docs: slight update to writing your own prompt doc
2023-06-21 21:12:12 +08:00
Fabian Boehm
c385027eca
docs: Add "Writing your own prompt" doc ( #9841 )
...
* docs: Add "Writing your own prompt" doc
* Remove a space from the "output"
* some teensy adjustments
* Address feedback
* envvar one more PWD
* More html warning
2023-06-20 19:43:09 +02:00
Fabian Boehm
f980125fb9
docs: More on profiling
2023-06-16 16:22:58 +02:00
Fabian Boehm
bc190ee818
docs: Turn off highlighting correctly in fish_config
2023-06-16 16:17:58 +02:00
Fabian Boehm
65769bf8c8
history: Allow deleting ranges
...
This allows giving a range like "5..7".
It works in combination with more (including overlapping) ranges or
single indices.
Fixes #9736
2023-06-10 15:35:40 +02:00
Fabian Boehm
ffd43c950a
docs/fish_config: Document theme files
2023-06-09 16:59:02 +02:00
Fabian Boehm
3cd527a62e
docs: Improve bg docs
...
Show an actual session here, to explain what you would actually do
with it.
2023-06-05 18:26:13 +02:00
Jo
272d123431
Fix a typo in language.rst
2023-06-02 13:13:49 +02:00
Fabian Boehm
946ecf235c
Restyle fishscript and python
2023-06-01 18:20:19 +02:00
Fabian Boehm
4ed74ed6c1
Improve CONTRIBUTING and add it to the docs
2023-06-01 18:09:02 +02:00
Fabian Boehm
bec8e8df05
docs/faq: Remove external tools
...
This was always extremely weasel-wordy and I have no idea which one
here is a good choice.
OMF is basically inactive at this point, so we might be doing people a
disservice by linking to it.
2023-05-25 17:46:25 +02:00
Fabian Boehm
2fa2b802c9
docs/interactive: Some small adjustments
...
Wording improvements and move private mode down, to the history section.
2023-05-25 17:46:25 +02:00
David Adam
4e13b1b5d5
Licensing: note MIT licensing status of Dracula theme
2023-05-25 21:30:30 +08:00
David Adam
2fbee01e17
Licensing: update the OpenBSD license details
...
The strlcpy/wcslcpy function is long gone.
2023-05-25 21:06:48 +08:00
David Adam
7c059b1112
Licensing: drop the LGPL reference and text
...
The wcstok function is long gone.
2023-05-25 20:50:36 +08:00
Fabian Boehm
8282ddcff2
faq: Update
...
Remove two that really aren't frequently asked and simplify the
history substitution thing, plus abbrs.
2023-05-23 16:57:53 +02:00
Fabian Boehm
80324c9d7f
docs: Fix link
2023-05-23 16:48:28 +02:00
Fabian Boehm
b1c06bbd2c
Put back extra licenses
...
This was erroneously removed in commit 03a6fb4a69
.
2023-05-23 16:47:32 +02:00
Fabian Boehm
b435fc4539
docs: Add something on variables-as-commands
...
Specifically point towards the necessary splitting (as always,
separate ahead of time) and the keyword thing.
Fixes #9797
2023-05-21 10:13:54 +02:00
Fabian Boehm
8a9f57112c
Fix typo
...
See https://github.com/fish-shell/fish-site/pull/112
2023-05-18 17:52:51 +02:00
Fabian Boehm
a8d7d9689d
docs: Another pass over bind
2023-05-18 10:11:17 +02:00
Fabian Boehm
0c900f74d0
docs: Explain bind --mode in custom bindings
2023-05-18 09:40:03 +02:00
Fabian Boehm
9c5571f14f
docs: Reword Combining lists section
...
This was quite hard to read, and the term "cartesian product" honestly
doesn't help
2023-05-12 18:53:53 +02:00
Fabian Boehm
a9708367db
doc: Link path in commands
2023-04-29 19:58:41 +02:00
Fabian Boehm
483478f4cf
docs: Improve prompt section and move title after it
2023-04-28 17:19:00 +02:00
Fabian Boehm
f826d59e5c
docs: Some on the tutorial
...
Try to clarify and simplify some wording and move the wildcards/redirection section behind variables because they are more important
2023-04-28 17:11:23 +02:00
Fabian Boehm
c55ec59e22
docs: A tad more on shared bindings
...
alt+enter, some consistency fixes
2023-04-26 21:22:34 +02:00
Fabian Boehm
93cd70edfe
docs: Remove weird "float: left"
...
This breaks the docs on extremely narrow screens and I cannot find a
reason for it.
Fixes https://github.com/fish-shell/fish-site/issues/110
2023-04-26 19:38:10 +02:00
Fabian Boehm
76b3965648
docs/string: Separate "pad" and "shorten"
...
This isn't the same as "join"/"join0", where one is just a special
case of the other.
These are two different, if basically opposite commands.
But more importantly this was a huge mess and the formatting was broken.
2023-04-20 22:17:08 +02:00
Paiusco
564039093b
Create fish_[default|vi]_key_bindings documentation
...
- Create docs file for both vi and default key bindings
- Remove variable mention on `interactive` and point to their own pages
2023-04-19 19:22:55 +02:00
Andy Hall
6ff971e4c2
Fix typo in set
docs
2023-04-08 18:56:46 -07:00
Eric N. Vander Weele
a6e16a11c2
docs/interactive: Document fish_color_history_current variable
...
All *.theme files set variables documented in the "Syntax highlighting
variables" section, and fish_color_history_current was missing.
2023-04-07 15:29:23 +02:00
Fabian Boehm
79f8364bc7
docs/completions: Add a teensy bit more
...
This should really be expanded instead of just pointing at the example
2023-04-04 18:07:25 +02:00
Fabian Boehm
a6560a4ea8
docs/fish_add_path: Also clarify the examples
2023-04-04 17:55:10 +02:00
Fabian Boehm
4a39772ed2
docs/fish_add_path: More on --path and appending
2023-04-04 17:50:01 +02:00
Fabian Boehm
d671710656
docs: Chapter on combining redirections
...
Fixes #5319
2023-04-01 16:03:24 +02:00
Fabian Boehm
e45bddcbb1
__fish_cursor_xterm: Ignore unknown cursor settings
...
This prevents leaking the escape sequence by printing nonsense, and it
also allows disabling cursor setting by just setting the variable to
e.g. empty.
And if we ever added any shapes, it would allow them to be used on new
fish and ignored on old
Fixes #9698
2023-03-31 20:07:54 +02:00
Fabian Boehm
ca02e88ef1
docs: Prevent overflow for narrow screens
...
Regression from #9003 , this is visible on mobile mainly.
Fixes #9690
2023-03-27 17:21:09 +02:00
Quinten Roets
f5506803d7
fish_vi_cursor: add new variable for external cursor mode ( #9565 )
...
* add new variable for external cursor mode
* fix backwards compatibility
* add documentation
* document change in changelog
2023-03-14 10:50:20 +01:00
Maurizio De Santis
68ba30d8c8
Fix typo
2023-03-03 19:25:17 +01:00
Fabian Boehm
f23103854c
docs/if: Link to other builtins
2023-02-28 20:49:11 +01:00
Fabian Boehm
aff84ef87d
docs/test: Simplify
...
A bit stuffy, also link to string/path
2023-02-28 20:47:50 +01:00
David Adam
e20d78431b
docs/index: update some formatting from #9482
2023-02-21 21:17:26 +08:00
Fabian Boehm
9c8b50cb8f
docs: Make some code lines shorter
...
For code, we need to limit the length because it can't be reflowed automatically
2023-02-15 18:50:28 +01:00
Fabian Boehm
811dbf0f9a
docs: More on dereferencing variables
...
Also that unclosed quote was driving me up the wall
2023-02-15 18:29:14 +01:00
esdmr
a607421912
functions --copy: store file and lineno ( #9542 )
...
Keeps the location of original function definition, and also stores
where it was copied. `functions` and `type` show both locations,
instead of none. It also retains the line numbers in the stack trace.
2023-02-13 09:59:28 -06:00
Fabian Boehm
d239e26f6b
docs: Add a missing newline
...
Sphinx is annoyingly specific here
2023-01-29 14:46:35 +01:00
Fabian Boehm
9043008933
abbr: Clarify universal variable message
...
And give explicit upgrade instructions.
2023-01-21 16:53:59 +01:00
Fabian Boehm
01d681067c
Bind ctrl-g to cancel as well
...
Classic emacs thing and the chord is so far unused.
Fixes #9484
2023-01-21 13:35:22 +01:00
mattmc3
cd17c1281d
Add argparse validation examples ( #9483 )
...
* Add argparse validation examples
* Remove invalid example
2023-01-19 11:06:51 +01:00
Eddie Lebow
1564c3e181
Minor formatting in Job Control documentation
2023-01-18 22:20:16 +01:00
Fabian Boehm
83d95cea35
docs: Reword quotes
...
Also explain that `$(foo)` is also done in double-quotes.
2023-01-18 16:39:37 +01:00
Fabian Boehm
d952ca1d1e
docs: Rename "index range expansion" to "slices"
...
It's a simpler term.
2023-01-17 17:08:10 +01:00
Fabian Boehm
dda0c8178d
docs: Remove "Variable scope for functions" chapter
...
This didn't need to be separately.
Also rename "More on universal variables" because it's the chapter on
universal variables.
2023-01-17 17:04:56 +01:00
Fabian Boehm
72a7111260
docs: Revise command substitution section
2023-01-16 18:36:59 +01:00
Fabian Boehm
97bef63af6
docs: Add more on conditionals
2023-01-16 17:53:08 +01:00
Fabian Boehm
78cc872904
Remove dangling footnote reference
2023-01-16 17:42:00 +01:00
Fabian Boehm
dc51a12b4f
docs: Mention env
...
Fixes #9482
2023-01-16 17:09:33 +01:00
Fabian Boehm
8203fdf631
docs/abbr: Just explain right out that uvars don't work anymore
2023-01-14 14:19:46 +01:00
Fabian Boehm
a322e3f180
docs: Fix typo
2023-01-13 22:53:02 +01:00
shenleban tongying
27952db9f7
docs: clearify global vs universal variable
2023-01-13 15:58:37 +01:00
Fabian Boehm
1d29ae7847
docs: Document more vi-mode bindings
...
These are quite incomplete and need more work.
2023-01-10 20:36:59 +01:00
Fabian Boehm
51bce422fd
docs: More about envvars
2023-01-09 20:33:37 +01:00
Fabian Boehm
16369a3abb
docs/interactive: More on custom bindings
2023-01-08 20:36:10 +01:00
Fabian Boehm
126647380a
docs: More on fish_greeting
2023-01-08 12:44:02 +01:00
Fabian Boehm
9e1c8a70bf
docs/string: Add a --
example to the match section
...
This keeps tripping people up. We can't mention it *everywhere*, but
lets see if it works just in "match", since that sees to be where
people hit it most.
2023-01-08 12:44:02 +01:00
David Adam
5db2d326f5
Bump copyright year
2023-01-06 18:26:21 +08:00
David Adam
c2ad9e44ec
docs: include fish_cursor_selection_mode in list of special variables
2023-01-01 22:44:09 +08:00
Fabian Boehm
c39c598996
docs/prompt_pwd: Fix envvar linking
2022-12-30 14:31:32 +01:00
Fabian Boehm
d14f39e583
docs/language: Some small bits
2022-12-30 13:52:55 +01:00
Fabian Boehm
3bacbeb2e1
docs/language: Improve argument parsing section
...
Better motivation and explanation.
2022-12-30 13:52:28 +01:00
Fabian Boehm
21c09c392b
docs/language: Improve an example
...
If a code sample uses prompt-style (with `>` lines) it needs to do
that consistently, or the rest is taken as output and not highlighted.
2022-12-28 20:42:33 +01:00