build: fix handling of string options
[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 \fBlist-changed-conffiles\fR
56 List package configuration files which have been modified after installation
57 .TP
58 \fBfiles <\fIpackage\fP>\fR
59 List files belonging to \fIpackage\fP
60 .TP
61 \fBsearch <\fIfile\fP|\fIregexp\fP>\fR
62 List package providing \fIfile\fP
63 .TP
64 \fBinfo [\fIpackage\fP|\fIregexp\fP]\fR
65 Display all info for selected packages
66 .TP
67 \fBstatus [\fIpackage\fP|\fIregexp\fP]\fR
68 Display all statuses for selected packages
69 .TP
70 \fBdownload <\fIpackage\fP>\fR
71 Download \fIpackage\fP to current directory
72 .TP
73 \fBcompare-version <\fIversion1\fP> <\fIoperator\fP> <\fIversion2\fP>\fR
74 compare versions using following operators :
75 .TS
76 tab(@);
77 c l. 
78 <<@less than
79 <@less than or equal to
80 <=@less than or equal to
81  =@equal to
82 >=@greater than or equal to
83 >@greater than or equal to
84 >>@greater than
85 .TE
86 .TP
87 \fBprint-architecture\fR
88 List installable package architectures
89 .TP
90 \fBwhatdepends [\fI\-A\fP] <\fIpackage(s)\fP|\fIregexp\fP>\fR
91 .TP
92 \fBwhatdependsrec [\fI\-A\fP] <\fIpackage(s)\fP|\fIregexp\fP>\fR
93 .TP
94 \fBwhatprovides [\fI\-A\fP] <\fIpackage(s)\fP|\fIregexp\fP>\fR
95 .TP
96 \fBwhatconflicts [\fI\-A\fP] <\fIpackage(s)\fP|\fIregexp\fP>\fR
97 .TP
98 \fBwhatreplaces [\fI\-A\fP] <\fIpackage(s)\fP|\fIregexp\fP>\fR
99
100 .SS OPTIONS
101 .TP 
102 \fB\-A\fR
103 Query all packages not just those installed
104 .
105 .TP
106 \fB\-v <\fIlevel\fP>, --verbosity <\fIlevel\fP>\fR
107 Set verbosity level to \fIlevel\fP. Verbosity levels :
108 .TS
109 tab(@);
110 l l.
111 0@errors only
112 1@normal messages (default)
113 2@informative messages
114 3@debug
115 4@debug level 2
116 .TE
117 .
118 .TP
119 \fB\-f <\fIconf_file\fP>, \fB\--conf <\fIconf_file\fP>\fR
120 Use \fIconf_file\fP as the opkg configuration file
121 .TP
122 \fB\--cache <\fIdirectory\fP>\fR
123 Use a package cache
124 .TP
125 \fB\-d <\fIdest_name\fP>, \fB\--dest <\fIdest_name\fP>\fR
126 Use \fIdest_name\fP as the the root directory for
127 package installation, removal, upgrading. \fIdest_name\fP should be a 
128 defined dest name from the configuration file, (but can also be a
129 directory name in a pinch).
130 .TP 
131 \fB\-o <\fIdirectory\fP>, \fB\--offline-root <\fIdirectory\fP>\fR
132 Use \fIdirectory\fP as the root directory for offline installation of 
133 packages.
134 .TP 
135 \fB\--add-dest <\fIname\fP>:<\fIpath\fP>\fR
136 Register \fIpath\fP as installation target \fIname\fP for use in
137 conjunction with \fB\--dest\fP
138 .TP 
139 \fB\--add-arch <\fIarch\fP>:<\fIprio\fP>\fR
140 Register the package architecture \fIarch\fP with the numeric
141 priority \fIprio\fP. Lower priorities take precedence.
142 .SS FORCE OPTIONS
143 .TP 
144 \fB\--force-depends \fR
145 Install/remove despite failed dependencies
146 .TP 
147 \fB\--force-maintainer \fR
148 Overwrite preexisting config files
149 .TP 
150 \fB\--force-reinstall \fR
151 Reinstall package(s)
152 .TP 
153 \fB\--force-overwrite\fR
154 Overwrite files from other package(s)
155 .TP 
156 \fB\--force-downgrade\fR
157 Allow opkg-cl to downgrade packages
158 .TP 
159 \fB\--force-space \fR
160 Disable free space checks
161 .TP 
162 \fB\--force-postinstall \fR
163 Execute package postinstall scripts in offline installation mode
164 .TP 
165 \fB\--noaction\fR
166 No action \- test only
167 .TP 
168 \fB\--download-only\fR
169 No action \- download only
170 .TP 
171 \fB\--nodeps\fR
172 Do not follow dependencies
173 .TP 
174 \fB\--force-removal-of-dependent-packages\fR
175 Remove package and all dependencies
176 .TP 
177 \fB\--autoremove\fR
178 Remove packages that were installed automatically to satisfy dependencies
179 .TP 
180 \fB\-t <\fIdirectory\fP>, \--tmp-dir <\fIdirectory\fP>\fR
181 Specify \fIdirectory\fP as temporary directory
182 .
183 .SH "REPORTING BUGS"
184 Report bugs to http://code.google.com/p/opkg/issues/list
185 .
186 .P
187 Copyright \(co Opkg development team.
188 .P
189 Copyright \(co Ipkg development team.
190 .