github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-25 09:39:52 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
6,384 Commits 35 Branches 80 Tags 116 MiB
ffd4754cb2
Commit Graph

661 Commits

Author SHA1 Message Date
Konrad Borowski
b5d9e366ad Mention that for variables are local. 
This is the current behaviour, documentation can be updated if this
behaviour changes, assuming it can, because it's an incompatible
change.
 2015-02-06 07:48:47 +01:00
David Adam
66acd17bc0 isatty: revert to previous behaviour 
This partially reverts commit 60808a4820.
 2015-02-01 18:18:34 +08:00
David Adam
b9ff17f33c test: note that the square bracket form is available 
As requested in https://github.com/fish-shell/fish-shell/issues/1850
 2014-12-28 19:03:26 +08:00
ridiculousfish
a76afd6dae Clarify some documentation regarding fish_indent 2014-12-24 13:05:31 -08:00
ridiculousfish
d300bd4b62 Document new flags to fish_indent 2014-12-23 17:21:54 -08:00
David Adam
a7bab7b18b abbr/web_config: support space-delimited abbreviations 
Support for space-delimited abbreviations was added to the expansion
parser in fbade198; this commit extends that support to the user-facing
tools, and documents the space-separated behaviour. Equals-delimited
abbreviations are expected to be removed before the next release.

Work on #731.
 2014-11-15 23:48:40 +08:00
David Adam
51e446bc5f update keybindings docs 2014-11-13 14:15:56 +08:00
Jared Grubb
f68f91b399 Vim bindings doc: describe modes better and explain some non-vim bindings 2014-11-13 14:15:55 +08:00
David Adam
7c2a420e88 add license for tmux code added in d944add 2014-11-10 16:06:02 +08:00
David Adam
f2447c537e document behaviour of arrays that are split on import 2014-11-10 11:58:11 +08:00
David Adam
a31b44f9b2 contains: add documentation regarding the use of -- 
Closes #1194.

[skip ci]
 2014-10-26 19:02:03 +08:00
Kevin Ballard
72f5ab3186 Fix typo in abbr documentation 
[skip ci]
 2014-10-07 16:48:22 -07:00
David Adam
46241e383f license.hdr: reduce duplication and clarify some comments 
[skip ci]
 2014-10-06 16:30:00 +08:00
David Adam
ea79f6b03f license.hdr: remove licensing information for XSel, no longer shipped 
[skip ci]
 2014-10-06 16:30:00 +08:00
David Adam
501c3d5518 abbr.fish: add abbr, a command to manipulate abbreviations 
Work on #731.
 2014-10-05 12:23:31 +08:00
Kevin Ballard
cfc06203e7 Add new functions flag -V/--inherit-variable 
--inherit-variable takes a variable name and snapshots its current
value. When the function is executed, it will have a local variable with
this value already defined. Printing the function source will include
synthesized `set -l` lines for the values.

This is primarily useful for functions that are created on the fly, such
as in `psub`.
 2014-10-02 18:41:39 -07:00
Kevin Ballard
bae2b2cc47 Fix examples in bind documentation 2014-10-01 18:20:09 -07:00
Kevin Ballard
b592da41f6 Fix doc example for echo 2014-10-01 15:30:36 -07:00
Jan-Thorsten Peter
646d9ab431 Added fish_preexec and fish_postexec events 
Fixes #1549.
 2014-10-01 15:09:35 -07:00
David Adam
5157ac30fa Create and use $DATADIR/vendor_completions.d/ for upstream completions 
Closes #1485.
 2014-10-01 21:28:01 +08:00
Kevin Ballard
d67800bbce Make false/true into builtins 
Making `true` into a builtin is a significant optimization to `while
true` loops. As long as `true` is a builtin, we may as well make `false`
builtin as well (despite the fact that it's not typically executed in a
loop).
 2014-09-29 13:39:35 -07:00
Konrad Borowski
26051ea198 Add Meta+H as keybinding for man page. 
Apparently, in zsh, Meta+H can be used to display the manpage for
the current command. This commit adds this zsh feature to fish shell.

The F1 keybinding is left, although it's now secondary according to
fish help, as some terminal emulators don't let the user press F1 key.
 2014-09-28 11:12:25 +02:00
ridiculousfish
4f4734fc9b Fix some busted escape sequences in docs, and slightly reformat a few examples 2014-09-27 16:56:13 -07:00
Mark Griffiths
a9b7e4582f Clean up font declarations 
re: fish-shell/fish-shell@2726712e01

As this is rendering ok in Firefox, this version should pickup the best
fonts for most browser/os variants based on 'font-stretch' support.

`.fish_left_bar` should be condensed, the main body font shouldn't.
 2014-09-23 12:14:20 +01:00
Konrad Borowski
2726712e01 Restore DejaVu Sans Condensed font. 
With font-strentch: condensed, the rendering is acceptable.
 2014-09-23 12:28:08 +02:00
Mark Griffiths
8d3d51a020 lexicon_filter fix for escaped options 
Fixes #1703. Also fixes short and long options markup in synopsis when
directly following a '(' or '[' character.
 2014-09-23 00:24:05 -07:00
Kevin Ballard
5afd42c097 Suppress italics in keyboard shortcuts 2014-09-23 00:21:18 -07:00
Kevin Ballard
5b33e60752 Support bind SEQ to print a binding for SEQ 2014-09-22 21:30:44 -07:00
Kevin Ballard
0a3f220572 Rework mode handling of bind 
Binds with the same sequence in multiple modes was not working right.
Fix up the implementation to propagate modes everywhere as necessary.
This means that `bind` will properly list distinct binds with the same
sequence, and `bind -e` will take mode into account properly as well.
Note that `bind -e seq` now assumes the bind is in the default bind
mode, whereas before it would erase the first binding with that sequence
regardless of mode.

`bind -e -a` still erases all binds in all modes, though `bind -M mode
-e -a` still only erases all binds in the selected mode.
 2014-09-22 21:04:06 -07:00
