man/analyse.1

   1 .TH "ANALYSE" "22" "Febuary 2010" "GENTOOLKIT" ""
   2 .SH "NAME"
   3 analyse \- Gentoo Installed Package Analysis Tool
   4
   5 .SH "SYNOPSIS"
   6 .BI "analyse " "[global\-options] " "module " "[local\-options]" "TARGET"
   7
   8 .SH "DESCRIPTION"
   9 .B Analyse
  10 Is a collection of modules for analysing 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 or its name
  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.
  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 analyse
  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 Analyse
  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 analyse
  62 and before the module name) or as a local option (after the module name).
  63
  64 .SS
  65 .BI "analyse (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 analyse the installed with USE flags for output results.
  74 .HP
  75 .B pkguse
  76 .br
  77 Will analyse 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 analyse the recorded keywords for output results.
  83 .HP
  84 .B unmask
  85 .br
  86 Will analyse the installed packages and portage trees for pkgs that require unmasking and report them.
  87 .br
  88 .P
  89 .I R "LOCAL OPTIONS" ":"
  90 .HP
  91 .B \-u, \-\-unset
  92 .br
  93 Will also include any USE flags used that were not enabled for some packages.
  94 .HP
  95 .B \-v, \-\-verebose
  96 .br
  97 Gives more detail about the results found and the current task being performed.
  98
  99 .P
 100 .I R "EXAMPLES" ":"
 101 .EX
 102 .HP
 103 analyse a \-\-verbose \-\-unset use
 104 .EE
 105 .br
 106 Report on all use flags used to install the packages.  (\-\-unset) Include in the report all flags
 107 that have been used but also were not set enabled for some packages.
 108 (\-\-verbose) Also list the packages that used the USE flag setting.
 109 The report will break down the useage and report the USE flag up to 3 times indicating its
 110 setting {"+","\-"," "= unset} prepended to the flag name.
 111 It will also color the output, red = Disabled, blue = Enabled, plain text = unset
 112 .br
 113
 114 .SS
 115 .BI "rebuild (r) [OPTIONS] TARGET"
 116 Create a list all packages for \fITARGET\fP settings that are needed for
 117 other than the default settings.
 118
 119 .I R "TARGET" ":"
 120 .HP
 121 .B use
 122 .br
 123 Will analyse the USE flags for output results.
 124 .HP
 125 .B keywords
 126 .br
 127 Will analyse the keywords for output results.
 128 .HP
 129 .B unmask
 130 .br
 131 Will analyse the installed packages and portage trees for pkgs that require
 132 unmasking and produce output/a new /etc/portage/package.unmask file.
 133 .P
 134 .I R "LOCAL OPTIONS" ":"
 135 .HP
 136 .B \-a, \-\-all
 137 .br
 138 Create files/output for all TARGET(s) found to need it. (not Implemented yet)
 139 .HP
 140 .B \-e, \-\-excact
 141 .br
 142 Will prepend the pkg with = as well as use the version information for the entries.
 143 .br
 144 eg.:  =CAT/PKG\-VER flag1 flag2
 145 .HP
 146 .B \-p, \-\-pretend
 147 .br
 148 Sends the output to the screen instead of a file.
 149 .HP
 150 .B \-v, \-\-verebose
 151 .br
 152 Gives more detail about the results found and the current task being performed.
 153 .P
 154 .I R "EXAMPLES" ":"
 155 .EX
 156 .HP
 157 analyse rebuild \-p use
 158 .EE
 159 .br
 160 Analyse the installed packages database and current system USE flag settings
 161  and output the results in the form of:
 162 .br
 163
 164 .br
 165 .EX
 166 CAT/PKG \-flag1 \-flag2 flag3 flag4...
 167
 168 .SS
 169 .BI "clean (c) [OPTIONS] TARGET"
 170 Clean all packages for \fITARGET\fP settings that are found with obsolete settings
 171 for the current settings and pkg ebuild. (not Implemented yet)
 172
 173 .I R "TARGET" ":"
 174 .HP
 175 .B use
 176 .br
 177 Will analyse the USE flags and /etc/portage/package.use file(s) for entries that
 178 are redundant or no longer used by the pkg.
 179 .HP
 180 .B keywords
 181 .br
 182 Will analyse the keywords and /etc/portage/package.keywords file(s) for entries
 183 that are no longer needed.
 184 .HP
 185 .B unmask
 186 .br
 187 Will analyse the installed packages, /etc/portage/package.unmask file(s) and
 188 portage trees for pkgs that no longer require unmasking.
 189 .P
 190 .I R "LOCAL OPTIONS" ":"
 191 .HP
 192 .B \-a, \-\-all
 193 .br
 194 Clean files/output for all TARGET(s) found to need it. (not Implemented yet)
 195 .HP
 196 .B \-p, \-\-pretend
 197 .br
 198 Sends the output to the screen instead of a file.
 199 .HP
 200 .B \-v, \-\-verebose
 201 .br
 202 Gives more detail about the results found and the current task being performed.
 203
 204
 205 .SH "BUGS"
 206 Submit bug reports to http://bugs.gentoo.org.
 207
 208 .SH "AUTHORS"
 209 .br
 210 Brian Dolbec <brian.dolbec@gmail.com>, 2010