lrzip/man/lrzip.conf.5

.TH "lrzip.conf" "5" "January 2009, updated May 2019" "" ""
.SH "NAME"
lrzip.conf \- Configuration File for lrzip
.SH "DESCRIPTION"
.PP
This file if used, will be read by the lrzip program\&, parsed\&,
and options passed to the program\&. Some options may be overridden
on the command line\&. Others are fixed\&.
.PP
The configuration file must be called \fBlrzip\&.conf\fP\&.
The lrzip program will search for the file automatically in one of
three places\&:
.nf
$PWD \- Current Directory
/etc/lrzip
$HOME/\&.lrzip
.PP
Parameters are set in \fBPARAMETER\&=VALUE\fP fashion where any line
beginning with a \fB#\fP or that is blank will be ignored\&.
Parameter values are not case sensitive except where specified\&.
.PP
.SH "CONFIG FILE EXAMPLE"
.nf
# This is a comment.

# Compression Window size in 100MB. Normally selected by program. (-w)
# WINDOW = 20
# Compression Level 1-9 (7 Default). (-L)
# COMPRESSIONLEVEL = 7
# Use -U setting, Unlimited ram. Yes or No
# UNLIMITED = NO
# Compression Method, rzip, gzip, bzip2, lzo, or lzma (default), or zpaq. (-n -g -b -l --lzma -z)
# If specified here, command line options not usable.
# COMPRESSIONMETHOD = lzma
# Perform LZO Test. Default = YES (-T )
# LZOTEST = NO
# Hash Check on decompression, (-c)
# HASHCHECK = YES
# Show HASH value on Compression even if Verbose is off, YES (-H)
# SHOWHASH = YES

# Default output directory (-O)
# OUTPUTDIRECTORY = location
# Verbosity, YES or MAX (v, vv)
# VERBOSITY = max
# Show Progress as file is parsed, YES or no (NO = -q option)
# SHOWPROGRESS = YES

# Set Niceness. 19 is default. -20 to 19 is the allowable range (-N)
# NICE = 19

# Keep broken or damaged output files, YES (-K)
# KEEPBROKEN = YES

# Delete source file after compression (-D)
# this parameter and value are case sensitive
# value must be YES to activate

# DELETEFILES = NO

# Replace existing lrzip file when compressing (-f)
# this parameter and value are case sensitive
# value must be YES to activate

# REPLACEFILE = YES 

# Override for Temporary Directory. Only valid when stdin/out or Test is used
# TMPDIR = /tmp

# Whether to use encryption on compression YES, NO (-e)
# ENCRYPT = NO

.fi
.PP
.SH "NOTES"
.PP
Be careful when using \fBDELETEFILES\fP or \fBREPLACEFILE\fP as
no warning will be given and lrzip will simply delete the source
or replace the output file!
.PP
.SH "SEE ALSO"
lrzip(1)
update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00			`.TH "lrzip.conf" "5" "January 2009, updated May 2019" "" ""`
Initial import 2010-03-29 01:07:08 +02:00			`.SH "NAME"`
			`lrzip.conf \- Configuration File for lrzip`
			`.SH "DESCRIPTION"`
			`.PP`
			`This file if used, will be read by the lrzip program\&, parsed\&,`
			`and options passed to the program\&. Some options may be overridden`
			`on the command line\&. Others are fixed\&.`
			`.PP`
			`The configuration file must be called \fBlrzip\&.conf\fP\&.`
			`The lrzip program will search for the file automatically in one of`
			`three places\&:`
			`.nf`
			`$PWD \- Current Directory`
			`/etc/lrzip`
update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00			`$HOME/\&.lrzip`
Initial import 2010-03-29 01:07:08 +02:00			`.PP`
			`Parameters are set in \fBPARAMETER\&=VALUE\fP fashion where any line`
			`beginning with a \fB#\fP or that is blank will be ignored\&.`
update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00			`Parameter values are not case sensitive except where specified\&.`
Initial import 2010-03-29 01:07:08 +02:00			`.PP`
			`.SH "CONFIG FILE EXAMPLE"`
			`.nf`
			`# This is a comment.`

update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00			`# Compression Window size in 100MB. Normally selected by program. (-w)`
			`# WINDOW = 20`
			`# Compression Level 1-9 (7 Default). (-L)`
Update lrzip.conf parser to respect -U, -H, -T, k, and -c options. Further updates to documentation. Changes by Peter Hyman <pete@peterhyman.com> 2011-02-23 17:07:57 +01:00			`# COMPRESSIONLEVEL = 7`
update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00			`# Use -U setting, Unlimited ram. Yes or No`
			`# UNLIMITED = NO`
			`# Compression Method, rzip, gzip, bzip2, lzo, or lzma (default), or zpaq. (-n -g -b -l --lzma -z)`
			`# If specified here, command line options not usable.`
			`# COMPRESSIONMETHOD = lzma`
			`# Perform LZO Test. Default = YES (-T )`
