Clarify docs on self-installing builds
Some checks are pending
make test / ubuntu (push) Waiting to run
make test / ubuntu-32bit-static-pcre2 (push) Waiting to run
make test / ubuntu-asan (push) Waiting to run
make test / macos (push) Waiting to run
Rust checks / rustfmt (push) Waiting to run
Rust checks / clippy (push) Waiting to run

This commit is contained in:
Fabian Boehm 2024-12-07 13:13:18 +01:00
parent 210d687b2b
commit fcf8ed0628
2 changed files with 16 additions and 16 deletions

View File

@ -58,7 +58,7 @@ Notable improvements and fixes
# and then, wherever you use it, run # and then, wherever you use it, run
/path/to/fish --install # or --install=noconfirm for non-interactive use /path/to/fish --install # or --install=noconfirm for non-interactive use
This will extract all the data files to ~/.local/share/fish/install/. To uninstall, remove the fish binaries and that directory. This will extract all the data files to (currently) ~/.local/share/fish/install/. To uninstall, remove the fish binaries and that directory.
This configuration is experimental. This configuration is experimental.
It does not affect the main configuration, which is a regular install via ``cmake``. It does not affect the main configuration, which is a regular install via ``cmake``.

View File

@ -149,13 +149,25 @@ To install into ``/usr/local``, run:
The install directory can be changed using the The install directory can be changed using the
``-DCMAKE_INSTALL_PREFIX`` parameter for ``cmake``. ``-DCMAKE_INSTALL_PREFIX`` parameter for ``cmake``.
Building fish as self-installable CMake Build options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
In addition to the normal CMake build options (like ``CMAKE_INSTALL_PREFIX``), fish's CMake build has some other options available to customize it.
- BUILD_DOCS=ON|OFF - whether to build the documentation. This is automatically set to OFF when Sphinx isn't installed.
- INSTALL_DOCS=ON|OFF - whether to install the docs. This is automatically set to on when BUILD_DOCS is or prebuilt documentation is available (like when building in-tree from a tarball).
- FISH_USE_SYSTEM_PCRE2=ON|OFF - whether to use an installed pcre2. This is normally autodetected.
- MAC_CODESIGN_ID=String|OFF - the codesign ID to use on Mac, or "OFF" to disable codesigning.
- WITH_GETTEXT=ON|OFF - whether to build with gettext support for translations.
- extra_functionsdir, extra_completionsdir and extra_confdir - to compile in an additional directory to be searched for functions, completions and configuration snippets
Building fish as self-installable (experimental)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can also build fish as a self-installing binary. You can also build fish as a self-installing binary.
This will include all the datafiles like the included functions or web configuration tool in the main ``fish`` binary, This will include all the datafiles like the included functions or web configuration tool in the main ``fish`` binary,
and you can unpack them to ~/.local/share/fish/install/ by running ``fish --install`` (or ``fish --install=noconfirm`` to skip the confirmation). and you can unpack them to ~/.local/share/fish/install/ (currently, subject to change) by running ``fish --install`` (or ``fish --install=noconfirm`` to skip the confirmation).
You will have to use ``--install`` once per user and you will have to run it again when you upgrade fish. It will tell you to. You will have to use ``--install`` once per user and you will have to run it again when you upgrade fish. It will tell you to.
@ -173,18 +185,6 @@ This build won't have the html docs (``help`` will open the online version) or t
You can also link it statically (but not against glibc) and move it to other computers. You can also link it statically (but not against glibc) and move it to other computers.
Build options
~~~~~~~~~~~~~
In addition to the normal CMake build options (like ``CMAKE_INSTALL_PREFIX``), fish's CMake build has some other options available to customize it.
- BUILD_DOCS=ON|OFF - whether to build the documentation. This is automatically set to OFF when Sphinx isn't installed.
- INSTALL_DOCS=ON|OFF - whether to install the docs. This is automatically set to on when BUILD_DOCS is or prebuilt documentation is available (like when building in-tree from a tarball).
- FISH_USE_SYSTEM_PCRE2=ON|OFF - whether to use an installed pcre2. This is normally autodetected.
- MAC_CODESIGN_ID=String|OFF - the codesign ID to use on Mac, or "OFF" to disable codesigning.
- WITH_GETTEXT=ON|OFF - whether to build with gettext support for translations.
- extra_functionsdir, extra_completionsdir and extra_confdir - to compile in an additional directory to be searched for functions, completions and configuration snippets
Contributing Changes to the Code Contributing Changes to the Code
-------------------------------- --------------------------------