tazpkg rev 835
en: edit docs
| author | Paul Issott <paul@slitaz.org> |
|---|---|
| date | Sat Aug 15 12:23:33 2015 +0100 (2015-08-15) |
| parents | f1c82b2d20aa |
| children | 4fbdffec7f48 |
| files | doc/tazpkg.en.html |
line diff
1.1 --- a/doc/tazpkg.en.html Fri Aug 14 16:55:14 2015 +0300 1.2 +++ b/doc/tazpkg.en.html Sat Aug 15 12:23:33 2015 +0100 1.3 @@ -52,10 +52,10 @@ 1.4 <p>TazPkg uses some environment variables:</p> 1.5 1.6 <ul> 1.7 - <li><tt>LANGUAGE</tt>: define the language of output and user 1.8 + <li><tt>LANGUAGE</tt>: defines the language of output and user 1.9 confirmations. <x-details>Note, <tt>LANG</tt> and <tt>LC_ALL</tt> 1.10 environment variables also affect output language</x-details></li> 1.11 - <li><tt>LC_TIME</tt>: define the date format in the <a 1.12 + <li><tt>LC_TIME</tt>: defines the date format in the <a 1.13 href="#activity">activity</a> command</li> 1.14 <!-- li><tt>TAZPKG_ROOT</tt>: if defined it points to the root of file system 1.15 where TazPkg should work. Note, value defined using <tt>--root=</tt> 1.16 @@ -82,24 +82,24 @@ 1.17 1.18 <ul> 1.19 <li><tt><a href="file:///var/lib/tazpkg/ID" target="_blank">ID</a></tt> 1.20 - (deprecated): identifier of current SliTaz repository state. 1.21 - <x-details>The value change when new or updated packages appear in the 1.22 + (deprecated): identifier of the current SliTaz repository state. 1.23 + <x-details>The value changes when new or updated packages appear in the 1.24 repository.</x-details></li> 1.25 <li><tt><a href="file:///var/lib/tazpkg/IDs" target="_blank">IDs</a></tt>: 1.26 - identifier of current SliTaz repository state and the UNIX time stamp. 1.27 - <x-details>The ID value change when new or updated packages appear in 1.28 - the repository. Time stamp allows to track how long a change is made in 1.29 - the repository, and allows to track the freshness of repository mirrors. 1.30 + identifier of the current SliTaz repository state and the UNIX time stamp. 1.31 + <x-details>The ID value changes when new or updated packages appear in 1.32 + the repository. Time stamp allows you to track how long a change is made in 1.33 + the repository and to track the freshness of repository mirrors. 1.34 (To convert UNIX time stamp to the date: 1.35 <code>date -d@<em>timestamp</em></code>)</x-details></li> 1.36 <li><tt><a href="file:///var/lib/tazpkg/mirror" 1.37 target="_blank">mirror</a></tt>: URL of the current repository mirror in 1.38 - use. <x-details>URL points to the remote folder contains packages and 1.39 + use. <x-details>URL points to the remote folder containing packages and 1.40 database files.</x-details></li> 1.41 <li><tt><a href="file:///var/lib/tazpkg/mirrors" 1.42 target="_blank">mirrors</a></tt>: list of URLs of available repository 1.43 mirrors. <x-details>Note the difference between URLs from these two 1.44 - files: you should append URL from this file by 1.45 + files; you should append URL from this file by 1.46 <tt>packages/<em>cooking</em>/</tt> (for <tt><em>cooking</em></tt>-based 1.47 Slitaz version).</x-details></li> 1.48 <li><tt><a href="file:///var/lib/tazpkg/packages.list" 1.49 @@ -107,21 +107,21 @@ 1.50 names with version numbers available in the repository.</li> 1.51 <li><tt><a href="file:///var/lib/tazpkg/packages.desc" 1.52 target="_blank">packages.desc</a></tt> (deprecated): list contained 1.53 - package name, version, short description, category, and upstream 1.54 + package name, version, short description, category and upstream 1.55 URL.</li> 1.56 <li><tt><a href="file:///var/lib/tazpkg/packages.txt" 1.57 - target="_blank">packages.txt</a></tt> (deprecated): list contained 1.58 - package name, version, short description, and two package sizes 1.59 + target="_blank">packages.txt</a></tt> (deprecated): list containing 1.60 + package name, version, short description and two package sizes 1.61 <x-details>(first — traffic to download package, second — HDD size for 1.62 installed package)</x-details>.</li> 1.63 <li><tt><a href="file:///var/lib/tazpkg/packages.md5" 1.64 - target="_blank">packages.md5</a></tt> (deprecated): list contained MD5 1.65 + target="_blank">packages.md5</a></tt> (deprecated): list containing MD5 1.66 checksum with package file name.</li> 1.67 <li><tt><a href="file:///var/lib/tazpkg/packages.info" 1.68 - target="_blank">packages.info</a></tt>: list was build to replace and 1.69 + target="_blank">packages.info</a></tt>: list was built to replace and 1.70 extend above lists. <x-details>For every package available in the 1.71 repository it contains: package name, version, category, short 1.72 - description, upstream URL, tags, package sizes, depends, and MD5 1.73 + description, upstream URL, tags, package sizes, depends and MD5 1.74 checksum. Development continues, and the list can be extended by other 1.75 fields, if necessary.</x-details></li> 1.76 <li><tt><a href="file:///var/lib/tazpkg/packages.equiv" 1.77 @@ -134,18 +134,18 @@ 1.78 <tt><em>package</em></tt>.<br> 1.79 In the second format of the rule <tt><em>alternative:</em></tt> part is 1.80 omitted — in this case <tt><em>newname</em></tt> <em>can be</em> 1.81 - installed insted of the <tt><em>package</em></tt> (in the user 1.82 + installed instead of the <tt><em>package</em></tt> (in the user 1.83 choice).</x-details></li> 1.84 <li><tt><a href="file:///var/lib/tazpkg/packages.diff" 1.85 target="_blank">packages.diff</a></tt>: list created when you run 1.86 <tt><a href="#recharge">recharge</a></tt> command. <x-details>List 1.87 contains package names with versions of the new packages available in 1.88 - the repository with the last recharging.</x-details></li> 1.89 + the repository with the last recharge.</x-details></li> 1.90 <li><tt><a href="file:///var/lib/tazpkg/packages.up" 1.91 target="_blank">packages.up</a></tt>: list created when you run 1.92 <tt><a href="#upgrade">upgrade</a></tt> command. <x-details>List 1.93 contains package names you can upgrade with the last 1.94 - recharging.</x-details></li> 1.95 + recharge.</x-details></li> 1.96 <li><tt><a href="file:///var/lib/tazpkg/descriptions.txt" 1.97 target="_blank">descriptions.txt</a></tt>: list of the “long” 1.98 descriptions of the all packages available on the repository.</li> 1.99 @@ -175,9 +175,9 @@ 1.100 target="_blank">installed.info</a></tt>: list of the installed packages 1.101 with the exact format of the <tt>packages.info</tt> list. 1.102 <x-details>Idea is just to copy list item from <tt>packages.info</tt> to 1.103 - the <tt>installed.info</tt> while package installation.</x-details></li> 1.104 + the <tt>installed.info</tt> during package installation.</x-details></li> 1.105 <li><tt><a href="file:///var/lib/tazpkg/installed.md5" 1.106 - target="_blank">installed.md5</a></tt> (deprecated): list contained MD5 1.107 + target="_blank">installed.md5</a></tt> (deprecated): list containing MD5 1.108 checksum with file names of all installed packages.</li> 1.109 </ul> 1.110 1.111 @@ -187,13 +187,13 @@ 1.112 <p>In addition to the common package database files there is also individual 1.113 folders for all installed packages placed by default in the 1.114 <tt>/var/lib/tazpkg/installed/<em>package</em></tt>. Every folder here may 1.115 -contain next files:</p> 1.116 +contain the following files:</p> 1.117 1.118 <ul> 1.119 <li><tt>receipt</tt> (mandatory) — the package recipe</li> 1.120 <li><tt>files.list</tt> (mandatory) — list of package files</li> 1.121 <li><tt>md5sum</tt> (mandatory) — checksums of package files (other checksum 1.122 - file can be specified in the settings: <tt>cksum</tt> (CRC32), 1.123 + files can be specified in the settings: <tt>cksum</tt> (CRC32), 1.124 <tt>md5sum</tt> (MD5), <tt>sha1sum</tt> (SHA1), <tt>sha256sum</tt> 1.125 (SHA256), <tt>sha512sum</tt> (SHA512), <tt>sha3sum</tt> (SHA3-512))</li> 1.126 <li><tt>description.txt</tt> (optional) — “long” description</li> 1.127 @@ -220,7 +220,7 @@ 1.128 unblocking, reconfiguring packages.</x-details></p> 1.129 1.130 <p>Shared MIME information which allows to “guess” SliTaz package files, package 1.131 -receipts, and SliTaz flavor files. <x-details>File placed here: <tt><a 1.132 +receipts and SliTaz flavor files. <x-details>File placed here: <tt><a 1.133 href="file:///usr/share/mime/packages/tazpkg.xml" 1.134 target="_blank">/usr/share/mime/packages/tazpkg.xml</a></tt>.</x-details></p> 1.135 1.136 @@ -228,7 +228,7 @@ 1.137 <tt>/var/www/tazpanel/pkgs.cgi</tt> allows you to manage SliTaz packages in the 1.138 <a href="http://127.0.0.1:82/pkgs.cgi" target="_blank">web application</a>.</p> 1.139 1.140 -<p>TazPkg documentation you read placed in the <tt>/usr/share/doc/tazpkg</tt> 1.141 +<p>TazPkg documentation is placed in the <tt>/usr/share/doc/tazpkg</tt> 1.142 folder.</p> 1.143 1.144 1.145 @@ -550,9 +550,9 @@ 1.146 <tt>.tazpkg</tt> extension (<tt>install</tt> or <tt>-i</tt>). See 1.147 <tt><a href="#get-install">get-install</a></tt> to install a package from the 1.148 internet. Note that you can force the installation via the <tt>--forced</tt> 1.149 -option. Option <tt>--newconf</tt> allow to rewrite all user configuration files 1.150 -using the new files from package. Option <tt>--nodeps</tt> allow to install only 1.151 -specified package without its dependencies.</p> 1.152 +option. Option <tt>--newconf</tt> allows you to rewrite all user configuration files 1.153 +using the new files from package. Option <tt>--nodeps</tt> allows you to install only 1.154 +a specified package without its dependencies.</p> 1.155 1.156 <pre> 1.157 # tazpkg install <em>package-1.0.tazpkg</em> 1.158 @@ -568,11 +568,11 @@ 1.159 mirror and if it has been already downloaded. For a list of packages on the 1.160 mirror, we must use the <tt><a href="#list-mirror">list-mirror</a></tt> 1.161 command. Note that you can force the installation via the <tt>--forced</tt> 1.162 -option. Option <tt>--newconf</tt> allow to rewrite all user configuration files 1.163 -using the new files from package. Option <tt>--nodeps</tt> allow to install only 1.164 -specified package without its dependencies.</p> 1.165 - 1.166 -<p>Option <tt>--forced</tt> allow update already installed package.</p> 1.167 +option. Option <tt>--newconf</tt> allows you to rewrite all user configuration files 1.168 +using the new files from a package. Option <tt>--nodeps</tt> allows you to install only 1.169 +a specified package without its dependencies.</p> 1.170 + 1.171 +<p>Option <tt>--forced</tt> allows you to update an already installed package.</p> 1.172 1.173 <pre> 1.174 # tazpkg get-install <em>grub</em> 1.175 @@ -600,7 +600,7 @@ 1.176 depending on this package, and for reinstalling packages modified by this 1.177 package. This command will delete all files installed with the package.</p> 1.178 1.179 -<p>Option <tt>--auto</tt> removes and reinstall packages without your 1.180 +<p>Option <tt>--auto</tt> removes and reinstalls packages without your 1.181 confirmation.</p> 1.182 1.183 <pre> 1.184 @@ -624,7 +624,7 @@ 1.185 1.186 <p>This command allows the installation of a package from another media device. 1.187 The set up is done through symbolic links and consumes very little memory. It is 1.188 -generally used within the system RAM to install add-ons from an USB key.</p> 1.189 +generally used within the system RAM to install add-ons from a USB key.</p> 1.190 1.191 <pre> 1.192 # tazpkg link <em>openoffice /media/usbdisk</em> 1.193 @@ -661,7 +661,7 @@ 1.194 1.195 <p>Show all the available information related to your package. You can specify 1.196 the name of the installed package or a package that is not yet installed, but 1.197 -available in the repository. You can also get information about local file 1.198 +available in the repository. You can also get information about a local file 1.199 package by entering an absolute or relative path to the file <tt>.tazpkg</tt>. 1.200 The information contained in the TazPkg database and in the package recipe — 1.201 its version, category, maintainer, Web site and all the dependencies (see also 1.202 @@ -702,7 +702,7 @@ 1.203 <p>The <tt>block</tt> (or <tt>-b</tt>) and <tt>unblock</tt> (or <tt>-u</tt>) 1.204 commands permit you to block installed package versions so that they are not 1.205 maintained by an <tt><a href="#upgrade">upgrade</a></tt>. Command 1.206 -<tt>chblock</tt> changes blocking state of the package. The list of packages on 1.207 +<tt>chblock</tt> changes the blocking state of the package. The list of packages on 1.208 hold are contained in the <tt>/var/lib/tazpkg/blocked-packages.list</tt>. This 1.209 file can also be edited by hand.</p> 1.210 1.211 @@ -743,13 +743,13 @@ 1.212 <p>Displays a dependency tree or reverse dependency tree for a package.</p> 1.213 1.214 <p>For <code>depends</code> command: option <tt>--mark</tt> marks installed 1.215 -packages with plus sign, and not installed with minus/dash. Option 1.216 -<tt>--total</tt> calculates number of displayed packages and its size. Also, 1.217 -with both options at a time you'll get number and size of packages to be 1.218 +packages with plus sign and not installed with a minus/dash. Option 1.219 +<tt>--total</tt> calculates the number of displayed packages and their size. Also, 1.220 +with both options at a time you'll get the number and size of packages to be 1.221 installed.</p> 1.222 1.223 -<p>For <code>rdepends</code> command: without <tt>--all</tt> option you'll get 1.224 -the list of only installed reverse dependency packages, with this option — list 1.225 +<p>For <code>rdepends</code> command: without the <tt>--all</tt> option you'll get 1.226 +the list of only installed reverse dependency packages, with this option — a list 1.227 of all available packages. Option <tt>--mark</tt> marks packages as in the 1.228 <code>depends</code> command.</p> 1.229 1.230 @@ -816,7 +816,7 @@ 1.231 <h3 id="convert">convert</h3> 1.232 1.233 <p>Converts an "alien" package into a SliTaz package (.tazpkg) (<tt>convert</tt> 1.234 -or <tt>-c</tt>.</p> 1.235 +or <tt>-c</tt>).</p> 1.236 1.237 <p>Supported packages formats:</p> 1.238 1.239 @@ -859,7 +859,7 @@ 1.240 1.241 <p>List suggested packages for each of your installed packages. With option 1.242 <tt>--all</tt> it shows all suggested packages, and without option it shows only 1.243 -not installed suggested packages.</p> 1.244 +non installed suggested packages.</p> 1.245 1.246 <pre> 1.247 $ tazpkg list-suggested 1.248 @@ -883,8 +883,8 @@ 1.249 packages, you can simply <tt><a href="#upgrade">upgrade</a></tt>.</p> 1.250 1.251 <p>Command without options will recharge databases of all your repositories. You 1.252 -can specify repository to be recharged: "main" for main repo, or undigest 1.253 -repository name. Option <tt>--root=</tt> allow you to specify root of filesystem 1.254 +can specify the repository to be recharged: "main" for main repo, or undigest 1.255 +repository name. Option <tt>--root=</tt> allows you to specify the root of the filesystem 1.256 where you want to recharge DB.</p> 1.257 1.258 <pre> 1.259 @@ -909,7 +909,7 @@ 1.260 href="#recharge">recharge</a></tt>) in order to provide you with the current 1.261 list of packages that you can update.</p> 1.262 1.263 -<p>Without options run in interactive mode and ask before install. You can 1.264 +<p>Without options it runs in interactive mode and asks before install. You can 1.265 specify one of the next options: <tt>-c</tt> or <tt>--check</tt> to check only 1.266 for available upgrades; <tt>-i</tt> or <tt>--install</tt> to check for upgrades 1.267 and install them all.</p>