ladybird/Ports
Daniel Lemos 3063aedb0c Ports: Add Lua's package manager LuaRocks
Ports: Add LuaRocks to AvailablePorts.md

Ports: Add ReadMe.md for the patches
2022-03-16 14:14:01 +00:00
..
angband Ports: Add ReadMe files explaining port patches that have explanations 2022-01-16 10:32:50 +03:30
Another-World Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
bash Ports: Download fresh config.guess if needed 2022-03-08 23:30:47 +01:00
bass Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
bc Ports: Enable history handling in bc 2021-10-25 21:42:26 +02:00
bdwgc Ports: Add a bdwgc (aka libgc) port 2022-03-08 22:29:53 +01:00
binutils Ports: Update binutils to version 2.38 2022-02-11 18:07:53 +01:00
bison Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
bochs Ports: Add Bochs x86 PC emulator 2022-02-23 09:59:08 +00:00
brogue Ports: Add ReadMe files explaining port patches that have explanations 2022-01-16 10:32:50 +03:30
byacc Ports/byacc: Remove obsolete getopt.h patch 2021-12-24 17:02:40 +03:30
bzip2 Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
c-ray Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
ca-certificates Ports: Add a ca-certificates "port" 2022-03-08 18:21:06 -08:00
carl Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
ccache Ports: Add ccache port to make compiling on Serenity more fun :^) 2022-01-09 23:32:03 +01:00
chester Ports/chester: Enable -Werror 2021-12-24 17:02:40 +03:30
citron Ports: Add a dependency on pcre to citron 2022-03-16 14:10:59 +00:00
cmake Ports: Enable OpenSSL support for CMake 2022-02-17 21:25:41 -08:00
cmatrix Ports/cmatrix: Fix hash and update version 2021-11-06 00:42:02 -07:00
composer Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
curl Ports: Update curl to 7.82.0 2022-03-13 22:58:21 +01:00
dash Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
dialog Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
diffutils Ports: Add config.sub location to diffutils config.sub 2022-03-15 14:03:07 +00:00
dmidecode Ports: Add ReadMe files explaining port patches that have explanations 2022-01-16 10:32:50 +03:30
doom Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
dos2unix Ports: Add ReadMe files explaining port patches that have explanations 2022-01-16 10:32:50 +03:30
dosbox-staging Ports: Remove wchar patch from dosbox-staging 2021-12-21 20:35:52 -08:00
drascula Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
dreamweb Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
dropbear Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
dungeonrush Ports: Add ReadMe files explaining port patches that have explanations 2022-01-16 10:32:50 +03:30
ed Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
emu2 Ports: Include missing signal.h in emu2 2022-01-08 00:46:30 +01:00
epsilon Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
ffmpeg Ports: Upgrade to FFmpeg 5.0 release; enable SDL and networking 2022-03-02 11:40:37 +01:00
figlet Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
fio Ports: Add fio port 2021-12-22 13:28:13 -08:00
flatbuffers Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
flex Ports: Add config_sub_path to flex 2022-03-15 14:03:07 +00:00
fontconfig Ports/fontconfig: Add freetype dependency 2022-01-31 03:31:40 +01:00
fotaq Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
freeciv Ports: Point freeciv to the correct config.sub location 2022-03-15 14:03:07 +00:00
freedink Ports: Point freedink to the correct config.sub location 2022-03-15 14:03:07 +00:00
freetype Ports: Fix freetype port 2022-01-24 07:55:39 +00:00
frotz Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
gawk Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
gcc Toolchain: Backport support for the mold linker 2022-01-24 10:41:47 +00:00
gdb Ports/gdb: Implement wait and mourn_inferior overrides for our target 2022-02-20 11:49:41 +01:00
genemu Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
gettext Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
git Ports: Update git to version 2.35.1 2022-03-12 17:38:45 -08:00
glib Ports: Add ReadMe files explaining port patches that have explanations 2022-01-16 10:32:50 +03:30
glm Ports: Add OpenGL Mathematics (GLM) port 2021-10-31 11:52:27 +01:00
gltron Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
glu Ports: Add Mesa GLU 2021-12-27 11:58:43 +01:00
gmp Ports: byacc+gmp+m4: Split auth_opts strings into array elements 2021-10-25 00:06:43 -07:00
gnuapl Ports: Specify sha256sum for the GNU APL port 2022-03-11 21:05:17 +01:00
gnucobol Ports: Point gnucobol to the correct config.sub location 2022-03-15 14:03:07 +00:00
gnupg Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
gnuplot Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
gperf Ports: Add GNU gperf port 2021-10-24 22:34:02 -07:00
grep Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
griffon Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
gsl Ports: Replace gsl download mirror with functional download url 2022-03-15 14:03:07 +00:00
halflife Ports: Enable menu support for half-life port 2022-01-24 07:55:39 +00:00
harfbuzz Ports: Allow harfbuzz to be built with cmake 3.18.4 2022-03-15 14:03:07 +00:00
hatari Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
imagemagick Ports: Add ImageMagick 2022-02-14 11:40:06 +01:00
imgcat Ports: Add libpng and libjpeg dependencies to imgcat 2022-03-16 14:10:59 +00:00
indent Ports: Point indent to the correct config.sub location 2022-03-15 14:03:07 +00:00
jot Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
jq Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
klong Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
less Ports: Update less to version 590 2022-03-12 17:38:45 -08:00
libarchive Ports: Point libarchive to the correct config.sub location 2022-03-15 14:03:07 +00:00
libassuan Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libatomic_ops Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libexpat Ports: Point libexpat to the correct config.sub location 2022-03-15 14:03:07 +00:00
libffi Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libgcrypt Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libgd Ports: Point libgd to the correct config.sub location 2022-03-15 14:03:07 +00:00
libgpg-error Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libiconv Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libicu Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libjpeg Ports: Update libjpeg to 9e 2022-02-20 12:42:13 +00:00
libksba Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libmad Ports: Add libmad 2022-02-22 23:48:59 +00:00
libmodplug Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libmpeg2 Ports: Disable SDL support for libmpeg2 2022-03-16 14:10:59 +00:00
libogg Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
liboggz Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libopenal Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libphysfs Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libpng Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libpuffy Ports: Fix building libpuffy 2021-05-01 22:52:15 +02:00
libsixel Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libsodium Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libssh2 Ports: Add libssh2 port 2021-12-20 10:43:47 -08:00
libtheora Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libtiff Ports: Update libtiff port to version 4.3.0 and use sha256 2022-01-08 13:50:48 +03:30
libtool Ports: Point libtool to the correct config.sub location 2022-03-15 14:03:07 +00:00
libuuid Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libuv Ports: Add ReadMe files explaining port patches that have explanations 2022-01-16 10:32:50 +03:30
libvorbis Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libxml2 Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
libzip Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
links Ports: Updated links port to version 2.25 2021-12-16 22:45:05 +01:00
llvm Ports: Add ReadMe files explaining port patches that have explanations 2022-01-16 10:32:50 +03:30
lua Ports: Make lua depends and build with readline 2022-03-16 14:12:30 +00:00
luarocks Ports: Add Lua's package manager LuaRocks 2022-03-16 14:14:01 +00:00
lure Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
m4 Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
make Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
mandoc Ports/mandoc: Remove obsolete patches 2021-12-24 17:02:40 +03:30
mawk Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
mbedtls Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
mc Ports: Regenerate the patch readme file for mc 2022-01-16 10:32:50 +03:30
milkytracker Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
mold Ports: Update mold port to v1.0.2 2022-01-24 02:53:04 +00:00
mpc Ports: Set the correct config.sub path for mpc 2022-02-17 11:16:38 +01:00
mpfr Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
mrsh Ports/mrsh: Remove obsolete PIPE_BUF patch 2021-12-24 17:02:40 +03:30
mruby Ports: Add port for mruby 2021-08-25 02:22:01 +02:00
mysthous Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
nano Ports: Update nano to version 6.0 2022-02-06 07:16:59 +00:00
nasm Ports: Point nasm to the correct config.sub location 2022-03-15 14:03:07 +00:00
ncdu Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
ncurses Ports/ncurses: Check for proper tic version during install 2021-12-20 10:45:52 -08:00
neofetch Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
nesalizer Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
nethack Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
ninja Ports: Remove obsolete patches for ninja 2021-07-04 00:35:35 +02:00
nippon Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
npiet Ports: Add npiet 2022-01-07 02:12:51 +01:00
npth Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
ntbtls Ports: Add a dependency on zlib to ntbtls 2022-03-16 14:10:59 +00:00
nyancat Ports: Use "launcher_run_in_terminal=true" instead of "Terminal -e ..." 2021-07-20 00:58:26 +01:00
oksh Ports: Remove obsolete /dev/tty patches 2021-12-24 17:02:40 +03:30
openssh Ports: Remove redundant ensure_new_config_sub call 2022-01-22 00:31:57 +03:30
openssl Ports: Update OpenSSL to 1.1.1n 2022-03-16 13:01:23 +00:00
openttd Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
openttd-opengfx Ports: Add openttd 2021-04-23 20:15:49 +02:00
openttd-opensfx Ports: Add openttd 2021-04-23 20:15:49 +02:00
opentyrian Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
opentyrian-data Ports: Add opentyrian and opentyrian-data 2021-05-31 19:01:49 +01:00
opfor Ports: Add Half-Life: Opposing Force port :^) 2022-01-24 17:04:55 +01:00
p7zip Ports: Add a dependency on libiconv to p7zip 2022-03-16 14:10:59 +00:00
patch Ports: Set the correct config.sub path for patch 2022-02-17 11:16:38 +01:00
pcre Ports: Regenerate patches for pcre 2022-01-16 10:32:50 +03:30
pcre2 Ports: Update pcre2 to 10.39 2021-11-06 00:32:36 -07:00
pfetch Ports: Add pfetch utility 2022-01-01 17:35:17 +00:00
php Ports: Unset env vars after configure in php 2022-01-08 00:45:49 +01:00
pkgconf Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
printf Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
pt2-clone Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
pv Ports: Add initial Pipe Viewer (pv) 1.6.20 port 2021-11-14 16:18:45 +00:00
python3 Ports: Update Python to 3.10.2 2022-01-30 17:40:39 +00:00
qt6-qtbase Ports/qt6: Add a very basic Qt6 Base package 2022-01-07 18:38:32 +01:00
qt6-serenity Ports/qt6: Add qt6-serenity 2022-01-07 18:38:32 +01:00
quake Ports: quake: Do no set PATH environment variable in package.sh 2021-11-02 23:04:22 +01:00
quake2 Ports: Add OpenGL include dir to quake2 build 2022-03-08 15:32:23 +01:00
r0 Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
radare2 Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
readline Ports/readline: Fix config.sub refresh for the readline port 2022-01-18 08:50:40 +01:00
rsync Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
ruby Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
sam Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
scummvm Ports: Enable monkey4 engine for ScummVM 2022-02-22 23:48:59 +00:00
SDL2 Ports: Fix dependencies for SDL2 2021-10-16 15:36:04 -07:00
SDL2-GNUBoy Ports: Add ReadMe files explaining port patches that have explanations 2022-01-16 10:32:50 +03:30
SDL2_gfx Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
SDL2_image Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
SDL2_mixer Ports: Set config.sub path for SDL2_mixer 2022-01-21 22:07:25 +01:00
SDL2_net Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
SDL2_ttf Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
SDL_sound Ports: Add ReadMe files explaining port patches that have explanations 2022-01-16 10:32:50 +03:30
SDLPoP Ports: Add ReadMe files explaining port patches that have explanations 2022-01-16 10:32:50 +03:30
sed Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
sfinx Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
sl Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
soltys Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
sparsehash Ports: Add a sparsehash port 2022-02-12 12:16:59 +01:00
sqlite Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
stpuzzles Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
stress-ng Ports: Regenerate stress-ng patches 2022-01-16 10:32:50 +03:30
Super-Mario Ports: Use the objcopy built as part of the toolchain 2022-02-20 23:07:31 +00:00
tcl Ports: Fix path for the tcl port's patch file 2021-04-27 17:59:52 +02:00
termcap Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
tig Ports: Add a dependency on libiconv to tig 2022-03-16 14:10:59 +00:00
tinycc Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
tinyscheme Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
tr Ports/tr: Remove obsolete getopt.h patch 2021-12-24 17:02:40 +03:30
tuxracer Ports: Remove unnecessary -lmodplug from tuxracer 2022-01-08 00:56:48 +01:00
vim Ports: Update vim to version 8.2.4554 2022-03-12 17:38:45 -08:00
vitetris Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
vlang Ports: Bump vlang version to weekly.2021.31 2021-08-14 20:28:55 +02:00
vttest Ports: Update vttest to version 20220215 2022-03-02 21:37:26 +01:00
wget Ports: Update wget to version 1.21.2 2022-02-06 03:20:25 +00:00
wireguard-tools Ports: Remove wireguard-tools strsep() replacement patch 2022-01-10 23:47:30 +01:00
xz Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
yasm Ports: Point yasm to the correct config.sub location 2022-03-15 14:03:07 +00:00
zlib Ports: Fix building zlib with Clang 2021-11-14 11:38:40 +00:00
zsh Ports: Remove some config.sub patches and download a fresh one if needed 2022-01-16 10:32:50 +03:30
zstd Ports: Update zstd to 1.5.2 2022-03-13 22:58:21 +01:00
.gitignore Ports: Build most python3 extension modules statically 2021-02-02 16:53:06 +01:00
.hosted_defs.sh Ports: Use the objcopy built as part of the toolchain 2022-02-20 23:07:31 +00:00
.port_include.sh Ports: Fail if config.{sub,guess} don't replace existing files 2022-03-16 14:10:59 +00:00
AvailablePorts.md Ports: Add Lua's package manager LuaRocks 2022-03-16 14:14:01 +00:00
build_all.sh Ports: Don't add ports to the "built" list unless successful 2021-11-06 11:54:00 +01:00
build_installed.sh Ports: Replace hardcoded Build/ paths with SERENITY_BUILD_DIR 2021-03-11 21:01:29 +01:00
README.md Meta: Update hashes in Port's README 2022-03-11 21:26:56 +01:00

