rddi Namespace Reference


Data Structures

class  Cmd

Functions

def ask
def ask_file
def ask_hash
def ask_num
def ask_opt_file
def ask_recover
def ask_size
def ask_slice
def ask_yn
def format
def fprint
def toplevel

Variables

string blksize_help
string blksize_text = """Block size?"""
string count_help
string count_text = """How many bytes to read?"""
string DEFAULT_BLKSIZE = "512k"
string DEFAULT_INTERVAL = "5"
string DEFAULT_LOG = "rdd-%u.log"
int DEFAULT_MAXERR = 0
string DEFAULT_MINBLKSIZE = "512"
 DEFAULT_OUT = None
string DEFAULT_PORT = "4832"
int DEFAULT_RECOVERYLEN = 3
string destfile_help
string destfile_text = """Output file:"""
string desthost_help
string desthost_text = """Destination host:"""
string hash_help
string hash_text = """Hash the data?"""
string inetd_help
string inetd_text = """Use (x)inetd to start the rdd server process?"""
string intro_text
string logfile_help
string logfile_text = """Log file:"""
string maxerr_help
string maxerr_text = """Quit after how many read errors?"""
string md5_help
string md5_text = """Use MD5?"""
string minblksize_help
string minblksize_text = """Minimum block size?"""
string mode_help
string mode_text
string offset_help
string offset_text = """Input file offset (in bytes)?"""
string overwrite_help
string overwrite_text = """Overwrite existing files?"""
string port_help
string port_text = """At which TCP port does the rdd server listen?"""
string progress_help
string progress_text
dictionary Q
string recover_help
string recover_text = """Do you want to modify any recovery options?"""
string run_help
string run_text = """Run now?"""
string section_help
string section_text
string sha1_help
string sha1_text = """Use SHA1?"""
string size_help
string slice_help
string slice_text = """Process entire input file?"""
string source_help
string source_text = """Input file:"""
string verb_help
string verb_text = """Do you want rdd to be verbose?"""


Function Documentation

def rddi::ask (   elt,
  answers,
  default = None 
)

Definition at line 354 of file rddi.py.

def rddi::ask_file (   elt,
  default = None 
)

Definition at line 394 of file rddi.py.

def rddi::ask_hash (   cmd  ) 

Definition at line 421 of file rddi.py.

def rddi::ask_num (   elt,
  default = None 
)

Definition at line 391 of file rddi.py.

def rddi::ask_opt_file (   elt,
  default = None 
)

Definition at line 397 of file rddi.py.

def rddi::ask_recover (   cmd  ) 

Definition at line 440 of file rddi.py.

def rddi::ask_size (   elt,
  default = None 
)

Definition at line 437 of file rddi.py.

def rddi::ask_slice (   cmd  ) 

Definition at line 445 of file rddi.py.

def rddi::ask_yn (   elt,
  default = None 
)

Definition at line 383 of file rddi.py.

def rddi::format (   str,
  indent 
)

Definition at line 406 of file rddi.py.

def rddi::fprint (   txt,
  indent = 0 
)

Definition at line 418 of file rddi.py.

def rddi::toplevel (  ) 

Definition at line 453 of file rddi.py.


Variable Documentation

Initial value:

"""
The block size specifies how much data rdd will read and write
at a time.  The block size should be (significantly) less than
the size of your machine's physical memory.  I cannot give
exact guidelines, but very small block sizes will slow down the copying and
very large block sizes waste memory without improving performance.
"""

Definition at line 286 of file rddi.py.

string rddi::blksize_text = """Block size?"""

Definition at line 285 of file rddi.py.

Initial value:

"""
Specify how many input bytes should be read.
"""

Definition at line 322 of file rddi.py.

string rddi::count_text = """How many bytes to read?"""

Definition at line 321 of file rddi.py.

string rddi::DEFAULT_BLKSIZE = "512k"

Definition at line 37 of file rddi.py.

string rddi::DEFAULT_INTERVAL = "5"

Definition at line 34 of file rddi.py.

string rddi::DEFAULT_LOG = "rdd-%u.log"

Definition at line 36 of file rddi.py.

Definition at line 39 of file rddi.py.

string rddi::DEFAULT_MINBLKSIZE = "512"

Definition at line 38 of file rddi.py.

Definition at line 35 of file rddi.py.

string rddi::DEFAULT_PORT = "4832"

Definition at line 33 of file rddi.py.

Definition at line 40 of file rddi.py.

Initial value:

