tazusb annotate doc/tazusb.en.html @ rev 203

Typos in tazusb.fr.html
author Pascal Bellard <pascal.bellard@slitaz.org>
date Sun Aug 02 12:47:21 2020 +0000 (2020-08-02)
parents d08681b315ea
children
rev   line source
pankso@81 1 <!DOCTYPE html>
pankso@81 2 <html xmlns="http://www.w3.org/1999/xhtml">
pankso@2 3 <head>
pankso@81 4 <title>TazUSB Manual (en)</title>
pankso@81 5 <meta charset="utf-8" />
pascal@203 6 <link rel="stylesheet" type="text/css" href="../slitaz-doc.css" />
pascal@203 7 <script type="text/javascript" src="../slitaz-doc.js"></script>
pankso@2 8 </head>
pankso@81 9 <body>
pankso@81 10
pankso@81 11 <!-- Header -->
pankso@2 12 <div id="header">
pankso@81 13 <h1>TazUSB Manual</h1>
pankso@2 14 </div>
pankso@81 15
pankso@2 16 <!-- Start content -->
pankso@2 17 <div id="content">
pankso@2 18
paul@51 19 <h2>NAME</h2>
pankso@2 20 <p>
paul@51 21 TazUSB - SliTaz LiveUSB utility
pankso@2 22 </p>
pankso@81 23
spode@4 24 <h2>SYNTAX</h2>
pankso@2 25 <pre>
paul@51 26 tazusb [command] [compression|device|file]
pankso@2 27 </pre>
pankso@81 28
pankso@2 29 <h2>DESCRIPTION</h2>
pankso@2 30 <p>
pankso@81 31 TazUSB is a utility designed for installing SliTaz to a USB drive. Unlike a
pankso@81 32 hard drive install, the filesystem is kept in a compressed "rootfs.gz" file.
pankso@81 33 The filesystem is loaded entirely into memory upon boot. This should
pankso@81 34 increase responsiveness, protect the filesystem against accidental
pankso@81 35 corruption and reduce read/writes to the USB drive. Once setup, this utility
pankso@81 36 can also rewrite the root filesystem with any changes you have made since
pankso@81 37 booting up, giving the effective benefits of a hard drive install.
spode@4 38 </p>
spode@4 39 <p>
pankso@81 40 TazUSB supports FAT32/EXT3/EXT2 formatted drives using SYSLINUX and EXTLINUX
pankso@81 41 respectively. "/home" is mounted on boot using the UUID of your particular
pankso@81 42 flash drive. Unlike a device name, the UUID has the benefit of never
pankso@81 43 changing from machine to machine.
pankso@2 44 </p>
pankso@81 45
spode@4 46 <h2>COMMANDS</h2>
pascal@42 47 <a name="usage"></a>
pankso@81 48 <h3>usage</h3>
pankso@2 49 <p>
pankso@81 50 The command 'usage' will display a short summary of all available commands.
pankso@2 51 </p>
pankso@2 52 <pre>
pankso@2 53 # tazusb usage
pankso@2 54 </pre>
pankso@81 55
pascal@42 56 <a name="writefs"></a>
pankso@81 57 <h3>writefs</h3>
pankso@2 58 <p>
pankso@81 59 The command 'writefs' will take the current memory resident filesystem and
pankso@81 60 create a "rootfs.gz" file. If your flash drive is mounted as /home (as it
pankso@81 61 should be), the new filesystem will be copied to the drive for you,
pankso@81 62 otherwise it is left on the root of the drive. Your previous filesystem
pankso@81 63 will be renamed to "previous.gz" and can be accessed on bootup by typing
pankso@81 64 "previous" at the "boot:" prompt. All previous filesystems are renamed to
pankso@81 65 rootfs.gz.unixtimestamp. These are not removed automatically, so you should
pankso@81 66 periodically delete these to keep disk usage down.
spode@4 67 </p>
spode@4 68 <p>
pankso@81 69 Filesystem compression is supported in the form of lzma, gzip or none.
pankso@81 70 Using no compression is very quick (under 5 seconds) and useful if you are
pankso@81 71 experimenting with a lot of changes. By comparison, using lzma or gzip takes
pankso@81 72 a few minutes but will dramatically reduce file size. This is recommended
pankso@81 73 when committing permanent changes to the filesystem.
pankso@2 74 </p>
pankso@2 75 <pre>
pankso@81 76 # tazusb writefs compression
spode@4 77 </pre>
pankso@81 78 <p>Example:</p>
spode@4 79 <pre>
pankso@81 80 # tazusb writefs lzma
pankso@2 81 </pre>
pankso@81 82
pascal@42 83 <a name="format"></a>
pankso@81 84 <h3>format</h3>
spode@4 85 <p>
pankso@81 86 The command 'format' is used for formatting a device for use as a LiveUSB
pankso@81 87 device. Currently, it supports formatting as EXT2, EXT3 and FAT32.
spode@4 88 </p>
spode@4 89 <pre>
pankso@81 90 # tazusb format /dev/name
spode@4 91 </pre>
pankso@81 92 <p>Example:</p>
spode@4 93 <pre>
pankso@81 94 # tazusb format /dev/sda1
spode@4 95 </pre>
pankso@81 96
pascal@42 97 <a name="gen-liveusb"></a>
pankso@81 98 <h3>gen-liveusb</h3>
pankso@2 99 <p>
pankso@81 100 "gen-liveusb" will install a fresh MBR, set your partition as bootable and
pankso@81 101 install syslinux/extlinux depending on the detected filesystem. It will then
pankso@81 102 copy the kernel and filesystem from the CDROM drive, and place this on the
pankso@81 103 target USB drive. This will leave you with a bootable USB copy of SliTaz.
pankso@2 104 </p>
spode@4 105 <pre>
pankso@81 106 # tazusb gen-liveusb /dev/name
spode@4 107 </pre>
pankso@81 108 <p>Example:</p>
spode@4 109 <pre>
pankso@81 110 # tazusb gen-liveusb /dev/sda1
spode@4 111 </pre>
pankso@81 112
paul@51 113 <a name="gen-swap"></a>
pankso@81 114 <h3>gen-swap</h3>
paul@51 115 <p>
pankso@81 116 The 'gen-swap' command re/creates a virtual swap file and places
pankso@81 117 it in the /home directory to be activated on each boot. This is useful
pankso@81 118 for old systems with low memory.
paul@51 119 </p>
pankso@81 120 <pre>
pankso@81 121 # tazusb gen-swap
paul@51 122 </pre>
pankso@81 123
paul@51 124 <a name="gen-iso2usb"></a>
pankso@81 125 <h3>gen-iso2usb</h3>
paul@51 126 <p>
pankso@81 127 This command performs the same task as gen-liveusb, only copying the Kernel
pankso@81 128 and filesystem from a downloaded ISO image instead of the CDROM drive.
paul@51 129 </p>
pankso@81 130 <pre>
pankso@81 131 # tazusb gen-iso2usb /path/to/iso
paul@51 132 </pre>
pankso@81 133 <p>Example:</p>
pankso@81 134 <pre>
pankso@81 135 # tazusb gen-iso2usb /home/tux/slitaz.iso
paul@51 136 </pre>
pankso@81 137
paul@51 138 <a name="clean"></a>
pankso@81 139 <h3>clean</h3>
paul@51 140 <p>
pankso@81 141 "clean" removes old rootfs.gz.unixtimestamp filesystems (see writefs)
pankso@81 142 to keep disk usage down.
paul@51 143 </p>
pankso@81 144 <pre>
pankso@81 145 # tazusb clean
paul@51 146 </pre>
pankso@81 147
paul@51 148 <h2>MAINTAINER</h2>
paul@51 149 <p>
pankso@81 150 Eric Joseph-Alexandre &lt;erjo at slitaz.org&gt;
paul@51 151 </p>
paul@51 152
pankso@2 153 <!-- End content -->
pankso@2 154 </div>
pankso@81 155
pankso@2 156 </body>
pankso@2 157 </html>