Commit cf69728b authored by Tim Peters's avatar Tim Peters

Module docstring: put all the options in the summary line; repair

grammar and spelling.
parent 4f92bb74
...@@ -13,44 +13,43 @@ ...@@ -13,44 +13,43 @@
############################################################################## ##############################################################################
"""Simple script for repairing damaged FileStorage files. """Simple script for repairing damaged FileStorage files.
Usage: %s [-f] input output Usage: %s [-f] [-v level] [-p] [-P seconds] input output
Recover data from a FileStorage data file, skipping over damaged Recover data from a FileStorage data file, skipping over damaged data. Any
data. Any damaged data will be lost. This could lead to useless output damaged data will be lost. This could lead to useless output if critical
of critical data were lost. data is lost.
Options: Options:
-f -f
Force output to output file even if it exists Overwrite output file even if it exists.
-v level -v level
Set the verbosity level: Set the verbosity level:
0 -- Show progress indicator (default) 0 -- show progress indicator (default)
1 -- Show transaction times and sizes 1 -- show transaction times and sizes
2 -- Show transaction times and sizes, and 2 -- show transaction times and sizes, and show object (record)
show object (record) ids, versions, and sizes. ids, versions, and sizes
-p -p
Copy partial transactions. If a data record in the middle of a Copy partial transactions. If a data record in the middle of a
transaction is bad, the data up to the bad data are packed. The transaction is bad, the data up to the bad data are packed. The
output record is marked as packed. If this option is not used, output record is marked as packed. If this option is not used,
transaction with any bad data are skipped. transactions with any bad data are skipped.
-P t -P t
Pack data to t seconds in the past. Note that is the "-p" Pack data to t seconds in the past. Note that if the "-p" option is
option is used, then t should be 0. used, then t should be 0.
Important note: The ZODB package must be imporatble. You may need Important: The ZODB package must be importable. You may need to adjust
to adjust PYTHONPATH accordingly. PYTHONPATH accordingly.
""" """
# Algorithm: # Algorithm:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment