aboutsummaryrefslogtreecommitdiff
path: root/INSTALL.md (unfollow)
Commit message (Collapse)AuthorLines
2024-02-06Don't use fancy Unicode quotes, stick to ASCIIDaniel Eklöf-16/+16
2023-10-03Codespell fixesDaniel Eklöf-1/+1
2023-07-28meson: add -Dterminfo-base-name optionDaniel Eklöf-2/+13
This defines the base name of the generated terminfo files. It defaults to the value of -Ddefault-terminfo (i.e. 'foot') Example: meson -Ddefault-terminfo=foot-bananas -Dterminfo-base-name=foot-apples The generated terminfo files will be * terminfo/f/foot-apples * terminfo/f/foot-apples-direct The default value of $TERM will be 'foot-bananas'
2023-05-22utmp: rewrite utmp loggingDaniel Eklöf-12/+14
This patch generalizes the utmp support, to not only support libutempter, but also ulog (and in the future, even more interfaces). * Rename config option main.utempter to main.utmp-helper * Add meson option -Dutmp-backend=none|libutempter|ulog|auto * Rename meson option -Ddefault-utempter-path to -Dutmp-default-helper-path * utmp is no longer detected at compile time, but at runtime instead. Meson will configure the following pre-processor macros, based on the selected utmp backend: * UTMP_ADD - argument to pass to utmp helper when adding a record (starting foot) * UTMP_DEL - argument to pass to utmp helper when removing a record (exiting foot) * UTMP_DEL_HAVE_ARGUMENT - if defined, UTMP_DEL expects an extra argument ($WAYLAND_DISPLAY) * UTMP_DEFAULT_HELPER_PATH - path to the default utmp helper binary The documentation has been updated to mention which arguments are passed to the helper binary. Closes #1314
2023-03-28fix typosHarri Nieminen-1/+1
2022-10-10pgo: run xtgettcap without any argumentsDaniel Eklöf-3/+3
We execute xtgettcap in the parent terminal. Thus we don’t know if it implements XTGETTCAP, and thus it’s not guaranteed to exit - it may hang indefinitely waiting for a reply. Fix by not actually quering anything.
2022-10-09install.md: add `./utils/xtgettcap name` to "full PGO" instructions tooDaniel Eklöf-3/+5
2022-10-08install.md: add xtgettcap to PGO build instructionsDaniel Eklöf-3/+5
2022-09-23Add support for creating utmp recordsDaniel Eklöf-10/+12
This patch adds support for creating utmp records using the ‘utempter’ helper binary from the ‘libutempter’ package. * New config option ‘main.utempter’ * New meson command line option, -Ddefault-utempter-path. Defaults to auto-detecting the path. The default value of the new ‘main.utempter’ config option depends on the meson command line option ‘-Ddefault-utempter-path’. If ‘main.utempter’ is *not* set to ‘none’, foot will try to execute the utempter helper binary to create utmp records when a new terminal is instantiated. The record is removed when the terminal instance is destroyed.
2022-09-23install.md: add ‘utf8proc’Daniel Eklöf-0/+1
2022-05-12meson: add -Dsystemd-units-dir=<path> meson command line optionDaniel Eklöf-9/+10
This allows package maintainers to override the location to which our systemd service files are installed. It’s value is an *absolute* path, and *not* relative ${prefix}. The default is ${systemduserunitdir}.
2022-04-22meson: add -Dtests=false|true optionDaniel Eklöf-8/+9
When set to false, no test binaries are neither built, nor executed (with “ninja test”). Closes #919
2022-04-22doc + meson.build: update information about foot.ini, small cleanupMerlin Büge-2/+2
- foot.ini.5: mention location of example config file - foot.1: replace outdated (or incomplete) information about the location of the config file with references to foot.ini.5 - foot.1 and foot.ini.5: conform to scdoc specification, thus surround each header with (at least) one blank line. additionally consistently use exactly one line before/after each header (was sometimes two before) - foot.1: some parts of the keybindings had their own section, move into KEYBOARD SHORTCUTS section - foot.1: move EXIT STATUS section to the end where it is commonly found - foot.1: copy information about config file handling from the beginning of foot.ini.5 into the CONFIGURATION section of foot.1 - INSTALL.md: foot.ini is no longer included in the documentation - meson.build: do not bundle foot.ini with documentation anymore, see also https://codeberg.org/dnkl/foot/pulls/1015 Closes #1002
2022-02-26Install notes regarding systemd unit filesMax Gautier-1/+1
2022-02-02install: remove reference to the Arch AUR packageDaniel Eklöf-6/+0
2022-02-02docs: remove arch linux from install.md now that it's in the official repositoriesgrtcdr-15/+0
2021-12-08install: add UTF-8 locate to runtime depsDaniel Eklöf-0/+1
2021-12-08install: update instructions on how to manually compile the terminfoDaniel Eklöf-9/+4
2021-12-03install: add UTF-8 locate to runtime depsDaniel Eklöf-0/+1
2021-12-03install: update instructions on how to manually compile the terminfoDaniel Eklöf-9/+4
2021-11-07PKGBUILD: dropDaniel Eklöf-11/+7
The bundled PKGBUILD has been pretty much identical to the one in the AUR package “foot-git” for a long time now.
2021-10-31install: remove text describing obsolete differences between PKGBUILDsDaniel Eklöf-9/+3
2021-10-16pgo: full-inner: add --override tweak.grapheme-shaping=noDaniel Eklöf-1/+5
Grapheme shaping is now enabled by default in foot. However, when generating the profiling data in PGO builds, this results in skewed optimizations. The end result is worse benchmark results regardless of whether grapheme-shaping is enabled or not (when running the benchmarks).
2021-10-02install: improve readability of the PGO LC_CTYPE paragraphDaniel Eklöf-2/+2
2021-10-02pgo: full-inner: do not set LC_CTYPE=en_US.UTF-8Daniel Eklöf-0/+4
That locale may not exist. Instead, require the user/build script to explicitly set an UTF-8 locale. Document this in INSTALL.md, and in the bundled PKGBUILD.
2021-09-12install.md: document pgo/*.sh scriptsDaniel Eklöf-0/+26
2021-08-30install: terminfo: pipe sed output to ticDaniel Eklöf-2/+2
Related to #700
2021-08-30install: document how to manually pre-process the terminfo source fileDaniel Eklöf-6/+3
Related to #700
2021-08-30meson: terminfo install location now defaults to $datadir/terminfoDaniel Eklöf-39/+50
The meson command line option -Dcustom-terminfo-install-location has been changed in the following ways: * If unset, $datadir/terminfo is used, and TERMINFO is *not* exported * If set, that value (relative to $prefix) is used, and TERMINFO *is* exported. * The special value ‘no’ is removed. -Ddefault-terminfo now also changes the terminfo names generated when -Dterminfo=enabled. Furthermore, the documentation for the TERMINFO environment variable has been removed from the foot.1 and footclient.1 man pages (but as mentioned above, foot *will* still set it if -Dcustom-terminfo-install-location has been used). INSTALL.md has been updated to now recommend using ncurses’ terminfo definitions, if available. But also to document the other alternatives; installing the terminfo definitions in a custom location, or installing them with a diferent name. It also describes the general problem, and the disadvantages of each alternative (but without going into too much depth).
2021-08-18slave: set TERMINFO instead of TERMINFO_DIRSDaniel Eklöf-18/+18
This seems to be slightly better supported than TERMINFO_DIRS. It also simplifies our code, since it’s no longer an issue of whether to append or not - we just set TERMINFO, and ignore whatever it was set to before. Also closes #687
2021-08-17terminfo: install to $datadir/foot/terminfo by default, append to TERMINFO_DIRSDaniel Eklöf-33/+109
As of 2021-07-31, ncurses ships its own version of foot’s terminfo. Since: * It doesn’t have the non-standard Sync,Tc,setrgbf,setrgbb capabilities. * It doesn’t set hs,fsl,dsl (statusbar). * We want to be able to update our termminfo without waiting for an ncurses release. * Foot should be installable and usable on Linux systems that doesn’t have the latest ncurses. we still want to ship our own version. We can however not install it to the default terminfo location (e.g. /usr/share/terminfo), since it will collide with the ncurses provided files. Our options are to either rename our terminfo to something else, or to keep the name, but install our terminfo files somewhere else. The first option would be the easy one. However, I think it makes sense to use the same name. For example, a user that SSH’s into a remote system that does *not* have our own version installed, but *does* have the ncurses one, will gracefully fall back to that one, which is better than manually having to set e.g. TERM=xterm-256color. Now, if we want to use the same name, we need to install it somewhere else. But where? And how do we ensure our version is preferred over the ncurses one? I opted to $datadir/foot/terminfo (e.g. /usr/share/foot/terminfo) by default. It makes it namespaced to foot (i.e. we’re not introducing a new “standard” terminfo location), thus guaranteeing it wont collide with ncurses. To enable applications to find it, we export TERMINFO_DIRS. This is a list of *additional* directories to search for terminfo files. If it’s already defined, we *append* to it. The nice thing with this is, if there’s no terminfo in that location (e.g. when you SSH into a remote), the default terminfo location is *also* searched. But only *after* having searched through TERMINFO_DIRS. In short: our version is preferred, but the ncurses one (or an older version of our terminfo package!) will be used if ours cannot be found. To enable packagers full control over the new behavior, the existing meson command line options have been modified, and a new option added: -Dterminfo=disabled|enabled|auto: *build* and *install* the terminfo files. -Dcustom-terminfo-install-location=<path>: *where* the terminfo files are expected to be found. This *needs* to be set *even* if -Dterminfo=disabled. For example, if the packaging script builds and packages the terminfo files separate from the regular foot build. The path is *relative to $prefix*, and defaults to $datadir/foot/terminfo. This is the value that will be appended to TERMINFO_DIRS. Note that you can set it to ‘no’, in which case foot will *not* set/modify TERMINFO_DIRS. Only do this if you don’t intend to package foot’s terminfo files at all (i.e. you plan on using the ncurses ones only). -Ddefault-terminfo=foot. Allows overriding the default TERM value. This should only be changed if the target platform doesn’t support terminfo files. Closes #671
2021-07-24meson: add -Ddocs=disabled|enabled|auto command line optionDaniel Eklöf-1/+5
When enabled (the default, if scdoc is found), we build and install the man pages, example foot.ini, readme, changelog and license files.
2021-06-24install: add -Dgrapheme-clustering to the list of custom meson optionsDaniel Eklöf-0/+1
2021-06-23install: add the new ‘terminfo-install-location’ optionDaniel Eklöf-4/+28
And flesh out the description of the ‘terminfo’ option, and how it relates to the new ‘terminfo-install-location’. Also add instructions on how to manually generate the terminfo files.
2021-05-13INSTALL: fix an unclosed markdown quoteDaniel Martí-5/+5
While skimming this doc, I noticed that "-Dterminfo" wasn't rendering properly as it was lacking its closing backquote. While at it, tweak the Arch wiki link, as it redirects to replace /index.php with /title.
2021-04-18install: add ‘ninja test’ to all build typesDaniel Eklöf-0/+3
While we don’t (yet) have any unit tests for foot, users can build foot with e.g. fcft and/or tllist as sub-projects. *They* have tests, and when doing PGO builds, those test binaries *must* be executed, or we get link failures in the final build.
2021-03-28install: add ‘ninja test’ to all build typesDaniel Eklöf-0/+3
While we don’t (yet) have any unit tests for foot, users can build foot with e.g. fcft and/or tllist as sub-projects. *They* have tests, and when doing PGO builds, those test binaries *must* be executed, or we get link failures in the final build.
2021-03-26install: clang-11.x compatible PGO instructionsDaniel Eklöf-11/+17
LLVM/Clang 11.x throws errors for _files_ without any profiling data: error: ../../async.c: Function control flow change detected (hash mismatch) async_write Hash = 72057641800614222 [-Werror,-Wbackend-plugin] This caused multiple issues with the current PGO instructions: * The `pgo` binary failed to link with `meson configure -Db_pgo=use` when doing a full PGO build (since it isn't used in this case); * `footclient` fails to link for the same reason. * `foot` fails to link for the same reason in **partial** PGO builds. The solution is to make sure all binaries that are built in the final phase (`-Db_pgo=use`) have been executed in the _generate_ phase. Doing this also means we can drop `-Wno-missing-profile` and friends. Also add `--sixel` to the `generate-alt-random-writes` command line in the description for a full PGO build. Closes #418
2021-03-26install: add ‘llvm’ as an optional build dependencyDaniel Eklöf-0/+1
It is needed for PGO builds with Clang.
2021-03-17Add: Bash completion for foot and footclientSimon Schricker-0/+1
* use toe for terminfo, thanks Craig. * adds optional dependency on bash-completion for positional arguments Co-authored-by: Craig Barnes <craigbarnes@protonmail.com>
2021-02-14install: add libnotify and xdg-utils as optional dependenciesDaniel Eklöf-0/+6
2021-02-12install: add -Dterminfo to list of compile-time optionsDaniel Eklöf-3/+4
2021-02-09install: add -Dterminfo to list of compile-time optionsDaniel Eklöf-3/+4
2020-12-21install: remove -march=nativeDaniel Eklöf-8/+4
This simplifies the instructions. People interested in performance are likely to know how to use it.
2020-12-21install.md: mention that packagers should not use -march=nativeDaniel Eklöf-0/+4
2020-12-21install.md: add -Wno-profile-instr-unprofiled to clang flags in PGO buildsDaniel Eklöf-1/+4
2020-12-21install: remove -march=nativeDaniel Eklöf-8/+4
This simplifies the instructions. People interested in performance are likely to know how to use it.
2020-12-21install: fix typo in ‘ninja’Daniel Eklöf-1/+1
2020-12-21install.md: mention that packagers should not use -march=nativeDaniel Eklöf-0/+4
2020-12-21install.md: add -Wno-profile-instr-unprofiled to clang flags in PGO buildsDaniel Eklöf-1/+4
2020-12-21install: fix typo in ‘ninja’Daniel Eklöf-1/+1
2020-12-19meson: use wrap files for fcft/tllist subprojectsCraig Barnes-18/+3
See: https://mesonbuild.com/Wrap-dependency-system-manual.html
2020-12-08install: simplify sentenceDaniel Eklöf-1/+1
2020-12-07install: highlight option default value in options listDaniel Eklöf-1/+1
2020-12-07install: highlight option name in options listDaniel Eklöf-3/+3
2020-12-07install: add ‘options’ section, describing compile-time optionsDaniel Eklöf-0/+10
2020-11-24install: add --sixel to suggested command line for generate-alt-random-writesDaniel Eklöf-0/+1
2020-11-22install: minor tweaks to PGO instructionsDaniel Eklöf-3/+5
2020-11-22install: re-write release build instructionsDaniel Eklöf-42/+51
2020-11-22install: re-write description of recommended flags, and add size comparisonDaniel Eklöf-10/+27
2020-11-22install: no need to run input *that* many timesDaniel Eklöf-1/+1
2020-11-22install: add --attr-{bold,italic,underline} to generate-alt-random-writesDaniel Eklöf-1/+4
2020-11-22remove pre-generated input corpus for PGODaniel Eklöf-2/+22
2020-11-22install: add --colors-256 to generate-alt-random-writesDaniel Eklöf-1/+1
2020-11-22install: small rewording and restructuring of PGO instructionsDaniel Eklöf-12/+10
2020-11-22install: update PGO instructionsDaniel Eklöf-4/+43
2020-11-14install: simplify sentenceDaniel Eklöf-1/+1
2020-11-14install: remove -fno-plt from recommended CFLAGSDaniel Eklöf-2/+2
It appears to _worsen_ the performance...
2020-11-06Fix documentation snippetsjeromenerf-2/+3
- zsh doesn't like "export var+=value", make it two steps - meson was complaining with "ERROR: Must specify at least one directory name.", so add the relative "../.."
2020-10-11install: say _why_ ncurses and scdoc is neededDaniel Eklöf-2/+2
2020-10-10selection: use appropriate check for PRIMARY pasteSergey Nazaryev-325/+85
Assume it could be a copy-paste typo. We should check PRIMARY, not CLIPBOARD. Without this fix, we can't use PRIMARY until we copy anything to CLIPBOARD.
2020-09-24install: say _why_ ncurses and scdoc is neededDaniel Eklöf-2/+2
2020-08-15Fix typosLennard Hofmann-2/+2
2020-07-31install: tllist is a *build* dependency, not a *runtime* dependencyDaniel Eklöf-1/+1
2020-07-28readme: move 'requirements' into INSTALL.mdDaniel Eklöf-0/+42
2020-07-28readme: move installation instructions to INSTALL.mdDaniel Eklöf-0/+194