Kevin Ballard
4718636ae2 Update bind documentation 
Document all the `bind` flags, including modes.

Fixes #1663.
 2014-09-22 20:08:38 -07:00
Kevin Ballard
7a9e2d733a Stop overriding <em> in user documentation 
<em> used to represent something else, but as far as I can tell, all
uses of <em> in the documentation today actually represent text that's
supposed to be visibly different. Notably, the documentation on
supported escapes uses <em> to indicate the letters that are a
placeholder for e.g. a hex digit, as opposed to being a literal
character.
 2014-09-22 14:47:01 -07:00
Kevin Ballard
fe9cf673a2 Add --right-prompt flag to read 
Add a flag to read to allow for setting the right prompt command in
addition to the existing support for setting the prompt command.

Fixes #1698.
 2014-09-21 21:10:07 -07:00
Kevin Ballard
8f8c4cdd17 Implement new read --null flag 
The `--null` flag to `read` makes it split incoming lines on NUL instead
of newlines. This is intended for processing the output of a command
that uses NUL separators (such as `find -print0`).

Fixes #1694.
 2014-09-21 19:27:26 -07:00
Konrad Borowski
f889ad0fda Don't use DejaVu Sans Condensed for documentation rendering. 
This font, at least under Kubuntu 14.04 and Firefox I use is rather
ugly. Anti-aliasing is wrong, and the spaces between letters are
rather random. It makes reading the documentation headings and table
of contents harder than it needs to be.

Those issues don't happen with DejaVu Sans.
 2014-09-21 14:35:32 +02:00
David Adam
708e21f929 fish_indent: minor documention updated 
[skip ci]
 2014-09-17 10:18:27 +08:00
Mark Griffiths
ea435d35ad After proofreading, fixes a few minor typos. 2014-09-12 16:45:47 +02:00
Mark Griffiths
6b75a4593b Merge remote-tracking branch 'upstream/master' into documentation-update 
Conflicts (resolved):
	doc_src/design.hdr - \c changed to backticks
 2014-09-08 07:05:53 +01:00
Noah Frederick
8643a5e266 Clean up typos and style in design doc 
This includes:

- Fixing some typos and misspellings
- Being consistent with pronouns (she/he)
- Hyphenating "built-in" and "command-line" where appropriate
 2014-09-07 16:08:10 -07:00
Mark Griffiths
47f97bbdd5 Fixed a couple of typos 2014-09-07 17:43:58 +01:00
Mark Griffiths
2e034e767f Update menus for consistency 
Widened 'Commands' menu + fish logo
fish logo added to FAQ menu
'Commands' menu content aligned with Docs menu
'FAQ' menu content aligned and made 1st order as all entires are long
and wrap.
 2014-09-07 17:35:19 +01:00
Mark Griffiths
f1bd2b823d Strip working files 2014-09-04 13:13:57 +01:00
Mark Griffiths
ac92f54ca6 Updated Testing Info. Ready for PR. 
Major documentation cleanup and update.
- Fixes Issue #1557
- Moves entire documentation to Markdown format. Much simpler.
- Fully supports Doxygen 1.8.7+
- All documentation targets updated: user_doc, share/man, doc and
doc/refman.pdf.
- Tested across Ubuntu, CentOS and Mac OS.

See doc_src/FORMATTING.md for in depth rationale and style guide.
 2014-09-04 12:50:43 +01:00
Mark Griffiths
1b4c85eb69 Fixed Doxygen required version to 1.8.7 
Doxygen 1.8.6 and lower do not have the \\htmlonly[block] directive
which fixes a multitude of problems in the rendering of the docs. In
Doxygen 1.8.7 the list of understood HTML entities was greatly
increased. I tested earlier versions and many little issues returned.
 2014-09-04 12:07:07 +01:00
Mark Griffiths
fb792c60cd Fix missed conflict 2014-09-04 12:01:08 +01:00
Mark Griffiths
cb9ef98bed Fix Doxygen unresolved link error 2014-09-04 10:32:13 +01:00
Mark Griffiths
89f0b9abc3 Added Doxygen notes 2014-09-04 10:23:38 +01:00
Mark Griffiths
0e5ddfd9f5 Merge branch 'master' into documentation-update 
Conflicts (fixed):
	doc_src/design.hdr
 2014-09-04 10:00:52 +01:00
Mark Griffiths
0a249c84ce Added notes to Formatting doc 2014-09-04 09:48:30 +01:00
Mark Griffiths
76aeae5db6 Synopsis tweaks 2014-09-04 08:10:42 +01:00
Mark Griffiths
1facdd30fb Formatting additions 2014-09-04 07:55:21 +01:00
Joseph Tannhuber
4acea72700 New -n option for read builtin 
Usage: read -n nchars
Reads maximum of nchars characters. If nchars <= 0, there's no limit.
 2014-09-03 22:48:37 -07:00
Mark Griffiths
cf688f6ba2 List fixes 2014-09-03 20:31:57 +01:00
Mark Griffiths
5f3b0d9f1e Merge branch 'master' into documentation-update 
Conflicts:
	doc_src/design.hdr
 2014-09-03 20:31:43 +01:00
Mark Griffiths
05848038db Index long line fixes 2014-09-03 19:39:22 +01:00
Mark Griffiths
664e2e5686 Rebase conflict resolution 2014-09-03 15:14:11 +01:00
Mark Griffiths
adbcecb456 Rebase documentation changes 2014-09-03 15:10:53 +01:00
Mark Griffiths
3df9e20ca7 Formatting updates 2014-09-03 14:43:27 +01:00
Mark Griffiths
3f005c928a Supporting files for development 2014-09-03 14:43:27 +01:00
Mark Griffiths
b3e28ac41a Addition of 'ascii fish' logo 
+ small fixes
 2014-09-03 14:43:27 +01:00
