build_multilib_wine.conf(5) : man page

build_multilib_wine.conf(5)

Custom settings for controlling the build_multilib_wine script

Synopsis

${HOME}/.config/build_multilib_wine/build_multilib_wine.conf

Description

This file contains various variables that are used, by the build_multilib_wine script, to change the default settings for any operation. The file has a newline-delimited list of <key>=<value> pairs.

To generate a basic: ${HOME}/.config/build_multilib_wine/build_multilib_wine.conf file, with defaults indicated (commented out), use:

build_multilib_wine generate_conf

which will write a generic version of the (above) file.

Note: the build_multilib_wine script will pre-parse the build_multilib_wine.conf testing that all variables are defined correctly (via various regex tests, etc.).
build_multilib_wine will check for settings/value overrides in the following order of precedence:

1. env variables,
2. build_multilib_wine.conf configuration,
3. build_multilib_wine command-line options,

where: 1. = lowest priority ... 3. = highest priority.

Variables

• BUILD_ROOT=directory
  Root directory where the binary builds are stored - "out-of-tree" build. By default, log files are stored in a subdirectory of the BUILD_ROOT directory.
  Defaults to: BUILD_ROOT="${HOME}/Wine/Build"

• COLOUR=[ "yes" | "no" | "1" | "0" | "true" | "false" ]
  Select whether to colourise, or not, all terminal and log output.
  Defaults to: COLOUR="false"

• LOG_COMPRESSION=[ "zip2" | "gzip" | "lzma" | "lzop" | "none" | "lz4" | "xz" ]
  Compression to be applied to new log files. Log files are only compressed, when the script is exiting. Supported compression algorithms are listed above.
  Defaults to: LOG_COMPRESSION="xz"

• LOG_DIRECTORY=directory
  Directory, in which to store log files. The log files record all script output.
  Defaults to: LOG_DIRECTORY="${HOME}/Wine/Build/Logs"

• LOGGING=[ "yes" | "no" | "1" | "0" | "true" | "false" ]
  Enable or disable logging, of all script output. Only applies to build and chroot commands.
  Defaults to: LOGGING="true"

• LSB_CODENAME="LSB codename"
  OS release override (e.g. cross-building for another Debian / Ubuntu version).
  Defaults to: LSB_CODENAME="$(lsb_release -sc)"

• PREFIX=directory
  Installation prefix directory in which Wine libraries, binaries, etc. are installed.
  Defaults to: PREFIX="${HOME}/usr"

• SOURCE_ROOT=directory
  Root directory where sources are stored i.e. clones of Wine (and Wine-Staging) Git trees.
  Defaults to: SOURCE_ROOT="${HOME}/Wine/Source"

• THREADS=CPU thread count
  Number of processor threads to use, when compiling. Use d by WINE_MAKE_OPTIONS.
  Defaults to: THREADS=hardware CPU threads+1

• USER_PATCH_DIRECTORIES=( directory(0) [ ... directory(N) ] )
  Array of one (or more) directories containing "non-official" user patch files.
  Additional array entries can be added using:
  USER_PATCH_DIRECTORIES+=( directory(N+1) [ ... directory(M) ] )
  Note: patches must formatted in a -p1 diff format).
  Defaults to: USER_PATCH_DIRECTORIES=none

• WINE_ADDON_GLOBAL=[ "yes" | "no" | "1" | "0" | "true" | "false" ]
  Specifies where the wine-addons: wine-gecko , wine-mono ; will be installed to:

  • WINE_ADDON_GLOBAL=1 : install addons relative to the user's HOME directory

    "${HOME}${WINE_ADDON_GLOBAL_RELPATH}"

  • WINE_ADDON_GLOBAL=0 : install addons relative to the Wine installation path

    "${PREFIX}/${WINE_ADDON_RELPATH}"

  Using: WINE_ADDON_GLOBAL=1 ; allows wine-addons to be shared between different Wine installations.
  Defaults to: WINE_ADDON_GLOBAL="${WINE_ADDON_GLOBAL}"

• WINE_ADDON_GLOBAL_RELPATH=relative directory path
  Specifies the install path for wine-addons: wine-gecko , wine-mono ; activated with: WINE_ADDON_GLOBAL=1.
  WINE_ADDON_GLOBAL_RELPATH specifies a path relative to: "${HOME}".
  It is not recommended to change this variable, as Wine has fixed paths, which are searched for addons.
  Defaults to: WINE_ADDON_GLOBAL_RELPATH="${WINE_ADDON_GLOBAL_RELPATH}"

