b142262cf7
Add missing muParser dependencies and link steps. Fixes #4379 |
||
---|---|---|
.github | ||
build_tools | ||
debian | ||
doc_src | ||
etc | ||
fish.xcodeproj | ||
m4 | ||
muparser-2.2.5 | ||
osx | ||
pcre2-10.22 | ||
po | ||
share | ||
src | ||
tests | ||
.clang-format | ||
.cppcheck.rules | ||
.cppcheck.suppressions | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.oclint | ||
.travis.yml | ||
CHANGELOG.md | ||
config.guess | ||
config.sub | ||
configure.ac | ||
CONTRIBUTING.md | ||
COPYING | ||
Dockerfile | ||
Doxyfile | ||
Doxyfile.help | ||
Doxyfile.user | ||
fish.pc.in | ||
fish.spec.in | ||
install-sh | ||
lexicon_filter.in | ||
Makefile.in | ||
README.md |
fish - the friendly interactive shell
fish is a smart and user-friendly command line shell for macOS, 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 https://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 https://fishshell.com/docs/current/index.html
Getting fish
macOS
fish can be installed:
- using Homebrew:
brew install fish
- using MacPorts:
sudo port install fish
- using the installer from fishshell.com
- as a standalone app from fishshell.com
Packages for Linux
Packages for Debian, Fedora, openSUSE, and Red Hat Enterprise Linux/CentOS are available from the openSUSE Build Service.
Packages for Ubuntu are available from the fish PPA, and can be installed using the following commands:
sudo apt-add-repository ppa:fish-shell/release-2
sudo apt-get update
sudo apt-get install fish
Instructions for other distributions may be found at fishshell.com.
Windows
fish can be installed using Cygwin Setup (under the Shells category).
fish can be installed into Windows Services for Linux using the instructions under Packages for Linux for the appropriate image (eg Ubuntu).
Building from source
If packages are not available for your platform, GPG-signed tarballs are available from fishshell.com and fish-shell on GitHub.
See the Building section for instructions.
Running fish
Once installed, run fish
from your current shell to try fish out!
Dependencies
Running fish requires:
- a curses implementation such as ncurses (libraries and the
tput
command) - PCRE2 library - a copy is included with fish
- MuParser library - a copy is included with fish
- gettext (library and
gettext
command), if compiled with translation support - basic system utilities including
basename
,cat
,cut
,date
,dircolors
,dirname
,ls
,mkdir
,mkfifo
,mktemp
,rm
,seq
,sort
,stat
,stty
,tail
,tr
,tty
,uname
,uniq
,wc
, andwhoami
- a number of common UNIX utilities:
awk
find
grep
hostname
kill
ps
sed
The following optional features also have specific requirements:
- builtin commands that have the
--help
option or print usage messages requirenroff
andul
(manual page formatters) to do so - completion generation from manual pages requires Python 2.7, 3.3 or greater, and possibly the
backports.lzma
module for Python 2.7 - the
fish_config
Web configuration tool requires Python 2.7, 3.3 or greater, and a web browser - system clipboard integration (with the default Ctrl-V and Ctrl-X bindings) require either the
xsel
orpbcopy
/pbpaste
utilities - prompts which support showing VCS information (Git, Mercurial or Subversion) require these utilities
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.
Building
Dependencies
Compiling fish requires:
- a C++11 compiler (g++ 4.8 or later, or clang 3.3 or later)
- either GNU Make (all platforms) or Xcode (macOS only)
- a curses implementation such as ncurses (headers and libraries)
- PCRE2 (headers and libraries) - a copy is included with fish
- MuParser (headers and libraries) - a copy is included with fish
- gettext (headers and libraries) - optional, for translation support
Compiling from git (that is, not a released tarball) also requires:
- either Xcode (macOS only) or the following Autotools utilities (all platforms):
- autoconf 2.60 or later
- automake 1.13 or later
- Doxygen (1.8.7 or later) - optional, for documentation
Autotools Build
autoreconf --no-recursive [if building from Git]
./configure
make [gmake on BSD]
sudo make install [sudo gmake install on BSD]
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 /
sudo make install-doc
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
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 for questions related to fish script and the fish tag on Superuser for all other questions (e.g., customizing colors, changing key bindings).
Found a bug? Have an awesome idea? Please open an issue on this github page.