lrzip/man/lrzip.conf.5

.TH "lrzip.conf" "5" "January 2009" "" ""
.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\&.
.PP
.SH "CONFIG FILE EXAMPLE"
.nf
# This is a comment.

# Compression Window size in 100MB. Normally selected by program.
# WINDOW = 5
# Compression Level 1-9 (7 Default).
# COMPRESSIONLEVEL = 7
# Unlimited Ram Compression
# UNLIMITED = YES
# Compression Method, rzip, gzip, bzip2, lzo, or lzma (default), zpaq.
# COMPRESSIONMETHOD = LZMA
# Perform LZO Test. Default = YES (\-T option, NO)
# LZOTEST = NO
# Hash Check on decompression, YES
# HASHCHECK = YES
# Show HASH value on Compression even if Verbose is off, YES
# SHOWHASH = YES

# Default output directory
# OUTPUTDIRECTORY = location
# Verbosity, Yes or Max
# VERBOSITY = MAX
# Show Progress as file is parsed, YES, NO (yes is default)
# SHOWPROGRESS = NO
# Set Niceness. 19 is default. \-20 to 19 is the allowable range
# NICE = 19

# Keep broken or damaged output files, YES
# KEEPBROKEN = YES
# Delete source file after compression
# this parameter and value are case sensitive
# value must be YES to activate
# DELETEFILES = NO

# Replace existing lrzip file when compressing
# this parameter and value are case sensitive
# value must be YES to activate
# REPLACEFILE = NO

# Select Temporary Directory when stdin/stdout or Test file is used
# TMPDIR = /tmp
.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)
Initial import 2010-03-29 01:07:08 +02:00			`.TH "lrzip.conf" "5" "January 2009" "" ""`
			`.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\&.`
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			`Parameter values are not case sensitive\&.`
Initial import 2010-03-29 01:07:08 +02:00			`.PP`
			`.SH "CONFIG FILE EXAMPLE"`
			`.nf`
			`# This is a comment.`

			`# Compression Window size in 100MB. Normally selected by program.`
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			`# WINDOW = 5`
Initial import 2010-03-29 01:07:08 +02:00			`# Compression Level 1-9 (7 Default).`
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`
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			`# Unlimited Ram Compression`
			`# UNLIMITED = YES`
			`# Compression Method, rzip, gzip, bzip2, lzo, or lzma (default), zpaq.`
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			`# COMPRESSIONMETHOD = LZMA`
man/lrzip.conf.5: fix hyphen 2011-04-21 19:05:55 +02:00			`# Perform LZO Test. Default = YES (\-T option, NO)`
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`
			`# Hash Check on decompression, YES`
			`# HASHCHECK = YES`
			`# Show HASH value on Compression even if Verbose is off, YES`
			`# SHOWHASH = YES`

Initial import 2010-03-29 01:07:08 +02:00			`# Default output directory`
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`
			`# Verbosity, Yes or Max`
			`# VERBOSITY = MAX`
			`# Show Progress as file is parsed, YES, NO (yes is default)`
			`# SHOWPROGRESS = NO`
Initial import 2010-03-29 01:07:08 +02:00			`# Set Niceness. 19 is default. \-20 to 19 is the allowable range`
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`

			`# Keep broken or damaged output files, YES`
			`# KEEPBROKEN = YES`
Initial import 2010-03-29 01:07:08 +02:00			`# Delete source file after compression`
			`# this parameter and value are case sensitive`
			`# value must be YES to activate`
			`# DELETEFILES = NO`

			`# Replace existing lrzip file when compressing`
			`# this parameter and value are case sensitive`
			`# value must be YES to activate`
			`# REPLACEFILE = NO`
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
			`# Select Temporary Directory when stdin/stdout or Test file 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`
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)`