Commit Graph

94 Commits

Author SHA1 Message Date
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
66ccae4bfe Consistency fixes 2014-08-26 19:19:24 +01: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
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
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
ridiculousfish
0daee33ad6 Document new fish_title behavior per #334 2014-08-03 00:00:26 -07:00
Mark Griffiths
8ca88f14f7 Style fix for sub-line comments 2014-08-02 17:11:00 +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
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
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
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
Alan Thompson
07944cfd20 Change terminology in docs from 'environment variables' -> 'shell variables' 2014-04-29 07:27:56 +02: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
David Adam
63d93a2f9a document new F1 binding 2013-11-09 20:12:53 +08: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
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)
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
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
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)
dd6bb04ba7 documentation typos 2013-05-13 01:48:20 -07:00
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
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
c3ee3af201 miscellaneous typos 2013-04-29 13:45:48 +08:00
Eivind Uggedal
26eeb9f37a Fix broken sentence in the Job Control section of the user doc. 2013-04-28 14:51:13 -07:00
Dmitry Chestnykh
c54097af20 Fix typo in docs 2013-04-20 13:30:40 -07:00
Kenneth Vestergaard
6a97b45ad1 Add note to docs. 2013-03-10 14:24:16 -07:00
ridiculousfish
d3e9183303 Add a note to the documentation about fish_user_paths 2013-02-19 18:05:20 -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
737972be2f clarify docs on variable scope in functions 2012-12-29 11:56:10 -08:00