diff options
author | 2004-10-03 17:56:19 +0000 | |
---|---|---|
committer | 2004-10-03 17:56:19 +0000 | |
commit | 69937180ad38f7a9aa403f7659d4271470fbabee (patch) | |
tree | 004953cbd4564f1d5e8158fc48f5506ff6b9de03 /man | |
parent | old file (diff) | |
download | portage-cvs-69937180ad38f7a9aa403f7659d4271470fbabee.tar.gz portage-cvs-69937180ad38f7a9aa403f7659d4271470fbabee.tar.bz2 portage-cvs-69937180ad38f7a9aa403f7659d4271470fbabee.zip |
use --action instead of action
Diffstat (limited to 'man')
-rw-r--r-- | man/emerge.1 | 74 | ||||
-rw-r--r-- | man/make.conf.5 | 132 | ||||
-rw-r--r-- | man/portage.5 | 379 |
3 files changed, 305 insertions, 280 deletions
diff --git a/man/emerge.1 b/man/emerge.1 index 4e19d7b..c6e8ebd 100644 --- a/man/emerge.1 +++ b/man/emerge.1 @@ -7,13 +7,10 @@ emerge \- Command\-line interface to the Portage system [\fIoptions\fR] [\fIaction\fR] [\fIebuild\fR | \fItbz2file\fR | \fIclass\fR | \fIdependency\fR] ... .TP .BR emerge -[\fIoptions\fR] [\fIaction\fR] \fBebuildfile\fR +\fB\-\-sync\fR | \fB\-\-metadata\fR .TP .BR emerge -\fBsync\fR | \fBmetadata\fR -.TP -.BR emerge -\fI\-\-help \-h\fR [\fBsystem\fR | \fBconfig\fR | \fBsync\fR] +\fI\-\-help\fR | \fI\-h\fR [\fBsystem\fR | \fBconfig\fR | \fBsync\fR] .TP .BR emerge \fI\-\-version\fR @@ -41,6 +38,7 @@ as \fBsys\-apps/portage\fR or \fB=python\-2.2.1\-r2\fR. \fBemerge\fR ignores a trailing slash so that filename completion can be used. The \fIebuild\fR may also be an actual filename, such as \fB/usr/portage/app\-admin/python/python\-2.2.1\-r2.ebuild\fR. +WARNING: The implementation of \fBemerge /path/to/ebuild\fR is broken and so this syntax shouldn't be used. .TP .BR tbz2file A \fItbz2file\fR must be a valid .tbz2 created with \fBebuild @@ -77,16 +75,16 @@ option if you want to install a tbz2\fR. The packages are added to the \fBworld\fR file at the end, so that they are considered for later updating. .TP -.BR "clean " (\fB\-c\fR) +.BR "\-\-clean " (\fB\-c\fR) Cleans the system by removing packages that will not effect the functionality of the system. The arguments can be \fIebuilds\fR, \fIclasses\fR, or \fIdependencies\fR. For example, \fBemerge clean binutils\fR cleans out old versions of binutils; -\fBemerge clean net\-www/mozilla\-0.9.9\-r2\fR cleans out that +\fBemerge \-\-clean net\-www/mozilla\-0.9.9\-r2\fR cleans out that specific version of Mozilla. This is generally safe to use. -\fBNote that\fR clean \fBdoes not remove unslotted packages.\fR +\fBNote that\fR \-\-clean \fBdoes not remove unslotted packages.\fR .TP -.BR depclean +.BR \-\-depclean Determines all packages installed on the system that have no explicit reason for being there. \fBemerge\fR generates a list of packages which it expects to be installed by checking the @@ -98,71 +96,71 @@ packages may cause packages which link to the removed package to stop working and complain about missing libraries.\fR Re\-emerge the complaining package to fix this issue. \fBNote that changes in USE flags can drastically affect the -output of depclean.\fR +output of \-\-depclean.\fR .TP -.BR info +.BR \-\-info This is a list of information to include in bug reports which aids the developers with fixing any problems you may report. \fBPlease include this information when submitting a bug report.\fR Expanded output can be obtained with the \fI\-\-verbose\fR option. .TP -.BR "inject " (\fB\-i\fR) +.BR "\-\-inject " (\fB\-i\fR) Injecting a package inserts a 'stub' for that package so that Portage thinks that it is installed. It is handy if you need, say, a binary version of XFree86 for esoteric hardware, or you just like to roll your own packages. You \fBmust\fR specify a category and particular version of a package for injecting. For example, -\fBemerge inject sys\-kernel/gentoo\-sources\-2.4.19\fR. +\fBemerge \-\-inject sys\-kernel/gentoo\-sources\-2.4.19\fR. .TP -.BR metadata +.BR \-\-metadata Causes portage to process all the metacache files as is normally done -on the tail end of an rsync update using \fBemerge sync\fR. The processing -creates the cache database that portage uses for pre-parsed lookups of +on the tail end of an rsync update using \fBemerge \-\-sync\fR. The processing +creates the cache database that portage uses for pre\-parsed lookups of package data. .TP -.BR "prune " (\fB\-P\fR) +.BR "\-\-prune " (\fB\-P\fR) \fBWARNING: This action can remove important packages!\fR Removes all but the latest versions of matching packages. If there are multiple SLOTs for a package, it leaves the latest version in each SLOT. This does no checking of dependencies, so it may remove packages necessary for the proper operation of your system. \fBUse\fR -clean \fBinstead unless you really know what you're doing\fR. Its +\-\-clean \fBinstead unless you really know what you're doing\fR. Its arguments can be \fIebuilds\fR, \fIclasses\fR, or \fIdependencies\fR -\-\- see \fBclean\fR above for examples. +\-\- see \fB\-\-clean\fR above for examples. .TP -.BR regen +.BR \-\-regen Causes portage to check and update the dependency cache of all ebuilds in the portage tree. The cache is used to speed up searches and the building of dependency trees. This command is not recommended for rsync users as rsync updates the cache using server\-side caches. If you do not know the differences between a 'rsync user' and some other user, then you are a 'rsync user' :). Rsync users should simply run -\fBemerge sync\fR to regenerate the cache. After a portage updated, rsync -users may find it convenient to run \fBemerge metadata\fR to rebuild the +\fBemerge \-\-sync\fR to regenerate the cache. After a portage updated, rsync +users may find it convenient to run \fBemerge \-\-metadata\fR to rebuild the cache as portage does at the end of a sync operation. .TP -.BR search (\fB\-s\fR) +.BR "\-\-search " (\fB\-s\fR) Searches for matches of the supplied string in the portage tree. -The search string is a regular expression. For example, \fBemerge -search "^kde"\fR searches for any package that starts with "kde"; -\fBemerge search "gcc$"\fR searches for any package that ends with -"gcc"; \fBemerge search "office"\fR searches for any package that +The \-\-search string is a regular expression. For example, \fBemerge +\-\-search "^kde"\fR searches for any package that starts with "kde"; +\fBemerge \-\-search "gcc$"\fR searches for any package that ends with +"gcc"; \fBemerge \-\-search "office"\fR searches for any package that contains the word "office". If you want to search the package descriptions as well, use the \fB\-\-searchdesc\fR option. .TP -.BR sync +.BR \-\-sync Initiates a portage tree update with one of the rsync.gentoo.org mirrors. \fBNote that any changes you have made to the portage tree will be erased\fR. Except for in special circumstances, this uses \fBrsync\fR to do the update. See \fBmake.conf\fR(5)'s description of PORTDIR_OVERLAY for a method to avoid deletions. .TP -.BR unmerge (\fB\-C\fR) +.BR "\-\-unmerge " (\fB\-C\fR) \fBWARNING: This action can remove important packages!\fR Removes all matching packages. This does no checking of dependencies, so it may remove packages necessary for the proper operation of your system. Its arguments can be \fIebuilds\fR, \fIclasses\fR, or -\fIdependencies\fR \-\- see \fBclean\fR above for examples. +\fIdependencies\fR \-\- see \fB\-\-clean\fR above for examples. .SH "OPTIONS" .TP .BR "\-\-ask " (\fB\-a\fR) @@ -218,7 +216,7 @@ and it enables complete trees to be rebuilt using the latest libraries. Instead of doing any package building, just perform fetches for all packages (the main package as well as all dependencies.) .TP -.BR "\-\-fetch-all-uri " (\fB\-f\fR) +.BR "\-\-fetch\-all\-uri " (\fB\-f\fR) Instead of doing any package building, just perform fetches for all packages (the main package as well as all dependencies.), grabbing all potential files. @@ -399,7 +397,7 @@ when the previous version emerged was injected (see \fBinject\fR for more info) or very outdated (so old that \fBSLOT\fR did not exist). Either way, a newer version of Xfree is availabe for your updating delight. .TP -.B [ebuild U ] sys\-devel/distcc\-2.16 [2.13-r1] \-gnome \-gtk +ipv6* (\-selinux) +.B [ebuild U ] sys\-devel/distcc\-2.16 [2.13\-r1] \-gnome \-gtk +ipv6* (\-selinux) The \-gtk and \-gnome reflect the status of \fBUSE\fR variables when emerging nmap. Here we see that nmap can use the \fBUSE\fR variables gtk and gnome, but that your current settings have gtk and gnome disabled. So optional support for gtk and gnome will @@ -433,7 +431,8 @@ override those specified in the default locations, letting you avoid using some dependencies you may not want to have. \fBUSE flags specified on the command line are NOT remembered\fR. For example, \fBUSE="\-x \-gnome" emerge mc\fR will emerge mc with -those USE settings. +those USE settings. If you want those changes to be permanent +please use /etc/portage/package.use too. .LP If \fBemerge \-\-update system\fR or \fBemerge \-\-update world\fR fail with an error message, it may be that an ebuild uses some @@ -482,7 +481,7 @@ Please report any bugs you encounter through our website: .LP \fBhttp://bugs.gentoo.org/\fR .LP -Please include the output of \fBemerge info\fR when you submit your +Please include the output of \fBemerge \-\-info\fR when you submit your bug report. .SH "SEE ALSO" .BR "emerge \-\-help", @@ -526,7 +525,7 @@ functions. \fBDo not edit this file\fR. Contains a list of default packages used to resolve virtual dependencies. \fBDo not edit this file\fR. .TP -\fB/etc/make.profile/package\fR +\fB/etc/make.profile/packages\fR Contains a list of packages used for the base system. The \fBsystem\fR and \fBworld\fR classes consult this file. \fBDo not edit this file\fR. .TP @@ -545,5 +544,8 @@ Nicholas Jones <carpaski@gentoo.org> Phil Bordelon <phil@thenexusproject.org> .br Mike Frysinger <vapier@gentoo.org> +.br +Marius Mauch <genone@gentoo.org> +.br .SH "CVS HEADER" -$Id: emerge.1,v 1.61 2004/09/27 05:44:05 carpaski Exp $ +$Id: emerge.1,v 1.62 2004/10/03 17:56:19 genone Exp $ diff --git a/man/make.conf.5 b/man/make.conf.5 index 2324d82..43c10ea 100644 --- a/man/make.conf.5 +++ b/man/make.conf.5 @@ -20,7 +20,7 @@ make.defaults to make.globals to make.conf to the environment settings. Clearing these variables requires a clear\-all as in: export USE="\-*" .SH "VARIABLES" -.TP +.TP \fBACCEPT_KEYWORDS\fR = \fI[space delimited list of KEYWORDS]\fR Enable testing of ebuilds that have not yet been deemed 'stable'. Users of the 'x86' architecture would set this to '~x86' while ppc users would @@ -28,7 +28,7 @@ set this to '~ppc'. This is an incremental variable. Only define a ~arch. .br Defaults to the value of $ARCH. -.TP +.TP \fBAUTOCLEAN\fR = \fI["yes" | "no"]\fR Automatically cleans the system by removing outdated packages which will not remove functionalities or prevent your system from working. On major ABI @@ -37,21 +37,21 @@ rebuilt using the new libs before the old ones are removed. Downgrading with this option turned off may result in missing symlinks and an inoperable system. .br Defaults to yes. -.TP +.TP \fBBUILD_PREFIX\fR = \fI[path]\fR Defines the location of the package working directory. .br Defaults to ${PORTAGE_TMPDIR}/portage -.TP +.TP \fBCBUILD\fR This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR as \fI\-\-build=${CBUILD}\fR only if it is defined. Presently HPPA is the only arch to require this. -.TP +.TP \fBCCACHE_SIZE\fR = \fI"size"\fR This controls the space use limitations for ccache. The default is 2 gigabytes ('2G'). Sizes are specified with 'G', 'M', or 'K'. -.TP +.TP \fBCFLAGS CXXFLAGS\fR Use these variables to set the desired optimization/CPU instruction settings for applications that you compile. Nearly all ebuild files will take advantage @@ -66,7 +66,7 @@ http://gcc.gnu.org/onlinedocs/gcc\-3.2/gcc/Invoking\-GCC.html http://gcc.gnu.org/onlinedocs/gcc\-3.3/gcc/Invoking\-GCC.html .br http://gcc.gnu.org/onlinedocs/gcc\-2.95.3/gcc_2.html -.TP +.TP \fBCHOST\fR This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR step as \fI\-\-host=${CHOST}\fR. This way you can force the build\-host. @@ -78,55 +78,55 @@ http://gcc.gnu.org/onlinedocs/gcc\-3.2/gcc/Submodel\-Options.html http://gcc.gnu.org/onlinedocs/gcc\-3.3/gcc/Submodel\-Options.html .br http://gcc.gnu.org/onlinedocs/gcc\-2.95.3/gcc_2.html -.TP +.TP \fBCLEAN_DELAY\fR = \fIinteger\fR Determines how long the countdown delay will be after running `emerge clean`. .br Defaults to 5 seconds. -.TP +.TP \fBCONFIG_PROTECT\fR = \fI[space delimited list of dirs]\fR All directories that are defined here will have "config file protection" enabled for them. For more information, please see `emerge \-\-help config`. -.TP +.TP \fBCONFIG_PROTECT_MASK\fR = \fI[space delimited list of dirs]\fR All directories that are defined here will have "config file protection" disabled for them. For more information, please see `emerge \-\-help config`. -.TP +.TP \fBDISTDIR\fR = \fI[path]\fR Defines the location of your local source file repository. .br Defaults to ${PORTDIR}/distfiles. -.TP +.TP \fBFEATURES\fR = \fI"sandbox ccache autoaddcvs"\fR Defines actions portage takes by default. These options should not be changed by anyone but developers and/or maintainers. 'sandbox' is an important part of \fBFEATURES\fR and should not be disabled by default. This is an incremental variable. .RS -.TP +.TP .B autoaddcvs Causes portage to automatically try to add files to cvs that will have to be added later. Done at generation times and only works when \fIcvs\fR is also in \fBFEATURES\fR. -.TP +.TP .B buildpkg Binary packages will be created for all packages that are merged. -.TP +.TP .B ccache Enable portage support for the ccache package. If the ccache dir is not present in the user's environment, then portage will default to ${PORTAGE_TMPDIR}/ccache (with \fIuserpriv\fR) and to /root/.ccache otherwise. -.TP +.TP .B collision\-protect A QA\-feature to ensure that a package doesn't overwrite files it doesn't own. -.TP +.TP .B cvs A feature for developers that causes portage to enable all USE flags in SRC_URI when creating digests. -.TP +.TP .B digest Autogenerate a digest for packages. -.TP +.TP .B distcc Enable portage support for the distcc package. .TP @@ -142,7 +142,7 @@ when a problem arises (normally due to a crash or disconnect). Runs the script that will fix the dependencies in all binary packages. This is run whenever packages are moved around in the portage tree. Please note that this can take a lot of time. -.TP +.TP .B getbinpkg Force emerges to always try to fetch files from the \fIPORTAGE_BINHOST\fR. See \fBmake.conf\fR(5) for more information. @@ -152,40 +152,40 @@ Check the signatures of Manifests and make sure they are correct. .TP .B keeptemp Do not delete the ${T} directory after the merge process. -.TP +.TP .B keepwork Do not delete the ${WORKDIR} directory after the merge process. -.TP +.TP .B maketest -Run package-specific tests during each merge to help make sure +Run package\-specific tests during each merge to help make sure the package compiled properly. See \fItest\fR in \fBebuild\fR(1) and \fIsrc_test()\fR in \fBebuild\fR(5). -.TP +.TP .B mirror This will cause \fBFETCHCOMMAND\fR to always be run even if the file already exists in \fBDISTDIR\fR. -.TP +.TP .B noauto When utilizing \fBebuild\fR(1), only run the function requested. -.TP +.TP .B noclean Do not delete the the source and temporary files after the merge process. -.TP +.TP .B nodoc Do not install doc files (/usr/share/doc). -.TP +.TP .B noinfo Do not install info pages. -.TP +.TP .B noman Do not install manpages. -.TP +.TP .B nostrip Prevents the stripping of binaries that are merged to the live filesystem. -.TP +.TP .B notitles Disables xterm titlebar updates (which contains status info). -.TP +.TP .B sandbox Enable sandbox\-ing when running \fBemerge\fR(1) and \fBebuild(1)\fR. .TP @@ -199,49 +199,49 @@ live filesystem, automatically search for and set permissions on setuid and setgid files. Files that are setuid have the group and other read bits removed while files that are setgid have the other read bit removed. See also \fIsuidctl\fR below. -.TP +.TP .B sign When commiting work to cvs with \fBrepoman\fR(1), sign the Manifest with a GPG key. Read about the \fIPORTAGE_GPG_KEY\fR variable in \fBmake.conf\fR(5). -.TP +.TP .B strict Have portage react strongly to conditions that have the potential to be dangerous (like missing or incorrect Manifests). -.TP +.TP .B suidctl Before merging packages to the live filesystem, automatically strip setuid bits from any file that is not listed in \fI/etc/portage/suidctl.conf\fR. -.TP +.TP .B userpriv Allow portage to drop root privledges and compile packages as portage:portage without a sandbox (unless \fIusersandbox\fR is also used). -.TP +.TP .B usersandbox Enable the sandbox in the compile phase, when running without root privs (\fIuserpriv\fR). .RE -.TP +.TP \fBFETCHCOMMAND\fR This variable contains the command used for fetching package\-sources from the internet. -.TP +.TP \fBGENTOO_MIRRORS\fR = \fI[URLs]\fR Insert your space\-seperated list of local mirrors here. These locations are used to download files before the ones listed in the \fIebuild scripts\fR. Merging 'mirrorselect' can help. -.TP +.TP \fBHTTP_PROXY FTP_PROXY\fR = \fI[host:port]\fR These vars are used if the sources must be downloaded from the internet by \fBwget\fR(1). They are only required if you use a proxy server for internet access. Either define \fIPROXY\fR or \fIPROXY_FTP\fR and \fIPROXY_HTTP\fR. -.TP +.TP \fBMAKEOPTS\fR Use this variable if you want to use parallel make. For example, if you have a dual\-processor system, set this variable to "\-j2" or "\-j3" for enhanced build performance with many packages. Suggested settings are between \fICPUs+1\fR and \fI2*CPUs+1\fR. For more information, see \fBmake\fR(1). -.TP +.TP \fBNOCOLOR\fR = \fI["true" | "false"]\fR Defines if color should be disabled by default. .br @@ -251,11 +251,11 @@ Defaults to false. Defines the location where created .tbz2 binary packages will be stored. .br Defaults to ${PORTDIR}/packages. -.TP +.TP .B PORT_LOGDIR This variable defines the directory in which per\-ebuild logs are kept. Logs are created only when this is set and writable. -.TP +.TP \fBPORTAGE_BINHOST\fR = \fI"ftp://login:pass@grp.mirror.site/pub/grp/i686/athlon\-xp"\fR This is the host from which portage will grab prebuilt\-binary packages. The list is a single entry specifying the full address of the directory @@ -263,34 +263,34 @@ serving the tbz2's for your system. This is only used when running with the get binary pkg options are given to \fBemerge\fR. Review \fBemerge\fR(1) for more information. Note that it should point to the 'All' directory on the host that creates the binary packages and not to the root of the \fBPKGDIR\fR. -.TP +.TP \fBPORTAGE_NICENESS\fR = \fI[number]\fR The value of this variable will be added to the current nice level that emerge is running at. In other words, this will not set the nice level, it will increment it. For more information about nice levels and what are acceptable ranges, see \fBnice\fR(1). -.TP +.TP \fBPORTAGE_TMPDIR\fR = \fI[path]\fR Defines the location of the temporary build directories. .br Defaults to /var/tmp. -.TP +.TP \fBPORTDIR\fR = \fI[path]\fR Defines the location of your Portage tree. .br Defaults to /usr/portage. -.TP +.TP \fBPORTDIR_OVERLAY\fR = \fI"[path] [different\-path] [etc...]"\fR Defines the directories in which user made ebuilds may be stored and not -overwriten when `emerge sync` is run. This is a space delimited list of +overwriten when `emerge \-\-sync` is run. This is a space delimited list of directories. .br Defaults to no value. -.TP +.TP \fBRESUMECOMMAND\fR This variable contains the command used for resuming package\-sources that have been partially downloaded by the \fBFETCHCOMMAND\fR. -.TP +.TP \fBROOT\fR = \fI[path]\fR Use \fBROOT\fR to specify the target root filesystem to be used for merging packages or ebuilds. Typically, you should set this setting @@ -298,42 +298,42 @@ in the environment rather than in \fI/etc/make.conf\fR itself. It's typically used for creating new build images. .br Defaults to /. -.TP +.TP \fBRSYNC_EXCLUDEFROM\fR = \fI"/etc/portage/rsync_excludes"\fR This is a file that portage will pass to rsync when it updates the portage tree. Specific chucks of the tree may be excluded from the sync process. This may cause dependency failures if you are not careful. The file format is pattern per line, blanks and ';' or '#' lines are comments. See \fBrsync\fR(1) for more details. -.TP +.TP \fBRSYNC_RETRIES\fR = \fI[NUMBER]\fR The number of times rsync should retry on failed connections before giving up. .br Defaults to 3. -.TP +.TP \fBRSYNC_TIMEOUT\fR = \fI[SECONDS]\fR The number of seconds rsync should remain idle before it determines the connection has timed out. Dialup users may need to set this value at or above 300 seconds. .br Defaults to 180 seconds. -.TP +.TP \fBRPMDIR\fR = \fI[path]\fR Defines the location where created RPM packages will be stored. .br Defaults to ${PORTDIR}/rpm. -.TP +.TP \fBSYNC\fR = \fI[RSYNC]\fR Insert your preferred rsync mirror here. This rsync server -is used to sync the local portage tree when `emerge sync` is run. +is used to sync the local portage tree when `emerge \-\-sync` is run. .br Defaults to rsync://rsync.gentoo.org/gentoo\-portage -.TP +.TP \fBUSE\fR = \fI[space delimited list of USE items]\fR This variable contains options that control the build behavior of several packages. More information in \fBebuild\fR(5). Possible USE values can be found in \fI/usr/portage/profiles/use.desc\fR. -.TP +.TP \fBUSE_ORDER\fR = \fI"env:pkg:conf:auto:defaults"\fR Determines precedence for incrementing the setting of the USE variable. The above setting will cause the environment (env) to override per package (pkg) @@ -355,21 +355,21 @@ Please report bugs via http://bugs.gentoo.org/ .BR portage (5), .BR ebuild (1), .BR ebuild (5) -.TP +.TP The \fI/usr/sbin/ebuild.sh\fR script. -.TP +.TP The helper apps in \fI/usr/lib/portage/bin\fR. .SH "FILES" -.TP +.TP \fB/etc/make.conf\fR Contains variables for the build\-process and overwrites those in make.defaults. -.TP +.TP \fB/etc/make.globals\fR Contains the default variables for the build\-process, you should edit \fI/etc/make.conf\fR instead. -.TP +.TP \fB/usr/portage/profiles/use.desc\fR Contains a list of all global USE flags. -.TP +.TP \fB/usr/portage/profiles/use.local.desc\fR Contains a list of all local USE variables. .SH "AUTHORS" @@ -379,4 +379,4 @@ Nicholas Jones <carpaski@gentoo.org> .br Mike Frysinger <vapier@gentoo.org> .SH "CVS HEADER" -$Header: /local/data/ulm/cvs/history/var/cvsroot/gentoo-src/portage/man/make.conf.5,v 1.43 2004/09/27 05:44:05 carpaski Exp $ +$Header: /local/data/ulm/cvs/history/var/cvsroot/gentoo-src/portage/man/make.conf.5,v 1.44 2004/10/03 17:56:19 genone Exp $ diff --git a/man/portage.5 b/man/portage.5 index fa0a1b6..e2cde27 100644 --- a/man/portage.5 +++ b/man/portage.5 @@ -1,7 +1,7 @@ .TH "PORTAGE" "5" "Jan 2004" "Portage 2.0.51" "Portage" .SH NAME portage \- the heart of Gentoo -.SH DESCRIPTION +.SH "DESCRIPTION" The current portage code uses many different configuration files most of which are unknown to users and normal developers. Here we will try to collect all the odds and ends so as to help users more effectively utilize portage. This @@ -9,16 +9,16 @@ is a reference only for files which do not already have a man page. .IP Note: If you are looking for information on how to emerge something, please see .BR emerge (1). -.SH SYNOPSIS -.TP +.SH "SYNOPSIS" +.TP .BR /etc/ -.nf +.nf make.globals .BR make.conf (5) -.fi -.TP +.fi +.TP .BR /etc/make.profile/ -.nf +.nf deprecated make.defaults packages @@ -26,10 +26,10 @@ packages.build use.defaults use.mask virtuals -.fi -.TP +.fi +.TP .BR /etc/portage/ -.nf +.nf bashrc package.mask package.unmask @@ -37,10 +37,10 @@ package.keywords package.use mirrors categories -.fi -.TP +.fi +.TP .BR /usr/portage/profiles/ -.nf +.nf arch.list categories package.mask @@ -48,68 +48,68 @@ thirdpartymirrors use.desc use.local.desc use.mask -.fi -.TP +.fi +.TP .BR /var/lib/portage/ world -.SH GLOSSARY +.SH "GLOSSARY" In the following sections, some terminology may be foreign to you or used with meaning specific to Portage. Please see the referenced manpages for more detailed explanations. .RS -.TP +.TP .B DEPEND atom A string which matches a package. It is of the form category/package. It may also contain optional logical operators and versions. -.br +.br More reading: .BR ebuild (5) -.TP +.TP .B KEYWORD Each architecture has a unique KEYWORD. -.br +.br More reading: .BR ebuild (5) -.TP +.TP .B virtual A DEPEND atom that is part of the "virtual" category. They are used when different packages can satisfy a dependency and only one of them is needed. -.br +.br More reading: .BR ebuild (5) .RE -.SH SPECIFIC FILE DESCRIPTIONS -.TP +.SH "SPECIFIC FILE DESCRIPTIONS" +.TP .BR /etc/ .RS -.TP +.TP .BR make.globals The global default settings for Portage. This comes from the portage package itself. Settings in \fBmake.conf\fR override values here. The format is described extensivly in \fBmake.conf\fR(5). -.TP +.TP .BR make.conf The global custom settings for Portage. See \fBmake.conf\fR(5). .RE -.TP +.TP .BR /etc/make.profile/ This is usually just a symlink to the correct profile in \fB/usr/portage/profiles/\fR. Since it is part of the portage tree, it -may easily be updated/regenerated by running `emerge sync`. It defines +may easily be updated/regenerated by running `emerge \-\-sync`. It defines what a profile is (usually arch specific stuff). If you need a custom profile, then you should make your own \fB/etc/make.profile/\fR directory and populate it. However, if you just wish to override some settings, do NOT edit these files because they WILL be lost with the -next `emerge sync`. See the section below on \fB/etc/portage/\fR for +next `emerge \-\-sync`. See the section below on \fB/etc/portage/\fR for overriding. .RS -.TP +.TP .BR deprecated The existance of this file marks a profile as deprecated, meaning it is not supported by Gentoo anymore. It contains the name of the profile to which users are encouraged to upgrade. -.TP +.TP .BR make.defaults The profile default settings for Portage. The general format is described in \fBmake.conf\fR(5). The \fImake.defaults\fR for your profile defines a @@ -117,192 +117,192 @@ few specific variables too: .PD 0 .RS -.TP +.TP .BR ARCH Architecture type (x86/ppc/hppa/etc...). -.TP +.TP .B USERLAND = \fI"GNU"\fR Support BSD/cygwin/etc... -.TP +.TP .B PORTAGE_LIBC = \fI"glibc"\fR Support uClibc/BSD libc/etc... -.TP +.TP .BR PROFILE_ARCH Distinguish machines classes that have the same \fBARCH\fR. All sparc machines have ARCH=sparc but set this to either 'sparc32' or 'sparc64'. -.TP +.TP .BR STAGE1_USE Special USE flags which may be need when bootstrapping from stage1 to stage2. -.TP +.TP .BR GRP_STAGE23_USE Special USE flags used by catalyst for building a stage3 and GRP sets. .RE .PD 1 -.TP +.TP .BR packages This file serves two purposes. The first is to mask out specific -packages/versions on a per-profile basis. The second is to provide the +packages/versions on a per\-profile basis. The second is to provide the list of packages that compose the special \fIsystem\fR class. .I Format: -.nf +.nf \- comments begin with # \- one DEPEND atom per line of what to mask OUT \- packages to be added to the system class begin with a * -.fi +.fi .I Note: In a cascading profile setup, you can remove packages in children profiles which were added by parent profiles by prefixing the atom with -a '-' +a '\-' .I Example: -.nf +.nf # i am a comment ! # only allow versions of glibc less than 2.3 -<sys-libs/glibc-2.3 +<sys\-libs/glibc\-2.3 # add any version of bash to the system class -*app-shells/bash +*app\-shells/bash # only allow versions of readline earlier than 4.2 # and add it to the system class -*<sys-libs/readline-4.2 -.fi -.TP +*<sys\-libs/readline\-4.2 +.fi +.TP .BR packages.build A list of packages (one per line) that make up a stage1 tarball. Really only useful for stage builders. -.TP +.TP .BR use.defaults -Here we DO NOT define the default USE flags, but the so-called auto-USE +Here we DO NOT define the default USE flags, but the so\-called auto\-USE flags. This rather unknown portage feature activates a USE flag if a specific package is installed and the flag was not explicitly deactivated. This file contains the associations between USE flags and -packages that trigger the auto-USE feature. +packages that trigger the auto\-USE feature. -In other words, if we never put "sdl" or "-sdl" into our USE, but we -have media-libs/libsdl emerged, then portage automagically sticks "sdl" +In other words, if we never put "sdl" or "\-sdl" into our USE, but we +have media\-libs/libsdl emerged, then portage automagically sticks "sdl" into our USE for us. .I Format: -.nf +.nf \- comments begin with # \- one USE flag per line with a list of DEPEND atom bases -.fi +.fi .I Example: -.nf -# media-libs/libsdl will activate "sdl" -sdl media-libs/libsdl +.nf +# media\-libs/libsdl will activate "sdl" +sdl media\-libs/libsdl # activate tcltk only if we have both -# dev-lang/tcl and dev-lang/tk -tcltk dev-lang/tcl dev-lang/tk -.fi -.TP +# dev\-lang/tcl and dev\-lang/tk +tcltk dev\-lang/tcl dev\-lang/tk +.fi +.TP .BR use.mask Some USE flags don't make sense on some archs (for example altivec on -non-ppc or mmx on non-x86). Here we list the masked ones. +non\-ppc or mmx on non\-x86). Here we list the masked ones. .I Format: -.nf +.nf \- comments begin with # \- one USE flag per line -.fi -.TP +.fi +.TP .BR virtuals This controls what packages will provide a virtual by default. For example, -if a package needs to send e-mail, it will need virtual/mta. In the absence +if a package needs to send e\-mail, it will need virtual/mta. In the absence of a package that provides virtual/mta (like qmail, sendmail, postfix, etc...), portage will look here to see what package to use. In this case, Gentoo uses -net-mail/ssmtp as the default (as defined in the virtuals file) because it's -the package that does the very bare minimum to send e-mail. +net\-mail/ssmtp as the default (as defined in the virtuals file) because it's +the package that does the very bare minimum to send e\-mail. .I Format: -.nf +.nf \- comments begin with # \- one virtual and DEPEND atom base pair per line -.fi +.fi .I Example: -.nf -# use net-mail/ssmtp as the default mta -virtual/mta net-mail/ssmtp -# use app-dicts/aspell-en as the default dictionary -virtual/aspell-dict app-dicts/aspell-en -.fi +.nf +# use net\-mail/ssmtp as the default mta +virtual/mta net\-mail/ssmtp +# use app\-dicts/aspell\-en as the default dictionary +virtual/aspell\-dict app\-dicts/aspell\-en +.fi .RE -.TP +.TP .BR /etc/portage/ .RS -.TP +.TP .BR bashrc If needed this file can be used to setup a different environment for ebuilds than the root environment. Syntax is the same as any other bash script. -.TP +.TP .BR package.mask List of DEPEND atoms to mask. Useful if specific versions of packages do not work well for you. For example, you swear by the Nvidia drivers, but only versions earlier than 1.0.4496. No problem! .I Format: -.nf +.nf \- comments begin with # \- one DEPEND atom per line -.fi +.fi .I Example: -.nf +.nf # mask out versions 1.0.4496 of the nvidia # drivers and later ->=media-video/nvidia-kernel-1.0.4496 ->=media-video/nvidia-glx-1.0.4496 -.fi -.TP +>=media\-video/nvidia\-kernel\-1.0.4496 +>=media\-video/nvidia\-glx\-1.0.4496 +.fi +.TP .BR package.unmask Just like package.mask above except here you list packages you want to unmask. Useful for overriding the global package.mask file (see below). Note that this does not override packages that are masked via KEYWORDS. -.TP +.TP .BR package.keywords Per package KEYWORDS. Useful for mixing unstable packages in with a normally stable machine or vice versa. This will allow you to augment ACCEPT_KEYWORDS for a single package. .I Format: -.nf +.nf \- comments begin with # \- one DEPEND atom per line followed by additional ACCEPT_KEYWORDS -.fi +.fi .I Example: -.nf +.nf # always use unstable libgd -media-libs/libgd ~x86 +media\-libs/libgd ~x86 # only use stable mplayer -media-video/mplayer -~x86 -# use a package that is marked -* ->=sys-kernel/linux-headers-2.6 -* -.fi -.TP +media\-video/mplayer \-~x86 +# use a package that is marked \-* +>=sys\-kernel/linux\-headers\-2.6 \-* +.fi +.TP .BR package.use -Per-package USE flags. Useful for tracking local USE flags or for +Per\-package USE flags. Useful for tracking local USE flags or for enabling USE flags for only certain packages. Perhaps you develop GTK and thus you want documentation for it, but you don't want documentation for QT. Easy as pie my friend! .I Format: -.nf +.nf \- comments begin with # \- one DEPEND atom per line followed by space separated list of USE flags -.fi +.fi .I Example: -.nf +.nf # turn on docs for GTK 2.x -=x11-libs/gtk+-2* doc +=x11\-libs/gtk+\-2* doc # disable mysql support for QT -x11-libs/qt -mysql -.fi -.TP +x11\-libs/qt \-mysql +.fi +.TP .BR mirrors Whenever portage encounters a mirror:// style URL it will look up the actual hosts here. If the mirror set is not found here, it will check the global @@ -312,13 +312,13 @@ before GENTOO_MIRRORS and be used even if the package has RESTRICT="nomirror". .I Format: -.nf +.nf \- comments begin with # \- mirror type followed by a list of hosts -.fi +.fi .I Example: -.nf +.nf # local private mirrors used only by my company local ftp://192.168.0.3/mirrors/gentoo http://192.168.0.4/distfiles @@ -327,62 +327,85 @@ sourceforge http://keihanna.dl.sourceforge.net/sourceforge # people in tawain would want to use the local gnu mirror first gnu ftp://ftp.nctu.edu.tw/UNIX/gnu/ -.fi -.TP +.fi +.TP .BR categories A simple list of valid categories that may be used in /usr/portage, PORTDIR_OVERLAY, and PKGDIR (see \fBmake.conf\fR(5)). This allows for custom categories to be created. .I Format: -.nf +.nf \- one category per line -.fi +.fi .I Example: -.nf -app-hackers -media-other -.fi +.nf +app\-hackers +media\-other +.TP +.BR virtuals +This controls what packages will provide a virtual by default. For example, +if a package needs to send e\-mail, it will need virtual/mta. In the absence +of a package that provides virtual/mta (like qmail, sendmail, postfix, etc...), +portage will look here to see what package to use. In this case, Gentoo uses +net\-mail/ssmtp as the default (as defined in the virtuals file) because it's +the package that does the very bare minimum to send e\-mail. + +.I Format: +.br +\- comments begin with # +.br +\- one virtual and DEPEND atom base pair per line + +.I Example: +.br +# use net\-mail/ssmtp as the default mta +.br +virtual/mta net\-mail/ssmtp +.br +# use app\-dicts/aspell\-en as the default dictionary +.br +virtual/aspell\-dict app\-dicts/aspell\-en .RE -.TP +.TP .BR /usr/portage/profiles/ Global Gentoo settings that are controlled by the developers. To override these settings, you can use the files in \fB/etc/portage/\fR. .RS -.TP +.TP .BR arch.list A list of all valid KEYWORDS. This does not include modifiers. .I Format: -.nf +.nf \- one KEYWORD per line -.fi +.fi .I Example: -.nf +.nf x86 ppc sparc -.fi -.TP +.fi +.TP .BR categories A simple list of valid categories that may be used in /usr/portage, PORTDIR_OVERLAY, and PKGDIR (see \fBmake.conf\fR(5)). .I Format: -.nf +.nf \- one category per line -.fi +.fi .I Example: -.nf -app-admin -dev-lang -games-strategy -sys-kernel -.fi -.TP +.nf +app\-admin +dev\-lang +games\-strategy +sys\-kernel +.fi +.TP .BR package.mask This contains a list of DEPEND atoms for packages that should not be installed in any profile. Useful for adding the latest KDE betas and making sure no @@ -391,109 +414,109 @@ versions due to security issues. ALWAYS include a comment explaining WHY the package has been masked and WHO is doing the masking. .I Format: -.nf +.nf \- comments begin with # \- one DEPEND atom per line -.fi +.fi .I Example: -.nf +.nf # masked for security reasons -<sys-libs/zlib-1.1.4 +<sys\-libs/zlib\-1.1.4 # <caleb@gentoo.org> (10 Sep 2003) # new kde betas -=kde-base/kde-3.2.0_beta1 -=kde-base/kdeaccessibility-3.2.0_beta1 -.fi -.TP +=kde\-base/kde\-3.2.0_beta1 +=kde\-base/kdeaccessibility\-3.2.0_beta1 +.fi +.TP .BR thirdpartymirrors Controls the mapping of mirror:// style URLs to actual lists of mirrors. Keeps us from overloading a single server. .I Format: -.nf +.nf \- comments begin with # \- mirror type followed by a list of hosts -.fi +.fi .I Example: -.nf +.nf sourceforge http://aleron.dl.sourceforge.net/sourceforge http://unc.dl.sourceforge.net/sourceforge gentoo http://distro.ibiblio.org/pub/linux/distributions/gentoo/distfiles/ ftp://ftp.gtlib.cc.gatech.edu/pub/gentoo/distfiles kernel http://www.kernel.org/pub http://www.us.kernel.org/pub -.fi -.TP +.fi +.TP .BR use.desc All global USE flags must be listed here with a description of what they do. .I Format: -.nf +.nf \- comments begin with # \- use flag \- some description -.fi +.fi .I Example: -.nf -3dfx - Adds support for 3dfx video cards -acl - Adds support for Access Control Lists -doc - Adds extra documentation -.fi -.TP +.nf +3dfx \- Adds support for 3dfx video cards +acl \- Adds support for Access Control Lists +doc \- Adds extra documentation +.fi +.TP .BR use.local.desc All local USE flags must be listed here along with the package and a description. .I Format: -.nf +.nf \- comments begin with # \- package:use flag \- description -.fi +.fi .I Example: -.nf -app-editors/nano:justify - Toggle the justify option -dev-games/clanlib:clanJavaScript - Enables javascript support -dev-libs/DirectFB:fusion - add Multi Application support -games-emulation/xmess:net - Add network support -.fi -.TP +.nf +app\-editors/nano:justify \- Toggle the justify option +dev\-games/clanlib:clanJavaScript \- Enables javascript support +dev\-libs/DirectFB:fusion \- add Multi Application support +games\-emulation/xmess:net \- Add network support +.fi +.TP .BR use.mask Just like the \fBuse.mask\fR found in \fB/etc/make.profile/\fR. See above for more information. .RE -.TP +.TP .BR /var/lib/portage/ .RS -.TP +.TP .BR world Every time you emerge a package, the package that you requested is -recorded here. Then when you run `emerge world -up`, the list of +recorded here. Then when you run `emerge world \-up`, the list of packages is read from this file. Note that this does not mean that the packages that were installed as dependencies are listed here. For example, if you run `emerge mod_php` and you do not have apache -already, then "dev-php/mod_php" is recorded in the world file but -"net-www/apache" is not. For more information, review \fBemerge\fR(1). +already, then "dev\-php/mod_php" is recorded in the world file but +"net\-www/apache" is not. For more information, review \fBemerge\fR(1). .I Format: -.nf +.nf \- one DEPEND atom base per line -.fi +.fi .I Example: -.nf -games-misc/fortune-mod-gentoo-dev -dev-libs/uclibc -app-cdr/cdemu -.fi +.nf +games\-misc/fortune\-mod\-gentoo\-dev +dev\-libs/uclibc +app\-cdr/cdemu +.fi .RE -.SH AUTHORS -.nf +.SH "AUTHORS" +.nf Marius Mauch <genone@gentoo.org> Mike Frysinger <vapier@gentoo.org> Drake Wyrm <wyrm@haell.com> -.fi +.fi .SH "REPORTING BUGS" Please report bugs via http://bugs.gentoo.org/ .SH "SEE ALSO" @@ -502,4 +525,4 @@ Please report bugs via http://bugs.gentoo.org/ .BR ebuild (5), .BR make.conf (5) .SH "CVS HEADER" -$Header: /local/data/ulm/cvs/history/var/cvsroot/gentoo-src/portage/man/portage.5,v 1.15 2004/09/17 00:17:10 vapier Exp $ +$Header: /local/data/ulm/cvs/history/var/cvsroot/gentoo-src/portage/man/portage.5,v 1.16 2004/10/03 17:56:19 genone Exp $ |