| .. | ||
| bash | ||
| bc | ||
| binutils | ||
| byacc | ||
| c-ray | ||
| curl | ||
| dash | ||
| diffutils | ||
| doom | ||
| dropbear | ||
| ed | ||
| editline | ||
| figlet | ||
| flex | ||
| frotz | ||
| gcc | ||
| git | ||
| gnuplot | ||
| grep | ||
| indent | ||
| jot | ||
| jq | ||
| klong | ||
| less | ||
| libarchive | ||
| libexpat | ||
| libffi | ||
| libiconv | ||
| libpuffy | ||
| links | ||
| lua | ||
| m4 | ||
| make | ||
| mandoc | ||
| mawk | ||
| mbedtls | ||
| mrsh | ||
| nano | ||
| nasm | ||
| ncurses | ||
| neofetch | ||
| nesalizer | ||
| ninja | ||
| nyancat | ||
| openssh | ||
| openssl | ||
| patch | ||
| pcre2 | ||
| pkgconf | ||
| printf | ||
| pt2-clone | ||
| python3 | ||
| quake | ||
| rsync | ||
| SDL2 | ||
| sed | ||
| sl | ||
| stress-ng | ||
| termcap | ||
| tinycc | ||
| tr | ||
| vim | ||
| vttest | ||
| zlib | ||
| zstd | ||
| .gitignore | ||
| .port_include.sh | ||
| AvailablePorts.md | ||
| build_all.sh | ||
| README.md | ||
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
Installed ports are being tracked in Ports/packages.db (a simple text file).
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.
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"
workdir="foo-${version}"
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 infilessha256: Use SHA256 hashes defined infilessha1: Use SHA1 hashes defined infilessig: Use PGP signatures (seeauth_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.
installopts
Options passed to make install in the default install function.
DESTDIR="$SERENITY_ROOT"/Build/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_ROOT/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:
post_fetchpre_configureconfigure.buildinstallpost_installcleanclean_distclean_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.shscript - 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:
- OS hacking: Porting the Bash shell (2019-05-20)
- OS hacking: Porting DOOM to Serenity (2019-09-09)
- OS hacking: Let's port git to SerenityOS! (2020-02-19)
- OS hacking: Fixing a resize bug with the vim port (2020-06-03)