jpayne@68: .\" SPDX-License-Identifier: 0BSD
jpayne@68: .\"
jpayne@68: .\" Authors: Lasse Collin
jpayne@68: .\"          Jia Tan
jpayne@68: .\"
jpayne@68: .\" (Note that this file is not based on gzip's zgrep.1.)
jpayne@68: .\"
jpayne@68: .TH XZGREP 1 "2024-02-13" "Tukaani" "XZ Utils"
jpayne@68: .SH NAME
jpayne@68: xzgrep \- search possibly-compressed files for patterns
jpayne@68: .
jpayne@68: .SH SYNOPSIS
jpayne@68: .B xzgrep
jpayne@68: .RI [ option... ]
jpayne@68: .RI [ pattern_list ]
jpayne@68: .RI [ file... ]
jpayne@68: .br
jpayne@68: .B xzegrep
jpayne@68: \&...
jpayne@68: .br
jpayne@68: .B xzfgrep
jpayne@68: \&...
jpayne@68: .br
jpayne@68: .B lzgrep
jpayne@68: \&...
jpayne@68: .br
jpayne@68: .B lzegrep
jpayne@68: \&...
jpayne@68: .br
jpayne@68: .B lzfgrep
jpayne@68: \&...
jpayne@68: .
jpayne@68: .SH DESCRIPTION
jpayne@68: .B xzgrep
jpayne@68: invokes
jpayne@68: .BR grep (1)
jpayne@68: on uncompressed contents of files.
jpayne@68: The formats of the
jpayne@68: .I files
jpayne@68: are determined from the filename suffixes.
jpayne@68: Any
jpayne@68: .I file
jpayne@68: with a suffix supported by
jpayne@68: .BR xz (1),
jpayne@68: .BR gzip (1),
jpayne@68: .BR bzip2 (1),
jpayne@68: .BR lzop (1),
jpayne@68: .BR zstd (1),
jpayne@68: or
jpayne@68: .BR lz4 (1)
jpayne@68: will be decompressed;
jpayne@68: all other files are assumed to be uncompressed.
jpayne@68: .PP
jpayne@68: If no
jpayne@68: .I files
jpayne@68: are specified or
jpayne@68: .I file
jpayne@68: is
jpayne@68: .B \-
jpayne@68: then standard input is read.
jpayne@68: When reading from standard input, only files supported by
jpayne@68: .BR xz (1)
jpayne@68: are decompressed.
jpayne@68: Other files are assumed to be in uncompressed form already.
jpayne@68: .PP
jpayne@68: Most
jpayne@68: .I options
jpayne@68: of
jpayne@68: .BR grep (1)
jpayne@68: are supported.
jpayne@68: However, the following options are not supported:
jpayne@68: .IP "" 4
jpayne@68: .BR \-r ,
jpayne@68: .B \-\-recursive
jpayne@68: .IP "" 4
jpayne@68: .BR \-R ,
jpayne@68: .B \-\-dereference\-recursive
jpayne@68: .IP "" 4
jpayne@68: .BR \-d ,
jpayne@68: .BI \-\-directories= action
jpayne@68: .IP "" 4
jpayne@68: .BR \-Z ,
jpayne@68: .B \-\-null
jpayne@68: .IP "" 4
jpayne@68: .BR \-z ,
jpayne@68: .B \-\-null\-data
jpayne@68: .IP "" 4
jpayne@68: .BI \-\-include= glob
jpayne@68: .IP "" 4
jpayne@68: .BI \-\-exclude= glob
jpayne@68: .IP "" 4
jpayne@68: .BI \-\-exclude\-from= file
jpayne@68: .IP "" 4
jpayne@68: .BI \-\-exclude\-dir= glob
jpayne@68: .PP
jpayne@68: .B xzegrep
jpayne@68: is an alias for
jpayne@68: .BR "xzgrep \-E" .
jpayne@68: .B xzfgrep
jpayne@68: is an alias for
jpayne@68: .BR "xzgrep \-F" .
jpayne@68: .PP
jpayne@68: The commands
jpayne@68: .BR lzgrep ,
jpayne@68: .BR lzegrep ,
jpayne@68: and
jpayne@68: .B lzfgrep
jpayne@68: are provided for backward compatibility with LZMA Utils.
jpayne@68: .
jpayne@68: .SH EXIT STATUS
jpayne@68: .TP
jpayne@68: 0
jpayne@68: At least one match was found from at least one of the input files.
jpayne@68: No errors occurred.
jpayne@68: .TP
jpayne@68: 1
jpayne@68: No matches were found from any of the input files.
jpayne@68: No errors occurred.
jpayne@68: .TP
jpayne@68: >1
jpayne@68: One or more errors occurred.
jpayne@68: It is unknown if matches were found.
jpayne@68: .
jpayne@68: .SH ENVIRONMENT
jpayne@68: .TP
jpayne@68: .B GREP
jpayne@68: If
jpayne@68: .B GREP
jpayne@68: is set to a non-empty value,
jpayne@68: it is used instead of
jpayne@68: .BR "grep" ,
jpayne@68: .BR "grep \-E" ,
jpayne@68: or
jpayne@68: .BR "grep \-F" .
jpayne@68: .
jpayne@68: .SH "SEE ALSO"
jpayne@68: .BR grep (1),
jpayne@68: .BR xz (1),
jpayne@68: .BR gzip (1),
jpayne@68: .BR bzip2 (1),
jpayne@68: .BR lzop (1),
jpayne@68: .BR zstd (1),
jpayne@68: .BR lz4 (1),
jpayne@68: .BR zgrep (1)