Update lrzip.conf parser to respect -U, -H, -T, k, and -c options. Further updates to documentation. Changes by Peter Hyman <pete@peterhyman.com> 2011-02-23 17:07:57 +01:00			`# LZOTEST = NO`
update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00			`# Hash Check on decompression, (-c)`
Update lrzip.conf parser to respect -U, -H, -T, k, and -c options. Further updates to documentation. Changes by Peter Hyman <pete@peterhyman.com> 2011-02-23 17:07:57 +01:00			`# HASHCHECK = YES`
update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00			`# Show HASH value on Compression even if Verbose is off, YES (-H)`
Update lrzip.conf parser to respect -U, -H, -T, k, and -c options. Further updates to documentation. Changes by Peter Hyman <pete@peterhyman.com> 2011-02-23 17:07:57 +01:00			`# SHOWHASH = YES`

update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00			`# Default output directory (-O)`
Update lrzip.conf parser to respect -U, -H, -T, k, and -c options. Further updates to documentation. Changes by Peter Hyman <pete@peterhyman.com> 2011-02-23 17:07:57 +01:00			`# OUTPUTDIRECTORY = location`
update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00			`# Verbosity, YES or MAX (v, vv)`
			`# VERBOSITY = max`
			`# Show Progress as file is parsed, YES or no (NO = -q option)`
			`# SHOWPROGRESS = YES`

			`# Set Niceness. 19 is default. -20 to 19 is the allowable range (-N)`
Update lrzip.conf parser to respect -U, -H, -T, k, and -c options. Further updates to documentation. Changes by Peter Hyman <pete@peterhyman.com> 2011-02-23 17:07:57 +01:00			`# NICE = 19`

update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00			`# Keep broken or damaged output files, YES (-K)`
Update lrzip.conf parser to respect -U, -H, -T, k, and -c options. Further updates to documentation. Changes by Peter Hyman <pete@peterhyman.com> 2011-02-23 17:07:57 +01:00			`# KEEPBROKEN = YES`
update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00
			`# Delete source file after compression (-D)`
Initial import 2010-03-29 01:07:08 +02:00			`# this parameter and value are case sensitive`
			`# value must be YES to activate`
update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00
Initial import 2010-03-29 01:07:08 +02:00			`# DELETEFILES = NO`

update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00			`# Replace existing lrzip file when compressing (-f)`
Initial import 2010-03-29 01:07:08 +02:00			`# this parameter and value are case sensitive`
			`# value must be YES to activate`
Minor updates to man pages, lrzip.conf example file. Update main help screen to include environment settings. Update to respect $TMP environment variable for TMP files. Updated control structure to include tmpdir pointer. Update lrzip.conf parser to respect -U -M options. Update lrzip.conf example to include new parameters. Reorder main Switch loop in main.c for readability. Have MAXRAM and control.window be exclusive. MAXRAM wins. Have UNLIMITED and control.window be exclusive. UNLIMITED wins. Have UNLIMITED and MAXRAM be exclusive. UNLIMITED wins. Corrects heuristic computation in rzip.c which would override MAXRAM or UNLIMITED if control.window set Show heuristically computed control.window when computed. Remove display compression level from control.window verbose output. Update print_verbose format for Testing for incompressible data in stream.c to omit extra \n. Changes by Peter Hyman <pete@peterhyman.com> 2011-02-21 02:03:08 +01:00
update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00			`# REPLACEFILE = YES`

			`# Override for Temporary Directory. Only valid when stdin/out or Test is used`
Update lrzip.conf parser to respect -U, -H, -T, k, and -c options. Further updates to documentation. Changes by Peter Hyman <pete@peterhyman.com> 2011-02-23 17:07:57 +01:00			`# TMPDIR = /tmp`
update to lrzip.conf.5 manpage and example file. 2019-05-12 19:35:13 +02:00
			`# Whether to use encryption on compression YES, NO (-e)`
			`# ENCRYPT = NO`

Initial import 2010-03-29 01:07:08 +02:00			`.fi`
			`.PP`
			`.SH "NOTES"`
			`.PP`
			`Be careful when using \fBDELETEFILES\fP or \fBREPLACEFILE\fP as`
			`no warning will be given and lrzip will simply delete the source`
			`or replace the output file!`
			`.PP`
			`.SH "SEE ALSO"`
			`lrzip(1)`