update to lrzip.conf.5 manpage and example file.

This commit is contained in:
Peter Hyman 2019-05-12 12:35:13 -05:00
parent 79f505165b
commit b1b5f81d81
2 changed files with 49 additions and 48 deletions

View file

@ -1,55 +1,47 @@
# lrzip.conf example file # lrzip.conf example file
# anything beginning with a # or whitespace will be ignored # anything beginning with a # or whitespace will be ignored
# valid parameters are separated with an = and a value # valid parameters are separated with an = and a value
# parameters and values are not case sensitive # parameters and values are not case sensitive except where specified
# #
# lrzip 0.24+, peter hyman, pete@peterhyman.com # lrzip 0.24+, peter hyman, pete@peterhyman.com
# ignored by earlier versions. # ignored by earlier versions.
# Compression Window size in 100MB. Normally selected by program. # Compression Window size in 100MB. Normally selected by program. (-w)
# WINDOW = 20 # WINDOW = 20
# Compression Level 1-9 (7 Default). (-L)
# Compression Level 1-9 (7 Default).
# COMPRESSIONLEVEL = 7 # COMPRESSIONLEVEL = 7
# Use -U setting, Unlimited ram. Yes or No # Use -U setting, Unlimited ram. Yes or No
# UNLIMITED = NO # UNLIMITED = NO
# Compression Method, rzip, gzip, bzip2, lzo, or lzma (default), or zpaq. (-n -g -b -l --lzma -z)
# Compression Method, rzip, gzip, bzip2, lzo, or lzma (default), or zpaq.
# If specified here, command line options not usable. # If specified here, command line options not usable.
# COMPRESSIONMETHOD = lzma # COMPRESSIONMETHOD = lzma
# Perform LZO Test. Default = YES (-T )
# Perform LZO Test. Default = YES (-T option, NO)
# LZOTEST = NO # LZOTEST = NO
# Hash Check on decompression, (-c)
# Hash Check on decompression, YES
# HASHCHECK = YES # HASHCHECK = YES
# Show HASH value on Compression even if Verbose is off, YES (-H)
# Show HASH value on Compression even if Verbose is off, YES
# SHOWHASH = YES # SHOWHASH = YES
# Default output directory # Default output directory (-O)
# OUTPUTDIRECTORY = location # OUTPUTDIRECTORY = location
# Verbosity, YES or MAX (v, vv)
# Verbosity, Yes or Max
# VERBOSITY = max # VERBOSITY = max
# Show Progress as file is parsed, YES or no (NO = -q option)
# SHOWPROGRESS = YES
# Show Progress as file is parsed, Yes or no # Set Niceness. 19 is default. -20 to 19 is the allowable range (-N)
# SHOWPROGRESS = true
# Set Niceness. 19 is default. -20 to 19 is the allowable range
# NICE = 19 # NICE = 19
# Keep broken or damaged output files, YES # Keep broken or damaged output files, YES (-K)
# KEEPBROKEN = YES # KEEPBROKEN = YES
# Delete source file after compression # Delete source file after compression (-D)
# this parameter and value are case sensitive # this parameter and value are case sensitive
# value must be YES to activate # value must be YES to activate
# DELETEFILES = NO # DELETEFILES = NO
# Replace existing lrzip file when compressing # Replace existing lrzip file when compressing (-f)
# this parameter and value are case sensitive # this parameter and value are case sensitive
# value must be YES to activate # value must be YES to activate
@ -58,6 +50,6 @@
# Override for Temporary Directory. Only valid when stdin/out or Test is used # Override for Temporary Directory. Only valid when stdin/out or Test is used
# TMPDIR = /tmp # TMPDIR = /tmp
# Whether to use encryption on compression YES, NO (-e)
# ENCRYPT = NO # ENCRYPT = NO
# Whether to use encryption on compression

View file

@ -1,4 +1,4 @@
.TH "lrzip.conf" "5" "January 2009" "" "" .TH "lrzip.conf" "5" "January 2009, updated May 2019" "" ""
.SH "NAME" .SH "NAME"
lrzip.conf \- Configuration File for lrzip lrzip.conf \- Configuration File for lrzip
.SH "DESCRIPTION" .SH "DESCRIPTION"
@ -13,54 +13,63 @@ three places\&:
.nf .nf
$PWD \- Current Directory $PWD \- Current Directory
/etc/lrzip /etc/lrzip
$HOME/\&./lrzip $HOME/\&.lrzip
.PP .PP
Parameters are set in \fBPARAMETER\&=VALUE\fP fashion where any line Parameters are set in \fBPARAMETER\&=VALUE\fP fashion where any line
beginning with a \fB#\fP or that is blank will be ignored\&. beginning with a \fB#\fP or that is blank will be ignored\&.
Parameter values are not case sensitive\&. Parameter values are not case sensitive except where specified\&.
.PP .PP
.SH "CONFIG FILE EXAMPLE" .SH "CONFIG FILE EXAMPLE"
.nf .nf
# This is a comment. # This is a comment.
# Compression Window size in 100MB. Normally selected by program. # Compression Window size in 100MB. Normally selected by program. (-w)
# WINDOW = 5 # WINDOW = 20
# Compression Level 1-9 (7 Default). # Compression Level 1-9 (7 Default). (-L)
# COMPRESSIONLEVEL = 7 # COMPRESSIONLEVEL = 7
# Unlimited Ram Compression # Use -U setting, Unlimited ram. Yes or No
# UNLIMITED = YES # UNLIMITED = NO
# Compression Method, rzip, gzip, bzip2, lzo, or lzma (default), zpaq. # Compression Method, rzip, gzip, bzip2, lzo, or lzma (default), or zpaq. (-n -g -b -l --lzma -z)
# COMPRESSIONMETHOD = LZMA # If specified here, command line options not usable.
# Perform LZO Test. Default = YES (\-T option, NO) # COMPRESSIONMETHOD = lzma
# Perform LZO Test. Default = YES (-T )
# LZOTEST = NO # LZOTEST = NO
# Hash Check on decompression, YES # Hash Check on decompression, (-c)
# HASHCHECK = YES # HASHCHECK = YES
# Show HASH value on Compression even if Verbose is off, YES # Show HASH value on Compression even if Verbose is off, YES (-H)
# SHOWHASH = YES # SHOWHASH = YES
# Default output directory # Default output directory (-O)
# OUTPUTDIRECTORY = location # OUTPUTDIRECTORY = location
# Verbosity, Yes or Max # Verbosity, YES or MAX (v, vv)
# VERBOSITY = MAX # VERBOSITY = max
# Show Progress as file is parsed, YES, NO (yes is default) # Show Progress as file is parsed, YES or no (NO = -q option)
# SHOWPROGRESS = NO # SHOWPROGRESS = YES
# Set Niceness. 19 is default. \-20 to 19 is the allowable range
# Set Niceness. 19 is default. -20 to 19 is the allowable range (-N)
# NICE = 19 # NICE = 19
# Keep broken or damaged output files, YES # Keep broken or damaged output files, YES (-K)
# KEEPBROKEN = YES # KEEPBROKEN = YES
# Delete source file after compression
# Delete source file after compression (-D)
# this parameter and value are case sensitive # this parameter and value are case sensitive
# value must be YES to activate # value must be YES to activate
# DELETEFILES = NO # DELETEFILES = NO
# Replace existing lrzip file when compressing # Replace existing lrzip file when compressing (-f)
# this parameter and value are case sensitive # this parameter and value are case sensitive
# value must be YES to activate # value must be YES to activate
# REPLACEFILE = NO
# Select Temporary Directory when stdin/stdout or Test file is used # REPLACEFILE = YES
# Override for Temporary Directory. Only valid when stdin/out or Test is used
# TMPDIR = /tmp # TMPDIR = /tmp
# Whether to use encryption on compression YES, NO (-e)
# ENCRYPT = NO
.fi .fi
.PP .PP
.SH "NOTES" .SH "NOTES"