diff options
author | fuzzyray <fuzzyray@gentoo.org> | 2009-05-05 17:39:24 +0000 |
---|---|---|
committer | fuzzyray <fuzzyray@gentoo.org> | 2009-05-05 17:39:24 +0000 |
commit | c819d146be6bce86d97019494173253e71b85d2f (patch) | |
tree | 200d00c2b9a420540ff9c4e0d8b3080b762fb562 /man | |
parent | Add some useful informations when using $EDITOR. (diff) | |
download | gentoolkit-c819d146be6bce86d97019494173253e71b85d2f.tar.gz gentoolkit-c819d146be6bce86d97019494173253e71b85d2f.tar.bz2 gentoolkit-c819d146be6bce86d97019494173253e71b85d2f.zip |
Rearrange trunk to support gentoolkit version 0.3. Split into gentoolkit, gentoolkit-dev, and deprecated. Import djanderson's work on the gentoolkit library and equery
svn path=/trunk/gentoolkit/; revision=589
Diffstat (limited to 'man')
-rw-r--r-- | man/eclean.1 | 176 | ||||
-rw-r--r-- | man/epkginfo.1 | 34 | ||||
-rw-r--r-- | man/equery.1 | 278 | ||||
-rw-r--r-- | man/eread.1 | 12 | ||||
-rw-r--r-- | man/euse.1 | 102 | ||||
-rw-r--r-- | man/genpkgindex.1 | 59 | ||||
-rw-r--r-- | man/glsa-check.1 | 57 | ||||
-rw-r--r-- | man/revdep-rebuild.1 | 101 |
8 files changed, 819 insertions, 0 deletions
diff --git a/man/eclean.1 b/man/eclean.1 new file mode 100644 index 0000000..7d785af --- /dev/null +++ b/man/eclean.1 @@ -0,0 +1,176 @@ +.TH "eclean" "1" "0.4.1" "gentoolkit" +.SH "NAME" +eclean \- A cleaning tool for Gentoo distfiles and binary packages. +.SH "SYNOPSIS" +.LP +.B eclean \fR[\fIglobal\-options\fR] ... <\fIactions\fR> \fR[\fIaction\-options\fR] ... +.LP +.B eclean\-dist \fR[\fIglobal\-options, distfiles\-options\fR] ... +.LP +.B eclean\-pkg \fR[\fIglobal\-options, packages\-options\fR] ... +.LP +.B eclean(-dist,-pkg) \fR[\fI\-\-help, \-\-version\fR] +.SH "DESCRIPTION" +\fBeclean\fP is small tool to remove obsolete portage sources files and binary packages. +Used on a regular basis, it prevents your DISTDIR and PKGDIR directories to +infinitely grow, while not deleting files which may still be useful. +.PP +By default, eclean will protect all distfiles or binary packages corresponding to some +ebuilds available in the Portage tree. This is the safest mode, since it will protect +whatever may still be useful, for instance to downgrade a package without downloading +its sources for the second time, or to reinstall a package you unmerge by mistake +without recompiling it. Sure, it's also a mode in which your DISTDIR and PKGDIR will +stay rather big (although still not growing infinitely). For the 'distfiles', this +mode is also quit slow mode because it requiries some access to the whole Portage tree. +.PP +If you use the \-\-destructive option, eclean will only protect files corresponding to +some currently installed package (taking their exact version into account). It will +save much more space, while still preserving sources files around for minor revision +bumps, and binaries for reinstallation of corrupted packages. But it won't keep files +for less usual operations like downgrading or reinstalling an unmerged package. This +is also the fastest execution mode (big difference for distfiles), and the one used by +most other cleaning scripts around like yacleaner (at least in its version 0.3). +.PP +Somewhere in the middle, adding the \-\-package\-names option when using \-\-destructive +will protect files corresponding to all existing versions of installed packages. It will +allow easy downgrading without recompilation or redownloading in case of trouble, but +won't protect you against package uninstallation. +.PP +In addition to this main modes, some options allow to declare a few special cases file +protection rules: +.IP o +\-\-time-limit is useful to protect files which are more recent than a given amount of time. +.IP o +\-\-size-limit (for distfiles only) is useful if you want to protect files bigger than a given size. +.IP o +\-\-fetch-restricted (for distfiles only) is useful to protect manually downloaded files. +But it's also very slow (again, it's a reading of the whole Portage tree data)... +.IP o +Finally, you can list some categories or package names to protect in exclusion files (see +\fBEXCLUSION FILES\fP below). +.SH "PARAMETERS" +.SS "Global options" +.TP +\fB\-C, \-\-nocolor\fP turn off colors on output +.TP +\fB\-d, \-\-destructive\fP only keep the minimum for a reinstallation +.TP +\fB\-e, \-\-exclude\-file=<path>\fP path to the exclusion file +\fB<path>\fP is the absolute path to the exclusion file you want to use. +When this option is not used, default paths are /etc/eclean/{packages,distfiles}.exclude +(if they exist). Use /dev/null if you have such a file at it standard location and +you want to temporary ignore it. +.TP +\fB\-i, \-\-interactive\fP ask confirmation before deleting +.TP +\fB\-n, \-\-package\-names\fP protect all versions (\-\-destructive only) +.TP +\fB\-p, \-\-pretend\fP only display what would be cleaned +.TP +\fB\-q, \-\-quiet\fP be as quiet as possible, only display errors +.TP +\fB\-t, \-\-time-limit=<time>\fP don't delete files modified since <time> +\fB<time>\fP is an amount of time: "1y" is "one year", "2w" is "two weeks", etc. +.br +Units are: y (years), m (months), w (weeks), d (days) and h (hours). +.TP +\fB\-h, \-\-help\fP display the help screen +.TP +\fB\-V, \-\-version\fP display version informations +.SS "Actions" +.TP +\fBdistfiles\fR +Clean files from /usr/portage/distfiles (or whatever else is your DISTDIR in /etc/make.conf). +This action should be useful to almost any Gentoo user, we all have to big DISTDIRs sometime... +.br +\fBeclean\-dist\fP is a shortcut to call eclean with the "distfiles" action, for simplified +command\-line. +.TP +\fBpackages\fR +Clean files from /usr/portage/packages (or whatever else is your PKGDIR in /etc/make.conf). +This action is in particular useful for people who use the "buildpkg" or "buildsyspkg" +FEATURES flags. +.br +\fBeclean\-pkg\fP is a shortcut to call eclean with the "packages" action, for simplified +command\-line. +.SS "Options for the 'distfiles' action" +.TP +\fB\-f, \-\-fetch-restricted\fP protect fetch-restricted files (\-\-destructive only) +.TP +\fB\-s, \-\-size-limit=<size>\fP don't delete distfiles bigger than <size> +<size> is a size specification: "10M" is "ten megabytes", "200K" is "two hundreds kilobytes", +etc. +.br +Units are: G, M, K and B. +.SS "Options for the 'packages' action" +.TP +There is no specific option for this action. +.SH "EXCLUSION FILES" +Exclusions files are lists of packages names or categories you want to protect +in particular. This may be useful to protect more binary packages for some system +related packages for instance. Syntax is the following: +.IP o +blank lines and lines starting with a "#" (comments) are ignored. +.IP o +only one entry per line is allowed. +.IP o +if a line contains a category name, like "sys\-apps", then all packages from this +category will be protected. "sys\-apps/*" is also allowed for aesthetic reasons, but +that does NOT mean that wildcard are supported in any way for any other usage. +.IP o +if a line contains a package name ("app\-shells/bash"), then this package will be +protected. Versioned atoms like ">=app\-shells/bash\-3" are NOT supported. Also, the +full package name (with category) is mandatory. +.IP o +if a line contains a package name with an exclamation mark in front ("!sys\-apps/portage"), +then this package will be excluded from protection. This is only useful if the category +itself was protected. +.IP o +for distfiles protection, a line can also a filename to protect. This is useful if you have +there some files which are not registered by the ebuilds, like OpenOffice.org i18n files +("helpcontent_33_unix.tgz" for instance). +.LP +By default, if it exists, /etc/eclean/packages.exclude (resp. distfiles.exclude) will be use +when action is "packages" (resp. "distfiles"). This can be overide with the \-\-exclude\-file +option. +.SH "EXAMPLES" +.LP +Clean distfiles only, with per file confirmation prompt: +.br +.B # eclean \-i distfiles +.LP +Check which binary packages could be removed, with a no-color display: +.br +.B # eclean \-Cp packages +.LP +Clean binary packages of uninstalled packages, but keep all versions of installed ones: +.br +.B # eclean-pkg \-d \-n +.LP +Clean all distfiles except for installed packages (exact version), those which +are less than one month old, bigger than 50MB, or fetch-restricted: +.br +.B # eclean-dist \-d \-t1m -s50M -f +.LP +From a crontab, silently clean packages in the safest mode, and then distfiles in destructive +mode but protecting files less than a week old, every sunday at 1am: +.br +.B 0 1 * * sun \ \ eclean \-C \-q packages ; eclean \-C \-q \-d \-t1w distfiles +.".SH "BUGS" +.".TP +."The policy used to decide wether a distfile can be removed or not relies on the SRC_URI variables ."of ebuilds. It means that if an ebuild uses files that are not part of its SRC_URI, eclean will ."probably remove them. This are ebuilds bugs, please report them as such on ."http://bugs.gentoo.org. +.".TP +."In safest mode (default, without the \-\-destructive option), this script can be very slow. There +."is not much to do about it without hacking outside of the portage API. +.SH "SEE ALSO" +.TP +The Gentoo forum thread that gave birth to eclean: +.B http://forums.gentoo.org/viewtopic.php?t=3011 +.TP +The bug report requesting eclean inclusion in gentoolkit: +.B http://bugs.gentoo.org/show_bug.cgi?id=33877 +.TP +Yacleaner, one of the other similar tools: +.B http://blog.tacvbo.net/data/files/yacleaner/ +.SH "AUTHORS" +Thomas de Grenier de Latour (tgl) <degrenier@easyconnect.fr> diff --git a/man/epkginfo.1 b/man/epkginfo.1 new file mode 100644 index 0000000..cefe602 --- /dev/null +++ b/man/epkginfo.1 @@ -0,0 +1,34 @@ +.TH "epkginfo" "1" "0.4.1" "Ned Ludd" "gentoolkit" +.SH "NAME" +.LP +epkginfo \- Displays metadata information from packages in portage +.SH "SYNTAX" +.LP +epkginfo [\fIpackage\-cat/\fP]package +.SH "EXAMPLES" +$ epkginfo app\-portage/gentoolkit +.br +\fBPackage:\fR app\-portage/gentoolkit +.br +\fBHerd:\fR tools\-portage +.br +\fBMaintainer:\fR tools\-portage +.br +\fBLocation:\fR /usr/portage/app\-portage/gentoolkit +.br +\fBKeywords:\fR gentoolkit\-0.2.2: +.br +\fBKeywords:\fR gentoolkit\-0.2.3: mips +.br +\fBKeywords:\fR gentoolkit\-0.2.3\-r1: ppc ppc64 alpha arm s390 amd64 hppa x86 sparc ia64 m68k sh +.br +\fBKeywords:\fR gentoolkit\-0.2.4_pre3: +.br +\fBKeywords:\fR gentoolkit\-0.2.4_pre4: +.br +\fBKeywords:\fR gentoolkit\-0.2.4_pre5: ~arm ~hppa ~x86 ~m68k ~amd64 ~ppc ~sh ~x86\-fbsd ~ia64 ~alpha ~sparc ~ppc64 ~sparc\-fbsd ~mips ~s390 +.SH "AUTHORS" +.LP +Ned Ludd <solar@gentoo.org> +.SH "BUGS" +Please report any bugs to http://bugs.gentoo.org diff --git a/man/equery.1 b/man/equery.1 new file mode 100644 index 0000000..27b8078 --- /dev/null +++ b/man/equery.1 @@ -0,0 +1,278 @@ +.TH "equery" "1" "Oct 2005" "gentoolkit" "" +.SH "NAME" +equery \- Gentoo: Package Query Tool +.SH "SYNOPSIS" +.B equery +.I [global\-opts] command [local\-opts] +.PP + +.SH "DESCRIPTION" +equery is a flexible utility which may display various information about +packages, such as the files they own, their USE flags, the md5sum +of each file owned by a given package, and many other things. + +.SH "OPTIONS" +The 'command' is the only mandatory option to equery. Most commands require +a 'pkgspec' option, which is described by <cat/>packagename<\-version>; +namely, the package name is mandatory, while the category and version are +optional. + +[global\-opts] may be one of: + +.B \-q, \-\-quiet +causes minimal output to be emitted +.PP +.B \-C, \-\-nocolor +turns off colours +.PP +.B \-h, \-\-help +displays a help summary +.PP +.B \-V, \-\-version +displays the equery version +.PP +.B \-N, \-\-no\-pipe +turns off pipe detection +.PP + +Only one command will actually be run, at most. The possible commands are: +.TP +.B belongs <local\-opts> file +This command lists all packages owning the specified file. +.br +Note: Normally, only one package will own a file. If multiple packages own the +same file, it usually consitutes a problem, and should be reported (http://bugs.gentoo.org). +.br +.IP +<local\-opts> is either or both of: +.br +.B \-c, \-\-category cat +only search in category cat +.br +.B \-f, \-\-full\-regex +supplied query is a regex +.br +.B \-e, \-\-earlyout +stop when first match found + +.PP +.B check pkgspec +This command checks the files of the specified package against recorded MD5 +sums and timestamps. +.PP +.TP +.B depends <local\-opts> pkgspec +This command displays all dependencies matching pkgspec. +.br +<local\-opts> is either or both of: +.br +.B \-a, \-\-all\-packages +search in all available packages (slow) +.br +.B \-d, \-\-direct +search direct dependencies only (default) +.br +.B \-D, \-\-indirect +search indirect dependencies (very slow) +.br +.B \-\-depth=n +Limit depth of indirect dependency tree to n levels. Setting \-\-depth=0 is the same as not specifing \-\-indirect. +.PP +.TP +.B depgraph <local\-opts> pkgspec +This command display a dependency tree for pkgspec, by default indented to reflect +how dependancies relate to each other. +.br +.IP +<local\-opts> is either or both of: +.br +.B \-U, \-\-no\-useflags +do not show USE flags. +.br +.B \-l, \-\-linear +do not use fancy formatting +.br +.B \-\-depth=n +Limit depth of dependency graph to n levels. +.PP +.TP +.B files <local\-opts> pkgspec +This lists files owned by a particular package, optionally with extra +information specified by <local\-opts> +.br + +<local\-opts> is any combination of: +.br +.B \-\-timestamp +output the timestamp of each file +.br +.B \-\-md5sum +output the md5sum of each file +.br +.B \-\-type +output the type of each file +.br +.B \-\-tree +display results in a tree (turns off all other options) +.br +.B \-\-filter=<rules> +filter output based on files type or path +.br +.B \t<rules> +is a comma separated list of filtering rules. Available rules are: +.br +.B \t\tdir\ +regular directories +.br +.B \t\tobj\ +regular files +.br +.B \t\tsym\ +symbolic links +.br +.B \t\tdev\ +device nodes +.br +.B \t\tfifo +named pipes +.br +.B \t\tpath +shortest paths where some files where installed +.br +.B \t\tconf +configuration files (based on $CONFIG_PROTECT) +.br +.B \t\tcmd\ +user commands (based on $PATH) +.br +.B \t\tdoc\ +documentation files (from /usr/share/doc) +.br +.B \t\tman\ +manpages (from /usr/share/man) +.br +.B \t\tinfo +info pages (from /usr/share/info) +.PP +.TP +.B hasuse <local\-opts> useflag +This command lists packages matching a particular USE flag in a user\-specified combination +of installed packages, packages which are not installed, the portage tree, and +the portage overlay tree. + +<local\-opts> must not include only \-I; +if \-I is used, \-p and/or \-o must be also be present. By default, only installed +packages are searched. \-o searches only the overlay tree [and possibly +installed packages], +.I not +the main portage tree. + +.B \-i, \-\-installed +search installed packages (default) +.br +.B \-I, \-\-exclude\-installed +do not search installed packages +.br +.B \-p, \-\-portage\-tree +also search in portage tree (/usr/portage) +.br +.B \-o, \-\-overlay\-tree +also search in overlay tree (/usr/local/portage) +.PP +.TP +.B list <local\-opts> pkgspec +This command lists packages matching pkgspec in a user\-specified combination +of installed packages, packages which are not installed, the portage tree, and +the portage overlay tree. By default the list command searches for partial name matches. + +<local\-opts> \-I cannot be used by itself; +if \-I is used, \-p and/or \-o must be also be present. By default, only installed +packages are searched. \-o searches only the overlay tree [and possibly +installed packages], +\fInot\fR the main portage tree. + +.B \-i, \-\-installed +search installed packages (default) +.br +.B \-I, \-\-exclude\-installed +do not search installed packages +.br +.B \-p, \-\-portage\-tree +also search in portage tree (/usr/portage) +.br +.B \-o, \-\-overlay\-tree +also search in overlay tree (/usr/local/portage) +.br +.B \-f, \-\-full\-regex +query is a regular expression +.br +.B \-e, \-\-exact\-name +list only those packages that exactly match +.br +.B \-d, \-\-duplicates +only list installed duplicate packages +.br + +\fBOutput:\fR + +.br +The list command searches packages for the name given. If found, the following info will be displayed: the package location between the first square brackets (I for Installed packages, P for Portage, O for Overlay), the possible masks between the second (~ by keyword, - by arch or M hard masked), then the category and complete name and last of all, the slot in which the package is stored. + +\fBExamples:\fR + +equery list zilla \- list all installed versions of packages containing the string 'zilla' + +equery list \-\-exact\-name x11\-libs/gtk+ \- list all installed versions of x11\-libs/gtk+ + +equery list \-\-full\-regex '(mozilla\-firefox|mozilla\-thunderbird)' \- list all installed versions of mozilla\-firefox and mozilla\-thunderbird + +equery list \-\-duplicates \- list all installed slotted packages +.PP +.TP +.B size <local\-opts> pkgspec +This command outputs the number of files in the specified package, as well as +their total size in an appropriate unit. + +The possible values for <local\-opts>, if specified, are: +.br +.B \-b, \-\-bytes +report size in bytes +.br +.B \-f, \-\-full\-regex +query is a regular expression +.br +.B \-e, \-\-exact\-name +list only those packages that exactly match +.PP +.TP +.B uses <local\-opts> pkgspec +display USE flags for pkgspec. + +The only possible value for <local\-opts>, if specified, is: +.br +.B \-a, \-\-all +include all package versions +.PP +.B which pkgspec +print full path to ebuild for package pkgspec +.PP + +.SH "Unimplemented Options" +.PP +.B changes +.PP +.B glsa \fR \- use glsa\-check for the time being. +.PP +.B stats + + + +.SH "BUGS" +Many options aren't implemented. Command\-line parsing could use some work. +.br +Submit bug reports to http://bugs.gentoo.org +.SH "AUTHORS" +equery, original man page: Karl Trygve Kalleberg <karltk@gentoo.org>, 2003. +.br +Massive man page updates: Katerina Barone\-Adesi <katerinab@gmail.com>, 2004. + diff --git a/man/eread.1 b/man/eread.1 new file mode 100644 index 0000000..5e18214 --- /dev/null +++ b/man/eread.1 @@ -0,0 +1,12 @@ +.TH "eread" "1" "1.0" "Donnie Berkholz" "gentoolkit" +.SH "NAME" +.LP +eread \- Gentoo: Tool to display and manage ELOG files from portage +.SH "SYNTAX" +.LP +eread +.SH "DESCRIPTION" +.LP +This tool is used to display and manage ELOG files produced by portage version 2.1 and higher. +.SH "ENVIRONMENT VARIABLES" +The eread utility uses the PAGER environment variable to display the ELOG files. If the variable is not set, it defaults to /usr/bin/less. diff --git a/man/euse.1 b/man/euse.1 new file mode 100644 index 0000000..b5148fd --- /dev/null +++ b/man/euse.1 @@ -0,0 +1,102 @@ +.TH "EUSE" "1" "2004-10-17" "Gentoo Linux" "Gentoo Toolkit" +.SH "NAME" +euse \- Gentoo: command line USE flag editor +.SH "SYNOPSIS" +.B euse +\fI<option> [suboption] [useflaglist]\fB +.SH "DESCRIPTION" +.PP +.I euse +is used to set(disable/enable) USE flags in /etc/make.conf without having to edit +the file directly. It is also used to get detail information about use flags +like description, status of flags(enabled/disabled), type of flag(global/local) +etc. +.SH "OPTIONS " +.TP +\fB\-E, \-\-enable\fI +Enables USE flag(s) in make.conf. It accepts one or more space seperated +USE flags as parameters. +.TP +\fB\-D, \-\-disable\fI +Disables USE flag(s) in make.conf. Puts a '\-' sign in front of the USE flag +and appends it to the USE setting in make.conf. It accepts one or more +space seperated USE flags as parameters. +.TP +\fB\-P, \-\-prune\fI +Removes USE flag(s) in make.conf. Removes all positive and negative references to +the given USE flags from make.conf. +.TP +\fB\-i, \-\-info\fI +Prints detail information about the USE flag(s). If no arguments are given then +it assumes you want information for all USE flags. If one or more +arguments are given (space separated) then only information for those flags is +printed. +.TP +\fB\-I, \-\-info\-installed\fI +Same as \-\-info, except that it will also list the currently installed packages that are utilizing the flag. +.sp +.RS +The output is in the following format: +.br +\fB[\- cD ]\fI alpha \- indicates that architecture ... +.br +\fB[\- ]\fI moznocompose (net\-www/mozilla): +.br +Disable building of mozilla's web page composer +.br +The indicators in the first column are: +.IP is_active ++ if the flag is seen as active by portage, \- if not +.IP is_in_env +E if the flag is enabled in the environment, e if it is +disabled in the environment, nothing if it's not affected +by the environment +.IP is_in_make_conf +C if the flag is enabled in make.conf, c if it is +disabled in make.conf, nothing if it's not affected +by make.conf +.IP is_in_make_defaults +D if the flag is enabled in make.defaults, d if it is +disabled in make.defaults, nothing if it's not affected +by make.defaults +.IP is_in_make_globals +G if the flag is enabled in make.globals, g if it is +disabled in make.globals, nothing if it's not affected +by make.globals +.br +Then follows the name of the flag, for local flags the +package name and then the description (on a new line for +local flags). +.TP +\fB\-a, \-\-active\fI +Shows all currently active USE flags and where they are activated (see +description for \fB\-\-info\fI). +.TP +\fB\-h, \-\-help\fI +Show the help message listing all the available flags and a short description +.TP +\fB\-v, \-\-version\fI +Show the version information +.SH "FILES" +/etc/make.conf +.br +/etc/make.profile/make.defaults +.br +/etc/make.globals +.br +$PORTDIR/profiles/use.desc +.br +$PORTDIR/profiles/use.local.desc +.br + +.SH "AUTHOR" +Original version by Arun Bhanu <codebear@gentoo.org> +.br +Updated for rewritten euse by Marius Mauch <genone@gentoo.org> +.SH "BUGS" +euse doesn't handle USE flags enabled or disabled by use.defaults, use.mask +or package.use yet. It also doesn't completely understand the \-* flag. +.SH "SEE ALSO" +.BR ufed(8), +.TP +The \fI/usr/bin/euse\fR script. diff --git a/man/genpkgindex.1 b/man/genpkgindex.1 new file mode 100644 index 0000000..8a3956e --- /dev/null +++ b/man/genpkgindex.1 @@ -0,0 +1,59 @@ +.TH "genpkgindex" "1" "" "Ned Ludd" "gentoolkit" +.SH "NAME" +.LP +genpkgindex \- Generates package metadata from binary packages for use with programs such a qmerge from portage\-utils +.SH "USAGE" +.LP +genpkgindex [\fI\-\-options\fP] + +.SH "DESCRIPTION" +.LP +Generates package metadata from binary packages for use with programs such a qmerge from portage\-utils +.SH "OPTIONS" +.LP +.TP +\fB\-h, \-\-help\fR + Display help and exit +.TP +\fB\-v, \-\-verbose\fR + Be verbose +.TP +\fB\-q, \-\-quiet\fR + Be quiet +.TP +\fB\-c, \-\-compress\fR + Compresses the generated metadata with bzip2. +.TP +\fB\-P, \-\-pkgdir <path>\fR + Set the base location of the binary packages. The default is normally /usr/portage/packages +.TP + +.SH "ENVIRONMENT VARIABLES" +.LP +.TP +\fBPKGDIR\fP +is the location of binary packages that you can have created with FEATURES=buildpkg, '\-\-buildpkg' or '\-b/\-B' while emerging a package. +.SH "EXAMPLES" +.LP +Typical usage is to simply run: +.LP +genpkgindex +.LP +Alternatively if you want the metadata compressed: +.LP +genpkgindex \-\-compress +.LP +.SH "NOTES" +.LP +When no package directories are directly given to genpkgindex on the command line it will output additional variables that it assumes from the running portage environment. +.LP +When FEATURES=cleanpkgdir is enabled genpkgindex will invoke "/usr/bin/eclean \-d packages" before creating any package metadata. +.LP +genpkgindex intended use is to be run from /etc/portage/bashrc in the $EBUILD_PHASE of "postinst". +.LP +.SH "AUTHORS" +.LP +Ned Ludd <solar@gentoo.org> +.SH "SEE ALSO" +.LP +emerge(1) qmerge(1) make.conf(5) portage(5) diff --git a/man/glsa-check.1 b/man/glsa-check.1 new file mode 100644 index 0000000..5a7a525 --- /dev/null +++ b/man/glsa-check.1 @@ -0,0 +1,57 @@ +.TH "glsa-check" "1" "0.6" "Marius Mauch" "gentoolkit" +.SH "NAME" +.LP +glsa\-check \- Gentoo: Tool to locally monitor and manage GLSA's +.SH "SYNTAX" +.LP +glsa\-check <\fIoption\fP> [\fIglsa\-list\fP] + +[\fIglsa\-list\fR] can contain an arbitrary number of GLSA ids, filenames containing GLSAs or the special identifiers 'all', 'new' and 'affected' +.SH "DESCRIPTION" +.LP +This tool is used to locally monitor and manage Gentoo Linux Security Advisories. +Please read: +.br +http://www.gentoo.org/proj/en/portage/glsa\-integration.xml +.br +before reporting a bug. +.LP +Note: In order for this tool to be effective, you must regularly sync your local portage tree. +.SH "OPTIONS" +.LP +.TP +.B \-l, \-\-list +list all unapplied GLSA +.TP +.B \-d, \-\-dump, \-\-print +show all information about the given GLSA +.TP +.B \-t, \-\-test +test if this system is affected by the given GLSA +.TP +.B \-p, \-\-pretend +show the necessary commands to apply this GLSA +.TP +.B \-f, \-\-fix +try to auto\-apply this GLSA (experimental) +.TP +.B \-i, \-\-inject +inject the given GLSA into the checkfile +.TP +.B \-n, \-\-nocolor +disable colors (option) +.TP +.B \-h, \-\-help +show this help message +.TP +.B \-V, \-\-version +some information about this tool +.TP +.B \-v, \-\-verbose +print more messages (option) +.TP +.B \-c, \-\-cve +show CAN ids in listing mode (option) +.TP +.B \-m, \-\-mail +send a mail with the given GLSAs to the administrator diff --git a/man/revdep-rebuild.1 b/man/revdep-rebuild.1 new file mode 100644 index 0000000..267f7f1 --- /dev/null +++ b/man/revdep-rebuild.1 @@ -0,0 +1,101 @@ +.TH "revdep\-rebuild" "1" "" "gentoolkit" "" +.SH "NAME" +revdep\-rebuild \- Gentoo: Reverse Dependency Rebuilder +.SH "SYNOPSIS" +.B revdep\-rebuild +[OPTIONS] [\-\-] [EMERGE OPTIONS] +.SH "DESCRIPTION" +revdep\-rebuild scans libraries and binaries for missing shared library dependencies and attempts to fix them by re\-emerging those broken binaries and shared libraries. It is useful when an upgraded package breaks other software packages that are dependent upon the upgraded package. +.SH "OPTIONS" +.TP +.B \-C | \-\-nocolor +Turn off colored output. (This option is also passed to portage.) +.TP +.B \-e | \-\-exact +Emerge the most recent version of found packages, without regard to SLOT. +.TP +.B \-h | \-\-help +Print usage. +.TP +.B \-i | \-\-ignore +Delete temporary files from previous runs. +.TP +.B \-k | \-\-keep\-temp +Force revdep\-rebuild not to delete temporary files after it successfully rebuilds packages. This option will NOT prevent revdep\-rebuild from deleting inconsistent or out\-of\-date temporary files. +.TP +.B \-\-library NAME | -L NAME +Search for reverse dependencies for a particular library or group of libraries, rather than every library on the system. Emerge packages that use the named library. NAME can be a full path to a library or basic regular expression. (See regex(7).) +.TP +.B \-l | \-\-no\-ld\-path +Do not set LD_LIBRARY_PATH. \fBNote:\fR Using this option will cause revdep-rebuild to report some false positives. +.TP +.B \-o | \-\-no-order +Do not check the build order against the deep dependency list. This will make revdep-rebuild faster, but it can cause emerge failures. Please try revdep\-rebuild without \-o before reporting any bugs. +.TP +.B \-p | \-\-pretend +Do a dry-run. Do not delete temporary files. (\-k \-p is redundant, but harmless.) \-\-pretend is assumed when not running revdep\-rebuild as root. +.TP +.B \-P | \-\-no\-progress +Turn off the progress meter +.TP +.B \-q | \-\-quiet +Print less output and disable the progress meter. (This option is also passed to portage.) +.TP +.B \-u UTIL | \-\-no-util UTIL +Do not use features provided by UTIL. +UTIL can be one of portage-utils or pkgcore, or it can be a \fBquoted\fR space-delimited list. +.TP +.B \-v | \-\-verbose +More output. (Prints the revdep\-rebuild search environment.) +.TP +.B All other options (including unrecognized ones) are passed to the emerge command. Single\-letter options may not be combined, so for example, \-pv is not valid. Please use \-p \-v. +.SH "CONFIGURATION" +revdep\-rebuild no longer uses hardcoded paths. To change the default behavior the following variables can be changed by the user. + +LD_LIBRARY_MASK \- Mask of specially evaluated libraries +.LP +SEARCH_DIRS \- List of directories to search for executables and libraries +.LP +SEARCH_DIRS_MASK \- List of directories to not search + +You can prepend to these variables by setting the variable in your environment prior to execution, by placing an entry in /etc/make.conf, or by placing a file in /etc/revdep\-rebuild containing the appropriate variables. + +The variables are read and set in the following order: + +environment settings \- one time changes by user +.br +/etc/make.conf \- persistent changes by user +.br +/etc/revdep\-rebuild/* \- persistent changes by ebuild authors + +While a user can edit and modify the files in the /etc/revdep\-rebuild directory, please be aware that the /etc/revdep\-rebuild directory is not under configuration protection and files can be removed and/or overwritten by an ebuild. To change this add /etc/revdep\-rebuild to the CONFIG_PROTECT variable in /etc/make.conf. + +An entry of "\-*" means to clear the variable from that point forward. +Example: SEARCH_DIRS="/usr/bin \-*" will set SEARCH_DIRS to contain only /usr/bin + +revdep\-rebuild honors the NOCOLOR and PORTAGE_NICENESS variables from /etc/make.conf +.SH "EXAMPLES" +It is recommended that when running revdep\-rebuild that the following command be used initially: +.br +\fBrevdep\-rebuild \-\-ignore \-\-pretend\fR + +To search the entire system, while excluding /mnt and /home: +.br +\fBenv SEARCH_DIRS="/ \-*" SEARCH_DIRS_MASK="/mnt /home" revdep\-rebuild\fR + +To rebuild packages that depend on libkdecore.so.4 from KDE 3.3: +.br +\fBrevdep\-rebuild \-\-library /usr/kde/3.3/lib/libkdecore.so.4\fR + +To rebuild packages that depend upon libImlib.so and libImlib2.so: +.br +\fBrevdep\-rebuild \-\-library libImlib[2]*.so.*\fR + +.SH "EXIT STATUS" +revdep\-rebuild returns a zero exit status if it \fBand emerge\fR succeeds, and a nonzero exit status otherwise. +.SH "BUGS" +.LP +Report bugs to <http://bugs.gentoo.org>. Please do not report emerge failures caused by \-o or \-e. Please include your .revdep\-rebuild* files, your emerge \-\-info, and patches. ;) + +.SH "SEE ALSO" +emerge(1), portage(5), regex(7) |