tazpkg diff doc/tazpkg.en.html @ rev 828
Add modules "info", "list" with extended functions; update documentations and translations
| author | Aleksej Bobylev <al.bobylev@gmail.com> |
|---|---|
| date | Tue Aug 11 01:09:15 2015 +0300 (2015-08-11) |
| parents | a73c9918a5de |
| children | f1c82b2d20aa |
line diff
1.1 --- a/doc/tazpkg.en.html Thu Jun 04 00:15:13 2015 +0300 1.2 +++ b/doc/tazpkg.en.html Tue Aug 11 01:09:15 2015 +0300 1.3 @@ -2,7 +2,7 @@ 1.4 <html lang="en"> 1.5 <head> 1.6 <meta charset="utf-8" /> 1.7 - <title>TazPkg Manual (en)</title> 1.8 + <title>TazPkg Manual</title> 1.9 <meta name="viewport" content="width=device-width,initial-scale=1"/> 1.10 <link rel="stylesheet" type="text/css" href="../slitaz-doc.css" /> 1.11 <script type="text/javascript" src="../slitaz-doc.js"></script> 1.12 @@ -17,19 +17,19 @@ 1.13 <div id="content"> 1.14 1.15 1.16 -<h2>NAME</h2> 1.17 +<h2>Name</h2> 1.18 1.19 <p>TazPkg — Tiny autonomous zone package manager</p> 1.20 1.21 1.22 -<h2>SYNTAX</h2> 1.23 +<h2>Syntax</h2> 1.24 1.25 <pre> 1.26 tazpkg [command] [options...] 1.27 </pre> 1.28 1.29 1.30 -<h2>DESCRIPTION</h2> 1.31 +<h2>Description</h2> 1.32 1.33 <p>TazPkg is a lightweight package manager to install, list, download, update or 1.34 remove precompiled packages on a GNU/Linux system. TazPkg offers commands for 1.35 @@ -43,10 +43,216 @@ 1.36 1.37 <p>TazPkg is entirely built from scratch using Shell script, compatible with 1.38 Bash; it runs under Ash — part of the Busybox project. TazPkg is distributed 1.39 -under the free GNU license GPL V3.</p> 1.40 +under the free GNU license <a href="file:///usr/share/licenses/gpl.txt" 1.41 +target="_blank">GPL V3</a>.</p> 1.42 1.43 1.44 -<h2>COMMANDS</h2> 1.45 +<h2>Environment</h2> 1.46 + 1.47 +<p>TazPkg uses some environment variables:</p> 1.48 + 1.49 +<ul> 1.50 + <li><tt>LANGUAGE</tt>: define the language of output and user 1.51 + confirmations. <x-details>Note, <tt>LANG</tt> and <tt>LC_ALL</tt> 1.52 + environment variables also affect output language</x-details></li> 1.53 + <li><tt>LC_TIME</tt>: define the date format in the <a 1.54 + href="#activity">activity</a> command</li> 1.55 + <!-- li><tt>TAZPKG_ROOT</tt>: if defined it points to the root of file system 1.56 + where TazPkg should work. Note, value defined using <tt>--root=</tt> 1.57 + option has precedence over this environment variable</li --> 1.58 +</ul> 1.59 + 1.60 + 1.61 +<h2>Files</h2> 1.62 + 1.63 + 1.64 +<h3>Configuration files</h3> 1.65 + 1.66 +<ul> 1.67 + <li><tt><a href="file:///etc/slitaz/slitaz.conf" 1.68 + target="_blank">/etc/slitaz/slitaz.conf</a></tt></li> 1.69 + <li><tt><a href="file:///etc/slitaz/tazpkg.conf" 1.70 + target="_blank">/etc/slitaz/tazpkg.conf</a></tt></li> 1.71 +</ul> 1.72 + 1.73 + 1.74 +<h3>Package database files</h3> 1.75 + 1.76 +<p>Default placement of the package database is <tt>/var/lib/tazpkg</tt>.</p> 1.77 + 1.78 +<ul> 1.79 + <li><tt><a href="file:///var/lib/tazpkg/ID" target="_blank">ID</a></tt> 1.80 + (deprecated): identifier of current SliTaz repository state. 1.81 + <x-details>The value change when new or updated packages appear in the 1.82 + repository.</x-details></li> 1.83 + <li><tt><a href="file:///var/lib/tazpkg/IDs" target="_blank">IDs</a></tt>: 1.84 + identifier of current SliTaz repository state and the UNIX time stamp. 1.85 + <x-details>The ID value change when new or updated packages appear in 1.86 + the repository. Time stamp allows to track how long a change is made in 1.87 + the repository, and allows to track the freshness of repository mirrors. 1.88 + (To convert UNIX time stamp to the date: 1.89 + <code>date -d@<em>timestamp</em></code>)</x-details></li> 1.90 + <li><tt><a href="file:///var/lib/tazpkg/mirror" 1.91 + target="_blank">mirror</a></tt>: URL of the current repository mirror in 1.92 + use. <x-details>URL points to the remote folder contains packages and 1.93 + database files.</x-details></li> 1.94 + <li><tt><a href="file:///var/lib/tazpkg/mirrors" 1.95 + target="_blank">mirrors</a></tt>: list of URLs of available repository 1.96 + mirrors. <x-details>Note the difference between URLs from these two 1.97 + files: you should append URL from this file by 1.98 + <tt>packages/<em>cooking</em>/</tt> (for <tt><em>cooking</em></tt>-based 1.99 + Slitaz version).</x-details></li> 1.100 + <li><tt><a href="file:///var/lib/tazpkg/packages.list" 1.101 + target="_blank">packages.list</a></tt> (deprecated): list of package 1.102 + names with version numbers available in the repository.</li> 1.103 + <li><tt><a href="file:///var/lib/tazpkg/packages.desc" 1.104 + target="_blank">packages.desc</a></tt> (deprecated): list contained 1.105 + package name, version, short description, category, and upstream 1.106 + URL.</li> 1.107 + <li><tt><a href="file:///var/lib/tazpkg/packages.txt" 1.108 + target="_blank">packages.txt</a></tt> (deprecated): list contained 1.109 + package name, version, short description, and two package sizes 1.110 + <x-details>(first — traffic to download package, second — HDD size for 1.111 + installed package)</x-details>.</li> 1.112 + <li><tt><a href="file:///var/lib/tazpkg/packages.md5" 1.113 + target="_blank">packages.md5</a></tt> (deprecated): list contained MD5 1.114 + checksum with package file name.</li> 1.115 + <li><tt><a href="file:///var/lib/tazpkg/packages.info" 1.116 + target="_blank">packages.info</a></tt>: list was build to replace and 1.117 + extend above lists. <x-details>For every package available in the 1.118 + repository it contains: package name, version, category, short 1.119 + description, upstream URL, tags, package sizes, depends, and MD5 1.120 + checksum. Development continues, and the list can be extended by other 1.121 + fields, if necessary.</x-details></li> 1.122 + <li><tt><a href="file:///var/lib/tazpkg/packages.equiv" 1.123 + target="_blank">packages.equiv</a></tt>: list of equivalent packages 1.124 + available in the repository. <x-details>Format of the list item: 1.125 + <tt><em>package</em>=<em>rule rule…</em></tt>.<br> 1.126 + Format of the rule: <tt><em>alternative:newname</em></tt> — if 1.127 + <tt><em>alternative</em></tt> is installed then 1.128 + <tt><em>newname</em></tt> will be installed instead of the 1.129 + <tt><em>package</em></tt>.<br> 1.130 + In the second format of the rule <tt><em>alternative:</em></tt> part is 1.131 + omitted — in this case <tt><em>newname</em></tt> <em>can be</em> 1.132 + installed insted of the <tt><em>package</em></tt> (in the user 1.133 + choice).</x-details></li> 1.134 + <li><tt><a href="file:///var/lib/tazpkg/packages.diff" 1.135 + target="_blank">packages.diff</a></tt>: list created when you run 1.136 + <tt><a href="#recharge">recharge</a></tt> command. <x-details>List 1.137 + contains package names with versions of the new packages available in 1.138 + the repository with the last recharging.</x-details></li> 1.139 + <li><tt><a href="file:///var/lib/tazpkg/packages.up" 1.140 + target="_blank">packages.up</a></tt>: list created when you run 1.141 + <tt><a href="#upgrade">upgrade</a></tt> command. <x-details>List 1.142 + contains package names you can upgrade with the last 1.143 + recharging.</x-details></li> 1.144 + <li><tt><a href="file:///var/lib/tazpkg/descriptions.txt" 1.145 + target="_blank">descriptions.txt</a></tt>: list of the “long” 1.146 + descriptions of the all packages available on the repository.</li> 1.147 + <li><tt>packages-desc.<em>language</em></tt> — optional list of the packages 1.148 + translated short descriptions <x-details>(see the package 1.149 + tazpkg-desc-ru)</x-details>.</li> 1.150 + <li><tt>descriptions.<em>language</em>.txt</tt> — optional list of the 1.151 + packages translated “long” descriptions <x-details>(see the package 1.152 + tazpkg-desc-ru)</x-details>.</li> 1.153 + <li><tt>packages.icons</tt> — optional list of the packages icons for 1.154 + TazPanel.</li> 1.155 + <li><tt><a href="file:///var/lib/tazpkg/blocked-packages.list" 1.156 + target="_blank">blocked-packages.list</a></tt>: optional list of the 1.157 + packages blocked for update.</li> 1.158 + <li><tt><a href="file:///var/lib/tazpkg/extra.list" 1.159 + target="_blank">extra.list</a></tt>: list of the extra packages 1.160 + <x-details>(non-free packages; free packages but not compiled from 1.161 + sources). List contains package name, short description, upstream URL, 1.162 + category, version, license.</x-details></li> 1.163 + <li><tt>files.list.lzma</tt>: very large compressed list which contains all 1.164 + the files of all the packages available in the repository 1.165 + <x-details>(nearly 5,000 packages and nearly 0.7 million 1.166 + files now)</x-details>.</li> 1.167 + <li><tt>files-list.md5</tt>: MD5 checksum of the 1.168 + <tt>files.list.lzma</tt>.</li> 1.169 + <li><tt><a href="file:///var/lib/tazpkg/installed.info" 1.170 + target="_blank">installed.info</a></tt>: list of the installed packages 1.171 + with the exact format of the <tt>packages.info</tt> list. 1.172 + <x-details>Idea is just to copy list item from <tt>packages.info</tt> to 1.173 + the <tt>installed.info</tt> while package installation.</x-details></li> 1.174 + <li><tt><a href="file:///var/lib/tazpkg/installed.md5" 1.175 + target="_blank">installed.md5</a></tt> (deprecated): list contained MD5 1.176 + checksum with file names of all installed packages.</li> 1.177 +</ul> 1.178 + 1.179 +<p>All the deprecated files will be deleted after we verify that the programs do 1.180 +not use them (and modify the programs as necessary).</p> 1.181 + 1.182 +<p>In addition to the common package database files there is also individual 1.183 +folders for all installed packages placed by default in the 1.184 +<tt>/var/lib/tazpkg/installed/<em>package</em></tt>. Every folder here may 1.185 +contain next files:</p> 1.186 + 1.187 +<ul> 1.188 + <li><tt>receipt</tt> (mandatory) — the package recipe</li> 1.189 + <li><tt>files.list</tt> (mandatory) — list of package files</li> 1.190 + <li><tt>md5sum</tt> (mandatory) — checksums of package files (other checksum 1.191 + file can be specified in the settings: <tt>cksum</tt> (CRC32), 1.192 + <tt>md5sum</tt> (MD5), <tt>sha1sum</tt> (SHA1), <tt>sha256sum</tt> 1.193 + (SHA256), <tt>sha512sum</tt> (SHA512), <tt>sha3sum</tt> (SHA3-512))</li> 1.194 + <li><tt>description.txt</tt> (optional) — “long” description</li> 1.195 + <li><tt>modifiers</tt> (optional) — list of packages that have replaced some 1.196 + of the files of this package</li> 1.197 + <li><tt>volatile.cpio.gz</tt> (optional) — archive of “official” 1.198 + configuration files</li> 1.199 +</ul> 1.200 + 1.201 + 1.202 +<h3>Cache</h3> 1.203 + 1.204 +<p>Default placement of the packages cache is <tt>/var/cache/tazpkg</tt> with 1.205 +sub-folders for the different repositories. <x-details>It is exactly 1.206 +<tt>/var/cache/tazpkg/<em>cooking</em>/packages</tt> for the 1.207 +<tt><em>cooking</em></tt>-based SliTaz version.</x-details></p> 1.208 + 1.209 + 1.210 +<h3>Misc files</h3> 1.211 + 1.212 +<p>File with default placement <tt><a href="file:///var/log/slitaz/tazpkg.log" 1.213 +target="_blank">/var/log/slitaz/tazpkg.log</a></tt> stores TazPkg activity log. 1.214 +<x-details>Log stores five types of actions: installing, uninstalling, blocking, 1.215 +unblocking, reconfiguring packages.</x-details></p> 1.216 + 1.217 +<p>Shared MIME information which allows to “guess” SliTaz package files, package 1.218 +receipts, and SliTaz flavor files. <x-details>File placed here: <tt><a 1.219 +href="file:///usr/share/mime/packages/tazpkg.xml" 1.220 +target="_blank">/usr/share/mime/packages/tazpkg.xml</a></tt>.</x-details></p> 1.221 + 1.222 +<p>Plug-in for the TazPanel (SliTaz administration and configuration panel) 1.223 +<tt>/var/www/tazpanel/pkgs.cgi</tt> allows you to manage SliTaz packages in the 1.224 +<a href="http://127.0.0.1:82/pkgs.cgi" target="_blank">web application</a>.</p> 1.225 + 1.226 +<p>TazPkg documentation you read placed in the <tt>/usr/share/doc/tazpkg</tt> 1.227 +folder.</p> 1.228 + 1.229 + 1.230 + 1.231 + 1.232 +<h2>Commands</h2> 1.233 + 1.234 +<p>The first <tt>tazpkg</tt> parameter is a command followed by other mandatory 1.235 +and optional parameters as will be described hereinafter. Options begin with 1.236 +double dashes.<!-- , you can arrange them in any order and in any place, even before 1.237 +the command. Unknown and inappropriate options are ignored. The following 1.238 +commands are equivalent: --></p> 1.239 + 1.240 +<!-- pre> 1.241 +$ tazpkg info nano --root=<em>/mnt/sda6</em> 1.242 +$ tazpkg --root=<em>/mnt/sda6</em> info nano 1.243 +$ tazpkg info --root=<em>/mnt/sda6</em> nano <em>--color</em> 1.244 +</pre --> 1.245 + 1.246 +<!-- p>You can add global option <tt>--root=…</tt> to any TazPkg command. This 1.247 +option allows to work with other SliTaz installations. Option points to the root 1.248 +of mounted file system from other SliTaz installation. <x-details>By the way, 1.249 +using this option allows to install SliTaz to the other file system “from 1.250 +scratch”, and upgrade SliTaz packages remotely.</x-details></p --> 1.251 1.252 1.253 <h3>Service commands</h3> 1.254 @@ -344,8 +550,9 @@ 1.255 <tt>.tazpkg</tt> extension (<tt>install</tt> or <tt>-i</tt>). See 1.256 <tt><a href="#get-install">get-install</a></tt> to install a package from the 1.257 internet. Note that you can force the installation via the <tt>--forced</tt> 1.258 -option, specify the root system where you want to install the packages via the 1.259 -<tt>--root=</tt> option.</p> 1.260 +option. Option <tt>--newconf</tt> allow to rewrite all user configuration files 1.261 +using the new files from package. Option <tt>--nodeps</tt> allow to install only 1.262 +specified package without its dependencies.</p> 1.263 1.264 <pre> 1.265 # tazpkg install <em>package-1.0.tazpkg</em> 1.266 @@ -360,14 +567,12 @@ 1.267 or <tt>-gi</tt>). Command begins by checking whether the package exists on the 1.268 mirror and if it has been already downloaded. For a list of packages on the 1.269 mirror, we must use the <tt><a href="#list-mirror">list-mirror</a></tt> 1.270 -command.</p> 1.271 +command. Note that you can force the installation via the <tt>--forced</tt> 1.272 +option. Option <tt>--newconf</tt> allow to rewrite all user configuration files 1.273 +using the new files from package. Option <tt>--nodeps</tt> allow to install only 1.274 +specified package without its dependencies.</p> 1.275 1.276 -<p>Following options are recognized by command:</p> 1.277 - 1.278 -<p><tt>--forced</tt> allow update already installed package.</p> 1.279 - 1.280 -<p><tt>--root=</tt> allow specify root of filesystem where package will be 1.281 -installed.</p> 1.282 +<p>Option <tt>--forced</tt> allow update already installed package.</p> 1.283 1.284 <pre> 1.285 # tazpkg get-install <em>grub</em> 1.286 @@ -395,8 +600,7 @@ 1.287 depending on this package, and for reinstalling packages modified by this 1.288 package. This command will delete all files installed with the package.</p> 1.289 1.290 -<p>Option <tt>--root=</tt> allows to specify root of the FS where package will 1.291 -be removed. Option <tt>--auto</tt> removes and reinstall packages without your 1.292 +<p>Option <tt>--auto</tt> removes and reinstall packages without your 1.293 confirmation.</p> 1.294 1.295 <pre> 1.296 @@ -455,12 +659,18 @@ 1.297 1.298 <h3 id="info">info</h3> 1.299 1.300 -<p>Display any information available in the receipt for the package in 1.301 -question — its version, category, maintainer, Web site and any dependencies (see 1.302 -also Cookutils for more information on receipts).</p> 1.303 +<p>Show all the available information related to your package. You can specify 1.304 +the name of the installed package or a package that is not yet installed, but 1.305 +available in the repository. You can also get information about local file 1.306 +package by entering an absolute or relative path to the file <tt>.tazpkg</tt>. 1.307 +The information contained in the TazPkg database and in the package recipe — 1.308 +its version, category, maintainer, Web site and all the dependencies (see also 1.309 +Cookutils for more information on recipes).</p> 1.310 1.311 <pre> 1.312 $ tazpkg info <em>busybox</em> 1.313 +$ tazpkg info <em>minitube</em> 1.314 +$ tazpkg info <em>packages/comix-4.0.4.tazpkg</em> 1.315 </pre> 1.316 1.317 1.318 @@ -532,6 +742,17 @@ 1.319 1.320 <p>Displays a dependency tree or reverse dependency tree for a package.</p> 1.321 1.322 +<p>For <code>depends</code> command: option <tt>--mark</tt> marks installed 1.323 +packages with plus sign, and not installed with minus/dash. Option 1.324 +<tt>--total</tt> calculates number of displayed packages and its size. Also, 1.325 +with both options at a time you'll get number and size of packages to be 1.326 +installed.</p> 1.327 + 1.328 +<p>For <code>rdepends</code> command: without <tt>--all</tt> option you'll get 1.329 +the list of only installed reverse dependency packages, with this option — list 1.330 +of all available packages. Option <tt>--mark</tt> marks packages as in the 1.331 +<code>depends</code> command.</p> 1.332 + 1.333 <pre> 1.334 # tazpkg depends <em>mpd</em> 1.335 # tazpkg rdepends <em>mpd</em> 1.336 @@ -684,21 +905,19 @@ 1.337 aimed at people with SliTaz installed on a hard drive. Updated packages in 1.338 Live CD mode will be lost on system shutdown.</p> 1.339 1.340 +<p>At the beginning the packages database is updated automatically (<tt><a 1.341 +href="#recharge">recharge</a></tt>) in order to provide you with the current 1.342 +list of packages that you can update.</p> 1.343 + 1.344 <p>Without options run in interactive mode and ask before install. You can 1.345 -specify one or more of the next options:</p> 1.346 - 1.347 -<p><tt>-c</tt> or <tt>--check</tt> to check only for available upgrades;</p> 1.348 - 1.349 -<p><tt>-r</tt> or <tt>--recharge</tt> to force recharge of packages list and 1.350 -check;</p> 1.351 - 1.352 -<p><tt>-i</tt> or <tt>--install</tt> to check for upgrades and install them 1.353 -all.</p> 1.354 +specify one of the next options: <tt>-c</tt> or <tt>--check</tt> to check only 1.355 +for available upgrades; <tt>-i</tt> or <tt>--install</tt> to check for upgrades 1.356 +and install them all.</p> 1.357 1.358 <pre> 1.359 # tazpkg upgrade 1.360 -# tazpkg up --recharge --install 1.361 -# tazpkg up -r -i 1.362 +# tazpkg up --check 1.363 +# tazpkg up -i 1.364 </pre> 1.365 1.366 1.367 @@ -750,11 +969,16 @@ 1.368 1.369 1.370 1.371 -<h2>MAINTAINER</h2> 1.372 +<h2>Maintainer</h2> 1.373 1.374 <p>Christophe Lincoln <pankso at slitaz.org></p> 1.375 1.376 </div> 1.377 <!-- End content --> 1.378 + 1.379 +<footer> 1.380 + Copyright © 2015 <a href="http://www.slitaz.org/">SliTaz GNU/Linux</a> 1.381 +</footer> 1.382 + 1.383 </body> 1.384 </html>