Add documentation for recursive mode

This commit is contained in:
Con Kolivas 2016-06-10 16:17:11 +10:00
parent 7a03965214
commit 3e178b4ede
2 changed files with 14 additions and 5 deletions

View file

@ -1,6 +1,6 @@
# Copyright # Copyright
# #
# Copyright (C) 2015 Con Kolivas # Copyright (C) 2016 Con Kolivas
# #
# License # License
# #
@ -48,8 +48,8 @@ lrz - gzip compatible command line variant of lrzip
=head1 DESCRIPTION =head1 DESCRIPTION
lrz is identical to the lrzip application however its command line options are lrz is identical to the lrzip application however its command line options and
made to be as compatible with gzip as possible. behaviour are made to be as compatible with gzip as possible.
=head1 OPTIONS =head1 OPTIONS
@ -65,8 +65,9 @@ General options:
-i, --info show compressed file information -i, --info show compressed file information
-L, --license display software version and license -L, --license display software version and license
-P, --progress show compression progress -P, --progress show compression progress
-r, --recursive operate recursively on directories
-t, --test test compressed file integrity -t, --test test compressed file integrity
-v[v], --verbose Increase verbosity -v[vv], --verbose Increase verbosity
-V, --version show version -V, --version show version
Options affecting output: Options affecting output:
-f, --force force overwrite of any existing files -f, --force force overwrite of any existing files

View file

@ -1,4 +1,4 @@
.TH "lrzip" "1" "April 2015" "" "" .TH "lrzip" "1" "June 2016" "" ""
.SH "NAME" .SH "NAME"
lrzip \- a large-file compression program lrzip \- a large-file compression program
.SH "SYNOPSIS" .SH "SYNOPSIS"
@ -43,6 +43,7 @@ General options:
\-H, \-\-hash display md5 hash integrity information \-H, \-\-hash display md5 hash integrity information
\-i, \-\-info show compressed file information \-i, \-\-info show compressed file information
\-q, \-\-quiet don't show compression progress \-q, \-\-quiet don't show compression progress
\-r, \-\-recursive operate recursively on directories
\-t, \-\-test test compressed file integrity \-t, \-\-test test compressed file integrity
\-v[v], \-\-verbose Increase verbosity \-v[v], \-\-verbose Increase verbosity
\-V, \-\-version show version \-V, \-\-version show version
@ -140,6 +141,13 @@ bursts with lzma compression which is the default compression. This means
that it will progress very rapidly for short periods and then stop for that it will progress very rapidly for short periods and then stop for
long periods. long periods.
.IP .IP
.IP "\fB-r\fP"
If this option is specified, lrzip will recursively enter the directories
specified, compressing or decompressing every file individually in the same
directory. Note for better compression it is recommended to instead combine
files in a tar file rather than compress them separately, either manually
or with the lrztar helper.
.IP
.IP "\fB-t\fP" .IP "\fB-t\fP"
This tests the compressed file integrity. It does this by decompressing it This tests the compressed file integrity. It does this by decompressing it
to a temporary file and then deleting it. to a temporary file and then deleting it.