No description
Find a file
Fredrik Fornwall fe8727fb71 Fix building on Android by avoiding getpwent() (#3441)
* Fix building on Android by avoiding getpwent() if missing with autoconf check

The getpwent() function does not link when building for Android,
and user names on that platform are not interesting anyway.
2016-10-15 17:20:53 -07:00
.github Update issue template 2016-09-06 03:58:06 -07:00
build_tools do not restyle all fish scripts 2016-10-04 19:48:40 -07:00
debian debian packaging: unbreak build 2016-10-02 18:35:23 +08:00
doc_src docs: Correct history path. 2016-10-15 19:50:23 +02:00
etc It's status --is-interactive (#3086) 2016-05-29 12:24:24 +02:00
fish.xcodeproj Update Xcode project version to 0800 2016-10-01 16:53:53 -07:00
osx Update osx/config.h 2016-10-07 15:26:34 -07:00
pcre2-10.21 Let git normalize line-endings upon commit (LF) 2016-08-01 04:38:08 -07:00
po fix handling input in the C locale 2016-08-12 20:33:43 -07:00
share fix interactive deletion of "all" items 2016-10-11 19:05:23 -07:00
src Fix building on Android by avoiding getpwent() (#3441) 2016-10-15 17:20:53 -07:00
tests eliminate many "unused parameter" warnings 2016-10-09 14:38:26 -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
.editorconfig Added .editorconfig file (#3332) (#3313) 2016-08-24 22:00:53 -07:00
.gitattributes .gitignore additions & fixes 2016-08-10 17:00:47 -07:00
.gitignore .gitignore additions & fixes 2016-08-10 17:00:47 -07:00
.oclint a couple more oclint RAII error suppressions 2016-07-20 23:05:08 -07:00
.travis.yml Travis: clang 3.5.0 on Linux 2016-06-14 15:05:50 -07:00
CHANGELOG.md Update CHANGELOG with merges 2016-08-27 20:25:48 +02: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 Fix building on Android by avoiding getpwent() (#3441) 2016-10-15 17:20:53 -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 Silence the Makefile build 2016-07-31 12:24:35 -07:00
Doxyfile.user Silence the Makefile build 2016-07-31 12:24:35 -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 install-sh 2016-09-09 01:24:24 -07:00
lexicon_filter.in Fix documentation 2016-07-16 20:22:41 -07:00
Makefile.in Don't show all the help input files on build 2016-10-03 14:35:14 -07:00
README.md Nobody really "needs" backports.lzma 2016-08-19 10:22:05 -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.

Usage output for builtin functions is generated on-demand from the installed manpages using nroff and ul.

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. To process lzma-compresed manpages, backports.lzma is needed for Python 3.2 or older. 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.

You may need to logout/login for the change (chsh) to take effect.

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.