summaryrefslogtreecommitdiffstats
path: root/src/isa-l/programs/igzip.1
blob: fd20512df15ae4d4adc8345cf044132588c5ecb2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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