- initial import of revision 374 from cnc
[apt.git] / contrib / apt-wrapper / apt.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.\r
2 .de Sh \" Subsection\r
3 .br\r
4 .if t .Sp\r
5 .ne 5\r
6 .PP\r
7 \fB\\$1\fR\r
8 .PP\r
9 ..\r
10 .de Sp \" Vertical space (when we can't use .PP)\r
11 .if t .sp .5v\r
12 .if n .sp\r
13 ..\r
14 .de Ip \" List item\r
15 .br\r
16 .ie \\n(.$>=3 .ne \\$3\r
17 .el .ne 3\r
18 .IP "\\$1" \\$2\r
19 ..\r
20 .TH "APT" 1 "21 June 2004" "Linux" ""\r
21 .SH NAME\r
22 apt \- Advanced Package Tool\r
23 .SH "SYNOPSIS"\r
24 .ad l\r
25 .hy 0\r
26 .HP 4\r
27 \fBapt\fR [\fB\fIoptions\fR\fR] [\fB\fIapt\-rpm\ options\fR\fR] [\fB\fIaction\fR\fR] [\fB\fIpackages\fR\fR]\r
28 .ad\r
29 .hy\r
30 \r
31 .SH "DESCRIPTION"\r
32 \r
33 .PP\r
34 Apt provides a single command line user interface for the following commands: \fB\fBapt\-get\fR\fR(8), \fB\fBapt\-cache\fR\fR(8), \fB\fBapt\-config\fR\fR(8), \fB\fBapt\-cdrom\fR\fR(8) and the \fBrpm\fR query possibilities\&. Besides the single interface it provides some additional options that are specific to apt in combination with rpm\&.\r
35 \r
36 .PP\r
37 Unless the \fB\-h\fR, \fB\-\-help\fR, \fB\-v\fR, or \fB\-\-version\fR option is given one of the commands mentioned in the ACTIONS section must be present\&.\r
38 \r
39 .PP\r
40 Detailed information about each apt command and its options can be found in the man pages that belong to the dispatched apt applications\&.\r
41 \r
42 .SH "ACTIONS"\r
43 \r
44 .PP\r
45 Actions supported by \fBapt\fR: add, autoclean, build\-dep, check, clean, depends, dist\-upgrade, dotty, dump, dumpavail, gencaches, groupinstall, groupremove, ident, install, list\-extras, list\-nodeps, moo, pkgnames, policy, query, querytags, rdepends\&. reinstall\&. remove, script, search, show, showgroup, showgroups, showpkg, showsrc, source, stats, unmet, update, upgrade, whatdepends, xvcg\&.\r
46 \r
47 .TP\r
48 groupinstall\r
49 Install a group (or groups) of packages\&. Most often those groups are defined by the distributor\&. Configuration item: Scripts::Groupinstall::Backend\r
50 \r
51 .TP\r
52 groupremove\r
53 Remove a group (or groups) of packages\&. Most often those groups are defined by the distributor\&. Configuration item: Scripts::Groupinstall::Backend\r
54 \r
55 .TP\r
56 list\-nodeps\r
57 list all installed packages that are not required by any other installed package\&.\r
58 \r
59 .TP\r
60 list\-extras\r
61 shows packages not found in any online repositories\&. These are packages downloaded or build and installed locally\&. It's useful to review that list and decide if all those packages are still needed\&. Specifically if the system is used to build packages distributed to other systems\&. It's very important to be aware of all installed non\-standard packages to avoid dependencies that cannot be satisfied from the standard repository\&.\r
62 \r
63 .TP\r
64 list\-nodeps\r
65 list all installed packages that are not required by any other installed package\&.\r
66 \r
67 .TP\r
68 reinstall\r
69 installs a package again, even if the package is already installed\&.\r
70 \r
71 .TP\r
72 showgroup\r
73 Provide information about group (or groups)\&. Most often those groups are defined by the distributor\&. Configuration item: Scripts::Groupinstall::Backend\r
74 \r
75 .TP\r
76 showgroups\r
77 Show available groups\&. Most often those groups are defined by the distributor\&. Configuration item: Scripts::Groupinstall::Backend\r
78 \r
79 .PP\r
80 The functionality of the remaining actions are provided by other apt tools\&. The actions listed by their respective command:\r
81 \r
82 .TP\r
83 \fBapt\-get\fR\r
84 autoclean, build\-dep, check, clean, dist\-upgrade, install, moo, remove, reinstall\&. script, source, update, upgrade\&.\r
85 \r
86 .TP\r
87 \fBapt\-cache\fR\r
88 add, depends, dotty, dump, dumpavail, gencaches, pkgnames, policy, rdepends\&. search, show, showpkg, showsrc, stats, unmet, whatdepends, xvcg\&.\r
89 \r
90 .TP\r
91 \fBapt\-config\fR\r
92 shell, dump\&.\r
93 \r
94 .TP\r
95 \fBapt\-cdrom\fR\r
96 add, ident\&.\r
97 \r
98 .SH "OPTIONS"\r
99 \r
100 .TP\r
101 \fB\-\-checksig\fR\r
102 checks the integrity and origin of the candidate packages to be installed\&. If the check fails for 1 or more packages non of the candidate packages will be installed! In case the signature check fails use the \-\-hold argument to keep back the offending package(s) or use the \-\-no\-checksig argument to skip the package integrity check\&. More about package checking can be found in the rpm manual\&. Configuration item: RPM::GPG\-Check\&.\r
103 \r
104 .TP\r
105 \fB\-\-hold\fR\r
106 puts a package on hold\&. A package on hold won't be upgraded unless overruled with the install action\&. Repeat this option if multiple packages must be kept from upgrading\&. This option uses regular expressions to find the package to be put on hold\&. E\&.g\&. in case the package "at" must be hold, it must be specified as \-\-hold ^at$, if not done like this a package like attr will be put on hold as well\&. In any case it is better to put packages on hold with the rpm::hold variable in the file \fIapt\&.conf\fR!\r
107 \r
108 .TP\r
109 \fB\-\-no\-checksig\fR\r
110 Do not check the integrity of the packages to be installed\&. It can be used if the integrity check fails for 1 or more packages, but the packages have been obtained from a save origin\&. Configuration item: RPM::GPG\-Check\&.\r
111 \r
112 .TP\r
113 \fB\-\-no\-postscript\fR\r
114 Do not run a postscript after packages have been upgraded, degraded, removed or installed\&. Configuration item: Scripts::Options::RunPostScript\&.\r
115 \r
116 .TP\r
117 \fB\-\-postscript\fR\r
118 Run a postscript after packages have been upgraded, degraded, removed or installed\&. The script to use is specified with configuration item: Scripts::PM::Post::\&. With this option it is possible to run for example ldconfig or a distribution specific configuration script\&. Configuration item: Scripts::Options::RunPostScript\&.\r
119 \r
120 .TP\r
121 \fB\-\-show\-rpm\-command\fR\r
122 Shows the exact rpm command to be performed, during install, upgrade or dist\-upgrade actions\&. The action itself will not be performed\&.\r
123 \r
124 .TP\r
125 \fB\-\-sourceslist\fR\r
126 Select the sourceslist file to be used (default is \fI/etc/apt/sources\&.list\fR)\&.\r
127 \r
128 .TP\r
129 \fB\-h\fR, \fB\-\-help\fR\r
130 Show a short usage summary\&.\r
131 \r
132 .TP\r
133 \fB\-v\fR, \fB\-\-version\fR\r
134 Show the program version\&.\r
135 \r
136 .TP\r
137 \fB\-c\fR, \fB\-\-config\-file\fR\r
138 Configuration File; Specify a configuration file to use\&. The program will read the default configuration file and then this configuration file\&. See \fB\fIapt\&.conf\fR\fR(5) for syntax information\&.\r
139 \r
140 .TP\r
141 \fB\-o\fR, \fB\-\-option\fR\r
142 Set a Configuration Option; This will set an arbitary configuration option\&. The syntax is \fB\-o Foo::Bar=bar\fR\&.\r
143 \r
144 .SH "RPM OPTIONS"\r
145 \r
146 .PP\r
147 Options handed over to \fBrpm\fR, see rpm man page for their functionality\&.\r
148 \r
149 .TP\r
150 \fB\-\-test\fR\r
151 \fBRpm\fR option \-\-test\&.\r
152 \r
153 .TP\r
154 \fB\-\-force\-rpm\fR\r
155 \fBRpm\fR option \-\-force\&.\r
156 \r
157 .SH "FILES"\r
158 \r
159 .TP\r
160 \fI/usr/lib/apt/scripts\fR\r
161 APT lua scripts\&. Configuration item: Dir::Bin::scripts\&.\r
162 \r
163 .SH "ENVIRONMENT"\r
164 \r
165 .TP\r
166 \fBAPT_VERBOSE\fR\r
167 If APT_VERBOSE is defined \fBapt\fR will show which application is being dispatched\&.\r
168 \r
169 .SH "CAVEATS"\r
170 \r
171 .PP\r
172 There are 2 apt actions, add and dump, that are used by several apt commands\&. The action add is used by \fBapt\-cdrom\fR and \fBapt\-cache\fR\&. \fBapt\fR uses add from \fBapt\-cdrom\&.\fR The action dump is used by \fBapt\-config\fR and \fBapt\-cache\fR\&. \fBapt\fR uses dump from \fBapt\-config\fR\&.\r
173 \r
174 .SH "SEE ALSO"\r
175 \r
176 .PP\r
177 \fB\fBapt\-get\fR\fR(8), \fB\fBapt\-cache\fR\fR(8), \fB\fBapt\-config\fR\fR(8), \fB\fBapt\-cdrom\fR\fR(8), \fB\fBrpm\fR\fR(1)\r
178 \r
179 .SH "DIAGNOSTICS"\r
180 \r
181 .PP\r
182 \fBapt\fR returns zero on normal operation, decimal 100 on error\&.\r
183 \r
184 .SH "BUGS"\r
185 \r
186 .PP\r
187 Report bugs to <apt\-rpm@distro2\&.conectiva\&.com\&.br>\r
188 \r
189 .SH AUTHORS\r
190 Debian apt development team, Conectiva apt\-rpm development team.\r