Debian Codegraph @

upstream/debian-unstable/man1/ptargrep.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "PTARGREP 1"
58 .TH PTARGREP 1 2026-04-10 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 ptargrep \- Apply pattern matching to the contents of files in a tar archive
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& ptargrep [options] <pattern> <tar file> ...
69 \&
70 \& Options:
71 \&
72 \& \-\-basename|\-b ignore directory paths from archive
73 \& \-\-ignore\-case|\-i do case\-insensitive pattern matching
74 \& \-\-list\-only|\-l list matching filenames rather than extracting matches
75 \& \-\-verbose|\-v write debugging message to STDERR
76 \& \-\-help|\-? detailed help message
77 .Ve
78 .SH DESCRIPTION
79 .IX Header "DESCRIPTION"
80 This utility allows you to apply pattern matching to \fBthe contents\fR of files
81 contained in a tar archive. You might use this to identify all files in an
82 archive which contain lines matching the specified pattern and either print out
83 the pathnames or extract the files.
84 .PP
85 The pattern will be used as a Perl regular expression (as opposed to a simple
86 grep regex).
87 .PP
88 Multiple tar archive filenames can be specified \- they will each be processed
89 in turn.
90 .SH OPTIONS
91 .IX Header "OPTIONS"
92 .IP "\fB\-\-basename\fR (alias \-b)" 4
93 .IX Item "--basename (alias -b)"
94 When matching files are extracted, ignore the directory path from the archive
95 and write to the current directory using the basename of the file from the
96 archive. Beware: if two matching files in the archive have the same basename,
97 the second file extracted will overwrite the first.
98 .IP "\fB\-\-ignore\-case\fR (alias \-i)" 4
99 .IX Item "--ignore-case (alias -i)"
100 Make pattern matching case-insensitive.
101 .IP "\fB\-\-list\-only\fR (alias \-l)" 4
102 .IX Item "--list-only (alias -l)"
103 Print the pathname of each matching file from the archive to STDOUT. Without
104 this option, the default behaviour is to extract each matching file.
105 .IP "\fB\-\-verbose\fR (alias \-v)" 4
106 .IX Item "--verbose (alias -v)"
107 Log debugging info to STDERR.
108 .IP "\fB\-\-help\fR (alias \-?)" 4
109 .IX Item "--help (alias -?)"
110 Display this documentation.
111 .SH COPYRIGHT
112 .IX Header "COPYRIGHT"
113 Copyright 2010 Grant McLean <[email protected]>
114 .PP
115 This program is free software; you can redistribute it and/or modify it
116 under the same terms as Perl itself.