• WINE_ADDON_RELPATH=relative directory path
  Specifies the install path for wine-addons: wine-gecko , wine-mono ; activated with: WINE_ADDON_GLOBAL=0.
  WINE_ADDON_RELPATH specifies a path relative to: "${PREFIX}".
  It is not recommended to change this variable, as Wine has fixed paths, which are searched for addons.
  Defaults to: WINE_ADDON_RELPATH="${WINE_ADDON_RELPATH}"

• WINE_BRANCH=git-branch
  Wine git branch to build against. This variable applies only during build commands.
  Requires that the Wine Staging patchset is disabled, for the current Wine build:

  • WINE_STAGING="false" (configuration option)
  • --wine-staging="false" (build option, command line argument)

  Defaults to: WINE_BRANCH=none

• WINE_CFLAGS=CFLAGS argument (configure script)
  CFLAGS ('C' compiler flags) to pass to Wine configure script. [src-configure]
  Defaults to: WINE_CFLAGS="-march=native -mtune=native"

• WINE_COMMIT=git-commit
  Wine git commit to build against. This variable applies only during build commands.
  Requires that the Wine Staging patchset is disabled, for the current Wine build:

  • WINE_STAGING="false" (configuration option)
  • --wine-staging="false" (build option, command line argument)

  Defaults to: WINE_COMMIT=none

• WINE_CONFIGURATION="configure options"
  Specify options to pass to the Wine configuration phase. [src-configure]
  Defaults to: WINE_CONFIGURATION="--without-hal --without-v4l --without-oss"

• WINE_MAKE_OPTIONS=arguments to make command
  Make options to pass to the make command, when compiling wine. [src-compile]
  Defaults to: WINE_MAKE_OPTIONS="-j$((THREADS+1))"

• WINE_STAGING=[ "yes" | "no" | "1" | "0" | "true" | "false" ]
  A build phase (only) option that specifies whether we wish to apply (or not) the Wine Staging patchsets.
  The default is to apply all the Wine Staging patchsets, with some (optional) Wine Staging patchset exclusions specified by:
  WINE_STAGING_EXCLUDE=... (see below, for more information about this option)
  Defaults to: WINE_STAGING="0"

• WINE_STAGING_BRANCH=git-branch
  Wine-Staging git branch to build against. This variable applies only during build commands.
  Requires that the Wine Staging patchset is enabled, for the current Wine build:

  • WINE_STAGING="true" (configuration option)
  • --wine-staging="true" (build option, command line argument)

  Defaults to: WINE_STAGING_BRANCH=none

• WINE_STAGING_COMMIT=git-commit
  Wine-Staging git commit to build against. This variable applies only during build commands.
  Requires that the Wine Staging patchset is enabled, for the current Wine build:

  • WINE_STAGING="true" (configuration option)
  • --wine-staging="true" (build option, command line argument)

  Defaults to: WINE_STAGING_COMMIT=none

• WINE_STAGING_EXCLUDE=patchset(1) [ ... patchset(N) ]
  Name(s) of specific Wine-Staging patchset(s), to optionally disable. [src-prepare]
  Defaults to: WINE_STAGING_EXCLUDE="configure-OSMesa winhlp32-Flex_Workaround"

• WINE_STAGING_VERSION=numeric-version
  Wine-Staging version to build. Specified as a wine-staging release version (without the git tag prefix).
  This variable applies only during build commands.
  Requires that the Wine Staging patchset is enabled, for the current Wine build:

  • WINE_STAGING="true" (configuration option)
  • --wine-staging="true" (build option, command line argument)

  Defaults to: WINE_STAGING_VERSION=none

• WINE_VERSION=numeric-version
  Wine version to build. Specified as a wine release version (without the git tag prefix).
  This variable applies only during build commands.
  Requires that the Wine Staging patchset is disabled, for the current Wine build:

  • WINE_STAGING="false" (configuration option)
  • --wine-staging="false" (build option, command line argument)

  Defaults to: WINE_VERSION=none

• WORKING_PATCHES_DIRECTORY=directory
  Directory to store additional stock Wine patches.
  Defaults to: WORKING_PATCHES_DIRECTORY="${HOME}/Wine/Source/patches"

Reporting Bugs

Please report issues at: Github: bobwya/build-multilib-wine Issues

Authors

Written by Robert Walker <bob.mt.wya@gmail.com>

Files

• ${HOME}/.config/build_multilib_wine/build_multilib_wine.conf

  Contains variables for controlling the operation of the build_multilib_wine script.

See Also

build_multilib_wine(1).