9c617f03ce9c372c74b41ae5514b81e2eadf3b9b
[oweals/opkg-lede.git] / man / opkg-cl.1.in
1 .TH "@PACKAGE_NAME@" 1 "@CLEAN_DATE@" "@PACKAGE_STRING@" "User Commands"
2 .SH NAME
3 opkg-cl \- command line utility to install, upgrade and uninstall opkg
4 software packages
5 .
6 .SH SYNOPSIS
7 .B \fBopkg-cl\fP [\fIOPTIONS...\fP] \fIsub-command\fP [\fIARGUMENTS...\fP]
8 .
9 .SH DESCRIPTION
10 \fBopkg-cl\fP is a simple utility to install, upgrade and uninstall opkg
11 software packages. Opkg is a lightweight package management system based 
12 on Ipkg.
13 .
14 .SH "OPTIONS AND COMMANDS"
15 .SS SUB-COMMANDS : PACKAGE MANIPULATION
16 .TP
17 \fBupdate\fR
18 Update list of available packages
19 .TP
20 \fBupgrade\fR
21 Upgrade installed packages
22 .TP
23 \fBinstall <\fIpackage(s)\fP>\fR
24 Install \fIpackage(s)\fP
25 .TP
26 \fBconfigure <\fIpackage(s)\fP>\fR
27 Configure unpacked \fIpackage(s)\fP
28 .TP
29 \fBremove <\fIpackages\fP|\fIregexp\fP>\fR
30 Remove \fIpackage(s)\fP. \fIregexp\fP could be something like 'pkgname*' '*file*' or similar
31 .TP
32 \fBflag <\fIflag\fP> <\fIpackages\fP>\fR
33 Flag \fIpackage(s)\fP. Available flags (one per invocation):
34 .TS
35 tab(@);
36 l. 
37 hold
38 noprune
39 user
40 ok
41 installed
42 unpacked
43 .TE
44 .SS INFORMATIONAL SUB-COMMANDS
45 .TP
46 \fBlist\fR
47 List available packages
48 .TP
49 \fBlist-installed\fR
50 List installed packages
51 .TP
52 \fBlist-upgradable\fR
53 List installed and upgradable packages
54 .TP
55 \fBfiles <\fIpackage\fP>\fR
56 List files belonging to \fIpackage\fP
57 .TP
58 \fBsearch <\fIfile\fP|\fIregexp\fP>\fR
59 List package providing \fIfile\fP
60 .TP
61 \fBinfo [\fIpackage\fP|\fIregexp\fP]\fR
62 Display all info for selected packages
63 .TP
64 \fBstatus [\fIpackage\fP|\fIregexp\fP]\fR
65 Display all statuses for selected packages
66 .TP
67 \fBdownload <\fIpackage\fP>\fR
68 Download \fIpackage\fP to current directory
69 .TP
70 \fBcompare-version <\fIversion1\fP> <\fIoperator\fP> <\fIversion2\fP>\fR
71 compare versions using following operators :
72 .TS
73 tab(@);
74 c l. 
75 <<@less than
76 <@less than or equal to
77 <=@less than or equal to
78  =@equal to
79 >=@greater than or equal to
80 >@greater than or equal to
81 >>@greater than
82 .TE
83 .TP
84 \fBprint-architecture\fR
85 List installable package architectures
86 .TP
87 \fBwhatdepends [\fI\-A\fP] <\fIpackage(s)\fP|\fIregexp\fP>\fR
88 .TP
89 \fBwhatdependsrec [\fI\-A\fP] <\fIpackage(s)\fP|\fIregexp\fP>\fR
90 .TP
91 \fBwhatprovides [\fI\-A\fP] <\fIpackage(s)\fP|\fIregexp\fP>\fR
92 .TP
93 \fBwhatconflicts [\fI\-A\fP] <\fIpackage(s)\fP|\fIregexp\fP>\fR
94 .TP
95 \fBwhatreplaces [\fI\-A\fP] <\fIpackage(s)\fP|\fIregexp\fP>\fR
96
97 .SS OPTIONS
98 .TP 
99 \fB\-A\fR
100 Query all packages not just those installed
101 .
102 .TP
103 \fB\-v <\fIlevel\fP>, --verbosity <\fIlevel\fP>\fR
104 Set verbosity level to \fIlevel\fP. Verbosity levels :
105 .TS
106 tab(@);
107 l l.
108 0@errors only
109 1@normal messages (default)
110 2@informative messages
111 3@debug
112 4@debug level 2
113 .TE
114 .
115 .TP
116 \fB\-f <\fIconf_file\fP>, \fB\--conf <\fIconf_file\fP>\fR
117 Use \fIconf_file\fP as the opkg configuration file
118 .TP
119 \fB\--cache <\fIdirectory\fP>\fR
120 Use a package cache
121 .TP
122 \fB\-d <\fIdest_name\fP>, \fB\--dest <\fIdest_name\fP>\fR
123 Use \fIdest_name\fP as the the root directory for
124 package installation, removal, upgrading. \fIdest_name\fP should be a 
125 defined dest name from the configuration file, (but can also be a
126 directory name in a pinch).
127 .TP 
128 \fB\-o <\fIdirectory\fP>, \fB\--offline-root <\fIdirectory\fP>\fR
129 Use \fIdirectory\fP as the root directory for offline installation of 
130 packages.
131 .SS FORCE OPTIONS
132 .TP 
133 \fB\--force-depends \fR
134 Install/remove despite failed dependencies
135 .TP 
136 \fB\--force-maintainer \fR
137 Overwrite preexisting config files
138 .TP 
139 \fB\--force-reinstall \fR
140 Reinstall package(s)
141 .TP 
142 \fB\--force-overwrite\fR
143 Overwrite files from other package(s)
144 .TP 
145 \fB\--force-downgrade\fR
146 Allow opkg-cl to downgrade packages
147 .TP 
148 \fB\--force-space \fR
149 Disable free space checks
150 .TP 
151 \fB\--noaction\fR
152 No action \- test only
153 .TP 
154 \fB\--download-only\fR
155 No action \- download only
156 .TP 
157 \fB\--nodeps\fR
158 Do not follow dependencies
159 .TP 
160 \fB\--force-removal-of-dependent-packages\fR
161 Remove package and all dependencies
162 .TP 
163 \fB\--autoremove\fR
164 Remove packages that were installed automatically to satisfy dependencies
165 .TP 
166 \fB\-t <\fIdirectory\fP>, \--tmp-dir <\fIdirectory\fP>\fR
167 Specify \fIdirectory\fP as temporary directory
168 .
169 .SH "REPORTING BUGS"
170 Report bugs to http://code.google.com/p/opkg/issues/list
171 .
172 .P
173 Copyright \(co Opkg development team.
174 .P
175 Copyright \(co Ipkg development team.
176 .