serenity/Ports
2021-08-25 02:22:01 +02:00
..
Another-World Ports: Adds Another World VM interpreter implementation 2021-06-14 12:19:54 +01:00
bash Ports: Update bash to 5.1.8 2021-07-29 19:35:03 +01:00
bass Ports: Add Beneath a Steel Sky 2021-06-07 19:04:57 +02:00
bc Ports: Remove obsolete patches for bc 2021-07-04 00:35:35 +02:00
binutils Ports: Use SHA256 to verify file integrity for binutils 2021-07-28 21:28:31 +02:00
bison
brogue Ports: Add port for Brogue (BrogueCE) 2021-05-15 10:13:43 +01:00
byacc
bzip2
c-ray
carl
chester Ports: Remove obsolete patches for chester 2021-07-04 00:35:35 +02:00
cmake Ports: Make the CMake port use the LibUV port 2021-07-09 15:36:50 +02:00
cmatrix Ports: Use "launcher_run_in_terminal=true" instead of "Terminal -e ..." 2021-07-20 00:58:26 +01:00
composer Ports: Add Composer 2021-06-13 17:06:45 +01:00
curl Ports: Build a shared library for curl 2021-08-13 21:29:48 +02:00
dash
dialog
diffutils Ports: Add missing fnmatch patch for diffutils 2021-08-09 17:56:29 +01:00
dmidecode Ports: Fix dmidecode patches 2021-06-29 20:53:59 +02:00
doom Ports: Remove SHA256 checksum for the doom port 2021-08-14 20:28:55 +02:00
dosbox-staging Ports/dosbox-staging: Change 'serenity*' build target to '*serenity*' 2021-07-19 16:59:56 +02:00
drascula Ports: Add ScummVM game Dráscula: The Vampire Strikes Back 2021-07-22 22:30:55 +02:00
dreamweb Ports: Add ScummVM game DreamWeb 2021-07-22 22:30:55 +02:00
dropbear
dungeonrush Ports: Add port for DungeonRush 2021-06-16 20:08:13 +02:00
ed Ports/ed: Make the configure script use the target toolchain 2021-08-11 08:41:17 +02:00
emu2
epsilon Ports: Add Launcher for Epsilon 2021-07-15 01:47:51 +02:00
ffmpeg
figlet
flatbuffers
flex
fotaq Ports: Add ScummVM game Flight of the Amazon Queen 2021-07-22 22:30:55 +02:00
freeciv Ports: Install launcher for Freeciv 2021-06-06 20:31:38 +02:00
freetype Ports: Build shared library for freetype 2021-06-05 10:56:37 +02:00
frotz
gcc Ports: Make sure re-installing the gcc port doesn't fail 2021-08-13 21:29:48 +02:00
genemu
gettext Ports: Add libiconv dependency to gettext 2021-05-15 09:01:55 +02:00
git Ports: Bump git to 2.33.0 2021-08-23 23:35:39 +02:00
glib Ports: Add glib version 2.69.0 2021-08-14 22:32:00 +01:00
gmp
gnucobol
gnupg
gnuplot
grep
griffon Ports: Add ScummVM game The Griffon Legend 2021-07-22 22:30:55 +02:00
harfbuzz
hatari
imgcat
indent
jot
jq
klong
less Ports: Fix less by disabling wctype 2021-06-18 10:19:00 +02:00
libarchive Ports: Bump libarchive from version 3.4.0 to 3.5.1 2021-07-19 16:24:15 +02:00
libassuan Ports: Build shared libraries for the GnuPG libraries 2021-05-19 22:45:02 +02:00
libatomic_ops Ports: Add libatomic_ops 2021-08-21 13:16:51 +01:00
libexpat Ports: Remove obsolete patches for libexpat 2021-07-04 00:35:35 +02:00
libffi Ports: Bump libffi from version 3.3 to 3.4.2 2021-07-19 10:45:47 +02:00
libgcrypt Ports: Build shared libraries for the GnuPG libraries 2021-05-19 22:45:02 +02:00
libgpg-error Ports: Build shared libraries for the GnuPG libraries 2021-05-19 22:45:02 +02:00
libiconv Ports: Make sure to remove the .la file after building libiconv 2021-08-14 12:40:49 +02:00
libicu Ports: Remove obsolete patches for libicu 2021-07-04 00:35:35 +02:00
libjpeg
libksba Ports: Build shared libraries for the GnuPG libraries 2021-05-19 22:45:02 +02:00
libogg
libopenal
libphysfs
libpng
libpuffy
libsixel Ports: Add libsixel 2021-08-15 19:48:11 +01:00
libsodium
libtheora
libtiff
libtool
libuv Ports: Add libuv 2021-07-09 15:36:50 +02:00
libvorbis
libxml2 Ports: Make sure to remove the .la file after building libxml2 2021-08-14 12:40:49 +02:00
libzip Ports: Fix zlib include directory for libzip 2021-06-06 17:45:15 +02:00
links
llvm Ports: Add LLVM port 2021-06-10 20:21:08 +01:00
lua
lure Ports: Fix reinstalling the lure port 2021-08-14 20:28:55 +02:00
m4
make
mandoc
mawk Ports: Add awk symlink to mawk port 2021-08-12 18:56:30 +02:00
mbedtls Ports: Install mbedtls into the right directory and build shared libs 2021-05-28 16:40:02 +01:00
milkytracker
mpc Ports: Add MPC 2021-07-28 21:55:00 +02:00
mpfr Ports: Add MPFR 2021-07-28 21:55:00 +02:00
mrsh
mruby Ports: Add port for mruby 2021-08-25 02:22:01 +02:00
mysthous Ports: Fix reinstalling the mysthous port 2021-08-14 20:28:55 +02:00
nano Ports: Fix building the nano port 2021-08-14 12:40:49 +02:00
nasm
ncurses Ports: Compile ncurses as a shared library 2021-08-09 20:08:36 +02:00
neofetch Ports: Add a space to end of shell name in neofetch 2021-08-14 22:46:34 +04:30
nesalizer
nethack
ninja Ports: Remove obsolete patches for ninja 2021-07-04 00:35:35 +02:00
nippon Ports: Add ScummVM game Nippon Safes Inc 2021-07-22 22:30:55 +02:00
npth Ports: Build shared libraries for the GnuPG libraries 2021-05-19 22:45:02 +02:00
ntbtls Ports: Build shared libraries for the GnuPG libraries 2021-05-19 22:45:02 +02:00
nyancat Ports: Use "launcher_run_in_terminal=true" instead of "Terminal -e ..." 2021-07-20 00:58:26 +01:00
oksh
openssh Ports: Remove note about ssh needing port numbers explicitly specified 2021-06-16 10:38:12 +02:00
openssl Ports: Update OpenSSL to 1.1.1k 2021-07-30 20:49:56 +02:00
openttd Ports: Create launchers for the stpuzzles port 2021-06-04 09:38:25 +02:00
openttd-opengfx
openttd-opensfx
opentyrian Ports: Create launchers for the stpuzzles port 2021-06-04 09:38:25 +02:00
opentyrian-data Ports: Add opentyrian and opentyrian-data 2021-05-31 19:01:49 +01:00
p7zip Ports: Add p7zip 2021-06-04 08:21:33 +01:00
patch
pcre
pcre2
php Ports: Add PHP entry to taskbar menu 2021-08-04 13:54:08 +01:00
pkgconf Ports: Bump pkgconf from version 1.7.3 to 1.8.0 2021-08-02 00:35:35 +02:00
printf
pt2-clone
python3 Ports: Fix Python's expected SHA256 sum 2021-08-07 15:10:50 +01:00
quake
quake2
r0 Ports: Add r0 to AvailablePorts.md 2021-07-07 21:08:54 +02:00
radare2 Ports: Add radare2-5.4.0-git package 2021-07-08 14:34:08 +02:00
readline Ports: Use sha256 sig check for readline 2021-07-29 15:58:38 +02:00
rsync
sam Ports: Add sam 2021-06-06 00:17:37 +01:00
scummvm Ports: Use shared icon logic for ScummVM 2021-06-09 18:53:21 +02:00
SDL2
SDL2-GNUBoy
SDL2_gfx
SDL2_image
SDL2_mixer
SDL2_net Ports: Add port for SDL2_net 2021-06-16 20:08:13 +02:00
SDL2_ttf Ports: Specify missing library when linking SDL2_ttf 2021-06-05 10:56:37 +02:00
SDLPoP Ports: Create launchers for the stpuzzles port 2021-06-04 09:38:25 +02:00
sed
sfinx Ports: Add ScummVM game Sfinx 2021-07-22 22:30:55 +02:00
sl
soltys Ports: Add ScummVM game Soltys 2021-07-22 22:30:55 +02:00
sqlite Ports: Build an .so file for SQLite 2021-06-09 20:04:25 +02:00
stpuzzles Ports: Remove checksum for the stpuzzles port 2021-06-09 17:39:00 +04:30
stress-ng Ports/stress-ng: Remove custom pause function from patch 2021-08-13 07:54:26 +02:00
Super-Mario Ports: Embed icon into the Super Mario port 2021-06-04 09:38:25 +02:00
tcl
termcap
tinycc
tinyscheme
tr
vim Ports: Add missing dependency for vim 2021-05-11 13:13:08 +01:00
vitetris Ports: Use "launcher_run_in_terminal=true" instead of "Terminal -e ..." 2021-07-20 00:58:26 +01:00
vlang Ports: Bump vlang version to weekly.2021.31 2021-08-14 20:28:55 +02:00
vttest
wget Ports: Fix building the wget port 2021-08-14 12:40:49 +02:00
xz
yasm
zlib Ports: Force cross compiling for zlib 2021-07-29 15:58:38 +02:00
zsh Ports: Add ZSH port 2021-06-09 19:41:23 +01:00
zstd
.gitignore
.hosted_defs.sh
.port_include.sh Ports: Make the build step messages use ellipsis rather than excl. point 2021-08-15 14:50:39 +01:00
AvailablePorts.md Ports: Add port for mruby 2021-08-25 02:22:01 +02:00
build_all.sh
build_installed.sh
README.md Ports: Add overridable pre_fetch method in .port_include.sh 2021-07-22 22:30:55 +02: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.

--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:

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

Defaults to md5, most ports use sig though as .asc files are widely available.

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.

configscript

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

Defaults to configure.

depends

A space-separated list of other SerenityOS ports the port depends on and which will be installed during the installdepends step.

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:

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"

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: