Fix some inconsistent help text formatting.

This commit is contained in:
voussoir 2020-10-12 21:59:02 -07:00
parent 2cd8a118fe
commit 55bd1d07a8

View file

@ -344,45 +344,50 @@ def rarpar_argparse(args):
) )
DOCSTRING = ''' DOCSTRING = '''
rarpar
======
> rarpar path <flags>
path: path:
The input file or directory to rarpar. The input file or directory to rarpar.
--volume X | X% | min(A, B) | max(A, B) --volume X | X% | min(A, B) | max(A, B):
Split rars into volumes of this many megabytes. Should be Split rars into volumes of this many megabytes. Should be
An integer number of megabytes, or; An integer number of megabytes, or;
A percentage "X%" to calculate volumes as X% of the file size, down to A percentage "X%" to calculate volumes as X% of the file size, down to
a 1 MB minimum, or; a 1 MB minimum, or;
A string "min(A, B)" or "max(A, B)" where A and B follow the above rules. A string "min(A, B)" or "max(A, B)" where A and B follow the above rules.
--rec X --rec X:
A integer to generate X% recovery record in the rars. A integer to generate X% recovery record in the rars.
See winrar documentation for information about recovery records. See winrar documentation for information about recovery records.
--rev X --rev X:
A integer to generate X% recovery volumes. A integer to generate X% recovery volumes.
Note that winrar's behavior is the number of revs will always be less than Note that winrar's behavior is the number of revs will always be less than
the number of rars. If you don't split volumes, you will have 1 rar and the number of rars. If you don't split volumes, you will have 1 rar and
thus 0 revs even if you ask for 100% rev. thus 0 revs even if you ask for 100% rev.
See winrar documentation for information about recovery volumes. See winrar documentation for information about recovery volumes.
--par X --par X:
A number to generate X% recovery with par2. A number to generate X% recovery with par2.
--basename --basename X:
A basename for the rar and par files. You will end up with A basename for the rar and par files. You will end up with
basename.partXX.rar and basename.par2. basename.partXX.rar and basename.par2.
Without this argument, the default basename is "basename ({timestamp})". Without this argument, the default basename is "basename ({timestamp})".
Your string may include {timestamp} including the braces to get the Your string may include {timestamp} including the braces to get the
timestamp there. timestamp there.
--password --password X:
A password with which to encrypt the rar files. A password with which to encrypt the rar files.
--workdir: --workdir X:
The directory in which the rars and pars will be generated while the The directory in which the rars and pars will be generated while the
program is working. program is working.
--moveto: --moveto X:
The directory to which the rars and pars will be moved after the program The directory to which the rars and pars will be moved after the program
has finished working. has finished working.