github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-29 13:23:53 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
14,035 Commits 36 Branches 80 Tags 117 MiB
4fd8673772
Commit Graph

1298 Commits

Author SHA1 Message Date
Fabian Homborg
c9d2c99a98 Document that echo takes -- 
[ci skip]
 2020-08-21 21:32:56 +02:00
Fabian Homborg
923f6174ab Adjust the FAQ 2020-08-21 20:46:23 +02:00
jonbakke
02d0e50b61 Fix typo (verb clarification) in math.rst 
Was: "parameter expansion takes before expressions are evaluated."
Now: "parameter expansion happens before expressions are evaluated."

I suspect the original intent was to use "takes place," but I see "happens" as less idiomatic and therefore may benefit non-English-native users.
 2020-08-19 12:18:52 -07:00
Fabian Homborg
7254dfecb2 fish_indent: Print the failed files with --check 
Also return the number of failed files.

I decided to *just* print the filenames (newline-separated because
NULLs are annoying here) to make it easier to deal with.

See #7251.
 2020-08-10 22:03:51 +02:00
Fabian Homborg
2cdd6df257 fish_indent: Add a "--check" option to only test indentation 
Fixes #7251.
 2020-08-08 20:23:14 +02:00
Fabian Homborg
616cd38d8e docs: Don't use force-repaint 
It's not needed here and misleading. force-repaint isn't all that
useful and especially not something for a simple example.
 2020-08-07 21:06:16 +02:00
Carlos Alexandro Becker
ef8c397e7b docs: fix small formatting issues 2020-08-07 22:05:05 +08:00
Soumya
a2b2bcef6e Add a $status_generation variable that's incremented for each interactive command that produces a status. 
This can be used to determine whether the previous command produced a real status, or just carried over the status from the command before it. Backgrounded commands and variable assignments will not increment status_generation, all other commands will.
 2020-08-05 12:23:49 -07:00
Johannes Altmanninger
242b60fdef history.rst: clarify that "history search" is the default command 2020-08-04 21:44:26 +02:00
ridiculousfish
af48d09ca6 Improve syntax highlighting variable docs 
Make them a table instead of a list, which renders more nicely.
Shorten some of the descriptions.
 2020-08-03 13:21:37 -07:00
ridiculousfish
201ca02893 Remove an errant space from the docs 
Corrects fish_pager_color_secondary_prefix
 2020-08-03 12:19:57 -07:00
Charles Gould
2740473a65 docs: use parsed-literal to highlight interactive examples 
There are a few code blocks where the default highlighting does not
work and the documentation looks bad as a result. Usually this happens
when we are demonstrating an important interactive feature, such as
autosuggestions, syntax highlighting, or tab completion.

The pygments highlighter was not designed for code samples like these.
But it is important to show the behavior clearly in the docs. I am
attempting to make these weird examples look as much like the "normal"
code blocks as possible.

https://docutils.sourceforge.io/docs/ref/rst/directives.html#parsed-literal
 2020-08-02 14:22:29 -07:00
Olivier FAURE
e7f0b5801d Add forward-single-char input command 
This allows users to add custom keybindings to autocomplete only one
character at a time.

Resolves https://github.com/fish-shell/fish-shell/issues/4984
 2020-08-01 12:09:31 +02:00
Olivier FAURE
6778d04aa5 Add or keybind input function 2020-08-01 12:09:31 +02:00
ridiculousfish
1c2323e76f Use dashes instead of underscores pervasively in tutorial anchors 
This fixes some broken help completions.
 2020-07-31 12:10:16 -07:00
ridiculousfish
c940af1600 Correct tut_combiners anchor to tut-combiners 
dash is preferred in the tutorial. This fixes a broken link from the main
help page.
 2020-07-31 11:53:47 -07:00
Fabian Homborg
6356912702 docs: Expand background section 
It's not entirely clear why there's two sections right now, tbh.

[ci skip]
 2020-07-26 17:33:11 +02:00
Fabian Homborg
50a40175f1 docs: More on conditionals directly 
It's weird to force people to go to the separate pages, at least give
some simple examples here and link to the tutorial.

[ci skip]
 2020-07-26 17:33:11 +02:00
