man/enalyze.1

   1 .TH "ENALYZE" "1" "Febuary 2010" "GENTOOLKIT" ""
   2 .SH "NAME"
   3 enalyze \- Gentoo Installed Package Analysis Tool
   4
   5 .SH "SYNOPSIS"
   6 .BI "enalyze " "[global\-options] " "module " "[local\-options]" " TARGET"
   7
   8 .SH "DESCRIPTION"
   9 .B Enalyze
  10 is a collection of modules for analyzing the state of installed Gentoo packages for
  11 USE flags or keywords used for installation, and their current masking status.
  12 .br
  13 It can also optionally (re)generate new /etc/portage/package.* files.
  14 .br
  15
  16 .br
  17 .B CAUTION:
  18 This is beta software and is not yet feature complete. Some features, options
  19 may change in the future.   Any files that it generates are saved to your home directory
  20 and will not harm your system without effort on your part.  It also does not need to be run as root.
  21 .br
  22
  23 .SH "GLOBAL OPTIONS"
  24 .HP
  25 .B \-h, \-\-help
  26 .br
  27 Output a help message.
  28 .HP
  29 .B \-q, \-\-quiet
  30 .br
  31 Be less verbose where possible. In some modules, this option can increase the output speed.
  32 .HP
  33 .B \-C, \-\-no\-color
  34 .br
  35 Do not colorize output.
  36 .HP
  37 .B \-N, \-\-no\-pipe
  38 .br
  39 Turn off automatic pipe detection. Use this option if you do not want
  40 .B enalyze
  41 to detect if the output is being directed to the screen or to another program
  42 and adjust color and verbosity accordingly.
  43 .HP
  44 .B \-V, \-\-version
  45 .br
  46 Display \fBGentoolkit\fP's version. Please include this in all bug reports. (see
  47 .B BUGS
  48 below)
  49
  50 .SH "MODULES"
  51 .B Enalyze
  52 uses a system of modules. Each module has both a long and short name.
  53 The list below uses the notation "\fBmodule (m)\fP", where \fIm\fP is the short name
  54 and \fImodule\fP is the long name.
  55 .P
  56 You can view the
  57 .B help
  58 message for a specific module by using
  59 .BR "\-h" ", " "\-\-help "
  60 as either a global option (after
  61 .B enalyze
  62 and before the module name) or as a local option (after the module name).
  63
  64 .SS
  65 .BI "analyze (a) [OPTIONS] TARGET"
  66 Report on all installed packages for \fITARGET\fP.
  67 .P
  68
  69 .I R "TARGET" ":"
  70 .HP
  71 .B use
  72 .br
  73 Will analyze the installed with USE flags for output results.
  74 .HP
  75 .B pkguse
  76 .br
  77 Will analyze the USE flags information from the installed pkg's 'PKGUSE' file which contains
  78 only flags settings from /etc/portage/package.use at the time of installation.
  79 .HP
  80 .B keywords
  81 .br
  82 Will analyze the recorded keywords for output results.
  83 .HP
  84 .B unmask
  85 .br
  86 Will analyze the installed packages and portage trees for pkgs that require unmasking and report them.
  87 (Not implemented yet)
  88 .br
  89 .P
  90 .I R "LOCAL OPTIONS" ":"
  91 .HP
  92 .B \-u, \-\-unset
  93 .br
  94 Will also include any USE flags used that were not enabled for some packages.
  95 .HP
  96 .B \-v, \-\-verbose
  97 .br
  98 Gives more detail about the results found and the current task being performed.
  99
 100 .P
 101 .I R "EXAMPLES" ":"
 102 .EX
 103 .HP
 104 enalyze a \-\-verbose \-\-unset use
 105 .EE
 106 .br
 107 Report on all use flags used to install the packages.  (\-\-unset) Include in the report all flags
 108 that have been used but also were not set enabled for some packages.
 109 (\-\-verbose) Also list the packages that used the USE flag setting.
 110 The report will break down the useage and report the USE flag up to 3 times indicating its
 111 setting {"+","\-"," "= unset} prepended to the flag name.
 112 It will also color the output, red = Disabled, blue = Enabled, plain text = unset
 113 .br
 114
 115 .SS
 116 .BI "rebuild (r) [OPTIONS] TARGET"
 117 Create a list all packages for \fITARGET\fP settings that are needed for
 118 other than the default settings.
 119
 120 .I R "TARGET" ":"
 121 .HP
 122 .B use
 123 .br
 124 Will analyze the USE flags for output results.
 125 .HP
 126 .B keywords
 127 .br
 128 Will analyze the keywords for output results.
 129 .HP
 130 .B unmask
 131 .br
 132 Will analyze the installed packages and portage trees for pkgs that require
 133 unmasking and produce output/a new /etc/portage/package.unmask file.
 134 .P
 135 .I R "LOCAL OPTIONS" ":"
 136 .HP
 137 .B \-a, \-\-all
 138 .br
 139 Create files/output for all TARGET(s) found to need it. (Not implemented yet)
 140 .HP
 141 .B \-e, \-\-exact
 142 .br
 143 Will prepend the pkg with = as well as use the version information for the entries.
 144 .br
 145 e.g.:  =CAT/PKG\-VER flag1 flag2
 146 .HP
 147 .B \-p, \-\-pretend
 148 .br
 149 Sends the output to the screen instead of a file.
 150 .HP
 151 .B \-v, \-\-verbose
 152 .br
 153 Gives more detail about the results found and the current task being performed.
 154 .P
 155 .I R "EXAMPLES" ":"
 156 .EX
 157 .HP
 158 enalyze rebuild \-p use
 159 .EE
 160 .br
 161 Analyze the installed packages database and current system USE flag settings
 162  and output the results in the form of:
 163 .br
 164
 165 .br
 166 .EX
 167 CAT/PKG \-flag1 \-flag2 flag3 flag4...
 168
 169 .SS
 170 .BI "clean (c) [OPTIONS] TARGET"
 171 Clean all packages for \fITARGET\fP settings that are found with obsolete settings
 172 for the current settings and pkg ebuild. (Not implemented yet)
 173
 174 .I R "TARGET" ":"
 175 .HP
 176 .B use
 177 .br
 178 Will analyze the USE flags and /etc/portage/package.use file(s) for entries that
 179 are redundant or no longer used by the pkg.
 180 .HP
 181 .B keywords
 182 .br
 183 Will analyze the keywords and /etc/portage/package.keywords file(s) for entries
 184 that are no longer needed.
 185 .HP
 186 .B unmask
 187 .br
 188 Will analyze the installed packages, /etc/portage/package.unmask file(s) and
 189 portage trees for pkgs that no longer require unmasking.
 190 .P
 191 .I R "LOCAL OPTIONS" ":"
 192 .HP
 193 .B \-a, \-\-all
 194 .br
 195 Clean files/output for all TARGET(s) found to need it. (not implemented yet)
 196 .HP
 197 .B \-p, \-\-pretend
 198 .br
 199 Sends the output to the screen instead of a file.
 200 .HP
 201 .B \-v, \-\-verbose
 202 .br
 203 Gives more detail about the results found and the current task being performed.
 204
 205
 206 .SH "BUGS"
 207 Submit bug reports to http://bugs.gentoo.org.
 208
 209 .SH "AUTHORS"
 210 .br
 211 Brian Dolbec <dolsen@gentoo.org>, 2010