Mark Griffiths
c39fe3433b Various additions and fixes 2014-09-03 14:43:27 +01:00
Mark Griffiths
668fa66d78 Fish documentation formatting guidelines 2014-09-03 14:43:27 +01:00
Mark Griffiths
98ebb21489 Consistency fixes 2014-09-03 14:43:27 +01:00
Mark Griffiths
137abd0cfa Make line length, wrapping and spacing consistent 2014-09-03 14:43:26 +01:00
Mark Griffiths
73fb9915fd Fixed a few more edge cases 2014-09-03 14:43:26 +01:00
Mark Griffiths
509d152e54 Tutorial auto colouring, Man page and Make fixes 
Completely fixes #1557 and the underlying Doxygen changes that caused
it. Should make fish docs simpler and more robust, more consistent and
generally prettier.

todo:
- trap unmarked text as arguments in context
- test & fix sed portability - see in particular. (so far tested on BSD
(Mac) and GNU sed).
- test Makefile changes
- last round of aesthetic changes and getting that ascii fish in there…
 2014-09-03 14:43:26 +01:00
Mark Griffiths
def7666609 Fix missed escaped '--' inside /fish block 2014-09-03 14:43:25 +01:00
Mark Griffiths
7b093ee4b3 Lexicon filter: fix 'if' and 'for' special cases 2014-09-03 14:43:25 +01:00
Mark Griffiths
9f75cef5e5 Style fix for sub-line comments 2014-09-03 14:43:25 +01:00
Mark Griffiths
a410c31bf8 Fixes lexicon filter pipes '|" 2014-09-03 14:43:25 +01:00
Mark Griffiths
1cd50ba572 Merged in latest changes to docs and formatting tweaks 
Addresses issue #1557 as well as fixing many typos, HTML errors and
inconsistencies. Also introduces automatic syntax colouring and enables
new documentation to be written in Markdown. TODO fix Tutorial.
 2014-09-03 14:43:25 +01:00
Mark Griffiths
1052eeee8c Simplify styling 2014-09-03 14:43:25 +01:00
Mark Griffiths
d282bc4625 Documentation update 
Rework for Doxygen >1.8. Moved large parts of the documentation to a
simplified format, making use of Markdown enhancements and fixing bad
long options.
 2014-09-03 14:43:24 +01:00
Chris Wolfe
677cee44ad failiure/failure 
Fix misspelling of failure in the fish shell design doc
 2014-09-03 14:48:21 +02:00
Mark Griffiths
385b00a468 Formatting updates 2014-09-03 13:06:49 +01:00
Mark Griffiths
6068e85ef2 Merge branch 'master' into documentation-update 2014-08-30 12:38:57 +01:00
Mark Griffiths
ced471d4ce Supporting files for development 2014-08-30 12:21:46 +01:00
Mark Griffiths
2445ac4a53 Addition of 'ascii fish' logo 
+ small fixes
 2014-08-30 11:03:02 +01:00
Christos Kontas
0f330d7226 Fix small typo in documentation 2014-08-30 08:03:24 +02:00
Mark Griffiths
3d29cc8636 Various additions and fixes 2014-08-27 00:30:08 +01:00
Mark Griffiths
d6c5a1e0c4 Merge branch 'master' into documentation-update 
Conflicts (FIXED):
	doc_src/command.txt
	doc_src/index.hdr.in
	doc_src/read.txt
	doc_src/type.txt
 2014-08-26 20:05:46 +01:00
Mark Griffiths
e90b1651e4 Fish documentation formatting guidelines 2014-08-26 19:19:48 +01:00
Mark Griffiths
66ccae4bfe Consistency fixes 2014-08-26 19:19:24 +01:00
ridiculousfish
033373f078 Merge branch 'make_type_better' of github.com:kballard/fish-shell into kballard-make_type_better 2014-08-21 21:36:39 -07:00
Kevin Ballard
20899f2df9 doc: Document how IFS affects command substitution 
IFS is used for more than just the read builtin. Setting it to the empty
string also disables line-splitting in command substitution, and it's
done this for the past 7 years. Some day we may have a better way to do
this, but for now, document the current solution.
 2014-08-21 20:57:23 -07:00
Kevin Ballard
b9948ca297 doc: Fix docs on $HOME/$USER 
The docs claimed that the $HOME and $USER variables could only be
changed by the root user. This is untrue. They can be changed by
non-root users as well.
 2014-08-21 20:57:23 -07:00
Kevin Ballard
f33e6a053e doc: Fix links in "Further help and development" 
Hyperlink the mailing list to the proper info page.

Tweak the GitHub link to use https.
 2014-08-21 19:15:58 -07:00
Mark Griffiths
4651919bd8 Make line length, wrapping and spacing consistent 2014-08-19 13:41:23 +01:00
Mark Griffiths
fed4bb5c07 Merge branch 'master' into documentation-update 
Conflicts (FIXED):
	.gitignore
	doc_src/complete.txt
	doc_src/function.txt
 2014-08-19 11:42:21 +01:00
Mark Griffiths
3ea956a0b4 Fixed a few more edge cases 2014-08-19 10:58:22 +01:00
ridiculousfish
06400b83b1 Support for command wrapping ("aliases") 
Add the --wraps option to 'complete' and 'function'. This allows a
command to (recursively) inherit the completions of a wrapped command.
Fixes #393.

When evaluating a completion, we inspect the entire "wrap chain" for a
command, i.e. we follow the sequence of wrapping until we either hit a
loop (which we silently ignore) or the end of the chain. We then
evaluate completions as if the wrapping command were substituted with
the wrapped command. Currently this only works for commands, i.e.
'complete --command gco --wraps git\ checkout' won't work (that would
seem to encroaching on abbreviations anyways). It might be useful to
show an error message for that case.

The commandline builtin reflects the commandline with the wrapped
command substituted in, so e.g. git completions (which inspect the
command line) will just work. This sort of command line munging is
also performed by 'complete -C' so it's not totally without precedent.

'alias will also now mark its generated function as wrapping the
'target.
 2014-08-15 18:14:36 -07:00
Mark Griffiths
629a39b45b Tutorial auto colouring, Man page and Make fixes 
Completely fixes #1557 and the underlying Doxygen changes that caused
it. Should make fish docs simpler and more robust, more consistent and
generally prettier.

todo:
- trap unmarked text as arguments in context
- test & fix sed portability - see in particular. (so far tested on BSD
(Mac) and GNU sed).
- test Makefile changes
- last round of aesthetic changes and getting that ascii fish in there…
 2014-08-08 03:44:37 +01:00
Mark Griffiths
cff928e2dc Merge branch 'master' into documentation-update 
Conflicts:
	doc_src/index.hdr.in -- UPDATED
	doc_src/license.hdr -- UPDATED
 2014-08-05 13:50:21 +01:00
Mark Griffiths
6aa701b3ee Fix missed escaped '--' inside /fish block 2014-08-05 13:07:46 +01:00
Gio d'Amelio
bcda3f1baa Set $CMD_DURATION to milliseconds. Fixes #1585 2014-08-04 13:36:39 +08:00
David Adam
8844f0c142 Clarify I/O redirection documentation 
Fix the examples and try and improve the clarity of the section.

Closes #1409.
 2014-08-03 18:54:10 +08:00
David Adam
6cabd42ed2 Remove getpeerid/getpeerucred and fallbacks 2014-08-03 15:40:44 +08:00
ridiculousfish
0daee33ad6 Document new fish_title behavior per #334 2014-08-03 00:00:26 -07:00
Mark Griffiths
7e3382340e Lexicon filter: fix 'if' and 'for' special cases 2014-08-03 02:22:23 +01:00
Mark Griffiths
8ca88f14f7 Style fix for sub-line comments 2014-08-02 17:11:00 +01:00
Mark Griffiths
b4a4a7c611 Fixes lexicon filter pipes '|" 2014-08-02 17:10:28 +01:00
Mark Griffiths
f4077bd41f Merged in latest changes to docs and formatting tweaks 
Addresses issue #1557 as well as fixing many typos, HTML errors and
inconsistencies. Also introduces automatic syntax colouring and enables
new documentation to be written in Markdown. TODO fix Tutorial.
 2014-08-02 04:51:43 +01:00
Mark Griffiths
cb5c560688 Simplify styling 2014-08-01 13:25:41 +01:00
Mark Griffiths
8ac0fdfea7 Merge branch 'master' into documentation-update 
Conflicts:
	doc_src/history.txt
	doc_src/test.txt
 2014-08-01 05:16:02 +01:00
Mark Griffiths
c070a2aa3e Documentation update 
Rework for Doxygen >1.8. Moved large parts of the documentation to a
simplified format, making use of Markdown enhancements and fixing bad
long options.
 2014-08-01 03:37:32 +01:00
ridiculousfish
8144725739 Fix bad example in docs for test -n $MANPATH 
Fixes #1574
 2014-07-29 14:44:51 -07:00
ridiculousfish
e9f870e25a Add support for history --merge to incorporate history changes from 
other sessions.

Fixes #825
 2014-07-25 10:49:12 -07:00
David Xia
fa88c42cf1 Fix minor syntax and capitalization mistakes in vi mode docs 2014-07-15 21:59:08 -04:00
David Xia
e84a762171 Add docs for vi mode 
fixes #1536
 2014-07-15 21:29:02 -04:00
Kevin Ballard
973dd6ffbd read: Support arrays, character splitting 
Enhance the `read` builtin to support creating an array with the --array
flag. With --array, only a single variable name is allowed and the
entire input is tokenized and placed into that variable as an array.

Also add custom behavior if IFS is empty or unset. In that event, split
the input on every character, instead of the previous behavior of doing
no splitting at all.
 2014-07-14 00:46:38 -07:00
Kevin Ballard
72e8489d50 command: Rename -p/--path flag to -s/--search 2014-07-13 19:11:29 -07:00
Kevin Ballard
6f7a7459c1 test: Add a new --quiet flag to suppress output 
The --quiet flag is useful when only the exit status matters.

Fix the documentation for the -t flag to no longer claim that `type` can
print "keyword", as it never does that.

Stop printing a blank line for functions/builtins when the -p flag has
been passed. It's just not useful.
 2014-07-13 19:11:29 -07:00
Kevin Ballard
0933e5cab4 Fix typo in documentation for type builtin 2014-07-13 19:11:29 -07:00
Kevin Ballard
cc565fc16c Teach command builtin a -p/--path flag 
Give the `command` builtin a single flag, -p/--path, that causes it to
print the full path that would be executed for the given command.
 2014-07-13 19:11:29 -07:00
Kevin Ballard
62d86b3d18 Fix documentation on variable scopes for read 
The `read` docs incorrectly asserted that -g was the default for
variables. In actuality it behaves the same way that `set` does.
 2014-07-14 09:12:00 +08:00
Kevin Ballard
dcc043df3b Add an optional mode to env_get_string() 
The mode restricts the scope in which the variable is searched for.

Use this new restricted scope functionality in the `set` builtin. This
fixes `set -g` to not show local shadowing variable values, and also
allows for scoped erasing of slices.
 2014-07-12 15:35:34 -07:00
Kevin Ballard
8c89e6bce5 Fix typo and tweak set docs 
Move the docs for the `-n` flag to `set` out of the list of scopes.
 2014-07-12 00:21:04 -07:00
ridiculousfish
3bc2dda00d Merge branch 'death_of_fishd' 
Incorporates more removal and cleanup of fishd remnants.
 2014-06-18 11:19:28 -07:00
David Adam
f4bc1ef4a2 docs: clarify fish_greeting function and variable in FAQ 
Tidy fish_greeting section in main documentation.

Closes #1506.
 2014-06-18 17:29:59 +08:00
