Jump to content

# Nonfree applications package guidelines

2 languages

- 日本語
- Português

From ArchWiki

This article or section needs expansion.

Reason: cover about encrypting archives, symlinking etc. (Discuss in Talk:Nonfree applications package guidelines)

For many applications (most of which are Windows ones) there are neither sources nor tarballs available. Many of such applications can not be freely distributed because of license restrictions and/or lack of legal ways to obtain installer for no fee.

Note: All information here is package-agnostic, for information specific to the most typical nonfree software see Wine PKGBUILD guidelines.

## Rationale

There are multiple reasons for packaging even non-packageable software:

- Simplification of installation/removal process

  This is applicable even to the simplest of applications, which consist of a single script to be installed into `/usr/bin`. Instead of issuing:

      $ chmod +x filename
      $ chown root:root filename
      # cp filename /usr/bin/

  you can just issue

      $ makepkg -i

  Most non-free applications are obviously much more complicated, but the burden of downloading an archive/installer from a homepage (often full of advertising), unpacking/decrypting it, hand-writing stereotypical launcher scripts and doing other similar tasks can be effectively lightened by a well-written packaging script.

- Utilizing pacman capabilities

  The ability to track state, perform automatic updates of any installed piece of software, determine ownership of every single file, and store compressed packages in a well-organized cache is what makes GNU/Linux distributions so powerful.

- Sharing code and knowledge

  It is simpler to apply tweaks, fix bugs and seek/provide help in a single public place like the AUR versus submitting patches to proprietary developers who may have ceased support or asking vague questions on general purpose forums.

## Common rules

### Avoid nonfree software when possible

Yes, it is better to leave this guide and spend some time searching (or maybe even creating) alternatives to an application you wanted to package because:

- It is better to support software that is owned by us all than software that is owned by a company
- It is better to support software that is actively maintained
- It is better to support software that can be fixed if just one person out of millions cares enough

### Use open source variants where possible

Many commercial games (some are listed in this Wiki) have open source engines and many old games can be played with emulators such as ScummVM. Using open source engines together with the original game assets gives users access to bug fixes and eliminates several issues caused by binary packages.

### Keep it simple

If the packaging of some program requires more effort and hacks than buying and using the original version, do the simplest thing—it is Arch!

## Package naming

Before naming a package, search the AUR for existing packages of software that you are packaging. Try to use established naming conventions, e.g. do not name your package gish-hb if there are existing packages called aquaria-hib, crayonphysicsdeluxe-hib and uplink-hib. If you are certain there will never be a source-based package, you can omit the suffix `-bin`. Otherwise, always use this suffix. A user submitting a source-based package of the software would have to ask the maintainer of your package (or, in the worst case, a Package maintainer) to orphan the existing package so that their source-based package could be submitted, and both the original binary package and the new source-based package would end up having their respective PKGBUILDs cluttered with additional `replaces` and `conflicts` entries.

## File placement

