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