aboutsummaryrefslogtreecommitdiff
path: root/vendor/libghostty-vt/PACKAGING.md
diff options
context:
space:
mode:
authorCan Celik <ogulcancelik@gmail.com>2026-04-04 19:22:04 +0300
committerCan Celik <ogulcancelik@gmail.com>2026-04-05 01:23:06 +0300
commit41dd733ca7123c9ac4bfc6c781697a660e95b052 (patch)
tree3fc91815ca139ef2e0b281bba0abda4ef15175f4 /vendor/libghostty-vt/PACKAGING.md
parent55c138263e190a1e79d4b997bfb9397306c0ec1f (diff)
feat: finish ghostty pane backend integration
Diffstat (limited to 'vendor/libghostty-vt/PACKAGING.md')
-rw-r--r--vendor/libghostty-vt/PACKAGING.md124
1 files changed, 124 insertions, 0 deletions
diff --git a/vendor/libghostty-vt/PACKAGING.md b/vendor/libghostty-vt/PACKAGING.md
new file mode 100644
index 00000000..1483b859
--- /dev/null
+++ b/vendor/libghostty-vt/PACKAGING.md
@@ -0,0 +1,124 @@
+# Packaging Ghostty for Distribution
+
+Ghostty relies on downstream package maintainers to distribute Ghostty to
+end-users. This document provides guidance to package maintainers on how to
+package Ghostty for distribution.
+
+> [!IMPORTANT]
+>
+> This document is only accurate for the Ghostty source alongside it.
+> **Do not use this document for older or newer versions of Ghostty!** If
+> you are reading this document in a different version of Ghostty, please
+> find the `PACKAGING.md` file alongside that version.
+
+## Source Tarballs
+
+Source tarballs with stable checksums are available for tagged releases
+at `release.files.ghostty.org` in the following URL format where
+`VERSION` is the version number with no prefix such as `1.0.0`:
+
+```
+https://release.files.ghostty.org/VERSION/ghostty-VERSION.tar.gz
+https://release.files.ghostty.org/VERSION/ghostty-VERSION.tar.gz.minisig
+```
+
+Signature files are signed with
+[minisign](https://jedisct1.github.io/minisign/)
+using the following public key:
+
+```
+RWQlAjJC23149WL2sEpT/l0QKy7hMIFhYdQOFy0Z7z7PbneUgvlsnYcV
+```
+
+**Tip source tarballs** are available on the
+[GitHub releases page](https://github.com/ghostty-org/ghostty/releases/tag/tip).
+Use the `ghostty-source.tar.gz` asset and _not the GitHub auto-generated
+source tarball_. These tarballs are generated for every commit to
+the `main` branch and are not associated with a specific version.
+
+> [!WARNING]
+>
+> Source tarballs are _not the same_ as a Git checkout. Source tarballs
+> contain some preprocessed files that allow building Ghostty with less
+> dependencies. If you are building Ghostty from a Git checkout, the
+> steps below are the same but they may require additional dependencies
+> not listed here. See the `README.md` for more information on building
+> from a Git checkout.
+>
+> For everyone except Ghostty developers, please use the source tarballs.
+> We generate tip source tarballs for users following the development
+> branch.
+
+## Zig Version
+
+[Zig](https://ziglang.org) is required to build Ghostty. Prior to Zig 1.0,
+Zig releases often have breaking changes. Ghostty requires specific Zig versions
+depending on the Ghostty version in order to build. To make things easier for
+package maintainers, Ghostty always uses some _released_ version of Zig.
+
+To find the version of Zig required to build Ghostty, check the `required_zig`
+constant in `build.zig`. You don't need to know Zig to extract this information.
+This version will always be an official released version of Zig.
+
+For example, at the time of writing this document, Ghostty requires Zig 0.14.0.
+
+## Building Ghostty
+
+The following is a standard example of how to build Ghostty _for system
+packages_. This is not the recommended way to build Ghostty for your
+own system. For that, see the primary README.
+
+1. First, we fetch our dependencies from the internet into a cached directory.
+ This is the only step that requires internet access:
+
+```sh
+ZIG_GLOBAL_CACHE_DIR=/tmp/offline-cache ./nix/build-support/fetch-zig-cache.sh
+```
+
+2. Next, we build Ghostty. This step requires no internet access:
+
+```sh
+DESTDIR=/tmp/ghostty \
+zig build \
+ --prefix /usr \
+ --system /tmp/offline-cache/p \
+ -Doptimize=ReleaseFast \
+ -Dcpu=baseline
+```
+
+The build options are covered in the next section, but this will build
+and install Ghostty to `/tmp/ghostty` with the prefix `/usr` (i.e. the
+binary will be at `/tmp/ghostty/usr/bin/ghostty`). This style is common
+for system packages which separate a build and install step, since the
+install step can then be done with a `mv` or `cp` command (from `/tmp/ghostty`
+to wherever the package manager expects it).
+
+### Build Options
+
+Ghostty uses the Zig build system. You can see all available build options by
+running `zig build --help`. The following are options that are particularly
+relevant to package maintainers:
+
+- `--prefix`: The installation prefix. Combine with the `DESTDIR` environment
+ variable to install to a temporary directory for packaging.
+
+- `--system`: The path to the offline cache directory. This disables
+ any package fetching from the internet. This flag also triggers all
+ dependencies to be dynamically linked by default. This flag also makes
+ the binary a PIE (Position Independent Executable) by default (override
+ with `-Dpie`).
+
+- `-Doptimize=ReleaseFast`: Build with optimizations enabled and safety checks
+ disabled. This is the recommended build mode for distribution. I'd prefer
+ a safe build but terminal emulators are performance-sensitive and the
+ safe build is currently too slow. I plan to improve this in the future.
+ Other build modes are available: `Debug`, `ReleaseSafe`, and `ReleaseSmall`.
+
+- `-Dcpu=baseline`: Build for the "baseline" CPU of the target architecture.
+ This avoids building for newer CPU features that may not be available on
+ all target machines.
+
+- `-Dtarget=$arch-$os-$abi`: Build for a specific target triple. This is
+ often necessary for system packages to specify a specific minimum Linux
+ version, glibc, etc. Run `zig targets` to a get a full list of available
+ targets.