diff options
| -rw-r--r-- | man/dispatch-conf.1 | 2 | ||||
| -rw-r--r-- | man/ebuild.1 | 4 | ||||
| -rw-r--r-- | man/ebuild.5 | 8 | ||||
| -rw-r--r-- | man/emaint.1 | 2 | ||||
| -rw-r--r-- | man/emerge.1 | 154 | ||||
| -rw-r--r-- | man/env-update.1 | 6 | ||||
| -rw-r--r-- | man/etc-update.1 | 2 | ||||
| -rw-r--r-- | man/make.conf.5 | 64 | ||||
| -rw-r--r-- | man/portage.5 | 152 | ||||
| -rw-r--r-- | man/quickpkg.1 | 14 | ||||
| -rw-r--r-- | man/xpak.5 | 2 |
11 files changed, 205 insertions, 205 deletions
diff --git a/man/dispatch-conf.1 b/man/dispatch-conf.1 index e16d49ca2..3a5264a16 100644 --- a/man/dispatch-conf.1 +++ b/man/dispatch-conf.1 @@ -24,7 +24,7 @@ None. \fIdispatch\-conf\fR must be run as root, since the config files to be replaced are generally owned by root. Before running \fIdispatch\-conf\fR for the first time the settings in \fB/etc/dispatch\-conf.conf\fR -should be edited and the archive directory specified in +should be edited and the archive directory specified in \fB/etc/dispatch\-conf.conf\fR will need to be created. All changes to config files will be saved in the archive directory either as patches or using rcs, making restoration to an earlier version rather simple. diff --git a/man/ebuild.1 b/man/ebuild.1 index bc9d31b44..4bde66ead 100644 --- a/man/ebuild.1 +++ b/man/ebuild.1 @@ -74,7 +74,7 @@ for all of the files listed in SRC_URI for each ebuild. For further information regarding the behavior of this command, see the documentation for the \fIassume\-digests\fR value of the \fBFEATURES\fR variable in \fBmake.conf\fR(5). See the \fB\-\-force\fR option if you would like to -prevent digests from being assumed. +prevent digests from being assumed. .TP .BR unpack Extracts the sources to a subdirectory in the \fIbuild directory\fR @@ -112,7 +112,7 @@ current working directory will be set to ${S}. When src_compile() completes, the sources should be fully compiled. .TP .BR test -Runs package-specific test cases to verify that everything was built +Runs package-specific test cases to verify that everything was built properly. .TP .BR preinst diff --git a/man/ebuild.5 b/man/ebuild.5 index 10ef4eee0..a9f3498be 100644 --- a/man/ebuild.5 +++ b/man/ebuild.5 @@ -28,7 +28,7 @@ Examples: .TP .B Atom Versions It is nice to be more specific and say that only certain versions of atoms are -acceptable. Note that versions must be combined with a prefix (see below). +acceptable. Note that versions must be combined with a prefix (see below). Hence you may add a version number as a postfix to the base. Examples: @@ -41,9 +41,9 @@ Examples: Versions are normally made up of two or three numbers separated by periods, such as 1.2 or 4.5.2. This string may be followed by a character such as 1.2a or 4.5.2z. Note that this letter is \fInot\fR meant to indicate alpha, beta, -etc... status. For that, use the optional suffix; either _alpha, _beta, _pre -(pre\-release), _rc (release candidate), or _p (patch). This means for the -3rd pre\-release of a package, you would use something like 1.2_pre3. The +etc... status. For that, use the optional suffix; either _alpha, _beta, _pre +(pre\-release), _rc (release candidate), or _p (patch). This means for the +3rd pre\-release of a package, you would use something like 1.2_pre3. The suffixes here can be arbitrarily chained without limitation. .TP .B Atom Prefix Operators [> >= = <= <] diff --git a/man/emaint.1 b/man/emaint.1 index 3fae5c215..83562998f 100644 --- a/man/emaint.1 +++ b/man/emaint.1 @@ -39,7 +39,7 @@ Perform package move updates for installed packages. .TP .BR world Fix problems in the \fIworld\fR file. -.SH DEFAULT OPTIONS +.SH DEFAULT OPTIONS .TP .B \-c, \-\-check Check for any problems that may exist. (all commands) diff --git a/man/emerge.1 b/man/emerge.1 index 66f4360fd..45114149b 100644 --- a/man/emerge.1 +++ b/man/emerge.1 @@ -49,7 +49,7 @@ so this syntax shouldn't be used. .TP .BR tbz2file A \fItbz2file\fR must be a valid .tbz2 created with \fBebuild -<package>\-<version>.ebuild package\fR or \fBemerge \-\-buildpkg +<package>\-<version>.ebuild package\fR or \fBemerge \-\-buildpkg [category/]<package>\fR or \fBquickpkg /var/db/pkg/<category>/<package>\fR. .TP .BR file @@ -73,19 +73,19 @@ on the current configuration. The default set configuration is located in the \fB/usr/share/portage/config/sets\fR directory. User sets may be created by placing files in the \fB/etc/portage/sets/\fR directory (see \fBportage\fR(5)). Note that a \fIset\fR -is generally used in conjunction with \fB\-\-update\fR. When used as +is generally used in conjunction with \fB\-\-update\fR. When used as arguments to \fBemerge\fR sets have to be prefixed with \fB@\fR to be recognized. Use the \fB\-\-list\-sets\fR action to display a list of available package sets. .TP .BR atom -An \fIatom\fR describes bounds on a package that you wish to install. +An \fIatom\fR describes bounds on a package that you wish to install. \fISee ebuild(5) for the details on atom syntax.\fR For example, -\fB>=dev\-lang/python\-2.2.1\-r2\fR matches the latest available version of -Python greater than or equal to 2.2.1\-r2. Similarly, -\fB<dev\-lang/python\-2.0\fR matches the latest available version of Python -before 2.0. Note that in many shells you will need to escape characters such -as '<' and '='; use single\- or double\-quotes around the \fIatom\fR +\fB>=dev\-lang/python\-2.2.1\-r2\fR matches the latest available version of +Python greater than or equal to 2.2.1\-r2. Similarly, +\fB<dev\-lang/python\-2.0\fR matches the latest available version of Python +before 2.0. Note that in many shells you will need to escape characters such +as '<' and '='; use single\- or double\-quotes around the \fIatom\fR to get around escaping problems. .SH "ACTIONS" .TP @@ -113,8 +113,8 @@ remove unslotted packages. Note: Most recently installed means most \fBrecent\fR, not highest version. .TP .BR "\-\-config " -Run package specific actions needed to be executed after the emerge process -has completed. This usually entails configuration file setup or other similar +Run package specific actions needed to be executed after the emerge process +has completed. This usually entails configuration file setup or other similar setups that the user may wish to run. .TP .BR "\-\-depclean (-c)" @@ -164,9 +164,9 @@ updated more frequently than this man page; check it out if you are having problems that this man page does not help resolve. .TP .BR \-\-info -Produces a list of information to include in bug reports which aids the -developers when fixing the reported problem. \fBPlease include this -information when submitting a bug report.\fR Expanded output can be obtained +Produces a list of information to include in bug reports which aids the +developers when fixing the reported problem. \fBPlease include this +information when submitting a bug report.\fR Expanded output can be obtained with the \fI\-\-verbose\fR option. .TP .BR \-\-list\-sets @@ -191,14 +191,14 @@ the emerge output of the next \-\-depclean run carefully! Use \-\-depclean to avoid this issue.\fR .TP .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 update, rsync users may find it convenient to run -\fBemerge \-\-metadata\fR to rebuild the cache as portage does at the end of +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 update, 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. In order to specify parallel \fB\-\-regen\fR behavior, use the \fB\-\-jobs\fR and \fB\-\-load\-average\fR options. If you would like to generate and distribute cache for use by others, use \fBegencache\fR(1). @@ -222,14 +222,14 @@ explicitly discarded by running `emaint \-\-fix cleanresume` (see .TP .BR "\-\-search " (\fB\-s\fR) Searches for matches of the supplied string in the portage tree. -By default emerge uses a case-insensitive simple search, but you can +By default emerge uses a case-insensitive simple search, but you can enable a regular expression search by prefixing the search string with %. -For example, \fBemerge \-\-search "%^kde"\fR searches for any package whose -name 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 include the -category into the search string, prepend an @: \fBemerge \-\-search -"%@^dev-java.*jdk"\fR. If you want to search the package descriptions as well, +For example, \fBemerge \-\-search "%^kde"\fR searches for any package whose +name 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 include the +category into the search string, prepend an @: \fBemerge \-\-search +"%@^dev-java.*jdk"\fR. If you want to search the package descriptions as well, use the \fB\-\-searchdesc\fR action. .TP .BR "\-\-searchdesc " (\fB\-S\fR) @@ -379,7 +379,7 @@ possible ways to enable building of binary packages. .TP .BR "\-\-buildpkgonly " (\fB\-B\fR) Creates binary packages for all ebuilds processed without actually -merging the packages. This comes with the caveat that all build-time +merging the packages. This comes with the caveat that all build-time dependencies must already be emerged on the system. .TP .BR "\-\-changed\-use" @@ -403,7 +403,7 @@ Enable or disable color output. This option will override \fINOCOLOR\fR is not a tty (by default, color is disabled unless stdout is a tty). .TP .BR "\-\-columns" -Used alongside \fB\-\-pretend\fR to cause the package name, new version, +Used alongside \fB\-\-pretend\fR to cause the package name, new version, and old version to be displayed in an aligned format for easy cut\-n\-paste. .TP .BR "\-\-complete\-graph [ y | n ]" @@ -432,7 +432,7 @@ Set the \fBPORTAGE_CONFIGROOT\fR environment variable. .TP .BR "\-\-debug " (\fB\-d\fR) Tells emerge to run the emerge command in \fB\-\-debug\fR mode. In this -mode the bash build environment will run with the \-x option, causing +mode the bash build environment will run with the \-x option, causing it to output verbose debugging information to stdout. This also enables a plethora of other output (mostly dependency resolution messages). .TP @@ -500,10 +500,10 @@ Instead of doing any package building, just perform fetches for all packages (fetch everything in SRC_URI regardless of USE setting). .TP .BR "\-\-getbinpkg [ y | n ] (\-g short option)" -Using the server and location defined in \fIPORTAGE_BINHOST\fR (see -\fBmake.conf\fR(5)), portage will download the information from each binary -package found and it will use that information to help build the dependency -list. This option implies \fB\-k\fR. (Use \fB\-gK\fR for binary\-only +Using the server and location defined in \fIPORTAGE_BINHOST\fR (see +\fBmake.conf\fR(5)), portage will download the information from each binary +package found and it will use that information to help build the dependency +list. This option implies \fB\-k\fR. (Use \fB\-gK\fR for binary\-only merging.) .TP .BR "\-\-getbinpkgonly [ y | n ] (\-G short option)" @@ -648,7 +648,7 @@ the printout: .TS lI l. N new (not yet installed) -S new SLOT installation (side-by-side versions) +S new SLOT installation (side-by-side versions) U updating (to another version) D downgrading (best version seems lower) r reinstall (forced for some reason, possibly due to slot or sub\-slot) @@ -778,7 +778,7 @@ Use \fB\-\-selective=n\fR if you want to forcefully disable \fB\-\-newuse\fR, \fB\-\-noreplace\fR, or \fB\-\-update\fR. .TP .BR "\-\-skipfirst" -This option is only valid when used with \fB\-\-resume\fR. It removes the +This option is only valid when used with \fB\-\-resume\fR. It removes the first package in the resume list. Dependencies are recalculated for remaining packages and any that have unsatisfied dependencies or are masked will be automatically dropped. Also see the related @@ -786,7 +786,7 @@ masked will be automatically dropped. Also see the related .TP .BR "\-\-tree " (\fB\-t\fR) Shows the dependency tree for the given target by indenting dependencies. -This is only really useful in combination with \fB\-\-emptytree\fR or +This is only really useful in combination with \fB\-\-emptytree\fR or \fB\-\-update\fR and \fB\-\-deep\fR. .TP .BR "\-\-unordered\-display" @@ -812,21 +812,21 @@ A space separated list of package names or slot atoms. Emerge will prefer matching binary packages over newer unbuilt packages. .TP .BR "\-\-usepkg [ y | n ] (\-k short option)" -Tells emerge to use binary packages (from $PKGDIR) if they are available, thus -possibly avoiding some time\-consuming compiles. This option is useful for CD -installs; you can export PKGDIR=/mnt/cdrom/packages and then use this option to +Tells emerge to use binary packages (from $PKGDIR) if they are available, thus +possibly avoiding some time\-consuming compiles. This option is useful for CD +installs; you can export PKGDIR=/mnt/cdrom/packages and then use this option to have emerge "pull" binary packages from the CD in order to satisfy dependencies. .TP .BR "\-\-usepkgonly [ y | n ] (\-K short option)" -Tells emerge to only use binary packages (from $PKGDIR). All the binary -packages must be available at the time of dependency calculation or emerge -will simply abort. Portage does not use $PORTDIR when calculating dependency +Tells emerge to only use binary packages (from $PKGDIR). All the binary +packages must be available at the time of dependency calculation or emerge +will simply abort. Portage does not use $PORTDIR when calculating dependency information so all masking information is ignored. .TP .BR "\-\-verbose [ y | n ] (\-v short option)" -Tell emerge to run in verbose mode. Currently this flag causes emerge to print -out GNU info errors, if any, and to show the USE flags that will be used for +Tell emerge to run in verbose mode. Currently this flag causes emerge to print +out GNU info errors, if any, and to show the USE flags that will be used for each package when pretending. The following symbols are affixed to USE flags in order to indicate their status: @@ -871,14 +871,14 @@ option or in \fBmake.conf\fR(5) (the command line overrides other settings). Defaults to /. .TP \fBPORTAGE_CONFIGROOT\fR = \fI[path]\fR -Use \fBPORTAGE_CONFIGROOT\fR to specify the location for various portage +Use \fBPORTAGE_CONFIGROOT\fR to specify the location for various portage configuration files (see \fBFILES\fR for a detailed list of configuration files). This variable can be set via the \fB\-\-config\-root\fR option. .br Defaults to /. .SH "OUTPUT" -When utilizing \fBemerge\fR with the \fB\-\-pretend\fR and \fB\-\-verbose\fR +When utilizing \fBemerge\fR with the \fB\-\-pretend\fR and \fB\-\-verbose\fR flags, the output may be a little hard to understand at first. This section explains the abbreviations. .TP @@ -893,34 +893,34 @@ simultaneously emerged because they usually provide the same functionality. Qstat is New to your system, and will be emerged for the first time. .TP .B [ebuild NS ] dev-libs/glib-2.4.7 -You already have a version of glib installed, but a 'new' version in +You already have a version of glib installed, but a 'new' version in a different SLOT is available. .TP .B [ebuild R ] sys\-apps/sed\-4.0.5 -Sed 4.0.5 has already been emerged, but if you run the command, then +Sed 4.0.5 has already been emerged, but if you run the command, then portage will Re\-emerge the specified package (sed in this case). .TP .B [ebuild F ] media\-video/realplayer\-8\-r6 -The realplayer package requires that you Fetch the sources manually. -When you attempt to emerge the package, if the sources are not found, -then portage will halt and you will be provided with instructions on how +The realplayer package requires that you Fetch the sources manually. +When you attempt to emerge the package, if the sources are not found, +then portage will halt and you will be provided with instructions on how to download the required files. .TP .B [ebuild f ] media\-video/realplayer\-8\-r6 The realplayer package's files are already downloaded. .TP .B [ebuild U ] net\-fs/samba\-2.2.8_pre1 [2.2.7a] -Samba 2.2.7a has already been emerged and can be Updated to version +Samba 2.2.7a has already been emerged and can be Updated to version 2.2.8_pre1. .TP .B [ebuild UD] media\-libs/libgd\-1.8.4 [2.0.11] -Libgd 2.0.11 is already emerged, but if you run the command, then +Libgd 2.0.11 is already emerged, but if you run the command, then portage will Downgrade to version 1.8.4 for you. -.br +.br This may occur if a newer version of a package has been masked because it is broken or it creates a security risk on your system and a fix has not been released yet. -.br +.br Another reason this may occur is if a package you are trying to emerge requires an older version of a package in order to emerge successfully. In this case, libgd 2.x is incompatible with libgd 1.x. This means that packages that were @@ -981,14 +981,14 @@ globally via \fBACCEPT_KEYWORDS\fR. .SH "NOTES" -You should almost always precede any package install or update attempt with a -\fB\-\-pretend\fR install or update. This lets you see how much will be -done, and shows you any blocking packages that you will have to rectify. -This goes doubly so for the \fBsystem\fR and \fBworld\fR sets, which can -update a large number of packages if the portage tree has been particularly +You should almost always precede any package install or update attempt with a +\fB\-\-pretend\fR install or update. This lets you see how much will be +done, and shows you any blocking packages that you will have to rectify. +This goes doubly so for the \fBsystem\fR and \fBworld\fR sets, which can +update a large number of packages if the portage tree has been particularly active. .LP -You also want to typically use \fB\-\-update\fR, which ignores packages that +You also want to typically use \fB\-\-update\fR, which ignores packages that are already fully updated but updates those that are not. .LP When you install a package with uninstalled dependencies and do @@ -1003,7 +1003,7 @@ avoid using some dependencies you may not want to have. \fBUSE flags specified on the command line are NOT remembered\fR. For example, \fBenv USE="\-X \-gnome" emerge mc\fR will emerge mc with those USE settings (on Bourne-compatible shells you may omit the \fBenv\fR -part). If you want those USE settings to be more +part). If you want those USE settings to be more permanent, you can put them in /etc/portage/package.use instead. .LP If \fBemerge \-\-update @system\fR or \fBemerge \-\-update @world\fR @@ -1021,7 +1021,7 @@ Masks in \fBportage\fR have many uses: they allow a testing period where the packages can be used in live machines; they prevent the use of a package when it will fail; and they mask existing packages that are broken or could pose a security risk. Read below -to find out how to unmask in various cases. Also note that if you give +to find out how to unmask in various cases. Also note that if you give \fBemerge\fR an ebuild, then all forms of masking will be ignored and \fBemerge\fR will attempt to emerge the package. .TP @@ -1047,15 +1047,15 @@ that are not supported by the current version of portage. Packages masked by \fBEAPI\fR can only be installed after portage has been upgraded. .TP .BR KEYWORDS -The \fBKEYWORDS\fR variable in an \fBebuild\fR file is also used for masking -a package still in testing. There are architecture\-specific keywords for -each package that let \fBportage\fR know which systems are compatible with -the package. Packages which compile on an architecture, but have not been -proven to be "stable", are masked with a tilde (\fB~\fR) in front of the -architecture name. \fBemerge\fR examines the \fBACCEPT_KEYWORDS\fR environment -variable to allow or disallow the emerging of a package masked by -\fBKEYWORDS\fR. To inform \fBemerge\fR that it should build these 'testing' -versions of packages, you should update your +The \fBKEYWORDS\fR variable in an \fBebuild\fR file is also used for masking +a package still in testing. There are architecture\-specific keywords for +each package that let \fBportage\fR know which systems are compatible with +the package. Packages which compile on an architecture, but have not been +proven to be "stable", are masked with a tilde (\fB~\fR) in front of the +architecture name. \fBemerge\fR examines the \fBACCEPT_KEYWORDS\fR environment +variable to allow or disallow the emerging of a package masked by +\fBKEYWORDS\fR. To inform \fBemerge\fR that it should build these 'testing' +versions of packages, you should update your \fI/etc/portage/package.accept_keywords\fR file to list the packages you want the \'testing\' version. See \fBportage\fR(5) for more information. @@ -1146,7 +1146,7 @@ Zac Medico <zmedico@gentoo.org> Arfrever Frehtes Taifersar Arahesis <arfrever@apache.org> .fi .SH "FILES" -Here is a common list of files you will probably be interested in. For a +Here is a common list of files you will probably be interested in. For a complete listing, please refer to the \fBportage\fR(5) man page. .TP .B /usr/share/portage/config/sets/ @@ -1173,7 +1173,7 @@ Contains variables customizing colors. Contains user package set definitions (see \fBportage\fR(5)). .TP .B /etc/dispatch\-conf.conf -Contains settings to handle automatic updates/backups of configuration +Contains settings to handle automatic updates/backups of configuration files. .TP .B /etc/portage/make.profile/make.defaults @@ -1206,5 +1206,5 @@ this file\fR. .LP A number of helper applications reside in \fI/usr/lib/portage/bin\fR. .LP -The \fBapp\-portage/gentoolkit\fR package contains useful scripts such as +The \fBapp\-portage/gentoolkit\fR package contains useful scripts such as \fBequery\fR (a package query tool). diff --git a/man/env-update.1 b/man/env-update.1 index 505152443..9ceddab1a 100644 --- a/man/env-update.1 +++ b/man/env-update.1 @@ -10,9 +10,9 @@ reads the files in \fI/etc/env.d\fR and automatically generates is run to update \fI/etc/ld.so.cache\fR. \fBenv-update\fR is run by \fBemerge\fR(1) automatically after each package merge. Also, if you make changes to \fI/etc/env.d\fR, you should run \fBenv-update\fR -yourself for changes to take effect immediately. Note that this would -only affect new processes. In order for the changes to affect your -active shell, you will probably have to run \fIsource /etc/profile\fR +yourself for changes to take effect immediately. Note that this would +only affect new processes. In order for the changes to affect your +active shell, you will probably have to run \fIsource /etc/profile\fR first. .SH "OPTIONS" .TP diff --git a/man/etc-update.1 b/man/etc-update.1 index 2662de57a..71900da4a 100644 --- a/man/etc-update.1 +++ b/man/etc-update.1 @@ -7,7 +7,7 @@ etc\-update \- handle configuration file updates .SH "DESCRIPTION" \fIetc\-update\fR is supposed to be run after merging a new package to see if there are updates to the configuration files. If a new -configuration file will override an old one, +configuration file will override an old one, \fIetc\-update\fR will prompt the user for a decision. .PP \fIetc\-update\fR will check all directories specified on the command diff --git a/man/make.conf.5 b/man/make.conf.5 index f75e27754..236fdf0c4 100644 --- a/man/make.conf.5 +++ b/man/make.conf.5 @@ -37,7 +37,7 @@ Defaults to the value of $CHOST. \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 -set this to '~ppc'. This is an incremental variable. Only define a +set this to '~ppc'. This is an incremental variable. Only define a ~arch. .br Defaults to the value of $ARCH. @@ -68,7 +68,7 @@ This variable is used to mask packages based on PROPERTIES restrictions. In addition to property names, the \fI*\fR and \fI-*\fR wildcard tokens are also supported. This variable can be temporarily overridden using the \fB\-\-accept\-properties\fR option of \fBemerge\fR(1). -See \fBebuild\fR(5) for more information about PROPERTIES. +See \fBebuild\fR(5) for more information about PROPERTIES. .br Defaults to the value of *. .br @@ -109,7 +109,7 @@ man page for more information. Defaults to /var/tmp/ccache .TP \fBCCACHE_SIZE\fR = \fI"size"\fR -This controls the space use limitations for ccache. The default is 2 gigabytes +This controls the space use limitations for ccache. The default is 2 gigabytes ('2G'). Sizes are specified with 'G', 'M', or 'K'. .TP .B CFLAGS CXXFLAGS @@ -229,7 +229,7 @@ should not be disabled by default. .RS .TP .B assume\-digests -When commiting work to cvs with \fBrepoman\fR(1), assume that all existing +When commiting work to cvs with \fBrepoman\fR(1), assume that all existing SRC_URI digests are correct. This feature also affects digest generation via \fBebuild\fR(1) and \fBemerge\fR(1) (emerge generates digests only when the \fIdigest\fR feature is enabled). Existing digests for files that do not exist @@ -256,8 +256,8 @@ Enable a special progress indicator when \fBemerge\fR(1) is calculating dependencies. .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 +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. \fBWarning\fR: This feature is known to cause numerous compilation failures. @@ -344,7 +344,7 @@ Both the \fBebuild\fR(1) command and the \fInoclean\fR feature cause the \fIfail\-clean\fR feature to be automatically disabled. .TP .B getbinpkg -Force emerges to always try to fetch files from the \fIPORTAGE_BINHOST\fR. See +Force emerges to always try to fetch files from the \fIPORTAGE_BINHOST\fR. See \fBmake.conf\fR(5) for more information. .TP .B installsources @@ -475,10 +475,10 @@ selectively disable this feature. It is recommended to leave either since otherwise file collisions between packages may result in files being overwritten or uninstalled at inappropriate times. If \fIcollision\-protect\fR is enabled then it takes precedence over -\fIprotect\-owned\fR. +\fIprotect\-owned\fR. .TP .B python\-trace -Output a verbose trace of python execution to stderr when a command's +Output a verbose trace of python execution to stderr when a command's \-\-debug option is enabled. .TP .B sandbox @@ -488,14 +488,14 @@ Enable sandbox\-ing when running \fBemerge\fR(1) and \fBebuild\fR(1). Enable SELinux sandbox\-ing. Do not toggle this \fBFEATURE\fR yourself. .TP .B sfperms -Stands for Smart Filesystem Permissions. Before merging packages to the -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. +Stands for Smart Filesystem Permissions. Before merging packages to the +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 .B sign -When commiting work to cvs with \fBrepoman\fR(1), sign the Manifest with +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 @@ -512,20 +512,20 @@ incompatibility. Store logs created by \fBPORTAGE_ELOG_SYSTEM="save"\fR in category subdirectories of \fBPORT_LOGDIR/elog\fR, instead of using \fBPORT_LOGDIR/elog\fR directly. -.TP +.TP .B split\-log Store build logs in category subdirectories of \fBPORT_LOGDIR/build\fR, instead of using \fBPORT_LOGDIR\fR directly. .TP .B splitdebug -Prior to stripping ELF etdyn and etexec files, the debugging info is +Prior to stripping ELF etdyn and etexec files, the debugging info is stored for later use by various debuggers. This feature is disabled by \fBnostrip\fR. You should also consider setting \fBcompressdebug\fR so the files don't suck up a lot of space. For installation of source code, see \fBinstallsources\fR. .TP .B strict -Have portage react strongly to conditions that have the potential to be +Have portage react strongly to conditions that have the potential to be dangerous (like missing or incorrect digests for ebuilds). .TP .B stricter @@ -534,12 +534,12 @@ security provisions (for example textrels, executable stack). Read about the \fIQA_STRICT_*\fR variables in \fBmake.conf\fR(5). .TP .B suidctl -Before merging packages to the live filesystem, automatically strip setuid +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 .B test -Run package\-specific tests during each merge to help make sure -the package compiled properly. See \fItest\fR in \fBebuild\fR(1) +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). This feature implies the "test" \fBUSE\fR flag if it is a member of \fBIUSE\fR, either explicitly or implicitly (see \fBebuild\fR(5) for more information about \fBIUSE\fR). @@ -577,7 +577,7 @@ When portage is run as root, drop privileges to portage:portage during the fetching of package sources. .TP .B userpriv -Allow portage to drop root privileges and compile packages as +Allow portage to drop root privileges and compile packages as portage:portage without a sandbox (unless \fIusersandbox\fR is also used). .TP .B usersandbox @@ -653,7 +653,7 @@ enabled for these flags may be closed as INVALID. .TP .B MAKEOPTS 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 +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. In order to avoid excess load, the \fB\-\-load\-average\fR option is recommended. @@ -698,7 +698,7 @@ This is a list of hosts from which portage will grab prebuilt\-binary packages. Each entry in the list must specify the full address of a directory serving tbz2's for your system (this directory must contain a 'Packages' index file). This is only used when running with -the get binary pkg options are given to \fBemerge\fR. Review \fBemerge\fR(1) +the get binary pkg options are given to \fBemerge\fR. Review \fBemerge\fR(1) for more information. .TP \fBPORTAGE_BINHOST_HEADER_URI\fR = \ @@ -850,7 +850,7 @@ Additional rsync options to be used by \fBemerge \-\-sync\fR. Defaults to no value. .TP \fBPORTAGE_RSYNC_OPTS\fR = \fI[rsync options string]\fR -Default rsync options to be used by \fBemerge \-\-sync\fR. +Default rsync options to be used by \fBemerge \-\-sync\fR. .br \fBDon't change this unless you know exactly what you're doing!\fR .br @@ -908,7 +908,7 @@ Defines the location of the Portage tree. This is the repository for all profile information as well as all ebuilds. If you change this, you must update your /etc/portage/make.profile symlink accordingly. .br -Defaults to /usr/portage. +Defaults to /usr/portage. .br \fB***Warning***\fR .br @@ -916,13 +916,13 @@ Data stored inside \fBPORTDIR\fR is in peril of being overwritten or deleted by the emerge \-\-sync command. The default value of \fBPORTAGE_RSYNC_OPTS\fR will protect the default locations of \fBDISTDIR\fR and \fBPKGDIR\fR, but users are warned that any other locations -inside \fBPORTDIR\fR are not necessarily safe for data storage. You should not -put other data (such as overlays) in your \fBPORTDIR\fB. Portage will walk +inside \fBPORTDIR\fR are not necessarily safe for data storage. You should not +put other data (such as overlays) in your \fBPORTDIR\fB. Portage will walk directory structures and may arbitrarily add invalid categories as packages. .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 +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 directories. .br Defaults to no value. @@ -959,9 +959,9 @@ be necessary in order to continue a partially downloaded file located at \\${DISTDIR}/\\${FILE}. .TP \fBROOT\fR = \fI[path]\fR -Use \fBROOT\fR to specify the target root filesystem to be used for merging +Use \fBROOT\fR to specify the target root filesystem to be used for merging packages or ebuilds. -Typically, you should set this setting in the environment rather than in +Typically, you should set this setting in the environment rather than in \fImake.conf\fR itself. It's commonly used for creating new build images. Make sure you use an absolute path. Refer to the \fBCross-compilation\fR section of \fBebuild\fR(5) for information about @@ -1085,6 +1085,6 @@ Contains a list of all local USE variables. .BR ebuild (1), .BR ebuild (5) .TP -The \fI/usr/sbin/ebuild.sh\fR script. +The \fI/usr/sbin/ebuild.sh\fR script. .TP The helper apps in \fI/usr/lib/portage/bin\fR. diff --git a/man/portage.5 b/man/portage.5 index 827c50402..38c6d8ca3 100644 --- a/man/portage.5 +++ b/man/portage.5 @@ -2,16 +2,16 @@ .SH NAME portage \- the heart of Gentoo .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 +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 is a reference only for files which do not already have a man page. -All files in the make.profile directory may be tweaked via parent profiles -when using cascading profiles. For more info, please see +All files in the make.profile directory may be tweaked via parent profiles +when using cascading profiles. For more info, please see http://www.gentoo.org/proj/en/releng/docs/cascading-profiles.xml .IP Note: -If you are looking for information on how to emerge something, please see +If you are looking for information on how to emerge something, please see .BR emerge (1). .SH "SYNOPSIS" .TP @@ -122,8 +122,8 @@ world world_sets .fi .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 +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 @@ -132,7 +132,7 @@ An atom is either of the form category/package or consists of an operator followed by category/package followed by a hyphen and a version specification. An atom might be suffixed by a slot specification. .br -More reading: +More reading: .BR ebuild (5) .B Extended Atom Syntax @@ -188,26 +188,26 @@ net\-*/* .B KEYWORD Each architecture has a unique KEYWORD. .br -More reading: +More reading: .BR ebuild (5) .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 +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 -More reading: +More reading: .BR ebuild (5) .RE .SH "SPECIFIC FILE DESCRIPTIONS" .TP \fB/etc/portage/make.profile/\fR or \fB/etc/make.profile/\fR -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 -what a profile is (usually arch specific stuff). If you need a custom -profile, then you should make your own \fBmake.profile\fR -directory and populate it. However, if you just wish to override some +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 +what a profile is (usually arch specific stuff). If you need a custom +profile, then you should make your own \fBmake.profile\fR +directory and populate it. However, if you just wish to override some settings, use \fB/etc/portage/profile/\fR (it supports all of the same file types that \fBmake.profile\fR does, except parent). Do NOT edit the settings in \fBmake.profile\fR because they WILL be lost with the next @@ -230,9 +230,9 @@ ${PORTDIR}/profiles/package.mask/testing .RS .TP .BR deprecated -The existence of this file marks a profile as deprecated, meaning it is -not supported by Gentoo anymore. The first line must be the profile to which -users are encouraged to upgrade, optionally followed by some instructions +The existence of this file marks a profile as deprecated, meaning it is +not supported by Gentoo anymore. The first line must be the profile to which +users are encouraged to upgrade, optionally followed by some instructions explaining how they can upgrade. .I Example: @@ -255,8 +255,8 @@ previously supported USE configuration files, except that they only influence packages that are merged due to a stable keyword. .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 +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 few specific variables too: .PD 0 @@ -317,11 +317,11 @@ Defines USERLAND values used to generate implicit Support uClibc/BSD libc/etc... .TP .B PROFILE_ONLY_VARIABLES = \fI"ARCH"\fR -Prevent critical variables from being changed by the user in make.conf +Prevent critical variables from being changed by the user in make.conf or the env. .TP .BR PROFILE_ARCH -Distinguish machines classes that have the same \fBARCH\fR. All sparc +Distinguish machines classes that have the same \fBARCH\fR. All sparc machines have ARCH=sparc but set this to either 'sparc32' or 'sparc64'. .TP .BR BOOTSTRAP_USE @@ -340,8 +340,8 @@ Provides the list of packages that compose the special \fIsystem\fR set. \- atoms without * only appear for legacy reasons .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 +In a cascading profile setup, you can remove packages in children +profiles which were added by parent profiles by prefixing the atom with a '\-'. .I Example: @@ -356,16 +356,16 @@ a '\-'. .fi .TP .BR packages.build -A list of packages (one per line) that make up a stage1 tarball. Really only +A list of packages (one per line) that make up a stage1 tarball. Really only useful for stage builders. .TP .BR package.provided -A list of packages (one per line) that portage should assume have been +A list of packages (one per line) that portage should assume have been provided. Useful for porting to non-Linux systems. Basically, it's a list that replaces the \fBemerge \-\-inject\fR syntax. -For example, if you manage your own copy of a 2.6 kernel, then you can -tell portage that 'sys-kernel/development-sources-2.6.7' is already taken +For example, if you manage your own copy of a 2.6 kernel, then you can +tell portage that 'sys-kernel/development-sources-2.6.7' is already taken care of and it should get off your back about it. Portage will not attempt to update a package that is listed here unless @@ -406,8 +406,8 @@ x11-base/xorg-x11-6.8 Per\-package USE flag forcing. .I Note: -In a cascading profile setup, you can remove USE flags in children -profiles which were added by parent profiles by prefixing the flag with +In a cascading profile setup, you can remove USE flags in children +profiles which were added by parent profiles by prefixing the flag with a '\-'. .I Format: @@ -428,8 +428,8 @@ x11\-libs/qt \-mysql Per\-package USE flag masks. .I Note: -In a cascading profile setup, you can remove USE flags in children -profiles which were added by parent profiles by prefixing the flag with +In a cascading profile setup, you can remove USE flags in children +profiles which were added by parent profiles by prefixing the flag with a '\-'. .I Format: @@ -470,8 +470,8 @@ Some USE flags don't make sense to disable under certain conditions. Here we list forced flags. .I Note: -In a cascading profile setup, you can remove USE flags in children -profiles which were added by parent profiles by prefixing the flag with +In a cascading profile setup, you can remove USE flags in children +profiles which were added by parent profiles by prefixing the flag with a '\-'. .I Format: @@ -481,13 +481,13 @@ a '\-'. .fi .TP \fBuse.mask\fR and \fBuse.stable.mask\fR -Some USE flags don't make sense on some archs (for example altivec on -non\-ppc or mmx on non\-x86), or haven't yet been tested. Here we list +Some USE flags don't make sense on some archs (for example altivec on +non\-ppc or mmx on non\-x86), or haven't yet been tested. Here we list the masked ones. .I Note: -In a cascading profile setup, you can remove USE flags in children -profiles which were added by parent profiles by prefixing the flag with +In a cascading profile setup, you can remove USE flags in children +profiles which were added by parent profiles by prefixing the flag with a '\-'. .I Format: @@ -529,8 +529,8 @@ virtual/aspell\-dict app\-dicts/aspell\-en .RE .TP .BR /etc/portage/ -Any file in this directory that begins with "package." can be more than just a -flat file. If it is a directory, then all the files in that directory will be +Any file in this directory that begins with "package." can be more than just a +flat file. If it is a directory, then all the files in that directory will be sorted in ascending alphabetical order by file name and summed together as if it were a single file. @@ -550,8 +550,8 @@ any other bash script. Additional package-specific bashrc files can be created in /etc/portage/env. .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 +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: @@ -572,11 +572,11 @@ Contains variables customizing colors. See \fBcolor.map\fR(5). The global custom settings for Portage. See \fBmake.conf\fR(5). .TP .BR mirrors -Whenever portage encounters a mirror:// style URI it will look up the actual -hosts here. If the mirror set is not found here, it will check the global -mirrors file at /usr/portage/profiles/thirdpartymirrors. You may also set a -special mirror type called "local". This list of mirrors will be checked -before GENTOO_MIRRORS and will be used even if the package has +Whenever portage encounters a mirror:// style URI it will look up the actual +hosts here. If the mirror set is not found here, it will check the global +mirrors file at /usr/portage/profiles/thirdpartymirrors. You may also set a +special mirror type called "local". This list of mirrors will be checked +before GENTOO_MIRRORS and will be used even if the package has RESTRICT="mirror" or RESTRICT="fetch". .I Format: @@ -654,8 +654,8 @@ three special tokens: .fi .I Additional Note: -If you encounter the \fB-*\fR KEYWORD, this indicates that the package is known -to be broken on all systems which are not otherwise listed in KEYWORDS. For +If you encounter the \fB-*\fR KEYWORD, this indicates that the package is known +to be broken on all systems which are not otherwise listed in KEYWORDS. For example, a binary only package which is built for x86 will look like: games-fps/quake3-demo-1.11.ebuild:KEYWORDS="-* x86" @@ -735,15 +735,15 @@ a single package. .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 -above). Note that this does not override packages that are masked via +Just like package.mask above, except here you list packages you want to +unmask. Useful for overriding the global package.mask file (see +above). Note that this does not override packages that are masked via KEYWORDS. .TP .BR package.use -Per\-package USE flags. Useful for tracking local USE flags or for -enabling USE flags for certain packages only. Perhaps you develop GTK -and thus you want documentation for it, but you don't want +Per\-package USE flags. Useful for tracking local USE flags or for +enabling USE flags for certain packages only. 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: @@ -1040,7 +1040,7 @@ profile\-formats = portage-2 .RE .TP .BR /usr/portage/profiles/ -Global Gentoo settings that are controlled by the developers. To override +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 @@ -1060,7 +1060,7 @@ sparc .fi .TP .BR categories -A simple list of valid categories that may be used in /usr/portage, +A simple list of valid categories that may be used in /usr/portage, PORTDIR_OVERLAY, and PKGDIR (see \fBmake.conf\fR(5)). .I Format: @@ -1130,10 +1130,10 @@ net-analyzer/netcat -* .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 -one accidentally upgrades to them. Also useful for quickly masking specific -versions due to security issues. ALWAYS include a comment explaining WHY the +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 +one accidentally upgrades to them. Also useful for quickly masking specific +versions due to security issues. ALWAYS include a comment explaining WHY the package has been masked and WHO is doing the masking. .I Format: @@ -1153,7 +1153,7 @@ package has been masked and WHO is doing the masking. .fi .TP .BR profiles.desc -List all the current stable and development profiles. If a profile is listed +List all the current stable and development profiles. If a profile is listed here, then it will be checked by repoman. .I Format: .nf @@ -1179,7 +1179,7 @@ hyphen. If the repo\-name attribute is specified in layout.conf, then that setting will take precedence. .TP .BR thirdpartymirrors -Controls the mapping of mirror:// style URIs to actual lists of +Controls the mapping of mirror:// style URIs to actual lists of mirrors. Keeps us from overloading a single server. .I Format: @@ -1200,7 +1200,7 @@ kernel http://www.kernel.org/pub http://www.us.kernel.org/pub .fi .TP .BR use.desc -All global USE flags must be listed here with a description of what they do. +All global USE flags must be listed here with a description of what they do. .I Format: .nf @@ -1216,7 +1216,7 @@ doc \- Adds extra documentation .fi .TP .BR use.local.desc -All local USE flags are listed here along with the package and a +All local USE flags are listed here along with the package and a description. This file is automatically generated from the metadata.xml files that are included with each individual package. Refer to GLEP 56 for further information: @@ -1238,7 +1238,7 @@ games\-emulation/xmess:net \- Adds network support .RS .TP .BR make.globals -The global default settings for Portage. This comes from the portage package +The global default settings for Portage. This comes from the portage package itself. Settings in \fBmake.conf\fR or \fBpackage.env\fR override values set here. The format is described extensively in \fBmake.conf\fR(5). .TP @@ -1290,12 +1290,12 @@ directories have been modified since being installed. Files which have not been modified will automatically be unmerged. .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 -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_wsgi` and you do not have apache -already, then "www\-apache/mod_wsgi" is recorded in the world file but +Every time you emerge a package, the package that you requested is +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_wsgi` and you do not have apache +already, then "www\-apache/mod_wsgi" is recorded in the world file but "www\-servers/apache" is not. For more information, review \fBemerge\fR(1). .I Format: diff --git a/man/quickpkg.1 b/man/quickpkg.1 index 0d3016367..a3f6165e4 100644 --- a/man/quickpkg.1 +++ b/man/quickpkg.1 @@ -7,16 +7,16 @@ quickpkg \- creates portage packages .I quickpkg can be utilized to quickly create a package for portage by utilizing the files already on your filesystem. This package -then can be emerged on any system. To review syntax for +then can be emerged on any system. To review syntax for emerging binary packages, review \fBemerge\fR(1). The upside -of this process is that you don't have to wait for the package -to unpack, configure, compile, and install before you can have -the package ready to go. The downside is that the package will -contain the files that exist on your filesystem even if they have +of this process is that you don't have to wait for the package +to unpack, configure, compile, and install before you can have +the package ready to go. The downside is that the package will +contain the files that exist on your filesystem even if they have modified since they were first installed. .br -The packages, after being created, will be placed in \fBPKGDIR\fR. -This variable is defined in \fBmake.conf\fR(5) and defaults to +The packages, after being created, will be placed in \fBPKGDIR\fR. +This variable is defined in \fBmake.conf\fR(5) and defaults to /usr/portage/packages. .SH OPTIONS .TP diff --git a/man/xpak.5 b/man/xpak.5 index 6e3d03d13..536810db5 100644 --- a/man/xpak.5 +++ b/man/xpak.5 @@ -47,7 +47,7 @@ String \fI"STOP"\fR. |<xpak_offset>| <tar>|<---xpak---->|<xpak_offset>"STOP" -Here you see the \fItar\fR archive, the attached \fIxpak\fR blob, the +Here you see the \fItar\fR archive, the attached \fIxpak\fR blob, the \fIxpak_offset\fR and the string \fI"STOP"\fR at the end. This metadata is not considered "part" of the \fIxpak\fR, but rather part of the binpkg. |