ceph/src/isa-l/programs/igzip.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.11.
   2 .TH IGZIP "1" "February 2020" "igzip command line interface 2.29.0" "User Commands"
   3 .SH NAME
   4 igzip \- compress or decompress files similar to gzip
   5 .SH SYNOPSIS
   6 .B igzip
   7 [\fI\,options\/\fR] [\fI\,infiles\/\fR]
   8 .SH DESCRIPTION
   9
  10 Compress or decompress files similar to gzip using the ISA-L fast deflate library.
  11
  12 Output .gz files are compatible with gzip and [RFC-1952].
  13
  14 Options are similar to gzip except --keep is default.
  15 .SH OPTIONS
  16 .TP
  17 \fB\-h\fR, \fB\-\-help\fR
  18 help, print this message
  19 .TP
  20 \-#
  21 use compression level # with 0 <= # <= 3
  22 .TP
  23 \fB\-o\fR
  24 <file>           output file
  25 .TP
  26 \fB\-c\fR, \fB\-\-stdout\fR
  27 write to stdout
  28 .TP
  29 \fB\-d\fR, \fB\-\-decompress\fR
  30 decompress file
  31 .TP
  32 \fB\-z\fR, \fB\-\-compress\fR
  33 compress file (default)
  34 .TP
  35 \fB\-f\fR, \fB\-\-force\fR
  36 overwrite output without prompting
  37 .TP
  38 \fB\-\-rm\fR
  39 remove source files after successful (de)compression
  40 .TP
  41 \fB\-k\fR, \fB\-\-keep\fR
  42 keep source files (default)
  43 .TP
  44 \fB\-S\fR, \fB\-\-suffix\fR <.suf>
  45 suffix to use while (de)compressing
  46 .TP
  47 \fB\-V\fR, \fB\-\-version\fR
  48 show version number
  49 .TP
  50 \fB\-v\fR, \fB\-\-verbose\fR
  51 verbose mode
  52 .TP
  53 \fB\-N\fR, \fB\-\-name\fR
  54 save/use file name and timestamp in compress/decompress
  55 .TP
  56 \fB\-n\fR, \fB\-\-no\-name\fR
  57 do not save/use file name and timestamp in compress/decompress
  58 .TP
  59 \fB\-t\fR, \fB\-\-test\fR
  60 test compressed file integrity
  61 .TP
  62 \fB\-T\fR, \fB\-\-threads\fR <n>
  63 use n threads to compress if enabled
  64 .TP
  65 \fB\-q\fR, \fB\-\-quiet\fR
  66 suppress warnings
  67 .PP
  68 with no infile, or when infile is \- , read standard input
  69 .SH EXAMPLES
  70
  71 Make compressed file1.gz and file2.gz and keep file1 and file2.
  72 .RS
  73 .B igzip file1 file2
  74 .RE
  75
  76 Piped compression and decompression.
  77 .RS
  78 .B igzip -c file.txt | igzip -d -c -
  79 .RE
  80
  81 Streaming compression from output of tar, compress level 2.
  82 .RS
  83 .B tar cf - dir1 | igzip -2 > dir1.tar.gz
  84 .RE
  85 .SH "REPORTING BUGS"
  86
  87 Report bugs to https://github.com/intel/isa-l/issues