CHANGELOG: start 3.0.3 process

[ci skip]

.builds/alpine.yml

@@ -1,24 +0,0 @@
-image: alpine/edge
-packages:
-  - cmake
-  - ninja
-  - ncurses-dev
-  - pcre2-dev
-  - expect
-  - python
-sources:
-  - https://git.sr.ht/~faho/fish
-tasks:
-  - build: |
-          cd fish
-          mkdir build || :
-          cd build
-          cmake -G Ninja .. \
-          -DCMAKE_INSTALL_PREFIX=/usr \
-          -DCMAKE_INSTALL_DATADIR=share \
-          -DCMAKE_INSTALL_DOCDIR=share/doc/fish \
-          -DCMAKE_INSTALL_SYSCONFDIR=/etc
-          ninja
-  - test: |
-          cd fish/build
-          env SHOW_INTERACTIVE_LOG=1 ninja test

.builds/arch.yml

@@ -1,22 +0,0 @@
-image: archlinux
-packages:
-  - cmake
-  - ninja
-  - expect
-  - python
-sources:
-  - https://git.sr.ht/~faho/fish
-tasks:
-  - build: |
-          cd fish
-          mkdir build || :
-          cd build
-          cmake -G Ninja .. \
-          -DCMAKE_INSTALL_PREFIX=/usr \
-          -DCMAKE_INSTALL_DATADIR=share \
-          -DCMAKE_INSTALL_DOCDIR=share/doc/fish \
-          -DCMAKE_INSTALL_SYSCONFDIR=/etc
-          ninja
-  - test: |
-          cd fish/build
-          env SHOW_INTERACTIVE_LOG=1 ninja test

.builds/freebsd.yml

@@ -1,26 +0,0 @@
-image: freebsd/latest
-packages:
-  - ncurses
-  - gcc
-  - gettext
-  - expect
-  - cmake
-  - gmake
-  - pcre2
-  - python
-sources:
-  - https://git.sr.ht/~faho/fish
-tasks:
-  - build: |
-          cd fish
-          mkdir build || :
-          cd build
-          cmake .. \
-          -DCMAKE_INSTALL_PREFIX=/usr \
-          -DCMAKE_INSTALL_DATADIR=share \
-          -DCMAKE_INSTALL_DOCDIR=share/doc/fish \
-          -DCMAKE_INSTALL_SYSCONFDIR=/etc
-          gmake -j2
-  - test: |
-          cd fish/build
-          gmake test SHOW_INTERACTIVE_LOG=1

.clang-format

@@ -6,11 +6,5 @@
 BasedOnStyle: Google
 ColumnLimit: 100
 IndentWidth: 4
-
-# Place config.h first always.
-IncludeCategories:
-  - Regex: '^"config.h"'
-    Priority: -1
-
 # We don't want OCLint pragmas to be reformatted.
 CommentPragmas: '^!OCLINT'

.editorconfig

@@ -12,7 +12,7 @@ max_line_length = 100
 [{Makefile,*.in}]
 indent_style = tab
 
-[*.{md,rst}]
+[*.md]
 trim_trailing_whitespace = false
 
 [*.{sh,ac}]

.gitattributes

@@ -6,7 +6,6 @@
 # let git show off diff hunk headers, help git diff -L:
 # https://git-scm.com/docs/gitattributes
 *.cpp diff=cpp
-*.h diff=cpp
 *.py diff=py
 # add a [diff "fish"] to git config with pattern
 *.fish diff=fish
@@ -19,12 +18,12 @@
 /debian/* export-ignore
 /.github export-ignore
 /.github/* export-ignore
-/.builds export-ignore
-/.builds/* export-ignore
-/.travis.yml export-ignore
 
 # for linguist; let github identify our project as C++ instead of C due to pcre2
-/pcre2-10.32/* linguist-vendored
+/pcre2-10.22/ linguist-vendored
+/pcre2-10.22/* linguist-vendored
+/muparser-2.2.5/ linguist-vendored
+/muparser-2.2.5/* linguist-vendored
 angular.js linguist-vendored
 /doc_src/* linguist-documentation
 *.fish linguist-language=fish

.gitignore

@@ -38,6 +38,16 @@ Desktop.ini
 Thumbs.db
 ehthumbs.db
 
+
+# These file names can appear anywhere in the hierarchy. They tend to be OS
+# or build system artifacts.
+autom4te.cache
+aclocal.m4
+Makefile
+config.h
+config.cache
+config.h.in
+config.status
 messages.pot
 .directory
 .fuse_hidden*
@@ -45,6 +55,7 @@ messages.pot
 
 # Directories that only contain transitory files from building and testing.
 /doc/
+/obj/
 /share/man/
 /share/doc/
 /test/
@@ -56,6 +67,8 @@ messages.pot
 /command_list.txt
 /command_list_toc.txt
 /compile_commands.json
+/confdefs.h
+/configure
 /doc.h
 /fish
 /fish.pc
@@ -72,6 +85,7 @@ fish-build-version-witness.txt
 # from building and testing.
 /doc_src/commands.hdr
 /doc_src/index.hdr
+/pcre2-*/configure.lineno
 /po/*.gmo
 /share/__fish_build_paths.fish
 /share/pkgconfig

.travis.yml

@@ -1,5 +1,5 @@
 language: cpp
-dist: xenial
+dist: trusty
 sudo: required
 
 matrix:
@@ -9,63 +9,73 @@ matrix:
       addons:
         apt:
           packages:
+            - bc
             - expect
             - gettext
             - libncurses5-dev
-            - libpcre2-dev
-            - python
-      env:
-          # Some warnings upgraded to errors to match Open Build Service platforms
-          - CXXFLAGS="-Werror=address -Werror=return-type"
     - os: linux
       compiler: gcc
       addons:
         apt:
-          packages: # Don't use libpcre2-dev here, so that one build uses the vendored code
+          packages:
+            - bc
             - expect
             - gettext
             - lib32ncurses5-dev
             - g++-multilib
-            - python
       env:
-          - CXXFLAGS="-m32 -Werror=address -Werror=return-type" CFLAGS="-m32"
+          - CXXFLAGS="-g -O2 -m32" CFLAGS="-g -m32"
     - os: linux
       compiler: clang
-      env:
-          - CXXFLAGS="-fno-omit-frame-pointer -fsanitize=undefined -fsanitize=address"
-          - ASAN_OPTIONS=check_initialization_order=1:detect_stack_use_after_return=1:detect_leaks=1
-          - UBSAN_OPTIONS=print_stacktrace=1:report_error_type=1:suppressions=$TRAVIS_BUILD_DIR/build_tools/ubsan.blacklist
       addons:
         apt:
           packages:
+            - bc
             - expect
             - gettext
             - libncurses5-dev
-            - libpcre2-dev
-            - python
+            - cmake
+      env:
+        - USE_CMAKE="1" # Dummy value, shows up in the Travis UI only
+      script:
+        - cmake -DCMAKE_INSTALL_PREFIX=$HOME/prefix . || cat CMakeFiles/CMakeError.log &&
+          make -j2 &&
+          make install &&
+          make test SHOW_INTERACTIVE_LOG=1
     - os: linux
       compiler: clang
       env:
-          - CXXFLAGS="-fsanitize=thread"
+          - CXXFLAGS="-g -O2 -fno-omit-frame-pointer -fsanitize=address" ASAN_OPTIONS=check_initialization_order=1:detect_stack_use_after_return=1:detect_leaks=1
+      before_install: export CXX=clang++-3.8
       addons:
         apt:
+          sources:
+            - llvm-toolchain-precise-3.8
+            - ubuntu-toolchain-r-test
           packages:
+            - clang-3.8
+            - llvm-3.8 # for llvm-symbolizer
+            - bc
             - expect
             - gettext
             - libncurses5-dev
-            - libpcre2-dev
-            - python
     - os: osx
       before_install:
         - brew update
         - brew install pcre2 # use system PCRE2
+        - brew outdated xctool || brew upgrade xctool # for xcode... soon.
+      env:
+          - CXXFLAGS="-g -O2 -lstdc++"
   fast_finish: true
 
 script:
-  - cmake -DCMAKE_INSTALL_PREFIX=$HOME/prefix . || cat CMakeFiles/CMakeError.log &&
-    make -j2 &&
-    make install &&
-    make test SHOW_INTERACTIVE_LOG=1
+  - autoreconf --no-recursive
+  - ./configure --prefix=$HOME/prefix || cat config.log
+  - make -j2 &&
+    make test DESTDIR=$HOME/prefix/ SHOW_INTERACTIVE_LOG=1 &&
+    make uninstall &&
+    echo "Checking for leftover files after make uninstall" &&
+    find $HOME/prefix/ -type f -print -exec false '{}' +
 
 notifications:
   # Some items are encrypted so that notifications from other repositories

BSDmakefile

@@ -1,23 +1,15 @@
-# This is a very basic `make` wrapper around the CMake build toolchain.
-#
-# Supported arguments:
-#   PREFIX: sets the installation prefix
-#   GENERATOR: explicitly specifies the CMake generator to use
-
-# By default, bmake will try to cd into ./obj before anything else. Don't do that.
+# by default bmake will cd into ./obj first
 .OBJDIR: ./
 
-CMAKE?=cmake
-
-# Before anything else, test for CMake, which is the only requirement to be able to run
-# this Makefile CMake will perform the remaining dependency tests on its own.
 .BEGIN:
-	@which $(CMAKE) >/dev/null 2>/dev/null || \
-		(echo 'Please install CMake and then re-run the `make` command!' 1>&2 && false)
+	# test for cmake, which is the only requirement to be able to run this Makefile
+	# cmake will perform the remaining dependency tests on its own
+	@which cmake >/dev/null 2>/dev/null || (echo 'Please install cmake and then re-run the `make` command!' 1>&2 && false)
 
-# Prefer to use ninja, if it is installed
-_GENERATOR!=which ninja 2>/dev/null >/dev/null && echo Ninja || echo "Unix Makefiles"
+# Use ninja, if it is installed
+_GENERATOR!=which ninja 2>/dev/null >/dev/null && echo Ninja || echo "'Unix Makefiles'"
 GENERATOR?=$(_GENERATOR)
+PREFIX?=/usr/local
 
 .if $(GENERATOR) == "Ninja"
 BUILDFILE=build/build.ninja
@@ -25,20 +17,19 @@ BUILDFILE=build/build.ninja
 BUILDFILE=build/Makefile
 .endif
 
-PREFIX?=/usr/local
-
+.DEFAULT: build/fish
 build/fish: build/$(BUILDFILE)
-	$(CMAKE) --build build
+	cmake --build build
 
 build:
 	mkdir -p build
 
 build/$(BUILDFILE): build
-	cd build; $(CMAKE) .. -G "$(GENERATOR)" -DCMAKE_INSTALL_PREFIX="$(PREFIX)" -DCMAKE_EXPORT_COMPILE_COMMANDS=1
+	cd build; cmake .. -G $(GENERATOR) -DCMAKE_INSTALL_PREFIX=$(PREFIX) -DCMAKE_EXPORT_COMPILE_COMMANDS=1
 
 .PHONY: install
 install: build/fish
-	$(CMAKE) --build build --target install
+	cmake --build build --target install
 
 .PHONY: clean
 clean:
@@ -46,7 +37,7 @@ clean:
 
 .PHONY: test
 test: build/fish
-	$(CMAKE) --build build --target test
+	cmake --build build --target test
 
 .PHONY: run
 run: build/fish

CHANGELOG.md

@@ -1,228 +1,8 @@
-# fish 3.1.0 (released February 12, 2020)
+# fish 3.0.3 (released ???)
 
-Compared to the beta release of fish 3.1b1, fish version 3.1.0:
-- fixes a regression where spaces after a brace were removed despite brace expansion not occurring (#6564)
-- fixes a number of problems in compiling and testing on Cygwin (#6549) and Solaris-derived systems such as Illumos (#6553, #6554, #6555, #6556, and #6558); 
-- fixes the process for building macOS packages;
-- fixes a regression where excessive error messages are printed if Unicode characters are emitted in non-Unicode-capable locales (#6584); and
-- contains some improvements to the documentation and a small number of completions.
+This release of fish fixes a number of major issues since fish 3.0.2.
 
-If you are upgrading from version 3.0.0 or before, please also review the release notes for 3.1b1 (included below).
-
----
-
-# fish 3.1b1 (released January 26, 2020)
-
-## Notable improvements and fixes
-- A new `$pipestatus` variable contains a list of exit statuses of the previous job, for each of the separate commands in a pipeline (#5632).
-- fish no longer buffers pipes to the last function in a pipeline, improving many cases where pipes appeared to block or hang (#1396).
-- An overhaul of error messages for builtin commands, including a removal of the overwhelming usage summary, more readable stack traces (#3404, #5434), and stack traces for `test` (aka `[`) (#5771).
-- fish's debugging arguments have been significantly improved. The `--debug-level` option has been removed, and a new `--debug` option replaces it. This option accepts various categories, which may be listed via `fish --print-debug-categories` (#5879). A new `--debug-output` option allows for redirection of debug output.
-- `string` has a new `collect` subcommand for use in command substitutions, producing a single output instead of splitting on new lines (similar to `"$(cmd)"` in other shells) (#159).
-- The fish manual, tutorial and FAQ are now available in `man` format as `fish-doc`, `fish-tutorial` and `fish-faq` respectively (#5521).
-- Like other shells, `cd` now always looks for its argument in the current directory as a last resort, even if the `CDPATH` variable does not include it or "." (#4484).
-- fish now correctly handles `CDPATH` entries that start with `..` (#6220) or contain `./` (#5887).
-- The `fish_trace` variable may be set to trace execution (#3427). This performs a similar role as `set -x` in other shells.
-- fish uses the temporary directory determined by the system, rather than relying on `/tmp` (#3845).
-- The fish Web configuration tool (`fish_config`) prints a list of commands it is executing, to help understanding and debugging (#5584).
-- Major performance improvements when pasting (#5866), executing lots of commands (#5905), importing history from bash (#6295), and when completing variables that might match `$history` (#6288).
-
-### Syntax changes and new commands
-- A new builtin command, `time`, which allows timing of fish functions and builtins as well as external commands (#117).
-- Brace expansion now only takes place if the braces include a "," or a variable expansion, meaning common commands such as `git reset HEAD@{0}` do not require escaping (#5869).
-- New redirections `&>` and `&|` may be used to redirect or pipe stdout, and also redirect stderr to stdout (#6192).
-- `switch` now allows arguments that expand to nothing, like empty variables (#5677).
-- The `VAR=val cmd` syntax can now be used to run a command in a modified environment (#6287).
-- `and` is no longer recognised as a command, so that nonsensical constructs like `and and and` produce a syntax error (#6089).
-- `math`'s exponent operator, '`^`', was previously left-associative, but now uses the more commonly-used right-associative behaviour (#6280). This means that `math '3^0.5^2'` was previously calculated as '(3^0.5)^2', but is now calculated as '3^(0.5^2)'.
-- In fish 3.0, the variable used with `for` loops inside command substitutions could leak into enclosing scopes; this was an inadvertent behaviour change and has been reverted (#6480).
-
-### Scripting improvements
-- `string split0` now returns 0 if it split something (#5701).
-- In the interest of consistency, `builtin -q` and `command -q` can now be used to query if a builtin or command exists (#5631).
-- `math` now accepts `--scale=max` for the maximum scale (#5579).
-- `builtin $var` now works correctly, allowing a variable as the builtin name (#5639).
-- `cd` understands the `--` argument to make it possible to change to directories starting with a hyphen (#6071).
-- `complete --do-complete` now also does fuzzy matches (#5467).
-- `complete --do-complete` can be used inside completions, allowing limited recursion (#3474).
-- `count` now also counts lines fed on standard input (#5744).
-- `eval` produces an exit status of 0 when given no arguments, like other shells (#5692).
-- `printf` prints what it can when input hasn't been fully converted to a number, but still prints an error (#5532).
-- `complete -C foo` now works as expected, rather than requiring `complete -Cfoo`.
-- `complete` has a new `--force-files` option, to re-enable file completions. This allows `sudo -E` and `pacman -Qo` to complete correctly (#5646).
-- `argparse` now defaults to showing the current function name (instead of `argparse`) in its errors, making `--name` often superfluous (#5835).
-- `argparse` has a new `--ignore-unknown` option to keep unrecognized options, allowing multiple argparse passes to parse options (#5367).
-- `argparse` correctly handles flag value validation of options that only have short names (#5864).
-- `read -S` (short option of `--shell`) is recognised correctly (#5660).
-- `read` understands `--list`, which acts like `--array` in reading all arguments into a list inside a single variable, but is better named (#5846).
-- `read` has a new option, `--tokenize`, which splits a string into variables according to the shell's tokenization rules, considering quoting, escaping, and so on (#3823).
-- `read` interacts more correctly with the deprecated `$IFS` variable, in particular removing multiple separators when splitting a variable into a list (#6406), matching other shells.
-- `fish_indent` now handles semicolons better, including leaving them in place for `; and` and `; or` instead of breaking the line (#5859).
-- `fish_indent --write` now supports multiple file arguments, indenting them in turn.
-- The default read limit has been increased to 100MiB (#5267).
-- `math` now also understands `x` for multiplication, provided it is followed by whitespace (#5906).
-- `math` reports the right error when incorrect syntax is used inside parentheses (#6063), and warns when unsupported logical operations are used (#6096).
-- `functions --erase` now also prevents fish from autoloading a function for the first time (#5951).
-- `jobs --last` returns 0 to indicate success when a job is found (#6104).
-- `commandline -p` and `commandline -j` now split on `&&` and `||` in addition to `;` and `&` (#6214).
-- A bug where `string split` would drop empty strings if the output was only empty strings has been fixed (#5987).
-- `eval` no long creates a new local variable scope, but affects variables in the scope it is called from (#4443). `source` still creates a new local scope.
-- `abbr` has a new `--query` option to check for the existence of an abbreviation.
-- Local values for `fish_complete_path` and `fish_function_path` are now ignored; only their global values are respected.
-- Syntax error reports now display a marker in the correct position (#5812).
-- Empty universal variables may now be exported (#5992).
-- Exported universal variables are no longer imported into the global scope, preventing shadowing. This makes it easier to change such variables for all fish sessions and avoids breakage when the value is a list of multiple elements (#5258).
-- A bug where `for` could use invalid variable names has been fixed (#5800).
-- A bug where local variables would not be exported to functions has been fixed (#6153).
-- The null command (`:`) now always exits successfully, rather than passing through the previous exit status (#6022).
-- The output of `functions FUNCTION` matches the declaration of the function, correctly including comments or blank lines (#5285), and correctly includes any `--wraps` flags (#1625).
-- `type` supports a new option, `--short`, which suppress function expansion (#6403).
-- `type --path` with a function argument will now output the path to the file containing the definition of that function, if it exists.
-- `type --force-path` with an argument that cannot be found now correctly outputs nothing, as documented (#6411).
-- The `$hostname` variable is no longer truncated to 32 characters (#5758).
-- Line numbers in function backtraces are calculated correctly (#6350).
-- A new `fish_cancel` event is emitted when the command line is cancelled, which is useful for terminal integration (#5973).
-
-### Interactive improvements
-- New Base16 color options are available through the Web-based configuration (#6504).
-- fish only parses `/etc/paths` on macOS in login shells, matching the bash implementation (#5637) and avoiding changes to path ordering in child shells (#5456). It now ignores blank lines like the bash implementation (#5809).
-- The locale is now reloaded when the `LOCPATH` variable is changed (#5815).
-- `read` no longer keeps a history, making it suitable for operations that shouldn't end up there, like password entry (#5904).
-- `dirh` outputs its stack in the correct order (#5477), and behaves as documented when universal variables are used for its stack (#5797).
-- `funced` and the edit-commandline-in-buffer bindings did not work in fish 3.0 when the `$EDITOR` variable contained spaces; this has been corrected (#5625).
-- Builtins now pipe their help output to a pager automatically (#6227).
-- `set_color` now colors the `--print-colors` output in the matching colors if it is going to a terminal.
-- fish now underlines every valid entered path instead of just the last one (#5872).
-- When syntax highlighting a string with an unclosed quote, only the quote itself will be shown as an error, instead of the whole argument.
-- Syntax highlighting works correctly with variables as commands (#5658) and redirections to close file descriptors (#6092).
-- `help` works properly on Windows Subsytem for Linux (#5759, #6338).
-- A bug where `disown` could crash the shell has been fixed (#5720).
-- fish will not autosuggest files ending with `~` unless there are no other candidates, as these are generally backup files (#985).
-- Escape in the pager works correctly (#5818).
-- Key bindings that call `fg` no longer leave the terminal in a broken state (#2114).
-- Brackets (#5831) and filenames containing `$` (#6060) are completed with appropriate escaping.
-- The output of `complete` and `functions` is now colorized in interactive terminals.
-- The Web-based configuration handles aliases that include single quotes correctly (#6120), and launches correctly under Termux (#6248) and OpenBSD (#6522).
-- `function` now correctly validates parameters for `--argument-names` as valid variable names (#6147) and correctly parses options following `--argument-names`, as in "`--argument-names foo --description bar`" (#6186).
-- History newly imported from bash includes command lines using `&&` or `||`.
-- The automatic generation of completions from manual pages is better described in job and process listings, and no longer produces a warning when exiting fish (#6269).
-- In private mode, setting `$fish_greeting` to an empty string before starting the private session will prevent the warning about history not being saved from being printed (#6299).
-- In the interactive editor, a line break (Enter) inside unclosed brackets will insert a new line, rather than executing the command and producing an error (#6316).
-- Ctrl-C always repaints the prompt (#6394).
-- When run interactively from another program (such as Python), fish will correctly start a new process group, like other shells (#5909).
-- Job identifiers (for example, for background jobs) are assigned more logically (#6053).
-- A bug where history would appear truncated if an empty command was executed was fixed (#6032).
-
-#### New or improved bindings
-- Pasting strips leading spaces to avoid pasted commands being omitted from the history (#4327).
-- Shift-Left and Shift-Right now default to moving backwards and forwards by one bigword (words separated by whitespace) (#1505).
-- The default escape delay (to differentiate between the escape key and an alt-combination) has been reduced to 30ms, down from 300ms for the default mode and 100ms for Vi mode (#3904).
-- The `forward-bigword` binding now interacts correctly with autosuggestions (#5336).
-- The `fish_clipboard_*` functions support Wayland by using [`wl-clipboard`](https://github.com/bugaevc/wl-clipboard) (#5450).
-- The `nextd` and `prevd` functions no longer print "Hit end of history", instead using a bell. They correctly store working directories containing symbolic links (#6395).
-- If a `fish_mode_prompt` function exists, Vi mode will only execute it on mode-switch instead of the entire prompt. This should make it much more responsive with slow prompts (#5783).
-- The path-component bindings (like Ctrl-w) now also stop at ":" and "@", because those are used to denote user and host in commands such as `ssh` (#5841).
-- The NULL character can now be bound via `bind -k nul`. Terminals often generate this character via control-space. (#3189).
-- A new readline command `expand-abbr` can be used to trigger abbreviation expansion (#5762).
-- A new readline command, `delete-or-exit`, removes a character to the right of the cursor or exits the shell if the command line is empty (moving this functionality out of the `delete-or-exit` function).
-- The `self-insert` readline command will now insert the binding sequence, if not empty.
-- A new binding to prepend `sudo`, bound to Alt-S by default (#6140).
-- The Alt-W binding to describe a command should now work better with multiline prompts (#6110)
-- The Alt-H binding to open a command's man page now tries to ignore `sudo` (#6122).
-- A new pair of bind functions, `history-prefix-search-backward` (and `forward`), was introduced (#6143).
-- Vi mode now supports R to enter replace mode (#6342), and `d0` to delete the current line (#6292).
-- In Vi mode, hitting Enter in replace-one mode no longer erases the prompt (#6298).
-- Selections in Vi mode are inclusive, matching the actual behaviour of Vi (#5770).
-
-#### Improved prompts
-- The Git prompt in informative mode now shows the number of stashes if enabled.
-- The Git prompt now has an option (`$__fish_git_prompt_use_informative_chars`) to use the (more modern) informative characters without enabling informative mode.
-- The default prompt now also features VCS integration and will color the host if running via SSH (#6375).
-- The default and example prompts print the pipe status if an earlier command in the pipe fails.
-- The default and example prompts try to resolve exit statuses to signal names when appropriate.
-
-#### Improved terminal output
-- New `fish_pager_color_` options have been added to control more elements of the pager's colors (#5524).
-- Better detection and support for using fish from various system consoles, where limited colors and special characters are supported (#5552).
-- fish now tries to guess if the system supports Unicode 9 (and displays emoji as wide), eliminating the need to set `$fish_emoji_width` in most cases (#5722).
-- Improvements to the display of wide characters, particularly Korean characters and emoji (#5583, #5729).
-- The Vi mode cursor is correctly redrawn when regaining focus under terminals that report focus (eg tmux) (#4788).
-- Variables that control background colors (such as `fish_pager_color_search_match`) can now use `--reverse`.
-
-#### Completions
-- Added completions for
-  - `aws`
-  - `bat` (#6052)
-  - `bosh` (#5700)
-  - `btrfs`
-  - `camcontrol`
-  - `cf` (#5700)
-  - `chronyc` (#6496)
-  - `code` (#6205)
-  - `cryptsetup` (#6488)
-  - `csc` and `csi` (#6016)
-  - `cwebp` (#6034)
-  - `cygpath` and `cygstart` (#6239)
-  - `epkginfo` (#5829)
-  - `ffmpeg`, `ffplay`, and `ffprobe` (#5922)
-  - `fsharpc` and `fsharpi` (#6016)
-  - `fzf` (#6178)
-  - `g++` (#6217)
-  - `gpg1` (#6139)
-  - `gpg2` (#6062)
-  - `grub-mkrescue` (#6182)
-  - `hledger` (#6043)
-  - `hwinfo` (#6496)
-  - `irb` (#6260)
-  - `iw` (#6232)
-  - `kak`
-  - `keepassxc-cli` (#6505)
-  - `keybase` (#6410)
-  - `loginctl` (#6501)
-  - `lz4`, `lz4c` and `lz4cat` (#6364)
-  - `mariner` (#5718)
-  - `nethack` (#6240)
-  - `patool` (#6083)
-  - `phpunit` (#6197)
-  - `plutil` (#6301)
-  - `pzstd` (#6364)
-  - `qubes-gpg-client` (#6067)
-  - `resolvectl` (#6501)
-  - `rg`
-  - `rustup`
-  - `sfdx` (#6149)
-  - `speedtest` and `speedtest-cli` (#5840)
-  - `src` (#6026)
-  - `tokei` (#6085)
-  - `tsc` (#6016)
-  - `unlz4` (#6364)
-  - `unzstd` (#6364)
-  - `vbc` (#6016)
-  - `zpaq` (#6245)
-  - `zstd`, `zstdcat`, `zstdgrep`, `zstdless` and `zstdmt` (#6364)
-- Lots of improvements to completions.
-- Selecting short options which also have a long name from the completion pager is possible (#5634).
-- Tab completion will no longer add trailing spaces if they already exist (#6107).
-- Completion of subcommands to builtins like `and` or `not` now works correctly (#6249).
-- Completion of arguments to short options works correctly when multiple short options are used together (#332).
-- Activating completion in the middle of an invalid completion does not move the cursor any more, making it easier to fix a mistake (#4124).
-- Completion in empty commandlines now lists all available commands.
-- Functions listed as completions could previously leak parts of the function as other completions; this has been fixed.
-
-### Deprecations and removed features
-- The vcs-prompt functions have been promoted to names without double-underscore, so __fish_git_prompt is now fish_git_prompt, __fish_vcs_prompt is now fish_vcs_prompt, __fish_hg_prompt is now fish_hg_prompt and __fish_svn_prompt is now fish_svn_prompt. Shims at the old names have been added, and the variables have kept their old names (#5586).
-- `string replace` has an additional round of escaping in the replacement expression, so escaping backslashes requires many escapes (eg `string replace -ra '([ab])' '\\\\\\\$1' a`). The new feature flag `regex-easyesc` can be used to disable this, so that the same effect can be achieved with `string replace -ra '([ab])' '\\\\$1' a` (#5556). As a reminder, the intention behind feature flags is that this will eventually become the default and then only option, so scripts should be updated.
-- The `fish_vi_mode` function, deprecated in fish 2.3, has been removed. Use `fish_vi_key_bindings` instead (#6372).
-
-### For distributors and developers
-- fish 3.0 introduced a CMake-based build system. In fish 3.1, both the Autotools-based build and legacy Xcode build system have been removed, leaving only the CMake build system. All distributors and developers must install CMake.
-- fish now depends on the common `tee` external command, for the `psub` process substitution function.
-- The documentation is now built with Sphinx. The old Doxygen-based documentation system has been removed. Developers, and distributors who wish to rebuild the documentation, must install Sphinx.
-- The `INTERNAL_WCWIDTH` build option has been removed, as fish now always uses an internal `wcwidth` function. It has a number of configuration options that make it more suitable for general use (#5777).
-- mandoc can now be used to format the output from `--help` if `nroff` is not installed, reducing the number of external dependencies on systems with `mandoc` installed (#5489).
-- Some bugs preventing building on Solaris-derived systems such as Illumos were fixed (#5458, #5461, #5611).
-- Completions for `npm`, `bower` and `yarn` no longer require the `jq` utility for full functionality, but will use Python instead if it is available.
-- The paths for completions, functions and configuration snippets have been extended. On systems that define `XDG_DATA_DIRS`, each of the directories in this variable are searched in the subdirectories `fish/vendor_completions.d`, `fish/vendor_functions.d`, and `fish/vendor_conf.d` respectively. On systems that do not define this variable in the environment, the vendor directories are searched for in both the installation prefix and the default "extra" directory, which now defaults to `/usr/local` (#5029).
+If you are upgrading from version 2.7.1 or before, please also review the release notes for 3.0.2, 3.0.1, 3.0.0 and 3.0b1 (included below).
 
 ---
 
@@ -234,8 +14,7 @@ This release of fish fixes an issue discovered in fish 3.0.1.
 
 - The PWD environment variable is now ignored if it does not resolve to the true working directory, fixing strange behaviour in terminals started by editors and IDEs (#5647).
 
-If you are upgrading from version 2.7.1 or before, please also review the release notes for 3.0.1,
-3.0.0 and 3.0b1 (included below).
+If you are upgrading from version 2.7.1 or before, please also review the release notes for 3.0.1, 3.0.0 and 3.0b1 (included below).
 
 ---
 
@@ -253,7 +32,7 @@ This release of fish fixes a number of major issues discovered in fish 3.0.0.
 - The `pager-toggle-search` binding (Ctrl-S by default) will now activate the search field, even when the pager is not focused.
 - The error when a command is not found is now printed a single time, instead of once per argument (#5588).
 - Fixes and improvements to the git completions, including printing correct paths with older git versions, fuzzy matching again, reducing unnecessary offers of root paths (starting with `:/`) (#5578, #5574, #5476), and ignoring shell aliases, so enterprising users can set up the wrapping command (via `set -g __fish_git_alias_$command $whatitwraps`) (#5412).
-- Significant performance improvements to core shell functions (#5447) and to the `kill` completions (#5541).
+- Significant performance improvements to core shell functions (#5447) and to the `kill` completions (#5541). 
 - Starting in symbolically-linked working directories works correctly (#5525).
 - The default `fish_title` function no longer contains extra spaces (#5517).
 - The `nim` prompt now works correctly when chosen in the Web-based configuration (#5490).
@@ -295,7 +74,7 @@ If you are upgrading from version 2.7.1 or before, please also review the releas
 fish 3 is a major release, which introduces some breaking changes alongside improved functionality. Although most existing scripts will continue to work, they should be reviewed against the list below.
 
 ## Notable non-backward compatible changes
-- Process and job expansion has largely been removed. `%` will no longer perform these expansions, except for `%self` for the PID of the current shell. Additionally, job management commands (`disown`, `wait`, `bg`, `fg` and `kill`) will expand job specifiers starting with `%` (#4230, #1202).
+-  Process and job expansion has largely been removed. `%` will no longer perform these expansions, except for `%self` for the PID of the current shell. Additionally, job management commands (`disown`, `wait`, `bg`, `fg` and `kill`) will expand job specifiers starting with `%` (#4230, #1202).
 - `set x[1] x[2] a b`, to set multiple elements of an array at once, is no longer valid syntax (#4236).
 - A literal `{}` now expands to itself, rather than nothing. This makes working with `find -exec` easier (#1109, #4632).
 - Literally accessing a zero-index is now illegal syntax and is caught by the parser (#4862). (fish indices start at 1)
@@ -355,6 +134,7 @@ A new feature flags mechanism is added for staging deprecations and breaking cha
 - `read` writes directly to stdout if called without arguments (#4407).
 - `read` can now read individual lines into separate variables without consuming the input in its entirety via the new `/--line` option.
 - `set` has new `--append` and `--prepend` options (#1326).
+- `set` has a new `--show` option to show lots of information about variables (#4265).
 - `string match` with an empty pattern and `--entire` in glob mode now matches everything instead of nothing (#4971).
 - `string split` supports a new `--no-empty` option to exclude empty strings from the result (#4779).
 - `string` has new subcommands `split0` and `join0` for working with NUL-delimited output.

CMakeLists.txt

@@ -4,24 +4,18 @@ IF(POLICY CMP0066)
   CMAKE_POLICY(SET CMP0066 OLD)
 ENDIF()
 IF(POLICY CMP0067)
-  CMAKE_POLICY(SET CMP0067 NEW)
+  CMAKE_POLICY(SET CMP0067 OLD)
 ENDIF()
 
 PROJECT(fish)
 
 # We are C++11.
 SET(CMAKE_CXX_STANDARD 11)
+SET(CMAKE_CXX_FLAGS_DEBUG "-O0 -g")
+SET(CMAKE_CXX_FLAGS_RELWITHDEBINFO "-O2 -g")
+SET(CMAKE_CXX_FLAGS_RELEASE "-O2")
 SET(DEFAULT_BUILD_TYPE "RelWithDebInfo")
 
-# Use the default flags (#6296) but remove -DNDEBUG so that asserts remain enabled.
-STRING(REPLACE "-DNDEBUG" ""
-  CMAKE_CXX_FLAGS_RELWITHDEBINFO
-  "${CMAKE_CXX_FLAGS_RELWITHDEBINFO}")
-
-STRING(REPLACE "-DNDEBUG" ""
-  CMAKE_CXX_FLAGS_RELEASE
-  "${CMAKE_CXX_FLAGS_RELEASE}")
-
 IF(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
     MESSAGE(STATUS "Setting build type to default '${DEFAULT_BUILD_TYPE}'")
     SET(CMAKE_BUILD_TYPE "${DEFAULT_BUILD_TYPE}")
@@ -36,32 +30,10 @@ if (CMAKE_GENERATOR STREQUAL "Ninja" AND
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fdiagnostics-color=always")
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fdiagnostics-color=always")
 endif()
-# Enable a whole bunch of warnings, but turn off:
-# - implicit fallthrough because that does not recognize some cases where it's desired (and I *really* want this one!)
-# - comment because we use a bunch of those, and they're not really all that harmful.
-# - address, because that occurs for our mkostemp check (weak-linking requires us to compare `&mkostemp == nullptr`).
-# - strict-aliasing, because on old GCCs (*Travis*) those are triggered by maybe.h, so you get it every time it is included.
-# - redundant-move, because we have one that is required on old libc
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra \
--Wno-implicit-fallthrough \
--Wno-comment \
--Wno-address \
--Wno-strict-aliasing \
--Wno-redundant-move \
-")
 
 # Disable exception handling.
 ADD_COMPILE_OPTIONS(-fno-exceptions)
 
-# Prefer the gold linker because it doesn't emit useless warnings about sys_nerr and _sys_errlist.
-if (UNIX AND NOT APPLE)
-  EXECUTE_PROCESS(COMMAND ${CMAKE_C_COMPILER} -fuse-ld=gold -Wl,--version
-                  ERROR_QUIET OUTPUT_VARIABLE LD_VERSION)
-  if ("${LD_VERSION}" MATCHES "GNU gold")
-    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fuse-ld=gold")
-  endif()
-endif()
-
 # Hide the CMake Rules directories in Xcode projects.
 SOURCE_GROUP("CMake Rules" REGULAR_EXPRESSION "^$")
 
@@ -73,9 +45,6 @@ SOURCE_GROUP("Builtins" REGULAR_EXPRESSION "builtin_.*")
 # Support folders.
 SET_PROPERTY(GLOBAL PROPERTY USE_FOLDERS ON)
 
-# Work around issue where archive-built libs go in the wrong place.
-SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR})
-
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
 
 IF(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR)
@@ -84,14 +53,6 @@ ELSE()
   SET(FISH_IN_TREE_BUILD FALSE)
 ENDIF()
 
-# NetBSD does weird things with finding libraries,
-# making the tests fail by failing to find pcre.
-#
-# Keep the rpath used to build.
-IF(CMAKE_SYSTEM_NAME STREQUAL NetBSD)
-  SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
-ENDIF()
-
 # All objects that the system needs to build fish, except fish.cpp
 SET(FISH_SRCS
     src/autoload.cpp src/builtin.cpp src/builtin_bg.cpp src/builtin_bind.cpp
@@ -105,20 +66,18 @@ SET(FISH_SRCS
     src/builtin_random.cpp src/builtin_read.cpp src/builtin_realpath.cpp
     src/builtin_return.cpp src/builtin_set.cpp src/builtin_set_color.cpp
     src/builtin_source.cpp src/builtin_status.cpp src/builtin_string.cpp
-    src/builtin_test.cpp src/builtin_ulimit.cpp src/builtin_wait.cpp src/builtin_eval.cpp
-    src/color.cpp src/common.cpp src/complete.cpp src/env.cpp src/env_dispatch.cpp
+    src/builtin_test.cpp src/builtin_ulimit.cpp src/builtin_wait.cpp
+    src/color.cpp src/common.cpp src/complete.cpp src/env.cpp
     src/env_universal_common.cpp src/event.cpp src/exec.cpp src/expand.cpp
     src/fallback.cpp src/fish_version.cpp src/function.cpp src/highlight.cpp
-    src/history.cpp src/history_file.cpp src/input.cpp src/input_common.cpp src/intern.cpp
-    src/io.cpp src/iothread.cpp src/kill.cpp src/output.cpp src/pager.cpp
+    src/history.cpp src/input.cpp src/input_common.cpp src/intern.cpp src/io.cpp
+    src/iothread.cpp src/kill.cpp src/output.cpp src/pager.cpp
     src/parse_execution.cpp src/parse_productions.cpp src/parse_tree.cpp
     src/parse_util.cpp src/parser.cpp src/parser_keywords.cpp src/path.cpp
     src/postfork.cpp src/proc.cpp src/reader.cpp src/sanity.cpp src/screen.cpp
-    src/signal.cpp src/tinyexpr.cpp src/tnode.cpp src/tokenizer.cpp src/utf8.cpp src/util.cpp
+    src/signal.cpp src/tinyexpr.c src/tnode.cpp src/tokenizer.cpp src/utf8.cpp src/util.cpp
     src/wcstringutil.cpp src/wgetopt.cpp src/wildcard.cpp src/wutil.cpp
-    src/future_feature_flags.cpp src/redirection.cpp src/topic_monitor.cpp
-    src/flog.cpp src/trace.cpp src/timer.cpp src/null_terminated_array.cpp
-    src/operation_context.cpp
+    src/future_feature_flags.cpp
 )
 
 # Header files are just globbed.
@@ -146,10 +105,8 @@ ADD_DEFINITIONS(-D_UNICODE=1
 INCLUDE(Version)
 
 # Let fish pick up when we're running out of the build directory without installing
-GET_FILENAME_COMPONENT(REAL_CMAKE_BINARY_DIR "${CMAKE_BINARY_DIR}" REALPATH)
-GET_FILENAME_COMPONENT(REAL_CMAKE_SOURCE_DIR "${CMAKE_SOURCE_DIR}" REALPATH)
-ADD_DEFINITIONS(-DCMAKE_BINARY_DIR="${REAL_CMAKE_BINARY_DIR}")
-ADD_DEFINITIONS(-DCMAKE_SOURCE_DIR="${REAL_CMAKE_SOURCE_DIR}")
+ADD_DEFINITIONS(-DCMAKE_BINARY_DIR="${CMAKE_BINARY_DIR}")
+ADD_DEFINITIONS(-DCMAKE_SOURCE_DIR="${CMAKE_SOURCE_DIR}")
 
 # Teach fish_version.o to rebuild when FBVF changes.
 # The standard C++ include detection machinery misses this.
@@ -157,12 +114,19 @@ SET_SOURCE_FILES_PROPERTIES(src/fish_version.cpp
                             PROPERTIES OBJECT_DEPENDS
                             ${CMAKE_CURRENT_BINARY_DIR}/${FBVF})
 
-# Enable thread-safe errno on Solaris (#5611)
-ADD_DEFINITIONS(-D_REENTRANT)
+OPTION(INTERNAL_WCWIDTH "use fallback wcwidth" ON)
+IF(INTERNAL_WCWIDTH)
+    add_definitions(-DHAVE_BROKEN_WCWIDTH=1)
+ELSE()
+    add_definitions(-DHAVE_BROKEN_WCWIDTH=0)
+ENDIF()
 
 # Set up PCRE2
 INCLUDE(cmake/PCRE2.cmake)
 
+# Set up the docs.
+INCLUDE(cmake/Docs.cmake)
+
 # Define a function to link dependencies.
 FUNCTION(FISH_LINK_DEPS target)
   TARGET_LINK_LIBRARIES(${target} fishlib)
@@ -173,7 +137,7 @@ ADD_LIBRARY(fishlib STATIC ${FISH_SRCS})
 TARGET_SOURCES(fishlib PRIVATE ${FISH_HEADERS})
 TARGET_LINK_LIBRARIES(fishlib
   ${CURSES_LIBRARY} ${CURSES_EXTRA_LIBRARY} Threads::Threads ${CMAKE_DL_LIBS}
-  ${PCRE2_LIB} ${Intl_LIBRARIES} ${ATOMIC_LIBRARY})
+  ${PCRE2_LIB} ${Intl_LIBRARIES})
 
 # Define fish.
 ADD_EXECUTABLE(fish src/fish.cpp)
@@ -189,38 +153,11 @@ ADD_EXECUTABLE(fish_key_reader
                src/fish_key_reader.cpp src/print_help.cpp)
 FISH_LINK_DEPS(fish_key_reader)
 
-# Set up the docs.
-INCLUDE(cmake/Docs.cmake)
-
-# A helper for running tests.
-ADD_EXECUTABLE(fish_test_helper src/fish_test_helper.cpp)
-
 # Set up tests.
 INCLUDE(cmake/Tests.cmake)
 
-# Benchmarking support.
-INCLUDE(cmake/Benchmark.cmake)
-
 # Set up install.
 INCLUDE(cmake/Install.cmake)
 
-# Mac app.
-INCLUDE(cmake/MacApp.cmake)
-
-# Lint targets
-# This could be implemented as target properties, but the script has the useful feature of only
-# checking the currently-staged commands
-# The generator expressions below rebuild the command line for the fishlib targets
-# CMake does not support the "iquote" flag - https://gitlab.kitware.com/cmake/cmake/issues/15491
-SET(LINT_ARGS "-D$<JOIN:$<TARGET_PROPERTY:fishlib,COMPILE_DEFINITIONS>, -D>" "-I$<JOIN:$<TARGET_PROPERTY:fishlib,INCLUDE_DIRECTORIES>, -I>")
-ADD_CUSTOM_TARGET(lint
-    COMMAND build_tools/lint.fish -- ${LINT_ARGS}
-    WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
-)
-ADD_CUSTOM_TARGET(lint-all
-    COMMAND build_tools/lint.fish --all -- ${LINT_ARGS}
-    WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
-)
-
 INCLUDE(FeatureSummary)
 FEATURE_SUMMARY(WHAT ALL)

CONTRIBUTING.md

@@ -69,7 +69,7 @@ Suppressing oclint warnings is more complicated to describe so I'll refer you to
 The following sections discuss the specific rules for the style that should be used when writing fish code. To ensure your changes conform to the style rules you simply need to run
 
 ```
-build_tools/style.fish
+make style
 ```
 
 before committing your change. That will run `git-clang-format` to rewrite only the lines you're modifying.
@@ -79,7 +79,7 @@ If you've already committed your changes that's okay since it will then check th
 If you want to check the style of the entire code base run
 
 ```
-build_tools/style.fish --all
+make style-all
 ```
 
 That command will refuse to restyle any files if you have uncommitted changes.
@@ -165,24 +165,9 @@ However, as I write this there are no places in the code where we use this and I
 
 1. Indent with spaces, not tabs and use four spaces per indent.
 
-1. Document the purpose of a function or class with doxygen-style comment blocks. e.g.:
-```
-/**
- * Sum numbers in a vector.
- *
- * @param values Container whose values are summed.
- * @return sum of `values`, or 0.0 if `values` is empty.
- */
-double sum(std::vector<double> & const values) {
-    ...
-}
- */
- ```
-or
-```
-/// brief description of somefunction()
-void somefunction() {
-```
+1. Comments should always use the C++ style; i.e., each line of the comment should begin with a `//` and should be limited to 100 characters. Comments that do not begin a line should be separated from the previous text by two spaces.
+
+1. Comments that document the purpose of a function or class should begin with three slashes, `///`, so that OS X Xcode (and possibly other IDEs) will extract the comment and show it in the "Quick Help" window when the cursor is on the symbol.
 
 ## Testing
 
@@ -194,9 +179,12 @@ You are strongly encouraged to add tests when changing the functionality of fish
 
 The tests can be run on your local computer on all operating systems.
 
+Running the tests is only supported from the autotools build and not xcodebuild. On OS X, you will need to install autoconf &mdash; we suggest using [Homebrew](https://brew.sh/) to install these tools.
+
 ```
-cmake path/to/fish-shell
-make test
+autoconf
+./configure
+make test # or "gmake test" on BSD
 ```
 
 ### Travis CI Build and Test
@@ -297,13 +285,7 @@ sudo ln -s /usr/bin/clang-format-3.9 /usr/bin/clang-format
 
 ## Message Translations
 
-Fish uses the GNU gettext library to translate messages from English to other languages.
-
-All non-debug messages output for user consumption should be marked for translation. In C++, this requires the use of the `_` (underscore) macro:
-
-```
-streams.out.append_format(_(L"%ls: There are no jobs\n"), argv[0]);
-```
+Fish uses the GNU gettext library to translate messages from English to other languages. To create or update a translation run `make po/[LANGUAGE CODE].po` where `LANGUAGE CODE` is the two letter ISO 639-1 language code of the language you are translating to (e.g. `de` for German). Make sure that you have the `xgettext`, `msgfmt` and `msgmerge` commands installed in order to do this.
 
 All messages in fish script must be enclosed in single or double quote characters. They must also be translated via a subcommand. This means that the following are **not** valid:
 
@@ -321,18 +303,6 @@ echo (_ "goodbye")
 
 Note that you can use either single or double quotes to enclose the message to be translated. You can also optionally include spaces after the opening parentheses and once again before the closing parentheses.
 
-Creating and updating translations requires the Gettext tools, including `xgettext`, `msgfmt` and `msgmerge`. Translation sources are stored in the `po` directory, named `LANG.po`, where `LANG` is the two letter ISO 639-1 language code of the target language (eg `de` for German).
-
-To create a new translation, for example for German:
-* generate a `messages.pot` file by running `build_tools/fish_xgettext.fish` from the source tree
-* copy `messages.pot` to `po/LANG.po` ()
-
-To update a translation:
-* generate a `messages.pot` file by running `build_tools/fish_xgettext.fish` from the source tree
-* update the existing translation by running `msgmerge --update --no-fuzzy-matching po/LANG.po messages.pot`
-
-Many tools are available for editing translation files, including command-line and graphical user interface programs.
-
-Be cautious about blindly updating an existing translation file. Trivial changes to an existing message (eg changing the punctuation) will cause existing translations to be removed, since the tools do literal string matching. Therefore, in general, you need to carefully review any recommended deletions.
+Be cautious about blindly updating an existing translation file. Trivial changes to an existing message (e.g., changing the punctuation) will cause existing translations to be removed, since the tools do literal string matching. Therefore, in general, you need to carefully review any recommended deletions.
 
 Read the [translations wiki](https://github.com/fish-shell/fish-shell/wiki/Translations) for more information.

COPYING

@@ -1,7 +1,6 @@
 Fish is a smart and user-friendly command line shell.
 
 Copyright (C) 2005-2009 Axel Liljencrantz
-Copyright (C) 2009-2019 fish-shell contributors
 
 fish is free software.
 

Dockerfile

@@ -2,8 +2,7 @@ FROM centos:latest
 
 # Build dependency
 RUN yum update -y &&\
-  yum install -y epel-release &&\
-  yum install -y clang cmake3 gcc-c++ make ncurses-devel &&\
+  yum install -y autoconf automake bc clang gcc-c++ make ncurses-devel &&\
   yum clean all
 
 # Test dependency
@@ -13,7 +12,8 @@ ADD . /src
 WORKDIR /src
 
 # Build fish
-RUN cmake3 . &&\
+RUN autoreconf &&\
+  ./configure &&\
   make &&\
   make install
 

GNUmakefile

@@ -1,69 +0,0 @@
-# This is a very basic `make` wrapper around the CMake build toolchain.
-#
-# Supported arguments:
-#   PREFIX: sets the installation prefix
-#   GENERATOR: explicitly specifies the CMake generator to use
-
-CMAKE ?= cmake
-
-GENERATOR ?= $(shell (which ninja > /dev/null 2> /dev/null && echo Ninja) || \
-			 echo 'Unix Makefiles')
-prefix ?= /usr/local
-PREFIX ?= $(prefix)
-
-ifeq ($(GENERATOR), Ninja)
-BUILDFILE = build.ninja
-else
-BUILDFILE = Makefile
-endif
-
-
-# If CMake has generated an in-tree Makefile, use that instead (issue #6264)
-MAKE_DIR:=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
-ifeq ($(shell test -f $(MAKE_DIR)/Makefile && echo 1), 1)
-
-all:
-	@+$(MAKE) -f $(MAKE_DIR)/Makefile $(MAKECMDGOALS) --no-print-directory
-%:
-	@+$(MAKE) -f $(MAKE_DIR)/Makefile $(MAKECMDGOALS) --no-print-directory
-
-else
-
-all: .begin build/fish
-
-PHONY: .begin
-.begin:
-	@which $(CMAKE) > /dev/null 2> /dev/null || \
-		 (echo 'Please install CMake and then re-run the `make` command!' 1>&2 && false)
-
-build/fish: build/$(BUILDFILE)
-	$(CMAKE) --build build
-
-build/$(BUILDFILE): build
-	cd build; $(CMAKE) .. -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -G "$(GENERATOR)" \
-		-DCMAKE_INSTALL_PREFIX="$(PREFIX)" -DCMAKE_EXPORT_COMPILE_COMMANDS=1
-
-build:
-	mkdir -p build
-
-.PHONY: clean
-clean:
-	rm -rf build
-
-.PHONY: test
-test: build/fish
-	$(CMAKE) --build build --target test
-
-.PHONY: install
-install: build/fish
-	$(CMAKE) --build build --target install
-
-.PHONY: run
-run: build/fish
-	./build/fish || true
-
-.PHONY: exec
-exec: build/fish
-	exec ./build/fish
-
-endif # CMake in-tree build check

README.md

@@ -32,14 +32,14 @@ fish can be installed:
 
 Packages for Debian, Fedora, openSUSE, and Red Hat Enterprise Linux/CentOS are available from the
 [openSUSE Build
-Service](https://software.opensuse.org/download.html?project=shells%3Afish&package=fish).
+Service](https://software.opensuse.org/download.html?project=shells%3Afish%3Arelease%3A2&package=fish).
 
 Packages for Ubuntu are available from the [fish
-PPA](https://launchpad.net/~fish-shell/+archive/ubuntu/release-3), and can be installed using the
+PPA](https://launchpad.net/~fish-shell/+archive/ubuntu/release-2), and can be installed using the
 following commands:
 
 ```
-sudo apt-add-repository ppa:fish-shell/release-3
+sudo apt-add-repository ppa:fish-shell/release-2
 sudo apt-get update
 sudo apt-get install fish
 ```
@@ -66,17 +66,18 @@ Once installed, run `fish` from your current shell to try fish out!
 Running fish requires:
 
 * curses or ncurses (preinstalled on most \*nix systems)
-* some common \*nix system utilities (currently `mktemp`), in addition to the basic POSIX utilities (`cat`, `cut`, `dirname`, `ls`, `mkdir`, `mkfifo`, `rm`, `sort`, `tee`, `tr`, `uname` and `sed` at least, but the full coreutils plus find, sed and awk is preferred)
+* some common \*nix system utilities (currently `mktemp` and `seq`), in addition to the basic POSIX utilities
 * gettext (library and `gettext` command), if compiled with translation support
 
 The following optional features also have specific requirements:
 
-* builtin commands that have the `--help` option or print usage messages require `ul` and either `nroff` or `mandoc` for display
+* builtin commands that have the `--help` option or print usage messages require `nroff` and `ul`
 * automated completion generation from manual pages requires Python (2.7+ or 3.3+) and possibly the
   `backports.lzma` module for Python 2.7
 * the `fish_config` web configuration tool requires Python (2.7+ or 3.3 +) and a web browser
 * system clipboard integration (with the default Ctrl-V and Ctrl-X bindings) require either the
-  `xsel`, `xclip`, `wl-copy`/`wl-paste` or `pbcopy`/`pbpaste` utilities
+  `xsel` or `pbcopy`/`pbpaste` utilities
+* full completions for `yarn` and `bower` require the `jq` utility
 * full completions for `yarn` and `npm` require the `all-the-package-names` NPM module
 
 ### Switching to fish
@@ -85,7 +86,7 @@ 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 fish was installed to, if it differs.) Log out, then log in again for the changes to take effect.
+`chsh` will prompt you for your password and change your default shell. (Substitute `/usr/local/bin/fish` with whatever path fish was installed to, if it differs.)
 
 Use the following command if fish isn't already added to `/etc/shells` to permit fish to be your login shell:
 
@@ -100,16 +101,16 @@ To switch your default shell back, you can run `chsh -s /bin/bash` (substituting
 Compiling fish requires:
 
 * a C++11 compiler (g++ 4.8 or later, or clang 3.3 or later)
-* CMake (version 3.2 or later)
+* any of CMake, GNU Make, or (on macOS only) Xcode
 * a curses implementation such as ncurses (headers and libraries)
 * PCRE2 (headers and libraries) - a copy is included with fish
 * gettext (headers and libraries) - optional, for translation support
 
-Sphinx is also optionally required to build the documentation from a cloned git repository.
+Additionally, if compiling fish with GNU Make from git (that is, not from an officially released tarball), `autoconf` 2.60+ and `automake` 1.13+ are required. Doxygen (1.8.7 or later) is also optionally required to build the documentation from a cloned git repository.
 
-### Building from source (all platforms) - Makefile generator
+### Building from source (all platforms)
 
-To install into `/usr/local`, run:
+#### Using CMake (preferred)
 
 ```bash
 mkdir build; cd build
@@ -118,32 +119,35 @@ make
 sudo make install
 ```
 
-The install directory can be changed using the `-DCMAKE_INSTALL_PREFIX` parameter for `cmake`.
-
-### Building from source (macOS) - Xcode
+#### Using autotools
 
 ```bash
-mkdir build; cd build
-cmake .. -G Xcode
+autoreconf --no-recursive #if building from Git
+./configure
+make
+sudo make install
 ```
 
-An Xcode project will now be available in the `build` subdirectory. You can open it with Xcode,
-or run the following to build and install in `/usr/local`:
+### Building from source (macOS only)
+
+* Build the `base` target in Xcode
+* Run the fish executable, for example, in `DerivedData/fish/Build/Products/Debug/base/bin/fish`
+
+To build and install fish with Xcode on macOS, execute the following in a terminal:
 
 ```bash
-xcodebuild
-xcodebuild -scheme install
+xcodebuild install
+sudo ditto /tmp/fish.dst /
+sudo make install-doc
 ```
 
-The install directory can be changed using the `-DCMAKE_INSTALL_PREFIX` parameter for `cmake`.
-
 ### 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 cmake ncurses-dev libncurses5-dev libpcre2-dev gettext
+    sudo apt-get install build-essential ncurses-dev libncurses5-dev gettext autoconf
 
 On RedHat, CentOS, or Amazon EC2:
 
@@ -155,6 +159,6 @@ See the [Guide for Developers](CONTRIBUTING.md).
 
 ## 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](https://gitter.im/fish-shell/fish-shell). Or use the [fish tag on Stackoverflow](https://stackoverflow.com/questions/tagged/fish) for questions related to fish script and the [fish tag on Superuser](https://superuser.com/questions/tagged/fish) for all other questions (e.g., customizing colors, changing key bindings).
+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](https://gitter.im/fish-shell/fish-shell) or IRC channel [#fish at irc.oftc.net](https://webchat.oftc.net/?channels=fish). Or use the [fish tag on Stackoverflow](https://stackoverflow.com/questions/tagged/fish) for questions related to fish script and the [fish tag on Superuser](https://superuser.com/questions/tagged/fish) for all other questions (e.g., customizing colors, changing key bindings).
 
 Found a bug? Have an awesome idea? Please [open an issue](https://github.com/fish-shell/fish-shell/issues/new).

benchmarks/benchmarks/external_cmds.fish

@@ -1,4 +0,0 @@
-for i in (seq 2000)
-    command true
-end
-

benchmarks/benchmarks/seq_echo.fish

@@ -1,3 +0,0 @@
-for i in (seq 1000)
-    echo $i
-end

benchmarks/driver.sh

@@ -1,17 +0,0 @@
-#!/bin/sh
-
-if [ "$#" -ne 1 ]; then
-    echo "Usage: driver.sh /path/to/fish"
-fi
-
-FISH_PATH=$1
-BENCHMARKS_DIR=$(dirname "$0")/benchmarks
-
-for benchmark in "$BENCHMARKS_DIR"/*; do
-    basename "$benchmark"
-    ${FISH_PATH} --print-rusage-self "$benchmark" > /dev/null
-    if command -v hyperfine >/dev/null 2>&1; then
-        hyperfine "${FISH_PATH} $benchmark > /dev/null"
-    fi
-done
-

build_tools/build_commands_hdr.sh

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+# Builds the commands.hdr file.
+# Usage: build_commands_hdr.sh ${HELP_SRC} < commands_hdr.in > commands.hdr
+
+rm -f command_list.tmp command_list_toc.tmp
+for i in `printf "%s\n" $@ | LC_ALL=C.UTF-8 sort`; do
+	echo "<hr>" >>command_list.tmp;
+	cat $i >>command_list.tmp;
+	echo >>command_list.tmp;
+	echo >>command_list.tmp;
+	NAME=`basename $i .txt`;
+	echo '- <a href="#'$NAME'">'$NAME'</a>' >> command_list_toc.tmp;
+	echo "Back to <a href='index.html#toc-commands'>command index</a>". >>command_list.tmp;
+done
+mv command_list.tmp command_list.txt
+mv command_list_toc.tmp command_list_toc.txt
+/usr/bin/env awk '{if ($0 ~ /@command_list_toc@/) { system("cat command_list_toc.txt"); }
+                   else if ($0 ~ /@command_list@/){ system("cat command_list.txt");}
+                   else{ print $0;}}'

build_tools/build_documentation.sh

@@ -0,0 +1,163 @@
+#!/bin/sh
+
+# This script is run as part of the build process
+
+if test $# -eq 0
+then
+	# Use fish's defaults
+	DOXYFILE=Doxyfile.help
+	INPUTDIR=doc_src
+	OUTPUTDIR=share
+	echo "Using defaults: $0 ${DOXYFILE} ${INPUTDIR} ${OUTPUTDIR}"
+elif test $# -eq 3
+then
+	DOXYFILE="$1"
+	INPUTDIR="$2"
+	OUTPUTDIR="$3"
+else
+	echo "Usage: $0 doxygen_file input_directory output_directory"
+	exit 1
+fi
+
+# Determine which man pages we don't want to generate.
+# on OS X, don't make a man page for open, since we defeat fish's open function on OS X.
+# This is also done in the Makefile, but the Xcode build doesn't use that
+CONDEMNED_PAGES=
+if test `uname` = 'Darwin'; then
+	CONDEMNED_PAGES="$CONDEMNED_PAGES open.1"
+fi
+
+# Helper function to turn a relative path into an absolute path
+resolve_path()
+{
+	D=`command dirname "$1"`
+	B=`command basename "$1"`
+	echo "`cd \"$D\" 2>/dev/null && pwd || echo \"$D\"`/$B"
+}
+
+# Expand relative paths
+DOXYFILE=`resolve_path "$DOXYFILE"`
+INPUTDIR=`resolve_path "$INPUTDIR"`
+INPUTFILTER=`resolve_path "$INPUT_FILTER"`
+OUTPUTDIR=`resolve_path "$OUTPUTDIR"`
+
+echo "      doxygen file: $DOXYFILE"
+echo "   input directory: $INPUTDIR"
+echo "      input filter: $INPUTFILTER"
+echo "  output directory: $OUTPUTDIR"
+echo "          skipping: $CONDEMNED_PAGES"
+
+#Until now the makefile likely has been affecting our output, reset for upcoming warnings
+tput sgr0
+
+# Make sure INPUTDIR is found
+if test ! -d "$INPUTDIR"; then
+	echo >&2 "Could not find input directory '${INPUTDIR}'"
+	exit 1
+fi
+
+# Make sure doxygen is found
+DOXYGENPATH=`command -v doxygen`
+if test -z "$DOXYGENPATH" ; then
+    for i in /usr/local/bin/doxygen /opt/bin/doxygen /Applications/Doxygen.app/Contents/Resources/doxygen ~/Applications/Doxygen.app/Contents/Resources/doxygen ; do
+    	if test -f "$i"; then
+    	    DOXYGENPATH="$i"
+    	    break
+    	fi
+    done
+fi
+
+if test -z "$DOXYGENPATH"; then
+    echo >&2 "doxygen is not installed, so documentation will not be built."
+    exit 0
+fi
+
+# Check we have the lexicon filter
+if test -z "$INPUT_FILTER"; then
+    echo >&2 "Lexicon filter is not available. Continuing without."
+    INPUTFILTER=''
+fi
+
+# Determine where our output should go
+if ! mkdir -p "${OUTPUTDIR}" ; then
+    echo "Could not create output directory '${OUTPUTDIR}'"
+fi
+
+# Make a temporary directory
+TMPLOC=`mktemp -d -t fish_doc_build_XXXXXX` || { echo >&2 "Could not build documentation because mktemp failed"; exit 1; }
+
+# Copy stuff to the temp directory
+for i in "$INPUTDIR"/*.txt; do
+	BASENAME=`basename $i .txt`
+	INPUTFILE=$TMPLOC/$BASENAME.doxygen
+	echo "/** \\page" $BASENAME > $INPUTFILE
+	cat $i | sed "s/\\\section $BASENAME $BASENAME/\\\section $BASENAME-man $BASENAME/" >> $INPUTFILE
+	echo "*/" >> $INPUTFILE
+done
+
+# Make some extra stuff to pass to doxygen
+# Input is kept as . because we cd to the input directory beforehand
+# This prevents doxygen from generating "documentation" for intermediate directories
+PROJECT_NUMBER=$(echo "$FISH_BUILD_VERSION" | env sed "s/-[a-z0-9-]*//")
+echo "PROJECT_NUMBER: $FISH_BUILD_VERSION"
+DOXYPARAMS=$(cat <<EOF
+PROJECT_NUMBER=${PROJECT_NUMBER}
+INPUT_FILTER=$INPUTFILTER
+INPUT=.
+OUTPUT_DIRECTORY=$OUTPUTDIR
+QUIET=YES
+EOF
+);
+
+# echo "$DOXYPARAMS"
+
+# Clear out the output directory first
+find "${OUTPUTDIR}" -name "*.1" -delete
+
+# Run doxygen
+cd "$TMPLOC"
+(cat "${DOXYFILE}" ; echo "$DOXYPARAMS";) | "$DOXYGENPATH" -
+
+# Remember errors
+RESULT=$?
+
+cd "${OUTPUTDIR}/man/man1/"
+if test "$RESULT" = 0 ; then
+
+	# Postprocess the files
+	for i in "$INPUTDIR"/*.txt; do
+		# This command turns the following weirdness from Doxygen:
+		# abbr \-
+		# .SH "abbr - manage fish abbreviations"
+		# into
+		# \fBabbr\fP - manage fish abbreviations
+		# It would be nice to use -i here for edit in place, but that is not portable
+		CMD_NAME=`basename "$i" .txt`;
+		sed -E < ${CMD_NAME}.1 > ${CMD_NAME}.1.tmp \
+			-e "/^.SH NAME/{
+											N; N
+											s/${CMD_NAME} \\\\- \n.SH \"${CMD_NAME} (- .*)\"/\\\fB${CMD_NAME}\\\fP \1/g
+											}"
+		mv "${CMD_NAME}.1.tmp" "${CMD_NAME}.1"
+	done
+
+	# Erase condemned pages
+	rm -f $CONDEMNED_PAGES
+fi
+
+# Destroy TMPLOC
+if test "$RESULT" -ne 0; then
+	echo "Cleaning up '$TMPLOC'"
+fi
+rm -Rf "$TMPLOC"
+
+if test "$RESULT" -ne 0; then
+	tput smso 2> /dev/null || true
+	echo "Doxygen failed creating manpages. See the output log for details."
+	tput sgr0 2> /dev/null || true
+else
+	tput bold 2> /dev/null || true
+	echo Built manpages
+	tput sgr0 2> /dev/null || true
+fi
+exit $RESULT

build_tools/build_index_hdr.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+TOC_TXT=$1
+env awk "{if (\$0 ~ /@toc@/){ system(\"cat ${TOC_TXT}\");} else{ print \$0;}}"
+

build_tools/build_lexicon_filter.sh

@@ -0,0 +1,51 @@
+#!/bin/sh
+
+# Builds the lexicon filter
+# Usage: build_lexicon_filter.sh FUNCTIONS_DIR COMPLETIONS_DIR lexicon_filter.in [SED_BINARY] > lexicon_filter
+
+set -e
+
+# To enable the lexicon filter, we first need to be aware of what fish
+# considers to be a command, function, or external binary. We use
+# command_list_toc.txt for the base commands. Scan the share/functions
+# directory for other functions, some of which are mentioned in the docs, and
+# use /share/completions to find a good selection of binaries. Additionally,
+# colour defaults from __fish_config_interactive to set the docs colours when
+# used in a 'cli' style context.
+rm -f lexicon.tmp lexicon_catalog.tmp lexicon_catalog.txt lexicon.txt
+
+FUNCTIONS_DIR=${1}
+FUNCTIONS_DIR_FILES=${1}/*.fish
+COMPLETIONS_DIR_FILES=${2}/*.fish
+LEXICON_FILTER_IN=${3}
+
+SED=${4:-$(command -v sed)}
+
+# Scan sources for commands/functions/binaries/colours. If GNU sed was portable, this could be much smarter.
+$SED <command_list_toc.txt >>lexicon.tmp -n \
+	-e "s|^.*>\([a-z][a-z_]*\)</a>|'\1'|w lexicon_catalog.tmp" \
+	-e "s|'\(.*\)'|bltn \1|p"; mv lexicon_catalog.tmp lexicon_catalog.txt
+printf "%s\n" ${COMPLETIONS_DIR_FILES} | $SED -n \
+	-e "s|[^ ]*/\([a-z][a-z_-]*\).fish|'\1'|p" | grep -F -vx -f lexicon_catalog.txt | $SED >>lexicon.tmp -n \
+	-e 'w lexicon_catalog.tmp' \
+	-e "s|'\(.*\)'|cmnd \1|p"; cat lexicon_catalog.tmp >> lexicon_catalog.txt;
+printf "%s\n" ${FUNCTIONS_DIR_FILES} | $SED -n \
+	-e "s|[^ ]*/\([a-z][a-z_-]*\).fish|'\1'|p" | grep -F -vx -f lexicon_catalog.txt | $SED >>lexicon.tmp -n \
+	-e 'w lexicon_catalog.tmp' \
+	-e "s|'\(.*\)'|func \1|p";
+$SED < ${FUNCTIONS_DIR}/__fish_config_interactive.fish >>lexicon.tmp -n  \
+	-e '/set_default/s/.*\(fish_[a-z][a-z_]*\).*$$/clrv \1/p'; \
+$SED < ${LEXICON_FILTER_IN} >>lexicon.tmp -n \
+	-e '/^#.!#/s/^#.!# \(.... [a-z][a-z_]*\)/\1/p';
+mv lexicon.tmp lexicon.txt; rm -f lexicon_catalog.tmp lexicon_catalog.txt;
+
+# Copy the filter to stdout. We're going to append sed commands to it after.
+$SED -e 's|@sed@|'$SED'|' < ${LEXICON_FILTER_IN}
+
+# Scan through the lexicon, transforming each line to something useful to Doxygen.
+if echo x | $SED "/[[:<:]]x/d" 2>/dev/null; then
+		WORDBL='[[:<:]]'; WORDBR='[[:>:]]';
+	else
+		WORDBL='\\<'; WORDBR='\\>';
+	fi;
+$SED < lexicon.txt -n -e "s|^\([a-z][a-z][a-z][a-z]\) \([a-z_-]*\)$|s,$WORDBL\2$WORDBR,@\1{\2},g|p" -e '$G;s/.*\n/b tidy/p';

build_tools/build_toc_txt.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+# Usage: build_toc_txt.sh $(HDR_FILES:index.hdr=index.hdr.in) > toc.txt
+
+# Ugly hack to set the toc initial title for the main page
+echo "- <a href=\"index.html\" id=\"toc-index\">fish shell documentation - ${FISH_BUILD_VERSION}</a>" > toc.txt
+# The first sed command captures the page name, followed by the description
+# The second sed command captures the command name \1 and the description \2, but only up to a dash
+# This is to reduce the size of the TOC in the command listing on the main page
+for i in $@; do
+	NAME=`basename $i .hdr`
+	NAME=`basename $NAME .hdr.in`
+  env sed <$i >>toc.txt -n \
+    -e 's,.*\\page *\([^ ]*\) *\(.*\)$,- <a href="'$NAME'.html" id="toc-'$NAME'">\2</a>,p' \
+    -e 's,.*\\section *\([^ ]*\) *\(.*\) - .*$,  - <a href="'$NAME'.html#\1">\2</a>,p' \
+    -e 's,.*\\section *\([^ ]*\) *\(.*\)$,  - <a href="'$NAME'.html#\1">\2</a>,p'
+done

build_tools/build_user_doc.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+# Usage: Doxyfile.user lexicon_filter
+DOXYFILE=$1
+LEXICON_FILTER=$2
+
+(cat "${DOXYFILE}" ;\
+ echo INPUT_FILTER="${LEXICON_FILTER}"; \
+ echo PROJECT_NUMBER=${FISH_BUILD_VERSION} \
+ | /usr/bin/env sed "s/-[a-z0-9-]*//") \
+   | doxygen - && touch user_doc
+
+(cd ./user_doc/html/ && \
+ rm -f bc_s.png bdwn.png closed.png doc.png folder*.png ftv2*.png \
+       nav*.png open.png splitbar.png sync_*.png tab*.* doxygen.* \
+       dynsections.js jquery.js pages.html)

build_tools/diff_profiles.fish

@@ -10,37 +10,37 @@ set profile2 (cat $argv[2])
 
 set line_no 0
 while set next_line_no (math $line_no + 1) && set -q profile1[$next_line_no] && set -q profile2[$next_line_no]
-    set line_no $next_line_no
+	set line_no $next_line_no
 
-    set line1 $profile1[$line_no]
-    set line2 $profile2[$line_no]
+	set line1 $profile1[$line_no]
+	set line2 $profile2[$line_no]
 
-    if not string match -qr '^\d+\t\d+' $line1
-        echo $line1
-        continue
-    end
+	if not string match -qr '^\d+\t\d+' $line1
+		echo $line1
+		continue
+	end
 
-    set results1 (string match -r '^(\d+)\t(\d+)\s+(.*)' $line1)
-    set results2 (string match -r '^(\d+)\t(\d+)\s+(.*)' $line2)
+	set results1 (string match -r '^(\d+)\t(\d+)\s+(.*)' $line1)
+	set results2 (string match -r '^(\d+)\t(\d+)\s+(.*)' $line2)
 
-    # times from both files
-    set time1 $results1[2..3]
-    set time2 $results2[2..3]
+	# times from both files
+	set time1 $results1[2..3]
+	set time2 $results2[2..3]
 
-    # leftover from both files
-    set remainder1 $results1[4]
-    set remainder2 $results2[4]
+	# leftover from both files
+	set remainder1 $results1[4]
+	set remainder2 $results2[4]
 
-    if not string match -q -- $remainder1 $remainder2
-        echo Mismatch on line $line_no:
-        echo - $remainder1
-        echo + $remainder2
-        exit 1
-    end
+	if not string match -q -- $remainder1 $remainder2
+		echo Mismatch on line $line_no:
+		echo - $remainder1
+		echo + $remainder2
+		exit 1
+	end
 
-    set -l diff
-    set diff[1] (math $time1[1] - $time2[1])
-    set diff[2] (math $time1[2] - $time2[2])
+	set -l diff
+	set diff[1] (math $time1[1] - $time2[1])
+	set diff[2] (math $time1[2] - $time2[2])
 
-    echo $diff[1] $diff[2] $remainder1
+	echo $diff[1] $diff[2] $remainder1
 end

build_tools/find_globals.fish

@@ -4,22 +4,6 @@
 # for object files in this directory.
 # This was written for macOS nm.
 
-set FISH_SOURCE_DIR $argv[1]
-if not test -d "$FISH_SOURCE_DIR"
-    echo "FISH_SOURCE_DIR not given"
-    exit 1
-end
-
-set -g whitelist \
-    # unclear what this is \
-    l_constinit \
-    # hacks to work around missing ncurses strings on mac \
-    sitm_esc ritm_esc dim_esc \
-
-
-# In our nm regex, we are interested in data (dD) and bss (bB) segments.
-set -g nm_regex '^([^ ]+) ([dDbB])'
-
 set total_globals 0
 set boring_files \
     fish_key_reader.cpp.o \
@@ -27,86 +11,31 @@ set boring_files \
     fish_indent.cpp.o \
 
 
-# return if we should ignore the given symbol name
-function should_ignore
-    set symname $argv[1]
-    string match -q '*guard variable for*' $symname
-    and return 0
-    contains $symname $whitelist
-    and return 0
-    return 1
-end
+set whitelist \
+    termsize_lock termsize \
+    initial_pid initial_fg_process_group \
+    _debug_level \
+    sitm_esc ritm_esc dim_esc \
+    iothread_init()::inited \
+    s_result_queue s_main_thread_request_queue s_read_pipe s_write_pipe \
+    s_main_thread_performer_lock s_main_thread_performer_cond s_main_thread_request_q_lock \
+    locked_consumed_job_ids \
+    env_initialized \
 
-# echo a cleaned-up symbol name, e.g. replacing template gunk
-function cleanup_syname
-    set symname $argv[1]
-    set symname (string replace --all 'std::__1::basic_string<wchar_t, std::__1::char_traits<wchar_t>, std::__1::allocator<wchar_t> >' 'wcstring' $symname)
-    set symname (string replace --all 'std::__1::vector<wcstring, std::__1::allocator<wcstring > >' 'wcstring_list_t' $symname)
-    echo $symname
-end
-
-# Output the declaration for a symbol name in a given file.
-function print_decl
-    set -l objfile $argv[1]
-    set -l symname $argv[2]
-    set -l varname (string split '::' $symname)[-1]
-    set -l srcfile (basename $objfile .o)
-    set -l srcpath $FISH_SOURCE_DIR/src/$srcfile
-
-    # A leading underscore indicates a global, strip it.
-    set varname (string replace --regex '^_' '' $varname)
-
-    if not test -f "$srcpath"
-        echo "Could not find $srcpath"
-    end
-    # Guess the variable as the first usage of the name.
-    # Strip everything after the first =.
-    set vardecl (egrep -m 1 " $varname\\b" $srcpath | cut -f -1 -d '=' | string trim)
-    if test -z "$vardecl"
-        echo "COULD_NOT_FIND_$varname"
-        return 1
-    end
-    echo $vardecl
-    return 0
-end
-
-# Return if a variable declaration is "thread safe".
-function decl_is_threadsafe
-    set -l vardecl $argv[1]
-    # decls starting with 'const ' or containing ' const ' are assumed safe.
-    string match -q --regex '(^|\\*| )const ' $vardecl
-    and return 0
-
-    # Ordinary types indicating a safe variable.
-    set safes relaxed_atomic_bool_t std::mutex std::condition_variable std::once_flag sig_atomic_t
-    for safe in $safes
-        string match -q "*$safe*" $vardecl
-        and return 0
-    end
-
-    # Template types indicate a safe variable.
-    set safes owning_lock mainthread_t std::atomic relaxed_atomic_t latch_t
-    for safe in $safes
-        string match -q "*$safe<*" $vardecl
-        and return 0
-    end
-end
 
 for file in ./**.o
     set filename (basename $file)
     # Skip boring files.
     contains $filename $boring_files
     and continue
-    for line in (nm -p -P -U $file | egrep $nm_regex)
-        set matches (string match --regex $nm_regex -- $line)
+    for line in (nm -p -P -U $file)
+        # Look in data (dD) and bss (bB) segments.
+        set matches (string match --regex '^([^ ]+) ([dDbB])' -- $line)
         or continue
-        set symname (cleanup_syname (echo $matches[2] | c++filt))
-        should_ignore $symname
+        set symname (echo $matches[2] | c++filt)
+        contains $symname $whitelist
         and continue
-        set vardecl (print_decl $filename $symname)
-        decl_is_threadsafe $vardecl
-        and continue
-        echo $filename $symname $matches[3] ":" $vardecl
+        echo $filename $symname $matches[3]
         set total_globals (math $total_globals + 1)
     end
 end

build_tools/fish_xgettext.fish

@@ -1,8 +1,5 @@
 #!/usr/bin/env fish
 #
-# Tool to generate messages.pot
-# Extended to replace the old Makefile rule which did not port easily to CMak
-
 # This script was originally motivated to work around a quirk (or bug depending on your viewpoint)
 # of the xgettext command. See https://lists.gnu.org/archive/html/bug-gettext/2014-11/msg00006.html.
 # However, it turns out that even if that quirk did not exist we would still need something like
@@ -11,19 +8,14 @@
 # all the strings we want translated. So we extract and normalize all such strings into a format
 # that `xgettext` can handle.
 
-# Start with the C++ source
-xgettext -k -k_ -kN_ -LC++ --no-wrap -o messages.pot src/*.cpp src/*.h
-
 # This regex handles descriptions for `complete` and `function` statements. These messages are not
 # particularly important to translate. Hence the "implicit" label.
-set implicit_regex '(?:^| +)(?:complete|function).*? (?:-d|--description) (([\'"]).+?(?<!\\\\)\\2).*'
+set implicit_regex '(?:^| +)(?:complete|function) .*? (?:-d|--description) (([\'"]).+?(?<!\\\\)\\2).*'
 
 # This regex handles explicit requests to translate a message. These are more important to translate
 # than messages which should be implicitly translated.
 set explicit_regex '.*\( *_ (([\'"]).+?(?<!\\\\)\\2) *\).*'
 
-rm -r /tmp/fish
-
 mkdir -p /tmp/fish/implicit/share/completions /tmp/fish/implicit/share/functions
 mkdir -p /tmp/fish/explicit/share/completions /tmp/fish/explicit/share/functions
 
@@ -37,7 +29,7 @@ for f in share/config.fish share/completions/*.fish share/functions/*.fish
     rm /tmp/fish/explicit/$f.tmp
 
     # Handle `complete` / `function` description messages. The `| fish` is subtle. It basically
-    # avoids the need to use `source` with a command substitution that could affect the current
+    # avoids the need to use `source` with a command substituion that could affect the current
     # shell.
     string replace --filter --regex $implicit_regex 'echo $1' <$f | fish >/tmp/fish/implicit/$f.tmp ^/dev/null
     while read description
@@ -48,8 +40,3 @@ for f in share/config.fish share/completions/*.fish share/functions/*.fish
     end </tmp/fish/implicit/$f.tmp >/tmp/fish/implicit/$f
     rm /tmp/fish/implicit/$f.tmp
 end
-
-xgettext -j -k -kN_ -LShell --from-code=UTF-8 -cDescription --no-wrap -o messages.pot /tmp/fish/explicit/share/*/*.fish
-xgettext -j -k -kN_ -LShell --from-code=UTF-8 -cDescription --no-wrap -o messages.pot /tmp/fish/implicit/share/*/*.fish
-
-rm -r /tmp/fish

build_tools/git_version_gen.sh

@@ -6,8 +6,12 @@
 
 set -e
 
-# Find the fish directory as two levels up from script directory.
-FISH_BASE_DIR="$( cd "$( dirname "$( dirname "$0" )" )" && pwd )"
+# Find the fish git directory as two levels up from script directory.
+GIT_DIR="$( cd "$( dirname $( dirname "$0" ) )" && pwd )"
+
+# Set the output directory as either the first param or cwd.
+test -n "$1" && OUTPUT_DIR=$1/ || OUTPUT_DIR=
+FBVF=${OUTPUT_DIR}FISH-BUILD-VERSION-FILE
 DEF_VER=unknown
 
 # First see if there is a version file (included in release tarballs),
@@ -15,26 +19,15 @@ DEF_VER=unknown
 if test -f version
 then
 	VN=$(cat version) || VN="$DEF_VER"
-elif ! VN=$(git -C "$FISH_BASE_DIR" describe --always --dirty 2>/dev/null); then
+elif ! VN=$(git -C "$GIT_DIR" describe --always --dirty 2>/dev/null); then
 	VN="$DEF_VER"
 fi
 
-# If the first param is --stdout, then output to stdout and exit.
-if test "$1" = '--stdout'
-then
-	echo $VN
-    exit 0
-fi
-
-# Set the output directory as either the first param or cwd.
-test -n "$1" && OUTPUT_DIR=$1/ || OUTPUT_DIR=
-FBVF=${OUTPUT_DIR}FISH-BUILD-VERSION-FILE
-
 if test -r $FBVF
 then
 	VC=$(grep -v '^#' $FBVF | tr -d '"' | sed -e 's/^FISH_BUILD_VERSION=//')
 else
-	VC="unset"
+	VC=unset
 fi
 
 # Maybe output the FBVF

build_tools/lint.fish

@@ -3,17 +3,31 @@
 # This is meant to be run by "make lint" or "make lint-all". It is not meant to
 # be run directly from a shell prompt.
 #
-
-# We don't include "missingInclude" as that doesn't find our config.h.
-# Missing includes will quickly be found by... compiling the thing anyway.
-set cppchecks warning,performance,portability,information #,missingInclude
+set cppchecks warning,performance,portability,information,missingInclude
 set cppcheck_args
 set c_files
 set all no
 set kernel_name (uname -s)
 set machine_type (uname -m)
 
-argparse a/all -- $argv
+set -gx CXX $argv[1]
+set -e argv[1]
+
+if test "$argv[1]" = "--all"
+    set all yes
+    set cppchecks "$cppchecks,unusedFunction"
+    set -e argv[1]
+end
+
+if test $kernel_name = Linux
+    # This is an awful hack. However, the include-what-you-use program spews lots of errors like
+    #   /usr/include/unistd.h:226:10: fatal error: 'stddef.h' file not found
+    # if we don't explicitly tell it where to find the system headers on Linux. See
+    # http://stackoverflow.com/questions/19642590/libtooling-cant-find-stddef-h-nor-other-headers/
+    set -l sys_includes (eval $CXX -v -c src/builtin.cpp 2>&1 | \
+        sed -n -e '/^#include <...> search/,/^End of search list/s/^ *//p')[2..-2]
+    set -x CPLUS_INCLUDE_PATH (string join ':' $sys_includes)
+end
 
 # We only want -D and -I options to be passed thru to cppcheck.
 for arg in $argv
@@ -35,9 +49,8 @@ if test "$machine_type" = "x86_64"
     set cppcheck_args -D__x86_64__ -D__LP64__ $cppcheck_args
 end
 
-if set -q _flag_all
+if test $all = yes
     set c_files src/*.cpp
-    set cppchecks "$cppchecks,unusedFunction"
 else
     # We haven't been asked to lint all the source. If there are uncommitted
     # changes lint those, else lint the files in the most recent commit.
@@ -115,7 +128,26 @@ if set -q c_files[1]
         # The stderr to stdout redirection is because oclint, incorrectly writes its final summary
         # counts of the errors detected to stderr. Anyone running this who wants to capture its
         # output will expect those messages to be written to stdout.
-        oclint $c_files -- $argv 2>&1
+        if test "$kernel_name" = "Darwin"
+            if not test -f compile_commands.json
+                xcodebuild -alltargets >xcodebuild.log
+                oclint-xcodebuild xcodebuild.log >/dev/null
+            end
+            if test $all = yes
+                oclint-json-compilation-database -e '/pcre2-10.22/' -- -enable-global-analysis 2>&1
+            else
+                set i_files
+                for f in $c_files
+                    set i_files $i_files -i $f
+                end
+                echo oclint-json-compilation-database -e '/pcre2-10.22/' $i_files
+                oclint-json-compilation-database -e '/pcre2-10.22/' $i_files 2>&1
+            end
+        else
+            # Presumably we're on Linux or other platform not requiring special
+            # handling for oclint to work.
+            oclint $c_files -- $argv 2>&1
+        end
     end
 else
     echo

build_tools/list_committers_since.fish

@@ -20,8 +20,8 @@ set committers_from_tag (mktemp)
 # Unicode collation tables mean that this is fraught with danger; for example, the
 # "“" character will not case-fold in UTF-8 locales. sort suggests using the C locale!
 
-git log "$TAG" --format="%aN" --reverse | sort -u >$committers_to_tag
-git log "$TAG".. --format="%aN" --reverse | sort -u >$committers_from_tag
+git log "$TAG"   --format="%aN" --reverse | sort -u > $committers_to_tag
+git log "$TAG".. --format="%aN" --reverse | sort -u > $committers_from_tag
 
 echo New committers:
 echo (comm -13 $committers_to_tag $committers_from_tag)','

build_tools/littlecheck.py

@@ -1,431 +0,0 @@
-#!/usr/bin/env python
-
-""" Command line test driver. """
-
-from __future__ import unicode_literals
-
-import argparse
-import io
-import re
-import shlex
-import subprocess
-import sys
-
-# A regex showing how to run the file.
-RUN_RE = re.compile(r"\s*#\s*RUN:\s+(.*)\n")
-
-# A regex capturing lines that should be checked against stdout.
-CHECK_STDOUT_RE = re.compile(r"\s*#\s*CHECK:\s+(.*)\n")
-
-# A regex capturing lines that should be checked against stderr.
-CHECK_STDERR_RE = re.compile(r"\s*#\s*CHECKERR:\s+(.*)\n")
-
-
-class Config(object):
-    def __init__(self):
-        # Whether to have verbose output.
-        self.verbose = False
-        # Whether output gets ANSI colorization.
-        self.colorize = False
-
-    def colors(self):
-        """ Return a dictionary mapping color names to ANSI escapes """
-
-        def ansic(n):
-            return "\033[%dm" % n if self.colorize else ""
-
-        return {
-            "RESET": ansic(0),
-            "BOLD": ansic(1),
-            "NORMAL": ansic(39),
-            "BLACK": ansic(30),
-            "RED": ansic(31),
-            "GREEN": ansic(32),
-            "YELLOW": ansic(33),
-            "BLUE": ansic(34),
-            "MAGENTA": ansic(35),
-            "CYAN": ansic(36),
-            "LIGHTGRAY": ansic(37),
-            "DARKGRAY": ansic(90),
-            "LIGHTRED": ansic(91),
-            "LIGHTGREEN": ansic(92),
-            "LIGHTYELLOW": ansic(93),
-            "LIGHTBLUE": ansic(94),
-            "LIGHTMAGENTA": ansic(95),
-            "LIGHTCYAN": ansic(96),
-            "WHITE": ansic(97),
-        }
-
-
-def output(*args):
-    print("".join(args) + "\n")
-
-
-class CheckerError(Exception):
-    """Exception subclass for check line parsing.
-
-    Attributes:
-      line: the Line object on which the exception occurred.
-    """
-
-    def __init__(self, message, line=None):
-        super(CheckerError, self).__init__(message)
-        self.line = line
-
-
-class Line(object):
-    """ A line that remembers where it came from. """
-
-    def __init__(self, text, number, file):
-        self.text = text
-        self.number = number
-        self.file = file
-
-    def subline(self, text):
-        """ Return a substring of our line with the given text, preserving number and file. """
-        return Line(text, self.number, self.file)
-
-    @staticmethod
-    def readfile(file, name):
-        return [Line(text, idx + 1, name) for idx, text in enumerate(file)]
-
-    def is_empty_space(self):
-        return not self.text or self.text.isspace()
-
-
-class RunCmd(object):
-    """ A command to run on a given Checker.
-    
-    Attributes:
-        args: Unexpanded shell command as a string.
-    """
-
-    def __init__(self, args, line):
-        self.args = args
-        self.line = line
-
-    @staticmethod
-    def parse(line):
-        if not shlex.split(line.text):
-            raise CheckerError("Invalid RUN command", line)
-        return RunCmd(line.text, line)
-
-
-class TestFailure(object):
-    def __init__(self, line, check, testrun):
-        self.line = line
-        self.check = check
-        self.testrun = testrun
-        self.error_annotation_line = None
-
-    def message(self):
-        fields = self.testrun.config.colors()
-        fields["name"] = self.testrun.name
-        fields["subbed_command"] = self.testrun.subbed_command
-        if self.line:
-            fields.update(
-                {
-                    "output_file": self.line.file,
-                    "output_lineno": self.line.number,
-                    "output_line": self.line.text.rstrip("\n"),
-                }
-            )
-        if self.check:
-            fields.update(
-                {
-                    "input_file": self.check.line.file,
-                    "input_lineno": self.check.line.number,
-                    "input_line": self.check.line.text,
-                    "check_type": self.check.type,
-                }
-            )
-        fmtstrs = ["{RED}Failure{RESET} in {name}:", ""]
-        if self.line and self.check:
-            fmtstrs += [
-                "  The {check_type} on line {input_lineno} wants:",
-                "    {BOLD}{input_line}{RESET}",
-                "",
-                "  which failed to match line {output_file}:{output_lineno}:",
-                "    {BOLD}{output_line}{RESET}",
-                "",
-            ]
-
-        elif self.check:
-            fmtstrs += [
-                "  The {check_type} on line {input_lineno} wants:",
-                "    {BOLD}{input_line}{RESET}",
-                "",
-                "  but there was no remaining output to match.",
-                "",
-            ]
-        else:
-            fmtstrs += [
-                "  There were no remaining checks left to match {output_file}:{output_lineno}:",
-                "    {BOLD}{output_line}{RESET}",
-                "",
-            ]
-        if self.error_annotation_line:
-            fields["error_annotation"] = self.error_annotation_line.text
-            fields["error_annotation_lineno"] = self.error_annotation_line.number
-            fmtstrs += [
-                "  additional output on stderr:{error_annotation_lineno}:",
-                "    {BOLD}{error_annotation}{RESET}",
-            ]
-        fmtstrs += ["  when running command:", "    {subbed_command}"]
-        return "\n".join(fmtstrs).format(**fields)
-
-    def print_message(self):
-        """ Print our message to stdout. """
-        print(self.message())
-
-
-def perform_substitution(input_str, subs):
-    """ Perform the substitutions described by subs to str
-        Return the substituted string.
-    """
-    # Sort our substitutions into a list of tuples (key, value), descending by length.
-    # It needs to be descending because we need to try longer substitutions first.
-    subs_ordered = sorted(subs.items(), key=lambda s: len(s[0]), reverse=True)
-
-    def subber(m):
-        # We get the entire sequence of characters.
-        # Replace just the prefix and return it.
-        text = m.group(1)
-        for key, replacement in subs_ordered:
-            if text.startswith(key):
-                return replacement + text[len(key) :]
-        raise CheckerError("Unknown substitution: " + m.group(0))
-
-    return re.sub(r"%(%|[a-zA-Z0-9_-]+)", subber, input_str)
-
-
-class TestRun(object):
-    def __init__(self, name, runcmd, checker, subs, config):
-        self.name = name
-        self.runcmd = runcmd
-        self.subbed_command = perform_substitution(runcmd.args, subs)
-        self.checker = checker
-        self.subs = subs
-        self.config = config
-
-    def check(self, lines, checks):
-        # Reverse our lines and checks so we can pop off the end.
-        lineq = lines[::-1]
-        checkq = checks[::-1]
-        while lineq and checkq:
-            line = lineq[-1]
-            check = checkq[-1]
-            if check.regex.match(line.text):
-                # This line matched this checker, continue on.
-                lineq.pop()
-                checkq.pop()
-            elif line.is_empty_space():
-                # Skip all whitespace input lines.
-                lineq.pop()
-            else:
-                # Failed to match.
-                return TestFailure(line, check, self)
-        # Drain empties.
-        while lineq and lineq[-1].is_empty_space():
-            lineq.pop()
-        # If there's still lines or checkers, we have a failure.
-        # Otherwise it's success.
-        if lineq:
-            return TestFailure(lineq[-1], None, self)
-        elif checkq:
-            return TestFailure(None, checkq[-1], self)
-        else:
-            return None
-
-    def run(self):
-        """ Run the command. Return a TestFailure, or None. """
-
-        def split_by_newlines(s):
-            """ Decode a string and split it by newlines only,
-                retaining the newlines.
-            """
-            return [s + "\n" for s in s.decode("utf-8").split("\n")]
-
-        PIPE = subprocess.PIPE
-        if self.config.verbose:
-            print(self.subbed_command)
-        proc = subprocess.Popen(
-            self.subbed_command,
-            stdin=PIPE,
-            stdout=PIPE,
-            stderr=PIPE,
-            shell=True,
-            close_fds=True,  # For Python 2.6 as shipped on RHEL 6
-        )
-        stdout, stderr = proc.communicate()
-        outlines = [
-            Line(text, idx + 1, "stdout")
-            for idx, text in enumerate(split_by_newlines(stdout))
-        ]
-        errlines = [
-            Line(text, idx + 1, "stderr")
-            for idx, text in enumerate(split_by_newlines(stderr))
-        ]
-        outfail = self.check(outlines, self.checker.outchecks)
-        errfail = self.check(errlines, self.checker.errchecks)
-        # It's possible that something going wrong on stdout resulted in new
-        # text being printed on stderr. If we have an outfailure, and either
-        # non-matching or unmatched stderr text, then annotate the outfail
-        # with it.
-        if outfail and errfail and errfail.line:
-            outfail.error_annotation_line = errfail.line
-        return outfail if outfail else errfail
-
-
-class CheckCmd(object):
-    def __init__(self, line, checktype, regex):
-        self.line = line
-        self.type = checktype
-        self.regex = regex
-
-    @staticmethod
-    def parse(line, checktype):
-        # type: (Line) -> CheckCmd
-        # Everything inside {{}} is a regular expression.
-        # Everything outside of it is a literal string.
-        # Split around {{...}}. Then every odd index will be a regex, and
-        # evens will be literals.
-        # Note that if {{...}} appears first we will get an empty string in
-        # the split array, so the {{...}} matches are always at odd indexes.
-        bracket_re = re.compile(
-            r"""
-                \{\{   # Two open brackets
-                (.*?)  # Nongreedy capture
-                \}\}   # Two close brackets
-            """,
-            re.VERBOSE,
-        )
-        pieces = bracket_re.split(line.text)
-        even = True
-        re_strings = []
-        for piece in pieces:
-            if even:
-                # piece is a literal string.
-                re_strings.append(re.escape(piece))
-            else:
-                # piece is a regex (found inside {{...}}).
-                # Verify the regex can be compiled.
-                try:
-                    re.compile(piece)
-                except re.error:
-                    raise CheckerError("Invalid regular expression: '%s'" % piece, line)
-                re_strings.append(piece)
-            even = not even
-        # Enclose each piece in a non-capturing group.
-        # This ensures that lower-precedence operators don't trip up catenation.
-        # For example: {{b|c}}d would result in /b|cd/ which is different.
-        # Backreferences are assumed to match across the entire string.
-        re_strings = ["(?:%s)" % s for s in re_strings]
-        # Anchor at beginning and end (allowing arbitrary whitespace), and maybe
-        # a terminating newline.
-        # We need the anchors because Python's match() matches an arbitrary prefix,
-        # not the entire string.
-        re_strings = [r"^\s*"] + re_strings + [r"\s*\n?$"]
-        full_re = re.compile("".join(re_strings))
-        return CheckCmd(line, checktype, full_re)
-
-
-class Checker(object):
-    def __init__(self, name, lines):
-        self.name = name
-        # Helper to yield subline containing group1 from all matching lines.
-        def group1s(regex):
-            for line in lines:
-                m = regex.match(line.text)
-                if m:
-                    yield line.subline(m.group(1))
-
-        # Find run commands.
-        self.runcmds = [RunCmd.parse(sl) for sl in group1s(RUN_RE)]
-        if not self.runcmds:
-            raise CheckerError("No runlines ('# RUN') found")
-
-        # Find check cmds.
-        self.outchecks = [
-            CheckCmd.parse(sl, "CHECK") for sl in group1s(CHECK_STDOUT_RE)
-        ]
-        self.errchecks = [
-            CheckCmd.parse(sl, "CHECKERR") for sl in group1s(CHECK_STDERR_RE)
-        ]
-
-
-def check_file(input_file, name, subs, config, failure_handler):
-    """ Check a single file. Return a True on success, False on error. """
-    success = True
-    lines = Line.readfile(input_file, name)
-    checker = Checker(name, lines)
-    for runcmd in checker.runcmds:
-        failure = TestRun(name, runcmd, checker, subs, config).run()
-        if failure:
-            failure_handler(failure)
-            success = False
-    return success
-
-
-def check_path(path, subs, config, failure_handler):
-    with io.open(path, encoding="utf-8") as fd:
-        return check_file(fd, path, subs, config, failure_handler)
-
-
-def parse_subs(subs):
-    """ Given a list of input substitutions like 'foo=bar',
-       return a dictionary like {foo:bar}, or exit if invalid.
-    """
-    result = {}
-    for sub in subs:
-        try:
-            key, val = sub.split("=", 1)
-            if not key:
-                print("Invalid substitution %s: empty key" % sub)
-                sys.exit(1)
-            if not val:
-                print("Invalid substitution %s: empty value" % sub)
-                sys.exit(1)
-            result[key] = val
-        except ValueError:
-            print("Invalid substitution %s: equal sign not found" % sub)
-            sys.exit(1)
-    return result
-
-
-def get_argparse():
-    """ Return a littlecheck argument parser. """
-    parser = argparse.ArgumentParser(
-        description="littlecheck: command line tool tester."
-    )
-    parser.add_argument(
-        "-s",
-        "--substitute",
-        type=str,
-        help="Add a new substitution for RUN lines. Example: bash=/bin/bash",
-        action="append",
-        default=[],
-    )
-    parser.add_argument("file", nargs="+", help="File to check")
-    return parser
-
-
-def main():
-    args = get_argparse().parse_args()
-    # Default substitution is %% -> %
-    def_subs = {"%": "%"}
-    def_subs.update(parse_subs(args.substitute))
-
-    success = True
-    config = Config()
-    config.colorize = sys.stdout.isatty()
-    for path in args.file:
-        subs = def_subs.copy()
-        subs["s"] = path
-        if not check_path(path, subs, config, TestFailure.print_message):
-            success = False
-    sys.exit(0 if success else 1)
-
-
-if __name__ == "__main__":
-    main()

build_tools/make_pkg.sh

@@ -2,11 +2,13 @@
 
 # Script to produce an OS X installer .pkg and .app(.zip)
 
-VERSION=$(git describe --always --dirty 2>/dev/null)
+VERSION=`git describe --always --dirty 2>/dev/null`
 if test -z "$VERSION" ; then
   echo "Could not get version from git"
-  if test -f version; then
-    VERSION=$(cat version)
+  VERSION=`sed -E -n 's/^.*PACKAGE_VERSION "([0-9a-z.\-]+)"/\1/p' osx/config.h`
+  if test -z "$VERSION"; then
+    echo "Could not get version from osx/config.h"
+    exit 1
   fi
 fi
 
@@ -14,22 +16,26 @@ echo "Version is $VERSION"
 
 set -x
 
+make distclean
+
 #Exit on error
 set -e
 
-PKGDIR=$(mktemp -d)
+PKGDIR=`mktemp -d`
 
-SRC_DIR=$PWD
 OUTPUT_PATH=${FISH_ARTEFACT_PATH:-~/fish_built}
 
-mkdir -p "$PKGDIR/build" "$PKGDIR/root" "$PKGDIR/intermediates" "$PKGDIR/dst"
-{ cd "$PKGDIR/build" && cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo "$SRC_DIR" && make -j 4 && env DESTDIR="$PKGDIR/root/" make install; }
-pkgbuild --scripts "$SRC_DIR/build_tools/osx_package_scripts" --root "$PKGDIR/root/" --identifier 'com.ridiculousfish.fish-shell-pkg' --version "$VERSION" "$PKGDIR/intermediates/fish.pkg"
+mkdir -p $PKGDIR/root $PKGDIR/intermediates $PKGDIR/dst
+xcodebuild install -scheme install_tree -configuration Release DSTROOT=$PKGDIR/root/
+pkgbuild --scripts build_tools/osx_package_scripts --root $PKGDIR/root/ --identifier 'com.ridiculousfish.fish-shell-pkg' --version "$VERSION"  $PKGDIR/intermediates/fish.pkg
 
-productbuild  --package-path "$PKGDIR/intermediates" --distribution "$SRC_DIR/build_tools/osx_distribution.xml" --resources "$SRC_DIR/build_tools/osx_package_resources/" "$OUTPUT_PATH/fish-$VERSION.pkg"
+productbuild  --package-path $PKGDIR/intermediates --distribution build_tools/osx_distribution.xml --resources build_tools/osx_package_resources/ $OUTPUT_PATH/fish-$VERSION.pkg
 
 
 # Make the app
-{ cd "$PKGDIR/build" && make fish_macapp && zip -r "$OUTPUT_PATH/fish-$VERSION.app.zip" fish.app; }
+xcodebuild -scheme fish.app -configuration Release DSTROOT=/tmp/fish_app/ SYMROOT=DerivedData/fish/Build/Products
 
-rm -r "$PKGDIR"
+cd DerivedData/fish/Build/Products/Release/
+zip -r $OUTPUT_PATH/fish-$VERSION.app.zip fish.app
+
+rm -r $PKGDIR

build_tools/make_tarball.sh

@@ -2,7 +2,7 @@
 
 # Script to generate a tarball
 # We use git to output a tree. But we also want to build the user documentation
-# and put that in the tarball, so that nobody needs to have sphinx installed
+# and put that in the tarball, so that nobody needs to have doxygen installed
 # to build it.
 # Outputs to $FISH_ARTEFACT_PATH or ~/fish_built by default
 
@@ -14,7 +14,8 @@ set -e
 # but to get the documentation in, we need to make a symlink called "fish-VERSION"
 # and tar from that, so that the documentation gets the right prefix
 
-# We need GNU tar as that supports the --mtime and --transform options
+# We need GNU tar as that supports the --mtime option
+# BSD tar supports --mtree but keeping them in sync sounds too hard
 TAR=notfound
 for try in tar gtar gnutar; do
   if $try -Pcf /dev/null --mtime now /dev/null >/dev/null 2>&1; then
@@ -32,7 +33,7 @@ fi
 wd="$PWD"
 
 # Get the version from git-describe
-VERSION=$(git describe --dirty 2>/dev/null)
+VERSION=`git describe --dirty 2>/dev/null`
 
 # The name of the prefix, which is the directory that you get when you untar
 prefix="fish-$VERSION"
@@ -47,21 +48,26 @@ rm -f "$path" "$path".gz
 # git starts the archive
 git archive --format=tar --prefix="$prefix"/ HEAD > "$path"
 
-# tarball out the documentation, generate a version file
-PREFIX_TMPDIR=$(mktemp -d)
-cd "$PREFIX_TMPDIR"
-echo "$VERSION" > version
-cmake "$wd"
-make doc
+# tarball out the documentation, generate a configure script and version file
+autoreconf --no-recursive
+./configure --with-doxygen
+make doc share/man
+echo $VERSION > version
 
-TAR_APPEND="$TAR --append --file=$path --mtime=now --owner=0 --group=0 \
-  --mode=g+w,a+rX --transform s/^/$prefix\//"
-$TAR_APPEND --no-recursion user_doc
-$TAR_APPEND user_doc/html user_doc/man
-$TAR_APPEND version
+PREFIX_TMPDIR=`mktemp -d`
+cd $PREFIX_TMPDIR
+
+ln -s "$wd" "$prefix"
+TAR_APPEND="$TAR --append --file=$path --mtime=now --owner=0 --group=0 --mode=g+w,a+rX"
+$TAR_APPEND --no-recursion "$prefix"/user_doc
+$TAR_APPEND "$prefix"/user_doc/html "$prefix"/share/man
+$TAR_APPEND "$prefix"/version
+$TAR_APPEND "$prefix"/configure "$prefix"/config.h.in
+rm "$prefix"/version
+unlink "$prefix"
 
 cd -
-rm -r "$PREFIX_TMPDIR"
+rmdir $PREFIX_TMPDIR
 
 # gzip it
 gzip "$path"

build_tools/style.fish

@@ -1,12 +1,14 @@
 #!/usr/bin/env fish
 #
+# This is meant to be run by "make style" or "make style-all". It is not meant to
+# be run directly from a shell prompt although it can be.
+#
 # This runs C++ files and fish scripts (*.fish) through their respective code
 # formatting programs.
 #
 set git_clang_format no
 set c_files
-set fish_files
-set python_files
+set f_files
 set all no
 
 if test "$argv[1]" = "--all"
@@ -23,13 +25,15 @@ if test $all = yes
     set files (git status --porcelain --short --untracked-files=all | sed -e 's/^ *[^ ]* *//')
     if set -q files[1]
         echo
-        echo You have uncommitted changes. Cowardly refusing to restyle the entire code base.
+        echo You have uncommited changes. Cowardly refusing to restyle the entire code base.
         echo
         exit 1
     end
     set c_files src/*.h src/*.cpp src/*.c
-    set fish_files (printf '%s\n' share/***.fish)
-    set python_files **.py
+    # For now we don't restyle all fish scripts other than completion scripts. That's because people
+    # really like to vertically align the elements of the `complete` command and fish_indent
+    # currently does not honor that whitespace.
+    set f_files (printf '%s\n' share/***.fish | grep -v /completions/)
 else
     # We haven't been asked to reformat all the source. If there are uncommitted changes reformat
     # those using `git clang-format`. Else reformat the files in the most recent commit.
@@ -48,20 +52,17 @@ else
         test -f $file; and set c_files $c_files $file
     end
     # Extract just the fish files.
-    set fish_files (string match -r '^.*\.fish$' -- $files)
-    set python_files (string match -r '^.*\.py$' -- $files)
+    set f_files (string match -r '^.*\.fish$' -- $files)
 end
 
-set -l red (set_color red)
-set -l green (set_color green)
-set -l blue (set_color blue)
-set -l normal (set_color normal)
-
 # Run the C++ reformatter if we have any C++ files.
 if set -q c_files[1]
     if test $git_clang_format = yes
         if type -q git-clang-format
-            echo === Running "$red"git-clang-format"$normal"
+            echo
+            echo ========================================
+            echo Running git-clang-format
+            echo ========================================
             git add $c_files
             git-clang-format
         else
@@ -70,7 +71,10 @@ if set -q c_files[1]
             echo
         end
     else if type -q clang-format
-        echo === Running "$red"clang-format"$normal"
+        echo
+        echo ========================================
+        echo Running clang-format
+        echo ========================================
         for file in $c_files
             cp $file $file.new # preserves mode bits
             clang-format $file >$file.new
@@ -89,22 +93,23 @@ if set -q c_files[1]
 end
 
 # Run the fish reformatter if we have any fish files.
-if set -q fish_files[1]
+if set -q f_files[1]
     if not type -q fish_indent
         make fish_indent
         set PATH . $PATH
     end
-    echo === Running "$green"fish_indent"$normal"
-    fish_indent -w -- $fish_files
-end
-
-if set -q python_files[1]
-    if not type -q black
-        echo
-        echo Please install "`black`" to style python
-        echo
-    else
-        echo === Running "$blue"black"$normal"
-        black $python_files
+    echo
+    echo ========================================
+    echo Running fish_indent
+    echo ========================================
+    for file in $f_files
+        cp $file $file.new # preserves mode bits
+        fish_indent <$file >$file.new
+        if cmp --quiet $file $file.new
+            rm $file.new
+        else
+            echo $file was NOT correctly formatted
+            mv $file.new $file
+        end
     end
 end

build_tools/ubsan.blacklist

@@ -1,3 +0,0 @@
-# Ubuntu Xenial (used for Travis CI builds) ships libstdc++ 5.4.0 which contains undefined behaviour
-# See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=63345
-object-size:*bits/stl_tree.h

build_tools/xcode_version_gen.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+# Expects to be called from Xcode (Run Script build phase),
+# write version number C preprocessor macro to header file.
+
+ver="$SCRIPT_OUTPUT_FILE_0"
+
+./build_tools/git_version_gen.sh
+
+cmp --quiet "FISH-BUILD-VERSION-FILE" "$ver"
+if [ $? -ne 0 ]; then
+    /bin/cp FISH-BUILD-VERSION-FILE "$ver"
+fi

cmake/Benchmark.cmake

@@ -1,6 +0,0 @@
-# Support for benchmarking fish.
-
-ADD_CUSTOM_TARGET(benchmark
-    COMMAND ${CMAKE_SOURCE_DIR}/benchmarks/driver.sh $<TARGET_FILE:fish>
-    USES_TERMINAL
-)

cmake/ConfigureChecks.cmake

@@ -1,30 +1,5 @@
-# The following defines affect the environment configuration tests are run in:
-# CMAKE_REQUIRED_DEFINITIONS, CMAKE_REQUIRED_FLAGS, CMAKE_REQUIRED_LIBRARIES,
-# and CMAKE_REQUIRED_INCLUDES
-# `wcstod_l` is a GNU-extension, sometimes hidden behind GNU-related defines.
-# This is the case for at least Cygwin and Newlib.
-LIST(APPEND CMAKE_REQUIRED_DEFINITIONS -D_GNU_SOURCE=1)
-
-IF(APPLE)
-    INCLUDE(CheckCXXCompilerFlag)
-    CHECK_CXX_COMPILER_FLAG("-Werror=unguarded-availability" REQUIRES_UNGUARDED_AVAILABILITY)
-    IF(REQUIRES_UNGUARDED_AVAILABILITY)
-        LIST(APPEND CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS} "-Werror=unguarded-availability")
-    ENDIF()
-ENDIF()
-
-# Try using CMake's own logic to locate curses/ncurses
-FIND_PACKAGE(Curses)
-IF(NOT ${CURSES_FOUND})
-    # CMake has trouble finding platform-specific system libraries
-    # installed to multiarch paths (e.g. /usr/lib/x86_64-linux-gnu)
-    # if not symlinked or passed in as a manual define.
-    MESSAGE("Falling back to pkg-config for (n)curses detection")
-    INCLUDE(FindPkgConfig)
-    PKG_SEARCH_MODULE(CURSES REQUIRED ncurses curses)
-    SET(CURSES_CURSES_LIBRARY ${CURSES_LIBRARIES})
-    SET(CURSES_LIBRARY ${CURSES_LIBRARIES})
-ENDIF()
+# Detect curses.
+FIND_PACKAGE(Curses REQUIRED)
 
 # Get threads.
 set(THREADS_PREFER_PTHREAD_FLAG ON)
@@ -34,6 +9,11 @@ IF(CMAKE_VERSION VERSION_LESS 3.4.0)
 ENDIF()
 FIND_PACKAGE(Threads REQUIRED)
 
+IF(APPLE)
+  # 10.7+ only.
+  SET(CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS} "-Werror=unguarded-availability")
+ENDIF()
+
 # Detect WSL. Does not match against native Windows/WIN32.
 if (CMAKE_HOST_SYSTEM_VERSION MATCHES ".*-Microsoft")
   SET(WSL 1)
@@ -62,7 +42,6 @@ CHECK_CXX_SYMBOL_EXISTS(futimens sys/stat.h HAVE_FUTIMENS)
 CHECK_CXX_SYMBOL_EXISTS(futimes sys/time.h HAVE_FUTIMES)
 CHECK_CXX_SYMBOL_EXISTS(getifaddrs ifaddrs.h HAVE_GETIFADDRS)
 CHECK_CXX_SYMBOL_EXISTS(getpwent pwd.h HAVE_GETPWENT)
-CHECK_CXX_SYMBOL_EXISTS(getrusage sys/resource.h HAVE_GETRUSAGE)
 CHECK_CXX_SYMBOL_EXISTS(gettext libintl.h HAVE_GETTEXT)
 CHECK_CXX_SYMBOL_EXISTS(killpg "sys/types.h;signal.h" HAVE_KILLPG)
 CHECK_CXX_SYMBOL_EXISTS(lrand48_r stdlib.h HAVE_LRAND48_R)
@@ -71,14 +50,13 @@ CHECK_CXX_SYMBOL_EXISTS(mkostemp "stdlib.h;unistd.h" HAVE_MKOSTEMP)
 SET(HAVE_CURSES_H ${CURSES_HAVE_CURSES_H})
 SET(HAVE_NCURSES_CURSES_H ${CURSES_HAVE_NCURSES_CURSES_H})
 SET(HAVE_NCURSES_H ${CURSES_HAVE_NCURSES_H})
-IF(HAVE_CURSES_H)
-    CHECK_INCLUDE_FILES("curses.h;term.h" HAVE_TERM_H)
-ENDIF()
-IF(NOT HAVE_TERM_H)
-    CHECK_INCLUDE_FILE_CXX("ncurses/term.h" HAVE_NCURSES_TERM_H)
-ENDIF()
+CHECK_INCLUDE_FILES("curses.h;term.h" HAVE_TERM_H)
+CHECK_INCLUDE_FILE_CXX("ncurses/term.h" HAVE_NCURSES_TERM_H)
 CHECK_INCLUDE_FILE_CXX(siginfo.h HAVE_SIGINFO_H)
 CHECK_INCLUDE_FILE_CXX(spawn.h HAVE_SPAWN_H)
+CHECK_CXX_SYMBOL_EXISTS(std::wcscasecmp wchar.h HAVE_STD__WCSCASECMP)
+CHECK_CXX_SYMBOL_EXISTS(std::wcsdup wchar.h HAVE_STD__WCSDUP)
+CHECK_CXX_SYMBOL_EXISTS(std::wcsncasecmp wchar.h HAVE_STD__WCSNCASECMP)
 CHECK_STRUCT_HAS_MEMBER("struct stat" st_ctime_nsec "sys/stat.h" HAVE_STRUCT_STAT_ST_CTIME_NSEC
     LANGUAGE CXX)
 CHECK_STRUCT_HAS_MEMBER("struct stat" st_mtimespec.tv_nsec "sys/stat.h"
@@ -90,45 +68,39 @@ CHECK_INCLUDE_FILE_CXX(sys/ioctl.h HAVE_SYS_IOCTL_H)
 CHECK_INCLUDE_FILE_CXX(sys/select.h HAVE_SYS_SELECT_H)
 CHECK_INCLUDE_FILES("sys/types.h;sys/sysctl.h" HAVE_SYS_SYSCTL_H)
 CHECK_INCLUDE_FILE_CXX(termios.h HAVE_TERMIOS_H) # Needed for TIOCGWINSZ
-
 CHECK_CXX_SYMBOL_EXISTS(wcscasecmp wchar.h HAVE_WCSCASECMP)
 CHECK_CXX_SYMBOL_EXISTS(wcsdup wchar.h HAVE_WCSDUP)
 CHECK_CXX_SYMBOL_EXISTS(wcslcpy wchar.h HAVE_WCSLCPY)
 CHECK_CXX_SYMBOL_EXISTS(wcsncasecmp wchar.h HAVE_WCSNCASECMP)
 CHECK_CXX_SYMBOL_EXISTS(wcsndup wchar.h HAVE_WCSNDUP)
 
-# These are for compatibility with Solaris 10, which places the following
-# in the std namespace.
-IF(NOT HAVE_WCSNCASECMP)
-    CHECK_CXX_SYMBOL_EXISTS(std::wcscasecmp wchar.h HAVE_STD__WCSCASECMP)
-ENDIF()
-IF(NOT HAVE_WCSDUP)
-    CHECK_CXX_SYMBOL_EXISTS(std::wcsdup wchar.h HAVE_STD__WCSDUP)
-ENDIF()
-IF(NOT HAVE_WCSNCASECMP)
-    CHECK_CXX_SYMBOL_EXISTS(std::wcsncasecmp wchar.h HAVE_STD__WCSNCASECMP)
-ENDIF()
-
-# `xlocale.h` is required to find `wcstod_l` in `wchar.h` under FreeBSD,
-# but it's not present under Linux.
+CMAKE_PUSH_CHECK_STATE(RESET)
+# `wcstod_l` is a GNU-extension, sometimes hidden behind the following define
+LIST(APPEND CMAKE_REQUIRED_DEFINITIONS -D_GNU_SOURCE=1)
+# `xlocale.h` is required to find `wcstod_l` in `wchar.h` under FreeBSD, but
+# it's not present under Linux.
+SET(WCSTOD_L_INCLUDES "")
 CHECK_INCLUDE_FILES("xlocale.h" HAVE_XLOCALE_H)
 IF(HAVE_XLOCALE_H)
     LIST(APPEND WCSTOD_L_INCLUDES "xlocale.h")
 ENDIF()
 LIST(APPEND WCSTOD_L_INCLUDES "wchar.h")
 CHECK_CXX_SYMBOL_EXISTS(wcstod_l "${WCSTOD_L_INCLUDES}" HAVE_WCSTOD_L)
+CMAKE_POP_CHECK_STATE()
 
 CHECK_CXX_SYMBOL_EXISTS(_sys_errs stdlib.h HAVE__SYS__ERRS)
 
-CMAKE_PUSH_CHECK_STATE()
 SET(CMAKE_EXTRA_INCLUDE_FILES termios.h sys/ioctl.h)
 CHECK_TYPE_SIZE("struct winsize" STRUCT_WINSIZE LANGUAGE CXX)
 CHECK_CXX_SYMBOL_EXISTS("TIOCGWINSZ" "termios.h;sys/ioctl.h" HAVE_TIOCGWINSZ)
 IF(STRUCT_WINSIZE GREATER -1 AND HAVE_TIOCGWINSZ EQUAL 1)
   SET(HAVE_WINSIZE 1)
 ENDIF()
-CMAKE_POP_CHECK_STATE()
+SET(CMAKE_EXTRA_INCLUDE_FILES)
 
+IF(EXISTS "/proc/self/stat")
+  SET(HAVE__PROC_SELF_STAT 1)
+ENDIF()
 CHECK_TYPE_SIZE("wchar_t[8]" WCHAR_T_BITS LANGUAGE CXX)
 
 # Solaris, NetBSD and X/Open-conforming systems have a fixed-args tparm
@@ -147,8 +119,7 @@ ELSEIF(HAVE_NCURSES_TERM_H)
   SET(TPARM_INCLUDES "${TPARM_INCLUDES}#include <ncurses/term.h>\n")
 ENDIF()
 
-CMAKE_PUSH_CHECK_STATE()
-LIST(APPEND CMAKE_REQUIRED_LIBRARIES ${CURSES_LIBRARY})
+SET(CMAKE_REQUIRED_LIBRARIES ${CURSES_LIBRARY})
 CHECK_CXX_SOURCE_COMPILES("
 ${TPARM_INCLUDES}
 
@@ -158,32 +129,9 @@ int main () {
 "
   TPARM_TAKES_VARARGS
 )
+SET(CMAKE_REQUIRED_LIBRARIES)
 IF(NOT TPARM_TAKES_VARARGS)
-  CHECK_CXX_SOURCE_COMPILES("
-${TPARM_INCLUDES}
-#define TPARM_VARARGS
-
-int main () {
-  tparm( \"\" );
-}
-"
-    TPARM_TAKES_VARARGS_WITH_VARARGS
-    )
-  IF(NOT TPARM_TAKES_VARARGS)
-    SET(TPARM_SOLARIS_KLUDGE 1)
-  ELSE()
-    SET(TPARM_VARARGS 1)
-  ENDIF()
-ENDIF()
-CMAKE_POP_CHECK_STATE()
-
-# Work around the fact that cmake does not propagate the language standard flag into
-# the CHECK_CXX_SOURCE_COMPILES function. See CMake issue #16456.
-# Ensure we do this after the FIND_PACKAGE calls which use C, and will error on a C++
-# standards flag.
-# Also see https://github.com/fish-shell/fish-shell/issues/5865
-IF(NOT POLICY CMP0067)
-  LIST(APPEND CMAKE_REQUIRED_FLAGS "${CMAKE_CXX${CMAKE_CXX_STANDARD}_EXTENSION_COMPILE_OPTION}")
+  SET(TPARM_SOLARIS_KLUDGE 1)
 ENDIF()
 
 CHECK_CXX_SOURCE_COMPILES("
@@ -197,15 +145,3 @@ int main () {
 )
 
 FIND_PROGRAM(SED sed)
-
-CHECK_CXX_SOURCE_COMPILES("
-#include <atomic>
-#include <cstdint>
-std::atomic<uint64_t> x;
-int main() {
-   return x;
-}"
-LIBATOMIC_NOT_NEEDED)
-IF (NOT LIBATOMIC_NOT_NEEDED)
-    SET(ATOMIC_LIBRARY "atomic")
-ENDIF()

cmake/Docs.cmake

@@ -1,59 +1,19 @@
-FIND_PROGRAM(SPHINX_EXECUTABLE NAMES sphinx-build
-    HINTS
-    $ENV{SPHINX_DIR}
-    PATH_SUFFIXES bin
-    DOC "Sphinx documentation generator")
+FIND_PACKAGE(Doxygen 1.8.7)
 
 INCLUDE(FeatureSummary)
 
-SET(SPHINX_SRC_DIR "${CMAKE_CURRENT_SOURCE_DIR}/sphinx_doc_src")
-SET(SPHINX_ROOT_DIR "${CMAKE_CURRENT_BINARY_DIR}/user_doc")
-SET(SPHINX_BUILD_DIR "${SPHINX_ROOT_DIR}/build")
-SET(SPHINX_CACHE_DIR "${SPHINX_ROOT_DIR}/doctrees")
-SET(SPHINX_HTML_DIR "${SPHINX_ROOT_DIR}/html")
-SET(SPHINX_MANPAGE_DIR "${SPHINX_ROOT_DIR}/man")
+IF(DOXYGEN_FOUND)
+    OPTION(BUILD_DOCS "build documentation (requires Doxygen)" ON)
+ELSE(DOXYGEN_FOUND)
+    OPTION(BUILD_DOCS "build documentation (requires Doxygen)" OFF)
+ENDIF(DOXYGEN_FOUND)
 
-# sphinx-docs uses fish_indent for highlighting.
-# Prepend the output dir of fish_indent to PATH.
-ADD_CUSTOM_TARGET(sphinx-docs
-    mkdir -p ${SPHINX_HTML_DIR}/_static/
-    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${SPHINX_SRC_DIR}/_static/pygments.css ${SPHINX_HTML_DIR}/_static/
-    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${SPHINX_SRC_DIR}/_static/custom.css ${SPHINX_HTML_DIR}/_static/
-    COMMAND env PATH="$<TARGET_FILE_DIR:fish_indent>:$$PATH"
-        ${SPHINX_EXECUTABLE}
-        -q -b html
-        -c "${SPHINX_SRC_DIR}"
-        -d "${SPHINX_CACHE_DIR}"
-        "${SPHINX_SRC_DIR}"
-        "${SPHINX_HTML_DIR}"
-    DEPENDS sphinx_doc_src/fish_indent_lexer.py fish_indent
-    COMMENT "Building HTML documentation with Sphinx")
-
-# sphinx-manpages needs the fish_indent binary for the version number
-ADD_CUSTOM_TARGET(sphinx-manpages
-    env PATH="$<TARGET_FILE_DIR:fish_indent>:$$PATH"
-        ${SPHINX_EXECUTABLE}
-        -q -b man
-        -c "${SPHINX_SRC_DIR}"
-        -d "${SPHINX_CACHE_DIR}"
-        "${SPHINX_SRC_DIR}"
-        # TODO: This only works if we only have section 1 manpages.
-        "${SPHINX_MANPAGE_DIR}/man1"
-    DEPENDS fish_indent
-    COMMENT "Building man pages with Sphinx")
-
-IF(SPHINX_EXECUTABLE)
-    OPTION(BUILD_DOCS "build documentation (requires Sphinx)" ON)
-ELSE(SPHINX_EXECUTABLE)
-    OPTION(BUILD_DOCS "build documentation (requires Sphinx)" OFF)
-ENDIF(SPHINX_EXECUTABLE)
-
-IF(BUILD_DOCS AND NOT SPHINX_EXECUTABLE)
-    MESSAGE(FATAL_ERROR "build documentation selected, but sphinx-build could not be found")
+IF(BUILD_DOCS AND NOT DOXYGEN_FOUND)
+    MESSAGE(FATAL_ERROR "build documentation selected, but Doxygen could not be found")
 ENDIF()
 
 IF(IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/user_doc/html
-   AND IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/user_doc/man)
+   AND IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/share/man/man1)
     SET(HAVE_PREBUILT_DOCS TRUE)
 ELSE()
     SET(HAVE_PREBUILT_DOCS FALSE)
@@ -68,18 +28,121 @@ ENDIF()
 ADD_FEATURE_INFO(Documentation INSTALL_DOCS "user manual and documentation")
 
 IF(BUILD_DOCS)
-    CONFIGURE_FILE("${SPHINX_SRC_DIR}/conf.py" "${SPHINX_BUILD_DIR}/conf.py" @ONLY)
+    # Files in ./share/completions/
+    FILE(GLOB COMPLETIONS_DIR_FILES share/completions/*.fish)
+
+    # Files in ./share/functions/
+    FILE(GLOB FUNCTIONS_DIR_FILES share/functions/*.fish)
+
+    # Files in doc_src
+    FILE(GLOB DOC_SRC_FILES doc_src/*)
+
+    # .txt files in doc_src
+    FILE(GLOB HELP_SRC doc_src/*.txt)
+
+    # These files are the source files, they contain a few @FOO@-style substitutions.
+    # Note that this order defines the order that they appear in the documentation.
+    SET(HDR_FILES_SRC doc_src/index.hdr.in doc_src/tutorial.hdr doc_src/design.hdr
+                      doc_src/license.hdr doc_src/commands.hdr.in doc_src/faq.hdr)
+
+    # These are the generated result files.
+    STRING(REPLACE ".in" "" HDR_FILES "${HDR_FILES_SRC}")
+
+    # Header files except for index.hdr
+    SET(HDR_FILES_NO_INDEX ${HDR_FILES})
+    LIST(REMOVE_ITEM HDR_FILES_NO_INDEX doc_src/index.hdr)
+
+    # Copy doc_src files
+    FILE(COPY ${DOC_SRC_FILES} DESTINATION doc_src)
+
+    # Build lexicon_filter.
+    ADD_CUSTOM_COMMAND(OUTPUT lexicon_filter
+                       COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/build_tools/build_lexicon_filter.sh
+                                  ${CMAKE_CURRENT_SOURCE_DIR}/share/functions/
+                                  ${CMAKE_CURRENT_SOURCE_DIR}/share/completions/
+                                  ${CMAKE_CURRENT_SOURCE_DIR}/lexicon_filter.in
+                                  ${SED}
+                                  > ${CMAKE_CURRENT_BINARY_DIR}/lexicon_filter
+                                    && chmod a+x ${CMAKE_CURRENT_BINARY_DIR}/lexicon_filter
+                      WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+                      DEPENDS ${FUNCTIONS_DIR_FILES} ${COMPLETIONS_DIR_FILES}
+                              doc_src/commands.hdr ${CMAKE_CURRENT_SOURCE_DIR}/lexicon_filter.in
+                              share/functions/__fish_config_interactive.fish
+                              build_tools/build_lexicon_filter.sh command_list_toc.txt)
+
+    # Other targets should depend on this target, otherwise the lexicon
+    # filter can be built twice.
+    ADD_CUSTOM_TARGET(build_lexicon_filter DEPENDS lexicon_filter)
+
+    #
+    # commands.hdr collects documentation on all commands, functions and
+    # builtins
+    #
+    FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc_src)
+    ADD_CUSTOM_COMMAND(OUTPUT doc_src/commands.hdr command_list_toc.txt
+                       WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+                       COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/build_tools/build_commands_hdr.sh ${HELP_SRC}
+                                   < doc_src/commands.hdr.in
+                                   > ${CMAKE_CURRENT_BINARY_DIR}/doc_src/commands.hdr
+                       DEPENDS ${HELP_SRC}
+                               ${CMAKE_CURRENT_SOURCE_DIR}/doc_src/commands.hdr.in
+                               ${CMAKE_CURRENT_SOURCE_DIR}/build_tools/build_commands_hdr.sh)
+
+    # doc.h is a compilation of the various snippets of text used both for
+    # the user documentation and for internal help functions into a single
+    # file that can be parsed by Doxygen to generate the user
+    # documentation.
+    ADD_CUSTOM_COMMAND(OUTPUT doc.h
+                       COMMAND cat ${HDR_FILES} > ${CMAKE_CURRENT_BINARY_DIR}/doc.h
+                       DEPENDS ${HDR_FILES})
+
+    # toc.txt: $(HDR_FILES:index.hdr=index.hdr.in) build_tools/build_toc_txt.sh | show-SED
+    #   FISH_BUILD_VERSION=${FISH_BUILD_VERSION} build_tools/build_toc_txt.sh \
+    #     $(HDR_FILES:index.hdr=index.hdr.in) > toc.txt
+    # Note we would like to add doc_src/index.hdr.in as a dependency but CMake replaces this with
+    # doc_src/index.hdr; CMake bug?
+    ADD_CUSTOM_COMMAND(OUTPUT toc.txt
+                       COMMAND env `cat ${FBVF} | tr -d '\"'` ${CMAKE_CURRENT_SOURCE_DIR}/build_tools/build_toc_txt.sh
+                               doc_src/index.hdr.in ${HDR_FILES_NO_INDEX}
+                               > ${CMAKE_CURRENT_BINARY_DIR}/toc.txt
+                       DEPENDS ${CFBVF} ${HDR_FILES_NO_INDEX})
+
+    # doc_src/index.hdr: toc.txt doc_src/index.hdr.in | show-AWK
+    # @echo "  AWK CAT  $(em)$@$(sgr0)"
+    # $v cat $@.in | $(AWK) '{if ($$0 ~ /@toc@/){ system("cat toc.txt");} else{ print $$0;}}' >$@
+    ADD_CUSTOM_COMMAND(OUTPUT doc_src/index.hdr
+                       COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/build_tools/build_index_hdr.sh toc.txt
+                               < doc_src/index.hdr.in
+                               > ${CMAKE_CURRENT_BINARY_DIR}/doc_src/index.hdr
+                       DEPENDS toc.txt)
+
+    # doc: $(HDR_FILES_SRC) Doxyfile.user $(HTML_SRC) $(HELP_SRC) doc.h $(HDR_FILES) lexicon_filter
+    #   @echo "  doxygen  $(em)user_doc$(sgr0)"
+    #   $v (cat Doxyfile.user; echo INPUT_FILTER=./lexicon_filter; echo PROJECT_NUMBER=$(FISH_BUILD_VERSION) | $(SED) "s/-.*//") | doxygen - && touch user_doc
+    #   $v rm -f $(wildcard $(addprefix ./user_doc/html/,arrow*.png bc_s.png bdwn.png closed.png doc.png folder*.png ftv2*.png nav*.png open.png splitbar.png sync_*.png tab*.* doxygen.* dynsections.js jquery.js pages.html))
     ADD_CUSTOM_TARGET(doc ALL
-                      DEPENDS sphinx-docs sphinx-manpages)
+                      COMMAND env `cat ${FBVF}`
+                              ${CMAKE_CURRENT_SOURCE_DIR}/build_tools/build_user_doc.sh
+                              ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.user ./lexicon_filter
+                      DEPENDS ${CFBVF} Doxyfile.user ${DOC_SRC_FILES} doc.h ${HDR_FILES} build_lexicon_filter command_list_toc.txt)
+
+    ADD_CUSTOM_COMMAND(OUTPUT share/man/
+                       COMMAND env `cat ${FBVF} | tr -d '\"' `
+                               INPUT_FILTER=lexicon_filter ${CMAKE_CURRENT_SOURCE_DIR}/build_tools/build_documentation.sh ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.help doc_src ./share
+                       DEPENDS ${CFBVF} ${HELP_SRC} build_lexicon_filter)
+
+    ADD_CUSTOM_TARGET(BUILD_MANUALS ALL DEPENDS share/man/)
 
     # Group docs targets into a DocsTargets folder
-    SET_PROPERTY(TARGET doc sphinx-docs sphinx-manpages
+    SET_PROPERTY(TARGET doc BUILD_MANUALS build_lexicon_filter
                  PROPERTY FOLDER cmake/DocTargets)
-
 ELSEIF(HAVE_PREBUILT_DOCS)
     IF(NOT CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR)
         # Out of tree build - link the prebuilt documentation to the build tree
         ADD_CUSTOM_TARGET(link_doc ALL)
+        ADD_CUSTOM_COMMAND(TARGET link_doc
+            COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_SOURCE_DIR}/share/man ${CMAKE_CURRENT_BINARY_DIR}/share/man
+            POST_BUILD)
         ADD_CUSTOM_COMMAND(TARGET link_doc
             COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_SOURCE_DIR}/user_doc ${CMAKE_CURRENT_BINARY_DIR}/user_doc
             POST_BUILD)

cmake/Install.cmake

@@ -25,37 +25,37 @@ SET(configure_input
  DO NOT MANUALLY EDIT THIS FILE!")
 
 SET(extra_completionsdir
-    /usr/local/share/fish/vendor_completions.d
+    ${datadir}/fish/vendor_completions.d
     CACHE STRING "Path for extra completions")
 
 SET(extra_functionsdir
-    /usr/local/share/fish/vendor_functions.d
-    CACHE STRING "Path for extra functions")
+    ${datadir}/fish/vendor_functions.d
+    CACHE STRING "Path for extra completions")
 
 SET(extra_confdir
-    /usr/local/share/fish/vendor_conf.d
+    ${datadir}/fish/vendor_conf.d
     CACHE STRING "Path for extra configuration")
 
 # These are the man pages that go in system manpath; all manpages go in the fish-specific manpath.
-SET(MANUALS ${CMAKE_CURRENT_BINARY_DIR}/user_doc/man/man1/fish.1
-            ${CMAKE_CURRENT_BINARY_DIR}/user_doc/man/man1/fish_indent.1
-            ${CMAKE_CURRENT_BINARY_DIR}/user_doc/man/man1/fish_key_reader.1)
+SET(MANUALS ${CMAKE_CURRENT_BINARY_DIR}/share/man/man1/fish.1
+            ${CMAKE_CURRENT_BINARY_DIR}/share/man/man1/fish_indent.1
+            ${CMAKE_CURRENT_BINARY_DIR}/share/man/man1/fish_key_reader.1)
 
 # Determine which man page we don't want to install.
 # On OS X, don't install a man page for open, since we defeat fish's open
 # function on OS X.
-# On other operating systems, don't install a realpath man page, as they almost all have a realpath
-# command, while macOS does not.
 IF(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
   SET(CONDEMNED_PAGE "open.1")
 ELSE()
-  SET(CONDEMNED_PAGE "realpath.1")
+  SET(CONDEMNED_PAGE "none")
 ENDIF()
 
 # Define a function to help us create directories.
 FUNCTION(FISH_CREATE_DIRS)
   FOREACH(dir ${ARGV})
-    INSTALL(DIRECTORY DESTINATION ${dir})
+      IF(NOT EXISTS ${CMAKE_INSTALL_PREFIX}/${dir})
+        INSTALL(DIRECTORY DESTINATION ${dir})
+      ENDIF()
   ENDFOREACH(dir)
 ENDFUNCTION(FISH_CREATE_DIRS)
 
@@ -113,13 +113,13 @@ INSTALL(FILES share/config.fish
 # -$v $(INSTALL) -m 755 -d $(DESTDIR)$(extra_completionsdir)
 # -$v $(INSTALL) -m 755 -d $(DESTDIR)$(extra_functionsdir)
 # -$v $(INSTALL) -m 755 -d $(DESTDIR)$(extra_confdir)
-# Create only the vendor directories inside the prefix (#5029 / #6508)
-FISH_CREATE_DIRS(${rel_datadir}/fish/vendor_completions.d ${rel_datadir}/fish/vendor_functions.d
-    ${rel_datadir}/fish/vendor_conf.d)
+FISH_CREATE_DIRS(${rel_datadir}/pkgconfig)
+# Don't try too hard to create these directories as they may be outside our writeable area
+# https://github.com/Homebrew/homebrew-core/pull/2813
+FISH_TRY_CREATE_DIRS(${extra_completionsdir} ${extra_functionsdir} ${extra_confdir})
 
 # @echo "Installing pkgconfig file"
 # $v $(INSTALL) -m 644 fish.pc $(DESTDIR)$(datadir)/pkgconfig
-FISH_TRY_CREATE_DIRS(${rel_datadir}/pkgconfig)
 CONFIGURE_FILE(fish.pc.in fish.pc.noversion)
 
 ADD_CUSTOM_COMMAND(OUTPUT fish.pc
@@ -153,8 +153,8 @@ INSTALL(DIRECTORY share/groff
 
 # $v test -z "$(wildcard share/man/man1/*.1)" || $(INSTALL) -m 644 $(filter-out $(addprefix share/man/man1/, $(CONDEMNED_PAGES)), $(wildcard share/man/man1/*.1)) $(DESTDIR)$(datadir)/fish/man/man1/
 # CONDEMNED_PAGE is managed by the conditional above
-# Building the man pages is optional: if sphinx isn't installed, they're not built
-INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/user_doc/man/man1/
+# Building the man pages is optional: if doxygen isn't installed, they're not built
+INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/share/man/man1/
         DESTINATION ${rel_datadir}/fish/man/man1
         FILES_MATCHING
         PATTERN "*.1"
@@ -187,7 +187,7 @@ INSTALL(DIRECTORY share/tools/web_config
 #   $(INSTALL) -m 644 $$i $(DESTDIR)$(mandir)/man1/; \
 #   true; \
 # done;
-# Building the man pages is optional: if Sphinx isn't installed, they're not built
+# Building the man pages is optional: if doxygen isn't installed, they're not built
 INSTALL(FILES ${MANUALS} DESTINATION ${mandir}/man1/ OPTIONAL)
 
 #install-doc: $(user_doc)
@@ -218,7 +218,7 @@ ENDIF()
 
 # Group install targets into a InstallTargets folder
 SET_PROPERTY(TARGET build_fish_pc CHECK-FISH-BUILD-VERSION-FILE
-                    test_fishscript
+                    test_invocation test_fishscript
                     test_prep tests_buildroot_target
              PROPERTY FOLDER cmake/InstallTargets)
 

cmake/MacApp.cmake

@@ -1,58 +0,0 @@
-# This is Mac-only.
-if (NOT APPLE)
-    RETURN()
-endif (NOT APPLE)
-
-# The source tree containing certain macOS resources.
-SET(OSX_DIR ${CMAKE_CURRENT_SOURCE_DIR}/osx)
-
-SET(RESOURCE_FILES
-    ${OSX_DIR}/launch_fish.scpt
-    ${OSX_DIR}/fish_term_icon.icns
-    ${CMAKE_CURRENT_SOURCE_DIR}/build_tools/osx_package_scripts/add-shell
-    ${OSX_DIR}/install.sh
-)
-
-# Resource files must be present in the source list.
-ADD_EXECUTABLE(fish_macapp EXCLUDE_FROM_ALL
-    ${OSX_DIR}/osx_fish_launcher.m
-    ${RESOURCE_FILES}
-)
-
-# Compute the version. Note this is done at generation time, not build time,
-# so cmake must be re-run after version changes for the app to be updated. But
-# generally this will be run by make_pkg.sh which always re-runs cmake.
-EXECUTE_PROCESS(
-    COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/build_tools/git_version_gen.sh --stdout
-    COMMAND cut -d- -f1
-    OUTPUT_VARIABLE FISH_SHORT_VERSION
-    OUTPUT_STRIP_TRAILING_WHITESPACE)
-
-
-# Note CMake appends .app, so the real output name will be fish.app. 
-# This target does not include the 'base' resource.
-SET_TARGET_PROPERTIES(fish_macapp PROPERTIES OUTPUT_NAME "fish")
-
-FIND_LIBRARY(FOUNDATION_LIB Foundation)
-TARGET_LINK_LIBRARIES(fish_macapp ${FOUNDATION_LIB})
-
-SET_TARGET_PROPERTIES(fish_macapp PROPERTIES
-    MACOSX_BUNDLE TRUE
-    MACOSX_BUNDLE_INFO_PLIST ${OSX_DIR}/CMakeMacAppInfo.plist.in
-    MACOSX_BUNDLE_GUI_IDENTIFIER "com.ridiculousfish.fish-shell"
-    MACOSX_BUNDLE_SHORT_VERSION_STRING ${FISH_SHORT_VERSION}
-    RESOURCE "${RESOURCE_FILES}"
-)
-
-# The fish Mac app contains a fish installation inside the package.
-# Here is where it gets built.
-# Copy into the fish mac app after.
-SET(MACAPP_FISH_BUILDROOT ${CMAKE_CURRENT_BINARY_DIR}/macapp_buildroot/base)
-
-ADD_CUSTOM_COMMAND(TARGET fish_macapp POST_BUILD
-    COMMAND ${CMAKE_COMMAND} -E make_directory ${MACAPP_FISH_BUILDROOT}
-    COMMAND DESTDIR=${MACAPP_FISH_BUILDROOT} ${CMAKE_COMMAND}
-            --build ${CMAKE_CURRENT_BINARY_DIR} --target install
-    COMMAND ${CMAKE_COMMAND} -E copy_directory ${MACAPP_FISH_BUILDROOT}/..
-            $<TARGET_BUNDLE_CONTENT_DIR:fish_macapp>/Resources/
-)

cmake/PCRE2.cmake

@@ -13,8 +13,8 @@ IF (PCRE2_LIB AND PCRE2_INCLUDE_DIR)
   MESSAGE(STATUS "Found system PCRE2 library ${PCRE2_INCLUDE_DIR}")
 ELSE()
   MESSAGE(STATUS "Using bundled PCRE2 library")
-  ADD_SUBDIRECTORY(pcre2-10.32 EXCLUDE_FROM_ALL)
-  SET(PCRE2_INCLUDE_DIR ${CMAKE_BINARY_DIR}/pcre2-10.32/)
+  ADD_SUBDIRECTORY(pcre2-10.22 EXCLUDE_FROM_ALL)
+  SET(PCRE2_INCLUDE_DIR ${CMAKE_BINARY_DIR}/pcre2-10.22/)
   SET(PCRE2_LIB pcre2-${PCRE2_WIDTH})
 endif(PCRE2_LIB AND PCRE2_INCLUDE_DIR)
 INCLUDE_DIRECTORIES(${PCRE2_INCLUDE_DIR})

cmake/Tests.cmake

@@ -26,22 +26,32 @@ IF(NOT FISH_IN_TREE_BUILD)
     ADD_DEPENDENCIES(fish_tests tests_dir)
 ENDIF()
 
-# Copy littlecheck.py
-CONFIGURE_FILE(build_tools/littlecheck.py littlecheck.py COPYONLY)
+# Create the 'test' target.
+# Set a policy so CMake stops complaining about the name 'test'.
+CMAKE_POLICY(PUSH)
+IF(POLICY CMP0037)
+  CMAKE_POLICY(SET CMP0037 OLD)
+ENDIF()
+ADD_CUSTOM_TARGET(test)
+CMAKE_POLICY(POP)
+
+ADD_CUSTOM_TARGET(test_low_level
+  COMMAND env XDG_DATA_HOME=test/data XDG_CONFIG_HOME=test/home ./fish_tests
+  WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+  DEPENDS fish_tests
+  USES_TERMINAL)
+ADD_DEPENDENCIES(test test_low_level tests_dir)
 
 # Make the directory in which to run tests.
 # Also symlink fish to where the tests expect it to be.
-# Lastly put fish_test_helper there too.
 ADD_CUSTOM_TARGET(tests_buildroot_target
                   COMMAND ${CMAKE_COMMAND} -E make_directory ${TEST_INSTALL_DIR}
                   COMMAND DESTDIR=${TEST_INSTALL_DIR} ${CMAKE_COMMAND}
                           --build ${CMAKE_CURRENT_BINARY_DIR} --target install
-                  COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/fish_test_helper
-                          ${TEST_INSTALL_DIR}/${CMAKE_INSTALL_PREFIX}/bin
                   COMMAND ${CMAKE_COMMAND} -E create_symlink
                           ${TEST_INSTALL_DIR}/${CMAKE_INSTALL_PREFIX}
                           ${TEST_ROOT_DIR}
-                  DEPENDS fish fish_test_helper)
+                  DEPENDS fish)
 
 IF(NOT FISH_IN_TREE_BUILD)
   # We need to symlink share/functions for the tests.
@@ -55,68 +65,67 @@ ELSE()
   ADD_CUSTOM_TARGET(symlink_functions)
 ENDIF()
 
+#
 # Prep the environment for running the unit tests.
+# test-prep: show-DESTDIR show-LN_S show-FISH_VERSION
+#   $v rm -rf test
+#   $v $(MKDIR_P) test/data test/home test/temp
+# ifdef DESTDIR
+#   $v $(LN_S) $(DESTDIR) test/root
+# else
+#   $v $(MKDIR_P) test/root
+# endif
 ADD_CUSTOM_TARGET(test_prep
                   COMMAND ${CMAKE_COMMAND} -E remove_directory ${TEST_DIR}/data
                   COMMAND ${CMAKE_COMMAND} -E remove_directory ${TEST_DIR}/home
                   COMMAND ${CMAKE_COMMAND} -E remove_directory ${TEST_DIR}/temp
                   COMMAND ${CMAKE_COMMAND} -E make_directory
                           ${TEST_DIR}/data ${TEST_DIR}/home ${TEST_DIR}/temp
-                  DEPENDS tests_buildroot_target tests_dir
+                  DEPENDS tests_buildroot_target
                   USES_TERMINAL)
 
-# Define our individual tests.
-# Each test is conceptually independent.
-# However when running all tests, we want to run them serially for sanity's sake.
-# So define both a normal target, and a serial variant which enforces ordering.
-FOREACH(TESTTYPE test serial_test)
-  ADD_CUSTOM_TARGET(${TESTTYPE}_low_level
-    COMMAND env XDG_DATA_HOME=test/data XDG_CONFIG_HOME=test/home ./fish_tests
-    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-    DEPENDS fish_tests
+
+# test_high_level_test_deps = test_fishscript test_interactive test_invocation
+# test_high_level: DESTDIR = $(PWD)/test/root/
+# test_high_level: prefix = .
+# test_high_level: test-prep install-force test_fishscript test_interactive test_invocation
+# .PHONY: test_high_level
+#
+# test_invocation: $(call filter_up_to,test_invocation,$(active_test_goals))
+#   cd tests; ./invocation.sh
+# .PHONY: test_invocation
+ADD_CUSTOM_TARGET(test_invocation
+                  COMMAND ./invocation.sh
+                  WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tests/
+                  DEPENDS test_prep test_low_level
+                  USES_TERMINAL)
+
+#
+# test_fishscript: $(call filter_up_to,test_fishscript,$(active_test_goals))
+#   cd tests; ../test/root/bin/fish test.fish
+# .PHONY: test_fishscript
+
+ADD_CUSTOM_TARGET(test_fishscript
+                  COMMAND cd tests && ${TEST_ROOT_DIR}/bin/fish test.fish
+                  DEPENDS test_prep test_invocation
+                  USES_TERMINAL)
+#
+# test_interactive: $(call filter_up_to,test_interactive,$(active_test_goals))
+#   cd tests; ../test/root/bin/fish interactive.fish
+# .PHONY: test_interactive
+
+ADD_CUSTOM_TARGET(test_interactive
+    COMMAND cd tests && ${TEST_ROOT_DIR}/bin/fish interactive.fish
+    DEPENDS test_prep test_invocation test_fishscript
     USES_TERMINAL)
 
-  ADD_CUSTOM_TARGET(${TESTTYPE}_fishscript
-                    COMMAND cd tests && ${TEST_ROOT_DIR}/bin/fish test.fish
-                    DEPENDS test_prep
-                    USES_TERMINAL)
-
-  ADD_CUSTOM_TARGET(${TESTTYPE}_interactive
-      COMMAND cd tests && ${TEST_ROOT_DIR}/bin/fish interactive.fish
-      DEPENDS test_prep
-      USES_TERMINAL)
-ENDFOREACH(TESTTYPE)
-
-# Now add a dependency chain between the serial versions.
-# This ensures they run in order.
-ADD_DEPENDENCIES(serial_test_fishscript serial_test_low_level)
-ADD_DEPENDENCIES(serial_test_interactive serial_test_fishscript)
-
-
-ADD_CUSTOM_TARGET(serial_test_high_level
-                  DEPENDS serial_test_interactive serial_test_fishscript)
-
-# Create the 'test' target.
-# Set a policy so CMake stops complaining about the name 'test'.
-CMAKE_POLICY(PUSH)
-
-IF(${CMAKE_VERSION} VERSION_LESS 3.11.0 AND POLICY CMP0037)
-  CMAKE_POLICY(SET CMP0037 OLD)
-ENDIF()
-ADD_CUSTOM_TARGET(test)
-CMAKE_POLICY(POP)
-ADD_DEPENDENCIES(test serial_test_high_level)
+ADD_CUSTOM_TARGET(test_high_level
+                  DEPENDS test_invocation test_fishscript test_interactive)
+ADD_DEPENDENCIES(test test_high_level)
 
 # Group test targets into a TestTargets folder
-SET_PROPERTY(TARGET test tests_dir
-                    test_low_level
-                    test_fishscript
-                    test_interactive
-                    test_fishscript test_prep
+SET_PROPERTY(TARGET test test_low_level test_high_level tests_dir
+                    test_invocation test_fishscript test_prep
                     tests_buildroot_target
-                    serial_test_high_level
-                    serial_test_low_level
-                    serial_test_fishscript
-                    serial_test_interactive
                     symlink_functions
              PROPERTY FOLDER cmake/TestTargets)

cmake/gettext.cmake

@@ -23,12 +23,12 @@ IF(GETTEXT_FOUND)
   ENDFOREACH()
 ENDIF()
 
-CMAKE_PUSH_CHECK_STATE()
-SET(CMAKE_REQUIRED_INCLUDES ${CMAKE_REQUIRED_INCLUDES} ${Intl_INCLUDE_DIR})
-SET(CMAKE_REQUIRED_LIBRARIES ${CMAKE_REQUIRED_LIBRARIES} ${Intl_LIBRARIES})
+
 # libintl.h can be compiled into the stdlib on some GLibC systems
 IF(Intl_FOUND AND Intl_LIBRARIES)
   SET(LIBINTL_INCLUDE "#include <libintl.h>")
+  SET(CMAKE_REQUIRED_INCLUDES ${CMAKE_REQUIRED_INCLUDES} ${Intl_INCLUDE_DIR})
+  SET(CMAKE_REQUIRED_LIBRARIES ${CMAKE_REQUIRED_LIBRARIES} ${Intl_LIBRARIES})
 ENDIF()
 CHECK_CXX_SOURCE_COMPILES("
 ${LIBINTL_INCLUDE}
@@ -40,4 +40,3 @@ int main () {
 }
 "
     HAVE__NL_MSG_CAT_CNTR)
-CMAKE_POP_CHECK_STATE()

config.guess

@@ -1,8 +1,8 @@
 #! /bin/sh
 # Attempt to guess a canonical system name.
-#   Copyright 1992-2017 Free Software Foundation, Inc.
+#   Copyright 1992-2015 Free Software Foundation, Inc.
 
-timestamp='2017-05-27'
+timestamp='2015-03-04'
 
 # This file is free software; you can redistribute it and/or modify it
 # under the terms of the GNU General Public License as published by
@@ -27,7 +27,7 @@ timestamp='2017-05-27'
 # Originally written by Per Bothner; maintained since 2000 by Ben Elliston.
 #
 # You can get the latest version of this script from:
-# http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.guess
+# http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.guess;hb=HEAD
 #
 # Please send patches to <config-patches@gnu.org>.
 
@@ -50,7 +50,7 @@ version="\
 GNU config.guess ($timestamp)
 
 Originally written by Per Bothner.
-Copyright 1992-2017 Free Software Foundation, Inc.
+Copyright 1992-2015 Free Software Foundation, Inc.
 
 This is free software; see the source for copying conditions.  There is NO
 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE."
@@ -186,12 +186,9 @@ case "${UNAME_MACHINE}:${UNAME_SYSTEM}:${UNAME_RELEASE}:${UNAME_VERSION}" in
 	    *) machine=${UNAME_MACHINE_ARCH}-unknown ;;
 	esac
 	# The Operating System including object format, if it has switched
-	# to ELF recently (or will in the future) and ABI.
+	# to ELF recently, or will in the future.
 	case "${UNAME_MACHINE_ARCH}" in
-	    earm*)
-		os=netbsdelf
-		;;
-	    arm*|i386|m68k|ns32k|sh3*|sparc|vax)
+	    arm*|earm*|i386|m68k|ns32k|sh3*|sparc|vax)
 		eval $set_cc_for_build
 		if echo __ELF__ | $CC_FOR_BUILD -E - 2>/dev/null \
 			| grep -q __ELF__
@@ -224,7 +221,7 @@ case "${UNAME_MACHINE}:${UNAME_SYSTEM}:${UNAME_RELEASE}:${UNAME_VERSION}" in
 		release='-gnu'
 		;;
 	    *)
-		release=`echo ${UNAME_RELEASE} | sed -e 's/[-_].*//' | cut -d. -f1,2`
+		release=`echo ${UNAME_RELEASE}|sed -e 's/[-_].*/\./'`
 		;;
 	esac
 	# Since CPU_TYPE-MANUFACTURER-KERNEL-OPERATING_SYSTEM:
@@ -240,10 +237,6 @@ case "${UNAME_MACHINE}:${UNAME_SYSTEM}:${UNAME_RELEASE}:${UNAME_VERSION}" in
 	UNAME_MACHINE_ARCH=`arch | sed 's/OpenBSD.//'`
 	echo ${UNAME_MACHINE_ARCH}-unknown-openbsd${UNAME_RELEASE}
 	exit ;;
-    *:LibertyBSD:*:*)
-	UNAME_MACHINE_ARCH=`arch | sed 's/^.*BSD\.//'`
-	echo ${UNAME_MACHINE_ARCH}-unknown-libertybsd${UNAME_RELEASE}
-	exit ;;
     *:ekkoBSD:*:*)
 	echo ${UNAME_MACHINE}-unknown-ekkobsd${UNAME_RELEASE}
 	exit ;;
@@ -256,9 +249,6 @@ case "${UNAME_MACHINE}:${UNAME_SYSTEM}:${UNAME_RELEASE}:${UNAME_VERSION}" in
     *:MirBSD:*:*)
 	echo ${UNAME_MACHINE}-unknown-mirbsd${UNAME_RELEASE}
 	exit ;;
-    *:Sortix:*:*)
-	echo ${UNAME_MACHINE}-unknown-sortix
-	exit ;;
     alpha:OSF1:*:*)
 	case $UNAME_RELEASE in
 	*4.0)
@@ -275,42 +265,42 @@ case "${UNAME_MACHINE}:${UNAME_SYSTEM}:${UNAME_RELEASE}:${UNAME_VERSION}" in
 	ALPHA_CPU_TYPE=`/usr/sbin/psrinfo -v | sed -n -e 's/^  The alpha \(.*\) processor.*$/\1/p' | head -n 1`
 	case "$ALPHA_CPU_TYPE" in
 	    "EV4 (21064)")
-		UNAME_MACHINE=alpha ;;
+		UNAME_MACHINE="alpha" ;;
 	    "EV4.5 (21064)")
-		UNAME_MACHINE=alpha ;;
+		UNAME_MACHINE="alpha" ;;
 	    "LCA4 (21066/21068)")
-		UNAME_MACHINE=alpha ;;
+		UNAME_MACHINE="alpha" ;;
 	    "EV5 (21164)")
-		UNAME_MACHINE=alphaev5 ;;
+		UNAME_MACHINE="alphaev5" ;;
 	    "EV5.6 (21164A)")
-		UNAME_MACHINE=alphaev56 ;;
+		UNAME_MACHINE="alphaev56" ;;
 	    "EV5.6 (21164PC)")
-		UNAME_MACHINE=alphapca56 ;;
+		UNAME_MACHINE="alphapca56" ;;
 	    "EV5.7 (21164PC)")
-		UNAME_MACHINE=alphapca57 ;;
+		UNAME_MACHINE="alphapca57" ;;
 	    "EV6 (21264)")
-		UNAME_MACHINE=alphaev6 ;;
+		UNAME_MACHINE="alphaev6" ;;
 	    "EV6.7 (21264A)")
-		UNAME_MACHINE=alphaev67 ;;
+		UNAME_MACHINE="alphaev67" ;;
 	    "EV6.8CB (21264C)")
-		UNAME_MACHINE=alphaev68 ;;
+		UNAME_MACHINE="alphaev68" ;;
 	    "EV6.8AL (21264B)")
-		UNAME_MACHINE=alphaev68 ;;
+		UNAME_MACHINE="alphaev68" ;;
 	    "EV6.8CX (21264D)")
-		UNAME_MACHINE=alphaev68 ;;
+		UNAME_MACHINE="alphaev68" ;;
 	    "EV6.9A (21264/EV69A)")
-		UNAME_MACHINE=alphaev69 ;;
+		UNAME_MACHINE="alphaev69" ;;
 	    "EV7 (21364)")
-		UNAME_MACHINE=alphaev7 ;;
+		UNAME_MACHINE="alphaev7" ;;
 	    "EV7.9 (21364A)")
-		UNAME_MACHINE=alphaev79 ;;
+		UNAME_MACHINE="alphaev79" ;;
 	esac
 	# A Pn.n version is a patched version.
 	# A Vn.n version is a released version.
 	# A Tn.n version is a released field test version.
 	# A Xn.n version is an unreleased experimental baselevel.
 	# 1.2 uses "1.2" for uname -r.
-	echo ${UNAME_MACHINE}-dec-osf`echo ${UNAME_RELEASE} | sed -e 's/^[PVTX]//' | tr ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz`
+	echo ${UNAME_MACHINE}-dec-osf`echo ${UNAME_RELEASE} | sed -e 's/^[PVTX]//' | tr 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 'abcdefghijklmnopqrstuvwxyz'`
 	# Reset EXIT trap before exiting to avoid spurious non-zero exit code.
 	exitcode=$?
 	trap '' 0
@@ -383,16 +373,16 @@ case "${UNAME_MACHINE}:${UNAME_SYSTEM}:${UNAME_RELEASE}:${UNAME_VERSION}" in
 	exit ;;
     i86pc:SunOS:5.*:* | i86xen:SunOS:5.*:*)
 	eval $set_cc_for_build
-	SUN_ARCH=i386
+	SUN_ARCH="i386"
 	# If there is a compiler, see if it is configured for 64-bit objects.
 	# Note that the Sun cc does not turn __LP64__ into 1 like gcc does.
 	# This test works for both compilers.
-	if [ "$CC_FOR_BUILD" != no_compiler_found ]; then
+	if [ "$CC_FOR_BUILD" != 'no_compiler_found' ]; then
 	    if (echo '#ifdef __amd64'; echo IS_64BIT_ARCH; echo '#endif') | \
-		(CCOPTS="" $CC_FOR_BUILD -E - 2>/dev/null) | \
+		(CCOPTS= $CC_FOR_BUILD -E - 2>/dev/null) | \
 		grep IS_64BIT_ARCH >/dev/null
 	    then
-		SUN_ARCH=x86_64
+		SUN_ARCH="x86_64"
 	    fi
 	fi
 	echo ${SUN_ARCH}-pc-solaris2`echo ${UNAME_RELEASE}|sed -e 's/[^.]*//'`
@@ -417,7 +407,7 @@ case "${UNAME_MACHINE}:${UNAME_SYSTEM}:${UNAME_RELEASE}:${UNAME_VERSION}" in
 	exit ;;
     sun*:*:4.2BSD:*)
 	UNAME_RELEASE=`(sed 1q /etc/motd | awk '{print substr($5,1,3)}') 2>/dev/null`
-	test "x${UNAME_RELEASE}" = x && UNAME_RELEASE=3
+	test "x${UNAME_RELEASE}" = "x" && UNAME_RELEASE=3
 	case "`/bin/arch`" in
 	    sun3)
 		echo m68k-sun-sunos${UNAME_RELEASE}
@@ -642,13 +632,13 @@ EOF
 		    sc_cpu_version=`/usr/bin/getconf SC_CPU_VERSION 2>/dev/null`
 		    sc_kernel_bits=`/usr/bin/getconf SC_KERNEL_BITS 2>/dev/null`
 		    case "${sc_cpu_version}" in
-		      523) HP_ARCH=hppa1.0 ;; # CPU_PA_RISC1_0
-		      528) HP_ARCH=hppa1.1 ;; # CPU_PA_RISC1_1
+		      523) HP_ARCH="hppa1.0" ;; # CPU_PA_RISC1_0
+		      528) HP_ARCH="hppa1.1" ;; # CPU_PA_RISC1_1
 		      532)                      # CPU_PA_RISC2_0
 			case "${sc_kernel_bits}" in
-			  32) HP_ARCH=hppa2.0n ;;
-			  64) HP_ARCH=hppa2.0w ;;
-			  '') HP_ARCH=hppa2.0 ;;   # HP-UX 10.20
+			  32) HP_ARCH="hppa2.0n" ;;
+			  64) HP_ARCH="hppa2.0w" ;;
+			  '') HP_ARCH="hppa2.0" ;;   # HP-UX 10.20
 			esac ;;
 		    esac
 		fi
@@ -687,11 +677,11 @@ EOF
 		    exit (0);
 		}
 EOF
-		    (CCOPTS="" $CC_FOR_BUILD -o $dummy $dummy.c 2>/dev/null) && HP_ARCH=`$dummy`
+		    (CCOPTS= $CC_FOR_BUILD -o $dummy $dummy.c 2>/dev/null) && HP_ARCH=`$dummy`
 		    test -z "$HP_ARCH" && HP_ARCH=hppa
 		fi ;;
 	esac
-	if [ ${HP_ARCH} = hppa2.0w ]
+	if [ ${HP_ARCH} = "hppa2.0w" ]
 	then
 	    eval $set_cc_for_build
 
@@ -704,12 +694,12 @@ EOF
 	    # $ CC_FOR_BUILD="cc +DA2.0w" ./config.guess
 	    # => hppa64-hp-hpux11.23
 
-	    if echo __LP64__ | (CCOPTS="" $CC_FOR_BUILD -E - 2>/dev/null) |
+	    if echo __LP64__ | (CCOPTS= $CC_FOR_BUILD -E - 2>/dev/null) |
 		grep -q __LP64__
 	    then
-		HP_ARCH=hppa2.0w
+		HP_ARCH="hppa2.0w"
 	    else
-		HP_ARCH=hppa64
+		HP_ARCH="hppa64"
 	    fi
 	fi
 	echo ${HP_ARCH}-hp-hpux${HPUX_REV}
@@ -814,14 +804,14 @@ EOF
 	echo craynv-cray-unicosmp${UNAME_RELEASE} | sed -e 's/\.[^.]*$/.X/'
 	exit ;;
     F30[01]:UNIX_System_V:*:* | F700:UNIX_System_V:*:*)
-	FUJITSU_PROC=`uname -m | tr ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz`
-	FUJITSU_SYS=`uname -p | tr ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz | sed -e 's/\///'`
+	FUJITSU_PROC=`uname -m | tr 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 'abcdefghijklmnopqrstuvwxyz'`
+	FUJITSU_SYS=`uname -p | tr 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 'abcdefghijklmnopqrstuvwxyz' | sed -e 's/\///'`
 	FUJITSU_REL=`echo ${UNAME_RELEASE} | sed -e 's/ /_/'`
 	echo "${FUJITSU_PROC}-fujitsu-${FUJITSU_SYS}${FUJITSU_REL}"
 	exit ;;
     5000:UNIX_System_V:4.*:*)
-	FUJITSU_SYS=`uname -p | tr ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz | sed -e 's/\///'`
-	FUJITSU_REL=`echo ${UNAME_RELEASE} | tr ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz | sed -e 's/ /_/'`
+	FUJITSU_SYS=`uname -p | tr 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 'abcdefghijklmnopqrstuvwxyz' | sed -e 's/\///'`
+	FUJITSU_REL=`echo ${UNAME_RELEASE} | tr 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 'abcdefghijklmnopqrstuvwxyz' | sed -e 's/ /_/'`
 	echo "sparc-fujitsu-${FUJITSU_SYS}${FUJITSU_REL}"
 	exit ;;
     i*86:BSD/386:*:* | i*86:BSD/OS:*:* | *:Ascend\ Embedded/OS:*:*)
@@ -837,11 +827,10 @@ EOF
 	UNAME_PROCESSOR=`/usr/bin/uname -p`
 	case ${UNAME_PROCESSOR} in
 	    amd64)
-		UNAME_PROCESSOR=x86_64 ;;
-	    i386)
-		UNAME_PROCESSOR=i586 ;;
+		echo x86_64-unknown-freebsd`echo ${UNAME_RELEASE}|sed -e 's/[-(].*//'` ;;
+	    *)
+		echo ${UNAME_PROCESSOR}-unknown-freebsd`echo ${UNAME_RELEASE}|sed -e 's/[-(].*//'` ;;
 	esac
-	echo ${UNAME_PROCESSOR}-unknown-freebsd`echo ${UNAME_RELEASE}|sed -e 's/[-(].*//'`
 	exit ;;
     i*:CYGWIN*:*)
 	echo ${UNAME_MACHINE}-pc-cygwin
@@ -904,7 +893,7 @@ EOF
 	exit ;;
     *:GNU/*:*:*)
 	# other systems with GNU libc and userland
-	echo ${UNAME_MACHINE}-unknown-`echo ${UNAME_SYSTEM} | sed 's,^[^/]*/,,' | tr "[:upper:]" "[:lower:]"``echo ${UNAME_RELEASE}|sed -e 's/[-(].*//'`-${LIBC}
+	echo ${UNAME_MACHINE}-unknown-`echo ${UNAME_SYSTEM} | sed 's,^[^/]*/,,' | tr '[A-Z]' '[a-z]'``echo ${UNAME_RELEASE}|sed -e 's/[-(].*//'`-${LIBC}
 	exit ;;
     i*86:Minix:*:*)
 	echo ${UNAME_MACHINE}-pc-minix
@@ -927,7 +916,7 @@ EOF
 	  EV68*) UNAME_MACHINE=alphaev68 ;;
 	esac
 	objdump --private-headers /bin/sh | grep -q ld.so.1
-	if test "$?" = 0 ; then LIBC=gnulibc1 ; fi
+	if test "$?" = 0 ; then LIBC="gnulibc1" ; fi
 	echo ${UNAME_MACHINE}-unknown-linux-${LIBC}
 	exit ;;
     arc:Linux:*:* | arceb:Linux:*:*)
@@ -973,9 +962,6 @@ EOF
     ia64:Linux:*:*)
 	echo ${UNAME_MACHINE}-unknown-linux-${LIBC}
 	exit ;;
-    k1om:Linux:*:*)
-	echo ${UNAME_MACHINE}-unknown-linux-${LIBC}
-	exit ;;
     m32r*:Linux:*:*)
 	echo ${UNAME_MACHINE}-unknown-linux-${LIBC}
 	exit ;;
@@ -1001,9 +987,6 @@ EOF
 	eval `$CC_FOR_BUILD -E $dummy.c 2>/dev/null | grep '^CPU'`
 	test x"${CPU}" != x && { echo "${CPU}-unknown-linux-${LIBC}"; exit; }
 	;;
-    mips64el:Linux:*:*)
-	echo ${UNAME_MACHINE}-unknown-linux-${LIBC}
-	exit ;;
     openrisc*:Linux:*:*)
 	echo or1k-unknown-linux-${LIBC}
 	exit ;;
@@ -1036,9 +1019,6 @@ EOF
     ppcle:Linux:*:*)
 	echo powerpcle-unknown-linux-${LIBC}
 	exit ;;
-    riscv32:Linux:*:* | riscv64:Linux:*:*)
-	echo ${UNAME_MACHINE}-unknown-linux-${LIBC}
-	exit ;;
     s390:Linux:*:* | s390x:Linux:*:*)
 	echo ${UNAME_MACHINE}-ibm-linux-${LIBC}
 	exit ;;
@@ -1058,7 +1038,7 @@ EOF
 	echo ${UNAME_MACHINE}-dec-linux-${LIBC}
 	exit ;;
     x86_64:Linux:*:*)
-	echo ${UNAME_MACHINE}-pc-linux-${LIBC}
+	echo ${UNAME_MACHINE}-unknown-linux-${LIBC}
 	exit ;;
     xtensa*:Linux:*:*)
 	echo ${UNAME_MACHINE}-unknown-linux-${LIBC}
@@ -1137,7 +1117,7 @@ EOF
 	# uname -m prints for DJGPP always 'pc', but it prints nothing about
 	# the processor, so we play safe by assuming i586.
 	# Note: whatever this is, it MUST be the same as what config.sub
-	# prints for the "djgpp" host, or else GDB configure will decide that
+	# prints for the "djgpp" host, or else GDB configury will decide that
 	# this is a cross-build.
 	echo i586-pc-msdosdjgpp
 	exit ;;
@@ -1286,9 +1266,6 @@ EOF
     SX-8R:SUPER-UX:*:*)
 	echo sx8r-nec-superux${UNAME_RELEASE}
 	exit ;;
-    SX-ACE:SUPER-UX:*:*)
-	echo sxace-nec-superux${UNAME_RELEASE}
-	exit ;;
     Power*:Rhapsody:*:*)
 	echo powerpc-apple-rhapsody${UNAME_RELEASE}
 	exit ;;
@@ -1302,23 +1279,16 @@ EOF
 	    UNAME_PROCESSOR=powerpc
 	fi
 	if test `echo "$UNAME_RELEASE" | sed -e 's/\..*//'` -le 10 ; then
-	    if [ "$CC_FOR_BUILD" != no_compiler_found ]; then
+	    if [ "$CC_FOR_BUILD" != 'no_compiler_found' ]; then
 		if (echo '#ifdef __LP64__'; echo IS_64BIT_ARCH; echo '#endif') | \
-		       (CCOPTS="" $CC_FOR_BUILD -E - 2>/dev/null) | \
-		       grep IS_64BIT_ARCH >/dev/null
+		    (CCOPTS= $CC_FOR_BUILD -E - 2>/dev/null) | \
+		    grep IS_64BIT_ARCH >/dev/null
 		then
 		    case $UNAME_PROCESSOR in
 			i386) UNAME_PROCESSOR=x86_64 ;;
 			powerpc) UNAME_PROCESSOR=powerpc64 ;;
 		    esac
 		fi
-		# On 10.4-10.6 one might compile for PowerPC via gcc -arch ppc
-		if (echo '#ifdef __POWERPC__'; echo IS_PPC; echo '#endif') | \
-		       (CCOPTS="" $CC_FOR_BUILD -E - 2>/dev/null) | \
-		       grep IS_PPC >/dev/null
-		then
-		    UNAME_PROCESSOR=powerpc
-		fi
 	    fi
 	elif test "$UNAME_PROCESSOR" = i386 ; then
 	    # Avoid executing cc on OS X 10.9, as it ships with a stub
@@ -1333,7 +1303,7 @@ EOF
 	exit ;;
     *:procnto*:*:* | *:QNX:[0123456789]*:*)
 	UNAME_PROCESSOR=`uname -p`
-	if test "$UNAME_PROCESSOR" = x86; then
+	if test "$UNAME_PROCESSOR" = "x86"; then
 		UNAME_PROCESSOR=i386
 		UNAME_MACHINE=pc
 	fi
@@ -1342,18 +1312,15 @@ EOF
     *:QNX:*:4*)
 	echo i386-pc-qnx
 	exit ;;
-    NEO-*:NONSTOP_KERNEL:*:*)
+    NEO-?:NONSTOP_KERNEL:*:*)
 	echo neo-tandem-nsk${UNAME_RELEASE}
 	exit ;;
     NSE-*:NONSTOP_KERNEL:*:*)
 	echo nse-tandem-nsk${UNAME_RELEASE}
 	exit ;;
-    NSR-*:NONSTOP_KERNEL:*:*)
+    NSR-?:NONSTOP_KERNEL:*:*)
 	echo nsr-tandem-nsk${UNAME_RELEASE}
 	exit ;;
-    NSX-*:NONSTOP_KERNEL:*:*)
-	echo nsx-tandem-nsk${UNAME_RELEASE}
-	exit ;;
     *:NonStop-UX:*:*)
 	echo mips-compaq-nonstopux
 	exit ;;
@@ -1367,7 +1334,7 @@ EOF
 	# "uname -m" is not consistent, so use $cputype instead. 386
 	# is converted to i386 for consistency with other x86
 	# operating systems.
-	if test "$cputype" = 386; then
+	if test "$cputype" = "386"; then
 	    UNAME_MACHINE=i386
 	else
 	    UNAME_MACHINE="$cputype"
@@ -1409,7 +1376,7 @@ EOF
 	echo i386-pc-xenix
 	exit ;;
     i*86:skyos:*:*)
-	echo ${UNAME_MACHINE}-pc-skyos`echo ${UNAME_RELEASE} | sed -e 's/ .*$//'`
+	echo ${UNAME_MACHINE}-pc-skyos`echo ${UNAME_RELEASE}` | sed -e 's/ .*$//'
 	exit ;;
     i*86:rdos:*:*)
 	echo ${UNAME_MACHINE}-pc-rdos
@@ -1420,25 +1387,23 @@ EOF
     x86_64:VMkernel:*:*)
 	echo ${UNAME_MACHINE}-unknown-esx
 	exit ;;
-    amd64:Isilon\ OneFS:*:*)
-	echo x86_64-unknown-onefs
-	exit ;;
 esac
 
 cat >&2 <<EOF
 $0: unable to guess system type
 
-This script (version $timestamp), has failed to recognize the
-operating system you are using. If your script is old, overwrite
-config.guess and config.sub with the latest versions from:
+This script, last modified $timestamp, has failed to recognize
+the operating system you are using. It is advised that you
+download the most up to date version of the config scripts from
 
-  http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.guess
+  http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.guess;hb=HEAD
 and
-  http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.sub
+  http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.sub;hb=HEAD
 
-If $0 has already been updated, send the following data and any
-information you think might be pertinent to config-patches@gnu.org to
-provide the necessary information to handle your system.
+If the version you run ($0) is already up to date, please
+send the following data and any information you think might be
+pertinent to <config-patches@gnu.org> in order to provide the needed
+information to handle your system.
 
 config.guess timestamp = $timestamp
 

config.sub

@@ -1,8 +1,8 @@
 #! /bin/sh
 # Configuration validation subroutine script.
-#   Copyright 1992-2017 Free Software Foundation, Inc.
+#   Copyright 1992-2015 Free Software Foundation, Inc.
 
-timestamp='2017-04-02'
+timestamp='2015-03-08'
 
 # This file is free software; you can redistribute it and/or modify it
 # under the terms of the GNU General Public License as published by
@@ -33,7 +33,7 @@ timestamp='2017-04-02'
 # Otherwise, we print the canonical config type on stdout and succeed.
 
 # You can get the latest version of this script from:
-# http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.sub
+# http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.sub;hb=HEAD
 
 # This file is supposed to be the same for all GNU packages
 # and recognize all the CPU types, system types and aliases
@@ -53,7 +53,8 @@ timestamp='2017-04-02'
 me=`echo "$0" | sed -e 's,.*/,,'`
 
 usage="\
-Usage: $0 [OPTION] CPU-MFR-OPSYS or ALIAS
+Usage: $0 [OPTION] CPU-MFR-OPSYS
+       $0 [OPTION] ALIAS
 
 Canonicalize a configuration name.
 
@@ -67,7 +68,7 @@ Report bugs and patches to <config-patches@gnu.org>."
 version="\
 GNU config.sub ($timestamp)
 
-Copyright 1992-2017 Free Software Foundation, Inc.
+Copyright 1992-2015 Free Software Foundation, Inc.
 
 This is free software; see the source for copying conditions.  There is NO
 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE."
@@ -117,7 +118,7 @@ case $maybe_os in
   nto-qnx* | linux-gnu* | linux-android* | linux-dietlibc | linux-newlib* | \
   linux-musl* | linux-uclibc* | uclinux-uclibc* | uclinux-gnu* | kfreebsd*-gnu* | \
   knetbsd*-gnu* | netbsd*-gnu* | netbsd*-eabi* | \
-  kopensolaris*-gnu* | cloudabi*-eabi* | \
+  kopensolaris*-gnu* | \
   storm-chaos* | os2-emx* | rtmk-nova*)
     os=-$maybe_os
     basic_machine=`echo $1 | sed 's/^\(.*\)-\([^-]*-[^-]*\)$/\1/'`
@@ -254,7 +255,6 @@ case $basic_machine in
 	| arc | arceb \
 	| arm | arm[bl]e | arme[lb] | armv[2-8] | armv[3-8][lb] | armv7[arm] \
 	| avr | avr32 \
-	| ba \
 	| be32 | be64 \
 	| bfin \
 	| c4x | c8051 | clipper \
@@ -263,7 +263,7 @@ case $basic_machine in
 	| fido | fr30 | frv | ft32 \
 	| h8300 | h8500 | hppa | hppa1.[01] | hppa2.0 | hppa2.0[nw] | hppa64 \
 	| hexagon \
-	| i370 | i860 | i960 | ia16 | ia64 \
+	| i370 | i860 | i960 | ia64 \
 	| ip2k | iq2000 \
 	| k1om \
 	| le32 | le64 \
@@ -301,12 +301,11 @@ case $basic_machine in
 	| open8 | or1k | or1knd | or32 \
 	| pdp10 | pdp11 | pj | pjl \
 	| powerpc | powerpc64 | powerpc64le | powerpcle \
-	| pru \
 	| pyramid \
 	| riscv32 | riscv64 \
 	| rl78 | rx \
 	| score \
-	| sh | sh[1234] | sh[24]a | sh[24]aeb | sh[23]e | sh[234]eb | sheb | shbe | shle | sh[1234]le | sh3ele \
+	| sh | sh[1234] | sh[24]a | sh[24]aeb | sh[23]e | sh[34]eb | sheb | shbe | shle | sh[1234]le | sh3ele \
 	| sh64 | sh64le \
 	| sparc | sparc64 | sparc64b | sparc64v | sparc86x | sparclet | sparclite \
 	| sparcv8 | sparcv9 | sparcv9b | sparcv9v \
@@ -315,7 +314,6 @@ case $basic_machine in
 	| ubicom32 \
 	| v850 | v850e | v850e1 | v850e2 | v850es | v850e2v3 \
 	| visium \
-	| wasm32 \
 	| we32k \
 	| x86 | xc16x | xstormy16 | xtensa \
 	| z8k | z80)
@@ -378,7 +376,6 @@ case $basic_machine in
 	| alphapca5[67]-* | alpha64pca5[67]-* | arc-* | arceb-* \
 	| arm-*  | armbe-* | armle-* | armeb-* | armv*-* \
 	| avr-* | avr32-* \
-	| ba-* \
 	| be32-* | be64-* \
 	| bfin-* | bs2000-* \
 	| c[123]* | c30-* | [cjt]90-* | c4x-* \
@@ -389,7 +386,7 @@ case $basic_machine in
 	| h8300-* | h8500-* \
 	| hppa-* | hppa1.[01]-* | hppa2.0-* | hppa2.0[nw]-* | hppa64-* \
 	| hexagon-* \
-	| i*86-* | i860-* | i960-* | ia16-* | ia64-* \
+	| i*86-* | i860-* | i960-* | ia64-* \
 	| ip2k-* | iq2000-* \
 	| k1om-* \
 	| le32-* | le64-* \
@@ -430,15 +427,13 @@ case $basic_machine in
 	| orion-* \
 	| pdp10-* | pdp11-* | pj-* | pjl-* | pn-* | power-* \
 	| powerpc-* | powerpc64-* | powerpc64le-* | powerpcle-* \
-	| pru-* \
 	| pyramid-* \
-	| riscv32-* | riscv64-* \
 	| rl78-* | romp-* | rs6000-* | rx-* \
 	| sh-* | sh[1234]-* | sh[24]a-* | sh[24]aeb-* | sh[23]e-* | sh[34]eb-* | sheb-* | shbe-* \
 	| shle-* | sh[1234]le-* | sh3ele-* | sh64-* | sh64le-* \
 	| sparc-* | sparc64-* | sparc64b-* | sparc64v-* | sparc86x-* | sparclet-* \
 	| sparclite-* \
-	| sparcv8-* | sparcv9-* | sparcv9b-* | sparcv9v-* | sv1-* | sx*-* \
+	| sparcv8-* | sparcv9-* | sparcv9b-* | sparcv9v-* | sv1-* | sx?-* \
 	| tahoe-* \
 	| tic30-* | tic4x-* | tic54x-* | tic55x-* | tic6x-* | tic80-* \
 	| tile*-* \
@@ -447,7 +442,6 @@ case $basic_machine in
 	| v850-* | v850e-* | v850e1-* | v850es-* | v850e2-* | v850e2v3-* \
 	| vax-* \
 	| visium-* \
-	| wasm32-* \
 	| we32k-* \
 	| x86-* | x86_64-* | xc16x-* | xps100-* \
 	| xstormy16-* | xtensa*-* \
@@ -524,7 +518,7 @@ case $basic_machine in
 		basic_machine=i386-pc
 		os=-aros
 		;;
-	asmjs)
+        asmjs)
 		basic_machine=asmjs-unknown
 		;;
 	aux)
@@ -647,14 +641,6 @@ case $basic_machine in
 		basic_machine=m68k-bull
 		os=-sysv3
 		;;
-	e500v[12])
-		basic_machine=powerpc-unknown
-		os=$os"spe"
-		;;
-	e500v[12]-*)
-		basic_machine=powerpc-`echo $basic_machine | sed 's/^[^-]*-//'`
-		os=$os"spe"
-		;;
 	ebmon29k)
 		basic_machine=a29k-amd
 		os=-ebmon
@@ -950,9 +936,6 @@ case $basic_machine in
 	nsr-tandem)
 		basic_machine=nsr-tandem
 		;;
-	nsx-tandem)
-		basic_machine=nsx-tandem
-		;;
 	op50n-* | op60c-*)
 		basic_machine=hppa1.1-oki
 		os=-proelf
@@ -1037,7 +1020,7 @@ case $basic_machine in
 	ppc-* | ppcbe-*)
 		basic_machine=powerpc-`echo $basic_machine | sed 's/^[^-]*-//'`
 		;;
-	ppcle | powerpclittle)
+	ppcle | powerpclittle | ppc-le | powerpc-little)
 		basic_machine=powerpcle-unknown
 		;;
 	ppcle-* | powerpclittle-*)
@@ -1047,7 +1030,7 @@ case $basic_machine in
 		;;
 	ppc64-*) basic_machine=powerpc64-`echo $basic_machine | sed 's/^[^-]*-//'`
 		;;
-	ppc64le | powerpc64little)
+	ppc64le | powerpc64little | ppc64-le | powerpc64-little)
 		basic_machine=powerpc64le-unknown
 		;;
 	ppc64le-* | powerpc64little-*)
@@ -1248,9 +1231,6 @@ case $basic_machine in
 		basic_machine=a29k-wrs
 		os=-vxworks
 		;;
-	wasm32)
-		basic_machine=wasm32-unknown
-		;;
 	w65*)
 		basic_machine=w65-wdc
 		os=-none
@@ -1396,18 +1376,18 @@ case $os in
 	      | -hpux* | -unos* | -osf* | -luna* | -dgux* | -auroraux* | -solaris* \
 	      | -sym* | -kopensolaris* | -plan9* \
 	      | -amigaos* | -amigados* | -msdos* | -newsos* | -unicos* | -aof* \
-	      | -aos* | -aros* | -cloudabi* | -sortix* \
+	      | -aos* | -aros* | -cloudabi* \
 	      | -nindy* | -vxsim* | -vxworks* | -ebmon* | -hms* | -mvs* \
 	      | -clix* | -riscos* | -uniplus* | -iris* | -rtu* | -xenix* \
 	      | -hiux* | -386bsd* | -knetbsd* | -mirbsd* | -netbsd* \
-	      | -bitrig* | -openbsd* | -solidbsd* | -libertybsd* \
+	      | -bitrig* | -openbsd* | -solidbsd* \
 	      | -ekkobsd* | -kfreebsd* | -freebsd* | -riscix* | -lynxos* \
 	      | -bosx* | -nextstep* | -cxux* | -aout* | -elf* | -oabi* \
 	      | -ptx* | -coff* | -ecoff* | -winnt* | -domain* | -vsta* \
 	      | -udi* | -eabi* | -lites* | -ieee* | -go32* | -aux* \
-	      | -chorusos* | -chorusrdb* | -cegcc* | -glidix* \
+	      | -chorusos* | -chorusrdb* | -cegcc* \
 	      | -cygwin* | -msys* | -pe* | -psos* | -moss* | -proelf* | -rtems* \
-	      | -midipix* | -mingw32* | -mingw64* | -linux-gnu* | -linux-android* \
+	      | -mingw32* | -mingw64* | -linux-gnu* | -linux-android* \
 	      | -linux-newlib* | -linux-musl* | -linux-uclibc* \
 	      | -uxpv* | -beos* | -mpeix* | -udk* | -moxiebox* \
 	      | -interix* | -uwin* | -mks* | -rhapsody* | -darwin* | -opened* \
@@ -1416,8 +1396,7 @@ case $os in
 	      | -os2* | -vos* | -palmos* | -uclinux* | -nucleus* \
 	      | -morphos* | -superux* | -rtmk* | -rtmk-nova* | -windiss* \
 	      | -powermax* | -dnix* | -nx6 | -nx7 | -sei* | -dragonfly* \
-	      | -skyos* | -haiku* | -rdos* | -toppers* | -drops* | -es* \
-	      | -onefs* | -tirtos* | -phoenix* | -fuchsia* | -redox*)
+	      | -skyos* | -haiku* | -rdos* | -toppers* | -drops* | -es* | -tirtos*)
 	# Remember, each alternative MUST END IN *, to match a version number.
 		;;
 	-qnx*)
@@ -1549,8 +1528,6 @@ case $os in
 		;;
 	-nacl*)
 		;;
-	-ios)
-		;;
 	-none)
 		;;
 	*)
@@ -1646,9 +1623,6 @@ case $basic_machine in
 	sparc-* | *-sun)
 		os=-sunos4.1.1
 		;;
-	pru-*)
-		os=-elf
-		;;
 	*-be)
 		os=-beos
 		;;

config_cmake.h.in

@@ -31,9 +31,6 @@
 /* Define to 1 if you have the `getpwent' function. */
 #cmakedefine HAVE_GETPWENT 1
 
-/* Define to 1 if you have the 'getrusage' function. */
-#cmakedefine HAVE_GETRUSAGE 1
-
 /* Define to 1 if you have the `gettext' function. */
 #cmakedefine HAVE_GETTEXT 1
 
@@ -127,8 +124,8 @@
 /* Define to 1 if the _nl_msg_cat_cntr symbol is exported. */
 #cmakedefine HAVE__NL_MSG_CAT_CNTR 1
 
-/* Define to 1 if std::make_unique is available. */
-#cmakedefine HAVE_STD__MAKE_UNIQUE 1
+/* Define to 1 if you have the file `/proc/self/stat'. */
+#cmakedefine HAVE__PROC_SELF_STAT 1
 
 /* Define to 1 if the _sys_errs array is available. */
 #cmakedefine HAVE__SYS__ERRS 1
@@ -145,7 +142,7 @@
 /* Define to the full name of this package. */
 #define PACKAGE_NAME "fish"
 
-/* Define to 1 if tparm accepts a fixed amount of parameters. */
+/* Define to 1 if tparm accepts a fixed amount of paramters. */
 #cmakedefine TPARM_SOLARIS_KLUDGE 1
 
 /* Enable GNU extensions on systems that have them.  */
@@ -168,6 +165,14 @@
 #ifndef __warn_unused
 #define __warn_unused __attribute__ ((warn_unused_result))
 #endif
+#ifndef __sentinel
+#define __sentinel __attribute__ ((sentinel))
+#endif
+#ifndef __packed
+#define __packed __attribute__ ((packed))
+#endif
 #else
 #define __warn_unused
+#define __sentinel
+#define __packed
 #endif

configure.ac

@@ -0,0 +1,726 @@
+#
+# This file is the main build configuration file for fish. It is used
+# to determine your systems capabilities, and tries to adapt fish to
+# take maximum advantage of the services your system offers.
+#
+# Process this file using the 'autoconf' command to produce a working
+# configure script, which should in turn be executed in order to
+# configure the build process.
+#
+
+m4_syscmd([build_tools/git_version_gen.sh 2>/dev/null])
+
+AC_PREREQ([2.60])
+AC_INIT(fish,
+        m4_esyscmd([cut -f 2 -d '=' FISH-BUILD-VERSION-FILE | tr -d '"\n']),
+        https://github.com/fish-shell/fish-shell/issues)
+ac_clean_files=a.out.dSYM
+
+#
+# List of output variables produced by this configure script
+#
+
+AC_SUBST(HAVE_GETTEXT)
+AC_SUBST(HAVE_DOXYGEN)
+AC_SUBST(LDFLAGS_FISH)
+AC_SUBST(WCHAR_T_BITS)
+AC_SUBST(EXTRA_PCRE2)
+AC_SUBST(HAVE_BROKEN_WCWIDTH)
+
+#
+# If needed, run autoconf to regenerate the configure file
+#
+# This makes sure that after running autoconf once to create the first
+# version of configure, we never again need to worry about manually
+# running autoconf to handle an updates configure.ac.
+#
+
+AC_MSG_CHECKING([if autoreconf needs to be run])
+if test configure -ot configure.ac; then
+  AC_MSG_RESULT([yes])
+  if command -v autoreconf >/dev/null; then
+    # No need to provide any error messages if autoreconf fails, the
+    # shell and autconf should take care of that themselves
+    AC_MSG_NOTICE([running autoreconf --no-recursive])
+    if autoreconf --no-recursive; then
+      ./configure "$@"
+      exit
+    fi
+    exit 1
+  else
+    AC_MSG_ERROR(
+      [cannot find the autoreconf program in your path.
+This program needs to be run whenever the configure.ac file is modified.
+Please install autoreconf and try again.]
+    )
+  fi
+else
+  AC_MSG_RESULT([no])
+fi
+
+
+#
+# If needed, run autoheader to regenerate config.h.in
+#
+# This makes sure we never ever have to run autoheader manually. It
+# will be run whenever needed automatically.
+#
+
+AC_MSG_CHECKING([if autoheader needs to be run])
+if test ! -f ./config.h.in -o config.h.in -ot configure.ac; then
+  AC_MSG_RESULT([yes])
+  if command -v autoheader >/dev/null; then
+    AC_MSG_NOTICE([running autoheader])
+    autoheader || exit 1
+  else
+    AC_MSG_ERROR(
+      [cannot find the autoheader program in your path.
+This program needs to be run whenever the configure.ac file is modified.
+Please install autotools and try again.]
+    )
+  fi
+else
+  AC_MSG_RESULT([no])
+fi
+
+#
+# Include the autoconf macros directory
+#
+
+AC_CONFIG_MACRO_DIRS([m4])
+
+#
+# Set up various programs needed for install
+# Note AC_PROG_CXX sets CXXFLAGS if not set, which we want
+# So ensure this happens before we modify CXXFLAGS below
+# Do CC also, because PCRE2 will use it.
+AC_PROG_CC
+AC_PROG_CC_STDC # c99
+AC_PROG_CXX
+AC_LANG(C++)
+AC_PROG_INSTALL
+AC_PROG_LN_S
+AC_PROG_MKDIR_P
+AC_PROG_AWK
+AC_PROG_FGREP
+AC_PROG_SED
+AC_USE_SYSTEM_EXTENSIONS
+AX_CXX_COMPILE_STDCXX_11(noext,mandatory)
+
+#
+# Tell autoconf to create config.h header
+#
+AC_CONFIG_HEADERS(config.h)
+AC_CANONICAL_HOST
+
+
+#
+# This adds markup to the code that results in a few extra compile
+# time checks on recent GCC versions. It helps stop a few common bugs.
+#
+
+AH_BOTTOM([#if __GNUC__ >= 3
+#ifndef __warn_unused
+#define __warn_unused __attribute__ ((warn_unused_result))
+#endif
+#ifndef __sentinel
+#define __sentinel __attribute__ ((sentinel))
+#endif
+#ifndef __packed
+#define __packed __attribute__ ((packed))
+#endif
+#else
+#define __warn_unused
+#define __sentinel
+#define __packed
+#endif])
+
+
+#
+# Optionally drop gettext support
+#
+
+AC_ARG_WITH(
+  gettext,
+  AS_HELP_STRING(
+    [--without-gettext],
+    [do not translate messages, even if gettext is available]
+  ),
+  [local_gettext=$withval],
+  [local_gettext=check]
+)
+
+AS_IF([test x$local_gettext != xno],
+  [ AC_CHECK_PROGS( [found_msgfmt], [msgfmt], [no] )
+    if test x$found_msgfmt != xno; then
+      AC_DEFINE([USE_GETTEXT],[1],[Perform string translations with gettext])
+    elif test "x$local_gettext" != "xcheck" ; then
+      AC_MSG_FAILURE([--with-gettext was given, but the msgfmt program could not be found])
+    else
+      local_gettext=no
+    fi
+   ],
+)
+
+#
+# Build/clean the documentation only if Doxygen is available
+#
+
+doxygen_minimum=1.8.7
+
+AC_ARG_WITH(
+  doxygen,
+  AS_HELP_STRING(
+    [--with-doxygen],
+    [use Doxygen to regenerate documentation]
+  ),
+  [use_doxygen=$withval],
+  [use_doxygen=auto]
+)
+
+AS_IF([test "$use_doxygen" != "no"],
+  [
+    AC_CHECK_PROGS([found_doxygen], [doxygen], [no])
+    if test "$found_doxygen" != no; then
+      # test version
+      AC_MSG_CHECKING([the doxygen version])
+      doxygen_version=`doxygen --version 2>/dev/null`
+      AC_MSG_RESULT([$doxygen_version])
+      dnl This requires autoconf 2.60 or newer
+      AS_VERSION_COMPARE([$doxygen_version], [$doxygen_minimum],
+        [ if test "$use_doxygen" = auto; then
+            AC_MSG_WARN([doxygen version $doxygen_version found, but $doxygen_minimum required])
+            HAVE_DOXYGEN=0
+          else
+            AC_MSG_FAILURE([doxygen version $doxygen_version found, but $doxygen_minimum required])
+          fi
+        ],
+        [HAVE_DOXYGEN=1], [HAVE_DOXYGEN=1])
+    elif test "$use_doxygen" != auto; then
+      AC_MSG_FAILURE([--with-doxygen was given, but the doxygen program could not be found])
+    else
+      HAVE_DOXYGEN=0
+    fi
+  ],
+)
+
+#
+# Try to enable large file support. This will make sure that on systems
+# where off_t can be either 32 or 64 bit, the latter size is used. On
+# other systems, this should do nothing. (Hopefully)
+#
+AC_SYS_LARGEFILE
+
+
+# Fish does not use exceptions.
+CXXFLAGS="$CXXFLAGS -fno-exceptions"
+
+#
+# Set some warning flags
+# Don't warn about missing field initializers, it has too many
+# false positives for code like `struct termios tmodes = {};`
+#
+CXXFLAGS="$CXXFLAGS -Wextra -Wno-missing-field-initializers"
+
+#
+# This is needed in order to get the really cool backtraces on Linux
+#
+AC_MSG_CHECKING([for -rdynamic linker flag])
+prev_LDFLAGS="$LDFLAGS"
+LDFLAGS="$LDFLAGS -rdynamic"
+AC_LINK_IFELSE([AC_LANG_PROGRAM([[]],[[]])],
+               [
+                AC_MSG_RESULT([yes])
+                LDFLAGS_FISH="$LDFLAGS_FISH -rdynamic"
+               ], [
+                AC_MSG_RESULT([no])
+                LDFLAGS_FISH="$LDFLAGS_FISH"
+               ])
+LDFLAGS="$prev_LDFLAGS"
+
+#
+# See if Linux procfs is present. This is used to get extra
+# information about running processes.
+#
+
+AC_CHECK_FILES([/proc/self/stat])
+
+# Disable curses macros that conflict with the STL
+AC_DEFINE([NCURSES_NOMACROS], [1], [Define to 1 to disable ncurses macros that conflict with the STL])
+AC_DEFINE([NOMACROS], [1], [Define to 1 to disable curses macros that conflict with the STL])
+
+# Threading is excitingly broken on Solaris without adding -pthread to CXXFLAGS
+# Only support GCC for now
+dnl Ideally we would use the AX_PTHREAD macro here, but it's GPL3-licensed
+dnl ACX_PTHREAD is way too old and seems to break the OS X build
+dnl Both only check with AC_LANG(C) in any case
+case $host_os in
+  solaris*)
+  CXXFLAGS="$CXXFLAGS -pthread"
+  CFLAGS="$CFLAGS -pthread"
+  ;;
+esac
+
+#
+# Check presense of various libraries. This is done on a per-binary
+# level, since including various extra libraries in all binaries only
+# because thay are used by some of them can cause extra bloat and
+# slower compiles when developing fish.
+#
+
+# Check for os dependant libraries for all binaries.
+AC_SEARCH_LIBS( nanosleep, rt, , [AC_MSG_ERROR([Cannot find the rt library, needed to build this package.] )] )
+AC_SEARCH_LIBS( shm_open, rt, [AC_DEFINE([HAVE_SHM_OPEN], [1], [Define to 1 if the shm_open() function exists])] )
+AC_SEARCH_LIBS( pthread_create, pthread, , [AC_MSG_ERROR([Cannot find the pthread library, needed to build this package.] )] )
+AC_SEARCH_LIBS( setupterm, [ncurses tinfo curses], , [AC_MSG_ERROR([Could not find a curses implementation, needed to build fish. If this is Linux, try running 'sudo apt-get install libncurses5-dev' or 'sudo yum install ncurses-devel'])] )
+AC_SEARCH_LIBS( [dladdr], [dl] )
+
+if test x$local_gettext != xno; then
+  AC_SEARCH_LIBS( gettext, intl,,)
+fi
+
+#
+# Check presense of various header files
+#
+
+AC_CHECK_HEADERS([getopt.h termios.h sys/resource.h term.h ncurses/term.h ncurses.h ncurses/curses.h curses.h stropts.h siginfo.h sys/select.h sys/ioctl.h execinfo.h spawn.h sys/sysctl.h])
+
+if test x$local_gettext != xno; then
+  AC_CHECK_HEADERS([libintl.h])
+fi
+
+
+#
+# Get the size in bits of wchar_t, needed for configuring the pcre2 build
+# and for code that #includes pcre2.h
+#
+
+AC_CHECK_SIZEOF(wchar_t)
+WCHAR_T_BITS=`expr 8 \* $ac_cv_sizeof_wchar_t`
+AC_DEFINE_UNQUOTED([WCHAR_T_BITS], [$WCHAR_T_BITS], [The size of wchar_t in bits.])
+
+#
+# Detect nanoseconds fields in struct stat
+#
+AC_CHECK_MEMBERS([struct stat.st_ctime_nsec])
+AC_CHECK_MEMBERS([struct stat.st_mtimespec.tv_nsec])
+AC_CHECK_MEMBERS([struct stat.st_mtim.tv_nsec])
+
+#
+# Check for D_TYPE in dirent, only on BSD and Linux
+#
+AC_STRUCT_DIRENT_D_TYPE
+
+#
+# Check for presence of various functions used by fish
+#
+
+AC_CHECK_FUNCS( wcsndup )
+AC_CHECK_FUNCS( wcstod_l )
+AC_CHECK_FUNCS( futimes )
+AC_CHECK_FUNCS( wcslcpy lrand48_r killpg )
+AC_CHECK_FUNCS( backtrace_symbols getifaddrs )
+AC_CHECK_FUNCS( futimens clock_gettime )
+AC_CHECK_FUNCS( getpwent flock )
+AC_CHECK_FUNCS( dirfd )
+
+AC_CHECK_DECL( [mkostemp], [ AC_CHECK_FUNCS([mkostemp]) ] )
+
+#
+# Although setupterm is linkable thanks to SEARCH_LIBS above, some
+# builds of ncurses include the actual headers in a different package
+#
+AC_CHECK_DECL( [setupterm], , [AC_MSG_ERROR([Could not find a curses implementation, needed to build fish. If this is Linux, try running 'sudo apt-get install libncurses5-dev' or 'sudo yum install ncurses-devel'])], [
+#if HAVE_NCURSES_H
+#include <ncurses.h>
+#elif HAVE_NCURSES_CURSES_H
+#include <ncurses/curses.h>
+#else
+#include <curses.h>
+#endif
+#if HAVE_TERM_H
+#include <term.h>
+#elif HAVE_NCURSES_TERM_H
+#include <ncurses/term.h>
+#endif
+] )
+
+dnl AC_CHECK_FUNCS uses C linkage, but sometimes (Solaris!) the behaviour is
+dnl different with C++.
+AC_MSG_CHECKING([for wcsdup])
+AC_TRY_LINK( [ #include <wchar.h> ],
+             [ wchar_t* foo = wcsdup(L""); ],
+             [ AC_MSG_RESULT(yes)
+               AC_DEFINE(HAVE_WCSDUP, 1, Define to 1 if you have the `wcsdup' function.)
+             ],
+             [AC_MSG_RESULT(no)],
+             )
+
+AC_MSG_CHECKING([for std::wcsdup])
+AC_TRY_LINK( [ #include <wchar.h> ],
+             [ wchar_t* foo = std::wcsdup(L""); ],
+             [ AC_MSG_RESULT(yes)
+               AC_DEFINE(HAVE_STD__WCSDUP, 1, Define to 1 if you have the `std::wcsdup' function.)
+             ],
+             [AC_MSG_RESULT(no)],
+             )
+
+AC_MSG_CHECKING([for wcscasecmp])
+AC_TRY_LINK( [ #include <wchar.h> ],
+             [ int foo = wcscasecmp(L"", L""); ],
+             [ AC_MSG_RESULT(yes)
+               AC_DEFINE(HAVE_WCSCASECMP, 1, Define to 1 if you have the `wcscasecmp' function.)
+             ],
+             [AC_MSG_RESULT(no)],
+             )
+
+AC_MSG_CHECKING([for std::wcscasecmp])
+AC_TRY_LINK( [ #include <wchar.h> ],
+             [ int foo = std::wcscasecmp(L"", L""); ],
+             [ AC_MSG_RESULT(yes)
+               AC_DEFINE(HAVE_STD__WCSCASECMP, 1, Define to 1 if you have the `std::wcscasecmp' function.)
+             ],
+             [AC_MSG_RESULT(no)],
+             )
+
+AC_MSG_CHECKING([for wcsncasecmp])
+AC_TRY_LINK( [ #include <wchar.h> ],
+             [ int foo = wcsncasecmp(L"", L"", 0); ],
+             [ AC_MSG_RESULT(yes)
+               AC_DEFINE(HAVE_WCSNCASECMP, 1, Define to 1 if you have the `wcsncasecmp' function.)
+             ],
+             [AC_MSG_RESULT(no)],
+             )
+
+AC_MSG_CHECKING([for std::wcsncasecmp])
+AC_TRY_LINK( [ #include <wchar.h> ],
+             [ int foo = std::wcsncasecmp(L"", L"", 0); ],
+             [ AC_MSG_RESULT(yes)
+               AC_DEFINE(HAVE_STD__WCSNCASECMP, 1, Define to 1 if you have the `std::wcsncasecmp' function.)
+             ],
+             [AC_MSG_RESULT(no)],
+             )
+
+AC_MSG_CHECKING([for std::make_unique])
+AC_TRY_LINK( [ #include <memory> ],
+             [ std::unique_ptr<int> foo = std::make_unique<int>(); ],
+             [ AC_MSG_RESULT(yes)
+               AC_DEFINE(HAVE_STD__MAKE_UNIQUE, 1, Define to 1 if you have the `std::make_unique' function.)
+             ],
+             [AC_MSG_RESULT(no)],
+             )
+
+if test x$local_gettext != xno; then
+  AC_CHECK_FUNCS( gettext )
+
+#
+# The Makefile also needs to know if we have gettext, so it knows if
+# the translations should be installed.
+#
+  AC_CHECK_FUNC( gettext, HAVE_GETTEXT=1, HAVE_GETTEXT=0 )
+fi
+
+#
+# Here follows a list of small programs used to test for various
+# features that Autoconf doesn't tell us about
+#
+
+dnl AC_CHECK_FUNCS uses C linkage, but sometimes (Solaris!) the behaviour is
+dnl different with C++.
+AC_MSG_CHECKING([if ctermid_r() available])
+AC_TRY_LINK( [ #include <stdio.h> ],
+             [ char buf[L_ctermid]; char *foo = ctermid_r(buf); ],
+             [ AC_MSG_RESULT(yes)
+               AC_DEFINE(HAVE_CTERMID_R, 1, Define to 1 if you have the `ctermid_r' function.)
+             ],
+             [AC_MSG_RESULT(no)],
+             )
+
+#
+# Check if struct winsize and TIOCGWINSZ exist
+#
+
+AC_MSG_CHECKING([if struct winsize and TIOCGWINSZ exist])
+AC_LINK_IFELSE(
+  [
+    AC_LANG_PROGRAM(
+      [
+        #ifdef HAVE_TERMIOS_H
+        #include <termios.h>
+        #endif
+
+        #ifdef HAVE_SYS_IOCTL_H
+        #include <sys/ioctl.h>
+        #endif
+      ],
+      [
+        struct winsize termsize = {0};
+        TIOCGWINSZ;
+      ]
+    )
+  ],
+  [
+    AC_MSG_RESULT(yes);
+    AC_DEFINE([HAVE_WINSIZE], [1], [Define to 1 if the winsize struct and TIOCGWINSZ macro exist])
+  ],
+  [
+    AC_MSG_RESULT(no)
+  ]
+)
+
+
+# Check for _nl_msg_cat_cntr symbol
+AC_MSG_CHECKING([for _nl_msg_cat_cntr symbol])
+AC_TRY_LINK(
+  [
+    #if HAVE_LIBINTL_H
+    #include <libintl.h>
+    #endif
+    #include <stdlib.h>
+  ],
+  [
+    extern int  _nl_msg_cat_cntr;
+    int tmp = _nl_msg_cat_cntr;
+    exit(tmp);
+  ],
+  have__nl_msg_cat_cntr=yes,
+  have__nl_msg_cat_cntr=no
+)
+if test "$have__nl_msg_cat_cntr" = yes; then
+  AC_MSG_RESULT(yes)
+  AC_DEFINE(
+    [HAVE__NL_MSG_CAT_CNTR],
+    [1],
+    [Define to 1 if the _nl_msg_cat_cntr symbol is exported.]
+  )
+else
+  AC_MSG_RESULT(no)
+fi
+
+
+# Check for sys_errlist
+AC_MSG_CHECKING([for sys_errlist array])
+AC_TRY_LINK(
+  [
+   #include <stdio.h>
+  ],
+  [
+    const char *p;
+    p = sys_errlist[sys_nerr];
+  ],
+  have_sys_errlist=yes,
+  have_sys_errlist=no
+)
+if test "$have_sys_errlist" = yes; then
+  AC_MSG_RESULT(yes)
+  AC_DEFINE(
+    [HAVE_SYS_ERRLIST],
+    [1],
+    [Define to 1 if the sys_errlist array is available.]
+  )
+else
+  AC_MSG_RESULT(no)
+fi
+
+# Check for _sys_errs
+AC_MSG_CHECKING([for _sys_errs array])
+AC_TRY_LINK(
+  [
+   #include <string>
+  ],
+  [
+    std::string p;
+    extern const char _sys_errs[];
+    extern const int _sys_index[];
+    p = _sys_errs[_sys_index[0]];
+  ],
+  have__sys__errs=yes,
+  have__sys__errs=no
+)
+if test "$have__sys__errs" = yes; then
+  AC_MSG_RESULT(yes)
+  AC_DEFINE(
+    [HAVE__SYS__ERRS],
+    [1],
+    [Define to 1 if the _sys_errs array is available.]
+  )
+else
+  AC_MSG_RESULT(no)
+fi
+
+# Check for Solaris curses tputs having fixed length parameter list.
+AC_MSG_CHECKING([if we are using non varargs tparm.])
+AC_COMPILE_IFELSE(
+  [
+    AC_LANG_PROGRAM(
+      [
+	#if HAVE_NCURSES_H
+	#include <ncurses.h>
+	#elif HAVE_NCURSES_CURSES_H
+	#include <ncurses/curses.h>
+	#else
+	#include <curses.h>
+	#endif
+
+	#if HAVE_TERM_H
+	#include <term.h>
+	#elif HAVE_NCURSES_TERM_H
+	#include <ncurses/term.h>
+	#endif
+      ],
+      [
+        tparm( "" );
+      ]
+    )
+  ],
+  [tparm_solaris_kludge=no],
+  [tparm_solaris_kludge=yes]
+)
+if test "x$tparm_solaris_kludge" = "xyes"; then
+  AC_MSG_RESULT(yes)
+  AC_DEFINE(
+    [TPARM_SOLARIS_KLUDGE],
+    [1],
+    [Define to 1 if tparm accepts a fixed amount of paramters.]
+  )
+else
+  AC_MSG_RESULT(no)
+fi
+
+# ========
+# PCRE2 library configuration.
+pcre2_min_version=10.21
+EXTRA_PCRE2=
+AC_ARG_WITH(
+  included-pcre2,
+  AS_HELP_STRING(
+    [--without-included-pcre2],
+    [build against the system PCRE2 library instead of the bundled version]
+  ),
+  [included_pcre2=$withval],
+  [included_pcre2=auto]
+)
+
+HAVE_BROKEN_WCWIDTH=
+AC_ARG_ENABLE(
+    [wcwidth],
+    AS_HELP_STRING(
+        [--disable-internal-wcwidth],
+        [use system wcwidth instead of the bundled version]
+        ))
+
+if test "x$enable_wcwidth" != "xno"; then
+      AC_DEFINE([HAVE_BROKEN_WCWIDTH], [1], [banana])
+else
+      AC_DEFINE([HAVE_BROKEN_WCWIDTH], [0], [banana])
+fi
+
+if test "x$included_pcre2" != "xyes"; then
+
+  # test for pcre2-config
+  # can use either pcre2-config or pkgconfig here but only implement the former for now
+  AC_CHECK_PROG(PCRE2_CONFIG, pcre2-config, pcre2-config)
+
+  if test "x$PCRE2_CONFIG" != "x"; then
+    dnl AC_MSG_CHECKING([for $WCHAR_T_BITS-bit PCRE2])
+    XLIBS="$LIBS"
+    LIBS="$LIBS "`$PCRE2_CONFIG --libs$WCHAR_T_BITS 2>/dev/null`
+    XCXXFLAGS="$CXXFLAGS"
+    CXXFLAGS="$CXXFLAGS "`$PCRE2_CONFIG --cflags`
+
+    # cheat a bit here. the exact library is determined by $WCHAR_T_BITS,
+    # and so AC_CHECK_LIB won't work (can't use a variable as library name)
+    # AC_SEARCH_LIBS will use the existing $LIBS flags with no additional library first
+    AC_SEARCH_LIBS([pcre2_compile_$WCHAR_T_BITS], [],
+      [ # pcre2 lib found, check for minimum version
+        pcre2_version=`$PCRE2_CONFIG --version`
+        AS_VERSION_COMPARE([$pcre2_version], [$pcre2_min_version],
+          [ # version < minimum
+            AC_MSG_NOTICE([system PCRE2 library version $pcre2_version, need $pcre2_min_version or later])
+            if test "x$included_pcre2" = "xno"; then
+              # complain about pcre2 version
+              AC_MSG_ERROR([system PCRE2 library is too old, but --without-included-pcre2 was given.])
+            else
+              # use the internal version; undo changes to LIBS/CXXFLAGS
+              included_pcre2=yes
+              LIBS="$XLIBS"
+              CXXFLAGS="$XCXXFLAGS"
+            fi
+          ],
+          [ # version == minimum
+            working_pcre2=yes
+          ],
+          [ # version > minimum
+            working_pcre2=yes
+          ]
+        )
+      ],
+      [ # fail case; undo the changes to LIBS/CXXFLAGS
+       working_pcre2=no
+       LIBS="$XLIBS"
+       CXXFLAGS="$XCXXFLAGS"
+      ]
+    )
+  fi
+
+  if test "x$working_pcre2" = "xyes"; then
+    AC_MSG_NOTICE([using system PCRE2 library])
+  else
+    # pcre2 size wrong or pcre2-config not found
+    # is it OK to use the included version?
+    if test "x$included_pcre2" = "xno"; then
+      # complain
+      AC_MSG_ERROR([cannot find system pcre2-config, but --without-included-pcre2 was given.
+Make sure pcre2-config is installed and available in PATH.
+You may need to install the PCRE2 development library for your system.])
+    else
+      # use the internal version
+      included_pcre2=yes
+    fi
+  fi
+fi
+
+# Re-test as value may have changed.
+if test "x$included_pcre2" = "xyes"; then
+  # Build configure/Makefile for pcre2
+  AC_MSG_NOTICE([using included PCRE2 library])
+  # unfortunately these get added to the global configuration
+  ac_configure_args="$ac_configure_args --disable-pcre2-8 --enable-pcre2-$WCHAR_T_BITS --disable-shared"
+  AC_CONFIG_SUBDIRS([pcre2-10.22])
+
+  PCRE2_CXXFLAGS='-I$(PCRE2_DIR)/src'
+  PCRE2_LIBS='-L$(PCRE2_LIBDIR) -lpcre2-$(PCRE2_WIDTH)'
+
+  # Make the binary depend on the PCRE2 libraries so they get built
+  EXTRA_PCRE2='$(PCRE2_LIB)'
+  CXXFLAGS="$CXXFLAGS $PCRE2_CXXFLAGS"
+  LIBS="$LIBS $PCRE2_LIBS"
+fi
+
+# Allow configurable extra directories.
+AC_SUBST(extra_completionsdir)
+AC_ARG_WITH([extra-completionsdir],
+            AS_HELP_STRING([--with-extra-completionsdir=DIR],
+                           [path for extra completions]),
+            [extra_completionsdir=$withval],
+            [extra_completionsdir='${datadir}/fish/vendor_completions.d'])
+
+AC_SUBST(extra_functionsdir)
+AC_ARG_WITH([extra_functionsdir],
+            AS_HELP_STRING([--with-extra-functionsdir=DIR],
+                           [path for extra functions]),
+            [extra_functionsdir=$withval],
+            [extra_functionsdir='${datadir}/fish/vendor_functions.d'])
+
+AC_SUBST(extra_confdir)
+AC_ARG_WITH([extra-confdir],
+            AS_HELP_STRING([--with-extra-confdir=DIR],
+                           [path for extra conf]),
+            [extra_confdir=$withval],
+            [extra_confdir='${datadir}/fish/vendor_conf.d'])
+
+# Tell the world what we know.
+AC_CONFIG_FILES([Makefile])
+AC_OUTPUT
+
+echo "fish is now configured."

debian/control

@@ -3,18 +3,16 @@ Section: shells
 Priority: extra
 Maintainer: ridiculous_fish <corydoras@ridiculousfish.com>
 Uploaders: David Adam <zanchey@ucc.gu.uwa.edu.au>
-Build-Depends: debhelper (>= 9.0.0), libncurses5-dev, cmake3 (>= 3.2.0) | cmake (>= 3.2.0), gettext,
-# Test dependencies
- locales-all
+Build-Depends: debhelper (>= 9.0.0), libncurses5-dev, cmake3 (>= 3.2.0) | cmake (>= 3.2.0), gettext
 # When libpcre2-dev is available on all supported Debian versions, add a dependency on that.
-Standards-Version: 3.9.7
+Standards-Version: 3.9.4
 Homepage: https://fishshell.com/
 Vcs-Git: https://github.com/fish-shell/fish-shell.git
 Vcs-Browser: https://github.com/fish-shell/fish-shell
 
 Package: fish
 Architecture: any
-Depends: ${shlibs:Depends}, ${misc:Depends}, fish-common (= ${source:Version}), passwd (>= 4.0.3-10), gettext-base, man-db
+Depends: ${shlibs:Depends}, ${misc:Depends}, fish-common (= ${source:Version}), passwd (>= 4.0.3-10), bc, gettext-base, man-db
 Recommends: xsel (>=1.2.0)
 Description: friendly interactive shell
  Fish is a command-line shell for modern systems, focusing on user-friendliness,

debian/rules

@@ -18,3 +18,6 @@ override_dh_installdocs:
 # Consider transitioning https://wiki.debian.org/DebugPackage
 override_dh_strip:
 	dh_strip --dbg-package=fish-dbg
+
+# Don't run tests; they don't work until fish is installed
+override_dh_auto_test:

doc_src/FORMATTING.md

@@ -0,0 +1,253 @@
+# Formatting guide for fish docs
+
+The fish documentation has been updated to support Doxygen 1.8.7+, and while the main benefit of this change is extensive Markdown support, the addition of a fish lexicon and syntax filter, combined with semantic markup rules allows for automatic formatting enhancements across the HTML user_docs and man pages.
+
+Initially my motivation was to fix a problem with long options ([Issue #1557](https://github.com/fish-shell/fish-shell/issues/1557) on GitHub), but as I worked on fixing the issue I realised there was an opportunity to simplify, reinforce and clarify the current documentation, hopefully making further contribution easier and cleaner, while allowing the documentation examples to presented more clearly with less author effort.
+
+While the documentation is pretty robust to variations in the documentation source, adherence to the following style guide will help keep the already excellent documentation in good shape moving forward.
+
+## Line breaks and wrapping
+
+Contrary to the rest of the fish source code, the documentation greatly benefits from the use of long lines and soft wrapping. Doxygen is able to treat paragraphs as complete blocks. The semantic filter can see complete lines when deciding on how to apply syntax highlighting. In advanced pagers, such as 'most', man pages will consistently wrap to the width of the user's console.
+
+## Doxygen special commands and aliases
+
+While Markdown syntax forms the basis of the documentation content, there are some exceptions that require the use of Doxygen special commands. On the whole, Doxygen commands should be avoided, especially inline word formatting such as \\c as this would allow Doxygen to make unhelpful assumptions, such as converting double dashes (\--) to n-dashes (–).
+
+### Structure: \\page, \\section and \\subsection
+
+Use of Doxygen sections markers are important, as these determine what will be eventually output as a web page, man page or included in the developer docs.
+
+Currently the make process for the documentation is quite convoluted, but basically the HTML docs are produced from a single, compiled file, doc.h. This contains a number of \\page markers that produce the various pages used in the documentation. The format of a \\page mark is:
+
+    \page universally_unique_page_id Page title
+
+The source files that contain the page markers are currently:
+
+- __index.hdr.in__: Core documentation
+- __commands.hdr.in__: Individual commands
+- __tutorial.hdr__: Tutorial
+- __design.hdr__: Design document
+- __faq.hdr__: Frequently Asked Questions
+- __license.hdr__: Fish and 3rd party licences
+
+Unless there is a _VERY_ good reason and developer consensus, new pages should never be added.
+
+The rest of the documentation is structured using \\section and \\subsection markers. Most of the source files (listed above) contain their full content, the exception being commands, which are separated out into source text files in the doc_src directory. These files are concatenated into one file, so each one starts with a \\section declaration. The synopsis, description and examples (if present) are declared as \\subsections. The format of these marks is practically identical to the page mark.
+
+    \section universally_unique_section_id Section title
+    \subsection universally_unique_subsection_id Subsection title
+
+Each page, section and subsection id _must_ be unique across the whole of the documentation, otherwise Doxygen will issue a warning.
+
+### Semantic markup: the \\fish .. \\endfish block
+
+While Doxygen has support for \\code..\\endcode blocks with enhanced markup and syntax colouring, it only understands the core Doxygen languages: C, C++, Objective C, Java, PHP, Python, Tcl and Fortran. To enhance Fish's syntax presentation, use the special \\fish..\\endfish blocks instead.
+
+Text placed in this block will be parsed by Doxygen using the included lexicon filter (see lexicon_filter.in) as a Doxygen input filter. The filter is built during make so that it can pick up information on builtins, functions and shell commands mentioned in completions and apply markup to keywords found inside the \\fish block.
+
+Basically, preformatted plain text inside the \\fish block is fed through the filter and is returned marked up so that Doxygen aliases can convert it back to a presentable form, according to the output document type.
+
+For instance:
+
+`echo hello world`
+
+is transformed into:
+
+`@cmnd{echo} @args{hello} @args{world}`
+
+which is then transformed by Doxygen into an HTML version (`make doc`):
+
+`<span class="command">echo</span> <span class="argument">hello</span> <span class="argument">world</span>`
+
+And a man page version (`make share/man`):
+
+__echo__ hello world
+
+### Fonts
+
+In older browsers, it was easy to set the fonts used for the three basic type styles (serif, sans-serif and monospace). Modern browsers have removed these options in their respective quests for simplification, assuming the content author will provide suitable styles for the content in the site's CSS, or the end user will provide overriding styles manually. Doxygen's default styling is very simple and most users will just accept this default.
+
+I've tried to use a sensible set of fonts in the documentation's CSS based on 'good' terminal fonts and as a result the first preference font used throughout the documentation is '[DejaVu](https://dejavu-fonts.github.io)'. The rationale behind this is that while DejaVu is getting a little long in the tooth, it still provides the most complete support across serif, sans-serif and monospace styles (giving a well balanced feel and consistent [x-height](https://en.wikipedia.org/wiki/X-height)), has the widest support for extended Unicode characters and has a free, permissive licenses (though it's still incompatible with GPLv2, though arguably less so than the SIL Open Font license, though this is a moot point when using it solely in the docs).
+
+#### Fonts inside \\fish blocks and \`backticks\`
+
+As the point of these constructs is to make fish's syntax clearer to the user, it makes sense to mimic what the user will see in the console, therefore any content is formatted using the monospaced style, specifically monospaced fonts are chosen in the following order:
+
+1. __DejaVu Sans Mono__: Explained above. [[&darr;](https://dejavu-fonts.github.io)]
+2. __Source Code Pro__: Monospaced code font, part of Adobe's free Edge Web Fonts. [[&darr;](https://edgewebfonts.adobe.com)]
+3. __Menlo__: Apple supplied variant of DejaVu.
+4. __Ubuntu Mono__: Ubuntu Linux's default monospaced font. [[&darr;](http://font.ubuntu.com)]
+5. __Consolas__: Modern Microsoft supplied console font.
+6. __Monaco__: Apple supplied console font since 1984!
+7. __Lucida Console__: Generic mono terminal font, standard in many OS's and distros.
+8. __monospace__: Catchall style. Chooses default monospaced font, often Courier.
+9. __fixed__: As above, more often used on mobile devices.
+
+#### General Fonts
+
+1. __DejaVu Sans__: As above.[[&darr;](https://dejavu-fonts.github.io)]
+2. __Roboto__: Elegant Google free font and is Doxygen's default [[&darr;](https://fonts.google.com/specimen/Roboto)]
+3. __Lucida Grande__: Default Apple OS X content font.
+4. __Calibri__: Default Microsoft Office font (since 2007).
+5. __Verdana__: Good general font found in a lot of OSs.
+6. __Helvetica Neue__: Better spaced and balanced Helvetica/Arial variant.
+7. __Helvetica__: Standard humanist typeface found almost everywhere.
+8. __Arial__: Microsoft's Helvetica.
+9. __sans-serif__: Catchall style. Chooses default sans-serif typeface, often Helvetica.
+
+The ordering of the fonts is important as it's designed to allow the documentation to settle into a number of different identities according to the fonts available. If you have the complete DejaVu family installed, then the docs are presented using that, and if your Console is set up to use the same fonts, presentation will be completely consistent.
+
+On OS X, with nothing extra installed, the docs will default to Menlo and Lucida Grande giving a Mac feel. Under Windows, it will default to using Consolas and Calibri on recent versions, giving a modern Windows style.
+
+#### Other sources:
+
+- [Font Squirrel](https://www.fontsquirrel.com): Good source of open source font packages.
+
+### Choosing a CLI style: using a \\fish{style} block
+
+By default, when output as HTML, a \\fish block uses syntax colouring suited to the style of the documentation rather than trying to mimic the terminal. The block has a light, bordered background and a colour scheme that 'suggests' what the user would see in a console.
+
+Additional stying can be applied adding a style declaration:
+
+    \fish{additional_style [another_style...]}
+        ...
+    \endfish
+
+This will translate to classes applied to the `<div>` tag, like so:
+
+    <div class="fish additional_style another_style">
+        ...
+    </div>
+
+The various classes are defined in `doc_src/user_doc.css` and new style can be simply added
+
+The documentation currently defines a couple of additional styles:
+
+- __cli-dark__: Used in the _tutorial_ and _FAQ_ to simulate a dark background terminal, with fish's default colours (slightly tweaked for legibility in the browser).
+
+- __synopsis__: A simple colour theme helpful for displaying the logical 'summary' of a command's syntax, options and structure.
+
+## Markdown
+
+Apart from the exceptions discussed above, the rest of the documentation now supports the use of Markdown. As such the use of Doxygen special commands for HTML tags is unnecessary.
+
+There are a few exceptions and extensions to the Markdown [standard](https://daringfireball.net/projects/markdown/) that are documented in the Doxygen [documentation](https://www.stack.nl/~dimitri/doxygen/manual/markdown.html).
+
+### \`Backticks\`
+
+As is standard in Markdown and 'Github Flavoured Markdown' (GFM), backticks can be used to denote inline technical terms in the documentation, `like so`. In the documentation this will set the font to the monospaced 'console' typeface and will cause the enclosed term to stand out.
+
+However, fenced code blocks using 4 spaces or 3 backticks (\`\`\`) should be avoided as Doxygen will interpret these as \\code blocks and try to apply standard syntax colouring, which doesn't work so well for fish examples. Use `\fish..\endfish` blocks instead.
+
+### Lists
+
+Standard Markdown list rules apply, but as Doxygen will collapse white space on output, combined with the use of long lines, it's a good idea to include an extra new line between long list items to assist future editing.
+
+## Special cases
+
+The following can be used in \\fish blocks to render some fish scenarios. These are mostly used in the tutorial when an interactive situation needs to be displayed.
+
+### Custom formatting tags
+
+```html
+<u>: <u>These words are underlined.</u>
+<s>: auto<s>suggestion</s>.
+<m>: <m>Matched</m> items, such as tab completions.
+<sm>: Matched items <sm>searched</sm> for, like grep results.
+<bs>: Render the contents with a preceding backslash. Useful when presenting output.
+<eror>: <eror>This would be shown as an error. (Note eror, not error).</eror>
+<asis>: <asis>This text will not be parsed for fish markup.</asis>
+<outp>: <outp>This would be rendered as command/script output.</outp>
+{{ and }}: Required when wanting curly braces in regular expression example.
+```
+
+### Prompts and cursors
+
+```html
+>_: Display a basic prompt.
+~>_: Display a prompt with a the home directory as the current working directory.
+___ (3 underscores): Display a cursor.
+```
+
+### Keyboard shortcuts: @key{} and @cursor_key{}
+
+Graphical keyboard shortcuts can be defined using the following special commands. These allow for the different text requirements across the html and man pages. The HTML uses CSS to create a keyboard style, whereas the man page would display the key as text.
+
+- `@key{lable}`
+  Displays a key with a purely textual lable, such as: 'Tab', 'Page Up', 'Page Down', 'Home', 'End', 'F1', 'F19' and so on.
+
+- `@key{modifier,lable}`
+  Displays a keystroke requiring the use of a 'modifier' key, such as 'Control-A', 'Shift-X', 'Alt-Tab' etc.
+
+- `@key{modifier,entity,lable}`
+  Displays a keystroke using a graphical entity, such as an arrow symbol for cursor key based shortcuts.
+
+- `@cursor_key{entity,lable}`
+  A special case for cursor keys, when no modifier is needed. i.e. `@cursor_key{&uarr;,up}` for the up arrow key.
+
+Some useful Unicode/HTML5 entities:
+
+- Up arrow: `&uarr;`
+- Down arrow: `&darr;`
+- Left arrow: `&larr;`
+- Right arrow `&rarr;`
+- Shift: `&#8679;`
+- Tab: `&rarrb;`
+- Mac option: `&#8997;`
+- Mac command: `&#8984;`
+
+## Notes
+
+### Doxygen
+
+Tested on:
+- Ubuntu 14.04 with Doxygen 1.8.8, built from [GitHub source](https://github.com/doxygen/doxygen.git).
+- CentOS 6.5 with Doxygen 1.8.8, built from [GitHub source](https://github.com/doxygen/doxygen.git).
+- Mac OS X 10.9 with Homebrew install Doxygen 1.8.7 and 1.8.8.
+
+Graphviz was also installed in all the above testing.
+
+Doxygen 1.8.6 and lower do not have the \\htmlonly[block] directive which fixes a multitude of problems in the rendering of the docs. In Doxygen 1.8.7 the list of understood HTML entities was greatly increased. I tested earlier versions and many little issues returned.
+
+As fish ships with pre-built documentation, I don't see this as an issue.
+
+### Updated Configure/Makefile
+
+- Tested on Ubuntu 14.04, CentOS 6.5 and Mac OS X 10.9.
+- Makefile has GNU/BSD sed/grep detection.
+
+### HTML output
+
+- The output HTML is HTML5 compliant, but should quickly and elegantly degrade on older browsers without losing basic structure.
+- The CSS avoids the use or browser specific extensions (i.e. -webkit, -moz etc), using the W3C HTML5 standard instead.
+- It's been tested in Chrome 37.0 and Firefox 32.0 on Mac OS X 10.9 (+Safari 7), Windows 8.1 (+Internet Explorer 11) and Ubuntu Desktop 14.04.
+- My assumption is basically that if someone cares enough to want to install fish, they'll be keeping a browser current.
+
+### Man page output
+
+- Tested on Ubuntu 14.04, CentOS 6.5 and Mac OS X 10.9.
+- Output is substantially cleaner.
+- Tested in cat, less, more and most pagers using the following fish script:
+
+```
+function manTest --description 'Test manpage' --argument page
+    set -l pager
+    for i in $argv
+        switch $i
+            case "-l"
+                set pager -P '/usr/bin/less -is'
+            case "-m"
+                set pager -P '/usr/bin/more -s'
+            case "-c"
+                set pager -P '/bin/cat'
+        end
+    end
+    man $pager ~/Projects/OpenSource/fish-shell/share/man/man1/$page.1
+end
+
+# Assumes 'most' is the default system pager.
+# NOT PORTABLE! Paths would be need to be updated on other systems.
+```
+
+#### Author: Mark Griffiths [@GitHub](https://github.com/MarkGriffiths)

doc_src/abbr.txt

@@ -0,0 +1,80 @@
+\section abbr abbr - manage fish abbreviations
+
+\subsection abbr-synopsis Synopsis
+\fish{synopsis}
+abbr --add [SCOPE] WORD EXPANSION
+abbr --erase word
+abbr --rename [SCOPE] OLD_WORD NEW_WORD
+abbr --show
+abbr --list
+\endfish
+
+\subsection abbr-description Description
+
+`abbr` manages abbreviations - user-defined words that are replaced with longer phrases after they are entered.
+
+For example, a frequently-run command like `git checkout` can be abbreviated to `gco`. After entering `gco` and pressing @key{Space} or @key{Enter}, the full text `git checkout` will appear in the command line.
+
+\subsection abbr-options Options
+
+The following options are available:
+
+- `-a WORD EXPANSION` or `--add WORD EXPANSION` Adds a new abbreviation, causing WORD to be expanded to PHRASE.
+
+- `-r OLD_WORD NEW_WORD` or `--rename OLD_WORD NEW_WORD` Renames an abbreviation, from OLD_WORD to NEW_WORD.
+
+- `-s` or `--show` Show all abbreviations in a manner suitable for export and import.
+
+- `-l` or `--list` Lists all abbreviated words.
+
+- `-e WORD` or `--erase WORD` Erase the abbreviation WORD.
+
+In addition, when adding abbreviations:
+
+- `-g` or `--global` to use a global variable.
+- `-U` or `--universal` to use a universal variable (default).
+
+See the "Internals" section for more on them.
+
+\subsection abbr-example Examples
+
+\fish
+abbr -a -g gco git checkout
+\endfish
+Add a new abbreviation where `gco` will be replaced with `git checkout` global to the current shell. This abbreviation will not be automatically visible to other shells unless the same command is run in those shells (such as when executing the commands in config.fish).
+
+\fish
+abbr -a -U l less
+\endfish
+Add a new abbreviation where `l` will be replaced with `less` universal so all shells. Note that you omit the `-U` since it is the default.
+
+\fish
+abbr -r gco gch
+\endfish
+Renames an existing abbreviation from `gco` to `gch`.
+
+\fish
+abbr -e gco
+\endfish
+Erase the `gco` abbreviation.
+
+\fish
+ssh another_host abbr -s | source
+\endfish
+Import the abbreviations defined on another_host over SSH.
+
+\subsection abbr-internals Internals
+Each abbreviation is stored in its own global or universal variable. The name consists of the prefix `_fish_abbr_` followed by the WORD after being transformed by `string escape style=var`. The WORD cannot contain a space but all other characters are legal.
+
+Defining an abbreviation with global scope is slightly faster than universal scope (which is the default). But in general you'll only want to use the global scope when defining abbreviations in a startup script like `~/.config/fish/config.fish` like this:
+
+\fish
+if status --is-interactive
+    abbr --add --global first 'echo my first abbreviation'
+    abbr --add --global second 'echo my second abbreviation'
+    abbr --add --global gco git checkout
+    # etcetera
+end
+\endfish
+
+You can create abbreviations interactively and they will be visible to other fish sessions if you use the `-U` or `--universal` flag or don't explicitly specify the scope and the abbreviation isn't already defined with global scope. If you want it to be visible only to the current shell use the `-g` or `--global` flag.

doc_src/alias.txt

@@ -0,0 +1,41 @@
+\section alias alias - create a function
+
+\subsection alias-synopsis Synopsis
+\fish{synopsis}
+alias
+alias [OPTIONS] NAME DEFINITION
+alias [OPTIONS] NAME=DEFINITION
+\endfish
+
+\subsection alias-description Description
+
+`alias` is a simple wrapper for the `function` builtin, which creates a function wrapping a command. It has similar syntax to POSIX shell `alias`. For other uses, it is recommended to define a <a href='#function'>function</a>.
+
+`fish` marks functions that have been created by `alias` by including the command used to create them in the function description. You can list `alias`-created functions by running `alias` without arguments. They must be erased using `functions -e`.
+
+- `NAME` is the name of the alias
+- `DEFINITION` is the actual command to execute. The string `$argv` will be appended.
+
+You cannot create an alias to a function with the same name. Note that spaces need to be escaped in the call to `alias` just like at the command line, _even inside quoted parts_.
+
+The following options are available:
+
+- `-h` or `--help` displays help about using this command.
+
+- `-s` or `--save` Automatically save the function created by the alias into your fish configuration directory using <a href='#funcsave'>funcsave</a>.
+
+\subsection alias-example Example
+
+The following code will create `rmi`, which runs `rm` with additional arguments on every invocation.
+
+\fish
+alias rmi="rm -i"
+
+# This is equivalent to entering the following function:
+function rmi --wraps rm --description 'alias rmi=rm -i'
+    rm -i $argv
+end
+
+# This needs to have the spaces escaped or "Chrome.app..." will be seen as an argument to "/Applications/Google":
+alias chrome='/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome banana'
+\endfish

doc_src/and.txt

@@ -0,0 +1,23 @@
+\section and and - conditionally execute a command
+
+\subsection and-synopsis Synopsis
+\fish{synopsis}
+COMMAND1; and COMMAND2
+\endfish
+
+\subsection and-description Description
+
+`and` is used to execute a command if the previous command was successful (returned a status of 0).
+
+`and` statements may be used as part of the condition in an <a href="#if">`if`</a> or <a href="#while">`while`</a> block. See the documentation for <a href="#if">`if`</a> and <a href="#while">`while`</a> for examples.
+
+`and` does not change the current exit status itself, but the command it runs most likely will. The exit status of the last foreground command to exit can always be accessed using the <a href="index.html#variables-status">$status</a> variable.
+
+\subsection and-example Example
+
+The following code runs the `make` command to build a program. If the build succeeds, `make`'s exit status is 0, and the program is installed. If either step fails, the exit status is 1, and `make clean` is run, which removes the files created by the build process.
+
+\fish
+make; and make install; or make clean
+\endfish
+

doc_src/argparse.txt

@@ -0,0 +1,131 @@
+\section argparse argparse - parse options passed to a fish script or function
+
+\subsection argparse-synopsis Synopsis
+\fish{synopsis}
+argparse [OPTIONS] OPTION_SPEC... -- [ARG...]
+\endfish
+
+\subsection argparse-description Description
+
+This command makes it easy for fish scripts and functions to handle arguments in a manner 100% identical to how fish builtin commands handle their arguments. You pass a sequence of arguments that define the options recognized, followed by a literal `--`, then the arguments to be parsed (which might also include a literal `--`). More on this in the <a href="#argparse-usage">usage</a> section below.
+
+Each OPTION_SPEC can be written in the domain specific language <a href="#argparse-option-specs">described below</a> or created using the companion <a href="#fish-opt">`fish_opt`</a> command. All OPTION_SPECs must appear after any argparse flags and before the `--` that separates them from the arguments to be parsed.
+
+Each option that is seen in the ARG list will result in a var name of the form `_flag_X`, where `X` is the short flag letter and the long flag name. The OPTION_SPEC always requires a short flag even if it can't be used. So there will always be `_flag_X` var set using the short flag letter if the corresponding short or long flag is seen. The long flag name var (e.g., `_flag_help`) will only be defined, obviously, if the OPTION_SPEC includes a long flag name.
+
+For example `_flag_h` and `_flag_help` if `-h` or `--help` is seen. The var will be set with local scope (i.e., as if the script had done `set -l _flag_X`). If the flag is a boolean (that is, does not have an associated value) the values are the short and long flags seen. If the option is not a boolean flag the values will be zero or more values corresponding to the values collected when the ARG list is processed. If the flag was not seen the flag var will not be set.
+
+\subsection argparse-options Options
+
+The following `argparse` options are available. They must appear before all OPTION_SPECs:
+
+- `-n` or `--name` is the command name to insert into any error messages. If you don't provide this value `argparse` will be used.
+
+- `-x` or `--exclusive` should be followed by a comma separated list of short of long options that are mutually exclusive. You can use this option more than once to define multiple sets of mutually exclusive options.
+
+- `-N` or `--min-args` is followed by an integer that defines the minimum number of acceptable non-option arguments. The default is zero.
+
+- `-X` or `--max-args` is followed by an integer that defines the maximum number of acceptable non-option arguments. The default is infinity.
+
+- `-s` or `--stop-nonopt` causes scanning the arguments to stop as soon as the first non-option argument is seen. Using this arg is equivalent to calling the C function `getopt_long()` with the short options starting with a `+` symbol. This is sometimes known as "POSIXLY CORRECT". If this flag is not used then arguments are reordered (i.e., permuted) so that all non-option arguments are moved after option arguments. This mode has several uses but the main one is to implement a command that has subcommands.
+
+- `-h` or `--help` displays help about using this command.
+
+\subsection argparse-usage Usage
+
+Using this command involves passing two sets of arguments separated by `--`. The first set consists of one or more option specifications (`OPTION_SPEC` above) and options that modify the behavior of `argparse`. These must be listed before the `--` argument. The second set are the arguments to be parsed in accordance with the option specifications. They occur after the `--` argument and can be empty. More about this below but here is a simple example that might be used in a function named `my_function`:
+
+\fish
+argparse --name=my_function 'h/help' 'n/name=' -- $argv
+or return
+\endfish
+
+If `$argv` is empty then there is nothing to parse and `argparse` returns zero to indicate success. If `$argv` is not empty then it is checked for flags `-h`, `--help`, `-n` and `--name`. If they are found they are removed from the arguments and local variables (more on this <a href="argparse-local-variables">below</a>) are set so the script can determine which options were seen. Assuming `$argv` doesn't have any errors, such as a missing mandatory value for an option, then `argparse` exits with status zero. Otherwise it writes appropriate error messages to stderr and exits with a status of one.
+
+The `--` argument is required. You do not have to include any arguments after the `--` but you must include the `--`. For example, this is acceptable:
+
+\fish
+set -l argv
+argparse 'h/help' 'n/name' -- $argv
+\endfish
+
+But this is not:
+
+\fish
+set -l argv
+argparse 'h/help' 'n/name' $argv
+\endfish
+
+The first `--` seen is what allows the `argparse` command to reliably separate the option specifications from the command arguments.
+
+\subsection argparse-option-specs Option Specifications
+
+Each option specification is a string composed of
+
+- A short flag letter (which is mandatory). It must be an alphanumeric or "#". The "#" character is special and means that a flag of the form `-123` is valid. The short flag "#" must be followed by "-" (since the short name isn't otherwise valid since `_flag_#` is not a valid var name) and must be followed by a long flag name with no modifiers.
+
+- A `/` if the short flag can be used by someone invoking your command else `-` if it should not be exposed as a valid short flag. If there is no long flag name these characters should be omitted. You can also specify a '#' to indicate the short and long flag names can be used and the value can be specified as an implicit int; i.e., a flag of the form `-NNN`.
+
+- A long flag name which is optional. If not present then only the short flag letter can be used.
+
+- Nothing if the flag is a boolean that takes no argument or is an implicit int flag, else
+
+- `=` if it requires a value and only the last instance of the flag is saved, else
+
+- `=?` it takes an optional value and only the last instance of the flag is saved, else
+
+- `=+` if it requires a value and each instance of the flag is saved.
+
+- Optionally a `!` followed by fish script to validate the value. Typically this will be a function to run. If the return status is zero the value for the flag is valid. If non-zero the value is invalid. Any error messages should be written to stdout (not stderr). See the section on <a href="#arparse-validation">Flag Value Validation</a> for more information.
+
+See the <a href="#fish-opt">`fish_opt`</a> command for a friendlier but more verbose way to create option specifications.
+
+In the following examples if a flag is not seen when parsing the arguments then the corresponding _flag_X var(s) will not be set.
+
+\subsection argparse-validation Flag Value Validation
+
+It is common to want to validate the the value provided for an option satisfies some criteria. For example, that it is a valid integer within a specific range. You can always do this after `argparse` returns but you can also request that `argparse` perform the validation by executing arbitrary fish script. To do so simply append an `!` (exclamation-mark) then the fish script to be run. When that code is executed three vars will be defined:
+
+- `_argparse_cmd` will be set to the value of the value of the `argparse --name` value.
+
+- `_flag_name` will be set to the short or long flag that being processed.
+
+- `_flag_value` will be set to the value associated with the flag being processed.
+
+If you do this via a function it should be defined with the `--no-scope-shadowing` flag. Otherwise it won't have access to those variables.
+
+The script should write any error messages to stdout, not stderr. It should return a status of zero if the flag value is valid otherwise a non-zero status to indicate it is invalid.
+
+Fish ships with a `_validate_int` function that accepts a `--min` and `--max` flag. Let's say your command accepts a `-m` or `--max` flag and the minimum allowable value is zero and the maximum is 5. You would define the option like this: `m/max=!_validate_int --min 0 --max 5`. The default if you just call `_validate_int` without those flags is to simply check that the value is a valid integer with no limits on the min or max value allowed.
+
+\subsection argparse-optspec-examples Example OPTION_SPECs
+
+Some OPTION_SPEC examples:
+
+- `h/help` means that both `-h` and `--help` are valid. The flag is a boolean and can be used more than once. If either flag is used then `_flag_h` and `_flag_help` will be set to the count of how many times either flag was seen.
+
+- `h-help` means that only `--help` is valid. The flag is a boolean and can be used more than once. If the long flag is used then `_flag_h` and `_flag_help` will be set to the count of how many times the long flag was seen.
+
+- `n/name=` means that both `-n` and `--name` are valid. It requires a value and can be used at most once. If the flag is seen then `_flag_n` and `_flag_name` will be set with the single mandatory value associated with the flag.
+
+- `n/name=?` means that both `-n` and `--name` are valid. It accepts an optional value and can be used at most once. If the flag is seen then `_flag_n` and `_flag_name` will be set with the value associated with the flag if one was provided else it will be set with no values.
+
+- `n-name=+` means that only `--name` is valid. It requires a value and can be used more than once. If the flag is seen then `_flag_n` and `_flag_name` will be set with the values associated with each occurrence of the flag.
+
+- `x` means that only `-x` is valid. It is a boolean can can be used more than once. If it is seen then `_flag_x` will be set to the count of how many times the flag was seen.
+
+- `x=`, `x=?`, and `x=+` are similar to the n/name examples above but there is no long flag alternative to the short flag `-x`.
+
+- `x-` is not valid since there is no long flag name and therefore the short flag, `-x`, has to be usable.
+
+- `#-max` means that flags matching the regex "^--?\d+$" are valid. When seen they are assigned to the variable `_flag_max`. This allows any valid positive or negative integer to be specified by prefixing it with a single "-". Many commands support this idiom. For example `head -3 /a/file` to emit only the first three lines of /a/file.
+
+- `n#max` means that flags matching the regex "^--?\d+$" are valid. When seen they are assigned to the variables `_flag_n` and `_flag_max`. This allows any valid positive or negative integer to be specified by prefixing it with a single "-". Many commands support this idiom. For example `head -3 /a/file` to emit only the first three lines of /a/file. You can also specify the value using either flag: `-n NNN` or `--max NNN` in this example.
+
+After parsing the arguments the `argv` var is set with local scope to any values not already consumed during flag processing. If there are not unbound values the var is set but `count $argv` will be zero.
+
+If an error occurs during argparse processing it will exit with a non-zero status and print error messages to stderr.
+
+\subsection argparse-notes Notes
+
+Prior to the addition of this builtin command in the 2.7.0 release there were two main ways to parse the arguments passed to a fish script or function. One way was to use the OS provided `getopt` command. The problem with that is that the GNU and BSD implementations are not compatible. Which makes using that external command difficult other than in trivial situations. The other way is to iterate over `$argv` and use the fish `switch` statement to decide how to handle the argument. That, however, involves a huge amount of boilerplate code. It is also borderline impossible to implement the same behavior as builtin commands.

doc_src/begin.txt

@@ -0,0 +1,46 @@
+\section begin begin - start a new block of code
+
+\subsection begin-synopsis Synopsis
+\fish{synopsis}
+begin; [COMMANDS...;] end
+\endfish
+
+\subsection begin-description Description
+
+`begin` is used to create a new block of code.
+
+A block allows the introduction of a new variable scope, redirection of the input or output of a set of commands as a group, or to specify precedence when using the conditional commands like `and`.
+
+The block is unconditionally executed. `begin; ...; end` is equivalent to `if true; ...; end`.
+
+`begin` does not change the current exit status itself. After the block has completed, `$status` will be set to the status returned by the most recent command.
+
+
+\subsection begin-example Example
+
+The following code sets a number of variables inside of a block scope. Since the variables are set inside the block and have local scope, they will be automatically deleted when the block ends.
+
+\fish
+begin
+    set -l PIRATE Yarrr
+
+    ...
+end
+
+echo $PIRATE
+# This will not output anything, since the PIRATE variable
+# went out of scope at the end of the block
+\endfish
+
+In the following code, all output is redirected to the file out.html.
+
+\fish
+begin
+    echo $xml_header
+    echo $html_header
+    if test -e $file
+        ...
+    end
+    ...
+end > out.html
+\endfish

doc_src/bg.txt

@@ -1,32 +1,25 @@
-.. _cmd-bg:
+\section bg bg - send jobs to background
 
-bg - send jobs to background
-============================
+\subsection bg-synopsis Synopsis
+\fish{synopsis}
+bg [PID...]
+\endfish
 
-Synopsis
---------
+\subsection bg-description Description
 
-::
-
-    bg [PID...]
-
-Description
------------
-
-``bg`` sends :ref:`jobs <syntax-job-control>` to the background, resuming them if they are stopped.
+`bg` sends <a href="index.html#syntax-job-control">jobs</a> to the background, resuming them if they are stopped.
 
 A background job is executed simultaneously with fish, and does not have access to the keyboard. If no job is specified, the last job to be used is put in the background. If PID is specified, the jobs with the specified process group IDs are put in the background.
 
 When at least one of the arguments isn't a valid job specifier (i.e. PID),
-``bg`` will print an error without backgrounding anything.
+`bg` will print an error without backgrounding anything.
 
 When all arguments are valid job specifiers, bg will background all matching jobs that exist.
 
-Example
--------
+\subsection bg-example Example
 
-``bg 123 456 789`` will background 123, 456 and 789.
+`bg 123 456 789` will background 123, 456 and 789.
 
 If only 123 and 789 exist, it will still background them and print an error about 456.
 
-``bg 123 banana`` or ``bg banana 123`` will complain that "banana" is not a valid job specifier.
+`bg 123 banana` or `bg banana 123` will complain that "banana" is not a valid job specifier.

doc_src/bind.txt

@@ -0,0 +1,170 @@
+\section bind bind - handle fish key bindings
+
+\subsection bind-synopsis Synopsis
+\fish{synopsis}
+bind [(-M | --mode) MODE] [(-m | --sets-mode) NEW_MODE]
+     [--preset | --user]
+     [(-s | --silent)] [(-k | --key)] SEQUENCE COMMAND [COMMAND...]
+bind [(-M | --mode) MODE] [(-k | --key)] [--preset] [--user] SEQUENCE
+bind (-K | --key-names) [(-a | --all)] [--preset] [--user]
+bind (-f | --function-names)
+bind (-L | --list-modes)
+bind (-e | --erase) [(-M | --mode) MODE]
+     [--preset] [--user]
+     (-a | --all | [(-k | --key)] SEQUENCE [SEQUENCE...])
+\endfish
+
+\subsection bind-description Description
+
+`bind` adds a binding for the specified key sequence to the specified command.
+
+SEQUENCE is the character sequence to bind to. These should be written as <a href="index.html#escapes">fish escape sequences</a>. For example, because pressing the Alt key and another character sends that character prefixed with an escape character, Alt-based key bindings can be written using the `\e` escape. For example, @key{Alt,w} can be written as `\ew`. The control character can be written in much the same way using the `\c` escape, for example @key{Control,X} (^X) can be written as `\cx`. Note that Alt-based key bindings are case sensitive and Control-based key bindings are not. This is a constraint of text-based terminals, not `fish`.
+
+The default key binding can be set by specifying a `SEQUENCE` of the empty string (that is, ```''``` ). It will be used whenever no other binding matches. For most key bindings, it makes sense to use the `self-insert` function (i.e. ```bind '' self-insert```) as the default keybinding. This will insert any keystrokes not specifically bound to into the editor. Non- printable characters are ignored by the editor, so this will not result in control sequences being printable.
+
+If the `-k` switch is used, the name of the key (such as 'down', 'up' or 'backspace') is used instead of a sequence. The names used are the same as the corresponding curses variables, but without the 'key_' prefix. (See `terminfo(5)` for more information, or use `bind --key-names` for a list of all available named keys.) If used in conjunction with the `-s` switch, `bind` will silently ignore bindings to named keys that are not found in termcap for the current `$TERMINAL`, otherwise a warning is emitted.
+
+`COMMAND` can be any fish command, but it can also be one of a set of special input functions. These include functions for moving the cursor, operating on the kill-ring, performing tab completion, etc. Use `bind --function-names` for a complete list of these input functions.
+
+When `COMMAND` is a shellscript command, it is a good practice to put the actual code into a <a href="#function">function</a> and simply bind to the function name. This way it becomes significantly easier to test the function while editing, and the result is usually more readable as well.
+
+If a script produces output, it should finish by calling `commandline -f repaint` to tell fish that a repaint is in order.
+
+When multiple `COMMAND`s are provided, they are all run in the specified order when the key is pressed. Note that special input functions cannot be combined with ordinary shell script commands. The commands must be entirely a sequence of special input functions (from `bind -f`) or all shell script commands (i.e., valid fish script).
+
+If no `SEQUENCE` is provided, all bindings (or just the bindings in the specified `MODE`) are printed. If `SEQUENCE` is provided without `COMMAND`, just the binding matching that sequence is printed.
+
+To save custom keybindings, put the `bind` statements into <a href="index.html#initialization">config.fish</a>. Alternatively, fish also automatically executes a function called `fish_user_key_bindings` if it exists.
+
+Key bindings may use "modes", which mimics Vi's modal input behavior. The default mode is "default", and every bind applies to a single mode. The mode can be viewed/changed with the `$fish_bind_mode` variable.
+
+The following parameters are available:
+
+- `-k` or `--key` Specify a key name, such as 'left' or 'backspace' instead of a character sequence
+
+- `-K` or `--key-names` Display a list of available key names. Specifying `-a` or `--all` includes keys that don't have a known mapping
+
+- `-f` or `--function-names` Display a list of available input functions
+
+- `-L` or `--list-modes` Display a list of defined bind modes
+
+- `-M MODE` or `--mode MODE` Specify a bind mode that the bind is used in. Defaults to "default"
+
+- `-m NEW_MODE` or `--sets-mode NEW_MODE` Change the current mode to `NEW_MODE` after this binding is executed
+
+- `-e` or `--erase` Erase the binding with the given sequence and mode instead of defining a new one. Multiple sequences can be specified with this flag. Specifying `-a` or `--all` with `-M` or `--mode` erases all binds in the given mode regardless of sequence. Specifying `-a` or `--all` without `-M` or `--mode` erases all binds in all modes regardless of sequence.
+
+- `-a` or `--all` See `--erase` and `--key-names`
+
+- `--preset` and `--user` specify if bind should operate on user or preset bindings. User bindings take precedence over preset bindings when fish looks up mappings. By default, all `bind` invocations work on the "user" level except for listing, which will show both levels. All invocations except for inserting new bindings can operate on both levels at the same time. `--preset` should only be used in full binding sets (like when working on `fish_vi_key_bindings`).
+
+\subsection bind-functions Special input functions
+The following special input functions are available:
+
+- `accept-autosuggestion`, accept the current autosuggestion completely
+
+- `backward-char`, moves one character to the left
+
+- `backward-bigword`, move one whitespace-delimited word to the left
+
+- `backward-delete-char`, deletes one character of input to the left of the cursor
+
+- `backward-kill-bigword`, move the whitespace-delimited word to the left of the cursor to the killring
+
+- `backward-kill-line`, move everything from the beginning of the line to the cursor to the killring
+
+- `backward-kill-path-component`, move one path component to the left of the cursor (everything from the last "/" or whitespace exclusive) to the killring
+
+- `backward-kill-word`, move the word to the left of the cursor to the killring
+
+- `backward-word`, move one word to the left
+
+- `beginning-of-buffer`, moves to the beginning of the buffer, i.e. the start of the first line
+
+- `beginning-of-history`, move to the beginning of the history
+
+- `beginning-of-line`, move to the beginning of the line
+
+- `begin-selection`, start selecting text
+
+- `capitalize-word`, make the current word begin with a capital letter
+
+- `complete`, guess the remainder of the current token
+
+- `complete-and-search`, invoke the searchable pager on completion options (for convenience, this also moves backwards in the completion pager)
+
+- `delete-char`, delete one character to the right of the cursor
+
+- `downcase-word`, make the current word lowercase
+
+- `end-of-buffer`, moves to the end of the buffer, i.e. the end of the first line
+
+- `end-of-history`, move to the end of the history
+
+- `end-of-line`, move to the end of the line
+
+- `end-selection`, end selecting text
+
+- `forward-bigword`, move one whitespace-delimited word to the right
+
+- `forward-char`, move one character to the right
+
+- `forward-word`, move one word to the right
+
+- `history-search-backward`, search the history for the previous match
+
+- `history-search-forward`, search the history for the next match
+
+- `kill-bigword`, move the next whitespace-delimited word to the killring
+
+- `kill-line`, move everything from the cursor to the end of the line to the killring
+
+- `kill-selection`, move the selected text to the killring
+
+- `kill-whole-line`, move the line to the killring
+
+- `kill-word`, move the next word to the killring
+
+- `pager-toggle-search`, toggles the search field if the completions pager is visible.
+
+- `suppress-autosuggestion`, remove the current autosuggestion
+
+- `swap-selection-start-stop`, go to the other end of the highlighted text without changing the selection
+
+- `transpose-chars`,  transpose two characters to the left of the cursor
+
+- `transpose-words`, transpose two words to the left of the cursor
+
+- `upcase-word`, make the current word uppercase
+
+- `yank`, insert the latest entry of the killring into the buffer
+
+- `yank-pop`, rotate to the previous entry of the killring
+
+
+\subsection bind-example Examples
+
+\fish
+bind <asis>\\cd</asis> 'exit'
+\endfish
+Causes `fish` to exit when @key{Control,D} is pressed.
+
+\fish
+bind -k ppage history-search-backward
+\endfish
+Performs a history search when the @key{Page Up} key is pressed.
+
+\fish
+set -g fish_key_bindings fish_vi_key_bindings
+bind -M insert \\cc kill-whole-line force-repaint
+\endfish
+Turns on Vi key bindings and rebinds @key{Control,C} to clear the input line.
+
+
+\subsection special-case-escape Special Case: The escape Character
+
+The escape key can be used standalone, for example, to switch from insertion mode to normal mode when using Vi keybindings. Escape may also be used as a "meta" key, to indicate the start of an escape sequence, such as function or arrow keys. Custom bindings can also be defined that begin with an escape character.
+
+fish waits for a period after receiving the escape character, to determine whether it is standalone or part of an escape sequence. While waiting, additional key presses make the escape key behave as a meta key. If no other key presses come in, it is handled as a standalone escape. The waiting period is set to 300 milliseconds (0.3 seconds) in the default key bindings and 10 milliseconds in the vi key bindings. It can be configured by setting the `fish_escape_delay_ms` variable to a value between 10 and 5000 ms. It is recommended that this be a universal variable that you set once from an interactive session.
+
+Note: fish 2.2.0 and earlier used a default of 10 milliseconds, and provided no way to configure it. That effectively made it impossible to use escape as a meta key.

doc_src/block.txt

@@ -0,0 +1,46 @@
+\section block block - temporarily block delivery of events
+
+\subsection block-synopsis Synopsis
+\fish{synopsis}
+block [OPTIONS...]
+\endfish
+
+\subsection block-description Description
+
+`block` prevents events triggered by `fish` or the <a href="commands.html#emit">`emit`</a> command from being delivered and acted upon while the block is in place.
+
+In functions, `block` can be useful while performing work that should not be interrupted by the shell.
+
+The block can be removed. Any events which triggered while the block was in place will then be delivered.
+
+Event blocks should not be confused with code blocks, which are created with `begin`, `if`, `while` or `for`
+
+The following parameters are available:
+
+- `-l` or `--local` Release the block automatically at the end of the current innermost code block scope
+
+- `-g` or `--global` Never automatically release the lock
+
+- `-e` or `--erase` Release global block
+
+
+\subsection block-example Example
+
+\fish
+# Create a function that listens for events
+function --on-event foo foo; echo 'foo fired'; end
+
+# Block the delivery of events
+block -g
+
+emit foo
+# No output will be produced
+
+block -e
+# 'foo fired' will now be printed
+\endfish
+
+
+\subsection block-notes Notes
+
+Note that events are only received from the current fish process as there is no way to send events from one fish process to another.

doc_src/break.txt

@@ -0,0 +1,25 @@
+\section break break - stop the current inner loop
+
+\subsection break-synopsis Synopsis
+\fish{synopsis}
+LOOP_CONSTRUCT; [COMMANDS...] break; [COMMANDS...] end
+\endfish
+
+\subsection break-description Description
+
+`break` halts a currently running loop, such as a <a href="#for">for</a> loop or a <a href="#while">while</a> loop. It is usually added inside of a conditional block such as an <a href="#if">if</a> statement or a <a href="#switch">switch</a> statement.
+
+There are no parameters for `break`.
+
+
+\subsection break-example Example
+The following code searches all .c files for "smurf", and halts at the first occurrence.
+
+\fish
+for i in *.c
+    if grep smurf $i
+        echo Smurfs are present in $i
+        break
+    end
+end
+\endfish

doc_src/breakpoint.txt

@@ -0,0 +1,14 @@
+\section breakpoint breakpoint - Launch debug mode
+
+\subsection breakpoint-synopsis Synopsis
+\fish{synopsis}
+breakpoint
+\endfish
+
+\subsection breakpoint-description Description
+
+`breakpoint` is used to halt a running script and launch an interactive debugging prompt.
+
+For more details, see <a href="index.html#debugging">Debugging fish scripts</a> in the `fish` manual.
+
+There are no parameters for `breakpoint`.

doc_src/builtin.txt

@@ -0,0 +1,22 @@
+\section builtin builtin - run a builtin command
+
+\subsection builtin-synopsis Synopsis
+\fish{synopsis}
+builtin BUILTINNAME [OPTIONS...]
+\endfish
+
+\subsection builtin-description Description
+
+`builtin` forces the shell to use a builtin command, rather than a function or program.
+
+The following parameters are available:
+
+- `-n` or `--names` List the names of all defined builtins
+
+
+\subsection builtin-example Example
+
+\fish
+builtin jobs
+# executes the jobs builtin, even if a function named jobs exists
+\endfish

doc_src/case.txt

@@ -0,0 +1,42 @@
+\section case case - conditionally execute a block of commands
+
+\subsection case-synopsis Synopsis
+\fish{synopsis}
+switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end
+\endfish
+
+\subsection case-description Description
+
+`switch` executes one of several blocks of commands, depending on whether a specified value matches one of several values. `case` is used together with the `switch` statement in order to determine which block should be executed.
+
+Each `case` command is given one or more parameters. The first `case` command with a parameter that matches the string specified in the switch command will be evaluated. `case` parameters may contain wildcards. These need to be escaped or quoted in order to avoid regular wildcard expansion using filenames.
+
+Note that fish does not fall through on case statements. Only the first matching case is executed.
+
+Note that command substitutions in a case statement will be evaluated even if its body is not taken. All substitutions, including command substitutions, must be performed before the value can be compared against the parameter.
+
+
+\subsection case-example Example
+
+Say \$animal contains the name of an animal. Then this code would classify it:
+
+\fish
+switch $animal
+    case cat
+        echo evil
+    case wolf dog human moose dolphin whale
+        echo mammal
+    case duck goose albatross
+        echo bird
+    case shark trout stingray
+        echo fish
+    # Note that the next case has a wildcard which is quoted
+    case '*'
+        echo I have no idea what a $animal is
+end
+\endfish
+
+If the above code was run with `$animal` set to `whale`, the output
+would be `mammal`.
+
+If `$animal` was set to "banana", it would print "I have no idea what a banana is".

doc_src/cd.txt

@@ -0,0 +1,33 @@
+\section cd cd - change directory
+
+\subsection cd-synopsis Synopsis
+\fish{synopsis}
+cd [DIRECTORY]
+\endfish
+
+\subsection cd-description Description
+`cd` changes the current working directory.
+
+If `DIRECTORY` is supplied, it will become the new directory. If no parameter is given, the contents of the `HOME` environment variable will be used.
+
+If `DIRECTORY` is a relative path, the paths found in the `CDPATH` environment variable array will be tried as prefixes for the specified path.
+
+Note that the shell will attempt to change directory without requiring `cd` if the name of a directory is provided (starting with `.`, `/` or `~`, or ending with `/`).
+
+Fish also ships a wrapper function around the builtin `cd` that understands `cd -` as changing to the previous directory. See also <a href="commands.html#prevd">`prevd`</a>. This wrapper function maintains a history of the 25 most recently visited directories in the `$dirprev` and `$dirnext` global variables. If you make those universal variables your `cd` history is shared among all fish instances.
+
+As a special case, `cd .` is equivalent to `cd $PWD`, which is useful in cases where a mountpoint has been recycled or a directory has been removed and recreated.
+
+\subsection cd-example Examples
+
+\fish
+cd
+# changes the working directory to your home directory.
+
+cd /usr/src/fish-shell
+# changes the working directory to /usr/src/fish-shell
+\endfish
+
+\subsection cd-see-also See Also
+
+See also the <a href="commands.html#cdh">`cdh`</a> command for changing to a recently visited directory.

doc_src/cdh.txt

@@ -0,0 +1,16 @@
+\section cdh cdh - change to a recently visited directory
+
+\subsection cdh-synopsis Synopsis
+\fish{synopsis}
+cdh [ directory ]
+\endfish
+
+\subsection cdh-description Description
+
+`cdh` with no arguments presents a list of recently visited directories. You can then select one of the entries by letter or number. You can also press @key{tab} to use the completion pager to select an item from the list. If you give it a single argument it is equivalent to `cd directory`.
+
+Note that the `cd` command limits directory history to the 25 most recently visited directories. The history is stored in the `$dirprev` and `$dirnext` variables which this command manipulates. If you make those universal variables your `cd` history is shared among all fish instances.
+
+\subsection cdh-see-also See Also
+
+See also the <a href="commands.html#prevd">`prevd`</a> and <a href="commands.html#pushd">`pushd`</a> commands which also work with the recent `cd` history and are provided for compatibility with other shells.

doc_src/command.txt

@@ -0,0 +1,30 @@
+\section command command - run a program
+
+\subsection command-synopsis Synopsis
+\fish{synopsis}
+command [OPTIONS] COMMANDNAME [ARGS...]
+\endfish
+
+\subsection command-description Description
+
+`command` forces the shell to execute the program `COMMANDNAME` and ignore any functions or builtins with the same name.
+
+The following options are available:
+
+- `-a` or `--all` returns all the external commands that are found in `$PATH` in the order they are found.
+
+- `-q` or `--quiet`, in conjunction with `-s`, silences the output and prints nothing, setting only the exit code.
+
+- `-s` or `--search` returns the name of the external command that would be executed, or nothing if no file with the specified name could be found in the `$PATH`.
+
+With the `-s` option, `command` treats every argument as a separate command to look up and sets the exit status to 0 if any of the specified commands were found, or 1 if no commands could be found. Additionally passing a `-q` or `--quiet` option prevents any paths from being printed, like `type -q`, for testing only the exit status.
+
+For basic compatibility with POSIX `command`, the `-v` flag is recognized as an alias for `-s`.
+
+\subsection command-example Examples
+
+`command ls` causes fish to execute the `ls` program, even if an `ls` function exists.
+
+`command -s ls` returns the path to the `ls` program.
+
+`command -sq git; and command git log` runs `git log` only if `git` exists.

doc_src/commandline.txt

@@ -0,0 +1,82 @@
+\section commandline commandline - set or get the current command line buffer
+
+\subsection commandline-synopsis Synopsis
+\fish{synopsis}
+commandline [OPTIONS] [CMD]
+\endfish
+
+\subsection commandline-description Description
+
+`commandline` can be used to set or get the current contents of the command line buffer.
+
+With no parameters, `commandline` returns the current value of the command line.
+
+With `CMD` specified, the command line buffer is erased and replaced with the contents of `CMD`.
+
+The following options are available:
+
+- `-C` or `--cursor` set or get the current cursor position, not the contents of the buffer. If no argument is given, the current cursor position is printed, otherwise the argument is interpreted as the new cursor position.
+
+- `-f` or `--function` inject readline functions into the reader. This option cannot be combined with any other option. It will cause any additional arguments to be interpreted as readline functions, and these functions will be injected into the reader, so that they will be returned to the reader before any additional actual key presses are read.
+
+The following options change the way `commandline` updates the command line buffer:
+
+- `-a` or `--append` do not remove the current commandline, append the specified string at the end of it
+
+- `-i` or `--insert` do not remove the current commandline, insert the specified string at the current cursor position
+
+- `-r` or `--replace` remove the current commandline and replace it with the specified string (default)
+
+The following options change what part of the commandline is printed or updated:
+
+- `-b` or `--current-buffer` select the entire buffer, including any displayed autosuggestion (default)
+
+- `-j` or `--current-job` select the current job
+
+- `-p` or `--current-process` select the current process
+
+- `-s` or `--current-selection` selects the current selection
+
+- `-t` or `--current-token` select the current token
+
+The following options change the way `commandline` prints the current commandline buffer:
+
+- `-c` or `--cut-at-cursor` only print selection up until the current cursor position
+
+- `-o` or `--tokenize` tokenize the selection and print one string-type token per line
+
+If `commandline` is called during a call to complete a given string using `complete -C STRING`, `commandline` will consider the specified string to be the current contents of the command line.
+
+The following options output metadata about the commandline state:
+
+- `-L` or `--line` print the line that the cursor is on, with the topmost line starting at 1
+
+- `-S` or `--search-mode` evaluates to true if the commandline is performing a history search
+
+- `-P` or `--paging-mode` evaluates to true if the commandline is showing pager contents, such as tab completions
+
+
+\subsection commandline-example Example
+
+`commandline -j $history[3]` replaces the job under the cursor with the third item from the command line history.
+
+If the commandline contains
+\fish
+>_ echo $fl___ounder >&2 | less; and echo $catfish
+\endfish
+
+(with the cursor on the "o" of "flounder")
+
+Then the following invocations behave like this:
+\fish
+>_ commandline -t
+$flounder
+>_ commandline -ct
+$fl
+>_ commandline -b # or just commandline
+echo $flounder >&2 | less; and echo $catfish
+>_ commandline -p
+echo $flounder >&2
+>_ commandline -j
+echo $flounder >&2 | less
+\endfish

doc_src/commands.hdr.in

@@ -0,0 +1,38 @@
+/**
+\page commands Commands
+\htmlonly[block]
+<div class="fish_left_bar">
+<div class="logo"></div>
+<div class="menu commands_menu">
+\endhtmlonly
+@command_list_toc@
+
+\htmlonly[block]
+</div>
+</div>
+<div class="commands fish_right_bar">
+<h1 class="interior_title">Command reference</h1>
+\endhtmlonly
+`fish` ships with a large number of builtin commands, shellscript functions and external commands. These are all described below.
+
+Almost all fish commands respond to the `-h` or `--help` options to display their relevant help, also accessible using the `help` and `man` commands, like so:
+
+\fish
+echo -h
+echo --help
+# Prints help to the terminal window
+
+man echo
+# Displays the man page in the system pager
+# (normally 'less', 'more' or 'most').
+
+help echo
+# Open a web browser to show the relevant documentation
+\endfish
+
+@command_list@
+
+\htmlonly[block]
+</div>
+\endhtmlonly
+*/

doc_src/complete.txt

@@ -0,0 +1,131 @@
+\section complete complete - edit command specific tab-completions
+
+\subsection complete-synopsis Synopsis
+\fish{synopsis}
+complete ( -c | --command | -p | --path ) COMMAND
+        [( -c | --command | -p | --path ) COMMAND]...
+        [( -e | --erase )]
+        [( -s | --short-option ) SHORT_OPTION]...
+        [( -l | --long-option | -o | --old-option ) LONG_OPTION]...
+        [( -a | --arguments ) OPTION_ARGUMENTS]
+        [( -k | --keep-order )]
+        [( -f | --no-files )]
+        [( -r | --require-parameter )]
+        [( -x | --exclusive )]
+        [( -w | --wraps ) WRAPPED_COMMAND]...
+        [( -n | --condition ) CONDITION]
+        [( -d | --description ) DESCRIPTION]
+complete ( -C[STRING] | --do-complete[=STRING] )
+\endfish
+
+\subsection complete-description Description
+
+For an introduction to specifying completions, see <a
+href='index.html#completion-own'>Writing your own completions</a> in
+the fish manual.
+
+- `COMMAND` is the name of the command for which to add a completion.
+
+- `SHORT_OPTION` is a one character option for the command.
+
+- `LONG_OPTION` is a multi character option for the command.
+
+- `OPTION_ARGUMENTS` is parameter containing a space-separated list of possible option-arguments, which may contain command substitutions.
+
+- `DESCRIPTION` is a description of what the option and/or option arguments do.
+
+- `-c COMMAND` or `--command COMMAND` specifies that `COMMAND` is the name of the command.
+
+- `-p COMMAND` or `--path COMMAND` specifies that `COMMAND` is the absolute path of the program (optionally containing wildcards).
+
+- `-e` or `--erase` deletes the specified completion.
+
+- `-s SHORT_OPTION` or `--short-option=SHORT_OPTION` adds a short option to the completions list.
+
+- `-l LONG_OPTION` or `--long-option=LONG_OPTION` adds a GNU style long option to the completions list.
+
+- `-o LONG_OPTION` or `--old-option=LONG_OPTION` adds an old style long option to the completions list (See below for details).
+
+- `-a OPTION_ARGUMENTS` or `--arguments=OPTION_ARGUMENTS` adds the specified option arguments to the completions list.
+
+- `-k` or `--keep-order` preserves the order of the `OPTION_ARGUMENTS` specified via `-a` or `--arguments` instead of sorting alphabetically.
+
+- `-f` or `--no-files` specifies that the options specified by this completion may not be followed by a filename.
+
+- `-r` or `--require-parameter` specifies that the options specified by this completion always must have an option argument, i.e. may not be followed by another option.
+
+- `-x` or `--exclusive` implies both `-r` and `-f`.
+
+- `-w WRAPPED_COMMAND` or `--wraps=WRAPPED_COMMAND` causes the specified command to inherit completions from the wrapped command (See below for details).
+
+- `-n` or `--condition` specifies a shell command that must return 0 if the completion is to be used. This makes it possible to specify completions that should only be used in some cases.
+
+- `-CSTRING` or `--do-complete=STRING` makes complete try to find all possible completions for the specified string.
+
+- `-C` or `--do-complete` with no argument makes complete try to find all possible completions for the current command line buffer. If the shell is not in interactive mode, an error is returned.
+
+- `-A` and `--authoritative` no longer do anything and are silently ignored.
+
+- `-u` and `--unauthoritative` no longer do anything and are silently ignored.
+
+Command specific tab-completions in `fish` are based on the notion of options and arguments. An option is a parameter which begins with a hyphen, such as '`-h`', '`-help`' or '`--help`'. Arguments are parameters that do not begin with a hyphen. Fish recognizes three styles of options, the same styles as the GNU version of the getopt library. These styles are:
+
+- Short options, like '`-a`'. Short options are a single character long, are preceded by a single hyphen and may be grouped together (like '`-la`', which is equivalent to '`-l -a`'). Option arguments may be specified in the following parameter ('`-w 32`') or by appending the option with the value ('`-w32`').
+
+- Old style long options, like '`-Wall`'. Old style long options can be more than one character long, are preceded by a single hyphen and may not be grouped together. Option arguments are specified in the following parameter ('`-ao null`').
+
+- GNU style long options, like '`--colors`'. GNU style long options can be more than one character long, are preceded by two hyphens, and may not be grouped together. Option arguments may be specified in the following parameter ('`--quoting-style shell`') or by appending the option with a '`=`' and the value ('`--quoting-style=shell`'). GNU style long options may be abbreviated so long as the abbreviation is unique ('`--h`') is equivalent to '`--help`' if help is the only long option beginning with an 'h').
+
+The options for specifying command name and command path may be used multiple times to define the same completions for multiple commands.
+
+The options for specifying command switches and wrapped commands may be used multiple times to define multiple completions for the command(s) in a single call.
+
+Invoking `complete` multiple times for the same command adds the new definitions on top of any existing completions defined for the command.
+
+When `-a` or `--arguments` is specified in conjunction with long, short, or old style options, the specified arguments are only used as completions when attempting to complete an argument for any of the specified options. If `-a` or `--arguments` is specified without any long, short, or old style options, the specified arguments are used when completing any argument to the command (except when completing an option argument that was specified with `-r` or `--require-parameter`).
+
+Command substitutions found in `OPTION_ARGUMENTS` are not expected to return a space-separated list of arguments. Instead they must return a newline-separated list of arguments, and each argument may optionally have a tab character followed by the argument description. Any description provided in this way overrides a description given with `-d` or `--description`.
+
+The `-w` or `--wraps` options causes the specified command to inherit completions from another command. The inheriting command is said to "wrap" the inherited command. The wrapping command may have its own completions in addition to inherited ones. A command may wrap multiple commands, and wrapping is transitive: if A wraps B, and B wraps C, then A automatically inherits all of C's completions. Wrapping can be removed using the `-e` or `--erase` options. Note that wrapping only works for completions specified with `-c` or `--command` and are ignored when specifying completions with `-p` or `--path`.
+
+When erasing completions, it is possible to either erase all completions for a specific command by specifying `complete -c COMMAND -e`, or by specifying a specific completion option to delete by specifying either a long, short or old style option.
+
+
+\subsection complete-example Example
+
+The short style option `-o` for the `gcc` command requires that a file follows it.  This can be done using writing:
+
+\fish
+complete -c gcc -s o -r
+\endfish
+
+The short style option `-d` for the `grep` command requires that one of the strings '`read`', '`skip`' or '`recurse`' is used.  This can be specified writing:
+
+\fish
+complete -c grep -s d -x -a "read skip recurse"
+\endfish
+
+The `su` command takes any username as an argument. Usernames are given as the first colon-separated field in the file /etc/passwd. This can be specified as:
+
+\fish
+complete -x -c su -d "Username" -a "(cat /etc/passwd | cut -d : -f 1)"
+\endfish
+
+The `rpm` command has several different modes. If the `-e` or `--erase` flag has been specified, `rpm` should delete one or more packages, in which case several switches related to deleting packages are valid, like the `nodeps` switch.
+
+This can be written as:
+
+\fish
+complete -c rpm -n "__fish_contains_opt -s e erase" -l nodeps -d "Don't check dependencies"
+\endfish
+
+where `__fish_contains_opt` is a function that checks the command line buffer for the presence of a specified set of options.
+
+To implement an alias, use the `-w` or `--wraps` option:
+
+\fish
+complete -c hub -w git
+\endfish
+
+Now hub inherits all of the completions from git. Note this can also be specified in a function declaration.
+

doc_src/contains.txt

@@ -0,0 +1,48 @@
+\section contains contains - test if a word is present in a list
+
+\subsection contains-synopsis Synopsis
+\fish{synopsis}
+contains [OPTIONS] KEY [VALUES...]
+\endfish
+
+\subsection contains-description Description
+
+`contains` tests whether the set `VALUES` contains the string `KEY`. If so, `contains` exits with status 0; if not, it exits with status 1.
+
+The following options are available:
+
+- `-i` or `--index` print the word index
+
+Note that, like GNU tools and most of fish's builtins, `contains` interprets all arguments starting with a `-` as options to contains, until it reaches an argument that is `--` (two dashes). See the examples below.
+
+\subsection contains-example Example
+
+If $animals is a list of animals, the following will test if it contains a cat:
+
+\fish
+if contains cat $animals
+   echo Your animal list is evil!
+end
+\endfish
+
+This code will add some directories to $PATH if they aren't yet included:
+
+\fish
+for i in ~/bin /usr/local/bin
+    if not contains $i $PATH
+        set PATH $PATH $i
+    end
+end
+\endfish
+
+While this will check if `hasargs` was run with the `-q` option:
+
+\fish
+function hasargs
+    if contains -- -q $argv
+        echo '$argv contains a -q option'
+    end
+end
+\endfish
+
+The `--` here stops `contains` from treating `-q` to an option to itself. Instead it treats it as a normal string to check.

doc_src/continue.txt

@@ -0,0 +1,26 @@
+\section continue continue - skip the remainder of the current iteration of the current inner loop
+
+\subsection continue-synopsis Synopsis
+\fish{synopsis}
+LOOP_CONSTRUCT; [COMMANDS...;] continue; [COMMANDS...;] end
+\endfish
+
+\subsection continue-description Description
+
+`continue` skips the remainder of the current iteration of the current inner loop, such as a <a href="#for">for</a> loop or a <a href="#while">while</a> loop. It is usually added inside of a conditional block such as an <a href="#if">if</a> statement or a <a href="#switch">switch</a> statement.
+
+\subsection continue-example Example
+
+The following code removes all tmp files that do not contain the word smurf.
+
+\fish
+for i in *.tmp
+    if grep smurf $i
+        continue
+    end
+    # This "rm" is skipped over if "continue" is executed.
+    rm $i
+    # As is this "echo"
+    echo $i
+end
+\endfish

doc_src/count.txt

@@ -0,0 +1,25 @@
+\section count count - count the number of elements of an array
+
+\subsection count-synopsis Synopsis
+\fish{synopsis}
+count $VARIABLE
+\endfish
+
+\subsection count-description Description
+
+`count` prints the number of arguments that were passed to it. This is usually used to find out how many elements an environment variable array contains.
+
+`count` does not accept any options, not even `-h` or `--help`.
+
+`count` exits with a non-zero exit status if no arguments were passed to it, and with zero if at least one argument was passed.
+
+
+\subsection count-example Example
+
+\fish
+count $PATH
+# Returns the number of directories in the users PATH variable.
+
+count *.txt
+# Returns the number of files in the current working directory ending with the suffix '.txt'.
+\endfish

doc_src/design.hdr

@@ -1,21 +1,25 @@
-.. _design:
+/**
+\page design Design document
+\htmlonly[block]
+<div class="fish_only_bar">
+<div class="design">
+<h1 class="interior_title">Design documentation</h1>
+\endhtmlonly
 
-Design
-======
+\section design-overview Overview
 
 This is a description of the design principles that have been used to design fish. The fish design has three high level goals. These are:
 
-1. Everything that can be done in other shell languages should be possible to do in fish, though fish may rely on external commands in doing so.
+-# Everything that can be done in other shell languages should be possible to do in fish, though fish may rely on external commands in doing so.
 
-2. Fish should be user friendly, but not at the expense of expressiveness. Most tradeoffs between power and ease of use can be avoided with careful design.
+-# Fish should be user friendly, but not at the expense of expressiveness. Most tradeoffs between power and ease of use can be avoided with careful design.
 
-3. Whenever possible without breaking the above goals, fish should follow the Posix syntax.
+-# Whenever possible without breaking the above goals, fish should follow the Posix syntax.
 
 To achieve these high-level goals, the fish design relies on a number of more specific design principles. These are presented below, together with a rationale and a few examples for each.
 
 
-The law of orthogonality
-------------------------
+\section ortho The law of orthogonality
 
 The shell language should have a small set of orthogonal features. Any situation where two features are related but not identical, one of them should be removed, and the other should be made powerful and general enough to handle all common use cases of either feature.
 
@@ -27,15 +31,14 @@ Examples:
 
 - Here documents are too similar to using echo inside of a pipeline.
 
-- Subshells, command substitution and process substitution are strongly related. ``fish`` only supports command substitution, the others can be achieved either using a block or the psub shellscript function.
+- Subshells, command substitution and process substitution are strongly related. `fish` only supports command substitution, the others can be achieved either using a block or the psub shellscript function.
 
-- Having both aliases and functions is confusing, especially since both of them have limitations and problems. ``fish`` functions have none of the drawbacks of either syntax.
+- Having both aliases and functions is confusing, especially since both of them have limitations and problems. `fish` functions have none of the drawbacks of either syntax.
 
 - The many Posix quoting styles are silly, especially $''.
 
 
-The law of responsiveness
--------------------------
+\section design-response The law of responsiveness
 
 The shell should attempt to remain responsive to the user at all times, even in the face of contended or unresponsive filesystems. It is only acceptable to block in response to a user initiated action, such as running a command.
 
@@ -48,8 +51,7 @@ Examples:
 
 - Startup should minimize forks and disk I/O, so that fish can be started even if the system is under load.
 
-Configurability is the root of all evil
----------------------------------------
+\section design-configurability Configurability is the root of all evil
 
 Every configuration option in a program is a place where the program is too stupid to figure out for itself what the user really wants, and should be considered a failure of both the program and the programmer who implemented it.
 
@@ -64,8 +66,7 @@ Examples:
 
 A special note on the evils of configurability is the long list of very useful features found in some shells, that are not turned on by default. Both zsh and bash support command-specific completions, but no such completions are shipped with bash by default, and they are turned off by default in zsh. Other features that zsh supports that are disabled by default include tab-completion of strings containing wildcards, a sane completion pager and a history file.
 
-The law of user focus
----------------------
+\section user The law of user focus
 
 When designing a program, one should first think about how to make an intuitive and powerful program. Implementation issues should only be considered once a user interface has been designed.
 
@@ -80,10 +81,9 @@ Examples:
 
 - Instead of forking when performing command substitution to provide a fake variable scope, all fish commands are performed from the same process, and fish instead supports true scoping.
 
-- All blocks end with the ``end`` built-in.
+- All blocks end with the `end` built-in.
 
-The law of discoverability
---------------------------
+\section disc The law of discoverability
 
 A program should be designed to make its features as easy as possible to discover for the user.
 
@@ -100,3 +100,11 @@ Examples:
 - The help manual should be easy to read, easily available from the shell, complete and contain many examples
 
 - The language should be uniform, so that once the user understands the command/argument syntax, they will know the whole language, and be able to use tab-completion to discover new features.
+
+
+\htmlonly[block]
+</div>
+</div>
+\endhtmlonly
+
+*/

doc_src/dirh.txt

@@ -0,0 +1,14 @@
+\section dirh dirh - print directory history
+
+\subsection dirh-synopsis Synopsis
+\fish{synopsis}
+dirh
+\endfish
+
+\subsection dirh-description Description
+
+`dirh` prints the current directory history. The current position in the history is highlighted using the color defined in the `fish_color_history_current` environment variable.
+
+`dirh` does not accept any parameters.
+
+Note that the `cd` command limits directory history to the 25 most recently visited directories. The history is stored in the `$dirprev` and `$dirnext` variables.

doc_src/dirs.txt

@@ -0,0 +1,15 @@
+\section dirs dirs - print directory stack
+
+\subsection dirs-synopsis Synopsis
+\fish{synopsis}
+dirs
+dirs -c
+\endfish
+
+\subsection dirs-description Description
+
+`dirs` prints the current directory stack, as created by the <a href="#pushd">`pushd`</a> command.
+
+With "-c", it clears the directory stack instead.
+
+`dirs` does not accept any parameters.

doc_src/disown.txt

@@ -0,0 +1,24 @@
+\section disown disown - remove a process from the list of jobs
+
+\subsection disown-synopsis Synopsis
+\fish{synopsis}
+disown [ PID ... ]
+\endfish
+
+\subsection disown-description Description
+
+`disown` removes the specified <a href="index.html#syntax-job-control">job</a> from the list of jobs. The job itself continues to exist, but fish does not keep track of it any longer.
+
+Jobs in the list of jobs are sent a hang-up signal when fish terminates, which usually causes the job to terminate; `disown` allows these processes to continue regardless.
+
+If no process is specified, the most recently-used job is removed (like `bg` and `fg`).  If one or more `PID`s are specified, jobs with the specified process IDs are removed from the job list. Invalid jobs are ignored and a warning is printed.
+
+If a job is stopped, it is sent a signal to continue running, and a warning is printed. It is not possible to use the `bg` builtin to continue a job once it has been disowned.
+
+`disown` returns 0 if all specified jobs were disowned successfully, and 1 if any problems were encountered.
+
+\subsection disown-example Example
+
+`firefox &; disown` will start the Firefox web browser in the background and remove it from the job list, meaning it will not be closed when the fish process is closed.
+
+`disown (jobs -p)` removes all jobs from the job list without terminating them.

doc_src/echo.txt

@@ -0,0 +1,60 @@
+\section echo echo - display a line of text
+
+\subsection echo-synopsis Synopsis
+\fish{synopsis}
+echo [OPTIONS] [STRING]
+\endfish
+
+\subsection echo-description Description
+
+`echo` displays a string of text.
+
+The following options are available:
+
+- `-n`, Do not output a newline
+
+- `-s`, Do not separate arguments with spaces
+
+- `-E`, Disable interpretation of backslash escapes (default)
+
+- `-e`, Enable interpretation of backslash escapes
+
+\subsection echo-escapes Escape Sequences
+
+If `-e` is used, the following sequences are recognized:
+
+- `\` backslash
+
+- `\a` alert (BEL)
+
+- `\b` backspace
+
+- `\c` produce no further output
+
+- `\e` escape
+
+- `\f` form feed
+
+- `\n` new line
+
+- `\r` carriage return
+
+- `\t` horizontal tab
+
+- `\v` vertical tab
+
+- `\0NNN` byte with octal value NNN (1 to 3 digits)
+
+- `\xHH` byte with hexadecimal value HH (1 to 2 digits)
+
+\subsection echo-example Example
+
+\fish
+echo 'Hello World'
+\endfish
+Print hello world to stdout
+
+\fish
+echo -e 'Top\\nBottom'
+\endfish
+Print Top and Bottom on separate lines, using an escape sequence

doc_src/else.txt

@@ -0,0 +1,23 @@
+\section else else - execute command if a condition is not met
+
+\subsection else-synopsis Synopsis
+\fish{synopsis}
+if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end
+\endfish
+
+\subsection else-description Description
+
+`if` will execute the command `CONDITION`. If the condition's exit status is 0, the commands `COMMANDS_TRUE` will execute. If it is not 0 and `else` is given, `COMMANDS_FALSE` will be executed.
+
+
+\subsection else-example Example
+
+The following code tests whether a file `foo.txt` exists as a regular file.
+
+\fish
+if test -f foo.txt
+    echo foo.txt exists
+else
+    echo foo.txt does not exist
+end
+\endfish

doc_src/emit.txt

@@ -0,0 +1,28 @@
+\section emit emit - Emit a generic event
+
+\subsection emit-synopsis Synopsis
+\fish{synopsis}
+emit EVENT_NAME [ARGUMENTS...]
+\endfish
+
+\subsection emit-description Description
+
+`emit` emits, or fires, an event. Events are delivered to, or caught by, special functions called event handlers. The arguments are passed to the event handlers as function arguments.
+
+
+\subsection emit-example Example
+
+The following code first defines an event handler for the generic event named 'test_event', and then emits an event of that type.
+
+\fish
+function event_test --on-event test_event
+    echo event test: $argv
+end
+
+emit test_event something
+\endfish
+
+
+\subsection emit-notes Notes
+
+Note that events are only sent to the current fish process as there is no way to send events from one fish process to another.

doc_src/end.txt

@@ -0,0 +1,19 @@
+\section end end - end a block of commands.
+
+\subsection end-synopsis Synopsis
+\fish{synopsis}
+begin; [COMMANDS...] end
+if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end
+while CONDITION; COMMANDS...; end
+for VARNAME in [VALUES...]; COMMANDS...; end
+switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end
+\endfish
+
+\subsection end-description Description
+
+`end` ends a block of commands.
+
+For more information, read the
+documentation for the block constructs, such as `if`, `for` and `while`.
+
+The `end` command does not change the current exit status. Instead, the status after it will be the status returned by the most recent command.

doc_src/eval.txt

@@ -0,0 +1,21 @@
+\section eval eval - evaluate the specified commands
+
+\subsection eval-synopsis Synopsis
+\fish{synopsis}
+eval [COMMANDS...]
+\endfish
+
+\subsection eval-description Description
+`eval` evaluates the specified parameters as a command. If more than one parameter is specified, all parameters will be joined using a space character as a separator.
+
+If your command does not need access to stdin, consider using `source` instead.
+
+\subsection eval-example Example
+
+The following code will call the ls command. Note that `fish` does not support the use of shell variables as direct commands; `eval` can be used to work around this.
+
+\fish
+set cmd ls
+eval $cmd
+\endfish
+

doc_src/exec.txt

@@ -0,0 +1,15 @@
+\section exec exec - execute command in current process
+
+\subsection exec-synopsis Synopsis
+\fish{synopsis}
+exec COMMAND [OPTIONS...]
+\endfish
+
+\subsection exec-description Description
+
+`exec` replaces the currently running shell with a new command. On successful completion, `exec` never returns. `exec` cannot be used inside a pipeline.
+
+
+\subsection exec-example Example
+
+`exec emacs` starts up the emacs text editor, and exits `fish`. When emacs exits, the session will terminate.

doc_src/exit.txt

@@ -0,0 +1,12 @@
+\section exit exit - exit the shell
+
+\subsection exit-synopsis Synopsis
+\fish{synopsis}
+exit [STATUS]
+\endfish
+
+\subsection exit-description Description
+
+`exit` causes fish to exit. If `STATUS` is supplied, it will be converted to an integer and used as the exit code. Otherwise, the exit code will be that of the last command executed.
+
+If exit is called while sourcing a file (using the <a href="#source">source</a> builtin) the rest of the file will be skipped, but the shell itself will not exit.

doc_src/false.txt

@@ -0,0 +1,10 @@
+\section false false - return an unsuccessful result
+
+\subsection false-synopsis Synopsis
+\fish{synopsis}
+false
+\endfish
+
+\subsection false-description Description
+
+`false` sets the exit status to 1.

doc_src/faq.hdr

@@ -0,0 +1,306 @@
+/**
+\page faq Frequently asked questions
+\htmlonly[block]
+<div class="fish_left_bar">
+<div class="logo"></div>
+<div class="menu faq_menu">
+
+\endhtmlonly
+
+- <a href='#faq-envvar'>How do I set or clear an environment variable?</a>
+- <a href='#faq-login-cmd'>How do I run a command every login? What's fish's equivalent to `.bashrc`?</a>
+- <a href='#faq-prompt'>How do I set my prompt?</a>
+- <a href='#faq-cmd-history'>How do I run a command from history?</a>
+- <a href='#faq-subcommand'>How do I run a subcommand? The backtick doesn't work!</a>
+- <a href='#faq-pkg-config'>My command (pkg-config) gives its output as a single long string?</a>
+- <a href='#faq-exit-status'>How do I get the exit status of a command?</a>
+- <a href='#faq-single-env'>How do I set an environment variable for just one command?</a>
+- <a href='#faq-exported-uvar'>Why doesn't `set -Ux` (exported universal variables) seem to work?</a>
+- <a href='#faq-customize-colors'>How do I customize my syntax highlighting colors?</a>
+- <a href='#faq-update-manpage-completions'>How do I update man page completions?</a>
+- <a href='#faq-cd-implicit'>I accidentally entered a directory path and fish changed directory. What happened?</a>
+- <a href='#faq-open'>The open command doesn't work.</a>
+- <a href='#faq-default'>How do I make fish my default shell?</a>
+- <a href='#faq-titlebar'>I'm seeing weird output before each prompt when using screen. What's wrong?</a>
+- <a href='#faq-greeting'>How do I change the greeting message?</a>
+- <a href='#faq-history'>Why doesn't history substitution ("!$" etc.) work?</a>
+- <a href='#faq-cd-minus'>How can I use `-` as a shortcut for `cd -`?</a>
+- <a href='#faq-uninstalling'>How do I uninstall fish?</a>
+- <a href='#faq-third-party'>Where can I find extra tools for fish?</a>
+
+\htmlonly[block]
+</div>
+</div>
+<div class="faq fish_right_bar">
+<h1 class="interior_title">Frequently Asked Questions</h1>
+\endhtmlonly
+
+
+\section faq-envvar How do I set or clear an environment variable?
+
+Use the <a href="commands.html#set">`set`</a> command:
+
+\fish{cli-dark}
+set -x key value
+set -e key
+\endfish
+
+
+\section faq-login-cmd How do I run a command every login? What's fish's equivalent to .bashrc?
+
+Edit the file `~/.config/fish/config.fish`, creating it if it does not exist (Note the leading period).
+
+<hr>
+\section faq-prompt How do I set my prompt?
+
+The prompt is the output of the `fish_prompt` function. Put it in `~/.config/fish/functions/fish_prompt.fish`. For example, a simple prompt is:
+
+\fish{cli-dark}
+function fish_prompt
+    set_color $fish_color_cwd
+    echo -n (prompt_pwd)
+    set_color normal
+    echo -n ' > '
+end
+\endfish
+
+You can also use the Web configuration tool, <a href="commands.html#fish_config">`fish_config`</a>, to preview and choose from a gallery of sample prompts.
+
+
+\section faq-cmd-history How do I run a command from history?
+
+Type some part of the command, and then hit the @cursor_key{&uarr;,up} or @cursor_key{&darr;,down} arrow keys to navigate through history matches.
+
+<hr>
+\section faq-subcommand How do I run a subcommand? The backtick doesn't work!
+
+`fish` uses parentheses for subcommands. For example:
+
+\fish{cli-dark}
+for i in (ls)
+    echo $i
+end
+\endfish
+
+\section faq-pkg-config My command (pkg-config) gives its output as a single long string?
+
+Unlike other shells, fish splits command substitutions only on newlines, not spaces or tabs or the characters in $IFS.
+
+That means if you run
+
+\fish{cli-dark}
+echo x(printf '%s ' a b c)x
+\endfish
+
+It will print `xa b c x`. But if you do
+
+\fish{cli-dark}
+echo x(printf '%s\n' a b c)x
+\endfish
+
+it will print `xax xbx xcx`.
+
+In the overwhelming majority of cases, splitting on spaces is unwanted, so this is an improvement.
+
+However sometimes, especially with `pkg-config` and related tools, splitting on spaces is needed.
+
+In these cases use `string split " "` like:
+
+\fish{cli-dark}
+g++ example_01.cpp (pkg-config --cflags --libs gtk+-2.0 | string split " ")
+\endfish
+
+\section faq-exit-status How do I get the exit status of a command?
+
+Use the `$status` variable. This replaces the `$?` variable used in some other shells.
+
+\fish{cli-dark}
+somecommand
+if test $status -eq 7
+    echo "That's my lucky number!"
+end
+\endfish
+
+If you are just interested in success or failure, you can run the command directly as the if-condition:
+
+\fish{cli-dark}
+if somecommand
+    echo "Command succeeded"
+else
+    echo "Command failed"
+end
+\endfish
+
+See the documentation for <a href="commands.html#test">`test`</a> and <a href="commands.html#if">`if`</a> for more information.
+
+<hr>
+\section faq-single-env How do I set an environment variable for just one command?
+
+<i>`SOME_VAR=1 command` produces an error: `Unknown command "SOME_VAR=1"`.</i>
+
+Use the `env` command.
+
+`env SOME_VAR=1 command`
+
+You can also declare a local variable in a block:
+
+\fish{cli-dark}
+begin
+    set -lx SOME_VAR 1
+    command
+end
+\endfish
+
+\section faq-exported-uvar Why doesn't `set -Ux` (exported universal variables) seem to work?
+
+A global variable of the same name already exists.
+
+Environment variables such as `EDITOR` or `TZ` can be set universally using `set -Ux`.  However, if
+there is an environment variable already set before fish starts (such as by login scripts or system
+administrators), it is imported into fish as a global variable. The <a
+href="index.html#variables-scope">variable scopes</a> are searched from the "inside out", which
+means that local variables are checked first, followed by global variables, and finally universal
+variables.
+
+This means that the global value takes precedence over the universal value.
+
+To avoid this problem, consider changing the setting which fish inherits. If this is not possible,
+add a statement to your <a href="index.html#">user initialization file</a> (usually
+`~/.config/fish/config.fish`):
+
+\fish{cli-dark}
+set -gx EDITOR vim
+\endfish
+
+\section faq-customize-colors How do I customize my syntax highlighting colors?
+
+Use the web configuration tool, <a href="commands.html#fish_config">`fish_config`</a>, or alter the <a href="index.html#variables-color">`fish_color` family of environment variables</a>.
+
+<hr>
+\section faq-update-manpage-completions How do I update man page completions?
+
+Use the <a href="commands.html#fish_update_completions">`fish_update_completions`</a> command.
+
+<hr>
+\section faq-cd-implicit I accidentally entered a directory path and fish changed directory. What happened?
+
+If fish is unable to locate a command with a given name, and it starts with '`.`', '`/`' or '`~`', fish will test if a directory of that name exists. If it does, it is implicitly assumed that you want to change working directory. For example, the fastest way to switch to your home directory is to simply press `~` and enter.
+
+<hr>
+\section faq-open The open command doesn't work.
+
+The `open` command uses the MIME type database and the `.desktop` files used by Gnome and KDE to identify filetypes and default actions. If at least one of these environments is installed, but the open command is not working, this probably means that the relevant files are installed in a non-standard location. Consider <a href="index.html#more-help">asking for more help</a>.
+
+<hr>
+\section faq-default How do I make fish my default shell?
+
+If you installed fish manually (e.g. by compiling it, not by using a package manager), you first need to add fish to the list of shells by executing the following command (assuming you installed fish in /usr/local):
+
+\fish{cli-dark}
+echo /usr/local/bin/fish | sudo tee -a /etc/shells
+\endfish
+
+If you installed a prepackaged version of fish, the package manager should have already done this for you.
+
+In order to change your default shell, type:
+
+\fish{cli-dark}
+chsh -s /usr/local/bin/fish
+\endfish
+
+You may need to adjust the above path to e.g. `/usr/bin/fish`. Use the command `which fish` if you are unsure of where fish is installed.
+
+Unfortunately, there is no way to make the changes take effect at once. You will need to log out and back in again.
+
+<hr>
+\section faq-titlebar I'm seeing weird output before each prompt when using screen. What's wrong?
+
+Quick answer:
+
+Run the following command in fish:
+
+\fish{cli-dark}
+function fish_title; end; funcsave fish_title
+\endfish
+
+Problem solved!
+
+The long answer:
+
+Fish is trying to set the titlebar message of your terminal. While screen itself supports this feature, your terminal does not. Unfortunately, when the underlying terminal doesn't support setting the titlebar, screen simply passes through the escape codes and text to the underlying terminal instead of ignoring them. It is impossible to detect and resolve this problem from inside fish since fish has no way of knowing what the underlying terminal type is. For now, the only way to fix this is to unset the titlebar message, as suggested above.
+
+Note that fish has a default titlebar message, which will be used if the fish_title function is undefined. So simply unsetting the fish_title function will not work.
+
+<hr>
+\section faq-greeting How do I change the greeting message?
+
+Change the value of the variable `fish_greeting` or create a `fish_greeting` function. For example, to remove the greeting use:
+
+\fish{cli-dark}
+set fish_greeting
+\endfish
+
+<hr>
+\section faq-history Why doesn't history substitution ("!$" etc.) work?
+
+Because history substitution is an awkward interface that was invented before interactive line editing was even possible.  Fish drops it in favor of perfecting the interactive history recall interface.  Switching requires a small change of habits: if you want to modify an old line/word, first recall it, then edit.  E.g. don't type "sudo !!" - first press Up, then Home, then type "sudo ".
+
+Fish history recall is very simple yet effective:
+
+- As in any modern shell, the Up arrow, @cursor_key{&uarr;,Up} recalls whole lines, starting from the last line executed.  A single press replaces "!!", later presses replace "!-3" and the like.
+
+  - If the line you want is far back in the history, type any part of the line and then press Up one or more times.  This will constrain the recall to lines that include this text, and you will get to the line you want much faster.  This replaces "!vi", "!?bar.c" and the like.
+
+- @key{Alt,&uarr;,Up} recalls individual arguments, starting from the last argument in the last line executed.  A single press replaces "!$", later presses replace "!!:4" and the like.
+
+  - If the argument you want is far back in history (e.g. 2 lines back - that's a lot of words!), type any part of it and then press @key{Alt,&uarr;,Up}.  This will show only arguments containing that part and you will get what you want much faster.  Try it out, this is very convenient!
+
+  - If you want to reuse several arguments from the same line ("!!:3*" and the like), consider recalling the whole line and removing what you don't need (@key{Alt,D} and @key{Alt,Backspace} are your friends).
+
+See <a href='index.html#editor'>documentation</a> for more details about line editing in fish.
+
+<hr>
+\section faq-cd-minus How can I use `-` as a shortcut for `cd -`?
+
+In fish versions prior to 2.5.0 it was possible to create a function named `-` that would do `cd -`. Changes in the 2.5.0 release included several bug fixes that enforce the rule that a bare hyphen is not a valid function (or variable) name. However, you can achieve the same effect via an abbreviation:
+
+\fish{cli-dark}
+abbr -a -- - 'cd -'
+\endfish
+
+<hr>
+\section faq-uninstalling Uninstalling fish
+
+Should you wish to uninstall fish, first ensure fish is not set as your shell. Run `chsh -s /bin/bash` if you are not sure.
+
+Next, do the following (assuming fish was installed to /usr/local):
+
+\fish{cli-dark}
+rm -Rf /usr/local/etc/fish /usr/local/share/fish ~/.config/fish
+rm /usr/local/share/man/man1/fish*.1
+cd /usr/local/bin
+rm -f fish fish_indent
+\endfish
+
+<hr>
+\section faq-reserved-chars Unicode private-use characters reserved by fish
+
+Fish reserves the <a href="http://www.unicode.org/faq/private_use.html">Unicode private-use character range</a> from U+F600 thru U+F73F for internal use. Any attempt to feed characters in that range to fish will result in them being replaced by the Unicode "replacement character" U+FFFD. This includes both interactive input as well as any file read by fish (but not programs run by fish).
+
+<hr>
+\section faq-third-party Where can I find extra tools for fish?
+
+The fish user community extends fish in unique and useful ways via scripts that aren't always appropriate for bundling with the fish package. Typically because they solve a niche problem unlikely to appeal to a broad audience. You can find those extensions, including prompts, themes and useful functions, in various third-party repositories. These include:
+
+- <a href="https://github.com/fisherman/fisherman">Fisherman</a>
+- <a href="https://github.com/tuvistavie/fundle">Fundle</a>
+- <a href="https://github.com/oh-my-fish/oh-my-fish">Oh My Fish</a>
+- <a href="https://github.com/justinmayer/tacklebox">Tacklebox</a>
+
+This is not an exhaustive list and the fish project has no opinion regarding the merits of the repositories listed above or the scripts found therein.
+
+\htmlonly[block]
+</div>
+\endhtmlonly
+
+*/

doc_src/fg.txt

@@ -0,0 +1,15 @@
+\section fg fg - bring job to foreground
+
+\subsection fg-synopsis Synopsis
+\fish{synopsis}
+fg [PID]
+\endfish
+
+\subsection fg-description Description
+
+`fg` brings the specified <a href="index.html#syntax-job-control">job</a> to the foreground, resuming it if it is stopped. While a foreground job is executed, fish is suspended. If no job is specified, the last job to be used is put in the foreground. If PID is specified, the job with the specified group ID is put in the foreground.
+
+
+\subsection fg-example Example
+
+`fg` will put the last job in the foreground.

doc_src/fish.txt

@@ -0,0 +1,34 @@
+\section fish fish - the friendly interactive shell
+
+\subsection fish-synopsis Synopsis
+\fish{synopsis}
+fish [OPTIONS] [-c command] [FILE [ARGUMENTS...]]
+\endfish
+
+\subsection fish-description Description
+
+`fish` is a command-line shell written mainly with interactive use in mind. The full manual is available <a href='index.html'>in HTML</a> by using the <a href='#help'>help</a> command from inside fish.
+
+The following options are available:
+
+- `-c` or `--command=COMMANDS` evaluate the specified commands instead of reading from the commandline
+
+- `-C` or `--init-command=COMMANDS` evaluate the specified commands after reading the configuration, before running the command specified by `-c` or reading interactive input
+
+- `-d` or `--debug-level=DEBUG_LEVEL` specify the verbosity level of fish. A higher number means higher verbosity. The default level is 1.
+
+- `-i` or `--interactive` specify that fish is to run in interactive mode
+
+- `-l` or `--login` specify that fish is to run as a login shell
+
+- `-n` or `--no-execute` do not execute any commands, only perform syntax checking
+
+- `-p` or `--profile=PROFILE_FILE` when fish exits, output timing information on all executed commands to the specified file
+
+- `-v` or `--version` display version and exit
+
+- `-D` or `--debug-stack-frames=DEBUG_LEVEL` specify how many stack frames to display when debug messages are written. The default is zero. A value of 3 or 4 is usually sufficient to gain insight into how a given debug call was reached but you can specify a value up to 128.
+
+- `-f` or `--features=FEATURES` enables one or more feature flags (separated by a comma). These are how fish stages changes that might break scripts.
+
+The fish exit status is generally the exit status of the last foreground command. If fish is exiting because of a parse error, the exit status is 127.

doc_src/fish_breakpoint_prompt.txt

@@ -0,0 +1,30 @@
+\section fish_breakpoint_prompt fish_breakpoint_prompt - define the appearance of the command line prompt when in the context of a `breakpoint` command
+
+\subsection fish_breakpoint_prompt-synopsis Synopsis
+\fish{synopsis}
+function fish_breakpoint_prompt
+    ...
+end
+\endfish
+
+\subsection fish_breakpoint_prompt-description Description
+
+By defining the `fish_breakpoint_prompt` function, the user can choose a custom prompt when asking for input in response to a `breakpoint` command. The `fish_breakpoint_prompt` function is executed when the prompt is to be shown, and the output is used as a prompt.
+
+The exit status of commands within `fish_breakpoint_prompt` will not modify the value of <a href="index.html#variables-status">$status</a> outside of the `fish_breakpoint_prompt` function.
+
+`fish` ships with a default version of this function that displays the function name and line number of the current execution context.
+
+
+\subsection fish_breakpoint_prompt-example Example
+
+A simple prompt that is a simplified version of the default debugging prompt:
+
+\fish
+function fish_breakpoint_prompt -d "Write out the debug prompt"
+    set -l function (status current-function)
+    set -l line (status current-line-number)
+    set -l prompt "$function:$line >"
+    echo -ns (set_color $fish_color_status) "BP $prompt" (set_color normal) ' '
+end
+\endfish

doc_src/fish_config.txt

@@ -0,0 +1,18 @@
+\section fish_config fish_config - start the web-based configuration interface
+
+\subsection fish_config-description Description
+
+`fish_config` starts the web-based configuration interface.
+
+The web interface allows you to view your functions, variables and history, and to make changes to your prompt and color configuration.
+
+`fish_config` starts a local web server and then opens a web browser window; when you have finished, close the browser window and then press the Enter key to terminate the configuration session.
+
+`fish_config` optionally accepts name of the initial configuration tab. For e.g. `fish_config history` will start configuration interface with history tab.
+
+If the `BROWSER` environment variable is set, it will be used as the name of the web browser to open instead of the system default.
+
+
+\subsection fish_config-example Example
+
+`fish_config` opens a new web browser window and allows you to configure certain fish settings.

doc_src/fish_indent.txt

@@ -0,0 +1,28 @@
+\section fish_indent fish_indent - indenter and prettifier
+
+\subsection fish_indent-synopsis Synopsis
+\fish{synopsis}
+fish_indent [OPTIONS]
+\endfish
+
+\subsection fish_indent-description Description
+
+`fish_indent` is used to indent a piece of fish code. `fish_indent` reads commands from standard input and outputs them to standard output or a specified file.
+
+The following options are available:
+
+- `-w` or `--write` indents a specified file and immediately writes to that file.
+
+- `-i` or `--no-indent` do not indent commands; only reformat to one job per line.
+
+- `-v` or `--version` displays the current fish version and then exits.
+
+- `--ansi` colorizes the output using ANSI escape sequences, appropriate for the current $TERM, using the colors defined in the environment (such as `$fish_color_command`).
+
+- `--html` outputs HTML, which supports syntax highlighting if the appropriate CSS is defined. The CSS class names are the same as the variable names, such as `fish_color_command`.
+
+- `-d` or `--debug-level=DEBUG_LEVEL` enables debug output and specifies a verbosity level (like `fish -d`). Defaults to 0.
+
+- `-D` or `--debug-stack-frames=DEBUG_LEVEL` specify how many stack frames to display when debug messages are written. The default is zero. A value of 3 or 4 is usually sufficient to gain insight into how a given debug call was reached but you can specify a value up to 128.
+
+- `--dump-parse-tree` dumps information about the parsed statements to stderr. This is likely to be of interest only to people working on the fish source code.

doc_src/fish_key_reader.txt

@@ -0,0 +1,35 @@
+\section fish_key_reader fish_key_reader - explore what characters keyboard keys send
+
+\subsection fish_key_reader-synopsis Synopsis
+\fish{synopsis}
+fish_key_reader [OPTIONS]
+\endfish
+
+\subsection fish_key_reader-description Description
+
+`fish_key_reader` is used to study input received from the terminal and can help with key binds. The program is interactive and works on standard input. Individual characters themselves and their hexadecimal values are displayed.
+
+The tool will write an example `bind` command matching the character sequence captured to stdout. If the character sequence matches a special key name (see `bind --key-names`),  both `bind CHARS ...` and `bind -k KEYNAME ...` usage will be shown. Additional details about the characters received, such as the delay between chars, are written to stderr.
+
+The following options are available:
+
+- `-c` or `--continuous` begins a session where multiple key sequences can be inspected. By default the program exits after capturing a single key sequence.
+
+- `-d` or `--debug-level=DEBUG_LEVEL` enables debug output and specifies a verbosity level (like `fish -d`). Defaults to 0.
+
+- `-D` or `--debug-stack-frames=DEBUG_LEVEL` specify how many stack frames to display when debug messages are written. The default is zero. A value of 3 or 4 is usually sufficient to gain insight into how a given debug call was reached but you can specify a value up to 128.
+
+- `-h` or `--help` prints usage information.
+
+- `-v` or `--version` prints fish_key_reader's version and exits.
+
+\subsection fish_key_reader-usage-notes Usage Notes
+
+The delay in milliseconds since the previous character was received is included in the diagnostic information written to stderr. This information may be useful to determine the optimal `fish_escape_delay_ms` setting or learn the amount of lag introduced by tools like `ssh`, `mosh` or `tmux`.
+
+`fish_key_reader` intentionally disables handling of many signals. To terminate `fish_key_reader` in `--continuous` mode do:
+
+- press `Ctrl-C` twice, or
+- press `Ctrl-D` twice, or
+- type `exit`, or
+- type `quit`

doc_src/fish_mode_prompt.txt

@@ -0,0 +1,37 @@
+\section fish_mode_prompt fish_mode_prompt - define the appearance of the mode indicator
+
+\subsection fish_mode_prompt-synopsis Synopsis
+
+The fish_mode_prompt function will output the mode indicator for use in vi-mode.
+
+\subsection fish_mode_prompt-description Description
+
+The default `fish_mode_prompt` function will output indicators about the current Vi editor mode displayed to the left of the regular prompt. Define your own function to customize the appearance of the mode indicator. You can also define an empty `fish_mode_prompt` function to remove the Vi mode indicators. The `$fish_bind_mode variable` can be used to determine the current mode. It
+will be one of `default`, `insert`, `replace_one`, or `visual`.
+
+\subsection fish_mode_prompt-example Example
+
+\fish
+function fish_mode_prompt
+  switch $fish_bind_mode
+    case default
+      set_color --bold red
+      echo 'N'
+    case insert
+      set_color --bold green
+      echo 'I'
+    case replace_one
+      set_color --bold green
+      echo 'R'
+    case visual
+      set_color --bold brmagenta
+      echo 'V'
+    case '*'
+      set_color --bold red
+      echo '?'
+  end
+  set_color normal
+end
+\endfish
+
+Outputting multiple lines is not supported in `fish_mode_prompt`.

doc_src/fish_opt.txt

@@ -0,0 +1,54 @@
+\section fish_opt fish_opt - create an option spec for the argparse command
+
+\subsection fish_opt-synopsis Synopsis
+\fish{synopsis}
+fish_opt [ -h | --help ]
+fish_opt ( -s X | --short=X ) [ -l LONG | --long=LONG ] [ --long-only ] \
+    [ -o | --optional-val ] [ -r | --required-val ] [ --multiple-vals ]
+\endfish
+
+\subsection fish_opt-description Description
+
+This command provides a way to produce option specifications suitable for use with the <a href="#argparse">`argparse`</a> command. You can, of course, write the option specs by hand without using this command. But you might prefer to use this for the clarity it provides.
+
+The following `argparse` options are available:
+
+- `-s` or `--short` takes a single letter that is used as the short flag in the option being defined. This option is mandatory.
+
+- `-l` or `--long` takes a string that is used as the long flag in the option being defined. This option is optional and has no default. If no long flag is defined then only the short flag will be allowed when parsing arguments using the option spec.
+
+- `--long-only` means the option spec being defined will only allow the long flag name to be used. The short flag name must still be defined (i.e., `--short` must be specified) but it cannot be used when parsing args using this option spec.
+
+- `-o` or `--optional` means the option being defined can take a value but it is optional rather than required. If the option is seen more than once when parsing arguments only the last value seen is saved. This means the resulting flag variable created by `argparse` will zero elements if no value was given with the option else it will have exactly one element.
+
+- `-r` or `--required` means the option being defined requires a value. If the option is seen more than once when parsing arguments only the last value seen is saved. This means the resulting flag variable created by `argparse` will have exactly one element.
+
+- `--multiple-vals` means the option being defined requires a value each time it is seen. Each instance is stored. This means the resulting flag variable created by `argparse` will have one element for each instance of this option in the args.
+
+- `-h` or `--help` displays help about using this command.
+
+\subsection fish_opt-examples Examples
+
+Define a single option spec for the boolean help flag:
+
+\fish
+set -l options (fish_opt -s h -l help)
+argparse $options -- $argv
+\endfish
+
+Same as above but with a second flag that requires a value:
+
+\fish
+set -l options (fish_opt -s h -l help)
+set options $options (fish_opt -s m -l max --required-val)
+argparse $options -- $argv
+\endfish
+
+Same as above but with a third flag that can be given multiple times saving the value of each instance seen and only the long flag name (`--token`) can be used:
+
+\fish
+set -l options (fish_opt --short=h --long=help)
+set options $options (fish_opt --short=m --long=max --required-val)
+set options $options (fish_opt --short=t --long=token --multiple-vals --long-only)
+argparse $options -- $argv
+\endfish