Fabian Homborg
cbd3adaa63 docs: Mention psub in the command substitution chapter 
[ci skip]
 2020-07-26 17:33:10 +02:00
Fabian Homborg
65f932edd2 docs: Also mention functions and type 
One of the nicest things about fish is how introspectable it is. We
should probably get people to just mess around and see what is
implemented how. This is a step in that direction.

[ci skip]
 2020-07-23 22:27:32 +02:00
Fabian Homborg
b485daa987 docs: Rewrite "Functions" section 
More examples, links to funced/funcsave, autoloading, wrappers

[ci skip]
 2020-07-23 17:49:43 +02:00
Charles Gould
f1302d336a docs: fix a few links 
- add missing links for some commands (control flow section)
- fix broken links that use the old syntax (#tut_ links)
- miscellaneous fixing of backticks/emphasis
 2020-07-18 20:46:50 +02:00
Fabian Homborg
82de51b9d3 Document adding bindings 
This was never made explicit.

[ci skip]
 2020-07-16 17:47:35 +02:00
Charles Gould
14ccac4887 docs: fix broken links in FAQ 2020-07-16 17:10:36 +02:00
Charles Gould
cea941a061 docs: fix literals in quotes section 2020-07-16 17:10:36 +02:00
Charles Gould
a83f580174 docs: shebang line cleanup 2020-07-16 17:10:36 +02:00
Charles Gould
49c575c3a5 docs: executing bash addition 2020-07-16 17:10:36 +02:00
Charles Gould
e5ac2fa879 docs: default shell formatting 2020-07-16 17:10:36 +02:00
blinry
b178f0921e Rephrase confusing display of key binding in documentation 
The binding Alt+., followed by a full stop, wasn't ideal. Rephrase the sentence to avoid that.
 2020-07-14 20:29:14 +02:00
blinry
641f1b00e4 Fix link target for "other features" 
Seems the link targets need a blank line above them, otherwise they will be rendered into the document.
 2020-07-14 20:28:45 +02:00
Fabian Homborg
8a6a265c3e docs: Add word splitting example 2020-07-09 18:35:41 +02:00
David Adam
4a35248465 docs/bind: make list formatting consistent 2020-07-06 20:50:19 +08:00
David Adam
1b121bd9a6 docs/jobs: add example output and remove spurious header 2020-07-06 20:48:13 +08:00
Gokul Soumya
6212a584a7 docs/jobs: Header is stripped in command substitution 2020-07-04 13:25:17 +02:00
Fabian Homborg
eb35975c0f Make cancel-commandline actual bind function 
This was always awkward as fish script, and had problems with
interrupting the autoloading.

Note that we still leave the old function intact to facilitate easier
upgrading for now.

Fixes #7145.
 2020-07-01 20:56:56 +02:00
Johannes Altmanninger
8b961a0ca8 Bind undo to Control-Z in addition to Control-/ 
See #7152
 2020-07-01 00:40:32 +02:00
Jeff Cook
b27440d536 Fix paste-o that duplicated documentation header. 2020-06-30 23:45:41 +02:00
Aadi Bajpai
7c5b19ec2c
Change natural number to non-negative integer (#7161) 
* natural → whole

* positive whole

* positive whole number → non-negative integer
 2020-06-29 20:26:53 +02:00
Daniel Bengtsson
e2f03fa8a7 Add a function to check if the user is root. 
Add a helper function to check if the user is root. This function can be
useful for the prompts for example. Modify the prompts made root checked
to use the function instead. Add also the support of Administrator like
a root user.

Fixes: #7031
 2020-06-26 21:25:13 +02:00
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
Delapouite
fba6da983b doc: add section about abbreviations in the index 
Fix: #3861
 2020-03-04 11:13:59 -08:00
Jason Nader
19e43a5df7 docs: remove undefined label 2020-03-04 10:39:55 -08:00
Delapouite
8530a4bd9e doc: add interlinks between echo ←→ printf commands 2020-03-03 20:01:48 +01:00
Fabian Homborg
bfc1de9ef4 argparse: Pass validation variables as exported 
This was written before local-exported variables did anything useful.

Passing these vars as local-exports removes the need to define the
validation function with `--no-scope-shadowing` which is quite the
hack.
 2020-03-01 19:28:51 +01:00
Fabian Homborg
0f34459fce Disable svn prompt by default 
This is apparently quite slow on large svn repos (like 40 seconds
slow), and we don't have a good thing to display other than the full
file information.

So we'll have to disable it for now.

Fixes #6681.

[ci skip]
 2020-03-01 17:04:02 +01:00
Delapouite
c0271a71d1 doc: fix 404 error for set_color command 2020-02-26 19:30:46 +01:00
Delapouite
a53405a7be doc(ulimit): add missing backquotes around -H, -S and -a options 2020-02-26 16:33:56 +01:00
Fabian Homborg
866df1ac86 docs: Rewrite variable expansion section 
Was a bit stuffy.

Hopefully now it should flow a bit better.

[ci skip]
 2020-02-24 19:36:37 +01:00
Delapouite
dce0fda2cc doc: add interlinks between true ←→ false and and ←→ or cmds 2020-02-23 23:41:16 -08:00
Delapouite
4fba8022a9 doc(abbr): adjust token names 2020-02-23 21:36:55 +08:00
Collin Styles
b7f9d9a229 Fix link in documentation 2020-02-23 09:37:40 +01:00
Fabian Homborg
1934e867f2 docs/tutorial: Fix < typo 
See #6640
 2020-02-23 09:27:33 +01:00
Fabian Homborg
b5cbdc623d docs/tutorial: Replace coloring markup 
This used to use doxygen's html blocks, which don't have a *direct*
equivalent in sphinx in code blocks.

Instead of adding this to the pygments highlighter, let's just use
some roles.

It's a teensy bit awkward as we then use block styling, but we want to
add more of our own styling anyway, so we can presumably get this
somehow, and these html tags look awkward and confuse people.

Fix #6640

[ci skip]
 2020-02-22 18:01:05 +01:00
Fabian Homborg
b28b14b67c docs: Correct bind docs on escape delay 
We never updated that after we changed the default.

[ci skip]
 2020-02-22 15:00:01 +01:00
Fabian Homborg
4f4c9aac34 FAQ: Reword history substitution entry 
[ci skip]
 2020-02-21 19:52:42 +01:00
Fabian Homborg
fdfb8f67d9 FAQ: Remove non-frequently asked questions 
I don't think I've ever had anyone ask about our usage of unicode
private use characters.
 2020-02-21 19:48:20 +01:00
Fabian Homborg
415cbb9e0b FAQ: Add question about mode prompt 
This is actually a frequently asked question.
 2020-02-21 19:45:14 +01:00
Aaron Gyes
85a0ca66e0 We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
ridiculousfish
a8120359c7 Remove all of doc_src 
See the last_doxygen tag for the last supported Doxygen build.
 2019-02-24 19:40:27 -08:00
Fabian Homborg
8a93c7d0ea abbr: Add "-q"/"--query" option 
[ci skip]
 2019-02-19 11:02:58 +01:00
Jonathan Revah
8e41e3337c small typo in the tutorial. stderr is redirected using 2> rather than >2 2019-02-18 22:08:58 +01:00
Sabine Maennel
20c51b7da9 changes according to feedback 
Changes according to the feedback have been made:

- What is a shell section has been moved before Installation and Start section

- Content changes have been made as suggested in both of the above sections.
 2019-02-16 13:40:18 -08:00
Sabine Maennel
f6974e5a76 documentation 
Start issue 740

- changed introduction section
- added installation section
- added what is a shell section
 2019-02-16 13:40:18 -08:00
Fabian Homborg
ca5b7c0ec4 math: Allow --scale=max 2019-02-13 12:54:58 +01:00
Fabian Homborg
dc0746bc45 Let command -q work 
This required "-sq" to be used and errored if just "-q" was given.

Instead, if only "-q" is given, we behave just as if "-sq" was.
 2019-02-12 20:34:19 +01:00
Fabian Homborg
fb7a6e5f34 Add builtin -q 
Used to query for a builtin's existence, like `type -q` and `functions
-q` can be used to query for a things and a functions existence respectively.
 2019-02-12 20:34:19 +01:00
Fabian Homborg
3382a2145f doc_src/math: Document needed escaping harder 
Fixes #5650.

[ci skip]
 2019-02-12 18:14:33 +01:00
Andrew Childs
fe73fbdb9a Document that snippets are run before system config 2019-02-10 18:25:44 +01:00
Fabian Homborg
8c6ae4612b Document fish_svn_prompt 2019-02-10 14:44:50 +01:00
Fabian Homborg
b19b1ee23a Document fish_hg_prompt 2019-02-10 14:44:50 +01:00
Fabian Homborg
f7c981af63 Document vcs prompt 2019-02-10 14:44:50 +01:00
Fabian Homborg
c771334924 Rename __fish_vcs_prompt -> fish_vcs_prompt 
Still keep a stub under the old name for compatibility.
 2019-02-10 14:44:50 +01:00
Fabian Homborg
f2b08ec592 Document fish_git_prompt 
Shows how convoluted the thing is, really.
 2019-02-10 14:44:50 +01:00
Fabian Homborg
965fef739c docs/tutorial: Remove mention of caret (^) 
While this is still technically included, the tutorial should not
steer people towards it.

[ci skip]
 2019-02-09 18:48:38 +01:00
Aaron Gyes
0abcf9265e {forward,backward}-bigword on Shift-Left/Right 
There was no way to do this at all without vi keybindings,
and it turns out shift-left/shift-right was available.

Fixes #1605
 2019-02-07 13:11:34 -08:00
Fabian Homborg
7c8b444927 Reduce default escape delay 
300ms was waaay too long, and even 100ms wasn't necessary.

Emacs' evil mode uses 10ms (0.01s), so let's stay a tad higher in case
some terminals are slow.

If anyone really wants to be able to type alt+h with escape, let them
raise the timeout.

Fixes #3904.
 2019-02-07 12:19:36 +01:00
Fabian Homborg
b03c62bd29 docs: Fix status is-command-substitution 
The docs spoke of a short "is-command-sub" variant, which does not
exist.

Fixes #5624.

[ci skip]
 2019-02-07 08:56:30 +01:00
David Adam
4cc168ae11 Documentation for while: note updated exit status 
From updates in #4982.
 2019-02-04 22:26:59 +08:00
Ashe Connor
c7635ed2c0 ***.fish* -> **.fish` 2019-01-31 22:03:12 +08:00
Ashe Connor
09ca268d50 fix "are equivalent" with same example 
This was introduced in 87eb073 when ^ redirection was removed from the
docs.
 2019-01-30 10:51:56 +01:00
Ashe Connor
d9d2ad1cd6 pcre2 -> regex 2019-01-30 10:47:07 +01:00
Jeremy
dc885d70b3 Rename Fisherman to Fisher in FAQ 
Fisherman became Fisher and moved to a new repo. The previous link still worked, but the name and URL change was needed to avoid confusion.
 2019-01-27 12:28:24 +01:00
ridiculousfish
730effa0d9 Remove an errant space from the docs 2019-01-26 16:32:37 -08:00
Dan Zimmerman
50448e4319 Enable configuring more pager colors 
Originally I sought out to configure the foreground color of the
selected text in the pager. After reading a thread on a github issue I
was inpired to do more: now you can conifgure any part of the pager when
selected, and when a row is secondary. More specifically this commit adds the
ability to specify a pager row's:

- Prefix
- Completion text
- Description
- Background

when said row is selected or secondary.
 2019-01-26 15:43:23 -08:00
Mahmoud Al-Qudsi
5adc07bf28 Document new type -p support for functions 2019-01-23 17:51:47 -06:00
ridiculousfish
71b5591f21 Update docs on tab completions and searching 
Fixes #5547
 2019-01-22 14:41:16 -08:00
Aaron Raimist
1398ee9bbb docs: list full command to change default shell 2019-01-18 10:38:12 +01:00
Mahmoud Al-Qudsi
1b23814f8b Clarify the point of type --force-path [docs] 
[ci skip]
 2019-01-16 17:42:11 -06:00
David Adam
4a8db53bcf status docs: add current-command 
Note deprecation of $_.

[ci skip]
 2019-01-09 22:38:57 +08:00
Fabian Homborg
adb97772c5 doc_src/printf: Add missing space 
[ci skip]
 2019-01-06 13:46:11 +01:00
Fabian Homborg
72c0213d42 docs: Document $hostname 
Fixes #5469.

[ci skip]
 2019-01-03 12:31:35 +01:00
hrvoj3e
69a1c5a3a1 Fix typos in anchor to fish_opt 2018-12-27 14:45:14 +01:00
Fabian Homborg
335c41f097 math: Document round 
[ci skip]
 2018-12-01 23:06:13 +01:00
Fabian Homborg
1785af156b doc_src/string: Add a small regex reference 
This isn't nearly all of
it (https://pcre.org/current/doc/html/pcre2syntax.html), but it should
cover the most-used features.

[ci skip]
 2018-12-01 09:54:05 +01:00
Fabian Homborg
85cecd30fb docs: fish_color_search_match is also used in the pager 
Fixes #5314.

[ci skip]
 2018-11-27 16:06:06 +01:00
Fabian Homborg
40799d9e95 docs: Use fish_exit event instead of waiting for a process 2018-11-25 19:13:18 +01:00
Fabian Homborg
8ab6078001 docs: Remove the last mention of process expansion 
See #5286.
 2018-11-25 19:12:58 +01:00
David Adam
2dab869b41 Restore legacy CMD_DURATION and FISH_VERSION variables 
Work on #4154.

Effectively reverts fb8ae04f80.

Discussed extensively in
https://github.com/fish-shell/fish-shell/pull/5320
 2018-11-24 12:37:26 +08:00
Fabian Homborg
c729a97c43 builtin_read: Remove --all-lines 
This was unused and needed to be warned about in the docs. Remove it
so nobody stumbles over it.

Fixes #5332.
 2018-11-20 16:56:52 +01:00
Mahmoud Al-Qudsi
31d17f4559 Rename string escape --style=pcre2 to string escape --style=regex 2018-11-16 20:22:06 -06:00
Wojciech Siewierski
75515a4917 Update the docs regarding floats support in test (#5344) 
* Replace "env" with "expr" in the test manpage

I'm pretty sure `env` isn't capable of comparing numbers and the author meant `expr`.

* Update the docs regarding floats support in test
 2018-11-16 13:32:15 +01:00
Mahmoud Al-Qudsi
680040d17d Document new PCRE2 string escaping in CHANGELOG and string.txt 2018-11-15 12:00:56 -06:00
David Adam
322b232fc0 Clarify and improve read documentation 2018-11-12 23:13:41 +08:00
David Adam
8e5b1f9e4d docs: drop reference to process expansion 2018-11-12 23:13:41 +08:00
Moritz Wilhelmy
9afc4b419e Allow cd . to re-enter the current directory 
Closes #4543.
 2018-11-04 21:46:24 +08:00
santpent
22f794125f add command substition indexing examples (#5303) 
* add command substition indexing examples

following from issue #243

* Update index.hdr.in
 2018-11-02 13:24:51 +01:00
Mahmoud Al-Qudsi
f695284a84 Add fish private mode info to changelog and manual 2018-10-24 19:33:48 +02:00
Fabian Homborg
57cf9055d5 FAQ: Add pkg-config/splitting question 
Fixes #4855.
 2018-10-23 16:55:44 +02:00
Fabian Homborg
1d5e715008 source: Return error instead of implicitly reading from tty 
For things like

    source $undefined

or
    source (nooutput)

it was quite annoying that it read from tty.

Instead we now require a "-" as the filename to read from the tty.

This does not apply to reading from stdin if it's redirected, so

    something | source

still works.

Fixes #2633.
 2018-10-22 21:22:27 +02:00
Fabian Homborg
6c988abe28 Add $__fish_config_dir variable 
Contains the path to the user config.fish (e.g. ~/.config/fish)
without having to do the `set -q XDG_CONFIG_HOME` dance.

See #5270.
 2018-10-21 15:42:25 +02:00
ridiculousfish
1b5ccb12d5 Document PATH variables 2018-10-20 12:31:44 -07:00
ridiculousfish
3f3b3a7006 Export arrays as colon delimited, and support path-style variables 
This commit begins to bake in a notion of path-style variables.

Prior to this fix, fish would export arrays as ASCII record separator
delimited, except for a whitelist (PATH, CDPATH, MANPATH). This is
surprising and awkward for other programs to deal with, and there's no way
to get similar behavior for other variables like GOPATH or LD_LIBRARY_PATH.

This commit does the following:

1. Exports all arrays as colon delimited strings, instead of RS.

2. Introduces a notion of "path variable." A path variable will be
"colon-delimited" which means it gets colon-separated in quoted expansion,
and automatically splits on colons. In this commit we only do the exporting
part.

Colons are not escaped in exporting; this is deliberate to support uses
like

    `set -x PYTHONPATH "/foo:/bar"`

which ought to work (and already do, we don't want  to make a compat break
here).
 2018-10-19 17:29:39 -07:00
Mahmoud Al-Qudsi
a8a9a823f2 Correct unescaped backslash in \n in string.txt 2018-10-14 16:40:27 -05:00
Dennis Schridde
e3643c610f doc_src/set.txt: -U affects only the user running the command, not all users 2018-10-10 18:42:56 +02:00
Mahmoud Al-Qudsi
e212269ab1 Add status fish-path 
Retrieves the fully resolved path to the currently executing fish binary
(regardless of PATH). Can be used to ensure that the same fish is
launched again from a script.

`get_executable_path()` moved from fish binary to libfish, also cleaned
up some duplicated (but differing!) definitions of PATH_MAX (which was
used by that function) in the process.
 2018-10-09 22:34:41 -05:00
Adel Atallah
6a9f0fc0c1 Fix typo in the documentation 2018-10-09 16:52:27 +02:00
Jason
ca159ae4b8 Fix typo 2018-10-07 12:49:02 +02:00
ridiculousfish
0f0bb1e10f Don't resolve symlinks with cd 
This switches fish to a "virtual" PWD, where it no longer uses getcwd to
discover its PWD but instead synthesizes it based on normalizing cd against
the $PWD variable.

Both pwd and $PWD contain the virtual path. pwd is taught about -P to
return the physical path, and -L the logical path (which is the default).

Fixes #3350
 2018-10-06 17:03:18 -07:00
Fabian Homborg
444f9f8715 Add separation of "preset" bindings 
This allows for marking certain bindings as part of a preset, which allows us to

- only erase those when switching presets
- go back to the preset binding when erasing a user binding
- only show user customization if requested
- make bare bind statements in config.fish work (!!!11elf!!!)

Fixes #5191.
Fixes #3699.
 2018-09-30 16:54:56 +02:00
David Adam
5cc92ffd70 Documentation for while: note new exit status changes 
Work on #4982.
 2018-09-28 22:57:02 +08:00
Fabian Homborg
d44c21b580 Document/complete feature flags more 2018-09-16 10:39:15 +02:00
Fabian Homborg
bda147c7d3 Correct math docs 
This was an oversight when math was changed to default to float output.

Also some more jokey stuff. Jokey stuff is nice.
 2018-09-15 15:31:59 +02:00
Jason
5d59c6a1cd Correct argument order for signal handler example 2018-09-10 19:05:06 +02:00
ridiculousfish
cbcabf6d00 Add support for fish_ambiguous_width 
fish_ambiguous_width is a variable which controls the width of ambiguous CJK
characters.

Fixes #5149
 2018-08-18 15:38:05 -07:00
David Adam
c5ec7daab4 Revert "license.hdr: add Apache2 license for wcwidth9" 
This reverts commit 00f2099f29. wcwidth9
has been removed.
 2018-07-14 15:43:37 +08:00
ridiculousfish
87f646d84d Correct spelling of 'consistently' 2018-07-09 20:55:55 -07:00
gkdoc
c04cb9c715 Update FORMATTING.md (#5087) 2018-07-09 20:54:56 -07:00
ridiculousfish
73c747d162 Add string join0 
string join0 joins its arguments using NUL byte, which complements
string split0. For example it allows piping a variable through sort -z.
 2018-07-01 15:56:34 -07:00
ridiculousfish
b1176323e7 Document string split0 2018-07-01 15:56:34 -07:00
David Adam
dc17869a84 commandline docs: add note that -b selects autosuggestion 
Suggested in #5000.
 2018-06-29 21:28:46 +08:00
David Adam
00f2099f29 license.hdr: add Apache2 license for wcwidth9 
The wcwidth code is derived entirely from neovim, not from vim.
 2018-06-29 21:27:29 +08:00
Fabian Homborg
cbdd347ec6 Changelog range expansion change, expand docs 2018-06-25 17:57:06 +02:00
Fabian Homborg
81a987c39c Fix range expansion with negative ends 
If just one of the range ends is negative, this now forces direction away from it.

I.e. if the beginning is negative, we go in reverse.
If the end is negative, we go forwards.

This fixes cases like

    $var[2..-1]

if $var only has one element.
 2018-06-25 17:52:56 +02:00
ridiculousfish
e812b609f9 Update set man page to clarify scoping rules 
"When an exported variable goes out of scope, it is unexported."

As requested in #5064
 2018-06-23 15:18:38 -07:00
Sabine Maennel
b347b44d9e added 2 sections to the tutorial 
Added 2 sections to the tutorial:
- getting started
- switching to fish

This fixes issue #475
 2018-06-04 20:39:08 -07:00
David Adam
8a6fe77f71 docs: remove unneeded dashes 2018-05-31 13:07:02 +08:00
David Adam
84f5d2082a Mark arguments as optional in read docs synopsis 2018-05-31 13:07:02 +08:00
Fabian Homborg
ff47b2dad5 [docs] Some rewording to the builtins 
Plus some additional examples.
 2018-05-14 00:36:49 +02:00
Fabian Homborg
90023e6dfb [docs] Reword abbr 
Move the variable discussion to a section at the bottom.
 2018-05-14 00:34:56 +02:00
Fabian Homborg
b3ce3e2b7c [docs] Reword variable expansion and cartesian product 
This should be a bit nicer to read.
 2018-05-13 23:57:16 +02:00
Fabian Homborg
7c5297e785
Merge branch 'master' into issue_4848 2018-05-11 16:06:27 +02:00
Fabian Homborg
2c312d05df [docs] Add more subsections 
They are great!
 2018-05-08 17:26:56 +02:00
Fabian Homborg
5b1731331e [math] Add subsection headers to the docs 
Otherwise this is printed as "math-syntax" in the man page.
 2018-05-08 17:11:48 +02:00
David Adam
21890ccac7 function: restore '%self' functionality for --on-process-exit 
One key use of process expansion, used in currently-shipped code, is for running a function on
current shell exit.

Restore the use of %self as a valid argument (and add `self`) and document this change.

(faho: Remove bare "self")
 2018-05-08 11:17:07 +02:00
ridiculousfish
d623ac5040 Add future feature flags to the documentation 2018-05-06 12:06:06 -07:00
ridiculousfish
87eb073ff9 Remove some references to ^ redirection from the docs 
Replace these with 2>
 2018-05-06 11:53:14 -07:00
ridiculousfish
762c31be87 Feature flag support for ? wildcard 
This partially reverts 6e56637cf0 and #4520
by bringing back the ? wildcard, guarded by the qmark-noglob feature flag.
 2018-05-06 11:20:15 -07:00
ridiculousfish
7cbc0c371a Remove a "common fish problems" section in the docs 
This wasn't really that common.
 2018-05-06 11:19:58 -07:00
Fabian Homborg
1a1ee352ff [commandline] Change "--selection" to "--current-selection" 
Plus documentation.

Work towards #4255.
 2018-05-05 21:41:03 +02:00
Mahmoud Al-Qudsi
bd8c8ceb59 Add line-delimited read presets with --line and --all-lines 
Refer to changes in doc_src/read.txt for more info. Closes #4861.
 2018-04-17 21:34:22 -05:00
Fabian Homborg
701259d372 Remove ":" from argparse docs 
Also improve some of the wording.

Fixes #4871.

[ci skip]
 2018-04-10 21:26:02 +02:00