Ports for SerenityOS

What's this?

Serenity has software patched to run on it. These shell scripts will allow you to build that sort of software, easily. Note that you must have already built Serenity, and be in a Serenity build environment.

Available ports

A list of all available ports can be found here.

Using ports scripts

Each port has a script called package.sh which defines a name and version, its dependencies, the required files that will be downloaded as well as configuration/compilation options, and some other things (see Writing ports scripts for details).

  • To install a certain port, cd into its directory and run ./package.sh
  • To install all available ports, run the build_all.sh script in this directory. Pass clean as first argument to remove old build files beforehand.
  • To reinstall all currently installed ports, run the build_installed.sh script in this directory. This is sometimes required when LibC changes, for example. Pass clean as first argument to remove old build files beforehand.

Installed ports are being tracked in Build/i686/Root/usr/Ports/packages.db (a simple text file). You can delete this file at any time, in fact it must be edited or removed when clearing the build directory as port dependencies may not be installed again otherwise.

Not giving an option is equivalent to installdepends, fetch, patch, configure, build and install, in that order. This is recommended for a regular install.

Options

The following options are available:

fetch

By default, download, verify, and extract the port's files.

patch

Apply the port's patches (patches/*.patch). A file .foo_applied is created in workdir upon success to ensure a certain patch is only applied once.

