mirror of
https://github.com/ckolivas/lrzip.git
synced 2025-12-06 07:12:00 +01:00
Add rudimentary manpage for lrz
This commit is contained in:
Con Kolivas
parent
d9cbf03a45
commit
f7ae8fddf9
|
|
@ -1,12 +1,12 @@
|
|||
MAINTAINERCLEANFILES = Makefile.in lrunzip.1 lrztar.1 lrzuntar.1
|
||||
MAINTAINERCLEANFILES = Makefile.in lrunzip.1 lrztar.1 lrzuntar.1 lrz.1
|
||||
|
||||
man1_MANS = lrzip.1 lrunzip.1 lrzcat.1 lrztar.1 lrzuntar.1
|
||||
man1_MANS = lrzip.1 lrunzip.1 lrzcat.1 lrztar.1 lrzuntar.1 lrz.1
|
||||
man5_MANS = lrzip.conf.5
|
||||
|
||||
BUILT_SOURCES = lrunzip.1 lrzcat.1 lrztar.1 lrzuntar.1
|
||||
BUILT_SOURCES = lrunzip.1 lrzcat.1 lrztar.1 lrzuntar.1 lrz.1
|
||||
CLEANFILES = $(BUILT_SOURCES)
|
||||
|
||||
EXTRA_DIST = lrzip.1 lrunzip.1.pod lrzcat.1.pod lrztar.1.pod lrzuntar.1.pod $(man5_MANS)
|
||||
EXTRA_DIST = lrzip.1 lrunzip.1.pod lrzcat.1.pod lrztar.1.pod lrzuntar.1.pod lrz.1.pod $(man5_MANS)
|
||||
|
||||
SUFFIXES = .1 .1.pod
|
||||
.1.pod.1:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Copyright
|
||||
#
|
||||
# Copyright (C) 2010-2011 Con Kolivas
|
||||
# Copyright (C) 2010-2015 Con Kolivas
|
||||
# Copyright (C) 2009-2009 Jari Aalto
|
||||
#
|
||||
# License
|
||||
|
|
@ -70,6 +70,7 @@ lrzip(1),
|
|||
lrzcat(1),
|
||||
lrztar(1),
|
||||
lrzuntar(1),
|
||||
lrz(1),
|
||||
bzip2(1),
|
||||
gzip(1),
|
||||
lzop(1),
|
||||
|
|
|
|||
128
man/lrz.1.pod
Normal file
128
man/lrz.1.pod
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
# Copyright
|
||||
#
|
||||
# Copyright (C) 2015 Con Kolivas
|
||||
#
|
||||
# License
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation; either version 2 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
#
|
||||
# Description
|
||||
#
|
||||
# To learn what TOP LEVEL section to use in manual pages,
|
||||
# see POSIX/Susv standard and "tility Description Defaults" at
|
||||
# http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap01.html#tag_01_11
|
||||
#
|
||||
# This is manual page in Perl POD format. Read more at
|
||||
# http://perldoc.perl.org/perlpod.html or run command:
|
||||
#
|
||||
# perldoc perlpod | less
|
||||
#
|
||||
# To check the syntax:
|
||||
#
|
||||
# podchecker *.pod
|
||||
#
|
||||
# Create manual page with command:
|
||||
#
|
||||
# pod2man PAGE.N.pod > PAGE.N
|
||||
|
||||
=pod
|
||||
|
||||
=head1 NAME
|
||||
|
||||
lrz - gzip compatible command line variant of lrzip
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
lrz [OPTIONS] <file>
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
lrz is identical to the lrzip application however its command line options are
|
||||
made to be as compatible with gzip as possible.
|
||||
|
||||
=head1 OPTIONS
|
||||
|
||||
lrz differs from lrzip by accepting the following commands:
|
||||
|
||||
General options:
|
||||
-c, --stdout output to STDOUT
|
||||
-C, --check check integrity of file written on decompression
|
||||
-d, --decompress decompress
|
||||
-e, --encrypt password protected sha512/aes128 encryption on compression
|
||||
-h, -?, --help show help
|
||||
-H, --hash display md5 hash integrity information
|
||||
-i, --info show compressed file information
|
||||
-L, --license display software version and license
|
||||
-P, --progress show compression progress
|
||||
-t, --test test compressed file integrity
|
||||
-v[v], --verbose Increase verbosity
|
||||
-V, --version show version
|
||||
Options affecting output:
|
||||
-f, --force force overwrite of any existing files
|
||||
-k, --keep don't delete source files on de/compression
|
||||
-K, --keep-broken keep broken or damaged output files
|
||||
-o, --outfile filename specify the output file name and/or path
|
||||
-O, --outdir directory specify the output directory when -o is not used
|
||||
-S, --suffix suffix specify compressed suffix (default '.lrz')
|
||||
Options affecting compression:
|
||||
-b, --bzip2 bzip2 compression
|
||||
-g, --gzip gzip compression using zlib
|
||||
-l, --lzo lzo compression (ultra fast)
|
||||
-n, --no-compress no backend compression - prepare for other compressor
|
||||
-z, --zpaq zpaq compression (best, extreme compression, extremely slow)
|
||||
Low level options:
|
||||
-1 .. -9 set lzma/bzip2/gzip compression level (1-9, default 7)
|
||||
--fast alias for -1
|
||||
--best alias for -9
|
||||
-L, --level level set lzma/bzip2/gzip compression level (1-9, default 7)
|
||||
-N, --nice-level value Set nice value to value (default 0)
|
||||
-p, --threads value Set processor count to override number of threads
|
||||
-m, --maxram size Set maximim available ram in hundreds of MB
|
||||
overrides detected ammount of available ram
|
||||
-T, --threshold Disable LZO compressibility testing
|
||||
-U, --unlimited Use unlimited window size beyond ramsize (potentially much slower)
|
||||
-w, --window size maximum compression window in hundreds of MB
|
||||
default chosen by heuristic dependent on ram and chosen compression
|
||||
|
||||
See also lrzip(1)
|
||||
|
||||
=head1 ENVIRONMENT
|
||||
|
||||
lrz uses the same environment and configuration files as lrzip(1)
|
||||
|
||||
=head1 FILES
|
||||
|
||||
See lrzip(1)
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
lrzip.conf(5),
|
||||
lrzip(1),
|
||||
lrunzip(1),
|
||||
lrztar(1),
|
||||
lrzuntar(1),
|
||||
bzip2(1),
|
||||
gzip(1),
|
||||
lzop(1),
|
||||
rzip(1),
|
||||
zip(1)
|
||||
|
||||
=head1 AUTHORS
|
||||
|
||||
This manual page was written by Con Kolivas <kernel@kolivas.org> (but
|
||||
may be used by others). Released under license GNU GPL version 2 or (at
|
||||
your option) any later version. For more information about license,
|
||||
visit <http://www.gnu.org/copyleft/gpl.html>.
|
||||
|
||||
=cut
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
# Copyright
|
||||
#
|
||||
# Copyright (C) 2011 Con Kolivas
|
||||
# Copyright (C) 2011-2015 Con Kolivas
|
||||
#
|
||||
# License
|
||||
#
|
||||
|
|
@ -69,6 +69,7 @@ lrzip(1),
|
|||
lrunzip(1),
|
||||
lrztar(1),
|
||||
lrzuntar(1),
|
||||
lrz(1),
|
||||
bzip2(1),
|
||||
gzip(1),
|
||||
lzop(1),
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH "lrzip" "1" "May 2011" "" ""
|
||||
.TH "lrzip" "1" "April 2015" "" ""
|
||||
.SH "NAME"
|
||||
lrzip \- a large-file compression program
|
||||
.SH "SYNOPSIS"
|
||||
|
|
@ -17,6 +17,8 @@ lrztar \-d [lrzip options] <directory>
|
|||
.br
|
||||
lrzuntar [lrzip options] <directory>
|
||||
.br
|
||||
lrz [lrz options] <directory>
|
||||
.br
|
||||
LRZIP=NOCONFIG [lrzip|lrunzip] [OPTIONS] <file>
|
||||
.PP
|
||||
.SH "DESCRIPTION"
|
||||
|
|
@ -331,6 +333,7 @@ lrunzip(1),
|
|||
lrzcat(1),
|
||||
lrztar(1),
|
||||
lrzuntar(1),
|
||||
lrz(1),
|
||||
bzip2(1),
|
||||
gzip(1),
|
||||
lzop(1),
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Copyright
|
||||
#
|
||||
# Copyright (C) 2010-2011 Con Kolivas
|
||||
# Copyright (C) 2010-2015 Con Kolivas
|
||||
# Copyright (C) 2009-2010 Jari Aalto
|
||||
#
|
||||
# License
|
||||
|
|
@ -74,6 +74,7 @@ lrzuntar(1),
|
|||
lrzip(1),
|
||||
lrunzip(1),
|
||||
lrzcat(1),
|
||||
lrz(1),
|
||||
bzip2(1),
|
||||
gzip(1),
|
||||
lzop(1),
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Copyright
|
||||
#
|
||||
# Copyright (C) 2010-2011 Con Kolivas
|
||||
# Copyright (C) 2010-2015 Con Kolivas
|
||||
#
|
||||
# License
|
||||
#
|
||||
|
|
@ -52,6 +52,7 @@ lrztar(1),
|
|||
lrzip(1),
|
||||
lrunzip(1),
|
||||
lrzcat(1),
|
||||
lrz(1),
|
||||
bzip2(1),
|
||||
gzip(1),
|
||||
lzop(1),
|
||||
|
|
|
|||
Loading…
Reference in a new issue