1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "pacutils-mtree 3"
.TH pacutils-mtree 3 "2021-08-14" "pacutils" "pacutils-mtree"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
pacutils\-mtree \- read mtree data for installed packages
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #include <pacutils/mtree.h>
\&
\& typedef struct pu_mtree_t {
\& char *path;
\& char *type;
\& uid_t uid;
\& gid_t gid;
\& mode_t mode;
\& off_t size;
\& char *md5digest;
\& char *sha256digest;
\& } pu_mtree_t;
\&
\& typedef struct {
\& FILE *stream;
\& int eof;
\& pu_mtree_t defaults;
\& } pu_mtree_reader_t;
\&
\& pu_mtree_reader_t *pu_mtree_reader_open_stream(FILE *stream);
\& pu_mtree_reader_t *pu_mtree_reader_open_package(alpm_handle_t *h, alpm_pkg_t *p);
\& pu_mtree_t *pu_mtree_reader_next(pu_mtree_reader_t *reader, pu_mtree_t *dest);
\& void pu_mtree_reader_free(pu_mtree_reader_t *reader);
\& void pu_mtree_free(pu_mtree_t *mtree);
\&
\& /* deprecated */
\& alpm_list_t *pu_mtree_load_pkg_mtree(alpm_handle_t *handle, alpm_pkg_t *pkg);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Package mtree reading functions are provided to fill gaps in libarchive's mtree
reader, notably \f(CW\*(C`md5digest\*(C'\fR and \f(CW\*(C`sha256digest\*(C'\fR which are currently not read
by libarchive. Support is incomplete and should only be used to supplement
libalpm's native mtree reader.
.IP "pu_mtree_reader_t *pu_mtree_reader_open_stream(\s-1FILE\s0 *stream);" 4
.IX Item "pu_mtree_reader_t *pu_mtree_reader_open_stream(FILE *stream);"
Open a file stream for parsing.
.IP "pu_mtree_reader_t *pu_mtree_reader_open_package(alpm_handle_t *h, alpm_pkg_t *p);" 4
.IX Item "pu_mtree_reader_t *pu_mtree_reader_open_package(alpm_handle_t *h, alpm_pkg_t *p);"
Open an installed package's mtree file for parsing. Results are undefined if
\&\f(CW\*(C`p\*(C'\fR is not a locally installed package.
.IP "pu_mtree_t *pu_mtree_reader_next(pu_mtree_reader_t *reader, pu_mtree_t *dest);" 4
.IX Item "pu_mtree_t *pu_mtree_reader_next(pu_mtree_reader_t *reader, pu_mtree_t *dest);"
Read and return the next entry in the mtree file. If \f(CW\*(C`dest\*(C'\fR is \f(CW\*(C`NULL\*(C'\fR a new
\&\f(CW\*(C`pu_mtree_t\*(C'\fR object will be allocated that should be freed by the caller.
Otherwise, it will be filled with the parsed data. Internally allocated memory
will automatically be freed as needed.
.IP "void pu_mtree_free(pu_mtree_t *mtree);" 4
.IX Item "void pu_mtree_free(pu_mtree_t *mtree);"
Free a \f(CW\*(C`pu_mtree_t\*(C'\fR struct.
.IP "void pu_mtree_reader_free(pu_mtree_reader_t *reader);" 4
.IX Item "void pu_mtree_reader_free(pu_mtree_reader_t *reader);"
Free a \f(CW\*(C`pu_mtree_reader_t\*(C'\fR object.
.IP "alpm_list_t *pu_mtree_load_pkg_mtree(alpm_handle_t *handle, alpm_pkg_t *pkg);" 4
.IX Item "alpm_list_t *pu_mtree_load_pkg_mtree(alpm_handle_t *handle, alpm_pkg_t *pkg);"
Returns a list of mtree entries for \f(CW\*(C`pkg\*(C'\fR. \fB\s-1DEPRECATED\s0\fR: use
\&\f(CW\*(C`pu_mtree_reader_open_package\*(C'\fR instead.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.IP "Print file md5sums for a package:" 4
.IX Item "Print file md5sums for a package:"
.Vb 2
\& pu_mtree_t *m;
\& pu_mtree_reader_t *r;
\&
\& if((r = pu_mtree_reader_open_package(handle, pkg)) == NULL) {
\& fprintf(stderr, "error: unable to load mtree data for \*(Aq%s\*(Aq\en",
\& alpm_pkg_get_name(pkg));
\& return;
\& }
\&
\& while((m = pu_mtree_reader_next(r, NULL))) {
\& const char *md5 = m\->md5digest;
\& printf("%s: %s\en", m\->path,
\& md5 && md5[0] != \*(Aq\e0\*(Aq ? md5 : "(no md5sum provided)");
\& pu_mtree_free(m);
\& }
\& if(!reader\->eof) {
\& fprintf(stderr, "error: unable to read mtree data for \*(Aq%s\*(Aq\en",
\& alpm_pkg_get_name(pkg));
\& }
\&
\& pu_mtree_reader_free(r);
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\fBalpm_pkg_mtree_open\fR\|(3), \fBalpm_pkg_mtree_next\fR\|(3), \fBalpm_pkg_mtree_close\fR\|(3)" 4
.IX Item "alpm_pkg_mtree_open, alpm_pkg_mtree_next, alpm_pkg_mtree_close"
.PD 0
.ie n .IP "\fBmtree\fR\|(5) \- description of ""pu_mtree_t"" members" 4
.el .IP "\fBmtree\fR\|(5) \- description of \f(CWpu_mtree_t\fR members" 4
.IX Item "mtree - description of pu_mtree_t members"
|
