1 .TH "PORTAGE" "5" "Dec 2013" "Portage VERSION" "Portage"
3 portage \- the heart of Gentoo
5 The current portage code uses many different configuration files, most of which
6 are unknown to users and normal developers. Here we will try to collect all
7 the odds and ends so as to help users more effectively utilize portage. This
8 is a reference only for files which do not already have a man page.
10 All files in the make.profile directory may be tweaked via parent profiles
11 when using cascading profiles. For more info, please see
12 http://www.gentoo.org/proj/en/releng/docs/cascading-profiles.xml
14 If you are looking for information on how to emerge something, please see
18 \fB/etc/portage/make.profile/\fR or \fB/etc/make.profile/\fR
19 site\-specific overrides go in \fB/etc/portage/profile/\fR
26 package.accept_keywords
34 package.use.stable.force
35 package.use.stable.mask
54 package.accept_keywords
55 package.accept_restrict
67 package-specific bashrc files
69 .BR /etc/portage/profile/
70 site-specific overrides of \fB/etc/portage/make.profile/\fR
72 .BR /etc/portage/sets/
73 user\-defined package sets
75 .BR /usr/portage/metadata/
80 .BR /usr/portage/profiles/
93 package.use.stable.force
94 package.use.stable.mask
106 .BR /usr/share/portage/config/
113 misc internal cache files
116 database to track installed packages
118 .BR /var/lib/portage/
125 In the following sections, some terminology may be foreign to you or used
126 with meaning specific to Portage. Please see the referenced manpages for
127 more detailed explanations.
131 An atom is either of the form category/package or consists of an operator
132 followed by category/package followed by a hyphen and a version specification.
133 An atom might be suffixed by a slot specification.
138 .B Extended Atom Syntax
140 The following atom syntax extensions are only supported in user
141 configuration files and command line arguments for programs such as
145 .B Repository Constraints
146 Atoms with repository constraints have a '::' separator appended to the
147 right side, followed by a repository name. Each repository name should
148 correspond to the value of a \fBrepo_name\fR entry from one of the
149 repositories that is configured via the \fBPORTDIR\fR or
150 \fBPORTDIR_OVERLAY\fR variables (see \fBmake.conf\fR(5)).
154 # match sed from the 'gentoo' repository
155 sys\-apps/sed::gentoo
156 # match kdelibs from the 'kde\-testing' repository
157 kde\-base/kdelibs::kde\-testing
158 # match empathy from the 'gnome' repository
159 net\-im/empathy::gnome
163 Atoms containing wildcard patterns are of the form category/package, where
164 the special '*' wildcard character substitutes for an arbitrary number
165 of normal characters. More than one '*' character is allowed, but not two
170 # match anything with a version containing 9999, which can be used in
171 # package.mask to prevent emerge --autounmask from selecting live ebuilds
173 # match anything with a version containing _beta
175 # match anything from the 'sys\-apps' category
177 # match packages named 'zlib' from any category
179 # match any package from a category that begins with 'net\-'
181 # match any package name from any category
183 # match any package from the 'gentoo' repository
189 Each architecture has a unique KEYWORD.
195 A DEPEND atom that is part of the "virtual" category. They are used
196 when different packages can satisfy a dependency and only one of them is
202 .SH "SPECIFIC FILE DESCRIPTIONS"
204 \fB/etc/portage/make.profile/\fR or \fB/etc/make.profile/\fR
205 This is usually just a symlink to the correct profile in
206 \fB/usr/portage/profiles/\fR. Since it is part of the portage tree, it
207 may easily be updated/regenerated by running `emerge \-\-sync`. It defines
208 what a profile is (usually arch specific stuff). If you need a custom
209 profile, then you should make your own \fBmake.profile\fR
210 directory and populate it. However, if you just wish to override some
211 settings, use \fB/etc/portage/profile/\fR (it supports all of the same file
212 types that \fBmake.profile\fR does, except parent). Do NOT edit the
213 settings in \fBmake.profile\fR because they WILL be lost with the next
214 `emerge \-\-sync`. If both \fB/etc/portage/make.profile/\fR and
215 \fB/etc/make.profile/\fR exist, then \fB/etc/portage/make.profile/\fR
218 Any file in this directory, directories of other profiles or top-level
219 "profiles" directory that begins with "package." or "use." can be more than
220 just a flat file. If it is a directory, then all the files in that directory
221 will be sorted in ascending alphabetical order by file name and summed together
222 as if it were a single file. Note that this behavior is only supported since
223 portage-2.1.6.7, and it is not included in PMS at this time.
227 ${PORTDIR}/profiles/package.mask/removals
228 ${PORTDIR}/profiles/package.mask/testing
233 The existence of this file marks a profile as deprecated, meaning it is
234 not supported by Gentoo anymore. The first line must be the profile to which
235 users are encouraged to upgrade, optionally followed by some instructions
236 explaining how they can upgrade.
240 default-linux/x86/2005.0
241 # emerge -n '>=sys-apps/portage-2.0.51'
242 # rm -f /etc/portage/make.profile
243 # ln -s /usr/portage/profiles/default-linux/alpha/2005.0 \
244 /etc/portage/make.profile
248 The first line of this file specifies the \fBEAPI\fR to which files in the
249 same directory conform. See \fBebuild\fR(5) for information about \fBEAPI\fR
250 and related features. Beginning with \fBEAPI 5\fR, new USE
251 configuration files are supported: use.stable.mask,
252 use.stable.force, package.use.stable.mask and
253 package.use.stable.force. These files behave similarly to
254 previously supported USE configuration files, except that they
255 only influence packages that are merged due to a stable keyword.
258 The profile default settings for Portage. The general format is described
259 in \fBmake.conf\fR(5). The \fImake.defaults\fR for your profile defines a
260 few specific variables too:
266 Architecture type (x86/ppc/hppa/etc...).
268 \fBIUSE_IMPLICIT\fR = \fI[space delimited list of USE flags]\fR
269 Defines implicit \fBIUSE\fR for ebuilds using \fBEAPI 5\fR or
270 later. Flags that come from \fBUSE_EXPAND\fR or
271 \fBUSE_EXPAND_UNPREFIXED\fR variables do not belong in
272 \fBIUSE_IMPLICIT\fR, since \fBUSE_EXPAND_VALUES_*\fR variables
273 are used to define implicit \fBIUSE\fR for those flags. See
274 \fBebuild\fR(5) for more information about \fBIUSE\fR.
276 .B USERLAND = \fI"GNU"\fR
277 Support BSD/cygwin/etc...
279 \fBUSE_EXPAND\fR = \fI[space delimited list of variable names]\fR
280 Any variable listed here will be used to augment USE by inserting a new flag
281 for every value in that variable, so USE_EXPAND="FOO" and FOO="bar bla" results
282 in USE="foo_bar foo_bla".
284 \fBUSE_EXPAND_HIDDEN\fR = \fI[space delimited list of variable names]\fR
285 Names of \fBUSE_EXPAND\fR variables that should not be shown in the verbose
286 merge list output of the \fBemerge\fR(1) command.
288 \fBUSE_EXPAND_IMPLICIT\fR = \fI[space delimited list of variable names]\fR
289 Defines \fBUSE_EXPAND\fR and \fBUSE_EXPAND_UNPREFIXED\fR
290 variables for which the corresponding USE flags may have
291 implicit \fBIUSE\fR for ebuilds using \fBEAPI 5\fR or later.
293 \fBUSE_EXPAND_UNPREFIXED\fR = \fI[space delimited list of variable names]\fR
294 Any variable listed here will be used to augment USE by
295 inserting a new flag for every value in that variable, so
296 USE_EXPAND_UNPREFIXED="FOO" and FOO="bar bla" results in
299 \fBUSE_EXPAND_VALUES_ARCH\fR = \fI[space delimited list of ARCH values]\fR
300 Defines ARCH values used to generate implicit
301 \fBIUSE\fR for ebuilds using \fBEAPI 5\fR or later.
303 \fBUSE_EXPAND_VALUES_ELIBC\fR = \fI[space delimited list of ELIBC values]\fR
304 Defines ELIBC values used to generate implicit
305 \fBIUSE\fR for ebuilds using \fBEAPI 5\fR or later.
307 \fBUSE_EXPAND_VALUES_KERNEL\fR = \fI[space delimited list of KERNEL values]\fR
308 Defines KERNEL values used to generate implicit
309 \fBIUSE\fR for ebuilds using \fBEAPI 5\fR or later.
311 \fBUSE_EXPAND_VALUES_USERLAND\fR = \fI[space delimited list of USERLAND \
313 Defines USERLAND values used to generate implicit
314 \fBIUSE\fR for ebuilds using \fBEAPI 5\fR or later.
316 .B ELIBC = \fI"glibc"\fR
317 Support uClibc/BSD libc/etc...
319 .B PROFILE_ONLY_VARIABLES = \fI"ARCH"\fR
320 Prevent critical variables from being changed by the user in make.conf
324 Distinguish machines classes that have the same \fBARCH\fR. All sparc
325 machines have ARCH=sparc but set this to either 'sparc32' or 'sparc64'.
328 Special USE flags which may be needed when bootstrapping from stage1 to stage2.
333 Provides the list of packages that compose the special \fIsystem\fR set.
337 \- comments begin with # (no inline comments)
338 \- one DEPEND atom per line
339 \- packages to be added to the system set begin with a *
340 \- atoms without * only appear for legacy reasons
343 In a cascading profile setup, you can remove packages in children
344 profiles which were added by parent profiles by prefixing the atom with
350 # pull in a version of glibc less than 2.3
351 *<sys\-libs/glibc\-2.3
352 # pull in any version of bash
354 # pull in a version of readline earlier than 4.2
355 *<sys\-libs/readline\-4.2
359 A list of packages (one per line) that make up a stage1 tarball. Really only
360 useful for stage builders.
363 A list of packages (one per line) that portage should assume have been
364 provided. Useful for porting to non-Linux systems. Basically, it's a
365 list that replaces the \fBemerge \-\-inject\fR syntax.
367 For example, if you manage your own copy of a 2.6 kernel, then you can
368 tell portage that 'sys-kernel/development-sources-2.6.7' is already taken
369 care of and it should get off your back about it.
371 Portage will not attempt to update a package that is listed here unless
372 another package explicitly requires a version that is newer than what
373 has been listed. Dependencies that are satisfied by package.provided
374 entries may cause installed packages satisfying equivalent dependencies
375 to be removed by \fBemerge\fR(1) \fB\-\-depclean\fR actions (see the
376 \fBACTIONS\fR section of the \fBemerge\fR(1) man page for more information).
378 Virtual packages (virtual/*) should not be specified in package.provided,
379 since virtual packages themselves do not provide any files, and
380 package.provided is intended to represent packages that do provide files.
381 Depending on the type of virtual, it may be necessary to add an entry to the
382 virtuals file and/or add a package that satisfies a virtual to
387 \- comments begin with # (no inline comments)
388 \- one DEPEND atom per line
389 \- relational operators are not allowed
390 \- must include a version
395 # you take care of the kernel
396 sys-kernel/development-sources-2.6.7
398 # you installed your own special copy of QT
401 # you have modular X but packages want monolithic
402 x11-base/xorg-x11-6.8
405 \fBpackage.use.force\fR and \fBpackage.use.stable.force\fR
406 Per\-package USE flag forcing.
409 In a cascading profile setup, you can remove USE flags in children
410 profiles which were added by parent profiles by prefixing the flag with
415 \- comments begin with # (no inline comments)
416 \- one DEPEND atom per line with space-delimited USE flags
421 # force docs for GTK 2.x
422 =x11\-libs/gtk+\-2* doc
423 # unforce mysql support for QT
427 \fBpackage.use.mask\fR and \fBpackage.use.stable.mask\fR
428 Per\-package USE flag masks.
431 In a cascading profile setup, you can remove USE flags in children
432 profiles which were added by parent profiles by prefixing the flag with
437 \- comments begin with # (no inline comments)
438 \- one DEPEND atom per line with space-delimited USE flags
443 # mask docs for GTK 2.x
444 =x11\-libs/gtk+\-2* doc
445 # unmask mysql support for QT
450 This contains paths to the parent profiles (one per line). They may be either
451 relative (to the location of the profile) or absolute. Most commonly this file
452 contains '..' to indicate the directory above. Utilized only in cascading
455 When multiple parent profiles are specified, they are inherited in order from
456 the first line to the last.
458 If \fBlayout.conf\fR is new enough, you can also use the <repo>:<path>
459 syntax. The <repo> is the same string as is stored in the \fBrepo_name\fR
460 file (or omitted to refer to the current repo), and <path> is a subdir starting
464 If needed, this file can be used to set up a special environment for ebuilds,
465 different from the standard root environment. The syntax is the same as for
466 any other bash script.
468 \fBuse.force\fR and \fBuse.stable.force\fR
469 Some USE flags don't make sense to disable under certain conditions. Here we
473 In a cascading profile setup, you can remove USE flags in children
474 profiles which were added by parent profiles by prefixing the flag with
479 \- comments begin with # (no inline comments)
480 \- one USE flag per line
483 \fBuse.mask\fR and \fBuse.stable.mask\fR
484 Some USE flags don't make sense on some archs (for example altivec on
485 non\-ppc or mmx on non\-x86), or haven't yet been tested. Here we list
489 In a cascading profile setup, you can remove USE flags in children
490 profiles which were added by parent profiles by prefixing the flag with
495 \- comments begin with # (no inline comments)
496 \- one USE flag per line
508 The virtuals file controls default preferences for virtuals that
509 are defined via the \fBPROVIDE\fR ebuild variable (see
510 \fBebuild\fR(5)). Since Gentoo now uses \fBGLEP 37\fR virtuals
511 instead of \fBPROVIDE\fR virtuals, the virtuals file is
512 irrelevant for all Gentoo ebuilds. However, it is still possible
513 for third\-parties to distribute ebuilds that make use of
518 \- comments begin with # (no inline comments)
519 \- one virtual and DEPEND atom base pair per line
524 # use net\-mail/ssmtp as the default mta
525 virtual/mta net\-mail/ssmtp
526 # use app\-dicts/aspell\-en as the default dictionary
527 virtual/aspell\-dict app\-dicts/aspell\-en
532 Any file in this directory that begins with "package." or is repos.conf can be
533 more than just a flat file. If it is a directory, then all the files in that
534 directory will be sorted in ascending alphabetical order by file name and summed
535 together as if it were a single file.
539 /etc/portage/package.accept_keywords/common
540 /etc/portage/package.accept_keywords/e17
541 /etc/portage/package.accept_keywords/kde
546 If needed, this file can be used to set up a special environment for ebuilds,
547 different from the standard root environment. The syntax is the same as for
548 any other bash script.
550 Additional package-specific bashrc files can be created in /etc/portage/env.
553 A simple list of valid categories that may be used in /usr/portage,
554 PORTDIR_OVERLAY, and PKGDIR (see \fBmake.conf\fR(5)). This allows for custom
555 categories to be created.
559 \- one category per line
569 Contains variables customizing colors. See \fBcolor.map\fR(5).
572 The global custom settings for Portage. See \fBmake.conf\fR(5).
575 Whenever portage encounters a mirror:// style URI it will look up the actual
576 hosts here. If the mirror set is not found here, it will check the global
577 mirrors file at /usr/portage/profiles/thirdpartymirrors. You may also set a
578 special mirror type called "local". This list of mirrors will be checked
579 before GENTOO_MIRRORS and will be used even if the package has
580 RESTRICT="mirror" or RESTRICT="fetch".
584 \- comments begin with # (no inline comments)
585 \- mirror type followed by a list of hosts
590 # local private mirrors used only by my company
591 local ftp://192.168.0.3/mirrors/gentoo http://192.168.0.4/distfiles
593 # people in japan would want to use the japanese mirror first
594 sourceforge http://keihanna.dl.sourceforge.net/sourceforge
596 # people in tawain would want to use the local gnu mirror first
597 gnu ftp://ftp.nctu.edu.tw/UNIX/gnu/
601 This file can be used to override the metadata cache implementation. In
602 practice, portdbapi.auxdbmodule is the only variable that the user will want to
607 portdbapi.auxdbmodule = portage.cache.sqlite.database
610 After changing the portdbapi.auxdbmodule setting, it may be necessary to
611 transfer or regenerate metadata cache. Users of the rsync tree need to
612 run `emerge \-\-metadata` if they have enabled FEATURES="metadata-transfer"
613 in \fBmake.conf\fR(5). In order to regenerate metadata for repositories
614 listed in \fBPORTDIR_OVERLAY\fR or a cvs tree, run `emerge \-\-regen`
615 (see \fBemerge\fR(1)). If you use something like the sqlite module and want
616 to keep all metadata in that format alone (useful for querying), enable
617 FEATURES="metadata-transfer" in \fBmake.conf\fR(5).
619 \fBpackage.accept_keywords\fR and \fBpackage.keywords\fR
620 Per\-package ACCEPT_KEYWORDS. Useful for mixing unstable packages in with a
621 normally stable system or vice versa. This will allow ACCEPT_KEYWORDS to be
622 augmented for a single package. If both \fBpackage.accept_keywords\fR and
623 \fBpackage.keywords\fR are present, both of them will be used, and values
624 from \fBpackage.accept_keywords\fR will override values from
625 \fBpackage.keywords\fR. The \fBpackage.accept_keywords\fR file is
626 intended to replace the \fBpackage.keywords\fR file, since
627 profiles support a different form of \fBpackage.keywords\fR which
628 modifies effective KEYWORDS (rather than ACCEPT_KEYWORDS).
632 \- comment lines begin with # (no inline comments)
633 \- one DEPEND atom per line followed by additional KEYWORDS
634 \- lines without any KEYWORDS imply unstable host arch
637 # always use unstable libgd
638 media\-libs/libgd ~x86
639 # only use stable mplayer
640 media\-video/mplayer \-~x86
641 # always use unstable netcat
647 In addition to the normal values from ACCEPT_KEYWORDS package.keywords supports
648 three special tokens:
651 \fB*\fR package is visible if it is stable on any architecture
652 \fB~*\fR package is visible if it is in testing on any architecture
653 \fB**\fR package is always visible (KEYWORDS are ignored completely)
657 If you encounter the \fB-*\fR KEYWORD, this indicates that the package is known
658 to be broken on all systems which are not otherwise listed in KEYWORDS. For
659 example, a binary only package which is built for x86 will look like:
661 games-fps/quake3-demo-1.11.ebuild:KEYWORDS="-* x86"
663 If you wish to accept this package anyways, then use one of the other keywords
664 in your package.accept_keywords like this:
666 games-fps/quake3-demo x86
669 .BR package.accept_restrict
670 This will allow ACCEPT_RESTRICT (see \fBmake.conf\fR(5)) to be augmented for a
675 \- comment lines begin with # (no inline comments)
676 \- one DEPEND atom per line followed by additional RESTRICT tokens
680 Per\-package environment variable settings. Entries refer to
681 environment files that are placed in the \fB/etc/portage/env/\fR
682 directory and have the same format as \fBmake.conf\fR(5). Note that these
683 files are interpreted much earlier than the package\-specific \fIbashrc\fR
684 files which are described in a later section about \fB/etc/portage/env/\fR.
685 Beginners should be careful to recognize the difference between these two types
686 of files. When environment variable settings are all that's needed,
687 \fBpackage.env\fR is the recommended approach to use.
691 \- comment lines begin with # (no inline comments)
692 \- one DEPEND atom per line followed by name(s) of environment file(s)
697 # use environment variables from /etc/portage/env/glibc.conf for the glibc \
699 sys\-libs/glibc glibc.conf
704 This will allow ACCEPT_LICENSE (see \fBmake.conf\fR(5)) to be augmented for a
709 \- comment lines begin with # (no inline comments)
710 \- one DEPEND atom per line followed by additional licenses or groups
714 A list of package atoms to mask. Useful if specific versions of packages do
715 not work well for you. For example, you swear by the Nvidia drivers, but only
716 versions earlier than 1.0.4496. No problem!
720 \- comment lines begin with # (no inline comments)
721 \- one DEPEND atom per line
726 # mask out versions 1.0.4496 of the nvidia
728 >=media\-video/nvidia\-kernel\-1.0.4496
729 >=media\-video/nvidia\-glx\-1.0.4496
732 .BR package.properties
733 This will allow ACCEPT_PROPERTIES (see \fBmake.conf\fR(5)) to be augmented for
738 \- comment lines begin with # (no inline comments)
739 \- one DEPEND atom per line followed by additional properties
743 Just like package.mask above, except here you list packages you want to
744 unmask. Useful for overriding the global package.mask file (see
745 above). Note that this does not override packages that are masked via
749 Per\-package USE flags. Useful for tracking local USE flags or for
750 enabling USE flags for certain packages only. Perhaps you develop GTK
751 and thus you want documentation for it, but you don't want
752 documentation for QT. Easy as pie my friend!
756 \- comments begin with # (no inline comments)
757 \- one DEPEND atom per line with space-delimited USE flags
762 # turn on docs for GTK 2.x
763 =x11\-libs/gtk+\-2* doc
764 # disable mysql support for QT
769 Specifies \fIsite\-specific\fR repository configuration information.
773 \- comments begin with # (no inline comments)
774 \- configuration of each repository is specified in a section starting with \
775 "[${repository_name}]"
776 \- attributes are specified in "${attribute} = ${value}" format
779 .I Attributes supported in DEFAULT section:
784 Specifies main repository.
787 Makes all repositories inherit eclasses from specified repositories.
789 Setting this attribute is generally not recommended since resulting changes
790 in eclass inheritance may trigger performance issues due to invalidation
793 When 'force = eclass\-overrides' attribute is not set, \fBegencache\fR(1),
794 \fBemirrordist\fR(1) and \fBrepoman\fR(1) ignore this attribute,
795 since operations performed by these tools are inherently
796 \fBnot\fR \fIsite\-specific\fR.
799 Specifies names of attributes, which should be forcefully respected by
800 \fBegencache\fR(1), \fBemirrordist\fR(1) and \fBrepoman\fR(1).
802 Valid values: aliases, eclass\-overrides, masters
805 .I Attributes supported in sections of repositories:
809 Specifies aliases of given repository.
811 Setting this attribute is generally not recommended since resulting changes
812 in eclass inheritance may trigger performance issues due to invalidation
815 When 'force = aliases' attribute is not set, \fBegencache\fR(1),
816 \fBemirrordist\fR(1) and \fBrepoman\fR(1) ignore this attribute,
817 since operations performed by these tools are inherently
818 \fBnot\fR \fIsite\-specific\fR.
821 Makes given repository inherit eclasses from specified repositories.
823 Setting this attribute is generally not recommended since resulting changes
824 in eclass inheritance may trigger performance issues due to invalidation
827 When 'force = eclass\-overrides' attribute is not set, \fBegencache\fR(1),
828 \fBemirrordist\fR(1) and \fBrepoman\fR(1) ignore this attribute,
829 since operations performed by these tools are inherently
830 \fBnot\fR \fIsite\-specific\fR.
833 Specifies names of attributes, which should be forcefully respected by
834 \fBegencache\fR(1), \fBemirrordist\fR(1) and \fBrepoman\fR(1).
836 Valid values: aliases, eclass\-overrides, masters
839 Specifies location of given repository.
842 Specifies master repositories of given repository.
844 Setting this attribute is generally not recommended since resulting changes
845 in eclass inheritance may trigger performance issues due to invalidation
848 When 'force = masters' attribute is not set, \fBegencache\fR(1),
849 \fBemirrordist\fR(1) and \fBrepoman\fR(1) ignore this attribute,
850 since operations performed by these tools are inherently
851 \fBnot\fR \fIsite\-specific\fR.
854 Specifies priority of given repository.
857 Specifies CVS repository.
860 Specifies type of synchronization performed by `emerge \-\-sync`.
862 Valid non-empty values: cvs, git, rsync
864 This attribute can be set to empty value to disable synchronization of given
865 repository. Empty value is default.
868 Specifies URI of repository used for synchronization performed by `emerge
871 This attribute can be set to empty value to disable synchronization of given
872 repository. Empty value is default.
876 cvs: [cvs://]:access_method:[username@]hostname[:port]:/path
878 git: (git|git+ssh|http|https)://[username@]hostname[:port]/path
880 rsync: (rsync|ssh)://[username@]hostname[:port]/(module|path)
884 rsync://private\-mirror.com/portage\-module
886 rsync://rsync\-user@private\-mirror.com:873/gentoo\-portage
888 ssh://ssh\-user@192.168.0.1:22/usr/portage
890 ssh://ssh\-user@192.168.0.1:22/\\${HOME}/portage\-storage
893 Note: For the ssh:// scheme, key\-based authentication might be of interest.
900 # make gentoo the main repository, which makes it the default master
901 # repository for repositories that do not specify masters
903 # make all repositories inherit eclasses from the java\-overlay and
904 # java\-experimental repositories, with eclasses from java\-experimental
905 # taking precedence over those from java\-overlay
906 eclass\-overrides = java\-overlay java\-experimental
909 # repos with higher priorities are preferred when ebuilds with equal versions
910 # are found in multiple repos (see the `emerge \-\-info \-\-verbose` repo
911 # display for a listing of repos and their corresponding priorities).
913 # disable all eclass overrides for ebuilds from the gentoo repository
915 # when processing metadata/layout.conf from other repositories, substitute
916 # 'gentoo' in place of references to repositories named 'foo' and 'bar',
917 # and discard the 'baz' alias contained in gentoo's layout.conf
918 aliases = foo bar -baz
921 # override the metadata/layout.conf masters setting from the kde-testing repo
925 # override the metadata/layout.conf masters setting from the python repo,
926 # so that settings won't be inherited from those masters, and so that
927 # those master repos won't be required as dependencies (the user must
928 # ensure that any required dependencies such as eclasses are satisfied)
931 # Repository 'gentoo' synchronized using CVS
933 location = /usr/portage
935 sync\-uri = :pserver:anonymous@anoncvs.gentoo.org:/var/cvsroot
936 sync\-cvs\-repo = gentoo\-x86
941 .BR /etc/portage/env/
943 In this directory additional package\-specific bashrc files can be created.
944 Note that if package\-specific environment variable settings are all that's
945 needed, then \fB/etc/portage/package.env\fR should be used instead of the
946 bashrc approach that is described here. Also note that special variables
947 such as \fBFEATURES\fR and \fBINSTALL_MASK\fR will not produce the intended
948 results if they are set in bashrc, and therefore
949 \fB/etc/portage/package.env\fR should be used instead. Lastly, note that these
950 files are interpreted much later than the portage environment file
953 Portage will source all of these bashrc files after \fB/etc/portage/bashrc\fR
954 in the following order:
957 /etc/portage/env/${CATEGORY}/${PN}
959 /etc/portage/env/${CATEGORY}/${PN}:${SLOT}
961 /etc/portage/env/${CATEGORY}/${P}
963 /etc/portage/env/${CATEGORY}/${PF}
966 .BR /etc/portage/sets/
968 For each file in this directory, a package set is created with its name
969 corresponding to the name of the file. Each file should contain a list
970 of package atoms and nested package sets, one per line. When a package
971 set is referenced as an \fBemerge\fR(1) argument or when it is
972 referenced as a nested package set (inside of another package set), the
973 set name is prefixed with \fB@\fR.
975 Also see \fB/var/lib/portage/world_sets\fR and the \fBemerge\fR(1)
976 \fB\-\-list\-sets\fR option.
979 .BR /usr/portage/metadata/
983 Specifies information about the repository layout. A
984 "masters" attribute is supported, which is used to specify names of
985 repositories which satisfy dependencies on eclasses and/or ebuilds. Each
986 repository name should correspond the value of a \fBrepo_name\fR entry
987 from one of the repositories that is configured via the \fBPORTDIR\fR or
988 \fBPORTDIR_OVERLAY\fR variables (see \fBmake.conf\fR(5)). Repositories listed
989 toward the right of the \fBmasters\fR list take precedence over those listed
990 toward the left of the list. An "aliases" attribute is also supported, which
991 behaves like an "aliases" attribute in \fBrepos.conf\fR. \fISite-specific\fR
992 overrides to \fBlayout.conf\fR settings may be specified in
993 \fB/etc/portage/repos.conf\fR. Settings in \fBrepos.conf\fR take
994 precedence over settings in \fBlayout.conf\fR, except tools such as
995 \fBrepoman\fR(1) and \fBegencache\fR(1) ignore "aliases", "eclass-overrides"
996 and "masters" attributes set in \fBrepos.conf\fR since their operations are
997 inherently \fBnot\fR \fIsite\-specific\fR.
1001 # Specify the repository name (if there is a different setting in
1002 # profiles/repo_name, then this layout.conf setting will take precedence)
1003 repo\-name = foo-overlay
1005 # eclasses provided by java-overlay take precedence over identically named
1006 # eclasses that are provided by gentoo
1007 masters = gentoo java-overlay
1009 # indicate that this repo can be used as a substitute for foo-overlay
1010 aliases = foo-overlay
1012 # indicate that ebuilds with the specified EAPIs are banned
1015 # indicate that ebuilds with the specified EAPIs are deprecated
1016 eapis\-deprecated = 2 3
1018 # sign commits in this repo, which requires Git >=1.7.9, and
1019 # key configured by `git config user.signingkey key_id`
1020 sign\-commits = true
1022 # do not sign Manifest files in this repo
1023 sign\-manifests = false
1025 # Manifest files only contain DIST entries
1026 thin\-manifests = true
1028 # indicate that this repo requires manifests for each package, and is
1029 # considered a failure if a manifest file is missing/incorrect
1030 use\-manifests = strict
1032 # customize the set of hashes generated for Manifest entries
1033 manifest\-hashes = SHA256 SHA512 WHIRLPOOL
1035 # indicate that this repo enables repoman's --echangelog=y option automatically
1036 update\-changelog = true
1038 # indicate that this repo contains both md5-dict and pms cache formats,
1039 # which may be generated by egencache(1)
1040 cache\-formats = md5-dict pms
1042 # indicate that this repo contains profiles that may use directories for
1043 # package.mask, package.provided, package.use, package.use.force,
1044 # package.use.mask, package.use.stable.force, package.use.stable.mask,
1045 # use.force, use.mask, use.stable.force, and use.stable.mask.
1046 # profile\-formats = portage-1
1047 # indicate that paths such as 'gentoo:targets/desktop' or ':targets/desktop' in
1048 # profile parent files can be used to express paths relative to the root
1049 # 'profiles' directory of a repository (when the repo name is omitted before
1050 # the colon, it refers to the current repository the parent file is inside)
1051 profile\-formats = portage-2
1055 .BR /usr/portage/profiles/
1056 Global Gentoo settings that are controlled by the developers. To override
1057 these settings, you can use the files in \fB/etc/portage/\fR.
1061 A list of all valid KEYWORDS. This does not include modifiers.
1065 \- one KEYWORD per line
1076 A simple list of valid categories that may be used in /usr/portage,
1077 PORTDIR_OVERLAY, and PKGDIR (see \fBmake.conf\fR(5)).
1081 \- one category per line
1093 A list of all the packages which will be displayed when you run `emerge info`.
1096 A list of all the variables which will be displayed when you run `emerge info`.
1099 This contains groups of licenses that may be specifed in the
1100 \fBACCEPT_LICENSE\fR variable (see \fBmake.conf\fR(5)). Refer
1101 to GLEP 23 for further information:
1102 \fIhttp://www.gentoo.org/proj/en/glep/glep-0023.html\fR.
1106 \- comments begin with # (no inline comments)
1107 \- one group name, followed by list of licenses and nested groups
1108 \- nested groups are prefixed with the '@' symbol
1113 # The FSF-APPROVED group includes the entire GPL-COMPATIBLE group and more.
1114 FSF-APPROVED @GPL-COMPATIBLE Apache-1.1 BSD-4 MPL-1.0 MPL-1.1
1115 # The GPL-COMPATIBLE group includes all licenses compatible with the GNU GPL.
1116 GPL-COMPATIBLE Apache-2.0 BSD BSD-2 GPL-2 GPL-3 LGPL-2.1 LGPL-3 X11 ZLIB
1119 .BR package.accept_keywords
1120 Per\-package ACCEPT_KEYWORDS for profiles. This has the same format and
1121 behavior as /etc/portage/package.accept_keywords, including the ability
1122 to list atoms without any keywords in order to accept unstable variants
1123 of all stable keywords listed in ACCEPT_KEYWORDS.
1125 .BR package.keywords
1126 Per\-profile KEYWORDS. Useful for cases in which the effective KEYWORDS of a
1127 given package should vary depending on which profile the user has selected.
1131 \- comment lines begin with # (no inline comments)
1132 \- one DEPEND atom per line followed by additional KEYWORDS
1137 # add stable keyword to libgd
1138 media\-libs/libgd x86
1139 # remove stable keyword from mplayer and add unstable keyword
1140 media\-video/mplayer \-x86 ~x86
1141 # remove all keywords from netcat
1142 net-analyzer/netcat -*
1146 This contains a list of DEPEND atoms for packages that should not be installed
1147 in any profile. Useful for adding the latest KDE betas and making sure no
1148 one accidentally upgrades to them. Also useful for quickly masking specific
1149 versions due to security issues. ALWAYS include a comment explaining WHY the
1150 package has been masked and WHO is doing the masking.
1154 \- comments begin with # (no inline comments)
1155 \- one DEPEND atom per line
1160 # masked for security reasons
1161 <sys\-libs/zlib\-1.1.4
1162 # <caleb@gentoo.org> (10 Sep 2003)
1164 =kde\-base/kde\-3.2.0_beta1
1165 =kde\-base/kdeaccessibility\-3.2.0_beta1
1169 List all the current stable and development profiles. If a profile is listed
1170 here, then it will be checked by repoman.
1173 \- comments begin with # (no inline comments)
1174 \- one profile list per line in format: arch dir status
1175 \- arch must be listed in arch.list
1176 \- dir is relative to profiles.desc
1177 \- status must be 'stable', 'dev', or 'exp'
1182 alpha default/linux/alpha/10.0 stable
1183 m68k default/linux/m68k/10.0 dev
1184 x86 default/linux/x86/10.0 stable
1185 x86-linux prefix/linux/x86 exp
1189 The first line of the file should define a unique repository name. The name
1190 may contain any of the characters [A\-Za\-z0\-9_\-]. It must not begin with a
1191 hyphen. If the repo\-name attribute is specified in layout.conf, then that
1192 setting will take precedence.
1194 .BR thirdpartymirrors
1195 Controls the mapping of mirror:// style URIs to actual lists of
1196 mirrors. Keeps us from overloading a single server.
1200 \- comments begin with # (no inline comments)
1201 \- mirror type followed by a list of hosts
1206 sourceforge http://aleron.dl.sourceforge.net/sourceforge \
1207 http://unc.dl.sourceforge.net/sourceforge
1209 gentoo http://distro.ibiblio.org/pub/linux/distributions/gentoo/distfiles/ \
1210 ftp://ftp.gtlib.cc.gatech.edu/pub/gentoo/distfiles
1212 kernel http://www.kernel.org/pub http://www.us.kernel.org/pub
1216 All global USE flags must be listed here with a description of what they do.
1220 \- comments begin with # (no inline comments)
1221 \- use flag \- some description
1226 3dfx \- Adds support for 3dfx video cards
1227 acl \- Adds support for Access Control Lists
1228 doc \- Adds extra documentation
1232 All local USE flags are listed here along with the package and a
1233 description. This file is automatically generated from the
1234 metadata.xml files that are included with each individual package.
1235 Refer to GLEP 56 for further information:
1236 \fIhttp://www.gentoo.org/proj/en/glep/glep-0056.html\fR.
1240 \- comments begin with # (no inline comments)
1241 \- package:use flag \- description
1244 app\-editors/nano:justify \- Toggles the justify option
1245 dev\-libs/DirectFB:fusion \- Adds Multi Application support
1246 games\-emulation/xmess:net \- Adds network support
1250 .BR /usr/share/portage/config/
1254 The global default settings for Portage. This comes from the portage package
1255 itself. Settings in \fBmake.conf\fR or \fBpackage.env\fR override values set
1256 here. The format is described extensively in \fBmake.conf\fR(5).
1259 The default configuration of repositories for Portage. This comes from
1260 the portage package itself. Settings in \fB/etc/portage/repos.conf\fR
1261 override values set here. The format is described extensively in section
1262 for \fB/etc/portage/repos.conf\fR.
1267 This directory is used to store internal portage cache files. The names and
1268 purpose of these files are not documented on purpose so as to keep down bitrot
1269 as internals change. If you aren't working on portage internally, then the
1270 details most likely do not matter to you.
1272 This entire directory can be safely deleted. It is highly recommended you do
1273 not do this however as it can be a time consuming process to generate them all
1279 All installed package information is recorded here. If portage thinks you have
1280 a package installed, it is usually because it is listed here.
1282 The format follows somewhat closely that of the portage tree. There is a
1283 directory for each category and a package-version subdirectory for each package
1286 Inside each package directory are misc files that describe the installed
1287 contents of the package as well as build time information (so that the package
1288 can be unmerged without needing the portage tree).
1290 The exact file contents and format are not described here again so that things
1291 can be changed quickly. Generally though there is one file per environment
1292 variable that "matters" (like CFLAGS) with the contents stored inside of it.
1293 Another common file is the CONTENTS file which lists the path and hashes of
1294 all objects that the package installed onto your system.
1297 .BR /var/lib/portage/
1301 Hashes which are used to determine whether files in config protected
1302 directories have been modified since being installed. Files which have not
1303 been modified will automatically be unmerged.
1306 Every time you emerge a package, the package that you requested is
1307 recorded here. Then when you run `emerge world \-up`, the list of
1308 packages is read from this file. Note that this does not mean that the
1309 packages that were installed as dependencies are listed here. For
1310 example, if you run `emerge mod_wsgi` and you do not have apache
1311 already, then "www\-apache/mod_wsgi" is recorded in the world file but
1312 "www\-servers/apache" is not. For more information, review \fBemerge\fR(1).
1316 \- one DEPEND atom base per line
1321 games\-misc/fortune\-mod\-gentoo\-dev
1327 This is like the world file but instead of package atoms it contains
1328 packages sets which always begin with the \fB@\fR character. Use
1329 \fB/etc/portage/sets/\fR to define user package sets.
1336 .SH "REPORTING BUGS"
1337 Please report bugs via http://bugs.gentoo.org/
1340 Marius Mauch <genone@gentoo.org>
1341 Mike Frysinger <vapier@gentoo.org>
1342 Drake Wyrm <wyrm@haell.com>
1343 Arfrever Frehtes Taifersar Arahesis <arfrever@apache.org>