Again, analyze existing packages (if present) and decide whether or not you want to conflict with them. Do not place things under `/opt` unless you want to use some ugly hacks like giving ownership `root:games` to the package directory (so users in group `games` running the game can write files in the game's own folder).

## Missing files

For most commercial games there is no way to (legally) download game files, which is the preferable way to get them for normal packages. Even when it is possible to download files after providing a password (like with all Humble Indie Bundle games) asking user for this password and downloading somewhere in `build` function is not recommended for a variety of reasons (for example, the user may have no Internet access but have all files downloaded and stored locally).

The subsections below provide recommendations for a few situations you may encounter.

### Files can only be obtained in a distributed archive/installer

The software is only available via that archive/installer file, which must be obtained in order to get the missing files.

Add the required archive/installer to the `source` array, renaming the source filename so the source's link in the AUR web interface looks different from names of files included in the source tarball:

    sources=(... "originalname::local://originalname")

Also add a pinned comment like the one below to the package page in the AUR, and explain the details in the PKGBUILD:

    Need archive/installer to work.

#### Scheme to choose

In case you use the local:// scheme in a source array, makepkg behaves as though no scheme were specified, and the file must be manually placed in the same directory as the PKGBUILD.

In case you use the file:// scheme, you can additionally specify DLAGENTS for the file protocol, so it may be obtained in a special way. See examples below.

However, there are still no clear rules which of these schemes you should use.

### Files can only be obtained in an distributed compact-disk or other type of optical disk media

The software is only available via an optical disk media (e.g. CD, DVD, Bluray etc.), which must be inserted into the optical disk drive in order get the missing files.

Add an installer script and an `.install` file to the package contents.

### Files can be obtained from several ways

Copying files from disk, downloading from Net or getting from archive during the `build` phase may look like a good idea but it is not recommended because it limits the user's possibilities and makes package installation interactive (which is generally discouraged and just annoying). Again, a good installer script and `.install` file can work instead.

Few examples of various strategies for obtaining files required for package:

- worldofgooAUR – dependency on user-provided file

This article or section needs expansion.

Reason: This page used to link to umineko-en and ut2004-anthology as examples, but they have been removed since they are no longer on the AUR, different examples should be provided. (Discuss in Talk:Nonfree applications package guidelines)

## Advanced topics

### Custom DLAGENTS

Some software authors aggressively protect their software from automatic downloading: ban certain "User-Agent" strings, create temporary links to files etc. You can still conveniently download these files by using `DLAGENTS` variable in the PKGBUILD (see makepkg.conf(5)). This is used by some packages in official repositories, for example in previous version of ttf-baekmuk.

Please pay attention, if you want to have a customized user-agent string, if the latter contains spaces, parentheses, or slashes in it (or actually anything that can break parsing), this will not work. There is no workaround, this is the nature of arrays in bash and the way DLAGENTS was designed to be consumed in makepkg. The following example will thus not work:

    DLAGENTS=("http::/usr/bin/curl -A 'Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1)' -fLC - --retry 3 --retry-delay 3 -o %o %u")

Shorten it to the following which is working:

    DLAGENTS=("http::/usr/bin/curl -A 'Mozilla' -fLC - --retry 3 --retry-delay 3 -o %o %u")

And the following allows to extract temporary link to file from download page:

    DLAGENTS=("http::/usr/bin/wget -r -np -nd -H %u")

In order to download temporary links to files or get past an interactive download, it is possible to analyze the HTTP request used to create the final download link, and then create a DLAGENTS that emulates this using curl. See for example decklink-sdkAUR or jlink-software-and-documentationAUR.

Alternatively, the DLAGENTS can be used to provide a more informative error message to the user when a file is missing. See for example ttf-ms-win10AUR.

### Unpacking

Many proprietary programs are shipped in nasty installers which sometimes do not even run in Wine. The following tools may be of some help:

- libarchive contains bsdtar, which can extract `.iso` images. It also provides bsdunzip which can be used in place of unzip. `bsdunzip -O` is used for non-UTF-8 zip files.
  - libarchive is required by pacman and so it is part of a base install.
- `.AppImage` files can be extracted by launching them with the `--appimage-extract` flag.
- unzip and unrar unpack executable SFX archives, based on these formats
- cabextract can unpack most `.cab` files (including ones with `.exe` extension)
- unshield can extract CAB files from InstallShield installers
- 7zip unpacks not only many archive formats but also NSIS-based `.exe` installers
  - it even can extract single sections from common PE (`.exe` & `.dll`) files!
- upx is sometimes used to compress above-listed executables and can be used for decompressing them as well
- innoextract can unpack `.exe` installers created with Inno Setup (used for example by GOG.com games)

In order to determine exact type of file run `file file_of_unknown_type`.

### Getting icons for .desktop files

Proprietary software often have no separate icon files, so there is nothing to use in .desktop file creation. Fortunately, `.ico` files can be easily extracted from executables using programs from the icoutils package. You can even do it on the fly during the `build` phase, for example:

    $ wrestool -x --output=icon.ico -t14 executable.exe

### Auto-bumping your pkgver

Non-free software vendors often don’t include a version number in their download source URL:

    source=('https://downloads.example.com/NonFreePackageWithPoorFileName.exe')

That will likely cause the release upstream package to change without notice, which is an issue for packaging. Just like in VCS packages, you may want to auto-bump your `pkgver` to handle that.

#### From the installer package

For example, some .exe installers have the Product Version field set in their PE. The `peres` command from the pevAUR package may help you extract and use that value to auto-bump your `pkgver`:

    pkgver=VERSION
    makedepends=('pev')

    pkgver() {
      peres -v -f csv "${srcdir}/NonFreePackageWithPoorFileName.exe" \
        | awk -F , '/^Product Version,/ { print $2 }'
    }

#### From the main executable

Sometimes the .exe installer doesn’t carry a meaningful value for Product Version but the main executable does. In that case, you can use the `prepare` step to extract the nested main executable (see Unpacking for details) and then auto-bump the `pkgver`:

For example:

    pkgver=VERSION
    makedepends=('p7zip' 'pev')

    prepare() {
      mkdir -p "${srcdir}/${pkgname}-unpacked"
      7z x -o"${srcdir}/${pkgname}-unpacked" "${srcdir}/NonFreePackageWithPoorFileName.exe"
    }

    pkgver() {
      peres -v -f csv "${srcdir}/${pkgname}-unpacked/NonFreeApp.exe" \
        | awk -F , '/^Product Version,/ { print $2 }'
    }

#### From a Debian (.deb) file

Sometimes a .deb file doesn’t have a version number in its name but in its control file.

You can use `dpkg-deb` to extract the version directly from the control file inside the .deb package:

    pkgver=VERSION
    makedepends=('dpkg')
    source=('https://example.com/vendor/nonfree-app-latest.deb')

    pkgver() {
      # shellcheck disable=SC2016
      dpkg-deb --show --showformat='${Version}' nonfree-app-latest.deb | tr - .
    }

### Replacing bundled runtimes

This article or section is being considered for removal.

Reason: The guidelines are aimed to be general, and replacing runtimes is a highly specific use-case (Only steam-native-runtime in the official repositories do it). More importantly, it will invalidate any support provided by upstream who bundled the package (Discuss in Talk:Nonfree applications package guidelines)
Note: This topic may conflict with KISS’s goals. Consider the trade-offs, and avoid overdoing it.

The factual accuracy of this article or section is disputed.

Reason: This section needs to cover ABI compability, ldd, and abi-compliance-checker. (Discuss in Talk:Nonfree applications package guidelines)

Some non-free applications bundle pre-built open source runtimes. However, there are advantages in replacing them.

You can use `pacman -F` to look for packages that provide the corresponding unbundled runtime. To replace the bundled libraries, try replacing them with symbolic links or just removing them from your package.

#### Security considerations

Vendored runtimes are sometimes built with insecure flags such as No RELRO. If your package must use vendored libraries or executables, consider scanning them for insecure RPATH entries. To remove insecure entries, use `patchelf --remove-rpath /path/to/binary`.

#### Plugin interoperability

Some non-free Qt applications lack important plugins such as qt5-wayland or fcitx5-qt. To make an application work with those system-provided packages, you might want to remove its bundled Qt runtime altogether, because mixing different Qt versions is impossible.

Category:

- Arch package guidelines

Hidden categories:

- Pages or sections flagged with Template:Expansion
- Sections flagged with Template:Remove
- Pages or sections flagged with Template:Accuracy