configure

By default, run the port's configscript (usually configure) with configopts.

build

By default, run make with the port's makeopts.

install

By default, run make install with the port's installopts.

shell

Open a shell in the $workdir with the build environment set.

installdepends

Install all ports from the port's depends list.

clean

By default, remove all .out files from the port's workdir.

clean_dist

By default, remove everything that's been downloaded from the port's files list.

clean_all

By default, clean and clean_dist combined.

uninstall

Remove the port's files from the Serenity build directory, if it has a plist file.

dev

Start a development session with guided patch importing. This mode has a bunch of nice features:

  • Drops the user in a git repository backed by another (local) git repository that acts as the "clean", patched version of the port that is ready to be built
  • The "remote" repository can be pushed to, pulled from and generally anything that you'd want to do with a remote repo.
  • After leaving the dev shell, all patches are updated and the user will be prompted whether they wish to generate a new patch readme file.

This mode takes an extra --no-depends option, that if given, will cause the dependency fetch and build steps to be skipped.

This mode can also assist in migrating old patches to new versions through a guided semi-automated process.

--auto

Same as no option, but mark the port as having been installed automatically. This is used for dependencies.

Writing ports scripts

The package.sh file is a simple Bash script that's required for each port. Patches and other files are optional. The most basic version of such a port script simply defines some well-known variables and looks like this:

#!/usr/bin/env -S bash ../.port_include.sh

port="foo"
version="1.2.3"
useconfigure="true"
files="https://example.com/foo-${version}.tar.gz foo-${version}.tar.gz"
depends=("bar" "baz")

The script in the shebang, .port_include.sh, is where all the magic happens.

Variables

The following variables have special functionality:

auth_import_key

PGP key to import (from keyserver.ubuntu.com) when auth_type is sig.

auth_opts

Options passed to gpg --verify when auth_type is sig.

Usually used like this:

auth_opts="foo-${version}.tar.xz.asc foo-${version}.tar.xz"

auth_type

The type of file validation to use, can be one of:

  • sha256: Use SHA256 hashes defined in files
  • sig: Use PGP signatures (see auth_opts)

Most ports use sig as .asc files are widely available.

This has to be specified in order for lint-ports to pass.

If no signature or hash is provided by the author of the files, just create the hash yourself by calling sha256sum on the downloaded file and specifying the hash along with the files.

configopts

Options passed to the port's configscript in the default configure function.

--host=i686-pc-serenity is always passed, override the configure function if that's undesirable.

use_fresh_config_sub

Boolean option (false by default), will replace the config.sub pointed to by config_sub_path as part of the patching process if set to true.

config_sub_path

Path to the config.sub file used by autoconf, starting at $workdir. This is set to config.sub by default.