"""
This is the name of the output file.  All directories leading up to
the output file should already exist; rdd will not create missing
directories.

If you do not want to create an output file, just hit ENTER.

If you use output splitting, rdd will prefix the name of each output
file with a sequence number.  Do not specify such prefixes manually.
For example, /tmp/disk.img will automatically be converted to
/tmp/000-disk.img, /tmp/001-disk.img, and so on.
"""

Definition at line 181 of file rddi.py.

string rddi::destfile_text = """Output file:"""

Definition at line 180 of file rddi.py.

Initial value:

"""
You can specify the destination host's DNS host name (e.g.,
yota.holmes.nl) or its IPv4 address in dotted quad notation (e.g.,
10.5.0.23).  The DNS host name will work only if your client
host knows how to resolve DNS host names to IPv4 addresses.
"""

Definition at line 163 of file rddi.py.

string rddi::desthost_text = """Destination host:"""

Definition at line 162 of file rddi.py.

Initial value:

"""
A (cryptographic) hash is a fixed-length, digital finger print
of a sequence of bytes that is computed by a well-defined
hash algorithm.
It is very difficult to find two inputs that
have the same hash value (in a reasonable amount of time).

Computing a cryptographic hash over the data allows you to
verify the data's integrity at another time by recomputing
the hash value.

The hash is computed only over the data that is read.  Rdd does not
guarantee that the data that it reads will be written to disk (or to the
network correctly).  To make sure that you have stored the data correctly,
we recommend that you recompute the hash value over the stored data
and compare it to the hash value computed by rdd.  They should be
equal.

You can use the following hash algorithms: MD5 and SHA1.
"""

Definition at line 195 of file rddi.py.

string rddi::hash_text = """Hash the data?"""

Definition at line 194 of file rddi.py.

Initial value:

"""
If you say yes here, you will have to configure (x)inetd
to start rdd.  Make sure that (x)inetd passes the options
'-S' (server mode) and '-i' (inetd) to rdd.
"""

Definition at line 241 of file rddi.py.

string rddi::inetd_text = """Use (x)inetd to start the rdd server process?"""

Definition at line 240 of file rddi.py.

Initial value:

"""
This is the rdd command-line wizard.  It will help you
construct a sensible rdd command line.  The wizard will ask
a series of questions and will eventually print a command line
that is based on your answers.  Optionally, the wizard will also
run this command.

Type '?' to obtain help information about a question.

Rdd comes with a man page.  Type 'man rdd' in another window to read it.
"""

Definition at line 115 of file rddi.py.

Initial value:

"""
This is the name of file in which rdd's messages will be logged.
These messages will always be visible on your screen.
If you do not wish to log rdd messages to a file, just hit ENTER.
"""

Definition at line 217 of file rddi.py.

string rddi::logfile_text = """Log file:"""

Definition at line 216 of file rddi.py.

Initial value:

"""
By default, rdd will not exit after read errors.  With this option,
you can force rdd to exit after a specified number of read errors.
If you specify 0, rdd allows infinitely many read errors.
"""

Definition at line 304 of file rddi.py.

string rddi::maxerr_text = """Quit after how many read errors?"""

Definition at line 303 of file rddi.py.

Initial value:

"""
MD5 is a cryptographic hash algorithm.  It generates a 128-bit
hash value from an arbitrary input stream.  For a full description, see
RFC 1321.  MD5 is widely used, but has known weaknesses.  SHA1 is
considered stronger, but is not used as widely.  Many hash-value databases
consist only of MD5 hash values.
"""

Definition at line 224 of file rddi.py.

string rddi::md5_text = """Use MD5?"""

Definition at line 223 of file rddi.py.

Initial value:

"""
When read errors occur, rdd will progressively reduce its block size.
This way, the amount of data lost to read errors is reduced.
You must specify the minimum block size.  Rdd will not use blocks
that are smaller than this size.  If a read error occurs, at least
this many bytes of data will be lost. 
"""

Definition at line 295 of file rddi.py.

string rddi::minblksize_text = """Minimum block size?"""

Definition at line 294 of file rddi.py.

Initial value:

"""
In local mode, you can copy data within a single file system.
(If you have NFS mount points, your file system may span
multiple hosts.)

In client mode, you can copy a file across the network to a server host.
On the server host, you must start a server process that will receive
and process the data that you send to it.

In server mode, you can receive a file from an rdd client on
another host.
"""

Definition at line 137 of file rddi.py.

Initial value:

"""
In which mode do you want to run rdd [local|client|server]?
"""

Definition at line 134 of file rddi.py.

Initial value:

"""
Specify at which input file offset rdd should start reading data.
"""

Definition at line 317 of file rddi.py.

string rddi::offset_text = """Input file offset (in bytes)?"""

Definition at line 316 of file rddi.py.

Initial value:

"""
If you say no here, rdd will refuse to overwrite existing files.
This is the default behavior, because it prevents silly accidents.
If you say yes, rdd will overwrite existing files without asking
for your confirmation.
"""

Definition at line 248 of file rddi.py.

string rddi::overwrite_text = """Overwrite existing files?"""

Definition at line 247 of file rddi.py.

Initial value:

"""
By default, rdd clients and servers assume that rdd requests
must be sent to TCP port 3482 on the server host.  If you
want to use another port, then you should specify another
number, both at the client and the server side.  Remember
that ports 0-1023 are reserved for privileged uses.  Port
numbers higher than 65535 are invalid.
"""

Definition at line 171 of file rddi.py.

string rddi::port_text = """At which TCP port does the rdd server listen?"""

Definition at line 170 of file rddi.py.

Initial value:

"""
If you say 0 here, rdd will not print periodic progress messages.

If you specify some positive number s, rdd will print a progress
line every s seconds (approximately).  The progress line tells you
how much of the data has already been copied and gives the current
copy speed.
"""

Definition at line 258 of file rddi.py.

Initial value:

"""
How often should rdd report progress [seconds; 0 means never]?
"""

Definition at line 255 of file rddi.py.

dictionary rddi::Q

Initial value:

{
    "blksize" : (blksize_text, blksize_help),
    "count" : (count_text, count_help),
    "destfile" : (destfile_text, destfile_help),
    "desthost" : (desthost_text, desthost_help),
    "hash" : (hash_text, hash_help),
    "logfile" : (logfile_text, logfile_help),
    "maxerr" : (maxerr_text, maxerr_help),
    "md5" : (md5_text, md5_help),
    "minblksize" : (minblksize_text, minblksize_help),
    "mode" : (mode_text, mode_help),
    "offset" : (offset_text, offset_help),
    "port" : (port_text, port_help),
    "progress" : (progress_text, progress_help),
    "recover" : (recover_text, recover_help),
    "run" : (run_text, run_help),
    "sha1" : (sha1_text, sha1_help),
    "slice" : (slice_text, slice_help),
    "source" : (source_text, source_help),
    "verb" : (verb_text, verb_help),
}

Definition at line 332 of file rddi.py.

Initial value:

"""
Recovery options include the minimum recovery block size, 
the retry count, and the maximum number of read errors.
"""

Definition at line 327 of file rddi.py.

string rddi::recover_text = """Do you want to modify any recovery options?"""

Definition at line 326 of file rddi.py.

Initial value:

"""
Type 'yes' to run your rdd command now.
Type 'no' to quit.
"""

Definition at line 280 of file rddi.py.

string rddi::run_text = """Run now?"""

Definition at line 279 of file rddi.py.

Initial value:

"""
With rdd, you can choose to copy a subsequence of the input data.
You can select a single, contiguous range of bytes.

If you wish to select a subsequence of your input data for
copying, say yes.  Otherwise, say no.
"""

Definition at line 271 of file rddi.py.

Initial value:

"""
Do you wish to copy all input data or do you wish to select a section
of the input data?
"""

Definition at line 267 of file rddi.py.

Initial value:

"""
SHA-1 is a cryptographic hash algorithm.  It generates a 160-bit
hash value from an arbitrary input stream.  For a full description, see
FIP 180 (a U.S. Federal Information Processing standard).
SHA1 is considered a strong hash algorithm.
"""

Definition at line 233 of file rddi.py.

string rddi::sha1_text = """Use SHA1?"""

Definition at line 232 of file rddi.py.

Initial value:

"""
The %s is given in bytes.  You may use the following
multipliers: b or B (512-byte block or sector); k or K (kilobyte);
m or M (megabyte); g or G (gigabyte).  There should be no space between
a number and its multiplier.
"""

Definition at line 127 of file rddi.py.

Initial value:

"""
Say 'yes' if you want to process all bytes in the input file.
Say 'no' if you want to process a subsequence of the input file.
"""

Definition at line 311 of file rddi.py.

string rddi::slice_text = """Process entire input file?"""

Definition at line 310 of file rddi.py.

Initial value:

"""
This is the name of the file from which data will be read.
"""

Definition at line 158 of file rddi.py.

string rddi::source_text = """Input file:"""

Definition at line 157 of file rddi.py.

Initial value:

"""
In verbose mode, rdd prints more informative messages than it
normally does.  This may be useful for debugging a problem or just
for understanding what's happening.
"""

Definition at line 151 of file rddi.py.

string rddi::verb_text = """Do you want rdd to be verbose?"""

Definition at line 150 of file rddi.py.


Generated on Sun Feb 6 12:36:46 2011 for rdd by  doxygen 1.5.6