Debian Codegraph @

upstream/mageia-cauldron/man1/ptargrep.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "PTARGREP 1"
61 .TH PTARGREP 1 2026-05-26 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 ptargrep \- Apply pattern matching to the contents of files in a tar archive
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& ptargrep [options] <pattern> <tar file> ...
72 \&
73 \& Options:
74 \&
75 \& \-\-basename|\-b ignore directory paths from archive
76 \& \-\-ignore\-case|\-i do case\-insensitive pattern matching
77 \& \-\-list\-only|\-l list matching filenames rather than extracting matches
78 \& \-\-verbose|\-v write debugging message to STDERR
79 \& \-\-help|\-? detailed help message
80 .Ve
81 .SH DESCRIPTION
82 .IX Header "DESCRIPTION"
83 This utility allows you to apply pattern matching to \fBthe contents\fR of files
84 contained in a tar archive. You might use this to identify all files in an
85 archive which contain lines matching the specified pattern and either print out
86 the pathnames or extract the files.
87 .PP
88 The pattern will be used as a Perl regular expression (as opposed to a simple
89 grep regex).
90 .PP
91 Multiple tar archive filenames can be specified \- they will each be processed
92 in turn.
93 .SH OPTIONS
94 .IX Header "OPTIONS"
95 .IP "\fB\-\-basename\fR (alias \-b)" 4
96 .IX Item "--basename (alias -b)"
97 When matching files are extracted, ignore the directory path from the archive
98 and write to the current directory using the basename of the file from the
99 archive. Beware: if two matching files in the archive have the same basename,
100 the second file extracted will overwrite the first.
101 .IP "\fB\-\-ignore\-case\fR (alias \-i)" 4
102 .IX Item "--ignore-case (alias -i)"
103 Make pattern matching case\-insensitive.
104 .IP "\fB\-\-list\-only\fR (alias \-l)" 4
105 .IX Item "--list-only (alias -l)"
106 Print the pathname of each matching file from the archive to STDOUT. Without
107 this option, the default behaviour is to extract each matching file.
108 .IP "\fB\-\-verbose\fR (alias \-v)" 4
109 .IX Item "--verbose (alias -v)"
110 Log debugging info to STDERR.
111 .IP "\fB\-\-help\fR (alias \-?)" 4
112 .IX Item "--help (alias -?)"
113 Display this documentation.
114 .SH COPYRIGHT
115 .IX Header "COPYRIGHT"
116 Copyright 2010 Grant McLean <[email protected]>
117 .PP
118 This program is free software; you can redistribute it and/or modify it
119 under the same terms as Perl itself.