configscript

Name of the script that will be run in the default configure function when useconfigure is true.

Defaults to configure.

depends

An array of other SerenityOS ports the port depends on and which will be installed during the installdepends step.

For example:

depends=("ncurses" "gettext")

files

A list of external files required by the port, one per line. The format of each line is as follows:

URL NAME HASH

Where URL is the URL from where the file will be downloaded (using curl), NAME is the output name of the downloaded file, and HASH is an optional MD5, SHA1, or SHA256 hash that will be used for verification when auth_type is set to either of those hash functions.

For example:

With PGP signatures

files="https://example.com/foo-${version}.tar.xz foo-${version}.tar.xz
https://example.com/foo-${version}.tar.xz.asc foo-${version}.tar.xz.asc"

With a SHA256 hash

files="https://example.com/foo-${version}.tar.xz foo-${version}.tar.xz 9acd50f9a2af37e471f761c3fe7b8dea5617e51dac802fe6c177b74abf0abb5a"

If a file is a compressed tar archive, a gzip compressed file or a zip compressed file, it will be extracted.

If a file is an .asc file (PGP signature) it will be imported into gpg's keyring and can later be used for verification using auth_opts.

icon_file

The file to use for the port launcher icon. The icon file is assumed to have a 16x16 as well as a 32x32 layer.

installopts

Options passed to make install in the default install function.

DESTDIR="${SERENITY_INSTALL_ROOT}" ("${SERENITY_SOURCE_DIR}/Build/${SERENITY_ARCH}/Root") is always passed, override the install function if that's undesirable.

makeopts

Options passed to make in the default build function.

Defaults to -j$(nproc).

patchlevel

The value for patch's -p / --strip option, see man patch for details.

Defaults to 1.

port

The "package name" of the port, usually the same as the directory this script is placed in.

prefix

The location of the ports directory, only used for the package.db file for now. Don't override this in ports contributed to Serenity.

Defaults to $SERENITY_SOURCE_DIR/Ports.

useconfigure

The configure step will run pre_configure and configure when this is set to true, and simply skip them otherwise.

Defaults to false.

version

The version of the port. Written to package.db, and usually used with variable interpolation in files where the version is part of the filename.

workdir

The working directory used for executing other commands via run as well as cleanup. Usually the directory name of the upacked source archive.

Defaults to $port-$version.

Functions

The various steps of the port installation process are split into individual Bash functions, some of which can be overridden to provide custom behaviour, like this:

build() {
    run mybuildtool --foo --bar
}

The following can be overridden, the names should be self-explanatory as they mostly match the available options:

  • pre_fetch
  • post_fetch
  • pre_configure
  • configure.
  • build
  • install
  • post_install
  • clean
  • clean_dist
  • clean_all

A few (non-overridable) util functions are available as well:

run

Log the command and run it in the port's workdir.

run_nocd

Log the command and run it in the current working directory (i.e. Ports/$port).

run_replace_in_file

Replace something in a file (using a Perl regular expression), like this:

run_replace_in_file "s/define FOO 1/undef FOO/" config.h

How do I contribute?

You can either:

  • Add new ports - just get the software to build and add the necessary patches and package.sh script
  • Update an existing port: bumping its version, getting functionality to work that wasn't available so far etc. Make sure to update the patches accordingly.

Some videos of Andreas adding new ports can be found on YouTube, they might help you understand how this usually works: