Commit Graph

429 Commits

Author SHA1 Message Date
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