use.conf / options.conf
This document applies only to clients using PaludisEnvironment
. Any standard client that supports a
--environment
command line option uses PaludisEnvironment
unless overridden, either by
explicitly selecting another environment (e.g. --environment portage
) or, on distributions also
supporting Portage, by lack of a Paludis configuration and presence of a Portage configuration.
On Gentoo and derived distributions, the use.conf
file controls which use flags are and are not enabled.
It is a standard configuration file which may be a bash file (use.bash
) and which may use the
use.conf.d/
directory.
On Exherbo, the options.conf
file controls which options are and are not enabled. It is a standard
configuration file which may be a bash file (options.bash
) and which may use the
options.conf.d/
directory.
Each line in the file consists of a specification followed by one or more use or option flags and labels. A specification may be any of:
- The special specification
*/*
, which matches all packages. Nearly all users will have at least one line using this specification. - A simple
category/package
name. - A simple
set
name. - A complex dependency specification.
Any token may be quoted using either single or double quotes.
A use flag or label can be:
flag
, which enables that flag.flag=value
, which enables that flag and sets its parameter value. Most flags do not use parameters, and so any parameter value specified is ignored. See theBUILD_OPTIONS: jobs
flag below for an example of one that does.-flag
, which disables that flag.label:
, which marks any subsequent flags on that line as applying to a particular use expand (Gentoo) or suboption (Exherbo) label. Common examples of use expand labels areVIDEO_CARDS
,LINGUAS
andINPUT_DEVICES
, as well as the specialBUILD_OPTIONS
label described below. Labels are not case sensitive.-*
, which disables all flags for the current label, or all flags that are not a label if there is no current label.
Flag settings are cumulative. This applies to expanded flags too, so if you do not wish to inherit, say,
default VIDEO_CARDS
from your profile, you will need to use */* VIDEO_CARDS: -* radeon
.
Special Flags
Paludis automatically adds special flags controlling how packages are built. These flags are all in the
BUILD_OPTIONS
group. Packages may have any of the following special flags:
- split
- If enabled, Paludis will split debugging information into
/usr/lib/debug
before merging binaries and libraries. - strip
- If enabled, Paludis will strip debugging information before merging binaries and libraries.
- recommended_tests
- If set, Paludis will run any 'recommended' tests provided by a package.
- optional_tests
- If set, Paludis will run any 'optional' tests provided by a package.
- expensive_tests
- If set, Paludis will run any 'expensive' tests provided by a package. This option should generally only be set by package maintainers, since tests marked as expensive are probably too painful in terms of CPU time or disk space requirements to run on user systems.
- trace
- If set, Paludis will ask bash to display extremely verbose information about what an ebuild or exheres is doing
(using
set -x
). Not generally a good idea, but can be handy to track down why an ebuild is misbehaving. - jobs
- If set to an unsigned integer, specifies the number of jobs to run in parallel when build systems
support this (e.g.
BUILD_OPTIONS: jobs=4
would implymake -j4
).
Note that these special flags are not use flags from an ebuild perspective. They are used only by Paludis internals, and are not exported to ebuilds.
Example
# Accept some basic defaults for all packages, inheriting defaults from profiles */* -doc -nls -apache2 bash-completion -gnome -kde mpd flac aac cdparanoia \ mmx mmxext rtc sse -arts -qt3 -cups real dvd threads dvdnav mp3 quicktime \ pnm real vidix a52 3dnow 3dnowext amr bidi bl cddb dts srt unicode xvmc # And set some USE_EXPAND defaults for all packages, explicitly overriding defaults # from profiles */* LINGUAS: -* en_GB en */* VIDEO_CARDS: -* nv nvidia */* ALSA_CARDS: -* emu10k1 # Some per package settings app-editors/vim -perl -python app-crypt/gnupg -X media-sound/lame -gtk # And some wildcarding dev-cpp/* doc # We like tests, and don't want debug symbols */* BUILD_OPTIONS: optional_tests -split strip # But we do want split debug symbols for a few packages dev-cpp/* BUILD_OPTIONS: split strip # We want to run four jobs in parallel if possible (Exheres format packages # only; Gentoo EAPIs use the MAKEOPTS environment variable instead) */* BUILD_OPTIONS: jobs=4