summaryrefslogtreecommitdiffstats
path: root/src/isa-l/programs/igzip.1
diff options
context:
space:
mode:
Diffstat (limited to 'src/isa-l/programs/igzip.1')
-rw-r--r--src/isa-l/programs/igzip.187
1 files changed, 87 insertions, 0 deletions
diff --git a/src/isa-l/programs/igzip.1 b/src/isa-l/programs/igzip.1
new file mode 100644
index 000000000..fd20512df
--- /dev/null
+++ b/src/isa-l/programs/igzip.1
@@ -0,0 +1,87 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.11.
+.TH IGZIP "1" "November 2020" "igzip command line interface 2.30.0" "User Commands"
+.SH NAME
+igzip \- compress or decompress files similar to gzip
+.SH SYNOPSIS
+.B igzip
+[\fI\,options\/\fR] [\fI\,infiles\/\fR]
+.SH DESCRIPTION
+
+Compress or decompress files similar to gzip using the ISA-L fast deflate library.
+
+Output .gz files are compatible with gzip and [RFC-1952].
+
+Options are similar to gzip except --keep is default.
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+help, print this message
+.TP
+\-#
+use compression level # with 0 <= # <= 3
+.TP
+\fB\-o\fR
+<file> output file
+.TP
+\fB\-c\fR, \fB\-\-stdout\fR
+write to stdout
+.TP
+\fB\-d\fR, \fB\-\-decompress\fR
+decompress file
+.TP
+\fB\-z\fR, \fB\-\-compress\fR
+compress file (default)
+.TP
+\fB\-f\fR, \fB\-\-force\fR
+overwrite output without prompting
+.TP
+\fB\-\-rm\fR
+remove source files after successful (de)compression
+.TP
+\fB\-k\fR, \fB\-\-keep\fR
+keep source files (default)
+.TP
+\fB\-S\fR, \fB\-\-suffix\fR <.suf>
+suffix to use while (de)compressing
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+show version number
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+verbose mode
+.TP
+\fB\-N\fR, \fB\-\-name\fR
+save/use file name and timestamp in compress/decompress
+.TP
+\fB\-n\fR, \fB\-\-no\-name\fR
+do not save/use file name and timestamp in compress/decompress
+.TP
+\fB\-t\fR, \fB\-\-test\fR
+test compressed file integrity
+.TP
+\fB\-T\fR, \fB\-\-threads\fR <n>
+use n threads to compress if enabled
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+suppress warnings
+.PP
+with no infile, or when infile is \- , read standard input
+.SH EXAMPLES
+
+Make compressed file1.gz and file2.gz and keep file1 and file2.
+.RS
+.B igzip file1 file2
+.RE
+
+Piped compression and decompression.
+.RS
+.B igzip -c file.txt | igzip -d -c -
+.RE
+
+Streaming compression from output of tar, compress level 2.
+.RS
+.B tar cf - dir1 | igzip -2 > dir1.tar.gz
+.RE
+.SH "REPORTING BUGS"
+
+Report bugs to https://github.com/intel/isa-l/issues