Changeset 376

Show
Ignore:
Timestamp:
04/17/05 22:08:21 (8 years ago)
Author:
ahu
Message:

documentation: process constructive criticism by Reinoud van Leeuwen :-)

Location:
trunk/splitpipe/doc
Files:
1 removed
3 modified

Legend:

Unmodified
Added
Removed

  • trunk/splitpipe/doc/joinpipe.1.txt

    r374 r376  
    1111-------- 
    1212'joinpipe'              [--help, -h] [--no-prompt, -n] [--verbose, -v] 
    13                         [--debug, d] [--version] device1 file2 ... 
     13                        [--debug, -d] [--version] device1 file2 ... 
    1414 
    1515 
    … …  
    2020volumes all belong to the same backup session. Integrity of data 
    2121is verified using a running checksum, currently MD5. 
     22 
     23EXAMPLES 
     24-------- 
     25 
     26To backup /home to one or more DVDs: 
     27 
     28 # tar czf - /home | splitpipe -c dvd  -o 'growisofs -Z /dev/dvd=/dev/stdin' 
     29 
     30To restore: 
     31 
     32 # joinpipe /dev/dvd | tar xzf - 
     33 
    2234 
    2335OPTIONS 
    … …  
    5567SEE ALSO 
    5668-------- 
    57 splitpipe(1) 
     69splitpipe(1), splitpipe(5) 
    5870 
    5971COPYING 

  • trunk/splitpipe/doc/splitpipe.1.txt

    r374 r376  
    66NAME 
    77---- 
    8 splitpipe - spread piped input over a number of volumes 
     8splitpipe - spread piped input over a number of volumes (DVD's, CD's etc) 
    99 
    1010SYNOPSIS 
    … …  
    2121Volumes can be DVD's, CD's, floppies, hard disks or files. 
    2222 
    23 Volumes contain makers to signify which backup session they belong to, and 
     23This allows the operator to make, for example, tar(1) archives larger than a 
     24single DVD. 
     25 
     26Volumes contain markers to signify which backup session they belong to, and 
    2427their order in the set. Furthermore, a running checksum is kept to guarantee 
    2528data integrity. 
    2629 
    2730Volumes created by splitpipe(1) can be read by joinpipe(1) 
     31 
     32EXAMPLES 
     33-------- 
     34 
     35To backup /home to one or more DVDs: 
     36 
     37 # tar czf - /home | splitpipe -c dvd  -o 'growisofs -Z /dev/dvd=/dev/stdin' 
     38 
     39To restore: 
     40 
     41 # joinpipe /dev/dvd | tar xzf - 
    2842 
    2943OPTIONS 
    … …  
    7589SEE ALSO 
    7690-------- 
    77 joinpipe(1) 
     91joinpipe(1), splitpipe(5) 
    7892 
    7993COPYING 

  • trunk/splitpipe/doc/splitpipe.5.txt

    r374 r376  
    7474last volume in a session, in which case it shall end on a Session EOF. 
    7575 
    76 MD5 or SHA1 checksums may be interleaved at any point during the stream, but 
    77 shall at least be included at the end of each volume. 
    78  
    79 BUGS 
    80 ---- 
    81 Does not yet allow retrying failed output, even when the failed data is  
    82 still available in the ringbuffer. 
     76MD5 or SHA1 checksum stretches may be interleaved at any point during the 
     77stream, but shall at least be included at the end of each volume. 
    8378 
    8479AUTHOR 
    … …  
    9287SEE ALSO 
    9388-------- 
    94 joinpipe(1) 
     89joinpipe(1), splitpipe(1) 
    9590 
    9691COPYING