src/scripts/xzgrep.1

   1 .\" Original file was take from gzip, thus this man page is under GNU GPLv2+.
   2 .TH XZGREP 1 "2009-04-13" "XZ Utils"
   3 .SH NAME
   4 xzgrep \- search .xz and .lzma compressed files for a regular expression
   5 .SH SYNOPSIS
   6 .B xzgrep
   7 .RI [ grep_options ]
   8 .RB  [ \-e ]
   9 .I pattern
  10 .IR filename ".\|.\|."
  11 .br
  12 .B xzegrep
  13 .RB ...
  14 .br
  15 .B xzfgrep
  16 .RB ...
  17 .br
  18 .B lzgrep
  19 .RB ...
  20 .br
  21 .B lzegrep
  22 .RB ...
  23 .br
  24 .B lzfgrep
  25 .RB ...
  26 .SH DESCRIPTION
  27 .B  xzgrep
  28 is used to invoke the
  29 .BR grep (1)
  30 on .xz or .lzma compressed files. All options specified are passed directly to
  31 .BR grep .
  32 If no file is specified, then the standard input is decompressed
  33 if necessary and fed to grep.
  34 Otherwise the given files are uncompressed if necessary and fed to
  35 .BR grep .
  36 .PP
  37 If
  38 .B xzgrep
  39 is invoked as
  40 .B xzegrep
  41 or
  42 .B xzfgrep
  43 then
  44 .B egrep
  45 or
  46 .B fgrep
  47 is used instead of
  48 .B grep.
  49 The same applies to names
  50 .BR lzgrep ,
  51 .BR lzegrep ,
  52 and
  53 .BR lzfgrep ,
  54 which are provided for backward compatibility with LZMA Utils.
  55
  56 If the GREP environment variable is set,
  57 .B xzgrep
  58 uses it as the
  59 .B grep
  60 program to be invoked. For example:
  61
  62     for sh:  GREP=fgrep  xzgrep string files
  63     for csh: (setenv GREP fgrep; xzgrep string files)
  64 .SH AUTHORS
  65 Original
  66 .BR zgrep (1)
  67 manual page by Charles Levert <charles@comm.polymtl.ca>.
  68 .PP
  69 Minor modifications for XZ Utils by Lasse Collin
  70 <lasse.collin@tukaani.org>.
  71 .SH "SEE ALSO"
  72 .BR grep (1),
  73 .BR egrep (1),
  74 .BR fgrep (1),
  75 .BR xzdiff (1),
  76 .BR xzmore (1),
  77 .BR xz (1)