Daniel Bengtsson
b8d0de1b88
Typo.
...
Replace the tabulation by space.
2020-06-20 18:17:11 +02:00
Fabian Homborg
c5f06cde82
docs/string: Fix match examples
...
One was just cosmetic (too many \\), one was actually broken because
it had duplicated `{{`, possibly resulting from the doxygen conversion?
[ci skip]
2020-06-19 21:23:51 +02:00
Fabian Homborg
547f649797
docs: Slight reword of argparse's optional argument section
...
[ci skip]
2020-06-17 15:36:50 +02:00
David Adam
7838b47e6b
docs: formatting fixes in initialization section
2020-06-15 21:46:20 +08:00
David Adam
5dd7944d0b
faq: add SSH/SFTP/SCP interactive guard suggestions
...
See #2160 , #2405 , #3742 , #4432 & #4745 , among others.
2020-06-15 21:46:20 +08:00
Fabian Homborg
d9b0a3b272
Revert "docs/tutorial: Fix duplicate sentence"
...
This reverts commit 9d1129f14c
.
Probably a bad rebase, at the time this appeared on master the sentence was already removed.
2020-06-11 18:40:35 +02:00
Fabian Homborg
5cae62a266
docs: Document comments
...
Turns out they weren't.
Fixes #7106 .
2020-06-10 17:39:04 +02:00
Fabian Homborg
e094e770e8
docs: Some more work on fish_for_bash_users
...
[ci skip]
2020-06-08 20:44:56 +02:00
Fabian Homborg
7791457bbb
docs: Add string-collect link
2020-06-07 20:04:31 +02:00
Fabian Homborg
a6e4e082b7
docs: Include "fish for bash users" document
...
Not 100% done, but it should be okay as an overview.
Fixes #2382 .
2020-06-07 20:04:05 +02:00
Mikel Ward
96425d2231
Fix string collect examples
...
collect -N leaves the trailing newline, not the other way around.
2020-06-07 19:33:27 +02:00
Awal Garg
cb5eb72c6b
Skip pre/post exec events for empty commands ( #4829 )
2020-06-06 16:31:33 -07:00
David Adam
c5e535e794
docs: link and explicit instructions on creating a blank fish_mode_prompt
...
Work on #5783 .
[ci skip]
2020-06-06 22:52:13 +08:00
Fabian Homborg
ab2db135ba
docs: Add first draft of fish-vs-bash
...
That name's probably not the correct one.
The idea is to have a quick primer document for people coming from bash.
2020-06-05 19:19:23 +02:00
Fabian Homborg
801ab95fd0
docs: Explain $XDG_CONFIG_HOME
2020-06-05 19:18:09 +02:00
Fabian Homborg
77fc83c293
docs: Reword history substitution
...
That prepend-sudo note was a bit awkward. I'm still not super happy
with it, but it should be better.
Also remove the "simple but effective" comment.
2020-06-05 19:17:19 +02:00
Fabian Homborg
e646285bcb
Let __fish_prepend_sudo
use the last commandline if there is no current one ( #7079 )
...
* docs/faq: Mention prepend_sudo
[ci skip]
* __fish_prepend_sudo: Use $history[1] if commandline is empty
Currently, if you press alt+s with an empty commandline, it inserts
"sudo", which seems fairly useless.
Now, it inserts "sudo " followed by the last history entry, which
makes it a replacement for `sudo !!`.
* docs
2020-06-04 18:25:02 +02:00
Fabian Homborg
44184f68e4
Add status dirname
and status basename
convenience commands
...
There's a terrible number of fishscripts that start with
set path (dirname (status filename))
And that's really just a bit boring.
So let's let it be
set path (status dirname)
2020-06-04 18:23:32 +02:00
Fabian Homborg
5efe1a09ce
docs/argparse: Add note on optional arguments
...
Yeah I had to answer this one again.
[ci skip]
2020-06-04 17:28:02 +02:00
Fabian Homborg
99c2c599f3
docs: Mention that reloading can take a bit
...
Fixes #7064 .
2020-05-30 10:07:21 +02:00
Fabian Homborg
4f6851b19f
Add CHANGELOG to the docs
...
This uses a cheesy trampoline file, but it seems to work alright.
2020-05-30 10:07:21 +02:00
Fabian Homborg
4785440f65
Add an "_" builtin to call into gettext ( #7036 )
...
* Add an "_" builtin to call into gettext
We already have gettext in C++ (if available), so it seems weird to
fork off a command to start it from script.
This is only for fish's own translations. There's no way to call into
other catalogs, it just translates all arguments separately.
This is faster by a factor of ~1000, which allows us to call
translations much more, especially from scripts.
E.g. making fish_greeting global by default would hurt cost-wise,
given that my fish starts up in 8ms and just calling the current `_`
function takes 2ms, and that would have two calls.
Incidentally, this also makes us rely on a weirdly defined function
less, so it:
Fixes #6804 .
* docs: Add `_` docs
Let's see if that filename works out.
* Reword _ docs
2020-05-29 20:53:44 +02:00
Fabian Homborg
1e17a68133
docs/tutorial: Recommend fish_add_path over $fish_user_paths
2020-05-29 20:51:09 +02:00
Fabian Homborg
9354dd6971
Add fish_add_path, a simple way to add to $PATH
...
This is a function you can either execute once, interactively, or
stick in config.fish, and it will do the right thing.
Some options are included to choose some slightly different behavior,
like setting $PATH directly instead of $fish_user_paths, or moving
already existing components to the front/back instead of ignoring
them, or appending new components instead of prepending them.
The defaults were chosen because they are the most safe, and
especially because they allow it to be idempotent - running it again
and again and again won't change anything, it won't even run the
actual `set` because it skips that if all components are already in.
Fixes #6960 .
2020-05-29 20:51:05 +02:00
Jason
90b9dd3627
Reword sentence
2020-05-28 17:39:37 +02:00
Donovan
bc2eb383d4
Funcsave with --directory option ( #7041 )
...
* funcsave: add option --directory
Signed-off-by: Donovan Jean <commit@dkrm.dev>
* funcsave: fix synopsis
Signed-off-by: Donovan Jean <commit@dkrm.dev>
* funcsave: fix completion
Signed-off-by: Donovan Jean <commit@dkrm.dev>
* funcsave: fix error message
Signed-off-by: Donovan Jean <commit@dkrm.dev>
* funcsave: fix parameter expansion
Signed-off-by: Donovan Jean <commit@dkrm.dev>
2020-05-27 20:13:44 +02:00
Fabian Homborg
2f7ac8767e
Fix wordo
...
English! It's a thing!
[ci skip]
2020-05-27 18:12:56 +02:00
Fabian Homborg
1dfc701ec6
docs: Slight rewording on the unmatched globs faq
...
[ci skip]
2020-05-27 18:11:59 +02:00
Fabian Homborg
ec267a1d54
Document how fish does not pass along unmatched globs
...
See #7043 .
[ci skip]
2020-05-27 18:09:53 +02:00
Fabian Homborg
1879b4e697
docs: Some rewording in Special Variables
2020-05-24 20:23:31 +02:00
Fabian Homborg
420f68b1e3
docs: Some rewording in the variable scope section
2020-05-24 20:23:31 +02:00
Fabian Homborg
82d720ca2a
docs: Rewrite variables section
2020-05-24 20:23:31 +02:00
Fabian Homborg
87660d3d87
docs: Rewrite identifiers and move it down
...
Weird to mention it before even explaining variables.
2020-05-24 20:23:31 +02:00
David Adam
b6eb95abad
docs: minor spelling/style corrections
...
[ci skip]
2020-05-24 16:14:23 +08:00
Fabian Homborg
07e6ccd444
docs: Rewrite index range section
2020-05-24 09:33:24 +02:00
Fabian Homborg
2522249145
docs: Rewrite cartesian product section
2020-05-24 09:33:20 +02:00
Fabian Homborg
c2a8557c38
docs: Reword brace expansion
2020-05-23 18:31:33 +02:00
Fabian Homborg
255ab2f140
docs: Reword command substitution
2020-05-23 18:31:33 +02:00
Fabian Homborg
85c970187b
docs: Reword parameter expansion/globbing
...
Why it said "Parameter expansion ("globbing")" no idea.
2020-05-23 18:31:07 +02:00
Fabian Homborg
1eb2bd13ca
docs: Reword autoloading
...
This is hard to understand, so it needs polish polish polish.
2020-05-23 18:24:43 +02:00
Fabian Homborg
25d51bf093
docs: Reword redirection/piping
...
Less emphasis on the file descriptors
2020-05-23 18:24:43 +02:00
Fabian Homborg
840663bc0b
docs: Reword quotes section
2020-05-23 18:24:37 +02:00
Fabian Homborg
814efb5569
docs: More on variable scoping
...
Specifically more examples, and more *real* examples. Some of it is
copied straight from my config.fish.
2020-05-23 16:42:54 +02:00
Fabian Homborg
9d1129f14c
docs/tutorial: Fix duplicate sentence
...
Fixes #7024 .
2020-05-20 19:20:12 +02:00
Charles Gould
b673f32b93
Add fish debugging examples
2020-05-19 21:07:33 +02:00
Fabian Homborg
e3c4692031
docs/bind: Overhaul
2020-05-18 20:48:36 +02:00
Fabian Homborg
ec759fb45e
printf: Overhaul docs
2020-05-18 20:48:36 +02:00
Fabian Homborg
56f24f08d7
printf: Don't print an error if not given an argument
2020-05-18 20:48:36 +02:00
Johannes Altmanninger
27f9920c7f
docs: sort some electric variables
2020-05-16 12:18:21 +02:00
Johannes Altmanninger
e03c375ee3
Purge remnants of process expansion, document {fish,last}_pid
2020-05-16 11:58:12 +02:00
Johannes Altmanninger
67531acc25
fish --help: remove outdated information about exit status
2020-05-16 10:33:13 +02:00
Moritz Reiter
f318da436e
Remove text duplicate in tutorial
2020-05-15 20:09:07 +08:00
LawAbidingCactus
f71737e58a
Add $fish_force_vi_cursor variable to allow cursor setting on unsupported terminals
2020-05-14 22:25:20 +02:00
Fabian Homborg
389c5e7ece
Update set --show
docs
...
See #6944
2020-04-26 17:55:17 +02:00
Fabian Homborg
1f459622cb
docs: Add fish_posterror
...
Also remove the "event will be emitted even if the command is invalid"
because it's not the case anymore, AFAICT.
See #6880 .
2020-04-25 09:25:03 +02:00
Jason Nader
18efd7dd48
Fix string split docs
2020-04-21 18:36:56 +02:00
Jason Nader
ea65db9421
string split: update docs
2020-04-20 22:39:48 +02:00
Charles Gould
2421eb6180
docs: Add completions for fish_key_reader
2020-04-19 07:06:31 +02:00
Weisi Dai
6ab2d78936
Doc: Fix dead link to POSIX man page "test".
2020-04-19 04:25:04 +02:00
Delapouite
8d20748f4a
doc: add section about directory history / stack
...
This PR also adds "See Also" section in the related commands.
2020-04-18 10:40:48 +02:00
Charles Gould
d3e720a045
docs: Use underscore in argument placeholder
2020-04-17 22:29:12 +02:00
Charles Gould
44976a5d31
docs: Remove extra colon to fix formatting
2020-04-17 22:29:12 +02:00
Johannes Altmanninger
1634a3b15c
docs: don't quote code snippets
...
The added single quotes don't look great in HTML, and it's already clear
that the monospaced text is to be interpreted literally.
2020-04-13 22:56:22 +02:00
exploide
8025e80fdb
new function __fish_preview_current_file to open file at the cursor in pager
...
bound to Alt+O by shared key bindings
created with help from @krobelus
fixes #6838
2020-04-07 22:30:05 +02:00
Soumya
639ea3caa0
Update docs for fish_kill_signal
, use "job" rather than "command"
2020-04-04 19:23:44 +02:00
Johannes Altmanninger
89c4ff9eae
Fix some inconsistencies in docs
2020-04-04 19:19:50 +02:00
Jason Nader
7cb1d3a646
Add string split --fields
2020-04-04 15:30:08 +02:00
Fabian Homborg
5bc3ec846e
docs: Reword variable scope section
...
Should be a bit easier to read.
[ci skip]
2020-04-04 13:17:12 +02:00
Delapouite
6c3732b99f
doc: add kbd markup to Tab Completion section
2020-04-04 10:45:13 +02:00
Delapouite
b8281f1284
doc: homogenize commands titles
2020-04-04 10:44:53 +02:00
Soumya
61a9cdaa74
Add $fish_kill_signal
to track the signal that terminated a command.
...
Set to `0` if the command exited normally.
2020-04-02 09:32:32 +02:00
jneem
3cf1de1b7f
Suggest string split -n for separating on spaces.
...
At least on some versions/systems, pkg-config outputs a trailing
space. Since the usually-desired behavior isn't to have a blank argument,
recommend using `string split -n` instead of `string split`.
Fixes #6836 .
[ci skip]
2020-03-30 20:42:39 +02:00
fcd
3246f736b8
docs: Fix repeated word in argparse documentation
2020-03-25 18:23:19 +01:00
Johannes Altmanninger
1547a22659
docs: remove some spurious backslashes
2020-03-23 21:02:15 +01:00
George Christou
a3436110c1
Add string sub --end
( #6765 )
2020-03-22 15:53:09 +01:00
Fabian Homborg
b61913ee74
docs: Add FAQ about unicode issues
...
This is an actual Frequently Asked Question.
[ci skip]
2020-03-21 18:01:17 +01:00
Fabian Homborg
638a66c8ff
pwd: Add "--physical" and "--logical" long options
...
These were already mentioned in the completions, and we don't
typically add short-only options.
Fixes #6787 .
2020-03-21 16:21:15 +01:00
Fabian Homborg
fd45877848
docs: Link builtins
...
When we say "the XYZ command/builtin", we should typically include a
link. The exceptions are
- In the documentation for that command - no need to link to ulimit in
the ulimit page
- When we've already linked before - not every thing needs to be
clickable, or clicking it will cause the browser to mark fifty words
as visited. This is roughly what wikipedia does for crosslinks.
[ci skip]
2020-03-21 15:31:25 +01:00
Fabian Homborg
8ddd512fba
Refine when we expand abbreviations
...
- ctrl-space will insert a space without expanding abbrs
- ")" or alt-enter will expand abbrs
Fixes #6658
2020-03-21 13:55:15 +01:00
Delapouite
401e5d1f6b
doc: add links to 'source' command from 'eval' and 'functions'
2020-03-21 13:21:38 +01:00
Charles Gould
54da5b82ba
docs: Fix spacing on key combinations
2020-03-21 13:20:34 +01:00
Charles Gould
90b46c72c8
docs: Use arrow symbols consistently
2020-03-21 13:20:34 +01:00
Charles Gould
fb6257ebc3
docs: Capitalize all keystroke characters
2020-03-21 13:20:34 +01:00
Fabian Homborg
0bb923dcec
docs: Make a fish-completions manpage
...
[ci skip]
2020-03-21 12:07:30 +01:00
Fabian Homborg
469e81e01d
docs: Remove weird ", Left"
...
This was meant as an alternative key name or something, but it's just
rendered. It seems clear what the glyph refers to and we explain it
where we explain the left/right bindings anyway.
[ci skip]
2020-03-19 19:48:24 +01:00
Fabian Homborg
ffd930e35b
docs: Format keychords as two :kbd: entries
...
Looks better in the html - see #6752 .
Also this converts the "ctrl-something" instances I could find to
proper markup.
[ci skip]
2020-03-19 19:43:49 +01:00
Delapouite
0152ba87c8
doc: make <kbd> style more prominent
2020-03-19 18:22:40 +01:00
Fabian Homborg
06b317c07f
Document funced/funcsave harder
...
[ci skip]
2020-03-19 18:02:16 +01:00
Fabian Homborg
65d277a581
docs: Move left/right arrow to shared bindings
...
This is a shared binding, so documenting it in emacs was wrong.
2020-03-15 13:24:45 +01:00
Fabian Homborg
463b9b99c6
Move ctrl-left/right forward-word to shared bindings
...
These also work in vim.
Fixes #6755 .
2020-03-15 13:24:45 +01:00
Delapouite
71243ffbdc
chore: bump copyright year 2019 → 2020
2020-03-14 14:03:09 -07:00
Delapouite
84c95324e1
doc: add links to count and contains commands in list section
2020-03-14 12:57:51 +01:00
Delapouite
8320467bb0
doc: add links between the string-split and read commands
2020-03-10 18:25:40 +01:00
Delapouite
a9eeca0d14
doc: add interlinks between break
and continue
commands
2020-03-09 19:24:38 +01:00
ridiculousfish
2e4cb15880
Add self-insert-notfirst readline command
...
This adds a new readline command self-insert-notfirst, which is
analogous to self-insert, except that it does nothing if the cursor
is at the beginning. This will serve as a higher-performance implementation
for stripping leading spaces on paste.
2020-03-07 13:31:55 -08:00
ridiculousfish
73a2097f63
Place bind.rst readline function docs in more alphabetical order
2020-03-07 13:31:55 -08:00
Johannes Altmanninger
0bb3efb1ad
Docs: add missing backticks
2020-03-07 18:33:39 +01:00
Johannes Altmanninger
da7b762f4a
Make default hg prompt leaner
...
The default hg prompt is slow on large repositories (hg status takes
2-3 seconds on mozilla-central) which is unacceptable as a default.
Mimick our git prompt: by default, only show the current branch.
If the new variable $fish_prompt_hg_show_informative_status is set,
then use the old behavior.
[ci skip]
2020-03-07 13:02:58 +01:00
Delapouite
5e3328ef1f
doc(end): mention the 'function' command and add links to all block starters
2020-03-06 22:14:53 +01:00
Fabian Homborg
17f989edf4
docs: Move completion tutorial out into its own document
...
This is useful, but it's a rather large thing that's uninteresting to
many users. So we put it into its own (top-level, for now) document.
2020-03-06 22:14:30 +01:00