No description
Find a file
Mark Griffiths b2be50f081 Fix documentation
Restores erroneous changes to lexicon_filter and changes to doc_src/ pages. Done by hand to ensure version history.

Fixes display of % when misinterpreted by Doxygen.
2016-07-16 20:22:41 -07:00
.github Update ISSUE_TEMPLATE.md 2016-07-09 03:19:50 -07:00
build_tools Lossless recompress of images with pngcrush+zopfli 2016-07-01 14:58:56 -07:00
debian death of mimedb: remove mimedb from the tree 2015-07-23 14:35:35 +08:00
doc_src Fix documentation 2016-07-16 20:22:41 -07:00
etc It's status --is-interactive (#3086) 2016-05-29 12:24:24 +02:00
fish.xcodeproj Fix fish_config in .app 2016-07-01 04:43:57 -07:00
osx Merge branch 'Integration_2.3.1' 2016-07-03 22:18:55 +08:00
pcre2-10.21 Restore aclocal.m4 2016-07-05 07:58:00 -07:00
po trivial locale cleanups 2016-06-14 19:57:07 -07:00
share git completion: add --stat to show 2016-07-16 20:20:33 -07:00
src fish_indent --dump should deal with invalid code 2016-07-15 19:45:54 -07:00
tests don't print internal token in error message 2016-07-10 20:02:39 -07:00
.clang-format config clang-format to ignore oclint pragmas 2016-05-04 18:08:26 -07:00
.cppcheck.rule implement custom cppcheck rules 2016-06-17 20:16:21 -07:00
.gitattributes Tell Linguist about our vendored code. 2016-07-09 11:59:32 -07:00
.gitignore enhance the key_reader program 2016-06-19 19:43:45 -07:00
.oclint disable the oclint InvertedLogic rule 2016-05-22 20:21:04 -07:00
.travis.yml Travis: restore clang with trusty & included clang 2016-06-20 03:27:32 -07:00
CHANGELOG.md Merge branch 'Integration_2.3.1' 2016-07-03 22:18:55 +08:00
config.guess Update to latest config.sub and config.guess versions 2015-05-28 12:29:46 +08:00
config.sub Update to latest config.sub and config.guess versions 2015-05-28 12:29:46 +08:00
configure.ac remove dependency on dcgettext() 2016-06-05 18:52:19 -07:00
CONTRIBUTING.md implement custom cppcheck rules 2016-06-17 20:16:21 -07:00
COPYING Move LICENSE to COPYING and update text. 2014-10-24 17:40:35 +08:00
Dockerfile math requires bc package 2015-01-22 14:47:28 +08:00
Doxyfile Improve comments, update Doxyfile 2016-06-12 11:19:44 -07:00
Doxyfile.help update lexicon for latest docs 2016-04-04 15:23:56 -07:00
Doxyfile.user update lexicon for latest docs 2016-04-04 15:23:56 -07:00
fish.pc.in Rename "snippets" to "conf" internally, and document them as snippets 2016-04-06 09:33:09 +08:00
fish.spec.in fish.spec: hostname dependency for openSUSE 2016-04-28 08:20:58 +08:00
install-sh Update to newer install-sh version 2015-05-28 12:30:34 +08:00
lexicon_filter.in Fix documentation 2016-07-16 20:22:41 -07:00
Makefile.in don't let low level tests pollute user home dir 2016-07-15 16:08:35 -07:00
README.md add better support for IWYU and fix things 2016-04-26 15:02:22 -07:00

fish - the friendly interactive shell Build Status

fish is a smart and user-friendly command line shell for OS X, Linux, and the rest of the family. fish includes features like syntax highlighting, autosuggest-as-you-type, and fancy tab completions that just work, with no configuration required.

For more on fish's design philosophy, see the design document.

Quick Start

fish generally works like other shells, like bash or zsh. A few important differences can be found at http://fishshell.com/docs/current/tutorial.html by searching for the magic phrase "unlike other shells".

Detailed user documentation is available by running help within fish, and also at http://fishshell.com/docs/current/index.html

Building

Fish can be built using a C++11 environment but only requires C++03. It builds successfully with g++ 4.2 or later, and with clang. This allows fish to run on older systems such as OS X Snow Leopard (released in 2009).

Fish can be built using autotools or Xcode. autoconf 2.60 or later is required to build from git versions, but is not required for releases.

fish depends on a curses implementation, such as ncurses. The headers and libraries are required for building.

fish requires PCRE2 due to the regular expression support contained in the string builtin. A copy is included with the source code, and will be used automatically if it does not already exist on your system.

fish requires gettext for translation support.

Building the documentation requires Doxygen 1.8.7 or newer.

Autotools Build

autoconf [if building from Git]
./configure
make [gmake on BSD]
sudo make install

Xcode Development Build

  • Build the base target in Xcode
  • Run the fish executable, for example, in DerivedData/fish/Build/Products/Debug/base/bin/fish

Xcode Build and Install

xcodebuild install
sudo ditto /tmp/fish.dst /

Help, it didn't build!

If fish reports that it could not find curses, try installing a curses development package and build again.

On Debian or Ubuntu you want:

sudo apt-get install build-essential ncurses-dev libncurses5-dev gettext autoconf

On RedHat, CentOS, or Amazon EC2:

sudo yum install ncurses-devel

Runtime Dependencies

fish requires a curses implementation, such as ncurses, to run.

fish requires PCRE2 due to the regular expression support contained in the string builtin. A bundled version will be compiled in automatically at build time if required.

fish requires a number of utilities to operate, which should be present on any Unix, GNU/Linux or OS X system. These include (but are not limited to) hostname, grep, awk, sed, which, and getopt. fish also requires the bc program.

Translation support requires the gettext program.

Some optional features of fish, such as the manual page completion parser and the web configuration tool, require Python.

In order to generate completions from man pages compressed with either lzma or xz, you may need to install an extra Python package. Python versions prior to 2.6 are not supported. For Python versions 2.6 to 3.2 you need to install the module backports.lzma. How to install it depends on your system and how you installed Python. Most Linux distributions should include it as a package named backports-lzma (or similar). From version 3.3 onwards, Python already includes the required module.

Packages for Linux

Instructions on how to find builds for several Linux distros are at https://github.com/fish-shell/fish-shell/wiki/Nightly-builds

Switching to fish

If you wish to use fish as your default shell, use the following command:

chsh -s /usr/local/bin/fish

chsh will prompt you for your password, and change your default shell. Substitute "/usr/local/bin/fish" with whatever path to fish is in your /etc/shells file.

Use the following command if you didn't already add your fish path to /etc/shells.

    echo /usr/local/bin/fish | sudo tee -a /etc/shells

To switch your default shell back, you can run:

chsh -s /bin/bash

Substitute /bin/bash with /bin/tcsh or /bin/zsh as appropriate.

Contributing Changes to the Code

See the Guide for Developers.

Contact Us

Questions, comments, rants and raves can be posted to the official fish mailing list at https://lists.sourceforge.net/lists/listinfo/fish-users or join us on our gitter.im channel or IRC channel #fish at irc.oftc.net. Or use the fish tag on Stackoverflow.

Found a bug? Have an awesome idea? Please open an issue on this github page.