online-docs/live-snapshot.en.1.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
   6 <meta name="generator" content="AsciiDoc 8.2.2" />\r
   7 <style type="text/css">\r
   8 /* Debug borders */\r
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
  10 /*\r
  11   border: 1px solid red;\r
  12 */\r
  13 }\r
  14 \r
  15 body {\r
  16   margin: 1em 5% 1em 5%;\r
  17 }\r
  18 \r
  19 a {\r
  20   color: blue;\r
  21   text-decoration: underline;\r
  22 }\r
  23 a:visited {\r
  24   color: fuchsia;\r
  25 }\r
  26 \r
  27 em {\r
  28   font-style: italic;\r
  29 }\r
  30 \r
  31 strong {\r
  32   font-weight: bold;\r
  33 }\r
  34 \r
  35 tt {\r
  36   color: navy;\r
  37 }\r
  38 \r
  39 h1, h2, h3, h4, h5, h6 {\r
  40   color: #527bbd;\r
  41   font-family: sans-serif;\r
  42   margin-top: 1.2em;\r
  43   margin-bottom: 0.5em;\r
  44   line-height: 1.3;\r
  45 }\r
  46 \r
  47 h1 {\r
  48   border-bottom: 2px solid silver;\r
  49 }\r
  50 h2 {\r
  51   border-bottom: 2px solid silver;\r
  52   padding-top: 0.5em;\r
  53 }\r
  54 \r
  55 div.sectionbody {\r
  56   font-family: serif;\r
  57   margin-left: 0;\r
  58 }\r
  59 \r
  60 hr {\r
  61   border: 1px solid silver;\r
  62 }\r
  63 \r
  64 p {\r
  65   margin-top: 0.5em;\r
  66   margin-bottom: 0.5em;\r
  67 }\r
  68 \r
  69 pre {\r
  70   padding: 0;\r
  71   margin: 0;\r
  72 }\r
  73 \r
  74 span#author {\r
  75   color: #527bbd;\r
  76   font-family: sans-serif;\r
  77   font-weight: bold;\r
  78   font-size: 1.1em;\r
  79 }\r
  80 span#email {\r
  81 }\r
  82 span#revision {\r
  83   font-family: sans-serif;\r
  84 }\r
  85 \r
  86 div#footer {\r
  87   font-family: sans-serif;\r
  88   font-size: small;\r
  89   border-top: 2px solid silver;\r
  90   padding-top: 0.5em;\r
  91   margin-top: 4.0em;\r
  92 }\r
  93 div#footer-text {\r
  94   float: left;\r
  95   padding-bottom: 0.5em;\r
  96 }\r
  97 div#footer-badges {\r
  98   float: right;\r
  99   padding-bottom: 0.5em;\r
 100 }\r
 101 \r
 102 div#preamble,\r
 103 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
 104 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
 105 div.admonitionblock {\r
 106   margin-right: 10%;\r
 107   margin-top: 1.5em;\r
 108   margin-bottom: 1.5em;\r
 109 }\r
 110 div.admonitionblock {\r
 111   margin-top: 2.5em;\r
 112   margin-bottom: 2.5em;\r
 113 }\r
 114 \r
 115 div.content { /* Block element content. */\r
 116   padding: 0;\r
 117 }\r
 118 \r
 119 /* Block element titles. */\r
 120 div.title, caption.title {\r
 121   font-family: sans-serif;\r
 122   font-weight: bold;\r
 123   text-align: left;\r
 124   margin-top: 1.0em;\r
 125   margin-bottom: 0.5em;\r
 126 }\r
 127 div.title + * {\r
 128   margin-top: 0;\r
 129 }\r
 130 \r
 131 td div.title:first-child {\r
 132   margin-top: 0.0em;\r
 133 }\r
 134 div.content div.title:first-child {\r
 135   margin-top: 0.0em;\r
 136 }\r
 137 div.content + div.title {\r
 138   margin-top: 0.0em;\r
 139 }\r
 140 \r
 141 div.sidebarblock > div.content {\r
 142   background: #ffffee;\r
 143   border: 1px solid silver;\r
 144   padding: 0.5em;\r
 145 }\r
 146 \r
 147 div.listingblock {\r
 148   margin-right: 0%;\r
 149 }\r
 150 div.listingblock > div.content {\r
 151   border: 1px solid silver;\r
 152   background: #f4f4f4;\r
 153   padding: 0.5em;\r
 154 }\r
 155 \r
 156 div.quoteblock > div.content {\r
 157   padding-left: 2.0em;\r
 158 }\r
 159 \r
 160 div.attribution {\r
 161   text-align: right;\r
 162 }\r
 163 div.verseblock + div.attribution {\r
 164   text-align: left;\r
 165 }\r
 166 \r
 167 div.admonitionblock .icon {\r
 168   vertical-align: top;\r
 169   font-size: 1.1em;\r
 170   font-weight: bold;\r
 171   text-decoration: underline;\r
 172   color: #527bbd;\r
 173   padding-right: 0.5em;\r
 174 }\r
 175 div.admonitionblock td.content {\r
 176   padding-left: 0.5em;\r
 177   border-left: 2px solid silver;\r
 178 }\r
 179 \r
 180 div.exampleblock > div.content {\r
 181   border-left: 2px solid silver;\r
 182   padding: 0.5em;\r
 183 }\r
 184 \r
 185 div.verseblock div.content {\r
 186   white-space: pre;\r
 187 }\r
 188 \r
 189 div.imageblock div.content { padding-left: 0; }\r
 190 div.imageblock img { border: 1px solid silver; }\r
 191 span.image img { border-style: none; }\r
 192 \r
 193 dl {\r
 194   margin-top: 0.8em;\r
 195   margin-bottom: 0.8em;\r
 196 }\r
 197 dt {\r
 198   margin-top: 0.5em;\r
 199   margin-bottom: 0;\r
 200   font-style: italic;\r
 201 }\r
 202 dd > *:first-child {\r
 203   margin-top: 0;\r
 204 }\r
 205 \r
 206 ul, ol {\r
 207     list-style-position: outside;\r
 208 }\r
 209 ol.olist2 {\r
 210   list-style-type: lower-alpha;\r
 211 }\r
 212 \r
 213 div.tableblock > table {\r
 214   border: 3px solid #527bbd;\r
 215 }\r
 216 thead {\r
 217   font-family: sans-serif;\r
 218   font-weight: bold;\r
 219 }\r
 220 tfoot {\r
 221   font-weight: bold;\r
 222 }\r
 223 \r
 224 div.hlist {\r
 225   margin-top: 0.8em;\r
 226   margin-bottom: 0.8em;\r
 227 }\r
 228 div.hlist td {\r
 229   padding-bottom: 5px;\r
 230 }\r
 231 td.hlist1 {\r
 232   vertical-align: top;\r
 233   font-style: italic;\r
 234   padding-right: 0.8em;\r
 235 }\r
 236 td.hlist2 {\r
 237   vertical-align: top;\r
 238 }\r
 239 \r
 240 @media print {\r
 241   div#footer-badges { display: none; }\r
 242 }\r
 243 \r
 244 div#toctitle {\r
 245   color: #527bbd;\r
 246   font-family: sans-serif;\r
 247   font-size: 1.1em;\r
 248   font-weight: bold;\r
 249   margin-top: 1.0em;\r
 250   margin-bottom: 0.1em;\r
 251 }\r
 252 \r
 253 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {\r
 254   margin-top: 0;\r
 255   margin-bottom: 0;\r
 256 }\r
 257 div.toclevel2 {\r
 258   margin-left: 2em;\r
 259   font-size: 0.9em;\r
 260 }\r
 261 div.toclevel3 {\r
 262   margin-left: 4em;\r
 263   font-size: 0.9em;\r
 264 }\r
 265 div.toclevel4 {\r
 266   margin-left: 6em;\r
 267   font-size: 0.9em;\r
 268 }\r
 269 /* Workarounds for IE6's broken and incomplete CSS2. */\r
 270 \r
 271 div.sidebar-content {\r
 272   background: #ffffee;\r
 273   border: 1px solid silver;\r
 274   padding: 0.5em;\r
 275 }\r
 276 div.sidebar-title, div.image-title {\r
 277   font-family: sans-serif;\r
 278   font-weight: bold;\r
 279   margin-top: 0.0em;\r
 280   margin-bottom: 0.5em;\r
 281 }\r
 282 \r
 283 div.listingblock div.content {\r
 284   border: 1px solid silver;\r
 285   background: #f4f4f4;\r
 286   padding: 0.5em;\r
 287 }\r
 288 \r
 289 div.quoteblock-content {\r
 290   padding-left: 2.0em;\r
 291 }\r
 292 \r
 293 div.exampleblock-content {\r
 294   border-left: 2px solid silver;\r
 295   padding-left: 0.5em;\r
 296 }\r
 297 \r
 298 /* IE6 sets dynamically generated links as visited. */\r
 299 div#toc a:visited { color: blue; }\r
 300 </style>\r
 301 <title>live-snapshot(1)</title>\r
 302 </head>\r
 303 <body>\r
 304 <div id="header">\r
 305 <h1>live-snapshot(1)</h1>\r
 306 </div>\r
 307 <h2>Name</h2>\r
 308 <div class="sectionbody">\r
 309 <p>live-snapshot - a simple script to ease persistence usage</p>\r
 310 </div>\r
 311 <h2>Synopsis</h2>\r
 312 <div class="sectionbody">\r
 313 <p>live-snapshot [-c|&#8212;cow <strong>DIRECTORY</strong>s] [-d|&#8212;device <strong>DEVICE</strong>] [-e|&#8212;exclude-list <strong>FILE</strong>] [-o|&#8212;output <strong>FILE</strong>] [-t|&#8212;type <strong>TYPE</strong>]</p>\r
 314 <p>live-snapshot [-r|&#8212;resync-string <strong>STRING</strong>]</p>\r
 315 <p>live-snapshot [-h|&#8212;help]</p>\r
 316 <p>live-snapshot [-u|&#8212;usage]</p>\r
 317 <p>live-snapshot [-v|&#8212;version]</p>\r
 318 </div>\r
 319 <h2>Description</h2>\r
 320 <div class="sectionbody">\r
 321 <p>live-snapshot is a script which can be used to build the right types of\r
 322 persistent image files supported by live-initramfs(7). It is also used on\r
 323 exit by the live-initramfs init script to resync the boot-found snapshots\r
 324 devices.</p>\r
 325 </div>\r
 326 <h2>Options</h2>\r
 327 <div class="sectionbody">\r
 328 <dl>\r
 329 <dt>\r
 330 -c, &#8212;cow <strong>DIRECTORY</strong>\r
 331 </dt>\r
 332 <dd>\r
 333 <p>\r
 334 specifies the input directory to be cloned in the image file. Its default value\r
 335 "/live/cow" should be right for most uses. However it could be handy to specify\r
 336 "/home" and type ext2 for the type to prepare an image file suited to be\r
 337 directly mounted by live-initramfs as home.\r
 338 </p>\r
 339 </dd>\r
 340 <dt>\r
 341 -d, &#8212;device <strong>DEVICE</strong>\r
 342 </dt>\r
 343 <dd>\r
 344 <p>\r
 345 sets the device where the media which the snapshot/persistence file/partition\r
 346 will be put. If it is not specified, a tmpfs will be used and linked to the\r
 347 user's desktop to move it where it is needed. If the device has no filesystem,\r
 348 an ext2 fs will be automatically created and labelled according to the values\r
 349 specified after the "&#8212;output" value or with a sane default.\r
 350 </p>\r
 351 </dd>\r
 352 <dt>\r
 353 -e, &#8212;exclude-list <strong>FILE</strong>\r
 354 </dt>\r
 355 <dd>\r
 356 <p>\r
 357 a file containing a list of filenames/paths that should not be saved. This exclude list will be remebered on the target snapshot media for reuse.\r
 358 </p>\r
 359 </dd>\r
 360 <dt>\r
 361 -o, &#8212;output <strong>FILE</strong>\r
 362 </dt>\r
 363 <dd>\r
 364 <p>\r
 365 the filename/label used for the output file/partition. If left blank, live-snapshot will search for a proper file on the device or use the whole partition.\r
 366 </p>\r
 367 </dd>\r
 368 <dt>\r
 369 -r, &#8212;resync-string <strong>STRING</strong>\r
 370 </dt>\r
 371 <dd>\r
 372 <p>\r
 373 internally used on resyncs.\r
 374 </p>\r
 375 </dd>\r
 376 <dt>\r
 377 -f, &#8212;refresh\r
 378 </dt>\r
 379 <dd>\r
 380 <p>\r
 381 try to do the same operation that should be done at reboot or halt, resyncing\r
 382 boot-time auto discovered snapshots. Useful to prevent a crash or surge\r
 383 power-off.\r
 384 </p>\r
 385 </dd>\r
 386 <dt>\r
 387 -t, &#8212;type <strong>TYPE</strong>\r
 388 </dt>\r
 389 <dd>\r
 390 <p>\r
 391 Type could be one of "cpio", "squashfs", "ext2", "ext3" or "jffs2".\r
 392 </p>\r
 393 </dd>\r
 394 <dt>\r
 395 -h, &#8212;help\r
 396 </dt>\r
 397 <dd>\r
 398 <p>\r
 399 display help and exit\r
 400 </p>\r
 401 </dd>\r
 402 <dt>\r
 403 -u, &#8212;usage\r
 404 </dt>\r
 405 <dd>\r
 406 <p>\r
 407 show usage and exit\r
 408 </p>\r
 409 </dd>\r
 410 <dt>\r
 411 -v, &#8212;version\r
 412 </dt>\r
 413 <dd>\r
 414 <p>\r
 415 output version information and exit\r
 416 </p>\r
 417 </dd>\r
 418 </dl>\r
 419 </div>\r
 420 <h2>Files</h2>\r
 421 <div class="sectionbody">\r
 422 <div class="literalblock">\r
 423 <div class="content">\r
 424 <pre><tt>/etc/live-snapshot.list</tt></pre>\r
 425 </div></div>\r
 426 <p>This optional file, if present changes the behaviour of live-snapshot, only files and directories listed there are included (integrally) in the snapshot.\r
 427 Beware, it is an experimental feature that only works for cpio targets now.</p>\r
 428 </div>\r
 429 <h2>See also</h2>\r
 430 <div class="sectionbody">\r
 431 <p>live-initramfs(8)</p>\r
 432 <p>This program is a part of live-initramfs.</p>\r
 433 </div>\r
 434 <h2>Bugs</h2>\r
 435 <div class="sectionbody">\r
 436 <p>Report bugs against live-initramfs\r
 437 <a href="http://packages.qa.debian.org/live-initramfs">http://packages.qa.debian.org/live-initramfs</a>.</p>\r
 438 </div>\r
 439 <h2>Homepage</h2>\r
 440 <div class="sectionbody">\r
 441 <p>More information about the Debian Live project can be found at\r
 442 <a href="http://debian-live.alioth.debian.org/">http://debian-live.alioth.debian.org/</a> and\r
 443 <a href="http://wiki.debian.org/DebianLive/">http://wiki.debian.org/DebianLive/</a>.</p>\r
 444 </div>\r
 445 <h2>Authors</h2>\r
 446 <div class="sectionbody">\r
 447 <p>live-initramfs is maintained by Daniel Baumann &lt;daniel@debian.org&gt; for the\r
 448 Debian project. live-initramfs is a fork of\r
 449 <a href="http://packages.ubuntu.com/casper/">casper</a>. casper was originally written\r
 450 by Tollef Fog Heen &lt;tfheen@canonical.com&gt; and Matt Zimmerman &lt;mdz@canonical.com&gt;.</p>\r
 451 </div>\r
 452 <div id="footer">\r
 453 <div id="footer-text">\r
 454 Last updated 01-Nov-2009 04:31:40 CEST\r
 455 </div>\r
 456 </div>\r
 457 </body>\r
 458 </html>\r