github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-23 22:17:52 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
14,104 Commits 35 Branches 80 Tags 115 MiB
af84c35282
Commit Graph

121 Commits

Author SHA1 Message Date
Fabian Homborg
dca6eee55f docs: Less "the user", more "you" 
The person reading this is "you". It's completely okay and sounds
better to address them directly.

When we're talking about OS users or users of fish script the reader
writes, "the user" is still okay.

[ci skip]
 2020-09-18 16:53:59 +02:00
Fabian Homborg
c188ecf6c7 docs: Reword Tab Completion section 
[ci skip]
 2020-09-18 16:46:52 +02:00
Fabian Homborg
63adb6871b docs: "fish" is a normal word 
We don't need to emphasize it with a monospace block.

Just on index.rst for now.

Work towards #6785.

[ci skip]
 2020-09-18 16:40:09 +02:00
Fabian Homborg
021d4157ca Fix hybrid binding instructions 
This needs to have the vi-bindings take precedence, so they need to be
executed *last*.

It just needs to tell them that they shouldn't erase all the bindings.

[ci skip]
 2020-08-28 20:50:24 +02:00
Fabian Homborg
bc715c6eb4 docs: Reword some of the Special Variables section 
[ci skip]
 2020-08-27 17:07:23 +02:00
Aurelio Jargas
0304135d2b
docs: Use \ instead of \\ in examples (#7286) 
Instead of informing the bell character (hex 07), the example was using
an escaped \ followed by x07.

    $ echo \\x07
    \x07
    $ echo \x07

    $ echo \x07 | od -a
    0000000 bel  nl
    0000002
    $

* docs: Use \u instead of \\u

Instead of informing the Unicode character 慡, this example was using an
escaped \ followed by u6161.

    $ echo \\u6161
    \u6161
    $ echo \u6161
    慡

Before:

    $ string escape --style=var 'a1 b2'\\u6161 | string unescape --style=var
    a1 b2\u6161

Now:

    $ string escape --style=var 'a1 b2'\u6161 | string unescape --style=var
    a1 b2慡
 2020-08-26 18:29:03 +02:00
Xandor Schiefer
ed212c631c Correct Emacs bindings in vi insert mode 
The original instruction does not actually enable Emacs key bindings in Vi mode. This fixes it.
 2020-08-23 12:56:27 -07: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
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
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
Fabian Homborg
82de51b9d3 Document adding bindings 
This was never made explicit.

[ci skip]
 2020-07-16 17:47:35 +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
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
Johannes Altmanninger
8b961a0ca8 Bind undo to Control-Z in addition to Control-/ 
See #7152
 2020-07-01 00:40:32 +02:00
David Adam
7838b47e6b docs: formatting fixes in initialization section 2020-06-15 21:46:20 +08:00
Fabian Homborg
5cae62a266 docs: Document comments 
Turns out they weren't.

Fixes #7106.
 2020-06-10 17:39:04 +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
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
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
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
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
LawAbidingCactus
f71737e58a Add $fish_force_vi_cursor variable to allow cursor setting on unsupported terminals 2020-05-14 22:25:20 +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
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
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
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
Johannes Altmanninger
1547a22659 docs: remove some spurious backslashes 2020-03-23 21:02: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
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
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
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
84c95324e1 doc: add links to count and contains commands in list section 2020-03-14 12:57:51 +01:00
Johannes Altmanninger
0bb3efb1ad Docs: add missing backticks 2020-03-07 18:33:39 +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
Delapouite
c0271a71d1 doc: fix 404 error for set_color command 2020-02-26 19:30:46 +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
Collin Styles
b7f9d9a229 Fix link in documentation 2020-02-23 09:37:40 +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