ridiculousfish
be3e64e5ea Remove fishd.cpp source, docs, and target from Makefile and Xcode 
project
 2014-06-05 11:49:05 -07:00
Alan Thompson
07944cfd20 Change terminology in docs from 'environment variables' -> 'shell variables' 2014-04-29 07:27:56 +02:00
David Adam
ba1b5e34a7 Check effective credentials of socket peers 
Fix for CVE-2014-2905.

Code for getpeereid() on non-BSD systems imported from the PostgreSQL
project under a BSD-style license.

Closes #1436
 2014-04-28 10:41:27 +08:00
ridiculousfish
aabed8279e Incorporate a modified UTF8 <-> wchar_t implementation from Alexey 
Vatchenko (http://www.bsdua.org/libbsdua.html) in preparation for
eliminating our dependency on iconv
 2014-03-22 23:46:58 -07:00
ridiculousfish
acd2038407 Remove old pager remnants, including documentation and references in the 
build system
 2014-03-15 14:24:05 -07:00
David Adam
3678f134d9 document Alt-F as well for accepting part of autosuggestion 
Closes #1290.
 2014-02-10 17:28:47 +08:00
David Adam
c168e6f870 Documented Alt-Right to accept a single word of an autosuggestion 
See https://github.com/fish-shell/fish-shell/issues/1262
 2014-02-02 21:45:03 +08:00
Geoff Nixon
60808a4820 Enhance/fix isatty using command test. 
Presently, `isatty` only works on a handful of keywords. Here it
  is rewritten to be able to take any path, device or fd number as
  an argument, and eliminates errors printed to stdout.
  Per discussion in #1228, using `builtin test -c` within a pipe to
  test special file descriptors is not viable, so this implementation
  specifcially uses `command test`. Additionally, a note has been
  added to the documentation of `test` regarding this potential
  aberration from the expected output of the test utility under the
  'Standards' section.
 2014-01-28 11:14:54 -08:00
ridiculousfish
32054b6f32 Implement and document new -P / --paging-mode flags to commandline, to support new 
pager
 2014-01-17 12:53:01 -08:00
Сергей Романов
d20f45b949 fix two minor typos in tutorial 2014-01-08 20:09:32 +03:00
Konrad Borowski
602f040940 Update Free Software Foundation address. 
Fixes #1184.
 2013-12-13 21:51:52 +01:00
Thomas Cort
0ec97c5d1e doc_src/eval.txt: fix typo. 
'folloing' => 'following'
 2013-12-10 19:09:32 +01:00
David Adam
63d93a2f9a document new F1 binding 2013-11-09 20:12:53 +08:00
Antoine Gourlay
4dc40b83e4 Fix broken links in tutorial 2013-10-31 16:37:11 +01:00
David Adam
edc4614e63 add completions for source and document the move away from '.' 
Closes: #310
 2013-10-28 23:33:24 +08:00
Konrad Borowski
553eb6ed40 Document appending / feature. 2013-10-06 14:17:33 +02:00
ridiculousfish
fab7299d49 Replace nextd/prevd <pre>s with \code 2013-10-05 12:13:16 -07:00
ridiculousfish
ad5ae9ba3b New documentation UI, including tutorial. 2013-10-05 00:37:44 -07:00
ridiculousfish
6c70ed79ae Update docs to describe autosuggestions. Fixes #937 2013-09-30 11:45:54 -07:00
Siteshwar Vashisht
0d2af9e742 Updated help text of fish_config command 2013-09-28 17:22:46 +05:30
David Adam (zanchey)
1565f9d9c3 fix typo introduced in b56542a9f 
Thanks to @siteshwar for spotting.

b56542a9f1 (commitcomment-4083982)
b56542a9f1 (commitcomment-4083982)
 2013-09-13 13:43:36 +08:00
David Adam (zanchey)
b56542a9f1 document new bindings introduced in cd1c2f74d3 2013-09-13 11:59:03 +08:00
David Adam (zanchey)
1442a2abe8 test documentation: update wording, generate test manual page (closes #734) 2013-09-13 11:59:03 +08:00
Tony Wang
1d67d8ff23 add -O and -G to test command 
they are available on Linux and OS X, and now ported to fish
 2013-08-25 15:54:06 -07:00
Mikko Viitamäki
6ec4591f02 fixing small typo 2013-08-16 11:45:15 +03:00
Konrad Borowski
679ef95257 Document source command. 2013-08-14 18:55:15 +03:00
David Adam (zanchey)
ed8ff85d2a accidentally reopened #943, fixed now 2013-08-07 11:26:57 +08:00
David Adam (zanchey)
b482cab7be docs: add editor documentation, move binding information 
closes #931
also fixes a crossreference error
 2013-08-07 11:23:17 +08:00
Gennadiy Zlobin
6f3d7209c2 Fixes broken link in docs. Fixes #943 2013-08-04 14:53:00 +04:00
David Adam (zanchey)
27d84ef8be documentation for test and function (closes: #734) 
plus speling in documentation for bind.
Note that this commit does not re-enable the generation of the manpage for
test, which will therefore still fall through to the system manual page with
`man test`.
 2013-07-29 16:07:00 +08:00
Konrad Borowski
07b7a65b86 Update documentation for $fish_user_paths 2013-06-22 17:22:05 +02:00
David Adam (zanchey)
8214ae9b15 docs: remove translation instructions 
(Moved to https://github.com/fish-shell/fish-shell/wiki/Translations)
 2013-06-05 16:00:08 +08:00
Dennis Ideler
2eb97edf02 Fix typo 
Remove extra instance of "builtin commands", shouldn't be there.
 2013-05-25 01:00:37 -07:00
David Adam (zanchey)
2ef9126744 FAQ: address local variable/env usage 2013-05-24 23:02:29 -07:00
David Adam (zanchey)
1d2cd99e96 FAQ: add questions from beta site 2013-05-24 23:02:29 -07:00
ridiculousfish
7d9b0a00e4 Add note about uninstalling fish 2013-05-16 09:32:31 -07:00
David Adam (zanchey)
1287b9d823 Help cleanup 
Large list of changes, including formatting and typos for most commands.

More substantive changes have been made to alias, bind, block, break,
builtin, case, cd, commandline, count, else, emit, fish_config, funced,
function, functions, history, math, mimedb, nextd, not, popd, prevd,
pushd, pwd, random, read, set, set_color, switch, test, trap, type,
ulimit, umask, and while.
 2013-05-13 01:48:20 -07:00
David Adam (zanchey)
91aab03b90 Document that fish functions cannot be background 
(Documentation for #238, #563)
 2013-05-13 01:48:20 -07:00
David Adam (zanchey)
e921dc50e0 FAQ updates - implicit cd and autosuggestions 2013-05-13 01:48:20 -07:00
David Adam (zanchey)
dd6bb04ba7 documentation typos 2013-05-13 01:48:20 -07:00
Siteshwar Vashisht
d4c881791f Avoid generating man page and help section for printf (to fallback on system man page for printf) 2013-05-05 14:59:34 +05:30
Siteshwar Vashisht
516be01366 Added documentation for printf 
Fix for https://github.com/fish-shell/fish-shell/issues/488
 2013-05-05 12:27:38 +05:30
ridiculousfish
4a4f8ec523 Clarify "input/output methods" in documentation 2013-05-04 11:53:50 -07:00
ridiculousfish
0c004147c0 Merge branch 'zanchey-docs' 
Conflicts:
	doc_src/index.hdr.in
 2013-05-04 11:47:07 -07:00
ridiculousfish
451eb13e0e Add a note about getting help through man pages 2013-05-04 11:43:15 -07:00
Kurtis Nusbaum
4e84cf1d38 Fixed small typo 
Fixed a small typo that I noticed in the design docs.
Pretty sure it was meant to say "turned off" instead
of "turned of".
 2013-05-01 18:37:52 -05:00
Eivind Uggedal
72b7e64ad8 Tiny typo. 2013-05-01 12:27:55 +02:00
David Adam
c3690b0878 index.hdr.in: slightly more controversial changes 
- Clarify wording in functions section
 - Use the term aliases rather than wrappers
 - Clarification of concepts and better? examples in variable expansion
 - Likewise in environment variables
 - Using the phrase builtin commands rather than builtins
 - Tidy up keybindings a bit
 - Another example in the history section
 - Remove TODO section in favour of mailing list, GitHub and IRC link
 2013-04-30 18:24:23 +08:00
David Adam
b3f248fd19 index.hdr.in: (hopefully) non-controversial edits 2013-04-30 18:24:23 +08:00
David Adam
d4686e6a59 index.hdr.in: add code markup 2013-04-30 18:09:34 +08:00
David Adam
14af6ba2af status command: improve help text 2013-04-29 13:46:00 +08:00
David Adam
c3ee3af201 miscellaneous typos 2013-04-29 13:45:48 +08:00
ridiculousfish
74ef1bc8ff Fix typos in count documentation 2013-04-28 15:59:21 -07:00
Eivind Uggedal
26eeb9f37a Fix broken sentence in the Job Control section of the user doc. 2013-04-28 14:51:13 -07:00
Steven Fackler
03c1f2ef5b Some documentation cleanup 2013-04-21 21:36:48 -04:00
Dmitry Chestnykh
c54097af20 Fix typo in docs 2013-04-20 13:30:40 -07:00
nmeum
24afe544a3 Typos 2013-04-14 12:19:56 +05:30
ridiculousfish
3d7ff9f758 Remove "law of minimalism" since echo is now a builtin and we're pretty clearly prioritizing performance over modularity. 
https://github.com/fish-shell/fish-shell/issues/612
 2013-04-13 23:13:18 -07:00
nmeum
7f6f0ca103 Fixed a typo 
It should be 'directory' not 'direcotry'
 2013-04-13 22:38:29 +02:00
Kenneth Vestergaard
6a97b45ad1 Add note to docs. 2013-03-10 14:24:16 -07:00
ridiculousfish
b2012467b3 Document -e and -E flags for echo, and provide some examples 2013-03-05 17:37:44 -08:00
ridiculousfish
85a5319c4b Add some examples to set_color 2013-03-04 12:05:21 -08:00
Daniel James
6ca11044a4 Remove -v flag from set_color synopsis. 
The -v documentation was removed when set_color was made a builtin, but wasn't removed from the synopsis.
 2013-03-04 11:33:50 -08:00
Jacob Johnson
1b0e4a0067 Update doc_src/contains.txt 
Escaped the $
 2013-02-20 17:17:53 -08:00
ridiculousfish
d3e9183303 Add a note to the documentation about fish_user_paths 2013-02-19 18:05:20 -08:00
ridiculousfish
8d95d0834d First stab at builtin set_color. Moved set_color.cpp to builtin_set_color.cpp and taught fish about it. 2013-02-14 15:52:24 -08:00
ridiculousfish
ad8d68dd43 Make subcommands modify $status, and make builtin_set not modify status unless it fails 
https://github.com/fish-shell/fish-shell/issues/547
https://github.com/fish-shell/fish-shell/issues/214
 2013-01-31 15:57:08 -08:00
ridiculousfish
91bf41cfce Document new MAC address behavior 2013-01-08 02:43:14 -08:00
Jan Kanis
a4c646f75c make 'alias' check for recursive calls and insert 'command'; update docs, fix #486 2013-01-01 22:56:08 +01:00
Jan Kanis
808fac9b14 document set -L/--long option 2012-12-29 11:56:11 -08:00
Jan Kanis
737972be2f clarify docs on variable scope in functions 2012-12-29 11:56:10 -08:00
ridiculousfish
489366290a Re-point some URLs at the fish homepage fishshell.com 2012-12-27 02:17:14 -08:00
Jan Kanis
af3059ab2a Allow 'emit' to accept event arguments 2012-12-20 16:13:00 +01:00
ridiculousfish
2628da4a59 Removed some debugging code used in determining autosuggestion truncation 
Fixed a busted link in the function doc
 2012-12-11 14:44:41 -08:00
ridiculousfish
90495f3ac5 Implement new newline-escaping behavior. Backslashes at the end of lines now essentially delete the newline, within normal text or double quotes. Backslashes are retained within single quotes. 
Fixes https://github.com/fish-shell/fish-shell/issues/347
Fixes https://github.com/fish-shell/fish-shell/issues/52
 2012-11-22 01:09:07 -08:00
David Adam (zanchey)
be5fde9e54 test documentation - format examples properly 2012-11-08 10:08:06 -08:00
David Adam (zanchey)
abfc7e16a1 test documentation - correct argument listing 2012-11-08 10:08:06 -08:00
ridiculousfish
d76f880faf Support for fish_right_prompt 
Fixes https://github.com/fish-shell/fish-shell/issues/80
 2012-11-07 19:59:20 -08:00
Nate Soares
f310f1e96c keybindings → key_bindings (for consistency) 2012-10-20 12:15:49 -07:00
ridiculousfish
14bf057c62 Remove bogus path from example of "." (source) command 
https://github.com/fish-shell/fish-shell/issues/297
 2012-10-04 14:57:23 -07:00
ridiculousfish
1a59346b51 Changed "elseif" to "else if" 2012-09-03 13:24:01 -07:00
ridiculousfish
de5223db66 Improve documentation and error reporting for elseif. 2012-09-01 02:14:13 -07:00
Rubycut
1b8f1650dc explain how to load binds automatically 2012-08-04 11:32:04 -07:00
Anders Bergh
13b1b73c15 Replaced references to http://fishshell.org/ with http://ridiculousfish.com/shell/. 2012-08-01 18:09:50 +02:00
maxfl
81e0342bf6 index range doc 2012-07-24 03:56:34 +05:30
ridiculousfish
8643870822 Tweaked fish_prompt document in a way I hope clarifies it 2012-07-13 21:32:50 -07:00
Dario Bertini
6819696222 Added small note to the fish_prompt doc 2012-07-12 14:52:15 -07:00
ridiculousfish
193bbd4e00 Tweaked pwd note about symbolic links 2012-07-12 14:48:51 -07:00
Dario Bertini
1bf168348e Added doc for pwd 2012-07-12 14:45:37 -07:00
maxfl
0c03b6ddc7 Allow 'contains' builtin to return index 
Add an option -i/--index to the contains builtin to print the index
of first coincidence.
 2012-07-10 16:21:00 -07:00
maxfl
76e1cda495 Set single-line default prompt 
Fish now doesn't join the fish_prompt output. This breaks the default
fish_prompt. Make default fish_prompt single-line. Fixes #203.

Add -l flag to 'read' documentation. Remove ambiguous '-x' description.
Fixes #157.
 2012-07-07 23:34:16 -07:00
Sean DuBois
c45479a6e5 Created the man page for echo and test 2012-07-06 14:41:44 -07:00
maxfl
fe26284376 Doc is updated 
btw. funced completion is updated
 2012-07-01 14:20:43 -07:00
maxfl
a02aa7a316 Step coloring for fish_pager introduces new variable 
fish_pager_color_secondary to set background of every second completion
line. It simplifies finding the options corresponding to given
description. Default color is 151515.
 2012-06-29 18:53:22 -07:00
ridiculousfish
3ab26a5d40 Updated funced documentation to reflect new behavior 2012-06-29 18:41:37 -07:00
maxfl
85f19f9b8c Add -e option to funced 
New option -e or --editor allows to edit function inside external
editor, rather than in reader.
 2012-06-29 16:42:34 -07:00
David Adam (zanchey)
08e78e63cf docs: fix percentage sign escape character 
(Patch taken from Debian packaging.)
 2012-06-18 14:01:22 -07:00
Siteshwar Vashisht
25f9105a97 Made history --help show history man page and history is now saved only once while deleting items 2012-06-12 14:20:07 +05:30
Torsten Grust
aad27a7a68 Fixed closing <pre> tag 
- Was an opening tag, should have been a closing tag
- Confused Doxygen 1.8.1.1 on my machine (OS X 10.7), resulting in the fish man pages not being installed at all
 2012-06-11 13:46:47 +02:00
Siteshwar Vashisht
ec34f2527a Adding history builtin 2012-06-05 09:54:42 +05:30
ridiculousfish
4edfd6d9d6 Update set_color documentation 2012-05-25 02:14:26 -07:00
ridiculousfish
8351ec0afd Document some of the new commands 2012-05-25 02:07:21 -07:00
Jakukyo Friel
cde6067cae minor changes on user doc 2011-02-20 02:58:11 +08:00
James Vega
9f3a4d1640 Fix some spelling mistakes 
Fix spelling mistakes in various bits of the documentation.

Signed-off-by: James Vega <jamessan@debian.org>
Signed-off-by: Grissiom <chaos.proton@gmail.com>
 2010-11-23 23:50:49 +08:00
Grissiom
1b9dd0c75f Merge remote branch 'origin/otherchirps-dev' 2010-09-19 14:12:30 +08:00
Grissiom
70322077d2 remove trialing spaces #2 2010-09-18 10:18:26 +08:00
Christopher Nilsson
ec8b3593f3 added '-c' option to the functions.txt docs. 2010-09-12 20:29:34 +10:00
axel
e50d0c18b0 Update todo list 
darcs-hash:20090308142007-ac50b-22e9cc31212ff9647f75426327cdf5aff2d30f79.gz
 2009-03-09 00:20:07 +10:00
axel
d5320fb9f9 Update copyright info, minor layout changes to section about licenses in fish 
darcs-hash:20090222224540-ac50b-69c4f8dd027e4672b8d25f8240c1d5f625135ad1.gz
 2009-02-23 08:45:40 +10:00
axel
f71c6f3f0e Misc documentation updates 
darcs-hash:20090222191714-ac50b-fdd090aafd60f71989ef5c63aac9f876dcad93eb.gz
 2009-02-23 05:17:14 +10:00
axel
f5be301a2f Handle exit status of processes terminated by signals 
darcs-hash:20090221164656-ac50b-7bcbf6cb0bb8384560fbf9bf1059480cb4089def.gz
 2009-02-22 02:46:56 +10:00
axel
972f3e121e Document rename of save_function to func_save. Pointed out by Ovchinnikov George 
darcs-hash:20090218202037-ac50b-0351e8564d3274cd4fb364c07b4a3260f8a45f20.gz
 2009-02-19 06:20:37 +10:00
axel
0dd8ae4843 Added faw entry on history editing, written by Beni Cherniavsky 
darcs-hash:20090216211940-ac50b-4175fb2ae8ec2f5a67ac3c6a33a48bc5ac35eea2.gz
 2009-02-17 07:19:40 +10:00
axel
07717a3570 Add possibility to define greeting function, suggested by Chris Miller 
darcs-hash:20090216210450-ac50b-9b4f7c5bf45afaf21d51e46ff8c2b11d171fcbf2.gz
 2009-02-17 07:04:50 +10:00
Isaac Dupree
9b95dda6bf fix help for open 
darcs-hash:20080605192305-6c1c4-ccf59a87bf7197b5d07a33d7aaeb31638aa0aa52.gz
 2008-06-06 05:23:05 +10:00
Ori Avtalion
e73c2be216 Add missing commas, letters and \c in the documentation 
darcs-hash:20080210210053-57fc3-f7e03b3fca9dff8bdc02256dfb78478b68945015.gz
 2008-02-11 07:00:53 +10:00
liljencrantz
0ad64ad2e4 Improve documentaion for bind builtin, clarify how to specify key sequences. 
darcs-hash:20080119003820-75c98-b1f9360ddab9206a1cdf77b94ce28e9978badb53.gz
 2008-01-19 10:38:20 +10:00
liljencrantz
0de629e009 Fix spelling in docs and add a help page for the funced builtin. These changes where suggested by Emanuele Rusconi. 
darcs-hash:20080118155413-75c98-eadff877b3af3c3271b098903f80a45082111424.gz
 2008-01-19 01:54:13 +10:00
liljencrantz
88a2b622df Add more documentation on events 
darcs-hash:20080116222531-75c98-ef30dabc492d7883dbb620c40ef95152469057a3.gz
 2008-01-17 08:25:31 +10:00
James Vega
e510d10c77 Fixed various spelling errors. 
darcs-hash:20080113200151-35ec8-c587f020aec07a5e613068677bd3dd4f5c6189ac.gz
 2008-01-14 06:01:51 +10:00
liljencrantz
22472ea980 Update todo list 
darcs-hash:20080113011617-75c98-8a3bcc0b4a2c58e5f2b13c51f372e7349ffec32d.gz
 2008-01-13 11:16:17 +10:00
liljencrantz
2229fad410 Fix bug in return and block builtins - they where unable to handle functions that do not shadow the calling scope 
darcs-hash:20080109030136-75c98-05f7a48cd991ac24e15d7e8b580caef0396ff59c.gz
 2008-01-09 13:01:36 +10:00
liljencrantz
8e9384e2e8 Update todo list again. :-) 
darcs-hash:20080109020655-75c98-9255c6c2287859211af77869fe2eb77543390c03.gz
 2008-01-09 12:06:55 +10:00
liljencrantz
394776c56b Update todo list and code comments 
darcs-hash:20080109012338-75c98-745297861fd11ec82e062a79fe1d15c9084342f1.gz
 2008-01-09 11:23:38 +10:00
liljencrantz
cb59da7a6f Fix typo in docs on exporting rules. This issue was pointed out by Isaac Dupree. 
darcs-hash:20080108213600-75c98-b68f1bc3846ca7050955ee0f133acd20282cb908.gz
 2008-01-09 07:36:00 +10:00
liljencrantz
bdec900aca Minor doc updates 
darcs-hash:20080108210918-75c98-7510c066f74a2c3f4bf60bda84237adcef2ca276.gz
 2008-01-09 07:09:18 +10:00
liljencrantz
063c4d7e67 Add comment on CDPATh being a universal variable after comments from Isac Dupree. 
darcs-hash:20080107235427-75c98-3f56a4f450bb9beb66c9949c9313a1991754d8fb.gz
 2008-01-08 09:54:27 +10:00
liljencrantz
30cfa2a445 Add explanation to csh versus sh variable naming in docs. 
darcs-hash:20080108194127-75c98-b44c6f18607cf270fae16179cd0df3e84f980b91.gz
 2008-01-09 05:41:27 +10:00
liljencrantz
71c2cde390 Cleanup and improve the exit status numbers and the messages generated on error as well as make sure that keyboard shortcuts don't change the status 
darcs-hash:20080108193145-75c98-56c8aa2dd081af643d206820aa36bf3b6e49e0f2.gz
 2008-01-09 05:31:45 +10:00
liljencrantz
a52bd219b9 Remove lots of things from the todo which have been implemented 
darcs-hash:20071028190344-75c98-9ccc5b5dab1f788c5179d5a527e6823d207f832e.gz
 2007-10-29 05:03:44 +10:00
liljencrantz
175dd75a3d Tiny touchups of docs and code 
darcs-hash:20071006105527-75c98-339c5d7ec2fbae0c2d4dc93552db85c389971a6a.gz
 2007-10-06 20:55:27 +10:00
liljencrantz
713c84d821 Make the . builtin have a more useful (and posix-compatible) exit status 
darcs-hash:20071005145808-75c98-17100c1e321b8bca06f75e900db1386451232f98.gz
 2007-10-06 00:58:08 +10:00