Version 1.15.3.
[libguestfs.git] / po-docs / libguestfs-docs.pot
1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
5 #
6 #, fuzzy
7 msgid ""
8 msgstr ""
9 "Project-Id-Version: libguestfs 1.15.3\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-11-09 22:24+0000\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
15 "Language: \n"
16 "MIME-Version: 1.0\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
19
20 #. type: =head1
21 #: ../align/virt-alignment-scan.pod:3 ../cat/virt-cat.pod:3 ../cat/virt-filesystems.pod:3 ../cat/virt-ls.pod:3 ../clone/virt-sysprep.pod:3 ../df/virt-df.pod:3 ../edit/virt-edit.pod:3 ../erlang/examples/guestfs-erlang.pod:3 ../examples/guestfs-examples.pod:3 ../examples/guestfs-recipes.pod:14 ../fish/guestfish.pod:3 ../fish/virt-copy-in.pod:3 ../fish/virt-copy-out.pod:3 ../fish/virt-tar-in.pod:3 ../fish/virt-tar-out.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pod:3 ../java/examples/guestfs-java.pod:3 ../ocaml/examples/guestfs-ocaml.pod:3 ../perl/examples/guestfs-perl.pod:3 ../python/examples/guestfs-python.pod:3 ../rescue/virt-rescue.pod:3 ../resize/virt-resize.pod:3 ../ruby/examples/guestfs-ruby.pod:3 ../sparsify/virt-sparsify.pod:3 ../src/guestfs.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30 ../tools/virt-make-fs.pl:35 ../tools/virt-tar.pl:31 ../tools/virt-win-reg.pl:35
22 msgid "NAME"
23 msgstr ""
24
25 #. type: textblock
26 #: ../align/virt-alignment-scan.pod:5
27 msgid "virt-alignment-scan - Check alignment of virtual machine partitions"
28 msgstr ""
29
30 #. type: =head1
31 #: ../align/virt-alignment-scan.pod:7 ../cat/virt-cat.pod:7 ../cat/virt-filesystems.pod:7 ../cat/virt-ls.pod:7 ../clone/virt-sysprep.pod:7 ../df/virt-df.pod:7 ../edit/virt-edit.pod:7 ../erlang/examples/guestfs-erlang.pod:7 ../examples/guestfs-examples.pod:7 ../fish/guestfish.pod:7 ../fish/virt-copy-in.pod:7 ../fish/virt-copy-out.pod:7 ../fish/virt-tar-in.pod:7 ../fish/virt-tar-out.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pod:7 ../java/examples/guestfs-java.pod:7 ../ocaml/examples/guestfs-ocaml.pod:7 ../perl/examples/guestfs-perl.pod:7 ../python/examples/guestfs-python.pod:7 ../rescue/virt-rescue.pod:7 ../resize/virt-resize.pod:7 ../ruby/examples/guestfs-ruby.pod:7 ../sparsify/virt-sparsify.pod:7 ../src/guestfs.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34 ../tools/virt-make-fs.pl:39 ../tools/virt-tar.pl:35 ../tools/virt-win-reg.pl:39
32 msgid "SYNOPSIS"
33 msgstr ""
34
35 #. type: verbatim
36 #: ../align/virt-alignment-scan.pod:9
37 #, no-wrap
38 msgid ""
39 " virt-alignment-scan [--options] -d domname\n"
40 "\n"
41 msgstr ""
42
43 #. type: verbatim
44 #: ../align/virt-alignment-scan.pod:11
45 #, no-wrap
46 msgid ""
47 " virt-alignment-scan [--options] -a disk.img [-a disk.img ...]\n"
48 "\n"
49 msgstr ""
50
51 #. type: =head1
52 #: ../align/virt-alignment-scan.pod:13 ../cat/virt-cat.pod:19 ../cat/virt-filesystems.pod:13 ../cat/virt-ls.pod:19 ../clone/virt-sysprep.pod:13 ../df/virt-df.pod:21 ../edit/virt-edit.pod:27 ../erlang/examples/guestfs-erlang.pod:16 ../examples/guestfs-examples.pod:19 ../examples/guestfs-recipes.pod:18 ../fish/guestfish.pod:30 ../fish/virt-copy-in.pod:19 ../fish/virt-copy-out.pod:13 ../fish/virt-tar-in.pod:21 ../fish/virt-tar-out.pod:15 ../fuse/guestmount.pod:20 ../inspector/virt-inspector.pod:19 ../java/examples/guestfs-java.pod:15 ../ocaml/examples/guestfs-ocaml.pod:25 ../perl/examples/guestfs-perl.pod:18 ../python/examples/guestfs-python.pod:14 ../rescue/virt-rescue.pod:31 ../resize/virt-resize.pod:13 ../ruby/examples/guestfs-ruby.pod:15 ../sparsify/virt-sparsify.pod:11 ../src/guestfs.pod:23 ../test-tool/libguestfs-test-tool.pod:11 ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40 ../tools/virt-make-fs.pl:47 ../tools/virt-tar.pl:77 ../tools/virt-win-reg.pl:63
53 msgid "DESCRIPTION"
54 msgstr ""
55
56 #. type: textblock
57 #: ../align/virt-alignment-scan.pod:15
58 msgid ""
59 "When older operating systems install themselves, the partitioning tools "
60 "place partitions at a sector misaligned with the underlying storage "
61 "(commonly the first partition starts on sector C<63>).  Misaligned "
62 "partitions can result in an operating system issuing more I/O than should be "
63 "necessary."
64 msgstr ""
65
66 #. type: textblock
67 #: ../align/virt-alignment-scan.pod:21
68 msgid ""
69 "The virt-alignment-scan tool checks the alignment of partitions in virtual "
70 "machines and disk images and warns you if there are alignment problems."
71 msgstr ""
72
73 #. type: textblock
74 #: ../align/virt-alignment-scan.pod:25
75 msgid ""
76 "Currently there is no virt tool for fixing alignment problems.  You can only "
77 "reinstall the guest operating system.  The following NetApp document "
78 "summarises the problem and possible solutions: "
79 "L<http://media.netapp.com/documents/tr-3747.pdf>"
80 msgstr ""
81
82 #. type: =head1
83 #: ../align/virt-alignment-scan.pod:30
84 msgid "OUTPUT"
85 msgstr ""
86
87 #. type: textblock
88 #: ../align/virt-alignment-scan.pod:32
89 msgid "To run this tool on a disk image directly, use the I<-a> option:"
90 msgstr ""
91
92 #. type: verbatim
93 #: ../align/virt-alignment-scan.pod:34
94 #, no-wrap
95 msgid ""
96 " $ virt-alignment-scan -a winxp.img\n"
97 " /dev/sda1        32256          512    bad (alignment < 4K)\n"
98 "\n"
99 msgstr ""
100
101 #. type: verbatim
102 #: ../align/virt-alignment-scan.pod:37
103 #, no-wrap
104 msgid ""
105 " $ virt-alignment-scan -a fedora16.img\n"
106 " /dev/sda1      1048576         1024K   ok\n"
107 " /dev/sda2      2097152         2048K   ok\n"
108 " /dev/sda3    526385152         2048K   ok\n"
109 "\n"
110 msgstr ""
111
112 #. type: textblock
113 #: ../align/virt-alignment-scan.pod:42
114 msgid ""
115 "To run the tool on a guest known to libvirt, use the I<-d> option and "
116 "possibly the I<-c> option:"
117 msgstr ""
118
119 #. type: verbatim
120 #: ../align/virt-alignment-scan.pod:45
121 #, no-wrap
122 msgid ""
123 " # virt-alignment-scan -d RHEL5\n"
124 " /dev/sda1        32256          512    bad (alignment < 4K)\n"
125 " /dev/sda2    106928640          512    bad (alignment < 4K)\n"
126 "\n"
127 msgstr ""
128
129 #. type: verbatim
130 #: ../align/virt-alignment-scan.pod:49
131 #, no-wrap
132 msgid ""
133 " $ virt-alignment-scan -c qemu:///system -d Win7TwoDisks\n"
134 " /dev/sda1      1048576         1024K   ok\n"
135 " /dev/sda2    105906176         1024K   ok\n"
136 " /dev/sdb1        65536           64K   ok\n"
137 "\n"
138 msgstr ""
139
140 #. type: textblock
141 #: ../align/virt-alignment-scan.pod:54
142 msgid ""
143 "The output consists of 4 or more whitespace-separated columns.  Only the "
144 "first 4 columns are signficant if you want to parse this from a program.  "
145 "The columns are:"
146 msgstr ""
147
148 #. type: =item
149 #: ../align/virt-alignment-scan.pod:60
150 msgid "col 1"
151 msgstr ""
152
153 #. type: textblock
154 #: ../align/virt-alignment-scan.pod:62
155 msgid ""
156 "the device and partition name (eg. C</dev/sda1> meaning the first partition "
157 "on the first block device)"
158 msgstr ""
159
160 #. type: =item
161 #: ../align/virt-alignment-scan.pod:65
162 msgid "col 2"
163 msgstr ""
164
165 #. type: textblock
166 #: ../align/virt-alignment-scan.pod:67
167 msgid "the start of the partition in bytes"
168 msgstr ""
169
170 #. type: =item
171 #: ../align/virt-alignment-scan.pod:69
172 msgid "col 3"
173 msgstr ""
174
175 #. type: textblock
176 #: ../align/virt-alignment-scan.pod:71
177 msgid "the alignment in bytes or Kbytes (eg. C<512> or C<4K>)"
178 msgstr ""
179
180 #. type: =item
181 #: ../align/virt-alignment-scan.pod:73
182 msgid "col 4"
183 msgstr ""
184
185 #. type: textblock
186 #: ../align/virt-alignment-scan.pod:75
187 msgid ""
188 "C<ok> if the alignment is best for performance, or C<bad> if the alignment "
189 "can cause performance problems"
190 msgstr ""
191
192 #. type: =item
193 #: ../align/virt-alignment-scan.pod:78
194 msgid "cols 5+"
195 msgstr ""
196
197 #. type: textblock
198 #: ../align/virt-alignment-scan.pod:80
199 msgid "optional free-text explanation."
200 msgstr ""
201
202 #. type: textblock
203 #: ../align/virt-alignment-scan.pod:84
204 msgid ""
205 "The exit code from the program changes depending on whether poorly aligned "
206 "partitions were found.  See L</EXIT STATUS> below."
207 msgstr ""
208
209 #. type: textblock
210 #: ../align/virt-alignment-scan.pod:87
211 msgid "If you just want the exit code with no output, use the I<-q> option."
212 msgstr ""
213
214 #. type: =head1
215 #: ../align/virt-alignment-scan.pod:89 ../cat/virt-cat.pod:62 ../cat/virt-filesystems.pod:91 ../cat/virt-ls.pod:261 ../clone/virt-sysprep.pod:42 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62 ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45 ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42 ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:92 ../inspector/virt-inspector.pod:55 ../rescue/virt-rescue.pod:112 ../resize/virt-resize.pod:262 ../sparsify/virt-sparsify.pod:99 ../test-tool/libguestfs-test-tool.pod:36 ../tools/virt-list-filesystems.pl:53 ../tools/virt-list-partitions.pl:54 ../tools/virt-make-fs.pl:153 ../tools/virt-tar.pl:103 ../tools/virt-win-reg.pl:96
216 msgid "OPTIONS"
217 msgstr ""
218
219 #. type: =item
220 #: ../align/virt-alignment-scan.pod:93 ../cat/virt-cat.pod:66 ../cat/virt-filesystems.pod:95 ../cat/virt-ls.pod:265 ../clone/virt-sysprep.pod:46 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66 ../fish/guestfish.pod:152 ../fuse/guestmount.pod:160 ../inspector/virt-inspector.pod:59 ../rescue/virt-rescue.pod:116 ../resize/virt-resize.pod:266 ../sparsify/virt-sparsify.pod:103 ../test-tool/libguestfs-test-tool.pod:40 ../tools/virt-list-filesystems.pl:61 ../tools/virt-list-partitions.pl:62 ../tools/virt-make-fs.pl:161 ../tools/virt-tar.pl:111 ../tools/virt-win-reg.pl:104
221 msgid "B<--help>"
222 msgstr ""
223
224 #. type: textblock
225 #: ../align/virt-alignment-scan.pod:95 ../cat/virt-cat.pod:68 ../cat/virt-filesystems.pod:97 ../cat/virt-ls.pod:267 ../clone/virt-sysprep.pod:48 ../df/virt-df.pod:65 ../edit/virt-edit.pod:68 ../inspector/virt-inspector.pod:61 ../rescue/virt-rescue.pod:118 ../tools/virt-list-filesystems.pl:63 ../tools/virt-list-partitions.pl:64 ../tools/virt-make-fs.pl:163 ../tools/virt-tar.pl:113 ../tools/virt-win-reg.pl:106
226 msgid "Display brief help."
227 msgstr ""
228
229 #. type: =item
230 #: ../align/virt-alignment-scan.pod:97 ../cat/virt-cat.pod:70 ../cat/virt-filesystems.pod:99 ../cat/virt-ls.pod:269 ../clone/virt-sysprep.pod:50 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70 ../inspector/virt-inspector.pod:63 ../rescue/virt-rescue.pod:120
231 msgid "B<-a> file"
232 msgstr ""
233
234 #. type: =item
235 #: ../align/virt-alignment-scan.pod:99 ../cat/virt-cat.pod:72 ../cat/virt-filesystems.pod:101 ../cat/virt-ls.pod:271 ../clone/virt-sysprep.pod:52 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72 ../inspector/virt-inspector.pod:65 ../rescue/virt-rescue.pod:122
236 msgid "B<--add> file"
237 msgstr ""
238
239 #. type: textblock
240 #: ../align/virt-alignment-scan.pod:101 ../clone/virt-sysprep.pod:54
241 msgid "Add I<file> which should be a disk image from a virtual machine."
242 msgstr ""
243
244 #. type: textblock
245 #: ../align/virt-alignment-scan.pod:103 ../cat/virt-cat.pod:78 ../cat/virt-filesystems.pod:107 ../cat/virt-ls.pod:277 ../clone/virt-sysprep.pod:56 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78 ../fish/guestfish.pod:174 ../fuse/guestmount.pod:102 ../inspector/virt-inspector.pod:71 ../rescue/virt-rescue.pod:128
246 msgid ""
247 "The format of the disk image is auto-detected.  To override this and force a "
248 "particular format use the I<--format=..> option."
249 msgstr ""
250
251 #. type: =item
252 #: ../align/virt-alignment-scan.pod:106 ../cat/virt-cat.pod:81 ../cat/virt-filesystems.pod:125 ../cat/virt-ls.pod:291 ../clone/virt-sysprep.pod:59 ../df/virt-df.pod:78 ../rescue/virt-rescue.pod:135
253 msgid "B<-c> URI"
254 msgstr ""
255
256 #. type: =item
257 #: ../align/virt-alignment-scan.pod:108 ../cat/virt-cat.pod:83 ../cat/virt-filesystems.pod:127 ../cat/virt-ls.pod:293 ../clone/virt-sysprep.pod:61 ../df/virt-df.pod:80 ../rescue/virt-rescue.pod:137
258 msgid "B<--connect> URI"
259 msgstr ""
260
261 #. type: textblock
262 #: ../align/virt-alignment-scan.pod:110 ../cat/virt-cat.pod:85 ../cat/virt-filesystems.pod:129 ../cat/virt-ls.pod:295 ../clone/virt-sysprep.pod:63 ../df/virt-df.pod:82 ../edit/virt-edit.pod:99 ../inspector/virt-inspector.pod:78 ../rescue/virt-rescue.pod:139 ../tools/virt-list-filesystems.pl:81 ../tools/virt-list-partitions.pl:82 ../tools/virt-tar.pl:131 ../tools/virt-win-reg.pl:132
263 msgid ""
264 "If using libvirt, connect to the given I<URI>.  If omitted, then we connect "
265 "to the default libvirt hypervisor."
266 msgstr ""
267
268 #. type: textblock
269 #: ../align/virt-alignment-scan.pod:113 ../cat/virt-cat.pod:88 ../cat/virt-filesystems.pod:132 ../cat/virt-ls.pod:298 ../clone/virt-sysprep.pod:66 ../df/virt-df.pod:85 ../rescue/virt-rescue.pod:142
270 msgid ""
271 "If you specify guest block devices directly (I<-a>), then libvirt is not "
272 "used at all."
273 msgstr ""
274
275 #. type: =item
276 #: ../align/virt-alignment-scan.pod:116 ../cat/virt-cat.pod:91 ../cat/virt-filesystems.pod:141 ../cat/virt-ls.pod:307 ../clone/virt-sysprep.pod:69 ../df/virt-df.pod:94 ../edit/virt-edit.pod:105 ../inspector/virt-inspector.pod:85 ../rescue/virt-rescue.pod:145
277 msgid "B<-d> guest"
278 msgstr ""
279
280 #. type: =item
281 #: ../align/virt-alignment-scan.pod:118 ../cat/virt-cat.pod:93 ../cat/virt-filesystems.pod:143 ../cat/virt-ls.pod:309 ../clone/virt-sysprep.pod:71 ../df/virt-df.pod:96 ../edit/virt-edit.pod:107 ../inspector/virt-inspector.pod:87 ../rescue/virt-rescue.pod:147
282 msgid "B<--domain> guest"
283 msgstr ""
284
285 #. type: textblock
286 #: ../align/virt-alignment-scan.pod:120 ../cat/virt-cat.pod:95 ../cat/virt-filesystems.pod:145 ../cat/virt-ls.pod:311 ../clone/virt-sysprep.pod:73 ../df/virt-df.pod:98 ../edit/virt-edit.pod:109 ../inspector/virt-inspector.pod:89 ../rescue/virt-rescue.pod:149
287 msgid ""
288 "Add all the disks from the named libvirt guest.  Domain UUIDs can be used "
289 "instead of names."
290 msgstr ""
291
292 #. type: =item
293 #: ../align/virt-alignment-scan.pod:123 ../cat/virt-cat.pod:105 ../cat/virt-filesystems.pod:170 ../cat/virt-ls.pod:328 ../clone/virt-sysprep.pod:95 ../df/virt-df.pod:101 ../fish/guestfish.pod:233 ../fuse/guestmount.pod:142 ../inspector/virt-inspector.pod:99 ../rescue/virt-rescue.pod:152
294 msgid "B<--format=raw|qcow2|..>"
295 msgstr ""
296
297 #. type: =item
298 #: ../align/virt-alignment-scan.pod:125 ../cat/virt-cat.pod:107 ../cat/virt-filesystems.pod:172 ../cat/virt-ls.pod:330 ../clone/virt-sysprep.pod:97 ../df/virt-df.pod:103 ../edit/virt-edit.pod:134 ../fish/guestfish.pod:235 ../fuse/guestmount.pod:144 ../inspector/virt-inspector.pod:101 ../rescue/virt-rescue.pod:154
299 msgid "B<--format>"
300 msgstr ""
301
302 #. type: textblock
303 #: ../align/virt-alignment-scan.pod:127 ../cat/virt-cat.pod:109 ../cat/virt-filesystems.pod:174 ../cat/virt-ls.pod:332 ../clone/virt-sysprep.pod:99 ../df/virt-df.pod:105 ../edit/virt-edit.pod:136 ../fish/guestfish.pod:237 ../fuse/guestmount.pod:146 ../rescue/virt-rescue.pod:156
304 msgid ""
305 "The default for the I<-a> option is to auto-detect the format of the disk "
306 "image.  Using this forces the disk format for I<-a> options which follow on "
307 "the command line.  Using I<--format> with no argument switches back to "
308 "auto-detection for subsequent I<-a> options."
309 msgstr ""
310
311 #. type: textblock
312 #: ../align/virt-alignment-scan.pod:132 ../cat/virt-cat.pod:114 ../cat/virt-filesystems.pod:179 ../cat/virt-ls.pod:337 ../clone/virt-sysprep.pod:104 ../df/virt-df.pod:110 ../edit/virt-edit.pod:141 ../fish/guestfish.pod:242 ../fish/guestfish.pod:673 ../inspector/virt-inspector.pod:351 ../rescue/virt-rescue.pod:161 ../src/guestfs.pod:2877
313 msgid "For example:"
314 msgstr ""
315
316 #. type: verbatim
317 #: ../align/virt-alignment-scan.pod:134
318 #, no-wrap
319 msgid ""
320 " virt-alignment-scan --format=raw -a disk.img\n"
321 "\n"
322 msgstr ""
323
324 #. type: textblock
325 #: ../align/virt-alignment-scan.pod:136 ../cat/virt-cat.pod:118 ../cat/virt-filesystems.pod:183 ../cat/virt-ls.pod:341 ../clone/virt-sysprep.pod:108 ../df/virt-df.pod:114 ../edit/virt-edit.pod:145 ../fish/guestfish.pod:246 ../rescue/virt-rescue.pod:165
326 msgid "forces raw format (no auto-detection) for C<disk.img>."
327 msgstr ""
328
329 #. type: verbatim
330 #: ../align/virt-alignment-scan.pod:138
331 #, no-wrap
332 msgid ""
333 " virt-alignment-scan --format=raw -a disk.img --format -a another.img\n"
334 "\n"
335 msgstr ""
336
337 #. type: textblock
338 #: ../align/virt-alignment-scan.pod:140 ../cat/virt-cat.pod:122 ../cat/virt-filesystems.pod:187 ../cat/virt-ls.pod:345 ../clone/virt-sysprep.pod:112 ../df/virt-df.pod:118 ../edit/virt-edit.pod:149 ../fish/guestfish.pod:250 ../rescue/virt-rescue.pod:169
339 msgid ""
340 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
341 "auto-detection for C<another.img>."
342 msgstr ""
343
344 #. type: textblock
345 #: ../align/virt-alignment-scan.pod:143 ../cat/virt-cat.pod:125 ../cat/virt-filesystems.pod:190 ../cat/virt-ls.pod:348 ../clone/virt-sysprep.pod:115 ../df/virt-df.pod:121 ../edit/virt-edit.pod:152 ../rescue/virt-rescue.pod:172
346 msgid ""
347 "If you have untrusted raw-format guest disk images, you should use this "
348 "option to specify the disk format.  This avoids a possible security problem "
349 "with malicious guests (CVE-2010-3851)."
350 msgstr ""
351
352 #. type: =item
353 #: ../align/virt-alignment-scan.pod:147 ../resize/virt-resize.pod:491 ../sparsify/virt-sparsify.pod:153
354 msgid "B<-q>"
355 msgstr ""
356
357 #. type: =item
358 #: ../align/virt-alignment-scan.pod:149 ../resize/virt-resize.pod:493 ../sparsify/virt-sparsify.pod:155
359 msgid "B<--quiet>"
360 msgstr ""
361
362 #. type: textblock
363 #: ../align/virt-alignment-scan.pod:151
364 msgid ""
365 "Don't produce any output.  Just set the exit code (see L</EXIT STATUS> "
366 "below)."
367 msgstr ""
368
369 #. type: =item
370 #: ../align/virt-alignment-scan.pod:154 ../cat/virt-cat.pod:134 ../cat/virt-filesystems.pod:261 ../cat/virt-ls.pod:425 ../clone/virt-sysprep.pod:138 ../df/virt-df.pod:173 ../edit/virt-edit.pod:161 ../fish/guestfish.pod:390 ../fuse/guestmount.pod:266 ../inspector/virt-inspector.pod:119 ../rescue/virt-rescue.pod:219 ../sparsify/virt-sparsify.pod:159
371 msgid "B<-v>"
372 msgstr ""
373
374 #. type: =item
375 #: ../align/virt-alignment-scan.pod:156 ../cat/virt-cat.pod:136 ../cat/virt-filesystems.pod:263 ../cat/virt-ls.pod:427 ../clone/virt-sysprep.pod:140 ../df/virt-df.pod:175 ../edit/virt-edit.pod:163 ../fish/guestfish.pod:392 ../fuse/guestmount.pod:268 ../inspector/virt-inspector.pod:121 ../rescue/virt-rescue.pod:221 ../sparsify/virt-sparsify.pod:161
376 msgid "B<--verbose>"
377 msgstr ""
378
379 #. type: textblock
380 #: ../align/virt-alignment-scan.pod:158 ../cat/virt-cat.pod:138 ../cat/virt-filesystems.pod:265 ../cat/virt-ls.pod:429 ../clone/virt-sysprep.pod:142 ../df/virt-df.pod:177 ../edit/virt-edit.pod:165 ../inspector/virt-inspector.pod:123 ../rescue/virt-rescue.pod:223 ../sparsify/virt-sparsify.pod:163
381 msgid "Enable verbose messages for debugging."
382 msgstr ""
383
384 #. type: =item
385 #: ../align/virt-alignment-scan.pod:160 ../cat/virt-cat.pod:140 ../cat/virt-filesystems.pod:267 ../cat/virt-ls.pod:431 ../clone/virt-sysprep.pod:144 ../df/virt-df.pod:179 ../edit/virt-edit.pod:167 ../fish/guestfish.pod:397 ../fuse/guestmount.pod:272 ../inspector/virt-inspector.pod:125 ../rescue/virt-rescue.pod:225 ../resize/virt-resize.pod:561 ../sparsify/virt-sparsify.pod:165
386 msgid "B<-V>"
387 msgstr ""
388
389 #. type: =item
390 #: ../align/virt-alignment-scan.pod:162 ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269 ../cat/virt-ls.pod:433 ../clone/virt-sysprep.pod:146 ../df/virt-df.pod:181 ../edit/virt-edit.pod:169 ../fish/guestfish.pod:399 ../fuse/guestmount.pod:274 ../inspector/virt-inspector.pod:127 ../rescue/virt-rescue.pod:227 ../resize/virt-resize.pod:563 ../sparsify/virt-sparsify.pod:167 ../tools/virt-list-filesystems.pl:69 ../tools/virt-list-partitions.pl:70 ../tools/virt-make-fs.pl:169 ../tools/virt-tar.pl:119 ../tools/virt-win-reg.pl:112
391 msgid "B<--version>"
392 msgstr ""
393
394 #. type: textblock
395 #: ../align/virt-alignment-scan.pod:164 ../cat/virt-cat.pod:144 ../cat/virt-filesystems.pod:271 ../cat/virt-ls.pod:435 ../clone/virt-sysprep.pod:148 ../df/virt-df.pod:183 ../edit/virt-edit.pod:171 ../inspector/virt-inspector.pod:129 ../rescue/virt-rescue.pod:229 ../resize/virt-resize.pod:565 ../sparsify/virt-sparsify.pod:169 ../tools/virt-list-filesystems.pl:71 ../tools/virt-list-partitions.pl:72 ../tools/virt-make-fs.pl:171 ../tools/virt-tar.pl:121 ../tools/virt-win-reg.pl:114
396 msgid "Display version number and exit."
397 msgstr ""
398
399 #. type: =item
400 #: ../align/virt-alignment-scan.pod:166 ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281 ../cat/virt-ls.pod:437 ../clone/virt-sysprep.pod:150 ../df/virt-df.pod:185 ../edit/virt-edit.pod:173 ../fish/guestfish.pod:412 ../fuse/guestmount.pod:287 ../inspector/virt-inspector.pod:131 ../rescue/virt-rescue.pod:240 ../sparsify/virt-sparsify.pod:171 ../tools/virt-tar.pl:158
401 msgid "B<-x>"
402 msgstr ""
403
404 #. type: textblock
405 #: ../align/virt-alignment-scan.pod:168 ../cat/virt-cat.pod:148 ../cat/virt-filesystems.pod:283 ../cat/virt-ls.pod:439 ../clone/virt-sysprep.pod:152 ../df/virt-df.pod:187 ../edit/virt-edit.pod:175 ../inspector/virt-inspector.pod:133 ../rescue/virt-rescue.pod:242 ../sparsify/virt-sparsify.pod:173
406 msgid "Enable tracing of libguestfs API calls."
407 msgstr ""
408
409 #. type: =head1
410 #: ../align/virt-alignment-scan.pod:172
411 msgid "RECOMMENDED ALIGNMENT"
412 msgstr ""
413
414 #. type: textblock
415 #: ../align/virt-alignment-scan.pod:174
416 msgid ""
417 "Operating systems older than Windows 2008 and Linux before ca.2010 place the "
418 "first sector of the first partition at sector 63, with a 512 byte sector "
419 "size.  This happens because of a historical accident.  Drives have to report "
420 "a cylinder / head / sector (CHS) geometry to the BIOS.  The geometry is "
421 "completely meaningless on modern drives, but it happens that the geometry "
422 "reported always has 63 sectors per track.  The operating system therefore "
423 "places the first partition at the start of the second \"track\", at sector "
424 "63."
425 msgstr ""
426
427 #. type: textblock
428 #: ../align/virt-alignment-scan.pod:183
429 msgid ""
430 "When the guest OS is virtualized, the host operating system and hypervisor "
431 "may prefer accesses aligned to one of:"
432 msgstr ""
433
434 #. type: =item
435 #: ../align/virt-alignment-scan.pod:188
436 msgid "* 512 bytes"
437 msgstr ""
438
439 #. type: textblock
440 #: ../align/virt-alignment-scan.pod:190
441 msgid ""
442 "if the host OS uses local storage directly on hard drive partitions, and the "
443 "hard drive has 512 byte physical sectors."
444 msgstr ""
445
446 #. type: =item
447 #: ../align/virt-alignment-scan.pod:193
448 msgid "* 4 Kbytes"
449 msgstr ""
450
451 #. type: textblock
452 #: ../align/virt-alignment-scan.pod:195
453 msgid ""
454 "for local storage on new hard drives with 4Kbyte physical sectors; for "
455 "file-backed storage on filesystems with 4Kbyte block size; or for some types "
456 "of network-attached storage."
457 msgstr ""
458
459 #. type: =item
460 #: ../align/virt-alignment-scan.pod:199
461 msgid "* 64 Kbytes"
462 msgstr ""
463
464 #. type: textblock
465 #: ../align/virt-alignment-scan.pod:201
466 msgid ""
467 "for high-end network-attached storage.  This is the optimal block size for "
468 "some NetApp hardware."
469 msgstr ""
470
471 #. type: =item
472 #: ../align/virt-alignment-scan.pod:204
473 msgid "* 1 Mbyte"
474 msgstr ""
475
476 #. type: textblock
477 #: ../align/virt-alignment-scan.pod:206
478 msgid "see L</1 MB PARTITION ALIGNMENT> below."
479 msgstr ""
480
481 #. type: textblock
482 #: ../align/virt-alignment-scan.pod:210
483 msgid ""
484 "Partitions which are not aligned correctly to the underlying storage cause "
485 "extra I/O.  For example:"
486 msgstr ""
487
488 #. type: verbatim
489 #: ../align/virt-alignment-scan.pod:213
490 #, no-wrap
491 msgid ""
492 "                       sect#63\n"
493 "                       +--------------------------+------\n"
494 "                       |         guest            |\n"
495 "                       |    filesystem block      |\n"
496 " ---+------------------+------+-------------------+-----+---\n"
497 "    |  host block             |  host block             |\n"
498 "    |                         |                         |\n"
499 " ---+-------------------------+-------------------------+---\n"
500 "\n"
501 msgstr ""
502
503 #. type: textblock
504 #: ../align/virt-alignment-scan.pod:222
505 msgid ""
506 "In this example, each time a 4K guest block is read, two blocks on the host "
507 "must be accessed (so twice as much I/O is done).  When a 4K guest block is "
508 "written, two host blocks must first be read, the old and new data combined, "
509 "and the two blocks written back (4x I/O)."
510 msgstr ""
511
512 #. type: =head2
513 #: ../align/virt-alignment-scan.pod:227
514 msgid "LINUX HOST BLOCK AND I/O SIZE"
515 msgstr ""
516
517 #. type: textblock
518 #: ../align/virt-alignment-scan.pod:229
519 msgid ""
520 "New versions of the Linux kernel expose the physical and logical block size, "
521 "and minimum and recommended I/O size."
522 msgstr ""
523
524 #. type: textblock
525 #: ../align/virt-alignment-scan.pod:232
526 msgid "For a typical consumer hard drive with 512 byte sectors:"
527 msgstr ""
528
529 #. type: verbatim
530 #: ../align/virt-alignment-scan.pod:234
531 #, no-wrap
532 msgid ""
533 " $ cat /sys/block/sda/queue/hw_sector_size\n"
534 " 512\n"
535 " $ cat /sys/block/sda/queue/physical_block_size\n"
536 " 512\n"
537 " $ cat /sys/block/sda/queue/logical_block_size\n"
538 " 512\n"
539 " $ cat /sys/block/sda/queue/minimum_io_size\n"
540 " 512\n"
541 " $ cat /sys/block/sda/queue/optimal_io_size\n"
542 " 0\n"
543 "\n"
544 msgstr ""
545
546 #. type: textblock
547 #: ../align/virt-alignment-scan.pod:245
548 msgid "For a new consumer hard drive with 4Kbyte sectors:"
549 msgstr ""
550
551 #. type: verbatim
552 #: ../align/virt-alignment-scan.pod:247
553 #, no-wrap
554 msgid ""
555 " $ cat /sys/block/sda/queue/hw_sector_size\n"
556 " 4096\n"
557 " $ cat /sys/block/sda/queue/physical_block_size\n"
558 " 4096\n"
559 " $ cat /sys/block/sda/queue/logical_block_size\n"
560 " 4096\n"
561 " $ cat /sys/block/sda/queue/minimum_io_size\n"
562 " 4096\n"
563 " $ cat /sys/block/sda/queue/optimal_io_size\n"
564 " 0\n"
565 "\n"
566 msgstr ""
567
568 #. type: textblock
569 #: ../align/virt-alignment-scan.pod:258
570 msgid "For a NetApp LUN:"
571 msgstr ""
572
573 #. type: verbatim
574 #: ../align/virt-alignment-scan.pod:260
575 #, no-wrap
576 msgid ""
577 " $ cat /sys/block/sdc/queue/logical_block_size\n"
578 " 512\n"
579 " $ cat /sys/block/sdc/queue/physical_block_size\n"
580 " 512\n"
581 " $ cat /sys/block/sdc/queue/minimum_io_size\n"
582 " 4096\n"
583 " $ cat /sys/block/sdc/queue/optimal_io_size\n"
584 " 65536\n"
585 "\n"
586 msgstr ""
587
588 #. type: textblock
589 #: ../align/virt-alignment-scan.pod:269
590 msgid ""
591 "The NetApp allows 512 byte accesses (but they will be very inefficient), "
592 "prefers a minimum 4K I/O size, but the optimal I/O size is 64K."
593 msgstr ""
594
595 #. type: textblock
596 #: ../align/virt-alignment-scan.pod:273
597 msgid ""
598 "For detailed information about what these numbers mean, see "
599 "L<http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/Storage_Administration_Guide/newstorage-iolimits.html>"
600 msgstr ""
601
602 #. type: textblock
603 #: ../align/virt-alignment-scan.pod:276
604 msgid ""
605 "[Thanks to Matt Booth for providing 4K drive data.  Thanks to Mike Snitzer "
606 "for providing NetApp data and additional information.]"
607 msgstr ""
608
609 #. type: =head2
610 #: ../align/virt-alignment-scan.pod:279
611 msgid "1 MB PARTITION ALIGNMENT"
612 msgstr ""
613
614 #. type: textblock
615 #: ../align/virt-alignment-scan.pod:281
616 msgid ""
617 "Microsoft picked 1 MB as the default alignment for all partitions starting "
618 "with Windows 2008 Server, and Linux has followed this."
619 msgstr ""
620
621 #. type: textblock
622 #: ../align/virt-alignment-scan.pod:284
623 msgid ""
624 "Assuming 512 byte sectors in the guest, you will now see the first partition "
625 "starting at sector 2048, and subsequent partitions (if any)  will start at a "
626 "multiple of 2048 sectors."
627 msgstr ""
628
629 #. type: textblock
630 #: ../align/virt-alignment-scan.pod:288
631 msgid ""
632 "1 MB alignment is compatible with all current alignment requirements (4K, "
633 "64K) and provides room for future growth in physical block sizes."
634 msgstr ""
635
636 #. type: =head2
637 #: ../align/virt-alignment-scan.pod:291
638 msgid "SETTING ALIGNMENT"
639 msgstr ""
640
641 #. type: textblock
642 #: ../align/virt-alignment-scan.pod:293
643 msgid ""
644 "L<virt-resize(1)> can change the alignment of the partitions of some "
645 "guests.  Currently it can fully align all the partitions of all Windows "
646 "guests, and it will fix the bootloader where necessary.  For Linux guests, "
647 "it can align the second and subsequent partitions, so the majority of OS "
648 "accesses except at boot will be aligned."
649 msgstr ""
650
651 #. type: textblock
652 #: ../align/virt-alignment-scan.pod:299
653 msgid ""
654 "Another way to correct partition alignment problems is to reinstall your "
655 "guest operating systems.  If you install operating systems from templates, "
656 "ensure these have correct partition alignment too."
657 msgstr ""
658
659 #. type: textblock
660 #: ../align/virt-alignment-scan.pod:303
661 msgid ""
662 "For older versions of Windows, the following NetApp document contains useful "
663 "information: L<http://media.netapp.com/documents/tr-3747.pdf>"
664 msgstr ""
665
666 #. type: textblock
667 #: ../align/virt-alignment-scan.pod:306
668 msgid ""
669 "For Red Hat Enterprise Linux E<le> 5, use a Kickstart script that contains "
670 "an explicit C<%pre> section that creates aligned partitions using "
671 "L<parted(8)>.  Do not use the Kickstart C<part> command.  The NetApp "
672 "document above contains an example."
673 msgstr ""
674
675 #. type: =head1
676 #: ../align/virt-alignment-scan.pod:311 ../cat/virt-cat.pod:231 ../cat/virt-filesystems.pod:373 ../cat/virt-ls.pod:483 ../clone/virt-sysprep.pod:475 ../df/virt-df.pod:215 ../edit/virt-edit.pod:342 ../inspector/virt-inspector.pod:367 ../rescue/virt-rescue.pod:303 ../resize/virt-resize.pod:676 ../tools/virt-list-filesystems.pl:188 ../tools/virt-list-partitions.pl:258 ../tools/virt-make-fs.pl:550 ../tools/virt-tar.pl:289 ../tools/virt-win-reg.pl:744
677 msgid "SHELL QUOTING"
678 msgstr ""
679
680 #. type: textblock
681 #: ../align/virt-alignment-scan.pod:313 ../cat/virt-cat.pod:233 ../cat/virt-filesystems.pod:375 ../cat/virt-ls.pod:485 ../clone/virt-sysprep.pod:477 ../df/virt-df.pod:217 ../edit/virt-edit.pod:344 ../inspector/virt-inspector.pod:369 ../rescue/virt-rescue.pod:305 ../resize/virt-resize.pod:678 ../tools/virt-list-filesystems.pl:190 ../tools/virt-list-partitions.pl:260 ../tools/virt-make-fs.pl:552 ../tools/virt-tar.pl:291 ../tools/virt-win-reg.pl:752
682 msgid ""
683 "Libvirt guest names can contain arbitrary characters, some of which have "
684 "meaning to the shell such as C<#> and space.  You may need to quote or "
685 "escape these characters on the command line.  See the shell manual page "
686 "L<sh(1)> for details."
687 msgstr ""
688
689 #. type: =head1
690 #: ../align/virt-alignment-scan.pod:318 ../cat/virt-cat.pod:238 ../cat/virt-filesystems.pod:380 ../cat/virt-ls.pod:490 ../clone/virt-sysprep.pod:482 ../df/virt-df.pod:222 ../edit/virt-edit.pod:349 ../fish/guestfish.pod:1114 ../fuse/guestmount.pod:312 ../inspector/virt-inspector.pod:390 ../resize/virt-resize.pod:683 ../sparsify/virt-sparsify.pod:227 ../test-tool/libguestfs-test-tool.pod:90
691 msgid "EXIT STATUS"
692 msgstr ""
693
694 #. type: textblock
695 #: ../align/virt-alignment-scan.pod:320
696 msgid "This program returns:"
697 msgstr ""
698
699 #. type: =item
700 #: ../align/virt-alignment-scan.pod:324 ../align/virt-alignment-scan.pod:330 ../align/virt-alignment-scan.pod:336 ../align/virt-alignment-scan.pod:343 ../cat/virt-cat.pod:177 ../cat/virt-cat.pod:182 ../cat/virt-cat.pod:187 ../cat/virt-cat.pod:198 ../cat/virt-cat.pod:202 ../clone/virt-sysprep.pod:283 ../clone/virt-sysprep.pod:287 ../clone/virt-sysprep.pod:291 ../clone/virt-sysprep.pod:295 ../clone/virt-sysprep.pod:310 ../clone/virt-sysprep.pod:314 ../clone/virt-sysprep.pod:318 ../clone/virt-sysprep.pod:322 ../clone/virt-sysprep.pod:326 ../clone/virt-sysprep.pod:362 ../clone/virt-sysprep.pod:384 ../clone/virt-sysprep.pod:388 ../df/virt-df.pod:148 ../df/virt-df.pod:154 ../edit/virt-edit.pod:266 ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276 ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291 ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102 ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132 ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227 ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235 ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:441 ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:1262 ../fish/guestfish-actions.pod:1266 ../fish/guestfish-actions.pod:1270 ../fish/guestfish-actions.pod:1274 ../fish/guestfish-actions.pod:1282 ../fish/guestfish-actions.pod:1286 ../fish/guestfish-actions.pod:1290 ../fish/guestfish-actions.pod:1300 ../fish/guestfish-actions.pod:1304 ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1398 ../fish/guestfish-actions.pod:1402 ../fish/guestfish-actions.pod:1407 ../fish/guestfish-actions.pod:1412 ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:1458 ../fish/guestfish-actions.pod:1463 ../fish/guestfish-actions.pod:1719 ../fish/guestfish-actions.pod:1726 ../fish/guestfish-actions.pod:1733 ../fish/guestfish-actions.pod:2136 ../fish/guestfish-actions.pod:2142 ../fish/guestfish-actions.pod:2150 ../fish/guestfish-actions.pod:2157 ../fish/guestfish-actions.pod:2164 ../fish/guestfish.pod:445 ../fish/guestfish.pod:449 ../fish/guestfish.pod:453 ../fish/guestfish.pod:457 ../inspector/virt-inspector.pod:408 ../inspector/virt-inspector.pod:412 ../resize/virt-resize.pod:359 ../resize/virt-resize.pod:363 ../resize/virt-resize.pod:372 ../resize/virt-resize.pod:378 ../sparsify/virt-sparsify.pod:32 ../sparsify/virt-sparsify.pod:39 ../sparsify/virt-sparsify.pod:43 ../sparsify/virt-sparsify.pod:49 ../sparsify/virt-sparsify.pod:54 ../sparsify/virt-sparsify.pod:58 ../sparsify/virt-sparsify.pod:64 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:641 ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:656 ../src/guestfs-actions.pod:663 ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2091 ../src/guestfs-actions.pod:2099 ../src/guestfs-actions.pod:2103 ../src/guestfs-actions.pod:2107 ../src/guestfs-actions.pod:2117 ../src/guestfs-actions.pod:2121 ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:2263 ../src/guestfs-actions.pod:2267 ../src/guestfs-actions.pod:2272 ../src/guestfs-actions.pod:2277 ../src/guestfs-actions.pod:2338 ../src/guestfs-actions.pod:2342 ../src/guestfs-actions.pod:2347 ../src/guestfs-actions.pod:2762 ../src/guestfs-actions.pod:2769 ../src/guestfs-actions.pod:2776 ../src/guestfs-actions.pod:3321 ../src/guestfs-actions.pod:3327 ../src/guestfs-actions.pod:3335 ../src/guestfs-actions.pod:3342 ../src/guestfs-actions.pod:3349 ../src/guestfs.pod:403 ../src/guestfs.pod:408 ../src/guestfs.pod:413 ../src/guestfs.pod:417 ../src/guestfs.pod:422 ../src/guestfs.pod:426 ../src/guestfs.pod:431 ../src/guestfs.pod:436 ../src/guestfs.pod:1109 ../src/guestfs.pod:1113 ../src/guestfs.pod:1117 ../src/guestfs.pod:1122 ../src/guestfs.pod:1130 ../src/guestfs.pod:1149 ../src/guestfs.pod:1157 ../src/guestfs.pod:1179 ../src/guestfs.pod:1183 ../src/guestfs.pod:1187 ../src/guestfs.pod:1191 ../src/guestfs.pod:1195 ../src/guestfs.pod:1199 ../src/guestfs.pod:1689 ../src/guestfs.pod:1694 ../src/guestfs.pod:1698 ../src/guestfs.pod:1800 ../src/guestfs.pod:1805 ../src/guestfs.pod:1809 ../src/guestfs.pod:1819 ../src/guestfs.pod:2108 ../src/guestfs.pod:2113 ../src/guestfs.pod:2119 ../src/guestfs.pod:2127 ../src/guestfs.pod:2645 ../src/guestfs.pod:2651 ../src/guestfs.pod:2656 ../src/guestfs.pod:2662 ../src/guestfs.pod:3062 ../src/guestfs.pod:3067 ../src/guestfs.pod:3071 ../src/guestfs.pod:3075 ../src/guestfs.pod:3079 ../src/guestfs.pod:3093 ../src/guestfs.pod:3098 ../src/guestfs.pod:3329 ../src/guestfs.pod:3333 ../src/guestfs.pod:3337 ../src/guestfs.pod:3341 ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202 ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:721 ../tools/virt-win-reg.pl:727 ../tools/virt-win-reg.pl:733
701 msgid "*"
702 msgstr ""
703
704 #. type: textblock
705 #: ../align/virt-alignment-scan.pod:326
706 msgid "0"
707 msgstr ""
708
709 #. type: textblock
710 #: ../align/virt-alignment-scan.pod:328
711 msgid "successful exit, all partitions are aligned E<ge> 64K for best performance"
712 msgstr ""
713
714 #. type: textblock
715 #: ../align/virt-alignment-scan.pod:332
716 msgid "1"
717 msgstr ""
718
719 #. type: textblock
720 #: ../align/virt-alignment-scan.pod:334
721 msgid "an error scanning the disk image or guest"
722 msgstr ""
723
724 #. type: textblock
725 #: ../align/virt-alignment-scan.pod:338
726 msgid "2"
727 msgstr ""
728
729 #. type: textblock
730 #: ../align/virt-alignment-scan.pod:340
731 msgid ""
732 "successful exit, some partitions have alignment E<lt> 64K which can result "
733 "in poor performance on high end network storage"
734 msgstr ""
735
736 #. type: textblock
737 #: ../align/virt-alignment-scan.pod:345
738 msgid "3"
739 msgstr ""
740
741 #. type: textblock
742 #: ../align/virt-alignment-scan.pod:347
743 msgid ""
744 "successful exit, some partitions have alignment E<lt> 4K which can result in "
745 "poor performance on most hypervisors"
746 msgstr ""
747
748 #. type: =head1
749 #: ../align/virt-alignment-scan.pod:352 ../cat/virt-cat.pod:243 ../cat/virt-filesystems.pod:385 ../cat/virt-ls.pod:495 ../clone/virt-sysprep.pod:486 ../df/virt-df.pod:227 ../edit/virt-edit.pod:354 ../erlang/examples/guestfs-erlang.pod:97 ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384 ../fish/guestfish.pod:1268 ../fish/virt-copy-in.pod:50 ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47 ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:317 ../inspector/virt-inspector.pod:395 ../java/examples/guestfs-java.pod:45 ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39 ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:325 ../resize/virt-resize.pod:688 ../ruby/examples/guestfs-ruby.pod:36 ../sparsify/virt-sparsify.pod:251 ../src/guestfs.pod:3270 ../test-tool/libguestfs-test-tool.pod:100 ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265 ../tools/virt-make-fs.pl:557 ../tools/virt-tar.pl:296 ../tools/virt-win-reg.pl:757
750 msgid "SEE ALSO"
751 msgstr ""
752
753 #. type: textblock
754 #: ../align/virt-alignment-scan.pod:354
755 msgid ""
756 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-rescue(1)>, "
757 "L<virt-resize(1)>, L<http://libguestfs.org/>."
758 msgstr ""
759
760 #. type: =head1
761 #: ../align/virt-alignment-scan.pod:361 ../cat/virt-cat.pod:252 ../cat/virt-filesystems.pod:396 ../cat/virt-ls.pod:507 ../clone/virt-sysprep.pod:501 ../df/virt-df.pod:235 ../edit/virt-edit.pod:368 ../rescue/virt-rescue.pod:334 ../resize/virt-resize.pod:711 ../sparsify/virt-sparsify.pod:264 ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277 ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:311 ../tools/virt-win-reg.pl:783
762 msgid "AUTHOR"
763 msgstr ""
764
765 #. type: textblock
766 #: ../align/virt-alignment-scan.pod:363 ../cat/virt-cat.pod:254 ../cat/virt-filesystems.pod:398 ../cat/virt-ls.pod:509 ../clone/virt-sysprep.pod:503 ../df/virt-df.pod:237 ../edit/virt-edit.pod:370 ../inspector/virt-inspector.pod:410 ../rescue/virt-rescue.pod:336 ../resize/virt-resize.pod:713 ../sparsify/virt-sparsify.pod:266 ../tools/virt-list-filesystems.pl:210 ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:584 ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:785
767 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
768 msgstr ""
769
770 #. type: =head1
771 #: ../align/virt-alignment-scan.pod:365 ../cat/virt-cat.pod:256 ../cat/virt-filesystems.pod:400 ../cat/virt-ls.pod:511 ../clone/virt-sysprep.pod:505 ../df/virt-df.pod:239 ../edit/virt-edit.pod:372 ../erlang/examples/guestfs-erlang.pod:114 ../examples/guestfs-examples.pod:49 ../examples/guestfs-recipes.pod:401 ../fish/guestfish.pod:1300 ../fish/virt-copy-in.pod:64 ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62 ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:332 ../inspector/virt-inspector.pod:418 ../java/examples/guestfs-java.pod:62 ../ocaml/examples/guestfs-ocaml.pod:95 ../perl/examples/guestfs-perl.pod:56 ../python/examples/guestfs-python.pod:58 ../rescue/virt-rescue.pod:338 ../resize/virt-resize.pod:715 ../ruby/examples/guestfs-ruby.pod:52 ../sparsify/virt-sparsify.pod:268 ../src/guestfs.pod:3352 ../test-tool/libguestfs-test-tool.pod:110 ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281 ../tools/virt-make-fs.pl:586 ../tools/virt-tar.pl:315 ../tools/virt-win-reg.pl:787
772 msgid "COPYRIGHT"
773 msgstr ""
774
775 #. type: textblock
776 #: ../align/virt-alignment-scan.pod:367 ../clone/virt-sysprep.pod:507 ../sparsify/virt-sparsify.pod:270
777 msgid "Copyright (C) 2011 Red Hat Inc."
778 msgstr ""
779
780 #. type: textblock
781 #: ../align/virt-alignment-scan.pod:369 ../cat/virt-cat.pod:260 ../cat/virt-filesystems.pod:404 ../cat/virt-ls.pod:515 ../clone/virt-sysprep.pod:509 ../df/virt-df.pod:243 ../edit/virt-edit.pod:376 ../fish/guestfish.pod:1305 ../fish/virt-copy-in.pod:69 ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67 ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:337 ../inspector/virt-inspector.pod:422 ../rescue/virt-rescue.pod:342 ../resize/virt-resize.pod:719 ../sparsify/virt-sparsify.pod:272 ../test-tool/libguestfs-test-tool.pod:115 ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285 ../tools/virt-make-fs.pl:590 ../tools/virt-tar.pl:319 ../tools/virt-win-reg.pl:791
782 msgid ""
783 "This program is free software; you can redistribute it and/or modify it "
784 "under the terms of the GNU General Public License as published by the Free "
785 "Software Foundation; either version 2 of the License, or (at your option) "
786 "any later version."
787 msgstr ""
788
789 #. type: textblock
790 #: ../align/virt-alignment-scan.pod:374 ../cat/virt-cat.pod:265 ../cat/virt-filesystems.pod:409 ../cat/virt-ls.pod:520 ../clone/virt-sysprep.pod:514 ../df/virt-df.pod:248 ../edit/virt-edit.pod:381 ../fish/guestfish.pod:1310 ../fish/virt-copy-in.pod:74 ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72 ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:342 ../inspector/virt-inspector.pod:427 ../rescue/virt-rescue.pod:347 ../resize/virt-resize.pod:724 ../sparsify/virt-sparsify.pod:277 ../test-tool/libguestfs-test-tool.pod:120 ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290 ../tools/virt-make-fs.pl:595 ../tools/virt-tar.pl:324 ../tools/virt-win-reg.pl:796
791 msgid ""
792 "This program is distributed in the hope that it will be useful, but WITHOUT "
793 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
794 "FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for "
795 "more details."
796 msgstr ""
797
798 #. type: textblock
799 #: ../align/virt-alignment-scan.pod:379 ../cat/virt-cat.pod:270 ../cat/virt-filesystems.pod:414 ../cat/virt-ls.pod:525 ../clone/virt-sysprep.pod:519 ../df/virt-df.pod:253 ../edit/virt-edit.pod:386 ../fish/guestfish.pod:1315 ../fish/virt-copy-in.pod:79 ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77 ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:347 ../inspector/virt-inspector.pod:432 ../rescue/virt-rescue.pod:352 ../resize/virt-resize.pod:729 ../sparsify/virt-sparsify.pod:282 ../test-tool/libguestfs-test-tool.pod:125 ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295 ../tools/virt-make-fs.pl:600 ../tools/virt-tar.pl:329 ../tools/virt-win-reg.pl:801
800 msgid ""
801 "You should have received a copy of the GNU General Public License along with "
802 "this program; if not, write to the Free Software Foundation, Inc., 51 "
803 "Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA."
804 msgstr ""
805
806 #. type: textblock
807 #: ../cat/virt-cat.pod:5
808 msgid "virt-cat - Display files in a virtual machine"
809 msgstr ""
810
811 #. type: verbatim
812 #: ../cat/virt-cat.pod:9
813 #, no-wrap
814 msgid ""
815 " virt-cat [--options] -d domname file [file ...]\n"
816 "\n"
817 msgstr ""
818
819 #. type: verbatim
820 #: ../cat/virt-cat.pod:11
821 #, no-wrap
822 msgid ""
823 " virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
824 "\n"
825 msgstr ""
826
827 #. type: textblock
828 #: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15 ../inspector/virt-inspector.pod:13
829 msgid "Old-style:"
830 msgstr ""
831
832 #. type: verbatim
833 #: ../cat/virt-cat.pod:15
834 #, no-wrap
835 msgid ""
836 " virt-cat domname file\n"
837 "\n"
838 msgstr ""
839
840 #. type: verbatim
841 #: ../cat/virt-cat.pod:17
842 #, no-wrap
843 msgid ""
844 " virt-cat disk.img file\n"
845 "\n"
846 msgstr ""
847
848 #. type: textblock
849 #: ../cat/virt-cat.pod:21
850 msgid ""
851 "C<virt-cat> is a command line tool to display the contents of C<file> where "
852 "C<file> exists in the named virtual machine (or disk image)."
853 msgstr ""
854
855 #. type: textblock
856 #: ../cat/virt-cat.pod:24
857 msgid ""
858 "Multiple filenames can be given, in which case they are concatenated "
859 "together.  Each filename must be a full path, starting at the root directory "
860 "(starting with '/')."
861 msgstr ""
862
863 #. type: textblock
864 #: ../cat/virt-cat.pod:28
865 msgid ""
866 "C<virt-cat> can be used to quickly view a file.  To edit a file, use "
867 "C<virt-edit>.  For more complex cases you should look at the L<guestfish(1)> "
868 "tool (see L</USING GUESTFISH> below)."
869 msgstr ""
870
871 #. type: =head1
872 #: ../cat/virt-cat.pod:32 ../cat/virt-ls.pod:35 ../df/virt-df.pod:43 ../edit/virt-edit.pod:44 ../fish/guestfish.pod:41 ../fish/guestfish.pod:1051 ../fish/virt-copy-in.pod:29 ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30 ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39 ../resize/virt-resize.pod:27 ../sparsify/virt-sparsify.pod:75 ../tools/virt-tar.pl:50
873 msgid "EXAMPLES"
874 msgstr ""
875
876 #. type: textblock
877 #: ../cat/virt-cat.pod:34
878 msgid "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
879 msgstr ""
880
881 #. type: verbatim
882 #: ../cat/virt-cat.pod:37
883 #, no-wrap
884 msgid ""
885 " virt-cat -d mydomain /etc/fstab\n"
886 "\n"
887 msgstr ""
888
889 #. type: textblock
890 #: ../cat/virt-cat.pod:39
891 msgid "List syslog messages from a VM disk image file:"
892 msgstr ""
893
894 #. type: verbatim
895 #: ../cat/virt-cat.pod:41
896 #, no-wrap
897 msgid ""
898 " virt-cat -a disk.img /var/log/messages | tail\n"
899 "\n"
900 msgstr ""
901
902 #. type: textblock
903 #: ../cat/virt-cat.pod:43
904 msgid "Find out what DHCP IP address a VM acquired:"
905 msgstr ""
906
907 #. type: verbatim
908 #: ../cat/virt-cat.pod:45
909 #, no-wrap
910 msgid ""
911 " virt-cat -d mydomain /var/log/messages | \\\n"
912 "   grep 'dhclient: bound to' | tail\n"
913 "\n"
914 msgstr ""
915
916 #. type: textblock
917 #: ../cat/virt-cat.pod:48
918 msgid "Find out what packages were recently installed:"
919 msgstr ""
920
921 #. type: verbatim
922 #: ../cat/virt-cat.pod:50
923 #, no-wrap
924 msgid ""
925 " virt-cat -d mydomain /var/log/yum.log | tail\n"
926 "\n"
927 msgstr ""
928
929 #. type: textblock
930 #: ../cat/virt-cat.pod:52
931 msgid "Find out who is logged on inside a virtual machine:"
932 msgstr ""
933
934 #. type: verbatim
935 #: ../cat/virt-cat.pod:54
936 #, no-wrap
937 msgid ""
938 " virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
939 " who /tmp/utmp\n"
940 "\n"
941 msgstr ""
942
943 #. type: textblock
944 #: ../cat/virt-cat.pod:57
945 msgid "or who was logged on:"
946 msgstr ""
947
948 #. type: verbatim
949 #: ../cat/virt-cat.pod:59
950 #, no-wrap
951 msgid ""
952 " virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
953 " last -f /tmp/wtmp\n"
954 "\n"
955 msgstr ""
956
957 #. type: textblock
958 #: ../cat/virt-cat.pod:74 ../cat/virt-filesystems.pod:103 ../cat/virt-ls.pod:273 ../df/virt-df.pod:71 ../edit/virt-edit.pod:74 ../inspector/virt-inspector.pod:67 ../rescue/virt-rescue.pod:124
959 msgid ""
960 "Add I<file> which should be a disk image from a virtual machine.  If the "
961 "virtual machine has multiple block devices, you must supply all of them with "
962 "separate I<-a> options."
963 msgstr ""
964
965 #. type: =item
966 #: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148 ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217 ../fuse/guestmount.pod:135 ../inspector/virt-inspector.pod:92
967 msgid "B<--echo-keys>"
968 msgstr ""
969
970 #. type: textblock
971 #: ../cat/virt-cat.pod:100
972 msgid ""
973 "When prompting for keys and passphrases, virt-cat normally turns echoing off "
974 "so you cannot see what you are typing.  If you are not worried about Tempest "
975 "attacks and there is no one else in the room you can specify this flag to "
976 "see what you are typing."
977 msgstr ""
978
979 #. type: verbatim
980 #: ../cat/virt-cat.pod:116
981 #, no-wrap
982 msgid ""
983 " virt-cat --format=raw -a disk.img file\n"
984 "\n"
985 msgstr ""
986
987 #. type: verbatim
988 #: ../cat/virt-cat.pod:120
989 #, no-wrap
990 msgid ""
991 " virt-cat --format=raw -a disk.img --format -a another.img file\n"
992 "\n"
993 msgstr ""
994
995 #. type: =item
996 #: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200 ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289 ../fuse/guestmount.pod:172 ../inspector/virt-inspector.pod:114
997 msgid "B<--keys-from-stdin>"
998 msgstr ""
999
1000 #. type: textblock
1001 #: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202 ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291 ../fuse/guestmount.pod:174 ../inspector/virt-inspector.pod:116
1002 msgid ""
1003 "Read key or passphrase parameters from stdin.  The default is to try to read "
1004 "passphrases from the user by opening C</dev/tty>."
1005 msgstr ""
1006
1007 #. type: =head1
1008 #: ../cat/virt-cat.pod:152 ../cat/virt-ls.pod:443 ../edit/virt-edit.pod:179 ../inspector/virt-inspector.pod:144 ../rescue/virt-rescue.pod:246
1009 msgid "OLD-STYLE COMMAND LINE ARGUMENTS"
1010 msgstr ""
1011
1012 #. type: textblock
1013 #: ../cat/virt-cat.pod:154
1014 msgid "Previous versions of virt-cat allowed you to write either:"
1015 msgstr ""
1016
1017 #. type: verbatim
1018 #: ../cat/virt-cat.pod:156
1019 #, no-wrap
1020 msgid ""
1021 " virt-cat disk.img [disk.img ...] file\n"
1022 "\n"
1023 msgstr ""
1024
1025 #. type: textblock
1026 #: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185 ../inspector/virt-inspector.pod:150 ../rescue/virt-rescue.pod:252
1027 msgid "or"
1028 msgstr ""
1029
1030 #. type: verbatim
1031 #: ../cat/virt-cat.pod:160
1032 #, no-wrap
1033 msgid ""
1034 " virt-cat guestname file\n"
1035 "\n"
1036 msgstr ""
1037
1038 #. type: textblock
1039 #: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189 ../inspector/virt-inspector.pod:154 ../rescue/virt-rescue.pod:256
1040 msgid ""
1041 "whereas in this version you should use I<-a> or I<-d> respectively to avoid "
1042 "the confusing case where a disk image might have the same name as a guest."
1043 msgstr ""
1044
1045 #. type: textblock
1046 #: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193 ../inspector/virt-inspector.pod:158 ../rescue/virt-rescue.pod:260
1047 msgid "For compatibility the old style is still supported."
1048 msgstr ""
1049
1050 #. type: =head1
1051 #: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
1052 msgid "WINDOWS PATHS"
1053 msgstr ""
1054
1055 #. type: textblock
1056 #: ../cat/virt-cat.pod:170
1057 msgid ""
1058 "C<virt-cat> has a limited ability to understand Windows drive letters and "
1059 "paths (eg. C<E:\\foo\\bar.txt>)."
1060 msgstr ""
1061
1062 #. type: textblock
1063 #: ../cat/virt-cat.pod:173 ../edit/virt-edit.pod:262
1064 msgid "If and only if the guest is running Windows then:"
1065 msgstr ""
1066
1067 #. type: textblock
1068 #: ../cat/virt-cat.pod:179 ../edit/virt-edit.pod:268
1069 msgid ""
1070 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
1071 "to the correct filesystem."
1072 msgstr ""
1073
1074 #. type: textblock
1075 #: ../cat/virt-cat.pod:184 ../edit/virt-edit.pod:273
1076 msgid ""
1077 "Any backslash (C<\\>) characters in the path are replaced with forward "
1078 "slashes so that libguestfs can process it."
1079 msgstr ""
1080
1081 #. type: textblock
1082 #: ../cat/virt-cat.pod:189
1083 msgid ""
1084 "The path is resolved case insensitively to locate the file that should be "
1085 "displayed."
1086 msgstr ""
1087
1088 #. type: textblock
1089 #: ../cat/virt-cat.pod:194 ../edit/virt-edit.pod:283
1090 msgid "There are some known shortcomings:"
1091 msgstr ""
1092
1093 #. type: textblock
1094 #: ../cat/virt-cat.pod:200 ../edit/virt-edit.pod:289
1095 msgid "Some NTFS symbolic links may not be followed correctly."
1096 msgstr ""
1097
1098 #. type: textblock
1099 #: ../cat/virt-cat.pod:204 ../edit/virt-edit.pod:293
1100 msgid "NTFS junction points that cross filesystems are not followed."
1101 msgstr ""
1102
1103 #. type: =head1
1104 #: ../cat/virt-cat.pod:208 ../edit/virt-edit.pod:297
1105 msgid "USING GUESTFISH"
1106 msgstr ""
1107
1108 #. type: textblock
1109 #: ../cat/virt-cat.pod:210
1110 msgid ""
1111 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
1112 "C<virt-cat> doesn't work."
1113 msgstr ""
1114
1115 #. type: textblock
1116 #: ../cat/virt-cat.pod:213
1117 msgid "Using C<virt-cat> is approximately equivalent to doing:"
1118 msgstr ""
1119
1120 #. type: verbatim
1121 #: ../cat/virt-cat.pod:215
1122 #, no-wrap
1123 msgid ""
1124 " guestfish --ro -i -d domname download file -\n"
1125 "\n"
1126 msgstr ""
1127
1128 #. type: textblock
1129 #: ../cat/virt-cat.pod:217
1130 msgid ""
1131 "where C<domname> is the name of the libvirt guest, and C<file> is the full "
1132 "path to the file.  Note the final C<-> (meaning \"output to stdout\")."
1133 msgstr ""
1134
1135 #. type: textblock
1136 #: ../cat/virt-cat.pod:221
1137 msgid ""
1138 "The command above uses libguestfs's guest inspection feature and so does not "
1139 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
1140 "disk images that don't contain guests.  To display a file from a disk image "
1141 "directly, use:"
1142 msgstr ""
1143
1144 #. type: verbatim
1145 #: ../cat/virt-cat.pod:226
1146 #, no-wrap
1147 msgid ""
1148 " guestfish --ro -a disk.img -m /dev/sda1 download file -\n"
1149 "\n"
1150 msgstr ""
1151
1152 #. type: textblock
1153 #: ../cat/virt-cat.pod:228
1154 msgid ""
1155 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
1156 "the disk image, and C<file> is the full path to the file."
1157 msgstr ""
1158
1159 #. type: textblock
1160 #: ../cat/virt-cat.pod:240 ../cat/virt-filesystems.pod:382 ../cat/virt-ls.pod:492 ../df/virt-df.pod:224 ../edit/virt-edit.pod:351 ../fuse/guestmount.pod:314 ../inspector/virt-inspector.pod:392 ../resize/virt-resize.pod:685 ../sparsify/virt-sparsify.pod:229
1161 msgid "This program returns 0 if successful, or non-zero if there was an error."
1162 msgstr ""
1163
1164 #. type: textblock
1165 #: ../cat/virt-cat.pod:245
1166 msgid ""
1167 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
1168 "L<virt-tar-out(1)>, L<http://libguestfs.org/>."
1169 msgstr ""
1170
1171 #. type: textblock
1172 #: ../cat/virt-cat.pod:258 ../inspector/virt-inspector.pod:420 ../resize/virt-resize.pod:717 ../tools/virt-make-fs.pl:588
1173 msgid "Copyright (C) 2010-2011 Red Hat Inc."
1174 msgstr ""
1175
1176 #. type: textblock
1177 #: ../cat/virt-filesystems.pod:5
1178 msgid ""
1179 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
1180 "virtual machine or disk image"
1181 msgstr ""
1182
1183 #. type: verbatim
1184 #: ../cat/virt-filesystems.pod:9
1185 #, no-wrap
1186 msgid ""
1187 " virt-filesystems [--options] -d domname\n"
1188 "\n"
1189 msgstr ""
1190
1191 #. type: verbatim
1192 #: ../cat/virt-filesystems.pod:11
1193 #, no-wrap
1194 msgid ""
1195 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
1196 "\n"
1197 msgstr ""
1198
1199 #. type: textblock
1200 #: ../cat/virt-filesystems.pod:15
1201 msgid ""
1202 "This tool allows you to discover filesystems, partitions, logical volumes, "
1203 "and their sizes in a disk image or virtual machine.  It is a replacement for "
1204 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
1205 msgstr ""
1206
1207 #. type: textblock
1208 #: ../cat/virt-filesystems.pod:20
1209 msgid ""
1210 "One use for this tool is from shell scripts to iterate over all filesystems "
1211 "from a disk image:"
1212 msgstr ""
1213
1214 #. type: verbatim
1215 #: ../cat/virt-filesystems.pod:23
1216 #, no-wrap
1217 msgid ""
1218 " for fs in $(virt-filesystems -a disk.img); do\n"
1219 "   # ...\n"
1220 " done\n"
1221 "\n"
1222 msgstr ""
1223
1224 #. type: textblock
1225 #: ../cat/virt-filesystems.pod:27
1226 msgid ""
1227 "Another use is to list partitions before using another tool to modify those "
1228 "partitions (such as L<virt-resize(1)>).  If you are curious about what an "
1229 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
1230 msgstr ""
1231
1232 #. type: textblock
1233 #: ../cat/virt-filesystems.pod:32
1234 msgid ""
1235 "Various command line options control what this program displays.  You need "
1236 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
1237 "guest respectively.  If you just specify that then the program shows "
1238 "filesystems found, one per line, like this:"
1239 msgstr ""
1240
1241 #. type: verbatim
1242 #: ../cat/virt-filesystems.pod:37
1243 #, no-wrap
1244 msgid ""
1245 " $ virt-filesystems -a disk.img\n"
1246 " /dev/sda1\n"
1247 " /dev/vg_guest/lv_root\n"
1248 "\n"
1249 msgstr ""
1250
1251 #. type: textblock
1252 #: ../cat/virt-filesystems.pod:41
1253 msgid "If you add I<-l> or I<--long> then the output includes extra information:"
1254 msgstr ""
1255
1256 #. type: verbatim
1257 #: ../cat/virt-filesystems.pod:44
1258 #, no-wrap
1259 msgid ""
1260 " $ virt-filesystems -a disk.img -l\n"
1261 " Name                   Type         VFS   Label  Size\n"
1262 " /dev/sda1              filesystem   ext4  boot   524288000\n"
1263 " /dev/vg_guest/lv_root  filesystem   ext4  root   10212081664\n"
1264 "\n"
1265 msgstr ""
1266
1267 #. type: textblock
1268 #: ../cat/virt-filesystems.pod:49
1269 msgid ""
1270 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
1271 "shown as well:"
1272 msgstr ""
1273
1274 #. type: verbatim
1275 #: ../cat/virt-filesystems.pod:52
1276 #, no-wrap
1277 msgid ""
1278 " $ virt-filesystems -a disk.img --extra\n"
1279 " /dev/sda1\n"
1280 " /dev/vg_guest/lv_root\n"
1281 " /dev/vg_guest/lv_swap\n"
1282 " /dev/vg_guest/lv_data\n"
1283 "\n"
1284 msgstr ""
1285
1286 #. type: textblock
1287 #: ../cat/virt-filesystems.pod:58
1288 msgid "If you add I<--partitions> then partitions are shown instead of filesystems:"
1289 msgstr ""
1290
1291 #. type: verbatim
1292 #: ../cat/virt-filesystems.pod:60
1293 #, no-wrap
1294 msgid ""
1295 " $ virt-filesystems -a disk.img --partitions\n"
1296 " /dev/sda1\n"
1297 " /dev/sda2\n"
1298 "\n"
1299 msgstr ""
1300
1301 #. type: textblock
1302 #: ../cat/virt-filesystems.pod:64
1303 msgid ""
1304 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, "
1305 "I<--physical-volumes>, I<--block-devices> to list those items."
1306 msgstr ""
1307
1308 #. type: textblock
1309 #: ../cat/virt-filesystems.pod:67
1310 msgid ""
1311 "You can use these options in combination as well (if you want a combination "
1312 "including filesystems, you have to add I<--filesystems>).  Notice that some "
1313 "items fall into several categories (eg. C</dev/sda1> might be both a "
1314 "partition and a filesystem).  These items are listed several times.  To get "
1315 "a list which includes absolutely everything that virt-filesystems knows "
1316 "about, use the I<--all> option."
1317 msgstr ""
1318
1319 #. type: textblock
1320 #: ../cat/virt-filesystems.pod:74
1321 msgid ""
1322 "UUIDs (because they are quite long) are not shown by default.  Add the "
1323 "I<--uuid> option to display device and filesystem UUIDs in the long output."
1324 msgstr ""
1325
1326 #. type: textblock
1327 #: ../cat/virt-filesystems.pod:78
1328 msgid ""
1329 "I<--all --long --uuid> is a useful combination to display all possible "
1330 "information about everything."
1331 msgstr ""
1332
1333 #. type: verbatim
1334 #: ../cat/virt-filesystems.pod:81
1335 #, no-wrap
1336 msgid ""
1337 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
1338 " Name      Type       VFS  Label           Size Parent   UUID\n"
1339 " /dev/sda1 filesystem ntfs System Reserved 100M -        F81C92571C92112C\n"
1340 " /dev/sda2 filesystem ntfs -               20G  -        F2E8996AE8992E3B\n"
1341 " /dev/sda1 partition  -    -               100M /dev/sda -\n"
1342 " /dev/sda2 partition  -    -               20G  /dev/sda -\n"
1343 " /dev/sda  device     -    -               20G  -        -\n"
1344 "\n"
1345 msgstr ""
1346
1347 #. type: textblock
1348 #: ../cat/virt-filesystems.pod:89
1349 msgid "For machine-readable output, use I<--csv> to get Comma-Separated Values."
1350 msgstr ""
1351
1352 #. type: =item
1353 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
1354 msgid "B<--all>"
1355 msgstr ""
1356
1357 #. type: textblock
1358 #: ../cat/virt-filesystems.pod:112
1359 msgid ""
1360 "Display everything.  This is currently the same as specifying these options: "
1361 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, "
1362 "I<--logical-volumes>, I<--volume-groups>, I<--physical-volumes>.  (More may "
1363 "be added to this list in future)."
1364 msgstr ""
1365
1366 #. type: textblock
1367 #: ../cat/virt-filesystems.pod:117
1368 msgid "See also I<--long>."
1369 msgstr ""
1370
1371 #. type: =item
1372 #: ../cat/virt-filesystems.pod:119
1373 msgid "B<--blkdevs>"
1374 msgstr ""
1375
1376 #. type: =item
1377 #: ../cat/virt-filesystems.pod:121
1378 msgid "B<--block-devices>"
1379 msgstr ""
1380
1381 #. type: textblock
1382 #: ../cat/virt-filesystems.pod:123
1383 msgid "Display block devices."
1384 msgstr ""
1385
1386 #. type: =item
1387 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88
1388 msgid "B<--csv>"
1389 msgstr ""
1390
1391 #. type: textblock
1392 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90
1393 msgid ""
1394 "Write out the results in CSV format (comma-separated values).  This format "
1395 "can be imported easily into databases and spreadsheets, but read L</NOTE "
1396 "ABOUT CSV FORMAT> below."
1397 msgstr ""
1398
1399 #. type: textblock
1400 #: ../cat/virt-filesystems.pod:150
1401 msgid ""
1402 "When prompting for keys and passphrases, virt-filesystems normally turns "
1403 "echoing off so you cannot see what you are typing.  If you are not worried "
1404 "about Tempest attacks and there is no one else in the room you can specify "
1405 "this flag to see what you are typing."
1406 msgstr ""
1407
1408 #. type: =item
1409 #: ../cat/virt-filesystems.pod:155
1410 msgid "B<--extra>"
1411 msgstr ""
1412
1413 #. type: textblock
1414 #: ../cat/virt-filesystems.pod:157
1415 msgid ""
1416 "This causes filesystems that are not ordinary, mountable filesystems to be "
1417 "displayed.  This category includes swapspace, and filesystems that are empty "
1418 "or contain unknown data."
1419 msgstr ""
1420
1421 #. type: textblock
1422 #: ../cat/virt-filesystems.pod:161
1423 msgid "This option implies I<--filesystems>."
1424 msgstr ""
1425
1426 #. type: =item
1427 #: ../cat/virt-filesystems.pod:163
1428 msgid "B<--filesystems>"
1429 msgstr ""
1430
1431 #. type: textblock
1432 #: ../cat/virt-filesystems.pod:165
1433 msgid ""
1434 "Display mountable filesystems.  If no display option was selected then this "
1435 "option is implied."
1436 msgstr ""
1437
1438 #. type: textblock
1439 #: ../cat/virt-filesystems.pod:168
1440 msgid "With I<--extra>, non-mountable filesystems are shown too."
1441 msgstr ""
1442
1443 #. type: verbatim
1444 #: ../cat/virt-filesystems.pod:181
1445 #, no-wrap
1446 msgid ""
1447 " virt-filesystems --format=raw -a disk.img\n"
1448 "\n"
1449 msgstr ""
1450
1451 #. type: verbatim
1452 #: ../cat/virt-filesystems.pod:185
1453 #, no-wrap
1454 msgid ""
1455 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
1456 "\n"
1457 msgstr ""
1458
1459 #. type: =item
1460 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352 ../df/virt-df.pod:125 ../fish/guestfish.pod:156 ../tools/virt-list-partitions.pl:109
1461 msgid "B<-h>"
1462 msgstr ""
1463
1464 #. type: =item
1465 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354 ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111
1466 msgid "B<--human-readable>"
1467 msgstr ""
1468
1469 #. type: textblock
1470 #: ../cat/virt-filesystems.pod:198
1471 msgid "In I<--long> mode, display sizes in human-readable format."
1472 msgstr ""
1473
1474 #. type: =item
1475 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366 ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
1476 msgid "B<-l>"
1477 msgstr ""
1478
1479 #. type: =item
1480 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368 ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
1481 msgid "B<--long>"
1482 msgstr ""
1483
1484 #. type: textblock
1485 #: ../cat/virt-filesystems.pod:209
1486 msgid "Display extra columns of data (\"long format\")."
1487 msgstr ""
1488
1489 #. type: textblock
1490 #: ../cat/virt-filesystems.pod:211
1491 msgid "A title row is added unless you also specify I<--no-title>."
1492 msgstr ""
1493
1494 #. type: textblock
1495 #: ../cat/virt-filesystems.pod:213
1496 msgid ""
1497 "The extra columns displayed depend on what output you select, and the "
1498 "ordering of columns may change in future versions.  Use the title row, "
1499 "I<--csv> output and/or L<csvtool(1)> to match columns to data in external "
1500 "programs."
1501 msgstr ""
1502
1503 #. type: textblock
1504 #: ../cat/virt-filesystems.pod:218
1505 msgid ""
1506 "Use I<-h> if you want sizes to be displayed in human-readable format.  The "
1507 "default is to show raw numbers of I<bytes>."
1508 msgstr ""
1509
1510 #. type: textblock
1511 #: ../cat/virt-filesystems.pod:221
1512 msgid "Use I<--uuid> to display UUIDs too."
1513 msgstr ""
1514
1515 #. type: =item
1516 #: ../cat/virt-filesystems.pod:223
1517 msgid "B<--lvs>"
1518 msgstr ""
1519
1520 #. type: =item
1521 #: ../cat/virt-filesystems.pod:225
1522 msgid "B<--logvols>"
1523 msgstr ""
1524
1525 #. type: =item
1526 #: ../cat/virt-filesystems.pod:227
1527 msgid "B<--logical-volumes>"
1528 msgstr ""
1529
1530 #. type: textblock
1531 #: ../cat/virt-filesystems.pod:229
1532 msgid ""
1533 "Display LVM logical volumes.  In this mode, these are displayed irrespective "
1534 "of whether the LVs contain filesystems."
1535 msgstr ""
1536
1537 #. type: =item
1538 #: ../cat/virt-filesystems.pod:232
1539 msgid "B<--no-title>"
1540 msgstr ""
1541
1542 #. type: textblock
1543 #: ../cat/virt-filesystems.pod:234
1544 msgid "In I<--long> mode, don't add a title row."
1545 msgstr ""
1546
1547 #. type: textblock
1548 #: ../cat/virt-filesystems.pod:236
1549 msgid ""
1550 "Note that the order of the columns is not fixed, and may change in future "
1551 "versions of virt-filesystems, so using this option may give you unexpected "
1552 "surprises."
1553 msgstr ""
1554
1555 #. type: =item
1556 #: ../cat/virt-filesystems.pod:240
1557 msgid "B<--parts>"
1558 msgstr ""
1559
1560 #. type: =item
1561 #: ../cat/virt-filesystems.pod:242
1562 msgid "B<--partitions>"
1563 msgstr ""
1564
1565 #. type: textblock
1566 #: ../cat/virt-filesystems.pod:244
1567 msgid ""
1568 "Display partitions.  In this mode, these are displayed irrespective of "
1569 "whether the partitions contain filesystems."
1570 msgstr ""
1571
1572 #. type: =item
1573 #: ../cat/virt-filesystems.pod:247
1574 msgid "B<--pvs>"
1575 msgstr ""
1576
1577 #. type: =item
1578 #: ../cat/virt-filesystems.pod:249
1579 msgid "B<--physvols>"
1580 msgstr ""
1581
1582 #. type: =item
1583 #: ../cat/virt-filesystems.pod:251
1584 msgid "B<--physical-volumes>"
1585 msgstr ""
1586
1587 #. type: textblock
1588 #: ../cat/virt-filesystems.pod:253
1589 msgid "Display LVM physical volumes."
1590 msgstr ""
1591
1592 #. type: =item
1593 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163
1594 msgid "B<--uuid>"
1595 msgstr ""
1596
1597 #. type: =item
1598 #: ../cat/virt-filesystems.pod:257
1599 msgid "B<--uuids>"
1600 msgstr ""
1601
1602 #. type: textblock
1603 #: ../cat/virt-filesystems.pod:259
1604 msgid "In I<--long> mode, display UUIDs as well."
1605 msgstr ""
1606
1607 #. type: =item
1608 #: ../cat/virt-filesystems.pod:273
1609 msgid "B<--vgs>"
1610 msgstr ""
1611
1612 #. type: =item
1613 #: ../cat/virt-filesystems.pod:275
1614 msgid "B<--volgroups>"
1615 msgstr ""
1616
1617 #. type: =item
1618 #: ../cat/virt-filesystems.pod:277
1619 msgid "B<--volume-groups>"
1620 msgstr ""
1621
1622 #. type: textblock
1623 #: ../cat/virt-filesystems.pod:279
1624 msgid "Display LVM volume groups."
1625 msgstr ""
1626
1627 #. type: =head1
1628 #: ../cat/virt-filesystems.pod:287
1629 msgid "COLUMNS"
1630 msgstr ""
1631
1632 #. type: textblock
1633 #: ../cat/virt-filesystems.pod:289
1634 msgid ""
1635 "Note that columns in the output are subject to reordering and change in "
1636 "future versions of this tool."
1637 msgstr ""
1638
1639 #. type: =item
1640 #: ../cat/virt-filesystems.pod:294
1641 msgid "B<Name>"
1642 msgstr ""
1643
1644 #. type: textblock
1645 #: ../cat/virt-filesystems.pod:296
1646 msgid "The filesystem, partition, block device or LVM name."
1647 msgstr ""
1648
1649 #. type: textblock
1650 #: ../cat/virt-filesystems.pod:298
1651 msgid ""
1652 "For device and partition names these are displayed as canonical libguestfs "
1653 "names, so that for example C</dev/sda2> is the second partition on the first "
1654 "device."
1655 msgstr ""
1656
1657 #. type: textblock
1658 #: ../cat/virt-filesystems.pod:302
1659 msgid ""
1660 "If the I<--long> option is B<not> specified, then only the name column is "
1661 "shown in the output."
1662 msgstr ""
1663
1664 #. type: =item
1665 #: ../cat/virt-filesystems.pod:305
1666 msgid "B<Type>"
1667 msgstr ""
1668
1669 #. type: textblock
1670 #: ../cat/virt-filesystems.pod:307
1671 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1672 msgstr ""
1673
1674 #. type: =item
1675 #: ../cat/virt-filesystems.pod:309
1676 msgid "B<VFS>"
1677 msgstr ""
1678
1679 #. type: textblock
1680 #: ../cat/virt-filesystems.pod:311
1681 msgid ""
1682 "If there is a filesystem, then this column displays the filesystem type if "
1683 "one could be detected, eg. C<ext4>."
1684 msgstr ""
1685
1686 #. type: =item
1687 #: ../cat/virt-filesystems.pod:314
1688 msgid "B<Label>"
1689 msgstr ""
1690
1691 #. type: textblock
1692 #: ../cat/virt-filesystems.pod:316
1693 msgid ""
1694 "If the object has a label (used for identifying and mounting filesystems) "
1695 "then this column contains the label."
1696 msgstr ""
1697
1698 #. type: =item
1699 #: ../cat/virt-filesystems.pod:319
1700 msgid "B<MBR>"
1701 msgstr ""
1702
1703 #. type: textblock
1704 #: ../cat/virt-filesystems.pod:321
1705 msgid ""
1706 "The partition type byte, displayed as a two digit hexadecimal number.  A "
1707 "comprehensive list of partition types can be found here: "
1708 "L<http://www.win.tue.nl/~aeb/partitions/partition_types-1.html>"
1709 msgstr ""
1710
1711 #. type: textblock
1712 #: ../cat/virt-filesystems.pod:325
1713 msgid "This is only applicable for DOS (MBR) partitions."
1714 msgstr ""
1715
1716 #. type: =item
1717 #: ../cat/virt-filesystems.pod:327
1718 msgid "B<Size>"
1719 msgstr ""
1720
1721 #. type: textblock
1722 #: ../cat/virt-filesystems.pod:329
1723 msgid ""
1724 "The size of the object in bytes.  If the I<--human> option is used then the "
1725 "size is displayed in a human-readable form."
1726 msgstr ""
1727
1728 #. type: =item
1729 #: ../cat/virt-filesystems.pod:332
1730 msgid "B<Parent>"
1731 msgstr ""
1732
1733 #. type: textblock
1734 #: ../cat/virt-filesystems.pod:334
1735 msgid ""
1736 "The parent column records the parent relationship between objects.  For "
1737 "example, if the object is a partition, then this column contains the name of "
1738 "the containing device.  If the object is a logical volume, then this column "
1739 "is the name of the volume group."
1740 msgstr ""
1741
1742 #. type: =item
1743 #: ../cat/virt-filesystems.pod:339
1744 msgid "B<UUID>"
1745 msgstr ""
1746
1747 #. type: textblock
1748 #: ../cat/virt-filesystems.pod:341
1749 msgid ""
1750 "If the object has a UUID (used for identifying and mounting filesystems and "
1751 "block devices) then this column contains the UUID as a string."
1752 msgstr ""
1753
1754 #. type: textblock
1755 #: ../cat/virt-filesystems.pod:345
1756 msgid "The UUID is only displayed if the I<--uuid> option is given."
1757 msgstr ""
1758
1759 #. type: =head1
1760 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:459 ../df/virt-df.pod:191
1761 msgid "NOTE ABOUT CSV FORMAT"
1762 msgstr ""
1763
1764 #. type: textblock
1765 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:461 ../df/virt-df.pod:193
1766 msgid ""
1767 "Comma-separated values (CSV) is a deceptive format.  It I<seems> like it "
1768 "should be easy to parse, but it is definitely not easy to parse."
1769 msgstr ""
1770
1771 #. type: textblock
1772 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:464 ../df/virt-df.pod:196
1773 msgid ""
1774 "Myth: Just split fields at commas.  Reality: This does I<not> work "
1775 "reliably.  This example has two columns:"
1776 msgstr ""
1777
1778 #. type: verbatim
1779 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:467 ../df/virt-df.pod:199
1780 #, no-wrap
1781 msgid ""
1782 " \"foo,bar\",baz\n"
1783 "\n"
1784 msgstr ""
1785
1786 #. type: textblock
1787 #: ../cat/virt-filesystems.pod:359 ../cat/virt-ls.pod:469 ../df/virt-df.pod:201
1788 msgid ""
1789 "Myth: Read the file one line at a time.  Reality: This does I<not> work "
1790 "reliably.  This example has one row:"
1791 msgstr ""
1792
1793 #. type: verbatim
1794 #: ../cat/virt-filesystems.pod:362 ../cat/virt-ls.pod:472 ../df/virt-df.pod:204
1795 #, no-wrap
1796 msgid ""
1797 " \"foo\n"
1798 " bar\",baz\n"
1799 "\n"
1800 msgstr ""
1801
1802 #. type: textblock
1803 #: ../cat/virt-filesystems.pod:365 ../cat/virt-ls.pod:475 ../df/virt-df.pod:207
1804 msgid ""
1805 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
1806 "packaged in major Linux distributions)."
1807 msgstr ""
1808
1809 #. type: textblock
1810 #: ../cat/virt-filesystems.pod:368 ../cat/virt-ls.pod:478 ../df/virt-df.pod:210
1811 msgid ""
1812 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
1813 "or Python's built-in csv library)."
1814 msgstr ""
1815
1816 #. type: textblock
1817 #: ../cat/virt-filesystems.pod:371 ../cat/virt-ls.pod:481 ../df/virt-df.pod:213
1818 msgid "Most spreadsheets and databases can import CSV directly."
1819 msgstr ""
1820
1821 #. type: textblock
1822 #: ../cat/virt-filesystems.pod:387
1823 msgid ""
1824 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
1825 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, "
1826 "L<http://libguestfs.org/>."
1827 msgstr ""
1828
1829 #. type: textblock
1830 #: ../cat/virt-filesystems.pod:402 ../tools/virt-win-reg.pl:789
1831 msgid "Copyright (C) 2010 Red Hat Inc."
1832 msgstr ""
1833
1834 #. type: textblock
1835 #: ../cat/virt-ls.pod:5
1836 msgid "virt-ls - List files in a virtual machine"
1837 msgstr ""
1838
1839 #. type: verbatim
1840 #: ../cat/virt-ls.pod:9
1841 #, no-wrap
1842 msgid ""
1843 " virt-ls [--options] -d domname directory [directory ...]\n"
1844 "\n"
1845 msgstr ""
1846
1847 #. type: verbatim
1848 #: ../cat/virt-ls.pod:11
1849 #, no-wrap
1850 msgid ""
1851 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory "
1852 "...]\n"
1853 "\n"
1854 msgstr ""
1855
1856 #. type: textblock
1857 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:15
1858 msgid "Old style:"
1859 msgstr ""
1860
1861 #. type: verbatim
1862 #: ../cat/virt-ls.pod:15
1863 #, no-wrap
1864 msgid ""
1865 " virt-ls [--options] domname directory\n"
1866 "\n"
1867 msgstr ""
1868
1869 #. type: verbatim
1870 #: ../cat/virt-ls.pod:17
1871 #, no-wrap
1872 msgid ""
1873 " virt-ls [--options] disk.img [disk.img ...] directory\n"
1874 "\n"
1875 msgstr ""
1876
1877 #. type: textblock
1878 #: ../cat/virt-ls.pod:21
1879 msgid ""
1880 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
1881 "more from a virtual machine or disk image."
1882 msgstr ""
1883
1884 #. type: textblock
1885 #: ../cat/virt-ls.pod:24
1886 msgid ""
1887 "Multiple directory names can be given, in which case the output from each is "
1888 "concatenated."
1889 msgstr ""
1890
1891 #. type: textblock
1892 #: ../cat/virt-ls.pod:27
1893 msgid ""
1894 "To list directories from a libvirt guest use the I<-d> option to specify the "
1895 "name of the guest.  For a disk image, use the I<-a> option."
1896 msgstr ""
1897
1898 #. type: textblock
1899 #: ../cat/virt-ls.pod:31
1900 msgid ""
1901 "C<virt-ls> can do many simple file listings.  For more complicated cases you "
1902 "may need to use L<guestfish(1)>, or write a program directly to the "
1903 "L<guestfs(3)> API."
1904 msgstr ""
1905
1906 #. type: textblock
1907 #: ../cat/virt-ls.pod:37
1908 msgid "Get a list of all files and directories in a virtual machine:"
1909 msgstr ""
1910
1911 #. type: verbatim
1912 #: ../cat/virt-ls.pod:39
1913 #, no-wrap
1914 msgid ""
1915 " virt-ls -R -d guest /\n"
1916 "\n"
1917 msgstr ""
1918
1919 #. type: textblock
1920 #: ../cat/virt-ls.pod:41
1921 msgid "List all setuid or setgid programs in a Linux virtual machine:"
1922 msgstr ""
1923
1924 #. type: verbatim
1925 #: ../cat/virt-ls.pod:43
1926 #, no-wrap
1927 msgid ""
1928 " virt-ls -lR -d guest / | grep '^- [42]'\n"
1929 "\n"
1930 msgstr ""
1931
1932 #. type: textblock
1933 #: ../cat/virt-ls.pod:45
1934 msgid "List all public-writable directories in a Linux virtual machine:"
1935 msgstr ""
1936
1937 #. type: verbatim
1938 #: ../cat/virt-ls.pod:47
1939 #, no-wrap
1940 msgid ""
1941 " virt-ls -lR -d guest / | grep '^d ...7'\n"
1942 "\n"
1943 msgstr ""
1944
1945 #. type: textblock
1946 #: ../cat/virt-ls.pod:49
1947 msgid "List all Unix domain sockets in a Linux virtual machine:"
1948 msgstr ""
1949
1950 #. type: verbatim
1951 #: ../cat/virt-ls.pod:51
1952 #, no-wrap
1953 msgid ""
1954 " virt-ls -lR -d guest / | grep '^s'\n"
1955 "\n"
1956 msgstr ""
1957
1958 #. type: textblock
1959 #: ../cat/virt-ls.pod:53
1960 msgid "List all regular files with filenames ending in '.png':"
1961 msgstr ""
1962
1963 #. type: verbatim
1964 #: ../cat/virt-ls.pod:55
1965 #, no-wrap
1966 msgid ""
1967 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
1968 "\n"
1969 msgstr ""
1970
1971 #. type: textblock
1972 #: ../cat/virt-ls.pod:57
1973 msgid "To display files larger than 10MB in home directories:"
1974 msgstr ""
1975
1976 #. type: verbatim
1977 #: ../cat/virt-ls.pod:59
1978 #, no-wrap
1979 msgid ""
1980 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
1981 "\n"
1982 msgstr ""
1983
1984 #. type: textblock
1985 #: ../cat/virt-ls.pod:61
1986 msgid "Find everything modified in the last 7 days:"
1987 msgstr ""
1988
1989 #. type: verbatim
1990 #: ../cat/virt-ls.pod:63
1991 #, no-wrap
1992 msgid ""
1993 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
1994 "\n"
1995 msgstr ""
1996
1997 #. type: textblock
1998 #: ../cat/virt-ls.pod:65
1999 msgid "Find regular files modified in the last 24 hours:"
2000 msgstr ""
2001
2002 #. type: verbatim
2003 #: ../cat/virt-ls.pod:67
2004 #, no-wrap
2005 msgid ""
2006 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
2007 "\n"
2008 msgstr ""
2009
2010 #. type: =head2
2011 #: ../cat/virt-ls.pod:69
2012 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
2013 msgstr ""
2014
2015 #. type: textblock
2016 #: ../cat/virt-ls.pod:71
2017 msgid ""
2018 "Find the differences between files in a guest and an earlier snapshot of the "
2019 "same guest."
2020 msgstr ""
2021
2022 #. type: verbatim
2023 #: ../cat/virt-ls.pod:74
2024 #, no-wrap
2025 msgid ""
2026 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
2027 " virt-ls -lR -a current.img / --uids --time-t > new\n"
2028 " diff -u old new | less\n"
2029 "\n"
2030 msgstr ""
2031
2032 #. type: textblock
2033 #: ../cat/virt-ls.pod:78
2034 msgid ""
2035 "The commands above won't find files where the content has changed but the "
2036 "metadata (eg. file size and modification date) is the same.  To do that, you "
2037 "need to add the I<--checksum> parameter to both C<virt-ls> commands.  "
2038 "I<--checksum> can be quite slow since it has to read and compute a checksum "
2039 "of every regular file in the virtual machine."
2040 msgstr ""
2041
2042 #. type: =head1
2043 #: ../cat/virt-ls.pod:84
2044 msgid "OUTPUT MODES"
2045 msgstr ""
2046
2047 #. type: textblock
2048 #: ../cat/virt-ls.pod:86
2049 msgid ""
2050 "C<virt-ls> has four output modes, controlled by different combinations of "
2051 "the I<-l> and I<-R> options."
2052 msgstr ""
2053
2054 #. type: =head2
2055 #: ../cat/virt-ls.pod:89
2056 msgid "SIMPLE LISTING"
2057 msgstr ""
2058
2059 #. type: textblock
2060 #: ../cat/virt-ls.pod:91
2061 msgid "A simple listing is like the ordinary L<ls(1)> command:"
2062 msgstr ""
2063
2064 #. type: verbatim
2065 #: ../cat/virt-ls.pod:93
2066 #, no-wrap
2067 msgid ""
2068 " $ virt-ls -d guest /\n"
2069 " bin\n"
2070 " boot\n"
2071 " [etc.]\n"
2072 "\n"
2073 msgstr ""
2074
2075 #. type: =head2
2076 #: ../cat/virt-ls.pod:98
2077 msgid "LONG LISTING"
2078 msgstr ""
2079
2080 #. type: textblock
2081 #: ../cat/virt-ls.pod:100
2082 msgid ""
2083 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
2084 "(more specifically, like the C<guestfs_ll> function)."
2085 msgstr ""
2086
2087 #. type: verbatim
2088 #: ../cat/virt-ls.pod:103
2089 #, no-wrap
2090 msgid ""
2091 " $ virt-ls -l -d guest /\n"
2092 " total 204\n"
2093 " dr-xr-xr-x.   2 root root   4096 2009-08-25 19:06 bin\n"
2094 " dr-xr-xr-x.   5 root root   3072 2009-08-25 19:06 boot\n"
2095 " [etc.]\n"
2096 "\n"
2097 msgstr ""
2098
2099 #. type: textblock
2100 #: ../cat/virt-ls.pod:109
2101 msgid ""
2102 "Note that while this is useful for displaying a directory, do not try "
2103 "parsing this output in another program.  Use L</RECURSIVE LONG LISTING> "
2104 "instead."
2105 msgstr ""
2106
2107 #. type: =head2
2108 #: ../cat/virt-ls.pod:113
2109 msgid "RECURSIVE LISTING"
2110 msgstr ""
2111
2112 #. type: textblock
2113 #: ../cat/virt-ls.pod:115
2114 msgid ""
2115 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
2116 "and directories recursively:"
2117 msgstr ""
2118
2119 #. type: verbatim
2120 #: ../cat/virt-ls.pod:118
2121 #, no-wrap
2122 msgid ""
2123 " $ virt-ls -R -d guest /tmp\n"
2124 " foo\n"
2125 " foo/bar\n"
2126 " [etc.]\n"
2127 "\n"
2128 msgstr ""
2129
2130 #. type: textblock
2131 #: ../cat/virt-ls.pod:123
2132 msgid ""
2133 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
2134 "converts C<\\0> characters to C<\\n>."
2135 msgstr ""
2136
2137 #. type: =head2
2138 #: ../cat/virt-ls.pod:126
2139 msgid "RECURSIVE LONG LISTING"
2140 msgstr ""
2141
2142 #. type: textblock
2143 #: ../cat/virt-ls.pod:128
2144 msgid ""
2145 "Using I<-lR> options together changes the output to display directories "
2146 "recursively, with file stats, and optionally other features such as "
2147 "checksums and extended attributes."
2148 msgstr ""
2149
2150 #. type: textblock
2151 #: ../cat/virt-ls.pod:132
2152 msgid ""
2153 "Most of the interesting features of C<virt-ls> are only available when using "
2154 "I<-lR> mode."
2155 msgstr ""
2156
2157 #. type: textblock
2158 #: ../cat/virt-ls.pod:135
2159 msgid ""
2160 "The fields are normally space-separated.  Filenames are B<not> quoted, so "
2161 "you cannot use the output in another program (because filenames can contain "
2162 "spaces and other unsafe characters).  If the guest was untrusted and someone "
2163 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
2164 "on you by creating filenames with embedded newline characters.  To B<safely> "
2165 "parse the output in another program, use the I<--csv> (Comma-Separated "
2166 "Values) option."
2167 msgstr ""
2168
2169 #. type: textblock
2170 #: ../cat/virt-ls.pod:143
2171 msgid ""
2172 "Note that this output format is completely unrelated to the C<ls -lR> "
2173 "command."
2174 msgstr ""
2175
2176 #. type: verbatim
2177 #: ../cat/virt-ls.pod:146
2178 #, no-wrap
2179 msgid ""
2180 " $ virt-ls -lR -d guest /bin\n"
2181 " d 0555       4096 /bin\n"
2182 " - 0755        123 /bin/alsaunmute\n"
2183 " - 0755      28328 /bin/arch\n"
2184 " l 0777          4 /bin/awk -> gawk\n"
2185 " - 0755      27216 /bin/basename\n"
2186 " - 0755     943360 /bin/bash\n"
2187 " [etc.]\n"
2188 "\n"
2189 msgstr ""
2190
2191 #. type: textblock
2192 #: ../cat/virt-ls.pod:155
2193 msgid "These basic fields are always shown:"
2194 msgstr ""
2195
2196 #. type: =item
2197 #: ../cat/virt-ls.pod:159
2198 msgid "type"
2199 msgstr ""
2200
2201 #. type: textblock
2202 #: ../cat/virt-ls.pod:161
2203 msgid ""
2204 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
2205 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
2206 "link), C<s> (socket) or C<u> (unknown)."
2207 msgstr ""
2208
2209 #. type: =item
2210 #: ../cat/virt-ls.pod:171
2211 msgid "permissions"
2212 msgstr ""
2213
2214 #. type: textblock
2215 #: ../cat/virt-ls.pod:173
2216 msgid "The Unix permissions, displayed as a 4 digit octal number."
2217 msgstr ""
2218
2219 #. type: =item
2220 #: ../cat/virt-ls.pod:175
2221 msgid "size"
2222 msgstr ""
2223
2224 #. type: textblock
2225 #: ../cat/virt-ls.pod:177
2226 msgid ""
2227 "The size of the file.  This is shown in bytes unless I<-h> or "
2228 "I<--human-readable> option is given, in which case this is shown as a "
2229 "human-readable number."
2230 msgstr ""
2231
2232 #. type: =head2
2233 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4380
2234 msgid "path"
2235 msgstr ""
2236
2237 #. type: textblock
2238 #: ../cat/virt-ls.pod:183
2239 msgid "The full path of the file or directory."
2240 msgstr ""
2241
2242 #. type: =item
2243 #: ../cat/virt-ls.pod:185
2244 msgid "link"
2245 msgstr ""
2246
2247 #. type: textblock
2248 #: ../cat/virt-ls.pod:187
2249 msgid "For symbolic links only, the link target."
2250 msgstr ""
2251
2252 #. type: textblock
2253 #: ../cat/virt-ls.pod:191
2254 msgid ""
2255 "In I<-lR> mode, additional command line options enable the display of more "
2256 "fields."
2257 msgstr ""
2258
2259 #. type: textblock
2260 #: ../cat/virt-ls.pod:194
2261 msgid ""
2262 "With the I<--uids> flag, these additional fields are displayed before the "
2263 "path:"
2264 msgstr ""
2265
2266 #. type: =item
2267 #: ../cat/virt-ls.pod:199
2268 msgid "uid"
2269 msgstr ""
2270
2271 #. type: =item
2272 #: ../cat/virt-ls.pod:201
2273 msgid "gid"
2274 msgstr ""
2275
2276 #. type: textblock
2277 #: ../cat/virt-ls.pod:203
2278 msgid ""
2279 "The UID and GID of the owner of the file (displayed numerically).  Note "
2280 "these only make sense in the context of a Unix-like guest."
2281 msgstr ""
2282
2283 #. type: textblock
2284 #: ../cat/virt-ls.pod:208
2285 msgid "With the I<--times> flag, these additional fields are displayed:"
2286 msgstr ""
2287
2288 #. type: =item
2289 #: ../cat/virt-ls.pod:212
2290 msgid "atime"
2291 msgstr ""
2292
2293 #. type: textblock
2294 #: ../cat/virt-ls.pod:214
2295 msgid "The time of last access."
2296 msgstr ""
2297
2298 #. type: =item
2299 #: ../cat/virt-ls.pod:216
2300 msgid "mtime"
2301 msgstr ""
2302
2303 #. type: textblock
2304 #: ../cat/virt-ls.pod:218
2305 msgid "The time of last modification."
2306 msgstr ""
2307
2308 #. type: =item
2309 #: ../cat/virt-ls.pod:220
2310 msgid "ctime"
2311 msgstr ""
2312
2313 #. type: textblock
2314 #: ../cat/virt-ls.pod:222
2315 msgid "The time of last status change."
2316 msgstr ""
2317
2318 #. type: textblock
2319 #: ../cat/virt-ls.pod:226
2320 msgid ""
2321 "The time fields are displayed as string dates and times, unless one of the "
2322 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
2323 msgstr ""
2324
2325 #. type: textblock
2326 #: ../cat/virt-ls.pod:229
2327 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
2328 msgstr ""
2329
2330 #. type: =item
2331 #: ../cat/virt-ls.pod:233
2332 msgid "device"
2333 msgstr ""
2334
2335 #. type: textblock
2336 #: ../cat/virt-ls.pod:235
2337 msgid ""
2338 "The device containing the file (displayed as major:minor).  This may not "
2339 "match devices as known to the guest."
2340 msgstr ""
2341
2342 #. type: =item
2343 #: ../cat/virt-ls.pod:238
2344 msgid "inode"
2345 msgstr ""
2346
2347 #. type: textblock
2348 #: ../cat/virt-ls.pod:240
2349 msgid "The inode number."
2350 msgstr ""
2351
2352 #. type: =item
2353 #: ../cat/virt-ls.pod:242
2354 msgid "nlink"
2355 msgstr ""
2356
2357 #. type: textblock
2358 #: ../cat/virt-ls.pod:244
2359 msgid "The number of hard links."
2360 msgstr ""
2361
2362 #. type: =item
2363 #: ../cat/virt-ls.pod:246
2364 msgid "rdev"
2365 msgstr ""
2366
2367 #. type: textblock
2368 #: ../cat/virt-ls.pod:248
2369 msgid "For block and char special files, the device (displayed as major:minor)."
2370 msgstr ""
2371
2372 #. type: =item
2373 #: ../cat/virt-ls.pod:251
2374 msgid "blocks"
2375 msgstr ""
2376
2377 #. type: textblock
2378 #: ../cat/virt-ls.pod:253
2379 msgid "The number of 512 byte blocks allocated to the file."
2380 msgstr ""
2381
2382 #. type: textblock
2383 #: ../cat/virt-ls.pod:257
2384 msgid ""
2385 "With the I<--checksum> flag, the checksum of the file contents is shown "
2386 "(only for regular files).  Computing file checksums can take a considerable "
2387 "amount of time."
2388 msgstr ""
2389
2390 #. type: =item
2391 #: ../cat/virt-ls.pod:280
2392 msgid "B<--checksum>"
2393 msgstr ""
2394
2395 #. type: =item
2396 #: ../cat/virt-ls.pod:282
2397 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
2398 msgstr ""
2399
2400 #. type: textblock
2401 #: ../cat/virt-ls.pod:284
2402 msgid ""
2403 "Display checksum over file contents for regular files.  With no argument, "
2404 "this defaults to using I<md5>.  Using an argument, you can select the "
2405 "checksum type to use."
2406 msgstr ""
2407
2408 #. type: textblock
2409 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358 ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408 ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
2410 msgid ""
2411 "This option only has effect in I<-lR> output mode.  See L</RECURSIVE LONG "
2412 "LISTING> above."
2413 msgstr ""
2414
2415 #. type: textblock
2416 #: ../cat/virt-ls.pod:316
2417 msgid ""
2418 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
2419 "so you cannot see what you are typing.  If you are not worried about Tempest "
2420 "attacks and there is no one else in the room you can specify this flag to "
2421 "see what you are typing."
2422 msgstr ""
2423
2424 #. type: =item
2425 #: ../cat/virt-ls.pod:321
2426 msgid "B<--extra-stats>"
2427 msgstr ""
2428
2429 #. type: textblock
2430 #: ../cat/virt-ls.pod:323
2431 msgid "Display extra stats."
2432 msgstr ""
2433
2434 #. type: verbatim
2435 #: ../cat/virt-ls.pod:339
2436 #, no-wrap
2437 msgid ""
2438 " virt-ls --format=raw -a disk.img /dir\n"
2439 "\n"
2440 msgstr ""
2441
2442 #. type: verbatim
2443 #: ../cat/virt-ls.pod:343
2444 #, no-wrap
2445 msgid ""
2446 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
2447 "\n"
2448 msgstr ""
2449
2450 #. type: textblock
2451 #: ../cat/virt-ls.pod:356
2452 msgid "Display file sizes in human-readable format."
2453 msgstr ""
2454
2455 #. type: =item
2456 #: ../cat/virt-ls.pod:370
2457 msgid "B<-R>"
2458 msgstr ""
2459
2460 #. type: =item
2461 #: ../cat/virt-ls.pod:372
2462 msgid "B<--recursive>"
2463 msgstr ""
2464
2465 #. type: textblock
2466 #: ../cat/virt-ls.pod:374
2467 msgid ""
2468 "Select the mode.  With neither of these options, C<virt-ls> produces a "
2469 "simple, flat list of the files in the named directory.  See L</SIMPLE "
2470 "LISTING>."
2471 msgstr ""
2472
2473 #. type: textblock
2474 #: ../cat/virt-ls.pod:378
2475 msgid ""
2476 "C<virt-ls -l> produces a \"long listing\", which shows more detail.  See "
2477 "L</LONG LISTING>."
2478 msgstr ""
2479
2480 #. type: textblock
2481 #: ../cat/virt-ls.pod:381
2482 msgid ""
2483 "C<virt-ls -R> produces a recursive list of files starting at the named "
2484 "directory.  See L</RECURSIVE LISTING>."
2485 msgstr ""
2486
2487 #. type: textblock
2488 #: ../cat/virt-ls.pod:384
2489 msgid ""
2490 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
2491 "parsed.  See L</RECURSIVE LONG LISTING>."
2492 msgstr ""
2493
2494 #. type: =item
2495 #: ../cat/virt-ls.pod:387
2496 msgid "B<--times>"
2497 msgstr ""
2498
2499 #. type: textblock
2500 #: ../cat/virt-ls.pod:389
2501 msgid "Display time fields."
2502 msgstr ""
2503
2504 #. type: =item
2505 #: ../cat/virt-ls.pod:394
2506 msgid "B<--time-days>"
2507 msgstr ""
2508
2509 #. type: textblock
2510 #: ../cat/virt-ls.pod:396
2511 msgid "Display time fields as days before now (negative if in the future)."
2512 msgstr ""
2513
2514 #. type: textblock
2515 #: ../cat/virt-ls.pod:398
2516 msgid ""
2517 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
2518 "of the file is between 0 and 86399 seconds."
2519 msgstr ""
2520
2521 #. type: =item
2522 #: ../cat/virt-ls.pod:404
2523 msgid "B<--time-relative>"
2524 msgstr ""
2525
2526 #. type: textblock
2527 #: ../cat/virt-ls.pod:406
2528 msgid "Display time fields as seconds before now (negative if in the future)."
2529 msgstr ""
2530
2531 #. type: =item
2532 #: ../cat/virt-ls.pod:411
2533 msgid "B<--time-t>"
2534 msgstr ""
2535
2536 #. type: textblock
2537 #: ../cat/virt-ls.pod:413
2538 msgid "Display time fields as seconds since the Unix epoch."
2539 msgstr ""
2540
2541 #. type: =item
2542 #: ../cat/virt-ls.pod:418
2543 msgid "B<--uids>"
2544 msgstr ""
2545
2546 #. type: textblock
2547 #: ../cat/virt-ls.pod:420
2548 msgid "Display UID and GID fields."
2549 msgstr ""
2550
2551 #. type: textblock
2552 #: ../cat/virt-ls.pod:445
2553 msgid "Previous versions of virt-ls allowed you to write either:"
2554 msgstr ""
2555
2556 #. type: verbatim
2557 #: ../cat/virt-ls.pod:447
2558 #, no-wrap
2559 msgid ""
2560 " virt-ls disk.img [disk.img ...] /dir\n"
2561 "\n"
2562 msgstr ""
2563
2564 #. type: verbatim
2565 #: ../cat/virt-ls.pod:451
2566 #, no-wrap
2567 msgid ""
2568 " virt-ls guestname /dir\n"
2569 "\n"
2570 msgstr ""
2571
2572 #. type: textblock
2573 #: ../cat/virt-ls.pod:497
2574 msgid ""
2575 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, "
2576 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
2577 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
2578 msgstr ""
2579
2580 #. type: textblock
2581 #: ../cat/virt-ls.pod:513 ../df/virt-df.pod:241 ../edit/virt-edit.pod:374 ../rescue/virt-rescue.pod:340
2582 msgid "Copyright (C) 2009-2011 Red Hat Inc."
2583 msgstr ""
2584
2585 #. type: textblock
2586 #: ../clone/virt-sysprep.pod:5
2587 msgid "virt-sysprep - Reset or unconfigure a virtual machine so clones can be made"
2588 msgstr ""
2589
2590 #. type: verbatim
2591 #: ../clone/virt-sysprep.pod:9
2592 #, no-wrap
2593 msgid ""
2594 " virt-sysprep [--options] -d domname\n"
2595 "\n"
2596 msgstr ""
2597
2598 #. type: verbatim
2599 #: ../clone/virt-sysprep.pod:11
2600 #, no-wrap
2601 msgid ""
2602 " virt-sysprep [--options] -a disk.img [-a disk.img ...]\n"
2603 "\n"
2604 msgstr ""
2605
2606 #. type: textblock
2607 #: ../clone/virt-sysprep.pod:15
2608 msgid ""
2609 "Virt-sysprep \"resets\" or \"unconfigures\" a virtual machine so that clones "
2610 "can be made from it.  Steps in this process include removing SSH host keys, "
2611 "removing persistent network MAC configuration, and removing user accounts.  "
2612 "Each step can be enabled or disabled as required."
2613 msgstr ""
2614
2615 #. type: textblock
2616 #: ../clone/virt-sysprep.pod:21
2617 msgid ""
2618 "Virt-sysprep is a simple shell script, allowing easy inspection or "
2619 "customization by the system administrator."
2620 msgstr ""
2621
2622 #. type: textblock
2623 #: ../clone/virt-sysprep.pod:24
2624 msgid ""
2625 "Virt-sysprep modifies the guest or disk image I<in place>.  The guest must "
2626 "be shut down.  If you want to preserve the existing contents of the guest, "
2627 "you I<must copy or clone the disk first>.  See L</COPYING AND CLONING> "
2628 "below."
2629 msgstr ""
2630
2631 #. type: textblock
2632 #: ../clone/virt-sysprep.pod:29
2633 msgid ""
2634 "You do I<not> need to run virt-sysprep as root.  In fact we'd generally "
2635 "recommend that you don't.  The time you might want to run it as root is when "
2636 "you need root in order to access the disk image, but even in this case it "
2637 "would be better to change the permissions on the disk image to be writable "
2638 "as the non-root user running virt-sysprep."
2639 msgstr ""
2640
2641 #. type: textblock
2642 #: ../clone/virt-sysprep.pod:35
2643 msgid ""
2644 "\"Sysprep\" stands for \"system preparation\" tool.  The name comes from the "
2645 "Microsoft program C<sysprep.exe> which is used to unconfigure Windows "
2646 "machines in preparation for cloning them.  Having said that, virt-sysprep "
2647 "does I<not> currently work on Microsoft Windows guests.  We plan to support "
2648 "Windows sysprepping in a future version, and we already have code to do it."
2649 msgstr ""
2650
2651 #. type: =item
2652 #: ../clone/virt-sysprep.pod:76
2653 msgid "B<--enable=...>"
2654 msgstr ""
2655
2656 #. type: textblock
2657 #: ../clone/virt-sysprep.pod:78
2658 msgid ""
2659 "Choose which sysprep operations to perform.  Give a comma-separated list of "
2660 "operations, for example:"
2661 msgstr ""
2662
2663 #. type: verbatim
2664 #: ../clone/virt-sysprep.pod:81
2665 #, no-wrap
2666 msgid ""
2667 " --enable=ssh-hostkeys,udev-persistent-net\n"
2668 "\n"
2669 msgstr ""
2670
2671 #. type: textblock
2672 #: ../clone/virt-sysprep.pod:83
2673 msgid "would enable ONLY C<ssh-hostkeys> and C<udev-persistent-net> operations."
2674 msgstr ""
2675
2676 #. type: textblock
2677 #: ../clone/virt-sysprep.pod:85
2678 msgid ""
2679 "If the I<--enable> option is not given, then we default to trying all "
2680 "possible sysprep operations.  But some sysprep operations are skipped for "
2681 "some guest types."
2682 msgstr ""
2683
2684 #. type: textblock
2685 #: ../clone/virt-sysprep.pod:89
2686 msgid ""
2687 "Use I<--list-operations> to list operations supported by a particular "
2688 "version of virt-sysprep."
2689 msgstr ""
2690
2691 #. type: textblock
2692 #: ../clone/virt-sysprep.pod:92
2693 msgid "See L</OPERATIONS> below for a list and an explanation of each operation."
2694 msgstr ""
2695
2696 #. type: verbatim
2697 #: ../clone/virt-sysprep.pod:106
2698 #, no-wrap
2699 msgid ""
2700 " virt-sysprep --format=raw -a disk.img\n"
2701 "\n"
2702 msgstr ""
2703
2704 #. type: verbatim
2705 #: ../clone/virt-sysprep.pod:110
2706 #, no-wrap
2707 msgid ""
2708 " virt-sysprep --format=raw -a disk.img --format -a another.img\n"
2709 "\n"
2710 msgstr ""
2711
2712 #. type: =item
2713 #: ../clone/virt-sysprep.pod:119
2714 msgid "B<--hostname> newhostname"
2715 msgstr ""
2716
2717 #. type: textblock
2718 #: ../clone/virt-sysprep.pod:121
2719 msgid ""
2720 "Change the hostname.  See the L</hostname> operation below.  If not given, "
2721 "defaults to C<localhost.localdomain>."
2722 msgstr ""
2723
2724 #. type: =item
2725 #: ../clone/virt-sysprep.pod:124
2726 msgid "B<--list-operations>"
2727 msgstr ""
2728
2729 #. type: textblock
2730 #: ../clone/virt-sysprep.pod:126
2731 msgid "List the operations supported by the virt-sysprep program."
2732 msgstr ""
2733
2734 #. type: =item
2735 #: ../clone/virt-sysprep.pod:128
2736 msgid "B<--selinux-relabel>"
2737 msgstr ""
2738
2739 #. type: =item
2740 #: ../clone/virt-sysprep.pod:130
2741 msgid "B<--no-selinux-relabel>"
2742 msgstr ""
2743
2744 #. type: textblock
2745 #: ../clone/virt-sysprep.pod:132
2746 msgid ""
2747 "I<--selinux-relabel> forces SELinux relabelling next time the guest boots.  "
2748 "I<--no-selinux-relabel> disables relabelling."
2749 msgstr ""
2750
2751 #. type: textblock
2752 #: ../clone/virt-sysprep.pod:135
2753 msgid ""
2754 "The default is to try to detect if SELinux relabelling is required.  See "
2755 "L</SELINUX RELABELLING> below for more details."
2756 msgstr ""
2757
2758 #. type: =head1
2759 #: ../clone/virt-sysprep.pod:156
2760 msgid "OPERATIONS"
2761 msgstr ""
2762
2763 #. type: textblock
2764 #: ../clone/virt-sysprep.pod:158
2765 msgid ""
2766 "If the I<--enable> option is I<not> given, then I<all sysprep operations are "
2767 "enabled>, although some are skipped depending on the type of guest."
2768 msgstr ""
2769
2770 #. type: textblock
2771 #: ../clone/virt-sysprep.pod:162
2772 msgid ""
2773 "Operations can be individually enabled using the I<--enable> option.  Use a "
2774 "comma-separated list, for example:"
2775 msgstr ""
2776
2777 #. type: verbatim
2778 #: ../clone/virt-sysprep.pod:165
2779 #, no-wrap
2780 msgid ""
2781 " virt-sysprep --enable=ssh-hostkeys,udev-persistent-net [etc..]\n"
2782 "\n"
2783 msgstr ""
2784
2785 #. type: textblock
2786 #: ../clone/virt-sysprep.pod:167
2787 msgid ""
2788 "To list the operations supported by the current version of virt-sysprep, use "
2789 "I<--list-operations>."
2790 msgstr ""
2791
2792 #. type: textblock
2793 #: ../clone/virt-sysprep.pod:170
2794 msgid ""
2795 "Future versions of virt-sysprep may add more operations.  If you are using "
2796 "virt-sysprep and want predictable behaviour, specify only the operations "
2797 "that you want to have enabled."
2798 msgstr ""
2799
2800 #. type: =head2
2801 #: ../clone/virt-sysprep.pod:174
2802 msgid "cron-spool"
2803 msgstr ""
2804
2805 #. type: textblock
2806 #: ../clone/virt-sysprep.pod:176
2807 msgid "Remove user at-jobs and cron-jobs."
2808 msgstr ""
2809
2810 #. type: =head2
2811 #: ../clone/virt-sysprep.pod:178
2812 msgid "dhcp-client-state"
2813 msgstr ""
2814
2815 #. type: textblock
2816 #: ../clone/virt-sysprep.pod:180
2817 msgid "Remove DHCP client leases."
2818 msgstr ""
2819
2820 #. type: =head2
2821 #: ../clone/virt-sysprep.pod:182
2822 msgid "dhcp-server-state"
2823 msgstr ""
2824
2825 #. type: textblock
2826 #: ../clone/virt-sysprep.pod:184
2827 msgid "Remove DHCP server leases."
2828 msgstr ""
2829
2830 #. type: =head2
2831 #: ../clone/virt-sysprep.pod:186
2832 msgid "hostname"
2833 msgstr ""
2834
2835 #. type: textblock
2836 #: ../clone/virt-sysprep.pod:188
2837 msgid ""
2838 "Changes the hostname of the guest to the value given in the I<--hostname> "
2839 "parameter."
2840 msgstr ""
2841
2842 #. type: textblock
2843 #: ../clone/virt-sysprep.pod:191
2844 msgid ""
2845 "If the I<--hostname> parameter is not given, then the hostname is changed to "
2846 "C<localhost.localdomain>."
2847 msgstr ""
2848
2849 #. type: =head2
2850 #: ../clone/virt-sysprep.pod:194
2851 msgid "logfiles"
2852 msgstr ""
2853
2854 #. type: textblock
2855 #: ../clone/virt-sysprep.pod:196
2856 msgid "Remove many log files."
2857 msgstr ""
2858
2859 #. type: =head2
2860 #: ../clone/virt-sysprep.pod:198
2861 msgid "mail-spool"
2862 msgstr ""
2863
2864 #. type: textblock
2865 #: ../clone/virt-sysprep.pod:200
2866 msgid "Remove email from the local mail spool directory."
2867 msgstr ""
2868
2869 #. type: =head2
2870 #: ../clone/virt-sysprep.pod:202
2871 msgid "net-hwaddr"
2872 msgstr ""
2873
2874 #. type: textblock
2875 #: ../clone/virt-sysprep.pod:204
2876 msgid ""
2877 "Remove HWADDR (hard-coded MAC address) configuration.  For Fedora and Red "
2878 "Hat Enterprise Linux, this is removed from C<ifcfg-*> files."
2879 msgstr ""
2880
2881 #. type: =head2
2882 #: ../clone/virt-sysprep.pod:207
2883 msgid "random-seed"
2884 msgstr ""
2885
2886 #. type: textblock
2887 #: ../clone/virt-sysprep.pod:209
2888 msgid ""
2889 "Write some random bytes from the host into the random seed file of the "
2890 "guest."
2891 msgstr ""
2892
2893 #. type: textblock
2894 #: ../clone/virt-sysprep.pod:212
2895 msgid "See L</RANDOM SEED> below."
2896 msgstr ""
2897
2898 #. type: =head2
2899 #: ../clone/virt-sysprep.pod:214
2900 msgid "rhn-systemid"
2901 msgstr ""
2902
2903 #. type: textblock
2904 #: ../clone/virt-sysprep.pod:216
2905 msgid "Remove the RHN system ID."
2906 msgstr ""
2907
2908 #. type: =head2
2909 #: ../clone/virt-sysprep.pod:218
2910 msgid "smolt-uuid"
2911 msgstr ""
2912
2913 #. type: textblock
2914 #: ../clone/virt-sysprep.pod:220
2915 msgid "Remove the Smolt hardware UUID."
2916 msgstr ""
2917
2918 #. type: =head2
2919 #: ../clone/virt-sysprep.pod:222
2920 msgid "ssh-hostkeys"
2921 msgstr ""
2922
2923 #. type: textblock
2924 #: ../clone/virt-sysprep.pod:224
2925 msgid "Remove the SSH host keys in the guest."
2926 msgstr ""
2927
2928 #. type: textblock
2929 #: ../clone/virt-sysprep.pod:226
2930 msgid ""
2931 "The SSH host keys are regenerated (differently) next time the guest is "
2932 "booted."
2933 msgstr ""
2934
2935 #. type: textblock
2936 #: ../clone/virt-sysprep.pod:229
2937 msgid ""
2938 "If, after cloning, the guest gets the same IP address, ssh will give you a "
2939 "stark warning about the host key changing:"
2940 msgstr ""
2941
2942 #. type: verbatim
2943 #: ../clone/virt-sysprep.pod:232
2944 #, no-wrap
2945 msgid ""
2946 " @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@\n"
2947 " @    WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED!     @\n"
2948 " @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@\n"
2949 " IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!\n"
2950 "\n"
2951 msgstr ""
2952
2953 #. type: =head2
2954 #: ../clone/virt-sysprep.pod:237
2955 msgid "udev-persistent-net"
2956 msgstr ""
2957
2958 #. type: textblock
2959 #: ../clone/virt-sysprep.pod:239
2960 msgid ""
2961 "Remove udev persistent net rules which map the guest's existing MAC address "
2962 "to a fixed ethernet device (eg. eth0)."
2963 msgstr ""
2964
2965 #. type: textblock
2966 #: ../clone/virt-sysprep.pod:242
2967 msgid ""
2968 "After a guest is cloned, the MAC address usually changes.  Since the old MAC "
2969 "address occupies the old name (eg. eth0), this means the fresh MAC address "
2970 "is assigned to a new name (eg. eth1) and this is usually undesirable.  "
2971 "Erasing the udev persistent net rules avoids this."
2972 msgstr ""
2973
2974 #. type: =head2
2975 #: ../clone/virt-sysprep.pod:247
2976 msgid "utmp"
2977 msgstr ""
2978
2979 #. type: textblock
2980 #: ../clone/virt-sysprep.pod:249
2981 msgid "Remove the utmp file."
2982 msgstr ""
2983
2984 #. type: textblock
2985 #: ../clone/virt-sysprep.pod:251
2986 msgid ""
2987 "This records who is currently logged in on a machine.  In modern Linux "
2988 "distros it is stored in a ramdisk and hence not part of the virtual "
2989 "machine's disk, but it was stored on disk in older distros."
2990 msgstr ""
2991
2992 #. type: =head2
2993 #: ../clone/virt-sysprep.pod:255
2994 msgid "yum-uuid"
2995 msgstr ""
2996
2997 #. type: textblock
2998 #: ../clone/virt-sysprep.pod:257
2999 msgid "Remove the yum UUID."
3000 msgstr ""
3001
3002 #. type: textblock
3003 #: ../clone/virt-sysprep.pod:259
3004 msgid ""
3005 "Yum creates a fresh UUID the next time it runs when it notices that the "
3006 "original UUID has been erased."
3007 msgstr ""
3008
3009 #. type: =head1
3010 #: ../clone/virt-sysprep.pod:262
3011 msgid "COPYING AND CLONING"
3012 msgstr ""
3013
3014 #. type: textblock
3015 #: ../clone/virt-sysprep.pod:264
3016 msgid ""
3017 "Virt-sysprep can be used as part of a process of cloning guests, or to "
3018 "prepare a template from which guests can be cloned.  There are many "
3019 "different ways to achieve this using the virt tools, and this section is "
3020 "just an introduction."
3021 msgstr ""
3022
3023 #. type: textblock
3024 #: ../clone/virt-sysprep.pod:269
3025 msgid "A virtual machine (when switched off) consists of two parts:"
3026 msgstr ""
3027
3028 #. type: =item
3029 #: ../clone/virt-sysprep.pod:273
3030 msgid "I<configuration>"
3031 msgstr ""
3032
3033 #. type: textblock
3034 #: ../clone/virt-sysprep.pod:275
3035 msgid ""
3036 "The configuration or description of the guest.  eg. The libvirt XML (see "
3037 "C<virsh dumpxml>), the running configuration of the guest, or another "
3038 "external format like OVF."
3039 msgstr ""
3040
3041 #. type: textblock
3042 #: ../clone/virt-sysprep.pod:279
3043 msgid "Some configuration items that might need to be changed:"
3044 msgstr ""
3045
3046 #. type: textblock
3047 #: ../clone/virt-sysprep.pod:285
3048 msgid "name"
3049 msgstr ""
3050
3051 #. type: textblock
3052 #: ../clone/virt-sysprep.pod:289 ../clone/virt-sysprep.pod:316
3053 msgid "UUID"
3054 msgstr ""
3055
3056 #. type: textblock
3057 #: ../clone/virt-sysprep.pod:293
3058 msgid "path to block device(s)"
3059 msgstr ""
3060
3061 #. type: textblock
3062 #: ../clone/virt-sysprep.pod:297
3063 msgid "network card MAC address"
3064 msgstr ""
3065
3066 #. type: =item
3067 #: ../clone/virt-sysprep.pod:301
3068 msgid "I<block device(s)>"
3069 msgstr ""
3070
3071 #. type: textblock
3072 #: ../clone/virt-sysprep.pod:303
3073 msgid ""
3074 "One or more hard disk images, themselves containing files, directories, "
3075 "applications, kernels, configuration, etc."
3076 msgstr ""
3077
3078 #. type: textblock
3079 #: ../clone/virt-sysprep.pod:306
3080 msgid "Some things inside the block devices that might need to be changed:"
3081 msgstr ""
3082
3083 #. type: textblock
3084 #: ../clone/virt-sysprep.pod:312
3085 msgid "hostname and other net configuration"
3086 msgstr ""
3087
3088 #. type: textblock
3089 #: ../clone/virt-sysprep.pod:320
3090 msgid "SSH host keys"
3091 msgstr ""
3092
3093 #. type: textblock
3094 #: ../clone/virt-sysprep.pod:324
3095 msgid "Windows unique security ID (SID)"
3096 msgstr ""
3097
3098 #. type: textblock
3099 #: ../clone/virt-sysprep.pod:328
3100 msgid "Puppet registration"
3101 msgstr ""
3102
3103 #. type: =head2
3104 #: ../clone/virt-sysprep.pod:334
3105 msgid "COPYING THE BLOCK DEVICE"
3106 msgstr ""
3107
3108 #. type: textblock
3109 #: ../clone/virt-sysprep.pod:336
3110 msgid ""
3111 "Starting with an original guest, you probably wish to copy the guest block "
3112 "device and its configuration to make a template.  Then once you are happy "
3113 "with the template, you will want to make many clones from it."
3114 msgstr ""
3115
3116 #. type: verbatim
3117 #: ../clone/virt-sysprep.pod:341
3118 #, no-wrap
3119 msgid ""
3120 "                        virt-sysprep\n"
3121 "                             |\n"
3122 "                             v\n"
3123 " original guest --------> template ---------->\n"
3124 "                                      \\------> cloned\n"
3125 "                                       \\-----> guests\n"
3126 "                                        \\---->\n"
3127 "\n"
3128 msgstr ""
3129
3130 #. type: textblock
3131 #: ../clone/virt-sysprep.pod:349
3132 msgid ""
3133 "You can, of course, just copy the block device on the host using L<cp(1)> or "
3134 "L<dd(1)>."
3135 msgstr ""
3136
3137 #. type: verbatim
3138 #: ../clone/virt-sysprep.pod:352
3139 #, no-wrap
3140 msgid ""
3141 "                   dd                 dd\n"
3142 " original guest --------> template ---------->\n"
3143 "                                      \\------> cloned\n"
3144 "                                       \\-----> guests\n"
3145 "                                        \\---->\n"
3146 "\n"
3147 msgstr ""
3148
3149 #. type: textblock
3150 #: ../clone/virt-sysprep.pod:358
3151 msgid "There are some smarter (and faster) ways too:"
3152 msgstr ""
3153
3154 #. type: verbatim
3155 #: ../clone/virt-sysprep.pod:364
3156 #, no-wrap
3157 msgid ""
3158 "                          snapshot\n"
3159 "                template ---------->\n"
3160 "                            \\------> cloned\n"
3161 "                             \\-----> guests\n"
3162 "                              \\---->\n"
3163 "\n"
3164 msgstr ""
3165
3166 #. type: textblock
3167 #: ../clone/virt-sysprep.pod:370
3168 msgid ""
3169 "Use the block device as a backing file and create a snapshot on top for each "
3170 "guest.  The advantage is that you don't need to copy the block device (very "
3171 "fast) and only changes are stored (less storage required)."
3172 msgstr ""
3173
3174 #. type: textblock
3175 #: ../clone/virt-sysprep.pod:375
3176 msgid ""
3177 "Note that writing to the backing file once you have created guests on top of "
3178 "it is not possible: you will corrupt the guests."
3179 msgstr ""
3180
3181 #. type: textblock
3182 #: ../clone/virt-sysprep.pod:378
3183 msgid ""
3184 "Tools that can do this include: L<qemu-img(1)> (with the I<create -f qcow2 "
3185 "-o backing_file> option), L<lvcreate(8)> (I<--snapshot> option).  Some "
3186 "filesystems (such as btrfs) and most Network Attached Storage devices can "
3187 "also create cheap snapshots from files or LUNs."
3188 msgstr ""
3189
3190 #. type: textblock
3191 #: ../clone/virt-sysprep.pod:386
3192 msgid "Get your NAS to snapshot and/or duplicate the LUN."
3193 msgstr ""
3194
3195 #. type: textblock
3196 #: ../clone/virt-sysprep.pod:390
3197 msgid "Prepare your template using L<virt-sparsify(1)>.  See below."
3198 msgstr ""
3199
3200 #. type: =head2
3201 #: ../clone/virt-sysprep.pod:394
3202 msgid "VIRT-CLONE"
3203 msgstr ""
3204
3205 #. type: textblock
3206 #: ../clone/virt-sysprep.pod:396
3207 msgid ""
3208 "A separate tool, L<virt-clone(1)>, can be used to duplicate the block device "
3209 "and/or modify the external libvirt configuration of a guest.  It will reset "
3210 "the name, UUID and MAC address of the guest in the libvirt XML."
3211 msgstr ""
3212
3213 #. type: textblock
3214 #: ../clone/virt-sysprep.pod:401
3215 msgid ""
3216 "L<virt-clone(1)> does not use libguestfs and cannot look inside the disk "
3217 "image.  This was the original motivation to write virt-sysprep."
3218 msgstr ""
3219
3220 #. type: =head2
3221 #: ../clone/virt-sysprep.pod:404
3222 msgid "SPARSIFY"
3223 msgstr ""
3224
3225 #. type: verbatim
3226 #: ../clone/virt-sysprep.pod:406
3227 #, no-wrap
3228 msgid ""
3229 "              virt-sparsify\n"
3230 " original guest --------> template\n"
3231 "\n"
3232 msgstr ""
3233
3234 #. type: textblock
3235 #: ../clone/virt-sysprep.pod:409
3236 msgid ""
3237 "L<virt-sparsify(1)> can be used to make the cloning template smaller, making "
3238 "it easier to compress and/or faster to copy."
3239 msgstr ""
3240
3241 #. type: textblock
3242 #: ../clone/virt-sysprep.pod:412
3243 msgid ""
3244 "Notice that since virt-sparsify also copies the image, you can use it to "
3245 "make the initial copy (instead of C<dd>)."
3246 msgstr ""
3247
3248 #. type: =head2
3249 #: ../clone/virt-sysprep.pod:415
3250 msgid "RESIZE"
3251 msgstr ""
3252
3253 #. type: verbatim
3254 #: ../clone/virt-sysprep.pod:417
3255 #, no-wrap
3256 msgid ""
3257 "                         virt-resize\n"
3258 "                template ---------->\n"
3259 "                            \\------> cloned\n"
3260 "                             \\-----> guests\n"
3261 "                              \\---->\n"
3262 "\n"
3263 msgstr ""
3264
3265 #. type: textblock
3266 #: ../clone/virt-sysprep.pod:423
3267 msgid ""
3268 "If you want to give people cloned guests, but let them pick the size of the "
3269 "guest themselves (eg. depending on how much they are prepared to pay for "
3270 "disk space), then instead of copying the template, you can run "
3271 "L<virt-resize(1)>.  Virt-resize performs a copy and resize, and thus is "
3272 "ideal for cloning guests from a template."
3273 msgstr ""
3274
3275 #. type: =head1
3276 #: ../clone/virt-sysprep.pod:429 ../src/guestfs.pod:1164
3277 msgid "SECURITY"
3278 msgstr ""
3279
3280 #. type: textblock
3281 #: ../clone/virt-sysprep.pod:431
3282 msgid ""
3283 "Although virt-sysprep removes some sensitive information from the guest, it "
3284 "does not pretend to remove all of it.  You should examine the L</OPERATIONS> "
3285 "above, and the implementation of the operations in the shell script.  You "
3286 "should also examine the guest afterwards."
3287 msgstr ""
3288
3289 #. type: textblock
3290 #: ../clone/virt-sysprep.pod:436
3291 msgid ""
3292 "Sensitive files are simply removed.  The data they contained may still exist "
3293 "on the disk, easily recovered with a hex editor or undelete tool.  Use "
3294 "L<virt-sparsify(1)> as one way to remove this content.  See also the "
3295 "L<scrub(1)> command to get rid of deleted content in directory entries and "
3296 "inodes."
3297 msgstr ""
3298
3299 #. type: =head2
3300 #: ../clone/virt-sysprep.pod:442
3301 msgid "RANDOM SEED"
3302 msgstr ""
3303
3304 #. type: textblock
3305 #: ../clone/virt-sysprep.pod:444
3306 msgid "I<(This section applies to Linux guests only)>"
3307 msgstr ""
3308
3309 #. type: textblock
3310 #: ../clone/virt-sysprep.pod:446
3311 msgid ""
3312 "The virt-sysprep C<random-seed> operation writes a few bytes of randomness "
3313 "from the host into the guest's random seed file."
3314 msgstr ""
3315
3316 #. type: textblock
3317 #: ../clone/virt-sysprep.pod:449
3318 msgid ""
3319 "If this is just done once and the guest is cloned from the same template, "
3320 "then each guest will start with the same entropy, and things like SSH host "
3321 "keys and TCP sequence numbers may be predictable."
3322 msgstr ""
3323
3324 #. type: textblock
3325 #: ../clone/virt-sysprep.pod:453
3326 msgid ""
3327 "Therefore you should arrange to add more randomness I<after> cloning from a "
3328 "template too, which can be done by just enabling the C<random-seed> "
3329 "operation:"
3330 msgstr ""
3331
3332 #. type: verbatim
3333 #: ../clone/virt-sysprep.pod:457
3334 #, no-wrap
3335 msgid ""
3336 " cp template.img newguest.img\n"
3337 " virt-sysprep --enable=random-seed -a newguest.img\n"
3338 "\n"
3339 msgstr ""
3340
3341 #. type: =head2
3342 #: ../clone/virt-sysprep.pod:460
3343 msgid "SELINUX RELABELLING"
3344 msgstr ""
3345
3346 #. type: textblock
3347 #: ../clone/virt-sysprep.pod:462
3348 msgid "I<(This section applies to Linux guests using SELinux only)>"
3349 msgstr ""
3350
3351 #. type: textblock
3352 #: ../clone/virt-sysprep.pod:464
3353 msgid ""
3354 "If any new files are created by virt-sysprep, then virt-sysprep touches "
3355 "C</.autorelabel> so that these will be correctly labelled by SELinux the "
3356 "next time the guest is booted.  This process interrupts boot and can take "
3357 "some time."
3358 msgstr ""
3359
3360 #. type: textblock
3361 #: ../clone/virt-sysprep.pod:469
3362 msgid ""
3363 "You can force relabelling for all guests by supplying the "
3364 "I<--selinux-relabel> option."
3365 msgstr ""
3366
3367 #. type: textblock
3368 #: ../clone/virt-sysprep.pod:472
3369 msgid ""
3370 "You can disable relabelling entirely by supplying the "
3371 "I<--no-selinux-relabel> option."
3372 msgstr ""
3373
3374 #. type: textblock
3375 #: ../clone/virt-sysprep.pod:484
3376 msgid "This program returns 0 on success, or 1 if there was an error."
3377 msgstr ""
3378
3379 #. type: textblock
3380 #: ../clone/virt-sysprep.pod:488
3381 msgid ""
3382 "L<guestfs(3)>, L<guestfish(1)>, L<virt-clone(1)>, L<virt-rescue(1)>, "
3383 "L<virt-resize(1)>, L<virt-sparsify(1)>, L<virsh(1)>, L<lvcreate(8)>, "
3384 "L<qemu-img(1)>, L<scrub(1)>, L<http://libguestfs.org/>, "
3385 "L<http://libvirt.org/>."
3386 msgstr ""
3387
3388 #. type: textblock
3389 #: ../df/virt-df.pod:5
3390 msgid "virt-df - Display free space on virtual filesystems"
3391 msgstr ""
3392
3393 #. type: verbatim
3394 #: ../df/virt-df.pod:9
3395 #, no-wrap
3396 msgid ""
3397 " virt-df [--options]\n"
3398 "\n"
3399 msgstr ""
3400
3401 #. type: verbatim
3402 #: ../df/virt-df.pod:11
3403 #, no-wrap
3404 msgid ""
3405 " virt-df [--options] -d domname\n"
3406 "\n"
3407 msgstr ""
3408
3409 #. type: verbatim
3410 #: ../df/virt-df.pod:13
3411 #, no-wrap
3412 msgid ""
3413 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
3414 "\n"
3415 msgstr ""
3416
3417 #. type: verbatim
3418 #: ../df/virt-df.pod:17
3419 #, no-wrap
3420 msgid ""
3421 " virt-df [--options] domname\n"
3422 "\n"
3423 msgstr ""
3424
3425 #. type: verbatim
3426 #: ../df/virt-df.pod:19
3427 #, no-wrap
3428 msgid ""
3429 " virt-df [--options] disk.img [disk.img ...]\n"
3430 "\n"
3431 msgstr ""
3432
3433 #. type: textblock
3434 #: ../df/virt-df.pod:23
3435 msgid ""
3436 "C<virt-df> is a command line tool to display free space on virtual machine "
3437 "filesystems.  Unlike other tools, it doesn't just display the size of disk "
3438 "allocated to a virtual machine, but can look inside disk images to see how "
3439 "much space is really being used."
3440 msgstr ""
3441
3442 #. type: textblock
3443 #: ../df/virt-df.pod:28
3444 msgid ""
3445 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
3446 "to get a list of all active and inactive guests, and performs a C<df>-type "
3447 "operation on each one in turn, printing out the results."
3448 msgstr ""
3449
3450 #. type: textblock
3451 #: ../df/virt-df.pod:32
3452 msgid ""
3453 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a "
3454 "C<df>-type operation on either the single named libvirt domain, or on the "
3455 "disk image(s) listed on the command line (which must all belong to a single "
3456 "VM).  In this mode (with arguments), C<virt-df> will I<only work for a "
3457 "single guest>.  If you want to run on multiple guests, then you have to "
3458 "invoke C<virt-df> multiple times."
3459 msgstr ""
3460
3461 #. type: textblock
3462 #: ../df/virt-df.pod:39
3463 msgid ""
3464 "Use the I<--csv> option to get a format which can be easily parsed by other "
3465 "programs.  Other options are similar to the standard L<df(1)> command."
3466 msgstr ""
3467
3468 #. type: textblock
3469 #: ../df/virt-df.pod:45
3470 msgid ""
3471 "Show disk usage for a single libvirt guest called C<F14x64>.  Make the "
3472 "output human-readable:"
3473 msgstr ""
3474
3475 #. type: verbatim
3476 #: ../df/virt-df.pod:48
3477 #, no-wrap
3478 msgid ""
3479 " # virt-df -d F14x64 -h\n"
3480 " Filesystem                       Size     Used  Available  Use%\n"
3481 " F14x64:/dev/sda1                 484M      66M       393M   14%\n"
3482 " F14x64:/dev/vg_f13x64/lv_root    7.4G     3.4G       4.0G   46%\n"
3483 "\n"
3484 msgstr ""
3485
3486 #. type: textblock
3487 #: ../df/virt-df.pod:53
3488 msgid "Show disk usage for a disk image file called C<test.img>:"
3489 msgstr ""
3490
3491 #. type: verbatim
3492 #: ../df/virt-df.pod:55
3493 #, no-wrap
3494 msgid ""
3495 " $ virt-df -a test1.img\n"
3496 " Filesystem                  1K-blocks     Used  Available  Use%\n"
3497 " test1.img:/dev/sda1             99099     1551      92432    2%\n"
3498 "\n"
3499 msgstr ""
3500
3501 #. type: verbatim
3502 #: ../df/virt-df.pod:112
3503 #, no-wrap
3504 msgid ""
3505 " virt-df --format=raw -a disk.img\n"
3506 "\n"
3507 msgstr ""
3508
3509 #. type: verbatim
3510 #: ../df/virt-df.pod:116
3511 #, no-wrap
3512 msgid ""
3513 " virt-df --format=raw -a disk.img --format -a another.img\n"
3514 "\n"
3515 msgstr ""
3516
3517 #. type: textblock
3518 #: ../df/virt-df.pod:129
3519 msgid "Print sizes in human-readable format."
3520 msgstr ""
3521
3522 #. type: textblock
3523 #: ../df/virt-df.pod:131
3524 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
3525 msgstr ""
3526
3527 #. type: =item
3528 #: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:164
3529 msgid "B<-i>"
3530 msgstr ""
3531
3532 #. type: =item
3533 #: ../df/virt-df.pod:135
3534 msgid "B<--inodes>"
3535 msgstr ""
3536
3537 #. type: textblock
3538 #: ../df/virt-df.pod:137
3539 msgid "Print inodes instead of blocks."
3540 msgstr ""
3541
3542 #. type: =item
3543 #: ../df/virt-df.pod:139
3544 msgid "B<--one-per-guest>"
3545 msgstr ""
3546
3547 #. type: textblock
3548 #: ../df/virt-df.pod:141
3549 msgid ""
3550 "Run one libguestfs appliance per guest.  Normally C<virt-df> will add the "
3551 "disks from several guests to a single libguestfs appliance."
3552 msgstr ""
3553
3554 #. type: textblock
3555 #: ../df/virt-df.pod:144
3556 msgid "You might use this option in the following circumstances:"
3557 msgstr ""
3558
3559 #. type: textblock
3560 #: ../df/virt-df.pod:150
3561 msgid ""
3562 "If you think an untrusted guest might actively try to exploit the libguestfs "
3563 "appliance kernel, then this prevents one guest from interfering with the "
3564 "stats printed for another guest."
3565 msgstr ""
3566
3567 #. type: textblock
3568 #: ../df/virt-df.pod:156
3569 msgid ""
3570 "If the kernel has a bug which stops it from accessing a filesystem in one "
3571 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
3572 "and report stats for further guests."
3573 msgstr ""
3574
3575 #. type: textblock
3576 #: ../df/virt-df.pod:165
3577 msgid ""
3578 "Print UUIDs instead of names.  This is useful for following a guest even "
3579 "when the guest is migrated or renamed, or when two guests happen to have the "
3580 "same name."
3581 msgstr ""
3582
3583 #. type: textblock
3584 #: ../df/virt-df.pod:169
3585 msgid ""
3586 "Note that only domains that we fetch from libvirt come with UUIDs.  For disk "
3587 "images, we still print the disk image name even when this option is "
3588 "specified."
3589 msgstr ""
3590
3591 #. type: textblock
3592 #: ../df/virt-df.pod:229
3593 msgid ""
3594 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
3595 "L<http://libguestfs.org/>."
3596 msgstr ""
3597
3598 #. type: textblock
3599 #: ../edit/virt-edit.pod:5
3600 msgid "virt-edit - Edit a file in a virtual machine"
3601 msgstr ""
3602
3603 #. type: verbatim
3604 #: ../edit/virt-edit.pod:9
3605 #, no-wrap
3606 msgid ""
3607 " virt-edit [--options] -d domname file [file ...]\n"
3608 "\n"
3609 msgstr ""
3610
3611 #. type: verbatim
3612 #: ../edit/virt-edit.pod:11
3613 #, no-wrap
3614 msgid ""
3615 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
3616 "\n"
3617 msgstr ""
3618
3619 #. type: verbatim
3620 #: ../edit/virt-edit.pod:13
3621 #, no-wrap
3622 msgid ""
3623 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
3624 "\n"
3625 msgstr ""
3626
3627 #. type: verbatim
3628 #: ../edit/virt-edit.pod:17
3629 #, no-wrap
3630 msgid ""
3631 " virt-edit domname file\n"
3632 "\n"
3633 msgstr ""
3634
3635 #. type: verbatim
3636 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
3637 #, no-wrap
3638 msgid ""
3639 " virt-edit disk.img [disk.img ...] file\n"
3640 "\n"
3641 msgstr ""
3642
3643 #. type: =head1
3644 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23 ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15 ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:21 ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51
3645 msgid "WARNING"
3646 msgstr ""
3647
3648 #. type: textblock
3649 #: ../edit/virt-edit.pod:23
3650 msgid ""
3651 "You must I<not> use C<virt-edit> on live virtual machines.  If you do this, "
3652 "you risk disk corruption in the VM.  C<virt-edit> tries to stop you from "
3653 "doing this, but doesn't catch all cases."
3654 msgstr ""
3655
3656 #. type: textblock
3657 #: ../edit/virt-edit.pod:29
3658 msgid ""
3659 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
3660 "exists in the named virtual machine (or disk image)."
3661 msgstr ""
3662
3663 #. type: textblock
3664 #: ../edit/virt-edit.pod:32
3665 msgid ""
3666 "Multiple filenames can be given, in which case they are each edited in "
3667 "turn.  Each filename must be a full path, starting at the root directory "
3668 "(starting with '/')."
3669 msgstr ""
3670
3671 #. type: textblock
3672 #: ../edit/virt-edit.pod:36
3673 msgid "If you want to just view a file, use L<virt-cat(1)>."
3674 msgstr ""
3675
3676 #. type: textblock
3677 #: ../edit/virt-edit.pod:38
3678 msgid ""
3679 "For more complex cases you should look at the L<guestfish(1)> tool (see "
3680 "L</USING GUESTFISH> below)."
3681 msgstr ""
3682
3683 #. type: textblock
3684 #: ../edit/virt-edit.pod:41
3685 msgid ""
3686 "C<virt-edit> cannot be used to create a new file.  L<guestfish(1)> can do "
3687 "that and much more."
3688 msgstr ""
3689
3690 #. type: textblock
3691 #: ../edit/virt-edit.pod:46
3692 msgid "Edit the named files interactively:"
3693 msgstr ""
3694
3695 #. type: verbatim
3696 #: ../edit/virt-edit.pod:48
3697 #, no-wrap
3698 msgid ""
3699 " virt-edit -d mydomain /boot/grub/grub.conf\n"
3700 "\n"
3701 msgstr ""
3702
3703 #. type: verbatim
3704 #: ../edit/virt-edit.pod:50
3705 #, no-wrap
3706 msgid ""
3707 " virt-edit -d mydomain /etc/passwd\n"
3708 "\n"
3709 msgstr ""
3710
3711 #. type: textblock
3712 #: ../edit/virt-edit.pod:52
3713 msgid "For Windows guests, some Windows paths are understood:"
3714 msgstr ""
3715
3716 #. type: verbatim
3717 #: ../edit/virt-edit.pod:54
3718 #, no-wrap
3719 msgid ""
3720 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
3721 "\n"
3722 msgstr ""
3723
3724 #. type: textblock
3725 #: ../edit/virt-edit.pod:56
3726 msgid ""
3727 "If Perl is installed, you can also edit files non-interactively (see "
3728 "L</NON-INTERACTIVE EDITING> below).  To change the init default level to 5:"
3729 msgstr ""
3730
3731 #. type: verbatim
3732 #: ../edit/virt-edit.pod:60
3733 #, no-wrap
3734 msgid ""
3735 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
3736 "\n"
3737 msgstr ""
3738
3739 #. type: =item
3740 #: ../edit/virt-edit.pod:81
3741 msgid "B<-b> extension"
3742 msgstr ""
3743
3744 #. type: =item
3745 #: ../edit/virt-edit.pod:83
3746 msgid "B<--backup> extension"
3747 msgstr ""
3748
3749 #. type: textblock
3750 #: ../edit/virt-edit.pod:85
3751 msgid ""
3752 "Create a backup of the original file I<in the guest disk image>.  The backup "
3753 "has the original filename with C<extension> added."
3754 msgstr ""
3755
3756 #. type: textblock
3757 #: ../edit/virt-edit.pod:88
3758 msgid ""
3759 "Usually the first character of C<extension> would be a dot C<.> so you would "
3760 "write:"
3761 msgstr ""
3762
3763 #. type: verbatim
3764 #: ../edit/virt-edit.pod:91
3765 #, no-wrap
3766 msgid ""
3767 " virt-edit -b .orig [etc]\n"
3768 "\n"
3769 msgstr ""
3770
3771 #. type: textblock
3772 #: ../edit/virt-edit.pod:93
3773 msgid "By default, no backup file is made."
3774 msgstr ""
3775
3776 #. type: =item
3777 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181 ../fuse/guestmount.pod:105 ../inspector/virt-inspector.pod:74 ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78 ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
3778 msgid "B<-c URI>"
3779 msgstr ""
3780
3781 #. type: =item
3782 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183 ../fuse/guestmount.pod:107 ../inspector/virt-inspector.pod:76 ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80 ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
3783 msgid "B<--connect URI>"
3784 msgstr ""
3785
3786 #. type: textblock
3787 #: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84 ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134 ../tools/virt-win-reg.pl:135
3788 msgid ""
3789 "If you specify guest block devices directly, then libvirt is not used at "
3790 "all."
3791 msgstr ""
3792
3793 #. type: textblock
3794 #: ../edit/virt-edit.pod:114
3795 msgid ""
3796 "When prompting for keys and passphrases, virt-edit normally turns echoing "
3797 "off so you cannot see what you are typing.  If you are not worried about "
3798 "Tempest attacks and there is no one else in the room you can specify this "
3799 "flag to see what you are typing."
3800 msgstr ""
3801
3802 #. type: =item
3803 #: ../edit/virt-edit.pod:119
3804 msgid "B<-e> EXPR"
3805 msgstr ""
3806
3807 #. type: =item
3808 #: ../edit/virt-edit.pod:121
3809 msgid "B<--expr> EXPR"
3810 msgstr ""
3811
3812 #. type: textblock
3813 #: ../edit/virt-edit.pod:123
3814 msgid ""
3815 "Instead of launching the external editor, non-interactively apply the Perl "
3816 "expression C<EXPR> to each line in the file.  See L</NON-INTERACTIVE "
3817 "EDITING> below."
3818 msgstr ""
3819
3820 #. type: textblock
3821 #: ../edit/virt-edit.pod:127
3822 msgid ""
3823 "Be careful to properly quote the expression to prevent it from being altered "
3824 "by the shell."
3825 msgstr ""
3826
3827 #. type: textblock
3828 #: ../edit/virt-edit.pod:130
3829 msgid "Note that this option is only available when Perl 5 is installed."
3830 msgstr ""
3831
3832 #. type: =item
3833 #: ../edit/virt-edit.pod:132
3834 msgid "B<--format> raw|qcow2|..."
3835 msgstr ""
3836
3837 #. type: verbatim
3838 #: ../edit/virt-edit.pod:143
3839 #, no-wrap
3840 msgid ""
3841 " virt-edit --format=raw -a disk.img file\n"
3842 "\n"
3843 msgstr ""
3844
3845 #. type: verbatim
3846 #: ../edit/virt-edit.pod:147
3847 #, no-wrap
3848 msgid ""
3849 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
3850 "\n"
3851 msgstr ""
3852
3853 #. type: textblock
3854 #: ../edit/virt-edit.pod:181
3855 msgid "Previous versions of virt-edit allowed you to write either:"
3856 msgstr ""
3857
3858 #. type: verbatim
3859 #: ../edit/virt-edit.pod:187
3860 #, no-wrap
3861 msgid ""
3862 " virt-edit guestname file\n"
3863 "\n"
3864 msgstr ""
3865
3866 #. type: =head1
3867 #: ../edit/virt-edit.pod:195
3868 msgid "NON-INTERACTIVE EDITING"
3869 msgstr ""
3870
3871 #. type: textblock
3872 #: ../edit/virt-edit.pod:197
3873 msgid ""
3874 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
3875 "administrator can interactively edit the file."
3876 msgstr ""
3877
3878 #. type: textblock
3879 #: ../edit/virt-edit.pod:200
3880 msgid ""
3881 "There are two ways also to use C<virt-edit> from scripts in order to make "
3882 "automated edits to files.  (Note that although you I<can> use C<virt-edit> "
3883 "like this, it's less error-prone to write scripts directly using the "
3884 "libguestfs API and Augeas for configuration file editing.)"
3885 msgstr ""
3886
3887 #. type: textblock
3888 #: ../edit/virt-edit.pod:206
3889 msgid ""
3890 "The first method is to temporarily set C<$EDITOR> to any script or program "
3891 "you want to run.  The script is invoked as C<$EDITOR tmpfile> and it should "
3892 "update C<tmpfile> in place however it likes."
3893 msgstr ""
3894
3895 #. type: textblock
3896 #: ../edit/virt-edit.pod:210
3897 msgid ""
3898 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
3899 "short Perl snippet in the style of L<sed(1)>.  For example to replace all "
3900 "instances of C<foo> with C<bar> in a file:"
3901 msgstr ""
3902
3903 #. type: verbatim
3904 #: ../edit/virt-edit.pod:214
3905 #, no-wrap
3906 msgid ""
3907 " virt-edit -d domname filename -e 's/foo/bar/'\n"
3908 "\n"
3909 msgstr ""
3910
3911 #. type: textblock
3912 #: ../edit/virt-edit.pod:216
3913 msgid ""
3914 "The full power of Perl regular expressions can be used (see L<perlre(1)>).  "
3915 "For example to delete root's password you could do:"
3916 msgstr ""
3917
3918 #. type: verbatim
3919 #: ../edit/virt-edit.pod:219
3920 #, no-wrap
3921 msgid ""
3922 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3923 "\n"
3924 msgstr ""
3925
3926 #. type: textblock
3927 #: ../edit/virt-edit.pod:221
3928 msgid ""
3929 "What really happens is that the snippet is evaluated as a Perl expression "
3930 "for each line of the file.  The line, including the final C<\\n>, is passed "
3931 "in C<$_> and the expression should update C<$_> or leave it unchanged."
3932 msgstr ""
3933
3934 #. type: textblock
3935 #: ../edit/virt-edit.pod:226
3936 msgid ""
3937 "To delete a line, set C<$_> to the empty string.  For example, to delete the "
3938 "C<apache> user account from the password file you can do:"
3939 msgstr ""
3940
3941 #. type: verbatim
3942 #: ../edit/virt-edit.pod:229
3943 #, no-wrap
3944 msgid ""
3945 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
3946 "\n"
3947 msgstr ""
3948
3949 #. type: textblock
3950 #: ../edit/virt-edit.pod:231
3951 msgid ""
3952 "To insert a line, prepend or append it to C<$_>.  However appending lines to "
3953 "the end of the file is rather difficult this way since there is no concept "
3954 "of \"last line of the file\" - your expression just doesn't get called "
3955 "again.  You might want to use the first method (setting C<$EDITOR>) if you "
3956 "want to do this."
3957 msgstr ""
3958
3959 #. type: textblock
3960 #: ../edit/virt-edit.pod:237
3961 msgid ""
3962 "The variable C<$lineno> contains the current line number.  As is "
3963 "traditional, the first line in the file is number C<1>."
3964 msgstr ""
3965
3966 #. type: textblock
3967 #: ../edit/virt-edit.pod:240
3968 msgid ""
3969 "The return value from the expression is ignored, but the expression may call "
3970 "C<die> in order to abort the whole program, leaving the original file "
3971 "untouched."
3972 msgstr ""
3973
3974 #. type: textblock
3975 #: ../edit/virt-edit.pod:244
3976 msgid ""
3977 "Remember when matching the end of a line that C<$_> may contain the final "
3978 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
3979 "newline then neither of these.  Thus to match or substitute some text at the "
3980 "end of a line, use this regular expression:"
3981 msgstr ""
3982
3983 #. type: verbatim
3984 #: ../edit/virt-edit.pod:249
3985 #, no-wrap
3986 msgid ""
3987 " /some text(\\r?\\n)?$/\n"
3988 "\n"
3989 msgstr ""
3990
3991 #. type: textblock
3992 #: ../edit/virt-edit.pod:251
3993 msgid ""
3994 "Alternately, use the perl C<chomp> function, being careful not to chomp "
3995 "C<$_> itself (since that would remove all newlines from the file):"
3996 msgstr ""
3997
3998 #. type: verbatim
3999 #: ../edit/virt-edit.pod:255
4000 #, no-wrap
4001 msgid ""
4002 " my $m = $_; chomp $m; $m =~ /some text$/\n"
4003 "\n"
4004 msgstr ""
4005
4006 #. type: textblock
4007 #: ../edit/virt-edit.pod:259
4008 msgid ""
4009 "C<virt-edit> has a limited ability to understand Windows drive letters and "
4010 "paths (eg. C<E:\\foo\\bar.txt>)."
4011 msgstr ""
4012
4013 #. type: textblock
4014 #: ../edit/virt-edit.pod:278
4015 msgid ""
4016 "The path is resolved case insensitively to locate the file that should be "
4017 "edited."
4018 msgstr ""
4019
4020 #. type: textblock
4021 #: ../edit/virt-edit.pod:299
4022 msgid ""
4023 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
4024 "C<virt-edit> doesn't work."
4025 msgstr ""
4026
4027 #. type: textblock
4028 #: ../edit/virt-edit.pod:302
4029 msgid "Using C<virt-edit> is approximately equivalent to doing:"
4030 msgstr ""
4031
4032 #. type: verbatim
4033 #: ../edit/virt-edit.pod:304
4034 #, no-wrap
4035 msgid ""
4036 " guestfish --rw -i -d domname edit /file\n"
4037 "\n"
4038 msgstr ""
4039
4040 #. type: textblock
4041 #: ../edit/virt-edit.pod:306
4042 msgid ""
4043 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
4044 "path to the file."
4045 msgstr ""
4046
4047 #. type: textblock
4048 #: ../edit/virt-edit.pod:309
4049 msgid ""
4050 "The command above uses libguestfs's guest inspection feature and so does not "
4051 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
4052 "disk images that don't contain guests.  To edit a file on a disk image "
4053 "directly, use:"
4054 msgstr ""
4055
4056 #. type: verbatim
4057 #: ../edit/virt-edit.pod:314
4058 #, no-wrap
4059 msgid ""
4060 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
4061 "\n"
4062 msgstr ""
4063
4064 #. type: textblock
4065 #: ../edit/virt-edit.pod:316
4066 msgid ""
4067 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
4068 "the disk image to edit, and C</file> is the full path to the file."
4069 msgstr ""
4070
4071 #. type: textblock
4072 #: ../edit/virt-edit.pod:320
4073 msgid ""
4074 "C<virt-edit> cannot create new files.  Use the guestfish commands C<touch>, "
4075 "C<write> or C<upload> instead:"
4076 msgstr ""
4077
4078 #. type: verbatim
4079 #: ../edit/virt-edit.pod:323
4080 #, no-wrap
4081 msgid ""
4082 " guestfish --rw -i -d domname touch /newfile\n"
4083 "\n"
4084 msgstr ""
4085
4086 #. type: verbatim
4087 #: ../edit/virt-edit.pod:325
4088 #, no-wrap
4089 msgid ""
4090 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
4091 "\n"
4092 msgstr ""
4093
4094 #. type: verbatim
4095 #: ../edit/virt-edit.pod:327
4096 #, no-wrap
4097 msgid ""
4098 " guestfish --rw -i -d domname upload localfile /newfile\n"
4099 "\n"
4100 msgstr ""
4101
4102 #. type: =head1
4103 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1119 ../rescue/virt-rescue.pod:298 ../sparsify/virt-sparsify.pod:232 ../src/guestfs.pod:3209 ../test-tool/libguestfs-test-tool.pod:95
4104 msgid "ENVIRONMENT VARIABLES"
4105 msgstr ""
4106
4107 #. type: =item
4108 #: ../edit/virt-edit.pod:333
4109 msgid "C<EDITOR>"
4110 msgstr ""
4111
4112 #. type: textblock
4113 #: ../edit/virt-edit.pod:335
4114 msgid ""
4115 "If set, this string is used as the editor.  It may contain arguments, "
4116 "eg. C<\"emacs -nw\">"
4117 msgstr ""
4118
4119 #. type: textblock
4120 #: ../edit/virt-edit.pod:338
4121 msgid "If not set, C<vi> is used."
4122 msgstr ""
4123
4124 #. type: textblock
4125 #: ../edit/virt-edit.pod:356
4126 msgid ""
4127 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
4128 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
4129 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
4130 msgstr ""
4131
4132 #. type: textblock
4133 #: ../erlang/examples/guestfs-erlang.pod:5
4134 msgid "guestfs-erlang - How to use libguestfs from Erlang"
4135 msgstr ""
4136
4137 #. type: verbatim
4138 #: ../erlang/examples/guestfs-erlang.pod:9
4139 #, no-wrap
4140 msgid ""
4141 " {ok, G} = guestfs:create(),\n"
4142 " ok = guestfs:add_drive_opts(G, Disk,\n"
4143 "                             [{format, \"raw\"}, {readonly, true}]),\n"
4144 " ok = guestfs:launch(G),\n"
4145 " [Device] = guestfs:list_devices(G),\n"
4146 " ok = guestfs:close(G).\n"
4147 "\n"
4148 msgstr ""
4149
4150 #. type: textblock
4151 #: ../erlang/examples/guestfs-erlang.pod:18
4152 msgid ""
4153 "This manual page documents how to call libguestfs from the Erlang "
4154 "programming language.  This page just documents the differences from the C "
4155 "API and gives some examples.  If you are not familiar with using libguestfs, "
4156 "you also need to read L<guestfs(3)>."
4157 msgstr ""
4158
4159 #. type: =head2
4160 #: ../erlang/examples/guestfs-erlang.pod:23
4161 msgid "OPENING AND CLOSING THE HANDLE"
4162 msgstr ""
4163
4164 #. type: textblock
4165 #: ../erlang/examples/guestfs-erlang.pod:25
4166 msgid ""
4167 "The Erlang bindings are implemented using an external program called "
4168 "C<erl-guestfs>.  This program must be on the current PATH, or else you "
4169 "should specify the full path to the program:"
4170 msgstr ""
4171
4172 #. type: verbatim
4173 #: ../erlang/examples/guestfs-erlang.pod:29
4174 #, no-wrap
4175 msgid ""
4176 " {ok, G} = guestfs:create().\n"
4177 "\n"
4178 msgstr ""
4179
4180 #. type: verbatim
4181 #: ../erlang/examples/guestfs-erlang.pod:31
4182 #, no-wrap
4183 msgid ""
4184 " {ok, G} = guestfs:create(\"/path/to/erl-guestfs\").\n"
4185 "\n"
4186 msgstr ""
4187
4188 #. type: textblock
4189 #: ../erlang/examples/guestfs-erlang.pod:33
4190 msgid "C<G> is the libguestfs handle which you should pass to other functions."
4191 msgstr ""
4192
4193 #. type: textblock
4194 #: ../erlang/examples/guestfs-erlang.pod:36
4195 msgid "To close the handle:"
4196 msgstr ""
4197
4198 #. type: verbatim
4199 #: ../erlang/examples/guestfs-erlang.pod:38
4200 #, no-wrap
4201 msgid ""
4202 " ok = guestfs:close(G).\n"
4203 "\n"
4204 msgstr ""
4205
4206 #. type: =head2
4207 #: ../erlang/examples/guestfs-erlang.pod:40
4208 msgid "FUNCTIONS WITH OPTIONAL ARGUMENTS"
4209 msgstr ""
4210
4211 #. type: textblock
4212 #: ../erlang/examples/guestfs-erlang.pod:42
4213 msgid ""
4214 "For functions that take optional arguments, the first arguments are the "
4215 "non-optional ones.  The last argument is a list of tuples supplying the "
4216 "remaining optional arguments."
4217 msgstr ""
4218
4219 #. type: verbatim
4220 #: ../erlang/examples/guestfs-erlang.pod:46
4221 #, no-wrap
4222 msgid ""
4223 " ok = guestfs:add_drive_opts(G, Disk,\n"
4224 "                             [{format, \"raw\"}, {readonly, true}]).\n"
4225 "\n"
4226 msgstr ""
4227
4228 #. type: textblock
4229 #: ../erlang/examples/guestfs-erlang.pod:49
4230 msgid "If the last argument would be an empty list, you can also omit it:"
4231 msgstr ""
4232
4233 #. type: verbatim
4234 #: ../erlang/examples/guestfs-erlang.pod:51
4235 #, no-wrap
4236 msgid ""
4237 " ok = guestfs:add_drive_opts(G, Disk).\n"
4238 "\n"
4239 msgstr ""
4240
4241 #. type: =head2
4242 #: ../erlang/examples/guestfs-erlang.pod:53
4243 msgid "RETURN VALUES AND ERRORS"
4244 msgstr ""
4245
4246 #. type: textblock
4247 #: ../erlang/examples/guestfs-erlang.pod:55
4248 msgid ""
4249 "On success, most functions return a C<Result> term (which could be a list, "
4250 "string, tuple etc.).  If there is nothing for the function to return, then "
4251 "the atom C<ok> is returned."
4252 msgstr ""
4253
4254 #. type: textblock
4255 #: ../erlang/examples/guestfs-erlang.pod:59
4256 msgid "On error, you would see one of the following tuples:"
4257 msgstr ""
4258
4259 #. type: =item
4260 #: ../erlang/examples/guestfs-erlang.pod:63
4261 msgid "C<{error, Msg, Errno}>"
4262 msgstr ""
4263
4264 #. type: textblock
4265 #: ../erlang/examples/guestfs-erlang.pod:65
4266 msgid "This indicates an ordinary error from the function."
4267 msgstr ""
4268
4269 #. type: textblock
4270 #: ../erlang/examples/guestfs-erlang.pod:67
4271 msgid ""
4272 "C<Msg> is the error message (string) and C<Errno> is the Unix error "
4273 "(integer)."
4274 msgstr ""
4275
4276 #. type: textblock
4277 #: ../erlang/examples/guestfs-erlang.pod:70
4278 msgid "C<Errno> can be zero.  See L<guestfs(3)/guestfs_last_errno>."
4279 msgstr ""
4280
4281 #. type: =item
4282 #: ../erlang/examples/guestfs-erlang.pod:72
4283 msgid "C<{unknown, Function}>"
4284 msgstr ""
4285
4286 #. type: textblock
4287 #: ../erlang/examples/guestfs-erlang.pod:74
4288 msgid ""
4289 "This indicates that the function you called is not known.  Generally this "
4290 "means you are mixing C<erl-guestfs> from another version of libguestfs, "
4291 "which you should not do."
4292 msgstr ""
4293
4294 #. type: textblock
4295 #: ../erlang/examples/guestfs-erlang.pod:78
4296 msgid "C<Function> is the name of the unknown function."
4297 msgstr ""
4298
4299 #. type: =item
4300 #: ../erlang/examples/guestfs-erlang.pod:80
4301 msgid "C<{unknownarg, Arg}>"
4302 msgstr ""
4303
4304 #. type: textblock
4305 #: ../erlang/examples/guestfs-erlang.pod:82
4306 msgid ""
4307 "This indicates that you called a function with optional arguments, with an "
4308 "unknown argument name."
4309 msgstr ""
4310
4311 #. type: textblock
4312 #: ../erlang/examples/guestfs-erlang.pod:85
4313 msgid "C<Arg> is the name of the unknown argument."
4314 msgstr ""
4315
4316 #. type: =head1
4317 #: ../erlang/examples/guestfs-erlang.pod:89 ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37 ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31 ../python/examples/guestfs-python.pod:34 ../ruby/examples/guestfs-ruby.pod:28
4318 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
4319 msgstr ""
4320
4321 #. type: textblock
4322 #: ../erlang/examples/guestfs-erlang.pod:91 ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39 ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33 ../python/examples/guestfs-python.pod:36 ../ruby/examples/guestfs-ruby.pod:30
4323 msgid "@EXAMPLE1@"
4324 msgstr ""
4325
4326 #. type: =head1
4327 #: ../erlang/examples/guestfs-erlang.pod:93 ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41 ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35 ../python/examples/guestfs-python.pod:38 ../ruby/examples/guestfs-ruby.pod:32
4328 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
4329 msgstr ""
4330
4331 #. type: textblock
4332 #: ../erlang/examples/guestfs-erlang.pod:95 ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43 ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37 ../python/examples/guestfs-python.pod:40 ../ruby/examples/guestfs-ruby.pod:34
4333 msgid "@EXAMPLE2@"
4334 msgstr ""
4335
4336 #. type: textblock
4337 #: ../erlang/examples/guestfs-erlang.pod:99
4338 msgid ""
4339 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
4340 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
4341 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://www.erlang.org/>.  "
4342 "L<http://libguestfs.org/>."
4343 msgstr ""
4344
4345 #. type: =head1
4346 #: ../erlang/examples/guestfs-erlang.pod:110 ../examples/guestfs-examples.pod:45 ../examples/guestfs-recipes.pod:397 ../fish/guestfish.pod:1296 ../fish/virt-copy-in.pod:60 ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58 ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:328 ../inspector/virt-inspector.pod:404 ../java/examples/guestfs-java.pod:58 ../ocaml/examples/guestfs-ocaml.pod:91 ../perl/examples/guestfs-perl.pod:52 ../python/examples/guestfs-python.pod:54 ../ruby/examples/guestfs-ruby.pod:48 ../src/guestfs.pod:3348 ../test-tool/libguestfs-test-tool.pod:106
4347 msgid "AUTHORS"
4348 msgstr ""
4349
4350 #. type: textblock
4351 #: ../erlang/examples/guestfs-erlang.pod:112 ../examples/guestfs-examples.pod:47 ../examples/guestfs-recipes.pod:399 ../fish/guestfish.pod:1298 ../fish/virt-copy-in.pod:62 ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60 ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:330 ../java/examples/guestfs-java.pod:60 ../ocaml/examples/guestfs-ocaml.pod:93 ../perl/examples/guestfs-perl.pod:54 ../python/examples/guestfs-python.pod:56 ../ruby/examples/guestfs-ruby.pod:50 ../src/guestfs.pod:3350 ../test-tool/libguestfs-test-tool.pod:108
4352 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4353 msgstr ""
4354
4355 #. type: textblock
4356 #: ../erlang/examples/guestfs-erlang.pod:116 ../java/examples/guestfs-java.pod:64 ../perl/examples/guestfs-perl.pod:58
4357 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
4358 msgstr ""
4359
4360 #. type: textblock
4361 #: ../erlang/examples/guestfs-erlang.pod:118 ../examples/guestfs-examples.pod:53 ../examples/guestfs-recipes.pod:405 ../java/examples/guestfs-java.pod:66 ../ocaml/examples/guestfs-ocaml.pod:99 ../perl/examples/guestfs-perl.pod:60 ../python/examples/guestfs-python.pod:62 ../ruby/examples/guestfs-ruby.pod:56
4362 msgid ""
4363 "The examples in this manual page may be freely copied, modified and "
4364 "distributed without any restrictions."
4365 msgstr ""
4366
4367 #. type: textblock
4368 #: ../erlang/examples/guestfs-erlang.pod:121 ../examples/guestfs-examples.pod:56 ../examples/guestfs-recipes.pod:408 ../java/examples/guestfs-java.pod:69 ../ocaml/examples/guestfs-ocaml.pod:102 ../perl/examples/guestfs-perl.pod:63 ../python/examples/guestfs-python.pod:65 ../ruby/examples/guestfs-ruby.pod:59 ../src/guestfs.pod:3357
4369 msgid ""
4370 "This library is free software; you can redistribute it and/or modify it "
4371 "under the terms of the GNU Lesser General Public License as published by the "
4372 "Free Software Foundation; either version 2 of the License, or (at your "
4373 "option) any later version."
4374 msgstr ""
4375
4376 #. type: textblock
4377 #: ../erlang/examples/guestfs-erlang.pod:126 ../examples/guestfs-examples.pod:61 ../examples/guestfs-recipes.pod:413 ../java/examples/guestfs-java.pod:74 ../ocaml/examples/guestfs-ocaml.pod:107 ../perl/examples/guestfs-perl.pod:68 ../python/examples/guestfs-python.pod:70 ../ruby/examples/guestfs-ruby.pod:64 ../src/guestfs.pod:3362
4378 msgid ""
4379 "This library is distributed in the hope that it will be useful, but WITHOUT "
4380 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4381 "FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License "
4382 "for more details."
4383 msgstr ""
4384
4385 #. type: textblock
4386 #: ../erlang/examples/guestfs-erlang.pod:131 ../examples/guestfs-examples.pod:66 ../examples/guestfs-recipes.pod:418 ../java/examples/guestfs-java.pod:79 ../ocaml/examples/guestfs-ocaml.pod:112 ../perl/examples/guestfs-perl.pod:73 ../python/examples/guestfs-python.pod:75 ../ruby/examples/guestfs-ruby.pod:69 ../src/guestfs.pod:3367
4387 msgid ""
4388 "You should have received a copy of the GNU Lesser General Public License "
4389 "along with this library; if not, write to the Free Software Foundation, "
4390 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4391 msgstr ""
4392
4393 #. type: textblock
4394 #: ../examples/guestfs-examples.pod:5
4395 msgid "guestfs-examples - Examples of using libguestfs from C"
4396 msgstr ""
4397
4398 #. type: verbatim
4399 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
4400 #, no-wrap
4401 msgid ""
4402 " #include <guestfs.h>\n"
4403 " \n"
4404 msgstr ""
4405
4406 #. type: verbatim
4407 #: ../examples/guestfs-examples.pod:11
4408 #, no-wrap
4409 msgid ""
4410 " guestfs_h *g = guestfs_create ();\n"
4411 " guestfs_add_drive_ro (g, \"disk.img\");\n"
4412 " guestfs_launch (g);\n"
4413 "\n"
4414 msgstr ""
4415
4416 #. type: verbatim
4417 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
4418 #, no-wrap
4419 msgid ""
4420 " cc prog.c -o prog -lguestfs\n"
4421 "or:\n"
4422 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
4423 "\n"
4424 msgstr ""
4425
4426 #. type: textblock
4427 #: ../examples/guestfs-examples.pod:21
4428 msgid ""
4429 "This manual page contains examples of calling libguestfs from the C "
4430 "programming language.  If you are not familiar with using libguestfs, you "
4431 "also need to read L<guestfs(3)>."
4432 msgstr ""
4433
4434 #. type: textblock
4435 #: ../examples/guestfs-examples.pod:35
4436 msgid ""
4437 "L<guestfs(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, "
4438 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
4439 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
4440 msgstr ""
4441
4442 #. type: textblock
4443 #: ../examples/guestfs-examples.pod:51 ../ocaml/examples/guestfs-ocaml.pod:97 ../python/examples/guestfs-python.pod:60 ../ruby/examples/guestfs-ruby.pod:54
4444 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
4445 msgstr ""
4446
4447 #. type: =end
4448 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
4449 msgid "comment"
4450 msgstr ""
4451
4452 #. type: textblock
4453 #: ../examples/guestfs-recipes.pod:5
4454 msgid ""
4455 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
4456 "here.  The only way which works for both sorts of output is to just write "
4457 "the URL directly.  Do NOT use L<...> for URLs."
4458 msgstr ""
4459
4460 #. type: textblock
4461 #: ../examples/guestfs-recipes.pod:9
4462 msgid ""
4463 "We break with tradition here and don't use ALL CAPS for the section "
4464 "headings, as this makes them much easier to read."
4465 msgstr ""
4466
4467 #. type: textblock
4468 #: ../examples/guestfs-recipes.pod:16
4469 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
4470 msgstr ""
4471
4472 #. type: textblock
4473 #: ../examples/guestfs-recipes.pod:20
4474 msgid ""
4475 "This page contains recipes for and links to things you can do using "
4476 "libguestfs, L<guestfish(1)> and the virt tools."
4477 msgstr ""
4478
4479 #. type: =head1
4480 #: ../examples/guestfs-recipes.pod:23
4481 msgid "Audit a virtual machine for setuid files"
4482 msgstr ""
4483
4484 #. type: textblock
4485 #: ../examples/guestfs-recipes.pod:25
4486 msgid ""
4487 "The link below contains a small program which can be used to audit a Linux "
4488 "virtual machine to see what setuid and setgid files it contains."
4489 msgstr ""
4490
4491 #. type: textblock
4492 #: ../examples/guestfs-recipes.pod:28
4493 msgid "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-files/#content"
4494 msgstr ""
4495
4496 #. type: =head1
4497 #: ../examples/guestfs-recipes.pod:30
4498 msgid "Change the background image in a Windows XP VM"
4499 msgstr ""
4500
4501 #. type: textblock
4502 #: ../examples/guestfs-recipes.pod:32
4503 msgid ""
4504 "The links below explain how to use L<guestfish(1)> to change the background "
4505 "image for a user of a Windows XP VM.  Unfortunately the technique appears to "
4506 "be substantially different for each version of Windows."
4507 msgstr ""
4508
4509 #. type: textblock
4510 #: ../examples/guestfs-recipes.pod:37
4511 msgid ""
4512 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html "
4513 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
4514 msgstr ""
4515
4516 #. type: =head1
4517 #: ../examples/guestfs-recipes.pod:40
4518 msgid "Cloning a virtual machine (Linux)"
4519 msgstr ""
4520
4521 #. type: textblock
4522 #: ../examples/guestfs-recipes.pod:42
4523 msgid ""
4524 "The guestfish technique described in the link below works well for most "
4525 "Linux VMs.  Depending on the Linux distro you may need to change the paths "
4526 "slightly."
4527 msgstr ""
4528
4529 #. type: textblock
4530 #: ../examples/guestfs-recipes.pod:46
4531 msgid "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-vm/#content"
4532 msgstr ""
4533
4534 #. type: textblock
4535 #: ../examples/guestfs-recipes.pod:48
4536 msgid ""
4537 "Avoid L<virt-clone(1)>.  Currently what to do about virt-clone is under "
4538 "discussion."
4539 msgstr ""
4540
4541 #. type: textblock
4542 #: ../examples/guestfs-recipes.pod:51
4543 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
4544 msgstr ""
4545
4546 #. type: =head1
4547 #: ../examples/guestfs-recipes.pod:53
4548 msgid "Cloning a virtual machine (Windows)"
4549 msgstr ""
4550
4551 #. type: textblock
4552 #: ../examples/guestfs-recipes.pod:55
4553 msgid ""
4554 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
4555 "straightforward.  Currently there is code in the Aeolus Oz project which "
4556 "does this (using libguestfs).  As part of our review of the virt-clone tool, "
4557 "we may add sysprepping ability."
4558 msgstr ""
4559
4560 #. type: textblock
4561 #: ../examples/guestfs-recipes.pod:60
4562 msgid ""
4563 "https://github.com/clalancette/oz "
4564 "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
4565 msgstr ""
4566
4567 #. type: =head1
4568 #: ../examples/guestfs-recipes.pod:63
4569 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
4570 msgstr ""
4571
4572 #. type: textblock
4573 #: ../examples/guestfs-recipes.pod:65
4574 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
4575 msgstr ""
4576
4577 #. type: verbatim
4578 #: ../examples/guestfs-recipes.pod:67
4579 #, no-wrap
4580 msgid ""
4581 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
4582 "\n"
4583 msgstr ""
4584
4585 #. type: textblock
4586 #: ../examples/guestfs-recipes.pod:69
4587 msgid "To export just a subdirectory, eg. C</files>, do:"
4588 msgstr ""
4589
4590 #. type: verbatim
4591 #: ../examples/guestfs-recipes.pod:71
4592 #, no-wrap
4593 msgid ""
4594 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
4595 "\n"
4596 msgstr ""
4597
4598 #. type: =head1
4599 #: ../examples/guestfs-recipes.pod:73
4600 msgid "Create empty disk images"
4601 msgstr ""
4602
4603 #. type: textblock
4604 #: ../examples/guestfs-recipes.pod:75
4605 msgid ""
4606 "You can use the L<guestfish(1)> I<-N> option to create empty disk images.  "
4607 "The useful guide below explains the options available."
4608 msgstr ""
4609
4610 #. type: textblock
4611 #: ../examples/guestfs-recipes.pod:78
4612 msgid "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/#content"
4613 msgstr ""
4614
4615 #. type: =head1
4616 #: ../examples/guestfs-recipes.pod:80
4617 msgid "Dump raw filesystem content from inside a disk image or VM"
4618 msgstr ""
4619
4620 #. type: textblock
4621 #: ../examples/guestfs-recipes.pod:82
4622 msgid ""
4623 "You can use the L<guestfish(1)> C<download> command to extract the raw "
4624 "filesystem content from any filesystem in a disk image or a VM (even one "
4625 "which is encrypted or buried inside an LV):"
4626 msgstr ""
4627
4628 #. type: verbatim
4629 #: ../examples/guestfs-recipes.pod:86
4630 #, no-wrap
4631 msgid ""
4632 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
4633 "\n"
4634 msgstr ""
4635
4636 #. type: verbatim
4637 #: ../examples/guestfs-recipes.pod:88
4638 #, no-wrap
4639 msgid ""
4640 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
4641 "\n"
4642 msgstr ""
4643
4644 #. type: textblock
4645 #: ../examples/guestfs-recipes.pod:90
4646 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
4647 msgstr ""
4648
4649 #. type: =head1
4650 #: ../examples/guestfs-recipes.pod:92
4651 msgid "Edit grub configuration in a VM"
4652 msgstr ""
4653
4654 #. type: textblock
4655 #: ../examples/guestfs-recipes.pod:94
4656 msgid "You can use this to:"
4657 msgstr ""
4658
4659 #. type: textblock
4660 #: ../examples/guestfs-recipes.pod:100
4661 msgid "Fix a virtual machine that does not boot."
4662 msgstr ""
4663
4664 #. type: textblock
4665 #: ../examples/guestfs-recipes.pod:104
4666 msgid "Change which kernel is used to boot the VM."
4667 msgstr ""
4668
4669 #. type: textblock
4670 #: ../examples/guestfs-recipes.pod:108
4671 msgid "Change kernel command line options."
4672 msgstr ""
4673
4674 #. type: textblock
4675 #: ../examples/guestfs-recipes.pod:112
4676 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
4677 msgstr ""
4678
4679 #. type: verbatim
4680 #: ../examples/guestfs-recipes.pod:114
4681 #, no-wrap
4682 msgid ""
4683 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
4684 "\n"
4685 msgstr ""
4686
4687 #. type: textblock
4688 #: ../examples/guestfs-recipes.pod:116
4689 msgid ""
4690 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
4691 "this:"
4692 msgstr ""
4693
4694 #. type: verbatim
4695 #: ../examples/guestfs-recipes.pod:119
4696 #, no-wrap
4697 msgid ""
4698 " virt-rescue -d BrokenGuest\n"
4699 "\n"
4700 msgstr ""
4701
4702 #. type: =head1
4703 #: ../examples/guestfs-recipes.pod:121
4704 msgid "Export any directory from a VM"
4705 msgstr ""
4706
4707 #. type: textblock
4708 #: ../examples/guestfs-recipes.pod:123
4709 msgid "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
4710 msgstr ""
4711
4712 #. type: verbatim
4713 #: ../examples/guestfs-recipes.pod:126
4714 #, no-wrap
4715 msgid ""
4716 " virt-copy-out -d Guest /home .\n"
4717 "\n"
4718 msgstr ""
4719
4720 #. type: textblock
4721 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1450 ../fish/guestfish-actions.pod:1715 ../fish/guestfish-actions.pod:2132 ../src/guestfs-actions.pod:18 ../src/guestfs-actions.pod:2334 ../src/guestfs-actions.pod:2758 ../src/guestfs-actions.pod:3317 ../src/guestfs.pod:1685 ../tools/virt-win-reg.pl:717
4722 msgid "Notes:"
4723 msgstr ""
4724
4725 #. type: textblock
4726 #: ../examples/guestfs-recipes.pod:134
4727 msgid ""
4728 "The final dot of the command is not a printing error.  It means we want to "
4729 "copy out to the current directory."
4730 msgstr ""
4731
4732 #. type: textblock
4733 #: ../examples/guestfs-recipes.pod:139
4734 msgid "This creates a directory called C<home> under the current directory."
4735 msgstr ""
4736
4737 #. type: textblock
4738 #: ../examples/guestfs-recipes.pod:143
4739 msgid ""
4740 "If the guest is a Windows guest then you can use drive letters and "
4741 "backslashes, but you must prefix the path with C<win:> and quote it to "
4742 "protect it from the shell, like this:"
4743 msgstr ""
4744
4745 #. type: verbatim
4746 #: ../examples/guestfs-recipes.pod:147
4747 #, no-wrap
4748 msgid ""
4749 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
4750 "\n"
4751 msgstr ""
4752
4753 #. type: textblock
4754 #: ../examples/guestfs-recipes.pod:149
4755 msgid "To get the output as a compressed tarball, do:"
4756 msgstr ""
4757
4758 #. type: verbatim
4759 #: ../examples/guestfs-recipes.pod:151
4760 #, no-wrap
4761 msgid ""
4762 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
4763 "\n"
4764 msgstr ""
4765
4766 #. type: textblock
4767 #: ../examples/guestfs-recipes.pod:153
4768 msgid ""
4769 "Although it sounds tempting, this is usually not a reliable way to get a "
4770 "backup from a running guest.  See the entry in the FAQ: "
4771 "http://libguestfs.org/FAQ.html#backup"
4772 msgstr ""
4773
4774 #. type: =head1
4775 #: ../examples/guestfs-recipes.pod:157
4776 msgid "Find out which user is using the most space"
4777 msgstr ""
4778
4779 #. type: textblock
4780 #: ../examples/guestfs-recipes.pod:159
4781 msgid ""
4782 "This simple script examines a Linux guest to find out which user is using "
4783 "the most space in their home directory:"
4784 msgstr ""
4785
4786 #. type: verbatim
4787 #: ../examples/guestfs-recipes.pod:162
4788 #, no-wrap
4789 msgid ""
4790 " #!/bin/sh -\n"
4791 " \n"
4792 msgstr ""
4793
4794 #. type: verbatim
4795 #: ../examples/guestfs-recipes.pod:164 ../fish/guestfish.pod:984
4796 #, no-wrap
4797 msgid ""
4798 " set -e\n"
4799 " \n"
4800 msgstr ""
4801
4802 #. type: verbatim
4803 #: ../examples/guestfs-recipes.pod:166
4804 #, no-wrap
4805 msgid ""
4806 " vm=\"$1\"\n"
4807 " dir=/home\n"
4808 " \n"
4809 msgstr ""
4810
4811 #. type: verbatim
4812 #: ../examples/guestfs-recipes.pod:169
4813 #, no-wrap
4814 msgid ""
4815 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
4816 " \n"
4817 msgstr ""
4818
4819 #. type: verbatim
4820 #: ../examples/guestfs-recipes.pod:171
4821 #, no-wrap
4822 msgid ""
4823 " for d in $(guestfish --remote ls \"$dir\"); do\n"
4824 "     echo -n \"$dir/$d\"\n"
4825 "     echo -ne '\\t'\n"
4826 "     guestfish --remote du \"$dir/$d\";\n"
4827 " done | sort -nr -k 2\n"
4828 " \n"
4829 msgstr ""
4830
4831 #. type: verbatim
4832 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
4833 #, no-wrap
4834 msgid ""
4835 " guestfish --remote exit\n"
4836 "\n"
4837 msgstr ""
4838
4839 #. type: =head1
4840 #: ../examples/guestfs-recipes.pod:179
4841 msgid "Get DHCP address from a VM"
4842 msgstr ""
4843
4844 #. type: textblock
4845 #: ../examples/guestfs-recipes.pod:181
4846 msgid ""
4847 "The link below explains the many different possible techniques for getting "
4848 "the last assigned DHCP address of a virtual machine."
4849 msgstr ""
4850
4851 #. type: textblock
4852 #: ../examples/guestfs-recipes.pod:184
4853 msgid "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-a-virtual-machine-disk-image/#content"
4854 msgstr ""
4855
4856 #. type: textblock
4857 #: ../examples/guestfs-recipes.pod:186
4858 msgid ""
4859 "In the libguestfs source examples directory you will find the latest version "
4860 "of the C<virt-dhcp-address.c> program."
4861 msgstr ""
4862
4863 #. type: =head1
4864 #: ../examples/guestfs-recipes.pod:189
4865 msgid "Get the operating system product name string"
4866 msgstr ""
4867
4868 #. type: textblock
4869 #: ../examples/guestfs-recipes.pod:191
4870 msgid "Save the following script into a file called C<product-name.sh>:"
4871 msgstr ""
4872
4873 #. type: verbatim
4874 #: ../examples/guestfs-recipes.pod:193
4875 #, no-wrap
4876 msgid ""
4877 " #!/bin/sh -\n"
4878 " set -e\n"
4879 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
4880 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
4881 " guestfish --remote inspect-get-product-name \"$root\"\n"
4882 " guestfish --remote exit\n"
4883 "\n"
4884 msgstr ""
4885
4886 #. type: textblock
4887 #: ../examples/guestfs-recipes.pod:200
4888 msgid "Make the script executable and run it on a named guest:"
4889 msgstr ""
4890
4891 #. type: verbatim
4892 #: ../examples/guestfs-recipes.pod:202
4893 #, no-wrap
4894 msgid ""
4895 " # product-name.sh RHEL60x64\n"
4896 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
4897 "\n"
4898 msgstr ""
4899
4900 #. type: textblock
4901 #: ../examples/guestfs-recipes.pod:205
4902 msgid ""
4903 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
4904 "C<xpath> command line tool or from your favourite programming language:"
4905 msgstr ""
4906
4907 #. type: verbatim
4908 #: ../examples/guestfs-recipes.pod:209
4909 #, no-wrap
4910 msgid ""
4911 " # virt-inspector RHEL60x64 > xml\n"
4912 " # xpath '//product_name' < xml\n"
4913 " Found 1 nodes:\n"
4914 " -- NODE --\n"
4915 " <product_name>Red Hat Enterprise Linux Server release 6.0 "
4916 "(Santiago)</product_name>\n"
4917 "\n"
4918 msgstr ""
4919
4920 #. type: =head1
4921 #: ../examples/guestfs-recipes.pod:215
4922 msgid "Get the default boot kernel for a Linux VM"
4923 msgstr ""
4924
4925 #. type: textblock
4926 #: ../examples/guestfs-recipes.pod:217
4927 msgid ""
4928 "The link below contains a program to print the default boot kernel for a "
4929 "Linux VM."
4930 msgstr ""
4931
4932 #. type: textblock
4933 #: ../examples/guestfs-recipes.pod:220
4934 msgid "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-kernel-for-a-vm/#content"
4935 msgstr ""
4936
4937 #. type: textblock
4938 #: ../examples/guestfs-recipes.pod:222
4939 msgid ""
4940 "It uses Augeas, and the technique is generally applicable for many different "
4941 "tasks, such as:"
4942 msgstr ""
4943
4944 #. type: textblock
4945 #: ../examples/guestfs-recipes.pod:229
4946 msgid "listing the user accounts in the guest"
4947 msgstr ""
4948
4949 #. type: textblock
4950 #: ../examples/guestfs-recipes.pod:233
4951 msgid "what repositories is it configured to use"
4952 msgstr ""
4953
4954 #. type: textblock
4955 #: ../examples/guestfs-recipes.pod:237
4956 msgid "what NTP servers does it connect to"
4957 msgstr ""
4958
4959 #. type: textblock
4960 #: ../examples/guestfs-recipes.pod:241
4961 msgid "what were the boot messages last time it booted"
4962 msgstr ""
4963
4964 #. type: textblock
4965 #: ../examples/guestfs-recipes.pod:245
4966 msgid "listing who was logged in recently"
4967 msgstr ""
4968
4969 #. type: textblock
4970 #: ../examples/guestfs-recipes.pod:249
4971 msgid "http://augeas.net/"
4972 msgstr ""
4973
4974 #. type: =head1
4975 #: ../examples/guestfs-recipes.pod:251
4976 msgid "Install RPMs in a guest"
4977 msgstr ""
4978
4979 #. type: textblock
4980 #: ../examples/guestfs-recipes.pod:253
4981 msgid ""
4982 "The link below contains a method to install RPMs in a guest.  In fact the "
4983 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
4984 "installs them next time the guest is booted.  You could use this technique "
4985 "to install vital security updates in an offline guest."
4986 msgstr ""
4987
4988 #. type: textblock
4989 #: ../examples/guestfs-recipes.pod:259
4990 msgid "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
4991 msgstr ""
4992
4993 #. type: =head1
4994 #: ../examples/guestfs-recipes.pod:261
4995 msgid "List applications installed in a VM"
4996 msgstr ""
4997
4998 #. type: textblock
4999 #: ../examples/guestfs-recipes.pod:263
5000 msgid "Save the following to a file C<list-apps.sh>:"
5001 msgstr ""
5002
5003 #. type: verbatim
5004 #: ../examples/guestfs-recipes.pod:265
5005 #, no-wrap
5006 msgid ""
5007 " #!/bin/sh -\n"
5008 " set -e\n"
5009 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
5010 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
5011 " guestfish --remote inspect-list-applications \"$root\"\n"
5012 " guestfish --remote exit\n"
5013 "\n"
5014 msgstr ""
5015
5016 #. type: textblock
5017 #: ../examples/guestfs-recipes.pod:272
5018 msgid ""
5019 "Make the file executable and then you can run it on any named virtual "
5020 "machine:"
5021 msgstr ""
5022
5023 #. type: verbatim
5024 #: ../examples/guestfs-recipes.pod:275
5025 #, no-wrap
5026 msgid ""
5027 " # list-apps.sh WinGuest\n"
5028 " [0] = {\n"
5029 "   app_name: Mozilla Firefox (3.6.12)\n"
5030 "   app_display_name: Mozilla Firefox (3.6.12)\n"
5031 "   app_epoch: 0\n"
5032 "   app_version: 3.6.12 (en-GB)\n"
5033 "   app_release:\n"
5034 "   app_install_path: C:\\Program Files\\Mozilla Firefox\n"
5035 "   app_trans_path:\n"
5036 "   app_publisher: Mozilla\n"
5037 "   app_url: http://www.mozilla.com/en-GB/\n"
5038 "   app_source_package:\n"
5039 "   app_summary:\n"
5040 "   app_description: Mozilla Firefox\n"
5041 " }\n"
5042 " [1] = {\n"
5043 "   app_name: VLC media player\n"
5044 "   app_display_name: VLC media player 1.1.5\n"
5045 "   app_epoch: 0\n"
5046 "   app_version: 1.1.5\n"
5047 "   app_release:\n"
5048 "   app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
5049 "   app_trans_path:\n"
5050 "   app_publisher: VideoLAN\n"
5051 "   app_url: http://www.videolan.org/\n"
5052 "   app_source_package:\n"
5053 "   app_summary:\n"
5054 "   app_description:\n"
5055 " }\n"
5056 "\n"
5057 msgstr ""
5058
5059 #. type: textblock
5060 #: ../examples/guestfs-recipes.pod:305
5061 msgid ""
5062 "If you want to run the script on disk images (instead of libvirt virtual "
5063 "machines), change C<-d \"$1\"> to C<-a \"$1\">.  See also "
5064 "L<virt-inspector(1)>."
5065 msgstr ""
5066
5067 #. type: =head1
5068 #: ../examples/guestfs-recipes.pod:309
5069 msgid "List files and directories in a VM"
5070 msgstr ""
5071
5072 #. type: textblock
5073 #: ../examples/guestfs-recipes.pod:311
5074 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
5075 msgstr ""
5076
5077 #. type: verbatim
5078 #: ../examples/guestfs-recipes.pod:313
5079 #, no-wrap
5080 msgid ""
5081 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
5082 "\n"
5083 msgstr ""
5084
5085 #. type: =head1
5086 #: ../examples/guestfs-recipes.pod:315
5087 msgid "List services in a Windows VM"
5088 msgstr ""
5089
5090 #. type: textblock
5091 #: ../examples/guestfs-recipes.pod:317
5092 msgid ""
5093 "The link below contains a script that can be used to list out the services "
5094 "from a Windows VM, and whether those services run at boot time or are loaded "
5095 "on demand."
5096 msgstr ""
5097
5098 #. type: textblock
5099 #: ../examples/guestfs-recipes.pod:321
5100 msgid "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/#content"
5101 msgstr ""
5102
5103 #. type: =head1
5104 #: ../examples/guestfs-recipes.pod:323
5105 msgid "Make a disk image sparse"
5106 msgstr ""
5107
5108 #. type: textblock
5109 #: ../examples/guestfs-recipes.pod:325
5110 msgid ""
5111 "The link below contains some guides for making a disk image sparse (or "
5112 "reintroducing sparseness)."
5113 msgstr ""
5114
5115 #. type: textblock
5116 #: ../examples/guestfs-recipes.pod:328
5117 msgid "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
5118 msgstr ""
5119
5120 #. type: =head1
5121 #: ../examples/guestfs-recipes.pod:330
5122 msgid "Monitor disk usage over time"
5123 msgstr ""
5124
5125 #. type: textblock
5126 #: ../examples/guestfs-recipes.pod:332
5127 msgid ""
5128 "You can use L<virt-df(1)> to monitor disk usage of your guests over time.  "
5129 "The link below contains a guide."
5130 msgstr ""
5131
5132 #. type: textblock
5133 #: ../examples/guestfs-recipes.pod:335
5134 msgid "http://virt-tools.org/learning/advanced-virt-df/"
5135 msgstr ""
5136
5137 #. type: =head1
5138 #: ../examples/guestfs-recipes.pod:337
5139 msgid "Reading the Windows Event Log from Windows Vista (or later)"
5140 msgstr ""
5141
5142 #. type: textblock
5143 #: ../examples/guestfs-recipes.pod:339
5144 msgid ""
5145 "L<guestfish(1)> plus the tools described in the link below can be used to "
5146 "read out the Windows Event Log from any virtual machine running Windows "
5147 "Vista or a later version."
5148 msgstr ""
5149
5150 #. type: textblock
5151 #: ../examples/guestfs-recipes.pod:343
5152 msgid "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-guestfish/#content"
5153 msgstr ""
5154
5155 #. type: =head1
5156 #: ../examples/guestfs-recipes.pod:345
5157 msgid "Remove root password (Linux)"
5158 msgstr ""
5159
5160 #. type: textblock
5161 #: ../examples/guestfs-recipes.pod:347
5162 msgid ""
5163 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
5164 "files.  One use is to remove the root password from a Linux guest:"
5165 msgstr ""
5166
5167 #. type: verbatim
5168 #: ../examples/guestfs-recipes.pod:350
5169 #, no-wrap
5170 msgid ""
5171 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
5172 "\n"
5173 msgstr ""
5174
5175 #. type: =head1
5176 #: ../examples/guestfs-recipes.pod:352
5177 msgid "Remove Administrator password (Windows)"
5178 msgstr ""
5179
5180 #. type: textblock
5181 #: ../examples/guestfs-recipes.pod:354
5182 msgid ""
5183 "The link below contains one technique for removing the Administrator "
5184 "password from a Windows VM, or to be more precise, it gives you a command "
5185 "prompt the next time you log in which you can use to bypass any security:"
5186 msgstr ""
5187
5188 #. type: textblock
5189 #: ../examples/guestfs-recipes.pod:359
5190 msgid "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-administrator-password-with-guestfish/"
5191 msgstr ""
5192
5193 #. type: =head1
5194 #: ../examples/guestfs-recipes.pod:361
5195 msgid "Unpack a live CD"
5196 msgstr ""
5197
5198 #. type: textblock
5199 #: ../examples/guestfs-recipes.pod:363
5200 msgid ""
5201 "Linux live CDs often contain multiple layers of disk images wrapped like a "
5202 "Russian doll.  You can use L<guestfish(1)> to look inside these multiple "
5203 "layers, as outlined in the guide below."
5204 msgstr ""
5205
5206 #. type: textblock
5207 #: ../examples/guestfs-recipes.pod:367
5208 msgid "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-cd/#content"
5209 msgstr ""
5210
5211 #. type: =head1
5212 #: ../examples/guestfs-recipes.pod:369
5213 msgid "Uploading and downloading files"
5214 msgstr ""
5215
5216 #. type: textblock
5217 #: ../examples/guestfs-recipes.pod:371
5218 msgid ""
5219 "The link below contains general tips on uploading (copying in)  and "
5220 "downloading (copying out) files from VMs."
5221 msgstr ""
5222
5223 #. type: textblock
5224 #: ../examples/guestfs-recipes.pod:374
5225 msgid "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
5226 msgstr ""
5227
5228 #. type: =head1
5229 #: ../examples/guestfs-recipes.pod:376
5230 msgid "Use libguestfs tools on VMware ESX guests"
5231 msgstr ""
5232
5233 #. type: textblock
5234 #: ../examples/guestfs-recipes.pod:378
5235 msgid ""
5236 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
5237 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
5238 msgstr ""
5239
5240 #. type: textblock
5241 #: ../examples/guestfs-recipes.pod:382
5242 msgid "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-guests/#content"
5243 msgstr ""
5244
5245 #. type: textblock
5246 #: ../examples/guestfs-recipes.pod:386
5247 msgid ""
5248 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, "
5249 "L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
5250 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, "
5251 "L<http://libguestfs.org/>."
5252 msgstr ""
5253
5254 #. type: textblock
5255 #: ../examples/guestfs-recipes.pod:403
5256 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5257 msgstr ""
5258
5259 #. type: =head2
5260 #: ../fish/guestfish-actions.pod:1
5261 msgid "add-cdrom"
5262 msgstr ""
5263
5264 #. type: verbatim
5265 #: ../fish/guestfish-actions.pod:3
5266 #, no-wrap
5267 msgid ""
5268 " add-cdrom filename\n"
5269 "\n"
5270 msgstr ""
5271
5272 #. type: textblock
5273 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:14
5274 msgid "This function adds a virtual CD-ROM disk image to the guest."
5275 msgstr ""
5276
5277 #. type: textblock
5278 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:16
5279 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5280 msgstr ""
5281
5282 #. type: textblock
5283 #: ../fish/guestfish-actions.pod:15
5284 msgid ""
5285 "This call checks for the existence of C<filename>.  This stops you from "
5286 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5287 "and C<http:> URLs.  To specify those, use the general L</config> call "
5288 "instead."
5289 msgstr ""
5290
5291 #. type: textblock
5292 #: ../fish/guestfish-actions.pod:22
5293 msgid ""
5294 "If you just want to add an ISO file (often you use this as an efficient way "
5295 "to transfer large files into the guest), then you should probably use "
5296 "L</add-drive-ro> instead."
5297 msgstr ""
5298
5299 #. type: textblock
5300 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:214 ../fish/guestfish-actions.pod:228
5301 msgid ""
5302 "I<This function is deprecated.> In new code, use the L</add_drive_opts> call "
5303 "instead."
5304 msgstr ""
5305
5306 #. type: textblock
5307 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:217 ../fish/guestfish-actions.pod:231 ../fish/guestfish-actions.pod:941 ../fish/guestfish-actions.pod:976 ../fish/guestfish-actions.pod:1149 ../fish/guestfish-actions.pod:1509 ../fish/guestfish-actions.pod:1523 ../fish/guestfish-actions.pod:3284 ../fish/guestfish-actions.pod:3595 ../fish/guestfish-actions.pod:3643 ../fish/guestfish-actions.pod:4561 ../fish/guestfish-actions.pod:4581 ../fish/guestfish-actions.pod:4600 ../fish/guestfish-actions.pod:4638 ../fish/guestfish-actions.pod:5287 ../fish/guestfish-actions.pod:5390 ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:305 ../src/guestfs-actions.pod:326 ../src/guestfs-actions.pod:1580 ../src/guestfs-actions.pod:1637 ../src/guestfs-actions.pod:1920 ../src/guestfs-actions.pod:2419 ../src/guestfs-actions.pod:2440 ../src/guestfs-actions.pod:5076 ../src/guestfs-actions.pod:5598 ../src/guestfs-actions.pod:5698 ../src/guestfs-actions.pod:6994 ../src/guestfs-actions.pod:7035 ../src/guestfs-actions.pod:7066 ../src/guestfs-actions.pod:7126 ../src/guestfs-actions.pod:8058 ../src/guestfs-actions.pod:8167 ../src/guestfs-actions.pod:8347
5308 msgid ""
5309 "Deprecated functions will not be removed from the API, but the fact that "
5310 "they are deprecated indicates that there are problems with correct use of "
5311 "these functions."
5312 msgstr ""
5313
5314 #. type: =head2
5315 #: ../fish/guestfish-actions.pod:35
5316 msgid "add-domain"
5317 msgstr ""
5318
5319 #. type: =head2
5320 #: ../fish/guestfish-actions.pod:37
5321 msgid "domain"
5322 msgstr ""
5323
5324 #. type: verbatim
5325 #: ../fish/guestfish-actions.pod:39
5326 #, no-wrap
5327 msgid ""
5328 " add-domain dom [libvirturi:..] [readonly:true|false] [iface:..] "
5329 "[live:true|false] [allowuuid:true|false] [readonlydisk:..]\n"
5330 "\n"
5331 msgstr ""
5332
5333 #. type: textblock
5334 #: ../fish/guestfish-actions.pod:41
5335 msgid ""
5336 "This function adds the disk(s) attached to the named libvirt domain C<dom>.  "
5337 "It works by connecting to libvirt, requesting the domain and domain XML from "
5338 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
5339 msgstr ""
5340
5341 #. type: textblock
5342 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:65
5343 msgid ""
5344 "The number of disks added is returned.  This operation is atomic: if an "
5345 "error is returned, then no disks are added."
5346 msgstr ""
5347
5348 #. type: textblock
5349 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:68
5350 msgid ""
5351 "This function does some minimal checks to make sure the libvirt domain is "
5352 "not running (unless C<readonly> is true).  In a future version we will try "
5353 "to acquire the libvirt lock on each disk."
5354 msgstr ""
5355
5356 #. type: textblock
5357 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:72
5358 msgid ""
5359 "Disks must be accessible locally.  This often means that adding disks from a "
5360 "remote libvirt connection (see L<http://libvirt.org/remote.html>)  will fail "
5361 "unless those disks are accessible via the same device path locally too."
5362 msgstr ""
5363
5364 #. type: textblock
5365 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:77
5366 msgid ""
5367 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5368 "L<http://libvirt.org/uri.html>).  If this is not set then we connect to the "
5369 "default libvirt URI (or one set through an environment variable, see the "
5370 "libvirt documentation for full details)."
5371 msgstr ""
5372
5373 #. type: textblock
5374 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:83
5375 msgid ""
5376 "The optional C<live> flag controls whether this call will try to connect to "
5377 "a running virtual machine C<guestfsd> process if it sees a suitable "
5378 "E<lt>channelE<gt> element in the libvirt XML definition.  The default (if "
5379 "the flag is omitted) is never to try.  See L<guestfs(3)/ATTACHING TO RUNNING "
5380 "DAEMONS> for more information."
5381 msgstr ""
5382
5383 #. type: textblock
5384 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:90
5385 msgid ""
5386 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
5387 "passed instead of the domain name.  The C<dom> string is treated as a UUID "
5388 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
5389 "as usual."
5390 msgstr ""
5391
5392 #. type: textblock
5393 #: ../fish/guestfish-actions.pod:76 ../src/guestfs-actions.pod:95
5394 msgid ""
5395 "The optional C<readonlydisk> parameter controls what we do for disks which "
5396 "are marked E<lt>readonly/E<gt> in the libvirt XML.  Possible values are:"
5397 msgstr ""
5398
5399 #. type: =item
5400 #: ../fish/guestfish-actions.pod:82 ../src/guestfs-actions.pod:101
5401 msgid "readonlydisk = \"error\""
5402 msgstr ""
5403
5404 #. type: textblock
5405 #: ../fish/guestfish-actions.pod:84 ../fish/guestfish-actions.pod:95 ../fish/guestfish-actions.pod:106 ../src/guestfs-actions.pod:103 ../src/guestfs-actions.pod:114 ../src/guestfs-actions.pod:125
5406 msgid "If C<readonly> is false:"
5407 msgstr ""
5408
5409 #. type: textblock
5410 #: ../fish/guestfish-actions.pod:86 ../src/guestfs-actions.pod:105
5411 msgid ""
5412 "The whole call is aborted with an error if any disk with the "
5413 "E<lt>readonly/E<gt> flag is found."
5414 msgstr ""
5415
5416 #. type: textblock
5417 #: ../fish/guestfish-actions.pod:89 ../fish/guestfish-actions.pod:100 ../fish/guestfish-actions.pod:110 ../src/guestfs-actions.pod:108 ../src/guestfs-actions.pod:119 ../src/guestfs-actions.pod:129
5418 msgid "If C<readonly> is true:"
5419 msgstr ""
5420
5421 #. type: textblock
5422 #: ../fish/guestfish-actions.pod:91 ../fish/guestfish-actions.pod:102 ../fish/guestfish-actions.pod:112 ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121 ../src/guestfs-actions.pod:131
5423 msgid "Disks with the E<lt>readonly/E<gt> flag are added read-only."
5424 msgstr ""
5425
5426 #. type: =item
5427 #: ../fish/guestfish-actions.pod:93 ../src/guestfs-actions.pod:112
5428 msgid "readonlydisk = \"read\""
5429 msgstr ""
5430
5431 #. type: textblock
5432 #: ../fish/guestfish-actions.pod:97 ../src/guestfs-actions.pod:116
5433 msgid ""
5434 "Disks with the E<lt>readonly/E<gt> flag are added read-only.  Other disks "
5435 "are added read/write."
5436 msgstr ""
5437
5438 #. type: =item
5439 #: ../fish/guestfish-actions.pod:104 ../src/guestfs-actions.pod:123
5440 msgid "readonlydisk = \"write\" (default)"
5441 msgstr ""
5442
5443 #. type: textblock
5444 #: ../fish/guestfish-actions.pod:108 ../src/guestfs-actions.pod:127
5445 msgid "Disks with the E<lt>readonly/E<gt> flag are added read/write."
5446 msgstr ""
5447
5448 #. type: =item
5449 #: ../fish/guestfish-actions.pod:114 ../src/guestfs-actions.pod:133
5450 msgid "readonlydisk = \"ignore\""
5451 msgstr ""
5452
5453 #. type: textblock
5454 #: ../fish/guestfish-actions.pod:116 ../src/guestfs-actions.pod:135
5455 msgid "If C<readonly> is true or false:"
5456 msgstr ""
5457
5458 #. type: textblock
5459 #: ../fish/guestfish-actions.pod:118 ../src/guestfs-actions.pod:137
5460 msgid "Disks with the E<lt>readonly/E<gt> flag are skipped."
5461 msgstr ""
5462
5463 #. type: textblock
5464 #: ../fish/guestfish-actions.pod:122
5465 msgid ""
5466 "The other optional parameters are passed directly through to "
5467 "L</add-drive-opts>."
5468 msgstr ""
5469
5470 #. type: textblock
5471 #: ../fish/guestfish-actions.pod:125 ../fish/guestfish-actions.pod:194 ../fish/guestfish-actions.pod:624 ../fish/guestfish-actions.pod:835 ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:894 ../fish/guestfish-actions.pod:903 ../fish/guestfish-actions.pod:912 ../fish/guestfish-actions.pod:926 ../fish/guestfish-actions.pod:2171 ../fish/guestfish-actions.pod:3333 ../fish/guestfish-actions.pod:3496 ../fish/guestfish-actions.pod:3631
5472 msgid ""
5473 "This command has one or more optional arguments.  See L</OPTIONAL "
5474 "ARGUMENTS>."
5475 msgstr ""
5476
5477 #. type: =head2
5478 #: ../fish/guestfish-actions.pod:127
5479 msgid "add-drive"
5480 msgstr ""
5481
5482 #. type: verbatim
5483 #: ../fish/guestfish-actions.pod:129
5484 #, no-wrap
5485 msgid ""
5486 " add-drive filename\n"
5487 "\n"
5488 msgstr ""
5489
5490 #. type: textblock
5491 #: ../fish/guestfish-actions.pod:131
5492 msgid ""
5493 "This function is the equivalent of calling L</add-drive-opts> with no "
5494 "optional parameters, so the disk is added writable, with the format being "
5495 "detected automatically."
5496 msgstr ""
5497
5498 #. type: textblock
5499 #: ../fish/guestfish-actions.pod:135
5500 msgid ""
5501 "Automatic detection of the format opens you up to a potential security hole "
5502 "when dealing with untrusted raw-format images.  See CVE-2010-3851 and "
5503 "RHBZ#642934.  Specifying the format closes this security hole.  Therefore "
5504 "you should think about replacing calls to this function with calls to "
5505 "L</add-drive-opts>, and specifying the format."
5506 msgstr ""
5507
5508 #. type: =head2
5509 #: ../fish/guestfish-actions.pod:142
5510 msgid "add-drive-opts"
5511 msgstr ""
5512
5513 #. type: =head2
5514 #: ../fish/guestfish-actions.pod:144
5515 msgid "add"
5516 msgstr ""
5517
5518 #. type: verbatim
5519 #: ../fish/guestfish-actions.pod:146
5520 #, no-wrap
5521 msgid ""
5522 " add-drive-opts filename [readonly:true|false] [format:..] [iface:..] "
5523 "[name:..]\n"
5524 "\n"
5525 msgstr ""
5526
5527 #. type: textblock
5528 #: ../fish/guestfish-actions.pod:148 ../src/guestfs-actions.pod:208
5529 msgid ""
5530 "This function adds a virtual machine disk image C<filename> to libguestfs.  "
5531 "The first time you call this function, the disk appears as C</dev/sda>, the "
5532 "second time as C</dev/sdb>, and so on."
5533 msgstr ""
5534
5535 #. type: textblock
5536 #: ../fish/guestfish-actions.pod:153 ../src/guestfs-actions.pod:213
5537 msgid ""
5538 "You don't necessarily need to be root when using libguestfs.  However you "
5539 "obviously do need sufficient permissions to access the filename for whatever "
5540 "operations you want to perform (ie. read access if you just want to read the "
5541 "image or write access if you want to modify the image)."
5542 msgstr ""
5543
5544 #. type: textblock
5545 #: ../fish/guestfish-actions.pod:159 ../src/guestfs-actions.pod:219
5546 msgid "This call checks that C<filename> exists."
5547 msgstr ""
5548
5549 #. type: textblock
5550 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:3295 ../src/guestfs-actions.pod:221 ../src/guestfs-actions.pod:5113
5551 msgid "The optional arguments are:"
5552 msgstr ""
5553
5554 #. type: =item
5555 #: ../fish/guestfish-actions.pod:165 ../src/guestfs-actions.pod:225
5556 msgid "C<readonly>"
5557 msgstr ""
5558
5559 #. type: textblock
5560 #: ../fish/guestfish-actions.pod:167 ../src/guestfs-actions.pod:227
5561 msgid ""
5562 "If true then the image is treated as read-only.  Writes are still allowed, "
5563 "but they are stored in a temporary snapshot overlay which is discarded at "
5564 "the end.  The disk that you add is not modified."
5565 msgstr ""
5566
5567 #. type: =item
5568 #: ../fish/guestfish-actions.pod:171 ../src/guestfs-actions.pod:231
5569 msgid "C<format>"
5570 msgstr ""
5571
5572 #. type: textblock
5573 #: ../fish/guestfish-actions.pod:173
5574 msgid ""
5575 "This forces the image format.  If you omit this (or use L</add-drive> or "
5576 "L</add-drive-ro>) then the format is automatically detected.  Possible "
5577 "formats include C<raw> and C<qcow2>."
5578 msgstr ""
5579
5580 #. type: textblock
5581 #: ../fish/guestfish-actions.pod:177 ../src/guestfs-actions.pod:237
5582 msgid ""
5583 "Automatic detection of the format opens you up to a potential security hole "
5584 "when dealing with untrusted raw-format images.  See CVE-2010-3851 and "
5585 "RHBZ#642934.  Specifying the format closes this security hole."
5586 msgstr ""
5587
5588 #. type: =item
5589 #: ../fish/guestfish-actions.pod:182 ../src/guestfs-actions.pod:242
5590 msgid "C<iface>"
5591 msgstr ""
5592
5593 #. type: textblock
5594 #: ../fish/guestfish-actions.pod:184
5595 msgid ""
5596 "This rarely-used option lets you emulate the behaviour of the deprecated "
5597 "L</add-drive-with-if> call (q.v.)"
5598 msgstr ""
5599
5600 #. type: =item
5601 #: ../fish/guestfish-actions.pod:187 ../src/guestfs-actions.pod:247
5602 msgid "C<name>"
5603 msgstr ""
5604
5605 #. type: textblock
5606 #: ../fish/guestfish-actions.pod:189 ../src/guestfs-actions.pod:249
5607 msgid ""
5608 "The name the drive had in the original guest, e.g. /dev/sdb. This is used as "
5609 "a hint to the guest inspection process if it is available."
5610 msgstr ""
5611
5612 #. type: =head2
5613 #: ../fish/guestfish-actions.pod:196
5614 msgid "add-drive-ro"
5615 msgstr ""
5616
5617 #. type: =head2
5618 #: ../fish/guestfish-actions.pod:198
5619 msgid "add-ro"
5620 msgstr ""
5621
5622 #. type: verbatim
5623 #: ../fish/guestfish-actions.pod:200
5624 #, no-wrap
5625 msgid ""
5626 " add-drive-ro filename\n"
5627 "\n"
5628 msgstr ""
5629
5630 #. type: textblock
5631 #: ../fish/guestfish-actions.pod:202
5632 msgid ""
5633 "This function is the equivalent of calling L</add-drive-opts> with the "
5634 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
5635 "is added read-only, with the format being detected automatically."
5636 msgstr ""
5637
5638 #. type: =head2
5639 #: ../fish/guestfish-actions.pod:207
5640 msgid "add-drive-ro-with-if"
5641 msgstr ""
5642
5643 #. type: verbatim
5644 #: ../fish/guestfish-actions.pod:209
5645 #, no-wrap
5646 msgid ""
5647 " add-drive-ro-with-if filename iface\n"
5648 "\n"
5649 msgstr ""
5650
5651 #. type: textblock
5652 #: ../fish/guestfish-actions.pod:211
5653 msgid ""
5654 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
5655 "interface emulation to use at run time."
5656 msgstr ""
5657
5658 #. type: =head2
5659 #: ../fish/guestfish-actions.pod:221
5660 msgid "add-drive-with-if"
5661 msgstr ""
5662
5663 #. type: verbatim
5664 #: ../fish/guestfish-actions.pod:223
5665 #, no-wrap
5666 msgid ""
5667 " add-drive-with-if filename iface\n"
5668 "\n"
5669 msgstr ""
5670
5671 #. type: textblock
5672 #: ../fish/guestfish-actions.pod:225
5673 msgid ""
5674 "This is the same as L</add-drive> but it allows you to specify the QEMU "
5675 "interface emulation to use at run time."
5676 msgstr ""
5677
5678 #. type: =head2
5679 #: ../fish/guestfish-actions.pod:235
5680 msgid "aug-clear"
5681 msgstr ""
5682
5683 #. type: verbatim
5684 #: ../fish/guestfish-actions.pod:237
5685 #, no-wrap
5686 msgid ""
5687 " aug-clear augpath\n"
5688 "\n"
5689 msgstr ""
5690
5691 #. type: textblock
5692 #: ../fish/guestfish-actions.pod:239 ../src/guestfs-actions.pod:343
5693 msgid ""
5694 "Set the value associated with C<path> to C<NULL>.  This is the same as the "
5695 "L<augtool(1)> C<clear> command."
5696 msgstr ""
5697
5698 #. type: =head2
5699 #: ../fish/guestfish-actions.pod:242
5700 msgid "aug-close"
5701 msgstr ""
5702
5703 #. type: verbatim
5704 #: ../fish/guestfish-actions.pod:244
5705 #, no-wrap
5706 msgid ""
5707 " aug-close\n"
5708 "\n"
5709 msgstr ""
5710
5711 #. type: textblock
5712 #: ../fish/guestfish-actions.pod:246
5713 msgid ""
5714 "Close the current Augeas handle and free up any resources used by it.  After "
5715 "calling this, you have to call L</aug-init> again before you can use any "
5716 "other Augeas functions."
5717 msgstr ""
5718
5719 #. type: =head2
5720 #: ../fish/guestfish-actions.pod:251
5721 msgid "aug-defnode"
5722 msgstr ""
5723
5724 #. type: verbatim
5725 #: ../fish/guestfish-actions.pod:253
5726 #, no-wrap
5727 msgid ""
5728 " aug-defnode name expr val\n"
5729 "\n"
5730 msgstr ""
5731
5732 #. type: textblock
5733 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:372
5734 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
5735 msgstr ""
5736
5737 #. type: textblock
5738 #: ../fish/guestfish-actions.pod:258
5739 msgid ""
5740 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
5741 "calling L</aug-set> C<expr>, C<value>.  C<name> will be the nodeset "
5742 "containing that single node."
5743 msgstr ""
5744
5745 #. type: textblock
5746 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:379
5747 msgid ""
5748 "On success this returns a pair containing the number of nodes in the "
5749 "nodeset, and a boolean flag if a node was created."
5750 msgstr ""
5751
5752 #. type: =head2
5753 #: ../fish/guestfish-actions.pod:266
5754 msgid "aug-defvar"
5755 msgstr ""
5756
5757 #. type: verbatim
5758 #: ../fish/guestfish-actions.pod:268
5759 #, no-wrap
5760 msgid ""
5761 " aug-defvar name expr\n"
5762 "\n"
5763 msgstr ""
5764
5765 #. type: textblock
5766 #: ../fish/guestfish-actions.pod:270 ../src/guestfs-actions.pod:396
5767 msgid ""
5768 "Defines an Augeas variable C<name> whose value is the result of evaluating "
5769 "C<expr>.  If C<expr> is NULL, then C<name> is undefined."
5770 msgstr ""
5771
5772 #. type: textblock
5773 #: ../fish/guestfish-actions.pod:274 ../src/guestfs-actions.pod:400
5774 msgid ""
5775 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
5776 "evaluates to something which is not a nodeset."
5777 msgstr ""
5778
5779 #. type: =head2
5780 #: ../fish/guestfish-actions.pod:277
5781 msgid "aug-get"
5782 msgstr ""
5783
5784 #. type: verbatim
5785 #: ../fish/guestfish-actions.pod:279
5786 #, no-wrap
5787 msgid ""
5788 " aug-get augpath\n"
5789 "\n"
5790 msgstr ""
5791
5792 #. type: textblock
5793 #: ../fish/guestfish-actions.pod:281 ../src/guestfs-actions.pod:413
5794 msgid ""
5795 "Look up the value associated with C<path>.  If C<path> matches exactly one "
5796 "node, the C<value> is returned."
5797 msgstr ""
5798
5799 #. type: =head2
5800 #: ../fish/guestfish-actions.pod:284
5801 msgid "aug-init"
5802 msgstr ""
5803
5804 #. type: verbatim
5805 #: ../fish/guestfish-actions.pod:286
5806 #, no-wrap
5807 msgid ""
5808 " aug-init root flags\n"
5809 "\n"
5810 msgstr ""
5811
5812 #. type: textblock
5813 #: ../fish/guestfish-actions.pod:288 ../src/guestfs-actions.pod:428
5814 msgid ""
5815 "Create a new Augeas handle for editing configuration files.  If there was "
5816 "any previous Augeas handle associated with this guestfs session, then it is "
5817 "closed."
5818 msgstr ""
5819
5820 #. type: textblock
5821 #: ../fish/guestfish-actions.pod:292
5822 msgid "You must call this before using any other L</aug-*> commands."
5823 msgstr ""
5824
5825 #. type: textblock
5826 #: ../fish/guestfish-actions.pod:295 ../src/guestfs-actions.pod:435
5827 msgid "C<root> is the filesystem root.  C<root> must not be NULL, use C</> instead."
5828 msgstr ""
5829
5830 #. type: textblock
5831 #: ../fish/guestfish-actions.pod:298 ../src/guestfs-actions.pod:438
5832 msgid ""
5833 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5834 "logical I<or> of the following integers:"
5835 msgstr ""
5836
5837 #. type: =item
5838 #: ../fish/guestfish-actions.pod:304 ../src/guestfs-actions.pod:444
5839 msgid "C<AUG_SAVE_BACKUP> = 1"
5840 msgstr ""
5841
5842 #. type: textblock
5843 #: ../fish/guestfish-actions.pod:306 ../src/guestfs-actions.pod:446
5844 msgid "Keep the original file with a C<.augsave> extension."
5845 msgstr ""
5846
5847 #. type: =item
5848 #: ../fish/guestfish-actions.pod:308 ../src/guestfs-actions.pod:448
5849 msgid "C<AUG_SAVE_NEWFILE> = 2"
5850 msgstr ""
5851
5852 #. type: textblock
5853 #: ../fish/guestfish-actions.pod:310 ../src/guestfs-actions.pod:450
5854 msgid ""
5855 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5856 "original.  Overrides C<AUG_SAVE_BACKUP>."
5857 msgstr ""
5858
5859 #. type: =item
5860 #: ../fish/guestfish-actions.pod:313 ../src/guestfs-actions.pod:453
5861 msgid "C<AUG_TYPE_CHECK> = 4"
5862 msgstr ""
5863
5864 #. type: textblock
5865 #: ../fish/guestfish-actions.pod:315 ../src/guestfs-actions.pod:455
5866 msgid "Typecheck lenses."
5867 msgstr ""
5868
5869 #. type: textblock
5870 #: ../fish/guestfish-actions.pod:317
5871 msgid ""
5872 "This option is only useful when debugging Augeas lenses.  Use of this option "
5873 "may require additional memory for the libguestfs appliance.  You may need to "
5874 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
5875 msgstr ""
5876
5877 #. type: =item
5878 #: ../fish/guestfish-actions.pod:322 ../src/guestfs-actions.pod:462
5879 msgid "C<AUG_NO_STDINC> = 8"
5880 msgstr ""
5881
5882 #. type: textblock
5883 #: ../fish/guestfish-actions.pod:324 ../src/guestfs-actions.pod:464
5884 msgid "Do not use standard load path for modules."
5885 msgstr ""
5886
5887 #. type: =item
5888 #: ../fish/guestfish-actions.pod:326 ../src/guestfs-actions.pod:466
5889 msgid "C<AUG_SAVE_NOOP> = 16"
5890 msgstr ""
5891
5892 #. type: textblock
5893 #: ../fish/guestfish-actions.pod:328 ../src/guestfs-actions.pod:468
5894 msgid "Make save a no-op, just record what would have been changed."
5895 msgstr ""
5896
5897 #. type: =item
5898 #: ../fish/guestfish-actions.pod:330 ../src/guestfs-actions.pod:470
5899 msgid "C<AUG_NO_LOAD> = 32"
5900 msgstr ""
5901
5902 #. type: textblock
5903 #: ../fish/guestfish-actions.pod:332
5904 msgid "Do not load the tree in L</aug-init>."
5905 msgstr ""
5906
5907 #. type: textblock
5908 #: ../fish/guestfish-actions.pod:336
5909 msgid "To close the handle, you can call L</aug-close>."
5910 msgstr ""
5911
5912 #. type: textblock
5913 #: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:478
5914 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5915 msgstr ""
5916
5917 #. type: =head2
5918 #: ../fish/guestfish-actions.pod:340
5919 msgid "aug-insert"
5920 msgstr ""
5921
5922 #. type: verbatim
5923 #: ../fish/guestfish-actions.pod:342
5924 #, no-wrap
5925 msgid ""
5926 " aug-insert augpath label true|false\n"
5927 "\n"
5928 msgstr ""
5929
5930 #. type: textblock
5931 #: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:492
5932 msgid ""
5933 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5934 "or after C<path> (depending on the boolean flag C<before>)."
5935 msgstr ""
5936
5937 #. type: textblock
5938 #: ../fish/guestfish-actions.pod:348 ../src/guestfs-actions.pod:496
5939 msgid ""
5940 "C<path> must match exactly one existing node in the tree, and C<label> must "
5941 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5942 msgstr ""
5943
5944 #. type: =head2
5945 #: ../fish/guestfish-actions.pod:352
5946 msgid "aug-load"
5947 msgstr ""
5948
5949 #. type: verbatim
5950 #: ../fish/guestfish-actions.pod:354
5951 #, no-wrap
5952 msgid ""
5953 " aug-load\n"
5954 "\n"
5955 msgstr ""
5956
5957 #. type: textblock
5958 #: ../fish/guestfish-actions.pod:356 ../src/guestfs-actions.pod:509
5959 msgid "Load files into the tree."
5960 msgstr ""
5961
5962 #. type: textblock
5963 #: ../fish/guestfish-actions.pod:358 ../src/guestfs-actions.pod:511
5964 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5965 msgstr ""
5966
5967 #. type: =head2
5968 #: ../fish/guestfish-actions.pod:361
5969 msgid "aug-ls"
5970 msgstr ""
5971
5972 #. type: verbatim
5973 #: ../fish/guestfish-actions.pod:363
5974 #, no-wrap
5975 msgid ""
5976 " aug-ls augpath\n"
5977 "\n"
5978 msgstr ""
5979
5980 #. type: textblock
5981 #: ../fish/guestfish-actions.pod:365
5982 msgid ""
5983 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
5984 "resulting nodes into alphabetical order."
5985 msgstr ""
5986
5987 #. type: =head2
5988 #: ../fish/guestfish-actions.pod:368
5989 msgid "aug-match"
5990 msgstr ""
5991
5992 #. type: verbatim
5993 #: ../fish/guestfish-actions.pod:370
5994 #, no-wrap
5995 msgid ""
5996 " aug-match augpath\n"
5997 "\n"
5998 msgstr ""
5999
6000 #. type: textblock
6001 #: ../fish/guestfish-actions.pod:372 ../src/guestfs-actions.pod:539
6002 msgid ""
6003 "Returns a list of paths which match the path expression C<path>.  The "
6004 "returned paths are sufficiently qualified so that they match exactly one "
6005 "node in the current tree."
6006 msgstr ""
6007
6008 #. type: =head2
6009 #: ../fish/guestfish-actions.pod:376
6010 msgid "aug-mv"
6011 msgstr ""
6012
6013 #. type: verbatim
6014 #: ../fish/guestfish-actions.pod:378
6015 #, no-wrap
6016 msgid ""
6017 " aug-mv src dest\n"
6018 "\n"
6019 msgstr ""
6020
6021 #. type: textblock
6022 #: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:556
6023 msgid ""
6024 "Move the node C<src> to C<dest>.  C<src> must match exactly one node.  "
6025 "C<dest> is overwritten if it exists."
6026 msgstr ""
6027
6028 #. type: =head2
6029 #: ../fish/guestfish-actions.pod:383
6030 msgid "aug-rm"
6031 msgstr ""
6032
6033 #. type: verbatim
6034 #: ../fish/guestfish-actions.pod:385
6035 #, no-wrap
6036 msgid ""
6037 " aug-rm augpath\n"
6038 "\n"
6039 msgstr ""
6040
6041 #. type: textblock
6042 #: ../fish/guestfish-actions.pod:387 ../src/guestfs-actions.pod:569
6043 msgid "Remove C<path> and all of its children."
6044 msgstr ""
6045
6046 #. type: textblock
6047 #: ../fish/guestfish-actions.pod:389 ../src/guestfs-actions.pod:571
6048 msgid "On success this returns the number of entries which were removed."
6049 msgstr ""
6050
6051 #. type: =head2
6052 #: ../fish/guestfish-actions.pod:391
6053 msgid "aug-save"
6054 msgstr ""
6055
6056 #. type: verbatim
6057 #: ../fish/guestfish-actions.pod:393
6058 #, no-wrap
6059 msgid ""
6060 " aug-save\n"
6061 "\n"
6062 msgstr ""
6063
6064 #. type: textblock
6065 #: ../fish/guestfish-actions.pod:395 ../src/guestfs-actions.pod:582
6066 msgid "This writes all pending changes to disk."
6067 msgstr ""
6068
6069 #. type: textblock
6070 #: ../fish/guestfish-actions.pod:397
6071 msgid ""
6072 "The flags which were passed to L</aug-init> affect exactly how files are "
6073 "saved."
6074 msgstr ""
6075
6076 #. type: =head2
6077 #: ../fish/guestfish-actions.pod:400
6078 msgid "aug-set"
6079 msgstr ""
6080
6081 #. type: verbatim
6082 #: ../fish/guestfish-actions.pod:402
6083 #, no-wrap
6084 msgid ""
6085 " aug-set augpath val\n"
6086 "\n"
6087 msgstr ""
6088
6089 #. type: textblock
6090 #: ../fish/guestfish-actions.pod:404 ../src/guestfs-actions.pod:598
6091 msgid "Set the value associated with C<path> to C<val>."
6092 msgstr ""
6093
6094 #. type: textblock
6095 #: ../fish/guestfish-actions.pod:406
6096 msgid ""
6097 "In the Augeas API, it is possible to clear a node by setting the value to "
6098 "NULL.  Due to an oversight in the libguestfs API you cannot do that with "
6099 "this call.  Instead you must use the L</aug-clear> call."
6100 msgstr ""
6101
6102 #. type: =head2
6103 #: ../fish/guestfish-actions.pod:411
6104 msgid "available"
6105 msgstr ""
6106
6107 #. type: verbatim
6108 #: ../fish/guestfish-actions.pod:413
6109 #, no-wrap
6110 msgid ""
6111 " available 'groups ...'\n"
6112 "\n"
6113 msgstr ""
6114
6115 #. type: textblock
6116 #: ../fish/guestfish-actions.pod:415 ../src/guestfs-actions.pod:615
6117 msgid ""
6118 "This command is used to check the availability of some groups of "
6119 "functionality in the appliance, which not all builds of the libguestfs "
6120 "appliance will be able to provide."
6121 msgstr ""
6122
6123 #. type: textblock
6124 #: ../fish/guestfish-actions.pod:419
6125 msgid ""
6126 "The libguestfs groups, and the functions that those groups correspond to, "
6127 "are listed in L<guestfs(3)/AVAILABILITY>.  You can also fetch this list at "
6128 "runtime by calling L</available-all-groups>."
6129 msgstr ""
6130
6131 #. type: textblock
6132 #: ../fish/guestfish-actions.pod:424 ../src/guestfs-actions.pod:624
6133 msgid ""
6134 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6135 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6136 "and Augeas (configuration file editing) functions."
6137 msgstr ""
6138
6139 #. type: textblock
6140 #: ../fish/guestfish-actions.pod:429 ../src/guestfs-actions.pod:629
6141 msgid "The command returns no error if I<all> requested groups are available."
6142 msgstr ""
6143
6144 #. type: textblock
6145 #: ../fish/guestfish-actions.pod:431 ../src/guestfs-actions.pod:631
6146 msgid ""
6147 "It fails with an error if one or more of the requested groups is unavailable "
6148 "in the appliance."
6149 msgstr ""
6150
6151 #. type: textblock
6152 #: ../fish/guestfish-actions.pod:434 ../src/guestfs-actions.pod:634
6153 msgid ""
6154 "If an unknown group name is included in the list of groups then an error is "
6155 "always returned."
6156 msgstr ""
6157
6158 #. type: textblock
6159 #: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:637
6160 msgid "I<Notes:>"
6161 msgstr ""
6162
6163 #. type: textblock
6164 #: ../fish/guestfish-actions.pod:443
6165 msgid "You must call L</launch> before calling this function."
6166 msgstr ""
6167
6168 #. type: textblock
6169 #: ../fish/guestfish-actions.pod:445 ../src/guestfs-actions.pod:645
6170 msgid ""
6171 "The reason is because we don't know what groups are supported by the "
6172 "appliance/daemon until it is running and can be queried."
6173 msgstr ""
6174
6175 #. type: textblock
6176 #: ../fish/guestfish-actions.pod:451 ../src/guestfs-actions.pod:651
6177 msgid ""
6178 "If a group of functions is available, this does not necessarily mean that "
6179 "they will work.  You still have to check for errors when calling individual "
6180 "API functions even if they are available."
6181 msgstr ""
6182
6183 #. type: textblock
6184 #: ../fish/guestfish-actions.pod:458 ../src/guestfs-actions.pod:658
6185 msgid ""
6186 "It is usually the job of distro packagers to build complete functionality "
6187 "into the libguestfs appliance.  Upstream libguestfs, if built from source "
6188 "with all requirements satisfied, will support everything."
6189 msgstr ""
6190
6191 #. type: textblock
6192 #: ../fish/guestfish-actions.pod:465
6193 msgid ""
6194 "This call was added in version C<1.0.80>.  In previous versions of "
6195 "libguestfs all you could do would be to speculatively execute a command to "
6196 "find out if the daemon implemented it.  See also L</version>."
6197 msgstr ""
6198
6199 #. type: =head2
6200 #: ../fish/guestfish-actions.pod:472
6201 msgid "available-all-groups"
6202 msgstr ""
6203
6204 #. type: verbatim
6205 #: ../fish/guestfish-actions.pod:474
6206 #, no-wrap
6207 msgid ""
6208 " available-all-groups\n"
6209 "\n"
6210 msgstr ""
6211
6212 #. type: textblock
6213 #: ../fish/guestfish-actions.pod:476
6214 msgid ""
6215 "This command returns a list of all optional groups that this daemon knows "
6216 "about.  Note this returns both supported and unsupported groups.  To find "
6217 "out which ones the daemon can actually support you have to call "
6218 "L</available> on each member of the returned list."
6219 msgstr ""
6220
6221 #. type: textblock
6222 #: ../fish/guestfish-actions.pod:482
6223 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
6224 msgstr ""
6225
6226 #. type: =head2
6227 #: ../fish/guestfish-actions.pod:484
6228 msgid "base64-in"
6229 msgstr ""
6230
6231 #. type: verbatim
6232 #: ../fish/guestfish-actions.pod:486
6233 #, no-wrap
6234 msgid ""
6235 " base64-in (base64file|-) filename\n"
6236 "\n"
6237 msgstr ""
6238
6239 #. type: textblock
6240 #: ../fish/guestfish-actions.pod:488 ../src/guestfs-actions.pod:702
6241 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6242 msgstr ""
6243
6244 #. type: textblock
6245 #: ../fish/guestfish-actions.pod:491 ../fish/guestfish-actions.pod:500 ../fish/guestfish-actions.pod:749 ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:854 ../fish/guestfish-actions.pod:1025 ../fish/guestfish-actions.pod:1044 ../fish/guestfish-actions.pod:1418 ../fish/guestfish-actions.pod:4858 ../fish/guestfish-actions.pod:4870 ../fish/guestfish-actions.pod:4881 ../fish/guestfish-actions.pod:4892 ../fish/guestfish-actions.pod:4944 ../fish/guestfish-actions.pod:4953 ../fish/guestfish-actions.pod:5007 ../fish/guestfish-actions.pod:5030
6246 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
6247 msgstr ""
6248
6249 #. type: =head2
6250 #: ../fish/guestfish-actions.pod:493
6251 msgid "base64-out"
6252 msgstr ""
6253
6254 #. type: verbatim
6255 #: ../fish/guestfish-actions.pod:495
6256 #, no-wrap
6257 msgid ""
6258 " base64-out filename (base64file|-)\n"
6259 "\n"
6260 msgstr ""
6261
6262 #. type: textblock
6263 #: ../fish/guestfish-actions.pod:497 ../src/guestfs-actions.pod:716
6264 msgid ""
6265 "This command downloads the contents of C<filename>, writing it out to local "
6266 "file C<base64file> encoded as base64."
6267 msgstr ""
6268
6269 #. type: =head2
6270 #: ../fish/guestfish-actions.pod:502
6271 msgid "blockdev-flushbufs"
6272 msgstr ""
6273
6274 #. type: verbatim
6275 #: ../fish/guestfish-actions.pod:504
6276 #, no-wrap
6277 msgid ""
6278 " blockdev-flushbufs device\n"
6279 "\n"
6280 msgstr ""
6281
6282 #. type: textblock
6283 #: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:729
6284 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6285 msgstr ""
6286
6287 #. type: textblock
6288 #: ../fish/guestfish-actions.pod:509 ../fish/guestfish-actions.pod:520 ../fish/guestfish-actions.pod:529 ../fish/guestfish-actions.pod:539 ../fish/guestfish-actions.pod:551 ../fish/guestfish-actions.pod:564 ../fish/guestfish-actions.pod:572 ../fish/guestfish-actions.pod:583 ../fish/guestfish-actions.pod:591 ../fish/guestfish-actions.pod:599 ../src/guestfs-actions.pod:732 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:764 ../src/guestfs-actions.pod:780 ../src/guestfs-actions.pod:798 ../src/guestfs-actions.pod:817 ../src/guestfs-actions.pod:831 ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:877
6289 msgid "This uses the L<blockdev(8)> command."
6290 msgstr ""
6291
6292 #. type: =head2
6293 #: ../fish/guestfish-actions.pod:511
6294 msgid "blockdev-getbsz"
6295 msgstr ""
6296
6297 #. type: verbatim
6298 #: ../fish/guestfish-actions.pod:513
6299 #, no-wrap
6300 msgid ""
6301 " blockdev-getbsz device\n"
6302 "\n"
6303 msgstr ""
6304
6305 #. type: textblock
6306 #: ../fish/guestfish-actions.pod:515 ../src/guestfs-actions.pod:744
6307 msgid "This returns the block size of a device."
6308 msgstr ""
6309
6310 #. type: textblock
6311 #: ../fish/guestfish-actions.pod:517 ../fish/guestfish-actions.pod:580 ../src/guestfs-actions.pod:746 ../src/guestfs-actions.pod:846
6312 msgid ""
6313 "(Note this is different from both I<size in blocks> and I<filesystem block "
6314 "size>)."
6315 msgstr ""
6316
6317 #. type: =head2
6318 #: ../fish/guestfish-actions.pod:522
6319 msgid "blockdev-getro"
6320 msgstr ""
6321
6322 #. type: verbatim
6323 #: ../fish/guestfish-actions.pod:524
6324 #, no-wrap
6325 msgid ""
6326 " blockdev-getro device\n"
6327 "\n"
6328 msgstr ""
6329
6330 #. type: textblock
6331 #: ../fish/guestfish-actions.pod:526 ../src/guestfs-actions.pod:761
6332 msgid ""
6333 "Returns a boolean indicating if the block device is read-only (true if "
6334 "read-only, false if not)."
6335 msgstr ""
6336
6337 #. type: =head2
6338 #: ../fish/guestfish-actions.pod:531
6339 msgid "blockdev-getsize64"
6340 msgstr ""
6341
6342 #. type: verbatim
6343 #: ../fish/guestfish-actions.pod:533
6344 #, no-wrap
6345 msgid ""
6346 " blockdev-getsize64 device\n"
6347 "\n"
6348 msgstr ""
6349
6350 #. type: textblock
6351 #: ../fish/guestfish-actions.pod:535 ../src/guestfs-actions.pod:776
6352 msgid "This returns the size of the device in bytes."
6353 msgstr ""
6354
6355 #. type: textblock
6356 #: ../fish/guestfish-actions.pod:537
6357 msgid "See also L</blockdev-getsz>."
6358 msgstr ""
6359
6360 #. type: =head2
6361 #: ../fish/guestfish-actions.pod:541
6362 msgid "blockdev-getss"
6363 msgstr ""
6364
6365 #. type: verbatim
6366 #: ../fish/guestfish-actions.pod:543
6367 #, no-wrap
6368 msgid ""
6369 " blockdev-getss device\n"
6370 "\n"
6371 msgstr ""
6372
6373 #. type: textblock
6374 #: ../fish/guestfish-actions.pod:545 ../src/guestfs-actions.pod:792
6375 msgid ""
6376 "This returns the size of sectors on a block device.  Usually 512, but can be "
6377 "larger for modern devices."
6378 msgstr ""
6379
6380 #. type: textblock
6381 #: ../fish/guestfish-actions.pod:548
6382 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
6383 msgstr ""
6384
6385 #. type: =head2
6386 #: ../fish/guestfish-actions.pod:553
6387 msgid "blockdev-getsz"
6388 msgstr ""
6389
6390 #. type: verbatim
6391 #: ../fish/guestfish-actions.pod:555
6392 #, no-wrap
6393 msgid ""
6394 " blockdev-getsz device\n"
6395 "\n"
6396 msgstr ""
6397
6398 #. type: textblock
6399 #: ../fish/guestfish-actions.pod:557 ../src/guestfs-actions.pod:810
6400 msgid ""
6401 "This returns the size of the device in units of 512-byte sectors (even if "
6402 "the sectorsize isn't 512 bytes ... weird)."
6403 msgstr ""
6404
6405 #. type: textblock
6406 #: ../fish/guestfish-actions.pod:560
6407 msgid ""
6408 "See also L</blockdev-getss> for the real sector size of the device, and "
6409 "L</blockdev-getsize64> for the more useful I<size in bytes>."
6410 msgstr ""
6411
6412 #. type: =head2
6413 #: ../fish/guestfish-actions.pod:566
6414 msgid "blockdev-rereadpt"
6415 msgstr ""
6416
6417 #. type: verbatim
6418 #: ../fish/guestfish-actions.pod:568
6419 #, no-wrap
6420 msgid ""
6421 " blockdev-rereadpt device\n"
6422 "\n"
6423 msgstr ""
6424
6425 #. type: textblock
6426 #: ../fish/guestfish-actions.pod:570 ../src/guestfs-actions.pod:829
6427 msgid "Reread the partition table on C<device>."
6428 msgstr ""
6429
6430 #. type: =head2
6431 #: ../fish/guestfish-actions.pod:574
6432 msgid "blockdev-setbsz"
6433 msgstr ""
6434
6435 #. type: verbatim
6436 #: ../fish/guestfish-actions.pod:576
6437 #, no-wrap
6438 msgid ""
6439 " blockdev-setbsz device blocksize\n"
6440 "\n"
6441 msgstr ""
6442
6443 #. type: textblock
6444 #: ../fish/guestfish-actions.pod:578 ../src/guestfs-actions.pod:844
6445 msgid "This sets the block size of a device."
6446 msgstr ""
6447
6448 #. type: =head2
6449 #: ../fish/guestfish-actions.pod:585
6450 msgid "blockdev-setro"
6451 msgstr ""
6452
6453 #. type: verbatim
6454 #: ../fish/guestfish-actions.pod:587
6455 #, no-wrap
6456 msgid ""
6457 " blockdev-setro device\n"
6458 "\n"
6459 msgstr ""
6460
6461 #. type: textblock
6462 #: ../fish/guestfish-actions.pod:589 ../src/guestfs-actions.pod:861
6463 msgid "Sets the block device named C<device> to read-only."
6464 msgstr ""
6465
6466 #. type: =head2
6467 #: ../fish/guestfish-actions.pod:593
6468 msgid "blockdev-setrw"
6469 msgstr ""
6470
6471 #. type: verbatim
6472 #: ../fish/guestfish-actions.pod:595
6473 #, no-wrap
6474 msgid ""
6475 " blockdev-setrw device\n"
6476 "\n"
6477 msgstr ""
6478
6479 #. type: textblock
6480 #: ../fish/guestfish-actions.pod:597 ../src/guestfs-actions.pod:875
6481 msgid "Sets the block device named C<device> to read-write."
6482 msgstr ""
6483
6484 #. type: =head2
6485 #: ../fish/guestfish-actions.pod:601
6486 msgid "btrfs-filesystem-resize"
6487 msgstr ""
6488
6489 #. type: verbatim
6490 #: ../fish/guestfish-actions.pod:603
6491 #, no-wrap
6492 msgid ""
6493 " btrfs-filesystem-resize mountpoint [size:N]\n"
6494 "\n"
6495 msgstr ""
6496
6497 #. type: textblock
6498 #: ../fish/guestfish-actions.pod:605 ../src/guestfs-actions.pod:897
6499 msgid "This command resizes a btrfs filesystem."
6500 msgstr ""
6501
6502 #. type: textblock
6503 #: ../fish/guestfish-actions.pod:607 ../src/guestfs-actions.pod:899
6504 msgid ""
6505 "Note that unlike other resize calls, the filesystem has to be mounted and "
6506 "the parameter is the mountpoint not the device (this is a requirement of "
6507 "btrfs itself)."
6508 msgstr ""
6509
6510 #. type: textblock
6511 #: ../fish/guestfish-actions.pod:611 ../fish/guestfish-actions.pod:3606 ../src/guestfs-actions.pod:903 ../src/guestfs-actions.pod:5637
6512 msgid "The optional parameters are:"
6513 msgstr ""
6514
6515 #. type: =item
6516 #: ../fish/guestfish-actions.pod:615 ../fish/guestfish-actions.pod:3610 ../src/guestfs-actions.pod:907 ../src/guestfs-actions.pod:5641
6517 msgid "C<size>"
6518 msgstr ""
6519
6520 #. type: textblock
6521 #: ../fish/guestfish-actions.pod:617 ../src/guestfs-actions.pod:909
6522 msgid ""
6523 "The new size (in bytes) of the filesystem.  If omitted, the filesystem is "
6524 "resized to the maximum size."
6525 msgstr ""
6526
6527 #. type: textblock
6528 #: ../fish/guestfish-actions.pod:622 ../src/guestfs-actions.pod:914
6529 msgid "See also L<btrfs(8)>."
6530 msgstr ""
6531
6532 #. type: =head2
6533 #: ../fish/guestfish-actions.pod:626
6534 msgid "case-sensitive-path"
6535 msgstr ""
6536
6537 #. type: verbatim
6538 #: ../fish/guestfish-actions.pod:628
6539 #, no-wrap
6540 msgid ""
6541 " case-sensitive-path path\n"
6542 "\n"
6543 msgstr ""
6544
6545 #. type: textblock
6546 #: ../fish/guestfish-actions.pod:630 ../src/guestfs-actions.pod:948
6547 msgid ""
6548 "This can be used to resolve case insensitive paths on a filesystem which is "
6549 "case sensitive.  The use case is to resolve paths which you have read from "
6550 "Windows configuration files or the Windows Registry, to the true path."
6551 msgstr ""
6552
6553 #. type: textblock
6554 #: ../fish/guestfish-actions.pod:635 ../src/guestfs-actions.pod:953
6555 msgid ""
6556 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6557 "(and probably others), which is that although the underlying filesystem is "
6558 "case-insensitive, the driver exports the filesystem to Linux as "
6559 "case-sensitive."
6560 msgstr ""
6561
6562 #. type: textblock
6563 #: ../fish/guestfish-actions.pod:640 ../src/guestfs-actions.pod:958
6564 msgid ""
6565 "One consequence of this is that special directories such as C<c:\\windows> "
6566 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6567 "precise details of how they were created.  In Windows itself this would not "
6568 "be a problem."
6569 msgstr ""
6570
6571 #. type: textblock
6572 #: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:964
6573 msgid ""
6574 "Bug or feature? You decide: "
6575 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
6576 msgstr ""
6577
6578 #. type: textblock
6579 #: ../fish/guestfish-actions.pod:649 ../src/guestfs-actions.pod:967
6580 msgid ""
6581 "This function resolves the true case of each element in the path and returns "
6582 "the case-sensitive path."
6583 msgstr ""
6584
6585 #. type: textblock
6586 #: ../fish/guestfish-actions.pod:652
6587 msgid ""
6588 "Thus L</case-sensitive-path> (\"/Windows/System32\")  might return "
6589 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
6590 "how the directories were originally created under Windows)."
6591 msgstr ""
6592
6593 #. type: textblock
6594 #: ../fish/guestfish-actions.pod:657 ../src/guestfs-actions.pod:975
6595 msgid "I<Note>: This function does not handle drive names, backslashes etc."
6596 msgstr ""
6597
6598 #. type: textblock
6599 #: ../fish/guestfish-actions.pod:660
6600 msgid "See also L</realpath>."
6601 msgstr ""
6602
6603 #. type: =head2
6604 #: ../fish/guestfish-actions.pod:662
6605 msgid "cat"
6606 msgstr ""
6607
6608 #. type: verbatim
6609 #: ../fish/guestfish-actions.pod:664
6610 #, no-wrap
6611 msgid ""
6612 " cat path\n"
6613 "\n"
6614 msgstr ""
6615
6616 #. type: textblock
6617 #: ../fish/guestfish-actions.pod:666 ../fish/guestfish-actions.pod:4037 ../src/guestfs-actions.pod:991 ../src/guestfs-actions.pod:6297
6618 msgid "Return the contents of the file named C<path>."
6619 msgstr ""
6620
6621 #. type: textblock
6622 #: ../fish/guestfish-actions.pod:668
6623 msgid ""
6624 "Note that this function cannot correctly handle binary files (specifically, "
6625 "files containing C<\\0> character which is treated as end of string).  For "
6626 "those you need to use the L</read-file> or L</download> functions which have "
6627 "a more complex interface."
6628 msgstr ""
6629
6630 #. type: textblock
6631 #: ../fish/guestfish-actions.pod:673 ../fish/guestfish-actions.pod:808 ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1180 ../fish/guestfish-actions.pod:1190 ../fish/guestfish-actions.pod:1382 ../fish/guestfish-actions.pod:1695 ../fish/guestfish-actions.pod:1705 ../fish/guestfish-actions.pod:1755 ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1799 ../fish/guestfish-actions.pod:3907 ../fish/guestfish-actions.pod:3922 ../fish/guestfish-actions.pod:3998 ../fish/guestfish-actions.pod:4015 ../fish/guestfish-actions.pod:4030 ../fish/guestfish-actions.pod:4699 ../fish/guestfish-actions.pod:4745 ../fish/guestfish-actions.pod:4830 ../fish/guestfish-actions.pod:4845 ../fish/guestfish-actions.pod:5251 ../fish/guestfish-actions.pod:5263 ../fish/guestfish-actions.pod:5281 ../fish/guestfish-actions.pod:5298 ../fish/guestfish-actions.pod:5308 ../fish/guestfish-actions.pod:5362 ../fish/guestfish-actions.pod:5372 ../fish/guestfish-actions.pod:5401 ../fish/guestfish-actions.pod:5411 ../src/guestfs-actions.pod:1001 ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1855 ../src/guestfs-actions.pod:1874 ../src/guestfs-actions.pod:1977 ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:2242 ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2808 ../src/guestfs-actions.pod:2832 ../src/guestfs-actions.pod:2849 ../src/guestfs-actions.pod:2878 ../src/guestfs-actions.pod:6079 ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6262 ../src/guestfs-actions.pod:6286 ../src/guestfs-actions.pod:7241 ../src/guestfs-actions.pod:7296 ../src/guestfs-actions.pod:7442 ../src/guestfs-actions.pod:7466 ../src/guestfs-actions.pod:8131 ../src/guestfs-actions.pod:8151 ../src/guestfs-actions.pod:8184 ../src/guestfs-actions.pod:8203 ../src/guestfs-actions.pod:8222 ../src/guestfs-actions.pod:8313 ../src/guestfs-actions.pod:8332 ../src/guestfs-actions.pod:8378 ../src/guestfs-actions.pod:8397
6632 msgid ""
6633 "Because of the message protocol, there is a transfer limit of somewhere "
6634 "between 2MB and 4MB.  See L<guestfs(3)/PROTOCOL LIMITS>."
6635 msgstr ""
6636
6637 #. type: =head2
6638 #: ../fish/guestfish-actions.pod:676
6639 msgid "checksum"
6640 msgstr ""
6641
6642 #. type: verbatim
6643 #: ../fish/guestfish-actions.pod:678
6644 #, no-wrap
6645 msgid ""
6646 " checksum csumtype path\n"
6647 "\n"
6648 msgstr ""
6649
6650 #. type: textblock
6651 #: ../fish/guestfish-actions.pod:680 ../src/guestfs-actions.pod:1013
6652 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
6653 msgstr ""
6654
6655 #. type: textblock
6656 #: ../fish/guestfish-actions.pod:683 ../src/guestfs-actions.pod:1016
6657 msgid ""
6658 "The type of checksum to compute is given by the C<csumtype> parameter which "
6659 "must have one of the following values:"
6660 msgstr ""
6661
6662 #. type: =item
6663 #: ../fish/guestfish-actions.pod:688 ../src/guestfs-actions.pod:1021
6664 msgid "C<crc>"
6665 msgstr ""
6666
6667 #. type: textblock
6668 #: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1023
6669 msgid ""
6670 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
6671 "C<cksum> command."
6672 msgstr ""
6673
6674 #. type: =item
6675 #: ../fish/guestfish-actions.pod:693 ../src/guestfs-actions.pod:1026
6676 msgid "C<md5>"
6677 msgstr ""
6678
6679 #. type: textblock
6680 #: ../fish/guestfish-actions.pod:695 ../src/guestfs-actions.pod:1028
6681 msgid "Compute the MD5 hash (using the C<md5sum> program)."
6682 msgstr ""
6683
6684 #. type: =item
6685 #: ../fish/guestfish-actions.pod:697 ../src/guestfs-actions.pod:1030
6686 msgid "C<sha1>"
6687 msgstr ""
6688
6689 #. type: textblock
6690 #: ../fish/guestfish-actions.pod:699 ../src/guestfs-actions.pod:1032
6691 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6692 msgstr ""
6693
6694 #. type: =item
6695 #: ../fish/guestfish-actions.pod:701 ../src/guestfs-actions.pod:1034
6696 msgid "C<sha224>"
6697 msgstr ""
6698
6699 #. type: textblock
6700 #: ../fish/guestfish-actions.pod:703 ../src/guestfs-actions.pod:1036
6701 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6702 msgstr ""
6703
6704 #. type: =item
6705 #: ../fish/guestfish-actions.pod:705 ../src/guestfs-actions.pod:1038
6706 msgid "C<sha256>"
6707 msgstr ""
6708
6709 #. type: textblock
6710 #: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1040
6711 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6712 msgstr ""
6713
6714 #. type: =item
6715 #: ../fish/guestfish-actions.pod:709 ../src/guestfs-actions.pod:1042
6716 msgid "C<sha384>"
6717 msgstr ""
6718
6719 #. type: textblock
6720 #: ../fish/guestfish-actions.pod:711 ../src/guestfs-actions.pod:1044
6721 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6722 msgstr ""
6723
6724 #. type: =item
6725 #: ../fish/guestfish-actions.pod:713 ../src/guestfs-actions.pod:1046
6726 msgid "C<sha512>"
6727 msgstr ""
6728
6729 #. type: textblock
6730 #: ../fish/guestfish-actions.pod:715 ../src/guestfs-actions.pod:1048
6731 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6732 msgstr ""
6733
6734 #. type: textblock
6735 #: ../fish/guestfish-actions.pod:719 ../src/guestfs-actions.pod:1052
6736 msgid "The checksum is returned as a printable string."
6737 msgstr ""
6738
6739 #. type: textblock
6740 #: ../fish/guestfish-actions.pod:721
6741 msgid "To get the checksum for a device, use L</checksum-device>."
6742 msgstr ""
6743
6744 #. type: textblock
6745 #: ../fish/guestfish-actions.pod:723
6746 msgid "To get the checksums for many files, use L</checksums-out>."
6747 msgstr ""
6748
6749 #. type: =head2
6750 #: ../fish/guestfish-actions.pod:725
6751 msgid "checksum-device"
6752 msgstr ""
6753
6754 #. type: verbatim
6755 #: ../fish/guestfish-actions.pod:727
6756 #, no-wrap
6757 msgid ""
6758 " checksum-device csumtype device\n"
6759 "\n"
6760 msgstr ""
6761
6762 #. type: textblock
6763 #: ../fish/guestfish-actions.pod:729
6764 msgid ""
6765 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6766 "device named C<device>.  For the types of checksums supported see the "
6767 "L</checksum> command."
6768 msgstr ""
6769
6770 #. type: =head2
6771 #: ../fish/guestfish-actions.pod:733
6772 msgid "checksums-out"
6773 msgstr ""
6774
6775 #. type: verbatim
6776 #: ../fish/guestfish-actions.pod:735
6777 #, no-wrap
6778 msgid ""
6779 " checksums-out csumtype directory (sumsfile|-)\n"
6780 "\n"
6781 msgstr ""
6782
6783 #. type: textblock
6784 #: ../fish/guestfish-actions.pod:737 ../src/guestfs-actions.pod:1087
6785 msgid ""
6786 "This command computes the checksums of all regular files in C<directory> and "
6787 "then emits a list of those checksums to the local output file C<sumsfile>."
6788 msgstr ""
6789
6790 #. type: textblock
6791 #: ../fish/guestfish-actions.pod:741 ../src/guestfs-actions.pod:1091
6792 msgid ""
6793 "This can be used for verifying the integrity of a virtual machine.  However "
6794 "to be properly secure you should pay attention to the output of the checksum "
6795 "command (it uses the ones from GNU coreutils).  In particular when the "
6796 "filename is not printable, coreutils uses a special backslash syntax.  For "
6797 "more information, see the GNU coreutils info file."
6798 msgstr ""
6799
6800 #. type: =head2
6801 #: ../fish/guestfish-actions.pod:751
6802 msgid "chmod"
6803 msgstr ""
6804
6805 #. type: verbatim
6806 #: ../fish/guestfish-actions.pod:753
6807 #, no-wrap
6808 msgid ""
6809 " chmod mode path\n"
6810 "\n"
6811 msgstr ""
6812
6813 #. type: textblock
6814 #: ../fish/guestfish-actions.pod:755 ../src/guestfs-actions.pod:1110
6815 msgid ""
6816 "Change the mode (permissions) of C<path> to C<mode>.  Only numeric modes are "
6817 "supported."
6818 msgstr ""
6819
6820 #. type: textblock
6821 #: ../fish/guestfish-actions.pod:758 ../src/guestfs-actions.pod:1113
6822 msgid ""
6823 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6824 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6825 "C<700>."
6826 msgstr ""
6827
6828 #. type: textblock
6829 #: ../fish/guestfish-actions.pod:762 ../fish/guestfish-actions.pod:3259 ../fish/guestfish-actions.pod:3398 ../fish/guestfish-actions.pod:3408 ../fish/guestfish-actions.pod:3418 ../src/guestfs-actions.pod:1117 ../src/guestfs-actions.pod:5044 ../src/guestfs-actions.pod:5253 ../src/guestfs-actions.pod:5272 ../src/guestfs-actions.pod:5291
6830 msgid "The mode actually set is affected by the umask."
6831 msgstr ""
6832
6833 #. type: =head2
6834 #: ../fish/guestfish-actions.pod:764
6835 msgid "chown"
6836 msgstr ""
6837
6838 #. type: verbatim
6839 #: ../fish/guestfish-actions.pod:766
6840 #, no-wrap
6841 msgid ""
6842 " chown owner group path\n"
6843 "\n"
6844 msgstr ""
6845
6846 #. type: textblock
6847 #: ../fish/guestfish-actions.pod:768 ../src/guestfs-actions.pod:1131
6848 msgid "Change the file owner to C<owner> and group to C<group>."
6849 msgstr ""
6850
6851 #. type: textblock
6852 #: ../fish/guestfish-actions.pod:770 ../fish/guestfish-actions.pod:2703 ../src/guestfs-actions.pod:1133 ../src/guestfs-actions.pod:4124
6853 msgid ""
6854 "Only numeric uid and gid are supported.  If you want to use names, you will "
6855 "need to locate and parse the password file yourself (Augeas support makes "
6856 "this relatively easy)."
6857 msgstr ""
6858
6859 #. type: =head2
6860 #: ../fish/guestfish-actions.pod:774
6861 msgid "command"
6862 msgstr ""
6863
6864 #. type: verbatim
6865 #: ../fish/guestfish-actions.pod:776
6866 #, no-wrap
6867 msgid ""
6868 " command 'arguments ...'\n"
6869 "\n"
6870 msgstr ""
6871
6872 #. type: textblock
6873 #: ../fish/guestfish-actions.pod:778 ../src/guestfs-actions.pod:1147
6874 msgid ""
6875 "This call runs a command from the guest filesystem.  The filesystem must be "
6876 "mounted, and must contain a compatible operating system (ie. something "
6877 "Linux, with the same or compatible processor architecture)."
6878 msgstr ""
6879
6880 #. type: textblock
6881 #: ../fish/guestfish-actions.pod:783
6882 msgid ""
6883 "The single parameter is an argv-style list of arguments.  The first element "
6884 "is the name of the program to run.  Subsequent elements are parameters.  The "
6885 "list must be non-empty (ie. must contain a program name).  Note that the "
6886 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
6887 msgstr ""
6888
6889 #. type: textblock
6890 #: ../fish/guestfish-actions.pod:790 ../src/guestfs-actions.pod:1159
6891 msgid "The return value is anything printed to I<stdout> by the command."
6892 msgstr ""
6893
6894 #. type: textblock
6895 #: ../fish/guestfish-actions.pod:793 ../src/guestfs-actions.pod:1162
6896 msgid ""
6897 "If the command returns a non-zero exit status, then this function returns an "
6898 "error message.  The error message string is the content of I<stderr> from "
6899 "the command."
6900 msgstr ""
6901
6902 #. type: textblock
6903 #: ../fish/guestfish-actions.pod:797 ../src/guestfs-actions.pod:1166
6904 msgid ""
6905 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
6906 "C</bin>.  If you require a program from another location, you should provide "
6907 "the full path in the first parameter."
6908 msgstr ""
6909
6910 #. type: textblock
6911 #: ../fish/guestfish-actions.pod:802 ../src/guestfs-actions.pod:1171
6912 msgid ""
6913 "Shared libraries and data files required by the program must be available on "
6914 "filesystems which are mounted in the correct places.  It is the caller's "
6915 "responsibility to ensure all filesystems that are needed are mounted at the "
6916 "right locations."
6917 msgstr ""
6918
6919 #. type: =head2
6920 #: ../fish/guestfish-actions.pod:811
6921 msgid "command-lines"
6922 msgstr ""
6923
6924 #. type: verbatim
6925 #: ../fish/guestfish-actions.pod:813
6926 #, no-wrap
6927 msgid ""
6928 " command-lines 'arguments ...'\n"
6929 "\n"
6930 msgstr ""
6931
6932 #. type: textblock
6933 #: ../fish/guestfish-actions.pod:815
6934 msgid "This is the same as L</command>, but splits the result into a list of lines."
6935 msgstr ""
6936
6937 #. type: textblock
6938 #: ../fish/guestfish-actions.pod:818
6939 msgid "See also: L</sh-lines>"
6940 msgstr ""
6941
6942 #. type: =head2
6943 #: ../fish/guestfish-actions.pod:823
6944 msgid "compress-device-out"
6945 msgstr ""
6946
6947 #. type: verbatim
6948 #: ../fish/guestfish-actions.pod:825
6949 #, no-wrap
6950 msgid ""
6951 " compress-device-out ctype device (zdevice|-) [level:N]\n"
6952 "\n"
6953 msgstr ""
6954
6955 #. type: textblock
6956 #: ../fish/guestfish-actions.pod:827 ../src/guestfs-actions.pod:1221
6957 msgid ""
6958 "This command compresses C<device> and writes it out to the local file "
6959 "C<zdevice>."
6960 msgstr ""
6961
6962 #. type: textblock
6963 #: ../fish/guestfish-actions.pod:830
6964 msgid ""
6965 "The C<ctype> and optional C<level> parameters have the same meaning as in "
6966 "L</compress-out>."
6967 msgstr ""
6968
6969 #. type: =head2
6970 #: ../fish/guestfish-actions.pod:837
6971 msgid "compress-out"
6972 msgstr ""
6973
6974 #. type: verbatim
6975 #: ../fish/guestfish-actions.pod:839
6976 #, no-wrap
6977 msgid ""
6978 " compress-out ctype file (zfile|-) [level:N]\n"
6979 "\n"
6980 msgstr ""
6981
6982 #. type: textblock
6983 #: ../fish/guestfish-actions.pod:841 ../src/guestfs-actions.pod:1273
6984 msgid ""
6985 "This command compresses C<file> and writes it out to the local file "
6986 "C<zfile>."
6987 msgstr ""
6988
6989 #. type: textblock
6990 #: ../fish/guestfish-actions.pod:844 ../src/guestfs-actions.pod:1276
6991 msgid ""
6992 "The compression program used is controlled by the C<ctype> parameter.  "
6993 "Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>.  "
6994 "Some compression types may not be supported by particular builds of "
6995 "libguestfs, in which case you will get an error containing the substring "
6996 "\"not supported\"."
6997 msgstr ""
6998
6999 #. type: textblock
7000 #: ../fish/guestfish-actions.pod:850 ../src/guestfs-actions.pod:1282
7001 msgid ""
7002 "The optional C<level> parameter controls compression level.  The meaning and "
7003 "default for this parameter depends on the compression program being used."
7004 msgstr ""
7005
7006 #. type: =head2
7007 #: ../fish/guestfish-actions.pod:858
7008 msgid "config"
7009 msgstr ""
7010
7011 #. type: verbatim
7012 #: ../fish/guestfish-actions.pod:860
7013 #, no-wrap
7014 msgid ""
7015 " config qemuparam qemuvalue\n"
7016 "\n"
7017 msgstr ""
7018
7019 #. type: textblock
7020 #: ../fish/guestfish-actions.pod:862 ../src/guestfs-actions.pod:1323
7021 msgid ""
7022 "This can be used to add arbitrary qemu command line parameters of the form "
7023 "I<-param value>.  Actually it's not quite arbitrary - we prevent you from "
7024 "setting some parameters which would interfere with parameters that we use."
7025 msgstr ""
7026
7027 #. type: textblock
7028 #: ../fish/guestfish-actions.pod:867 ../src/guestfs-actions.pod:1328
7029 msgid "The first character of C<param> string must be a C<-> (dash)."
7030 msgstr ""
7031
7032 #. type: textblock
7033 #: ../fish/guestfish-actions.pod:869 ../src/guestfs-actions.pod:1330
7034 msgid "C<value> can be NULL."
7035 msgstr ""
7036
7037 #. type: =head2
7038 #: ../fish/guestfish-actions.pod:871
7039 msgid "copy-device-to-device"
7040 msgstr ""
7041
7042 #. type: verbatim
7043 #: ../fish/guestfish-actions.pod:873
7044 #, no-wrap
7045 msgid ""
7046 " copy-device-to-device src dest [srcoffset:N] [destoffset:N] [size:N]\n"
7047 "\n"
7048 msgstr ""
7049
7050 #. type: textblock
7051 #: ../fish/guestfish-actions.pod:875
7052 msgid ""
7053 "The four calls L</copy-device-to-device>, L</copy-device-to-file>, "
7054 "L</copy-file-to-device>, and L</copy-file-to-file> let you copy from a "
7055 "source (device|file) to a destination (device|file)."
7056 msgstr ""
7057
7058 #. type: textblock
7059 #: ../fish/guestfish-actions.pod:882 ../src/guestfs-actions.pod:1360
7060 msgid ""
7061 "Partial copies can be made since you can specify optionally the source "
7062 "offset, destination offset and size to copy.  These values are all specified "
7063 "in bytes.  If not given, the offsets both default to zero, and the size "
7064 "defaults to copying as much as possible until we hit the end of the source."
7065 msgstr ""
7066
7067 #. type: textblock
7068 #: ../fish/guestfish-actions.pod:888 ../src/guestfs-actions.pod:1366
7069 msgid ""
7070 "The source and destination may be the same object.  However overlapping "
7071 "regions may not be copied correctly."
7072 msgstr ""
7073
7074 #. type: textblock
7075 #: ../fish/guestfish-actions.pod:891 ../src/guestfs-actions.pod:1369
7076 msgid ""
7077 "If the destination is a file, it is created if required.  If the destination "
7078 "file is not large enough, it is extended."
7079 msgstr ""
7080
7081 #. type: =head2
7082 #: ../fish/guestfish-actions.pod:896
7083 msgid "copy-device-to-file"
7084 msgstr ""
7085
7086 #. type: verbatim
7087 #: ../fish/guestfish-actions.pod:898
7088 #, no-wrap
7089 msgid ""
7090 " copy-device-to-file src dest [srcoffset:N] [destoffset:N] [size:N]\n"
7091 "\n"
7092 msgstr ""
7093
7094 #. type: textblock
7095 #: ../fish/guestfish-actions.pod:900 ../fish/guestfish-actions.pod:909 ../fish/guestfish-actions.pod:918
7096 msgid "See L</copy-device-to-device> for a general overview of this call."
7097 msgstr ""
7098
7099 #. type: =head2
7100 #: ../fish/guestfish-actions.pod:905
7101 msgid "copy-file-to-device"
7102 msgstr ""
7103
7104 #. type: verbatim
7105 #: ../fish/guestfish-actions.pod:907
7106 #, no-wrap
7107 msgid ""
7108 " copy-file-to-device src dest [srcoffset:N] [destoffset:N] [size:N]\n"
7109 "\n"
7110 msgstr ""
7111
7112 #. type: =head2
7113 #: ../fish/guestfish-actions.pod:914
7114 msgid "copy-file-to-file"
7115 msgstr ""
7116
7117 #. type: verbatim
7118 #: ../fish/guestfish-actions.pod:916
7119 #, no-wrap
7120 msgid ""
7121 " copy-file-to-file src dest [srcoffset:N] [destoffset:N] [size:N]\n"
7122 "\n"
7123 msgstr ""
7124
7125 #. type: textblock
7126 #: ../fish/guestfish-actions.pod:921
7127 msgid ""
7128 "This is B<not> the function you want for copying files.  This is for copying "
7129 "blocks within existing files.  See L</cp>, L</cp-a> and L</mv> for general "
7130 "file copying and moving functions."
7131 msgstr ""
7132
7133 #. type: =head2
7134 #: ../fish/guestfish-actions.pod:928
7135 msgid "copy-size"
7136 msgstr ""
7137
7138 #. type: verbatim
7139 #: ../fish/guestfish-actions.pod:930
7140 #, no-wrap
7141 msgid ""
7142 " copy-size src dest size\n"
7143 "\n"
7144 msgstr ""
7145
7146 #. type: textblock
7147 #: ../fish/guestfish-actions.pod:932 ../src/guestfs-actions.pod:1584
7148 msgid ""
7149 "This command copies exactly C<size> bytes from one source device or file "
7150 "C<src> to another destination device or file C<dest>."
7151 msgstr ""
7152
7153 #. type: textblock
7154 #: ../fish/guestfish-actions.pod:935 ../src/guestfs-actions.pod:1587
7155 msgid ""
7156 "Note this will fail if the source is too short or if the destination is not "
7157 "large enough."
7158 msgstr ""
7159
7160 #. type: textblock
7161 #: ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:973
7162 msgid ""
7163 "I<This function is deprecated.> In new code, use the "
7164 "L</copy_device_to_device> call instead."
7165 msgstr ""
7166
7167 #. type: =head2
7168 #: ../fish/guestfish-actions.pod:945
7169 msgid "cp"
7170 msgstr ""
7171
7172 #. type: verbatim
7173 #: ../fish/guestfish-actions.pod:947
7174 #, no-wrap
7175 msgid ""
7176 " cp src dest\n"
7177 "\n"
7178 msgstr ""
7179
7180 #. type: textblock
7181 #: ../fish/guestfish-actions.pod:949 ../src/guestfs-actions.pod:1606
7182 msgid ""
7183 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7184 "destination filename or destination directory."
7185 msgstr ""
7186
7187 #. type: =head2
7188 #: ../fish/guestfish-actions.pod:952
7189 msgid "cp-a"
7190 msgstr ""
7191
7192 #. type: verbatim
7193 #: ../fish/guestfish-actions.pod:954
7194 #, no-wrap
7195 msgid ""
7196 " cp-a src dest\n"
7197 "\n"
7198 msgstr ""
7199
7200 #. type: textblock
7201 #: ../fish/guestfish-actions.pod:956 ../src/guestfs-actions.pod:1620
7202 msgid ""
7203 "This copies a file or directory from C<src> to C<dest> recursively using the "
7204 "C<cp -a> command."
7205 msgstr ""
7206
7207 #. type: =head2
7208 #: ../fish/guestfish-actions.pod:959
7209 msgid "dd"
7210 msgstr ""
7211
7212 #. type: verbatim
7213 #: ../fish/guestfish-actions.pod:961
7214 #, no-wrap
7215 msgid ""
7216 " dd src dest\n"
7217 "\n"
7218 msgstr ""
7219
7220 #. type: textblock
7221 #: ../fish/guestfish-actions.pod:963 ../src/guestfs-actions.pod:1641
7222 msgid ""
7223 "This command copies from one source device or file C<src> to another "
7224 "destination device or file C<dest>.  Normally you would use this to copy to "
7225 "or from a device or partition, for example to duplicate a filesystem."
7226 msgstr ""
7227
7228 #. type: textblock
7229 #: ../fish/guestfish-actions.pod:968
7230 msgid ""
7231 "If the destination is a device, it must be as large or larger than the "
7232 "source file or device, otherwise the copy will fail.  This command cannot do "
7233 "partial copies (see L</copy-device-to-device>)."
7234 msgstr ""
7235
7236 #. type: =head2
7237 #: ../fish/guestfish-actions.pod:980
7238 msgid "df"
7239 msgstr ""
7240
7241 #. type: verbatim
7242 #: ../fish/guestfish-actions.pod:982
7243 #, no-wrap
7244 msgid ""
7245 " df\n"
7246 "\n"
7247 msgstr ""
7248
7249 #. type: textblock
7250 #: ../fish/guestfish-actions.pod:984 ../src/guestfs-actions.pod:1660
7251 msgid "This command runs the C<df> command to report disk space used."
7252 msgstr ""
7253
7254 #. type: textblock
7255 #: ../fish/guestfish-actions.pod:986 ../fish/guestfish-actions.pod:997
7256 msgid ""
7257 "This command is mostly useful for interactive sessions.  It is I<not> "
7258 "intended that you try to parse the output string.  Use L</statvfs> from "
7259 "programs."
7260 msgstr ""
7261
7262 #. type: =head2
7263 #: ../fish/guestfish-actions.pod:990
7264 msgid "df-h"
7265 msgstr ""
7266
7267 #. type: verbatim
7268 #: ../fish/guestfish-actions.pod:992
7269 #, no-wrap
7270 msgid ""
7271 " df-h\n"
7272 "\n"
7273 msgstr ""
7274
7275 #. type: textblock
7276 #: ../fish/guestfish-actions.pod:994 ../src/guestfs-actions.pod:1676
7277 msgid ""
7278 "This command runs the C<df -h> command to report disk space used in "
7279 "human-readable format."
7280 msgstr ""
7281
7282 #. type: =head2
7283 #: ../fish/guestfish-actions.pod:1001
7284 msgid "dmesg"
7285 msgstr ""
7286
7287 #. type: verbatim
7288 #: ../fish/guestfish-actions.pod:1003
7289 #, no-wrap
7290 msgid ""
7291 " dmesg\n"
7292 "\n"
7293 msgstr ""
7294
7295 #. type: textblock
7296 #: ../fish/guestfish-actions.pod:1005 ../src/guestfs-actions.pod:1693
7297 msgid ""
7298 "This returns the kernel messages (C<dmesg> output) from the guest kernel.  "
7299 "This is sometimes useful for extended debugging of problems."
7300 msgstr ""
7301
7302 #. type: textblock
7303 #: ../fish/guestfish-actions.pod:1009
7304 msgid ""
7305 "Another way to get the same information is to enable verbose messages with "
7306 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
7307 "before running the program."
7308 msgstr ""
7309
7310 #. type: =head2
7311 #: ../fish/guestfish-actions.pod:1014
7312 msgid "download"
7313 msgstr ""
7314
7315 #. type: verbatim
7316 #: ../fish/guestfish-actions.pod:1016
7317 #, no-wrap
7318 msgid ""
7319 " download remotefilename (filename|-)\n"
7320 "\n"
7321 msgstr ""
7322
7323 #. type: textblock
7324 #: ../fish/guestfish-actions.pod:1018 ../fish/guestfish-actions.pod:1031 ../src/guestfs-actions.pod:1714 ../src/guestfs-actions.pod:1739
7325 msgid ""
7326 "Download file C<remotefilename> and save it as C<filename> on the local "
7327 "machine."
7328 msgstr ""
7329
7330 #. type: textblock
7331 #: ../fish/guestfish-actions.pod:1021 ../fish/guestfish-actions.pod:5003 ../src/guestfs-actions.pod:1717 ../src/guestfs-actions.pod:7701
7332 msgid "C<filename> can also be a named pipe."
7333 msgstr ""
7334
7335 #. type: textblock
7336 #: ../fish/guestfish-actions.pod:1023
7337 msgid "See also L</upload>, L</cat>."
7338 msgstr ""
7339
7340 #. type: =head2
7341 #: ../fish/guestfish-actions.pod:1027
7342 msgid "download-offset"
7343 msgstr ""
7344
7345 #. type: verbatim
7346 #: ../fish/guestfish-actions.pod:1029
7347 #, no-wrap
7348 msgid ""
7349 " download-offset remotefilename (filename|-) offset size\n"
7350 "\n"
7351 msgstr ""
7352
7353 #. type: textblock
7354 #: ../fish/guestfish-actions.pod:1034 ../src/guestfs-actions.pod:1742
7355 msgid ""
7356 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7357 "region must be within the file or device)."
7358 msgstr ""
7359
7360 #. type: textblock
7361 #: ../fish/guestfish-actions.pod:1037
7362 msgid ""
7363 "Note that there is no limit on the amount of data that can be downloaded "
7364 "with this call, unlike with L</pread>, and this call always reads the full "
7365 "amount unless an error occurs."
7366 msgstr ""
7367
7368 #. type: textblock
7369 #: ../fish/guestfish-actions.pod:1042
7370 msgid "See also L</download>, L</pread>."
7371 msgstr ""
7372
7373 #. type: =head2
7374 #: ../fish/guestfish-actions.pod:1046
7375 msgid "drop-caches"
7376 msgstr ""
7377
7378 #. type: verbatim
7379 #: ../fish/guestfish-actions.pod:1048
7380 #, no-wrap
7381 msgid ""
7382 " drop-caches whattodrop\n"
7383 "\n"
7384 msgstr ""
7385
7386 #. type: textblock
7387 #: ../fish/guestfish-actions.pod:1050 ../src/guestfs-actions.pod:1767
7388 msgid ""
7389 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7390 "inode caches.  The parameter C<whattodrop> tells the kernel what precisely "
7391 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7392 msgstr ""
7393
7394 #. type: textblock
7395 #: ../fish/guestfish-actions.pod:1055 ../src/guestfs-actions.pod:1772
7396 msgid "Setting C<whattodrop> to 3 should drop everything."
7397 msgstr ""
7398
7399 #. type: textblock
7400 #: ../fish/guestfish-actions.pod:1057 ../src/guestfs-actions.pod:1774
7401 msgid ""
7402 "This automatically calls L<sync(2)> before the operation, so that the "
7403 "maximum guest memory is freed."
7404 msgstr ""
7405
7406 #. type: =head2
7407 #: ../fish/guestfish-actions.pod:1060
7408 msgid "du"
7409 msgstr ""
7410
7411 #. type: verbatim
7412 #: ../fish/guestfish-actions.pod:1062
7413 #, no-wrap
7414 msgid ""
7415 " du path\n"
7416 "\n"
7417 msgstr ""
7418
7419 #. type: textblock
7420 #: ../fish/guestfish-actions.pod:1064 ../src/guestfs-actions.pod:1787
7421 msgid ""
7422 "This command runs the C<du -s> command to estimate file space usage for "
7423 "C<path>."
7424 msgstr ""
7425
7426 #. type: textblock
7427 #: ../fish/guestfish-actions.pod:1067 ../src/guestfs-actions.pod:1790
7428 msgid ""
7429 "C<path> can be a file or a directory.  If C<path> is a directory then the "
7430 "estimate includes the contents of the directory and all subdirectories "
7431 "(recursively)."
7432 msgstr ""
7433
7434 #. type: textblock
7435 #: ../fish/guestfish-actions.pod:1071 ../src/guestfs-actions.pod:1794
7436 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7437 msgstr ""
7438
7439 #. type: =head2
7440 #: ../fish/guestfish-actions.pod:1074
7441 msgid "e2fsck-f"
7442 msgstr ""
7443
7444 #. type: verbatim
7445 #: ../fish/guestfish-actions.pod:1076
7446 #, no-wrap
7447 msgid ""
7448 " e2fsck-f device\n"
7449 "\n"
7450 msgstr ""
7451
7452 #. type: textblock
7453 #: ../fish/guestfish-actions.pod:1078 ../src/guestfs-actions.pod:1812
7454 msgid ""
7455 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7456 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
7457 "clean (I<-f>)."
7458 msgstr ""
7459
7460 #. type: textblock
7461 #: ../fish/guestfish-actions.pod:1082
7462 msgid ""
7463 "This command is only needed because of L</resize2fs> (q.v.).  Normally you "
7464 "should use L</fsck>."
7465 msgstr ""
7466
7467 #. type: =head2
7468 #: ../fish/guestfish-actions.pod:1085
7469 msgid "echo-daemon"
7470 msgstr ""
7471
7472 #. type: verbatim
7473 #: ../fish/guestfish-actions.pod:1087
7474 #, no-wrap
7475 msgid ""
7476 " echo-daemon 'words ...'\n"
7477 "\n"
7478 msgstr ""
7479
7480 #. type: textblock
7481 #: ../fish/guestfish-actions.pod:1089 ../src/guestfs-actions.pod:1829
7482 msgid ""
7483 "This command concatenates the list of C<words> passed with single spaces "
7484 "between them and returns the resulting string."
7485 msgstr ""
7486
7487 #. type: textblock
7488 #: ../fish/guestfish-actions.pod:1092 ../src/guestfs-actions.pod:1832
7489 msgid "You can use this command to test the connection through to the daemon."
7490 msgstr ""
7491
7492 #. type: textblock
7493 #: ../fish/guestfish-actions.pod:1094
7494 msgid "See also L</ping-daemon>."
7495 msgstr ""
7496
7497 #. type: =head2
7498 #: ../fish/guestfish-actions.pod:1096
7499 msgid "egrep"
7500 msgstr ""
7501
7502 #. type: verbatim
7503 #: ../fish/guestfish-actions.pod:1098
7504 #, no-wrap
7505 msgid ""
7506 " egrep regex path\n"
7507 "\n"
7508 msgstr ""
7509
7510 #. type: textblock
7511 #: ../fish/guestfish-actions.pod:1100 ../src/guestfs-actions.pod:1848
7512 msgid "This calls the external C<egrep> program and returns the matching lines."
7513 msgstr ""
7514
7515 #. type: =head2
7516 #: ../fish/guestfish-actions.pod:1106
7517 msgid "egrepi"
7518 msgstr ""
7519
7520 #. type: verbatim
7521 #: ../fish/guestfish-actions.pod:1108
7522 #, no-wrap
7523 msgid ""
7524 " egrepi regex path\n"
7525 "\n"
7526 msgstr ""
7527
7528 #. type: textblock
7529 #: ../fish/guestfish-actions.pod:1110 ../src/guestfs-actions.pod:1867
7530 msgid "This calls the external C<egrep -i> program and returns the matching lines."
7531 msgstr ""
7532
7533 #. type: =head2
7534 #: ../fish/guestfish-actions.pod:1116
7535 msgid "equal"
7536 msgstr ""
7537
7538 #. type: verbatim
7539 #: ../fish/guestfish-actions.pod:1118
7540 #, no-wrap
7541 msgid ""
7542 " equal file1 file2\n"
7543 "\n"
7544 msgstr ""
7545
7546 #. type: textblock
7547 #: ../fish/guestfish-actions.pod:1120 ../src/guestfs-actions.pod:1886
7548 msgid ""
7549 "This compares the two files C<file1> and C<file2> and returns true if their "
7550 "content is exactly equal, or false otherwise."
7551 msgstr ""
7552
7553 #. type: textblock
7554 #: ../fish/guestfish-actions.pod:1123 ../src/guestfs-actions.pod:1889
7555 msgid "The external L<cmp(1)> program is used for the comparison."
7556 msgstr ""
7557
7558 #. type: =head2
7559 #: ../fish/guestfish-actions.pod:1125
7560 msgid "exists"
7561 msgstr ""
7562
7563 #. type: verbatim
7564 #: ../fish/guestfish-actions.pod:1127
7565 #, no-wrap
7566 msgid ""
7567 " exists path\n"
7568 "\n"
7569 msgstr ""
7570
7571 #. type: textblock
7572 #: ../fish/guestfish-actions.pod:1129 ../src/guestfs-actions.pod:1901
7573 msgid ""
7574 "This returns C<true> if and only if there is a file, directory (or anything) "
7575 "with the given C<path> name."
7576 msgstr ""
7577
7578 #. type: textblock
7579 #: ../fish/guestfish-actions.pod:1132
7580 msgid "See also L</is-file>, L</is-dir>, L</stat>."
7581 msgstr ""
7582
7583 #. type: =head2
7584 #: ../fish/guestfish-actions.pod:1134
7585 msgid "fallocate"
7586 msgstr ""
7587
7588 #. type: verbatim
7589 #: ../fish/guestfish-actions.pod:1136
7590 #, no-wrap
7591 msgid ""
7592 " fallocate path len\n"
7593 "\n"
7594 msgstr ""
7595
7596 #. type: textblock
7597 #: ../fish/guestfish-actions.pod:1138 ../fish/guestfish-actions.pod:1157 ../src/guestfs-actions.pod:1924 ../src/guestfs-actions.pod:1943
7598 msgid ""
7599 "This command preallocates a file (containing zero bytes) named C<path> of "
7600 "size C<len> bytes.  If the file exists already, it is overwritten."
7601 msgstr ""
7602
7603 #. type: textblock
7604 #: ../fish/guestfish-actions.pod:1142 ../src/guestfs-actions.pod:1928
7605 msgid ""
7606 "Do not confuse this with the guestfish-specific C<alloc> command which "
7607 "allocates a file in the host and attaches it as a device."
7608 msgstr ""
7609
7610 #. type: textblock
7611 #: ../fish/guestfish-actions.pod:1146
7612 msgid ""
7613 "I<This function is deprecated.> In new code, use the L</fallocate64> call "
7614 "instead."
7615 msgstr ""
7616
7617 #. type: =head2
7618 #: ../fish/guestfish-actions.pod:1153
7619 msgid "fallocate64"
7620 msgstr ""
7621
7622 #. type: verbatim
7623 #: ../fish/guestfish-actions.pod:1155
7624 #, no-wrap
7625 msgid ""
7626 " fallocate64 path len\n"
7627 "\n"
7628 msgstr ""
7629
7630 #. type: textblock
7631 #: ../fish/guestfish-actions.pod:1161
7632 msgid ""
7633 "Note that this call allocates disk blocks for the file.  To create a sparse "
7634 "file use L</truncate-size> instead."
7635 msgstr ""
7636
7637 #. type: textblock
7638 #: ../fish/guestfish-actions.pod:1164
7639 msgid ""
7640 "The deprecated call L</fallocate> does the same, but owing to an oversight "
7641 "it only allowed 30 bit lengths to be specified, effectively limiting the "
7642 "maximum size of files created through that call to 1GB."
7643 msgstr ""
7644
7645 #. type: textblock
7646 #: ../fish/guestfish-actions.pod:1169 ../src/guestfs-actions.pod:1955
7647 msgid ""
7648 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
7649 "commands which create a file in the host and attach it as a device."
7650 msgstr ""
7651
7652 #. type: =head2
7653 #: ../fish/guestfish-actions.pod:1173
7654 msgid "fgrep"
7655 msgstr ""
7656
7657 #. type: verbatim
7658 #: ../fish/guestfish-actions.pod:1175
7659 #, no-wrap
7660 msgid ""
7661 " fgrep pattern path\n"
7662 "\n"
7663 msgstr ""
7664
7665 #. type: textblock
7666 #: ../fish/guestfish-actions.pod:1177 ../src/guestfs-actions.pod:1970
7667 msgid "This calls the external C<fgrep> program and returns the matching lines."
7668 msgstr ""
7669
7670 #. type: =head2
7671 #: ../fish/guestfish-actions.pod:1183
7672 msgid "fgrepi"
7673 msgstr ""
7674
7675 #. type: verbatim
7676 #: ../fish/guestfish-actions.pod:1185
7677 #, no-wrap
7678 msgid ""
7679 " fgrepi pattern path\n"
7680 "\n"
7681 msgstr ""
7682
7683 #. type: textblock
7684 #: ../fish/guestfish-actions.pod:1187 ../src/guestfs-actions.pod:1989
7685 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
7686 msgstr ""
7687
7688 #. type: =head2
7689 #: ../fish/guestfish-actions.pod:1193
7690 msgid "file"
7691 msgstr ""
7692
7693 #. type: verbatim
7694 #: ../fish/guestfish-actions.pod:1195
7695 #, no-wrap
7696 msgid ""
7697 " file path\n"
7698 "\n"
7699 msgstr ""
7700
7701 #. type: textblock
7702 #: ../fish/guestfish-actions.pod:1197 ../src/guestfs-actions.pod:2007
7703 msgid ""
7704 "This call uses the standard L<file(1)> command to determine the type or "
7705 "contents of the file."
7706 msgstr ""
7707
7708 #. type: textblock
7709 #: ../fish/guestfish-actions.pod:1200 ../src/guestfs-actions.pod:2010
7710 msgid ""
7711 "This call will also transparently look inside various types of compressed "
7712 "file."
7713 msgstr ""
7714
7715 #. type: textblock
7716 #: ../fish/guestfish-actions.pod:1203 ../src/guestfs-actions.pod:2013
7717 msgid ""
7718 "The exact command which runs is C<file -zb path>.  Note in particular that "
7719 "the filename is not prepended to the output (the I<-b> option)."
7720 msgstr ""
7721
7722 #. type: textblock
7723 #: ../fish/guestfish-actions.pod:1207 ../src/guestfs-actions.pod:2017
7724 msgid ""
7725 "The output depends on the output of the underlying L<file(1)> command and it "
7726 "can change in future in ways beyond our control.  In other words, the output "
7727 "is not guaranteed by the ABI."
7728 msgstr ""
7729
7730 #. type: textblock
7731 #: ../fish/guestfish-actions.pod:1211
7732 msgid ""
7733 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
7734 "(etc), L</is-zero>."
7735 msgstr ""
7736
7737 #. type: =head2
7738 #: ../fish/guestfish-actions.pod:1214
7739 msgid "file-architecture"
7740 msgstr ""
7741
7742 #. type: verbatim
7743 #: ../fish/guestfish-actions.pod:1216
7744 #, no-wrap
7745 msgid ""
7746 " file-architecture filename\n"
7747 "\n"
7748 msgstr ""
7749
7750 #. type: textblock
7751 #: ../fish/guestfish-actions.pod:1218 ../src/guestfs-actions.pod:2035
7752 msgid ""
7753 "This detects the architecture of the binary C<filename>, and returns it if "
7754 "known."
7755 msgstr ""
7756
7757 #. type: textblock
7758 #: ../fish/guestfish-actions.pod:1221 ../src/guestfs-actions.pod:2038
7759 msgid "Currently defined architectures are:"
7760 msgstr ""
7761
7762 #. type: =item
7763 #: ../fish/guestfish-actions.pod:1225 ../src/guestfs-actions.pod:2042
7764 msgid "\"i386\""
7765 msgstr ""
7766
7767 #. type: textblock
7768 #: ../fish/guestfish-actions.pod:1227 ../src/guestfs-actions.pod:2044
7769 msgid ""
7770 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7771 "irrespective of the precise processor requirements of the binary."
7772 msgstr ""
7773
7774 #. type: =item
7775 #: ../fish/guestfish-actions.pod:1230 ../src/guestfs-actions.pod:2047
7776 msgid "\"x86_64\""
7777 msgstr ""
7778
7779 #. type: textblock
7780 #: ../fish/guestfish-actions.pod:1232 ../src/guestfs-actions.pod:2049
7781 msgid "64 bit x86-64."
7782 msgstr ""
7783
7784 #. type: =item
7785 #: ../fish/guestfish-actions.pod:1234 ../src/guestfs-actions.pod:2051
7786 msgid "\"sparc\""
7787 msgstr ""
7788
7789 #. type: textblock
7790 #: ../fish/guestfish-actions.pod:1236 ../src/guestfs-actions.pod:2053
7791 msgid "32 bit SPARC."
7792 msgstr ""
7793
7794 #. type: =item
7795 #: ../fish/guestfish-actions.pod:1238 ../src/guestfs-actions.pod:2055
7796 msgid "\"sparc64\""
7797 msgstr ""
7798
7799 #. type: textblock
7800 #: ../fish/guestfish-actions.pod:1240 ../src/guestfs-actions.pod:2057
7801 msgid "64 bit SPARC V9 and above."
7802 msgstr ""
7803
7804 #. type: =item
7805 #: ../fish/guestfish-actions.pod:1242 ../src/guestfs-actions.pod:2059
7806 msgid "\"ia64\""
7807 msgstr ""
7808
7809 #. type: textblock
7810 #: ../fish/guestfish-actions.pod:1244 ../src/guestfs-actions.pod:2061
7811 msgid "Intel Itanium."
7812 msgstr ""
7813
7814 #. type: =item
7815 #: ../fish/guestfish-actions.pod:1246 ../src/guestfs-actions.pod:2063
7816 msgid "\"ppc\""
7817 msgstr ""
7818
7819 #. type: textblock
7820 #: ../fish/guestfish-actions.pod:1248 ../src/guestfs-actions.pod:2065
7821 msgid "32 bit Power PC."
7822 msgstr ""
7823
7824 #. type: =item
7825 #: ../fish/guestfish-actions.pod:1250 ../src/guestfs-actions.pod:2067
7826 msgid "\"ppc64\""
7827 msgstr ""
7828
7829 #. type: textblock
7830 #: ../fish/guestfish-actions.pod:1252 ../src/guestfs-actions.pod:2069
7831 msgid "64 bit Power PC."
7832 msgstr ""
7833
7834 #. type: textblock
7835 #: ../fish/guestfish-actions.pod:1256 ../src/guestfs-actions.pod:2073
7836 msgid "Libguestfs may return other architecture strings in future."
7837 msgstr ""
7838
7839 #. type: textblock
7840 #: ../fish/guestfish-actions.pod:1258 ../src/guestfs-actions.pod:2075
7841 msgid "The function works on at least the following types of files:"
7842 msgstr ""
7843
7844 #. type: textblock
7845 #: ../fish/guestfish-actions.pod:1264 ../src/guestfs-actions.pod:2081
7846 msgid "many types of Un*x and Linux binary"
7847 msgstr ""
7848
7849 #. type: textblock
7850 #: ../fish/guestfish-actions.pod:1268 ../src/guestfs-actions.pod:2085
7851 msgid "many types of Un*x and Linux shared library"
7852 msgstr ""
7853
7854 #. type: textblock
7855 #: ../fish/guestfish-actions.pod:1272 ../src/guestfs-actions.pod:2089
7856 msgid "Windows Win32 and Win64 binaries"
7857 msgstr ""
7858
7859 #. type: textblock
7860 #: ../fish/guestfish-actions.pod:1276 ../src/guestfs-actions.pod:2093
7861 msgid "Windows Win32 and Win64 DLLs"
7862 msgstr ""
7863
7864 #. type: textblock
7865 #: ../fish/guestfish-actions.pod:1278 ../src/guestfs-actions.pod:2095
7866 msgid "Win32 binaries and DLLs return C<i386>."
7867 msgstr ""
7868
7869 #. type: textblock
7870 #: ../fish/guestfish-actions.pod:1280 ../src/guestfs-actions.pod:2097
7871 msgid "Win64 binaries and DLLs return C<x86_64>."
7872 msgstr ""
7873
7874 #. type: textblock
7875 #: ../fish/guestfish-actions.pod:1284 ../src/guestfs-actions.pod:2101
7876 msgid "Linux kernel modules"
7877 msgstr ""
7878
7879 #. type: textblock
7880 #: ../fish/guestfish-actions.pod:1288 ../src/guestfs-actions.pod:2105
7881 msgid "Linux new-style initrd images"
7882 msgstr ""
7883
7884 #. type: textblock
7885 #: ../fish/guestfish-actions.pod:1292 ../src/guestfs-actions.pod:2109
7886 msgid "some non-x86 Linux vmlinuz kernels"
7887 msgstr ""
7888
7889 #. type: textblock
7890 #: ../fish/guestfish-actions.pod:1296 ../src/guestfs-actions.pod:2113
7891 msgid "What it can't do currently:"
7892 msgstr ""
7893
7894 #. type: textblock
7895 #: ../fish/guestfish-actions.pod:1302 ../src/guestfs-actions.pod:2119
7896 msgid "static libraries (libfoo.a)"
7897 msgstr ""
7898
7899 #. type: textblock
7900 #: ../fish/guestfish-actions.pod:1306 ../src/guestfs-actions.pod:2123
7901 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7902 msgstr ""
7903
7904 #. type: textblock
7905 #: ../fish/guestfish-actions.pod:1310 ../src/guestfs-actions.pod:2127
7906 msgid "x86 Linux vmlinuz kernels"
7907 msgstr ""
7908
7909 #. type: textblock
7910 #: ../fish/guestfish-actions.pod:1312 ../src/guestfs-actions.pod:2129
7911 msgid ""
7912 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7913 "compressed code, and are horribly hard to unpack.  If you want to find the "
7914 "architecture of a kernel, use the architecture of the associated initrd or "
7915 "kernel module(s) instead."
7916 msgstr ""
7917
7918 #. type: =head2
7919 #: ../fish/guestfish-actions.pod:1319
7920 msgid "filesize"
7921 msgstr ""
7922
7923 #. type: verbatim
7924 #: ../fish/guestfish-actions.pod:1321
7925 #, no-wrap
7926 msgid ""
7927 " filesize file\n"
7928 "\n"
7929 msgstr ""
7930
7931 #. type: textblock
7932 #: ../fish/guestfish-actions.pod:1323 ../src/guestfs-actions.pod:2147
7933 msgid "This command returns the size of C<file> in bytes."
7934 msgstr ""
7935
7936 #. type: textblock
7937 #: ../fish/guestfish-actions.pod:1325
7938 msgid ""
7939 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
7940 "L</is-file> etc.  To get the size of block devices, use "
7941 "L</blockdev-getsize64>."
7942 msgstr ""
7943
7944 #. type: =head2
7945 #: ../fish/guestfish-actions.pod:1329
7946 msgid "fill"
7947 msgstr ""
7948
7949 #. type: verbatim
7950 #: ../fish/guestfish-actions.pod:1331
7951 #, no-wrap
7952 msgid ""
7953 " fill c len path\n"
7954 "\n"
7955 msgstr ""
7956
7957 #. type: textblock
7958 #: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:2165
7959 msgid ""
7960 "This command creates a new file called C<path>.  The initial content of the "
7961 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
7962 "C<[0..255]>."
7963 msgstr ""
7964
7965 #. type: textblock
7966 #: ../fish/guestfish-actions.pod:1337
7967 msgid ""
7968 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7969 "L</truncate-size>.  To create a file with a pattern of repeating bytes use "
7970 "L</fill-pattern>."
7971 msgstr ""
7972
7973 #. type: =head2
7974 #: ../fish/guestfish-actions.pod:1342
7975 msgid "fill-pattern"
7976 msgstr ""
7977
7978 #. type: verbatim
7979 #: ../fish/guestfish-actions.pod:1344
7980 #, no-wrap
7981 msgid ""
7982 " fill-pattern pattern len path\n"
7983 "\n"
7984 msgstr ""
7985
7986 #. type: textblock
7987 #: ../fish/guestfish-actions.pod:1346
7988 msgid ""
7989 "This function is like L</fill> except that it creates a new file of length "
7990 "C<len> containing the repeating pattern of bytes in C<pattern>.  The pattern "
7991 "is truncated if necessary to ensure the length of the file is exactly C<len> "
7992 "bytes."
7993 msgstr ""
7994
7995 #. type: =head2
7996 #: ../fish/guestfish-actions.pod:1351
7997 msgid "find"
7998 msgstr ""
7999
8000 #. type: verbatim
8001 #: ../fish/guestfish-actions.pod:1353
8002 #, no-wrap
8003 msgid ""
8004 " find directory\n"
8005 "\n"
8006 msgstr ""
8007
8008 #. type: textblock
8009 #: ../fish/guestfish-actions.pod:1355 ../src/guestfs-actions.pod:2211
8010 msgid ""
8011 "This command lists out all files and directories, recursively, starting at "
8012 "C<directory>.  It is essentially equivalent to running the shell command "
8013 "C<find directory -print> but some post-processing happens on the output, "
8014 "described below."
8015 msgstr ""
8016
8017 #. type: textblock
8018 #: ../fish/guestfish-actions.pod:1360 ../src/guestfs-actions.pod:2216
8019 msgid ""
8020 "This returns a list of strings I<without any prefix>.  Thus if the directory "
8021 "structure was:"
8022 msgstr ""
8023
8024 #. type: verbatim
8025 #: ../fish/guestfish-actions.pod:1363 ../src/guestfs-actions.pod:2219
8026 #, no-wrap
8027 msgid ""
8028 " /tmp/a\n"
8029 " /tmp/b\n"
8030 " /tmp/c/d\n"
8031 "\n"
8032 msgstr ""
8033
8034 #. type: textblock
8035 #: ../fish/guestfish-actions.pod:1367
8036 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
8037 msgstr ""
8038
8039 #. type: verbatim
8040 #: ../fish/guestfish-actions.pod:1370 ../src/guestfs-actions.pod:2226
8041 #, no-wrap
8042 msgid ""
8043 " a\n"
8044 " b\n"
8045 " c\n"
8046 " c/d\n"
8047 "\n"
8048 msgstr ""
8049
8050 #. type: textblock
8051 #: ../fish/guestfish-actions.pod:1375 ../src/guestfs-actions.pod:2231
8052 msgid "If C<directory> is not a directory, then this command returns an error."
8053 msgstr ""
8054
8055 #. type: textblock
8056 #: ../fish/guestfish-actions.pod:1378 ../src/guestfs-actions.pod:2234
8057 msgid "The returned list is sorted."
8058 msgstr ""
8059
8060 #. type: textblock
8061 #: ../fish/guestfish-actions.pod:1380
8062 msgid "See also L</find0>."
8063 msgstr ""
8064
8065 #. type: =head2
8066 #: ../fish/guestfish-actions.pod:1385
8067 msgid "find0"
8068 msgstr ""
8069
8070 #. type: verbatim
8071 #: ../fish/guestfish-actions.pod:1387
8072 #, no-wrap
8073 msgid ""
8074 " find0 directory (files|-)\n"
8075 "\n"
8076 msgstr ""
8077
8078 #. type: textblock
8079 #: ../fish/guestfish-actions.pod:1389 ../src/guestfs-actions.pod:2254
8080 msgid ""
8081 "This command lists out all files and directories, recursively, starting at "
8082 "C<directory>, placing the resulting list in the external file called "
8083 "C<files>."
8084 msgstr ""
8085
8086 #. type: textblock
8087 #: ../fish/guestfish-actions.pod:1393
8088 msgid "This command works the same way as L</find> with the following exceptions:"
8089 msgstr ""
8090
8091 #. type: textblock
8092 #: ../fish/guestfish-actions.pod:1400 ../src/guestfs-actions.pod:2265
8093 msgid "The resulting list is written to an external file."
8094 msgstr ""
8095
8096 #. type: textblock
8097 #: ../fish/guestfish-actions.pod:1404 ../src/guestfs-actions.pod:2269
8098 msgid ""
8099 "Items (filenames) in the result are separated by C<\\0> characters.  See "
8100 "L<find(1)> option I<-print0>."
8101 msgstr ""
8102
8103 #. type: textblock
8104 #: ../fish/guestfish-actions.pod:1409 ../src/guestfs-actions.pod:2274
8105 msgid "This command is not limited in the number of names that it can return."
8106 msgstr ""
8107
8108 #. type: textblock
8109 #: ../fish/guestfish-actions.pod:1414 ../src/guestfs-actions.pod:2279
8110 msgid "The result list is not sorted."
8111 msgstr ""
8112
8113 #. type: =head2
8114 #: ../fish/guestfish-actions.pod:1420
8115 msgid "findfs-label"
8116 msgstr ""
8117
8118 #. type: verbatim
8119 #: ../fish/guestfish-actions.pod:1422
8120 #, no-wrap
8121 msgid ""
8122 " findfs-label label\n"
8123 "\n"
8124 msgstr ""
8125
8126 #. type: textblock
8127 #: ../fish/guestfish-actions.pod:1424 ../src/guestfs-actions.pod:2293
8128 msgid ""
8129 "This command searches the filesystems and returns the one which has the "
8130 "given label.  An error is returned if no such filesystem can be found."
8131 msgstr ""
8132
8133 #. type: textblock
8134 #: ../fish/guestfish-actions.pod:1428
8135 msgid "To find the label of a filesystem, use L</vfs-label>."
8136 msgstr ""
8137
8138 #. type: =head2
8139 #: ../fish/guestfish-actions.pod:1430
8140 msgid "findfs-uuid"
8141 msgstr ""
8142
8143 #. type: verbatim
8144 #: ../fish/guestfish-actions.pod:1432
8145 #, no-wrap
8146 msgid ""
8147 " findfs-uuid uuid\n"
8148 "\n"
8149 msgstr ""
8150
8151 #. type: textblock
8152 #: ../fish/guestfish-actions.pod:1434 ../src/guestfs-actions.pod:2310
8153 msgid ""
8154 "This command searches the filesystems and returns the one which has the "
8155 "given UUID.  An error is returned if no such filesystem can be found."
8156 msgstr ""
8157
8158 #. type: textblock
8159 #: ../fish/guestfish-actions.pod:1438
8160 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
8161 msgstr ""
8162
8163 #. type: =head2
8164 #: ../fish/guestfish-actions.pod:1440
8165 msgid "fsck"
8166 msgstr ""
8167
8168 #. type: verbatim
8169 #: ../fish/guestfish-actions.pod:1442
8170 #, no-wrap
8171 msgid ""
8172 " fsck fstype device\n"
8173 "\n"
8174 msgstr ""
8175
8176 #. type: textblock
8177 #: ../fish/guestfish-actions.pod:1444 ../src/guestfs-actions.pod:2328
8178 msgid ""
8179 "This runs the filesystem checker (fsck) on C<device> which should have "
8180 "filesystem type C<fstype>."
8181 msgstr ""
8182
8183 #. type: textblock
8184 #: ../fish/guestfish-actions.pod:1447 ../src/guestfs-actions.pod:2331
8185 msgid ""
8186 "The returned integer is the status.  See L<fsck(8)> for the list of status "
8187 "codes from C<fsck>."
8188 msgstr ""
8189
8190 #. type: textblock
8191 #: ../fish/guestfish-actions.pod:1456 ../src/guestfs-actions.pod:2340
8192 msgid "Multiple status codes can be summed together."
8193 msgstr ""
8194
8195 #. type: textblock
8196 #: ../fish/guestfish-actions.pod:1460 ../src/guestfs-actions.pod:2344
8197 msgid ""
8198 "A non-zero return code can mean \"success\", for example if errors have been "
8199 "corrected on the filesystem."
8200 msgstr ""
8201
8202 #. type: textblock
8203 #: ../fish/guestfish-actions.pod:1465 ../src/guestfs-actions.pod:2349
8204 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8205 msgstr ""
8206
8207 #. type: textblock
8208 #: ../fish/guestfish-actions.pod:1470 ../src/guestfs-actions.pod:2354
8209 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8210 msgstr ""
8211
8212 #. type: =head2
8213 #: ../fish/guestfish-actions.pod:1472
8214 msgid "get-append"
8215 msgstr ""
8216
8217 #. type: verbatim
8218 #: ../fish/guestfish-actions.pod:1474
8219 #, no-wrap
8220 msgid ""
8221 " get-append\n"
8222 "\n"
8223 msgstr ""
8224
8225 #. type: textblock
8226 #: ../fish/guestfish-actions.pod:1476 ../src/guestfs-actions.pod:2365
8227 msgid ""
8228 "Return the additional kernel options which are added to the guest kernel "
8229 "command line."
8230 msgstr ""
8231
8232 #. type: textblock
8233 #: ../fish/guestfish-actions.pod:1479 ../src/guestfs-actions.pod:2368
8234 msgid "If C<NULL> then no options are added."
8235 msgstr ""
8236
8237 #. type: =head2
8238 #: ../fish/guestfish-actions.pod:1481
8239 msgid "get-attach-method"
8240 msgstr ""
8241
8242 #. type: verbatim
8243 #: ../fish/guestfish-actions.pod:1483
8244 #, no-wrap
8245 msgid ""
8246 " get-attach-method\n"
8247 "\n"
8248 msgstr ""
8249
8250 #. type: textblock
8251 #: ../fish/guestfish-actions.pod:1485
8252 msgid "Return the current attach method.  See L</set-attach-method>."
8253 msgstr ""
8254
8255 #. type: =head2
8256 #: ../fish/guestfish-actions.pod:1487
8257 msgid "get-autosync"
8258 msgstr ""
8259
8260 #. type: verbatim
8261 #: ../fish/guestfish-actions.pod:1489
8262 #, no-wrap
8263 msgid ""
8264 " get-autosync\n"
8265 "\n"
8266 msgstr ""
8267
8268 #. type: textblock
8269 #: ../fish/guestfish-actions.pod:1491 ../src/guestfs-actions.pod:2393
8270 msgid "Get the autosync flag."
8271 msgstr ""
8272
8273 #. type: =head2
8274 #: ../fish/guestfish-actions.pod:1493
8275 msgid "get-direct"
8276 msgstr ""
8277
8278 #. type: verbatim
8279 #: ../fish/guestfish-actions.pod:1495
8280 #, no-wrap
8281 msgid ""
8282 " get-direct\n"
8283 "\n"
8284 msgstr ""
8285
8286 #. type: textblock
8287 #: ../fish/guestfish-actions.pod:1497 ../src/guestfs-actions.pod:2404
8288 msgid "Return the direct appliance mode flag."
8289 msgstr ""
8290
8291 #. type: =head2
8292 #: ../fish/guestfish-actions.pod:1499
8293 msgid "get-e2label"
8294 msgstr ""
8295
8296 #. type: verbatim
8297 #: ../fish/guestfish-actions.pod:1501
8298 #, no-wrap
8299 msgid ""
8300 " get-e2label device\n"
8301 "\n"
8302 msgstr ""
8303
8304 #. type: textblock
8305 #: ../fish/guestfish-actions.pod:1503 ../src/guestfs-actions.pod:2423
8306 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8307 msgstr ""
8308
8309 #. type: textblock
8310 #: ../fish/guestfish-actions.pod:1506
8311 msgid ""
8312 "I<This function is deprecated.> In new code, use the L</vfs_label> call "
8313 "instead."
8314 msgstr ""
8315
8316 #. type: =head2
8317 #: ../fish/guestfish-actions.pod:1513
8318 msgid "get-e2uuid"
8319 msgstr ""
8320
8321 #. type: verbatim
8322 #: ../fish/guestfish-actions.pod:1515
8323 #, no-wrap
8324 msgid ""
8325 " get-e2uuid device\n"
8326 "\n"
8327 msgstr ""
8328
8329 #. type: textblock
8330 #: ../fish/guestfish-actions.pod:1517 ../src/guestfs-actions.pod:2444
8331 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8332 msgstr ""
8333
8334 #. type: textblock
8335 #: ../fish/guestfish-actions.pod:1520
8336 msgid ""
8337 "I<This function is deprecated.> In new code, use the L</vfs_uuid> call "
8338 "instead."
8339 msgstr ""
8340
8341 #. type: =head2
8342 #: ../fish/guestfish-actions.pod:1527
8343 msgid "get-memsize"
8344 msgstr ""
8345
8346 #. type: verbatim
8347 #: ../fish/guestfish-actions.pod:1529
8348 #, no-wrap
8349 msgid ""
8350 " get-memsize\n"
8351 "\n"
8352 msgstr ""
8353
8354 #. type: textblock
8355 #: ../fish/guestfish-actions.pod:1531 ../src/guestfs-actions.pod:2457
8356 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8357 msgstr ""
8358
8359 #. type: textblock
8360 #: ../fish/guestfish-actions.pod:1534
8361 msgid ""
8362 "If L</set-memsize> was not called on this handle, and if "
8363 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8364 "value for memsize."
8365 msgstr ""
8366
8367 #. type: textblock
8368 #: ../fish/guestfish-actions.pod:1538 ../fish/guestfish-actions.pod:1595 ../fish/guestfish-actions.pod:4360 ../fish/guestfish-actions.pod:4462 ../src/guestfs-actions.pod:2464 ../src/guestfs-actions.pod:2556 ../src/guestfs-actions.pod:6755 ../src/guestfs-actions.pod:6881
8369 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8370 msgstr ""
8371
8372 #. type: =head2
8373 #: ../fish/guestfish-actions.pod:1541
8374 msgid "get-network"
8375 msgstr ""
8376
8377 #. type: verbatim
8378 #: ../fish/guestfish-actions.pod:1543
8379 #, no-wrap
8380 msgid ""
8381 " get-network\n"
8382 "\n"
8383 msgstr ""
8384
8385 #. type: textblock
8386 #: ../fish/guestfish-actions.pod:1545 ../src/guestfs-actions.pod:2476
8387 msgid "This returns the enable network flag."
8388 msgstr ""
8389
8390 #. type: =head2
8391 #: ../fish/guestfish-actions.pod:1547
8392 msgid "get-path"
8393 msgstr ""
8394
8395 #. type: verbatim
8396 #: ../fish/guestfish-actions.pod:1549
8397 #, no-wrap
8398 msgid ""
8399 " get-path\n"
8400 "\n"
8401 msgstr ""
8402
8403 #. type: textblock
8404 #: ../fish/guestfish-actions.pod:1551 ../src/guestfs-actions.pod:2487
8405 msgid "Return the current search path."
8406 msgstr ""
8407
8408 #. type: textblock
8409 #: ../fish/guestfish-actions.pod:1553 ../src/guestfs-actions.pod:2489
8410 msgid ""
8411 "This is always non-NULL.  If it wasn't set already, then this will return "
8412 "the default path."
8413 msgstr ""
8414
8415 #. type: =head2
8416 #: ../fish/guestfish-actions.pod:1556
8417 msgid "get-pgroup"
8418 msgstr ""
8419
8420 #. type: verbatim
8421 #: ../fish/guestfish-actions.pod:1558
8422 #, no-wrap
8423 msgid ""
8424 " get-pgroup\n"
8425 "\n"
8426 msgstr ""
8427
8428 #. type: textblock
8429 #: ../fish/guestfish-actions.pod:1560 ../src/guestfs-actions.pod:2502
8430 msgid "This returns the process group flag."
8431 msgstr ""
8432
8433 #. type: =head2
8434 #: ../fish/guestfish-actions.pod:1562
8435 msgid "get-pid"
8436 msgstr ""
8437
8438 #. type: =head2
8439 #: ../fish/guestfish-actions.pod:1564
8440 msgid "pid"
8441 msgstr ""
8442
8443 #. type: verbatim
8444 #: ../fish/guestfish-actions.pod:1566
8445 #, no-wrap
8446 msgid ""
8447 " get-pid\n"
8448 "\n"
8449 msgstr ""
8450
8451 #. type: textblock
8452 #: ../fish/guestfish-actions.pod:1568 ../src/guestfs-actions.pod:2513
8453 msgid ""
8454 "Return the process ID of the qemu subprocess.  If there is no qemu "
8455 "subprocess, then this will return an error."
8456 msgstr ""
8457
8458 #. type: textblock
8459 #: ../fish/guestfish-actions.pod:1571 ../src/guestfs-actions.pod:2516
8460 msgid "This is an internal call used for debugging and testing."
8461 msgstr ""
8462
8463 #. type: =head2
8464 #: ../fish/guestfish-actions.pod:1573
8465 msgid "get-qemu"
8466 msgstr ""
8467
8468 #. type: verbatim
8469 #: ../fish/guestfish-actions.pod:1575
8470 #, no-wrap
8471 msgid ""
8472 " get-qemu\n"
8473 "\n"
8474 msgstr ""
8475
8476 #. type: textblock
8477 #: ../fish/guestfish-actions.pod:1577 ../src/guestfs-actions.pod:2527
8478 msgid "Return the current qemu binary."
8479 msgstr ""
8480
8481 #. type: textblock
8482 #: ../fish/guestfish-actions.pod:1579 ../src/guestfs-actions.pod:2529
8483 msgid ""
8484 "This is always non-NULL.  If it wasn't set already, then this will return "
8485 "the default qemu binary name."
8486 msgstr ""
8487
8488 #. type: =head2
8489 #: ../fish/guestfish-actions.pod:1582
8490 msgid "get-recovery-proc"
8491 msgstr ""
8492
8493 #. type: verbatim
8494 #: ../fish/guestfish-actions.pod:1584
8495 #, no-wrap
8496 msgid ""
8497 " get-recovery-proc\n"
8498 "\n"
8499 msgstr ""
8500
8501 #. type: textblock
8502 #: ../fish/guestfish-actions.pod:1586 ../src/guestfs-actions.pod:2542
8503 msgid "Return the recovery process enabled flag."
8504 msgstr ""
8505
8506 #. type: =head2
8507 #: ../fish/guestfish-actions.pod:1588
8508 msgid "get-selinux"
8509 msgstr ""
8510
8511 #. type: verbatim
8512 #: ../fish/guestfish-actions.pod:1590
8513 #, no-wrap
8514 msgid ""
8515 " get-selinux\n"
8516 "\n"
8517 msgstr ""
8518
8519 #. type: textblock
8520 #: ../fish/guestfish-actions.pod:1592
8521 msgid ""
8522 "This returns the current setting of the selinux flag which is passed to the "
8523 "appliance at boot time.  See L</set-selinux>."
8524 msgstr ""
8525
8526 #. type: =head2
8527 #: ../fish/guestfish-actions.pod:1598
8528 msgid "get-smp"
8529 msgstr ""
8530
8531 #. type: verbatim
8532 #: ../fish/guestfish-actions.pod:1600
8533 #, no-wrap
8534 msgid ""
8535 " get-smp\n"
8536 "\n"
8537 msgstr ""
8538
8539 #. type: textblock
8540 #: ../fish/guestfish-actions.pod:1602 ../src/guestfs-actions.pod:2568
8541 msgid "This returns the number of virtual CPUs assigned to the appliance."
8542 msgstr ""
8543
8544 #. type: =head2
8545 #: ../fish/guestfish-actions.pod:1604
8546 msgid "get-state"
8547 msgstr ""
8548
8549 #. type: verbatim
8550 #: ../fish/guestfish-actions.pod:1606
8551 #, no-wrap
8552 msgid ""
8553 " get-state\n"
8554 "\n"
8555 msgstr ""
8556
8557 #. type: textblock
8558 #: ../fish/guestfish-actions.pod:1608 ../src/guestfs-actions.pod:2579
8559 msgid ""
8560 "This returns the current state as an opaque integer.  This is only useful "
8561 "for printing debug and internal error messages."
8562 msgstr ""
8563
8564 #. type: textblock
8565 #: ../fish/guestfish-actions.pod:1611 ../fish/guestfish-actions.pod:2570 ../fish/guestfish-actions.pod:2588 ../fish/guestfish-actions.pod:2626 ../fish/guestfish-actions.pod:2642 ../src/guestfs-actions.pod:2582 ../src/guestfs-actions.pod:3901 ../src/guestfs-actions.pod:3930 ../src/guestfs-actions.pod:3991 ../src/guestfs-actions.pod:4018
8566 msgid "For more information on states, see L<guestfs(3)>."
8567 msgstr ""
8568
8569 #. type: =head2
8570 #: ../fish/guestfish-actions.pod:1613
8571 msgid "get-trace"
8572 msgstr ""
8573
8574 #. type: verbatim
8575 #: ../fish/guestfish-actions.pod:1615
8576 #, no-wrap
8577 msgid ""
8578 " get-trace\n"
8579 "\n"
8580 msgstr ""
8581
8582 #. type: textblock
8583 #: ../fish/guestfish-actions.pod:1617 ../src/guestfs-actions.pod:2593
8584 msgid "Return the command trace flag."
8585 msgstr ""
8586
8587 #. type: =head2
8588 #: ../fish/guestfish-actions.pod:1619
8589 msgid "get-umask"
8590 msgstr ""
8591
8592 #. type: verbatim
8593 #: ../fish/guestfish-actions.pod:1621
8594 #, no-wrap
8595 msgid ""
8596 " get-umask\n"
8597 "\n"
8598 msgstr ""
8599
8600 #. type: textblock
8601 #: ../fish/guestfish-actions.pod:1623
8602 msgid ""
8603 "Return the current umask.  By default the umask is C<022> unless it has been "
8604 "set by calling L</umask>."
8605 msgstr ""
8606
8607 #. type: =head2
8608 #: ../fish/guestfish-actions.pod:1626
8609 msgid "get-verbose"
8610 msgstr ""
8611
8612 #. type: verbatim
8613 #: ../fish/guestfish-actions.pod:1628
8614 #, no-wrap
8615 msgid ""
8616 " get-verbose\n"
8617 "\n"
8618 msgstr ""
8619
8620 #. type: textblock
8621 #: ../fish/guestfish-actions.pod:1630 ../src/guestfs-actions.pod:2616
8622 msgid "This returns the verbose messages flag."
8623 msgstr ""
8624
8625 #. type: =head2
8626 #: ../fish/guestfish-actions.pod:1632
8627 msgid "getcon"
8628 msgstr ""
8629
8630 #. type: verbatim
8631 #: ../fish/guestfish-actions.pod:1634
8632 #, no-wrap
8633 msgid ""
8634 " getcon\n"
8635 "\n"
8636 msgstr ""
8637
8638 #. type: textblock
8639 #: ../fish/guestfish-actions.pod:1636 ../src/guestfs-actions.pod:2627
8640 msgid "This gets the SELinux security context of the daemon."
8641 msgstr ""
8642
8643 #. type: textblock
8644 #: ../fish/guestfish-actions.pod:1638
8645 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
8646 msgstr ""
8647
8648 #. type: =head2
8649 #: ../fish/guestfish-actions.pod:1641
8650 msgid "getxattr"
8651 msgstr ""
8652
8653 #. type: verbatim
8654 #: ../fish/guestfish-actions.pod:1643
8655 #, no-wrap
8656 msgid ""
8657 " getxattr path name\n"
8658 "\n"
8659 msgstr ""
8660
8661 #. type: textblock
8662 #: ../fish/guestfish-actions.pod:1645
8663 msgid ""
8664 "Get a single extended attribute from file C<path> named C<name>.  This call "
8665 "follows symlinks.  If you want to lookup an extended attribute for the "
8666 "symlink itself, use L</lgetxattr>."
8667 msgstr ""
8668
8669 #. type: textblock
8670 #: ../fish/guestfish-actions.pod:1649 ../fish/guestfish-actions.pod:2715
8671 msgid ""
8672 "Normally it is better to get all extended attributes from a file in one go "
8673 "by calling L</getxattrs>.  However some Linux filesystem implementations are "
8674 "buggy and do not provide a way to list out attributes.  For these "
8675 "filesystems (notably ntfs-3g)  you have to know the names of the extended "
8676 "attributes you want in advance and call this function."
8677 msgstr ""
8678
8679 #. type: textblock
8680 #: ../fish/guestfish-actions.pod:1656 ../fish/guestfish-actions.pod:2722 ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:4151
8681 msgid ""
8682 "Extended attribute values are blobs of binary data.  If there is no extended "
8683 "attribute named C<name>, this returns an error."
8684 msgstr ""
8685
8686 #. type: textblock
8687 #: ../fish/guestfish-actions.pod:1659
8688 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
8689 msgstr ""
8690
8691 #. type: =head2
8692 #: ../fish/guestfish-actions.pod:1661
8693 msgid "getxattrs"
8694 msgstr ""
8695
8696 #. type: verbatim
8697 #: ../fish/guestfish-actions.pod:1663
8698 #, no-wrap
8699 msgid ""
8700 " getxattrs path\n"
8701 "\n"
8702 msgstr ""
8703
8704 #. type: textblock
8705 #: ../fish/guestfish-actions.pod:1665 ../src/guestfs-actions.pod:2673
8706 msgid "This call lists the extended attributes of the file or directory C<path>."
8707 msgstr ""
8708
8709 #. type: textblock
8710 #: ../fish/guestfish-actions.pod:1668 ../src/guestfs-actions.pod:2676
8711 msgid ""
8712 "At the system call level, this is a combination of the L<listxattr(2)> and "
8713 "L<getxattr(2)> calls."
8714 msgstr ""
8715
8716 #. type: textblock
8717 #: ../fish/guestfish-actions.pod:1671
8718 msgid "See also: L</lgetxattrs>, L<attr(5)>."
8719 msgstr ""
8720
8721 #. type: =head2
8722 #: ../fish/guestfish-actions.pod:1673
8723 msgid "glob-expand"
8724 msgstr ""
8725
8726 #. type: verbatim
8727 #: ../fish/guestfish-actions.pod:1675
8728 #, no-wrap
8729 msgid ""
8730 " glob-expand pattern\n"
8731 "\n"
8732 msgstr ""
8733
8734 #. type: textblock
8735 #: ../fish/guestfish-actions.pod:1677 ../src/guestfs-actions.pod:2693
8736 msgid ""
8737 "This command searches for all the pathnames matching C<pattern> according to "
8738 "the wildcard expansion rules used by the shell."
8739 msgstr ""
8740
8741 #. type: textblock
8742 #: ../fish/guestfish-actions.pod:1681 ../src/guestfs-actions.pod:2697
8743 msgid "If no paths match, then this returns an empty list (note: not an error)."
8744 msgstr ""
8745
8746 #. type: textblock
8747 #: ../fish/guestfish-actions.pod:1684 ../src/guestfs-actions.pod:2700
8748 msgid ""
8749 "It is just a wrapper around the C L<glob(3)> function with flags "
8750 "C<GLOB_MARK|GLOB_BRACE>.  See that manual page for more details."
8751 msgstr ""
8752
8753 #. type: =head2
8754 #: ../fish/guestfish-actions.pod:1688
8755 msgid "grep"
8756 msgstr ""
8757
8758 #. type: verbatim
8759 #: ../fish/guestfish-actions.pod:1690
8760 #, no-wrap
8761 msgid ""
8762 " grep regex path\n"
8763 "\n"
8764 msgstr ""
8765
8766 #. type: textblock
8767 #: ../fish/guestfish-actions.pod:1692 ../src/guestfs-actions.pod:2717
8768 msgid "This calls the external C<grep> program and returns the matching lines."
8769 msgstr ""
8770
8771 #. type: =head2
8772 #: ../fish/guestfish-actions.pod:1698
8773 msgid "grepi"
8774 msgstr ""
8775
8776 #. type: verbatim
8777 #: ../fish/guestfish-actions.pod:1700
8778 #, no-wrap
8779 msgid ""
8780 " grepi regex path\n"
8781 "\n"
8782 msgstr ""
8783
8784 #. type: textblock
8785 #: ../fish/guestfish-actions.pod:1702 ../src/guestfs-actions.pod:2736
8786 msgid "This calls the external C<grep -i> program and returns the matching lines."
8787 msgstr ""
8788
8789 #. type: =head2
8790 #: ../fish/guestfish-actions.pod:1708
8791 msgid "grub-install"
8792 msgstr ""
8793
8794 #. type: verbatim
8795 #: ../fish/guestfish-actions.pod:1710
8796 #, no-wrap
8797 msgid ""
8798 " grub-install root device\n"
8799 "\n"
8800 msgstr ""
8801
8802 #. type: textblock
8803 #: ../fish/guestfish-actions.pod:1712 ../src/guestfs-actions.pod:2755
8804 msgid ""
8805 "This command installs GRUB 1 (the Grand Unified Bootloader) on C<device>, "
8806 "with the root directory being C<root>."
8807 msgstr ""
8808
8809 #. type: textblock
8810 #: ../fish/guestfish-actions.pod:1721 ../src/guestfs-actions.pod:2764
8811 msgid ""
8812 "There is currently no way in the API to install grub2, which is used by most "
8813 "modern Linux guests.  It is possible to run the grub2 command from the "
8814 "guest, although see the caveats in L<guestfs(3)/RUNNING COMMANDS>."
8815 msgstr ""
8816
8817 #. type: textblock
8818 #: ../fish/guestfish-actions.pod:1728 ../src/guestfs-actions.pod:2771
8819 msgid ""
8820 "This uses C<grub-install> from the host.  Unfortunately grub is not always "
8821 "compatible with itself, so this only works in rather narrow circumstances.  "
8822 "Careful testing with each guest version is advisable."
8823 msgstr ""
8824
8825 #. type: textblock
8826 #: ../fish/guestfish-actions.pod:1735 ../src/guestfs-actions.pod:2778
8827 msgid ""
8828 "If grub-install reports the error \"No suitable drive was found in the "
8829 "generated device map.\" it may be that you need to create a "
8830 "C</boot/grub/device.map> file first that contains the mapping between grub "
8831 "device names and Linux device names.  It is usually sufficient to create a "
8832 "file containing:"
8833 msgstr ""
8834
8835 #. type: verbatim
8836 #: ../fish/guestfish-actions.pod:1742 ../src/guestfs-actions.pod:2785
8837 #, no-wrap
8838 msgid ""
8839 " (hd0) /dev/vda\n"
8840 "\n"
8841 msgstr ""
8842
8843 #. type: textblock
8844 #: ../fish/guestfish-actions.pod:1744 ../src/guestfs-actions.pod:2787
8845 msgid "replacing C</dev/vda> with the name of the installation device."
8846 msgstr ""
8847
8848 #. type: =head2
8849 #: ../fish/guestfish-actions.pod:1748
8850 msgid "head"
8851 msgstr ""
8852
8853 #. type: verbatim
8854 #: ../fish/guestfish-actions.pod:1750
8855 #, no-wrap
8856 msgid ""
8857 " head path\n"
8858 "\n"
8859 msgstr ""
8860
8861 #. type: textblock
8862 #: ../fish/guestfish-actions.pod:1752 ../src/guestfs-actions.pod:2801
8863 msgid ""
8864 "This command returns up to the first 10 lines of a file as a list of "
8865 "strings."
8866 msgstr ""
8867
8868 #. type: =head2
8869 #: ../fish/guestfish-actions.pod:1758
8870 msgid "head-n"
8871 msgstr ""
8872
8873 #. type: verbatim
8874 #: ../fish/guestfish-actions.pod:1760
8875 #, no-wrap
8876 msgid ""
8877 " head-n nrlines path\n"
8878 "\n"
8879 msgstr ""
8880
8881 #. type: textblock
8882 #: ../fish/guestfish-actions.pod:1762 ../src/guestfs-actions.pod:2820
8883 msgid ""
8884 "If the parameter C<nrlines> is a positive number, this returns the first "
8885 "C<nrlines> lines of the file C<path>."
8886 msgstr ""
8887
8888 #. type: textblock
8889 #: ../fish/guestfish-actions.pod:1765 ../src/guestfs-actions.pod:2823
8890 msgid ""
8891 "If the parameter C<nrlines> is a negative number, this returns lines from "
8892 "the file C<path>, excluding the last C<nrlines> lines."
8893 msgstr ""
8894
8895 #. type: textblock
8896 #: ../fish/guestfish-actions.pod:1768 ../fish/guestfish-actions.pod:4843 ../src/guestfs-actions.pod:2826 ../src/guestfs-actions.pod:7460
8897 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8898 msgstr ""
8899
8900 #. type: =head2
8901 #: ../fish/guestfish-actions.pod:1773
8902 msgid "hexdump"
8903 msgstr ""
8904
8905 #. type: verbatim
8906 #: ../fish/guestfish-actions.pod:1775
8907 #, no-wrap
8908 msgid ""
8909 " hexdump path\n"
8910 "\n"
8911 msgstr ""
8912
8913 #. type: textblock
8914 #: ../fish/guestfish-actions.pod:1777 ../src/guestfs-actions.pod:2843
8915 msgid ""
8916 "This runs C<hexdump -C> on the given C<path>.  The result is the "
8917 "human-readable, canonical hex dump of the file."
8918 msgstr ""
8919
8920 #. type: =head2
8921 #: ../fish/guestfish-actions.pod:1783
8922 msgid "initrd-cat"
8923 msgstr ""
8924
8925 #. type: verbatim
8926 #: ../fish/guestfish-actions.pod:1785
8927 #, no-wrap
8928 msgid ""
8929 " initrd-cat initrdpath filename\n"
8930 "\n"
8931 msgstr ""
8932
8933 #. type: textblock
8934 #: ../fish/guestfish-actions.pod:1787 ../src/guestfs-actions.pod:2862
8935 msgid ""
8936 "This command unpacks the file C<filename> from the initrd file called "
8937 "C<initrdpath>.  The filename must be given I<without> the initial C</> "
8938 "character."
8939 msgstr ""
8940
8941 #. type: textblock
8942 #: ../fish/guestfish-actions.pod:1791 ../src/guestfs-actions.pod:2866
8943 msgid ""
8944 "For example, in guestfish you could use the following command to examine the "
8945 "boot script (usually called C</init>)  contained in a Linux initrd or "
8946 "initramfs image:"
8947 msgstr ""
8948
8949 #. type: verbatim
8950 #: ../fish/guestfish-actions.pod:1795 ../src/guestfs-actions.pod:2870
8951 #, no-wrap
8952 msgid ""
8953 " initrd-cat /boot/initrd-<version>.img init\n"
8954 "\n"
8955 msgstr ""
8956
8957 #. type: textblock
8958 #: ../fish/guestfish-actions.pod:1797
8959 msgid "See also L</initrd-list>."
8960 msgstr ""
8961
8962 #. type: =head2
8963 #: ../fish/guestfish-actions.pod:1802
8964 msgid "initrd-list"
8965 msgstr ""
8966
8967 #. type: verbatim
8968 #: ../fish/guestfish-actions.pod:1804
8969 #, no-wrap
8970 msgid ""
8971 " initrd-list path\n"
8972 "\n"
8973 msgstr ""
8974
8975 #. type: textblock
8976 #: ../fish/guestfish-actions.pod:1806 ../src/guestfs-actions.pod:2889
8977 msgid "This command lists out files contained in an initrd."
8978 msgstr ""
8979
8980 #. type: textblock
8981 #: ../fish/guestfish-actions.pod:1808 ../src/guestfs-actions.pod:2891
8982 msgid ""
8983 "The files are listed without any initial C</> character.  The files are "
8984 "listed in the order they appear (not necessarily alphabetical).  Directory "
8985 "names are listed as separate items."
8986 msgstr ""
8987
8988 #. type: textblock
8989 #: ../fish/guestfish-actions.pod:1812 ../src/guestfs-actions.pod:2895
8990 msgid ""
8991 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8992 "initrd.  We I<only> support the newer initramfs format (compressed cpio "
8993 "files)."
8994 msgstr ""
8995
8996 #. type: =head2
8997 #: ../fish/guestfish-actions.pod:1816
8998 msgid "inotify-add-watch"
8999 msgstr ""
9000
9001 #. type: verbatim
9002 #: ../fish/guestfish-actions.pod:1818
9003 #, no-wrap
9004 msgid ""
9005 " inotify-add-watch path mask\n"
9006 "\n"
9007 msgstr ""
9008
9009 #. type: textblock
9010 #: ../fish/guestfish-actions.pod:1820 ../src/guestfs-actions.pod:2912
9011 msgid "Watch C<path> for the events listed in C<mask>."
9012 msgstr ""
9013
9014 #. type: textblock
9015 #: ../fish/guestfish-actions.pod:1822 ../src/guestfs-actions.pod:2914
9016 msgid ""
9017 "Note that if C<path> is a directory then events within that directory are "
9018 "watched, but this does I<not> happen recursively (in subdirectories)."
9019 msgstr ""
9020
9021 #. type: textblock
9022 #: ../fish/guestfish-actions.pod:1826 ../src/guestfs-actions.pod:2918
9023 msgid ""
9024 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9025 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9026 msgstr ""
9027
9028 #. type: =head2
9029 #: ../fish/guestfish-actions.pod:1830
9030 msgid "inotify-close"
9031 msgstr ""
9032
9033 #. type: verbatim
9034 #: ../fish/guestfish-actions.pod:1832
9035 #, no-wrap
9036 msgid ""
9037 " inotify-close\n"
9038 "\n"
9039 msgstr ""
9040
9041 #. type: textblock
9042 #: ../fish/guestfish-actions.pod:1834 ../src/guestfs-actions.pod:2931
9043 msgid ""
9044 "This closes the inotify handle which was previously opened by inotify_init.  "
9045 "It removes all watches, throws away any pending events, and deallocates all "
9046 "resources."
9047 msgstr ""
9048
9049 #. type: =head2
9050 #: ../fish/guestfish-actions.pod:1838
9051 msgid "inotify-files"
9052 msgstr ""
9053
9054 #. type: verbatim
9055 #: ../fish/guestfish-actions.pod:1840
9056 #, no-wrap
9057 msgid ""
9058 " inotify-files\n"
9059 "\n"
9060 msgstr ""
9061
9062 #. type: textblock
9063 #: ../fish/guestfish-actions.pod:1842
9064 msgid ""
9065 "This function is a helpful wrapper around L</inotify-read> which just "
9066 "returns a list of pathnames of objects that were touched.  The returned "
9067 "pathnames are sorted and deduplicated."
9068 msgstr ""
9069
9070 #. type: =head2
9071 #: ../fish/guestfish-actions.pod:1846
9072 msgid "inotify-init"
9073 msgstr ""
9074
9075 #. type: verbatim
9076 #: ../fish/guestfish-actions.pod:1848
9077 #, no-wrap
9078 msgid ""
9079 " inotify-init maxevents\n"
9080 "\n"
9081 msgstr ""
9082
9083 #. type: textblock
9084 #: ../fish/guestfish-actions.pod:1850 ../src/guestfs-actions.pod:2960
9085 msgid ""
9086 "This command creates a new inotify handle.  The inotify subsystem can be "
9087 "used to notify events which happen to objects in the guest filesystem."
9088 msgstr ""
9089
9090 #. type: textblock
9091 #: ../fish/guestfish-actions.pod:1854
9092 msgid ""
9093 "C<maxevents> is the maximum number of events which will be queued up between "
9094 "calls to L</inotify-read> or L</inotify-files>.  If this is passed as C<0>, "
9095 "then the kernel (or previously set)  default is used.  For Linux 2.6.29 the "
9096 "default was 16384 events.  Beyond this limit, the kernel throws away events, "
9097 "but records the fact that it threw them away by setting a flag "
9098 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
9099 msgstr ""
9100
9101 #. type: textblock
9102 #: ../fish/guestfish-actions.pod:1864
9103 msgid ""
9104 "Before any events are generated, you have to add some watches to the "
9105 "internal watch list.  See: L</inotify-add-watch>, L</inotify-rm-watch> and "
9106 "L</inotify-watch-all>."
9107 msgstr ""
9108
9109 #. type: textblock
9110 #: ../fish/guestfish-actions.pod:1870
9111 msgid ""
9112 "Queued up events should be read periodically by calling L</inotify-read> (or "
9113 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>).  "
9114 "If you don't read the events out often enough then you risk the internal "
9115 "queue overflowing."
9116 msgstr ""
9117
9118 #. type: textblock
9119 #: ../fish/guestfish-actions.pod:1877
9120 msgid ""
9121 "The handle should be closed after use by calling L</inotify-close>.  This "
9122 "also removes any watches automatically."
9123 msgstr ""
9124
9125 #. type: textblock
9126 #: ../fish/guestfish-actions.pod:1881 ../src/guestfs-actions.pod:2991
9127 msgid ""
9128 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9129 "by the Linux kernel, which is roughly what we expose via libguestfs.  Note "
9130 "that there is one global inotify handle per libguestfs instance."
9131 msgstr ""
9132
9133 #. type: =head2
9134 #: ../fish/guestfish-actions.pod:1886
9135 msgid "inotify-read"
9136 msgstr ""
9137
9138 #. type: verbatim
9139 #: ../fish/guestfish-actions.pod:1888
9140 #, no-wrap
9141 msgid ""
9142 " inotify-read\n"
9143 "\n"
9144 msgstr ""
9145
9146 #. type: textblock
9147 #: ../fish/guestfish-actions.pod:1890 ../src/guestfs-actions.pod:3005
9148 msgid ""
9149 "Return the complete queue of events that have happened since the previous "
9150 "read call."
9151 msgstr ""
9152
9153 #. type: textblock
9154 #: ../fish/guestfish-actions.pod:1893 ../src/guestfs-actions.pod:3008
9155 msgid "If no events have happened, this returns an empty list."
9156 msgstr ""
9157
9158 #. type: textblock
9159 #: ../fish/guestfish-actions.pod:1895 ../src/guestfs-actions.pod:3010
9160 msgid ""
9161 "I<Note>: In order to make sure that all events have been read, you must call "
9162 "this function repeatedly until it returns an empty list.  The reason is that "
9163 "the call will read events up to the maximum appliance-to-host message size "
9164 "and leave remaining events in the queue."
9165 msgstr ""
9166
9167 #. type: =head2
9168 #: ../fish/guestfish-actions.pod:1901
9169 msgid "inotify-rm-watch"
9170 msgstr ""
9171
9172 #. type: verbatim
9173 #: ../fish/guestfish-actions.pod:1903
9174 #, no-wrap
9175 msgid ""
9176 " inotify-rm-watch wd\n"
9177 "\n"
9178 msgstr ""
9179
9180 #. type: textblock
9181 #: ../fish/guestfish-actions.pod:1905
9182 msgid "Remove a previously defined inotify watch.  See L</inotify-add-watch>."
9183 msgstr ""
9184
9185 #. type: =head2
9186 #: ../fish/guestfish-actions.pod:1908
9187 msgid "inspect-get-arch"
9188 msgstr ""
9189
9190 #. type: verbatim
9191 #: ../fish/guestfish-actions.pod:1910
9192 #, no-wrap
9193 msgid ""
9194 " inspect-get-arch root\n"
9195 "\n"
9196 msgstr ""
9197
9198 #. type: textblock
9199 #: ../fish/guestfish-actions.pod:1912
9200 msgid ""
9201 "This returns the architecture of the inspected operating system.  The "
9202 "possible return values are listed under L</file-architecture>."
9203 msgstr ""
9204
9205 #. type: textblock
9206 #: ../fish/guestfish-actions.pod:1916 ../src/guestfs-actions.pod:3045
9207 msgid ""
9208 "If the architecture could not be determined, then the string C<unknown> is "
9209 "returned."
9210 msgstr ""
9211
9212 #. type: textblock
9213 #: ../fish/guestfish-actions.pod:1919 ../fish/guestfish-actions.pod:2014 ../fish/guestfish-actions.pod:2093 ../fish/guestfish-actions.pod:2105 ../fish/guestfish-actions.pod:2189 ../fish/guestfish-actions.pod:2251 ../fish/guestfish-actions.pod:2272 ../fish/guestfish-actions.pod:2286 ../fish/guestfish-actions.pod:2326 ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2375 ../fish/guestfish-actions.pod:2388 ../fish/guestfish-actions.pod:2398 ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:2420 ../fish/guestfish-actions.pod:2516 ../fish/guestfish-actions.pod:2550 ../src/guestfs-actions.pod:3048 ../src/guestfs-actions.pod:3150 ../src/guestfs-actions.pod:3254 ../src/guestfs-actions.pod:3273 ../src/guestfs-actions.pod:3404 ../src/guestfs-actions.pod:3488 ../src/guestfs-actions.pod:3516 ../src/guestfs-actions.pod:3537 ../src/guestfs-actions.pod:3590 ../src/guestfs-actions.pod:3634 ../src/guestfs-actions.pod:3654 ../src/guestfs-actions.pod:3674 ../src/guestfs-actions.pod:3691 ../src/guestfs-actions.pod:3707 ../src/guestfs-actions.pod:3725 ../src/guestfs-actions.pod:3827 ../src/guestfs-actions.pod:3868
9214 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9215 msgstr ""
9216
9217 #. type: =head2
9218 #: ../fish/guestfish-actions.pod:1921
9219 msgid "inspect-get-distro"
9220 msgstr ""
9221
9222 #. type: verbatim
9223 #: ../fish/guestfish-actions.pod:1923
9224 #, no-wrap
9225 msgid ""
9226 " inspect-get-distro root\n"
9227 "\n"
9228 msgstr ""
9229
9230 #. type: textblock
9231 #: ../fish/guestfish-actions.pod:1925 ../src/guestfs-actions.pod:3061
9232 msgid "This returns the distro (distribution) of the inspected operating system."
9233 msgstr ""
9234
9235 #. type: textblock
9236 #: ../fish/guestfish-actions.pod:1928 ../src/guestfs-actions.pod:3064
9237 msgid "Currently defined distros are:"
9238 msgstr ""
9239
9240 #. type: =item
9241 #: ../fish/guestfish-actions.pod:1932 ../src/guestfs-actions.pod:3068
9242 msgid "\"archlinux\""
9243 msgstr ""
9244
9245 #. type: textblock
9246 #: ../fish/guestfish-actions.pod:1934 ../src/guestfs-actions.pod:3070
9247 msgid "Arch Linux."
9248 msgstr ""
9249
9250 #. type: =item
9251 #: ../fish/guestfish-actions.pod:1936 ../src/guestfs-actions.pod:3072
9252 msgid "\"centos\""
9253 msgstr ""
9254
9255 #. type: textblock
9256 #: ../fish/guestfish-actions.pod:1938 ../src/guestfs-actions.pod:3074
9257 msgid "CentOS."
9258 msgstr ""
9259
9260 #. type: =item
9261 #: ../fish/guestfish-actions.pod:1940 ../src/guestfs-actions.pod:3076
9262 msgid "\"debian\""
9263 msgstr ""
9264
9265 #. type: textblock
9266 #: ../fish/guestfish-actions.pod:1942 ../src/guestfs-actions.pod:3078
9267 msgid "Debian."
9268 msgstr ""
9269
9270 #. type: =item
9271 #: ../fish/guestfish-actions.pod:1944 ../src/guestfs-actions.pod:3080
9272 msgid "\"fedora\""
9273 msgstr ""
9274
9275 #. type: textblock
9276 #: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:3082
9277 msgid "Fedora."
9278 msgstr ""
9279
9280 #. type: =item
9281 #: ../fish/guestfish-actions.pod:1948 ../src/guestfs-actions.pod:3084
9282 msgid "\"gentoo\""
9283 msgstr ""
9284
9285 #. type: textblock
9286 #: ../fish/guestfish-actions.pod:1950 ../src/guestfs-actions.pod:3086
9287 msgid "Gentoo."
9288 msgstr ""
9289
9290 #. type: =item
9291 #: ../fish/guestfish-actions.pod:1952 ../src/guestfs-actions.pod:3088
9292 msgid "\"linuxmint\""
9293 msgstr ""
9294
9295 #. type: textblock
9296 #: ../fish/guestfish-actions.pod:1954 ../src/guestfs-actions.pod:3090
9297 msgid "Linux Mint."
9298 msgstr ""
9299
9300 #. type: =item
9301 #: ../fish/guestfish-actions.pod:1956 ../src/guestfs-actions.pod:3092
9302 msgid "\"mageia\""
9303 msgstr ""
9304
9305 #. type: textblock
9306 #: ../fish/guestfish-actions.pod:1958 ../src/guestfs-actions.pod:3094
9307 msgid "Mageia."
9308 msgstr ""
9309
9310 #. type: =item
9311 #: ../fish/guestfish-actions.pod:1960 ../src/guestfs-actions.pod:3096
9312 msgid "\"mandriva\""
9313 msgstr ""
9314
9315 #. type: textblock
9316 #: ../fish/guestfish-actions.pod:1962 ../src/guestfs-actions.pod:3098
9317 msgid "Mandriva."
9318 msgstr ""
9319
9320 #. type: =item
9321 #: ../fish/guestfish-actions.pod:1964 ../src/guestfs-actions.pod:3100
9322 msgid "\"meego\""
9323 msgstr ""
9324
9325 #. type: textblock
9326 #: ../fish/guestfish-actions.pod:1966 ../src/guestfs-actions.pod:3102
9327 msgid "MeeGo."
9328 msgstr ""
9329
9330 #. type: =item
9331 #: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:3104
9332 msgid "\"opensuse\""
9333 msgstr ""
9334
9335 #. type: textblock
9336 #: ../fish/guestfish-actions.pod:1970 ../src/guestfs-actions.pod:3106
9337 msgid "OpenSUSE."
9338 msgstr ""
9339
9340 #. type: =item
9341 #: ../fish/guestfish-actions.pod:1972 ../src/guestfs-actions.pod:3108
9342 msgid "\"pardus\""
9343 msgstr ""
9344
9345 #. type: textblock
9346 #: ../fish/guestfish-actions.pod:1974 ../src/guestfs-actions.pod:3110
9347 msgid "Pardus."
9348 msgstr ""
9349
9350 #. type: =item
9351 #: ../fish/guestfish-actions.pod:1976 ../src/guestfs-actions.pod:3112
9352 msgid "\"redhat-based\""
9353 msgstr ""
9354
9355 #. type: textblock
9356 #: ../fish/guestfish-actions.pod:1978 ../src/guestfs-actions.pod:3114
9357 msgid "Some Red Hat-derived distro."
9358 msgstr ""
9359
9360 #. type: =item
9361 #: ../fish/guestfish-actions.pod:1980 ../src/guestfs-actions.pod:3116
9362 msgid "\"rhel\""
9363 msgstr ""
9364
9365 #. type: textblock
9366 #: ../fish/guestfish-actions.pod:1982 ../src/guestfs-actions.pod:3118
9367 msgid "Red Hat Enterprise Linux."
9368 msgstr ""
9369
9370 #. type: =item
9371 #: ../fish/guestfish-actions.pod:1984 ../src/guestfs-actions.pod:3120
9372 msgid "\"scientificlinux\""
9373 msgstr ""
9374
9375 #. type: textblock
9376 #: ../fish/guestfish-actions.pod:1986 ../src/guestfs-actions.pod:3122
9377 msgid "Scientific Linux."
9378 msgstr ""
9379
9380 #. type: =item
9381 #: ../fish/guestfish-actions.pod:1988 ../src/guestfs-actions.pod:3124
9382 msgid "\"slackware\""
9383 msgstr ""
9384
9385 #. type: textblock
9386 #: ../fish/guestfish-actions.pod:1990 ../src/guestfs-actions.pod:3126
9387 msgid "Slackware."
9388 msgstr ""
9389
9390 #. type: =item
9391 #: ../fish/guestfish-actions.pod:1992 ../src/guestfs-actions.pod:3128
9392 msgid "\"ttylinux\""
9393 msgstr ""
9394
9395 #. type: textblock
9396 #: ../fish/guestfish-actions.pod:1994 ../src/guestfs-actions.pod:3130
9397 msgid "ttylinux."
9398 msgstr ""
9399
9400 #. type: =item
9401 #: ../fish/guestfish-actions.pod:1996 ../src/guestfs-actions.pod:3132
9402 msgid "\"ubuntu\""
9403 msgstr ""
9404
9405 #. type: textblock
9406 #: ../fish/guestfish-actions.pod:1998 ../src/guestfs-actions.pod:3134
9407 msgid "Ubuntu."
9408 msgstr ""
9409
9410 #. type: =item
9411 #: ../fish/guestfish-actions.pod:2000 ../fish/guestfish-actions.pod:2084 ../fish/guestfish-actions.pod:2353 ../src/guestfs-actions.pod:3136 ../src/guestfs-actions.pod:3245 ../src/guestfs-actions.pod:3625
9412 msgid "\"unknown\""
9413 msgstr ""
9414
9415 #. type: textblock
9416 #: ../fish/guestfish-actions.pod:2002 ../src/guestfs-actions.pod:3138
9417 msgid "The distro could not be determined."
9418 msgstr ""
9419
9420 #. type: =item
9421 #: ../fish/guestfish-actions.pod:2004 ../fish/guestfish-actions.pod:2341 ../src/guestfs-actions.pod:3140 ../src/guestfs-actions.pod:3613
9422 msgid "\"windows\""
9423 msgstr ""
9424
9425 #. type: textblock
9426 #: ../fish/guestfish-actions.pod:2006 ../src/guestfs-actions.pod:3142
9427 msgid ""
9428 "Windows does not have distributions.  This string is returned if the OS type "
9429 "is Windows."
9430 msgstr ""
9431
9432 #. type: textblock
9433 #: ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2090 ../fish/guestfish-actions.pod:2359 ../src/guestfs-actions.pod:3147 ../src/guestfs-actions.pod:3251 ../src/guestfs-actions.pod:3631
9434 msgid ""
9435 "Future versions of libguestfs may return other strings here.  The caller "
9436 "should be prepared to handle any string."
9437 msgstr ""
9438
9439 #. type: =head2
9440 #: ../fish/guestfish-actions.pod:2016
9441 msgid "inspect-get-drive-mappings"
9442 msgstr ""
9443
9444 #. type: verbatim
9445 #: ../fish/guestfish-actions.pod:2018
9446 #, no-wrap
9447 msgid ""
9448 " inspect-get-drive-mappings root\n"
9449 "\n"
9450 msgstr ""
9451
9452 #. type: textblock
9453 #: ../fish/guestfish-actions.pod:2020 ../src/guestfs-actions.pod:3163
9454 msgid ""
9455 "This call is useful for Windows which uses a primitive system of assigning "
9456 "drive letters (like \"C:\") to partitions.  This inspection API examines the "
9457 "Windows Registry to find out how disks/partitions are mapped to drive "
9458 "letters, and returns a hash table as in the example below:"
9459 msgstr ""
9460
9461 #. type: verbatim
9462 #: ../fish/guestfish-actions.pod:2026 ../src/guestfs-actions.pod:3169
9463 #, no-wrap
9464 msgid ""
9465 " C      =>     /dev/vda2\n"
9466 " E      =>     /dev/vdb1\n"
9467 " F      =>     /dev/vdc1\n"
9468 "\n"
9469 msgstr ""
9470
9471 #. type: textblock
9472 #: ../fish/guestfish-actions.pod:2030 ../src/guestfs-actions.pod:3173
9473 msgid ""
9474 "Note that keys are drive letters.  For Windows, the key is case insensitive "
9475 "and just contains the drive letter, without the customary colon separator "
9476 "character."
9477 msgstr ""
9478
9479 #. type: textblock
9480 #: ../fish/guestfish-actions.pod:2034 ../src/guestfs-actions.pod:3177
9481 msgid ""
9482 "In future we may support other operating systems that also used drive "
9483 "letters, but the keys for those might not be case insensitive and might be "
9484 "longer than 1 character.  For example in OS-9, hard drives were named C<h0>, "
9485 "C<h1> etc."
9486 msgstr ""
9487
9488 #. type: textblock
9489 #: ../fish/guestfish-actions.pod:2039 ../src/guestfs-actions.pod:3182
9490 msgid ""
9491 "For Windows guests, currently only hard drive mappings are returned.  "
9492 "Removable disks (eg. DVD-ROMs) are ignored."
9493 msgstr ""
9494
9495 #. type: textblock
9496 #: ../fish/guestfish-actions.pod:2042 ../src/guestfs-actions.pod:3185
9497 msgid ""
9498 "For guests that do not use drive mappings, or if the drive mappings could "
9499 "not be determined, this returns an empty hash table."
9500 msgstr ""
9501
9502 #. type: textblock
9503 #: ../fish/guestfish-actions.pod:2045
9504 msgid ""
9505 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
9506 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
9507 msgstr ""
9508
9509 #. type: =head2
9510 #: ../fish/guestfish-actions.pod:2049
9511 msgid "inspect-get-filesystems"
9512 msgstr ""
9513
9514 #. type: verbatim
9515 #: ../fish/guestfish-actions.pod:2051
9516 #, no-wrap
9517 msgid ""
9518 " inspect-get-filesystems root\n"
9519 "\n"
9520 msgstr ""
9521
9522 #. type: textblock
9523 #: ../fish/guestfish-actions.pod:2053 ../src/guestfs-actions.pod:3206
9524 msgid ""
9525 "This returns a list of all the filesystems that we think are associated with "
9526 "this operating system.  This includes the root filesystem, other ordinary "
9527 "filesystems, and non-mounted devices like swap partitions."
9528 msgstr ""
9529
9530 #. type: textblock
9531 #: ../fish/guestfish-actions.pod:2058 ../src/guestfs-actions.pod:3211
9532 msgid ""
9533 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
9534 "to be shared between operating systems."
9535 msgstr ""
9536
9537 #. type: textblock
9538 #: ../fish/guestfish-actions.pod:2061
9539 msgid ""
9540 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
9541 "L</inspect-get-mountpoints>."
9542 msgstr ""
9543
9544 #. type: =head2
9545 #: ../fish/guestfish-actions.pod:2064
9546 msgid "inspect-get-format"
9547 msgstr ""
9548
9549 #. type: verbatim
9550 #: ../fish/guestfish-actions.pod:2066
9551 #, no-wrap
9552 msgid ""
9553 " inspect-get-format root\n"
9554 "\n"
9555 msgstr ""
9556
9557 #. type: textblock
9558 #: ../fish/guestfish-actions.pod:2068 ../src/guestfs-actions.pod:3229
9559 msgid ""
9560 "This returns the format of the inspected operating system.  You can use it "
9561 "to detect install images, live CDs and similar."
9562 msgstr ""
9563
9564 #. type: textblock
9565 #: ../fish/guestfish-actions.pod:2071 ../src/guestfs-actions.pod:3232
9566 msgid "Currently defined formats are:"
9567 msgstr ""
9568
9569 #. type: =item
9570 #: ../fish/guestfish-actions.pod:2075 ../src/guestfs-actions.pod:3236
9571 msgid "\"installed\""
9572 msgstr ""
9573
9574 #. type: textblock
9575 #: ../fish/guestfish-actions.pod:2077 ../src/guestfs-actions.pod:3238
9576 msgid "This is an installed operating system."
9577 msgstr ""
9578
9579 #. type: =item
9580 #: ../fish/guestfish-actions.pod:2079 ../src/guestfs-actions.pod:3240
9581 msgid "\"installer\""
9582 msgstr ""
9583
9584 #. type: textblock
9585 #: ../fish/guestfish-actions.pod:2081 ../src/guestfs-actions.pod:3242
9586 msgid ""
9587 "The disk image being inspected is not an installed operating system, but a "
9588 "I<bootable> install disk, live CD, or similar."
9589 msgstr ""
9590
9591 #. type: textblock
9592 #: ../fish/guestfish-actions.pod:2086 ../src/guestfs-actions.pod:3247
9593 msgid "The format of this disk image is not known."
9594 msgstr ""
9595
9596 #. type: =head2
9597 #: ../fish/guestfish-actions.pod:2095
9598 msgid "inspect-get-hostname"
9599 msgstr ""
9600
9601 #. type: verbatim
9602 #: ../fish/guestfish-actions.pod:2097
9603 #, no-wrap
9604 msgid ""
9605 " inspect-get-hostname root\n"
9606 "\n"
9607 msgstr ""
9608
9609 #. type: textblock
9610 #: ../fish/guestfish-actions.pod:2099 ../src/guestfs-actions.pod:3267
9611 msgid ""
9612 "This function returns the hostname of the operating system as found by "
9613 "inspection of the guest's configuration files."
9614 msgstr ""
9615
9616 #. type: textblock
9617 #: ../fish/guestfish-actions.pod:2102 ../src/guestfs-actions.pod:3270
9618 msgid ""
9619 "If the hostname could not be determined, then the string C<unknown> is "
9620 "returned."
9621 msgstr ""
9622
9623 #. type: =head2
9624 #: ../fish/guestfish-actions.pod:2107
9625 msgid "inspect-get-icon"
9626 msgstr ""
9627
9628 #. type: verbatim
9629 #: ../fish/guestfish-actions.pod:2109
9630 #, no-wrap
9631 msgid ""
9632 " inspect-get-icon root [favicon:true|false] [highquality:true|false]\n"
9633 "\n"
9634 msgstr ""
9635
9636 #. type: textblock
9637 #: ../fish/guestfish-actions.pod:2111 ../src/guestfs-actions.pod:3296
9638 msgid ""
9639 "This function returns an icon corresponding to the inspected operating "
9640 "system.  The icon is returned as a buffer containing a PNG image (re-encoded "
9641 "to PNG if necessary)."
9642 msgstr ""
9643
9644 #. type: textblock
9645 #: ../fish/guestfish-actions.pod:2115 ../src/guestfs-actions.pod:3300
9646 msgid ""
9647 "If it was not possible to get an icon this function returns a zero-length "
9648 "(non-NULL) buffer.  I<Callers must check for this case>."
9649 msgstr ""
9650
9651 #. type: textblock
9652 #: ../fish/guestfish-actions.pod:2118 ../src/guestfs-actions.pod:3303
9653 msgid ""
9654 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
9655 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
9656 "this file will be returned.  You can disable favicons by passing the "
9657 "optional C<favicon> boolean as false (default is true)."
9658 msgstr ""
9659
9660 #. type: textblock
9661 #: ../fish/guestfish-actions.pod:2124 ../src/guestfs-actions.pod:3309
9662 msgid ""
9663 "If finding the favicon fails, then we look in other places in the guest for "
9664 "a suitable icon."
9665 msgstr ""
9666
9667 #. type: textblock
9668 #: ../fish/guestfish-actions.pod:2127 ../src/guestfs-actions.pod:3312
9669 msgid ""
9670 "If the optional C<highquality> boolean is true then only high quality icons "
9671 "are returned, which means only icons of high resolution with an alpha "
9672 "channel.  The default (false) is to return any icon we can, even if it is of "
9673 "substandard quality."
9674 msgstr ""
9675
9676 #. type: textblock
9677 #: ../fish/guestfish-actions.pod:2138 ../src/guestfs-actions.pod:3323
9678 msgid ""
9679 "Unlike most other inspection API calls, the guest's disks must be mounted up "
9680 "before you call this, since it needs to read information from the guest "
9681 "filesystem during the call."
9682 msgstr ""
9683
9684 #. type: textblock
9685 #: ../fish/guestfish-actions.pod:2144 ../src/guestfs-actions.pod:3329
9686 msgid ""
9687 "B<Security:> The icon data comes from the untrusted guest, and should be "
9688 "treated with caution.  PNG files have been known to contain exploits.  "
9689 "Ensure that libpng (or other relevant libraries) are fully up to date before "
9690 "trying to process or display the icon."
9691 msgstr ""
9692
9693 #. type: textblock
9694 #: ../fish/guestfish-actions.pod:2152 ../src/guestfs-actions.pod:3337
9695 msgid ""
9696 "The PNG image returned can be any size.  It might not be square.  Libguestfs "
9697 "tries to return the largest, highest quality icon available.  The "
9698 "application must scale the icon to the required size."
9699 msgstr ""
9700
9701 #. type: textblock
9702 #: ../fish/guestfish-actions.pod:2159 ../src/guestfs-actions.pod:3344
9703 msgid ""
9704 "Extracting icons from Windows guests requires the external C<wrestool> "
9705 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
9706 "C<pnmtopng>, C<pamcut>)  from the C<netpbm> package.  These must be "
9707 "installed separately."
9708 msgstr ""
9709
9710 #. type: textblock
9711 #: ../fish/guestfish-actions.pod:2166 ../src/guestfs-actions.pod:3351
9712 msgid ""
9713 "Operating system icons are usually trademarks.  Seek legal advice before "
9714 "using trademarks in applications."
9715 msgstr ""
9716
9717 #. type: =head2
9718 #: ../fish/guestfish-actions.pod:2173
9719 msgid "inspect-get-major-version"
9720 msgstr ""
9721
9722 #. type: verbatim
9723 #: ../fish/guestfish-actions.pod:2175
9724 #, no-wrap
9725 msgid ""
9726 " inspect-get-major-version root\n"
9727 "\n"
9728 msgstr ""
9729
9730 #. type: textblock
9731 #: ../fish/guestfish-actions.pod:2177 ../src/guestfs-actions.pod:3392
9732 msgid "This returns the major version number of the inspected operating system."
9733 msgstr ""
9734
9735 #. type: textblock
9736 #: ../fish/guestfish-actions.pod:2180 ../src/guestfs-actions.pod:3395
9737 msgid ""
9738 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
9739 "popular public names used by the operating system.  Notably the operating "
9740 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
9741 "1).  You can find out the real versions corresponding to releases of Windows "
9742 "by consulting Wikipedia or MSDN."
9743 msgstr ""
9744
9745 #. type: textblock
9746 #: ../fish/guestfish-actions.pod:2187 ../fish/guestfish-actions.pod:2198 ../src/guestfs-actions.pod:3402 ../src/guestfs-actions.pod:3419
9747 msgid "If the version could not be determined, then C<0> is returned."
9748 msgstr ""
9749
9750 #. type: =head2
9751 #: ../fish/guestfish-actions.pod:2191
9752 msgid "inspect-get-minor-version"
9753 msgstr ""
9754
9755 #. type: verbatim
9756 #: ../fish/guestfish-actions.pod:2193
9757 #, no-wrap
9758 msgid ""
9759 " inspect-get-minor-version root\n"
9760 "\n"
9761 msgstr ""
9762
9763 #. type: textblock
9764 #: ../fish/guestfish-actions.pod:2195 ../src/guestfs-actions.pod:3416
9765 msgid "This returns the minor version number of the inspected operating system."
9766 msgstr ""
9767
9768 #. type: textblock
9769 #: ../fish/guestfish-actions.pod:2200
9770 msgid ""
9771 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
9772 "L</inspect-get-major-version>."
9773 msgstr ""
9774
9775 #. type: =head2
9776 #: ../fish/guestfish-actions.pod:2203
9777 msgid "inspect-get-mountpoints"
9778 msgstr ""
9779
9780 #. type: verbatim
9781 #: ../fish/guestfish-actions.pod:2205
9782 #, no-wrap
9783 msgid ""
9784 " inspect-get-mountpoints root\n"
9785 "\n"
9786 msgstr ""
9787
9788 #. type: textblock
9789 #: ../fish/guestfish-actions.pod:2207 ../src/guestfs-actions.pod:3434
9790 msgid ""
9791 "This returns a hash of where we think the filesystems associated with this "
9792 "operating system should be mounted.  Callers should note that this is at "
9793 "best an educated guess made by reading configuration files such as "
9794 "C</etc/fstab>.  I<In particular note> that this may return filesystems which "
9795 "are non-existent or not mountable and callers should be prepared to handle "
9796 "or ignore failures if they try to mount them."
9797 msgstr ""
9798
9799 #. type: textblock
9800 #: ../fish/guestfish-actions.pod:2216 ../src/guestfs-actions.pod:3443
9801 msgid ""
9802 "Each element in the returned hashtable has a key which is the path of the "
9803 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9804 "mounted there (eg. C</dev/sda1>)."
9805 msgstr ""
9806
9807 #. type: textblock
9808 #: ../fish/guestfish-actions.pod:2221 ../src/guestfs-actions.pod:3448
9809 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
9810 msgstr ""
9811
9812 #. type: textblock
9813 #: ../fish/guestfish-actions.pod:2224
9814 msgid ""
9815 "For operating systems like Windows which still use drive letters, this call "
9816 "will only return an entry for the first drive \"mounted on\" C</>.  For "
9817 "information about the mapping of drive letters to partitions, see "
9818 "L</inspect-get-drive-mappings>."
9819 msgstr ""
9820
9821 #. type: textblock
9822 #: ../fish/guestfish-actions.pod:2230
9823 msgid ""
9824 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
9825 "L</inspect-get-filesystems>."
9826 msgstr ""
9827
9828 #. type: =head2
9829 #: ../fish/guestfish-actions.pod:2233
9830 msgid "inspect-get-package-format"
9831 msgstr ""
9832
9833 #. type: verbatim
9834 #: ../fish/guestfish-actions.pod:2235
9835 #, no-wrap
9836 msgid ""
9837 " inspect-get-package-format root\n"
9838 "\n"
9839 msgstr ""
9840
9841 #. type: textblock
9842 #: ../fish/guestfish-actions.pod:2237
9843 msgid ""
9844 "This function and L</inspect-get-package-management> return the package "
9845 "format and package management tool used by the inspected operating system.  "
9846 "For example for Fedora these functions would return C<rpm> (package format) "
9847 "and C<yum> (package management)."
9848 msgstr ""
9849
9850 #. type: textblock
9851 #: ../fish/guestfish-actions.pod:2243 ../src/guestfs-actions.pod:3480
9852 msgid ""
9853 "This returns the string C<unknown> if we could not determine the package "
9854 "format I<or> if the operating system does not have a real packaging system "
9855 "(eg. Windows)."
9856 msgstr ""
9857
9858 #. type: textblock
9859 #: ../fish/guestfish-actions.pod:2247 ../src/guestfs-actions.pod:3484
9860 msgid ""
9861 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>, "
9862 "C<pkgsrc>.  Future versions of libguestfs may return other strings."
9863 msgstr ""
9864
9865 #. type: =head2
9866 #: ../fish/guestfish-actions.pod:2253
9867 msgid "inspect-get-package-management"
9868 msgstr ""
9869
9870 #. type: verbatim
9871 #: ../fish/guestfish-actions.pod:2255
9872 #, no-wrap
9873 msgid ""
9874 " inspect-get-package-management root\n"
9875 "\n"
9876 msgstr ""
9877
9878 #. type: textblock
9879 #: ../fish/guestfish-actions.pod:2257
9880 msgid ""
9881 "L</inspect-get-package-format> and this function return the package format "
9882 "and package management tool used by the inspected operating system.  For "
9883 "example for Fedora these functions would return C<rpm> (package format) and "
9884 "C<yum> (package management)."
9885 msgstr ""
9886
9887 #. type: textblock
9888 #: ../fish/guestfish-actions.pod:2263 ../src/guestfs-actions.pod:3507
9889 msgid ""
9890 "This returns the string C<unknown> if we could not determine the package "
9891 "management tool I<or> if the operating system does not have a real packaging "
9892 "system (eg. Windows)."
9893 msgstr ""
9894
9895 #. type: textblock
9896 #: ../fish/guestfish-actions.pod:2267 ../src/guestfs-actions.pod:3511
9897 msgid ""
9898 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9899 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>, C<zypper>.  Future "
9900 "versions of libguestfs may return other strings."
9901 msgstr ""
9902
9903 #. type: =head2
9904 #: ../fish/guestfish-actions.pod:2274
9905 msgid "inspect-get-product-name"
9906 msgstr ""
9907
9908 #. type: verbatim
9909 #: ../fish/guestfish-actions.pod:2276
9910 #, no-wrap
9911 msgid ""
9912 " inspect-get-product-name root\n"
9913 "\n"
9914 msgstr ""
9915
9916 #. type: textblock
9917 #: ../fish/guestfish-actions.pod:2278 ../src/guestfs-actions.pod:3529
9918 msgid ""
9919 "This returns the product name of the inspected operating system.  The "
9920 "product name is generally some freeform string which can be displayed to the "
9921 "user, but should not be parsed by programs."
9922 msgstr ""
9923
9924 #. type: textblock
9925 #: ../fish/guestfish-actions.pod:2283 ../src/guestfs-actions.pod:3534
9926 msgid ""
9927 "If the product name could not be determined, then the string C<unknown> is "
9928 "returned."
9929 msgstr ""
9930
9931 #. type: =head2
9932 #: ../fish/guestfish-actions.pod:2288
9933 msgid "inspect-get-product-variant"
9934 msgstr ""
9935
9936 #. type: verbatim
9937 #: ../fish/guestfish-actions.pod:2290
9938 #, no-wrap
9939 msgid ""
9940 " inspect-get-product-variant root\n"
9941 "\n"
9942 msgstr ""
9943
9944 #. type: textblock
9945 #: ../fish/guestfish-actions.pod:2292 ../src/guestfs-actions.pod:3550
9946 msgid "This returns the product variant of the inspected operating system."
9947 msgstr ""
9948
9949 #. type: textblock
9950 #: ../fish/guestfish-actions.pod:2295 ../src/guestfs-actions.pod:3553
9951 msgid ""
9952 "For Windows guests, this returns the contents of the Registry key "
9953 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
9954 "which is usually a string such as C<Client> or C<Server> (other values are "
9955 "possible).  This can be used to distinguish consumer and enterprise versions "
9956 "of Windows that have the same version number (for example, Windows 7 and "
9957 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
9958 "the latter is C<Server>)."
9959 msgstr ""
9960
9961 #. type: textblock
9962 #: ../fish/guestfish-actions.pod:2304 ../src/guestfs-actions.pod:3562
9963 msgid ""
9964 "For enterprise Linux guests, in future we intend this to return the product "
9965 "variant such as C<Desktop>, C<Server> and so on.  But this is not "
9966 "implemented at present."
9967 msgstr ""
9968
9969 #. type: textblock
9970 #: ../fish/guestfish-actions.pod:2308 ../src/guestfs-actions.pod:3566
9971 msgid ""
9972 "If the product variant could not be determined, then the string C<unknown> "
9973 "is returned."
9974 msgstr ""
9975
9976 #. type: textblock
9977 #: ../fish/guestfish-actions.pod:2311
9978 msgid ""
9979 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
9980 "L</inspect-get-product-name>, L</inspect-get-major-version>."
9981 msgstr ""
9982
9983 #. type: =head2
9984 #: ../fish/guestfish-actions.pod:2315
9985 msgid "inspect-get-roots"
9986 msgstr ""
9987
9988 #. type: verbatim
9989 #: ../fish/guestfish-actions.pod:2317
9990 #, no-wrap
9991 msgid ""
9992 " inspect-get-roots\n"
9993 "\n"
9994 msgstr ""
9995
9996 #. type: textblock
9997 #: ../fish/guestfish-actions.pod:2319
9998 msgid ""
9999 "This function is a convenient way to get the list of root devices, as "
10000 "returned from a previous call to L</inspect-os>, but without redoing the "
10001 "whole inspection process."
10002 msgstr ""
10003
10004 #. type: textblock
10005 #: ../fish/guestfish-actions.pod:2323
10006 msgid ""
10007 "This returns an empty list if either no root devices were found or the "
10008 "caller has not called L</inspect-os>."
10009 msgstr ""
10010
10011 #. type: =head2
10012 #: ../fish/guestfish-actions.pod:2328
10013 msgid "inspect-get-type"
10014 msgstr ""
10015
10016 #. type: verbatim
10017 #: ../fish/guestfish-actions.pod:2330
10018 #, no-wrap
10019 msgid ""
10020 " inspect-get-type root\n"
10021 "\n"
10022 msgstr ""
10023
10024 #. type: textblock
10025 #: ../fish/guestfish-actions.pod:2332 ../src/guestfs-actions.pod:3604
10026 msgid ""
10027 "This returns the type of the inspected operating system.  Currently defined "
10028 "types are:"
10029 msgstr ""
10030
10031 #. type: =item
10032 #: ../fish/guestfish-actions.pod:2337 ../src/guestfs-actions.pod:3609
10033 msgid "\"linux\""
10034 msgstr ""
10035
10036 #. type: textblock
10037 #: ../fish/guestfish-actions.pod:2339 ../src/guestfs-actions.pod:3611
10038 msgid "Any Linux-based operating system."
10039 msgstr ""
10040
10041 #. type: textblock
10042 #: ../fish/guestfish-actions.pod:2343 ../src/guestfs-actions.pod:3615
10043 msgid "Any Microsoft Windows operating system."
10044 msgstr ""
10045
10046 #. type: =item
10047 #: ../fish/guestfish-actions.pod:2345 ../src/guestfs-actions.pod:3617
10048 msgid "\"freebsd\""
10049 msgstr ""
10050
10051 #. type: textblock
10052 #: ../fish/guestfish-actions.pod:2347 ../src/guestfs-actions.pod:3619
10053 msgid "FreeBSD."
10054 msgstr ""
10055
10056 #. type: =item
10057 #: ../fish/guestfish-actions.pod:2349 ../src/guestfs-actions.pod:3621
10058 msgid "\"netbsd\""
10059 msgstr ""
10060
10061 #. type: textblock
10062 #: ../fish/guestfish-actions.pod:2351 ../src/guestfs-actions.pod:3623
10063 msgid "NetBSD."
10064 msgstr ""
10065
10066 #. type: textblock
10067 #: ../fish/guestfish-actions.pod:2355 ../src/guestfs-actions.pod:3627
10068 msgid "The operating system type could not be determined."
10069 msgstr ""
10070
10071 #. type: =head2
10072 #: ../fish/guestfish-actions.pod:2364
10073 msgid "inspect-get-windows-current-control-set"
10074 msgstr ""
10075
10076 #. type: verbatim
10077 #: ../fish/guestfish-actions.pod:2366
10078 #, no-wrap
10079 msgid ""
10080 " inspect-get-windows-current-control-set root\n"
10081 "\n"
10082 msgstr ""
10083
10084 #. type: textblock
10085 #: ../fish/guestfish-actions.pod:2368 ../src/guestfs-actions.pod:3647
10086 msgid ""
10087 "This returns the Windows CurrentControlSet of the inspected guest.  The "
10088 "CurrentControlSet is a registry key name such as C<ControlSet001>."
10089 msgstr ""
10090
10091 #. type: textblock
10092 #: ../fish/guestfish-actions.pod:2371 ../src/guestfs-actions.pod:3650
10093 msgid ""
10094 "This call assumes that the guest is Windows and that the Registry could be "
10095 "examined by inspection.  If this is not the case then an error is returned."
10096 msgstr ""
10097
10098 #. type: =head2
10099 #: ../fish/guestfish-actions.pod:2377
10100 msgid "inspect-get-windows-systemroot"
10101 msgstr ""
10102
10103 #. type: verbatim
10104 #: ../fish/guestfish-actions.pod:2379
10105 #, no-wrap
10106 msgid ""
10107 " inspect-get-windows-systemroot root\n"
10108 "\n"
10109 msgstr ""
10110
10111 #. type: textblock
10112 #: ../fish/guestfish-actions.pod:2381 ../src/guestfs-actions.pod:3667
10113 msgid ""
10114 "This returns the Windows systemroot of the inspected guest.  The systemroot "
10115 "is a directory path such as C</WINDOWS>."
10116 msgstr ""
10117
10118 #. type: textblock
10119 #: ../fish/guestfish-actions.pod:2384 ../src/guestfs-actions.pod:3670
10120 msgid ""
10121 "This call assumes that the guest is Windows and that the systemroot could be "
10122 "determined by inspection.  If this is not the case then an error is "
10123 "returned."
10124 msgstr ""
10125
10126 #. type: =head2
10127 #: ../fish/guestfish-actions.pod:2390
10128 msgid "inspect-is-live"
10129 msgstr ""
10130
10131 #. type: verbatim
10132 #: ../fish/guestfish-actions.pod:2392
10133 #, no-wrap
10134 msgid ""
10135 " inspect-is-live root\n"
10136 "\n"
10137 msgstr ""
10138
10139 #. type: textblock
10140 #: ../fish/guestfish-actions.pod:2394
10141 msgid ""
10142 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
10143 "then this returns true if a live image was detected on the disk."
10144 msgstr ""
10145
10146 #. type: =head2
10147 #: ../fish/guestfish-actions.pod:2400
10148 msgid "inspect-is-multipart"
10149 msgstr ""
10150
10151 #. type: verbatim
10152 #: ../fish/guestfish-actions.pod:2402
10153 #, no-wrap
10154 msgid ""
10155 " inspect-is-multipart root\n"
10156 "\n"
10157 msgstr ""
10158
10159 #. type: textblock
10160 #: ../fish/guestfish-actions.pod:2404
10161 msgid ""
10162 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
10163 "then this returns true if the disk is part of a set."
10164 msgstr ""
10165
10166 #. type: =head2
10167 #: ../fish/guestfish-actions.pod:2410
10168 msgid "inspect-is-netinst"
10169 msgstr ""
10170
10171 #. type: verbatim
10172 #: ../fish/guestfish-actions.pod:2412
10173 #, no-wrap
10174 msgid ""
10175 " inspect-is-netinst root\n"
10176 "\n"
10177 msgstr ""
10178
10179 #. type: textblock
10180 #: ../fish/guestfish-actions.pod:2414
10181 msgid ""
10182 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
10183 "then this returns true if the disk is a network installer, ie. not a "
10184 "self-contained install CD but one which is likely to require network access "
10185 "to complete the install."
10186 msgstr ""
10187
10188 #. type: =head2
10189 #: ../fish/guestfish-actions.pod:2422
10190 msgid "inspect-list-applications"
10191 msgstr ""
10192
10193 #. type: verbatim
10194 #: ../fish/guestfish-actions.pod:2424
10195 #, no-wrap
10196 msgid ""
10197 " inspect-list-applications root\n"
10198 "\n"
10199 msgstr ""
10200
10201 #. type: textblock
10202 #: ../fish/guestfish-actions.pod:2426 ../src/guestfs-actions.pod:3737
10203 msgid "Return the list of applications installed in the operating system."
10204 msgstr ""
10205
10206 #. type: textblock
10207 #: ../fish/guestfish-actions.pod:2428
10208 msgid ""
10209 "I<Note:> This call works differently from other parts of the inspection "
10210 "API.  You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
10211 "then mount up the disks, before calling this.  Listing applications is a "
10212 "significantly more difficult operation which requires access to the full "
10213 "filesystem.  Also note that unlike the other L</inspect-get-*> calls which "
10214 "are just returning data cached in the libguestfs handle, this call actually "
10215 "reads parts of the mounted filesystems during the call."
10216 msgstr ""
10217
10218 #. type: textblock
10219 #: ../fish/guestfish-actions.pod:2438 ../src/guestfs-actions.pod:3749
10220 msgid ""
10221 "This returns an empty list if the inspection code was not able to determine "
10222 "the list of applications."
10223 msgstr ""
10224
10225 #. type: textblock
10226 #: ../fish/guestfish-actions.pod:2441 ../src/guestfs-actions.pod:3752
10227 msgid "The application structure contains the following fields:"
10228 msgstr ""
10229
10230 #. type: =item
10231 #: ../fish/guestfish-actions.pod:2445 ../src/guestfs-actions.pod:3756
10232 msgid "C<app_name>"
10233 msgstr ""
10234
10235 #. type: textblock
10236 #: ../fish/guestfish-actions.pod:2447 ../src/guestfs-actions.pod:3758
10237 msgid ""
10238 "The name of the application.  For Red Hat-derived and Debian-derived Linux "
10239 "guests, this is the package name."
10240 msgstr ""
10241
10242 #. type: =item
10243 #: ../fish/guestfish-actions.pod:2450 ../src/guestfs-actions.pod:3761
10244 msgid "C<app_display_name>"
10245 msgstr ""
10246
10247 #. type: textblock
10248 #: ../fish/guestfish-actions.pod:2452 ../src/guestfs-actions.pod:3763
10249 msgid ""
10250 "The display name of the application, sometimes localized to the install "
10251 "language of the guest operating system."
10252 msgstr ""
10253
10254 #. type: textblock
10255 #: ../fish/guestfish-actions.pod:2455 ../src/guestfs-actions.pod:3766
10256 msgid ""
10257 "If unavailable this is returned as an empty string C<\"\">.  Callers needing "
10258 "to display something can use C<app_name> instead."
10259 msgstr ""
10260
10261 #. type: =item
10262 #: ../fish/guestfish-actions.pod:2458 ../src/guestfs-actions.pod:3769
10263 msgid "C<app_epoch>"
10264 msgstr ""
10265
10266 #. type: textblock
10267 #: ../fish/guestfish-actions.pod:2460 ../src/guestfs-actions.pod:3771
10268 msgid ""
10269 "For package managers which use epochs, this contains the epoch of the "
10270 "package (an integer).  If unavailable, this is returned as C<0>."
10271 msgstr ""
10272
10273 #. type: =item
10274 #: ../fish/guestfish-actions.pod:2463 ../src/guestfs-actions.pod:3774
10275 msgid "C<app_version>"
10276 msgstr ""
10277
10278 #. type: textblock
10279 #: ../fish/guestfish-actions.pod:2465 ../src/guestfs-actions.pod:3776
10280 msgid ""
10281 "The version string of the application or package.  If unavailable this is "
10282 "returned as an empty string C<\"\">."
10283 msgstr ""
10284
10285 #. type: =item
10286 #: ../fish/guestfish-actions.pod:2468 ../src/guestfs-actions.pod:3779
10287 msgid "C<app_release>"
10288 msgstr ""
10289
10290 #. type: textblock
10291 #: ../fish/guestfish-actions.pod:2470 ../src/guestfs-actions.pod:3781
10292 msgid ""
10293 "The release string of the application or package, for package managers that "
10294 "use this.  If unavailable this is returned as an empty string C<\"\">."
10295 msgstr ""
10296
10297 #. type: =item
10298 #: ../fish/guestfish-actions.pod:2474 ../src/guestfs-actions.pod:3785
10299 msgid "C<app_install_path>"
10300 msgstr ""
10301
10302 #. type: textblock
10303 #: ../fish/guestfish-actions.pod:2476 ../src/guestfs-actions.pod:3787
10304 msgid ""
10305 "The installation path of the application (on operating systems such as "
10306 "Windows which use installation paths).  This path is in the format used by "
10307 "the guest operating system, it is not a libguestfs path."
10308 msgstr ""
10309
10310 #. type: textblock
10311 #: ../fish/guestfish-actions.pod:2481 ../src/guestfs-actions.pod:3792
10312 msgid "If unavailable this is returned as an empty string C<\"\">."
10313 msgstr ""
10314
10315 #. type: =item
10316 #: ../fish/guestfish-actions.pod:2483 ../src/guestfs-actions.pod:3794
10317 msgid "C<app_trans_path>"
10318 msgstr ""
10319
10320 #. type: textblock
10321 #: ../fish/guestfish-actions.pod:2485 ../src/guestfs-actions.pod:3796
10322 msgid ""
10323 "The install path translated into a libguestfs path.  If unavailable this is "
10324 "returned as an empty string C<\"\">."
10325 msgstr ""
10326
10327 #. type: =item
10328 #: ../fish/guestfish-actions.pod:2488 ../src/guestfs-actions.pod:3799
10329 msgid "C<app_publisher>"
10330 msgstr ""
10331
10332 #. type: textblock
10333 #: ../fish/guestfish-actions.pod:2490 ../src/guestfs-actions.pod:3801
10334 msgid ""
10335 "The name of the publisher of the application, for package managers that use "
10336 "this.  If unavailable this is returned as an empty string C<\"\">."
10337 msgstr ""
10338
10339 #. type: =item
10340 #: ../fish/guestfish-actions.pod:2494 ../src/guestfs-actions.pod:3805
10341 msgid "C<app_url>"
10342 msgstr ""
10343
10344 #. type: textblock
10345 #: ../fish/guestfish-actions.pod:2496 ../src/guestfs-actions.pod:3807
10346 msgid ""
10347 "The URL (eg. upstream URL) of the application.  If unavailable this is "
10348 "returned as an empty string C<\"\">."
10349 msgstr ""
10350
10351 #. type: =item
10352 #: ../fish/guestfish-actions.pod:2499 ../src/guestfs-actions.pod:3810
10353 msgid "C<app_source_package>"
10354 msgstr ""
10355
10356 #. type: textblock
10357 #: ../fish/guestfish-actions.pod:2501 ../src/guestfs-actions.pod:3812
10358 msgid ""
10359 "For packaging systems which support this, the name of the source package.  "
10360 "If unavailable this is returned as an empty string C<\"\">."
10361 msgstr ""
10362
10363 #. type: =item
10364 #: ../fish/guestfish-actions.pod:2504 ../src/guestfs-actions.pod:3815
10365 msgid "C<app_summary>"
10366 msgstr ""
10367
10368 #. type: textblock
10369 #: ../fish/guestfish-actions.pod:2506 ../src/guestfs-actions.pod:3817
10370 msgid ""
10371 "A short (usually one line) description of the application or package.  If "
10372 "unavailable this is returned as an empty string C<\"\">."
10373 msgstr ""
10374
10375 #. type: =item
10376 #: ../fish/guestfish-actions.pod:2509 ../src/guestfs-actions.pod:3820
10377 msgid "C<app_description>"
10378 msgstr ""
10379
10380 #. type: textblock
10381 #: ../fish/guestfish-actions.pod:2511 ../src/guestfs-actions.pod:3822
10382 msgid ""
10383 "A longer description of the application or package.  If unavailable this is "
10384 "returned as an empty string C<\"\">."
10385 msgstr ""
10386
10387 #. type: =head2
10388 #: ../fish/guestfish-actions.pod:2518
10389 msgid "inspect-os"
10390 msgstr ""
10391
10392 #. type: verbatim
10393 #: ../fish/guestfish-actions.pod:2520
10394 #, no-wrap
10395 msgid ""
10396 " inspect-os\n"
10397 "\n"
10398 msgstr ""
10399
10400 #. type: textblock
10401 #: ../fish/guestfish-actions.pod:2522 ../src/guestfs-actions.pod:3840
10402 msgid ""
10403 "This function uses other libguestfs functions and certain heuristics to "
10404 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10405 "for operating systems."
10406 msgstr ""
10407
10408 #. type: textblock
10409 #: ../fish/guestfish-actions.pod:2526 ../src/guestfs-actions.pod:3844
10410 msgid "The list returned is empty if no operating systems were found."
10411 msgstr ""
10412
10413 #. type: textblock
10414 #: ../fish/guestfish-actions.pod:2528 ../src/guestfs-actions.pod:3846
10415 msgid ""
10416 "If one operating system was found, then this returns a list with a single "
10417 "element, which is the name of the root filesystem of this operating system.  "
10418 "It is also possible for this function to return a list containing more than "
10419 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10420 "element being the root filesystem of one of the operating systems."
10421 msgstr ""
10422
10423 #. type: textblock
10424 #: ../fish/guestfish-actions.pod:2535
10425 msgid ""
10426 "You can pass the root string(s) returned to other L</inspect-get-*> "
10427 "functions in order to query further information about each operating system, "
10428 "such as the name and version."
10429 msgstr ""
10430
10431 #. type: textblock
10432 #: ../fish/guestfish-actions.pod:2540
10433 msgid ""
10434 "This function uses other libguestfs features such as L</mount-ro> and "
10435 "L</umount-all> in order to mount and unmount filesystems and look at the "
10436 "contents.  This should be called with no disks currently mounted.  The "
10437 "function may also use Augeas, so any existing Augeas handle will be closed."
10438 msgstr ""
10439
10440 #. type: textblock
10441 #: ../fish/guestfish-actions.pod:2546 ../src/guestfs-actions.pod:3864
10442 msgid ""
10443 "This function cannot decrypt encrypted disks.  The caller must do that first "
10444 "(supplying the necessary keys) if the disk is encrypted."
10445 msgstr ""
10446
10447 #. type: textblock
10448 #: ../fish/guestfish-actions.pod:2552 ../fish/guestfish-actions.pod:2750 ../fish/guestfish-actions.pod:2809
10449 msgid "See also L</list-filesystems>."
10450 msgstr ""
10451
10452 #. type: =head2
10453 #: ../fish/guestfish-actions.pod:2554
10454 msgid "is-blockdev"
10455 msgstr ""
10456
10457 #. type: verbatim
10458 #: ../fish/guestfish-actions.pod:2556
10459 #, no-wrap
10460 msgid ""
10461 " is-blockdev path\n"
10462 "\n"
10463 msgstr ""
10464
10465 #. type: textblock
10466 #: ../fish/guestfish-actions.pod:2558 ../src/guestfs-actions.pod:3884
10467 msgid ""
10468 "This returns C<true> if and only if there is a block device with the given "
10469 "C<path> name."
10470 msgstr ""
10471
10472 #. type: textblock
10473 #: ../fish/guestfish-actions.pod:2561 ../fish/guestfish-actions.pod:2579 ../fish/guestfish-actions.pod:2598 ../fish/guestfish-actions.pod:2607 ../fish/guestfish-actions.pod:2617 ../fish/guestfish-actions.pod:2651 ../fish/guestfish-actions.pod:2660
10474 msgid "See also L</stat>."
10475 msgstr ""
10476
10477 #. type: =head2
10478 #: ../fish/guestfish-actions.pod:2563
10479 msgid "is-busy"
10480 msgstr ""
10481
10482 #. type: verbatim
10483 #: ../fish/guestfish-actions.pod:2565
10484 #, no-wrap
10485 msgid ""
10486 " is-busy\n"
10487 "\n"
10488 msgstr ""
10489
10490 #. type: textblock
10491 #: ../fish/guestfish-actions.pod:2567 ../src/guestfs-actions.pod:3898
10492 msgid ""
10493 "This returns true iff this handle is busy processing a command (in the "
10494 "C<BUSY> state)."
10495 msgstr ""
10496
10497 #. type: =head2
10498 #: ../fish/guestfish-actions.pod:2572
10499 msgid "is-chardev"
10500 msgstr ""
10501
10502 #. type: verbatim
10503 #: ../fish/guestfish-actions.pod:2574
10504 #, no-wrap
10505 msgid ""
10506 " is-chardev path\n"
10507 "\n"
10508 msgstr ""
10509
10510 #. type: textblock
10511 #: ../fish/guestfish-actions.pod:2576 ../src/guestfs-actions.pod:3913
10512 msgid ""
10513 "This returns C<true> if and only if there is a character device with the "
10514 "given C<path> name."
10515 msgstr ""
10516
10517 #. type: =head2
10518 #: ../fish/guestfish-actions.pod:2581
10519 msgid "is-config"
10520 msgstr ""
10521
10522 #. type: verbatim
10523 #: ../fish/guestfish-actions.pod:2583
10524 #, no-wrap
10525 msgid ""
10526 " is-config\n"
10527 "\n"
10528 msgstr ""
10529
10530 #. type: textblock
10531 #: ../fish/guestfish-actions.pod:2585 ../src/guestfs-actions.pod:3927
10532 msgid ""
10533 "This returns true iff this handle is being configured (in the C<CONFIG> "
10534 "state)."
10535 msgstr ""
10536
10537 #. type: =head2
10538 #: ../fish/guestfish-actions.pod:2590
10539 msgid "is-dir"
10540 msgstr ""
10541
10542 #. type: verbatim
10543 #: ../fish/guestfish-actions.pod:2592
10544 #, no-wrap
10545 msgid ""
10546 " is-dir path\n"
10547 "\n"
10548 msgstr ""
10549
10550 #. type: textblock
10551 #: ../fish/guestfish-actions.pod:2594 ../src/guestfs-actions.pod:3942
10552 msgid ""
10553 "This returns C<true> if and only if there is a directory with the given "
10554 "C<path> name.  Note that it returns false for other objects like files."
10555 msgstr ""
10556
10557 #. type: =head2
10558 #: ../fish/guestfish-actions.pod:2600
10559 msgid "is-fifo"
10560 msgstr ""
10561
10562 #. type: verbatim
10563 #: ../fish/guestfish-actions.pod:2602
10564 #, no-wrap
10565 msgid ""
10566 " is-fifo path\n"
10567 "\n"
10568 msgstr ""
10569
10570 #. type: textblock
10571 #: ../fish/guestfish-actions.pod:2604 ../src/guestfs-actions.pod:3958
10572 msgid ""
10573 "This returns C<true> if and only if there is a FIFO (named pipe)  with the "
10574 "given C<path> name."
10575 msgstr ""
10576
10577 #. type: =head2
10578 #: ../fish/guestfish-actions.pod:2609
10579 msgid "is-file"
10580 msgstr ""
10581
10582 #. type: verbatim
10583 #: ../fish/guestfish-actions.pod:2611
10584 #, no-wrap
10585 msgid ""
10586 " is-file path\n"
10587 "\n"
10588 msgstr ""
10589
10590 #. type: textblock
10591 #: ../fish/guestfish-actions.pod:2613 ../src/guestfs-actions.pod:3973
10592 msgid ""
10593 "This returns C<true> if and only if there is a regular file with the given "
10594 "C<path> name.  Note that it returns false for other objects like "
10595 "directories."
10596 msgstr ""
10597
10598 #. type: =head2
10599 #: ../fish/guestfish-actions.pod:2619
10600 msgid "is-launching"
10601 msgstr ""
10602
10603 #. type: verbatim
10604 #: ../fish/guestfish-actions.pod:2621
10605 #, no-wrap
10606 msgid ""
10607 " is-launching\n"
10608 "\n"
10609 msgstr ""
10610
10611 #. type: textblock
10612 #: ../fish/guestfish-actions.pod:2623 ../src/guestfs-actions.pod:3988
10613 msgid ""
10614 "This returns true iff this handle is launching the subprocess (in the "
10615 "C<LAUNCHING> state)."
10616 msgstr ""
10617
10618 #. type: =head2
10619 #: ../fish/guestfish-actions.pod:2628
10620 msgid "is-lv"
10621 msgstr ""
10622
10623 #. type: verbatim
10624 #: ../fish/guestfish-actions.pod:2630
10625 #, no-wrap
10626 msgid ""
10627 " is-lv device\n"
10628 "\n"
10629 msgstr ""
10630
10631 #. type: textblock
10632 #: ../fish/guestfish-actions.pod:2632 ../src/guestfs-actions.pod:4003
10633 msgid ""
10634 "This command tests whether C<device> is a logical volume, and returns true "
10635 "iff this is the case."
10636 msgstr ""
10637
10638 #. type: =head2
10639 #: ../fish/guestfish-actions.pod:2635
10640 msgid "is-ready"
10641 msgstr ""
10642
10643 #. type: verbatim
10644 #: ../fish/guestfish-actions.pod:2637
10645 #, no-wrap
10646 msgid ""
10647 " is-ready\n"
10648 "\n"
10649 msgstr ""
10650
10651 #. type: textblock
10652 #: ../fish/guestfish-actions.pod:2639 ../src/guestfs-actions.pod:4015
10653 msgid ""
10654 "This returns true iff this handle is ready to accept commands (in the "
10655 "C<READY> state)."
10656 msgstr ""
10657
10658 #. type: =head2
10659 #: ../fish/guestfish-actions.pod:2644
10660 msgid "is-socket"
10661 msgstr ""
10662
10663 #. type: verbatim
10664 #: ../fish/guestfish-actions.pod:2646
10665 #, no-wrap
10666 msgid ""
10667 " is-socket path\n"
10668 "\n"
10669 msgstr ""
10670
10671 #. type: textblock
10672 #: ../fish/guestfish-actions.pod:2648 ../src/guestfs-actions.pod:4030
10673 msgid ""
10674 "This returns C<true> if and only if there is a Unix domain socket with the "
10675 "given C<path> name."
10676 msgstr ""
10677
10678 #. type: =head2
10679 #: ../fish/guestfish-actions.pod:2653
10680 msgid "is-symlink"
10681 msgstr ""
10682
10683 #. type: verbatim
10684 #: ../fish/guestfish-actions.pod:2655
10685 #, no-wrap
10686 msgid ""
10687 " is-symlink path\n"
10688 "\n"
10689 msgstr ""
10690
10691 #. type: textblock
10692 #: ../fish/guestfish-actions.pod:2657 ../src/guestfs-actions.pod:4045
10693 msgid ""
10694 "This returns C<true> if and only if there is a symbolic link with the given "
10695 "C<path> name."
10696 msgstr ""
10697
10698 #. type: =head2
10699 #: ../fish/guestfish-actions.pod:2662
10700 msgid "is-zero"
10701 msgstr ""
10702
10703 #. type: verbatim
10704 #: ../fish/guestfish-actions.pod:2664
10705 #, no-wrap
10706 msgid ""
10707 " is-zero path\n"
10708 "\n"
10709 msgstr ""
10710
10711 #. type: textblock
10712 #: ../fish/guestfish-actions.pod:2666 ../src/guestfs-actions.pod:4060
10713 msgid ""
10714 "This returns true iff the file exists and the file is empty or it contains "
10715 "all zero bytes."
10716 msgstr ""
10717
10718 #. type: =head2
10719 #: ../fish/guestfish-actions.pod:2669
10720 msgid "is-zero-device"
10721 msgstr ""
10722
10723 #. type: verbatim
10724 #: ../fish/guestfish-actions.pod:2671
10725 #, no-wrap
10726 msgid ""
10727 " is-zero-device device\n"
10728 "\n"
10729 msgstr ""
10730
10731 #. type: textblock
10732 #: ../fish/guestfish-actions.pod:2673 ../src/guestfs-actions.pod:4073
10733 msgid "This returns true iff the device exists and contains all zero bytes."
10734 msgstr ""
10735
10736 #. type: textblock
10737 #: ../fish/guestfish-actions.pod:2675 ../src/guestfs-actions.pod:4075
10738 msgid "Note that for large devices this can take a long time to run."
10739 msgstr ""
10740
10741 #. type: =head2
10742 #: ../fish/guestfish-actions.pod:2677
10743 msgid "kill-subprocess"
10744 msgstr ""
10745
10746 #. type: verbatim
10747 #: ../fish/guestfish-actions.pod:2679
10748 #, no-wrap
10749 msgid ""
10750 " kill-subprocess\n"
10751 "\n"
10752 msgstr ""
10753
10754 #. type: textblock
10755 #: ../fish/guestfish-actions.pod:2681 ../src/guestfs-actions.pod:4086
10756 msgid "This kills the qemu subprocess.  You should never need to call this."
10757 msgstr ""
10758
10759 #. type: =head2
10760 #: ../fish/guestfish-actions.pod:2683
10761 msgid "launch"
10762 msgstr ""
10763
10764 #. type: =head2
10765 #: ../fish/guestfish-actions.pod:2685
10766 msgid "run"
10767 msgstr ""
10768
10769 #. type: verbatim
10770 #: ../fish/guestfish-actions.pod:2687
10771 #, no-wrap
10772 msgid ""
10773 " launch\n"
10774 "\n"
10775 msgstr ""
10776
10777 #. type: textblock
10778 #: ../fish/guestfish-actions.pod:2689 ../src/guestfs-actions.pod:4097
10779 msgid ""
10780 "Internally libguestfs is implemented by running a virtual machine using "
10781 "L<qemu(1)>."
10782 msgstr ""
10783
10784 #. type: textblock
10785 #: ../fish/guestfish-actions.pod:2692 ../src/guestfs-actions.pod:4100
10786 msgid ""
10787 "You should call this after configuring the handle (eg. adding drives) but "
10788 "before performing any actions."
10789 msgstr ""
10790
10791 #. type: =head2
10792 #: ../fish/guestfish-actions.pod:2695
10793 msgid "lchown"
10794 msgstr ""
10795
10796 #. type: verbatim
10797 #: ../fish/guestfish-actions.pod:2697
10798 #, no-wrap
10799 msgid ""
10800 " lchown owner group path\n"
10801 "\n"
10802 msgstr ""
10803
10804 #. type: textblock
10805 #: ../fish/guestfish-actions.pod:2699
10806 msgid ""
10807 "Change the file owner to C<owner> and group to C<group>.  This is like "
10808 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
10809 "the target."
10810 msgstr ""
10811
10812 #. type: =head2
10813 #: ../fish/guestfish-actions.pod:2707
10814 msgid "lgetxattr"
10815 msgstr ""
10816
10817 #. type: verbatim
10818 #: ../fish/guestfish-actions.pod:2709
10819 #, no-wrap
10820 msgid ""
10821 " lgetxattr path name\n"
10822 "\n"
10823 msgstr ""
10824
10825 #. type: textblock
10826 #: ../fish/guestfish-actions.pod:2711 ../src/guestfs-actions.pod:4140
10827 msgid ""
10828 "Get a single extended attribute from file C<path> named C<name>.  If C<path> "
10829 "is a symlink, then this call returns an extended attribute from the symlink."
10830 msgstr ""
10831
10832 #. type: textblock
10833 #: ../fish/guestfish-actions.pod:2725
10834 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
10835 msgstr ""
10836
10837 #. type: =head2
10838 #: ../fish/guestfish-actions.pod:2727
10839 msgid "lgetxattrs"
10840 msgstr ""
10841
10842 #. type: verbatim
10843 #: ../fish/guestfish-actions.pod:2729
10844 #, no-wrap
10845 msgid ""
10846 " lgetxattrs path\n"
10847 "\n"
10848 msgstr ""
10849
10850 #. type: textblock
10851 #: ../fish/guestfish-actions.pod:2731
10852 msgid ""
10853 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
10854 "it returns the extended attributes of the link itself."
10855 msgstr ""
10856
10857 #. type: =head2
10858 #: ../fish/guestfish-actions.pod:2735
10859 msgid "list-9p"
10860 msgstr ""
10861
10862 #. type: verbatim
10863 #: ../fish/guestfish-actions.pod:2737
10864 #, no-wrap
10865 msgid ""
10866 " list-9p\n"
10867 "\n"
10868 msgstr ""
10869
10870 #. type: textblock
10871 #: ../fish/guestfish-actions.pod:2739 ../src/guestfs-actions.pod:4183
10872 msgid ""
10873 "List all 9p filesystems attached to the guest.  A list of mount tags is "
10874 "returned."
10875 msgstr ""
10876
10877 #. type: =head2
10878 #: ../fish/guestfish-actions.pod:2742
10879 msgid "list-devices"
10880 msgstr ""
10881
10882 #. type: verbatim
10883 #: ../fish/guestfish-actions.pod:2744
10884 #, no-wrap
10885 msgid ""
10886 " list-devices\n"
10887 "\n"
10888 msgstr ""
10889
10890 #. type: textblock
10891 #: ../fish/guestfish-actions.pod:2746 ../src/guestfs-actions.pod:4197
10892 msgid "List all the block devices."
10893 msgstr ""
10894
10895 #. type: textblock
10896 #: ../fish/guestfish-actions.pod:2748 ../src/guestfs-actions.pod:4199
10897 msgid "The full block device names are returned, eg. C</dev/sda>."
10898 msgstr ""
10899
10900 #. type: =head2
10901 #: ../fish/guestfish-actions.pod:2752
10902 msgid "list-dm-devices"
10903 msgstr ""
10904
10905 #. type: verbatim
10906 #: ../fish/guestfish-actions.pod:2754
10907 #, no-wrap
10908 msgid ""
10909 " list-dm-devices\n"
10910 "\n"
10911 msgstr ""
10912
10913 #. type: textblock
10914 #: ../fish/guestfish-actions.pod:2756 ../src/guestfs-actions.pod:4214
10915 msgid "List all device mapper devices."
10916 msgstr ""
10917
10918 #. type: textblock
10919 #: ../fish/guestfish-actions.pod:2758
10920 msgid ""
10921 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
10922 "previous call to L</luks-open>."
10923 msgstr ""
10924
10925 #. type: textblock
10926 #: ../fish/guestfish-actions.pod:2761
10927 msgid ""
10928 "Device mapper devices which correspond to logical volumes are I<not> "
10929 "returned in this list.  Call L</lvs> if you want to list logical volumes."
10930 msgstr ""
10931
10932 #. type: =head2
10933 #: ../fish/guestfish-actions.pod:2765
10934 msgid "list-filesystems"
10935 msgstr ""
10936
10937 #. type: verbatim
10938 #: ../fish/guestfish-actions.pod:2767
10939 #, no-wrap
10940 msgid ""
10941 " list-filesystems\n"
10942 "\n"
10943 msgstr ""
10944
10945 #. type: textblock
10946 #: ../fish/guestfish-actions.pod:2769 ../src/guestfs-actions.pod:4234
10947 msgid ""
10948 "This inspection command looks for filesystems on partitions, block devices "
10949 "and logical volumes, returning a list of devices containing filesystems and "
10950 "their type."
10951 msgstr ""
10952
10953 #. type: textblock
10954 #: ../fish/guestfish-actions.pod:2773 ../src/guestfs-actions.pod:4238
10955 msgid ""
10956 "The return value is a hash, where the keys are the devices containing "
10957 "filesystems, and the values are the filesystem types.  For example:"
10958 msgstr ""
10959
10960 #. type: verbatim
10961 #: ../fish/guestfish-actions.pod:2777 ../src/guestfs-actions.pod:4242
10962 #, no-wrap
10963 msgid ""
10964 " \"/dev/sda1\" => \"ntfs\"\n"
10965 " \"/dev/sda2\" => \"ext2\"\n"
10966 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10967 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10968 "\n"
10969 msgstr ""
10970
10971 #. type: textblock
10972 #: ../fish/guestfish-actions.pod:2782 ../src/guestfs-actions.pod:4247
10973 msgid ""
10974 "The value can have the special value \"unknown\", meaning the content of the "
10975 "device is undetermined or empty.  \"swap\" means a Linux swap partition."
10976 msgstr ""
10977
10978 #. type: textblock
10979 #: ../fish/guestfish-actions.pod:2786
10980 msgid ""
10981 "This command runs other libguestfs commands, which might include L</mount> "
10982 "and L</umount>, and therefore you should use this soon after launch and only "
10983 "when nothing is mounted."
10984 msgstr ""
10985
10986 #. type: textblock
10987 #: ../fish/guestfish-actions.pod:2790
10988 msgid ""
10989 "Not all of the filesystems returned will be mountable.  In particular, swap "
10990 "partitions are returned in the list.  Also this command does not check that "
10991 "each filesystem found is valid and mountable, and some filesystems might be "
10992 "mountable but require special options.  Filesystems may not all belong to a "
10993 "single logical operating system (use L</inspect-os> to look for OSes)."
10994 msgstr ""
10995
10996 #. type: =head2
10997 #: ../fish/guestfish-actions.pod:2798
10998 msgid "list-partitions"
10999 msgstr ""
11000
11001 #. type: verbatim
11002 #: ../fish/guestfish-actions.pod:2800
11003 #, no-wrap
11004 msgid ""
11005 " list-partitions\n"
11006 "\n"
11007 msgstr ""
11008
11009 #. type: textblock
11010 #: ../fish/guestfish-actions.pod:2802 ../src/guestfs-actions.pod:4276
11011 msgid "List all the partitions detected on all block devices."
11012 msgstr ""
11013
11014 #. type: textblock
11015 #: ../fish/guestfish-actions.pod:2804 ../src/guestfs-actions.pod:4278
11016 msgid "The full partition device names are returned, eg. C</dev/sda1>"
11017 msgstr ""
11018
11019 #. type: textblock
11020 #: ../fish/guestfish-actions.pod:2806
11021 msgid ""
11022 "This does not return logical volumes.  For that you will need to call "
11023 "L</lvs>."
11024 msgstr ""
11025
11026 #. type: =head2
11027 #: ../fish/guestfish-actions.pod:2811
11028 msgid "ll"
11029 msgstr ""
11030
11031 #. type: verbatim
11032 #: ../fish/guestfish-actions.pod:2813
11033 #, no-wrap
11034 msgid ""
11035 " ll directory\n"
11036 "\n"
11037 msgstr ""
11038
11039 #. type: textblock
11040 #: ../fish/guestfish-actions.pod:2815 ../src/guestfs-actions.pod:4297
11041 msgid ""
11042 "List the files in C<directory> (relative to the root directory, there is no "
11043 "cwd) in the format of 'ls -la'."
11044 msgstr ""
11045
11046 #. type: textblock
11047 #: ../fish/guestfish-actions.pod:2818 ../src/guestfs-actions.pod:4300
11048 msgid ""
11049 "This command is mostly useful for interactive sessions.  It is I<not> "
11050 "intended that you try to parse the output string."
11051 msgstr ""
11052
11053 #. type: =head2
11054 #: ../fish/guestfish-actions.pod:2821
11055 msgid "ln"
11056 msgstr ""
11057
11058 #. type: verbatim
11059 #: ../fish/guestfish-actions.pod:2823
11060 #, no-wrap
11061 msgid ""
11062 " ln target linkname\n"
11063 "\n"
11064 msgstr ""
11065
11066 #. type: textblock
11067 #: ../fish/guestfish-actions.pod:2825 ../src/guestfs-actions.pod:4315
11068 msgid "This command creates a hard link using the C<ln> command."
11069 msgstr ""
11070
11071 #. type: =head2
11072 #: ../fish/guestfish-actions.pod:2827
11073 msgid "ln-f"
11074 msgstr ""
11075
11076 #. type: verbatim
11077 #: ../fish/guestfish-actions.pod:2829
11078 #, no-wrap
11079 msgid ""
11080 " ln-f target linkname\n"
11081 "\n"
11082 msgstr ""
11083
11084 #. type: textblock
11085 #: ../fish/guestfish-actions.pod:2831 ../src/guestfs-actions.pod:4328
11086 msgid ""
11087 "This command creates a hard link using the C<ln -f> command.  The I<-f> "
11088 "option removes the link (C<linkname>) if it exists already."
11089 msgstr ""
11090
11091 #. type: =head2
11092 #: ../fish/guestfish-actions.pod:2834
11093 msgid "ln-s"
11094 msgstr ""
11095
11096 #. type: verbatim
11097 #: ../fish/guestfish-actions.pod:2836
11098 #, no-wrap
11099 msgid ""
11100 " ln-s target linkname\n"
11101 "\n"
11102 msgstr ""
11103
11104 #. type: textblock
11105 #: ../fish/guestfish-actions.pod:2838 ../src/guestfs-actions.pod:4342
11106 msgid "This command creates a symbolic link using the C<ln -s> command."
11107 msgstr ""
11108
11109 #. type: =head2
11110 #: ../fish/guestfish-actions.pod:2840
11111 msgid "ln-sf"
11112 msgstr ""
11113
11114 #. type: verbatim
11115 #: ../fish/guestfish-actions.pod:2842
11116 #, no-wrap
11117 msgid ""
11118 " ln-sf target linkname\n"
11119 "\n"
11120 msgstr ""
11121
11122 #. type: textblock
11123 #: ../fish/guestfish-actions.pod:2844 ../src/guestfs-actions.pod:4355
11124 msgid ""
11125 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
11126 "option removes the link (C<linkname>) if it exists already."
11127 msgstr ""
11128
11129 #. type: =head2
11130 #: ../fish/guestfish-actions.pod:2847
11131 msgid "lremovexattr"
11132 msgstr ""
11133
11134 #. type: verbatim
11135 #: ../fish/guestfish-actions.pod:2849
11136 #, no-wrap
11137 msgid ""
11138 " lremovexattr xattr path\n"
11139 "\n"
11140 msgstr ""
11141
11142 #. type: textblock
11143 #: ../fish/guestfish-actions.pod:2851
11144 msgid ""
11145 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
11146 "it removes an extended attribute of the link itself."
11147 msgstr ""
11148
11149 #. type: =head2
11150 #: ../fish/guestfish-actions.pod:2855
11151 msgid "ls"
11152 msgstr ""
11153
11154 #. type: verbatim
11155 #: ../fish/guestfish-actions.pod:2857
11156 #, no-wrap
11157 msgid ""
11158 " ls directory\n"
11159 "\n"
11160 msgstr ""
11161
11162 #. type: textblock
11163 #: ../fish/guestfish-actions.pod:2859 ../src/guestfs-actions.pod:4383
11164 msgid ""
11165 "List the files in C<directory> (relative to the root directory, there is no "
11166 "cwd).  The '.' and '..' entries are not returned, but hidden files are "
11167 "shown."
11168 msgstr ""
11169
11170 #. type: textblock
11171 #: ../fish/guestfish-actions.pod:2863
11172 msgid ""
11173 "This command is mostly useful for interactive sessions.  Programs should "
11174 "probably use L</readdir> instead."
11175 msgstr ""
11176
11177 #. type: =head2
11178 #: ../fish/guestfish-actions.pod:2866
11179 msgid "lsetxattr"
11180 msgstr ""
11181
11182 #. type: verbatim
11183 #: ../fish/guestfish-actions.pod:2868
11184 #, no-wrap
11185 msgid ""
11186 " lsetxattr xattr val vallen path\n"
11187 "\n"
11188 msgstr ""
11189
11190 #. type: textblock
11191 #: ../fish/guestfish-actions.pod:2870
11192 msgid ""
11193 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
11194 "sets an extended attribute of the link itself."
11195 msgstr ""
11196
11197 #. type: =head2
11198 #: ../fish/guestfish-actions.pod:2874
11199 msgid "lstat"
11200 msgstr ""
11201
11202 #. type: verbatim
11203 #: ../fish/guestfish-actions.pod:2876
11204 #, no-wrap
11205 msgid ""
11206 " lstat path\n"
11207 "\n"
11208 msgstr ""
11209
11210 #. type: textblock
11211 #: ../fish/guestfish-actions.pod:2878 ../fish/guestfish-actions.pod:4678 ../src/guestfs-actions.pod:4419 ../src/guestfs-actions.pod:7200
11212 msgid "Returns file information for the given C<path>."
11213 msgstr ""
11214
11215 #. type: textblock
11216 #: ../fish/guestfish-actions.pod:2880
11217 msgid ""
11218 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
11219 "the link is stat-ed, not the file it refers to."
11220 msgstr ""
11221
11222 #. type: textblock
11223 #: ../fish/guestfish-actions.pod:2884 ../src/guestfs-actions.pod:4425
11224 msgid "This is the same as the C<lstat(2)> system call."
11225 msgstr ""
11226
11227 #. type: =head2
11228 #: ../fish/guestfish-actions.pod:2886
11229 msgid "lstatlist"
11230 msgstr ""
11231
11232 #. type: verbatim
11233 #: ../fish/guestfish-actions.pod:2888
11234 #, no-wrap
11235 msgid ""
11236 " lstatlist path 'names ...'\n"
11237 "\n"
11238 msgstr ""
11239
11240 #. type: textblock
11241 #: ../fish/guestfish-actions.pod:2890
11242 msgid ""
11243 "This call allows you to perform the L</lstat> operation on multiple files, "
11244 "where all files are in the directory C<path>.  C<names> is the list of files "
11245 "from this directory."
11246 msgstr ""
11247
11248 #. type: textblock
11249 #: ../fish/guestfish-actions.pod:2894 ../src/guestfs-actions.pod:4444
11250 msgid ""
11251 "On return you get a list of stat structs, with a one-to-one correspondence "
11252 "to the C<names> list.  If any name did not exist or could not be lstat'd, "
11253 "then the C<ino> field of that structure is set to C<-1>."
11254 msgstr ""
11255
11256 #. type: textblock
11257 #: ../fish/guestfish-actions.pod:2899
11258 msgid ""
11259 "This call is intended for programs that want to efficiently list a directory "
11260 "contents without making many round-trips.  See also L</lxattrlist> for a "
11261 "similarly efficient call for getting extended attributes.  Very long "
11262 "directory listings might cause the protocol message size to be exceeded, "
11263 "causing this call to fail.  The caller must split up such requests into "
11264 "smaller groups of names."
11265 msgstr ""
11266
11267 #. type: =head2
11268 #: ../fish/guestfish-actions.pod:2907
11269 msgid "luks-add-key"
11270 msgstr ""
11271
11272 #. type: verbatim
11273 #: ../fish/guestfish-actions.pod:2909
11274 #, no-wrap
11275 msgid ""
11276 " luks-add-key device keyslot\n"
11277 "\n"
11278 msgstr ""
11279
11280 #. type: textblock
11281 #: ../fish/guestfish-actions.pod:2911 ../src/guestfs-actions.pod:4472
11282 msgid ""
11283 "This command adds a new key on LUKS device C<device>.  C<key> is any "
11284 "existing key, and is used to access the device.  C<newkey> is the new key to "
11285 "add.  C<keyslot> is the key slot that will be replaced."
11286 msgstr ""
11287
11288 #. type: textblock
11289 #: ../fish/guestfish-actions.pod:2916
11290 msgid ""
11291 "Note that if C<keyslot> already contains a key, then this command will "
11292 "fail.  You have to use L</luks-kill-slot> first to remove that key."
11293 msgstr ""
11294
11295 #. type: textblock
11296 #: ../fish/guestfish-actions.pod:2920 ../fish/guestfish-actions.pod:2942 ../fish/guestfish-actions.pod:2952 ../fish/guestfish-actions.pod:2963 ../fish/guestfish-actions.pod:2989 ../fish/guestfish-actions.pod:2999
11297 msgid ""
11298 "This command has one or more key or passphrase parameters.  Guestfish will "
11299 "prompt for these separately."
11300 msgstr ""
11301
11302 #. type: =head2
11303 #: ../fish/guestfish-actions.pod:2923
11304 msgid "luks-close"
11305 msgstr ""
11306
11307 #. type: verbatim
11308 #: ../fish/guestfish-actions.pod:2925
11309 #, no-wrap
11310 msgid ""
11311 " luks-close device\n"
11312 "\n"
11313 msgstr ""
11314
11315 #. type: textblock
11316 #: ../fish/guestfish-actions.pod:2927
11317 msgid ""
11318 "This closes a LUKS device that was created earlier by L</luks-open> or "
11319 "L</luks-open-ro>.  The C<device> parameter must be the name of the LUKS "
11320 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
11321 "underlying block device."
11322 msgstr ""
11323
11324 #. type: =head2
11325 #: ../fish/guestfish-actions.pod:2933
11326 msgid "luks-format"
11327 msgstr ""
11328
11329 #. type: verbatim
11330 #: ../fish/guestfish-actions.pod:2935
11331 #, no-wrap
11332 msgid ""
11333 " luks-format device keyslot\n"
11334 "\n"
11335 msgstr ""
11336
11337 #. type: textblock
11338 #: ../fish/guestfish-actions.pod:2937 ../src/guestfs-actions.pod:4513
11339 msgid ""
11340 "This command erases existing data on C<device> and formats the device as a "
11341 "LUKS encrypted device.  C<key> is the initial key, which is added to key "
11342 "slot C<slot>.  (LUKS supports 8 key slots, numbered 0-7)."
11343 msgstr ""
11344
11345 #. type: =head2
11346 #: ../fish/guestfish-actions.pod:2945
11347 msgid "luks-format-cipher"
11348 msgstr ""
11349
11350 #. type: verbatim
11351 #: ../fish/guestfish-actions.pod:2947
11352 #, no-wrap
11353 msgid ""
11354 " luks-format-cipher device keyslot cipher\n"
11355 "\n"
11356 msgstr ""
11357
11358 #. type: textblock
11359 #: ../fish/guestfish-actions.pod:2949
11360 msgid ""
11361 "This command is the same as L</luks-format> but it also allows you to set "
11362 "the C<cipher> used."
11363 msgstr ""
11364
11365 #. type: =head2
11366 #: ../fish/guestfish-actions.pod:2955
11367 msgid "luks-kill-slot"
11368 msgstr ""
11369
11370 #. type: verbatim
11371 #: ../fish/guestfish-actions.pod:2957
11372 #, no-wrap
11373 msgid ""
11374 " luks-kill-slot device keyslot\n"
11375 "\n"
11376 msgstr ""
11377
11378 #. type: textblock
11379 #: ../fish/guestfish-actions.pod:2959 ../src/guestfs-actions.pod:4554
11380 msgid ""
11381 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11382 "device C<device>.  C<key> must be one of the I<other> keys."
11383 msgstr ""
11384
11385 #. type: =head2
11386 #: ../fish/guestfish-actions.pod:2966
11387 msgid "luks-open"
11388 msgstr ""
11389
11390 #. type: verbatim
11391 #: ../fish/guestfish-actions.pod:2968
11392 #, no-wrap
11393 msgid ""
11394 " luks-open device mapname\n"
11395 "\n"
11396 msgstr ""
11397
11398 #. type: textblock
11399 #: ../fish/guestfish-actions.pod:2970 ../src/guestfs-actions.pod:4574
11400 msgid ""
11401 "This command opens a block device which has been encrypted according to the "
11402 "Linux Unified Key Setup (LUKS) standard."
11403 msgstr ""
11404
11405 #. type: textblock
11406 #: ../fish/guestfish-actions.pod:2973 ../src/guestfs-actions.pod:4577
11407 msgid "C<device> is the encrypted block device or partition."
11408 msgstr ""
11409
11410 #. type: textblock
11411 #: ../fish/guestfish-actions.pod:2975 ../src/guestfs-actions.pod:4579
11412 msgid ""
11413 "The caller must supply one of the keys associated with the LUKS block "
11414 "device, in the C<key> parameter."
11415 msgstr ""
11416
11417 #. type: textblock
11418 #: ../fish/guestfish-actions.pod:2978 ../src/guestfs-actions.pod:4582
11419 msgid ""
11420 "This creates a new block device called C</dev/mapper/mapname>.  Reads and "
11421 "writes to this block device are decrypted from and encrypted to the "
11422 "underlying C<device> respectively."
11423 msgstr ""
11424
11425 #. type: textblock
11426 #: ../fish/guestfish-actions.pod:2982
11427 msgid ""
11428 "If this block device contains LVM volume groups, then calling L</vgscan> "
11429 "followed by L</vg-activate-all> will make them visible."
11430 msgstr ""
11431
11432 #. type: textblock
11433 #: ../fish/guestfish-actions.pod:2986
11434 msgid "Use L</list-dm-devices> to list all device mapper devices."
11435 msgstr ""
11436
11437 #. type: =head2
11438 #: ../fish/guestfish-actions.pod:2992
11439 msgid "luks-open-ro"
11440 msgstr ""
11441
11442 #. type: verbatim
11443 #: ../fish/guestfish-actions.pod:2994
11444 #, no-wrap
11445 msgid ""
11446 " luks-open-ro device mapname\n"
11447 "\n"
11448 msgstr ""
11449
11450 #. type: textblock
11451 #: ../fish/guestfish-actions.pod:2996
11452 msgid ""
11453 "This is the same as L</luks-open> except that a read-only mapping is "
11454 "created."
11455 msgstr ""
11456
11457 #. type: =head2
11458 #: ../fish/guestfish-actions.pod:3002
11459 msgid "lvcreate"
11460 msgstr ""
11461
11462 #. type: verbatim
11463 #: ../fish/guestfish-actions.pod:3004
11464 #, no-wrap
11465 msgid ""
11466 " lvcreate logvol volgroup mbytes\n"
11467 "\n"
11468 msgstr ""
11469
11470 #. type: textblock
11471 #: ../fish/guestfish-actions.pod:3006 ../src/guestfs-actions.pod:4628
11472 msgid ""
11473 "This creates an LVM logical volume called C<logvol> on the volume group "
11474 "C<volgroup>, with C<size> megabytes."
11475 msgstr ""
11476
11477 #. type: =head2
11478 #: ../fish/guestfish-actions.pod:3009
11479 msgid "lvm-canonical-lv-name"
11480 msgstr ""
11481
11482 #. type: verbatim
11483 #: ../fish/guestfish-actions.pod:3011
11484 #, no-wrap
11485 msgid ""
11486 " lvm-canonical-lv-name lvname\n"
11487 "\n"
11488 msgstr ""
11489
11490 #. type: textblock
11491 #: ../fish/guestfish-actions.pod:3013 ../src/guestfs-actions.pod:4641
11492 msgid ""
11493 "This converts alternative naming schemes for LVs that you might find to the "
11494 "canonical name.  For example, C</dev/mapper/VG-LV> is converted to "
11495 "C</dev/VG/LV>."
11496 msgstr ""
11497
11498 #. type: textblock
11499 #: ../fish/guestfish-actions.pod:3017 ../src/guestfs-actions.pod:4645
11500 msgid ""
11501 "This command returns an error if the C<lvname> parameter does not refer to a "
11502 "logical volume."
11503 msgstr ""
11504
11505 #. type: textblock
11506 #: ../fish/guestfish-actions.pod:3020
11507 msgid "See also L</is-lv>."
11508 msgstr ""
11509
11510 #. type: =head2
11511 #: ../fish/guestfish-actions.pod:3022
11512 msgid "lvm-clear-filter"
11513 msgstr ""
11514
11515 #. type: verbatim
11516 #: ../fish/guestfish-actions.pod:3024
11517 #, no-wrap
11518 msgid ""
11519 " lvm-clear-filter\n"
11520 "\n"
11521 msgstr ""
11522
11523 #. type: textblock
11524 #: ../fish/guestfish-actions.pod:3026
11525 msgid ""
11526 "This undoes the effect of L</lvm-set-filter>.  LVM will be able to see every "
11527 "block device."
11528 msgstr ""
11529
11530 #. type: textblock
11531 #: ../fish/guestfish-actions.pod:3029 ../fish/guestfish-actions.pod:3057 ../src/guestfs-actions.pod:4663 ../src/guestfs-actions.pod:4702
11532 msgid "This command also clears the LVM cache and performs a volume group scan."
11533 msgstr ""
11534
11535 #. type: =head2
11536 #: ../fish/guestfish-actions.pod:3032
11537 msgid "lvm-remove-all"
11538 msgstr ""
11539
11540 #. type: verbatim
11541 #: ../fish/guestfish-actions.pod:3034
11542 #, no-wrap
11543 msgid ""
11544 " lvm-remove-all\n"
11545 "\n"
11546 msgstr ""
11547
11548 #. type: textblock
11549 #: ../fish/guestfish-actions.pod:3036 ../src/guestfs-actions.pod:4675
11550 msgid ""
11551 "This command removes all LVM logical volumes, volume groups and physical "
11552 "volumes."
11553 msgstr ""
11554
11555 #. type: =head2
11556 #: ../fish/guestfish-actions.pod:3039
11557 msgid "lvm-set-filter"
11558 msgstr ""
11559
11560 #. type: verbatim
11561 #: ../fish/guestfish-actions.pod:3041
11562 #, no-wrap
11563 msgid ""
11564 " lvm-set-filter 'devices ...'\n"
11565 "\n"
11566 msgstr ""
11567
11568 #. type: textblock
11569 #: ../fish/guestfish-actions.pod:3043 ../src/guestfs-actions.pod:4688
11570 msgid ""
11571 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
11572 "block devices in the list C<devices>, and will ignore all other attached "
11573 "block devices."
11574 msgstr ""
11575
11576 #. type: textblock
11577 #: ../fish/guestfish-actions.pod:3047 ../src/guestfs-actions.pod:4692
11578 msgid ""
11579 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
11580 "get LVM to ignore the duplicates, otherwise LVM can get confused.  Note also "
11581 "there are two types of duplication possible: either cloned PVs/VGs which "
11582 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
11583 "same name.  In normal operation you cannot create this situation, but you "
11584 "can do it outside LVM, eg.  by cloning disk images or by bit twiddling "
11585 "inside the LVM metadata."
11586 msgstr ""
11587
11588 #. type: textblock
11589 #: ../fish/guestfish-actions.pod:3060 ../src/guestfs-actions.pod:4705
11590 msgid "You can filter whole block devices or individual partitions."
11591 msgstr ""
11592
11593 #. type: textblock
11594 #: ../fish/guestfish-actions.pod:3062 ../src/guestfs-actions.pod:4707
11595 msgid ""
11596 "You cannot use this if any VG is currently in use (eg.  contains a mounted "
11597 "filesystem), even if you are not filtering out that VG."
11598 msgstr ""
11599
11600 #. type: =head2
11601 #: ../fish/guestfish-actions.pod:3066
11602 msgid "lvremove"
11603 msgstr ""
11604
11605 #. type: verbatim
11606 #: ../fish/guestfish-actions.pod:3068
11607 #, no-wrap
11608 msgid ""
11609 " lvremove device\n"
11610 "\n"
11611 msgstr ""
11612
11613 #. type: textblock
11614 #: ../fish/guestfish-actions.pod:3070 ../src/guestfs-actions.pod:4721
11615 msgid ""
11616 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
11617 "LV, such as C</dev/VG/LV>."
11618 msgstr ""
11619
11620 #. type: textblock
11621 #: ../fish/guestfish-actions.pod:3073 ../src/guestfs-actions.pod:4724
11622 msgid ""
11623 "You can also remove all LVs in a volume group by specifying the VG name, "
11624 "C</dev/VG>."
11625 msgstr ""
11626
11627 #. type: =head2
11628 #: ../fish/guestfish-actions.pod:3076
11629 msgid "lvrename"
11630 msgstr ""
11631
11632 #. type: verbatim
11633 #: ../fish/guestfish-actions.pod:3078
11634 #, no-wrap
11635 msgid ""
11636 " lvrename logvol newlogvol\n"
11637 "\n"
11638 msgstr ""
11639
11640 #. type: textblock
11641 #: ../fish/guestfish-actions.pod:3080 ../src/guestfs-actions.pod:4738
11642 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
11643 msgstr ""
11644
11645 #. type: =head2
11646 #: ../fish/guestfish-actions.pod:3082
11647 msgid "lvresize"
11648 msgstr ""
11649
11650 #. type: verbatim
11651 #: ../fish/guestfish-actions.pod:3084
11652 #, no-wrap
11653 msgid ""
11654 " lvresize device mbytes\n"
11655 "\n"
11656 msgstr ""
11657
11658 #. type: textblock
11659 #: ../fish/guestfish-actions.pod:3086 ../src/guestfs-actions.pod:4751
11660 msgid ""
11661 "This resizes (expands or shrinks) an existing LVM logical volume to "
11662 "C<mbytes>.  When reducing, data in the reduced part is lost."
11663 msgstr ""
11664
11665 #. type: =head2
11666 #: ../fish/guestfish-actions.pod:3090
11667 msgid "lvresize-free"
11668 msgstr ""
11669
11670 #. type: verbatim
11671 #: ../fish/guestfish-actions.pod:3092
11672 #, no-wrap
11673 msgid ""
11674 " lvresize-free lv percent\n"
11675 "\n"
11676 msgstr ""
11677
11678 #. type: textblock
11679 #: ../fish/guestfish-actions.pod:3094 ../src/guestfs-actions.pod:4766
11680 msgid ""
11681 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
11682 "remaining free space in the volume group.  Commonly you would call this with "
11683 "pc = 100 which expands the logical volume as much as possible, using all "
11684 "remaining free space in the volume group."
11685 msgstr ""
11686
11687 #. type: =head2
11688 #: ../fish/guestfish-actions.pod:3100
11689 msgid "lvs"
11690 msgstr ""
11691
11692 #. type: verbatim
11693 #: ../fish/guestfish-actions.pod:3102
11694 #, no-wrap
11695 msgid ""
11696 " lvs\n"
11697 "\n"
11698 msgstr ""
11699
11700 #. type: textblock
11701 #: ../fish/guestfish-actions.pod:3104 ../src/guestfs-actions.pod:4781
11702 msgid ""
11703 "List all the logical volumes detected.  This is the equivalent of the "
11704 "L<lvs(8)> command."
11705 msgstr ""
11706
11707 #. type: textblock
11708 #: ../fish/guestfish-actions.pod:3107 ../src/guestfs-actions.pod:4784
11709 msgid ""
11710 "This returns a list of the logical volume device names "
11711 "(eg. C</dev/VolGroup00/LogVol00>)."
11712 msgstr ""
11713
11714 #. type: textblock
11715 #: ../fish/guestfish-actions.pod:3110
11716 msgid "See also L</lvs-full>, L</list-filesystems>."
11717 msgstr ""
11718
11719 #. type: =head2
11720 #: ../fish/guestfish-actions.pod:3112
11721 msgid "lvs-full"
11722 msgstr ""
11723
11724 #. type: verbatim
11725 #: ../fish/guestfish-actions.pod:3114
11726 #, no-wrap
11727 msgid ""
11728 " lvs-full\n"
11729 "\n"
11730 msgstr ""
11731
11732 #. type: textblock
11733 #: ../fish/guestfish-actions.pod:3116 ../src/guestfs-actions.pod:4800
11734 msgid ""
11735 "List all the logical volumes detected.  This is the equivalent of the "
11736 "L<lvs(8)> command.  The \"full\" version includes all fields."
11737 msgstr ""
11738
11739 #. type: =head2
11740 #: ../fish/guestfish-actions.pod:3119
11741 msgid "lvuuid"
11742 msgstr ""
11743
11744 #. type: verbatim
11745 #: ../fish/guestfish-actions.pod:3121
11746 #, no-wrap
11747 msgid ""
11748 " lvuuid device\n"
11749 "\n"
11750 msgstr ""
11751
11752 #. type: textblock
11753 #: ../fish/guestfish-actions.pod:3123 ../src/guestfs-actions.pod:4815
11754 msgid "This command returns the UUID of the LVM LV C<device>."
11755 msgstr ""
11756
11757 #. type: =head2
11758 #: ../fish/guestfish-actions.pod:3125
11759 msgid "lxattrlist"
11760 msgstr ""
11761
11762 #. type: verbatim
11763 #: ../fish/guestfish-actions.pod:3127
11764 #, no-wrap
11765 msgid ""
11766 " lxattrlist path 'names ...'\n"
11767 "\n"
11768 msgstr ""
11769
11770 #. type: textblock
11771 #: ../fish/guestfish-actions.pod:3129 ../src/guestfs-actions.pod:4829
11772 msgid ""
11773 "This call allows you to get the extended attributes of multiple files, where "
11774 "all files are in the directory C<path>.  C<names> is the list of files from "
11775 "this directory."
11776 msgstr ""
11777
11778 #. type: textblock
11779 #: ../fish/guestfish-actions.pod:3133 ../src/guestfs-actions.pod:4833
11780 msgid ""
11781 "On return you get a flat list of xattr structs which must be interpreted "
11782 "sequentially.  The first xattr struct always has a zero-length C<attrname>.  "
11783 "C<attrval> in this struct is zero-length to indicate there was an error "
11784 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11785 "number (the number of following attributes for this file, which could be "
11786 "C<\"0\">).  Then after the first xattr struct are the zero or more "
11787 "attributes for the first named file.  This repeats for the second and "
11788 "subsequent files."
11789 msgstr ""
11790
11791 #. type: textblock
11792 #: ../fish/guestfish-actions.pod:3143
11793 msgid ""
11794 "This call is intended for programs that want to efficiently list a directory "
11795 "contents without making many round-trips.  See also L</lstatlist> for a "
11796 "similarly efficient call for getting standard stats.  Very long directory "
11797 "listings might cause the protocol message size to be exceeded, causing this "
11798 "call to fail.  The caller must split up such requests into smaller groups of "
11799 "names."
11800 msgstr ""
11801
11802 #. type: =head2
11803 #: ../fish/guestfish-actions.pod:3151
11804 msgid "mkdir"
11805 msgstr ""
11806
11807 #. type: verbatim
11808 #: ../fish/guestfish-actions.pod:3153
11809 #, no-wrap
11810 msgid ""
11811 " mkdir path\n"
11812 "\n"
11813 msgstr ""
11814
11815 #. type: textblock
11816 #: ../fish/guestfish-actions.pod:3155 ../src/guestfs-actions.pod:4863
11817 msgid "Create a directory named C<path>."
11818 msgstr ""
11819
11820 #. type: =head2
11821 #: ../fish/guestfish-actions.pod:3157
11822 msgid "mkdir-mode"
11823 msgstr ""
11824
11825 #. type: verbatim
11826 #: ../fish/guestfish-actions.pod:3159
11827 #, no-wrap
11828 msgid ""
11829 " mkdir-mode path mode\n"
11830 "\n"
11831 msgstr ""
11832
11833 #. type: textblock
11834 #: ../fish/guestfish-actions.pod:3161 ../src/guestfs-actions.pod:4876
11835 msgid ""
11836 "This command creates a directory, setting the initial permissions of the "
11837 "directory to C<mode>."
11838 msgstr ""
11839
11840 #. type: textblock
11841 #: ../fish/guestfish-actions.pod:3164 ../src/guestfs-actions.pod:4879
11842 msgid ""
11843 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11844 "~umask & 01777>.  Non-native-Linux filesystems may interpret the mode in "
11845 "other ways."
11846 msgstr ""
11847
11848 #. type: textblock
11849 #: ../fish/guestfish-actions.pod:3168
11850 msgid "See also L</mkdir>, L</umask>"
11851 msgstr ""
11852
11853 #. type: =head2
11854 #: ../fish/guestfish-actions.pod:3170
11855 msgid "mkdir-p"
11856 msgstr ""
11857
11858 #. type: verbatim
11859 #: ../fish/guestfish-actions.pod:3172
11860 #, no-wrap
11861 msgid ""
11862 " mkdir-p path\n"
11863 "\n"
11864 msgstr ""
11865
11866 #. type: textblock
11867 #: ../fish/guestfish-actions.pod:3174 ../src/guestfs-actions.pod:4895
11868 msgid ""
11869 "Create a directory named C<path>, creating any parent directories as "
11870 "necessary.  This is like the C<mkdir -p> shell command."
11871 msgstr ""
11872
11873 #. type: =head2
11874 #: ../fish/guestfish-actions.pod:3177
11875 msgid "mkdtemp"
11876 msgstr ""
11877
11878 #. type: verbatim
11879 #: ../fish/guestfish-actions.pod:3179
11880 #, no-wrap
11881 msgid ""
11882 " mkdtemp template\n"
11883 "\n"
11884 msgstr ""
11885
11886 #. type: textblock
11887 #: ../fish/guestfish-actions.pod:3181 ../src/guestfs-actions.pod:4908
11888 msgid ""
11889 "This command creates a temporary directory.  The C<template> parameter "
11890 "should be a full pathname for the temporary directory name with the final "
11891 "six characters being \"XXXXXX\"."
11892 msgstr ""
11893
11894 #. type: textblock
11895 #: ../fish/guestfish-actions.pod:3186 ../src/guestfs-actions.pod:4913
11896 msgid ""
11897 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11898 "being suitable for Windows filesystems."
11899 msgstr ""
11900
11901 #. type: textblock
11902 #: ../fish/guestfish-actions.pod:3189 ../src/guestfs-actions.pod:4916
11903 msgid "The name of the temporary directory that was created is returned."
11904 msgstr ""
11905
11906 #. type: textblock
11907 #: ../fish/guestfish-actions.pod:3192 ../src/guestfs-actions.pod:4919
11908 msgid "The temporary directory is created with mode 0700 and is owned by root."
11909 msgstr ""
11910
11911 #. type: textblock
11912 #: ../fish/guestfish-actions.pod:3195 ../src/guestfs-actions.pod:4922
11913 msgid ""
11914 "The caller is responsible for deleting the temporary directory and its "
11915 "contents after use."
11916 msgstr ""
11917
11918 #. type: textblock
11919 #: ../fish/guestfish-actions.pod:3198 ../src/guestfs-actions.pod:4925
11920 msgid "See also: L<mkdtemp(3)>"
11921 msgstr ""
11922
11923 #. type: =head2
11924 #: ../fish/guestfish-actions.pod:3200
11925 msgid "mke2fs-J"
11926 msgstr ""
11927
11928 #. type: verbatim
11929 #: ../fish/guestfish-actions.pod:3202
11930 #, no-wrap
11931 msgid ""
11932 " mke2fs-J fstype blocksize device journal\n"
11933 "\n"
11934 msgstr ""
11935
11936 #. type: textblock
11937 #: ../fish/guestfish-actions.pod:3204 ../src/guestfs-actions.pod:4941
11938 msgid ""
11939 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11940 "C<journal>.  It is equivalent to the command:"
11941 msgstr ""
11942
11943 #. type: verbatim
11944 #: ../fish/guestfish-actions.pod:3208 ../src/guestfs-actions.pod:4945
11945 #, no-wrap
11946 msgid ""
11947 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11948 "\n"
11949 msgstr ""
11950
11951 #. type: textblock
11952 #: ../fish/guestfish-actions.pod:3210
11953 msgid "See also L</mke2journal>."
11954 msgstr ""
11955
11956 #. type: =head2
11957 #: ../fish/guestfish-actions.pod:3212
11958 msgid "mke2fs-JL"
11959 msgstr ""
11960
11961 #. type: verbatim
11962 #: ../fish/guestfish-actions.pod:3214
11963 #, no-wrap
11964 msgid ""
11965 " mke2fs-JL fstype blocksize device label\n"
11966 "\n"
11967 msgstr ""
11968
11969 #. type: textblock
11970 #: ../fish/guestfish-actions.pod:3216 ../src/guestfs-actions.pod:4962
11971 msgid ""
11972 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11973 "the journal labeled C<label>."
11974 msgstr ""
11975
11976 #. type: textblock
11977 #: ../fish/guestfish-actions.pod:3219
11978 msgid "See also L</mke2journal-L>."
11979 msgstr ""
11980
11981 #. type: =head2
11982 #: ../fish/guestfish-actions.pod:3221
11983 msgid "mke2fs-JU"
11984 msgstr ""
11985
11986 #. type: verbatim
11987 #: ../fish/guestfish-actions.pod:3223
11988 #, no-wrap
11989 msgid ""
11990 " mke2fs-JU fstype blocksize device uuid\n"
11991 "\n"
11992 msgstr ""
11993
11994 #. type: textblock
11995 #: ../fish/guestfish-actions.pod:3225 ../src/guestfs-actions.pod:4980
11996 msgid ""
11997 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11998 "the journal with UUID C<uuid>."
11999 msgstr ""
12000
12001 #. type: textblock
12002 #: ../fish/guestfish-actions.pod:3228
12003 msgid "See also L</mke2journal-U>."
12004 msgstr ""
12005
12006 #. type: =head2
12007 #: ../fish/guestfish-actions.pod:3230
12008 msgid "mke2journal"
12009 msgstr ""
12010
12011 #. type: verbatim
12012 #: ../fish/guestfish-actions.pod:3232
12013 #, no-wrap
12014 msgid ""
12015 " mke2journal blocksize device\n"
12016 "\n"
12017 msgstr ""
12018
12019 #. type: textblock
12020 #: ../fish/guestfish-actions.pod:3234 ../src/guestfs-actions.pod:4996
12021 msgid ""
12022 "This creates an ext2 external journal on C<device>.  It is equivalent to the "
12023 "command:"
12024 msgstr ""
12025
12026 #. type: verbatim
12027 #: ../fish/guestfish-actions.pod:3237 ../src/guestfs-actions.pod:4999
12028 #, no-wrap
12029 msgid ""
12030 " mke2fs -O journal_dev -b blocksize device\n"
12031 "\n"
12032 msgstr ""
12033
12034 #. type: =head2
12035 #: ../fish/guestfish-actions.pod:3239
12036 msgid "mke2journal-L"
12037 msgstr ""
12038
12039 #. type: verbatim
12040 #: ../fish/guestfish-actions.pod:3241
12041 #, no-wrap
12042 msgid ""
12043 " mke2journal-L blocksize label device\n"
12044 "\n"
12045 msgstr ""
12046
12047 #. type: textblock
12048 #: ../fish/guestfish-actions.pod:3243 ../src/guestfs-actions.pod:5013
12049 msgid "This creates an ext2 external journal on C<device> with label C<label>."
12050 msgstr ""
12051
12052 #. type: =head2
12053 #: ../fish/guestfish-actions.pod:3245
12054 msgid "mke2journal-U"
12055 msgstr ""
12056
12057 #. type: verbatim
12058 #: ../fish/guestfish-actions.pod:3247
12059 #, no-wrap
12060 msgid ""
12061 " mke2journal-U blocksize uuid device\n"
12062 "\n"
12063 msgstr ""
12064
12065 #. type: textblock
12066 #: ../fish/guestfish-actions.pod:3249 ../src/guestfs-actions.pod:5027
12067 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
12068 msgstr ""
12069
12070 #. type: =head2
12071 #: ../fish/guestfish-actions.pod:3251
12072 msgid "mkfifo"
12073 msgstr ""
12074
12075 #. type: verbatim
12076 #: ../fish/guestfish-actions.pod:3253
12077 #, no-wrap
12078 msgid ""
12079 " mkfifo mode path\n"
12080 "\n"
12081 msgstr ""
12082
12083 #. type: textblock
12084 #: ../fish/guestfish-actions.pod:3255
12085 msgid ""
12086 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>.  It "
12087 "is just a convenient wrapper around L</mknod>."
12088 msgstr ""
12089
12090 #. type: =head2
12091 #: ../fish/guestfish-actions.pod:3261
12092 msgid "mkfs"
12093 msgstr ""
12094
12095 #. type: verbatim
12096 #: ../fish/guestfish-actions.pod:3263
12097 #, no-wrap
12098 msgid ""
12099 " mkfs fstype device\n"
12100 "\n"
12101 msgstr ""
12102
12103 #. type: textblock
12104 #: ../fish/guestfish-actions.pod:3265 ../src/guestfs-actions.pod:5057
12105 msgid ""
12106 "This creates a filesystem on C<device> (usually a partition or LVM logical "
12107 "volume).  The filesystem type is C<fstype>, for example C<ext3>."
12108 msgstr ""
12109
12110 #. type: =head2
12111 #: ../fish/guestfish-actions.pod:3269
12112 msgid "mkfs-b"
12113 msgstr ""
12114
12115 #. type: verbatim
12116 #: ../fish/guestfish-actions.pod:3271
12117 #, no-wrap
12118 msgid ""
12119 " mkfs-b fstype blocksize device\n"
12120 "\n"
12121 msgstr ""
12122
12123 #. type: textblock
12124 #: ../fish/guestfish-actions.pod:3273
12125 msgid ""
12126 "This call is similar to L</mkfs>, but it allows you to control the block "
12127 "size of the resulting filesystem.  Supported block sizes depend on the "
12128 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
12129 msgstr ""
12130
12131 #. type: textblock
12132 #: ../fish/guestfish-actions.pod:3278 ../fish/guestfish-actions.pod:3305 ../src/guestfs-actions.pod:5085 ../src/guestfs-actions.pod:5123
12133 msgid ""
12134 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
12135 "cluster size."
12136 msgstr ""
12137
12138 #. type: textblock
12139 #: ../fish/guestfish-actions.pod:3281
12140 msgid ""
12141 "I<This function is deprecated.> In new code, use the L</mkfs_opts> call "
12142 "instead."
12143 msgstr ""
12144
12145 #. type: =head2
12146 #: ../fish/guestfish-actions.pod:3288
12147 msgid "mkfs-opts"
12148 msgstr ""
12149
12150 #. type: verbatim
12151 #: ../fish/guestfish-actions.pod:3290
12152 #, no-wrap
12153 msgid ""
12154 " mkfs-opts fstype device [blocksize:N] [features:..] [inode:N] "
12155 "[sectorsize:N]\n"
12156 "\n"
12157 msgstr ""
12158
12159 #. type: textblock
12160 #: ../fish/guestfish-actions.pod:3292 ../src/guestfs-actions.pod:5110
12161 msgid ""
12162 "This function creates a filesystem on C<device>.  The filesystem type is "
12163 "C<fstype>, for example C<ext3>."
12164 msgstr ""
12165
12166 #. type: =item
12167 #: ../fish/guestfish-actions.pod:3299 ../src/guestfs-actions.pod:5117
12168 msgid "C<blocksize>"
12169 msgstr ""
12170
12171 #. type: textblock
12172 #: ../fish/guestfish-actions.pod:3301 ../src/guestfs-actions.pod:5119
12173 msgid ""
12174 "The filesystem block size.  Supported block sizes depend on the filesystem "
12175 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
12176 "filesystems."
12177 msgstr ""
12178
12179 #. type: textblock
12180 #: ../fish/guestfish-actions.pod:3308 ../src/guestfs-actions.pod:5126
12181 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
12182 msgstr ""
12183
12184 #. type: =item
12185 #: ../fish/guestfish-actions.pod:3310 ../src/guestfs-actions.pod:5128
12186 msgid "C<features>"
12187 msgstr ""
12188
12189 #. type: textblock
12190 #: ../fish/guestfish-actions.pod:3312 ../src/guestfs-actions.pod:5130
12191 msgid "This passes the I<-O> parameter to the external mkfs program."
12192 msgstr ""
12193
12194 #. type: textblock
12195 #: ../fish/guestfish-actions.pod:3314 ../src/guestfs-actions.pod:5132
12196 msgid ""
12197 "For certain filesystem types, this allows extra filesystem features to be "
12198 "selected.  See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
12199 msgstr ""
12200
12201 #. type: textblock
12202 #: ../fish/guestfish-actions.pod:3318 ../src/guestfs-actions.pod:5136
12203 msgid ""
12204 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
12205 "type."
12206 msgstr ""
12207
12208 #. type: =item
12209 #: ../fish/guestfish-actions.pod:3321 ../src/guestfs-actions.pod:5139
12210 msgid "C<inode>"
12211 msgstr ""
12212
12213 #. type: textblock
12214 #: ../fish/guestfish-actions.pod:3323 ../src/guestfs-actions.pod:5141
12215 msgid ""
12216 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
12217 "sets the inode size (only for ext2/3/4 filesystems at present)."
12218 msgstr ""
12219
12220 #. type: =item
12221 #: ../fish/guestfish-actions.pod:3326 ../src/guestfs-actions.pod:5144
12222 msgid "C<sectorsize>"
12223 msgstr ""
12224
12225 #. type: textblock
12226 #: ../fish/guestfish-actions.pod:3328 ../src/guestfs-actions.pod:5146
12227 msgid ""
12228 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
12229 "sets sector size for ufs filesystem."
12230 msgstr ""
12231
12232 #. type: =head2
12233 #: ../fish/guestfish-actions.pod:3335
12234 msgid "mkmountpoint"
12235 msgstr ""
12236
12237 #. type: verbatim
12238 #: ../fish/guestfish-actions.pod:3337
12239 #, no-wrap
12240 msgid ""
12241 " mkmountpoint exemptpath\n"
12242 "\n"
12243 msgstr ""
12244
12245 #. type: textblock
12246 #: ../fish/guestfish-actions.pod:3339
12247 msgid ""
12248 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
12249 "to create extra mountpoints before mounting the first filesystem."
12250 msgstr ""
12251
12252 #. type: textblock
12253 #: ../fish/guestfish-actions.pod:3343 ../src/guestfs-actions.pod:5189
12254 msgid ""
12255 "These calls are I<only> necessary in some very limited circumstances, mainly "
12256 "the case where you want to mount a mix of unrelated and/or read-only "
12257 "filesystems together."
12258 msgstr ""
12259
12260 #. type: textblock
12261 #: ../fish/guestfish-actions.pod:3347 ../src/guestfs-actions.pod:5193
12262 msgid ""
12263 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12264 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12265 "inside that.  You can unpack this as follows in guestfish:"
12266 msgstr ""
12267
12268 #. type: verbatim
12269 #: ../fish/guestfish-actions.pod:3352 ../src/guestfs-actions.pod:5198
12270 #, no-wrap
12271 msgid ""
12272 " add-ro Fedora-11-i686-Live.iso\n"
12273 " run\n"
12274 " mkmountpoint /cd\n"
12275 " mkmountpoint /sqsh\n"
12276 " mkmountpoint /ext3fs\n"
12277 " mount /dev/sda /cd\n"
12278 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
12279 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
12280 "\n"
12281 msgstr ""
12282
12283 #. type: textblock
12284 #: ../fish/guestfish-actions.pod:3361 ../src/guestfs-actions.pod:5207
12285 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
12286 msgstr ""
12287
12288 #. type: textblock
12289 #: ../fish/guestfish-actions.pod:3363
12290 msgid ""
12291 "L</mkmountpoint> is not compatible with L</umount-all>.  You may get "
12292 "unexpected errors if you try to mix these calls.  It is safest to manually "
12293 "unmount filesystems and remove mountpoints after use."
12294 msgstr ""
12295
12296 #. type: textblock
12297 #: ../fish/guestfish-actions.pod:3367
12298 msgid ""
12299 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
12300 "for this to work for manual mountpoints, you must ensure that the innermost "
12301 "mountpoints have the longest pathnames, as in the example code above."
12302 msgstr ""
12303
12304 #. type: textblock
12305 #: ../fish/guestfish-actions.pod:3372 ../src/guestfs-actions.pod:5218
12306 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
12307 msgstr ""
12308
12309 #. type: textblock
12310 #: ../fish/guestfish-actions.pod:3374
12311 msgid ""
12312 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
12313 "L</umount-all> to be called when the handle is closed which can also trigger "
12314 "these issues."
12315 msgstr ""
12316
12317 #. type: =head2
12318 #: ../fish/guestfish-actions.pod:3378
12319 msgid "mknod"
12320 msgstr ""
12321
12322 #. type: verbatim
12323 #: ../fish/guestfish-actions.pod:3380
12324 #, no-wrap
12325 msgid ""
12326 " mknod mode devmajor devminor path\n"
12327 "\n"
12328 msgstr ""
12329
12330 #. type: textblock
12331 #: ../fish/guestfish-actions.pod:3382 ../src/guestfs-actions.pod:5237
12332 msgid ""
12333 "This call creates block or character special devices, or named pipes "
12334 "(FIFOs)."
12335 msgstr ""
12336
12337 #. type: textblock
12338 #: ../fish/guestfish-actions.pod:3385 ../src/guestfs-actions.pod:5240
12339 msgid ""
12340 "The C<mode> parameter should be the mode, using the standard constants.  "
12341 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
12342 "used when creating block and character special devices."
12343 msgstr ""
12344
12345 #. type: textblock
12346 #: ../fish/guestfish-actions.pod:3390
12347 msgid ""
12348 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
12349 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
12350 "regular file).  These constants are available in the standard Linux header "
12351 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
12352 "wrappers around this command which bitwise OR in the appropriate constant "
12353 "for you."
12354 msgstr ""
12355
12356 #. type: =head2
12357 #: ../fish/guestfish-actions.pod:3400
12358 msgid "mknod-b"
12359 msgstr ""
12360
12361 #. type: verbatim
12362 #: ../fish/guestfish-actions.pod:3402
12363 #, no-wrap
12364 msgid ""
12365 " mknod-b mode devmajor devminor path\n"
12366 "\n"
12367 msgstr ""
12368
12369 #. type: textblock
12370 #: ../fish/guestfish-actions.pod:3404
12371 msgid ""
12372 "This call creates a block device node called C<path> with mode C<mode> and "
12373 "device major/minor C<devmajor> and C<devminor>.  It is just a convenient "
12374 "wrapper around L</mknod>."
12375 msgstr ""
12376
12377 #. type: =head2
12378 #: ../fish/guestfish-actions.pod:3410
12379 msgid "mknod-c"
12380 msgstr ""
12381
12382 #. type: verbatim
12383 #: ../fish/guestfish-actions.pod:3412
12384 #, no-wrap
12385 msgid ""
12386 " mknod-c mode devmajor devminor path\n"
12387 "\n"
12388 msgstr ""
12389
12390 #. type: textblock
12391 #: ../fish/guestfish-actions.pod:3414
12392 msgid ""
12393 "This call creates a char device node called C<path> with mode C<mode> and "
12394 "device major/minor C<devmajor> and C<devminor>.  It is just a convenient "
12395 "wrapper around L</mknod>."
12396 msgstr ""
12397
12398 #. type: =head2
12399 #: ../fish/guestfish-actions.pod:3420
12400 msgid "mkswap"
12401 msgstr ""
12402
12403 #. type: verbatim
12404 #: ../fish/guestfish-actions.pod:3422
12405 #, no-wrap
12406 msgid ""
12407 " mkswap device\n"
12408 "\n"
12409 msgstr ""
12410
12411 #. type: textblock
12412 #: ../fish/guestfish-actions.pod:3424 ../src/guestfs-actions.pod:5303
12413 msgid "Create a swap partition on C<device>."
12414 msgstr ""
12415
12416 #. type: =head2
12417 #: ../fish/guestfish-actions.pod:3426
12418 msgid "mkswap-L"
12419 msgstr ""
12420
12421 #. type: verbatim
12422 #: ../fish/guestfish-actions.pod:3428
12423 #, no-wrap
12424 msgid ""
12425 " mkswap-L label device\n"
12426 "\n"
12427 msgstr ""
12428
12429 #. type: textblock
12430 #: ../fish/guestfish-actions.pod:3430 ../src/guestfs-actions.pod:5316
12431 msgid "Create a swap partition on C<device> with label C<label>."
12432 msgstr ""
12433
12434 #. type: textblock
12435 #: ../fish/guestfish-actions.pod:3432 ../src/guestfs-actions.pod:5318
12436 msgid ""
12437 "Note that you cannot attach a swap label to a block device "
12438 "(eg. C</dev/sda>), just to a partition.  This appears to be a limitation of "
12439 "the kernel or swap tools."
12440 msgstr ""
12441
12442 #. type: =head2
12443 #: ../fish/guestfish-actions.pod:3436
12444 msgid "mkswap-U"
12445 msgstr ""
12446
12447 #. type: verbatim
12448 #: ../fish/guestfish-actions.pod:3438
12449 #, no-wrap
12450 msgid ""
12451 " mkswap-U uuid device\n"
12452 "\n"
12453 msgstr ""
12454
12455 #. type: textblock
12456 #: ../fish/guestfish-actions.pod:3440 ../src/guestfs-actions.pod:5333
12457 msgid "Create a swap partition on C<device> with UUID C<uuid>."
12458 msgstr ""
12459
12460 #. type: =head2
12461 #: ../fish/guestfish-actions.pod:3442
12462 msgid "mkswap-file"
12463 msgstr ""
12464
12465 #. type: verbatim
12466 #: ../fish/guestfish-actions.pod:3444
12467 #, no-wrap
12468 msgid ""
12469 " mkswap-file path\n"
12470 "\n"
12471 msgstr ""
12472
12473 #. type: textblock
12474 #: ../fish/guestfish-actions.pod:3446 ../src/guestfs-actions.pod:5345
12475 msgid "Create a swap file."
12476 msgstr ""
12477
12478 #. type: textblock
12479 #: ../fish/guestfish-actions.pod:3448
12480 msgid ""
12481 "This command just writes a swap file signature to an existing file.  To "
12482 "create the file itself, use something like L</fallocate>."
12483 msgstr ""
12484
12485 #. type: =head2
12486 #: ../fish/guestfish-actions.pod:3451
12487 msgid "modprobe"
12488 msgstr ""
12489
12490 #. type: verbatim
12491 #: ../fish/guestfish-actions.pod:3453
12492 #, no-wrap
12493 msgid ""
12494 " modprobe modulename\n"
12495 "\n"
12496 msgstr ""
12497
12498 #. type: textblock
12499 #: ../fish/guestfish-actions.pod:3455 ../src/guestfs-actions.pod:5360
12500 msgid "This loads a kernel module in the appliance."
12501 msgstr ""
12502
12503 #. type: textblock
12504 #: ../fish/guestfish-actions.pod:3457 ../src/guestfs-actions.pod:5362
12505 msgid ""
12506 "The kernel module must have been whitelisted when libguestfs was built (see "
12507 "C<appliance/kmod.whitelist.in> in the source)."
12508 msgstr ""
12509
12510 #. type: =head2
12511 #: ../fish/guestfish-actions.pod:3460
12512 msgid "mount"
12513 msgstr ""
12514
12515 #. type: verbatim
12516 #: ../fish/guestfish-actions.pod:3462
12517 #, no-wrap
12518 msgid ""
12519 " mount device mountpoint\n"
12520 "\n"
12521 msgstr ""
12522
12523 #. type: textblock
12524 #: ../fish/guestfish-actions.pod:3464 ../src/guestfs-actions.pod:5376
12525 msgid ""
12526 "Mount a guest disk at a position in the filesystem.  Block devices are named "
12527 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest.  If "
12528 "those block devices contain partitions, they will have the usual names "
12529 "(eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style names can be used."
12530 msgstr ""
12531
12532 #. type: textblock
12533 #: ../fish/guestfish-actions.pod:3470 ../src/guestfs-actions.pod:5382
12534 msgid ""
12535 "The rules are the same as for L<mount(2)>: A filesystem must first be "
12536 "mounted on C</> before others can be mounted.  Other filesystems can only be "
12537 "mounted on directories which already exist."
12538 msgstr ""
12539
12540 #. type: textblock
12541 #: ../fish/guestfish-actions.pod:3475 ../src/guestfs-actions.pod:5387
12542 msgid ""
12543 "The mounted filesystem is writable, if we have sufficient permissions on the "
12544 "underlying device."
12545 msgstr ""
12546
12547 #. type: textblock
12548 #: ../fish/guestfish-actions.pod:3478
12549 msgid ""
12550 "Before libguestfs 1.13.16, this call implicitly added the options C<sync> "
12551 "and C<noatime>.  The C<sync> option greatly slowed writes and caused many "
12552 "problems for users.  If your program might need to work with older versions "
12553 "of libguestfs, use L</mount-options> instead (using an empty string for the "
12554 "first parameter if you don't want any options)."
12555 msgstr ""
12556
12557 #. type: =head2
12558 #: ../fish/guestfish-actions.pod:3485
12559 msgid "mount-9p"
12560 msgstr ""
12561
12562 #. type: verbatim
12563 #: ../fish/guestfish-actions.pod:3487
12564 #, no-wrap
12565 msgid ""
12566 " mount-9p mounttag mountpoint [options:..]\n"
12567 "\n"
12568 msgstr ""
12569
12570 #. type: textblock
12571 #: ../fish/guestfish-actions.pod:3489 ../src/guestfs-actions.pod:5416
12572 msgid ""
12573 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
12574 "C<mountpoint>."
12575 msgstr ""
12576
12577 #. type: textblock
12578 #: ../fish/guestfish-actions.pod:3492 ../src/guestfs-actions.pod:5419
12579 msgid ""
12580 "If required, C<trans=virtio> will be automatically added to the options.  "
12581 "Any other options required can be passed in the optional C<options> "
12582 "parameter."
12583 msgstr ""
12584
12585 #. type: =head2
12586 #: ../fish/guestfish-actions.pod:3498
12587 msgid "mount-loop"
12588 msgstr ""
12589
12590 #. type: verbatim
12591 #: ../fish/guestfish-actions.pod:3500
12592 #, no-wrap
12593 msgid ""
12594 " mount-loop file mountpoint\n"
12595 "\n"
12596 msgstr ""
12597
12598 #. type: textblock
12599 #: ../fish/guestfish-actions.pod:3502 ../src/guestfs-actions.pod:5458
12600 msgid ""
12601 "This command lets you mount C<file> (a filesystem image in a file) on a "
12602 "mount point.  It is entirely equivalent to the command C<mount -o loop file "
12603 "mountpoint>."
12604 msgstr ""
12605
12606 #. type: =head2
12607 #: ../fish/guestfish-actions.pod:3506
12608 msgid "mount-options"
12609 msgstr ""
12610
12611 #. type: verbatim
12612 #: ../fish/guestfish-actions.pod:3508
12613 #, no-wrap
12614 msgid ""
12615 " mount-options options device mountpoint\n"
12616 "\n"
12617 msgstr ""
12618
12619 #. type: textblock
12620 #: ../fish/guestfish-actions.pod:3510
12621 msgid ""
12622 "This is the same as the L</mount> command, but it allows you to set the "
12623 "mount options as for the L<mount(8)> I<-o> flag."
12624 msgstr ""
12625
12626 #. type: textblock
12627 #: ../fish/guestfish-actions.pod:3514 ../src/guestfs-actions.pod:5478
12628 msgid ""
12629 "If the C<options> parameter is an empty string, then no options are passed "
12630 "(all options default to whatever the filesystem uses)."
12631 msgstr ""
12632
12633 #. type: =head2
12634 #: ../fish/guestfish-actions.pod:3518
12635 msgid "mount-ro"
12636 msgstr ""
12637
12638 #. type: verbatim
12639 #: ../fish/guestfish-actions.pod:3520
12640 #, no-wrap
12641 msgid ""
12642 " mount-ro device mountpoint\n"
12643 "\n"
12644 msgstr ""
12645
12646 #. type: textblock
12647 #: ../fish/guestfish-actions.pod:3522
12648 msgid ""
12649 "This is the same as the L</mount> command, but it mounts the filesystem with "
12650 "the read-only (I<-o ro>) flag."
12651 msgstr ""
12652
12653 #. type: =head2
12654 #: ../fish/guestfish-actions.pod:3525
12655 msgid "mount-vfs"
12656 msgstr ""
12657
12658 #. type: verbatim
12659 #: ../fish/guestfish-actions.pod:3527
12660 #, no-wrap
12661 msgid ""
12662 " mount-vfs options vfstype device mountpoint\n"
12663 "\n"
12664 msgstr ""
12665
12666 #. type: textblock
12667 #: ../fish/guestfish-actions.pod:3529
12668 msgid ""
12669 "This is the same as the L</mount> command, but it allows you to set both the "
12670 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
12671 msgstr ""
12672
12673 #. type: =head2
12674 #: ../fish/guestfish-actions.pod:3533
12675 msgid "mountpoints"
12676 msgstr ""
12677
12678 #. type: verbatim
12679 #: ../fish/guestfish-actions.pod:3535
12680 #, no-wrap
12681 msgid ""
12682 " mountpoints\n"
12683 "\n"
12684 msgstr ""
12685
12686 #. type: textblock
12687 #: ../fish/guestfish-actions.pod:3537
12688 msgid ""
12689 "This call is similar to L</mounts>.  That call returns a list of devices.  "
12690 "This one returns a hash table (map) of device name to directory where the "
12691 "device is mounted."
12692 msgstr ""
12693
12694 #. type: =head2
12695 #: ../fish/guestfish-actions.pod:3541
12696 msgid "mounts"
12697 msgstr ""
12698
12699 #. type: verbatim
12700 #: ../fish/guestfish-actions.pod:3543
12701 #, no-wrap
12702 msgid ""
12703 " mounts\n"
12704 "\n"
12705 msgstr ""
12706
12707 #. type: textblock
12708 #: ../fish/guestfish-actions.pod:3545 ../src/guestfs-actions.pod:5539
12709 msgid ""
12710 "This returns the list of currently mounted filesystems.  It returns the list "
12711 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
12712 msgstr ""
12713
12714 #. type: textblock
12715 #: ../fish/guestfish-actions.pod:3548 ../src/guestfs-actions.pod:5542
12716 msgid "Some internal mounts are not shown."
12717 msgstr ""
12718
12719 #. type: textblock
12720 #: ../fish/guestfish-actions.pod:3550
12721 msgid "See also: L</mountpoints>"
12722 msgstr ""
12723
12724 #. type: =head2
12725 #: ../fish/guestfish-actions.pod:3552
12726 msgid "mv"
12727 msgstr ""
12728
12729 #. type: verbatim
12730 #: ../fish/guestfish-actions.pod:3554
12731 #, no-wrap
12732 msgid ""
12733 " mv src dest\n"
12734 "\n"
12735 msgstr ""
12736
12737 #. type: textblock
12738 #: ../fish/guestfish-actions.pod:3556 ../src/guestfs-actions.pod:5559
12739 msgid ""
12740 "This moves a file from C<src> to C<dest> where C<dest> is either a "
12741 "destination filename or destination directory."
12742 msgstr ""
12743
12744 #. type: =head2
12745 #: ../fish/guestfish-actions.pod:3559
12746 msgid "ntfs-3g-probe"
12747 msgstr ""
12748
12749 #. type: verbatim
12750 #: ../fish/guestfish-actions.pod:3561
12751 #, no-wrap
12752 msgid ""
12753 " ntfs-3g-probe true|false device\n"
12754 "\n"
12755 msgstr ""
12756
12757 #. type: textblock
12758 #: ../fish/guestfish-actions.pod:3563 ../src/guestfs-actions.pod:5573
12759 msgid ""
12760 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
12761 "C<device> for mountability.  (Not all NTFS volumes can be mounted "
12762 "read-write, and some cannot be mounted at all)."
12763 msgstr ""
12764
12765 #. type: textblock
12766 #: ../fish/guestfish-actions.pod:3567 ../src/guestfs-actions.pod:5577
12767 msgid ""
12768 "C<rw> is a boolean flag.  Set it to true if you want to test if the volume "
12769 "can be mounted read-write.  Set it to false if you want to test if the "
12770 "volume can be mounted read-only."
12771 msgstr ""
12772
12773 #. type: textblock
12774 #: ../fish/guestfish-actions.pod:3571 ../src/guestfs-actions.pod:5581
12775 msgid ""
12776 "The return value is an integer which C<0> if the operation would succeed, or "
12777 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12778 msgstr ""
12779
12780 #. type: =head2
12781 #: ../fish/guestfish-actions.pod:3575
12782 msgid "ntfsresize"
12783 msgstr ""
12784
12785 #. type: verbatim
12786 #: ../fish/guestfish-actions.pod:3577
12787 #, no-wrap
12788 msgid ""
12789 " ntfsresize device\n"
12790 "\n"
12791 msgstr ""
12792
12793 #. type: textblock
12794 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3603 ../src/guestfs-actions.pod:5602 ../src/guestfs-actions.pod:5634
12795 msgid ""
12796 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12797 "size of the underlying device."
12798 msgstr ""
12799
12800 #. type: textblock
12801 #: ../fish/guestfish-actions.pod:3582 ../src/guestfs-actions.pod:5605
12802 msgid ""
12803 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
12804 "consistency check (for safety).  You have to boot into Windows to perform "
12805 "this check and clear this condition.  Furthermore, ntfsresize refuses to "
12806 "resize filesystems which have been marked in this way.  So in effect it is "
12807 "not possible to call ntfsresize multiple times on a single filesystem "
12808 "without booting into Windows between each resize."
12809 msgstr ""
12810
12811 #. type: textblock
12812 #: ../fish/guestfish-actions.pod:3590 ../fish/guestfish-actions.pod:3629 ../src/guestfs-actions.pod:5613 ../src/guestfs-actions.pod:5660
12813 msgid "See also L<ntfsresize(8)>."
12814 msgstr ""
12815
12816 #. type: textblock
12817 #: ../fish/guestfish-actions.pod:3592 ../fish/guestfish-actions.pod:3640
12818 msgid ""
12819 "I<This function is deprecated.> In new code, use the L</ntfsresize_opts> "
12820 "call instead."
12821 msgstr ""
12822
12823 #. type: =head2
12824 #: ../fish/guestfish-actions.pod:3599
12825 msgid "ntfsresize-opts"
12826 msgstr ""
12827
12828 #. type: verbatim
12829 #: ../fish/guestfish-actions.pod:3601
12830 #, no-wrap
12831 msgid ""
12832 " ntfsresize-opts device [size:N] [force:true|false]\n"
12833 "\n"
12834 msgstr ""
12835
12836 #. type: textblock
12837 #: ../fish/guestfish-actions.pod:3612 ../src/guestfs-actions.pod:5643
12838 msgid ""
12839 "The new size (in bytes) of the filesystem.  If omitted, the filesystem is "
12840 "resized to fit the container (eg. partition)."
12841 msgstr ""
12842
12843 #. type: =item
12844 #: ../fish/guestfish-actions.pod:3615 ../src/guestfs-actions.pod:5646
12845 msgid "C<force>"
12846 msgstr ""
12847
12848 #. type: textblock
12849 #: ../fish/guestfish-actions.pod:3617 ../src/guestfs-actions.pod:5648
12850 msgid ""
12851 "If this option is true, then force the resize of the filesystem even if the "
12852 "filesystem is marked as requiring a consistency check."
12853 msgstr ""
12854
12855 #. type: textblock
12856 #: ../fish/guestfish-actions.pod:3620
12857 msgid ""
12858 "After the resize operation, the filesystem is always marked as requiring a "
12859 "consistency check (for safety).  You have to boot into Windows to perform "
12860 "this check and clear this condition.  If you I<don't> set the C<force> "
12861 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
12862 "a single filesystem without booting into Windows between each resize."
12863 msgstr ""
12864
12865 #. type: =head2
12866 #: ../fish/guestfish-actions.pod:3633
12867 msgid "ntfsresize-size"
12868 msgstr ""
12869
12870 #. type: verbatim
12871 #: ../fish/guestfish-actions.pod:3635
12872 #, no-wrap
12873 msgid ""
12874 " ntfsresize-size device size\n"
12875 "\n"
12876 msgstr ""
12877
12878 #. type: textblock
12879 #: ../fish/guestfish-actions.pod:3637
12880 msgid ""
12881 "This command is the same as L</ntfsresize> except that it allows you to "
12882 "specify the new size (in bytes) explicitly."
12883 msgstr ""
12884
12885 #. type: =head2
12886 #: ../fish/guestfish-actions.pod:3647
12887 msgid "part-add"
12888 msgstr ""
12889
12890 #. type: verbatim
12891 #: ../fish/guestfish-actions.pod:3649
12892 #, no-wrap
12893 msgid ""
12894 " part-add device prlogex startsect endsect\n"
12895 "\n"
12896 msgstr ""
12897
12898 #. type: textblock
12899 #: ../fish/guestfish-actions.pod:3651
12900 msgid ""
12901 "This command adds a partition to C<device>.  If there is no partition table "
12902 "on the device, call L</part-init> first."
12903 msgstr ""
12904
12905 #. type: textblock
12906 #: ../fish/guestfish-actions.pod:3654 ../src/guestfs-actions.pod:5721
12907 msgid ""
12908 "The C<prlogex> parameter is the type of partition.  Normally you should pass "
12909 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12910 "C<logical>) and C<e> (or C<extended>) partition types."
12911 msgstr ""
12912
12913 #. type: textblock
12914 #: ../fish/guestfish-actions.pod:3659 ../src/guestfs-actions.pod:5726
12915 msgid ""
12916 "C<startsect> and C<endsect> are the start and end of the partition in "
12917 "I<sectors>.  C<endsect> may be negative, which means it counts backwards "
12918 "from the end of the disk (C<-1> is the last sector)."
12919 msgstr ""
12920
12921 #. type: textblock
12922 #: ../fish/guestfish-actions.pod:3663
12923 msgid ""
12924 "Creating a partition which covers the whole disk is not so easy.  Use "
12925 "L</part-disk> to do that."
12926 msgstr ""
12927
12928 #. type: =head2
12929 #: ../fish/guestfish-actions.pod:3666
12930 msgid "part-del"
12931 msgstr ""
12932
12933 #. type: verbatim
12934 #: ../fish/guestfish-actions.pod:3668
12935 #, no-wrap
12936 msgid ""
12937 " part-del device partnum\n"
12938 "\n"
12939 msgstr ""
12940
12941 #. type: textblock
12942 #: ../fish/guestfish-actions.pod:3670 ../src/guestfs-actions.pod:5744
12943 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12944 msgstr ""
12945
12946 #. type: textblock
12947 #: ../fish/guestfish-actions.pod:3672 ../src/guestfs-actions.pod:5746
12948 msgid ""
12949 "Note that in the case of MBR partitioning, deleting an extended partition "
12950 "also deletes any logical partitions it contains."
12951 msgstr ""
12952
12953 #. type: =head2
12954 #: ../fish/guestfish-actions.pod:3676
12955 msgid "part-disk"
12956 msgstr ""
12957
12958 #. type: verbatim
12959 #: ../fish/guestfish-actions.pod:3678
12960 #, no-wrap
12961 msgid ""
12962 " part-disk device parttype\n"
12963 "\n"
12964 msgstr ""
12965
12966 #. type: textblock
12967 #: ../fish/guestfish-actions.pod:3680
12968 msgid ""
12969 "This command is simply a combination of L</part-init> followed by "
12970 "L</part-add> to create a single primary partition covering the whole disk."
12971 msgstr ""
12972
12973 #. type: textblock
12974 #: ../fish/guestfish-actions.pod:3684
12975 msgid ""
12976 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12977 "possible values are described in L</part-init>."
12978 msgstr ""
12979
12980 #. type: =head2
12981 #: ../fish/guestfish-actions.pod:3687
12982 msgid "part-get-bootable"
12983 msgstr ""
12984
12985 #. type: verbatim
12986 #: ../fish/guestfish-actions.pod:3689
12987 #, no-wrap
12988 msgid ""
12989 " part-get-bootable device partnum\n"
12990 "\n"
12991 msgstr ""
12992
12993 #. type: textblock
12994 #: ../fish/guestfish-actions.pod:3691 ../src/guestfs-actions.pod:5779
12995 msgid ""
12996 "This command returns true if the partition C<partnum> on C<device> has the "
12997 "bootable flag set."
12998 msgstr ""
12999
13000 #. type: textblock
13001 #: ../fish/guestfish-actions.pod:3694
13002 msgid "See also L</part-set-bootable>."
13003 msgstr ""
13004
13005 #. type: =head2
13006 #: ../fish/guestfish-actions.pod:3696
13007 msgid "part-get-mbr-id"
13008 msgstr ""
13009
13010 #. type: verbatim
13011 #: ../fish/guestfish-actions.pod:3698
13012 #, no-wrap
13013 msgid ""
13014 " part-get-mbr-id device partnum\n"
13015 "\n"
13016 msgstr ""
13017
13018 #. type: textblock
13019 #: ../fish/guestfish-actions.pod:3700 ../src/guestfs-actions.pod:5795
13020 msgid ""
13021 "Returns the MBR type byte (also known as the ID byte) from the numbered "
13022 "partition C<partnum>."
13023 msgstr ""
13024
13025 #. type: textblock
13026 #: ../fish/guestfish-actions.pod:3703 ../fish/guestfish-actions.pod:3847
13027 msgid ""
13028 "Note that only MBR (old DOS-style) partitions have type bytes.  You will get "
13029 "undefined results for other partition table types (see "
13030 "L</part-get-parttype>)."
13031 msgstr ""
13032
13033 #. type: =head2
13034 #: ../fish/guestfish-actions.pod:3707
13035 msgid "part-get-parttype"
13036 msgstr ""
13037
13038 #. type: verbatim
13039 #: ../fish/guestfish-actions.pod:3709
13040 #, no-wrap
13041 msgid ""
13042 " part-get-parttype device\n"
13043 "\n"
13044 msgstr ""
13045
13046 #. type: textblock
13047 #: ../fish/guestfish-actions.pod:3711 ../src/guestfs-actions.pod:5812
13048 msgid ""
13049 "This command examines the partition table on C<device> and returns the "
13050 "partition table type (format) being used."
13051 msgstr ""
13052
13053 #. type: textblock
13054 #: ../fish/guestfish-actions.pod:3714
13055 msgid ""
13056 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
13057 "table), C<gpt> (a GPT/EFI-style partition table).  Other values are "
13058 "possible, although unusual.  See L</part-init> for a full list."
13059 msgstr ""
13060
13061 #. type: =head2
13062 #: ../fish/guestfish-actions.pod:3719
13063 msgid "part-init"
13064 msgstr ""
13065
13066 #. type: verbatim
13067 #: ../fish/guestfish-actions.pod:3721
13068 #, no-wrap
13069 msgid ""
13070 " part-init device parttype\n"
13071 "\n"
13072 msgstr ""
13073
13074 #. type: textblock
13075 #: ../fish/guestfish-actions.pod:3723 ../src/guestfs-actions.pod:5832
13076 msgid ""
13077 "This creates an empty partition table on C<device> of one of the partition "
13078 "types listed below.  Usually C<parttype> should be either C<msdos> or C<gpt> "
13079 "(for large disks)."
13080 msgstr ""
13081
13082 #. type: textblock
13083 #: ../fish/guestfish-actions.pod:3727
13084 msgid ""
13085 "Initially there are no partitions.  Following this, you should call "
13086 "L</part-add> for each partition required."
13087 msgstr ""
13088
13089 #. type: textblock
13090 #: ../fish/guestfish-actions.pod:3730 ../src/guestfs-actions.pod:5839
13091 msgid "Possible values for C<parttype> are:"
13092 msgstr ""
13093
13094 #. type: =item
13095 #: ../fish/guestfish-actions.pod:3734 ../src/guestfs-actions.pod:5843
13096 msgid "B<efi>"
13097 msgstr ""
13098
13099 #. type: =item
13100 #: ../fish/guestfish-actions.pod:3736 ../src/guestfs-actions.pod:5845
13101 msgid "B<gpt>"
13102 msgstr ""
13103
13104 #. type: textblock
13105 #: ../fish/guestfish-actions.pod:3738 ../src/guestfs-actions.pod:5847
13106 msgid "Intel EFI / GPT partition table."
13107 msgstr ""
13108
13109 #. type: textblock
13110 #: ../fish/guestfish-actions.pod:3740 ../src/guestfs-actions.pod:5849
13111 msgid ""
13112 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
13113 "and Intel-based Mac OS X.  It also has limited backwards compatibility with "
13114 "the C<mbr> format."
13115 msgstr ""
13116
13117 #. type: =item
13118 #: ../fish/guestfish-actions.pod:3744 ../src/guestfs-actions.pod:5853
13119 msgid "B<mbr>"
13120 msgstr ""
13121
13122 #. type: =item
13123 #: ../fish/guestfish-actions.pod:3746 ../src/guestfs-actions.pod:5855
13124 msgid "B<msdos>"
13125 msgstr ""
13126
13127 #. type: textblock
13128 #: ../fish/guestfish-actions.pod:3748 ../src/guestfs-actions.pod:5857
13129 msgid ""
13130 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
13131 "Windows.  This partition type will B<only> work for device sizes up to 2 "
13132 "TB.  For large disks we recommend using C<gpt>."
13133 msgstr ""
13134
13135 #. type: textblock
13136 #: ../fish/guestfish-actions.pod:3755 ../src/guestfs-actions.pod:5864
13137 msgid "Other partition table types that may work but are not supported include:"
13138 msgstr ""
13139
13140 #. type: =item
13141 #: ../fish/guestfish-actions.pod:3760 ../src/guestfs-actions.pod:5869
13142 msgid "B<aix>"
13143 msgstr ""
13144
13145 #. type: textblock
13146 #: ../fish/guestfish-actions.pod:3762 ../src/guestfs-actions.pod:5871
13147 msgid "AIX disk labels."
13148 msgstr ""
13149
13150 #. type: =item
13151 #: ../fish/guestfish-actions.pod:3764 ../src/guestfs-actions.pod:5873
13152 msgid "B<amiga>"
13153 msgstr ""
13154
13155 #. type: =item
13156 #: ../fish/guestfish-actions.pod:3766 ../src/guestfs-actions.pod:5875
13157 msgid "B<rdb>"
13158 msgstr ""
13159
13160 #. type: textblock
13161 #: ../fish/guestfish-actions.pod:3768 ../src/guestfs-actions.pod:5877
13162 msgid "Amiga \"Rigid Disk Block\" format."
13163 msgstr ""
13164
13165 #. type: =item
13166 #: ../fish/guestfish-actions.pod:3770 ../src/guestfs-actions.pod:5879
13167 msgid "B<bsd>"
13168 msgstr ""
13169
13170 #. type: textblock
13171 #: ../fish/guestfish-actions.pod:3772 ../src/guestfs-actions.pod:5881
13172 msgid "BSD disk labels."
13173 msgstr ""
13174
13175 #. type: =item
13176 #: ../fish/guestfish-actions.pod:3774 ../src/guestfs-actions.pod:5883
13177 msgid "B<dasd>"
13178 msgstr ""
13179
13180 #. type: textblock
13181 #: ../fish/guestfish-actions.pod:3776 ../src/guestfs-actions.pod:5885
13182 msgid "DASD, used on IBM mainframes."
13183 msgstr ""
13184
13185 #. type: =item
13186 #: ../fish/guestfish-actions.pod:3778 ../src/guestfs-actions.pod:5887
13187 msgid "B<dvh>"
13188 msgstr ""
13189
13190 #. type: textblock
13191 #: ../fish/guestfish-actions.pod:3780 ../src/guestfs-actions.pod:5889
13192 msgid "MIPS/SGI volumes."
13193 msgstr ""
13194
13195 #. type: =item
13196 #: ../fish/guestfish-actions.pod:3782 ../src/guestfs-actions.pod:5891
13197 msgid "B<mac>"
13198 msgstr ""
13199
13200 #. type: textblock
13201 #: ../fish/guestfish-actions.pod:3784 ../src/guestfs-actions.pod:5893
13202 msgid "Old Mac partition format.  Modern Macs use C<gpt>."
13203 msgstr ""
13204
13205 #. type: =item
13206 #: ../fish/guestfish-actions.pod:3786 ../src/guestfs-actions.pod:5895
13207 msgid "B<pc98>"
13208 msgstr ""
13209
13210 #. type: textblock
13211 #: ../fish/guestfish-actions.pod:3788 ../src/guestfs-actions.pod:5897
13212 msgid "NEC PC-98 format, common in Japan apparently."
13213 msgstr ""
13214
13215 #. type: =item
13216 #: ../fish/guestfish-actions.pod:3790 ../src/guestfs-actions.pod:5899
13217 msgid "B<sun>"
13218 msgstr ""
13219
13220 #. type: textblock
13221 #: ../fish/guestfish-actions.pod:3792 ../src/guestfs-actions.pod:5901
13222 msgid "Sun disk labels."
13223 msgstr ""
13224
13225 #. type: =head2
13226 #: ../fish/guestfish-actions.pod:3796
13227 msgid "part-list"
13228 msgstr ""
13229
13230 #. type: verbatim
13231 #: ../fish/guestfish-actions.pod:3798
13232 #, no-wrap
13233 msgid ""
13234 " part-list device\n"
13235 "\n"
13236 msgstr ""
13237
13238 #. type: textblock
13239 #: ../fish/guestfish-actions.pod:3800 ../src/guestfs-actions.pod:5915
13240 msgid ""
13241 "This command parses the partition table on C<device> and returns the list of "
13242 "partitions found."
13243 msgstr ""
13244
13245 #. type: textblock
13246 #: ../fish/guestfish-actions.pod:3803 ../src/guestfs-actions.pod:5918
13247 msgid "The fields in the returned structure are:"
13248 msgstr ""
13249
13250 #. type: =item
13251 #: ../fish/guestfish-actions.pod:3807 ../src/guestfs-actions.pod:5922
13252 msgid "B<part_num>"
13253 msgstr ""
13254
13255 #. type: textblock
13256 #: ../fish/guestfish-actions.pod:3809 ../src/guestfs-actions.pod:5924
13257 msgid "Partition number, counting from 1."
13258 msgstr ""
13259
13260 #. type: =item
13261 #: ../fish/guestfish-actions.pod:3811 ../src/guestfs-actions.pod:5926
13262 msgid "B<part_start>"
13263 msgstr ""
13264
13265 #. type: textblock
13266 #: ../fish/guestfish-actions.pod:3813
13267 msgid ""
13268 "Start of the partition I<in bytes>.  To get sectors you have to divide by "
13269 "the device's sector size, see L</blockdev-getss>."
13270 msgstr ""
13271
13272 #. type: =item
13273 #: ../fish/guestfish-actions.pod:3816 ../src/guestfs-actions.pod:5931
13274 msgid "B<part_end>"
13275 msgstr ""
13276
13277 #. type: textblock
13278 #: ../fish/guestfish-actions.pod:3818 ../src/guestfs-actions.pod:5933
13279 msgid "End of the partition in bytes."
13280 msgstr ""
13281
13282 #. type: =item
13283 #: ../fish/guestfish-actions.pod:3820 ../src/guestfs-actions.pod:5935
13284 msgid "B<part_size>"
13285 msgstr ""
13286
13287 #. type: textblock
13288 #: ../fish/guestfish-actions.pod:3822 ../src/guestfs-actions.pod:5937
13289 msgid "Size of the partition in bytes."
13290 msgstr ""
13291
13292 #. type: =head2
13293 #: ../fish/guestfish-actions.pod:3826
13294 msgid "part-set-bootable"
13295 msgstr ""
13296
13297 #. type: verbatim
13298 #: ../fish/guestfish-actions.pod:3828
13299 #, no-wrap
13300 msgid ""
13301 " part-set-bootable device partnum true|false\n"
13302 "\n"
13303 msgstr ""
13304
13305 #. type: textblock
13306 #: ../fish/guestfish-actions.pod:3830 ../src/guestfs-actions.pod:5955
13307 msgid ""
13308 "This sets the bootable flag on partition numbered C<partnum> on device "
13309 "C<device>.  Note that partitions are numbered from 1."
13310 msgstr ""
13311
13312 #. type: textblock
13313 #: ../fish/guestfish-actions.pod:3833 ../src/guestfs-actions.pod:5958
13314 msgid ""
13315 "The bootable flag is used by some operating systems (notably Windows) to "
13316 "determine which partition to boot from.  It is by no means universally "
13317 "recognized."
13318 msgstr ""
13319
13320 #. type: =head2
13321 #: ../fish/guestfish-actions.pod:3837
13322 msgid "part-set-mbr-id"
13323 msgstr ""
13324
13325 #. type: verbatim
13326 #: ../fish/guestfish-actions.pod:3839
13327 #, no-wrap
13328 msgid ""
13329 " part-set-mbr-id device partnum idbyte\n"
13330 "\n"
13331 msgstr ""
13332
13333 #. type: textblock
13334 #: ../fish/guestfish-actions.pod:3841 ../src/guestfs-actions.pod:5974
13335 msgid ""
13336 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
13337 "C<partnum> to C<idbyte>.  Note that the type bytes quoted in most "
13338 "documentation are in fact hexadecimal numbers, but usually documented "
13339 "without any leading \"0x\" which might be confusing."
13340 msgstr ""
13341
13342 #. type: =head2
13343 #: ../fish/guestfish-actions.pod:3851
13344 msgid "part-set-name"
13345 msgstr ""
13346
13347 #. type: verbatim
13348 #: ../fish/guestfish-actions.pod:3853
13349 #, no-wrap
13350 msgid ""
13351 " part-set-name device partnum name\n"
13352 "\n"
13353 msgstr ""
13354
13355 #. type: textblock
13356 #: ../fish/guestfish-actions.pod:3855 ../src/guestfs-actions.pod:5996
13357 msgid ""
13358 "This sets the partition name on partition numbered C<partnum> on device "
13359 "C<device>.  Note that partitions are numbered from 1."
13360 msgstr ""
13361
13362 #. type: textblock
13363 #: ../fish/guestfish-actions.pod:3858 ../src/guestfs-actions.pod:5999
13364 msgid ""
13365 "The partition name can only be set on certain types of partition table.  "
13366 "This works on C<gpt> but not on C<mbr> partitions."
13367 msgstr ""
13368
13369 #. type: =head2
13370 #: ../fish/guestfish-actions.pod:3861
13371 msgid "part-to-dev"
13372 msgstr ""
13373
13374 #. type: verbatim
13375 #: ../fish/guestfish-actions.pod:3863
13376 #, no-wrap
13377 msgid ""
13378 " part-to-dev partition\n"
13379 "\n"
13380 msgstr ""
13381
13382 #. type: textblock
13383 #: ../fish/guestfish-actions.pod:3865 ../src/guestfs-actions.pod:6012
13384 msgid ""
13385 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
13386 "partition number, returning the device name (eg. \"/dev/sdb\")."
13387 msgstr ""
13388
13389 #. type: textblock
13390 #: ../fish/guestfish-actions.pod:3869 ../fish/guestfish-actions.pod:3881
13391 msgid ""
13392 "The named partition must exist, for example as a string returned from "
13393 "L</list-partitions>."
13394 msgstr ""
13395
13396 #. type: textblock
13397 #: ../fish/guestfish-actions.pod:3872
13398 msgid "See also L</part-to-partnum>."
13399 msgstr ""
13400
13401 #. type: =head2
13402 #: ../fish/guestfish-actions.pod:3874
13403 msgid "part-to-partnum"
13404 msgstr ""
13405
13406 #. type: verbatim
13407 #: ../fish/guestfish-actions.pod:3876
13408 #, no-wrap
13409 msgid ""
13410 " part-to-partnum partition\n"
13411 "\n"
13412 msgstr ""
13413
13414 #. type: textblock
13415 #: ../fish/guestfish-actions.pod:3878 ../src/guestfs-actions.pod:6032
13416 msgid ""
13417 "This function takes a partition name (eg. \"/dev/sdb1\") and returns the "
13418 "partition number (eg. C<1>)."
13419 msgstr ""
13420
13421 #. type: textblock
13422 #: ../fish/guestfish-actions.pod:3884
13423 msgid "See also L</part-to-dev>."
13424 msgstr ""
13425
13426 #. type: =head2
13427 #: ../fish/guestfish-actions.pod:3886
13428 msgid "ping-daemon"
13429 msgstr ""
13430
13431 #. type: verbatim
13432 #: ../fish/guestfish-actions.pod:3888
13433 #, no-wrap
13434 msgid ""
13435 " ping-daemon\n"
13436 "\n"
13437 msgstr ""
13438
13439 #. type: textblock
13440 #: ../fish/guestfish-actions.pod:3890 ../src/guestfs-actions.pod:6049
13441 msgid ""
13442 "This is a test probe into the guestfs daemon running inside the qemu "
13443 "subprocess.  Calling this function checks that the daemon responds to the "
13444 "ping message, without affecting the daemon or attached block device(s) in "
13445 "any other way."
13446 msgstr ""
13447
13448 #. type: =head2
13449 #: ../fish/guestfish-actions.pod:3895
13450 msgid "pread"
13451 msgstr ""
13452
13453 #. type: verbatim
13454 #: ../fish/guestfish-actions.pod:3897
13455 #, no-wrap
13456 msgid ""
13457 " pread path count offset\n"
13458 "\n"
13459 msgstr ""
13460
13461 #. type: textblock
13462 #: ../fish/guestfish-actions.pod:3899 ../src/guestfs-actions.pod:6067
13463 msgid ""
13464 "This command lets you read part of a file.  It reads C<count> bytes of the "
13465 "file, starting at C<offset>, from file C<path>."
13466 msgstr ""
13467
13468 #. type: textblock
13469 #: ../fish/guestfish-actions.pod:3902 ../fish/guestfish-actions.pod:3917 ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6096
13470 msgid ""
13471 "This may read fewer bytes than requested.  For further details see the "
13472 "L<pread(2)> system call."
13473 msgstr ""
13474
13475 #. type: textblock
13476 #: ../fish/guestfish-actions.pod:3905
13477 msgid "See also L</pwrite>, L</pread-device>."
13478 msgstr ""
13479
13480 #. type: =head2
13481 #: ../fish/guestfish-actions.pod:3910
13482 msgid "pread-device"
13483 msgstr ""
13484
13485 #. type: verbatim
13486 #: ../fish/guestfish-actions.pod:3912
13487 #, no-wrap
13488 msgid ""
13489 " pread-device device count offset\n"
13490 "\n"
13491 msgstr ""
13492
13493 #. type: textblock
13494 #: ../fish/guestfish-actions.pod:3914 ../src/guestfs-actions.pod:6093
13495 msgid ""
13496 "This command lets you read part of a file.  It reads C<count> bytes of "
13497 "C<device>, starting at C<offset>."
13498 msgstr ""
13499
13500 #. type: textblock
13501 #: ../fish/guestfish-actions.pod:3920
13502 msgid "See also L</pread>."
13503 msgstr ""
13504
13505 #. type: =head2
13506 #: ../fish/guestfish-actions.pod:3925
13507 msgid "pvcreate"
13508 msgstr ""
13509
13510 #. type: verbatim
13511 #: ../fish/guestfish-actions.pod:3927
13512 #, no-wrap
13513 msgid ""
13514 " pvcreate device\n"
13515 "\n"
13516 msgstr ""
13517
13518 #. type: textblock
13519 #: ../fish/guestfish-actions.pod:3929 ../src/guestfs-actions.pod:6116
13520 msgid ""
13521 "This creates an LVM physical volume on the named C<device>, where C<device> "
13522 "should usually be a partition name such as C</dev/sda1>."
13523 msgstr ""
13524
13525 #. type: =head2
13526 #: ../fish/guestfish-actions.pod:3933
13527 msgid "pvremove"
13528 msgstr ""
13529
13530 #. type: verbatim
13531 #: ../fish/guestfish-actions.pod:3935
13532 #, no-wrap
13533 msgid ""
13534 " pvremove device\n"
13535 "\n"
13536 msgstr ""
13537
13538 #. type: textblock
13539 #: ../fish/guestfish-actions.pod:3937 ../src/guestfs-actions.pod:6130
13540 msgid ""
13541 "This wipes a physical volume C<device> so that LVM will no longer recognise "
13542 "it."
13543 msgstr ""
13544
13545 #. type: textblock
13546 #: ../fish/guestfish-actions.pod:3940 ../src/guestfs-actions.pod:6133
13547 msgid ""
13548 "The implementation uses the C<pvremove> command which refuses to wipe "
13549 "physical volumes that contain any volume groups, so you have to remove those "
13550 "first."
13551 msgstr ""
13552
13553 #. type: =head2
13554 #: ../fish/guestfish-actions.pod:3944
13555 msgid "pvresize"
13556 msgstr ""
13557
13558 #. type: verbatim
13559 #: ../fish/guestfish-actions.pod:3946
13560 #, no-wrap
13561 msgid ""
13562 " pvresize device\n"
13563 "\n"
13564 msgstr ""
13565
13566 #. type: textblock
13567 #: ../fish/guestfish-actions.pod:3948 ../src/guestfs-actions.pod:6147
13568 msgid ""
13569 "This resizes (expands or shrinks) an existing LVM physical volume to match "
13570 "the new size of the underlying device."
13571 msgstr ""
13572
13573 #. type: =head2
13574 #: ../fish/guestfish-actions.pod:3951
13575 msgid "pvresize-size"
13576 msgstr ""
13577
13578 #. type: verbatim
13579 #: ../fish/guestfish-actions.pod:3953
13580 #, no-wrap
13581 msgid ""
13582 " pvresize-size device size\n"
13583 "\n"
13584 msgstr ""
13585
13586 #. type: textblock
13587 #: ../fish/guestfish-actions.pod:3955
13588 msgid ""
13589 "This command is the same as L</pvresize> except that it allows you to "
13590 "specify the new size (in bytes) explicitly."
13591 msgstr ""
13592
13593 #. type: =head2
13594 #: ../fish/guestfish-actions.pod:3958
13595 msgid "pvs"
13596 msgstr ""
13597
13598 #. type: verbatim
13599 #: ../fish/guestfish-actions.pod:3960
13600 #, no-wrap
13601 msgid ""
13602 " pvs\n"
13603 "\n"
13604 msgstr ""
13605
13606 #. type: textblock
13607 #: ../fish/guestfish-actions.pod:3962 ../src/guestfs-actions.pod:6173
13608 msgid ""
13609 "List all the physical volumes detected.  This is the equivalent of the "
13610 "L<pvs(8)> command."
13611 msgstr ""
13612
13613 #. type: textblock
13614 #: ../fish/guestfish-actions.pod:3965 ../src/guestfs-actions.pod:6176
13615 msgid ""
13616 "This returns a list of just the device names that contain PVs "
13617 "(eg. C</dev/sda2>)."
13618 msgstr ""
13619
13620 #. type: textblock
13621 #: ../fish/guestfish-actions.pod:3968
13622 msgid "See also L</pvs-full>."
13623 msgstr ""
13624
13625 #. type: =head2
13626 #: ../fish/guestfish-actions.pod:3970
13627 msgid "pvs-full"
13628 msgstr ""
13629
13630 #. type: verbatim
13631 #: ../fish/guestfish-actions.pod:3972
13632 #, no-wrap
13633 msgid ""
13634 " pvs-full\n"
13635 "\n"
13636 msgstr ""
13637
13638 #. type: textblock
13639 #: ../fish/guestfish-actions.pod:3974 ../src/guestfs-actions.pod:6192
13640 msgid ""
13641 "List all the physical volumes detected.  This is the equivalent of the "
13642 "L<pvs(8)> command.  The \"full\" version includes all fields."
13643 msgstr ""
13644
13645 #. type: =head2
13646 #: ../fish/guestfish-actions.pod:3977
13647 msgid "pvuuid"
13648 msgstr ""
13649
13650 #. type: verbatim
13651 #: ../fish/guestfish-actions.pod:3979
13652 #, no-wrap
13653 msgid ""
13654 " pvuuid device\n"
13655 "\n"
13656 msgstr ""
13657
13658 #. type: textblock
13659 #: ../fish/guestfish-actions.pod:3981 ../src/guestfs-actions.pod:6207
13660 msgid "This command returns the UUID of the LVM PV C<device>."
13661 msgstr ""
13662
13663 #. type: =head2
13664 #: ../fish/guestfish-actions.pod:3983
13665 msgid "pwrite"
13666 msgstr ""
13667
13668 #. type: verbatim
13669 #: ../fish/guestfish-actions.pod:3985
13670 #, no-wrap
13671 msgid ""
13672 " pwrite path content offset\n"
13673 "\n"
13674 msgstr ""
13675
13676 #. type: textblock
13677 #: ../fish/guestfish-actions.pod:3987 ../src/guestfs-actions.pod:6223
13678 msgid ""
13679 "This command writes to part of a file.  It writes the data buffer C<content> "
13680 "to the file C<path> starting at offset C<offset>."
13681 msgstr ""
13682
13683 #. type: textblock
13684 #: ../fish/guestfish-actions.pod:3990 ../src/guestfs-actions.pod:6226
13685 msgid ""
13686 "This command implements the L<pwrite(2)> system call, and like that system "
13687 "call it may not write the full data requested.  The return value is the "
13688 "number of bytes that were actually written to the file.  This could even be "
13689 "0, although short writes are unlikely for regular files in ordinary "
13690 "circumstances."
13691 msgstr ""
13692
13693 #. type: textblock
13694 #: ../fish/guestfish-actions.pod:3996
13695 msgid "See also L</pread>, L</pwrite-device>."
13696 msgstr ""
13697
13698 #. type: =head2
13699 #: ../fish/guestfish-actions.pod:4001
13700 msgid "pwrite-device"
13701 msgstr ""
13702
13703 #. type: verbatim
13704 #: ../fish/guestfish-actions.pod:4003
13705 #, no-wrap
13706 msgid ""
13707 " pwrite-device device content offset\n"
13708 "\n"
13709 msgstr ""
13710
13711 #. type: textblock
13712 #: ../fish/guestfish-actions.pod:4005 ../src/guestfs-actions.pod:6250
13713 msgid ""
13714 "This command writes to part of a device.  It writes the data buffer "
13715 "C<content> to C<device> starting at offset C<offset>."
13716 msgstr ""
13717
13718 #. type: textblock
13719 #: ../fish/guestfish-actions.pod:4008 ../src/guestfs-actions.pod:6253
13720 msgid ""
13721 "This command implements the L<pwrite(2)> system call, and like that system "
13722 "call it may not write the full data requested (although short writes to disk "
13723 "devices and partitions are probably impossible with standard Linux kernels)."
13724 msgstr ""
13725
13726 #. type: textblock
13727 #: ../fish/guestfish-actions.pod:4013
13728 msgid "See also L</pwrite>."
13729 msgstr ""
13730
13731 #. type: =head2
13732 #: ../fish/guestfish-actions.pod:4018
13733 msgid "read-file"
13734 msgstr ""
13735
13736 #. type: verbatim
13737 #: ../fish/guestfish-actions.pod:4020
13738 #, no-wrap
13739 msgid ""
13740 " read-file path\n"
13741 "\n"
13742 msgstr ""
13743
13744 #. type: textblock
13745 #: ../fish/guestfish-actions.pod:4022 ../src/guestfs-actions.pod:6274
13746 msgid "This calls returns the contents of the file C<path> as a buffer."
13747 msgstr ""
13748
13749 #. type: textblock
13750 #: ../fish/guestfish-actions.pod:4025
13751 msgid ""
13752 "Unlike L</cat>, this function can correctly handle files that contain "
13753 "embedded ASCII NUL characters.  However unlike L</download>, this function "
13754 "is limited in the total size of file that can be handled."
13755 msgstr ""
13756
13757 #. type: =head2
13758 #: ../fish/guestfish-actions.pod:4033
13759 msgid "read-lines"
13760 msgstr ""
13761
13762 #. type: verbatim
13763 #: ../fish/guestfish-actions.pod:4035
13764 #, no-wrap
13765 msgid ""
13766 " read-lines path\n"
13767 "\n"
13768 msgstr ""
13769
13770 #. type: textblock
13771 #: ../fish/guestfish-actions.pod:4039 ../src/guestfs-actions.pod:6299
13772 msgid ""
13773 "The file contents are returned as a list of lines.  Trailing C<LF> and "
13774 "C<CRLF> character sequences are I<not> returned."
13775 msgstr ""
13776
13777 #. type: textblock
13778 #: ../fish/guestfish-actions.pod:4042
13779 msgid ""
13780 "Note that this function cannot correctly handle binary files (specifically, "
13781 "files containing C<\\0> character which is treated as end of line).  For "
13782 "those you need to use the L</read-file> function which has a more complex "
13783 "interface."
13784 msgstr ""
13785
13786 #. type: =head2
13787 #: ../fish/guestfish-actions.pod:4047
13788 msgid "readdir"
13789 msgstr ""
13790
13791 #. type: verbatim
13792 #: ../fish/guestfish-actions.pod:4049
13793 #, no-wrap
13794 msgid ""
13795 " readdir dir\n"
13796 "\n"
13797 msgstr ""
13798
13799 #. type: textblock
13800 #: ../fish/guestfish-actions.pod:4051 ../src/guestfs-actions.pod:6319
13801 msgid "This returns the list of directory entries in directory C<dir>."
13802 msgstr ""
13803
13804 #. type: textblock
13805 #: ../fish/guestfish-actions.pod:4053 ../src/guestfs-actions.pod:6321
13806 msgid ""
13807 "All entries in the directory are returned, including C<.> and C<..>.  The "
13808 "entries are I<not> sorted, but returned in the same order as the underlying "
13809 "filesystem."
13810 msgstr ""
13811
13812 #. type: textblock
13813 #: ../fish/guestfish-actions.pod:4057 ../src/guestfs-actions.pod:6325
13814 msgid ""
13815 "Also this call returns basic file type information about each file.  The "
13816 "C<ftyp> field will contain one of the following characters:"
13817 msgstr ""
13818
13819 #. type: =item
13820 #: ../fish/guestfish-actions.pod:4062 ../src/guestfs-actions.pod:6330
13821 msgid "'b'"
13822 msgstr ""
13823
13824 #. type: textblock
13825 #: ../fish/guestfish-actions.pod:4064 ../src/guestfs-actions.pod:6332
13826 msgid "Block special"
13827 msgstr ""
13828
13829 #. type: =item
13830 #: ../fish/guestfish-actions.pod:4066 ../src/guestfs-actions.pod:6334
13831 msgid "'c'"
13832 msgstr ""
13833
13834 #. type: textblock
13835 #: ../fish/guestfish-actions.pod:4068 ../src/guestfs-actions.pod:6336
13836 msgid "Char special"
13837 msgstr ""
13838
13839 #. type: =item
13840 #: ../fish/guestfish-actions.pod:4070 ../src/guestfs-actions.pod:6338
13841 msgid "'d'"
13842 msgstr ""
13843
13844 #. type: textblock
13845 #: ../fish/guestfish-actions.pod:4072 ../src/guestfs-actions.pod:6340
13846 msgid "Directory"
13847 msgstr ""
13848
13849 #. type: =item
13850 #: ../fish/guestfish-actions.pod:4074 ../src/guestfs-actions.pod:6342
13851 msgid "'f'"
13852 msgstr ""
13853
13854 #. type: textblock
13855 #: ../fish/guestfish-actions.pod:4076 ../src/guestfs-actions.pod:6344
13856 msgid "FIFO (named pipe)"
13857 msgstr ""
13858
13859 #. type: =item
13860 #: ../fish/guestfish-actions.pod:4078 ../src/guestfs-actions.pod:6346
13861 msgid "'l'"
13862 msgstr ""
13863
13864 #. type: textblock
13865 #: ../fish/guestfish-actions.pod:4080 ../src/guestfs-actions.pod:6348
13866 msgid "Symbolic link"
13867 msgstr ""
13868
13869 #. type: =item
13870 #: ../fish/guestfish-actions.pod:4082 ../src/guestfs-actions.pod:6350
13871 msgid "'r'"
13872 msgstr ""
13873
13874 #. type: textblock
13875 #: ../fish/guestfish-actions.pod:4084 ../src/guestfs-actions.pod:6352
13876 msgid "Regular file"
13877 msgstr ""
13878
13879 #. type: =item
13880 #: ../fish/guestfish-actions.pod:4086 ../src/guestfs-actions.pod:6354
13881 msgid "'s'"
13882 msgstr ""
13883
13884 #. type: textblock
13885 #: ../fish/guestfish-actions.pod:4088 ../src/guestfs-actions.pod:6356
13886 msgid "Socket"
13887 msgstr ""
13888
13889 #. type: =item
13890 #: ../fish/guestfish-actions.pod:4090 ../src/guestfs-actions.pod:6358
13891 msgid "'u'"
13892 msgstr ""
13893
13894 #. type: textblock
13895 #: ../fish/guestfish-actions.pod:4092 ../src/guestfs-actions.pod:6360
13896 msgid "Unknown file type"
13897 msgstr ""
13898
13899 #. type: =item
13900 #: ../fish/guestfish-actions.pod:4094 ../src/guestfs-actions.pod:6362
13901 msgid "'?'"
13902 msgstr ""
13903
13904 #. type: textblock
13905 #: ../fish/guestfish-actions.pod:4096 ../src/guestfs-actions.pod:6364
13906 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13907 msgstr ""
13908
13909 #. type: textblock
13910 #: ../fish/guestfish-actions.pod:4101
13911 msgid ""
13912 "This function is primarily intended for use by programs.  To get a simple "
13913 "list of names, use L</ls>.  To get a printable directory for human "
13914 "consumption, use L</ll>."
13915 msgstr ""
13916
13917 #. type: =head2
13918 #: ../fish/guestfish-actions.pod:4105
13919 msgid "readlink"
13920 msgstr ""
13921
13922 #. type: verbatim
13923 #: ../fish/guestfish-actions.pod:4107
13924 #, no-wrap
13925 msgid ""
13926 " readlink path\n"
13927 "\n"
13928 msgstr ""
13929
13930 #. type: textblock
13931 #: ../fish/guestfish-actions.pod:4109 ../src/guestfs-actions.pod:6385
13932 msgid "This command reads the target of a symbolic link."
13933 msgstr ""
13934
13935 #. type: =head2
13936 #: ../fish/guestfish-actions.pod:4111
13937 msgid "readlinklist"
13938 msgstr ""
13939
13940 #. type: verbatim
13941 #: ../fish/guestfish-actions.pod:4113
13942 #, no-wrap
13943 msgid ""
13944 " readlinklist path 'names ...'\n"
13945 "\n"
13946 msgstr ""
13947
13948 #. type: textblock
13949 #: ../fish/guestfish-actions.pod:4115 ../src/guestfs-actions.pod:6399
13950 msgid ""
13951 "This call allows you to do a C<readlink> operation on multiple files, where "
13952 "all files are in the directory C<path>.  C<names> is the list of files from "
13953 "this directory."
13954 msgstr ""
13955
13956 #. type: textblock
13957 #: ../fish/guestfish-actions.pod:4119 ../src/guestfs-actions.pod:6403
13958 msgid ""
13959 "On return you get a list of strings, with a one-to-one correspondence to the "
13960 "C<names> list.  Each string is the value of the symbolic link."
13961 msgstr ""
13962
13963 #. type: textblock
13964 #: ../fish/guestfish-actions.pod:4123 ../src/guestfs-actions.pod:6407
13965 msgid ""
13966 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13967 "result string is the empty string C<\"\">.  However the whole operation is "
13968 "completed even if there were C<readlink(2)> errors, and so you can call this "
13969 "function with names where you don't know if they are symbolic links already "
13970 "(albeit slightly less efficient)."
13971 msgstr ""
13972
13973 #. type: textblock
13974 #: ../fish/guestfish-actions.pod:4130 ../src/guestfs-actions.pod:6414
13975 msgid ""
13976 "This call is intended for programs that want to efficiently list a directory "
13977 "contents without making many round-trips.  Very long directory listings "
13978 "might cause the protocol message size to be exceeded, causing this call to "
13979 "fail.  The caller must split up such requests into smaller groups of names."
13980 msgstr ""
13981
13982 #. type: =head2
13983 #: ../fish/guestfish-actions.pod:4137
13984 msgid "realpath"
13985 msgstr ""
13986
13987 #. type: verbatim
13988 #: ../fish/guestfish-actions.pod:4139
13989 #, no-wrap
13990 msgid ""
13991 " realpath path\n"
13992 "\n"
13993 msgstr ""
13994
13995 #. type: textblock
13996 #: ../fish/guestfish-actions.pod:4141 ../src/guestfs-actions.pod:6433
13997 msgid ""
13998 "Return the canonicalized absolute pathname of C<path>.  The returned path "
13999 "has no C<.>, C<..> or symbolic link path elements."
14000 msgstr ""
14001
14002 #. type: =head2
14003 #: ../fish/guestfish-actions.pod:4144
14004 msgid "removexattr"
14005 msgstr ""
14006
14007 #. type: verbatim
14008 #: ../fish/guestfish-actions.pod:4146
14009 #, no-wrap
14010 msgid ""
14011 " removexattr xattr path\n"
14012 "\n"
14013 msgstr ""
14014
14015 #. type: textblock
14016 #: ../fish/guestfish-actions.pod:4148 ../src/guestfs-actions.pod:6448
14017 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
14018 msgstr ""
14019
14020 #. type: textblock
14021 #: ../fish/guestfish-actions.pod:4151
14022 msgid "See also: L</lremovexattr>, L<attr(5)>."
14023 msgstr ""
14024
14025 #. type: =head2
14026 #: ../fish/guestfish-actions.pod:4153
14027 msgid "resize2fs"
14028 msgstr ""
14029
14030 #. type: verbatim
14031 #: ../fish/guestfish-actions.pod:4155
14032 #, no-wrap
14033 msgid ""
14034 " resize2fs device\n"
14035 "\n"
14036 msgstr ""
14037
14038 #. type: textblock
14039 #: ../fish/guestfish-actions.pod:4157 ../src/guestfs-actions.pod:6463
14040 msgid ""
14041 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
14042 "underlying device."
14043 msgstr ""
14044
14045 #. type: textblock
14046 #: ../fish/guestfish-actions.pod:4160
14047 msgid ""
14048 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
14049 "before calling this command.  For unknown reasons C<resize2fs> sometimes "
14050 "gives an error about this and sometimes not.  In any case, it is always safe "
14051 "to call L</e2fsck-f> before calling this function."
14052 msgstr ""
14053
14054 #. type: =head2
14055 #: ../fish/guestfish-actions.pod:4166
14056 msgid "resize2fs-M"
14057 msgstr ""
14058
14059 #. type: verbatim
14060 #: ../fish/guestfish-actions.pod:4168
14061 #, no-wrap
14062 msgid ""
14063 " resize2fs-M device\n"
14064 "\n"
14065 msgstr ""
14066
14067 #. type: textblock
14068 #: ../fish/guestfish-actions.pod:4170
14069 msgid ""
14070 "This command is the same as L</resize2fs>, but the filesystem is resized to "
14071 "its minimum size.  This works like the I<-M> option to the C<resize2fs> "
14072 "command."
14073 msgstr ""
14074
14075 #. type: textblock
14076 #: ../fish/guestfish-actions.pod:4174
14077 msgid ""
14078 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
14079 "and read the C<Block size> and C<Block count> values.  These two numbers, "
14080 "multiplied together, give the resulting size of the minimal filesystem in "
14081 "bytes."
14082 msgstr ""
14083
14084 #. type: =head2
14085 #: ../fish/guestfish-actions.pod:4179
14086 msgid "resize2fs-size"
14087 msgstr ""
14088
14089 #. type: verbatim
14090 #: ../fish/guestfish-actions.pod:4181
14091 #, no-wrap
14092 msgid ""
14093 " resize2fs-size device size\n"
14094 "\n"
14095 msgstr ""
14096
14097 #. type: textblock
14098 #: ../fish/guestfish-actions.pod:4183
14099 msgid ""
14100 "This command is the same as L</resize2fs> except that it allows you to "
14101 "specify the new size (in bytes) explicitly."
14102 msgstr ""
14103
14104 #. type: =head2
14105 #: ../fish/guestfish-actions.pod:4186
14106 msgid "rm"
14107 msgstr ""
14108
14109 #. type: verbatim
14110 #: ../fish/guestfish-actions.pod:4188
14111 #, no-wrap
14112 msgid ""
14113 " rm path\n"
14114 "\n"
14115 msgstr ""
14116
14117 #. type: textblock
14118 #: ../fish/guestfish-actions.pod:4190 ../src/guestfs-actions.pod:6515
14119 msgid "Remove the single file C<path>."
14120 msgstr ""
14121
14122 #. type: =head2
14123 #: ../fish/guestfish-actions.pod:4192
14124 msgid "rm-rf"
14125 msgstr ""
14126
14127 #. type: verbatim
14128 #: ../fish/guestfish-actions.pod:4194
14129 #, no-wrap
14130 msgid ""
14131 " rm-rf path\n"
14132 "\n"
14133 msgstr ""
14134
14135 #. type: textblock
14136 #: ../fish/guestfish-actions.pod:4196 ../src/guestfs-actions.pod:6527
14137 msgid ""
14138 "Remove the file or directory C<path>, recursively removing the contents if "
14139 "its a directory.  This is like the C<rm -rf> shell command."
14140 msgstr ""
14141
14142 #. type: =head2
14143 #: ../fish/guestfish-actions.pod:4200
14144 msgid "rmdir"
14145 msgstr ""
14146
14147 #. type: verbatim
14148 #: ../fish/guestfish-actions.pod:4202
14149 #, no-wrap
14150 msgid ""
14151 " rmdir path\n"
14152 "\n"
14153 msgstr ""
14154
14155 #. type: textblock
14156 #: ../fish/guestfish-actions.pod:4204 ../src/guestfs-actions.pod:6541
14157 msgid "Remove the single directory C<path>."
14158 msgstr ""
14159
14160 #. type: =head2
14161 #: ../fish/guestfish-actions.pod:4206
14162 msgid "rmmountpoint"
14163 msgstr ""
14164
14165 #. type: verbatim
14166 #: ../fish/guestfish-actions.pod:4208
14167 #, no-wrap
14168 msgid ""
14169 " rmmountpoint exemptpath\n"
14170 "\n"
14171 msgstr ""
14172
14173 #. type: textblock
14174 #: ../fish/guestfish-actions.pod:4210
14175 msgid ""
14176 "This calls removes a mountpoint that was previously created with "
14177 "L</mkmountpoint>.  See L</mkmountpoint> for full details."
14178 msgstr ""
14179
14180 #. type: =head2
14181 #: ../fish/guestfish-actions.pod:4214
14182 msgid "scrub-device"
14183 msgstr ""
14184
14185 #. type: verbatim
14186 #: ../fish/guestfish-actions.pod:4216
14187 #, no-wrap
14188 msgid ""
14189 " scrub-device device\n"
14190 "\n"
14191 msgstr ""
14192
14193 #. type: textblock
14194 #: ../fish/guestfish-actions.pod:4218 ../src/guestfs-actions.pod:6567
14195 msgid ""
14196 "This command writes patterns over C<device> to make data retrieval more "
14197 "difficult."
14198 msgstr ""
14199
14200 #. type: textblock
14201 #: ../fish/guestfish-actions.pod:4221 ../fish/guestfish-actions.pod:4233 ../fish/guestfish-actions.pod:4246 ../src/guestfs-actions.pod:6570 ../src/guestfs-actions.pod:6588 ../src/guestfs-actions.pod:6607
14202 msgid ""
14203 "It is an interface to the L<scrub(1)> program.  See that manual page for "
14204 "more details."
14205 msgstr ""
14206
14207 #. type: =head2
14208 #: ../fish/guestfish-actions.pod:4224
14209 msgid "scrub-file"
14210 msgstr ""
14211
14212 #. type: verbatim
14213 #: ../fish/guestfish-actions.pod:4226
14214 #, no-wrap
14215 msgid ""
14216 " scrub-file file\n"
14217 "\n"
14218 msgstr ""
14219
14220 #. type: textblock
14221 #: ../fish/guestfish-actions.pod:4228 ../src/guestfs-actions.pod:6583
14222 msgid ""
14223 "This command writes patterns over a file to make data retrieval more "
14224 "difficult."
14225 msgstr ""
14226
14227 #. type: textblock
14228 #: ../fish/guestfish-actions.pod:4231 ../src/guestfs-actions.pod:6586
14229 msgid "The file is I<removed> after scrubbing."
14230 msgstr ""
14231
14232 #. type: =head2
14233 #: ../fish/guestfish-actions.pod:4236
14234 msgid "scrub-freespace"
14235 msgstr ""
14236
14237 #. type: verbatim
14238 #: ../fish/guestfish-actions.pod:4238
14239 #, no-wrap
14240 msgid ""
14241 " scrub-freespace dir\n"
14242 "\n"
14243 msgstr ""
14244
14245 #. type: textblock
14246 #: ../fish/guestfish-actions.pod:4240
14247 msgid ""
14248 "This command creates the directory C<dir> and then fills it with files until "
14249 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
14250 "deletes them.  The intention is to scrub any free space on the partition "
14251 "containing C<dir>."
14252 msgstr ""
14253
14254 #. type: =head2
14255 #: ../fish/guestfish-actions.pod:4249
14256 msgid "set-append"
14257 msgstr ""
14258
14259 #. type: =head2
14260 #: ../fish/guestfish-actions.pod:4251
14261 msgid "append"
14262 msgstr ""
14263
14264 #. type: verbatim
14265 #: ../fish/guestfish-actions.pod:4253
14266 #, no-wrap
14267 msgid ""
14268 " set-append append\n"
14269 "\n"
14270 msgstr ""
14271
14272 #. type: textblock
14273 #: ../fish/guestfish-actions.pod:4255 ../src/guestfs-actions.pod:6620
14274 msgid ""
14275 "This function is used to add additional options to the guest kernel command "
14276 "line."
14277 msgstr ""
14278
14279 #. type: textblock
14280 #: ../fish/guestfish-actions.pod:4258 ../src/guestfs-actions.pod:6623
14281 msgid ""
14282 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
14283 "environment variable."
14284 msgstr ""
14285
14286 #. type: textblock
14287 #: ../fish/guestfish-actions.pod:4261 ../src/guestfs-actions.pod:6626
14288 msgid ""
14289 "Setting C<append> to C<NULL> means I<no> additional options are passed "
14290 "(libguestfs always adds a few of its own)."
14291 msgstr ""
14292
14293 #. type: =head2
14294 #: ../fish/guestfish-actions.pod:4264
14295 msgid "set-attach-method"
14296 msgstr ""
14297
14298 #. type: =head2
14299 #: ../fish/guestfish-actions.pod:4266
14300 msgid "attach-method"
14301 msgstr ""
14302
14303 #. type: verbatim
14304 #: ../fish/guestfish-actions.pod:4268
14305 #, no-wrap
14306 msgid ""
14307 " set-attach-method attachmethod\n"
14308 "\n"
14309 msgstr ""
14310
14311 #. type: textblock
14312 #: ../fish/guestfish-actions.pod:4270 ../src/guestfs-actions.pod:6639
14313 msgid ""
14314 "Set the method that libguestfs uses to connect to the back end guestfsd "
14315 "daemon.  Possible methods are:"
14316 msgstr ""
14317
14318 #. type: =item
14319 #: ../fish/guestfish-actions.pod:4275 ../src/guestfs-actions.pod:6644 ../src/guestfs.pod:2916
14320 msgid "C<appliance>"
14321 msgstr ""
14322
14323 #. type: textblock
14324 #: ../fish/guestfish-actions.pod:4277 ../src/guestfs-actions.pod:6646
14325 msgid ""
14326 "Launch an appliance and connect to it.  This is the ordinary method and the "
14327 "default."
14328 msgstr ""
14329
14330 #. type: =item
14331 #: ../fish/guestfish-actions.pod:4280 ../src/guestfs-actions.pod:6649
14332 msgid "C<unix:I<path>>"
14333 msgstr ""
14334
14335 #. type: textblock
14336 #: ../fish/guestfish-actions.pod:4282 ../src/guestfs-actions.pod:6651
14337 msgid "Connect to the Unix domain socket I<path>."
14338 msgstr ""
14339
14340 #. type: textblock
14341 #: ../fish/guestfish-actions.pod:4284 ../src/guestfs-actions.pod:6653
14342 msgid ""
14343 "This method lets you connect to an existing daemon or (using virtio-serial) "
14344 "to a live guest.  For more information, see L<guestfs(3)/ATTACHING TO "
14345 "RUNNING DAEMONS>."
14346 msgstr ""
14347
14348 #. type: =head2
14349 #: ../fish/guestfish-actions.pod:4290
14350 msgid "set-autosync"
14351 msgstr ""
14352
14353 #. type: =head2
14354 #: ../fish/guestfish-actions.pod:4292
14355 msgid "autosync"
14356 msgstr ""
14357
14358 #. type: verbatim
14359 #: ../fish/guestfish-actions.pod:4294
14360 #, no-wrap
14361 msgid ""
14362 " set-autosync true|false\n"
14363 "\n"
14364 msgstr ""
14365
14366 #. type: textblock
14367 #: ../fish/guestfish-actions.pod:4296 ../src/guestfs-actions.pod:6669
14368 msgid ""
14369 "If C<autosync> is true, this enables autosync.  Libguestfs will make a best "
14370 "effort attempt to make filesystems consistent and synchronized when the "
14371 "handle is closed (also if the program exits without closing handles)."
14372 msgstr ""
14373
14374 #. type: textblock
14375 #: ../fish/guestfish-actions.pod:4301 ../src/guestfs-actions.pod:6674
14376 msgid ""
14377 "This is enabled by default (since libguestfs 1.5.24, previously it was "
14378 "disabled by default)."
14379 msgstr ""
14380
14381 #. type: =head2
14382 #: ../fish/guestfish-actions.pod:4304
14383 msgid "set-direct"
14384 msgstr ""
14385
14386 #. type: =head2
14387 #: ../fish/guestfish-actions.pod:4306
14388 msgid "direct"
14389 msgstr ""
14390
14391 #. type: verbatim
14392 #: ../fish/guestfish-actions.pod:4308
14393 #, no-wrap
14394 msgid ""
14395 " set-direct true|false\n"
14396 "\n"
14397 msgstr ""
14398
14399 #. type: textblock
14400 #: ../fish/guestfish-actions.pod:4310 ../src/guestfs-actions.pod:6687
14401 msgid ""
14402 "If the direct appliance mode flag is enabled, then stdin and stdout are "
14403 "passed directly through to the appliance once it is launched."
14404 msgstr ""
14405
14406 #. type: textblock
14407 #: ../fish/guestfish-actions.pod:4314
14408 msgid ""
14409 "One consequence of this is that log messages aren't caught by the library "
14410 "and handled by L</set-log-message-callback>, but go straight to stdout."
14411 msgstr ""
14412
14413 #. type: textblock
14414 #: ../fish/guestfish-actions.pod:4318 ../src/guestfs-actions.pod:6695
14415 msgid "You probably don't want to use this unless you know what you are doing."
14416 msgstr ""
14417
14418 #. type: textblock
14419 #: ../fish/guestfish-actions.pod:4321 ../src/guestfs-actions.pod:6698
14420 msgid "The default is disabled."
14421 msgstr ""
14422
14423 #. type: =head2
14424 #: ../fish/guestfish-actions.pod:4323
14425 msgid "set-e2label"
14426 msgstr ""
14427
14428 #. type: verbatim
14429 #: ../fish/guestfish-actions.pod:4325
14430 #, no-wrap
14431 msgid ""
14432 " set-e2label device label\n"
14433 "\n"
14434 msgstr ""
14435
14436 #. type: textblock
14437 #: ../fish/guestfish-actions.pod:4327 ../src/guestfs-actions.pod:6711
14438 msgid ""
14439 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
14440 "C<label>.  Filesystem labels are limited to 16 characters."
14441 msgstr ""
14442
14443 #. type: textblock
14444 #: ../fish/guestfish-actions.pod:4331
14445 msgid ""
14446 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
14447 "label on a filesystem."
14448 msgstr ""
14449
14450 #. type: =head2
14451 #: ../fish/guestfish-actions.pod:4334
14452 msgid "set-e2uuid"
14453 msgstr ""
14454
14455 #. type: verbatim
14456 #: ../fish/guestfish-actions.pod:4336
14457 #, no-wrap
14458 msgid ""
14459 " set-e2uuid device uuid\n"
14460 "\n"
14461 msgstr ""
14462
14463 #. type: textblock
14464 #: ../fish/guestfish-actions.pod:4338 ../src/guestfs-actions.pod:6729
14465 msgid ""
14466 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
14467 "C<uuid>.  The format of the UUID and alternatives such as C<clear>, "
14468 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
14469 msgstr ""
14470
14471 #. type: textblock
14472 #: ../fish/guestfish-actions.pod:4343
14473 msgid ""
14474 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
14475 "UUID of a filesystem."
14476 msgstr ""
14477
14478 #. type: =head2
14479 #: ../fish/guestfish-actions.pod:4346
14480 msgid "set-memsize"
14481 msgstr ""
14482
14483 #. type: =head2
14484 #: ../fish/guestfish-actions.pod:4348
14485 msgid "memsize"
14486 msgstr ""
14487
14488 #. type: verbatim
14489 #: ../fish/guestfish-actions.pod:4350
14490 #, no-wrap
14491 msgid ""
14492 " set-memsize memsize\n"
14493 "\n"
14494 msgstr ""
14495
14496 #. type: textblock
14497 #: ../fish/guestfish-actions.pod:4352
14498 msgid ""
14499 "This sets the memory size in megabytes allocated to the qemu subprocess.  "
14500 "This only has any effect if called before L</launch>."
14501 msgstr ""
14502
14503 #. type: textblock
14504 #: ../fish/guestfish-actions.pod:4356 ../src/guestfs-actions.pod:6751
14505 msgid ""
14506 "You can also change this by setting the environment variable "
14507 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
14508 msgstr ""
14509
14510 #. type: =head2
14511 #: ../fish/guestfish-actions.pod:4363
14512 msgid "set-network"
14513 msgstr ""
14514
14515 #. type: =head2
14516 #: ../fish/guestfish-actions.pod:4365
14517 msgid "network"
14518 msgstr ""
14519
14520 #. type: verbatim
14521 #: ../fish/guestfish-actions.pod:4367
14522 #, no-wrap
14523 msgid ""
14524 " set-network true|false\n"
14525 "\n"
14526 msgstr ""
14527
14528 #. type: textblock
14529 #: ../fish/guestfish-actions.pod:4369 ../src/guestfs-actions.pod:6768
14530 msgid ""
14531 "If C<network> is true, then the network is enabled in the libguestfs "
14532 "appliance.  The default is false."
14533 msgstr ""
14534
14535 #. type: textblock
14536 #: ../fish/guestfish-actions.pod:4372 ../src/guestfs-actions.pod:6771
14537 msgid ""
14538 "This affects whether commands are able to access the network (see "
14539 "L<guestfs(3)/RUNNING COMMANDS>)."
14540 msgstr ""
14541
14542 #. type: textblock
14543 #: ../fish/guestfish-actions.pod:4375
14544 msgid "You must call this before calling L</launch>, otherwise it has no effect."
14545 msgstr ""
14546
14547 #. type: =head2
14548 #: ../fish/guestfish-actions.pod:4378
14549 msgid "set-path"
14550 msgstr ""
14551
14552 #. type: verbatim
14553 #: ../fish/guestfish-actions.pod:4382
14554 #, no-wrap
14555 msgid ""
14556 " set-path searchpath\n"
14557 "\n"
14558 msgstr ""
14559
14560 #. type: textblock
14561 #: ../fish/guestfish-actions.pod:4384 ../src/guestfs-actions.pod:6787
14562 msgid "Set the path that libguestfs searches for kernel and initrd.img."
14563 msgstr ""
14564
14565 #. type: textblock
14566 #: ../fish/guestfish-actions.pod:4386 ../src/guestfs-actions.pod:6789
14567 msgid ""
14568 "The default is C<$libdir/guestfs> unless overridden by setting "
14569 "C<LIBGUESTFS_PATH> environment variable."
14570 msgstr ""
14571
14572 #. type: textblock
14573 #: ../fish/guestfish-actions.pod:4389 ../src/guestfs-actions.pod:6792
14574 msgid "Setting C<path> to C<NULL> restores the default path."
14575 msgstr ""
14576
14577 #. type: =head2
14578 #: ../fish/guestfish-actions.pod:4391
14579 msgid "set-pgroup"
14580 msgstr ""
14581
14582 #. type: =head2
14583 #: ../fish/guestfish-actions.pod:4393
14584 msgid "pgroup"
14585 msgstr ""
14586
14587 #. type: verbatim
14588 #: ../fish/guestfish-actions.pod:4395
14589 #, no-wrap
14590 msgid ""
14591 " set-pgroup true|false\n"
14592 "\n"
14593 msgstr ""
14594
14595 #. type: textblock
14596 #: ../fish/guestfish-actions.pod:4397 ../src/guestfs-actions.pod:6804
14597 msgid ""
14598 "If C<pgroup> is true, child processes are placed into their own process "
14599 "group."
14600 msgstr ""
14601
14602 #. type: textblock
14603 #: ../fish/guestfish-actions.pod:4400 ../src/guestfs-actions.pod:6807
14604 msgid ""
14605 "The practical upshot of this is that signals like C<SIGINT> (from users "
14606 "pressing C<^C>) won't be received by the child process."
14607 msgstr ""
14608
14609 #. type: textblock
14610 #: ../fish/guestfish-actions.pod:4403 ../src/guestfs-actions.pod:6810
14611 msgid ""
14612 "The default for this flag is false, because usually you want C<^C> to kill "
14613 "the subprocess."
14614 msgstr ""
14615
14616 #. type: =head2
14617 #: ../fish/guestfish-actions.pod:4406
14618 msgid "set-qemu"
14619 msgstr ""
14620
14621 #. type: =head2
14622 #: ../fish/guestfish-actions.pod:4408
14623 msgid "qemu"
14624 msgstr ""
14625
14626 #. type: verbatim
14627 #: ../fish/guestfish-actions.pod:4410
14628 #, no-wrap
14629 msgid ""
14630 " set-qemu qemu\n"
14631 "\n"
14632 msgstr ""
14633
14634 #. type: textblock
14635 #: ../fish/guestfish-actions.pod:4412 ../src/guestfs-actions.pod:6823
14636 msgid "Set the qemu binary that we will use."
14637 msgstr ""
14638
14639 #. type: textblock
14640 #: ../fish/guestfish-actions.pod:4414 ../src/guestfs-actions.pod:6825
14641 msgid "The default is chosen when the library was compiled by the configure script."
14642 msgstr ""
14643
14644 #. type: textblock
14645 #: ../fish/guestfish-actions.pod:4417 ../src/guestfs-actions.pod:6828
14646 msgid ""
14647 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
14648 "variable."
14649 msgstr ""
14650
14651 #. type: textblock
14652 #: ../fish/guestfish-actions.pod:4420 ../src/guestfs-actions.pod:6831
14653 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
14654 msgstr ""
14655
14656 #. type: textblock
14657 #: ../fish/guestfish-actions.pod:4422 ../src/guestfs-actions.pod:6833
14658 msgid ""
14659 "Note that you should call this function as early as possible after creating "
14660 "the handle.  This is because some pre-launch operations depend on testing "
14661 "qemu features (by running C<qemu -help>).  If the qemu binary changes, we "
14662 "don't retest features, and so you might see inconsistent results.  Using the "
14663 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
14664 "the qemu binary at the same time as the handle is created."
14665 msgstr ""
14666
14667 #. type: =head2
14668 #: ../fish/guestfish-actions.pod:4430
14669 msgid "set-recovery-proc"
14670 msgstr ""
14671
14672 #. type: =head2
14673 #: ../fish/guestfish-actions.pod:4432
14674 msgid "recovery-proc"
14675 msgstr ""
14676
14677 #. type: verbatim
14678 #: ../fish/guestfish-actions.pod:4434
14679 #, no-wrap
14680 msgid ""
14681 " set-recovery-proc true|false\n"
14682 "\n"
14683 msgstr ""
14684
14685 #. type: textblock
14686 #: ../fish/guestfish-actions.pod:4436
14687 msgid ""
14688 "If this is called with the parameter C<false> then L</launch> does not "
14689 "create a recovery process.  The purpose of the recovery process is to stop "
14690 "runaway qemu processes in the case where the main program aborts abruptly."
14691 msgstr ""
14692
14693 #. type: textblock
14694 #: ../fish/guestfish-actions.pod:4441
14695 msgid ""
14696 "This only has any effect if called before L</launch>, and the default is "
14697 "true."
14698 msgstr ""
14699
14700 #. type: textblock
14701 #: ../fish/guestfish-actions.pod:4444 ../src/guestfs-actions.pod:6859
14702 msgid ""
14703 "About the only time when you would want to disable this is if the main "
14704 "process will fork itself into the background (\"daemonize\" itself).  In "
14705 "this case the recovery process thinks that the main program has disappeared "
14706 "and so kills qemu, which is not very helpful."
14707 msgstr ""
14708
14709 #. type: =head2
14710 #: ../fish/guestfish-actions.pod:4450
14711 msgid "set-selinux"
14712 msgstr ""
14713
14714 #. type: =head2
14715 #: ../fish/guestfish-actions.pod:4452
14716 msgid "selinux"
14717 msgstr ""
14718
14719 #. type: verbatim
14720 #: ../fish/guestfish-actions.pod:4454
14721 #, no-wrap
14722 msgid ""
14723 " set-selinux true|false\n"
14724 "\n"
14725 msgstr ""
14726
14727 #. type: textblock
14728 #: ../fish/guestfish-actions.pod:4456 ../src/guestfs-actions.pod:6875
14729 msgid ""
14730 "This sets the selinux flag that is passed to the appliance at boot time.  "
14731 "The default is C<selinux=0> (disabled)."
14732 msgstr ""
14733
14734 #. type: textblock
14735 #: ../fish/guestfish-actions.pod:4459 ../src/guestfs-actions.pod:6878
14736 msgid ""
14737 "Note that if SELinux is enabled, it is always in Permissive mode "
14738 "(C<enforcing=0>)."
14739 msgstr ""
14740
14741 #. type: =head2
14742 #: ../fish/guestfish-actions.pod:4465
14743 msgid "set-smp"
14744 msgstr ""
14745
14746 #. type: =head2
14747 #: ../fish/guestfish-actions.pod:4467
14748 msgid "smp"
14749 msgstr ""
14750
14751 #. type: verbatim
14752 #: ../fish/guestfish-actions.pod:4469
14753 #, no-wrap
14754 msgid ""
14755 " set-smp smp\n"
14756 "\n"
14757 msgstr ""
14758
14759 #. type: textblock
14760 #: ../fish/guestfish-actions.pod:4471 ../src/guestfs-actions.pod:6894
14761 msgid ""
14762 "Change the number of virtual CPUs assigned to the appliance.  The default is "
14763 "C<1>.  Increasing this may improve performance, though often it has no "
14764 "effect."
14765 msgstr ""
14766
14767 #. type: textblock
14768 #: ../fish/guestfish-actions.pod:4475
14769 msgid "This function must be called before L</launch>."
14770 msgstr ""
14771
14772 #. type: =head2
14773 #: ../fish/guestfish-actions.pod:4477
14774 msgid "set-trace"
14775 msgstr ""
14776
14777 #. type: =head2
14778 #: ../fish/guestfish-actions.pod:4479
14779 msgid "trace"
14780 msgstr ""
14781
14782 #. type: verbatim
14783 #: ../fish/guestfish-actions.pod:4481
14784 #, no-wrap
14785 msgid ""
14786 " set-trace true|false\n"
14787 "\n"
14788 msgstr ""
14789
14790 #. type: textblock
14791 #: ../fish/guestfish-actions.pod:4483 ../src/guestfs-actions.pod:6910
14792 msgid ""
14793 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
14794 "return values are traced."
14795 msgstr ""
14796
14797 #. type: textblock
14798 #: ../fish/guestfish-actions.pod:4486 ../src/guestfs-actions.pod:6913
14799 msgid ""
14800 "If you want to trace C API calls into libguestfs (and other libraries) then "
14801 "possibly a better way is to use the external ltrace(1) command."
14802 msgstr ""
14803
14804 #. type: textblock
14805 #: ../fish/guestfish-actions.pod:4490 ../src/guestfs-actions.pod:6917
14806 msgid ""
14807 "Command traces are disabled unless the environment variable "
14808 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
14809 msgstr ""
14810
14811 #. type: textblock
14812 #: ../fish/guestfish-actions.pod:4493
14813 msgid ""
14814 "Trace messages are normally sent to C<stderr>, unless you register a "
14815 "callback to send them somewhere else (see L</set-event-callback>)."
14816 msgstr ""
14817
14818 #. type: =head2
14819 #: ../fish/guestfish-actions.pod:4497
14820 msgid "set-verbose"
14821 msgstr ""
14822
14823 #. type: =head2
14824 #: ../fish/guestfish-actions.pod:4499
14825 msgid "verbose"
14826 msgstr ""
14827
14828 #. type: verbatim
14829 #: ../fish/guestfish-actions.pod:4501
14830 #, no-wrap
14831 msgid ""
14832 " set-verbose true|false\n"
14833 "\n"
14834 msgstr ""
14835
14836 #. type: textblock
14837 #: ../fish/guestfish-actions.pod:4503 ../src/guestfs-actions.pod:6934
14838 msgid "If C<verbose> is true, this turns on verbose messages."
14839 msgstr ""
14840
14841 #. type: textblock
14842 #: ../fish/guestfish-actions.pod:4505 ../src/guestfs-actions.pod:6936
14843 msgid ""
14844 "Verbose messages are disabled unless the environment variable "
14845 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
14846 msgstr ""
14847
14848 #. type: textblock
14849 #: ../fish/guestfish-actions.pod:4508
14850 msgid ""
14851 "Verbose messages are normally sent to C<stderr>, unless you register a "
14852 "callback to send them somewhere else (see L</set-event-callback>)."
14853 msgstr ""
14854
14855 #. type: =head2
14856 #: ../fish/guestfish-actions.pod:4512
14857 msgid "setcon"
14858 msgstr ""
14859
14860 #. type: verbatim
14861 #: ../fish/guestfish-actions.pod:4514
14862 #, no-wrap
14863 msgid ""
14864 " setcon context\n"
14865 "\n"
14866 msgstr ""
14867
14868 #. type: textblock
14869 #: ../fish/guestfish-actions.pod:4516 ../src/guestfs-actions.pod:6953
14870 msgid ""
14871 "This sets the SELinux security context of the daemon to the string "
14872 "C<context>."
14873 msgstr ""
14874
14875 #. type: textblock
14876 #: ../fish/guestfish-actions.pod:4519 ../src/guestfs-actions.pod:6956
14877 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14878 msgstr ""
14879
14880 #. type: =head2
14881 #: ../fish/guestfish-actions.pod:4521
14882 msgid "setxattr"
14883 msgstr ""
14884
14885 #. type: verbatim
14886 #: ../fish/guestfish-actions.pod:4523
14887 #, no-wrap
14888 msgid ""
14889 " setxattr xattr val vallen path\n"
14890 "\n"
14891 msgstr ""
14892
14893 #. type: textblock
14894 #: ../fish/guestfish-actions.pod:4525 ../src/guestfs-actions.pod:6971
14895 msgid ""
14896 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14897 "the value C<val> (of length C<vallen>).  The value is arbitrary 8 bit data."
14898 msgstr ""
14899
14900 #. type: textblock
14901 #: ../fish/guestfish-actions.pod:4529
14902 msgid "See also: L</lsetxattr>, L<attr(5)>."
14903 msgstr ""
14904
14905 #. type: =head2
14906 #: ../fish/guestfish-actions.pod:4531
14907 msgid "sfdisk"
14908 msgstr ""
14909
14910 #. type: verbatim
14911 #: ../fish/guestfish-actions.pod:4533
14912 #, no-wrap
14913 msgid ""
14914 " sfdisk device cyls heads sectors 'lines ...'\n"
14915 "\n"
14916 msgstr ""
14917
14918 #. type: textblock
14919 #: ../fish/guestfish-actions.pod:4535 ../src/guestfs-actions.pod:6998
14920 msgid ""
14921 "This is a direct interface to the L<sfdisk(8)> program for creating "
14922 "partitions on block devices."
14923 msgstr ""
14924
14925 #. type: textblock
14926 #: ../fish/guestfish-actions.pod:4538 ../src/guestfs-actions.pod:7001
14927 msgid "C<device> should be a block device, for example C</dev/sda>."
14928 msgstr ""
14929
14930 #. type: textblock
14931 #: ../fish/guestfish-actions.pod:4540 ../src/guestfs-actions.pod:7003
14932 msgid ""
14933 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14934 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
14935 "I<-H> and I<-S> parameters.  If you pass C<0> for any of these, then the "
14936 "corresponding parameter is omitted.  Usually for 'large' disks, you can just "
14937 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14938 "the kernel) cannot work out the right geometry and you will need to tell it."
14939 msgstr ""
14940
14941 #. type: textblock
14942 #: ../fish/guestfish-actions.pod:4548 ../src/guestfs-actions.pod:7011
14943 msgid ""
14944 "C<lines> is a list of lines that we feed to C<sfdisk>.  For more information "
14945 "refer to the L<sfdisk(8)> manpage."
14946 msgstr ""
14947
14948 #. type: textblock
14949 #: ../fish/guestfish-actions.pod:4551 ../src/guestfs-actions.pod:7014
14950 msgid ""
14951 "To create a single partition occupying the whole disk, you would pass "
14952 "C<lines> as a single element list, when the single element being the string "
14953 "C<,> (comma)."
14954 msgstr ""
14955
14956 #. type: textblock
14957 #: ../fish/guestfish-actions.pod:4555
14958 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
14959 msgstr ""
14960
14961 #. type: textblock
14962 #: ../fish/guestfish-actions.pod:4558 ../fish/guestfish-actions.pod:4578 ../fish/guestfish-actions.pod:4597
14963 msgid ""
14964 "I<This function is deprecated.> In new code, use the L</part_add> call "
14965 "instead."
14966 msgstr ""
14967
14968 #. type: =head2
14969 #: ../fish/guestfish-actions.pod:4565
14970 msgid "sfdiskM"
14971 msgstr ""
14972
14973 #. type: verbatim
14974 #: ../fish/guestfish-actions.pod:4567
14975 #, no-wrap
14976 msgid ""
14977 " sfdiskM device 'lines ...'\n"
14978 "\n"
14979 msgstr ""
14980
14981 #. type: textblock
14982 #: ../fish/guestfish-actions.pod:4569
14983 msgid ""
14984 "This is a simplified interface to the L</sfdisk> command, where partition "
14985 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
14986 "you don't need to specify the cyls, heads and sectors parameters which were "
14987 "rarely if ever used anyway."
14988 msgstr ""
14989
14990 #. type: textblock
14991 #: ../fish/guestfish-actions.pod:4575
14992 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
14993 msgstr ""
14994
14995 #. type: =head2
14996 #: ../fish/guestfish-actions.pod:4585
14997 msgid "sfdisk-N"
14998 msgstr ""
14999
15000 #. type: verbatim
15001 #: ../fish/guestfish-actions.pod:4587
15002 #, no-wrap
15003 msgid ""
15004 " sfdisk-N device partnum cyls heads sectors line\n"
15005 "\n"
15006 msgstr ""
15007
15008 #. type: textblock
15009 #: ../fish/guestfish-actions.pod:4589 ../src/guestfs-actions.pod:7070
15010 msgid ""
15011 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
15012 "(note: C<n> counts from 1)."
15013 msgstr ""
15014
15015 #. type: textblock
15016 #: ../fish/guestfish-actions.pod:4592
15017 msgid ""
15018 "For other parameters, see L</sfdisk>.  You should usually pass C<0> for the "
15019 "cyls/heads/sectors parameters."
15020 msgstr ""
15021
15022 #. type: textblock
15023 #: ../fish/guestfish-actions.pod:4595
15024 msgid "See also: L</part-add>"
15025 msgstr ""
15026
15027 #. type: =head2
15028 #: ../fish/guestfish-actions.pod:4604
15029 msgid "sfdisk-disk-geometry"
15030 msgstr ""
15031
15032 #. type: verbatim
15033 #: ../fish/guestfish-actions.pod:4606
15034 #, no-wrap
15035 msgid ""
15036 " sfdisk-disk-geometry device\n"
15037 "\n"
15038 msgstr ""
15039
15040 #. type: textblock
15041 #: ../fish/guestfish-actions.pod:4608
15042 msgid ""
15043 "This displays the disk geometry of C<device> read from the partition table.  "
15044 "Especially in the case where the underlying block device has been resized, "
15045 "this can be different from the kernel's idea of the geometry (see "
15046 "L</sfdisk-kernel-geometry>)."
15047 msgstr ""
15048
15049 #. type: textblock
15050 #: ../fish/guestfish-actions.pod:4613 ../fish/guestfish-actions.pod:4622 ../src/guestfs-actions.pod:7093 ../src/guestfs-actions.pod:7109
15051 msgid "The result is in human-readable format, and not designed to be parsed."
15052 msgstr ""
15053
15054 #. type: =head2
15055 #: ../fish/guestfish-actions.pod:4616
15056 msgid "sfdisk-kernel-geometry"
15057 msgstr ""
15058
15059 #. type: verbatim
15060 #: ../fish/guestfish-actions.pod:4618
15061 #, no-wrap
15062 msgid ""
15063 " sfdisk-kernel-geometry device\n"
15064 "\n"
15065 msgstr ""
15066
15067 #. type: textblock
15068 #: ../fish/guestfish-actions.pod:4620 ../src/guestfs-actions.pod:7107
15069 msgid "This displays the kernel's idea of the geometry of C<device>."
15070 msgstr ""
15071
15072 #. type: =head2
15073 #: ../fish/guestfish-actions.pod:4625
15074 msgid "sfdisk-l"
15075 msgstr ""
15076
15077 #. type: verbatim
15078 #: ../fish/guestfish-actions.pod:4627
15079 #, no-wrap
15080 msgid ""
15081 " sfdisk-l device\n"
15082 "\n"
15083 msgstr ""
15084
15085 #. type: textblock
15086 #: ../fish/guestfish-actions.pod:4629 ../src/guestfs-actions.pod:7130
15087 msgid ""
15088 "This displays the partition table on C<device>, in the human-readable output "
15089 "of the L<sfdisk(8)> command.  It is not intended to be parsed."
15090 msgstr ""
15091
15092 #. type: textblock
15093 #: ../fish/guestfish-actions.pod:4633
15094 msgid "See also: L</part-list>"
15095 msgstr ""
15096
15097 #. type: textblock
15098 #: ../fish/guestfish-actions.pod:4635
15099 msgid ""
15100 "I<This function is deprecated.> In new code, use the L</part_list> call "
15101 "instead."
15102 msgstr ""
15103
15104 #. type: =head2
15105 #: ../fish/guestfish-actions.pod:4642
15106 msgid "sh"
15107 msgstr ""
15108
15109 #. type: verbatim
15110 #: ../fish/guestfish-actions.pod:4644
15111 #, no-wrap
15112 msgid ""
15113 " sh command\n"
15114 "\n"
15115 msgstr ""
15116
15117 #. type: textblock
15118 #: ../fish/guestfish-actions.pod:4646 ../src/guestfs-actions.pod:7147
15119 msgid ""
15120 "This call runs a command from the guest filesystem via the guest's "
15121 "C</bin/sh>."
15122 msgstr ""
15123
15124 #. type: textblock
15125 #: ../fish/guestfish-actions.pod:4649
15126 msgid "This is like L</command>, but passes the command to:"
15127 msgstr ""
15128
15129 #. type: verbatim
15130 #: ../fish/guestfish-actions.pod:4651 ../src/guestfs-actions.pod:7152
15131 #, no-wrap
15132 msgid ""
15133 " /bin/sh -c \"command\"\n"
15134 "\n"
15135 msgstr ""
15136
15137 #. type: textblock
15138 #: ../fish/guestfish-actions.pod:4653 ../src/guestfs-actions.pod:7154
15139 msgid ""
15140 "Depending on the guest's shell, this usually results in wildcards being "
15141 "expanded, shell expressions being interpolated and so on."
15142 msgstr ""
15143
15144 #. type: textblock
15145 #: ../fish/guestfish-actions.pod:4657
15146 msgid "All the provisos about L</command> apply to this call."
15147 msgstr ""
15148
15149 #. type: =head2
15150 #: ../fish/guestfish-actions.pod:4659
15151 msgid "sh-lines"
15152 msgstr ""
15153
15154 #. type: verbatim
15155 #: ../fish/guestfish-actions.pod:4661
15156 #, no-wrap
15157 msgid ""
15158 " sh-lines command\n"
15159 "\n"
15160 msgstr ""
15161
15162 #. type: textblock
15163 #: ../fish/guestfish-actions.pod:4663
15164 msgid "This is the same as L</sh>, but splits the result into a list of lines."
15165 msgstr ""
15166
15167 #. type: textblock
15168 #: ../fish/guestfish-actions.pod:4666
15169 msgid "See also: L</command-lines>"
15170 msgstr ""
15171
15172 #. type: =head2
15173 #: ../fish/guestfish-actions.pod:4668
15174 msgid "sleep"
15175 msgstr ""
15176
15177 #. type: verbatim
15178 #: ../fish/guestfish-actions.pod:4670
15179 #, no-wrap
15180 msgid ""
15181 " sleep secs\n"
15182 "\n"
15183 msgstr ""
15184
15185 #. type: textblock
15186 #: ../fish/guestfish-actions.pod:4672 ../src/guestfs-actions.pod:7188
15187 msgid "Sleep for C<secs> seconds."
15188 msgstr ""
15189
15190 #. type: =head2
15191 #: ../fish/guestfish-actions.pod:4674
15192 msgid "stat"
15193 msgstr ""
15194
15195 #. type: verbatim
15196 #: ../fish/guestfish-actions.pod:4676
15197 #, no-wrap
15198 msgid ""
15199 " stat path\n"
15200 "\n"
15201 msgstr ""
15202
15203 #. type: textblock
15204 #: ../fish/guestfish-actions.pod:4680 ../src/guestfs-actions.pod:7202
15205 msgid "This is the same as the C<stat(2)> system call."
15206 msgstr ""
15207
15208 #. type: =head2
15209 #: ../fish/guestfish-actions.pod:4682
15210 msgid "statvfs"
15211 msgstr ""
15212
15213 #. type: verbatim
15214 #: ../fish/guestfish-actions.pod:4684
15215 #, no-wrap
15216 msgid ""
15217 " statvfs path\n"
15218 "\n"
15219 msgstr ""
15220
15221 #. type: textblock
15222 #: ../fish/guestfish-actions.pod:4686 ../src/guestfs-actions.pod:7216
15223 msgid ""
15224 "Returns file system statistics for any mounted file system.  C<path> should "
15225 "be a file or directory in the mounted file system (typically it is the mount "
15226 "point itself, but it doesn't need to be)."
15227 msgstr ""
15228
15229 #. type: textblock
15230 #: ../fish/guestfish-actions.pod:4690 ../src/guestfs-actions.pod:7220
15231 msgid "This is the same as the C<statvfs(2)> system call."
15232 msgstr ""
15233
15234 #. type: =head2
15235 #: ../fish/guestfish-actions.pod:4692
15236 msgid "strings"
15237 msgstr ""
15238
15239 #. type: verbatim
15240 #: ../fish/guestfish-actions.pod:4694
15241 #, no-wrap
15242 msgid ""
15243 " strings path\n"
15244 "\n"
15245 msgstr ""
15246
15247 #. type: textblock
15248 #: ../fish/guestfish-actions.pod:4696 ../src/guestfs-actions.pod:7234
15249 msgid ""
15250 "This runs the L<strings(1)> command on a file and returns the list of "
15251 "printable strings found."
15252 msgstr ""
15253
15254 #. type: =head2
15255 #: ../fish/guestfish-actions.pod:4702
15256 msgid "strings-e"
15257 msgstr ""
15258
15259 #. type: verbatim
15260 #: ../fish/guestfish-actions.pod:4704
15261 #, no-wrap
15262 msgid ""
15263 " strings-e encoding path\n"
15264 "\n"
15265 msgstr ""
15266
15267 #. type: textblock
15268 #: ../fish/guestfish-actions.pod:4706
15269 msgid ""
15270 "This is like the L</strings> command, but allows you to specify the encoding "
15271 "of strings that are looked for in the source file C<path>."
15272 msgstr ""
15273
15274 #. type: textblock
15275 #: ../fish/guestfish-actions.pod:4710 ../src/guestfs-actions.pod:7257
15276 msgid "Allowed encodings are:"
15277 msgstr ""
15278
15279 #. type: =item
15280 #: ../fish/guestfish-actions.pod:4714 ../src/guestfs-actions.pod:7261
15281 msgid "s"
15282 msgstr ""
15283
15284 #. type: textblock
15285 #: ../fish/guestfish-actions.pod:4716
15286 msgid ""
15287 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
15288 "ISO-8859-X (this is what L</strings> uses)."
15289 msgstr ""
15290
15291 #. type: =item
15292 #: ../fish/guestfish-actions.pod:4719 ../src/guestfs-actions.pod:7266
15293 msgid "S"
15294 msgstr ""
15295
15296 #. type: textblock
15297 #: ../fish/guestfish-actions.pod:4721 ../src/guestfs-actions.pod:7268
15298 msgid "Single 8-bit-byte characters."
15299 msgstr ""
15300
15301 #. type: =item
15302 #: ../fish/guestfish-actions.pod:4723 ../src/guestfs-actions.pod:7270
15303 msgid "b"
15304 msgstr ""
15305
15306 #. type: textblock
15307 #: ../fish/guestfish-actions.pod:4725 ../src/guestfs-actions.pod:7272
15308 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
15309 msgstr ""
15310
15311 #. type: =item
15312 #: ../fish/guestfish-actions.pod:4728 ../src/guestfs-actions.pod:7275
15313 msgid "l (lower case letter L)"
15314 msgstr ""
15315
15316 #. type: textblock
15317 #: ../fish/guestfish-actions.pod:4730 ../src/guestfs-actions.pod:7277
15318 msgid ""
15319 "16-bit little endian such as UTF-16LE and UCS-2LE.  This is useful for "
15320 "examining binaries in Windows guests."
15321 msgstr ""
15322
15323 #. type: =item
15324 #: ../fish/guestfish-actions.pod:4733 ../src/guestfs-actions.pod:7280
15325 msgid "B"
15326 msgstr ""
15327
15328 #. type: textblock
15329 #: ../fish/guestfish-actions.pod:4735 ../src/guestfs-actions.pod:7282
15330 msgid "32-bit big endian such as UCS-4BE."
15331 msgstr ""
15332
15333 #. type: =item
15334 #: ../fish/guestfish-actions.pod:4737 ../src/guestfs-actions.pod:7284
15335 msgid "L"
15336 msgstr ""
15337
15338 #. type: textblock
15339 #: ../fish/guestfish-actions.pod:4739 ../src/guestfs-actions.pod:7286
15340 msgid "32-bit little endian such as UCS-4LE."
15341 msgstr ""
15342
15343 #. type: textblock
15344 #: ../fish/guestfish-actions.pod:4743 ../src/guestfs-actions.pod:7290
15345 msgid "The returned strings are transcoded to UTF-8."
15346 msgstr ""
15347
15348 #. type: =head2
15349 #: ../fish/guestfish-actions.pod:4748
15350 msgid "swapoff-device"
15351 msgstr ""
15352
15353 #. type: verbatim
15354 #: ../fish/guestfish-actions.pod:4750
15355 #, no-wrap
15356 msgid ""
15357 " swapoff-device device\n"
15358 "\n"
15359 msgstr ""
15360
15361 #. type: textblock
15362 #: ../fish/guestfish-actions.pod:4752
15363 msgid ""
15364 "This command disables the libguestfs appliance swap device or partition "
15365 "named C<device>.  See L</swapon-device>."
15366 msgstr ""
15367
15368 #. type: =head2
15369 #: ../fish/guestfish-actions.pod:4756
15370 msgid "swapoff-file"
15371 msgstr ""
15372
15373 #. type: verbatim
15374 #: ../fish/guestfish-actions.pod:4758
15375 #, no-wrap
15376 msgid ""
15377 " swapoff-file file\n"
15378 "\n"
15379 msgstr ""
15380
15381 #. type: textblock
15382 #: ../fish/guestfish-actions.pod:4760 ../src/guestfs-actions.pod:7321
15383 msgid "This command disables the libguestfs appliance swap on file."
15384 msgstr ""
15385
15386 #. type: =head2
15387 #: ../fish/guestfish-actions.pod:4762
15388 msgid "swapoff-label"
15389 msgstr ""
15390
15391 #. type: verbatim
15392 #: ../fish/guestfish-actions.pod:4764
15393 #, no-wrap
15394 msgid ""
15395 " swapoff-label label\n"
15396 "\n"
15397 msgstr ""
15398
15399 #. type: textblock
15400 #: ../fish/guestfish-actions.pod:4766 ../src/guestfs-actions.pod:7333
15401 msgid ""
15402 "This command disables the libguestfs appliance swap on labeled swap "
15403 "partition."
15404 msgstr ""
15405
15406 #. type: =head2
15407 #: ../fish/guestfish-actions.pod:4769
15408 msgid "swapoff-uuid"
15409 msgstr ""
15410
15411 #. type: verbatim
15412 #: ../fish/guestfish-actions.pod:4771
15413 #, no-wrap
15414 msgid ""
15415 " swapoff-uuid uuid\n"
15416 "\n"
15417 msgstr ""
15418
15419 #. type: textblock
15420 #: ../fish/guestfish-actions.pod:4773 ../src/guestfs-actions.pod:7346
15421 msgid ""
15422 "This command disables the libguestfs appliance swap partition with the given "
15423 "UUID."
15424 msgstr ""
15425
15426 #. type: =head2
15427 #: ../fish/guestfish-actions.pod:4776
15428 msgid "swapon-device"
15429 msgstr ""
15430
15431 #. type: verbatim
15432 #: ../fish/guestfish-actions.pod:4778
15433 #, no-wrap
15434 msgid ""
15435 " swapon-device device\n"
15436 "\n"
15437 msgstr ""
15438
15439 #. type: textblock
15440 #: ../fish/guestfish-actions.pod:4780
15441 msgid ""
15442 "This command enables the libguestfs appliance to use the swap device or "
15443 "partition named C<device>.  The increased memory is made available for all "
15444 "commands, for example those run using L</command> or L</sh>."
15445 msgstr ""
15446
15447 #. type: textblock
15448 #: ../fish/guestfish-actions.pod:4785 ../src/guestfs-actions.pod:7364
15449 msgid ""
15450 "Note that you should not swap to existing guest swap partitions unless you "
15451 "know what you are doing.  They may contain hibernation information, or other "
15452 "information that the guest doesn't want you to trash.  You also risk leaking "
15453 "information about the host to the guest this way.  Instead, attach a new "
15454 "host device to the guest and swap on that."
15455 msgstr ""
15456
15457 #. type: =head2
15458 #: ../fish/guestfish-actions.pod:4792
15459 msgid "swapon-file"
15460 msgstr ""
15461
15462 #. type: verbatim
15463 #: ../fish/guestfish-actions.pod:4794
15464 #, no-wrap
15465 msgid ""
15466 " swapon-file file\n"
15467 "\n"
15468 msgstr ""
15469
15470 #. type: textblock
15471 #: ../fish/guestfish-actions.pod:4796
15472 msgid "This command enables swap to a file.  See L</swapon-device> for other notes."
15473 msgstr ""
15474
15475 #. type: =head2
15476 #: ../fish/guestfish-actions.pod:4799
15477 msgid "swapon-label"
15478 msgstr ""
15479
15480 #. type: verbatim
15481 #: ../fish/guestfish-actions.pod:4801
15482 #, no-wrap
15483 msgid ""
15484 " swapon-label label\n"
15485 "\n"
15486 msgstr ""
15487
15488 #. type: textblock
15489 #: ../fish/guestfish-actions.pod:4803
15490 msgid ""
15491 "This command enables swap to a labeled swap partition.  See "
15492 "L</swapon-device> for other notes."
15493 msgstr ""
15494
15495 #. type: =head2
15496 #: ../fish/guestfish-actions.pod:4806
15497 msgid "swapon-uuid"
15498 msgstr ""
15499
15500 #. type: verbatim
15501 #: ../fish/guestfish-actions.pod:4808
15502 #, no-wrap
15503 msgid ""
15504 " swapon-uuid uuid\n"
15505 "\n"
15506 msgstr ""
15507
15508 #. type: textblock
15509 #: ../fish/guestfish-actions.pod:4810
15510 msgid ""
15511 "This command enables swap to a swap partition with the given UUID.  See "
15512 "L</swapon-device> for other notes."
15513 msgstr ""
15514
15515 #. type: =head2
15516 #: ../fish/guestfish-actions.pod:4813
15517 msgid "sync"
15518 msgstr ""
15519
15520 #. type: verbatim
15521 #: ../fish/guestfish-actions.pod:4815
15522 #, no-wrap
15523 msgid ""
15524 " sync\n"
15525 "\n"
15526 msgstr ""
15527
15528 #. type: textblock
15529 #: ../fish/guestfish-actions.pod:4817 ../src/guestfs-actions.pod:7419
15530 msgid ""
15531 "This syncs the disk, so that any writes are flushed through to the "
15532 "underlying disk image."
15533 msgstr ""
15534
15535 #. type: textblock
15536 #: ../fish/guestfish-actions.pod:4820 ../src/guestfs-actions.pod:7422
15537 msgid ""
15538 "You should always call this if you have modified a disk image, before "
15539 "closing the handle."
15540 msgstr ""
15541
15542 #. type: =head2
15543 #: ../fish/guestfish-actions.pod:4823
15544 msgid "tail"
15545 msgstr ""
15546
15547 #. type: verbatim
15548 #: ../fish/guestfish-actions.pod:4825
15549 #, no-wrap
15550 msgid ""
15551 " tail path\n"
15552 "\n"
15553 msgstr ""
15554
15555 #. type: textblock
15556 #: ../fish/guestfish-actions.pod:4827 ../src/guestfs-actions.pod:7435
15557 msgid "This command returns up to the last 10 lines of a file as a list of strings."
15558 msgstr ""
15559
15560 #. type: =head2
15561 #: ../fish/guestfish-actions.pod:4833
15562 msgid "tail-n"
15563 msgstr ""
15564
15565 #. type: verbatim
15566 #: ../fish/guestfish-actions.pod:4835
15567 #, no-wrap
15568 msgid ""
15569 " tail-n nrlines path\n"
15570 "\n"
15571 msgstr ""
15572
15573 #. type: textblock
15574 #: ../fish/guestfish-actions.pod:4837 ../src/guestfs-actions.pod:7454
15575 msgid ""
15576 "If the parameter C<nrlines> is a positive number, this returns the last "
15577 "C<nrlines> lines of the file C<path>."
15578 msgstr ""
15579
15580 #. type: textblock
15581 #: ../fish/guestfish-actions.pod:4840 ../src/guestfs-actions.pod:7457
15582 msgid ""
15583 "If the parameter C<nrlines> is a negative number, this returns lines from "
15584 "the file C<path>, starting with the C<-nrlines>th line."
15585 msgstr ""
15586
15587 #. type: =head2
15588 #: ../fish/guestfish-actions.pod:4848
15589 msgid "tar-in"
15590 msgstr ""
15591
15592 #. type: verbatim
15593 #: ../fish/guestfish-actions.pod:4850
15594 #, no-wrap
15595 msgid ""
15596 " tar-in (tarfile|-) directory\n"
15597 "\n"
15598 msgstr ""
15599
15600 #. type: textblock
15601 #: ../fish/guestfish-actions.pod:4852 ../src/guestfs-actions.pod:7478
15602 msgid ""
15603 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
15604 "tar file) into C<directory>."
15605 msgstr ""
15606
15607 #. type: textblock
15608 #: ../fish/guestfish-actions.pod:4855
15609 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
15610 msgstr ""
15611
15612 #. type: =head2
15613 #: ../fish/guestfish-actions.pod:4860
15614 msgid "tar-out"
15615 msgstr ""
15616
15617 #. type: verbatim
15618 #: ../fish/guestfish-actions.pod:4862
15619 #, no-wrap
15620 msgid ""
15621 " tar-out directory (tarfile|-)\n"
15622 "\n"
15623 msgstr ""
15624
15625 #. type: textblock
15626 #: ../fish/guestfish-actions.pod:4864 ../src/guestfs-actions.pod:7495
15627 msgid ""
15628 "This command packs the contents of C<directory> and downloads it to local "
15629 "file C<tarfile>."
15630 msgstr ""
15631
15632 #. type: textblock
15633 #: ../fish/guestfish-actions.pod:4867
15634 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
15635 msgstr ""
15636
15637 #. type: =head2
15638 #: ../fish/guestfish-actions.pod:4872
15639 msgid "tgz-in"
15640 msgstr ""
15641
15642 #. type: verbatim
15643 #: ../fish/guestfish-actions.pod:4874
15644 #, no-wrap
15645 msgid ""
15646 " tgz-in (tarball|-) directory\n"
15647 "\n"
15648 msgstr ""
15649
15650 #. type: textblock
15651 #: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7512
15652 msgid ""
15653 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
15654 "tar file) into C<directory>."
15655 msgstr ""
15656
15657 #. type: textblock
15658 #: ../fish/guestfish-actions.pod:4879
15659 msgid "To upload an uncompressed tarball, use L</tar-in>."
15660 msgstr ""
15661
15662 #. type: =head2
15663 #: ../fish/guestfish-actions.pod:4883
15664 msgid "tgz-out"
15665 msgstr ""
15666
15667 #. type: verbatim
15668 #: ../fish/guestfish-actions.pod:4885
15669 #, no-wrap
15670 msgid ""
15671 " tgz-out directory (tarball|-)\n"
15672 "\n"
15673 msgstr ""
15674
15675 #. type: textblock
15676 #: ../fish/guestfish-actions.pod:4887 ../src/guestfs-actions.pod:7528
15677 msgid ""
15678 "This command packs the contents of C<directory> and downloads it to local "
15679 "file C<tarball>."
15680 msgstr ""
15681
15682 #. type: textblock
15683 #: ../fish/guestfish-actions.pod:4890
15684 msgid "To download an uncompressed tarball, use L</tar-out>."
15685 msgstr ""
15686
15687 #. type: =head2
15688 #: ../fish/guestfish-actions.pod:4894
15689 msgid "touch"
15690 msgstr ""
15691
15692 #. type: verbatim
15693 #: ../fish/guestfish-actions.pod:4896
15694 #, no-wrap
15695 msgid ""
15696 " touch path\n"
15697 "\n"
15698 msgstr ""
15699
15700 #. type: textblock
15701 #: ../fish/guestfish-actions.pod:4898 ../src/guestfs-actions.pod:7543
15702 msgid ""
15703 "Touch acts like the L<touch(1)> command.  It can be used to update the "
15704 "timestamps on a file, or, if the file does not exist, to create a new "
15705 "zero-length file."
15706 msgstr ""
15707
15708 #. type: textblock
15709 #: ../fish/guestfish-actions.pod:4902 ../src/guestfs-actions.pod:7547
15710 msgid ""
15711 "This command only works on regular files, and will fail on other file types "
15712 "such as directories, symbolic links, block special etc."
15713 msgstr ""
15714
15715 #. type: =head2
15716 #: ../fish/guestfish-actions.pod:4905
15717 msgid "truncate"
15718 msgstr ""
15719
15720 #. type: verbatim
15721 #: ../fish/guestfish-actions.pod:4907
15722 #, no-wrap
15723 msgid ""
15724 " truncate path\n"
15725 "\n"
15726 msgstr ""
15727
15728 #. type: textblock
15729 #: ../fish/guestfish-actions.pod:4909 ../src/guestfs-actions.pod:7560
15730 msgid ""
15731 "This command truncates C<path> to a zero-length file.  The file must exist "
15732 "already."
15733 msgstr ""
15734
15735 #. type: =head2
15736 #: ../fish/guestfish-actions.pod:4912
15737 msgid "truncate-size"
15738 msgstr ""
15739
15740 #. type: verbatim
15741 #: ../fish/guestfish-actions.pod:4914
15742 #, no-wrap
15743 msgid ""
15744 " truncate-size path size\n"
15745 "\n"
15746 msgstr ""
15747
15748 #. type: textblock
15749 #: ../fish/guestfish-actions.pod:4916 ../src/guestfs-actions.pod:7574
15750 msgid ""
15751 "This command truncates C<path> to size C<size> bytes.  The file must exist "
15752 "already."
15753 msgstr ""
15754
15755 #. type: textblock
15756 #: ../fish/guestfish-actions.pod:4919
15757 msgid ""
15758 "If the current file size is less than C<size> then the file is extended to "
15759 "the required size with zero bytes.  This creates a sparse file (ie. disk "
15760 "blocks are not allocated for the file until you write to it).  To create a "
15761 "non-sparse file of zeroes, use L</fallocate64> instead."
15762 msgstr ""
15763
15764 #. type: =head2
15765 #: ../fish/guestfish-actions.pod:4925
15766 msgid "tune2fs-l"
15767 msgstr ""
15768
15769 #. type: verbatim
15770 #: ../fish/guestfish-actions.pod:4927
15771 #, no-wrap
15772 msgid ""
15773 " tune2fs-l device\n"
15774 "\n"
15775 msgstr ""
15776
15777 #. type: textblock
15778 #: ../fish/guestfish-actions.pod:4929 ../src/guestfs-actions.pod:7593
15779 msgid ""
15780 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15781 "C<device>."
15782 msgstr ""
15783
15784 #. type: textblock
15785 #: ../fish/guestfish-actions.pod:4932 ../src/guestfs-actions.pod:7596
15786 msgid ""
15787 "It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)> manpage "
15788 "for more details.  The list of fields returned isn't clearly defined, and "
15789 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15790 "and the filesystem itself."
15791 msgstr ""
15792
15793 #. type: =head2
15794 #: ../fish/guestfish-actions.pod:4937
15795 msgid "txz-in"
15796 msgstr ""
15797
15798 #. type: verbatim
15799 #: ../fish/guestfish-actions.pod:4939
15800 #, no-wrap
15801 msgid ""
15802 " txz-in (tarball|-) directory\n"
15803 "\n"
15804 msgstr ""
15805
15806 #. type: textblock
15807 #: ../fish/guestfish-actions.pod:4941 ../src/guestfs-actions.pod:7616
15808 msgid ""
15809 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15810 "tar file) into C<directory>."
15811 msgstr ""
15812
15813 #. type: =head2
15814 #: ../fish/guestfish-actions.pod:4946
15815 msgid "txz-out"
15816 msgstr ""
15817
15818 #. type: verbatim
15819 #: ../fish/guestfish-actions.pod:4948
15820 #, no-wrap
15821 msgid ""
15822 " txz-out directory (tarball|-)\n"
15823 "\n"
15824 msgstr ""
15825
15826 #. type: textblock
15827 #: ../fish/guestfish-actions.pod:4950 ../src/guestfs-actions.pod:7630
15828 msgid ""
15829 "This command packs the contents of C<directory> and downloads it to local "
15830 "file C<tarball> (as an xz compressed tar archive)."
15831 msgstr ""
15832
15833 #. type: =head2
15834 #: ../fish/guestfish-actions.pod:4955
15835 msgid "umask"
15836 msgstr ""
15837
15838 #. type: verbatim
15839 #: ../fish/guestfish-actions.pod:4957
15840 #, no-wrap
15841 msgid ""
15842 " umask mask\n"
15843 "\n"
15844 msgstr ""
15845
15846 #. type: textblock
15847 #: ../fish/guestfish-actions.pod:4959 ../src/guestfs-actions.pod:7643
15848 msgid ""
15849 "This function sets the mask used for creating new files and device nodes to "
15850 "C<mask & 0777>."
15851 msgstr ""
15852
15853 #. type: textblock
15854 #: ../fish/guestfish-actions.pod:4962 ../src/guestfs-actions.pod:7646
15855 msgid ""
15856 "Typical umask values would be C<022> which creates new files with "
15857 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15858 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15859 msgstr ""
15860
15861 #. type: textblock
15862 #: ../fish/guestfish-actions.pod:4967 ../src/guestfs-actions.pod:7651
15863 msgid ""
15864 "The default umask is C<022>.  This is important because it means that "
15865 "directories and device nodes will be created with C<0644> or C<0755> mode "
15866 "even if you specify C<0777>."
15867 msgstr ""
15868
15869 #. type: textblock
15870 #: ../fish/guestfish-actions.pod:4971
15871 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
15872 msgstr ""
15873
15874 #. type: textblock
15875 #: ../fish/guestfish-actions.pod:4974 ../src/guestfs-actions.pod:7658
15876 msgid "This call returns the previous umask."
15877 msgstr ""
15878
15879 #. type: =head2
15880 #: ../fish/guestfish-actions.pod:4976
15881 msgid "umount"
15882 msgstr ""
15883
15884 #. type: =head2
15885 #: ../fish/guestfish-actions.pod:4978
15886 msgid "unmount"
15887 msgstr ""
15888
15889 #. type: verbatim
15890 #: ../fish/guestfish-actions.pod:4980
15891 #, no-wrap
15892 msgid ""
15893 " umount pathordevice\n"
15894 "\n"
15895 msgstr ""
15896
15897 #. type: textblock
15898 #: ../fish/guestfish-actions.pod:4982 ../src/guestfs-actions.pod:7670
15899 msgid ""
15900 "This unmounts the given filesystem.  The filesystem may be specified either "
15901 "by its mountpoint (path) or the device which contains the filesystem."
15902 msgstr ""
15903
15904 #. type: =head2
15905 #: ../fish/guestfish-actions.pod:4986
15906 msgid "umount-all"
15907 msgstr ""
15908
15909 #. type: =head2
15910 #: ../fish/guestfish-actions.pod:4988
15911 msgid "unmount-all"
15912 msgstr ""
15913
15914 #. type: verbatim
15915 #: ../fish/guestfish-actions.pod:4990
15916 #, no-wrap
15917 msgid ""
15918 " umount-all\n"
15919 "\n"
15920 msgstr ""
15921
15922 #. type: textblock
15923 #: ../fish/guestfish-actions.pod:4992 ../src/guestfs-actions.pod:7683
15924 msgid "This unmounts all mounted filesystems."
15925 msgstr ""
15926
15927 #. type: textblock
15928 #: ../fish/guestfish-actions.pod:4994 ../src/guestfs-actions.pod:7685
15929 msgid "Some internal mounts are not unmounted by this call."
15930 msgstr ""
15931
15932 #. type: =head2
15933 #: ../fish/guestfish-actions.pod:4996
15934 msgid "upload"
15935 msgstr ""
15936
15937 #. type: verbatim
15938 #: ../fish/guestfish-actions.pod:4998
15939 #, no-wrap
15940 msgid ""
15941 " upload (filename|-) remotefilename\n"
15942 "\n"
15943 msgstr ""
15944
15945 #. type: textblock
15946 #: ../fish/guestfish-actions.pod:5000 ../fish/guestfish-actions.pod:5013 ../src/guestfs-actions.pod:7698 ../src/guestfs-actions.pod:7722
15947 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15948 msgstr ""
15949
15950 #. type: textblock
15951 #: ../fish/guestfish-actions.pod:5005
15952 msgid "See also L</download>."
15953 msgstr ""
15954
15955 #. type: =head2
15956 #: ../fish/guestfish-actions.pod:5009
15957 msgid "upload-offset"
15958 msgstr ""
15959
15960 #. type: verbatim
15961 #: ../fish/guestfish-actions.pod:5011
15962 #, no-wrap
15963 msgid ""
15964 " upload-offset (filename|-) remotefilename offset\n"
15965 "\n"
15966 msgstr ""
15967
15968 #. type: textblock
15969 #: ../fish/guestfish-actions.pod:5016 ../src/guestfs-actions.pod:7725
15970 msgid ""
15971 "C<remotefilename> is overwritten starting at the byte C<offset> specified.  "
15972 "The intention is to overwrite parts of existing files or devices, although "
15973 "if a non-existant file is specified then it is created with a \"hole\" "
15974 "before C<offset>.  The size of the data written is implicit in the size of "
15975 "the source C<filename>."
15976 msgstr ""
15977
15978 #. type: textblock
15979 #: ../fish/guestfish-actions.pod:5023
15980 msgid ""
15981 "Note that there is no limit on the amount of data that can be uploaded with "
15982 "this call, unlike with L</pwrite>, and this call always writes the full "
15983 "amount unless an error occurs."
15984 msgstr ""
15985
15986 #. type: textblock
15987 #: ../fish/guestfish-actions.pod:5028
15988 msgid "See also L</upload>, L</pwrite>."
15989 msgstr ""
15990
15991 #. type: =head2
15992 #: ../fish/guestfish-actions.pod:5032
15993 msgid "utimens"
15994 msgstr ""
15995
15996 #. type: verbatim
15997 #: ../fish/guestfish-actions.pod:5034
15998 #, no-wrap
15999 msgid ""
16000 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
16001 "\n"
16002 msgstr ""
16003
16004 #. type: textblock
16005 #: ../fish/guestfish-actions.pod:5036 ../src/guestfs-actions.pod:7758
16006 msgid "This command sets the timestamps of a file with nanosecond precision."
16007 msgstr ""
16008
16009 #. type: textblock
16010 #: ../fish/guestfish-actions.pod:5039 ../src/guestfs-actions.pod:7761
16011 msgid ""
16012 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
16013 "from the epoch."
16014 msgstr ""
16015
16016 #. type: textblock
16017 #: ../fish/guestfish-actions.pod:5042 ../src/guestfs-actions.pod:7764
16018 msgid ""
16019 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
16020 "nanoseconds from the epoch."
16021 msgstr ""
16022
16023 #. type: textblock
16024 #: ../fish/guestfish-actions.pod:5045 ../src/guestfs-actions.pod:7767
16025 msgid ""
16026 "If the C<*nsecs> field contains the special value C<-1> then the "
16027 "corresponding timestamp is set to the current time.  (The C<*secs> field is "
16028 "ignored in this case)."
16029 msgstr ""
16030
16031 #. type: textblock
16032 #: ../fish/guestfish-actions.pod:5049 ../src/guestfs-actions.pod:7771
16033 msgid ""
16034 "If the C<*nsecs> field contains the special value C<-2> then the "
16035 "corresponding timestamp is left unchanged.  (The C<*secs> field is ignored "
16036 "in this case)."
16037 msgstr ""
16038
16039 #. type: =head2
16040 #: ../fish/guestfish-actions.pod:5053
16041 msgid "version"
16042 msgstr ""
16043
16044 #. type: verbatim
16045 #: ../fish/guestfish-actions.pod:5055
16046 #, no-wrap
16047 msgid ""
16048 " version\n"
16049 "\n"
16050 msgstr ""
16051
16052 #. type: textblock
16053 #: ../fish/guestfish-actions.pod:5057 ../src/guestfs-actions.pod:7784
16054 msgid "Return the libguestfs version number that the program is linked against."
16055 msgstr ""
16056
16057 #. type: textblock
16058 #: ../fish/guestfish-actions.pod:5060 ../src/guestfs-actions.pod:7787
16059 msgid ""
16060 "Note that because of dynamic linking this is not necessarily the version of "
16061 "libguestfs that you compiled against.  You can compile the program, and then "
16062 "at runtime dynamically link against a completely different C<libguestfs.so> "
16063 "library."
16064 msgstr ""
16065
16066 #. type: textblock
16067 #: ../fish/guestfish-actions.pod:5065 ../src/guestfs-actions.pod:7792
16068 msgid ""
16069 "This call was added in version C<1.0.58>.  In previous versions of "
16070 "libguestfs there was no way to get the version number.  From C code you can "
16071 "use dynamic linker functions to find out if this symbol exists (if it "
16072 "doesn't, then it's an earlier version)."
16073 msgstr ""
16074
16075 #. type: textblock
16076 #: ../fish/guestfish-actions.pod:5071 ../src/guestfs-actions.pod:7798
16077 msgid ""
16078 "The call returns a structure with four elements.  The first three (C<major>, "
16079 "C<minor> and C<release>) are numbers and correspond to the usual version "
16080 "triplet.  The fourth element (C<extra>) is a string and is normally empty, "
16081 "but may be used for distro-specific information."
16082 msgstr ""
16083
16084 #. type: textblock
16085 #: ../fish/guestfish-actions.pod:5077 ../src/guestfs-actions.pod:7804
16086 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
16087 msgstr ""
16088
16089 #. type: textblock
16090 #: ../fish/guestfish-actions.pod:5080 ../src/guestfs-actions.pod:7807
16091 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
16092 msgstr ""
16093
16094 #. type: textblock
16095 #: ../fish/guestfish-actions.pod:5082
16096 msgid ""
16097 "I<Note:> Don't use this call to test for availability of features.  In "
16098 "enterprise distributions we backport features from later versions into "
16099 "earlier versions, making this an unreliable way to test for features.  Use "
16100 "L</available> instead."
16101 msgstr ""
16102
16103 #. type: =head2
16104 #: ../fish/guestfish-actions.pod:5088
16105 msgid "vfs-label"
16106 msgstr ""
16107
16108 #. type: verbatim
16109 #: ../fish/guestfish-actions.pod:5090
16110 #, no-wrap
16111 msgid ""
16112 " vfs-label device\n"
16113 "\n"
16114 msgstr ""
16115
16116 #. type: textblock
16117 #: ../fish/guestfish-actions.pod:5092 ../src/guestfs-actions.pod:7827
16118 msgid "This returns the filesystem label of the filesystem on C<device>."
16119 msgstr ""
16120
16121 #. type: textblock
16122 #: ../fish/guestfish-actions.pod:5095 ../src/guestfs-actions.pod:7830
16123 msgid "If the filesystem is unlabeled, this returns the empty string."
16124 msgstr ""
16125
16126 #. type: textblock
16127 #: ../fish/guestfish-actions.pod:5097
16128 msgid "To find a filesystem from the label, use L</findfs-label>."
16129 msgstr ""
16130
16131 #. type: =head2
16132 #: ../fish/guestfish-actions.pod:5099
16133 msgid "vfs-type"
16134 msgstr ""
16135
16136 #. type: verbatim
16137 #: ../fish/guestfish-actions.pod:5101
16138 #, no-wrap
16139 msgid ""
16140 " vfs-type device\n"
16141 "\n"
16142 msgstr ""
16143
16144 #. type: textblock
16145 #: ../fish/guestfish-actions.pod:5103 ../src/guestfs-actions.pod:7845
16146 msgid ""
16147 "This command gets the filesystem type corresponding to the filesystem on "
16148 "C<device>."
16149 msgstr ""
16150
16151 #. type: textblock
16152 #: ../fish/guestfish-actions.pod:5106 ../src/guestfs-actions.pod:7848
16153 msgid ""
16154 "For most filesystems, the result is the name of the Linux VFS module which "
16155 "would be used to mount this filesystem if you mounted it without specifying "
16156 "the filesystem type.  For example a string such as C<ext3> or C<ntfs>."
16157 msgstr ""
16158
16159 #. type: =head2
16160 #: ../fish/guestfish-actions.pod:5111
16161 msgid "vfs-uuid"
16162 msgstr ""
16163
16164 #. type: verbatim
16165 #: ../fish/guestfish-actions.pod:5113
16166 #, no-wrap
16167 msgid ""
16168 " vfs-uuid device\n"
16169 "\n"
16170 msgstr ""
16171
16172 #. type: textblock
16173 #: ../fish/guestfish-actions.pod:5115 ../src/guestfs-actions.pod:7864
16174 msgid "This returns the filesystem UUID of the filesystem on C<device>."
16175 msgstr ""
16176
16177 #. type: textblock
16178 #: ../fish/guestfish-actions.pod:5118 ../src/guestfs-actions.pod:7867
16179 msgid "If the filesystem does not have a UUID, this returns the empty string."
16180 msgstr ""
16181
16182 #. type: textblock
16183 #: ../fish/guestfish-actions.pod:5120
16184 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
16185 msgstr ""
16186
16187 #. type: =head2
16188 #: ../fish/guestfish-actions.pod:5122
16189 msgid "vg-activate"
16190 msgstr ""
16191
16192 #. type: verbatim
16193 #: ../fish/guestfish-actions.pod:5124
16194 #, no-wrap
16195 msgid ""
16196 " vg-activate true|false 'volgroups ...'\n"
16197 "\n"
16198 msgstr ""
16199
16200 #. type: textblock
16201 #: ../fish/guestfish-actions.pod:5126 ../src/guestfs-actions.pod:7883
16202 msgid ""
16203 "This command activates or (if C<activate> is false) deactivates all logical "
16204 "volumes in the listed volume groups C<volgroups>."
16205 msgstr ""
16206
16207 #. type: textblock
16208 #: ../fish/guestfish-actions.pod:5129 ../src/guestfs-actions.pod:7886
16209 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
16210 msgstr ""
16211
16212 #. type: textblock
16213 #: ../fish/guestfish-actions.pod:5131 ../src/guestfs-actions.pod:7888
16214 msgid ""
16215 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
16216 "activated or deactivated."
16217 msgstr ""
16218
16219 #. type: =head2
16220 #: ../fish/guestfish-actions.pod:5134
16221 msgid "vg-activate-all"
16222 msgstr ""
16223
16224 #. type: verbatim
16225 #: ../fish/guestfish-actions.pod:5136
16226 #, no-wrap
16227 msgid ""
16228 " vg-activate-all true|false\n"
16229 "\n"
16230 msgstr ""
16231
16232 #. type: textblock
16233 #: ../fish/guestfish-actions.pod:5138 ../src/guestfs-actions.pod:7901
16234 msgid ""
16235 "This command activates or (if C<activate> is false) deactivates all logical "
16236 "volumes in all volume groups."
16237 msgstr ""
16238
16239 #. type: textblock
16240 #: ../fish/guestfish-actions.pod:5141 ../src/guestfs-actions.pod:7904
16241 msgid "This command is the same as running C<vgchange -a y|n>"
16242 msgstr ""
16243
16244 #. type: =head2
16245 #: ../fish/guestfish-actions.pod:5143
16246 msgid "vgcreate"
16247 msgstr ""
16248
16249 #. type: verbatim
16250 #: ../fish/guestfish-actions.pod:5145
16251 #, no-wrap
16252 msgid ""
16253 " vgcreate volgroup 'physvols ...'\n"
16254 "\n"
16255 msgstr ""
16256
16257 #. type: textblock
16258 #: ../fish/guestfish-actions.pod:5147 ../src/guestfs-actions.pod:7917
16259 msgid ""
16260 "This creates an LVM volume group called C<volgroup> from the non-empty list "
16261 "of physical volumes C<physvols>."
16262 msgstr ""
16263
16264 #. type: =head2
16265 #: ../fish/guestfish-actions.pod:5150
16266 msgid "vglvuuids"
16267 msgstr ""
16268
16269 #. type: verbatim
16270 #: ../fish/guestfish-actions.pod:5152
16271 #, no-wrap
16272 msgid ""
16273 " vglvuuids vgname\n"
16274 "\n"
16275 msgstr ""
16276
16277 #. type: textblock
16278 #: ../fish/guestfish-actions.pod:5154 ../src/guestfs-actions.pod:7930
16279 msgid ""
16280 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
16281 "volumes created in this volume group."
16282 msgstr ""
16283
16284 #. type: textblock
16285 #: ../fish/guestfish-actions.pod:5157
16286 msgid ""
16287 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
16288 "logical volumes and volume groups."
16289 msgstr ""
16290
16291 #. type: textblock
16292 #: ../fish/guestfish-actions.pod:5160
16293 msgid "See also L</vgpvuuids>."
16294 msgstr ""
16295
16296 #. type: =head2
16297 #: ../fish/guestfish-actions.pod:5162
16298 msgid "vgpvuuids"
16299 msgstr ""
16300
16301 #. type: verbatim
16302 #: ../fish/guestfish-actions.pod:5164
16303 #, no-wrap
16304 msgid ""
16305 " vgpvuuids vgname\n"
16306 "\n"
16307 msgstr ""
16308
16309 #. type: textblock
16310 #: ../fish/guestfish-actions.pod:5166 ../src/guestfs-actions.pod:7950
16311 msgid ""
16312 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
16313 "volumes that this volume group resides on."
16314 msgstr ""
16315
16316 #. type: textblock
16317 #: ../fish/guestfish-actions.pod:5169
16318 msgid ""
16319 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
16320 "physical volumes and volume groups."
16321 msgstr ""
16322
16323 #. type: textblock
16324 #: ../fish/guestfish-actions.pod:5172
16325 msgid "See also L</vglvuuids>."
16326 msgstr ""
16327
16328 #. type: =head2
16329 #: ../fish/guestfish-actions.pod:5174
16330 msgid "vgremove"
16331 msgstr ""
16332
16333 #. type: verbatim
16334 #: ../fish/guestfish-actions.pod:5176
16335 #, no-wrap
16336 msgid ""
16337 " vgremove vgname\n"
16338 "\n"
16339 msgstr ""
16340
16341 #. type: textblock
16342 #: ../fish/guestfish-actions.pod:5178 ../src/guestfs-actions.pod:7970
16343 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
16344 msgstr ""
16345
16346 #. type: textblock
16347 #: ../fish/guestfish-actions.pod:5180 ../src/guestfs-actions.pod:7972
16348 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
16349 msgstr ""
16350
16351 #. type: =head2
16352 #: ../fish/guestfish-actions.pod:5183
16353 msgid "vgrename"
16354 msgstr ""
16355
16356 #. type: verbatim
16357 #: ../fish/guestfish-actions.pod:5185
16358 #, no-wrap
16359 msgid ""
16360 " vgrename volgroup newvolgroup\n"
16361 "\n"
16362 msgstr ""
16363
16364 #. type: textblock
16365 #: ../fish/guestfish-actions.pod:5187 ../src/guestfs-actions.pod:7986
16366 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
16367 msgstr ""
16368
16369 #. type: =head2
16370 #: ../fish/guestfish-actions.pod:5189
16371 msgid "vgs"
16372 msgstr ""
16373
16374 #. type: verbatim
16375 #: ../fish/guestfish-actions.pod:5191
16376 #, no-wrap
16377 msgid ""
16378 " vgs\n"
16379 "\n"
16380 msgstr ""
16381
16382 #. type: textblock
16383 #: ../fish/guestfish-actions.pod:5193 ../src/guestfs-actions.pod:7997
16384 msgid ""
16385 "List all the volumes groups detected.  This is the equivalent of the "
16386 "L<vgs(8)> command."
16387 msgstr ""
16388
16389 #. type: textblock
16390 #: ../fish/guestfish-actions.pod:5196 ../src/guestfs-actions.pod:8000
16391 msgid ""
16392 "This returns a list of just the volume group names that were detected "
16393 "(eg. C<VolGroup00>)."
16394 msgstr ""
16395
16396 #. type: textblock
16397 #: ../fish/guestfish-actions.pod:5199
16398 msgid "See also L</vgs-full>."
16399 msgstr ""
16400
16401 #. type: =head2
16402 #: ../fish/guestfish-actions.pod:5201
16403 msgid "vgs-full"
16404 msgstr ""
16405
16406 #. type: verbatim
16407 #: ../fish/guestfish-actions.pod:5203
16408 #, no-wrap
16409 msgid ""
16410 " vgs-full\n"
16411 "\n"
16412 msgstr ""
16413
16414 #. type: textblock
16415 #: ../fish/guestfish-actions.pod:5205 ../src/guestfs-actions.pod:8016
16416 msgid ""
16417 "List all the volumes groups detected.  This is the equivalent of the "
16418 "L<vgs(8)> command.  The \"full\" version includes all fields."
16419 msgstr ""
16420
16421 #. type: =head2
16422 #: ../fish/guestfish-actions.pod:5208
16423 msgid "vgscan"
16424 msgstr ""
16425
16426 #. type: verbatim
16427 #: ../fish/guestfish-actions.pod:5210
16428 #, no-wrap
16429 msgid ""
16430 " vgscan\n"
16431 "\n"
16432 msgstr ""
16433
16434 #. type: textblock
16435 #: ../fish/guestfish-actions.pod:5212 ../src/guestfs-actions.pod:8030
16436 msgid ""
16437 "This rescans all block devices and rebuilds the list of LVM physical "
16438 "volumes, volume groups and logical volumes."
16439 msgstr ""
16440
16441 #. type: =head2
16442 #: ../fish/guestfish-actions.pod:5215
16443 msgid "vguuid"
16444 msgstr ""
16445
16446 #. type: verbatim
16447 #: ../fish/guestfish-actions.pod:5217
16448 #, no-wrap
16449 msgid ""
16450 " vguuid vgname\n"
16451 "\n"
16452 msgstr ""
16453
16454 #. type: textblock
16455 #: ../fish/guestfish-actions.pod:5219 ../src/guestfs-actions.pod:8043
16456 msgid "This command returns the UUID of the LVM VG named C<vgname>."
16457 msgstr ""
16458
16459 #. type: =head2
16460 #: ../fish/guestfish-actions.pod:5221
16461 msgid "wc-c"
16462 msgstr ""
16463
16464 #. type: verbatim
16465 #: ../fish/guestfish-actions.pod:5223
16466 #, no-wrap
16467 msgid ""
16468 " wc-c path\n"
16469 "\n"
16470 msgstr ""
16471
16472 #. type: textblock
16473 #: ../fish/guestfish-actions.pod:5225 ../src/guestfs-actions.pod:8083
16474 msgid ""
16475 "This command counts the characters in a file, using the C<wc -c> external "
16476 "command."
16477 msgstr ""
16478
16479 #. type: =head2
16480 #: ../fish/guestfish-actions.pod:5228
16481 msgid "wc-l"
16482 msgstr ""
16483
16484 #. type: verbatim
16485 #: ../fish/guestfish-actions.pod:5230
16486 #, no-wrap
16487 msgid ""
16488 " wc-l path\n"
16489 "\n"
16490 msgstr ""
16491
16492 #. type: textblock
16493 #: ../fish/guestfish-actions.pod:5232 ../src/guestfs-actions.pod:8096
16494 msgid ""
16495 "This command counts the lines in a file, using the C<wc -l> external "
16496 "command."
16497 msgstr ""
16498
16499 #. type: =head2
16500 #: ../fish/guestfish-actions.pod:5235
16501 msgid "wc-w"
16502 msgstr ""
16503
16504 #. type: verbatim
16505 #: ../fish/guestfish-actions.pod:5237
16506 #, no-wrap
16507 msgid ""
16508 " wc-w path\n"
16509 "\n"
16510 msgstr ""
16511
16512 #. type: textblock
16513 #: ../fish/guestfish-actions.pod:5239 ../src/guestfs-actions.pod:8109
16514 msgid ""
16515 "This command counts the words in a file, using the C<wc -w> external "
16516 "command."
16517 msgstr ""
16518
16519 #. type: =head2
16520 #: ../fish/guestfish-actions.pod:5242
16521 msgid "write"
16522 msgstr ""
16523
16524 #. type: verbatim
16525 #: ../fish/guestfish-actions.pod:5244
16526 #, no-wrap
16527 msgid ""
16528 " write path content\n"
16529 "\n"
16530 msgstr ""
16531
16532 #. type: textblock
16533 #: ../fish/guestfish-actions.pod:5246 ../src/guestfs-actions.pod:8124
16534 msgid ""
16535 "This call creates a file called C<path>.  The content of the file is the "
16536 "string C<content> (which can contain any 8 bit data)."
16537 msgstr ""
16538
16539 #. type: textblock
16540 #: ../fish/guestfish-actions.pod:5249
16541 msgid "See also L</write-append>."
16542 msgstr ""
16543
16544 #. type: =head2
16545 #: ../fish/guestfish-actions.pod:5254
16546 msgid "write-append"
16547 msgstr ""
16548
16549 #. type: verbatim
16550 #: ../fish/guestfish-actions.pod:5256
16551 #, no-wrap
16552 msgid ""
16553 " write-append path content\n"
16554 "\n"
16555 msgstr ""
16556
16557 #. type: textblock
16558 #: ../fish/guestfish-actions.pod:5258 ../src/guestfs-actions.pod:8144
16559 msgid ""
16560 "This call appends C<content> to the end of file C<path>.  If C<path> does "
16561 "not exist, then a new file is created."
16562 msgstr ""
16563
16564 #. type: textblock
16565 #: ../fish/guestfish-actions.pod:5261
16566 msgid "See also L</write>."
16567 msgstr ""
16568
16569 #. type: =head2
16570 #: ../fish/guestfish-actions.pod:5266
16571 msgid "write-file"
16572 msgstr ""
16573
16574 #. type: verbatim
16575 #: ../fish/guestfish-actions.pod:5268
16576 #, no-wrap
16577 msgid ""
16578 " write-file path content size\n"
16579 "\n"
16580 msgstr ""
16581
16582 #. type: textblock
16583 #: ../fish/guestfish-actions.pod:5270 ../src/guestfs-actions.pod:8171
16584 msgid ""
16585 "This call creates a file called C<path>.  The contents of the file is the "
16586 "string C<content> (which can contain any 8 bit data), with length C<size>."
16587 msgstr ""
16588
16589 #. type: textblock
16590 #: ../fish/guestfish-actions.pod:5274 ../src/guestfs-actions.pod:8175
16591 msgid ""
16592 "As a special case, if C<size> is C<0> then the length is calculated using "
16593 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
16594 msgstr ""
16595
16596 #. type: textblock
16597 #: ../fish/guestfish-actions.pod:5278 ../src/guestfs-actions.pod:8179
16598 msgid ""
16599 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
16600 "I<not> work, even if the length is specified."
16601 msgstr ""
16602
16603 #. type: textblock
16604 #: ../fish/guestfish-actions.pod:5284
16605 msgid "I<This function is deprecated.> In new code, use the L</write> call instead."
16606 msgstr ""
16607
16608 #. type: =head2
16609 #: ../fish/guestfish-actions.pod:5291
16610 msgid "zegrep"
16611 msgstr ""
16612
16613 #. type: verbatim
16614 #: ../fish/guestfish-actions.pod:5293
16615 #, no-wrap
16616 msgid ""
16617 " zegrep regex path\n"
16618 "\n"
16619 msgstr ""
16620
16621 #. type: textblock
16622 #: ../fish/guestfish-actions.pod:5295 ../src/guestfs-actions.pod:8196
16623 msgid "This calls the external C<zegrep> program and returns the matching lines."
16624 msgstr ""
16625
16626 #. type: =head2
16627 #: ../fish/guestfish-actions.pod:5301
16628 msgid "zegrepi"
16629 msgstr ""
16630
16631 #. type: verbatim
16632 #: ../fish/guestfish-actions.pod:5303
16633 #, no-wrap
16634 msgid ""
16635 " zegrepi regex path\n"
16636 "\n"
16637 msgstr ""
16638
16639 #. type: textblock
16640 #: ../fish/guestfish-actions.pod:5305 ../src/guestfs-actions.pod:8215
16641 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
16642 msgstr ""
16643
16644 #. type: =head2
16645 #: ../fish/guestfish-actions.pod:5311
16646 msgid "zero"
16647 msgstr ""
16648
16649 #. type: verbatim
16650 #: ../fish/guestfish-actions.pod:5313
16651 #, no-wrap
16652 msgid ""
16653 " zero device\n"
16654 "\n"
16655 msgstr ""
16656
16657 #. type: textblock
16658 #: ../fish/guestfish-actions.pod:5315 ../src/guestfs-actions.pod:8233
16659 msgid "This command writes zeroes over the first few blocks of C<device>."
16660 msgstr ""
16661
16662 #. type: textblock
16663 #: ../fish/guestfish-actions.pod:5317 ../src/guestfs-actions.pod:8235
16664 msgid ""
16665 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
16666 "securely wipe the device).  It should be sufficient to remove any partition "
16667 "tables, filesystem superblocks and so on."
16668 msgstr ""
16669
16670 #. type: textblock
16671 #: ../fish/guestfish-actions.pod:5321 ../fish/guestfish-actions.pod:5336 ../src/guestfs-actions.pod:8239 ../src/guestfs-actions.pod:8265
16672 msgid ""
16673 "If blocks are already zero, then this command avoids writing zeroes.  This "
16674 "prevents the underlying device from becoming non-sparse or growing "
16675 "unnecessarily."
16676 msgstr ""
16677
16678 #. type: textblock
16679 #: ../fish/guestfish-actions.pod:5325
16680 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
16681 msgstr ""
16682
16683 #. type: =head2
16684 #: ../fish/guestfish-actions.pod:5328
16685 msgid "zero-device"
16686 msgstr ""
16687
16688 #. type: verbatim
16689 #: ../fish/guestfish-actions.pod:5330
16690 #, no-wrap
16691 msgid ""
16692 " zero-device device\n"
16693 "\n"
16694 msgstr ""
16695
16696 #. type: textblock
16697 #: ../fish/guestfish-actions.pod:5332
16698 msgid ""
16699 "This command writes zeroes over the entire C<device>.  Compare with L</zero> "
16700 "which just zeroes the first few blocks of a device."
16701 msgstr ""
16702
16703 #. type: =head2
16704 #: ../fish/guestfish-actions.pod:5340
16705 msgid "zerofree"
16706 msgstr ""
16707
16708 #. type: verbatim
16709 #: ../fish/guestfish-actions.pod:5342
16710 #, no-wrap
16711 msgid ""
16712 " zerofree device\n"
16713 "\n"
16714 msgstr ""
16715
16716 #. type: textblock
16717 #: ../fish/guestfish-actions.pod:5344 ../src/guestfs-actions.pod:8284
16718 msgid ""
16719 "This runs the I<zerofree> program on C<device>.  This program claims to zero "
16720 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16721 "possible to compress the filesystem more effectively."
16722 msgstr ""
16723
16724 #. type: textblock
16725 #: ../fish/guestfish-actions.pod:5349 ../src/guestfs-actions.pod:8289
16726 msgid "You should B<not> run this program if the filesystem is mounted."
16727 msgstr ""
16728
16729 #. type: textblock
16730 #: ../fish/guestfish-actions.pod:5352 ../src/guestfs-actions.pod:8292
16731 msgid ""
16732 "It is possible that using this program can damage the filesystem or data on "
16733 "the filesystem."
16734 msgstr ""
16735
16736 #. type: =head2
16737 #: ../fish/guestfish-actions.pod:5355
16738 msgid "zfgrep"
16739 msgstr ""
16740
16741 #. type: verbatim
16742 #: ../fish/guestfish-actions.pod:5357
16743 #, no-wrap
16744 msgid ""
16745 " zfgrep pattern path\n"
16746 "\n"
16747 msgstr ""
16748
16749 #. type: textblock
16750 #: ../fish/guestfish-actions.pod:5359 ../src/guestfs-actions.pod:8306
16751 msgid "This calls the external C<zfgrep> program and returns the matching lines."
16752 msgstr ""
16753
16754 #. type: =head2
16755 #: ../fish/guestfish-actions.pod:5365
16756 msgid "zfgrepi"
16757 msgstr ""
16758
16759 #. type: verbatim
16760 #: ../fish/guestfish-actions.pod:5367
16761 #, no-wrap
16762 msgid ""
16763 " zfgrepi pattern path\n"
16764 "\n"
16765 msgstr ""
16766
16767 #. type: textblock
16768 #: ../fish/guestfish-actions.pod:5369 ../src/guestfs-actions.pod:8325
16769 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
16770 msgstr ""
16771
16772 #. type: =head2
16773 #: ../fish/guestfish-actions.pod:5375
16774 msgid "zfile"
16775 msgstr ""
16776
16777 #. type: verbatim
16778 #: ../fish/guestfish-actions.pod:5377
16779 #, no-wrap
16780 msgid ""
16781 " zfile meth path\n"
16782 "\n"
16783 msgstr ""
16784
16785 #. type: textblock
16786 #: ../fish/guestfish-actions.pod:5379 ../src/guestfs-actions.pod:8351
16787 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
16788 msgstr ""
16789
16790 #. type: textblock
16791 #: ../fish/guestfish-actions.pod:5382 ../src/guestfs-actions.pod:8354
16792 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16793 msgstr ""
16794
16795 #. type: textblock
16796 #: ../fish/guestfish-actions.pod:5384
16797 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
16798 msgstr ""
16799
16800 #. type: textblock
16801 #: ../fish/guestfish-actions.pod:5387
16802 msgid "I<This function is deprecated.> In new code, use the L</file> call instead."
16803 msgstr ""
16804
16805 #. type: =head2
16806 #: ../fish/guestfish-actions.pod:5394
16807 msgid "zgrep"
16808 msgstr ""
16809
16810 #. type: verbatim
16811 #: ../fish/guestfish-actions.pod:5396
16812 #, no-wrap
16813 msgid ""
16814 " zgrep regex path\n"
16815 "\n"
16816 msgstr ""
16817
16818 #. type: textblock
16819 #: ../fish/guestfish-actions.pod:5398 ../src/guestfs-actions.pod:8371
16820 msgid "This calls the external C<zgrep> program and returns the matching lines."
16821 msgstr ""
16822
16823 #. type: =head2
16824 #: ../fish/guestfish-actions.pod:5404
16825 msgid "zgrepi"
16826 msgstr ""
16827
16828 #. type: verbatim
16829 #: ../fish/guestfish-actions.pod:5406
16830 #, no-wrap
16831 msgid ""
16832 " zgrepi regex path\n"
16833 "\n"
16834 msgstr ""
16835
16836 #. type: textblock
16837 #: ../fish/guestfish-actions.pod:5408 ../src/guestfs-actions.pod:8390
16838 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
16839 msgstr ""
16840
16841 #. type: =head2
16842 #: ../fish/guestfish-commands.pod:1
16843 msgid "alloc"
16844 msgstr ""
16845
16846 #. type: =head2
16847 #: ../fish/guestfish-commands.pod:3
16848 msgid "allocate"
16849 msgstr ""
16850
16851 #. type: verbatim
16852 #: ../fish/guestfish-commands.pod:5
16853 #, no-wrap
16854 msgid ""
16855 " alloc filename size\n"
16856 "\n"
16857 msgstr ""
16858
16859 #. type: textblock
16860 #: ../fish/guestfish-commands.pod:7
16861 msgid ""
16862 "This creates an empty (zeroed) file of the given size, and then adds so it "
16863 "can be further examined."
16864 msgstr ""
16865
16866 #. type: textblock
16867 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:193
16868 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
16869 msgstr ""
16870
16871 #. type: textblock
16872 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:195
16873 msgid "Size can be specified using standard suffixes, eg. C<1M>."
16874 msgstr ""
16875
16876 #. type: textblock
16877 #: ../fish/guestfish-commands.pod:14
16878 msgid ""
16879 "To create a sparse file, use L</sparse> instead.  To create a prepared disk "
16880 "image, see L</PREPARED DISK IMAGES>."
16881 msgstr ""
16882
16883 #. type: =head2
16884 #: ../fish/guestfish-commands.pod:17
16885 msgid "copy-in"
16886 msgstr ""
16887
16888 #. type: verbatim
16889 #: ../fish/guestfish-commands.pod:19
16890 #, no-wrap
16891 msgid ""
16892 " copy-in local [local ...] /remotedir\n"
16893 "\n"
16894 msgstr ""
16895
16896 #. type: textblock
16897 #: ../fish/guestfish-commands.pod:21
16898 msgid ""
16899 "C<copy-in> copies local files or directories recursively into the disk "
16900 "image, placing them in the directory called C</remotedir> (which must "
16901 "exist).  This guestfish meta-command turns into a sequence of L</tar-in> and "
16902 "other commands as necessary."
16903 msgstr ""
16904
16905 #. type: textblock
16906 #: ../fish/guestfish-commands.pod:26
16907 msgid ""
16908 "Multiple local files and directories can be specified, but the last "
16909 "parameter must always be a remote directory.  Wildcards cannot be used."
16910 msgstr ""
16911
16912 #. type: =head2
16913 #: ../fish/guestfish-commands.pod:30
16914 msgid "copy-out"
16915 msgstr ""
16916
16917 #. type: verbatim
16918 #: ../fish/guestfish-commands.pod:32
16919 #, no-wrap
16920 msgid ""
16921 " copy-out remote [remote ...] localdir\n"
16922 "\n"
16923 msgstr ""
16924
16925 #. type: textblock
16926 #: ../fish/guestfish-commands.pod:34
16927 msgid ""
16928 "C<copy-out> copies remote files or directories recursively out of the disk "
16929 "image, placing them on the host disk in a local directory called C<localdir> "
16930 "(which must exist).  This guestfish meta-command turns into a sequence of "
16931 "L</download>, L</tar-out> and other commands as necessary."
16932 msgstr ""
16933
16934 #. type: textblock
16935 #: ../fish/guestfish-commands.pod:40
16936 msgid ""
16937 "Multiple remote files and directories can be specified, but the last "
16938 "parameter must always be a local directory.  To download to the current "
16939 "directory, use C<.> as in:"
16940 msgstr ""
16941
16942 #. type: verbatim
16943 #: ../fish/guestfish-commands.pod:44
16944 #, no-wrap
16945 msgid ""
16946 " copy-out /home .\n"
16947 "\n"
16948 msgstr ""
16949
16950 #. type: textblock
16951 #: ../fish/guestfish-commands.pod:46
16952 msgid ""
16953 "Wildcards cannot be used in the ordinary command, but you can use them with "
16954 "the help of L</glob> like this:"
16955 msgstr ""
16956
16957 #. type: verbatim
16958 #: ../fish/guestfish-commands.pod:49
16959 #, no-wrap
16960 msgid ""
16961 " glob copy-out /home/* .\n"
16962 "\n"
16963 msgstr ""
16964
16965 #. type: =head2
16966 #: ../fish/guestfish-commands.pod:51
16967 msgid "display"
16968 msgstr ""
16969
16970 #. type: verbatim
16971 #: ../fish/guestfish-commands.pod:53
16972 #, no-wrap
16973 msgid ""
16974 " display filename\n"
16975 "\n"
16976 msgstr ""
16977
16978 #. type: textblock
16979 #: ../fish/guestfish-commands.pod:55
16980 msgid ""
16981 "Use C<display> (a graphical display program) to display an image file.  It "
16982 "downloads the file, and runs C<display> on it."
16983 msgstr ""
16984
16985 #. type: textblock
16986 #: ../fish/guestfish-commands.pod:58
16987 msgid ""
16988 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
16989 "environment variable.  For example to use the GNOME display program:"
16990 msgstr ""
16991
16992 #. type: verbatim
16993 #: ../fish/guestfish-commands.pod:61
16994 #, no-wrap
16995 msgid ""
16996 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
16997 "\n"
16998 msgstr ""
16999
17000 #. type: textblock
17001 #: ../fish/guestfish-commands.pod:63
17002 msgid "See also L<display(1)>."
17003 msgstr ""
17004
17005 #. type: =head2
17006 #: ../fish/guestfish-commands.pod:65
17007 msgid "echo"
17008 msgstr ""
17009
17010 #. type: verbatim
17011 #: ../fish/guestfish-commands.pod:67
17012 #, no-wrap
17013 msgid ""
17014 " echo [params ...]\n"
17015 "\n"
17016 msgstr ""
17017
17018 #. type: textblock
17019 #: ../fish/guestfish-commands.pod:69
17020 msgid "This echos the parameters to the terminal."
17021 msgstr ""
17022
17023 #. type: =head2
17024 #: ../fish/guestfish-commands.pod:71
17025 msgid "edit"
17026 msgstr ""
17027
17028 #. type: =head2
17029 #: ../fish/guestfish-commands.pod:73
17030 msgid "vi"
17031 msgstr ""
17032
17033 #. type: =head2
17034 #: ../fish/guestfish-commands.pod:75
17035 msgid "emacs"
17036 msgstr ""
17037
17038 #. type: verbatim
17039 #: ../fish/guestfish-commands.pod:77
17040 #, no-wrap
17041 msgid ""
17042 " edit filename\n"
17043 "\n"
17044 msgstr ""
17045
17046 #. type: textblock
17047 #: ../fish/guestfish-commands.pod:79
17048 msgid ""
17049 "This is used to edit a file.  It downloads the file, edits it locally using "
17050 "your editor, then uploads the result."
17051 msgstr ""
17052
17053 #. type: textblock
17054 #: ../fish/guestfish-commands.pod:82
17055 msgid ""
17056 "The editor is C<$EDITOR>.  However if you use the alternate commands C<vi> "
17057 "or C<emacs> you will get those corresponding editors."
17058 msgstr ""
17059
17060 #. type: =head2
17061 #: ../fish/guestfish-commands.pod:86
17062 msgid "glob"
17063 msgstr ""
17064
17065 #. type: verbatim
17066 #: ../fish/guestfish-commands.pod:88
17067 #, no-wrap
17068 msgid ""
17069 " glob command args...\n"
17070 "\n"
17071 msgstr ""
17072
17073 #. type: textblock
17074 #: ../fish/guestfish-commands.pod:90
17075 msgid ""
17076 "Expand wildcards in any paths in the args list, and run C<command> "
17077 "repeatedly on each matching path."
17078 msgstr ""
17079
17080 #. type: textblock
17081 #: ../fish/guestfish-commands.pod:93
17082 msgid "See L</WILDCARDS AND GLOBBING>."
17083 msgstr ""
17084
17085 #. type: =head2
17086 #: ../fish/guestfish-commands.pod:95
17087 msgid "hexedit"
17088 msgstr ""
17089
17090 #. type: verbatim
17091 #: ../fish/guestfish-commands.pod:97
17092 #, no-wrap
17093 msgid ""
17094 " hexedit <filename|device>\n"
17095 " hexedit <filename|device> <max>\n"
17096 " hexedit <filename|device> <start> <max>\n"
17097 "\n"
17098 msgstr ""
17099
17100 #. type: textblock
17101 #: ../fish/guestfish-commands.pod:101
17102 msgid ""
17103 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
17104 "device."
17105 msgstr ""
17106
17107 #. type: textblock
17108 #: ../fish/guestfish-commands.pod:104
17109 msgid ""
17110 "This command works by downloading potentially the whole file or device, "
17111 "editing it locally, then uploading it.  If the file or device is large, you "
17112 "have to specify which part you wish to edit by using C<max> and/or C<start> "
17113 "C<max> parameters.  C<start> and C<max> are specified in bytes, with the "
17114 "usual modifiers allowed such as C<1M> (1 megabyte)."
17115 msgstr ""
17116
17117 #. type: textblock
17118 #: ../fish/guestfish-commands.pod:111
17119 msgid "For example to edit the first few sectors of a disk you might do:"
17120 msgstr ""
17121
17122 #. type: verbatim
17123 #: ../fish/guestfish-commands.pod:114
17124 #, no-wrap
17125 msgid ""
17126 " hexedit /dev/sda 1M\n"
17127 "\n"
17128 msgstr ""
17129
17130 #. type: textblock
17131 #: ../fish/guestfish-commands.pod:116
17132 msgid ""
17133 "which would allow you to edit anywhere within the first megabyte of the "
17134 "disk."
17135 msgstr ""
17136
17137 #. type: textblock
17138 #: ../fish/guestfish-commands.pod:119
17139 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
17140 msgstr ""
17141
17142 #. type: verbatim
17143 #: ../fish/guestfish-commands.pod:121
17144 #, no-wrap
17145 msgid ""
17146 " hexedit /dev/sda1 0x400 0x400\n"
17147 "\n"
17148 msgstr ""
17149
17150 #. type: textblock
17151 #: ../fish/guestfish-commands.pod:123
17152 msgid "(assuming the superblock is in the standard location)."
17153 msgstr ""
17154
17155 #. type: textblock
17156 #: ../fish/guestfish-commands.pod:125
17157 msgid ""
17158 "This command requires the external L<hexedit(1)> program.  You can specify "
17159 "another program to use by setting the C<HEXEDITOR> environment variable."
17160 msgstr ""
17161
17162 #. type: textblock
17163 #: ../fish/guestfish-commands.pod:129
17164 msgid "See also L</hexdump>."
17165 msgstr ""
17166
17167 #. type: =head2
17168 #: ../fish/guestfish-commands.pod:131
17169 msgid "lcd"
17170 msgstr ""
17171
17172 #. type: verbatim
17173 #: ../fish/guestfish-commands.pod:133
17174 #, no-wrap
17175 msgid ""
17176 " lcd directory\n"
17177 "\n"
17178 msgstr ""
17179
17180 #. type: textblock
17181 #: ../fish/guestfish-commands.pod:135
17182 msgid "Change the local directory, ie. the current directory of guestfish itself."
17183 msgstr ""
17184
17185 #. type: textblock
17186 #: ../fish/guestfish-commands.pod:138
17187 msgid "Note that C<!cd> won't do what you might expect."
17188 msgstr ""
17189
17190 #. type: =head2
17191 #: ../fish/guestfish-commands.pod:140
17192 msgid "man"
17193 msgstr ""
17194
17195 #. type: =head2
17196 #: ../fish/guestfish-commands.pod:142
17197 msgid "manual"
17198 msgstr ""
17199
17200 #. type: verbatim
17201 #: ../fish/guestfish-commands.pod:144
17202 #, no-wrap
17203 msgid ""
17204 "  man\n"
17205 "\n"
17206 msgstr ""
17207
17208 #. type: textblock
17209 #: ../fish/guestfish-commands.pod:146
17210 msgid "Opens the manual page for guestfish."
17211 msgstr ""
17212
17213 #. type: =head2
17214 #: ../fish/guestfish-commands.pod:148
17215 msgid "more"
17216 msgstr ""
17217
17218 #. type: =head2
17219 #: ../fish/guestfish-commands.pod:150
17220 msgid "less"
17221 msgstr ""
17222
17223 #. type: verbatim
17224 #: ../fish/guestfish-commands.pod:152
17225 #, no-wrap
17226 msgid ""
17227 " more filename\n"
17228 "\n"
17229 msgstr ""
17230
17231 #. type: verbatim
17232 #: ../fish/guestfish-commands.pod:154
17233 #, no-wrap
17234 msgid ""
17235 " less filename\n"
17236 "\n"
17237 msgstr ""
17238
17239 #. type: textblock
17240 #: ../fish/guestfish-commands.pod:156
17241 msgid "This is used to view a file."
17242 msgstr ""
17243
17244 #. type: textblock
17245 #: ../fish/guestfish-commands.pod:158
17246 msgid ""
17247 "The default viewer is C<$PAGER>.  However if you use the alternate command "
17248 "C<less> you will get the C<less> command specifically."
17249 msgstr ""
17250
17251 #. type: =head2
17252 #: ../fish/guestfish-commands.pod:161
17253 msgid "reopen"
17254 msgstr ""
17255
17256 #. type: verbatim
17257 #: ../fish/guestfish-commands.pod:163
17258 #, no-wrap
17259 msgid ""
17260 "  reopen\n"
17261 "\n"
17262 msgstr ""
17263
17264 #. type: textblock
17265 #: ../fish/guestfish-commands.pod:165
17266 msgid ""
17267 "Close and reopen the libguestfs handle.  It is not necessary to use this "
17268 "normally, because the handle is closed properly when guestfish exits.  "
17269 "However this is occasionally useful for testing."
17270 msgstr ""
17271
17272 #. type: =head2
17273 #: ../fish/guestfish-commands.pod:169
17274 msgid "setenv"
17275 msgstr ""
17276
17277 #. type: verbatim
17278 #: ../fish/guestfish-commands.pod:171
17279 #, no-wrap
17280 msgid ""
17281 "  setenv VAR value\n"
17282 "\n"
17283 msgstr ""
17284
17285 #. type: textblock
17286 #: ../fish/guestfish-commands.pod:173
17287 msgid "Set the environment variable C<VAR> to the string C<value>."
17288 msgstr ""
17289
17290 #. type: textblock
17291 #: ../fish/guestfish-commands.pod:175
17292 msgid "To print the value of an environment variable use a shell command such as:"
17293 msgstr ""
17294
17295 #. type: verbatim
17296 #: ../fish/guestfish-commands.pod:178
17297 #, no-wrap
17298 msgid ""
17299 " !echo $VAR\n"
17300 "\n"
17301 msgstr ""
17302
17303 #. type: =head2
17304 #: ../fish/guestfish-commands.pod:180
17305 msgid "sparse"
17306 msgstr ""
17307
17308 #. type: verbatim
17309 #: ../fish/guestfish-commands.pod:182
17310 #, no-wrap
17311 msgid ""
17312 " sparse filename size\n"
17313 "\n"
17314 msgstr ""
17315
17316 #. type: textblock
17317 #: ../fish/guestfish-commands.pod:184
17318 msgid ""
17319 "This creates an empty sparse file of the given size, and then adds so it can "
17320 "be further examined."
17321 msgstr ""
17322
17323 #. type: textblock
17324 #: ../fish/guestfish-commands.pod:187
17325 msgid ""
17326 "In all respects it works the same as the L</alloc> command, except that the "
17327 "image file is allocated sparsely, which means that disk blocks are not "
17328 "assigned to the file until they are needed.  Sparse disk files only use "
17329 "space when written to, but they are slower and there is a danger you could "
17330 "run out of real disk space during a write operation."
17331 msgstr ""
17332
17333 #. type: =head2
17334 #: ../fish/guestfish-commands.pod:197
17335 msgid "supported"
17336 msgstr ""
17337
17338 #. type: verbatim
17339 #: ../fish/guestfish-commands.pod:199
17340 #, no-wrap
17341 msgid ""
17342 " supported\n"
17343 "\n"
17344 msgstr ""
17345
17346 #. type: textblock
17347 #: ../fish/guestfish-commands.pod:201
17348 msgid ""
17349 "This command returns a list of the optional groups known to the daemon, and "
17350 "indicates which ones are supported by this build of the libguestfs "
17351 "appliance."
17352 msgstr ""
17353
17354 #. type: textblock
17355 #: ../fish/guestfish-commands.pod:205
17356 msgid "See also L<guestfs(3)/AVAILABILITY>."
17357 msgstr ""
17358
17359 #. type: =head2
17360 #: ../fish/guestfish-commands.pod:207
17361 msgid "time"
17362 msgstr ""
17363
17364 #. type: verbatim
17365 #: ../fish/guestfish-commands.pod:209
17366 #, no-wrap
17367 msgid ""
17368 " time command args...\n"
17369 "\n"
17370 msgstr ""
17371
17372 #. type: textblock
17373 #: ../fish/guestfish-commands.pod:211
17374 msgid ""
17375 "Run the command as usual, but print the elapsed time afterwards.  This can "
17376 "be useful for benchmarking operations."
17377 msgstr ""
17378
17379 #. type: =head2
17380 #: ../fish/guestfish-commands.pod:214
17381 msgid "unsetenv"
17382 msgstr ""
17383
17384 #. type: verbatim
17385 #: ../fish/guestfish-commands.pod:216
17386 #, no-wrap
17387 msgid ""
17388 "  unsetenv VAR\n"
17389 "\n"
17390 msgstr ""
17391
17392 #. type: textblock
17393 #: ../fish/guestfish-commands.pod:218
17394 msgid "Remove C<VAR> from the environment."
17395 msgstr ""
17396
17397 #. type: textblock
17398 #: ../fish/guestfish.pod:5
17399 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
17400 msgstr ""
17401
17402 #. type: verbatim
17403 #: ../fish/guestfish.pod:9
17404 #, no-wrap
17405 msgid ""
17406 " guestfish [--options] [commands]\n"
17407 "\n"
17408 msgstr ""
17409
17410 #. type: verbatim
17411 #: ../fish/guestfish.pod:11
17412 #, no-wrap
17413 msgid ""
17414 " guestfish\n"
17415 "\n"
17416 msgstr ""
17417
17418 #. type: verbatim
17419 #: ../fish/guestfish.pod:13
17420 #, no-wrap
17421 msgid ""
17422 " guestfish [--ro|--rw] -a disk.img\n"
17423 "\n"
17424 msgstr ""
17425
17426 #. type: verbatim
17427 #: ../fish/guestfish.pod:15
17428 #, no-wrap
17429 msgid ""
17430 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
17431 "\n"
17432 msgstr ""
17433
17434 #. type: verbatim
17435 #: ../fish/guestfish.pod:17
17436 #, no-wrap
17437 msgid ""
17438 " guestfish -d libvirt-domain\n"
17439 "\n"
17440 msgstr ""
17441
17442 #. type: verbatim
17443 #: ../fish/guestfish.pod:19
17444 #, no-wrap
17445 msgid ""
17446 " guestfish [--ro|--rw] -a disk.img -i\n"
17447 "\n"
17448 msgstr ""
17449
17450 #. type: verbatim
17451 #: ../fish/guestfish.pod:21
17452 #, no-wrap
17453 msgid ""
17454 " guestfish -d libvirt-domain -i\n"
17455 "\n"
17456 msgstr ""
17457
17458 #. type: textblock
17459 #: ../fish/guestfish.pod:25
17460 msgid ""
17461 "Using guestfish in read/write mode on live virtual machines can be "
17462 "dangerous, potentially causing disk corruption.  Use the I<--ro> (read-only) "
17463 "option to use guestfish safely if the disk image or virtual machine might be "
17464 "live."
17465 msgstr ""
17466
17467 #. type: textblock
17468 #: ../fish/guestfish.pod:32
17469 msgid ""
17470 "Guestfish is a shell and command-line tool for examining and modifying "
17471 "virtual machine filesystems.  It uses libguestfs and exposes all of the "
17472 "functionality of the guestfs API, see L<guestfs(3)>."
17473 msgstr ""
17474
17475 #. type: textblock
17476 #: ../fish/guestfish.pod:36
17477 msgid ""
17478 "Guestfish gives you structured access to the libguestfs API, from shell "
17479 "scripts or the command line or interactively.  If you want to rescue a "
17480 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
17481 "command."
17482 msgstr ""
17483
17484 #. type: =head2
17485 #: ../fish/guestfish.pod:43
17486 msgid "As an interactive shell"
17487 msgstr ""
17488
17489 #. type: verbatim
17490 #: ../fish/guestfish.pod:45
17491 #, no-wrap
17492 msgid ""
17493 " $ guestfish\n"
17494 " \n"
17495 msgstr ""
17496
17497 #. type: verbatim
17498 #: ../fish/guestfish.pod:47
17499 #, no-wrap
17500 msgid ""
17501 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
17502 " editing virtual machine filesystems.\n"
17503 " \n"
17504 msgstr ""
17505
17506 #. type: verbatim
17507 #: ../fish/guestfish.pod:50
17508 #, no-wrap
17509 msgid ""
17510 " Type: 'help' for a list of commands\n"
17511 "       'man' to read the manual\n"
17512 "       'quit' to quit the shell\n"
17513 " \n"
17514 msgstr ""
17515
17516 #. type: verbatim
17517 #: ../fish/guestfish.pod:54
17518 #, no-wrap
17519 msgid ""
17520 " ><fs> add-ro disk.img\n"
17521 " ><fs> run\n"
17522 " ><fs> list-filesystems\n"
17523 " /dev/sda1: ext4\n"
17524 " /dev/vg_guest/lv_root: ext4\n"
17525 " /dev/vg_guest/lv_swap: swap\n"
17526 " ><fs> mount /dev/vg_guest/lv_root /\n"
17527 " ><fs> cat /etc/fstab\n"
17528 " # /etc/fstab\n"
17529 " # Created by anaconda\n"
17530 " [...]\n"
17531 " ><fs> exit\n"
17532 "\n"
17533 msgstr ""
17534
17535 #. type: =head2
17536 #: ../fish/guestfish.pod:67
17537 msgid "From shell scripts"
17538 msgstr ""
17539
17540 #. type: textblock
17541 #: ../fish/guestfish.pod:69
17542 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17543 msgstr ""
17544
17545 #. type: verbatim
17546 #: ../fish/guestfish.pod:71
17547 #, no-wrap
17548 msgid ""
17549 " guestfish <<_EOF_\n"
17550 " add disk.img\n"
17551 " run\n"
17552 " mount /dev/vg_guest/lv_root /\n"
17553 " write /etc/motd \"Welcome, new users\"\n"
17554 " _EOF_\n"
17555 "\n"
17556 msgstr ""
17557
17558 #. type: textblock
17559 #: ../fish/guestfish.pod:78
17560 msgid "List the LVM logical volumes in a disk image:"
17561 msgstr ""
17562
17563 #. type: verbatim
17564 #: ../fish/guestfish.pod:80
17565 #, no-wrap
17566 msgid ""
17567 " guestfish -a disk.img --ro <<_EOF_\n"
17568 " run\n"
17569 " lvs\n"
17570 " _EOF_\n"
17571 "\n"
17572 msgstr ""
17573
17574 #. type: textblock
17575 #: ../fish/guestfish.pod:85
17576 msgid "List all the filesystems in a disk image:"
17577 msgstr ""
17578
17579 #. type: verbatim
17580 #: ../fish/guestfish.pod:87
17581 #, no-wrap
17582 msgid ""
17583 " guestfish -a disk.img --ro <<_EOF_\n"
17584 " run\n"
17585 " list-filesystems\n"
17586 " _EOF_\n"
17587 "\n"
17588 msgstr ""
17589
17590 #. type: =head2
17591 #: ../fish/guestfish.pod:92
17592 msgid "On one command line"
17593 msgstr ""
17594
17595 #. type: textblock
17596 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
17597 msgid "Update C</etc/resolv.conf> in a guest:"
17598 msgstr ""
17599
17600 #. type: verbatim
17601 #: ../fish/guestfish.pod:96
17602 #, no-wrap
17603 msgid ""
17604 " guestfish \\\n"
17605 "   add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17606 "   write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17607 "\n"
17608 msgstr ""
17609
17610 #. type: textblock
17611 #: ../fish/guestfish.pod:100
17612 msgid "Edit C</boot/grub/grub.conf> interactively:"
17613 msgstr ""
17614
17615 #. type: verbatim
17616 #: ../fish/guestfish.pod:102
17617 #, no-wrap
17618 msgid ""
17619 " guestfish --rw --add disk.img \\\n"
17620 "   --mount /dev/vg_guest/lv_root \\\n"
17621 "   --mount /dev/sda1:/boot \\\n"
17622 "   edit /boot/grub/grub.conf\n"
17623 "\n"
17624 msgstr ""
17625
17626 #. type: =head2
17627 #: ../fish/guestfish.pod:107
17628 msgid "Mount disks automatically"
17629 msgstr ""
17630
17631 #. type: textblock
17632 #: ../fish/guestfish.pod:109
17633 msgid ""
17634 "Use the I<-i> option to automatically mount the disks from a virtual "
17635 "machine:"
17636 msgstr ""
17637
17638 #. type: verbatim
17639 #: ../fish/guestfish.pod:112
17640 #, no-wrap
17641 msgid ""
17642 " guestfish --ro -a disk.img -i cat /etc/group\n"
17643 "\n"
17644 msgstr ""
17645
17646 #. type: verbatim
17647 #: ../fish/guestfish.pod:114
17648 #, no-wrap
17649 msgid ""
17650 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17651 "\n"
17652 msgstr ""
17653
17654 #. type: textblock
17655 #: ../fish/guestfish.pod:116
17656 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17657 msgstr ""
17658
17659 #. type: verbatim
17660 #: ../fish/guestfish.pod:118
17661 #, no-wrap
17662 msgid ""
17663 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17664 "\n"
17665 msgstr ""
17666
17667 #. type: =head2
17668 #: ../fish/guestfish.pod:120
17669 msgid "As a script interpreter"
17670 msgstr ""
17671
17672 #. type: textblock
17673 #: ../fish/guestfish.pod:122
17674 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17675 msgstr ""
17676
17677 #. type: verbatim
17678 #: ../fish/guestfish.pod:124
17679 #, no-wrap
17680 msgid ""
17681 " #!/usr/bin/guestfish -f\n"
17682 " sparse test1.img 100M\n"
17683 " run\n"
17684 " part-disk /dev/sda mbr\n"
17685 " mkfs ext2 /dev/sda1\n"
17686 "\n"
17687 msgstr ""
17688
17689 #. type: =head2
17690 #: ../fish/guestfish.pod:130
17691 msgid "Start with a prepared disk"
17692 msgstr ""
17693
17694 #. type: textblock
17695 #: ../fish/guestfish.pod:132
17696 msgid ""
17697 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17698 "single ext2-formatted partition:"
17699 msgstr ""
17700
17701 #. type: verbatim
17702 #: ../fish/guestfish.pod:135 ../src/guestfs.pod:2243
17703 #, no-wrap
17704 msgid ""
17705 " guestfish -N fs\n"
17706 "\n"
17707 msgstr ""
17708
17709 #. type: textblock
17710 #: ../fish/guestfish.pod:137
17711 msgid "To list what is available do:"
17712 msgstr ""
17713
17714 #. type: verbatim
17715 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1042
17716 #, no-wrap
17717 msgid ""
17718 " guestfish -N help | less\n"
17719 "\n"
17720 msgstr ""
17721
17722 #. type: =head2
17723 #: ../fish/guestfish.pod:141
17724 msgid "Remote control"
17725 msgstr ""
17726
17727 #. type: verbatim
17728 #: ../fish/guestfish.pod:143
17729 #, no-wrap
17730 msgid ""
17731 " eval \"`guestfish --listen`\"\n"
17732 " guestfish --remote add-ro disk.img\n"
17733 " guestfish --remote run\n"
17734 " guestfish --remote lvs\n"
17735 "\n"
17736 msgstr ""
17737
17738 #. type: textblock
17739 #: ../fish/guestfish.pod:154
17740 msgid "Displays general help on options."
17741 msgstr ""
17742
17743 #. type: =item
17744 #: ../fish/guestfish.pod:158
17745 msgid "B<--cmd-help>"
17746 msgstr ""
17747
17748 #. type: textblock
17749 #: ../fish/guestfish.pod:160
17750 msgid "Lists all available guestfish commands."
17751 msgstr ""
17752
17753 #. type: =item
17754 #: ../fish/guestfish.pod:162
17755 msgid "B<-h cmd>"
17756 msgstr ""
17757
17758 #. type: =item
17759 #: ../fish/guestfish.pod:164
17760 msgid "B<--cmd-help cmd>"
17761 msgstr ""
17762
17763 #. type: textblock
17764 #: ../fish/guestfish.pod:166
17765 msgid "Displays detailed help on a single command C<cmd>."
17766 msgstr ""
17767
17768 #. type: =item
17769 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:96
17770 msgid "B<-a image>"
17771 msgstr ""
17772
17773 #. type: =item
17774 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:98
17775 msgid "B<--add image>"
17776 msgstr ""
17777
17778 #. type: textblock
17779 #: ../fish/guestfish.pod:172
17780 msgid "Add a block device or virtual machine image to the shell."
17781 msgstr ""
17782
17783 #. type: textblock
17784 #: ../fish/guestfish.pod:177
17785 msgid ""
17786 "Using this flag is mostly equivalent to using the C<add> command, with "
17787 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
17788 "the I<--format=...> flag was given."
17789 msgstr ""
17790
17791 #. type: textblock
17792 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:109
17793 msgid ""
17794 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17795 "URI to use.  The default is to use the default libvirt connection."
17796 msgstr ""
17797
17798 #. type: =item
17799 #: ../fish/guestfish.pod:189
17800 msgid "B<--csh>"
17801 msgstr ""
17802
17803 #. type: textblock
17804 #: ../fish/guestfish.pod:191
17805 msgid ""
17806 "If using the I<--listen> option and a csh-like shell, use this option.  See "
17807 "section L</REMOTE CONTROL AND CSH> below."
17808 msgstr ""
17809
17810 #. type: =item
17811 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:113
17812 msgid "B<-d libvirt-domain>"
17813 msgstr ""
17814
17815 #. type: =item
17816 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:115
17817 msgid "B<--domain libvirt-domain>"
17818 msgstr ""
17819
17820 #. type: textblock
17821 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:117
17822 msgid ""
17823 "Add disks from the named libvirt domain.  If the I<--ro> option is also "
17824 "used, then any libvirt domain can be used.  However in write mode, only "
17825 "libvirt domains which are shut down can be named here."
17826 msgstr ""
17827
17828 #. type: textblock
17829 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:121
17830 msgid "Domain UUIDs can be used instead of names."
17831 msgstr ""
17832
17833 #. type: textblock
17834 #: ../fish/guestfish.pod:204
17835 msgid ""
17836 "Using this flag is mostly equivalent to using the C<add-domain> command, "
17837 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
17838 "if the I<--format:...> flag was given."
17839 msgstr ""
17840
17841 #. type: =item
17842 #: ../fish/guestfish.pod:208
17843 msgid "B<-D>"
17844 msgstr ""
17845
17846 #. type: =item
17847 #: ../fish/guestfish.pod:210
17848 msgid "B<--no-dest-paths>"
17849 msgstr ""
17850
17851 #. type: textblock
17852 #: ../fish/guestfish.pod:212
17853 msgid ""
17854 "Don't tab-complete paths on the guest filesystem.  It is useful to be able "
17855 "to hit the tab key to complete paths on the guest filesystem, but this "
17856 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17857 "allow this feature to be disabled."
17858 msgstr ""
17859
17860 #. type: textblock
17861 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:137
17862 msgid ""
17863 "When prompting for keys and passphrases, guestfish normally turns echoing "
17864 "off so you cannot see what you are typing.  If you are not worried about "
17865 "Tempest attacks and there is no one else in the room you can specify this "
17866 "flag to see what you are typing."
17867 msgstr ""
17868
17869 #. type: =item
17870 #: ../fish/guestfish.pod:224
17871 msgid "B<-f file>"
17872 msgstr ""
17873
17874 #. type: =item
17875 #: ../fish/guestfish.pod:226
17876 msgid "B<--file file>"
17877 msgstr ""
17878
17879 #. type: textblock
17880 #: ../fish/guestfish.pod:228
17881 msgid "Read commands from C<file>.  To write pure guestfish scripts, use:"
17882 msgstr ""
17883
17884 #. type: verbatim
17885 #: ../fish/guestfish.pod:231
17886 #, no-wrap
17887 msgid ""
17888 " #!/usr/bin/guestfish -f\n"
17889 "\n"
17890 msgstr ""
17891
17892 #. type: verbatim
17893 #: ../fish/guestfish.pod:244
17894 #, no-wrap
17895 msgid ""
17896 " guestfish --format=raw -a disk.img\n"
17897 "\n"
17898 msgstr ""
17899
17900 #. type: verbatim
17901 #: ../fish/guestfish.pod:248
17902 #, no-wrap
17903 msgid ""
17904 " guestfish --format=raw -a disk.img --format -a another.img\n"
17905 "\n"
17906 msgstr ""
17907
17908 #. type: textblock
17909 #: ../fish/guestfish.pod:253
17910 msgid ""
17911 "If you have untrusted raw-format guest disk images, you should use this "
17912 "option to specify the disk format.  This avoids a possible security problem "
17913 "with malicious guests (CVE-2010-3851).  See also L</add-drive-opts>."
17914 msgstr ""
17915
17916 #. type: =item
17917 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:166
17918 msgid "B<--inspector>"
17919 msgstr ""
17920
17921 #. type: textblock
17922 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:168
17923 msgid ""
17924 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
17925 "system and mount filesystems as they would be mounted on the real virtual "
17926 "machine."
17927 msgstr ""
17928
17929 #. type: textblock
17930 #: ../fish/guestfish.pod:266
17931 msgid "Typical usage is either:"
17932 msgstr ""
17933
17934 #. type: verbatim
17935 #: ../fish/guestfish.pod:268
17936 #, no-wrap
17937 msgid ""
17938 " guestfish -d myguest -i\n"
17939 "\n"
17940 msgstr ""
17941
17942 #. type: textblock
17943 #: ../fish/guestfish.pod:270
17944 msgid "(for an inactive libvirt domain called I<myguest>), or:"
17945 msgstr ""
17946
17947 #. type: verbatim
17948 #: ../fish/guestfish.pod:272
17949 #, no-wrap
17950 msgid ""
17951 " guestfish --ro -d myguest -i\n"
17952 "\n"
17953 msgstr ""
17954
17955 #. type: textblock
17956 #: ../fish/guestfish.pod:274
17957 msgid "(for active domains, readonly), or specify the block device directly:"
17958 msgstr ""
17959
17960 #. type: verbatim
17961 #: ../fish/guestfish.pod:276
17962 #, no-wrap
17963 msgid ""
17964 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
17965 "\n"
17966 msgstr ""
17967
17968 #. type: textblock
17969 #: ../fish/guestfish.pod:278
17970 msgid ""
17971 "Note that the command line syntax changed slightly over older versions of "
17972 "guestfish.  You can still use the old syntax:"
17973 msgstr ""
17974
17975 #. type: verbatim
17976 #: ../fish/guestfish.pod:281
17977 #, no-wrap
17978 msgid ""
17979 " guestfish [--ro] -i disk.img\n"
17980 "\n"
17981 msgstr ""
17982
17983 #. type: verbatim
17984 #: ../fish/guestfish.pod:283
17985 #, no-wrap
17986 msgid ""
17987 " guestfish [--ro] -i libvirt-domain\n"
17988 "\n"
17989 msgstr ""
17990
17991 #. type: textblock
17992 #: ../fish/guestfish.pod:285
17993 msgid ""
17994 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
17995 "then using other commands to mount the filesystems that were found."
17996 msgstr ""
17997
17998 #. type: =item
17999 #: ../fish/guestfish.pod:294
18000 msgid "B<--listen>"
18001 msgstr ""
18002
18003 #. type: textblock
18004 #: ../fish/guestfish.pod:296
18005 msgid ""
18006 "Fork into the background and listen for remote commands.  See section "
18007 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
18008 msgstr ""
18009
18010 #. type: =item
18011 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:177
18012 msgid "B<--live>"
18013 msgstr ""
18014
18015 #. type: textblock
18016 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:179
18017 msgid ""
18018 "Connect to a live virtual machine.  (Experimental, see "
18019 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
18020 msgstr ""
18021
18022 #. type: =item
18023 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:182
18024 msgid "B<-m dev[:mountpoint[:options]]>"
18025 msgstr ""
18026
18027 #. type: =item
18028 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:184
18029 msgid "B<--mount dev[:mountpoint[:options]]>"
18030 msgstr ""
18031
18032 #. type: textblock
18033 #: ../fish/guestfish.pod:308
18034 msgid "Mount the named partition or logical volume on the given mountpoint."
18035 msgstr ""
18036
18037 #. type: textblock
18038 #: ../fish/guestfish.pod:310
18039 msgid "If the mountpoint is omitted, it defaults to C</>."
18040 msgstr ""
18041
18042 #. type: textblock
18043 #: ../fish/guestfish.pod:312
18044 msgid "You have to mount something on C</> before most commands will work."
18045 msgstr ""
18046
18047 #. type: textblock
18048 #: ../fish/guestfish.pod:314
18049 msgid ""
18050 "If any I<-m> or I<--mount> options are given, the guest is automatically "
18051 "launched."
18052 msgstr ""
18053
18054 #. type: textblock
18055 #: ../fish/guestfish.pod:317
18056 msgid ""
18057 "If you don't know what filesystems a disk image contains, you can either run "
18058 "guestfish without this option, then list the partitions, filesystems and LVs "
18059 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
18060 "commands), or you can use the L<virt-filesystems(1)> program."
18061 msgstr ""
18062
18063 #. type: textblock
18064 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:192
18065 msgid ""
18066 "The third (and rarely used) part of the mount parameter is the list of mount "
18067 "options used to mount the underlying filesystem.  If this is not given, then "
18068 "the mount options are either the empty string or C<ro> (the latter if the "
18069 "I<--ro> flag is used).  By specifying the mount options, you override this "
18070 "default choice.  Probably the only time you would use this is to enable ACLs "
18071 "and/or extended attributes if the filesystem can support them:"
18072 msgstr ""
18073
18074 #. type: verbatim
18075 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:200
18076 #, no-wrap
18077 msgid ""
18078 " -m /dev/sda1:/:acl,user_xattr\n"
18079 "\n"
18080 msgstr ""
18081
18082 #. type: textblock
18083 #: ../fish/guestfish.pod:333
18084 msgid "Using this flag is equivalent to using the C<mount-options> command."
18085 msgstr ""
18086
18087 #. type: =item
18088 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:202 ../resize/virt-resize.pod:435
18089 msgid "B<-n>"
18090 msgstr ""
18091
18092 #. type: =item
18093 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:204
18094 msgid "B<--no-sync>"
18095 msgstr ""
18096
18097 #. type: textblock
18098 #: ../fish/guestfish.pod:339
18099 msgid ""
18100 "Disable autosync.  This is enabled by default.  See the discussion of "
18101 "autosync in the L<guestfs(3)> manpage."
18102 msgstr ""
18103
18104 #. type: =item
18105 #: ../fish/guestfish.pod:342
18106 msgid "B<-N type>"
18107 msgstr ""
18108
18109 #. type: =item
18110 #: ../fish/guestfish.pod:344
18111 msgid "B<--new type>"
18112 msgstr ""
18113
18114 #. type: =item
18115 #: ../fish/guestfish.pod:346
18116 msgid "B<-N help>"
18117 msgstr ""
18118
18119 #. type: textblock
18120 #: ../fish/guestfish.pod:348
18121 msgid ""
18122 "Prepare a fresh disk image formatted as \"type\".  This is an alternative to "
18123 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
18124 "preformatted disk with a filesystem and adds it.  See L</PREPARED DISK "
18125 "IMAGES> below."
18126 msgstr ""
18127
18128 #. type: =item
18129 #: ../fish/guestfish.pod:353
18130 msgid "B<--progress-bars>"
18131 msgstr ""
18132
18133 #. type: textblock
18134 #: ../fish/guestfish.pod:355
18135 msgid "Enable progress bars, even when guestfish is used non-interactively."
18136 msgstr ""
18137
18138 #. type: textblock
18139 #: ../fish/guestfish.pod:357
18140 msgid ""
18141 "Progress bars are enabled by default when guestfish is used as an "
18142 "interactive shell."
18143 msgstr ""
18144
18145 #. type: =item
18146 #: ../fish/guestfish.pod:360
18147 msgid "B<--no-progress-bars>"
18148 msgstr ""
18149
18150 #. type: textblock
18151 #: ../fish/guestfish.pod:362
18152 msgid "Disable progress bars."
18153 msgstr ""
18154
18155 #. type: =item
18156 #: ../fish/guestfish.pod:364
18157 msgid "B<--remote[=pid]>"
18158 msgstr ""
18159
18160 #. type: textblock
18161 #: ../fish/guestfish.pod:366
18162 msgid ""
18163 "Send remote commands to C<$GUESTFISH_PID> or C<pid>.  See section L</REMOTE "
18164 "CONTROL GUESTFISH OVER A SOCKET> below."
18165 msgstr ""
18166
18167 #. type: =item
18168 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:248 ../rescue/virt-rescue.pod:189
18169 msgid "B<-r>"
18170 msgstr ""
18171
18172 #. type: =item
18173 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:250 ../rescue/virt-rescue.pod:191
18174 msgid "B<--ro>"
18175 msgstr ""
18176
18177 #. type: textblock
18178 #: ../fish/guestfish.pod:373
18179 msgid ""
18180 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18181 "mounts are done read-only."
18182 msgstr ""
18183
18184 #. type: textblock
18185 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:195
18186 msgid ""
18187 "The option must always be used if the disk image or virtual machine might be "
18188 "running, and is generally recommended in cases where you don't need write "
18189 "access to the disk."
18190 msgstr ""
18191
18192 #. type: textblock
18193 #: ../fish/guestfish.pod:380
18194 msgid ""
18195 "Note that prepared disk images created with I<-N> are not affected by this "
18196 "option.  Also commands like C<add> are not affected - you have to specify "
18197 "the C<readonly:true> option explicitly if you need it."
18198 msgstr ""
18199
18200 #. type: textblock
18201 #: ../fish/guestfish.pod:384
18202 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
18203 msgstr ""
18204
18205 #. type: =item
18206 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:262 ../rescue/virt-rescue.pod:201
18207 msgid "B<--selinux>"
18208 msgstr ""
18209
18210 #. type: textblock
18211 #: ../fish/guestfish.pod:388
18212 msgid "Enable SELinux support for the guest.  See L<guestfs(3)/SELINUX>."
18213 msgstr ""
18214
18215 #. type: textblock
18216 #: ../fish/guestfish.pod:394
18217 msgid ""
18218 "Enable very verbose messages.  This is particularly useful if you find a "
18219 "bug."
18220 msgstr ""
18221
18222 #. type: textblock
18223 #: ../fish/guestfish.pod:401
18224 msgid "Display the guestfish / libguestfs version number and exit."
18225 msgstr ""
18226
18227 #. type: =item
18228 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:278 ../rescue/virt-rescue.pod:231
18229 msgid "B<-w>"
18230 msgstr ""
18231
18232 #. type: =item
18233 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:280 ../rescue/virt-rescue.pod:233
18234 msgid "B<--rw>"
18235 msgstr ""
18236
18237 #. type: textblock
18238 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:282
18239 msgid ""
18240 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18241 "mounts are done read-write."
18242 msgstr ""
18243
18244 #. type: textblock
18245 #: ../fish/guestfish.pod:410
18246 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
18247 msgstr ""
18248
18249 #. type: textblock
18250 #: ../fish/guestfish.pod:414
18251 msgid "Echo each command before executing it."
18252 msgstr ""
18253
18254 #. type: =head1
18255 #: ../fish/guestfish.pod:418
18256 msgid "COMMANDS ON COMMAND LINE"
18257 msgstr ""
18258
18259 #. type: textblock
18260 #: ../fish/guestfish.pod:420
18261 msgid "Any additional (non-option) arguments are treated as commands to execute."
18262 msgstr ""
18263
18264 #. type: textblock
18265 #: ../fish/guestfish.pod:423
18266 msgid ""
18267 "Commands to execute should be separated by a colon (C<:>), where the colon "
18268 "is a separate parameter.  Thus:"
18269 msgstr ""
18270
18271 #. type: verbatim
18272 #: ../fish/guestfish.pod:426
18273 #, no-wrap
18274 msgid ""
18275 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
18276 "\n"
18277 msgstr ""
18278
18279 #. type: textblock
18280 #: ../fish/guestfish.pod:428
18281 msgid ""
18282 "If there are no additional arguments, then we enter a shell, either an "
18283 "interactive shell with a prompt (if the input is a terminal) or a "
18284 "non-interactive shell."
18285 msgstr ""
18286
18287 #. type: textblock
18288 #: ../fish/guestfish.pod:432
18289 msgid ""
18290 "In either command line mode or non-interactive shell, the first command that "
18291 "gives an error causes the whole shell to exit.  In interactive mode (with a "
18292 "prompt) if a command fails, you can continue to enter commands."
18293 msgstr ""
18294
18295 #. type: =head1
18296 #: ../fish/guestfish.pod:437
18297 msgid "USING launch (OR run)"
18298 msgstr ""
18299
18300 #. type: textblock
18301 #: ../fish/guestfish.pod:439
18302 msgid ""
18303 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
18304 "then launch it, then mount any disks you need, and finally issue "
18305 "actions/commands.  So the general order of the day is:"
18306 msgstr ""
18307
18308 #. type: textblock
18309 #: ../fish/guestfish.pod:447
18310 msgid "add or -a/--add"
18311 msgstr ""
18312
18313 #. type: textblock
18314 #: ../fish/guestfish.pod:451
18315 msgid "launch (aka run)"
18316 msgstr ""
18317
18318 #. type: textblock
18319 #: ../fish/guestfish.pod:455
18320 msgid "mount or -m/--mount"
18321 msgstr ""
18322
18323 #. type: textblock
18324 #: ../fish/guestfish.pod:459
18325 msgid "any other commands"
18326 msgstr ""
18327
18328 #. type: textblock
18329 #: ../fish/guestfish.pod:463
18330 msgid ""
18331 "C<run> is a synonym for C<launch>.  You must C<launch> (or C<run>)  your "
18332 "guest before mounting or performing any other commands."
18333 msgstr ""
18334
18335 #. type: textblock
18336 #: ../fish/guestfish.pod:466
18337 msgid ""
18338 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
18339 "I<--new> options were given then C<run> is done automatically, simply "
18340 "because guestfish can't perform the action you asked for without doing this."
18341 msgstr ""
18342
18343 #. type: =head1
18344 #: ../fish/guestfish.pod:471
18345 msgid "OPENING DISKS FOR READ AND WRITE"
18346 msgstr ""
18347
18348 #. type: textblock
18349 #: ../fish/guestfish.pod:473
18350 msgid ""
18351 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
18352 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
18353 "I<-i> and I<-m> open disk images read-only or for writing."
18354 msgstr ""
18355
18356 #. type: textblock
18357 #: ../fish/guestfish.pod:478
18358 msgid ""
18359 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
18360 "opening disk images supplied on the command line for write.  To open a disk "
18361 "image read-only you have to do I<-a image --ro>."
18362 msgstr ""
18363
18364 #. type: textblock
18365 #: ../fish/guestfish.pod:482
18366 msgid ""
18367 "This matters: If you accidentally open a live VM disk image writable then "
18368 "you will cause irreversible disk corruption."
18369 msgstr ""
18370
18371 #. type: textblock
18372 #: ../fish/guestfish.pod:485
18373 msgid ""
18374 "In a future libguestfs we intend to change the default the other way.  Disk "
18375 "images will be opened read-only.  You will have to either specify "
18376 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
18377 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
18378 "access for disk images specified by those other command line options."
18379 msgstr ""
18380
18381 #. type: textblock
18382 #: ../fish/guestfish.pod:492
18383 msgid ""
18384 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
18385 "which does nothing (it is already the default).  However it is highly "
18386 "recommended that you use this option to indicate that you need write access, "
18387 "and prepare your scripts for the day when this option will be required for "
18388 "write access."
18389 msgstr ""
18390
18391 #. type: textblock
18392 #: ../fish/guestfish.pod:498
18393 msgid ""
18394 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
18395 "other libguestfs program apart from guestfish and guestmount."
18396 msgstr ""
18397
18398 #. type: =head1
18399 #: ../fish/guestfish.pod:501
18400 msgid "QUOTING"
18401 msgstr ""
18402
18403 #. type: textblock
18404 #: ../fish/guestfish.pod:503
18405 msgid ""
18406 "You can quote ordinary parameters using either single or double quotes.  For "
18407 "example:"
18408 msgstr ""
18409
18410 #. type: verbatim
18411 #: ../fish/guestfish.pod:506
18412 #, no-wrap
18413 msgid ""
18414 " add \"file with a space.img\"\n"
18415 "\n"
18416 msgstr ""
18417
18418 #. type: verbatim
18419 #: ../fish/guestfish.pod:508
18420 #, no-wrap
18421 msgid ""
18422 " rm '/file name'\n"
18423 "\n"
18424 msgstr ""
18425
18426 #. type: verbatim
18427 #: ../fish/guestfish.pod:510
18428 #, no-wrap
18429 msgid ""
18430 " rm '/\"'\n"
18431 "\n"
18432 msgstr ""
18433
18434 #. type: textblock
18435 #: ../fish/guestfish.pod:512
18436 msgid ""
18437 "A few commands require a list of strings to be passed.  For these, use a "
18438 "whitespace-separated list, enclosed in quotes.  Strings containing "
18439 "whitespace to be passed through must be enclosed in single quotes.  A "
18440 "literal single quote must be escaped with a backslash."
18441 msgstr ""
18442
18443 #. type: verbatim
18444 #: ../fish/guestfish.pod:517
18445 #, no-wrap
18446 msgid ""
18447 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
18448 " command \"/bin/echo 'foo      bar'\"\n"
18449 " command \"/bin/echo \\'foo\\'\"\n"
18450 "\n"
18451 msgstr ""
18452
18453 #. type: =head2
18454 #: ../fish/guestfish.pod:521
18455 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
18456 msgstr ""
18457
18458 #. type: textblock
18459 #: ../fish/guestfish.pod:523
18460 msgid ""
18461 "In double-quoted arguments (only) use backslash to insert special "
18462 "characters:"
18463 msgstr ""
18464
18465 #. type: =item
18466 #: ../fish/guestfish.pod:528
18467 msgid "C<\\a>"
18468 msgstr ""
18469
18470 #. type: textblock
18471 #: ../fish/guestfish.pod:530
18472 msgid "Alert (bell) character."
18473 msgstr ""
18474
18475 #. type: =item
18476 #: ../fish/guestfish.pod:532
18477 msgid "C<\\b>"
18478 msgstr ""
18479
18480 #. type: textblock
18481 #: ../fish/guestfish.pod:534
18482 msgid "Backspace character."
18483 msgstr ""
18484
18485 #. type: =item
18486 #: ../fish/guestfish.pod:536
18487 msgid "C<\\f>"
18488 msgstr ""
18489
18490 #. type: textblock
18491 #: ../fish/guestfish.pod:538
18492 msgid "Form feed character."
18493 msgstr ""
18494
18495 #. type: =item
18496 #: ../fish/guestfish.pod:540
18497 msgid "C<\\n>"
18498 msgstr ""
18499
18500 #. type: textblock
18501 #: ../fish/guestfish.pod:542
18502 msgid "Newline character."
18503 msgstr ""
18504
18505 #. type: =item
18506 #: ../fish/guestfish.pod:544
18507 msgid "C<\\r>"
18508 msgstr ""
18509
18510 #. type: textblock
18511 #: ../fish/guestfish.pod:546
18512 msgid "Carriage return character."
18513 msgstr ""
18514
18515 #. type: =item
18516 #: ../fish/guestfish.pod:548
18517 msgid "C<\\t>"
18518 msgstr ""
18519
18520 #. type: textblock
18521 #: ../fish/guestfish.pod:550
18522 msgid "Horizontal tab character."
18523 msgstr ""
18524
18525 #. type: =item
18526 #: ../fish/guestfish.pod:552
18527 msgid "C<\\v>"
18528 msgstr ""
18529
18530 #. type: textblock
18531 #: ../fish/guestfish.pod:554
18532 msgid "Vertical tab character."
18533 msgstr ""
18534
18535 #. type: =item
18536 #: ../fish/guestfish.pod:556
18537 msgid "C<\\\">"
18538 msgstr ""
18539
18540 #. type: textblock
18541 #: ../fish/guestfish.pod:558
18542 msgid "A literal double quote character."
18543 msgstr ""
18544
18545 #. type: =item
18546 #: ../fish/guestfish.pod:560
18547 msgid "C<\\ooo>"
18548 msgstr ""
18549
18550 #. type: textblock
18551 #: ../fish/guestfish.pod:562
18552 msgid ""
18553 "A character with octal value I<ooo>.  There must be precisely 3 octal digits "
18554 "(unlike C)."
18555 msgstr ""
18556
18557 #. type: =item
18558 #: ../fish/guestfish.pod:565
18559 msgid "C<\\xhh>"
18560 msgstr ""
18561
18562 #. type: textblock
18563 #: ../fish/guestfish.pod:567
18564 msgid "A character with hex value I<hh>.  There must be precisely 2 hex digits."
18565 msgstr ""
18566
18567 #. type: textblock
18568 #: ../fish/guestfish.pod:570
18569 msgid ""
18570 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
18571 "strings."
18572 msgstr ""
18573
18574 #. type: =item
18575 #: ../fish/guestfish.pod:573
18576 msgid "C<\\\\>"
18577 msgstr ""
18578
18579 #. type: textblock
18580 #: ../fish/guestfish.pod:575
18581 msgid "A literal backslash character."
18582 msgstr ""
18583
18584 #. type: =head1
18585 #: ../fish/guestfish.pod:579
18586 msgid "OPTIONAL ARGUMENTS"
18587 msgstr ""
18588
18589 #. type: textblock
18590 #: ../fish/guestfish.pod:581
18591 msgid ""
18592 "Some commands take optional arguments.  These arguments appear in this "
18593 "documentation as C<[argname:..]>.  You can use them as in these examples:"
18594 msgstr ""
18595
18596 #. type: verbatim
18597 #: ../fish/guestfish.pod:585
18598 #, no-wrap
18599 msgid ""
18600 " add-drive-opts filename\n"
18601 "\n"
18602 msgstr ""
18603
18604 #. type: verbatim
18605 #: ../fish/guestfish.pod:587
18606 #, no-wrap
18607 msgid ""
18608 " add-drive-opts filename readonly:true\n"
18609 "\n"
18610 msgstr ""
18611
18612 #. type: verbatim
18613 #: ../fish/guestfish.pod:589
18614 #, no-wrap
18615 msgid ""
18616 " add-drive-opts filename format:qcow2 readonly:false\n"
18617 "\n"
18618 msgstr ""
18619
18620 #. type: textblock
18621 #: ../fish/guestfish.pod:591
18622 msgid ""
18623 "Each optional argument can appear at most once.  All optional arguments must "
18624 "appear after the required ones."
18625 msgstr ""
18626
18627 #. type: =head1
18628 #: ../fish/guestfish.pod:594
18629 msgid "NUMBERS"
18630 msgstr ""
18631
18632 #. type: textblock
18633 #: ../fish/guestfish.pod:596
18634 msgid "This section applies to all commands which can take integers as parameters."
18635 msgstr ""
18636
18637 #. type: =head2
18638 #: ../fish/guestfish.pod:599
18639 msgid "SIZE SUFFIX"
18640 msgstr ""
18641
18642 #. type: textblock
18643 #: ../fish/guestfish.pod:601
18644 msgid ""
18645 "When the command takes a parameter measured in bytes, you can use one of the "
18646 "following suffixes to specify kilobytes, megabytes and larger sizes:"
18647 msgstr ""
18648
18649 #. type: =item
18650 #: ../fish/guestfish.pod:607
18651 msgid "B<k> or B<K> or B<KiB>"
18652 msgstr ""
18653
18654 #. type: textblock
18655 #: ../fish/guestfish.pod:609
18656 msgid "The size in kilobytes (multiplied by 1024)."
18657 msgstr ""
18658
18659 #. type: =item
18660 #: ../fish/guestfish.pod:611
18661 msgid "B<KB>"
18662 msgstr ""
18663
18664 #. type: textblock
18665 #: ../fish/guestfish.pod:613
18666 msgid "The size in SI 1000 byte units."
18667 msgstr ""
18668
18669 #. type: =item
18670 #: ../fish/guestfish.pod:615
18671 msgid "B<M> or B<MiB>"
18672 msgstr ""
18673
18674 #. type: textblock
18675 #: ../fish/guestfish.pod:617
18676 msgid "The size in megabytes (multiplied by 1048576)."
18677 msgstr ""
18678
18679 #. type: =item
18680 #: ../fish/guestfish.pod:619
18681 msgid "B<MB>"
18682 msgstr ""
18683
18684 #. type: textblock
18685 #: ../fish/guestfish.pod:621
18686 msgid "The size in SI 1000000 byte units."
18687 msgstr ""
18688
18689 #. type: =item
18690 #: ../fish/guestfish.pod:623
18691 msgid "B<G> or B<GiB>"
18692 msgstr ""
18693
18694 #. type: textblock
18695 #: ../fish/guestfish.pod:625
18696 msgid "The size in gigabytes (multiplied by 2**30)."
18697 msgstr ""
18698
18699 #. type: =item
18700 #: ../fish/guestfish.pod:627
18701 msgid "B<GB>"
18702 msgstr ""
18703
18704 #. type: textblock
18705 #: ../fish/guestfish.pod:629
18706 msgid "The size in SI 10**9 byte units."
18707 msgstr ""
18708
18709 #. type: =item
18710 #: ../fish/guestfish.pod:631
18711 msgid "B<T> or B<TiB>"
18712 msgstr ""
18713
18714 #. type: textblock
18715 #: ../fish/guestfish.pod:633
18716 msgid "The size in terabytes (multiplied by 2**40)."
18717 msgstr ""
18718
18719 #. type: =item
18720 #: ../fish/guestfish.pod:635
18721 msgid "B<TB>"
18722 msgstr ""
18723
18724 #. type: textblock
18725 #: ../fish/guestfish.pod:637
18726 msgid "The size in SI 10**12 byte units."
18727 msgstr ""
18728
18729 #. type: =item
18730 #: ../fish/guestfish.pod:639
18731 msgid "B<P> or B<PiB>"
18732 msgstr ""
18733
18734 #. type: textblock
18735 #: ../fish/guestfish.pod:641
18736 msgid "The size in petabytes (multiplied by 2**50)."
18737 msgstr ""
18738
18739 #. type: =item
18740 #: ../fish/guestfish.pod:643
18741 msgid "B<PB>"
18742 msgstr ""
18743
18744 #. type: textblock
18745 #: ../fish/guestfish.pod:645
18746 msgid "The size in SI 10**15 byte units."
18747 msgstr ""
18748
18749 #. type: =item
18750 #: ../fish/guestfish.pod:647
18751 msgid "B<E> or B<EiB>"
18752 msgstr ""
18753
18754 #. type: textblock
18755 #: ../fish/guestfish.pod:649
18756 msgid "The size in exabytes (multiplied by 2**60)."
18757 msgstr ""
18758
18759 #. type: =item
18760 #: ../fish/guestfish.pod:651
18761 msgid "B<EB>"
18762 msgstr ""
18763
18764 #. type: textblock
18765 #: ../fish/guestfish.pod:653
18766 msgid "The size in SI 10**18 byte units."
18767 msgstr ""
18768
18769 #. type: =item
18770 #: ../fish/guestfish.pod:655
18771 msgid "B<Z> or B<ZiB>"
18772 msgstr ""
18773
18774 #. type: textblock
18775 #: ../fish/guestfish.pod:657
18776 msgid "The size in zettabytes (multiplied by 2**70)."
18777 msgstr ""
18778
18779 #. type: =item
18780 #: ../fish/guestfish.pod:659
18781 msgid "B<ZB>"
18782 msgstr ""
18783
18784 #. type: textblock
18785 #: ../fish/guestfish.pod:661
18786 msgid "The size in SI 10**21 byte units."
18787 msgstr ""
18788
18789 #. type: =item
18790 #: ../fish/guestfish.pod:663
18791 msgid "B<Y> or B<YiB>"
18792 msgstr ""
18793
18794 #. type: textblock
18795 #: ../fish/guestfish.pod:665
18796 msgid "The size in yottabytes (multiplied by 2**80)."
18797 msgstr ""
18798
18799 #. type: =item
18800 #: ../fish/guestfish.pod:667
18801 msgid "B<YB>"
18802 msgstr ""
18803
18804 #. type: textblock
18805 #: ../fish/guestfish.pod:669
18806 msgid "The size in SI 10**24 byte units."
18807 msgstr ""
18808
18809 #. type: verbatim
18810 #: ../fish/guestfish.pod:675
18811 #, no-wrap
18812 msgid ""
18813 " truncate-size /file 1G\n"
18814 "\n"
18815 msgstr ""
18816
18817 #. type: textblock
18818 #: ../fish/guestfish.pod:677
18819 msgid "would truncate the file to 1 gigabyte."
18820 msgstr ""
18821
18822 #. type: textblock
18823 #: ../fish/guestfish.pod:679
18824 msgid ""
18825 "Be careful because a few commands take sizes in kilobytes or megabytes "
18826 "(eg. the parameter to L</memsize> is specified in megabytes already).  "
18827 "Adding a suffix will probably not do what you expect."
18828 msgstr ""
18829
18830 #. type: =head2
18831 #: ../fish/guestfish.pod:683
18832 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18833 msgstr ""
18834
18835 #. type: textblock
18836 #: ../fish/guestfish.pod:685
18837 msgid ""
18838 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18839 "octal number or C<0x> to prefix a hexadecimal number.  For example:"
18840 msgstr ""
18841
18842 #. type: verbatim
18843 #: ../fish/guestfish.pod:688
18844 #, no-wrap
18845 msgid ""
18846 " 1234      decimal number 1234\n"
18847 " 02322     octal number, equivalent to decimal 1234\n"
18848 " 0x4d2     hexadecimal number, equivalent to decimal 1234\n"
18849 "\n"
18850 msgstr ""
18851
18852 #. type: textblock
18853 #: ../fish/guestfish.pod:692
18854 msgid ""
18855 "When using the C<chmod> command, you almost always want to specify an octal "
18856 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18857 "L<chmod(1)> program):"
18858 msgstr ""
18859
18860 #. type: verbatim
18861 #: ../fish/guestfish.pod:696
18862 #, no-wrap
18863 msgid ""
18864 " chmod 0777 /public  # OK\n"
18865 " chmod 777 /public   # WRONG! This is mode 777 decimal = 01411 octal.\n"
18866 "\n"
18867 msgstr ""
18868
18869 #. type: textblock
18870 #: ../fish/guestfish.pod:699
18871 msgid ""
18872 "Commands that return numbers usually print them in decimal, but some "
18873 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18874 "octal, preceeded by C<0>)."
18875 msgstr ""
18876
18877 #. type: =head1
18878 #: ../fish/guestfish.pod:703
18879 msgid "WILDCARDS AND GLOBBING"
18880 msgstr ""
18881
18882 #. type: textblock
18883 #: ../fish/guestfish.pod:705
18884 msgid ""
18885 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18886 "(globbing) by default.  So for example the following will not do what you "
18887 "expect:"
18888 msgstr ""
18889
18890 #. type: verbatim
18891 #: ../fish/guestfish.pod:709
18892 #, no-wrap
18893 msgid ""
18894 " rm-rf /home/*\n"
18895 "\n"
18896 msgstr ""
18897
18898 #. type: textblock
18899 #: ../fish/guestfish.pod:711
18900 msgid ""
18901 "Assuming you don't have a directory called literally C</home/*> then the "
18902 "above command will return an error."
18903 msgstr ""
18904
18905 #. type: textblock
18906 #: ../fish/guestfish.pod:714
18907 msgid "To perform wildcard expansion, use the C<glob> command."
18908 msgstr ""
18909
18910 #. type: verbatim
18911 #: ../fish/guestfish.pod:716
18912 #, no-wrap
18913 msgid ""
18914 " glob rm-rf /home/*\n"
18915 "\n"
18916 msgstr ""
18917
18918 #. type: textblock
18919 #: ../fish/guestfish.pod:718
18920 msgid ""
18921 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18922 "many times), equivalent to:"
18923 msgstr ""
18924
18925 #. type: verbatim
18926 #: ../fish/guestfish.pod:721
18927 #, no-wrap
18928 msgid ""
18929 " rm-rf /home/jim\n"
18930 " rm-rf /home/joe\n"
18931 " rm-rf /home/mary\n"
18932 "\n"
18933 msgstr ""
18934
18935 #. type: textblock
18936 #: ../fish/guestfish.pod:725
18937 msgid "C<glob> only works on simple guest paths and not on device names."
18938 msgstr ""
18939
18940 #. type: textblock
18941 #: ../fish/guestfish.pod:727
18942 msgid ""
18943 "If you have several parameters, each containing a wildcard, then glob will "
18944 "perform a Cartesian product."
18945 msgstr ""
18946
18947 #. type: =head1
18948 #: ../fish/guestfish.pod:730
18949 msgid "COMMENTS"
18950 msgstr ""
18951
18952 #. type: textblock
18953 #: ../fish/guestfish.pod:732
18954 msgid ""
18955 "Any line which starts with a I<#> character is treated as a comment and "
18956 "ignored.  The I<#> can optionally be preceeded by whitespace, but B<not> by "
18957 "a command.  For example:"
18958 msgstr ""
18959
18960 #. type: verbatim
18961 #: ../fish/guestfish.pod:736
18962 #, no-wrap
18963 msgid ""
18964 " # this is a comment\n"
18965 "         # this is a comment\n"
18966 " foo # NOT a comment\n"
18967 "\n"
18968 msgstr ""
18969
18970 #. type: textblock
18971 #: ../fish/guestfish.pod:740
18972 msgid "Blank lines are also ignored."
18973 msgstr ""
18974
18975 #. type: =head1
18976 #: ../fish/guestfish.pod:742
18977 msgid "RUNNING COMMANDS LOCALLY"
18978 msgstr ""
18979
18980 #. type: textblock
18981 #: ../fish/guestfish.pod:744
18982 msgid ""
18983 "Any line which starts with a I<!> character is treated as a command sent to "
18984 "the local shell (C</bin/sh> or whatever L<system(3)> uses).  For example:"
18985 msgstr ""
18986
18987 #. type: verbatim
18988 #: ../fish/guestfish.pod:748
18989 #, no-wrap
18990 msgid ""
18991 " !mkdir local\n"
18992 " tgz-out /remote local/remote-data.tar.gz\n"
18993 "\n"
18994 msgstr ""
18995
18996 #. type: textblock
18997 #: ../fish/guestfish.pod:751
18998 msgid ""
18999 "will create a directory C<local> on the host, and then export the contents "
19000 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>.  "
19001 "(See C<tgz-out>)."
19002 msgstr ""
19003
19004 #. type: textblock
19005 #: ../fish/guestfish.pod:755
19006 msgid ""
19007 "To change the local directory, use the C<lcd> command.  C<!cd> will have no "
19008 "effect, due to the way that subprocesses work in Unix."
19009 msgstr ""
19010
19011 #. type: =head2
19012 #: ../fish/guestfish.pod:758
19013 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
19014 msgstr ""
19015
19016 #. type: textblock
19017 #: ../fish/guestfish.pod:760
19018 msgid ""
19019 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
19020 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
19021 "and executed as guestfish commands."
19022 msgstr ""
19023
19024 #. type: textblock
19025 #: ../fish/guestfish.pod:764
19026 msgid ""
19027 "Thus you can use shell script to construct arbitrary guestfish commands "
19028 "which are then parsed by guestfish."
19029 msgstr ""
19030
19031 #. type: textblock
19032 #: ../fish/guestfish.pod:767
19033 msgid ""
19034 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
19035 "through C</foo.100>) using guestfish commands alone.  However this is simple "
19036 "if we use a shell script to create the guestfish commands for us:"
19037 msgstr ""
19038
19039 #. type: verbatim
19040 #: ../fish/guestfish.pod:772
19041 #, no-wrap
19042 msgid ""
19043 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
19044 "\n"
19045 msgstr ""
19046
19047 #. type: textblock
19048 #: ../fish/guestfish.pod:774
19049 msgid "or with names like C</foo.001>:"
19050 msgstr ""
19051
19052 #. type: verbatim
19053 #: ../fish/guestfish.pod:776
19054 #, no-wrap
19055 msgid ""
19056 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
19057 "\n"
19058 msgstr ""
19059
19060 #. type: textblock
19061 #: ../fish/guestfish.pod:778
19062 msgid ""
19063 "When using guestfish interactively it can be helpful to just run the shell "
19064 "script first (ie. remove the initial C<E<lt>> character so it is just an "
19065 "ordinary I<!> local command), see what guestfish commands it would run, and "
19066 "when you are happy with those prepend the C<E<lt>> character to run the "
19067 "guestfish commands for real."
19068 msgstr ""
19069
19070 #. type: =head1
19071 #: ../fish/guestfish.pod:784
19072 msgid "PIPES"
19073 msgstr ""
19074
19075 #. type: textblock
19076 #: ../fish/guestfish.pod:786
19077 msgid ""
19078 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
19079 "command (a guestfish command) to the second command (any host command).  For "
19080 "example:"
19081 msgstr ""
19082
19083 #. type: verbatim
19084 #: ../fish/guestfish.pod:790
19085 #, no-wrap
19086 msgid ""
19087 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
19088 "\n"
19089 msgstr ""
19090
19091 #. type: textblock
19092 #: ../fish/guestfish.pod:792
19093 msgid ""
19094 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
19095 "program).  The above command would list all accounts in the guest filesystem "
19096 "which have UID 0, ie. root accounts including backdoors.  Other examples:"
19097 msgstr ""
19098
19099 #. type: verbatim
19100 #: ../fish/guestfish.pod:797
19101 #, no-wrap
19102 msgid ""
19103 " hexdump /bin/ls | head\n"
19104 " list-devices | tail -1\n"
19105 " tgz-out / - | tar ztf -\n"
19106 "\n"
19107 msgstr ""
19108
19109 #. type: textblock
19110 #: ../fish/guestfish.pod:801
19111 msgid ""
19112 "The space before the pipe symbol is required, any space after the pipe "
19113 "symbol is optional.  Everything after the pipe symbol is just passed "
19114 "straight to the host shell, so it can contain redirections, globs and "
19115 "anything else that makes sense on the host side."
19116 msgstr ""
19117
19118 #. type: textblock
19119 #: ../fish/guestfish.pod:806
19120 msgid ""
19121 "To use a literal argument which begins with a pipe symbol, you have to quote "
19122 "it, eg:"
19123 msgstr ""
19124
19125 #. type: verbatim
19126 #: ../fish/guestfish.pod:809
19127 #, no-wrap
19128 msgid ""
19129 " echo \"|\"\n"
19130 "\n"
19131 msgstr ""
19132
19133 #. type: =head1
19134 #: ../fish/guestfish.pod:811
19135 msgid "HOME DIRECTORIES"
19136 msgstr ""
19137
19138 #. type: textblock
19139 #: ../fish/guestfish.pod:813
19140 msgid ""
19141 "If a parameter starts with the character C<~> then the tilde may be expanded "
19142 "as a home directory path (either C<~> for the current user's home directory, "
19143 "or C<~user> for another user)."
19144 msgstr ""
19145
19146 #. type: textblock
19147 #: ../fish/guestfish.pod:817
19148 msgid ""
19149 "Note that home directory expansion happens for users known I<on the host>, "
19150 "not in the guest filesystem."
19151 msgstr ""
19152
19153 #. type: textblock
19154 #: ../fish/guestfish.pod:820
19155 msgid ""
19156 "To use a literal argument which begins with a tilde, you have to quote it, "
19157 "eg:"
19158 msgstr ""
19159
19160 #. type: verbatim
19161 #: ../fish/guestfish.pod:823
19162 #, no-wrap
19163 msgid ""
19164 " echo \"~\"\n"
19165 "\n"
19166 msgstr ""
19167
19168 #. type: =head2
19169 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:534
19170 msgid "ENCRYPTED DISKS"
19171 msgstr ""
19172
19173 #. type: textblock
19174 #: ../fish/guestfish.pod:827
19175 msgid ""
19176 "Libguestfs has some support for Linux guests encrypted according to the "
19177 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
19178 "disk encryption systems used by modern Linux guests.  Currently only "
19179 "LVM-on-LUKS is supported."
19180 msgstr ""
19181
19182 #. type: textblock
19183 #: ../fish/guestfish.pod:832
19184 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
19185 msgstr ""
19186
19187 #. type: verbatim
19188 #: ../fish/guestfish.pod:834
19189 #, no-wrap
19190 msgid ""
19191 " ><fs> vfs-type /dev/sda2\n"
19192 " crypto_LUKS\n"
19193 "\n"
19194 msgstr ""
19195
19196 #. type: textblock
19197 #: ../fish/guestfish.pod:837
19198 msgid ""
19199 "Then open those devices using L</luks-open>.  This creates a device-mapper "
19200 "device called C</dev/mapper/luksdev>."
19201 msgstr ""
19202
19203 #. type: verbatim
19204 #: ../fish/guestfish.pod:840
19205 #, no-wrap
19206 msgid ""
19207 " ><fs> luks-open /dev/sda2 luksdev\n"
19208 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
19209 "\n"
19210 msgstr ""
19211
19212 #. type: textblock
19213 #: ../fish/guestfish.pod:843
19214 msgid ""
19215 "Finally you have to tell LVM to scan for volume groups on the newly created "
19216 "mapper device:"
19217 msgstr ""
19218
19219 #. type: verbatim
19220 #: ../fish/guestfish.pod:846
19221 #, no-wrap
19222 msgid ""
19223 " vgscan\n"
19224 " vg-activate-all true\n"
19225 "\n"
19226 msgstr ""
19227
19228 #. type: textblock
19229 #: ../fish/guestfish.pod:849
19230 msgid "The logical volume(s) can now be mounted in the usual way."
19231 msgstr ""
19232
19233 #. type: textblock
19234 #: ../fish/guestfish.pod:851
19235 msgid ""
19236 "Before closing a LUKS device you must unmount any logical volumes on it and "
19237 "deactivate the volume groups by calling C<vg-activate false VG> on each "
19238 "one.  Then you can close the mapper device:"
19239 msgstr ""
19240
19241 #. type: verbatim
19242 #: ../fish/guestfish.pod:855
19243 #, no-wrap
19244 msgid ""
19245 " vg-activate false /dev/VG\n"
19246 " luks-close /dev/mapper/luksdev\n"
19247 "\n"
19248 msgstr ""
19249
19250 #. type: textblock
19251 #: ../fish/guestfish.pod:860
19252 msgid ""
19253 "If a path is prefixed with C<win:> then you can use Windows-style drive "
19254 "letters and paths (with some limitations).  The following commands are "
19255 "equivalent:"
19256 msgstr ""
19257
19258 #. type: verbatim
19259 #: ../fish/guestfish.pod:864
19260 #, no-wrap
19261 msgid ""
19262 " file /WINDOWS/system32/config/system.LOG\n"
19263 "\n"
19264 msgstr ""
19265
19266 #. type: verbatim
19267 #: ../fish/guestfish.pod:866
19268 #, no-wrap
19269 msgid ""
19270 " file win:\\windows\\system32\\config\\system.log\n"
19271 "\n"
19272 msgstr ""
19273
19274 #. type: verbatim
19275 #: ../fish/guestfish.pod:868
19276 #, no-wrap
19277 msgid ""
19278 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
19279 "\n"
19280 msgstr ""
19281
19282 #. type: textblock
19283 #: ../fish/guestfish.pod:870
19284 msgid ""
19285 "The parameter is rewritten \"behind the scenes\" by looking up the position "
19286 "where the drive is mounted, prepending that to the path, changing all "
19287 "backslash characters to forward slash, then resolving the result using "
19288 "L</case-sensitive-path>.  For example if the E: drive was mounted on C</e> "
19289 "then the parameter might be rewritten like this:"
19290 msgstr ""
19291
19292 #. type: verbatim
19293 #: ../fish/guestfish.pod:876
19294 #, no-wrap
19295 msgid ""
19296 " win:e:\\foo\\bar => /e/FOO/bar\n"
19297 "\n"
19298 msgstr ""
19299
19300 #. type: textblock
19301 #: ../fish/guestfish.pod:878
19302 msgid "This only works in argument positions that expect a path."
19303 msgstr ""
19304
19305 #. type: =head1
19306 #: ../fish/guestfish.pod:880
19307 msgid "UPLOADING AND DOWNLOADING FILES"
19308 msgstr ""
19309
19310 #. type: textblock
19311 #: ../fish/guestfish.pod:882
19312 msgid ""
19313 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
19314 "others which upload from or download to a local file, you can use the "
19315 "special filename C<-> to mean \"from stdin\" or \"to stdout\".  For example:"
19316 msgstr ""
19317
19318 #. type: verbatim
19319 #: ../fish/guestfish.pod:886
19320 #, no-wrap
19321 msgid ""
19322 " upload - /foo\n"
19323 "\n"
19324 msgstr ""
19325
19326 #. type: textblock
19327 #: ../fish/guestfish.pod:888
19328 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
19329 msgstr ""
19330
19331 #. type: verbatim
19332 #: ../fish/guestfish.pod:891
19333 #, no-wrap
19334 msgid ""
19335 " tar-out /etc - | tar tf -\n"
19336 "\n"
19337 msgstr ""
19338
19339 #. type: textblock
19340 #: ../fish/guestfish.pod:893
19341 msgid ""
19342 "writes the tarball to stdout and then pipes that into the external \"tar\" "
19343 "command (see L</PIPES>)."
19344 msgstr ""
19345
19346 #. type: textblock
19347 #: ../fish/guestfish.pod:896
19348 msgid ""
19349 "When using C<-> to read from stdin, the input is read up to the end of "
19350 "stdin.  You can also use a special \"heredoc\"-like syntax to read up to "
19351 "some arbitrary end marker:"
19352 msgstr ""
19353
19354 #. type: verbatim
19355 #: ../fish/guestfish.pod:900
19356 #, no-wrap
19357 msgid ""
19358 " upload -<<END /foo\n"
19359 " input line 1\n"
19360 " input line 2\n"
19361 " input line 3\n"
19362 " END\n"
19363 "\n"
19364 msgstr ""
19365
19366 #. type: textblock
19367 #: ../fish/guestfish.pod:906
19368 msgid ""
19369 "Any string of characters can be used instead of C<END>.  The end marker must "
19370 "appear on a line of its own, without any preceeding or following characters "
19371 "(not even spaces)."
19372 msgstr ""
19373
19374 #. type: textblock
19375 #: ../fish/guestfish.pod:910
19376 msgid ""
19377 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
19378 "upload local files (so-called \"FileIn\" parameters in the generator)."
19379 msgstr ""
19380
19381 #. type: =head1
19382 #: ../fish/guestfish.pod:913
19383 msgid "EXIT ON ERROR BEHAVIOUR"
19384 msgstr ""
19385
19386 #. type: textblock
19387 #: ../fish/guestfish.pod:915
19388 msgid ""
19389 "By default, guestfish will ignore any errors when in interactive mode "
19390 "(ie. taking commands from a human over a tty), and will exit on the first "
19391 "error in non-interactive mode (scripts, commands given on the command line)."
19392 msgstr ""
19393
19394 #. type: textblock
19395 #: ../fish/guestfish.pod:920
19396 msgid ""
19397 "If you prefix a command with a I<-> character, then that command will not "
19398 "cause guestfish to exit, even if that (one) command returns an error."
19399 msgstr ""
19400
19401 #. type: =head1
19402 #: ../fish/guestfish.pod:924
19403 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
19404 msgstr ""
19405
19406 #. type: textblock
19407 #: ../fish/guestfish.pod:926
19408 msgid ""
19409 "Guestfish can be remote-controlled over a socket.  This is useful "
19410 "particularly in shell scripts where you want to make several different "
19411 "changes to a filesystem, but you don't want the overhead of starting up a "
19412 "guestfish process each time."
19413 msgstr ""
19414
19415 #. type: textblock
19416 #: ../fish/guestfish.pod:931
19417 msgid "Start a guestfish server process using:"
19418 msgstr ""
19419
19420 #. type: verbatim
19421 #: ../fish/guestfish.pod:933
19422 #, no-wrap
19423 msgid ""
19424 " eval \"`guestfish --listen`\"\n"
19425 "\n"
19426 msgstr ""
19427
19428 #. type: textblock
19429 #: ../fish/guestfish.pod:935
19430 msgid "and then send it commands by doing:"
19431 msgstr ""
19432
19433 #. type: verbatim
19434 #: ../fish/guestfish.pod:937
19435 #, no-wrap
19436 msgid ""
19437 " guestfish --remote cmd [...]\n"
19438 "\n"
19439 msgstr ""
19440
19441 #. type: textblock
19442 #: ../fish/guestfish.pod:939
19443 msgid "To cause the server to exit, send it the exit command:"
19444 msgstr ""
19445
19446 #. type: textblock
19447 #: ../fish/guestfish.pod:943
19448 msgid ""
19449 "Note that the server will normally exit if there is an error in a command.  "
19450 "You can change this in the usual way.  See section L</EXIT ON ERROR "
19451 "BEHAVIOUR>."
19452 msgstr ""
19453
19454 #. type: =head2
19455 #: ../fish/guestfish.pod:947
19456 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
19457 msgstr ""
19458
19459 #. type: textblock
19460 #: ../fish/guestfish.pod:949
19461 msgid ""
19462 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
19463 "is how the I<--remote> option knows where to send the commands.  You can "
19464 "have several guestfish listener processes running using:"
19465 msgstr ""
19466
19467 #. type: verbatim
19468 #: ../fish/guestfish.pod:953
19469 #, no-wrap
19470 msgid ""
19471 " eval \"`guestfish --listen`\"\n"
19472 " pid1=$GUESTFISH_PID\n"
19473 " eval \"`guestfish --listen`\"\n"
19474 " pid2=$GUESTFISH_PID\n"
19475 " ...\n"
19476 " guestfish --remote=$pid1 cmd\n"
19477 " guestfish --remote=$pid2 cmd\n"
19478 "\n"
19479 msgstr ""
19480
19481 #. type: =head2
19482 #: ../fish/guestfish.pod:961
19483 msgid "REMOTE CONTROL AND CSH"
19484 msgstr ""
19485
19486 #. type: textblock
19487 #: ../fish/guestfish.pod:963
19488 msgid ""
19489 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
19490 "option:"
19491 msgstr ""
19492
19493 #. type: verbatim
19494 #: ../fish/guestfish.pod:966
19495 #, no-wrap
19496 msgid ""
19497 " eval \"`guestfish --listen --csh`\"\n"
19498 "\n"
19499 msgstr ""
19500
19501 #. type: =head2
19502 #: ../fish/guestfish.pod:968
19503 msgid "REMOTE CONTROL DETAILS"
19504 msgstr ""
19505
19506 #. type: textblock
19507 #: ../fish/guestfish.pod:970
19508 msgid ""
19509 "Remote control happens over a Unix domain socket called "
19510 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
19511 "of the process, and C<$PID> is the process ID of the server."
19512 msgstr ""
19513
19514 #. type: textblock
19515 #: ../fish/guestfish.pod:974
19516 msgid "Guestfish client and server versions must match exactly."
19517 msgstr ""
19518
19519 #. type: =head2
19520 #: ../fish/guestfish.pod:976
19521 msgid "USING REMOTE CONTROL ROBUSTLY FROM SHELL SCRIPTS"
19522 msgstr ""
19523
19524 #. type: textblock
19525 #: ../fish/guestfish.pod:978
19526 msgid ""
19527 "From Bash, you can use the following code which creates a guestfish "
19528 "instance, correctly quotes the command line, handles failure to start, and "
19529 "cleans up guestfish when the script exits:"
19530 msgstr ""
19531
19532 #. type: verbatim
19533 #: ../fish/guestfish.pod:982 ../src/guestfs.pod:980
19534 #, no-wrap
19535 msgid ""
19536 " #!/bin/bash -\n"
19537 " \n"
19538 msgstr ""
19539
19540 #. type: verbatim
19541 #: ../fish/guestfish.pod:986
19542 #, no-wrap
19543 msgid ""
19544 " guestfish[0]=\"guestfish\"\n"
19545 " guestfish[1]=\"--listen\"\n"
19546 " guestfish[2]=\"--ro\"\n"
19547 " guestfish[3]=\"-a\"\n"
19548 " guestfish[4]=\"disk.img\"\n"
19549 " \n"
19550 msgstr ""
19551
19552 #. type: verbatim
19553 #: ../fish/guestfish.pod:992
19554 #, no-wrap
19555 msgid ""
19556 " GUESTFISH_PID=\n"
19557 " eval $(\"${guestfish[@]}\")\n"
19558 " if [ -z \"$GUESTFISH_PID\" ]; then\n"
19559 "     echo \"error: guestfish didn't start up, see error messages above\"\n"
19560 "     exit 1\n"
19561 " fi\n"
19562 " \n"
19563 msgstr ""
19564
19565 #. type: verbatim
19566 #: ../fish/guestfish.pod:999
19567 #, no-wrap
19568 msgid ""
19569 " cleanup_guestfish ()\n"
19570 " {\n"
19571 "     guestfish --remote -- exit >/dev/null 2>&1 ||:\n"
19572 " }\n"
19573 " trap cleanup_guestfish EXIT ERR\n"
19574 " \n"
19575 msgstr ""
19576
19577 #. type: verbatim
19578 #: ../fish/guestfish.pod:1005
19579 #, no-wrap
19580 msgid ""
19581 " guestfish --remote -- run\n"
19582 " \n"
19583 msgstr ""
19584
19585 #. type: verbatim
19586 #: ../fish/guestfish.pod:1007
19587 #, no-wrap
19588 msgid ""
19589 " # ...\n"
19590 "\n"
19591 msgstr ""
19592
19593 #. type: =head2
19594 #: ../fish/guestfish.pod:1009
19595 msgid "REMOTE CONTROL RUN COMMAND HANGING"
19596 msgstr ""
19597
19598 #. type: textblock
19599 #: ../fish/guestfish.pod:1011
19600 msgid ""
19601 "Using the C<run> (or C<launch>) command remotely in a command substitution "
19602 "context hangs, ie. don't do (note the backquotes):"
19603 msgstr ""
19604
19605 #. type: verbatim
19606 #: ../fish/guestfish.pod:1014
19607 #, no-wrap
19608 msgid ""
19609 " a=`guestfish --remote run`\n"
19610 "\n"
19611 msgstr ""
19612
19613 #. type: textblock
19614 #: ../fish/guestfish.pod:1016
19615 msgid ""
19616 "Since the C<run> command produces no output on stdout, this is not useful "
19617 "anyway.  For further information see "
19618 "L<https://bugzilla.redhat.com/show_bug.cgi?id=592910>."
19619 msgstr ""
19620
19621 #. type: =head1
19622 #: ../fish/guestfish.pod:1020
19623 msgid "PREPARED DISK IMAGES"
19624 msgstr ""
19625
19626 #. type: textblock
19627 #: ../fish/guestfish.pod:1022
19628 msgid ""
19629 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
19630 "preformatted disk images that guestfish can make for you to save typing.  "
19631 "This is particularly useful for testing purposes.  This option is used "
19632 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
19633 "can be mixed with I<-a>)."
19634 msgstr ""
19635
19636 #. type: textblock
19637 #: ../fish/guestfish.pod:1028
19638 msgid ""
19639 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
19640 "the second and so on.  Existing files in the current directory are "
19641 "I<overwritten>."
19642 msgstr ""
19643
19644 #. type: textblock
19645 #: ../fish/guestfish.pod:1032
19646 msgid ""
19647 "The type briefly describes how the disk should be sized, partitioned, how "
19648 "filesystem(s) should be created, and how content should be added.  "
19649 "Optionally the type can be followed by extra parameters, separated by C<:> "
19650 "(colon) characters.  For example, I<-N fs> creates a default 100MB, "
19651 "sparsely-allocated disk, containing a single partition, with the partition "
19652 "formatted as ext2.  I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
19653 "on a 1GB disk instead."
19654 msgstr ""
19655
19656 #. type: textblock
19657 #: ../fish/guestfish.pod:1040
19658 msgid "To list the available types and any extra parameters they take, run:"
19659 msgstr ""
19660
19661 #. type: textblock
19662 #: ../fish/guestfish.pod:1044
19663 msgid ""
19664 "Note that the prepared filesystem is not mounted.  You would usually have to "
19665 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
19666 msgstr ""
19667
19668 #. type: textblock
19669 #: ../fish/guestfish.pod:1048
19670 msgid ""
19671 "If any I<-N> or I<--new> options are given, the guest is automatically "
19672 "launched."
19673 msgstr ""
19674
19675 #. type: textblock
19676 #: ../fish/guestfish.pod:1053
19677 msgid "Create a 100MB disk with an ext4-formatted partition:"
19678 msgstr ""
19679
19680 #. type: verbatim
19681 #: ../fish/guestfish.pod:1055
19682 #, no-wrap
19683 msgid ""
19684 " guestfish -N fs:ext4\n"
19685 "\n"
19686 msgstr ""
19687
19688 #. type: textblock
19689 #: ../fish/guestfish.pod:1057
19690 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
19691 msgstr ""
19692
19693 #. type: verbatim
19694 #: ../fish/guestfish.pod:1059
19695 #, no-wrap
19696 msgid ""
19697 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
19698 "\n"
19699 msgstr ""
19700
19701 #. type: textblock
19702 #: ../fish/guestfish.pod:1061
19703 msgid "Create a blank 200MB disk:"
19704 msgstr ""
19705
19706 #. type: verbatim
19707 #: ../fish/guestfish.pod:1063
19708 #, no-wrap
19709 msgid ""
19710 " guestfish -N disk:200M\n"
19711 "\n"
19712 msgstr ""
19713
19714 #. type: =head1
19715 #: ../fish/guestfish.pod:1065
19716 msgid "PROGRESS BARS"
19717 msgstr ""
19718
19719 #. type: textblock
19720 #: ../fish/guestfish.pod:1067
19721 msgid ""
19722 "Some (not all) long-running commands send progress notification messages as "
19723 "they are running.  Guestfish turns these messages into progress bars."
19724 msgstr ""
19725
19726 #. type: textblock
19727 #: ../fish/guestfish.pod:1071
19728 msgid ""
19729 "When a command that supports progress bars takes longer than two seconds to "
19730 "run, and if progress bars are enabled, then you will see one appearing below "
19731 "the command:"
19732 msgstr ""
19733
19734 #. type: verbatim
19735 #: ../fish/guestfish.pod:1075
19736 #, no-wrap
19737 msgid ""
19738 " ><fs> copy-size /large-file /another-file 2048M\n"
19739 " / 10% [#####-----------------------------------------] 00:30\n"
19740 "\n"
19741 msgstr ""
19742
19743 #. type: textblock
19744 #: ../fish/guestfish.pod:1078
19745 msgid ""
19746 "The spinner on the left hand side moves round once for every progress "
19747 "notification received from the backend.  This is a (reasonably) golden "
19748 "assurance that the command is \"doing something\" even if the progress bar "
19749 "is not moving, because the command is able to send the progress "
19750 "notifications.  When the bar reaches 100% and the command finishes, the "
19751 "spinner disappears."
19752 msgstr ""
19753
19754 #. type: textblock
19755 #: ../fish/guestfish.pod:1085
19756 msgid ""
19757 "Progress bars are enabled by default when guestfish is used interactively.  "
19758 "You can enable them even for non-interactive modes using I<--progress-bars>, "
19759 "and you can disable them completely using I<--no-progress-bars>."
19760 msgstr ""
19761
19762 #. type: =head1
19763 #: ../fish/guestfish.pod:1090
19764 msgid "GUESTFISH COMMANDS"
19765 msgstr ""
19766
19767 #. type: textblock
19768 #: ../fish/guestfish.pod:1092
19769 msgid ""
19770 "The commands in this section are guestfish convenience commands, in other "
19771 "words, they are not part of the L<guestfs(3)> API."
19772 msgstr ""
19773
19774 #. type: =head2
19775 #: ../fish/guestfish.pod:1095
19776 msgid "help"
19777 msgstr ""
19778
19779 #. type: verbatim
19780 #: ../fish/guestfish.pod:1097
19781 #, no-wrap
19782 msgid ""
19783 " help\n"
19784 " help cmd\n"
19785 "\n"
19786 msgstr ""
19787
19788 #. type: textblock
19789 #: ../fish/guestfish.pod:1100
19790 msgid "Without any parameter, this provides general help."
19791 msgstr ""
19792
19793 #. type: textblock
19794 #: ../fish/guestfish.pod:1102
19795 msgid "With a C<cmd> parameter, this displays detailed help for that command."
19796 msgstr ""
19797
19798 #. type: =head2
19799 #: ../fish/guestfish.pod:1104
19800 msgid "quit | exit"
19801 msgstr ""
19802
19803 #. type: textblock
19804 #: ../fish/guestfish.pod:1106
19805 msgid "This exits guestfish.  You can also use C<^D> key."
19806 msgstr ""
19807
19808 #. type: textblock
19809 #: ../fish/guestfish.pod:1108
19810 msgid "@FISH_COMMANDS@"
19811 msgstr ""
19812
19813 #. type: =head1
19814 #: ../fish/guestfish.pod:1110
19815 msgid "COMMANDS"
19816 msgstr ""
19817
19818 #. type: textblock
19819 #: ../fish/guestfish.pod:1112 ../src/guestfs.pod:1520
19820 msgid "@ACTIONS@"
19821 msgstr ""
19822
19823 #. type: textblock
19824 #: ../fish/guestfish.pod:1116
19825 msgid ""
19826 "guestfish returns 0 if the commands completed without error, or 1 if there "
19827 "was an error."
19828 msgstr ""
19829
19830 #. type: =item
19831 #: ../fish/guestfish.pod:1123
19832 msgid "EDITOR"
19833 msgstr ""
19834
19835 #. type: textblock
19836 #: ../fish/guestfish.pod:1125
19837 msgid ""
19838 "The C<edit> command uses C<$EDITOR> as the editor.  If not set, it uses "
19839 "C<vi>."
19840 msgstr ""
19841
19842 #. type: =item
19843 #: ../fish/guestfish.pod:1128 ../src/guestfs.pod:3213
19844 msgid "FEBOOTSTRAP_KERNEL"
19845 msgstr ""
19846
19847 #. type: =item
19848 #: ../fish/guestfish.pod:1130 ../src/guestfs.pod:3215
19849 msgid "FEBOOTSTRAP_MODULES"
19850 msgstr ""
19851
19852 #. type: textblock
19853 #: ../fish/guestfish.pod:1132 ../src/guestfs.pod:3217
19854 msgid ""
19855 "These two environment variables allow the kernel that libguestfs uses in the "
19856 "appliance to be selected.  If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
19857 "most recent host kernel is chosen.  For more information about kernel "
19858 "selection, see L<febootstrap-supermin-helper(8)>.  This feature is only "
19859 "available in febootstrap E<ge> 3.8."
19860 msgstr ""
19861
19862 #. type: =item
19863 #: ../fish/guestfish.pod:1138
19864 msgid "GUESTFISH_DISPLAY_IMAGE"
19865 msgstr ""
19866
19867 #. type: textblock
19868 #: ../fish/guestfish.pod:1140
19869 msgid ""
19870 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images.  "
19871 "If not set, it uses L<display(1)>."
19872 msgstr ""
19873
19874 #. type: =item
19875 #: ../fish/guestfish.pod:1143
19876 msgid "GUESTFISH_PID"
19877 msgstr ""
19878
19879 #. type: textblock
19880 #: ../fish/guestfish.pod:1145
19881 msgid ""
19882 "Used with the I<--remote> option to specify the remote guestfish process to "
19883 "control.  See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19884 msgstr ""
19885
19886 #. type: =item
19887 #: ../fish/guestfish.pod:1149
19888 msgid "HEXEDITOR"
19889 msgstr ""
19890
19891 #. type: textblock
19892 #: ../fish/guestfish.pod:1151
19893 msgid ""
19894 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor.  If "
19895 "not specified, the external L<hexedit(1)> program is used."
19896 msgstr ""
19897
19898 #. type: =item
19899 #: ../fish/guestfish.pod:1155
19900 msgid "HOME"
19901 msgstr ""
19902
19903 #. type: textblock
19904 #: ../fish/guestfish.pod:1157
19905 msgid ""
19906 "If compiled with GNU readline support, various files in the home directory "
19907 "can be used.  See L</FILES>."
19908 msgstr ""
19909
19910 #. type: =item
19911 #: ../fish/guestfish.pod:1160 ../src/guestfs.pod:3223
19912 msgid "LIBGUESTFS_APPEND"
19913 msgstr ""
19914
19915 #. type: textblock
19916 #: ../fish/guestfish.pod:1162 ../src/guestfs.pod:3225
19917 msgid "Pass additional options to the guest kernel."
19918 msgstr ""
19919
19920 #. type: =item
19921 #: ../fish/guestfish.pod:1164 ../src/guestfs.pod:3227
19922 msgid "LIBGUESTFS_DEBUG"
19923 msgstr ""
19924
19925 #. type: textblock
19926 #: ../fish/guestfish.pod:1166
19927 msgid ""
19928 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages.  This has the same "
19929 "effect as using the B<-v> option."
19930 msgstr ""
19931
19932 #. type: =item
19933 #: ../fish/guestfish.pod:1169 ../src/guestfs.pod:3232
19934 msgid "LIBGUESTFS_MEMSIZE"
19935 msgstr ""
19936
19937 #. type: textblock
19938 #: ../fish/guestfish.pod:1171 ../src/guestfs.pod:3234
19939 msgid "Set the memory allocated to the qemu process, in megabytes.  For example:"
19940 msgstr ""
19941
19942 #. type: verbatim
19943 #: ../fish/guestfish.pod:1174 ../src/guestfs.pod:3237
19944 #, no-wrap
19945 msgid ""
19946 " LIBGUESTFS_MEMSIZE=700\n"
19947 "\n"
19948 msgstr ""
19949
19950 #. type: =item
19951 #: ../fish/guestfish.pod:1176 ../src/guestfs.pod:3239
19952 msgid "LIBGUESTFS_PATH"
19953 msgstr ""
19954
19955 #. type: textblock
19956 #: ../fish/guestfish.pod:1178
19957 msgid ""
19958 "Set the path that guestfish uses to search for kernel and initrd.img.  See "
19959 "the discussion of paths in L<guestfs(3)>."
19960 msgstr ""
19961
19962 #. type: =item
19963 #: ../fish/guestfish.pod:1181 ../src/guestfs.pod:3244
19964 msgid "LIBGUESTFS_QEMU"
19965 msgstr ""
19966
19967 #. type: textblock
19968 #: ../fish/guestfish.pod:1183 ../src/guestfs.pod:3246
19969 msgid ""
19970 "Set the default qemu binary that libguestfs uses.  If not set, then the qemu "
19971 "which was found at compile time by the configure script is used."
19972 msgstr ""
19973
19974 #. type: =item
19975 #: ../fish/guestfish.pod:1187 ../src/guestfs.pod:3252
19976 msgid "LIBGUESTFS_TRACE"
19977 msgstr ""
19978
19979 #. type: textblock
19980 #: ../fish/guestfish.pod:1189
19981 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19982 msgstr ""
19983
19984 #. type: =item
19985 #: ../fish/guestfish.pod:1191
19986 msgid "PAGER"
19987 msgstr ""
19988
19989 #. type: textblock
19990 #: ../fish/guestfish.pod:1193
19991 msgid ""
19992 "The C<more> command uses C<$PAGER> as the pager.  If not set, it uses "
19993 "C<more>."
19994 msgstr ""
19995
19996 #. type: =item
19997 #: ../fish/guestfish.pod:1196 ../sparsify/virt-sparsify.pod:236 ../src/guestfs.pod:3257
19998 msgid "TMPDIR"
19999 msgstr ""
20000
20001 #. type: textblock
20002 #: ../fish/guestfish.pod:1198 ../src/guestfs.pod:3259
20003 msgid ""
20004 "Location of temporary directory, defaults to C</tmp> except for the cached "
20005 "supermin appliance which defaults to C</var/tmp>."
20006 msgstr ""
20007
20008 #. type: textblock
20009 #: ../fish/guestfish.pod:1201 ../src/guestfs.pod:3262
20010 msgid ""
20011 "If libguestfs was compiled to use the supermin appliance then the real "
20012 "appliance is cached in this directory, shared between all handles belonging "
20013 "to the same EUID.  You can use C<$TMPDIR> to configure another directory to "
20014 "use in case C</var/tmp> is not large enough."
20015 msgstr ""
20016
20017 #. type: =head1
20018 #: ../fish/guestfish.pod:1209 ../fuse/guestmount.pod:297 ../rescue/virt-rescue.pod:310
20019 msgid "FILES"
20020 msgstr ""
20021
20022 #. type: =item
20023 #: ../fish/guestfish.pod:1213 ../fuse/guestmount.pod:301 ../rescue/virt-rescue.pod:314
20024 msgid "$HOME/.libguestfs-tools.rc"
20025 msgstr ""
20026
20027 #. type: =item
20028 #: ../fish/guestfish.pod:1215 ../fuse/guestmount.pod:303 ../rescue/virt-rescue.pod:316
20029 msgid "/etc/libguestfs-tools.conf"
20030 msgstr ""
20031
20032 #. type: textblock
20033 #: ../fish/guestfish.pod:1217 ../fuse/guestmount.pod:305 ../rescue/virt-rescue.pod:318
20034 msgid ""
20035 "This configuration file controls the default read-only or read-write mode "
20036 "(I<--ro> or I<--rw>)."
20037 msgstr ""
20038
20039 #. type: textblock
20040 #: ../fish/guestfish.pod:1220
20041 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
20042 msgstr ""
20043
20044 #. type: =item
20045 #: ../fish/guestfish.pod:1222
20046 msgid "$HOME/.guestfish"
20047 msgstr ""
20048
20049 #. type: textblock
20050 #: ../fish/guestfish.pod:1224
20051 msgid ""
20052 "If compiled with GNU readline support, then the command history is saved in "
20053 "this file."
20054 msgstr ""
20055
20056 #. type: =item
20057 #: ../fish/guestfish.pod:1227
20058 msgid "$HOME/.inputrc"
20059 msgstr ""
20060
20061 #. type: =item
20062 #: ../fish/guestfish.pod:1229
20063 msgid "/etc/inputrc"
20064 msgstr ""
20065
20066 #. type: textblock
20067 #: ../fish/guestfish.pod:1231
20068 msgid ""
20069 "If compiled with GNU readline support, then these files can be used to "
20070 "configure readline.  For further information, please see "
20071 "L<readline(3)/INITIALIZATION FILE>."
20072 msgstr ""
20073
20074 #. type: textblock
20075 #: ../fish/guestfish.pod:1235
20076 msgid "To write rules which only apply to guestfish, use:"
20077 msgstr ""
20078
20079 #. type: verbatim
20080 #: ../fish/guestfish.pod:1237
20081 #, no-wrap
20082 msgid ""
20083 " $if guestfish\n"
20084 " ...\n"
20085 " $endif\n"
20086 "\n"
20087 msgstr ""
20088
20089 #. type: textblock
20090 #: ../fish/guestfish.pod:1241
20091 msgid ""
20092 "Variables that you can set in inputrc that change the behaviour of guestfish "
20093 "in useful ways include:"
20094 msgstr ""
20095
20096 #. type: =item
20097 #: ../fish/guestfish.pod:1246
20098 msgid "completion-ignore-case (default: on)"
20099 msgstr ""
20100
20101 #. type: textblock
20102 #: ../fish/guestfish.pod:1248
20103 msgid ""
20104 "By default, guestfish will ignore case when tab-completing paths on the "
20105 "disk.  Use:"
20106 msgstr ""
20107
20108 #. type: verbatim
20109 #: ../fish/guestfish.pod:1251
20110 #, no-wrap
20111 msgid ""
20112 " set completion-ignore-case off\n"
20113 "\n"
20114 msgstr ""
20115
20116 #. type: textblock
20117 #: ../fish/guestfish.pod:1253
20118 msgid "to make guestfish case sensitive."
20119 msgstr ""
20120
20121 #. type: =item
20122 #: ../fish/guestfish.pod:1257
20123 msgid "test1.img"
20124 msgstr ""
20125
20126 #. type: =item
20127 #: ../fish/guestfish.pod:1259
20128 msgid "test2.img (etc)"
20129 msgstr ""
20130
20131 #. type: textblock
20132 #: ../fish/guestfish.pod:1261
20133 msgid ""
20134 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
20135 "will be created in the file C<test1.img> in the current directory.  The "
20136 "second use of I<-N> will use C<test2.img> and so on.  Any existing file with "
20137 "the same name will be overwritten."
20138 msgstr ""
20139
20140 #. type: textblock
20141 #: ../fish/guestfish.pod:1270
20142 msgid ""
20143 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-alignment-scan(1)>, "
20144 "L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, "
20145 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
20146 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
20147 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
20148 "L<virt-sparsify(1)>, L<virt-sysprep(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
20149 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>, "
20150 "L<febootstrap-supermin-helper(8)>."
20151 msgstr ""
20152
20153 #. type: textblock
20154 #: ../fish/guestfish.pod:1302 ../src/guestfs.pod:3354 ../test-tool/libguestfs-test-tool.pod:112
20155 msgid "Copyright (C) 2009-2011 Red Hat Inc.  L<http://libguestfs.org/>"
20156 msgstr ""
20157
20158 #. type: textblock
20159 #: ../fish/virt-copy-in.pod:5
20160 msgid "virt-copy-in - Copy files and directories into a virtual machine disk image."
20161 msgstr ""
20162
20163 #. type: verbatim
20164 #: ../fish/virt-copy-in.pod:9
20165 #, no-wrap
20166 msgid ""
20167 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
20168 "\n"
20169 msgstr ""
20170
20171 #. type: verbatim
20172 #: ../fish/virt-copy-in.pod:11
20173 #, no-wrap
20174 msgid ""
20175 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
20176 "\n"
20177 msgstr ""
20178
20179 #. type: textblock
20180 #: ../fish/virt-copy-in.pod:15
20181 msgid ""
20182 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
20183 "causing disk corruption.  The virtual machine must be shut down before you "
20184 "use this command."
20185 msgstr ""
20186
20187 #. type: textblock
20188 #: ../fish/virt-copy-in.pod:21
20189 msgid ""
20190 "C<virt-copy-in> copies files and directories from the local disk into a "
20191 "virtual machine disk image or named libvirt domain."
20192 msgstr ""
20193
20194 #. type: textblock
20195 #: ../fish/virt-copy-in.pod:24
20196 msgid ""
20197 "You can give one of more filenames and directories on the command line.  "
20198 "Directories are copied in recursively.  The final parameter must be the "
20199 "destination directory in the disk image which must be an absolute path "
20200 "starting with a C</> character."
20201 msgstr ""
20202
20203 #. type: verbatim
20204 #: ../fish/virt-copy-in.pod:33
20205 #, no-wrap
20206 msgid ""
20207 " virt-copy-in -d MyGuest resolv.conf /etc\n"
20208 "\n"
20209 msgstr ""
20210
20211 #. type: textblock
20212 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
20213 msgid "Upload a home directory to a guest:"
20214 msgstr ""
20215
20216 #. type: verbatim
20217 #: ../fish/virt-copy-in.pod:37
20218 #, no-wrap
20219 msgid ""
20220 " virt-copy-in -d MyGuest skel /home\n"
20221 "\n"
20222 msgstr ""
20223
20224 #. type: =head1
20225 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28 ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
20226 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
20227 msgstr ""
20228
20229 #. type: textblock
20230 #: ../fish/virt-copy-in.pod:41
20231 msgid ""
20232 "This command is just a simple shell script wrapper around the "
20233 "L<guestfish(1)> C<copy-in> command.  For anything more complex than a "
20234 "trivial copy, you are probably better off using guestfish directly."
20235 msgstr ""
20236
20237 #. type: textblock
20238 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36 ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
20239 msgid ""
20240 "Since the shell script just passes options straight to guestfish, read "
20241 "L<guestfish(1)> to see the full list of options."
20242 msgstr ""
20243
20244 #. type: textblock
20245 #: ../fish/virt-copy-in.pod:52
20246 msgid ""
20247 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
20248 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
20249 msgstr ""
20250
20251 #. type: textblock
20252 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55 ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
20253 msgid "Copyright (C) 2011 Red Hat Inc.  L<http://libguestfs.org/>"
20254 msgstr ""
20255
20256 #. type: textblock
20257 #: ../fish/virt-copy-out.pod:5
20258 msgid ""
20259 "virt-copy-out - Copy files and directories out of a virtual machine disk "
20260 "image."
20261 msgstr ""
20262
20263 #. type: verbatim
20264 #: ../fish/virt-copy-out.pod:9
20265 #, no-wrap
20266 msgid ""
20267 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
20268 "\n"
20269 msgstr ""
20270
20271 #. type: verbatim
20272 #: ../fish/virt-copy-out.pod:11
20273 #, no-wrap
20274 msgid ""
20275 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
20276 "\n"
20277 msgstr ""
20278
20279 #. type: textblock
20280 #: ../fish/virt-copy-out.pod:15
20281 msgid ""
20282 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
20283 "image or named libvirt domain."
20284 msgstr ""
20285
20286 #. type: textblock
20287 #: ../fish/virt-copy-out.pod:18
20288 msgid ""
20289 "You can give one of more filenames and directories on the command line.  "
20290 "Directories are copied out recursively."
20291 msgstr ""
20292
20293 #. type: textblock
20294 #: ../fish/virt-copy-out.pod:23
20295 msgid "Download the home directories from a virtual machine:"
20296 msgstr ""
20297
20298 #. type: verbatim
20299 #: ../fish/virt-copy-out.pod:25
20300 #, no-wrap
20301 msgid ""
20302 " mkdir homes\n"
20303 " virt-copy-out -d MyGuest /home homes\n"
20304 "\n"
20305 msgstr ""
20306
20307 #. type: textblock
20308 #: ../fish/virt-copy-out.pod:30
20309 msgid ""
20310 "This command is just a simple shell script wrapper around the "
20311 "L<guestfish(1)> C<copy-out> command.  For anything more complex than a "
20312 "trivial copy, you are probably better off using guestfish directly."
20313 msgstr ""
20314
20315 #. type: textblock
20316 #: ../fish/virt-copy-out.pod:41
20317 msgid ""
20318 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, "
20319 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
20320 msgstr ""
20321
20322 #. type: textblock
20323 #: ../fish/virt-tar-in.pod:5
20324 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
20325 msgstr ""
20326
20327 #. type: verbatim
20328 #: ../fish/virt-tar-in.pod:9
20329 #, no-wrap
20330 msgid ""
20331 " virt-tar-in -a disk.img data.tar /destination\n"
20332 "\n"
20333 msgstr ""
20334
20335 #. type: verbatim
20336 #: ../fish/virt-tar-in.pod:11
20337 #, no-wrap
20338 msgid ""
20339 " virt-tar-in -d domain data.tar /destination\n"
20340 "\n"
20341 msgstr ""
20342
20343 #. type: verbatim
20344 #: ../fish/virt-tar-in.pod:13
20345 #, no-wrap
20346 msgid ""
20347 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
20348 "\n"
20349 msgstr ""
20350
20351 #. type: textblock
20352 #: ../fish/virt-tar-in.pod:17
20353 msgid ""
20354 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
20355 "causing disk corruption.  The virtual machine must be shut down before you "
20356 "use this command."
20357 msgstr ""
20358
20359 #. type: textblock
20360 #: ../fish/virt-tar-in.pod:23
20361 msgid ""
20362 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
20363 "image or named libvirt domain."
20364 msgstr ""
20365
20366 #. type: textblock
20367 #: ../fish/virt-tar-in.pod:26
20368 msgid ""
20369 "The first parameter is the tar file.  Use C<-> to read the tar file from "
20370 "standard input.  The second parameter is the absolute target directory to "
20371 "unpack into."
20372 msgstr ""
20373
20374 #. type: verbatim
20375 #: ../fish/virt-tar-in.pod:34
20376 #, no-wrap
20377 msgid ""
20378 " virt-tar-in -d MyGuest homes.tar /home\n"
20379 "\n"
20380 msgstr ""
20381
20382 #. type: textblock
20383 #: ../fish/virt-tar-in.pod:38
20384 msgid ""
20385 "This command is just a simple shell script wrapper around the "
20386 "L<guestfish(1)> C<tar-in> command.  For anything more complex than a trivial "
20387 "copy, you are probably better off using guestfish directly."
20388 msgstr ""
20389
20390 #. type: textblock
20391 #: ../fish/virt-tar-in.pod:49
20392 msgid ""
20393 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
20394 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, "
20395 "L<http://libguestfs.org/>."
20396 msgstr ""
20397
20398 #. type: textblock
20399 #: ../fish/virt-tar-out.pod:5
20400 msgid "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
20401 msgstr ""
20402
20403 #. type: verbatim
20404 #: ../fish/virt-tar-out.pod:9
20405 #, no-wrap
20406 msgid ""
20407 " virt-tar-out -a disk.img /dir files.tar\n"
20408 "\n"
20409 msgstr ""
20410
20411 #. type: verbatim
20412 #: ../fish/virt-tar-out.pod:11
20413 #, no-wrap
20414 msgid ""
20415 " virt-tar-out -d domain /dir files.tar\n"
20416 "\n"
20417 msgstr ""
20418
20419 #. type: verbatim
20420 #: ../fish/virt-tar-out.pod:13
20421 #, no-wrap
20422 msgid ""
20423 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
20424 "\n"
20425 msgstr ""
20426
20427 #. type: textblock
20428 #: ../fish/virt-tar-out.pod:17
20429 msgid "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
20430 msgstr ""
20431
20432 #. type: textblock
20433 #: ../fish/virt-tar-out.pod:20
20434 msgid ""
20435 "The first parameter is the absolute path of the virtual machine directory.  "
20436 "The second parameter is the tar file to write.  Use C<-> to write to "
20437 "standard output."
20438 msgstr ""
20439
20440 #. type: textblock
20441 #: ../fish/virt-tar-out.pod:26
20442 msgid "Download the home directories from a guest:"
20443 msgstr ""
20444
20445 #. type: verbatim
20446 #: ../fish/virt-tar-out.pod:28
20447 #, no-wrap
20448 msgid ""
20449 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
20450 "\n"
20451 msgstr ""
20452
20453 #. type: textblock
20454 #: ../fish/virt-tar-out.pod:32
20455 msgid ""
20456 "This command is just a simple shell script wrapper around the "
20457 "L<guestfish(1)> C<tar-out> command.  For anything more complex than a "
20458 "trivial copy, you are probably better off using guestfish directly."
20459 msgstr ""
20460
20461 #. type: textblock
20462 #: ../fish/virt-tar-out.pod:43
20463 msgid ""
20464 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
20465 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
20466 msgstr ""
20467
20468 #. type: textblock
20469 #: ../fuse/guestmount.pod:5
20470 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
20471 msgstr ""
20472
20473 #. type: verbatim
20474 #: ../fuse/guestmount.pod:9
20475 #, no-wrap
20476 msgid ""
20477 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
20478 "\n"
20479 msgstr ""
20480
20481 #. type: verbatim
20482 #: ../fuse/guestmount.pod:11
20483 #, no-wrap
20484 msgid ""
20485 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
20486 "\n"
20487 msgstr ""
20488
20489 #. type: verbatim
20490 #: ../fuse/guestmount.pod:13
20491 #, no-wrap
20492 msgid ""
20493 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
20494 "\n"
20495 msgstr ""
20496
20497 #. type: textblock
20498 #: ../fuse/guestmount.pod:17
20499 msgid ""
20500 "You must I<not> use C<guestmount> in read-write mode on live virtual "
20501 "machines.  If you do this, you risk disk corruption in the VM."
20502 msgstr ""
20503
20504 #. type: textblock
20505 #: ../fuse/guestmount.pod:22
20506 msgid ""
20507 "The guestmount program can be used to mount virtual machine filesystems and "
20508 "other disk images on the host.  It uses libguestfs for access to the guest "
20509 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
20510 "a mountable device."
20511 msgstr ""
20512
20513 #. type: textblock
20514 #: ../fuse/guestmount.pod:27
20515 msgid ""
20516 "Along with other options, you have to give at least one device (I<-a> "
20517 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
20518 "option) or use the I<-i> inspection option or the I<--live> option.  How "
20519 "this works is better explained in the L<guestfish(1)> manual page, or by "
20520 "looking at the examples below."
20521 msgstr ""
20522
20523 #. type: textblock
20524 #: ../fuse/guestmount.pod:33
20525 msgid ""
20526 "FUSE lets you mount filesystems as non-root.  The mountpoint must be owned "
20527 "by you, and the filesystem will not be visible to any other users unless you "
20528 "make certain global configuration changes to C</etc/fuse.conf>.  To unmount "
20529 "the filesystem, use the C<fusermount -u> command."
20530 msgstr ""
20531
20532 #. type: textblock
20533 #: ../fuse/guestmount.pod:41
20534 msgid ""
20535 "For a typical Windows guest which has its main filesystem on the first "
20536 "partition:"
20537 msgstr ""
20538
20539 #. type: verbatim
20540 #: ../fuse/guestmount.pod:44
20541 #, no-wrap
20542 msgid ""
20543 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
20544 "\n"
20545 msgstr ""
20546
20547 #. type: textblock
20548 #: ../fuse/guestmount.pod:46
20549 msgid ""
20550 "For a typical Linux guest which has a /boot filesystem on the first "
20551 "partition, and the root filesystem on a logical volume:"
20552 msgstr ""
20553
20554 #. type: verbatim
20555 #: ../fuse/guestmount.pod:49
20556 #, no-wrap
20557 msgid ""
20558 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
20559 "\n"
20560 msgstr ""
20561
20562 #. type: textblock
20563 #: ../fuse/guestmount.pod:51
20564 msgid "To get libguestfs to detect guest mountpoints for you:"
20565 msgstr ""
20566
20567 #. type: verbatim
20568 #: ../fuse/guestmount.pod:53
20569 #, no-wrap
20570 msgid ""
20571 " guestmount -a guest.img -i --ro /mnt\n"
20572 "\n"
20573 msgstr ""
20574
20575 #. type: textblock
20576 #: ../fuse/guestmount.pod:55
20577 msgid "For a libvirt guest called \"Guest\" you could do:"
20578 msgstr ""
20579
20580 #. type: verbatim
20581 #: ../fuse/guestmount.pod:57
20582 #, no-wrap
20583 msgid ""
20584 " guestmount -d Guest -i --ro /mnt\n"
20585 "\n"
20586 msgstr ""
20587
20588 #. type: textblock
20589 #: ../fuse/guestmount.pod:59
20590 msgid ""
20591 "If you don't know what filesystems are contained in a guest or disk image, "
20592 "use L<virt-filesystems(1)> first:"
20593 msgstr ""
20594
20595 #. type: verbatim
20596 #: ../fuse/guestmount.pod:62
20597 #, no-wrap
20598 msgid ""
20599 " virt-filesystems MyGuest\n"
20600 "\n"
20601 msgstr ""
20602
20603 #. type: textblock
20604 #: ../fuse/guestmount.pod:64
20605 msgid ""
20606 "If you want to trace the libguestfs calls but without excessive debugging "
20607 "information, we recommend:"
20608 msgstr ""
20609
20610 #. type: verbatim
20611 #: ../fuse/guestmount.pod:67
20612 #, no-wrap
20613 msgid ""
20614 " guestmount [...] --trace /mnt\n"
20615 "\n"
20616 msgstr ""
20617
20618 #. type: textblock
20619 #: ../fuse/guestmount.pod:69
20620 msgid "If you want to debug the program, we recommend:"
20621 msgstr ""
20622
20623 #. type: verbatim
20624 #: ../fuse/guestmount.pod:71
20625 #, no-wrap
20626 msgid ""
20627 " guestmount [...] --trace --verbose /mnt\n"
20628 "\n"
20629 msgstr ""
20630
20631 #. type: =head1
20632 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:96 ../resize/virt-resize.pod:621
20633 msgid "NOTES"
20634 msgstr ""
20635
20636 #. type: =head2
20637 #: ../fuse/guestmount.pod:75
20638 msgid "Other users cannot see the filesystem by default"
20639 msgstr ""
20640
20641 #. type: textblock
20642 #: ../fuse/guestmount.pod:77
20643 msgid ""
20644 "If you mount a filesystem as one user (eg. root), then other users will not "
20645 "be able to see it by default.  The fix is to add the FUSE C<allow_other> "
20646 "option when mounting:"
20647 msgstr ""
20648
20649 #. type: verbatim
20650 #: ../fuse/guestmount.pod:81
20651 #, no-wrap
20652 msgid ""
20653 " sudo guestmount [...] -o allow_other /mnt\n"
20654 "\n"
20655 msgstr ""
20656
20657 #. type: =head2
20658 #: ../fuse/guestmount.pod:83
20659 msgid "Enabling FUSE"
20660 msgstr ""
20661
20662 #. type: textblock
20663 #: ../fuse/guestmount.pod:85
20664 msgid ""
20665 "On some distros, you may need to add yourself to a special group "
20666 "(eg. C<fuse>) before you can use any FUSE filesystem.  This is necessary on "
20667 "Debian and derivatives."
20668 msgstr ""
20669
20670 #. type: textblock
20671 #: ../fuse/guestmount.pod:89
20672 msgid ""
20673 "On other distros, no special group is required.  It is not necessary on "
20674 "Fedora or Red Hat Enterprise Linux."
20675 msgstr ""
20676
20677 #. type: textblock
20678 #: ../fuse/guestmount.pod:100
20679 msgid "Add a block device or virtual machine image."
20680 msgstr ""
20681
20682 #. type: =item
20683 #: ../fuse/guestmount.pod:123
20684 msgid "B<--dir-cache-timeout N>"
20685 msgstr ""
20686
20687 #. type: textblock
20688 #: ../fuse/guestmount.pod:125
20689 msgid ""
20690 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
20691 "seconds.  The readdir cache [actually, there are several semi-independent "
20692 "caches] is populated after a readdir(2) call with the stat and extended "
20693 "attributes of the files in the directory, in anticipation that they will be "
20694 "requested soon after."
20695 msgstr ""
20696
20697 #. type: textblock
20698 #: ../fuse/guestmount.pod:131
20699 msgid ""
20700 "There is also a different attribute cache implemented by FUSE (see the FUSE "
20701 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
20702 "requests, only cache existing ones."
20703 msgstr ""
20704
20705 #. type: textblock
20706 #: ../fuse/guestmount.pod:151
20707 msgid ""
20708 "If you have untrusted raw-format guest disk images, you should use this "
20709 "option to specify the disk format.  This avoids a possible security problem "
20710 "with malicious guests (CVE-2010-3851).  See also "
20711 "L<guestfs(3)/guestfs_add_drive_opts>."
20712 msgstr ""
20713
20714 #. type: =item
20715 #: ../fuse/guestmount.pod:156
20716 msgid "B<--fuse-help>"
20717 msgstr ""
20718
20719 #. type: textblock
20720 #: ../fuse/guestmount.pod:158
20721 msgid "Display help on special FUSE options (see I<-o> below)."
20722 msgstr ""
20723
20724 #. type: textblock
20725 #: ../fuse/guestmount.pod:162
20726 msgid "Display brief help and exit."
20727 msgstr ""
20728
20729 #. type: textblock
20730 #: ../fuse/guestmount.pod:186
20731 msgid ""
20732 "Mount the named partition or logical volume on the given mountpoint B<in the "
20733 "guest> (this has nothing to do with mountpoints in the host)."
20734 msgstr ""
20735
20736 #. type: textblock
20737 #: ../fuse/guestmount.pod:189
20738 msgid ""
20739 "If the mountpoint is omitted, it defaults to C</>.  You have to mount "
20740 "something on C</>."
20741 msgstr ""
20742
20743 #. type: textblock
20744 #: ../fuse/guestmount.pod:206
20745 msgid ""
20746 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
20747 "unmounted.  If you specify this option, then we don't attempt to sync the "
20748 "disk.  See the discussion of autosync in the L<guestfs(3)> manpage."
20749 msgstr ""
20750
20751 #. type: =item
20752 #: ../fuse/guestmount.pod:211
20753 msgid "B<-o option>"
20754 msgstr ""
20755
20756 #. type: =item
20757 #: ../fuse/guestmount.pod:213
20758 msgid "B<--option option>"
20759 msgstr ""
20760
20761 #. type: textblock
20762 #: ../fuse/guestmount.pod:215
20763 msgid "Pass extra options to FUSE."
20764 msgstr ""
20765
20766 #. type: textblock
20767 #: ../fuse/guestmount.pod:217
20768 msgid ""
20769 "To get a list of all the extra options supported by FUSE, use the command "
20770 "below.  Note that only the FUSE I<-o> options can be passed, and only some "
20771 "of them are a good idea."
20772 msgstr ""
20773
20774 #. type: verbatim
20775 #: ../fuse/guestmount.pod:221
20776 #, no-wrap
20777 msgid ""
20778 " guestmount --fuse-help\n"
20779 "\n"
20780 msgstr ""
20781
20782 #. type: textblock
20783 #: ../fuse/guestmount.pod:223
20784 msgid "Some potentially useful FUSE options:"
20785 msgstr ""
20786
20787 #. type: =item
20788 #: ../fuse/guestmount.pod:227
20789 msgid "B<-o allow_other>"
20790 msgstr ""
20791
20792 #. type: textblock
20793 #: ../fuse/guestmount.pod:229
20794 msgid "Allow other users to see the filesystem."
20795 msgstr ""
20796
20797 #. type: =item
20798 #: ../fuse/guestmount.pod:231
20799 msgid "B<-o attr_timeout=N>"
20800 msgstr ""
20801
20802 #. type: textblock
20803 #: ../fuse/guestmount.pod:233
20804 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
20805 msgstr ""
20806
20807 #. type: =item
20808 #: ../fuse/guestmount.pod:235
20809 msgid "B<-o kernel_cache>"
20810 msgstr ""
20811
20812 #. type: textblock
20813 #: ../fuse/guestmount.pod:237
20814 msgid ""
20815 "Allow the kernel to cache files (reduces the number of reads that have to go "
20816 "through the L<guestfs(3)> API).  This is generally a good idea if you can "
20817 "afford the extra memory usage."
20818 msgstr ""
20819
20820 #. type: =item
20821 #: ../fuse/guestmount.pod:241
20822 msgid "B<-o uid=N> B<-o gid=N>"
20823 msgstr ""
20824
20825 #. type: textblock
20826 #: ../fuse/guestmount.pod:243
20827 msgid ""
20828 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
20829 "the chosen values."
20830 msgstr ""
20831
20832 #. type: textblock
20833 #: ../fuse/guestmount.pod:252
20834 msgid ""
20835 "Add devices and mount everything read-only.  Also disallow writes and make "
20836 "the disk appear read-only to FUSE."
20837 msgstr ""
20838
20839 #. type: textblock
20840 #: ../fuse/guestmount.pod:255
20841 msgid ""
20842 "This is highly recommended if you are not going to edit the guest disk.  If "
20843 "the guest is running and this option is I<not> supplied, then there is a "
20844 "strong risk of disk corruption in the guest.  We try to prevent this from "
20845 "happening, but it is not always possible."
20846 msgstr ""
20847
20848 #. type: textblock
20849 #: ../fuse/guestmount.pod:260 ../rescue/virt-rescue.pod:199
20850 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
20851 msgstr ""
20852
20853 #. type: textblock
20854 #: ../fuse/guestmount.pod:264
20855 msgid "Enable SELinux support for the guest."
20856 msgstr ""
20857
20858 #. type: textblock
20859 #: ../fuse/guestmount.pod:270
20860 msgid "Enable verbose messages from underlying libguestfs."
20861 msgstr ""
20862
20863 #. type: textblock
20864 #: ../fuse/guestmount.pod:276
20865 msgid "Display the program version and exit."
20866 msgstr ""
20867
20868 #. type: textblock
20869 #: ../fuse/guestmount.pod:285 ../fuse/guestmount.pod:308 ../rescue/virt-rescue.pod:238 ../rescue/virt-rescue.pod:321
20870 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
20871 msgstr ""
20872
20873 #. type: =item
20874 #: ../fuse/guestmount.pod:289
20875 msgid "B<--trace>"
20876 msgstr ""
20877
20878 #. type: textblock
20879 #: ../fuse/guestmount.pod:291
20880 msgid "Trace libguestfs calls and entry into each FUSE function."
20881 msgstr ""
20882
20883 #. type: textblock
20884 #: ../fuse/guestmount.pod:293
20885 msgid "This also stops the daemon from forking into the background."
20886 msgstr ""
20887
20888 #. type: textblock
20889 #: ../fuse/guestmount.pod:319
20890 msgid ""
20891 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
20892 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
20893 "L<http://fuse.sf.net/>."
20894 msgstr ""
20895
20896 #. type: textblock
20897 #: ../fuse/guestmount.pod:334
20898 msgid "Copyright (C) 2009-2010 Red Hat Inc.  L<http://libguestfs.org/>"
20899 msgstr ""
20900
20901 #. type: textblock
20902 #: ../inspector/virt-inspector.pod:5
20903 msgid ""
20904 "virt-inspector - Display operating system version and other information "
20905 "about a virtual machine"
20906 msgstr ""
20907
20908 #. type: verbatim
20909 #: ../inspector/virt-inspector.pod:9
20910 #, no-wrap
20911 msgid ""
20912 " virt-inspector [--options] -d domname\n"
20913 "\n"
20914 msgstr ""
20915
20916 #. type: verbatim
20917 #: ../inspector/virt-inspector.pod:11
20918 #, no-wrap
20919 msgid ""
20920 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
20921 "\n"
20922 msgstr ""
20923
20924 #. type: verbatim
20925 #: ../inspector/virt-inspector.pod:15
20926 #, no-wrap
20927 msgid ""
20928 " virt-inspector domname\n"
20929 "\n"
20930 msgstr ""
20931
20932 #. type: verbatim
20933 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:148
20934 #, no-wrap
20935 msgid ""
20936 " virt-inspector disk.img [disk.img ...]\n"
20937 "\n"
20938 msgstr ""
20939
20940 #. type: textblock
20941 #: ../inspector/virt-inspector.pod:21
20942 msgid ""
20943 "B<virt-inspector> examines a virtual machine or disk image and tries to "
20944 "determine the version of the operating system and other information about "
20945 "the virtual machine."
20946 msgstr ""
20947
20948 #. type: textblock
20949 #: ../inspector/virt-inspector.pod:25
20950 msgid "Virt-inspector produces XML output for feeding into other programs."
20951 msgstr ""
20952
20953 #. type: textblock
20954 #: ../inspector/virt-inspector.pod:27
20955 msgid ""
20956 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
20957 "the libvirt domain (see: C<virsh list --all>)."
20958 msgstr ""
20959
20960 #. type: textblock
20961 #: ../inspector/virt-inspector.pod:30
20962 msgid ""
20963 "You can also run virt-inspector directly on disk images from a single "
20964 "virtual machine.  Use C<virt-inspector -a disk.img>.  In rare cases a domain "
20965 "has several block devices, in which case you should list several I<-a> "
20966 "options one after another, with the first corresponding to the guest's "
20967 "C</dev/sda>, the second to the guest's C</dev/sdb> and so on."
20968 msgstr ""
20969
20970 #. type: textblock
20971 #: ../inspector/virt-inspector.pod:37
20972 msgid ""
20973 "You can also run virt-inspector on install disks, live CDs, bootable USB "
20974 "keys and similar."
20975 msgstr ""
20976
20977 #. type: textblock
20978 #: ../inspector/virt-inspector.pod:40
20979 msgid ""
20980 "Virt-inspector can only inspect and report upon I<one domain at a time>.  To "
20981 "inspect several virtual machines, you have to run virt-inspector several "
20982 "times (for example, from a shell script for-loop)."
20983 msgstr ""
20984
20985 #. type: textblock
20986 #: ../inspector/virt-inspector.pod:45
20987 msgid ""
20988 "Because virt-inspector needs direct access to guest images, it won't "
20989 "normally work over remote libvirt connections."
20990 msgstr ""
20991
20992 #. type: textblock
20993 #: ../inspector/virt-inspector.pod:48
20994 msgid ""
20995 "All of the information available from virt-inspector is also available "
20996 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>).  "
20997 "The same information can also be fetched using guestfish or via libguestfs "
20998 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
20999 "WITH OTHER PROGRAMMING LANGUAGES>)."
21000 msgstr ""
21001
21002 #. type: textblock
21003 #: ../inspector/virt-inspector.pod:81
21004 msgid ""
21005 "Libvirt is only used if you specify a C<domname> on the command line.  If "
21006 "you specify guest block devices directly (I<-a>), then libvirt is not used "
21007 "at all."
21008 msgstr ""
21009
21010 #. type: textblock
21011 #: ../inspector/virt-inspector.pod:94
21012 msgid ""
21013 "When prompting for keys and passphrases, virt-inspector normally turns "
21014 "echoing off so you cannot see what you are typing.  If you are not worried "
21015 "about Tempest attacks and there is no one else in the room you can specify "
21016 "this flag to see what you are typing."
21017 msgstr ""
21018
21019 #. type: textblock
21020 #: ../inspector/virt-inspector.pod:103 ../tools/virt-list-filesystems.pl:93 ../tools/virt-list-partitions.pl:94 ../tools/virt-tar.pl:143 ../tools/virt-win-reg.pl:144
21021 msgid ""
21022 "Specify the format of disk images given on the command line.  If this is "
21023 "omitted then the format is autodetected from the content of the disk image."
21024 msgstr ""
21025
21026 #. type: textblock
21027 #: ../inspector/virt-inspector.pod:107 ../tools/virt-list-filesystems.pl:97 ../tools/virt-list-partitions.pl:98 ../tools/virt-tar.pl:147 ../tools/virt-win-reg.pl:148
21028 msgid ""
21029 "If disk images are requested from libvirt, then this program asks libvirt "
21030 "for this information.  In this case, the value of the format parameter is "
21031 "ignored."
21032 msgstr ""
21033
21034 #. type: textblock
21035 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:391 ../resize/virt-resize.pod:483 ../sparsify/virt-sparsify.pod:132 ../tools/virt-list-filesystems.pl:101 ../tools/virt-list-partitions.pl:102 ../tools/virt-tar.pl:151 ../tools/virt-win-reg.pl:152
21036 msgid ""
21037 "If working with untrusted raw-format guest disk images, you should ensure "
21038 "the format is always specified."
21039 msgstr ""
21040
21041 #. type: =item
21042 #: ../inspector/virt-inspector.pod:135
21043 msgid "B<--xpath> query"
21044 msgstr ""
21045
21046 #. type: textblock
21047 #: ../inspector/virt-inspector.pod:137
21048 msgid ""
21049 "Perform an XPath query on the XML on stdin, and print the result on stdout.  "
21050 "In this mode virt-inspector simply runs an XPath query; all other inspection "
21051 "functions are disabled.  See L</XPATH QUERIES> below for some examples."
21052 msgstr ""
21053
21054 #. type: textblock
21055 #: ../inspector/virt-inspector.pod:146
21056 msgid "Previous versions of virt-inspector allowed you to write either:"
21057 msgstr ""
21058
21059 #. type: verbatim
21060 #: ../inspector/virt-inspector.pod:152
21061 #, no-wrap
21062 msgid ""
21063 " virt-inspector guestname\n"
21064 "\n"
21065 msgstr ""
21066
21067 #. type: =head1
21068 #: ../inspector/virt-inspector.pod:160
21069 msgid "XML FORMAT"
21070 msgstr ""
21071
21072 #. type: textblock
21073 #: ../inspector/virt-inspector.pod:162
21074 msgid ""
21075 "The virt-inspector XML is described precisely in a RELAX NG schema file "
21076 "C<virt-inspector.rng> which is supplied with libguestfs.  This section is "
21077 "just an overview."
21078 msgstr ""
21079
21080 #. type: textblock
21081 #: ../inspector/virt-inspector.pod:166
21082 msgid ""
21083 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
21084 "more E<lt>operatingsystemE<gt> elements.  You would only see more than one "
21085 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
21086 "which is vanishingly rare in real world VMs."
21087 msgstr ""
21088
21089 #. type: =head2
21090 #: ../inspector/virt-inspector.pod:171
21091 msgid "E<lt>operatingsystemE<gt>"
21092 msgstr ""
21093
21094 #. type: textblock
21095 #: ../inspector/virt-inspector.pod:173
21096 msgid ""
21097 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
21098 "describe the operating system, its architecture, the descriptive \"product "
21099 "name\" string, the type of OS and so on, as in this example:"
21100 msgstr ""
21101
21102 #. type: verbatim
21103 #: ../inspector/virt-inspector.pod:177
21104 #, no-wrap
21105 msgid ""
21106 " <operatingsystems>\n"
21107 "   <operatingsystem>\n"
21108 "     <root>/dev/sda2</root>\n"
21109 "     <name>windows</name>\n"
21110 "     <arch>i386</arch>\n"
21111 "     <distro>windows</distro>\n"
21112 "     <product_name>Windows 7 Enterprise</product_name>\n"
21113 "     <product_variant>Client</product_variant>\n"
21114 "     <major_version>6</major_version>\n"
21115 "     <minor_version>1</minor_version>\n"
21116 "     <windows_systemroot>/Windows</windows_systemroot>\n"
21117 "     <format>installed</format>\n"
21118 "\n"
21119 msgstr ""
21120
21121 #. type: textblock
21122 #: ../inspector/virt-inspector.pod:190
21123 msgid ""
21124 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
21125 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
21126 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
21127 "architecture.  The other fields are fairly self-explanatory, but because "
21128 "these fields are taken directly from the libguestfs inspection API you can "
21129 "find precise information from L<guestfs(3)/INSPECTION>."
21130 msgstr ""
21131
21132 #. type: textblock
21133 #: ../inspector/virt-inspector.pod:198
21134 msgid ""
21135 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
21136 "of view of libguestfs (block devices may have completely different names "
21137 "inside the VM itself)."
21138 msgstr ""
21139
21140 #. type: =head2
21141 #: ../inspector/virt-inspector.pod:202
21142 msgid "E<lt>mountpointsE<gt>"
21143 msgstr ""
21144
21145 #. type: textblock
21146 #: ../inspector/virt-inspector.pod:204
21147 msgid ""
21148 "Un*x-like guests typically have multiple filesystems which are mounted at "
21149 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
21150 "element which looks like this:"
21151 msgstr ""
21152
21153 #. type: verbatim
21154 #: ../inspector/virt-inspector.pod:208
21155 #, no-wrap
21156 msgid ""
21157 " <operatingsystems>\n"
21158 "   <operatingsystem>\n"
21159 "     ...\n"
21160 "     <mountpoints>\n"
21161 "       <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
21162 "       <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
21163 "     </mountpoints>\n"
21164 "\n"
21165 msgstr ""
21166
21167 #. type: textblock
21168 #: ../inspector/virt-inspector.pod:216
21169 msgid ""
21170 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
21171 "and may have completely different names inside the guest.  Only mountable "
21172 "filesystems appear in this list, not things like swap devices."
21173 msgstr ""
21174
21175 #. type: =head2
21176 #: ../inspector/virt-inspector.pod:221
21177 msgid "E<lt>filesystemsE<gt>"
21178 msgstr ""
21179
21180 #. type: textblock
21181 #: ../inspector/virt-inspector.pod:223
21182 msgid ""
21183 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
21184 "filesystems belonging to the guest, including swap and empty partitions.  "
21185 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
21186 "this OS or shared with this OS and other OSes)."
21187 msgstr ""
21188
21189 #. type: textblock
21190 #: ../inspector/virt-inspector.pod:229
21191 msgid "You might see something like this:"
21192 msgstr ""
21193
21194 #. type: verbatim
21195 #: ../inspector/virt-inspector.pod:231
21196 #, no-wrap
21197 msgid ""
21198 " <operatingsystems>\n"
21199 "   <operatingsystem>\n"
21200 "     ...\n"
21201 "     <filesystems>\n"
21202 "       <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
21203 "         <type>ext4</type>\n"
21204 "         <label>Fedora-13-x86_64</label>\n"
21205 "         <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
21206 "       </filesystem>\n"
21207 "\n"
21208 msgstr ""
21209
21210 #. type: textblock
21211 #: ../inspector/virt-inspector.pod:241
21212 msgid ""
21213 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
21214 "the label, and the UUID."
21215 msgstr ""
21216
21217 #. type: =head2
21218 #: ../inspector/virt-inspector.pod:244
21219 msgid "E<lt>applicationsE<gt>"
21220 msgstr ""
21221
21222 #. type: textblock
21223 #: ../inspector/virt-inspector.pod:246
21224 msgid ""
21225 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
21226 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
21227 "machine."
21228 msgstr ""
21229
21230 #. type: textblock
21231 #: ../inspector/virt-inspector.pod:250
21232 msgid ""
21233 "E<lt>package_formatE<gt>, if present, describes the packaging system used.  "
21234 "Typical values would be C<rpm> and C<deb>."
21235 msgstr ""
21236
21237 #. type: textblock
21238 #: ../inspector/virt-inspector.pod:253
21239 msgid ""
21240 "E<lt>package_managementE<gt>, if present, describes the package manager.  "
21241 "Typical values include C<yum>, C<up2date> and C<apt>"
21242 msgstr ""
21243
21244 #. type: textblock
21245 #: ../inspector/virt-inspector.pod:256
21246 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
21247 msgstr ""
21248
21249 #. type: verbatim
21250 #: ../inspector/virt-inspector.pod:259
21251 #, no-wrap
21252 msgid ""
21253 " <operatingsystems>\n"
21254 "   <operatingsystem>\n"
21255 "     ...\n"
21256 "     <applications>\n"
21257 "       <application>\n"
21258 "         <name>coreutils</name>\n"
21259 "         <version>8.5</version>\n"
21260 "         <release>1</release>\n"
21261 "       </application>\n"
21262 "\n"
21263 msgstr ""
21264
21265 #. type: textblock
21266 #: ../inspector/virt-inspector.pod:269
21267 msgid ""
21268 "The version and release fields may not be available for some types guests.  "
21269 "Other fields are possible, see "
21270 "L<guestfs(3)/guestfs_inspect_list_applications>."
21271 msgstr ""
21272
21273 #. type: =head2
21274 #: ../inspector/virt-inspector.pod:273
21275 msgid "E<lt>drive_mappingsE<gt>"
21276 msgstr ""
21277
21278 #. type: textblock
21279 #: ../inspector/virt-inspector.pod:275
21280 msgid ""
21281 "For operating systems like Windows which use drive letters, virt-inspector "
21282 "is able to find out how drive letters map to filesystems."
21283 msgstr ""
21284
21285 #. type: verbatim
21286 #: ../inspector/virt-inspector.pod:279
21287 #, no-wrap
21288 msgid ""
21289 " <operatingsystems>\n"
21290 "   <operatingsystem>\n"
21291 "     ...\n"
21292 "     <drive_mappings>\n"
21293 "       <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
21294 "       <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
21295 "     </drive_mappings>\n"
21296 "\n"
21297 msgstr ""
21298
21299 #. type: textblock
21300 #: ../inspector/virt-inspector.pod:287
21301 msgid ""
21302 "In the example above, drive C maps to the filesystem on the second partition "
21303 "on the first disk, and drive E maps to the filesystem on the first partition "
21304 "on the second disk."
21305 msgstr ""
21306
21307 #. type: textblock
21308 #: ../inspector/virt-inspector.pod:291
21309 msgid ""
21310 "Note that this only covers permanent local filesystem mappings, not things "
21311 "like network shares.  Furthermore NTFS volume mount points may not be listed "
21312 "here."
21313 msgstr ""
21314
21315 #. type: =head2
21316 #: ../inspector/virt-inspector.pod:295
21317 msgid "E<lt>iconE<gt>"
21318 msgstr ""
21319
21320 #. type: textblock
21321 #: ../inspector/virt-inspector.pod:297
21322 msgid ""
21323 "Virt-inspector is sometimes able to extract an icon or logo for the guest.  "
21324 "The icon is returned as base64-encoded PNG data.  Note that the icon can be "
21325 "very large and high quality."
21326 msgstr ""
21327
21328 #. type: verbatim
21329 #: ../inspector/virt-inspector.pod:301
21330 #, no-wrap
21331 msgid ""
21332 " <operatingsystems>\n"
21333 "   <operatingsystem>\n"
21334 "     ...\n"
21335 "     <icon>\n"
21336 "       iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
21337 "       [... many lines of base64 data ...]\n"
21338 "     </icon>\n"
21339 "\n"
21340 msgstr ""
21341
21342 #. type: textblock
21343 #: ../inspector/virt-inspector.pod:309
21344 msgid ""
21345 "To display the icon, you have to extract it and convert the base64 data back "
21346 "to a binary file.  Use an XPath query or simply an editor to extract the "
21347 "data, then use the coreutils L<base64(1)> program to do the conversion back "
21348 "to a PNG file:"
21349 msgstr ""
21350
21351 #. type: verbatim
21352 #: ../inspector/virt-inspector.pod:314
21353 #, no-wrap
21354 msgid ""
21355 " base64 -i -d < icon.data > icon.png\n"
21356 "\n"
21357 msgstr ""
21358
21359 #. type: =head2
21360 #: ../inspector/virt-inspector.pod:316
21361 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
21362 msgstr ""
21363
21364 #. type: textblock
21365 #: ../inspector/virt-inspector.pod:318
21366 msgid ""
21367 "Virt-inspector can detect some operating system installers on install disks, "
21368 "live CDs, bootable USB keys and more."
21369 msgstr ""
21370
21371 #. type: textblock
21372 #: ../inspector/virt-inspector.pod:321
21373 msgid ""
21374 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
21375 "fields may be present to indicate a live CD, network installer, or one part "
21376 "of a multipart CD.  For example:"
21377 msgstr ""
21378
21379 #. type: verbatim
21380 #: ../inspector/virt-inspector.pod:325
21381 #, no-wrap
21382 msgid ""
21383 " <operatingsystems>\n"
21384 "   <operatingsystem>\n"
21385 "     <root>/dev/sda</root>\n"
21386 "     <name>linux</name>\n"
21387 "     <arch>i386</arch>\n"
21388 "     <distro>ubuntu</distro>\n"
21389 "     <product_name>Ubuntu 10.10 &quot;Maverick "
21390 "Meerkat&quot;</product_name>\n"
21391 "     <major_version>10</major_version>\n"
21392 "     <minor_version>10</minor_version>\n"
21393 "     <format>installer</format>\n"
21394 "     <live/>\n"
21395 "\n"
21396 msgstr ""
21397
21398 #. type: =head1
21399 #: ../inspector/virt-inspector.pod:337
21400 msgid "XPATH QUERIES"
21401 msgstr ""
21402
21403 #. type: textblock
21404 #: ../inspector/virt-inspector.pod:339
21405 msgid ""
21406 "Virt-inspector includes built in support for running XPath queries.  The "
21407 "reason for including XPath support directly in virt-inspector is simply that "
21408 "there are no good and widely available command line programs that can do "
21409 "XPath queries.  The only good one is L<xmlstarlet(1)> and that is not "
21410 "available on Red Hat Enterprise Linux."
21411 msgstr ""
21412
21413 #. type: textblock
21414 #: ../inspector/virt-inspector.pod:346
21415 msgid ""
21416 "To perform an XPath query, use the I<--xpath> option.  Note that in this "
21417 "mode, virt-inspector simply reads XML from stdin and outputs the query "
21418 "result on stdout.  All other inspection features are disabled in this mode."
21419 msgstr ""
21420
21421 #. type: verbatim
21422 #: ../inspector/virt-inspector.pod:353
21423 #, no-wrap
21424 msgid ""
21425 " $ virt-inspector -d Guest | virt-inspector --xpath '//filesystems'\n"
21426 " <filesystems>\n"
21427 "      <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
21428 "        <type>ext4</type>\n"
21429 " [...]\n"
21430 "\n"
21431 msgstr ""
21432
21433 #. type: verbatim
21434 #: ../inspector/virt-inspector.pod:359
21435 #, no-wrap
21436 msgid ""
21437 " $ virt-inspector -d Guest | \\\n"
21438 "     virt-inspector --xpath "
21439 "\"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
21440 " ext4\n"
21441 "\n"
21442 msgstr ""
21443
21444 #. type: verbatim
21445 #: ../inspector/virt-inspector.pod:363
21446 #, no-wrap
21447 msgid ""
21448 " $ virt-inspector -d Guest | \\\n"
21449 "     virt-inspector --xpath 'string(//icon)' | base64 -i -d | display -\n"
21450 " [displays the guest icon, if there is one]\n"
21451 "\n"
21452 msgstr ""
21453
21454 #. type: =head1
21455 #: ../inspector/virt-inspector.pod:374
21456 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
21457 msgstr ""
21458
21459 #. type: textblock
21460 #: ../inspector/virt-inspector.pod:376
21461 msgid ""
21462 "Early versions of libguestfs shipped with a different virt-inspector program "
21463 "written in Perl (the current version is written in C).  The XML output of "
21464 "the Perl virt-inspector was different and it could also output in other "
21465 "formats like text."
21466 msgstr ""
21467
21468 #. type: textblock
21469 #: ../inspector/virt-inspector.pod:381
21470 msgid "The old virt-inspector is no longer supported or shipped with libguestfs."
21471 msgstr ""
21472
21473 #. type: textblock
21474 #: ../inspector/virt-inspector.pod:384
21475 msgid ""
21476 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
21477 "versions of virt-inspector with different names:"
21478 msgstr ""
21479
21480 #. type: verbatim
21481 #: ../inspector/virt-inspector.pod:387
21482 #, no-wrap
21483 msgid ""
21484 " virt-inspector     Old Perl version.\n"
21485 " virt-inspector2    New C version.\n"
21486 "\n"
21487 msgstr ""
21488
21489 #. type: textblock
21490 #: ../inspector/virt-inspector.pod:397
21491 msgid ""
21492 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, "
21493 "L<base64(1)>, L<xmlstarlet(1)>, L<http://libguestfs.org/>."
21494 msgstr ""
21495
21496 #. type: textblock
21497 #: ../inspector/virt-inspector.pod:414
21498 msgid "Matthew Booth L<mbooth@redhat.com>"
21499 msgstr ""
21500
21501 #. type: textblock
21502 #: ../java/examples/guestfs-java.pod:5
21503 msgid "guestfs-java - How to use libguestfs from Java"
21504 msgstr ""
21505
21506 #. type: verbatim
21507 #: ../java/examples/guestfs-java.pod:9
21508 #, no-wrap
21509 msgid ""
21510 " import com.redhat.et.libguestfs.*;\n"
21511 " \n"
21512 msgstr ""
21513
21514 #. type: verbatim
21515 #: ../java/examples/guestfs-java.pod:11
21516 #, no-wrap
21517 msgid ""
21518 " GuestFS g = new GuestFS ();\n"
21519 " g.add_drive_opts (\"disk.img\", null);\n"
21520 " g.launch ();\n"
21521 "\n"
21522 msgstr ""
21523
21524 #. type: textblock
21525 #: ../java/examples/guestfs-java.pod:17
21526 msgid ""
21527 "This manual page documents how to call libguestfs from the Java programming "
21528 "language.  This page just documents the differences from the C API and gives "
21529 "some examples.  If you are not familiar with using libguestfs, you also need "
21530 "to read L<guestfs(3)>."
21531 msgstr ""
21532
21533 #. type: =head2
21534 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
21535 msgid "CLOSING THE HANDLE"
21536 msgstr ""
21537
21538 #. type: textblock
21539 #: ../java/examples/guestfs-java.pod:24
21540 msgid ""
21541 "The handle is closed when it is reaped by the garbage collector.  Because "
21542 "libguestfs handles include a lot of state, it is also possible to close (and "
21543 "hence free) them explicitly by calling the C<close> method."
21544 msgstr ""
21545
21546 #. type: =head2
21547 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60 ../python/examples/guestfs-python.pod:21 ../ruby/examples/guestfs-ruby.pod:22
21548 msgid "EXCEPTIONS"
21549 msgstr ""
21550
21551 #. type: textblock
21552 #: ../java/examples/guestfs-java.pod:31
21553 msgid ""
21554 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
21555 "exception.  This has a single parameter which is the error message (a "
21556 "C<String>)."
21557 msgstr ""
21558
21559 #. type: textblock
21560 #: ../java/examples/guestfs-java.pod:35
21561 msgid "Calling any method on a closed handle raises the same exception."
21562 msgstr ""
21563
21564 #. type: textblock
21565 #: ../java/examples/guestfs-java.pod:47
21566 msgid ""
21567 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
21568 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
21569 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>, "
21570 "L<http://caml.inria.fr/>."
21571 msgstr ""
21572
21573 #. type: textblock
21574 #: ../ocaml/examples/guestfs-ocaml.pod:5
21575 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
21576 msgstr ""
21577
21578 #. type: textblock
21579 #: ../ocaml/examples/guestfs-ocaml.pod:9
21580 msgid "Module style:"
21581 msgstr ""
21582
21583 #. type: verbatim
21584 #: ../ocaml/examples/guestfs-ocaml.pod:11
21585 #, no-wrap
21586 msgid ""
21587 " let g = Guestfs.create () in\n"
21588 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
21589 " Guestfs.launch g;\n"
21590 "\n"
21591 msgstr ""
21592
21593 #. type: textblock
21594 #: ../ocaml/examples/guestfs-ocaml.pod:15
21595 msgid "Object-oriented style:"
21596 msgstr ""
21597
21598 #. type: verbatim
21599 #: ../ocaml/examples/guestfs-ocaml.pod:17
21600 #, no-wrap
21601 msgid ""
21602 " let g = new Guestfs.guestfs () in\n"
21603 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
21604 " g#launch ();\n"
21605 "\n"
21606 msgstr ""
21607
21608 #. type: verbatim
21609 #: ../ocaml/examples/guestfs-ocaml.pod:21
21610 #, no-wrap
21611 msgid ""
21612 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
21613 "or:\n"
21614 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
21615 "\n"
21616 msgstr ""
21617
21618 #. type: textblock
21619 #: ../ocaml/examples/guestfs-ocaml.pod:27
21620 msgid ""
21621 "This manual page documents how to call libguestfs from the OCaml programming "
21622 "language.  This page just documents the differences from the C API and gives "
21623 "some examples.  If you are not familiar with using libguestfs, you also need "
21624 "to read L<guestfs(3)>."
21625 msgstr ""
21626
21627 #. type: =head2
21628 #: ../ocaml/examples/guestfs-ocaml.pod:32
21629 msgid "PROGRAMMING STYLES"
21630 msgstr ""
21631
21632 #. type: textblock
21633 #: ../ocaml/examples/guestfs-ocaml.pod:34
21634 msgid ""
21635 "There are two different programming styles supported by the OCaml bindings.  "
21636 "You can use a module style, with each C function mapped to an OCaml "
21637 "function:"
21638 msgstr ""
21639
21640 #. type: verbatim
21641 #: ../ocaml/examples/guestfs-ocaml.pod:38
21642 #, no-wrap
21643 msgid ""
21644 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
21645 "\n"
21646 msgstr ""
21647
21648 #. type: textblock
21649 #: ../ocaml/examples/guestfs-ocaml.pod:40
21650 msgid "becomes:"
21651 msgstr ""
21652
21653 #. type: verbatim
21654 #: ../ocaml/examples/guestfs-ocaml.pod:42
21655 #, no-wrap
21656 msgid ""
21657 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
21658 "\n"
21659 msgstr ""
21660
21661 #. type: textblock
21662 #: ../ocaml/examples/guestfs-ocaml.pod:44
21663 msgid ""
21664 "Alternately you can use an object-oriented style, calling methods on the "
21665 "class C<Guestfs.guestfs>:"
21666 msgstr ""
21667
21668 #. type: verbatim
21669 #: ../ocaml/examples/guestfs-ocaml.pod:47
21670 #, no-wrap
21671 msgid ""
21672 " method set_verbose : bool -> unit\n"
21673 "\n"
21674 msgstr ""
21675
21676 #. type: textblock
21677 #: ../ocaml/examples/guestfs-ocaml.pod:49
21678 msgid ""
21679 "The object-oriented style is usually briefer, and the minor performance "
21680 "penalty isn't noticable in the general overhead of performing libguestfs "
21681 "functions."
21682 msgstr ""
21683
21684 #. type: textblock
21685 #: ../ocaml/examples/guestfs-ocaml.pod:55
21686 msgid ""
21687 "The handle is closed when it is reaped by the garbage collector.  Because "
21688 "libguestfs handles include a lot of state, it is also possible to close (and "
21689 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
21690 "method."
21691 msgstr ""
21692
21693 #. type: textblock
21694 #: ../ocaml/examples/guestfs-ocaml.pod:62
21695 msgid ""
21696 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
21697 "exception.  This has a single parameter which is the error message (a "
21698 "string)."
21699 msgstr ""
21700
21701 #. type: textblock
21702 #: ../ocaml/examples/guestfs-ocaml.pod:66
21703 msgid ""
21704 "Calling any function/method on a closed handle raises "
21705 "C<Guestfs.Handle_closed>.  The single parameter is the name of the function "
21706 "that you called."
21707 msgstr ""
21708
21709 #. type: textblock
21710 #: ../ocaml/examples/guestfs-ocaml.pod:80
21711 msgid ""
21712 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
21713 "L<guestfs-java(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
21714 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>, "
21715 "L<http://caml.inria.fr/>."
21716 msgstr ""
21717
21718 #. type: textblock
21719 #: ../perl/examples/guestfs-perl.pod:5
21720 msgid "guestfs-perl - How to use libguestfs from Perl"
21721 msgstr ""
21722
21723 #. type: verbatim
21724 #: ../perl/examples/guestfs-perl.pod:9
21725 #, no-wrap
21726 msgid ""
21727 " use Sys::Guestfs;\n"
21728 " \n"
21729 msgstr ""
21730
21731 #. type: verbatim
21732 #: ../perl/examples/guestfs-perl.pod:11
21733 #, no-wrap
21734 msgid ""
21735 " my $h = Sys::Guestfs->new ();\n"
21736 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
21737 " $h->launch ();\n"
21738 " $h->mount_options ('', '/dev/sda1', '/');\n"
21739 " $h->touch ('/hello');\n"
21740 " $h->sync ();\n"
21741 "\n"
21742 msgstr ""
21743
21744 #. type: textblock
21745 #: ../perl/examples/guestfs-perl.pod:20
21746 msgid ""
21747 "This manual page documents how to call libguestfs from the Perl programming "
21748 "language.  This page just documents the differences from the C API and gives "
21749 "some examples.  If you are not familiar with using libguestfs, you also need "
21750 "to read L<guestfs(3)>.  To read the full Perl API, see L<Sys::Guestfs(3)>."
21751 msgstr ""
21752
21753 #. type: =head2
21754 #: ../perl/examples/guestfs-perl.pod:26
21755 msgid "ERRORS"
21756 msgstr ""
21757
21758 #. type: textblock
21759 #: ../perl/examples/guestfs-perl.pod:28
21760 msgid ""
21761 "Errors from libguestfs functions turn into calls to C<croak> (see "
21762 "L<Carp(3)>)."
21763 msgstr ""
21764
21765 #. type: textblock
21766 #: ../perl/examples/guestfs-perl.pod:41
21767 msgid ""
21768 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, "
21769 "L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
21770 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, "
21771 "L<http://libguestfs.org/>."
21772 msgstr ""
21773
21774 #. type: textblock
21775 #: ../python/examples/guestfs-python.pod:5
21776 msgid "guestfs-python - How to use libguestfs from Python"
21777 msgstr ""
21778
21779 #. type: verbatim
21780 #: ../python/examples/guestfs-python.pod:9
21781 #, no-wrap
21782 msgid ""
21783 " import guestfs\n"
21784 " g = guestfs.GuestFS ()\n"
21785 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
21786 " g.launch\n"
21787 "\n"
21788 msgstr ""
21789
21790 #. type: textblock
21791 #: ../python/examples/guestfs-python.pod:16
21792 msgid ""
21793 "This manual page documents how to call libguestfs from the Python "
21794 "programming language.  This page just documents the differences from the C "
21795 "API and gives some examples.  If you are not familiar with using libguestfs, "
21796 "you also need to read L<guestfs(3)>."
21797 msgstr ""
21798
21799 #. type: textblock
21800 #: ../python/examples/guestfs-python.pod:23
21801 msgid ""
21802 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
21803 "single string argument which is the error message."
21804 msgstr ""
21805
21806 #. type: =head2
21807 #: ../python/examples/guestfs-python.pod:26
21808 msgid "MORE DOCUMENTATION"
21809 msgstr ""
21810
21811 #. type: textblock
21812 #: ../python/examples/guestfs-python.pod:28
21813 msgid "Type:"
21814 msgstr ""
21815
21816 #. type: verbatim
21817 #: ../python/examples/guestfs-python.pod:30
21818 #, no-wrap
21819 msgid ""
21820 " $ python\n"
21821 " >>> import guestfs\n"
21822 " >>> help (guestfs)\n"
21823 "\n"
21824 msgstr ""
21825
21826 #. type: textblock
21827 #: ../python/examples/guestfs-python.pod:44
21828 msgid ""
21829 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
21830 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
21831 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
21832 msgstr ""
21833
21834 #. type: textblock
21835 #: ../rescue/virt-rescue.pod:5
21836 msgid "virt-rescue - Run a rescue shell on a virtual machine"
21837 msgstr ""
21838
21839 #. type: verbatim
21840 #: ../rescue/virt-rescue.pod:9
21841 #, no-wrap
21842 msgid ""
21843 " virt-rescue [--options] -d domname\n"
21844 "\n"
21845 msgstr ""
21846
21847 #. type: verbatim
21848 #: ../rescue/virt-rescue.pod:11
21849 #, no-wrap
21850 msgid ""
21851 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
21852 "\n"
21853 msgstr ""
21854
21855 #. type: verbatim
21856 #: ../rescue/virt-rescue.pod:13
21857 #, no-wrap
21858 msgid ""
21859 " virt-rescue --suggest (-d domname | -a disk.img ...)\n"
21860 "\n"
21861 msgstr ""
21862
21863 #. type: verbatim
21864 #: ../rescue/virt-rescue.pod:17
21865 #, no-wrap
21866 msgid ""
21867 " virt-rescue [--options] domname\n"
21868 "\n"
21869 msgstr ""
21870
21871 #. type: verbatim
21872 #: ../rescue/virt-rescue.pod:19
21873 #, no-wrap
21874 msgid ""
21875 " virt-rescue [--options] disk.img [disk.img ...]\n"
21876 "\n"
21877 msgstr ""
21878
21879 #. type: textblock
21880 #: ../rescue/virt-rescue.pod:23
21881 msgid ""
21882 "You must I<not> use C<virt-rescue> on live virtual machines.  Doing so will "
21883 "probably result in disk corruption in the VM.  C<virt-rescue> tries to stop "
21884 "you from doing this, but doesn't catch all cases."
21885 msgstr ""
21886
21887 #. type: textblock
21888 #: ../rescue/virt-rescue.pod:27
21889 msgid ""
21890 "However if you use the I<--ro> (read only) option, then you can attach a "
21891 "shell to a live virtual machine.  The results might be strange or "
21892 "inconsistent at times but you won't get disk corruption."
21893 msgstr ""
21894
21895 #. type: textblock
21896 #: ../rescue/virt-rescue.pod:33
21897 msgid ""
21898 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
21899 "need for a CD.  virt-rescue gives you a rescue shell and some simple "
21900 "recovery tools which you can use to examine or rescue a virtual machine or "
21901 "disk image."
21902 msgstr ""
21903
21904 #. type: textblock
21905 #: ../rescue/virt-rescue.pod:38
21906 msgid ""
21907 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
21908 "on disk image(s):"
21909 msgstr ""
21910
21911 #. type: verbatim
21912 #: ../rescue/virt-rescue.pod:41
21913 #, no-wrap
21914 msgid ""
21915 " virt-rescue -d GuestName\n"
21916 "\n"
21917 msgstr ""
21918
21919 #. type: verbatim
21920 #: ../rescue/virt-rescue.pod:43
21921 #, no-wrap
21922 msgid ""
21923 " virt-rescue --ro -a /path/to/disk.img\n"
21924 "\n"
21925 msgstr ""
21926
21927 #. type: verbatim
21928 #: ../rescue/virt-rescue.pod:45
21929 #, no-wrap
21930 msgid ""
21931 " virt-rescue -a /dev/sdc\n"
21932 "\n"
21933 msgstr ""
21934
21935 #. type: textblock
21936 #: ../rescue/virt-rescue.pod:47
21937 msgid "For live VMs you I<must> use the --ro option."
21938 msgstr ""
21939
21940 #. type: textblock
21941 #: ../rescue/virt-rescue.pod:49
21942 msgid ""
21943 "When you run virt-rescue on a virtual machine or disk image, you are placed "
21944 "in an interactive bash shell where you can use many ordinary Linux "
21945 "commands.  What you see in C</> (C</bin>, C</lib> etc) is the rescue "
21946 "appliance.  You must mount the virtual machine's filesystems by hand.  There "
21947 "is an empty directory called C</sysroot> where you can mount filesystems."
21948 msgstr ""
21949
21950 #. type: textblock
21951 #: ../rescue/virt-rescue.pod:56
21952 msgid ""
21953 "You can get virt-rescue to suggest mount commands for you by using the "
21954 "I<--suggest> option (in another terminal):"
21955 msgstr ""
21956
21957 #. type: verbatim
21958 #: ../rescue/virt-rescue.pod:59
21959 #, no-wrap
21960 msgid ""
21961 " $ virt-rescue --suggest -d Fedora15\n"
21962 " Inspecting the virtual machine or disk image ...\n"
21963 " \n"
21964 msgstr ""
21965
21966 #. type: verbatim
21967 #: ../rescue/virt-rescue.pod:62
21968 #, no-wrap
21969 msgid ""
21970 " This disk contains one or more operating systems.  You can use these\n"
21971 " mount commands in virt-rescue (at the ><rescue> prompt) to mount the\n"
21972 " filesystems.\n"
21973 " \n"
21974 msgstr ""
21975
21976 #. type: verbatim
21977 #: ../rescue/virt-rescue.pod:66
21978 #, no-wrap
21979 msgid ""
21980 " # /dev/vg_f15x32/lv_root is the root of a linux operating system\n"
21981 " # type: linux, distro: fedora, version: 15.0\n"
21982 " # Fedora release 15 (Lovelock)\n"
21983 " \n"
21984 msgstr ""
21985
21986 #. type: verbatim
21987 #: ../rescue/virt-rescue.pod:70
21988 #, no-wrap
21989 msgid ""
21990 " mount /dev/vg_f15x32/lv_root /sysroot/\n"
21991 " mount /dev/vda1 /sysroot/boot\n"
21992 " mount --bind /dev /sysroot/dev\n"
21993 " mount --bind /dev/pts /sysroot/dev/pts\n"
21994 " mount --bind /proc /sysroot/proc\n"
21995 " mount --bind /sys /sysroot/sys\n"
21996 "\n"
21997 msgstr ""
21998
21999 #. type: textblock
22000 #: ../rescue/virt-rescue.pod:77
22001 msgid ""
22002 "Another way is to list the logical volumes (with L<lvs(8)>) and partitions "
22003 "(with L<parted(8)>) and mount them by hand:"
22004 msgstr ""
22005
22006 #. type: verbatim
22007 #: ../rescue/virt-rescue.pod:80
22008 #, no-wrap
22009 msgid ""
22010 " ><rescue> lvs\n"
22011 " LV      VG        Attr   LSize   Origin Snap%  Move Log Copy%  Convert\n"
22012 " lv_root vg_f15x32 -wi-a-   8.83G\n"
22013 " lv_swap vg_f15x32 -wi-a- 992.00M\n"
22014 " ><rescue> mount /dev/vg_f15x32/lv_root /sysroot\n"
22015 " ><rescue> mount /dev/vda1 /sysroot/boot\n"
22016 " ><rescue> ls /sysroot\n"
22017 "\n"
22018 msgstr ""
22019
22020 #. type: textblock
22021 #: ../rescue/virt-rescue.pod:88
22022 msgid "Another command to list available filesystems is L<virt-filesystems(1)>."
22023 msgstr ""
22024
22025 #. type: textblock
22026 #: ../rescue/virt-rescue.pod:91
22027 msgid ""
22028 "To run commands in a Linux guest (for example, grub), you should chroot into "
22029 "the /sysroot directory first:"
22030 msgstr ""
22031
22032 #. type: verbatim
22033 #: ../rescue/virt-rescue.pod:94
22034 #, no-wrap
22035 msgid ""
22036 " ><rescue> chroot /sysroot\n"
22037 "\n"
22038 msgstr ""
22039
22040 #. type: textblock
22041 #: ../rescue/virt-rescue.pod:98
22042 msgid ""
22043 "Virt-rescue can be used on I<any> disk image file or device, not just a "
22044 "virtual machine.  For example you can use it on a blank file if you want to "
22045 "partition that file (although we would recommend using L<guestfish(1)> "
22046 "instead as it is more suitable for this purpose).  You can even use "
22047 "virt-rescue on things like SD cards."
22048 msgstr ""
22049
22050 #. type: textblock
22051 #: ../rescue/virt-rescue.pod:104
22052 msgid ""
22053 "Virt-rescue does not require root.  You only need to run it as root if you "
22054 "need root to open the disk image."
22055 msgstr ""
22056
22057 #. type: textblock
22058 #: ../rescue/virt-rescue.pod:107
22059 msgid ""
22060 "This tool is just designed for quick interactive hacking on a virtual "
22061 "machine.  For more structured access to a virtual machine disk image, you "
22062 "should use L<guestfs(3)>.  To get a structured shell that you can use to "
22063 "make scripted changes to guests, use L<guestfish(1)>."
22064 msgstr ""
22065
22066 #. type: =item
22067 #: ../rescue/virt-rescue.pod:131
22068 msgid "B<--append kernelopts>"
22069 msgstr ""
22070
22071 #. type: textblock
22072 #: ../rescue/virt-rescue.pod:133
22073 msgid "Pass additional options to the rescue kernel."
22074 msgstr ""
22075
22076 #. type: verbatim
22077 #: ../rescue/virt-rescue.pod:163
22078 #, no-wrap
22079 msgid ""
22080 " virt-rescue --format=raw -a disk.img\n"
22081 "\n"
22082 msgstr ""
22083
22084 #. type: verbatim
22085 #: ../rescue/virt-rescue.pod:167
22086 #, no-wrap
22087 msgid ""
22088 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
22089 "\n"
22090 msgstr ""
22091
22092 #. type: =item
22093 #: ../rescue/virt-rescue.pod:176
22094 msgid "B<-m MB>"
22095 msgstr ""
22096
22097 #. type: =item
22098 #: ../rescue/virt-rescue.pod:178
22099 msgid "B<--memsize MB>"
22100 msgstr ""
22101
22102 #. type: textblock
22103 #: ../rescue/virt-rescue.pod:180
22104 msgid ""
22105 "Change the amount of memory allocated to the rescue system.  The default is "
22106 "set by libguestfs and is small but adequate for running system tools.  The "
22107 "occasional program might need more memory.  The parameter is specified in "
22108 "megabytes."
22109 msgstr ""
22110
22111 #. type: =item
22112 #: ../rescue/virt-rescue.pod:185
22113 msgid "B<--network>"
22114 msgstr ""
22115
22116 #. type: textblock
22117 #: ../rescue/virt-rescue.pod:187
22118 msgid "Enable QEMU user networking in the guest.  See L</NETWORK>."
22119 msgstr ""
22120
22121 #. type: textblock
22122 #: ../rescue/virt-rescue.pod:193
22123 msgid "Open the image read-only."
22124 msgstr ""
22125
22126 #. type: textblock
22127 #: ../rescue/virt-rescue.pod:203
22128 msgid ""
22129 "Enable SELinux in the rescue appliance.  You should read "
22130 "L<guestfs(3)/SELINUX> before using this option."
22131 msgstr ""
22132
22133 #. type: =item
22134 #: ../rescue/virt-rescue.pod:206
22135 msgid "B<--smp> N"
22136 msgstr ""
22137
22138 #. type: textblock
22139 #: ../rescue/virt-rescue.pod:208
22140 msgid "Enable N E<ge> 2 virtual CPUs in the rescue appliance."
22141 msgstr ""
22142
22143 #. type: =item
22144 #: ../rescue/virt-rescue.pod:210
22145 msgid "B<--suggest>"
22146 msgstr ""
22147
22148 #. type: textblock
22149 #: ../rescue/virt-rescue.pod:212
22150 msgid ""
22151 "Inspect the disk image and suggest what mount commands should be used to "
22152 "mount the disks.  You should use the I<--suggest> option in a second "
22153 "terminal, then paste the commands into another virt-rescue."
22154 msgstr ""
22155
22156 #. type: textblock
22157 #: ../rescue/virt-rescue.pod:216
22158 msgid ""
22159 "This option implies I<--ro> and is safe to use even if the guest is up or if "
22160 "another virt-rescue is running."
22161 msgstr ""
22162
22163 #. type: textblock
22164 #: ../rescue/virt-rescue.pod:235
22165 msgid ""
22166 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
22167 "are done read-write."
22168 msgstr ""
22169
22170 #. type: textblock
22171 #: ../rescue/virt-rescue.pod:248
22172 msgid "Previous versions of virt-rescue allowed you to write either:"
22173 msgstr ""
22174
22175 #. type: verbatim
22176 #: ../rescue/virt-rescue.pod:250
22177 #, no-wrap
22178 msgid ""
22179 " virt-rescue disk.img [disk.img ...]\n"
22180 "\n"
22181 msgstr ""
22182
22183 #. type: verbatim
22184 #: ../rescue/virt-rescue.pod:254
22185 #, no-wrap
22186 msgid ""
22187 " virt-rescue guestname\n"
22188 "\n"
22189 msgstr ""
22190
22191 #. type: =head1
22192 #: ../rescue/virt-rescue.pod:262
22193 msgid "NETWORK"
22194 msgstr ""
22195
22196 #. type: textblock
22197 #: ../rescue/virt-rescue.pod:264
22198 msgid ""
22199 "Adding the I<--network> option enables QEMU user networking in the rescue "
22200 "appliance.  There are some differences between user networking and ordinary "
22201 "networking:"
22202 msgstr ""
22203
22204 #. type: =item
22205 #: ../rescue/virt-rescue.pod:270
22206 msgid "ping does not work"
22207 msgstr ""
22208
22209 #. type: textblock
22210 #: ../rescue/virt-rescue.pod:272
22211 msgid ""
22212 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
22213 "send the ping packets, and because virt-rescue must be able to run as "
22214 "non-root, QEMU user networking is not able to emulate the L<ping(8)> "
22215 "command.  The ping command will appear to resolve addresses but will not be "
22216 "able to send or receive any packets.  This does not mean that the network is "
22217 "not working."
22218 msgstr ""
22219
22220 #. type: =item
22221 #: ../rescue/virt-rescue.pod:279
22222 msgid "cannot receive connections"
22223 msgstr ""
22224
22225 #. type: textblock
22226 #: ../rescue/virt-rescue.pod:281
22227 msgid "QEMU user networking cannot receive incoming connections."
22228 msgstr ""
22229
22230 #. type: =item
22231 #: ../rescue/virt-rescue.pod:283
22232 msgid "making TCP connections"
22233 msgstr ""
22234
22235 #. type: textblock
22236 #: ../rescue/virt-rescue.pod:285
22237 msgid ""
22238 "The virt-rescue appliance needs to be small and so does not include many "
22239 "network tools.  In particular there is no L<telnet(1)> command.  You can "
22240 "make TCP connections from the shell using the magical "
22241 "C</dev/tcp/E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
22242 msgstr ""
22243
22244 #. type: verbatim
22245 #: ../rescue/virt-rescue.pod:290
22246 #, no-wrap
22247 msgid ""
22248 " exec 3<>/dev/tcp/redhat.com/80\n"
22249 " echo \"GET /\" >&3\n"
22250 " cat <&3\n"
22251 "\n"
22252 msgstr ""
22253
22254 #. type: textblock
22255 #: ../rescue/virt-rescue.pod:294
22256 msgid "See L<bash(1)> for more details."
22257 msgstr ""
22258
22259 #. type: textblock
22260 #: ../rescue/virt-rescue.pod:300
22261 msgid ""
22262 "Several environment variables affect virt-rescue.  See "
22263 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
22264 msgstr ""
22265
22266 #. type: textblock
22267 #: ../rescue/virt-rescue.pod:327
22268 msgid ""
22269 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
22270 "L<virt-filesystems(1)>, L<http://libguestfs.org/>."
22271 msgstr ""
22272
22273 #. type: textblock
22274 #: ../resize/virt-resize.pod:5
22275 msgid "virt-resize - Resize a virtual machine disk"
22276 msgstr ""
22277
22278 #. type: verbatim
22279 #: ../resize/virt-resize.pod:9
22280 #, no-wrap
22281 msgid ""
22282 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
22283 "   [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
22284 "   [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
22285 "\n"
22286 msgstr ""
22287
22288 #. type: textblock
22289 #: ../resize/virt-resize.pod:15
22290 msgid ""
22291 "Virt-resize is a tool which can resize a virtual machine disk, making it "
22292 "larger or smaller overall, and resizing or deleting any partitions contained "
22293 "within."
22294 msgstr ""
22295
22296 #. type: textblock
22297 #: ../resize/virt-resize.pod:19
22298 msgid ""
22299 "Virt-resize B<cannot> resize disk images in-place.  Virt-resize B<should "
22300 "not> be used on live virtual machines - for consistent results, shut the "
22301 "virtual machine down before resizing it."
22302 msgstr ""
22303
22304 #. type: textblock
22305 #: ../resize/virt-resize.pod:23
22306 msgid ""
22307 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
22308 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
22309 msgstr ""
22310
22311 #. type: =item
22312 #: ../resize/virt-resize.pod:31 ../resize/virt-resize.pod:597 ../sparsify/virt-sparsify.pod:203 ../src/guestfs.pod:484 ../src/guestfs.pod:1302 ../src/guestfs.pod:1441 ../src/guestfs.pod:2690
22313 msgid "1."
22314 msgstr ""
22315
22316 #. type: textblock
22317 #: ../resize/virt-resize.pod:33
22318 msgid ""
22319 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
22320 "fill the extra 5GB of space."
22321 msgstr ""
22322
22323 #. type: verbatim
22324 #: ../resize/virt-resize.pod:36
22325 #, no-wrap
22326 msgid ""
22327 " virt-filesystems --long -h --all -a olddisk\n"
22328 " \n"
22329 msgstr ""
22330
22331 #. type: verbatim
22332 #: ../resize/virt-resize.pod:38
22333 #, no-wrap
22334 msgid ""
22335 " truncate -r olddisk newdisk\n"
22336 " truncate -s +5G newdisk\n"
22337 " \n"
22338 msgstr ""
22339
22340 #. type: verbatim
22341 #: ../resize/virt-resize.pod:41
22342 #, no-wrap
22343 msgid ""
22344 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
22345 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
22346 "\n"
22347 msgstr ""
22348
22349 #. type: =item
22350 #: ../resize/virt-resize.pod:44 ../resize/virt-resize.pod:604 ../sparsify/virt-sparsify.pod:210 ../src/guestfs.pod:490 ../src/guestfs.pod:1306 ../src/guestfs.pod:1445 ../src/guestfs.pod:2715
22351 msgid "2."
22352 msgstr ""
22353
22354 #. type: textblock
22355 #: ../resize/virt-resize.pod:46
22356 msgid ""
22357 "As above, but make the /boot partition 200MB bigger, while giving the "
22358 "remaining space to /dev/sda2:"
22359 msgstr ""
22360
22361 #. type: verbatim
22362 #: ../resize/virt-resize.pod:49
22363 #, no-wrap
22364 msgid ""
22365 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
22366 "   olddisk newdisk\n"
22367 "\n"
22368 msgstr ""
22369
22370 #. type: =item
22371 #: ../resize/virt-resize.pod:52 ../resize/virt-resize.pod:610 ../sparsify/virt-sparsify.pod:216 ../src/guestfs.pod:501 ../src/guestfs.pod:1451
22372 msgid "3."
22373 msgstr ""
22374
22375 #. type: textblock
22376 #: ../resize/virt-resize.pod:54
22377 msgid ""
22378 "As in the first example, but expand a logical volume as the final step.  "
22379 "This is what you would typically use for Linux guests that use LVM:"
22380 msgstr ""
22381
22382 #. type: verbatim
22383 #: ../resize/virt-resize.pod:58
22384 #, no-wrap
22385 msgid ""
22386 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
22387 "   olddisk newdisk\n"
22388 "\n"
22389 msgstr ""
22390
22391 #. type: =item
22392 #: ../resize/virt-resize.pod:61
22393 msgid "4."
22394 msgstr ""
22395
22396 #. type: textblock
22397 #: ../resize/virt-resize.pod:63
22398 msgid ""
22399 "As in the first example, but the output format will be qcow2 instead of a "
22400 "raw disk:"
22401 msgstr ""
22402
22403 #. type: verbatim
22404 #: ../resize/virt-resize.pod:66
22405 #, no-wrap
22406 msgid ""
22407 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
22408 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
22409 "\n"
22410 msgstr ""
22411
22412 #. type: =head1
22413 #: ../resize/virt-resize.pod:71
22414 msgid "DETAILED USAGE"
22415 msgstr ""
22416
22417 #. type: =head2
22418 #: ../resize/virt-resize.pod:73
22419 msgid "EXPANDING A VIRTUAL MACHINE DISK"
22420 msgstr ""
22421
22422 #. type: =item
22423 #: ../resize/virt-resize.pod:77
22424 msgid "1. Shut down the virtual machine"
22425 msgstr ""
22426
22427 #. type: =item
22428 #: ../resize/virt-resize.pod:79
22429 msgid "2. Locate input disk image"
22430 msgstr ""
22431
22432 #. type: textblock
22433 #: ../resize/virt-resize.pod:81
22434 msgid ""
22435 "Locate the input disk image (ie. the file or device on the host containing "
22436 "the guest's disk).  If the guest is managed by libvirt, you can use C<virsh "
22437 "dumpxml> like this to find the disk image name:"
22438 msgstr ""
22439
22440 #. type: verbatim
22441 #: ../resize/virt-resize.pod:85
22442 #, no-wrap
22443 msgid ""
22444 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
22445 " Found 1 nodes:\n"
22446 " -- NODE --\n"
22447 " <source dev=\"/dev/vg/lv_guest\" />\n"
22448 "\n"
22449 msgstr ""
22450
22451 #. type: =item
22452 #: ../resize/virt-resize.pod:90
22453 msgid "3. Look at current sizing"
22454 msgstr ""
22455
22456 #. type: textblock
22457 #: ../resize/virt-resize.pod:92
22458 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
22459 msgstr ""
22460
22461 #. type: verbatim
22462 #: ../resize/virt-resize.pod:95
22463 #, no-wrap
22464 msgid ""
22465 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
22466 " Name       Type       Size  Parent\n"
22467 " /dev/sda1  partition  101M  /dev/sda\n"
22468 " /dev/sda2  partition  7.9G  /dev/sda\n"
22469 " /dev/sda   device     8.0G  -\n"
22470 "\n"
22471 msgstr ""
22472
22473 #. type: textblock
22474 #: ../resize/virt-resize.pod:101
22475 msgid ""
22476 "(This example is a virtual machine with an 8 GB disk which we would like to "
22477 "expand up to 10 GB)."
22478 msgstr ""
22479
22480 #. type: =item
22481 #: ../resize/virt-resize.pod:104
22482 msgid "4. Create output disk"
22483 msgstr ""
22484
22485 #. type: textblock
22486 #: ../resize/virt-resize.pod:106
22487 msgid ""
22488 "Virt-resize cannot do in-place disk modifications.  You have to have space "
22489 "to store the resized output disk."
22490 msgstr ""
22491
22492 #. type: textblock
22493 #: ../resize/virt-resize.pod:109
22494 msgid "To store the resized disk image in a file, create a file of a suitable size:"
22495 msgstr ""
22496
22497 #. type: verbatim
22498 #: ../resize/virt-resize.pod:112
22499 #, no-wrap
22500 msgid ""
22501 " # rm -f outdisk\n"
22502 " # truncate -s 10G outdisk\n"
22503 "\n"
22504 msgstr ""
22505
22506 #. type: textblock
22507 #: ../resize/virt-resize.pod:115
22508 msgid "Or use L<lvcreate(1)> to create a logical volume:"
22509 msgstr ""
22510
22511 #. type: verbatim
22512 #: ../resize/virt-resize.pod:117
22513 #, no-wrap
22514 msgid ""
22515 " # lvcreate -L 10G -n lv_name vg_name\n"
22516 "\n"
22517 msgstr ""
22518
22519 #. type: textblock
22520 #: ../resize/virt-resize.pod:119
22521 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
22522 msgstr ""
22523
22524 #. type: verbatim
22525 #: ../resize/virt-resize.pod:121
22526 #, no-wrap
22527 msgid ""
22528 " # virsh pool-list\n"
22529 " # virsh vol-create-as poolname newvol 10G\n"
22530 "\n"
22531 msgstr ""
22532
22533 #. type: =item
22534 #: ../resize/virt-resize.pod:124
22535 msgid "5. Resize"
22536 msgstr ""
22537
22538 #. type: textblock
22539 #: ../resize/virt-resize.pod:126
22540 msgid ""
22541 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
22542 "file) and the output disk.  The output disk is the one created in the "
22543 "previous step."
22544 msgstr ""
22545
22546 #. type: verbatim
22547 #: ../resize/virt-resize.pod:130
22548 #, no-wrap
22549 msgid ""
22550 " # virt-resize indisk outdisk\n"
22551 "\n"
22552 msgstr ""
22553
22554 #. type: textblock
22555 #: ../resize/virt-resize.pod:132
22556 msgid ""
22557 "This command just copies disk image C<indisk> to disk image C<outdisk> "
22558 "I<without> resizing or changing any existing partitions.  If C<outdisk> is "
22559 "larger, then an extra, empty partition is created at the end of the disk "
22560 "covering the extra space.  If C<outdisk> is smaller, then it will give an "
22561 "error."
22562 msgstr ""
22563
22564 #. type: textblock
22565 #: ../resize/virt-resize.pod:138
22566 msgid ""
22567 "More realistically you'd want to expand existing partitions in the disk "
22568 "image by passing extra options (for the full list see the L</OPTIONS> "
22569 "section below)."
22570 msgstr ""
22571
22572 #. type: textblock
22573 #: ../resize/virt-resize.pod:142
22574 msgid ""
22575 "L</--expand> is the most useful option.  It expands the named partition "
22576 "within the disk to fill any extra space:"
22577 msgstr ""
22578
22579 #. type: verbatim
22580 #: ../resize/virt-resize.pod:145
22581 #, no-wrap
22582 msgid ""
22583 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
22584 "\n"
22585 msgstr ""
22586
22587 #. type: textblock
22588 #: ../resize/virt-resize.pod:147
22589 msgid ""
22590 "(In this case, an extra partition is I<not> created at the end of the disk, "
22591 "because there will be no unused space)."
22592 msgstr ""
22593
22594 #. type: textblock
22595 #: ../resize/virt-resize.pod:150
22596 msgid ""
22597 "L</--resize> is the other commonly used option.  The following would "
22598 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
22599 "rest of the available space:"
22600 msgstr ""
22601
22602 #. type: verbatim
22603 #: ../resize/virt-resize.pod:154
22604 #, no-wrap
22605 msgid ""
22606 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
22607 "     indisk outdisk\n"
22608 "\n"
22609 msgstr ""
22610
22611 #. type: textblock
22612 #: ../resize/virt-resize.pod:157
22613 msgid ""
22614 "If the expanded partition in the image contains a filesystem or LVM PV, then "
22615 "if virt-resize knows how, it will resize the contents, the equivalent of "
22616 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
22617 "or L<btrfs(8)>.  However virt-resize does not know how to resize some "
22618 "filesystems, so you would have to online resize them after booting the "
22619 "guest."
22620 msgstr ""
22621
22622 #. type: textblock
22623 #: ../resize/virt-resize.pod:164
22624 msgid "Other options are covered below."
22625 msgstr ""
22626
22627 #. type: =item
22628 #: ../resize/virt-resize.pod:166
22629 msgid "6. Test"
22630 msgstr ""
22631
22632 #. type: textblock
22633 #: ../resize/virt-resize.pod:168
22634 msgid "Thoroughly test the new disk image I<before> discarding the old one."
22635 msgstr ""
22636
22637 #. type: textblock
22638 #: ../resize/virt-resize.pod:170
22639 msgid "If you are using libvirt, edit the XML to point at the new disk:"
22640 msgstr ""
22641
22642 #. type: verbatim
22643 #: ../resize/virt-resize.pod:172
22644 #, no-wrap
22645 msgid ""
22646 " # virsh edit guestname\n"
22647 "\n"
22648 msgstr ""
22649
22650 #. type: textblock
22651 #: ../resize/virt-resize.pod:174
22652 msgid ""
22653 "Change E<lt>source ...E<gt>, see "
22654 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
22655 msgstr ""
22656
22657 #. type: textblock
22658 #: ../resize/virt-resize.pod:177
22659 msgid "Then start up the domain with the new, resized disk:"
22660 msgstr ""
22661
22662 #. type: verbatim
22663 #: ../resize/virt-resize.pod:179
22664 #, no-wrap
22665 msgid ""
22666 " # virsh start guestname\n"
22667 "\n"
22668 msgstr ""
22669
22670 #. type: textblock
22671 #: ../resize/virt-resize.pod:181
22672 msgid ""
22673 "and check that it still works.  See also the L</NOTES> section below for "
22674 "additional information."
22675 msgstr ""
22676
22677 #. type: =item
22678 #: ../resize/virt-resize.pod:184
22679 msgid "7. Resize LVs etc inside the guest"
22680 msgstr ""
22681
22682 #. type: textblock
22683 #: ../resize/virt-resize.pod:186
22684 msgid "(This can also be done offline using L<guestfish(1)>)"
22685 msgstr ""
22686
22687 #. type: textblock
22688 #: ../resize/virt-resize.pod:188
22689 msgid ""
22690 "Once the guest has booted you should see the new space available, at least "
22691 "for filesystems that virt-resize knows how to resize, and for PVs.  The user "
22692 "may need to resize LVs inside PVs, and also resize filesystem types that "
22693 "virt-resize does not know how to expand."
22694 msgstr ""
22695
22696 #. type: =head2
22697 #: ../resize/virt-resize.pod:195
22698 msgid "SHRINKING A VIRTUAL MACHINE DISK"
22699 msgstr ""
22700
22701 #. type: textblock
22702 #: ../resize/virt-resize.pod:197
22703 msgid ""
22704 "Shrinking is somewhat more complex than expanding, and only an overview is "
22705 "given here."
22706 msgstr ""
22707
22708 #. type: textblock
22709 #: ../resize/virt-resize.pod:200
22710 msgid ""
22711 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
22712 "filesystems).  The user has to shrink content before passing the disk image "
22713 "to virt-resize, and virt-resize will check that the content has been shrunk "
22714 "properly."
22715 msgstr ""
22716
22717 #. type: textblock
22718 #: ../resize/virt-resize.pod:205
22719 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
22720 msgstr ""
22721
22722 #. type: textblock
22723 #: ../resize/virt-resize.pod:207
22724 msgid ""
22725 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
22726 "steps 3 and 4 above to allocate a new disk image."
22727 msgstr ""
22728
22729 #. type: textblock
22730 #: ../resize/virt-resize.pod:210
22731 msgid "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
22732 msgstr ""
22733
22734 #. type: =head2
22735 #: ../resize/virt-resize.pod:213
22736 msgid "IGNORING OR DELETING PARTITIONS"
22737 msgstr ""
22738
22739 #. type: textblock
22740 #: ../resize/virt-resize.pod:215
22741 msgid ""
22742 "virt-resize also gives a convenient way to ignore or delete partitions when "
22743 "copying from the input disk to the output disk.  Ignoring a partition speeds "
22744 "up the copy where you don't care about the existing contents of a "
22745 "partition.  Deleting a partition removes it completely, but note that it "
22746 "also renumbers any partitions after the one which is deleted, which can "
22747 "leave some guests unbootable."
22748 msgstr ""
22749
22750 #. type: =head2
22751 #: ../resize/virt-resize.pod:222
22752 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
22753 msgstr ""
22754
22755 #. type: textblock
22756 #: ../resize/virt-resize.pod:224
22757 msgid ""
22758 "If the input disk is in qcow2 format, then you may prefer that the output is "
22759 "in qcow2 format as well.  Alternately, virt-resize can convert the format on "
22760 "the fly.  The output format is simply determined by the format of the empty "
22761 "output container that you provide.  Thus to create qcow2 output, use:"
22762 msgstr ""
22763
22764 #. type: verbatim
22765 #: ../resize/virt-resize.pod:230
22766 #, no-wrap
22767 msgid ""
22768 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
22769 "\n"
22770 msgstr ""
22771
22772 #. type: textblock
22773 #: ../resize/virt-resize.pod:232
22774 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
22775 msgstr ""
22776
22777 #. type: textblock
22778 #: ../resize/virt-resize.pod:234
22779 msgid "Similarly, to get non-sparse raw output use:"
22780 msgstr ""
22781
22782 #. type: verbatim
22783 #: ../resize/virt-resize.pod:236
22784 #, no-wrap
22785 msgid ""
22786 " fallocate -l size outdisk\n"
22787 "\n"
22788 msgstr ""
22789
22790 #. type: textblock
22791 #: ../resize/virt-resize.pod:238
22792 msgid ""
22793 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
22794 "if=/dev/zero of=outdisk bs=1M count=..>)"
22795 msgstr ""
22796
22797 #. type: =head2
22798 #: ../resize/virt-resize.pod:241
22799 msgid "LOGICAL PARTITIONS"
22800 msgstr ""
22801
22802 #. type: textblock
22803 #: ../resize/virt-resize.pod:243
22804 msgid ""
22805 "Logical partitions (a.k.a. C</dev/sda5+> on disks using DOS partition "
22806 "tables) cannot be resized."
22807 msgstr ""
22808
22809 #. type: textblock
22810 #: ../resize/virt-resize.pod:246
22811 msgid ""
22812 "To understand what is going on, firstly one of the four partitions "
22813 "C</dev/sda1-4> will have MBR partition type C<05> or C<0f>.  This is called "
22814 "the B<extended partition>.  Use L<virt-filesystems(1)> to see the MBR "
22815 "partition type."
22816 msgstr ""
22817
22818 #. type: textblock
22819 #: ../resize/virt-resize.pod:251
22820 msgid "Logical partitions live inside the extended partition."
22821 msgstr ""
22822
22823 #. type: textblock
22824 #: ../resize/virt-resize.pod:253
22825 msgid ""
22826 "The extended partition can be expanded, but not shrunk (unless you force it, "
22827 "which is not advisable).  When the extended partition is copied across, all "
22828 "the logical partitions contained inside are copied over implicitly.  "
22829 "Virt-resize does not look inside the extended partition, so it copies the "
22830 "logical partitions blindly."
22831 msgstr ""
22832
22833 #. type: textblock
22834 #: ../resize/virt-resize.pod:259
22835 msgid ""
22836 "You cannot specify a logical partition (C</dev/sda5+>) at all on the command "
22837 "line.  Doing so will give an error."
22838 msgstr ""
22839
22840 #. type: textblock
22841 #: ../resize/virt-resize.pod:268 ../sparsify/virt-sparsify.pod:105
22842 msgid "Display help."
22843 msgstr ""
22844
22845 #. type: =item
22846 #: ../resize/virt-resize.pod:270
22847 msgid "B<--align-first auto>"
22848 msgstr ""
22849
22850 #. type: =item
22851 #: ../resize/virt-resize.pod:272
22852 msgid "B<--align-first never>"
22853 msgstr ""
22854
22855 #. type: =item
22856 #: ../resize/virt-resize.pod:274
22857 msgid "B<--align-first always>"
22858 msgstr ""
22859
22860 #. type: textblock
22861 #: ../resize/virt-resize.pod:276
22862 msgid ""
22863 "Align the first partition for improved performance (see also the "
22864 "I<--alignment> option)."
22865 msgstr ""
22866
22867 #. type: textblock
22868 #: ../resize/virt-resize.pod:279
22869 msgid ""
22870 "The default is I<--align-first auto> which only aligns the first partition "
22871 "if it is safe to do so.  That is, only when we know how to fix the "
22872 "bootloader automatically, and at the moment that can only be done for "
22873 "Windows guests."
22874 msgstr ""
22875
22876 #. type: textblock
22877 #: ../resize/virt-resize.pod:284
22878 msgid ""
22879 "I<--align-first never> means we never move the first partition.  This is the "
22880 "safest option.  Try this if the guest does not boot after resizing."
22881 msgstr ""
22882
22883 #. type: textblock
22884 #: ../resize/virt-resize.pod:288
22885 msgid ""
22886 "I<--align-first always> means we always align the first partition (if it "
22887 "needs to be aligned).  For some guests this will break the bootloader, "
22888 "making the guest unbootable."
22889 msgstr ""
22890
22891 #. type: =item
22892 #: ../resize/virt-resize.pod:292
22893 msgid "B<--alignment N>"
22894 msgstr ""
22895
22896 #. type: textblock
22897 #: ../resize/virt-resize.pod:294
22898 msgid ""
22899 "Set the alignment of partitions to C<N> sectors.  The default in virt-resize "
22900 "E<lt> 1.13.19 was 64 sectors, and after that is 128 sectors."
22901 msgstr ""
22902
22903 #. type: textblock
22904 #: ../resize/virt-resize.pod:298
22905 msgid ""
22906 "Assuming 512 byte sector size inside the guest, here are some suitable "
22907 "values for this:"
22908 msgstr ""
22909
22910 #. type: =item
22911 #: ../resize/virt-resize.pod:303
22912 msgid "I<--alignment 1> (512 bytes)"
22913 msgstr ""
22914
22915 #. type: textblock
22916 #: ../resize/virt-resize.pod:305
22917 msgid ""
22918 "The partitions would be packed together as closely as possible, but would be "
22919 "completely unaligned.  In some cases this can cause very poor performance.  "
22920 "See L<virt-alignment-scan(1)> for further details."
22921 msgstr ""
22922
22923 #. type: =item
22924 #: ../resize/virt-resize.pod:309
22925 msgid "I<--alignment 8> (4K)"
22926 msgstr ""
22927
22928 #. type: textblock
22929 #: ../resize/virt-resize.pod:311
22930 msgid ""
22931 "This would be the minimum acceptable alignment for reasonable performance on "
22932 "modern hosts."
22933 msgstr ""
22934
22935 #. type: =item
22936 #: ../resize/virt-resize.pod:314
22937 msgid "I<--alignment 128> (64K)"
22938 msgstr ""
22939
22940 #. type: textblock
22941 #: ../resize/virt-resize.pod:316
22942 msgid ""
22943 "This alignment provides good performance when the host is using high end "
22944 "network storage."
22945 msgstr ""
22946
22947 #. type: =item
22948 #: ../resize/virt-resize.pod:319
22949 msgid "I<--alignment 2048> (1M)"
22950 msgstr ""
22951
22952 #. type: textblock
22953 #: ../resize/virt-resize.pod:321
22954 msgid ""
22955 "This is the standard alignment used by all newly installed guests since "
22956 "around 2008."
22957 msgstr ""
22958
22959 #. type: =item
22960 #: ../resize/virt-resize.pod:326
22961 msgid "B<-d>"
22962 msgstr ""
22963
22964 #. type: =item
22965 #: ../resize/virt-resize.pod:328 ../tools/virt-make-fs.pl:177 ../tools/virt-win-reg.pl:120
22966 msgid "B<--debug>"
22967 msgstr ""
22968
22969 #. type: textblock
22970 #: ../resize/virt-resize.pod:330 ../tools/virt-win-reg.pl:122
22971 msgid "Enable debugging messages."
22972 msgstr ""
22973
22974 #. type: =item
22975 #: ../resize/virt-resize.pod:332
22976 msgid "B<--delete part>"
22977 msgstr ""
22978
22979 #. type: textblock
22980 #: ../resize/virt-resize.pod:334
22981 msgid ""
22982 "Delete the named partition.  It would be more accurate to describe this as "
22983 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
22984 "the original disk image is left intact."
22985 msgstr ""
22986
22987 #. type: textblock
22988 #: ../resize/virt-resize.pod:338
22989 msgid ""
22990 "Note that when you delete a partition, then anything contained in the "
22991 "partition is also deleted.  Furthermore, this causes any partitions that "
22992 "come after to be I<renumbered>, which can easily make your guest unbootable."
22993 msgstr ""
22994
22995 #. type: textblock
22996 #: ../resize/virt-resize.pod:343 ../resize/virt-resize.pod:404 ../resize/virt-resize.pod:531 ../sparsify/virt-sparsify.pod:145
22997 msgid "You can give this option multiple times."
22998 msgstr ""
22999
23000 #. type: =item
23001 #: ../resize/virt-resize.pod:345
23002 msgid "B<--expand part>"
23003 msgstr ""
23004
23005 #. type: textblock
23006 #: ../resize/virt-resize.pod:347
23007 msgid ""
23008 "Expand the named partition so it uses up all extra space (space left over "
23009 "after any other resize changes that you request have been done)."
23010 msgstr ""
23011
23012 #. type: textblock
23013 #: ../resize/virt-resize.pod:350
23014 msgid ""
23015 "If virt-resize knows how, it will expand the direct content of the "
23016 "partition.  For example, if the partition is an LVM PV, it will expand the "
23017 "PV to fit (like calling L<pvresize(8)>).  Virt-resize leaves any other "
23018 "content it doesn't know about alone."
23019 msgstr ""
23020
23021 #. type: textblock
23022 #: ../resize/virt-resize.pod:355
23023 msgid "Currently virt-resize can resize:"
23024 msgstr ""
23025
23026 #. type: textblock
23027 #: ../resize/virt-resize.pod:361
23028 msgid "ext2, ext3 and ext4 filesystems."
23029 msgstr ""
23030
23031 #. type: textblock
23032 #: ../resize/virt-resize.pod:365
23033 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
23034 msgstr ""
23035
23036 #. type: textblock
23037 #: ../resize/virt-resize.pod:367
23038 msgid ""
23039 "The filesystem must have been shut down consistently last time it was used.  "
23040 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
23041 "consistency check, so at the first boot after resizing Windows will check "
23042 "the disk."
23043 msgstr ""
23044
23045 #. type: textblock
23046 #: ../resize/virt-resize.pod:374
23047 msgid ""
23048 "LVM PVs (physical volumes).  virt-resize does not usually resize anything "
23049 "inside the PV, but see the I<--LV-expand> option.  The user could also "
23050 "resize LVs as desired after boot."
23051 msgstr ""
23052
23053 #. type: textblock
23054 #: ../resize/virt-resize.pod:380
23055 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
23056 msgstr ""
23057
23058 #. type: textblock
23059 #: ../resize/virt-resize.pod:384 ../resize/virt-resize.pod:559
23060 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
23061 msgstr ""
23062
23063 #. type: =item
23064 #: ../resize/virt-resize.pod:386 ../sparsify/virt-sparsify.pod:125 ../tools/virt-list-filesystems.pl:91 ../tools/virt-list-partitions.pl:92 ../tools/virt-tar.pl:141 ../tools/virt-win-reg.pl:142
23065 msgid "B<--format> raw"
23066 msgstr ""
23067
23068 #. type: textblock
23069 #: ../resize/virt-resize.pod:388 ../sparsify/virt-sparsify.pod:129
23070 msgid ""
23071 "Specify the format of the input disk image.  If this flag is not given then "
23072 "it is auto-detected from the image itself."
23073 msgstr ""
23074
23075 #. type: textblock
23076 #: ../resize/virt-resize.pod:394
23077 msgid ""
23078 "Note that this option I<does not> affect the output format.  See L</QCOW2 "
23079 "AND NON-SPARSE RAW FORMATS>."
23080 msgstr ""
23081
23082 #. type: =item
23083 #: ../resize/virt-resize.pod:397
23084 msgid "B<--ignore part>"
23085 msgstr ""
23086
23087 #. type: textblock
23088 #: ../resize/virt-resize.pod:399
23089 msgid ""
23090 "Ignore the named partition.  Effectively this means the partition is "
23091 "allocated on the destination disk, but the content is not copied across from "
23092 "the source disk.  The content of the partition will be blank (all zero "
23093 "bytes)."
23094 msgstr ""
23095
23096 #. type: =item
23097 #: ../resize/virt-resize.pod:406
23098 msgid "B<--LV-expand logvol>"
23099 msgstr ""
23100
23101 #. type: textblock
23102 #: ../resize/virt-resize.pod:408
23103 msgid ""
23104 "This takes the logical volume and, as a final step, expands it to fill all "
23105 "the space available in its volume group.  A typical usage, assuming a Linux "
23106 "guest with a single PV C</dev/sda2> and a root device called "
23107 "C</dev/vg_guest/lv_root> would be:"
23108 msgstr ""
23109
23110 #. type: verbatim
23111 #: ../resize/virt-resize.pod:413
23112 #, no-wrap
23113 msgid ""
23114 " virt-resize indisk outdisk \\\n"
23115 "   --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
23116 "\n"
23117 msgstr ""
23118
23119 #. type: textblock
23120 #: ../resize/virt-resize.pod:416
23121 msgid ""
23122 "This would first expand the partition (and PV), and then expand the root "
23123 "device to fill the extra space in the PV."
23124 msgstr ""
23125
23126 #. type: textblock
23127 #: ../resize/virt-resize.pod:419
23128 msgid ""
23129 "The contents of the LV are also resized if virt-resize knows how to do "
23130 "that.  You can stop virt-resize from trying to expand the content by using "
23131 "the option I<--no-expand-content>."
23132 msgstr ""
23133
23134 #. type: textblock
23135 #: ../resize/virt-resize.pod:423
23136 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
23137 msgstr ""
23138
23139 #. type: textblock
23140 #: ../resize/virt-resize.pod:425
23141 msgid ""
23142 "You can give this option multiple times, I<but> it doesn't make sense to do "
23143 "this unless the logical volumes you specify are all in different volume "
23144 "groups."
23145 msgstr ""
23146
23147 #. type: =item
23148 #: ../resize/virt-resize.pod:429 ../sparsify/virt-sparsify.pod:147
23149 msgid "B<--machine-readable>"
23150 msgstr ""
23151
23152 #. type: textblock
23153 #: ../resize/virt-resize.pod:431 ../sparsify/virt-sparsify.pod:149
23154 msgid ""
23155 "This option is used to make the output more machine friendly when being "
23156 "parsed by other programs.  See L</MACHINE READABLE OUTPUT> below."
23157 msgstr ""
23158
23159 #. type: =item
23160 #: ../resize/virt-resize.pod:437
23161 msgid "B<--dryrun>"
23162 msgstr ""
23163
23164 #. type: textblock
23165 #: ../resize/virt-resize.pod:439
23166 msgid "Print a summary of what would be done, but don't do anything."
23167 msgstr ""
23168
23169 #. type: =item
23170 #: ../resize/virt-resize.pod:441
23171 msgid "B<--no-copy-boot-loader>"
23172 msgstr ""
23173
23174 #. type: textblock
23175 #: ../resize/virt-resize.pod:443
23176 msgid ""
23177 "By default, virt-resize copies over some sectors at the start of the disk "
23178 "(up to the beginning of the first partition).  Commonly these sectors "
23179 "contain the Master Boot Record (MBR) and the boot loader, and are required "
23180 "in order for the guest to boot correctly."
23181 msgstr ""
23182
23183 #. type: textblock
23184 #: ../resize/virt-resize.pod:448
23185 msgid ""
23186 "If you specify this flag, then this initial copy is not done.  You may need "
23187 "to reinstall the boot loader in this case."
23188 msgstr ""
23189
23190 #. type: =item
23191 #: ../resize/virt-resize.pod:451
23192 msgid "B<--no-extra-partition>"
23193 msgstr ""
23194
23195 #. type: textblock
23196 #: ../resize/virt-resize.pod:453
23197 msgid ""
23198 "By default, virt-resize creates an extra partition if there is any extra, "
23199 "unused space after all resizing has happened.  Use this option to prevent "
23200 "the extra partition from being created.  If you do this then the extra space "
23201 "will be inaccessible until you run fdisk, parted, or some other partitioning "
23202 "tool in the guest."
23203 msgstr ""
23204
23205 #. type: textblock
23206 #: ../resize/virt-resize.pod:459
23207 msgid ""
23208 "Note that if the surplus space is smaller than 10 MB, no extra partition "
23209 "will be created."
23210 msgstr ""
23211
23212 #. type: =item
23213 #: ../resize/virt-resize.pod:462
23214 msgid "B<--no-expand-content>"
23215 msgstr ""
23216
23217 #. type: textblock
23218 #: ../resize/virt-resize.pod:464
23219 msgid ""
23220 "By default, virt-resize will try to expand the direct contents of "
23221 "partitions, if it knows how (see I<--expand> option above)."
23222 msgstr ""
23223
23224 #. type: textblock
23225 #: ../resize/virt-resize.pod:467
23226 msgid ""
23227 "If you give the I<--no-expand-content> option then virt-resize will not "
23228 "attempt this."
23229 msgstr ""
23230
23231 #. type: =item
23232 #: ../resize/virt-resize.pod:470
23233 msgid "B<--ntfsresize-force>"
23234 msgstr ""
23235
23236 #. type: textblock
23237 #: ../resize/virt-resize.pod:472
23238 msgid ""
23239 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
23240 "the NTFS disk is marked as needing a consistency check.  You have to use "
23241 "this option if you want to resize a Windows guest multiple times without "
23242 "booting into Windows between each resize."
23243 msgstr ""
23244
23245 #. type: =item
23246 #: ../resize/virt-resize.pod:478
23247 msgid "B<--output-format> raw"
23248 msgstr ""
23249
23250 #. type: textblock
23251 #: ../resize/virt-resize.pod:480
23252 msgid ""
23253 "Specify the format of the output disk image.  If this flag is not given then "
23254 "it is auto-detected from the image itself."
23255 msgstr ""
23256
23257 #. type: textblock
23258 #: ../resize/virt-resize.pod:486
23259 msgid ""
23260 "Note that this option I<does not create> the output format.  This option "
23261 "just tells libguestfs what it is so it doesn't try to guess it.  You still "
23262 "need to create the output disk with the right format.  See L</QCOW2 AND "
23263 "NON-SPARSE RAW FORMATS>."
23264 msgstr ""
23265
23266 #. type: textblock
23267 #: ../resize/virt-resize.pod:495
23268 msgid "Don't print the summary."
23269 msgstr ""
23270
23271 #. type: =item
23272 #: ../resize/virt-resize.pod:497
23273 msgid "B<--resize part=size>"
23274 msgstr ""
23275
23276 #. type: textblock
23277 #: ../resize/virt-resize.pod:499
23278 msgid ""
23279 "Resize the named partition (expanding or shrinking it) so that it has the "
23280 "given size."
23281 msgstr ""
23282
23283 #. type: textblock
23284 #: ../resize/virt-resize.pod:502
23285 msgid ""
23286 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
23287 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
23288 "size; or as a relative number or percentage.  For example:"
23289 msgstr ""
23290
23291 #. type: verbatim
23292 #: ../resize/virt-resize.pod:508
23293 #, no-wrap
23294 msgid ""
23295 " --resize /dev/sda2=10G\n"
23296 "\n"
23297 msgstr ""
23298
23299 #. type: verbatim
23300 #: ../resize/virt-resize.pod:510
23301 #, no-wrap
23302 msgid ""
23303 " --resize /dev/sda4=90%\n"
23304 "\n"
23305 msgstr ""
23306
23307 #. type: verbatim
23308 #: ../resize/virt-resize.pod:512
23309 #, no-wrap
23310 msgid ""
23311 " --resize /dev/sda2=+1G\n"
23312 "\n"
23313 msgstr ""
23314
23315 #. type: verbatim
23316 #: ../resize/virt-resize.pod:514
23317 #, no-wrap
23318 msgid ""
23319 " --resize /dev/sda2=-200M\n"
23320 "\n"
23321 msgstr ""
23322
23323 #. type: verbatim
23324 #: ../resize/virt-resize.pod:516
23325 #, no-wrap
23326 msgid ""
23327 " --resize /dev/sda1=+128K\n"
23328 "\n"
23329 msgstr ""
23330
23331 #. type: verbatim
23332 #: ../resize/virt-resize.pod:518
23333 #, no-wrap
23334 msgid ""
23335 " --resize /dev/sda1=+10%\n"
23336 "\n"
23337 msgstr ""
23338
23339 #. type: verbatim
23340 #: ../resize/virt-resize.pod:520
23341 #, no-wrap
23342 msgid ""
23343 " --resize /dev/sda1=-10%\n"
23344 "\n"
23345 msgstr ""
23346
23347 #. type: textblock
23348 #: ../resize/virt-resize.pod:522
23349 msgid ""
23350 "You can increase the size of any partition.  Virt-resize will expand the "
23351 "direct content of the partition if it knows how (see I<--expand> below)."
23352 msgstr ""
23353
23354 #. type: textblock
23355 #: ../resize/virt-resize.pod:526
23356 msgid ""
23357 "You can only I<decrease> the size of partitions that contain filesystems or "
23358 "PVs which have already been shrunk.  Virt-resize will check this has been "
23359 "done before proceeding, or else will print an error (see also "
23360 "I<--resize-force>)."
23361 msgstr ""
23362
23363 #. type: =item
23364 #: ../resize/virt-resize.pod:533
23365 msgid "B<--resize-force part=size>"
23366 msgstr ""
23367
23368 #. type: textblock
23369 #: ../resize/virt-resize.pod:535
23370 msgid ""
23371 "This is the same as I<--resize> except that it will let you decrease the "
23372 "size of any partition.  Generally this means you will lose any data which "
23373 "was at the end of the partition you shrink, but you may not care about that "
23374 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
23375 "as a swap partition)."
23376 msgstr ""
23377
23378 #. type: textblock
23379 #: ../resize/virt-resize.pod:541
23380 msgid "See also the I<--ignore> option."
23381 msgstr ""
23382
23383 #. type: =item
23384 #: ../resize/virt-resize.pod:543
23385 msgid "B<--shrink part>"
23386 msgstr ""
23387
23388 #. type: textblock
23389 #: ../resize/virt-resize.pod:545
23390 msgid ""
23391 "Shrink the named partition until the overall disk image fits in the "
23392 "destination.  The named partition B<must> contain a filesystem or PV which "
23393 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
23394 "online tools).  Virt-resize will check this and give an error if it has not "
23395 "been done."
23396 msgstr ""
23397
23398 #. type: textblock
23399 #: ../resize/virt-resize.pod:551
23400 msgid ""
23401 "The amount by which the overall disk must be shrunk (after carrying out all "
23402 "other operations requested by the user) is called the \"deficit\".  For "
23403 "example, a straight copy (assume no other operations)  from a 5GB disk image "
23404 "to a 4GB disk image results in a 1GB deficit.  In this case, virt-resize "
23405 "would give an error unless the user specified a partition to shrink and that "
23406 "partition had more than a gigabyte of free space."
23407 msgstr ""
23408
23409 #. type: =head1
23410 #: ../resize/virt-resize.pod:569 ../sparsify/virt-sparsify.pod:177
23411 msgid "MACHINE READABLE OUTPUT"
23412 msgstr ""
23413
23414 #. type: textblock
23415 #: ../resize/virt-resize.pod:571
23416 msgid ""
23417 "The I<--machine-readable> option can be used to make the output more machine "
23418 "friendly, which is useful when calling virt-resize from other programs, GUIs "
23419 "etc."
23420 msgstr ""
23421
23422 #. type: textblock
23423 #: ../resize/virt-resize.pod:575 ../sparsify/virt-sparsify.pod:183
23424 msgid "There are two ways to use this option."
23425 msgstr ""
23426
23427 #. type: textblock
23428 #: ../resize/virt-resize.pod:577
23429 msgid ""
23430 "Firstly use the option on its own to query the capabilities of the "
23431 "virt-resize binary.  Typical output looks like this:"
23432 msgstr ""
23433
23434 #. type: verbatim
23435 #: ../resize/virt-resize.pod:580
23436 #, no-wrap
23437 msgid ""
23438 " $ virt-resize --machine-readable\n"
23439 " virt-resize\n"
23440 " ntfsresize-force\n"
23441 " 32bitok\n"
23442 " ntfs\n"
23443 " btrfs\n"
23444 "\n"
23445 msgstr ""
23446
23447 #. type: textblock
23448 #: ../resize/virt-resize.pod:587 ../sparsify/virt-sparsify.pod:193
23449 msgid ""
23450 "A list of features is printed, one per line, and the program exits with "
23451 "status 0."
23452 msgstr ""
23453
23454 #. type: textblock
23455 #: ../resize/virt-resize.pod:590 ../sparsify/virt-sparsify.pod:196
23456 msgid ""
23457 "Secondly use the option in conjunction with other options to make the "
23458 "regular program output more machine friendly."
23459 msgstr ""
23460
23461 #. type: textblock
23462 #: ../resize/virt-resize.pod:593 ../sparsify/virt-sparsify.pod:199
23463 msgid "At the moment this means:"
23464 msgstr ""
23465
23466 #. type: textblock
23467 #: ../resize/virt-resize.pod:599 ../sparsify/virt-sparsify.pod:205
23468 msgid ""
23469 "Progress bar messages can be parsed from stdout by looking for this regular "
23470 "expression:"
23471 msgstr ""
23472
23473 #. type: verbatim
23474 #: ../resize/virt-resize.pod:602 ../sparsify/virt-sparsify.pod:208
23475 #, no-wrap
23476 msgid ""
23477 " ^[0-9]+/[0-9]+$\n"
23478 "\n"
23479 msgstr ""
23480
23481 #. type: textblock
23482 #: ../resize/virt-resize.pod:606 ../sparsify/virt-sparsify.pod:212
23483 msgid ""
23484 "The calling program should treat messages sent to stdout (except for "
23485 "progress bar messages) as status messages.  They can be logged and/or "
23486 "displayed to the user."
23487 msgstr ""
23488
23489 #. type: textblock
23490 #: ../resize/virt-resize.pod:612
23491 msgid ""
23492 "The calling program should treat messages sent to stderr as error messages.  "
23493 "In addition, virt-resize exits with a non-zero status code if there was a "
23494 "fatal error."
23495 msgstr ""
23496
23497 #. type: textblock
23498 #: ../resize/virt-resize.pod:618
23499 msgid ""
23500 "Versions of the program prior to 1.13.9 did not support the "
23501 "I<--machine-readable> option and will return an error."
23502 msgstr ""
23503
23504 #. type: =head2
23505 #: ../resize/virt-resize.pod:623
23506 msgid "\"Partition 1 does not end on cylinder boundary.\""
23507 msgstr ""
23508
23509 #. type: textblock
23510 #: ../resize/virt-resize.pod:625
23511 msgid ""
23512 "Virt-resize aligns partitions to multiples of 128 sectors (see the "
23513 "I<--alignment> parameter).  Usually this means the partitions will not be "
23514 "aligned to the ancient CHS geometry.  However CHS geometry is meaningless "
23515 "for disks manufactured since the early 1990s, and doubly so for virtual hard "
23516 "drives.  Alignment of partitions to cylinders is not required by any modern "
23517 "operating system."
23518 msgstr ""
23519
23520 #. type: =head2
23521 #: ../resize/virt-resize.pod:632
23522 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
23523 msgstr ""
23524
23525 #. type: textblock
23526 #: ../resize/virt-resize.pod:634
23527 msgid ""
23528 "In Windows Vista and later versions, Microsoft switched to using a separate "
23529 "boot partition.  In these VMs, typically C</dev/sda1> is the boot partition "
23530 "and C</dev/sda2> is the main (C:) drive.  Resizing the first (boot) "
23531 "partition causes the bootloader to fail with C<0xC0000225> error.  Resizing "
23532 "the second partition (ie. C: drive)  should work."
23533 msgstr ""
23534
23535 #. type: textblock
23536 #: ../resize/virt-resize.pod:641
23537 msgid ""
23538 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
23539 "NTFS partitions have been expanded.  This is just a safety check and (unless "
23540 "it find errors) is nothing to worry about."
23541 msgstr ""
23542
23543 #. type: =head2
23544 #: ../resize/virt-resize.pod:645
23545 msgid "GUEST BOOT STUCK AT \"GRUB\""
23546 msgstr ""
23547
23548 #. type: textblock
23549 #: ../resize/virt-resize.pod:647
23550 msgid ""
23551 "If a Linux guest does not boot after resizing, and the boot is stuck after "
23552 "printing C<GRUB> on the console, try reinstalling grub."
23553 msgstr ""
23554
23555 #. type: verbatim
23556 #: ../resize/virt-resize.pod:650
23557 #, no-wrap
23558 msgid ""
23559 " guestfish -i -a newdisk\n"
23560 " ><fs> cat /boot/grub/device.map\n"
23561 " # check the contents of this file are sensible or\n"
23562 " # edit the file if necessary\n"
23563 " ><fs> grub-install / /dev/vda\n"
23564 " ><fs> exit\n"
23565 "\n"
23566 msgstr ""
23567
23568 #. type: textblock
23569 #: ../resize/virt-resize.pod:657
23570 msgid ""
23571 "For more flexible guest reconfiguration, including if you need to specify "
23572 "other parameters to grub-install, use L<virt-rescue(1)>."
23573 msgstr ""
23574
23575 #. type: =head1
23576 #: ../resize/virt-resize.pod:660
23577 msgid "ALTERNATIVE TOOLS"
23578 msgstr ""
23579
23580 #. type: textblock
23581 #: ../resize/virt-resize.pod:662
23582 msgid ""
23583 "There are several proprietary tools for resizing partitions.  We won't "
23584 "mention any here."
23585 msgstr ""
23586
23587 #. type: textblock
23588 #: ../resize/virt-resize.pod:665
23589 msgid ""
23590 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
23591 "operations on disk images.  They can resize and move partitions, but I don't "
23592 "think they can do anything with the contents, and they certainly don't "
23593 "understand LVM."
23594 msgstr ""
23595
23596 #. type: textblock
23597 #: ../resize/virt-resize.pod:670
23598 msgid ""
23599 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
23600 "but at a much lower level.  You will probably end up hand-calculating sector "
23601 "offsets, which is something that virt-resize was designed to avoid.  If you "
23602 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
23603 "I<--debug> flag."
23604 msgstr ""
23605
23606 #. type: textblock
23607 #: ../resize/virt-resize.pod:690
23608 msgid ""
23609 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
23610 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
23611 "L<ntfsresize(8)>, L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
23612 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
23613 "L<virt-sparsify(1)>, L<virt-alignment-scan(1)>, L<http://libguestfs.org/>."
23614 msgstr ""
23615
23616 #. type: textblock
23617 #: ../ruby/examples/guestfs-ruby.pod:5
23618 msgid "guestfs-ruby - How to use libguestfs from Ruby"
23619 msgstr ""
23620
23621 #. type: verbatim
23622 #: ../ruby/examples/guestfs-ruby.pod:9
23623 #, no-wrap
23624 msgid ""
23625 " require 'guestfs'\n"
23626 " g = Guestfs::Guestfs.new()\n"
23627 " g.add_drive_opts(\"disk.img\",\n"
23628 "                  :readonly => 1, :format => \"raw\")\n"
23629 " g.launch()\n"
23630 "\n"
23631 msgstr ""
23632
23633 #. type: textblock
23634 #: ../ruby/examples/guestfs-ruby.pod:17
23635 msgid ""
23636 "This manual page documents how to call libguestfs from the Ruby programming "
23637 "language.  This page just documents the differences from the C API and gives "
23638 "some examples.  If you are not familiar with using libguestfs, you also need "
23639 "to read L<guestfs(3)>."
23640 msgstr ""
23641
23642 #. type: textblock
23643 #: ../ruby/examples/guestfs-ruby.pod:24
23644 msgid ""
23645 "Errors from libguestfs functions are mapped into the C<Error> exception.  "
23646 "This has a single parameter which is the error message (a string)."
23647 msgstr ""
23648
23649 #. type: textblock
23650 #: ../ruby/examples/guestfs-ruby.pod:38
23651 msgid ""
23652 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
23653 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
23654 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
23655 msgstr ""
23656
23657 #. type: textblock
23658 #: ../sparsify/virt-sparsify.pod:5
23659 msgid "virt-sparsify - Make a virtual machine disk sparse"
23660 msgstr ""
23661
23662 #. type: verbatim
23663 #: ../sparsify/virt-sparsify.pod:9
23664 #, no-wrap
23665 msgid ""
23666 " virt-sparsify [--options] indisk outdisk\n"
23667 "\n"
23668 msgstr ""
23669
23670 #. type: textblock
23671 #: ../sparsify/virt-sparsify.pod:13
23672 msgid ""
23673 "Virt-sparsify is a tool which can make a virtual machine disk (or any disk "
23674 "image) sparse a.k.a. thin-provisioned.  This means that free space within "
23675 "the disk image can be converted back to free space on the host."
23676 msgstr ""
23677
23678 #. type: textblock
23679 #: ../sparsify/virt-sparsify.pod:18
23680 msgid ""
23681 "Virt-sparsify can locate and sparsify free space in most filesystems "
23682 "(eg. ext2/3/4, btrfs, NTFS, etc.), and also in LVM physical volumes."
23683 msgstr ""
23684
23685 #. type: textblock
23686 #: ../sparsify/virt-sparsify.pod:21
23687 msgid ""
23688 "Virt-sparsify can also convert between some disk formats, for example "
23689 "converting a raw disk image to a thin-provisioned qcow2 image."
23690 msgstr ""
23691
23692 #. type: textblock
23693 #: ../sparsify/virt-sparsify.pod:24
23694 msgid ""
23695 "Virt-sparsify can operate on any disk image, not just ones from virtual "
23696 "machines.  If a virtual machine has more than one attached disk, you must "
23697 "sparsify each one separately."
23698 msgstr ""
23699
23700 #. type: =head2
23701 #: ../sparsify/virt-sparsify.pod:28
23702 msgid "IMPORTANT LIMITATIONS"
23703 msgstr ""
23704
23705 #. type: textblock
23706 #: ../sparsify/virt-sparsify.pod:34
23707 msgid ""
23708 "Virt-sparsify does not do in-place modifications.  It copies from a source "
23709 "image to a destination image, leaving the source unchanged.  I<Check that "
23710 "the sparsification was successful before deleting the source image>."
23711 msgstr ""
23712
23713 #. type: textblock
23714 #: ../sparsify/virt-sparsify.pod:41
23715 msgid "The virtual machine I<must be shut down> before using this tool."
23716 msgstr ""
23717
23718 #. type: textblock
23719 #: ../sparsify/virt-sparsify.pod:45
23720 msgid ""
23721 "Virt-sparsify may require up to 2x the virtual size of the source disk image "
23722 "(1 temporary copy + 1 destination image).  This is in the worst case and "
23723 "usually much less space is required."
23724 msgstr ""
23725
23726 #. type: textblock
23727 #: ../sparsify/virt-sparsify.pod:51
23728 msgid "Virt-sparsify cannot resize disk images.  To do that, use L<virt-resize(1)>."
23729 msgstr ""
23730
23731 #. type: textblock
23732 #: ../sparsify/virt-sparsify.pod:56
23733 msgid "Virt-sparsify cannot handle encrypted disks."
23734 msgstr ""
23735
23736 #. type: textblock
23737 #: ../sparsify/virt-sparsify.pod:60
23738 msgid ""
23739 "Virt-sparsify cannot yet sparsify the space between partitions.  Note that "
23740 "this space is often used for critical items like bootloaders so it's not "
23741 "really unused."
23742 msgstr ""
23743
23744 #. type: textblock
23745 #: ../sparsify/virt-sparsify.pod:66
23746 msgid ""
23747 "Virt-sparsify does not yet know how to sparsify swapspace.  It is not safe "
23748 "to do this unless we can be sure there is no hibernation data, so at the "
23749 "moment swap partitions are ignored."
23750 msgstr ""
23751
23752 #. type: textblock
23753 #: ../sparsify/virt-sparsify.pod:72
23754 msgid ""
23755 "You may also want to read the manual pages for the associated tools "
23756 "L<virt-filesystems(1)> and L<virt-df(1)> before starting."
23757 msgstr ""
23758
23759 #. type: textblock
23760 #: ../sparsify/virt-sparsify.pod:77
23761 msgid "Typical usage is:"
23762 msgstr ""
23763
23764 #. type: verbatim
23765 #: ../sparsify/virt-sparsify.pod:79
23766 #, no-wrap
23767 msgid ""
23768 " virt-sparsify indisk outdisk\n"
23769 "\n"
23770 msgstr ""
23771
23772 #. type: textblock
23773 #: ../sparsify/virt-sparsify.pod:81
23774 msgid ""
23775 "which copies C<indisk> to C<outdisk>, making the output sparse.  C<outdisk> "
23776 "is created, or overwritten if it already exists.  The format of the input "
23777 "disk is detected (eg. qcow2) and the same format is used for the output "
23778 "disk."
23779 msgstr ""
23780
23781 #. type: textblock
23782 #: ../sparsify/virt-sparsify.pod:86
23783 msgid "To convert between formats, use the I<--convert> option:"
23784 msgstr ""
23785
23786 #. type: verbatim
23787 #: ../sparsify/virt-sparsify.pod:88
23788 #, no-wrap
23789 msgid ""
23790 " virt-sparsify disk.raw --convert qcow2 disk.qcow2\n"
23791 "\n"
23792 msgstr ""
23793
23794 #. type: textblock
23795 #: ../sparsify/virt-sparsify.pod:90
23796 msgid ""
23797 "Virt-sparsify tries to zero and sparsify free space on every filesystem it "
23798 "can find within the source disk image.  You can get it to ignore (don't zero "
23799 "free space on) certain filesystems by doing:"
23800 msgstr ""
23801
23802 #. type: verbatim
23803 #: ../sparsify/virt-sparsify.pod:94
23804 #, no-wrap
23805 msgid ""
23806 " virt-sparsify --ignore /dev/sda1 indisk outdisk\n"
23807 "\n"
23808 msgstr ""
23809
23810 #. type: textblock
23811 #: ../sparsify/virt-sparsify.pod:96
23812 msgid "See L<virt-filesystems(1)> to get a list of filesystems within a disk image."
23813 msgstr ""
23814
23815 #. type: =item
23816 #: ../sparsify/virt-sparsify.pod:107
23817 msgid "B<--convert> raw"
23818 msgstr ""
23819
23820 #. type: =item
23821 #: ../sparsify/virt-sparsify.pod:109
23822 msgid "B<--convert> qcow2"
23823 msgstr ""
23824
23825 #. type: =item
23826 #: ../sparsify/virt-sparsify.pod:111
23827 msgid "B<--convert> [other formats]"
23828 msgstr ""
23829
23830 #. type: textblock
23831 #: ../sparsify/virt-sparsify.pod:113
23832 msgid ""
23833 "Use C<output-format> as the format for the destination image.  If this is "
23834 "not specified, then the input format is used."
23835 msgstr ""
23836
23837 #. type: textblock
23838 #: ../sparsify/virt-sparsify.pod:116
23839 msgid "Supported and known-working output formats are: C<raw>, C<qcow2>."
23840 msgstr ""
23841
23842 #. type: textblock
23843 #: ../sparsify/virt-sparsify.pod:118
23844 msgid ""
23845 "You can also use any format supported by the L<qemu-img(1)> program, "
23846 "eg. C<vdi> or C<vmdk>, but support for other formats is reliant on qemu."
23847 msgstr ""
23848
23849 #. type: textblock
23850 #: ../sparsify/virt-sparsify.pod:122
23851 msgid ""
23852 "Specifying the I<--convert> option is usually a good idea, because then "
23853 "virt-sparsify doesn't need to try to guess the input format."
23854 msgstr ""
23855
23856 #. type: =item
23857 #: ../sparsify/virt-sparsify.pod:127
23858 msgid "B<--format> qcow2"
23859 msgstr ""
23860
23861 #. type: =item
23862 #: ../sparsify/virt-sparsify.pod:135
23863 msgid "B<--ignore> filesystem"
23864 msgstr ""
23865
23866 #. type: =item
23867 #: ../sparsify/virt-sparsify.pod:137
23868 msgid "B<--ignore> volgroup"
23869 msgstr ""
23870
23871 #. type: textblock
23872 #: ../sparsify/virt-sparsify.pod:139
23873 msgid ""
23874 "Ignore the named filesystem.  Free space on the filesystem will not be "
23875 "zeroed, but existing blocks of zeroes will still be sparsified."
23876 msgstr ""
23877
23878 #. type: textblock
23879 #: ../sparsify/virt-sparsify.pod:142
23880 msgid ""
23881 "In the second form, this ignores the named volume group.  Use the volume "
23882 "group name without the C</dev/> prefix, eg. I<--ignore vg_foo>"
23883 msgstr ""
23884
23885 #. type: textblock
23886 #: ../sparsify/virt-sparsify.pod:157
23887 msgid "This disables progress bars and other unnecessary output."
23888 msgstr ""
23889
23890 #. type: textblock
23891 #: ../sparsify/virt-sparsify.pod:179
23892 msgid ""
23893 "The I<--machine-readable> option can be used to make the output more machine "
23894 "friendly, which is useful when calling virt-sparsify from other programs, "
23895 "GUIs etc."
23896 msgstr ""
23897
23898 #. type: textblock
23899 #: ../sparsify/virt-sparsify.pod:185
23900 msgid ""
23901 "Firstly use the option on its own to query the capabilities of the "
23902 "virt-sparsify binary.  Typical output looks like this:"
23903 msgstr ""
23904
23905 #. type: verbatim
23906 #: ../sparsify/virt-sparsify.pod:188
23907 #, no-wrap
23908 msgid ""
23909 " $ virt-sparsify --machine-readable\n"
23910 " virt-sparsify\n"
23911 " ntfs\n"
23912 " btrfs\n"
23913 "\n"
23914 msgstr ""
23915
23916 #. type: textblock
23917 #: ../sparsify/virt-sparsify.pod:218
23918 msgid ""
23919 "The calling program should treat messages sent to stderr as error messages.  "
23920 "In addition, virt-sparsify exits with a non-zero status code if there was a "
23921 "fatal error."
23922 msgstr ""
23923
23924 #. type: textblock
23925 #: ../sparsify/virt-sparsify.pod:224
23926 msgid ""
23927 "All versions of virt-sparsify have supported the I<--machine-readable> "
23928 "option."
23929 msgstr ""
23930
23931 #. type: textblock
23932 #: ../sparsify/virt-sparsify.pod:238
23933 msgid ""
23934 "Location of the temporary directory used for the potentially large temporary "
23935 "overlay file."
23936 msgstr ""
23937
23938 #. type: textblock
23939 #: ../sparsify/virt-sparsify.pod:241
23940 msgid ""
23941 "You should ensure there is enough free space in the worst case for a full "
23942 "copy of the source disk (I<virtual> size), or else set C<$TMPDIR> to point "
23943 "to another directory that has enough space."
23944 msgstr ""
23945
23946 #. type: textblock
23947 #: ../sparsify/virt-sparsify.pod:245
23948 msgid "This defaults to C</tmp>."
23949 msgstr ""
23950
23951 #. type: textblock
23952 #: ../sparsify/virt-sparsify.pod:249
23953 msgid "For other environment variables, see L<guestfs(3)/ENVIRONMENT VARIABLES>."
23954 msgstr ""
23955
23956 #. type: textblock
23957 #: ../sparsify/virt-sparsify.pod:253
23958 msgid ""
23959 "L<virt-filesystems(1)>, L<virt-df(1)>, L<virt-resize(1)>, L<virt-rescue(1)>, "
23960 "L<guestfs(3)>, L<guestfish(1)>, L<truncate(1)>, L<fallocate(1)>, "
23961 "L<qemu-img(1)>, L<http://libguestfs.org/>."
23962 msgstr ""
23963
23964 #. type: =head2
23965 #: ../src/guestfs-actions.pod:1
23966 msgid "guestfs_add_cdrom"
23967 msgstr ""
23968
23969 #. type: verbatim
23970 #: ../src/guestfs-actions.pod:3
23971 #, no-wrap
23972 msgid ""
23973 " int\n"
23974 " guestfs_add_cdrom (guestfs_h *g,\n"
23975 "                    const char *filename);\n"
23976 "\n"
23977 msgstr ""
23978
23979 #. type: textblock
23980 #: ../src/guestfs-actions.pod:7 ../src/guestfs-actions.pod:302 ../src/guestfs-actions.pod:323
23981 msgid ""
23982 "I<This function is deprecated.> In new code, use the "
23983 "L</guestfs_add_drive_opts> call instead."
23984 msgstr ""
23985
23986 #. type: textblock
23987 #: ../src/guestfs-actions.pod:24
23988 msgid ""
23989 "This call checks for the existence of C<filename>.  This stops you from "
23990 "specifying other types of drive which are supported by qemu such as C<nbd:> "
23991 "and C<http:> URLs.  To specify those, use the general C<guestfs_config> call "
23992 "instead."
23993 msgstr ""
23994
23995 #. type: textblock
23996 #: ../src/guestfs-actions.pod:31
23997 msgid ""
23998 "If you just want to add an ISO file (often you use this as an efficient way "
23999 "to transfer large files into the guest), then you should probably use "
24000 "C<guestfs_add_drive_ro> instead."
24001 msgstr ""
24002
24003 #. type: textblock
24004 #: ../src/guestfs-actions.pod:37 ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:291 ../src/guestfs-actions.pod:312 ../src/guestfs-actions.pod:333 ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360 ../src/guestfs-actions.pod:480 ../src/guestfs-actions.pod:500 ../src/guestfs-actions.pod:514 ../src/guestfs-actions.pod:559 ../src/guestfs-actions.pod:587 ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:705 ../src/guestfs-actions.pod:719 ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:833 ../src/guestfs-actions.pod:851 ../src/guestfs-actions.pod:865 ../src/guestfs-actions.pod:879 ../src/guestfs-actions.pod:916 ../src/guestfs-actions.pod:1099 ../src/guestfs-actions.pod:1119 ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:1286 ../src/guestfs-actions.pod:1332 ../src/guestfs-actions.pod:1372 ../src/guestfs-actions.pod:1425 ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1536 ../src/guestfs-actions.pod:1590 ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1623 ../src/guestfs-actions.pod:1651 ../src/guestfs-actions.pod:1721 ../src/guestfs-actions.pod:1752 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1819 ../src/guestfs-actions.pod:1932 ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2174 ../src/guestfs-actions.pod:2196 ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2791 ../src/guestfs-actions.pod:2935 ../src/guestfs-actions.pod:2996 ../src/guestfs-actions.pod:3031 ../src/guestfs-actions.pod:4088 ../src/guestfs-actions.pod:4103 ../src/guestfs-actions.pod:4128 ../src/guestfs-actions.pod:4317 ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:4344 ../src/guestfs-actions.pod:4358 ../src/guestfs-actions.pod:4373 ../src/guestfs-actions.pod:4409 ../src/guestfs-actions.pod:4481 ../src/guestfs-actions.pod:4501 ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:4538 ../src/guestfs-actions.pod:4558 ../src/guestfs-actions.pod:4593 ../src/guestfs-actions.pod:4612 ../src/guestfs-actions.pod:4631 ../src/guestfs-actions.pod:4666 ../src/guestfs-actions.pod:4678 ../src/guestfs-actions.pod:4711 ../src/guestfs-actions.pod:4727 ../src/guestfs-actions.pod:4740 ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4865 ../src/guestfs-actions.pod:4885 ../src/guestfs-actions.pod:4898 ../src/guestfs-actions.pod:4949 ../src/guestfs-actions.pod:4967 ../src/guestfs-actions.pod:4985 ../src/guestfs-actions.pod:5001 ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5029 ../src/guestfs-actions.pod:5046 ../src/guestfs-actions.pod:5061 ../src/guestfs-actions.pod:5088 ../src/guestfs-actions.pod:5151 ../src/guestfs-actions.pod:5224 ../src/guestfs-actions.pod:5255 ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5293 ../src/guestfs-actions.pod:5305 ../src/guestfs-actions.pod:5322 ../src/guestfs-actions.pod:5335 ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5365 ../src/guestfs-actions.pod:5397 ../src/guestfs-actions.pod:5423 ../src/guestfs-actions.pod:5462 ../src/guestfs-actions.pod:5482 ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5513 ../src/guestfs-actions.pod:5562 ../src/guestfs-actions.pod:5615 ../src/guestfs-actions.pod:5662 ../src/guestfs-actions.pod:5705 ../src/guestfs-actions.pod:5733 ../src/guestfs-actions.pod:5750 ../src/guestfs-actions.pod:5768 ../src/guestfs-actions.pod:5905 ../src/guestfs-actions.pod:5962 ../src/guestfs-actions.pod:5984 ../src/guestfs-actions.pod:6002 ../src/guestfs-actions.pod:6054 ../src/guestfs-actions.pod:6120 ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6150 ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6453 ../src/guestfs-actions.pod:6472 ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6517 ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6543 ../src/guestfs-actions.pod:6557 ../src/guestfs-actions.pod:6573 ../src/guestfs-actions.pod:6591 ../src/guestfs-actions.pod:6610 ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6659 ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:6700 ../src/guestfs-actions.pod:6718 ../src/guestfs-actions.pod:6737 ../src/guestfs-actions.pod:6758 ../src/guestfs-actions.pod:6777 ../src/guestfs-actions.pod:6794 ../src/guestfs-actions.pod:6813 ../src/guestfs-actions.pod:6841 ../src/guestfs-actions.pod:6865 ../src/guestfs-actions.pod:6884 ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6924 ../src/guestfs-actions.pod:6943 ../src/guestfs-actions.pod:6958 ../src/guestfs-actions.pod:6977 ../src/guestfs-actions.pod:7021 ../src/guestfs-actions.pod:7048 ../src/guestfs-actions.pod:7078 ../src/guestfs-actions.pod:7190 ../src/guestfs-actions.pod:7311 ../src/guestfs-actions.pod:7323 ../src/guestfs-actions.pod:7336 ../src/guestfs-actions.pod:7349 ../src/guestfs-actions.pod:7371 ../src/guestfs-actions.pod:7384 ../src/guestfs-actions.pod:7397 ../src/guestfs-actions.pod:7410 ../src/guestfs-actions.pod:7425 ../src/guestfs-actions.pod:7484 ../src/guestfs-actions.pod:7501 ../src/guestfs-actions.pod:7517 ../src/guestfs-actions.pod:7533 ../src/guestfs-actions.pod:7550 ../src/guestfs-actions.pod:7563 ../src/guestfs-actions.pod:7583 ../src/guestfs-actions.pod:7619 ../src/guestfs-actions.pod:7633 ../src/guestfs-actions.pod:7674 ../src/guestfs-actions.pod:7687 ../src/guestfs-actions.pod:7705 ../src/guestfs-actions.pod:7739 ../src/guestfs-actions.pod:7775 ../src/guestfs-actions.pod:7891 ../src/guestfs-actions.pod:7906 ../src/guestfs-actions.pod:7920 ../src/guestfs-actions.pod:7975 ../src/guestfs-actions.pod:7988 ../src/guestfs-actions.pod:8033 ../src/guestfs-actions.pod:8073 ../src/guestfs-actions.pod:8129 ../src/guestfs-actions.pod:8149 ../src/guestfs-actions.pod:8182 ../src/guestfs-actions.pod:8246 ../src/guestfs-actions.pod:8269 ../src/guestfs-actions.pod:8295
24005 msgid "This function returns 0 on success or -1 on error."
24006 msgstr ""
24007
24008 #. type: textblock
24009 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:189 ../src/guestfs-actions.pod:1334 ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2495 ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:4090 ../src/guestfs-actions.pod:4110 ../src/guestfs-actions.pod:5399 ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6945 ../src/guestfs-actions.pod:7427 ../src/guestfs-actions.pod:7552 ../src/guestfs-actions.pod:8075
24010 msgid "(Added in 0.3)"
24011 msgstr ""
24012
24013 #. type: =head2
24014 #: ../src/guestfs-actions.pod:41
24015 msgid "guestfs_add_domain"
24016 msgstr ""
24017
24018 #. type: verbatim
24019 #: ../src/guestfs-actions.pod:43
24020 #, no-wrap
24021 msgid ""
24022 " int\n"
24023 " guestfs_add_domain (guestfs_h *g,\n"
24024 "                     const char *dom,\n"
24025 "                     ...);\n"
24026 "\n"
24027 msgstr ""
24028
24029 #. type: textblock
24030 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:198 ../src/guestfs-actions.pod:890 ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1266 ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:1466 ../src/guestfs-actions.pod:1519 ../src/guestfs-actions.pod:3288 ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5409 ../src/guestfs-actions.pod:5626
24031 msgid ""
24032 "You may supply a list of optional arguments to this call.  Use zero or more "
24033 "of the following pairs of parameters, and terminate the list with C<-1> on "
24034 "its own.  See L</CALLS WITH OPTIONAL ARGUMENTS>."
24035 msgstr ""
24036
24037 #. type: verbatim
24038 #: ../src/guestfs-actions.pod:53
24039 #, no-wrap
24040 msgid ""
24041 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
24042 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
24043 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
24044 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
24045 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
24046 " GUESTFS_ADD_DOMAIN_READONLYDISK, const char *readonlydisk,\n"
24047 "\n"
24048 msgstr ""
24049
24050 #. type: textblock
24051 #: ../src/guestfs-actions.pod:60
24052 msgid ""
24053 "This function adds the disk(s) attached to the named libvirt domain C<dom>.  "
24054 "It works by connecting to libvirt, requesting the domain and domain XML from "
24055 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
24056 "one."
24057 msgstr ""
24058
24059 #. type: textblock
24060 #: ../src/guestfs-actions.pod:141
24061 msgid ""
24062 "The other optional parameters are passed directly through to "
24063 "C<guestfs_add_drive_opts>."
24064 msgstr ""
24065
24066 #. type: textblock
24067 #: ../src/guestfs-actions.pod:144 ../src/guestfs-actions.pod:403 ../src/guestfs-actions.pod:573 ../src/guestfs-actions.pod:751 ../src/guestfs-actions.pod:782 ../src/guestfs-actions.pod:800 ../src/guestfs-actions.pod:819 ../src/guestfs-actions.pod:1797 ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:2356 ../src/guestfs-actions.pod:2467 ../src/guestfs-actions.pod:2518 ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:2584 ../src/guestfs-actions.pod:2607 ../src/guestfs-actions.pod:2922 ../src/guestfs-actions.pod:3406 ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:5585 ../src/guestfs-actions.pod:5802 ../src/guestfs-actions.pod:6040 ../src/guestfs-actions.pod:6234 ../src/guestfs-actions.pod:6260 ../src/guestfs-actions.pod:7660 ../src/guestfs-actions.pod:8086 ../src/guestfs-actions.pod:8099 ../src/guestfs-actions.pod:8112
24068 msgid "On error this function returns -1."
24069 msgstr ""
24070
24071 #. type: textblock
24072 #: ../src/guestfs-actions.pod:146
24073 msgid "(Added in 1.7.4)"
24074 msgstr ""
24075
24076 #. type: =head2
24077 #: ../src/guestfs-actions.pod:148
24078 msgid "guestfs_add_domain_va"
24079 msgstr ""
24080
24081 #. type: verbatim
24082 #: ../src/guestfs-actions.pod:150
24083 #, no-wrap
24084 msgid ""
24085 " int\n"
24086 " guestfs_add_domain_va (guestfs_h *g,\n"
24087 "                        const char *dom,\n"
24088 "                        va_list args);\n"
24089 "\n"
24090 msgstr ""
24091
24092 #. type: textblock
24093 #: ../src/guestfs-actions.pod:155
24094 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
24095 msgstr ""
24096
24097 #. type: textblock
24098 #: ../src/guestfs-actions.pod:157 ../src/guestfs-actions.pod:168 ../src/guestfs-actions.pod:267 ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:929 ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:1242 ../src/guestfs-actions.pod:1255 ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1314 ../src/guestfs-actions.pod:1391 ../src/guestfs-actions.pod:1403 ../src/guestfs-actions.pod:1444 ../src/guestfs-actions.pod:1456 ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1509 ../src/guestfs-actions.pod:1555 ../src/guestfs-actions.pod:1567 ../src/guestfs-actions.pod:3372 ../src/guestfs-actions.pod:3384 ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:5437 ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5675 ../src/guestfs-actions.pod:5686
24099 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
24100 msgstr ""
24101
24102 #. type: =head2
24103 #: ../src/guestfs-actions.pod:159
24104 msgid "guestfs_add_domain_argv"
24105 msgstr ""
24106
24107 #. type: verbatim
24108 #: ../src/guestfs-actions.pod:161
24109 #, no-wrap
24110 msgid ""
24111 " int\n"
24112 " guestfs_add_domain_argv (guestfs_h *g,\n"
24113 "                          const char *dom,\n"
24114 "                          const struct guestfs_add_domain_argv *optargs);\n"
24115 "\n"
24116 msgstr ""
24117
24118 #. type: textblock
24119 #: ../src/guestfs-actions.pod:166
24120 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
24121 msgstr ""
24122
24123 #. type: =head2
24124 #: ../src/guestfs-actions.pod:170
24125 msgid "guestfs_add_drive"
24126 msgstr ""
24127
24128 #. type: verbatim
24129 #: ../src/guestfs-actions.pod:172
24130 #, no-wrap
24131 msgid ""
24132 " int\n"
24133 " guestfs_add_drive (guestfs_h *g,\n"
24134 "                    const char *filename);\n"
24135 "\n"
24136 msgstr ""
24137
24138 #. type: textblock
24139 #: ../src/guestfs-actions.pod:176
24140 msgid ""
24141 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
24142 "optional parameters, so the disk is added writable, with the format being "
24143 "detected automatically."
24144 msgstr ""
24145
24146 #. type: textblock
24147 #: ../src/guestfs-actions.pod:180
24148 msgid ""
24149 "Automatic detection of the format opens you up to a potential security hole "
24150 "when dealing with untrusted raw-format images.  See CVE-2010-3851 and "
24151 "RHBZ#642934.  Specifying the format closes this security hole.  Therefore "
24152 "you should think about replacing calls to this function with calls to "
24153 "C<guestfs_add_drive_opts>, and specifying the format."
24154 msgstr ""
24155
24156 #. type: =head2
24157 #: ../src/guestfs-actions.pod:191
24158 msgid "guestfs_add_drive_opts"
24159 msgstr ""
24160
24161 #. type: verbatim
24162 #: ../src/guestfs-actions.pod:193
24163 #, no-wrap
24164 msgid ""
24165 " int\n"
24166 " guestfs_add_drive_opts (guestfs_h *g,\n"
24167 "                         const char *filename,\n"
24168 "                         ...);\n"
24169 "\n"
24170 msgstr ""
24171
24172 #. type: verbatim
24173 #: ../src/guestfs-actions.pod:203
24174 #, no-wrap
24175 msgid ""
24176 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
24177 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
24178 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
24179 " GUESTFS_ADD_DRIVE_OPTS_NAME, const char *name,\n"
24180 "\n"
24181 msgstr ""
24182
24183 #. type: textblock
24184 #: ../src/guestfs-actions.pod:233
24185 msgid ""
24186 "This forces the image format.  If you omit this (or use C<guestfs_add_drive> "
24187 "or C<guestfs_add_drive_ro>) then the format is automatically detected.  "
24188 "Possible formats include C<raw> and C<qcow2>."
24189 msgstr ""
24190
24191 #. type: textblock
24192 #: ../src/guestfs-actions.pod:244
24193 msgid ""
24194 "This rarely-used option lets you emulate the behaviour of the deprecated "
24195 "C<guestfs_add_drive_with_if> call (q.v.)"
24196 msgstr ""
24197
24198 #. type: textblock
24199 #: ../src/guestfs-actions.pod:256
24200 msgid "(Added in 1.5.23)"
24201 msgstr ""
24202
24203 #. type: =head2
24204 #: ../src/guestfs-actions.pod:258
24205 msgid "guestfs_add_drive_opts_va"
24206 msgstr ""
24207
24208 #. type: verbatim
24209 #: ../src/guestfs-actions.pod:260
24210 #, no-wrap
24211 msgid ""
24212 " int\n"
24213 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
24214 "                            const char *filename,\n"
24215 "                            va_list args);\n"
24216 "\n"
24217 msgstr ""
24218
24219 #. type: textblock
24220 #: ../src/guestfs-actions.pod:265
24221 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
24222 msgstr ""
24223
24224 #. type: =head2
24225 #: ../src/guestfs-actions.pod:269
24226 msgid "guestfs_add_drive_opts_argv"
24227 msgstr ""
24228
24229 #. type: verbatim
24230 #: ../src/guestfs-actions.pod:271
24231 #, no-wrap
24232 msgid ""
24233 " int\n"
24234 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
24235 "                              const char *filename,\n"
24236 "                              const struct guestfs_add_drive_opts_argv "
24237 "*optargs);\n"
24238 "\n"
24239 msgstr ""
24240
24241 #. type: textblock
24242 #: ../src/guestfs-actions.pod:276
24243 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
24244 msgstr ""
24245
24246 #. type: =head2
24247 #: ../src/guestfs-actions.pod:280
24248 msgid "guestfs_add_drive_ro"
24249 msgstr ""
24250
24251 #. type: verbatim
24252 #: ../src/guestfs-actions.pod:282
24253 #, no-wrap
24254 msgid ""
24255 " int\n"
24256 " guestfs_add_drive_ro (guestfs_h *g,\n"
24257 "                       const char *filename);\n"
24258 "\n"
24259 msgstr ""
24260
24261 #. type: textblock
24262 #: ../src/guestfs-actions.pod:286
24263 msgid ""
24264 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
24265 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
24266 "disk is added read-only, with the format being detected automatically."
24267 msgstr ""
24268
24269 #. type: textblock
24270 #: ../src/guestfs-actions.pod:293
24271 msgid "(Added in 1.0.38)"
24272 msgstr ""
24273
24274 #. type: =head2
24275 #: ../src/guestfs-actions.pod:295
24276 msgid "guestfs_add_drive_ro_with_if"
24277 msgstr ""
24278
24279 #. type: verbatim
24280 #: ../src/guestfs-actions.pod:297
24281 #, no-wrap
24282 msgid ""
24283 " int\n"
24284 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
24285 "                               const char *filename,\n"
24286 "                               const char *iface);\n"
24287 "\n"
24288 msgstr ""
24289
24290 #. type: textblock
24291 #: ../src/guestfs-actions.pod:309
24292 msgid ""
24293 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
24294 "QEMU interface emulation to use at run time."
24295 msgstr ""
24296
24297 #. type: textblock
24298 #: ../src/guestfs-actions.pod:314 ../src/guestfs-actions.pod:335 ../src/guestfs-actions.pod:2881
24299 msgid "(Added in 1.0.84)"
24300 msgstr ""
24301
24302 #. type: =head2
24303 #: ../src/guestfs-actions.pod:316
24304 msgid "guestfs_add_drive_with_if"
24305 msgstr ""
24306
24307 #. type: verbatim
24308 #: ../src/guestfs-actions.pod:318
24309 #, no-wrap
24310 msgid ""
24311 " int\n"
24312 " guestfs_add_drive_with_if (guestfs_h *g,\n"
24313 "                            const char *filename,\n"
24314 "                            const char *iface);\n"
24315 "\n"
24316 msgstr ""
24317
24318 #. type: textblock
24319 #: ../src/guestfs-actions.pod:330
24320 msgid ""
24321 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
24322 "QEMU interface emulation to use at run time."
24323 msgstr ""
24324
24325 #. type: =head2
24326 #: ../src/guestfs-actions.pod:337
24327 msgid "guestfs_aug_clear"
24328 msgstr ""
24329
24330 #. type: verbatim
24331 #: ../src/guestfs-actions.pod:339
24332 #, no-wrap
24333 msgid ""
24334 " int\n"
24335 " guestfs_aug_clear (guestfs_h *g,\n"
24336 "                    const char *augpath);\n"
24337 "\n"
24338 msgstr ""
24339
24340 #. type: textblock
24341 #: ../src/guestfs-actions.pod:348 ../src/guestfs-actions.pod:2609
24342 msgid "(Added in 1.3.4)"
24343 msgstr ""
24344
24345 #. type: =head2
24346 #: ../src/guestfs-actions.pod:350
24347 msgid "guestfs_aug_close"
24348 msgstr ""
24349
24350 #. type: verbatim
24351 #: ../src/guestfs-actions.pod:352
24352 #, no-wrap
24353 msgid ""
24354 " int\n"
24355 " guestfs_aug_close (guestfs_h *g);\n"
24356 "\n"
24357 msgstr ""
24358
24359 #. type: textblock
24360 #: ../src/guestfs-actions.pod:355
24361 msgid ""
24362 "Close the current Augeas handle and free up any resources used by it.  After "
24363 "calling this, you have to call C<guestfs_aug_init> again before you can use "
24364 "any other Augeas functions."
24365 msgstr ""
24366
24367 #. type: textblock
24368 #: ../src/guestfs-actions.pod:362 ../src/guestfs-actions.pod:387 ../src/guestfs-actions.pod:405 ../src/guestfs-actions.pod:419 ../src/guestfs-actions.pod:482 ../src/guestfs-actions.pod:502 ../src/guestfs-actions.pod:516 ../src/guestfs-actions.pod:547 ../src/guestfs-actions.pod:561 ../src/guestfs-actions.pod:575 ../src/guestfs-actions.pod:589 ../src/guestfs-actions.pod:607 ../src/guestfs-actions.pod:6311
24369 msgid "(Added in 0.7)"
24370 msgstr ""
24371
24372 #. type: =head2
24373 #: ../src/guestfs-actions.pod:364
24374 msgid "guestfs_aug_defnode"
24375 msgstr ""
24376
24377 #. type: verbatim
24378 #: ../src/guestfs-actions.pod:366
24379 #, no-wrap
24380 msgid ""
24381 " struct guestfs_int_bool *\n"
24382 " guestfs_aug_defnode (guestfs_h *g,\n"
24383 "                      const char *name,\n"
24384 "                      const char *expr,\n"
24385 "                      const char *val);\n"
24386 "\n"
24387 msgstr ""
24388
24389 #. type: textblock
24390 #: ../src/guestfs-actions.pod:375
24391 msgid ""
24392 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24393 "calling C<guestfs_aug_set> C<expr>, C<value>.  C<name> will be the nodeset "
24394 "containing that single node."
24395 msgstr ""
24396
24397 #. type: textblock
24398 #: ../src/guestfs-actions.pod:383
24399 msgid ""
24400 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
24401 "an error.  I<The caller must call C<guestfs_free_int_bool> after use>."
24402 msgstr ""
24403
24404 #. type: =head2
24405 #: ../src/guestfs-actions.pod:389
24406 msgid "guestfs_aug_defvar"
24407 msgstr ""
24408
24409 #. type: verbatim
24410 #: ../src/guestfs-actions.pod:391
24411 #, no-wrap
24412 msgid ""
24413 " int\n"
24414 " guestfs_aug_defvar (guestfs_h *g,\n"
24415 "                     const char *name,\n"
24416 "                     const char *expr);\n"
24417 "\n"
24418 msgstr ""
24419
24420 #. type: =head2
24421 #: ../src/guestfs-actions.pod:407
24422 msgid "guestfs_aug_get"
24423 msgstr ""
24424
24425 #. type: verbatim
24426 #: ../src/guestfs-actions.pod:409
24427 #, no-wrap
24428 msgid ""
24429 " char *\n"
24430 " guestfs_aug_get (guestfs_h *g,\n"
24431 "                  const char *augpath);\n"
24432 "\n"
24433 msgstr ""
24434
24435 #. type: textblock
24436 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:980 ../src/guestfs-actions.pod:998 ../src/guestfs-actions.pod:1058 ../src/guestfs-actions.pod:1074 ../src/guestfs-actions.pod:1177 ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1683 ../src/guestfs-actions.pod:1702 ../src/guestfs-actions.pod:1836 ../src/guestfs-actions.pod:2024 ../src/guestfs-actions.pod:2136 ../src/guestfs-actions.pod:2299 ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2383 ../src/guestfs-actions.pod:2426 ../src/guestfs-actions.pod:2447 ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:3050 ../src/guestfs-actions.pod:3152 ../src/guestfs-actions.pod:3256 ../src/guestfs-actions.pod:3275 ../src/guestfs-actions.pod:3490 ../src/guestfs-actions.pod:3518 ../src/guestfs-actions.pod:3539 ../src/guestfs-actions.pod:3573 ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:3656 ../src/guestfs-actions.pod:3676 ../src/guestfs-actions.pod:4303 ../src/guestfs-actions.pod:4650 ../src/guestfs-actions.pod:4817 ../src/guestfs-actions.pod:4927 ../src/guestfs-actions.pod:5820 ../src/guestfs-actions.pod:6021 ../src/guestfs-actions.pod:6209 ../src/guestfs-actions.pod:6387 ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:7096 ../src/guestfs-actions.pod:7112 ../src/guestfs-actions.pod:7136 ../src/guestfs-actions.pod:7160 ../src/guestfs-actions.pod:7834 ../src/guestfs-actions.pod:7853 ../src/guestfs-actions.pod:7871 ../src/guestfs-actions.pod:8045 ../src/guestfs-actions.pod:8359
24437 msgid ""
24438 "This function returns a string, or NULL on error.  I<The caller must free "
24439 "the returned string after use>."
24440 msgstr ""
24441
24442 #. type: =head2
24443 #: ../src/guestfs-actions.pod:421
24444 msgid "guestfs_aug_init"
24445 msgstr ""
24446
24447 #. type: verbatim
24448 #: ../src/guestfs-actions.pod:423
24449 #, no-wrap
24450 msgid ""
24451 " int\n"
24452 " guestfs_aug_init (guestfs_h *g,\n"
24453 "                   const char *root,\n"
24454 "                   int flags);\n"
24455 "\n"
24456 msgstr ""
24457
24458 #. type: textblock
24459 #: ../src/guestfs-actions.pod:432
24460 msgid "You must call this before using any other C<guestfs_aug_*> commands."
24461 msgstr ""
24462
24463 #. type: textblock
24464 #: ../src/guestfs-actions.pod:457
24465 msgid ""
24466 "This option is only useful when debugging Augeas lenses.  Use of this option "
24467 "may require additional memory for the libguestfs appliance.  You may need to "
24468 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
24469 "C<guestfs_set_memsize>."
24470 msgstr ""
24471
24472 #. type: textblock
24473 #: ../src/guestfs-actions.pod:472
24474 msgid "Do not load the tree in C<guestfs_aug_init>."
24475 msgstr ""
24476
24477 #. type: textblock
24478 #: ../src/guestfs-actions.pod:476
24479 msgid "To close the handle, you can call C<guestfs_aug_close>."
24480 msgstr ""
24481
24482 #. type: =head2
24483 #: ../src/guestfs-actions.pod:484
24484 msgid "guestfs_aug_insert"
24485 msgstr ""
24486
24487 #. type: verbatim
24488 #: ../src/guestfs-actions.pod:486
24489 #, no-wrap
24490 msgid ""
24491 " int\n"
24492 " guestfs_aug_insert (guestfs_h *g,\n"
24493 "                     const char *augpath,\n"
24494 "                     const char *label,\n"
24495 "                     int before);\n"
24496 "\n"
24497 msgstr ""
24498
24499 #. type: =head2
24500 #: ../src/guestfs-actions.pod:504
24501 msgid "guestfs_aug_load"
24502 msgstr ""
24503
24504 #. type: verbatim
24505 #: ../src/guestfs-actions.pod:506
24506 #, no-wrap
24507 msgid ""
24508 " int\n"
24509 " guestfs_aug_load (guestfs_h *g);\n"
24510 "\n"
24511 msgstr ""
24512
24513 #. type: =head2
24514 #: ../src/guestfs-actions.pod:518
24515 msgid "guestfs_aug_ls"
24516 msgstr ""
24517
24518 #. type: verbatim
24519 #: ../src/guestfs-actions.pod:520
24520 #, no-wrap
24521 msgid ""
24522 " char **\n"
24523 " guestfs_aug_ls (guestfs_h *g,\n"
24524 "                 const char *augpath);\n"
24525 "\n"
24526 msgstr ""
24527
24528 #. type: textblock
24529 #: ../src/guestfs-actions.pod:524
24530 msgid ""
24531 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
24532 "sorting the resulting nodes into alphabetical order."
24533 msgstr ""
24534
24535 #. type: textblock
24536 #: ../src/guestfs-actions.pod:527 ../src/guestfs-actions.pod:543 ../src/guestfs-actions.pod:689 ../src/guestfs-actions.pod:1196 ../src/guestfs-actions.pod:1851 ../src/guestfs-actions.pod:1870 ../src/guestfs-actions.pod:1973 ../src/guestfs-actions.pod:1992 ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2704 ../src/guestfs-actions.pod:2720 ../src/guestfs-actions.pod:2739 ../src/guestfs-actions.pod:2804 ../src/guestfs-actions.pod:2828 ../src/guestfs-actions.pod:2899 ../src/guestfs-actions.pod:2948 ../src/guestfs-actions.pod:3217 ../src/guestfs-actions.pod:3592 ../src/guestfs-actions.pod:3872 ../src/guestfs-actions.pod:4186 ../src/guestfs-actions.pod:4203 ../src/guestfs-actions.pod:4223 ../src/guestfs-actions.pod:4285 ../src/guestfs-actions.pod:4390 ../src/guestfs-actions.pod:4789 ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:6181 ../src/guestfs-actions.pod:6307 ../src/guestfs-actions.pod:6421 ../src/guestfs-actions.pod:7176 ../src/guestfs-actions.pod:7237 ../src/guestfs-actions.pod:7292 ../src/guestfs-actions.pod:7438 ../src/guestfs-actions.pod:7462 ../src/guestfs-actions.pod:7938 ../src/guestfs-actions.pod:7958 ../src/guestfs-actions.pod:8005 ../src/guestfs-actions.pod:8199 ../src/guestfs-actions.pod:8218 ../src/guestfs-actions.pod:8309 ../src/guestfs-actions.pod:8328 ../src/guestfs-actions.pod:8374 ../src/guestfs-actions.pod:8393
24537 msgid ""
24538 "This function returns a NULL-terminated array of strings (like "
24539 "L<environ(3)>), or NULL if there was an error.  I<The caller must free the "
24540 "strings and the array after use>."
24541 msgstr ""
24542
24543 #. type: textblock
24544 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:1121 ../src/guestfs-actions.pod:1139 ../src/guestfs-actions.pod:1908 ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:3981 ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4680 ../src/guestfs-actions.pod:4867 ../src/guestfs-actions.pod:4900 ../src/guestfs-actions.pod:5063 ../src/guestfs-actions.pod:5550 ../src/guestfs-actions.pod:6122 ../src/guestfs-actions.pod:6519 ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6545 ../src/guestfs-actions.pod:7023 ../src/guestfs-actions.pod:7676 ../src/guestfs-actions.pod:7689 ../src/guestfs-actions.pod:7922 ../src/guestfs-actions.pod:8187
24545 msgid "(Added in 0.8)"
24546 msgstr ""
24547
24548 #. type: =head2
24549 #: ../src/guestfs-actions.pod:533
24550 msgid "guestfs_aug_match"
24551 msgstr ""
24552
24553 #. type: verbatim
24554 #: ../src/guestfs-actions.pod:535
24555 #, no-wrap
24556 msgid ""
24557 " char **\n"
24558 " guestfs_aug_match (guestfs_h *g,\n"
24559 "                    const char *augpath);\n"
24560 "\n"
24561 msgstr ""
24562
24563 #. type: =head2
24564 #: ../src/guestfs-actions.pod:549
24565 msgid "guestfs_aug_mv"
24566 msgstr ""
24567
24568 #. type: verbatim
24569 #: ../src/guestfs-actions.pod:551
24570 #, no-wrap
24571 msgid ""
24572 " int\n"
24573 " guestfs_aug_mv (guestfs_h *g,\n"
24574 "                 const char *src,\n"
24575 "                 const char *dest);\n"
24576 "\n"
24577 msgstr ""
24578
24579 #. type: =head2
24580 #: ../src/guestfs-actions.pod:563
24581 msgid "guestfs_aug_rm"
24582 msgstr ""
24583
24584 #. type: verbatim
24585 #: ../src/guestfs-actions.pod:565
24586 #, no-wrap
24587 msgid ""
24588 " int\n"
24589 " guestfs_aug_rm (guestfs_h *g,\n"
24590 "                 const char *augpath);\n"
24591 "\n"
24592 msgstr ""
24593
24594 #. type: =head2
24595 #: ../src/guestfs-actions.pod:577
24596 msgid "guestfs_aug_save"
24597 msgstr ""
24598
24599 #. type: verbatim
24600 #: ../src/guestfs-actions.pod:579
24601 #, no-wrap
24602 msgid ""
24603 " int\n"
24604 " guestfs_aug_save (guestfs_h *g);\n"
24605 "\n"
24606 msgstr ""
24607
24608 #. type: textblock
24609 #: ../src/guestfs-actions.pod:584
24610 msgid ""
24611 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
24612 "are saved."
24613 msgstr ""
24614
24615 #. type: =head2
24616 #: ../src/guestfs-actions.pod:591
24617 msgid "guestfs_aug_set"
24618 msgstr ""
24619
24620 #. type: verbatim
24621 #: ../src/guestfs-actions.pod:593
24622 #, no-wrap
24623 msgid ""
24624 " int\n"
24625 " guestfs_aug_set (guestfs_h *g,\n"
24626 "                  const char *augpath,\n"
24627 "                  const char *val);\n"
24628 "\n"
24629 msgstr ""
24630
24631 #. type: textblock
24632 #: ../src/guestfs-actions.pod:600
24633 msgid ""
24634 "In the Augeas API, it is possible to clear a node by setting the value to "
24635 "NULL.  Due to an oversight in the libguestfs API you cannot do that with "
24636 "this call.  Instead you must use the C<guestfs_aug_clear> call."
24637 msgstr ""
24638
24639 #. type: =head2
24640 #: ../src/guestfs-actions.pod:609
24641 msgid "guestfs_available"
24642 msgstr ""
24643
24644 #. type: verbatim
24645 #: ../src/guestfs-actions.pod:611
24646 #, no-wrap
24647 msgid ""
24648 " int\n"
24649 " guestfs_available (guestfs_h *g,\n"
24650 "                    char *const *groups);\n"
24651 "\n"
24652 msgstr ""
24653
24654 #. type: textblock
24655 #: ../src/guestfs-actions.pod:619
24656 msgid ""
24657 "The libguestfs groups, and the functions that those groups correspond to, "
24658 "are listed in L<guestfs(3)/AVAILABILITY>.  You can also fetch this list at "
24659 "runtime by calling C<guestfs_available_all_groups>."
24660 msgstr ""
24661
24662 #. type: textblock
24663 #: ../src/guestfs-actions.pod:643
24664 msgid "You must call C<guestfs_launch> before calling this function."
24665 msgstr ""
24666
24667 #. type: textblock
24668 #: ../src/guestfs-actions.pod:665
24669 msgid ""
24670 "This call was added in version C<1.0.80>.  In previous versions of "
24671 "libguestfs all you could do would be to speculatively execute a command to "
24672 "find out if the daemon implemented it.  See also C<guestfs_version>."
24673 msgstr ""
24674
24675 #. type: textblock
24676 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:1653
24677 msgid "(Added in 1.0.80)"
24678 msgstr ""
24679
24680 #. type: =head2
24681 #: ../src/guestfs-actions.pod:676
24682 msgid "guestfs_available_all_groups"
24683 msgstr ""
24684
24685 #. type: verbatim
24686 #: ../src/guestfs-actions.pod:678
24687 #, no-wrap
24688 msgid ""
24689 " char **\n"
24690 " guestfs_available_all_groups (guestfs_h *g);\n"
24691 "\n"
24692 msgstr ""
24693
24694 #. type: textblock
24695 #: ../src/guestfs-actions.pod:681
24696 msgid ""
24697 "This command returns a list of all optional groups that this daemon knows "
24698 "about.  Note this returns both supported and unsupported groups.  To find "
24699 "out which ones the daemon can actually support you have to call "
24700 "C<guestfs_available> on each member of the returned list."
24701 msgstr ""
24702
24703 #. type: textblock
24704 #: ../src/guestfs-actions.pod:687
24705 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
24706 msgstr ""
24707
24708 #. type: textblock
24709 #: ../src/guestfs-actions.pod:693
24710 msgid "(Added in 1.3.15)"
24711 msgstr ""
24712
24713 #. type: =head2
24714 #: ../src/guestfs-actions.pod:695
24715 msgid "guestfs_base64_in"
24716 msgstr ""
24717
24718 #. type: verbatim
24719 #: ../src/guestfs-actions.pod:697
24720 #, no-wrap
24721 msgid ""
24722 " int\n"
24723 " guestfs_base64_in (guestfs_h *g,\n"
24724 "                    const char *base64file,\n"
24725 "                    const char *filename);\n"
24726 "\n"
24727 msgstr ""
24728
24729 #. type: textblock
24730 #: ../src/guestfs-actions.pod:707 ../src/guestfs-actions.pod:721
24731 msgid "(Added in 1.3.5)"
24732 msgstr ""
24733
24734 #. type: =head2
24735 #: ../src/guestfs-actions.pod:709
24736 msgid "guestfs_base64_out"
24737 msgstr ""
24738
24739 #. type: verbatim
24740 #: ../src/guestfs-actions.pod:711
24741 #, no-wrap
24742 msgid ""
24743 " int\n"
24744 " guestfs_base64_out (guestfs_h *g,\n"
24745 "                     const char *filename,\n"
24746 "                     const char *base64file);\n"
24747 "\n"
24748 msgstr ""
24749
24750 #. type: =head2
24751 #: ../src/guestfs-actions.pod:723
24752 msgid "guestfs_blockdev_flushbufs"
24753 msgstr ""
24754
24755 #. type: verbatim
24756 #: ../src/guestfs-actions.pod:725
24757 #, no-wrap
24758 msgid ""
24759 " int\n"
24760 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
24761 "                             const char *device);\n"
24762 "\n"
24763 msgstr ""
24764
24765 #. type: textblock
24766 #: ../src/guestfs-actions.pod:736 ../src/guestfs-actions.pod:753 ../src/guestfs-actions.pod:768 ../src/guestfs-actions.pod:784 ../src/guestfs-actions.pod:802 ../src/guestfs-actions.pod:821 ../src/guestfs-actions.pod:835 ../src/guestfs-actions.pod:853 ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:881
24767 msgid "(Added in 0.9.3)"
24768 msgstr ""
24769
24770 #. type: =head2
24771 #: ../src/guestfs-actions.pod:738
24772 msgid "guestfs_blockdev_getbsz"
24773 msgstr ""
24774
24775 #. type: verbatim
24776 #: ../src/guestfs-actions.pod:740
24777 #, no-wrap
24778 msgid ""
24779 " int\n"
24780 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
24781 "                          const char *device);\n"
24782 "\n"
24783 msgstr ""
24784
24785 #. type: =head2
24786 #: ../src/guestfs-actions.pod:755
24787 msgid "guestfs_blockdev_getro"
24788 msgstr ""
24789
24790 #. type: verbatim
24791 #: ../src/guestfs-actions.pod:757
24792 #, no-wrap
24793 msgid ""
24794 " int\n"
24795 " guestfs_blockdev_getro (guestfs_h *g,\n"
24796 "                         const char *device);\n"
24797 "\n"
24798 msgstr ""
24799
24800 #. type: textblock
24801 #: ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:1891 ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:2395 ../src/guestfs-actions.pod:2406 ../src/guestfs-actions.pod:2478 ../src/guestfs-actions.pod:2504 ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2595 ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:3693 ../src/guestfs-actions.pod:3709 ../src/guestfs-actions.pod:3727 ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3903 ../src/guestfs-actions.pod:3918 ../src/guestfs-actions.pod:3932 ../src/guestfs-actions.pod:3948 ../src/guestfs-actions.pod:3963 ../src/guestfs-actions.pod:3979 ../src/guestfs-actions.pod:3993 ../src/guestfs-actions.pod:4006 ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4035 ../src/guestfs-actions.pod:4050 ../src/guestfs-actions.pod:4063 ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:5784
24802 msgid "This function returns a C truth value on success or -1 on error."
24803 msgstr ""
24804
24805 #. type: =head2
24806 #: ../src/guestfs-actions.pod:770
24807 msgid "guestfs_blockdev_getsize64"
24808 msgstr ""
24809
24810 #. type: verbatim
24811 #: ../src/guestfs-actions.pod:772
24812 #, no-wrap
24813 msgid ""
24814 " int64_t\n"
24815 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
24816 "                             const char *device);\n"
24817 "\n"
24818 msgstr ""
24819
24820 #. type: textblock
24821 #: ../src/guestfs-actions.pod:778
24822 msgid "See also C<guestfs_blockdev_getsz>."
24823 msgstr ""
24824
24825 #. type: =head2
24826 #: ../src/guestfs-actions.pod:786
24827 msgid "guestfs_blockdev_getss"
24828 msgstr ""
24829
24830 #. type: verbatim
24831 #: ../src/guestfs-actions.pod:788
24832 #, no-wrap
24833 msgid ""
24834 " int\n"
24835 " guestfs_blockdev_getss (guestfs_h *g,\n"
24836 "                         const char *device);\n"
24837 "\n"
24838 msgstr ""
24839
24840 #. type: textblock
24841 #: ../src/guestfs-actions.pod:795
24842 msgid ""
24843 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
24844 "that)."
24845 msgstr ""
24846
24847 #. type: =head2
24848 #: ../src/guestfs-actions.pod:804
24849 msgid "guestfs_blockdev_getsz"
24850 msgstr ""
24851
24852 #. type: verbatim
24853 #: ../src/guestfs-actions.pod:806
24854 #, no-wrap
24855 msgid ""
24856 " int64_t\n"
24857 " guestfs_blockdev_getsz (guestfs_h *g,\n"
24858 "                         const char *device);\n"
24859 "\n"
24860 msgstr ""
24861
24862 #. type: textblock
24863 #: ../src/guestfs-actions.pod:813
24864 msgid ""
24865 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
24866 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
24867 msgstr ""
24868
24869 #. type: =head2
24870 #: ../src/guestfs-actions.pod:823
24871 msgid "guestfs_blockdev_rereadpt"
24872 msgstr ""
24873
24874 #. type: verbatim
24875 #: ../src/guestfs-actions.pod:825
24876 #, no-wrap
24877 msgid ""
24878 " int\n"
24879 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
24880 "                            const char *device);\n"
24881 "\n"
24882 msgstr ""
24883
24884 #. type: =head2
24885 #: ../src/guestfs-actions.pod:837
24886 msgid "guestfs_blockdev_setbsz"
24887 msgstr ""
24888
24889 #. type: verbatim
24890 #: ../src/guestfs-actions.pod:839
24891 #, no-wrap
24892 msgid ""
24893 " int\n"
24894 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
24895 "                          const char *device,\n"
24896 "                          int blocksize);\n"
24897 "\n"
24898 msgstr ""
24899
24900 #. type: =head2
24901 #: ../src/guestfs-actions.pod:855
24902 msgid "guestfs_blockdev_setro"
24903 msgstr ""
24904
24905 #. type: verbatim
24906 #: ../src/guestfs-actions.pod:857
24907 #, no-wrap
24908 msgid ""
24909 " int\n"
24910 " guestfs_blockdev_setro (guestfs_h *g,\n"
24911 "                         const char *device);\n"
24912 "\n"
24913 msgstr ""
24914
24915 #. type: =head2
24916 #: ../src/guestfs-actions.pod:869
24917 msgid "guestfs_blockdev_setrw"
24918 msgstr ""
24919
24920 #. type: verbatim
24921 #: ../src/guestfs-actions.pod:871
24922 #, no-wrap
24923 msgid ""
24924 " int\n"
24925 " guestfs_blockdev_setrw (guestfs_h *g,\n"
24926 "                         const char *device);\n"
24927 "\n"
24928 msgstr ""
24929
24930 #. type: =head2
24931 #: ../src/guestfs-actions.pod:883
24932 msgid "guestfs_btrfs_filesystem_resize"
24933 msgstr ""
24934
24935 #. type: verbatim
24936 #: ../src/guestfs-actions.pod:885
24937 #, no-wrap
24938 msgid ""
24939 " int\n"
24940 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
24941 "                                  const char *mountpoint,\n"
24942 "                                  ...);\n"
24943 "\n"
24944 msgstr ""
24945
24946 #. type: verbatim
24947 #: ../src/guestfs-actions.pod:895
24948 #, no-wrap
24949 msgid ""
24950 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
24951 "\n"
24952 msgstr ""
24953
24954 #. type: textblock
24955 #: ../src/guestfs-actions.pod:918
24956 msgid "(Added in 1.11.17)"
24957 msgstr ""
24958
24959 #. type: =head2
24960 #: ../src/guestfs-actions.pod:920
24961 msgid "guestfs_btrfs_filesystem_resize_va"
24962 msgstr ""
24963
24964 #. type: verbatim
24965 #: ../src/guestfs-actions.pod:922
24966 #, no-wrap
24967 msgid ""
24968 " int\n"
24969 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
24970 "                                     const char *mountpoint,\n"
24971 "                                     va_list args);\n"
24972 "\n"
24973 msgstr ""
24974
24975 #. type: textblock
24976 #: ../src/guestfs-actions.pod:927
24977 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
24978 msgstr ""
24979
24980 #. type: =head2
24981 #: ../src/guestfs-actions.pod:931
24982 msgid "guestfs_btrfs_filesystem_resize_argv"
24983 msgstr ""
24984
24985 #. type: verbatim
24986 #: ../src/guestfs-actions.pod:933
24987 #, no-wrap
24988 msgid ""
24989 " int\n"
24990 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
24991 "                                       const char *mountpoint,\n"
24992 "                                       const struct "
24993 "guestfs_btrfs_filesystem_resize_argv *optargs);\n"
24994 "\n"
24995 msgstr ""
24996
24997 #. type: textblock
24998 #: ../src/guestfs-actions.pod:938
24999 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
25000 msgstr ""
25001
25002 #. type: =head2
25003 #: ../src/guestfs-actions.pod:942
25004 msgid "guestfs_case_sensitive_path"
25005 msgstr ""
25006
25007 #. type: verbatim
25008 #: ../src/guestfs-actions.pod:944
25009 #, no-wrap
25010 msgid ""
25011 " char *\n"
25012 " guestfs_case_sensitive_path (guestfs_h *g,\n"
25013 "                              const char *path);\n"
25014 "\n"
25015 msgstr ""
25016
25017 #. type: textblock
25018 #: ../src/guestfs-actions.pod:970
25019 msgid ""
25020 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")  might return "
25021 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
25022 "how the directories were originally created under Windows)."
25023 msgstr ""
25024
25025 #. type: textblock
25026 #: ../src/guestfs-actions.pod:978
25027 msgid "See also C<guestfs_realpath>."
25028 msgstr ""
25029
25030 #. type: textblock
25031 #: ../src/guestfs-actions.pod:983 ../src/guestfs-actions.pod:7856
25032 msgid "(Added in 1.0.75)"
25033 msgstr ""
25034
25035 #. type: =head2
25036 #: ../src/guestfs-actions.pod:985
25037 msgid "guestfs_cat"
25038 msgstr ""
25039
25040 #. type: verbatim
25041 #: ../src/guestfs-actions.pod:987
25042 #, no-wrap
25043 msgid ""
25044 " char *\n"
25045 " guestfs_cat (guestfs_h *g,\n"
25046 "              const char *path);\n"
25047 "\n"
25048 msgstr ""
25049
25050 #. type: textblock
25051 #: ../src/guestfs-actions.pod:993
25052 msgid ""
25053 "Note that this function cannot correctly handle binary files (specifically, "
25054 "files containing C<\\0> character which is treated as end of string).  For "
25055 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
25056 "functions which have a more complex interface."
25057 msgstr ""
25058
25059 #. type: textblock
25060 #: ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4306 ../src/guestfs-actions.pod:4394 ../src/guestfs-actions.pod:4793 ../src/guestfs-actions.pod:4807 ../src/guestfs-actions.pod:6185 ../src/guestfs-actions.pod:6199 ../src/guestfs-actions.pod:8009 ../src/guestfs-actions.pod:8023
25061 msgid "(Added in 0.4)"
25062 msgstr ""
25063
25064 #. type: =head2
25065 #: ../src/guestfs-actions.pod:1006
25066 msgid "guestfs_checksum"
25067 msgstr ""
25068
25069 #. type: verbatim
25070 #: ../src/guestfs-actions.pod:1008
25071 #, no-wrap
25072 msgid ""
25073 " char *\n"
25074 " guestfs_checksum (guestfs_h *g,\n"
25075 "                   const char *csumtype,\n"
25076 "                   const char *path);\n"
25077 "\n"
25078 msgstr ""
25079
25080 #. type: textblock
25081 #: ../src/guestfs-actions.pod:1054
25082 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
25083 msgstr ""
25084
25085 #. type: textblock
25086 #: ../src/guestfs-actions.pod:1056
25087 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
25088 msgstr ""
25089
25090 #. type: textblock
25091 #: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1728 ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:3905 ../src/guestfs-actions.pod:3934 ../src/guestfs-actions.pod:3995 ../src/guestfs-actions.pod:4022 ../src/guestfs-actions.pod:7712
25092 msgid "(Added in 1.0.2)"
25093 msgstr ""
25094
25095 #. type: =head2
25096 #: ../src/guestfs-actions.pod:1063
25097 msgid "guestfs_checksum_device"
25098 msgstr ""
25099
25100 #. type: verbatim
25101 #: ../src/guestfs-actions.pod:1065
25102 #, no-wrap
25103 msgid ""
25104 " char *\n"
25105 " guestfs_checksum_device (guestfs_h *g,\n"
25106 "                          const char *csumtype,\n"
25107 "                          const char *device);\n"
25108 "\n"
25109 msgstr ""
25110
25111 #. type: textblock
25112 #: ../src/guestfs-actions.pod:1070
25113 msgid ""
25114 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
25115 "device named C<device>.  For the types of checksums supported see the "
25116 "C<guestfs_checksum> command."
25117 msgstr ""
25118
25119 #. type: textblock
25120 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:5617 ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5786 ../src/guestfs-actions.pod:5804 ../src/guestfs-actions.pod:5986 ../src/guestfs-actions.pod:7621 ../src/guestfs-actions.pod:7635 ../src/guestfs-actions.pod:8035
25121 msgid "(Added in 1.3.2)"
25122 msgstr ""
25123
25124 #. type: =head2
25125 #: ../src/guestfs-actions.pod:1079
25126 msgid "guestfs_checksums_out"
25127 msgstr ""
25128
25129 #. type: verbatim
25130 #: ../src/guestfs-actions.pod:1081
25131 #, no-wrap
25132 msgid ""
25133 " int\n"
25134 " guestfs_checksums_out (guestfs_h *g,\n"
25135 "                        const char *csumtype,\n"
25136 "                        const char *directory,\n"
25137 "                        const char *sumsfile);\n"
25138 "\n"
25139 msgstr ""
25140
25141 #. type: textblock
25142 #: ../src/guestfs-actions.pod:1101
25143 msgid "(Added in 1.3.7)"
25144 msgstr ""
25145
25146 #. type: =head2
25147 #: ../src/guestfs-actions.pod:1103
25148 msgid "guestfs_chmod"
25149 msgstr ""
25150
25151 #. type: verbatim
25152 #: ../src/guestfs-actions.pod:1105
25153 #, no-wrap
25154 msgid ""
25155 " int\n"
25156 " guestfs_chmod (guestfs_h *g,\n"
25157 "                int mode,\n"
25158 "                const char *path);\n"
25159 "\n"
25160 msgstr ""
25161
25162 #. type: =head2
25163 #: ../src/guestfs-actions.pod:1123
25164 msgid "guestfs_chown"
25165 msgstr ""
25166
25167 #. type: verbatim
25168 #: ../src/guestfs-actions.pod:1125
25169 #, no-wrap
25170 msgid ""
25171 " int\n"
25172 " guestfs_chown (guestfs_h *g,\n"
25173 "                int owner,\n"
25174 "                int group,\n"
25175 "                const char *path);\n"
25176 "\n"
25177 msgstr ""
25178
25179 #. type: =head2
25180 #: ../src/guestfs-actions.pod:1141
25181 msgid "guestfs_command"
25182 msgstr ""
25183
25184 #. type: verbatim
25185 #: ../src/guestfs-actions.pod:1143
25186 #, no-wrap
25187 msgid ""
25188 " char *\n"
25189 " guestfs_command (guestfs_h *g,\n"
25190 "                  char *const *arguments);\n"
25191 "\n"
25192 msgstr ""
25193
25194 #. type: textblock
25195 #: ../src/guestfs-actions.pod:1152
25196 msgid ""
25197 "The single parameter is an argv-style list of arguments.  The first element "
25198 "is the name of the program to run.  Subsequent elements are parameters.  The "
25199 "list must be non-empty (ie. must contain a program name).  Note that the "
25200 "command runs directly, and is I<not> invoked via the shell (see "
25201 "C<guestfs_sh>)."
25202 msgstr ""
25203
25204 #. type: textblock
25205 #: ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1203 ../src/guestfs-actions.pod:2027
25206 msgid "(Added in 0.9.1)"
25207 msgstr ""
25208
25209 #. type: =head2
25210 #: ../src/guestfs-actions.pod:1185
25211 msgid "guestfs_command_lines"
25212 msgstr ""
25213
25214 #. type: verbatim
25215 #: ../src/guestfs-actions.pod:1187
25216 #, no-wrap
25217 msgid ""
25218 " char **\n"
25219 " guestfs_command_lines (guestfs_h *g,\n"
25220 "                        char *const *arguments);\n"
25221 "\n"
25222 msgstr ""
25223
25224 #. type: textblock
25225 #: ../src/guestfs-actions.pod:1191
25226 msgid ""
25227 "This is the same as C<guestfs_command>, but splits the result into a list of "
25228 "lines."
25229 msgstr ""
25230
25231 #. type: textblock
25232 #: ../src/guestfs-actions.pod:1194
25233 msgid "See also: C<guestfs_sh_lines>"
25234 msgstr ""
25235
25236 #. type: =head2
25237 #: ../src/guestfs-actions.pod:1205
25238 msgid "guestfs_compress_device_out"
25239 msgstr ""
25240
25241 #. type: verbatim
25242 #: ../src/guestfs-actions.pod:1207
25243 #, no-wrap
25244 msgid ""
25245 " int\n"
25246 " guestfs_compress_device_out (guestfs_h *g,\n"
25247 "                              const char *ctype,\n"
25248 "                              const char *device,\n"
25249 "                              const char *zdevice,\n"
25250 "                              ...);\n"
25251 "\n"
25252 msgstr ""
25253
25254 #. type: verbatim
25255 #: ../src/guestfs-actions.pod:1219
25256 #, no-wrap
25257 msgid ""
25258 " GUESTFS_COMPRESS_DEVICE_OUT_LEVEL, int level,\n"
25259 "\n"
25260 msgstr ""
25261
25262 #. type: textblock
25263 #: ../src/guestfs-actions.pod:1224
25264 msgid ""
25265 "The C<ctype> and optional C<level> parameters have the same meaning as in "
25266 "C<guestfs_compress_out>."
25267 msgstr ""
25268
25269 #. type: textblock
25270 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1288 ../src/guestfs-actions.pod:2572 ../src/guestfs-actions.pod:6902
25271 msgid "(Added in 1.13.15)"
25272 msgstr ""
25273
25274 #. type: =head2
25275 #: ../src/guestfs-actions.pod:1231
25276 msgid "guestfs_compress_device_out_va"
25277 msgstr ""
25278
25279 #. type: verbatim
25280 #: ../src/guestfs-actions.pod:1233
25281 #, no-wrap
25282 msgid ""
25283 " int\n"
25284 " guestfs_compress_device_out_va (guestfs_h *g,\n"
25285 "                                 const char *ctype,\n"
25286 "                                 const char *device,\n"
25287 "                                 const char *zdevice,\n"
25288 "                                 va_list args);\n"
25289 "\n"
25290 msgstr ""
25291
25292 #. type: textblock
25293 #: ../src/guestfs-actions.pod:1240
25294 msgid "This is the \"va_list variant\" of L</guestfs_compress_device_out>."
25295 msgstr ""
25296
25297 #. type: =head2
25298 #: ../src/guestfs-actions.pod:1244
25299 msgid "guestfs_compress_device_out_argv"
25300 msgstr ""
25301
25302 #. type: verbatim
25303 #: ../src/guestfs-actions.pod:1246
25304 #, no-wrap
25305 msgid ""
25306 " int\n"
25307 " guestfs_compress_device_out_argv (guestfs_h *g,\n"
25308 "                                   const char *ctype,\n"
25309 "                                   const char *device,\n"
25310 "                                   const char *zdevice,\n"
25311 "                                   const struct "
25312 "guestfs_compress_device_out_argv *optargs);\n"
25313 "\n"
25314 msgstr ""
25315
25316 #. type: textblock
25317 #: ../src/guestfs-actions.pod:1253
25318 msgid "This is the \"argv variant\" of L</guestfs_compress_device_out>."
25319 msgstr ""
25320
25321 #. type: =head2
25322 #: ../src/guestfs-actions.pod:1257
25323 msgid "guestfs_compress_out"
25324 msgstr ""
25325
25326 #. type: verbatim
25327 #: ../src/guestfs-actions.pod:1259
25328 #, no-wrap
25329 msgid ""
25330 " int\n"
25331 " guestfs_compress_out (guestfs_h *g,\n"
25332 "                       const char *ctype,\n"
25333 "                       const char *file,\n"
25334 "                       const char *zfile,\n"
25335 "                       ...);\n"
25336 "\n"
25337 msgstr ""
25338
25339 #. type: verbatim
25340 #: ../src/guestfs-actions.pod:1271
25341 #, no-wrap
25342 msgid ""
25343 " GUESTFS_COMPRESS_OUT_LEVEL, int level,\n"
25344 "\n"
25345 msgstr ""
25346
25347 #. type: =head2
25348 #: ../src/guestfs-actions.pod:1290
25349 msgid "guestfs_compress_out_va"
25350 msgstr ""
25351
25352 #. type: verbatim
25353 #: ../src/guestfs-actions.pod:1292
25354 #, no-wrap
25355 msgid ""
25356 " int\n"
25357 " guestfs_compress_out_va (guestfs_h *g,\n"
25358 "                          const char *ctype,\n"
25359 "                          const char *file,\n"
25360 "                          const char *zfile,\n"
25361 "                          va_list args);\n"
25362 "\n"
25363 msgstr ""
25364
25365 #. type: textblock
25366 #: ../src/guestfs-actions.pod:1299
25367 msgid "This is the \"va_list variant\" of L</guestfs_compress_out>."
25368 msgstr ""
25369
25370 #. type: =head2
25371 #: ../src/guestfs-actions.pod:1303
25372 msgid "guestfs_compress_out_argv"
25373 msgstr ""
25374
25375 #. type: verbatim
25376 #: ../src/guestfs-actions.pod:1305
25377 #, no-wrap
25378 msgid ""
25379 " int\n"
25380 " guestfs_compress_out_argv (guestfs_h *g,\n"
25381 "                            const char *ctype,\n"
25382 "                            const char *file,\n"
25383 "                            const char *zfile,\n"
25384 "                            const struct guestfs_compress_out_argv "
25385 "*optargs);\n"
25386 "\n"
25387 msgstr ""
25388
25389 #. type: textblock
25390 #: ../src/guestfs-actions.pod:1312
25391 msgid "This is the \"argv variant\" of L</guestfs_compress_out>."
25392 msgstr ""
25393
25394 #. type: =head2
25395 #: ../src/guestfs-actions.pod:1316
25396 msgid "guestfs_config"
25397 msgstr ""
25398
25399 #. type: verbatim
25400 #: ../src/guestfs-actions.pod:1318
25401 #, no-wrap
25402 msgid ""
25403 " int\n"
25404 " guestfs_config (guestfs_h *g,\n"
25405 "                 const char *qemuparam,\n"
25406 "                 const char *qemuvalue);\n"
25407 "\n"
25408 msgstr ""
25409
25410 #. type: =head2
25411 #: ../src/guestfs-actions.pod:1336
25412 msgid "guestfs_copy_device_to_device"
25413 msgstr ""
25414
25415 #. type: verbatim
25416 #: ../src/guestfs-actions.pod:1338
25417 #, no-wrap
25418 msgid ""
25419 " int\n"
25420 " guestfs_copy_device_to_device (guestfs_h *g,\n"
25421 "                                const char *src,\n"
25422 "                                const char *dest,\n"
25423 "                                ...);\n"
25424 "\n"
25425 msgstr ""
25426
25427 #. type: verbatim
25428 #: ../src/guestfs-actions.pod:1349
25429 #, no-wrap
25430 msgid ""
25431 " GUESTFS_COPY_DEVICE_TO_DEVICE_SRCOFFSET, int64_t srcoffset,\n"
25432 " GUESTFS_COPY_DEVICE_TO_DEVICE_DESTOFFSET, int64_t destoffset,\n"
25433 " GUESTFS_COPY_DEVICE_TO_DEVICE_SIZE, int64_t size,\n"
25434 "\n"
25435 msgstr ""
25436
25437 #. type: textblock
25438 #: ../src/guestfs-actions.pod:1353
25439 msgid ""
25440 "The four calls C<guestfs_copy_device_to_device>, "
25441 "C<guestfs_copy_device_to_file>, C<guestfs_copy_file_to_device>, and "
25442 "C<guestfs_copy_file_to_file> let you copy from a source (device|file) to a "
25443 "destination (device|file)."
25444 msgstr ""
25445
25446 #. type: textblock
25447 #: ../src/guestfs-actions.pod:1374 ../src/guestfs-actions.pod:1427 ../src/guestfs-actions.pod:1480 ../src/guestfs-actions.pod:1538 ../src/guestfs-actions.pod:1592 ../src/guestfs-actions.pod:1723 ../src/guestfs-actions.pod:1754 ../src/guestfs-actions.pod:1799 ../src/guestfs-actions.pod:2176 ../src/guestfs-actions.pod:2198 ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:7707 ../src/guestfs-actions.pod:7741 ../src/guestfs-actions.pod:8248 ../src/guestfs-actions.pod:8271
25448 msgid ""
25449 "This long-running command can generate progress notification messages so "
25450 "that the caller can display a progress bar or indicator.  To receive these "
25451 "messages, the caller must register a progress event callback.  See "
25452 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
25453 msgstr ""
25454
25455 #. type: textblock
25456 #: ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1485 ../src/guestfs-actions.pod:1543 ../src/guestfs-actions.pod:6042
25457 msgid "(Added in 1.13.25)"
25458 msgstr ""
25459
25460 #. type: =head2
25461 #: ../src/guestfs-actions.pod:1381
25462 msgid "guestfs_copy_device_to_device_va"
25463 msgstr ""
25464
25465 #. type: verbatim
25466 #: ../src/guestfs-actions.pod:1383
25467 #, no-wrap
25468 msgid ""
25469 " int\n"
25470 " guestfs_copy_device_to_device_va (guestfs_h *g,\n"
25471 "                                   const char *src,\n"
25472 "                                   const char *dest,\n"
25473 "                                   va_list args);\n"
25474 "\n"
25475 msgstr ""
25476
25477 #. type: textblock
25478 #: ../src/guestfs-actions.pod:1389
25479 msgid "This is the \"va_list variant\" of L</guestfs_copy_device_to_device>."
25480 msgstr ""
25481
25482 #. type: =head2
25483 #: ../src/guestfs-actions.pod:1393
25484 msgid "guestfs_copy_device_to_device_argv"
25485 msgstr ""
25486
25487 #. type: verbatim
25488 #: ../src/guestfs-actions.pod:1395
25489 #, no-wrap
25490 msgid ""
25491 " int\n"
25492 " guestfs_copy_device_to_device_argv (guestfs_h *g,\n"
25493 "                                     const char *src,\n"
25494 "                                     const char *dest,\n"
25495 "                                     const struct "
25496 "guestfs_copy_device_to_device_argv *optargs);\n"
25497 "\n"
25498 msgstr ""
25499
25500 #. type: textblock
25501 #: ../src/guestfs-actions.pod:1401
25502 msgid "This is the \"argv variant\" of L</guestfs_copy_device_to_device>."
25503 msgstr ""
25504
25505 #. type: =head2
25506 #: ../src/guestfs-actions.pod:1405
25507 msgid "guestfs_copy_device_to_file"
25508 msgstr ""
25509
25510 #. type: verbatim
25511 #: ../src/guestfs-actions.pod:1407
25512 #, no-wrap
25513 msgid ""
25514 " int\n"
25515 " guestfs_copy_device_to_file (guestfs_h *g,\n"
25516 "                              const char *src,\n"
25517 "                              const char *dest,\n"
25518 "                              ...);\n"
25519 "\n"
25520 msgstr ""
25521
25522 #. type: verbatim
25523 #: ../src/guestfs-actions.pod:1418
25524 #, no-wrap
25525 msgid ""
25526 " GUESTFS_COPY_DEVICE_TO_FILE_SRCOFFSET, int64_t srcoffset,\n"
25527 " GUESTFS_COPY_DEVICE_TO_FILE_DESTOFFSET, int64_t destoffset,\n"
25528 " GUESTFS_COPY_DEVICE_TO_FILE_SIZE, int64_t size,\n"
25529 "\n"
25530 msgstr ""
25531
25532 #. type: textblock
25533 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1475 ../src/guestfs-actions.pod:1528
25534 msgid "See C<guestfs_copy_device_to_device> for a general overview of this call."
25535 msgstr ""
25536
25537 #. type: =head2
25538 #: ../src/guestfs-actions.pod:1434
25539 msgid "guestfs_copy_device_to_file_va"
25540 msgstr ""
25541
25542 #. type: verbatim
25543 #: ../src/guestfs-actions.pod:1436
25544 #, no-wrap
25545 msgid ""
25546 " int\n"
25547 " guestfs_copy_device_to_file_va (guestfs_h *g,\n"
25548 "                                 const char *src,\n"
25549 "                                 const char *dest,\n"
25550 "                                 va_list args);\n"
25551 "\n"
25552 msgstr ""
25553
25554 #. type: textblock
25555 #: ../src/guestfs-actions.pod:1442
25556 msgid "This is the \"va_list variant\" of L</guestfs_copy_device_to_file>."
25557 msgstr ""
25558
25559 #. type: =head2
25560 #: ../src/guestfs-actions.pod:1446
25561 msgid "guestfs_copy_device_to_file_argv"
25562 msgstr ""
25563
25564 #. type: verbatim
25565 #: ../src/guestfs-actions.pod:1448
25566 #, no-wrap
25567 msgid ""
25568 " int\n"
25569 " guestfs_copy_device_to_file_argv (guestfs_h *g,\n"
25570 "                                   const char *src,\n"
25571 "                                   const char *dest,\n"
25572 "                                   const struct "
25573 "guestfs_copy_device_to_file_argv *optargs);\n"
25574 "\n"
25575 msgstr ""
25576
25577 #. type: textblock
25578 #: ../src/guestfs-actions.pod:1454
25579 msgid "This is the \"argv variant\" of L</guestfs_copy_device_to_file>."
25580 msgstr ""
25581
25582 #. type: =head2
25583 #: ../src/guestfs-actions.pod:1458
25584 msgid "guestfs_copy_file_to_device"
25585 msgstr ""
25586
25587 #. type: verbatim
25588 #: ../src/guestfs-actions.pod:1460
25589 #, no-wrap
25590 msgid ""
25591 " int\n"
25592 " guestfs_copy_file_to_device (guestfs_h *g,\n"
25593 "                              const char *src,\n"
25594 "                              const char *dest,\n"
25595 "                              ...);\n"
25596 "\n"
25597 msgstr ""
25598
25599 #. type: verbatim
25600 #: ../src/guestfs-actions.pod:1471
25601 #, no-wrap
25602 msgid ""
25603 " GUESTFS_COPY_FILE_TO_DEVICE_SRCOFFSET, int64_t srcoffset,\n"
25604 " GUESTFS_COPY_FILE_TO_DEVICE_DESTOFFSET, int64_t destoffset,\n"
25605 " GUESTFS_COPY_FILE_TO_DEVICE_SIZE, int64_t size,\n"
25606 "\n"
25607 msgstr ""
25608
25609 #. type: =head2
25610 #: ../src/guestfs-actions.pod:1487
25611 msgid "guestfs_copy_file_to_device_va"
25612 msgstr ""
25613
25614 #. type: verbatim
25615 #: ../src/guestfs-actions.pod:1489
25616 #, no-wrap
25617 msgid ""
25618 " int\n"
25619 " guestfs_copy_file_to_device_va (guestfs_h *g,\n"
25620 "                                 const char *src,\n"
25621 "                                 const char *dest,\n"
25622 "                                 va_list args);\n"
25623 "\n"
25624 msgstr ""
25625
25626 #. type: textblock
25627 #: ../src/guestfs-actions.pod:1495
25628 msgid "This is the \"va_list variant\" of L</guestfs_copy_file_to_device>."
25629 msgstr ""
25630
25631 #. type: =head2
25632 #: ../src/guestfs-actions.pod:1499
25633 msgid "guestfs_copy_file_to_device_argv"
25634 msgstr ""
25635
25636 #. type: verbatim
25637 #: ../src/guestfs-actions.pod:1501
25638 #, no-wrap
25639 msgid ""
25640 " int\n"
25641 " guestfs_copy_file_to_device_argv (guestfs_h *g,\n"
25642 "                                   const char *src,\n"
25643 "                                   const char *dest,\n"
25644 "                                   const struct "
25645 "guestfs_copy_file_to_device_argv *optargs);\n"
25646 "\n"
25647 msgstr ""
25648
25649 #. type: textblock
25650 #: ../src/guestfs-actions.pod:1507
25651 msgid "This is the \"argv variant\" of L</guestfs_copy_file_to_device>."
25652 msgstr ""
25653
25654 #. type: =head2
25655 #: ../src/guestfs-actions.pod:1511
25656 msgid "guestfs_copy_file_to_file"
25657 msgstr ""
25658
25659 #. type: verbatim
25660 #: ../src/guestfs-actions.pod:1513
25661 #, no-wrap
25662 msgid ""
25663 " int\n"
25664 " guestfs_copy_file_to_file (guestfs_h *g,\n"
25665 "                            const char *src,\n"
25666 "                            const char *dest,\n"
25667 "                            ...);\n"
25668 "\n"
25669 msgstr ""
25670
25671 #. type: verbatim
25672 #: ../src/guestfs-actions.pod:1524
25673 #, no-wrap
25674 msgid ""
25675 " GUESTFS_COPY_FILE_TO_FILE_SRCOFFSET, int64_t srcoffset,\n"
25676 " GUESTFS_COPY_FILE_TO_FILE_DESTOFFSET, int64_t destoffset,\n"
25677 " GUESTFS_COPY_FILE_TO_FILE_SIZE, int64_t size,\n"
25678 "\n"
25679 msgstr ""
25680
25681 #. type: textblock
25682 #: ../src/guestfs-actions.pod:1531
25683 msgid ""
25684 "This is B<not> the function you want for copying files.  This is for copying "
25685 "blocks within existing files.  See C<guestfs_cp>, C<guestfs_cp_a> and "
25686 "C<guestfs_mv> for general file copying and moving functions."
25687 msgstr ""
25688
25689 #. type: =head2
25690 #: ../src/guestfs-actions.pod:1545
25691 msgid "guestfs_copy_file_to_file_va"
25692 msgstr ""
25693
25694 #. type: verbatim
25695 #: ../src/guestfs-actions.pod:1547
25696 #, no-wrap
25697 msgid ""
25698 " int\n"
25699 " guestfs_copy_file_to_file_va (guestfs_h *g,\n"
25700 "                               const char *src,\n"
25701 "                               const char *dest,\n"
25702 "                               va_list args);\n"
25703 "\n"
25704 msgstr ""
25705
25706 #. type: textblock
25707 #: ../src/guestfs-actions.pod:1553
25708 msgid "This is the \"va_list variant\" of L</guestfs_copy_file_to_file>."
25709 msgstr ""
25710
25711 #. type: =head2
25712 #: ../src/guestfs-actions.pod:1557
25713 msgid "guestfs_copy_file_to_file_argv"
25714 msgstr ""
25715
25716 #. type: verbatim
25717 #: ../src/guestfs-actions.pod:1559
25718 #, no-wrap
25719 msgid ""
25720 " int\n"
25721 " guestfs_copy_file_to_file_argv (guestfs_h *g,\n"
25722 "                                 const char *src,\n"
25723 "                                 const char *dest,\n"
25724 "                                 const struct guestfs_copy_file_to_file_argv "
25725 "*optargs);\n"
25726 "\n"
25727 msgstr ""
25728
25729 #. type: textblock
25730 #: ../src/guestfs-actions.pod:1565
25731 msgid "This is the \"argv variant\" of L</guestfs_copy_file_to_file>."
25732 msgstr ""
25733
25734 #. type: =head2
25735 #: ../src/guestfs-actions.pod:1569
25736 msgid "guestfs_copy_size"
25737 msgstr ""
25738
25739 #. type: verbatim
25740 #: ../src/guestfs-actions.pod:1571
25741 #, no-wrap
25742 msgid ""
25743 " int\n"
25744 " guestfs_copy_size (guestfs_h *g,\n"
25745 "                    const char *src,\n"
25746 "                    const char *dest,\n"
25747 "                    int64_t size);\n"
25748 "\n"
25749 msgstr ""
25750
25751 #. type: textblock
25752 #: ../src/guestfs-actions.pod:1577 ../src/guestfs-actions.pod:1634
25753 msgid ""
25754 "I<This function is deprecated.> In new code, use the "
25755 "L</guestfs_copy_device_to_device> call instead."
25756 msgstr ""
25757
25758 #. type: textblock
25759 #: ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:4820 ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:7942 ../src/guestfs-actions.pod:7962 ../src/guestfs-actions.pod:8048
25760 msgid "(Added in 1.0.87)"
25761 msgstr ""
25762
25763 #. type: =head2
25764 #: ../src/guestfs-actions.pod:1599
25765 msgid "guestfs_cp"
25766 msgstr ""
25767
25768 #. type: verbatim
25769 #: ../src/guestfs-actions.pod:1601
25770 #, no-wrap
25771 msgid ""
25772 " int\n"
25773 " guestfs_cp (guestfs_h *g,\n"
25774 "             const char *src,\n"
25775 "             const char *dest);\n"
25776 "\n"
25777 msgstr ""
25778
25779 #. type: textblock
25780 #: ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1705 ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:5564 ../src/guestfs-actions.pod:6056
25781 msgid "(Added in 1.0.18)"
25782 msgstr ""
25783
25784 #. type: =head2
25785 #: ../src/guestfs-actions.pod:1613
25786 msgid "guestfs_cp_a"
25787 msgstr ""
25788
25789 #. type: verbatim
25790 #: ../src/guestfs-actions.pod:1615
25791 #, no-wrap
25792 msgid ""
25793 " int\n"
25794 " guestfs_cp_a (guestfs_h *g,\n"
25795 "               const char *src,\n"
25796 "               const char *dest);\n"
25797 "\n"
25798 msgstr ""
25799
25800 #. type: =head2
25801 #: ../src/guestfs-actions.pod:1627
25802 msgid "guestfs_dd"
25803 msgstr ""
25804
25805 #. type: verbatim
25806 #: ../src/guestfs-actions.pod:1629
25807 #, no-wrap
25808 msgid ""
25809 " int\n"
25810 " guestfs_dd (guestfs_h *g,\n"
25811 "             const char *src,\n"
25812 "             const char *dest);\n"
25813 "\n"
25814 msgstr ""
25815
25816 #. type: textblock
25817 #: ../src/guestfs-actions.pod:1646
25818 msgid ""
25819 "If the destination is a device, it must be as large or larger than the "
25820 "source file or device, otherwise the copy will fail.  This command cannot do "
25821 "partial copies (see C<guestfs_copy_device_to_device>)."
25822 msgstr ""
25823
25824 #. type: =head2
25825 #: ../src/guestfs-actions.pod:1655
25826 msgid "guestfs_df"
25827 msgstr ""
25828
25829 #. type: verbatim
25830 #: ../src/guestfs-actions.pod:1657
25831 #, no-wrap
25832 msgid ""
25833 " char *\n"
25834 " guestfs_df (guestfs_h *g);\n"
25835 "\n"
25836 msgstr ""
25837
25838 #. type: textblock
25839 #: ../src/guestfs-actions.pod:1662 ../src/guestfs-actions.pod:1679
25840 msgid ""
25841 "This command is mostly useful for interactive sessions.  It is I<not> "
25842 "intended that you try to parse the output string.  Use C<guestfs_statvfs> "
25843 "from programs."
25844 msgstr ""
25845
25846 #. type: textblock
25847 #: ../src/guestfs-actions.pod:1669 ../src/guestfs-actions.pod:1686 ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2811 ../src/guestfs-actions.pod:2835 ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:4930 ../src/guestfs-actions.pod:5464 ../src/guestfs-actions.pod:7445 ../src/guestfs-actions.pod:7469 ../src/guestfs-actions.pod:8088 ../src/guestfs-actions.pod:8101 ../src/guestfs-actions.pod:8114
25848 msgid "(Added in 1.0.54)"
25849 msgstr ""
25850
25851 #. type: =head2
25852 #: ../src/guestfs-actions.pod:1671
25853 msgid "guestfs_df_h"
25854 msgstr ""
25855
25856 #. type: verbatim
25857 #: ../src/guestfs-actions.pod:1673
25858 #, no-wrap
25859 msgid ""
25860 " char *\n"
25861 " guestfs_df_h (guestfs_h *g);\n"
25862 "\n"
25863 msgstr ""
25864
25865 #. type: =head2
25866 #: ../src/guestfs-actions.pod:1688
25867 msgid "guestfs_dmesg"
25868 msgstr ""
25869
25870 #. type: verbatim
25871 #: ../src/guestfs-actions.pod:1690
25872 #, no-wrap
25873 msgid ""
25874 " char *\n"
25875 " guestfs_dmesg (guestfs_h *g);\n"
25876 "\n"
25877 msgstr ""
25878
25879 #. type: textblock
25880 #: ../src/guestfs-actions.pod:1697
25881 msgid ""
25882 "Another way to get the same information is to enable verbose messages with "
25883 "C<guestfs_set_verbose> or by setting the environment variable "
25884 "C<LIBGUESTFS_DEBUG=1> before running the program."
25885 msgstr ""
25886
25887 #. type: =head2
25888 #: ../src/guestfs-actions.pod:1707
25889 msgid "guestfs_download"
25890 msgstr ""
25891
25892 #. type: verbatim
25893 #: ../src/guestfs-actions.pod:1709
25894 #, no-wrap
25895 msgid ""
25896 " int\n"
25897 " guestfs_download (guestfs_h *g,\n"
25898 "                   const char *remotefilename,\n"
25899 "                   const char *filename);\n"
25900 "\n"
25901 msgstr ""
25902
25903 #. type: textblock
25904 #: ../src/guestfs-actions.pod:1719
25905 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
25906 msgstr ""
25907
25908 #. type: =head2
25909 #: ../src/guestfs-actions.pod:1730
25910 msgid "guestfs_download_offset"
25911 msgstr ""
25912
25913 #. type: verbatim
25914 #: ../src/guestfs-actions.pod:1732
25915 #, no-wrap
25916 msgid ""
25917 " int\n"
25918 " guestfs_download_offset (guestfs_h *g,\n"
25919 "                          const char *remotefilename,\n"
25920 "                          const char *filename,\n"
25921 "                          int64_t offset,\n"
25922 "                          int64_t size);\n"
25923 "\n"
25924 msgstr ""
25925
25926 #. type: textblock
25927 #: ../src/guestfs-actions.pod:1745
25928 msgid ""
25929 "Note that there is no limit on the amount of data that can be downloaded "
25930 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
25931 "full amount unless an error occurs."
25932 msgstr ""
25933
25934 #. type: textblock
25935 #: ../src/guestfs-actions.pod:1750
25936 msgid "See also C<guestfs_download>, C<guestfs_pread>."
25937 msgstr ""
25938
25939 #. type: textblock
25940 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:7746
25941 msgid "(Added in 1.5.17)"
25942 msgstr ""
25943
25944 #. type: =head2
25945 #: ../src/guestfs-actions.pod:1761
25946 msgid "guestfs_drop_caches"
25947 msgstr ""
25948
25949 #. type: verbatim
25950 #: ../src/guestfs-actions.pod:1763
25951 #, no-wrap
25952 msgid ""
25953 " int\n"
25954 " guestfs_drop_caches (guestfs_h *g,\n"
25955 "                      int whattodrop);\n"
25956 "\n"
25957 msgstr ""
25958
25959 #. type: =head2
25960 #: ../src/guestfs-actions.pod:1781
25961 msgid "guestfs_du"
25962 msgstr ""
25963
25964 #. type: verbatim
25965 #: ../src/guestfs-actions.pod:1783
25966 #, no-wrap
25967 msgid ""
25968 " int64_t\n"
25969 " guestfs_du (guestfs_h *g,\n"
25970 "             const char *path);\n"
25971 "\n"
25972 msgstr ""
25973
25974 #. type: =head2
25975 #: ../src/guestfs-actions.pod:1806
25976 msgid "guestfs_e2fsck_f"
25977 msgstr ""
25978
25979 #. type: verbatim
25980 #: ../src/guestfs-actions.pod:1808
25981 #, no-wrap
25982 msgid ""
25983 " int\n"
25984 " guestfs_e2fsck_f (guestfs_h *g,\n"
25985 "                   const char *device);\n"
25986 "\n"
25987 msgstr ""
25988
25989 #. type: textblock
25990 #: ../src/guestfs-actions.pod:1816
25991 msgid ""
25992 "This command is only needed because of C<guestfs_resize2fs> (q.v.).  "
25993 "Normally you should use C<guestfs_fsck>."
25994 msgstr ""
25995
25996 #. type: textblock
25997 #: ../src/guestfs-actions.pod:1821
25998 msgid "(Added in 1.0.29)"
25999 msgstr ""
26000
26001 #. type: =head2
26002 #: ../src/guestfs-actions.pod:1823
26003 msgid "guestfs_echo_daemon"
26004 msgstr ""
26005
26006 #. type: verbatim
26007 #: ../src/guestfs-actions.pod:1825
26008 #, no-wrap
26009 msgid ""
26010 " char *\n"
26011 " guestfs_echo_daemon (guestfs_h *g,\n"
26012 "                      char *const *words);\n"
26013 "\n"
26014 msgstr ""
26015
26016 #. type: textblock
26017 #: ../src/guestfs-actions.pod:1834
26018 msgid "See also C<guestfs_ping_daemon>."
26019 msgstr ""
26020
26021 #. type: textblock
26022 #: ../src/guestfs-actions.pod:1839 ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:6926
26023 msgid "(Added in 1.0.69)"
26024 msgstr ""
26025
26026 #. type: =head2
26027 #: ../src/guestfs-actions.pod:1841
26028 msgid "guestfs_egrep"
26029 msgstr ""
26030
26031 #. type: verbatim
26032 #: ../src/guestfs-actions.pod:1843
26033 #, no-wrap
26034 msgid ""
26035 " char **\n"
26036 " guestfs_egrep (guestfs_h *g,\n"
26037 "                const char *regex,\n"
26038 "                const char *path);\n"
26039 "\n"
26040 msgstr ""
26041
26042 #. type: textblock
26043 #: ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:1877 ../src/guestfs-actions.pod:1934 ../src/guestfs-actions.pod:1980 ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:2746 ../src/guestfs-actions.pod:2924 ../src/guestfs-actions.pod:2937 ../src/guestfs-actions.pod:2952 ../src/guestfs-actions.pod:2998 ../src/guestfs-actions.pod:3020 ../src/guestfs-actions.pod:3033 ../src/guestfs-actions.pod:4319 ../src/guestfs-actions.pod:4333 ../src/guestfs-actions.pod:4346 ../src/guestfs-actions.pod:4360 ../src/guestfs-actions.pod:5352 ../src/guestfs-actions.pod:6390 ../src/guestfs-actions.pod:6439 ../src/guestfs-actions.pod:7313 ../src/guestfs-actions.pod:7325 ../src/guestfs-actions.pod:7338 ../src/guestfs-actions.pod:7351 ../src/guestfs-actions.pod:7373 ../src/guestfs-actions.pod:7386 ../src/guestfs-actions.pod:7399 ../src/guestfs-actions.pod:7412 ../src/guestfs-actions.pod:8206 ../src/guestfs-actions.pod:8225 ../src/guestfs-actions.pod:8316 ../src/guestfs-actions.pod:8335 ../src/guestfs-actions.pod:8381 ../src/guestfs-actions.pod:8400
26044 msgid "(Added in 1.0.66)"
26045 msgstr ""
26046
26047 #. type: =head2
26048 #: ../src/guestfs-actions.pod:1860
26049 msgid "guestfs_egrepi"
26050 msgstr ""
26051
26052 #. type: verbatim
26053 #: ../src/guestfs-actions.pod:1862
26054 #, no-wrap
26055 msgid ""
26056 " char **\n"
26057 " guestfs_egrepi (guestfs_h *g,\n"
26058 "                 const char *regex,\n"
26059 "                 const char *path);\n"
26060 "\n"
26061 msgstr ""
26062
26063 #. type: =head2
26064 #: ../src/guestfs-actions.pod:1879
26065 msgid "guestfs_equal"
26066 msgstr ""
26067
26068 #. type: verbatim
26069 #: ../src/guestfs-actions.pod:1881
26070 #, no-wrap
26071 msgid ""
26072 " int\n"
26073 " guestfs_equal (guestfs_h *g,\n"
26074 "                const char *file1,\n"
26075 "                const char *file2);\n"
26076 "\n"
26077 msgstr ""
26078
26079 #. type: =head2
26080 #: ../src/guestfs-actions.pod:1895
26081 msgid "guestfs_exists"
26082 msgstr ""
26083
26084 #. type: verbatim
26085 #: ../src/guestfs-actions.pod:1897
26086 #, no-wrap
26087 msgid ""
26088 " int\n"
26089 " guestfs_exists (guestfs_h *g,\n"
26090 "                 const char *path);\n"
26091 "\n"
26092 msgstr ""
26093
26094 #. type: textblock
26095 #: ../src/guestfs-actions.pod:1904
26096 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
26097 msgstr ""
26098
26099 #. type: =head2
26100 #: ../src/guestfs-actions.pod:1910
26101 msgid "guestfs_fallocate"
26102 msgstr ""
26103
26104 #. type: verbatim
26105 #: ../src/guestfs-actions.pod:1912
26106 #, no-wrap
26107 msgid ""
26108 " int\n"
26109 " guestfs_fallocate (guestfs_h *g,\n"
26110 "                    const char *path,\n"
26111 "                    int len);\n"
26112 "\n"
26113 msgstr ""
26114
26115 #. type: textblock
26116 #: ../src/guestfs-actions.pod:1917
26117 msgid ""
26118 "I<This function is deprecated.> In new code, use the L</guestfs_fallocate64> "
26119 "call instead."
26120 msgstr ""
26121
26122 #. type: =head2
26123 #: ../src/guestfs-actions.pod:1936
26124 msgid "guestfs_fallocate64"
26125 msgstr ""
26126
26127 #. type: verbatim
26128 #: ../src/guestfs-actions.pod:1938
26129 #, no-wrap
26130 msgid ""
26131 " int\n"
26132 " guestfs_fallocate64 (guestfs_h *g,\n"
26133 "                      const char *path,\n"
26134 "                      int64_t len);\n"
26135 "\n"
26136 msgstr ""
26137
26138 #. type: textblock
26139 #: ../src/guestfs-actions.pod:1947
26140 msgid ""
26141 "Note that this call allocates disk blocks for the file.  To create a sparse "
26142 "file use C<guestfs_truncate_size> instead."
26143 msgstr ""
26144
26145 #. type: textblock
26146 #: ../src/guestfs-actions.pod:1950
26147 msgid ""
26148 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
26149 "oversight it only allowed 30 bit lengths to be specified, effectively "
26150 "limiting the maximum size of files created through that call to 1GB."
26151 msgstr ""
26152
26153 #. type: textblock
26154 #: ../src/guestfs-actions.pod:1961
26155 msgid "(Added in 1.3.17)"
26156 msgstr ""
26157
26158 #. type: =head2
26159 #: ../src/guestfs-actions.pod:1963
26160 msgid "guestfs_fgrep"
26161 msgstr ""
26162
26163 #. type: verbatim
26164 #: ../src/guestfs-actions.pod:1965
26165 #, no-wrap
26166 msgid ""
26167 " char **\n"
26168 " guestfs_fgrep (guestfs_h *g,\n"
26169 "                const char *pattern,\n"
26170 "                const char *path);\n"
26171 "\n"
26172 msgstr ""
26173
26174 #. type: =head2
26175 #: ../src/guestfs-actions.pod:1982
26176 msgid "guestfs_fgrepi"
26177 msgstr ""
26178
26179 #. type: verbatim
26180 #: ../src/guestfs-actions.pod:1984
26181 #, no-wrap
26182 msgid ""
26183 " char **\n"
26184 " guestfs_fgrepi (guestfs_h *g,\n"
26185 "                 const char *pattern,\n"
26186 "                 const char *path);\n"
26187 "\n"
26188 msgstr ""
26189
26190 #. type: =head2
26191 #: ../src/guestfs-actions.pod:2001
26192 msgid "guestfs_file"
26193 msgstr ""
26194
26195 #. type: verbatim
26196 #: ../src/guestfs-actions.pod:2003
26197 #, no-wrap
26198 msgid ""
26199 " char *\n"
26200 " guestfs_file (guestfs_h *g,\n"
26201 "               const char *path);\n"
26202 "\n"
26203 msgstr ""
26204
26205 #. type: textblock
26206 #: ../src/guestfs-actions.pod:2021
26207 msgid ""
26208 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
26209 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
26210 msgstr ""
26211
26212 #. type: =head2
26213 #: ../src/guestfs-actions.pod:2029
26214 msgid "guestfs_file_architecture"
26215 msgstr ""
26216
26217 #. type: verbatim
26218 #: ../src/guestfs-actions.pod:2031
26219 #, no-wrap
26220 msgid ""
26221 " char *\n"
26222 " guestfs_file_architecture (guestfs_h *g,\n"
26223 "                            const char *filename);\n"
26224 "\n"
26225 msgstr ""
26226
26227 #. type: textblock
26228 #: ../src/guestfs-actions.pod:2139 ../src/guestfs-actions.pod:2302 ../src/guestfs-actions.pod:2319 ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:3221 ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3542 ../src/guestfs-actions.pod:3639 ../src/guestfs-actions.pod:3876 ../src/guestfs-actions.pod:4008
26229 msgid "(Added in 1.5.3)"
26230 msgstr ""
26231
26232 #. type: =head2
26233 #: ../src/guestfs-actions.pod:2141
26234 msgid "guestfs_filesize"
26235 msgstr ""
26236
26237 #. type: verbatim
26238 #: ../src/guestfs-actions.pod:2143
26239 #, no-wrap
26240 msgid ""
26241 " int64_t\n"
26242 " guestfs_filesize (guestfs_h *g,\n"
26243 "                   const char *file);\n"
26244 "\n"
26245 msgstr ""
26246
26247 #. type: textblock
26248 #: ../src/guestfs-actions.pod:2149
26249 msgid ""
26250 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
26251 "C<guestfs_is_dir>, C<guestfs_is_file> etc.  To get the size of block "
26252 "devices, use C<guestfs_blockdev_getsize64>."
26253 msgstr ""
26254
26255 #. type: textblock
26256 #: ../src/guestfs-actions.pod:2155
26257 msgid "(Added in 1.0.82)"
26258 msgstr ""
26259
26260 #. type: =head2
26261 #: ../src/guestfs-actions.pod:2157
26262 msgid "guestfs_fill"
26263 msgstr ""
26264
26265 #. type: verbatim
26266 #: ../src/guestfs-actions.pod:2159
26267 #, no-wrap
26268 msgid ""
26269 " int\n"
26270 " guestfs_fill (guestfs_h *g,\n"
26271 "               int c,\n"
26272 "               int len,\n"
26273 "               const char *path);\n"
26274 "\n"
26275 msgstr ""
26276
26277 #. type: textblock
26278 #: ../src/guestfs-actions.pod:2169
26279 msgid ""
26280 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
26281 "C<guestfs_truncate_size>.  To create a file with a pattern of repeating "
26282 "bytes use C<guestfs_fill_pattern>."
26283 msgstr ""
26284
26285 #. type: textblock
26286 #: ../src/guestfs-actions.pod:2181
26287 msgid "(Added in 1.0.79)"
26288 msgstr ""
26289
26290 #. type: =head2
26291 #: ../src/guestfs-actions.pod:2183
26292 msgid "guestfs_fill_pattern"
26293 msgstr ""
26294
26295 #. type: verbatim
26296 #: ../src/guestfs-actions.pod:2185
26297 #, no-wrap
26298 msgid ""
26299 " int\n"
26300 " guestfs_fill_pattern (guestfs_h *g,\n"
26301 "                       const char *pattern,\n"
26302 "                       int len,\n"
26303 "                       const char *path);\n"
26304 "\n"
26305 msgstr ""
26306
26307 #. type: textblock
26308 #: ../src/guestfs-actions.pod:2191
26309 msgid ""
26310 "This function is like C<guestfs_fill> except that it creates a new file of "
26311 "length C<len> containing the repeating pattern of bytes in C<pattern>.  The "
26312 "pattern is truncated if necessary to ensure the length of the file is "
26313 "exactly C<len> bytes."
26314 msgstr ""
26315
26316 #. type: textblock
26317 #: ../src/guestfs-actions.pod:2203
26318 msgid "(Added in 1.3.12)"
26319 msgstr ""
26320
26321 #. type: =head2
26322 #: ../src/guestfs-actions.pod:2205
26323 msgid "guestfs_find"
26324 msgstr ""
26325
26326 #. type: verbatim
26327 #: ../src/guestfs-actions.pod:2207
26328 #, no-wrap
26329 msgid ""
26330 " char **\n"
26331 " guestfs_find (guestfs_h *g,\n"
26332 "               const char *directory);\n"
26333 "\n"
26334 msgstr ""
26335
26336 #. type: textblock
26337 #: ../src/guestfs-actions.pod:2223
26338 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
26339 msgstr ""
26340
26341 #. type: textblock
26342 #: ../src/guestfs-actions.pod:2236
26343 msgid "See also C<guestfs_find0>."
26344 msgstr ""
26345
26346 #. type: textblock
26347 #: ../src/guestfs-actions.pod:2245 ../src/guestfs-actions.pod:4757 ../src/guestfs-actions.pod:6474
26348 msgid "(Added in 1.0.27)"
26349 msgstr ""
26350
26351 #. type: =head2
26352 #: ../src/guestfs-actions.pod:2247
26353 msgid "guestfs_find0"
26354 msgstr ""
26355
26356 #. type: verbatim
26357 #: ../src/guestfs-actions.pod:2249
26358 #, no-wrap
26359 msgid ""
26360 " int\n"
26361 " guestfs_find0 (guestfs_h *g,\n"
26362 "                const char *directory,\n"
26363 "                const char *files);\n"
26364 "\n"
26365 msgstr ""
26366
26367 #. type: textblock
26368 #: ../src/guestfs-actions.pod:2258
26369 msgid ""
26370 "This command works the same way as C<guestfs_find> with the following "
26371 "exceptions:"
26372 msgstr ""
26373
26374 #. type: textblock
26375 #: ../src/guestfs-actions.pod:2285
26376 msgid "(Added in 1.0.74)"
26377 msgstr ""
26378
26379 #. type: =head2
26380 #: ../src/guestfs-actions.pod:2287
26381 msgid "guestfs_findfs_label"
26382 msgstr ""
26383
26384 #. type: verbatim
26385 #: ../src/guestfs-actions.pod:2289
26386 #, no-wrap
26387 msgid ""
26388 " char *\n"
26389 " guestfs_findfs_label (guestfs_h *g,\n"
26390 "                       const char *label);\n"
26391 "\n"
26392 msgstr ""
26393
26394 #. type: textblock
26395 #: ../src/guestfs-actions.pod:2297
26396 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
26397 msgstr ""
26398
26399 #. type: =head2
26400 #: ../src/guestfs-actions.pod:2304
26401 msgid "guestfs_findfs_uuid"
26402 msgstr ""
26403
26404 #. type: verbatim
26405 #: ../src/guestfs-actions.pod:2306
26406 #, no-wrap
26407 msgid ""
26408 " char *\n"
26409 " guestfs_findfs_uuid (guestfs_h *g,\n"
26410 "                      const char *uuid);\n"
26411 "\n"
26412 msgstr ""
26413
26414 #. type: textblock
26415 #: ../src/guestfs-actions.pod:2314
26416 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
26417 msgstr ""
26418
26419 #. type: =head2
26420 #: ../src/guestfs-actions.pod:2321
26421 msgid "guestfs_fsck"
26422 msgstr ""
26423
26424 #. type: verbatim
26425 #: ../src/guestfs-actions.pod:2323
26426 #, no-wrap
26427 msgid ""
26428 " int\n"
26429 " guestfs_fsck (guestfs_h *g,\n"
26430 "               const char *fstype,\n"
26431 "               const char *device);\n"
26432 "\n"
26433 msgstr ""
26434
26435 #. type: textblock
26436 #: ../src/guestfs-actions.pod:2358 ../src/guestfs-actions.pod:8253
26437 msgid "(Added in 1.0.16)"
26438 msgstr ""
26439
26440 #. type: =head2
26441 #: ../src/guestfs-actions.pod:2360
26442 msgid "guestfs_get_append"
26443 msgstr ""
26444
26445 #. type: verbatim
26446 #: ../src/guestfs-actions.pod:2362
26447 #, no-wrap
26448 msgid ""
26449 " const char *\n"
26450 " guestfs_get_append (guestfs_h *g);\n"
26451 "\n"
26452 msgstr ""
26453
26454 #. type: textblock
26455 #: ../src/guestfs-actions.pod:2370
26456 msgid ""
26457 "This function returns a string which may be NULL.  There is no way to return "
26458 "an error from this function.  The string is owned by the guest handle and "
26459 "must I<not> be freed."
26460 msgstr ""
26461
26462 #. type: textblock
26463 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:6152 ../src/guestfs-actions.pod:6631 ../src/guestfs-actions.pod:7080 ../src/guestfs-actions.pod:7099 ../src/guestfs-actions.pod:7115 ../src/guestfs-actions.pod:7139 ../src/guestfs-actions.pod:7893 ../src/guestfs-actions.pod:7908 ../src/guestfs-actions.pod:8297
26464 msgid "(Added in 1.0.26)"
26465 msgstr ""
26466
26467 #. type: =head2
26468 #: ../src/guestfs-actions.pod:2376
26469 msgid "guestfs_get_attach_method"
26470 msgstr ""
26471
26472 #. type: verbatim
26473 #: ../src/guestfs-actions.pod:2378
26474 #, no-wrap
26475 msgid ""
26476 " char *\n"
26477 " guestfs_get_attach_method (guestfs_h *g);\n"
26478 "\n"
26479 msgstr ""
26480
26481 #. type: textblock
26482 #: ../src/guestfs-actions.pod:2381
26483 msgid "Return the current attach method.  See C<guestfs_set_attach_method>."
26484 msgstr ""
26485
26486 #. type: textblock
26487 #: ../src/guestfs-actions.pod:2386 ../src/guestfs-actions.pod:6661
26488 msgid "(Added in 1.9.8)"
26489 msgstr ""
26490
26491 #. type: =head2
26492 #: ../src/guestfs-actions.pod:2388
26493 msgid "guestfs_get_autosync"
26494 msgstr ""
26495
26496 #. type: verbatim
26497 #: ../src/guestfs-actions.pod:2390
26498 #, no-wrap
26499 msgid ""
26500 " int\n"
26501 " guestfs_get_autosync (guestfs_h *g);\n"
26502 "\n"
26503 msgstr ""
26504
26505 #. type: =head2
26506 #: ../src/guestfs-actions.pod:2399
26507 msgid "guestfs_get_direct"
26508 msgstr ""
26509
26510 #. type: verbatim
26511 #: ../src/guestfs-actions.pod:2401
26512 #, no-wrap
26513 msgid ""
26514 " int\n"
26515 " guestfs_get_direct (guestfs_h *g);\n"
26516 "\n"
26517 msgstr ""
26518
26519 #. type: textblock
26520 #: ../src/guestfs-actions.pod:2408 ../src/guestfs-actions.pod:6702
26521 msgid "(Added in 1.0.72)"
26522 msgstr ""
26523
26524 #. type: =head2
26525 #: ../src/guestfs-actions.pod:2410
26526 msgid "guestfs_get_e2label"
26527 msgstr ""
26528
26529 #. type: verbatim
26530 #: ../src/guestfs-actions.pod:2412
26531 #, no-wrap
26532 msgid ""
26533 " char *\n"
26534 " guestfs_get_e2label (guestfs_h *g,\n"
26535 "                      const char *device);\n"
26536 "\n"
26537 msgstr ""
26538
26539 #. type: textblock
26540 #: ../src/guestfs-actions.pod:2416
26541 msgid ""
26542 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_label> "
26543 "call instead."
26544 msgstr ""
26545
26546 #. type: textblock
26547 #: ../src/guestfs-actions.pod:2429 ../src/guestfs-actions.pod:2450 ../src/guestfs-actions.pod:6720 ../src/guestfs-actions.pod:6739
26548 msgid "(Added in 1.0.15)"
26549 msgstr ""
26550
26551 #. type: =head2
26552 #: ../src/guestfs-actions.pod:2431
26553 msgid "guestfs_get_e2uuid"
26554 msgstr ""
26555
26556 #. type: verbatim
26557 #: ../src/guestfs-actions.pod:2433
26558 #, no-wrap
26559 msgid ""
26560 " char *\n"
26561 " guestfs_get_e2uuid (guestfs_h *g,\n"
26562 "                     const char *device);\n"
26563 "\n"
26564 msgstr ""
26565
26566 #. type: textblock
26567 #: ../src/guestfs-actions.pod:2437
26568 msgid ""
26569 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_uuid> "
26570 "call instead."
26571 msgstr ""
26572
26573 #. type: =head2
26574 #: ../src/guestfs-actions.pod:2452
26575 msgid "guestfs_get_memsize"
26576 msgstr ""
26577
26578 #. type: verbatim
26579 #: ../src/guestfs-actions.pod:2454
26580 #, no-wrap
26581 msgid ""
26582 " int\n"
26583 " guestfs_get_memsize (guestfs_h *g);\n"
26584 "\n"
26585 msgstr ""
26586
26587 #. type: textblock
26588 #: ../src/guestfs-actions.pod:2460
26589 msgid ""
26590 "If C<guestfs_set_memsize> was not called on this handle, and if "
26591 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
26592 "value for memsize."
26593 msgstr ""
26594
26595 #. type: textblock
26596 #: ../src/guestfs-actions.pod:2469 ../src/guestfs-actions.pod:5048 ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5276 ../src/guestfs-actions.pod:5295 ../src/guestfs-actions.pod:5307 ../src/guestfs-actions.pod:5324 ../src/guestfs-actions.pod:5337 ../src/guestfs-actions.pod:6377 ../src/guestfs-actions.pod:6760 ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7662
26597 msgid "(Added in 1.0.55)"
26598 msgstr ""
26599
26600 #. type: =head2
26601 #: ../src/guestfs-actions.pod:2471
26602 msgid "guestfs_get_network"
26603 msgstr ""
26604
26605 #. type: verbatim
26606 #: ../src/guestfs-actions.pod:2473
26607 #, no-wrap
26608 msgid ""
26609 " int\n"
26610 " guestfs_get_network (guestfs_h *g);\n"
26611 "\n"
26612 msgstr ""
26613
26614 #. type: textblock
26615 #: ../src/guestfs-actions.pod:2480 ../src/guestfs-actions.pod:6779
26616 msgid "(Added in 1.5.4)"
26617 msgstr ""
26618
26619 #. type: =head2
26620 #: ../src/guestfs-actions.pod:2482
26621 msgid "guestfs_get_path"
26622 msgstr ""
26623
26624 #. type: verbatim
26625 #: ../src/guestfs-actions.pod:2484
26626 #, no-wrap
26627 msgid ""
26628 " const char *\n"
26629 " guestfs_get_path (guestfs_h *g);\n"
26630 "\n"
26631 msgstr ""
26632
26633 #. type: textblock
26634 #: ../src/guestfs-actions.pod:2492 ../src/guestfs-actions.pod:2532
26635 msgid ""
26636 "This function returns a string, or NULL on error.  The string is owned by "
26637 "the guest handle and must I<not> be freed."
26638 msgstr ""
26639
26640 #. type: =head2
26641 #: ../src/guestfs-actions.pod:2497
26642 msgid "guestfs_get_pgroup"
26643 msgstr ""
26644
26645 #. type: verbatim
26646 #: ../src/guestfs-actions.pod:2499
26647 #, no-wrap
26648 msgid ""
26649 " int\n"
26650 " guestfs_get_pgroup (guestfs_h *g);\n"
26651 "\n"
26652 msgstr ""
26653
26654 #. type: textblock
26655 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:8154
26656 msgid "(Added in 1.11.18)"
26657 msgstr ""
26658
26659 #. type: =head2
26660 #: ../src/guestfs-actions.pod:2508
26661 msgid "guestfs_get_pid"
26662 msgstr ""
26663
26664 #. type: verbatim
26665 #: ../src/guestfs-actions.pod:2510
26666 #, no-wrap
26667 msgid ""
26668 " int\n"
26669 " guestfs_get_pid (guestfs_h *g);\n"
26670 "\n"
26671 msgstr ""
26672
26673 #. type: textblock
26674 #: ../src/guestfs-actions.pod:2520
26675 msgid "(Added in 1.0.56)"
26676 msgstr ""
26677
26678 #. type: =head2
26679 #: ../src/guestfs-actions.pod:2522
26680 msgid "guestfs_get_qemu"
26681 msgstr ""
26682
26683 #. type: verbatim
26684 #: ../src/guestfs-actions.pod:2524
26685 #, no-wrap
26686 msgid ""
26687 " const char *\n"
26688 " guestfs_get_qemu (guestfs_h *g);\n"
26689 "\n"
26690 msgstr ""
26691
26692 #. type: textblock
26693 #: ../src/guestfs-actions.pod:2535 ../src/guestfs-actions.pod:6843
26694 msgid "(Added in 1.0.6)"
26695 msgstr ""
26696
26697 #. type: =head2
26698 #: ../src/guestfs-actions.pod:2537
26699 msgid "guestfs_get_recovery_proc"
26700 msgstr ""
26701
26702 #. type: verbatim
26703 #: ../src/guestfs-actions.pod:2539
26704 #, no-wrap
26705 msgid ""
26706 " int\n"
26707 " guestfs_get_recovery_proc (guestfs_h *g);\n"
26708 "\n"
26709 msgstr ""
26710
26711 #. type: textblock
26712 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:4130 ../src/guestfs-actions.pod:4461 ../src/guestfs-actions.pod:4855 ../src/guestfs-actions.pod:4887 ../src/guestfs-actions.pod:6082 ../src/guestfs-actions.pod:6425 ../src/guestfs-actions.pod:6867 ../src/guestfs-actions.pod:7565 ../src/guestfs-actions.pod:7585 ../src/guestfs-actions.pod:7777
26713 msgid "(Added in 1.0.77)"
26714 msgstr ""
26715
26716 #. type: =head2
26717 #: ../src/guestfs-actions.pod:2548
26718 msgid "guestfs_get_selinux"
26719 msgstr ""
26720
26721 #. type: verbatim
26722 #: ../src/guestfs-actions.pod:2550
26723 #, no-wrap
26724 msgid ""
26725 " int\n"
26726 " guestfs_get_selinux (guestfs_h *g);\n"
26727 "\n"
26728 msgstr ""
26729
26730 #. type: textblock
26731 #: ../src/guestfs-actions.pod:2553
26732 msgid ""
26733 "This returns the current setting of the selinux flag which is passed to the "
26734 "appliance at boot time.  See C<guestfs_set_selinux>."
26735 msgstr ""
26736
26737 #. type: textblock
26738 #: ../src/guestfs-actions.pod:2561 ../src/guestfs-actions.pod:2635 ../src/guestfs-actions.pod:6886 ../src/guestfs-actions.pod:6960
26739 msgid "(Added in 1.0.67)"
26740 msgstr ""
26741
26742 #. type: =head2
26743 #: ../src/guestfs-actions.pod:2563
26744 msgid "guestfs_get_smp"
26745 msgstr ""
26746
26747 #. type: verbatim
26748 #: ../src/guestfs-actions.pod:2565
26749 #, no-wrap
26750 msgid ""
26751 " int\n"
26752 " guestfs_get_smp (guestfs_h *g);\n"
26753 "\n"
26754 msgstr ""
26755
26756 #. type: =head2
26757 #: ../src/guestfs-actions.pod:2574
26758 msgid "guestfs_get_state"
26759 msgstr ""
26760
26761 #. type: verbatim
26762 #: ../src/guestfs-actions.pod:2576
26763 #, no-wrap
26764 msgid ""
26765 " int\n"
26766 " guestfs_get_state (guestfs_h *g);\n"
26767 "\n"
26768 msgstr ""
26769
26770 #. type: =head2
26771 #: ../src/guestfs-actions.pod:2588
26772 msgid "guestfs_get_trace"
26773 msgstr ""
26774
26775 #. type: verbatim
26776 #: ../src/guestfs-actions.pod:2590
26777 #, no-wrap
26778 msgid ""
26779 " int\n"
26780 " guestfs_get_trace (guestfs_h *g);\n"
26781 "\n"
26782 msgstr ""
26783
26784 #. type: =head2
26785 #: ../src/guestfs-actions.pod:2599
26786 msgid "guestfs_get_umask"
26787 msgstr ""
26788
26789 #. type: verbatim
26790 #: ../src/guestfs-actions.pod:2601
26791 #, no-wrap
26792 msgid ""
26793 " int\n"
26794 " guestfs_get_umask (guestfs_h *g);\n"
26795 "\n"
26796 msgstr ""
26797
26798 #. type: textblock
26799 #: ../src/guestfs-actions.pod:2604
26800 msgid ""
26801 "Return the current umask.  By default the umask is C<022> unless it has been "
26802 "set by calling C<guestfs_umask>."
26803 msgstr ""
26804
26805 #. type: =head2
26806 #: ../src/guestfs-actions.pod:2611
26807 msgid "guestfs_get_verbose"
26808 msgstr ""
26809
26810 #. type: verbatim
26811 #: ../src/guestfs-actions.pod:2613
26812 #, no-wrap
26813 msgid ""
26814 " int\n"
26815 " guestfs_get_verbose (guestfs_h *g);\n"
26816 "\n"
26817 msgstr ""
26818
26819 #. type: =head2
26820 #: ../src/guestfs-actions.pod:2622
26821 msgid "guestfs_getcon"
26822 msgstr ""
26823
26824 #. type: verbatim
26825 #: ../src/guestfs-actions.pod:2624
26826 #, no-wrap
26827 msgid ""
26828 " char *\n"
26829 " guestfs_getcon (guestfs_h *g);\n"
26830 "\n"
26831 msgstr ""
26832
26833 #. type: textblock
26834 #: ../src/guestfs-actions.pod:2629
26835 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
26836 msgstr ""
26837
26838 #. type: =head2
26839 #: ../src/guestfs-actions.pod:2637
26840 msgid "guestfs_getxattr"
26841 msgstr ""
26842
26843 #. type: verbatim
26844 #: ../src/guestfs-actions.pod:2639
26845 #, no-wrap
26846 msgid ""
26847 " char *\n"
26848 " guestfs_getxattr (guestfs_h *g,\n"
26849 "                   const char *path,\n"
26850 "                   const char *name,\n"
26851 "                   size_t *size_r);\n"
26852 "\n"
26853 msgstr ""
26854
26855 #. type: textblock
26856 #: ../src/guestfs-actions.pod:2645
26857 msgid ""
26858 "Get a single extended attribute from file C<path> named C<name>.  This call "
26859 "follows symlinks.  If you want to lookup an extended attribute for the "
26860 "symlink itself, use C<guestfs_lgetxattr>."
26861 msgstr ""
26862
26863 #. type: textblock
26864 #: ../src/guestfs-actions.pod:2649 ../src/guestfs-actions.pod:4144
26865 msgid ""
26866 "Normally it is better to get all extended attributes from a file in one go "
26867 "by calling C<guestfs_getxattrs>.  However some Linux filesystem "
26868 "implementations are buggy and do not provide a way to list out attributes.  "
26869 "For these filesystems (notably ntfs-3g)  you have to know the names of the "
26870 "extended attributes you want in advance and call this function."
26871 msgstr ""
26872
26873 #. type: textblock
26874 #: ../src/guestfs-actions.pod:2659
26875 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
26876 msgstr ""
26877
26878 #. type: textblock
26879 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2874 ../src/guestfs-actions.pod:3356 ../src/guestfs-actions.pod:4156 ../src/guestfs-actions.pod:6075 ../src/guestfs-actions.pod:6101 ../src/guestfs-actions.pod:6282
26880 msgid ""
26881 "This function returns a buffer, or NULL on error.  The size of the returned "
26882 "buffer is written to C<*size_r>.  I<The caller must free the returned buffer "
26883 "after use>."
26884 msgstr ""
26885
26886 #. type: textblock
26887 #: ../src/guestfs-actions.pod:2665 ../src/guestfs-actions.pod:4160
26888 msgid "(Added in 1.7.24)"
26889 msgstr ""
26890
26891 #. type: =head2
26892 #: ../src/guestfs-actions.pod:2667
26893 msgid "guestfs_getxattrs"
26894 msgstr ""
26895
26896 #. type: verbatim
26897 #: ../src/guestfs-actions.pod:2669
26898 #, no-wrap
26899 msgid ""
26900 " struct guestfs_xattr_list *\n"
26901 " guestfs_getxattrs (guestfs_h *g,\n"
26902 "                    const char *path);\n"
26903 "\n"
26904 msgstr ""
26905
26906 #. type: textblock
26907 #: ../src/guestfs-actions.pod:2679
26908 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
26909 msgstr ""
26910
26911 #. type: textblock
26912 #: ../src/guestfs-actions.pod:2681 ../src/guestfs-actions.pod:4172 ../src/guestfs-actions.pod:4851
26913 msgid ""
26914 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
26915 "an error.  I<The caller must call C<guestfs_free_xattr_list> after use>."
26916 msgstr ""
26917
26918 #. type: textblock
26919 #: ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:4176 ../src/guestfs-actions.pod:4375 ../src/guestfs-actions.pod:4411 ../src/guestfs-actions.pod:6455 ../src/guestfs-actions.pod:6979 ../src/guestfs-actions.pod:8362
26920 msgid "(Added in 1.0.59)"
26921 msgstr ""
26922
26923 #. type: =head2
26924 #: ../src/guestfs-actions.pod:2687
26925 msgid "guestfs_glob_expand"
26926 msgstr ""
26927
26928 #. type: verbatim
26929 #: ../src/guestfs-actions.pod:2689
26930 #, no-wrap
26931 msgid ""
26932 " char **\n"
26933 " guestfs_glob_expand (guestfs_h *g,\n"
26934 "                      const char *pattern);\n"
26935 "\n"
26936 msgstr ""
26937
26938 #. type: textblock
26939 #: ../src/guestfs-actions.pod:2708 ../src/guestfs-actions.pod:7163 ../src/guestfs-actions.pod:7180
26940 msgid "(Added in 1.0.50)"
26941 msgstr ""
26942
26943 #. type: =head2
26944 #: ../src/guestfs-actions.pod:2710
26945 msgid "guestfs_grep"
26946 msgstr ""
26947
26948 #. type: verbatim
26949 #: ../src/guestfs-actions.pod:2712
26950 #, no-wrap
26951 msgid ""
26952 " char **\n"
26953 " guestfs_grep (guestfs_h *g,\n"
26954 "               const char *regex,\n"
26955 "               const char *path);\n"
26956 "\n"
26957 msgstr ""
26958
26959 #. type: =head2
26960 #: ../src/guestfs-actions.pod:2729
26961 msgid "guestfs_grepi"
26962 msgstr ""
26963
26964 #. type: verbatim
26965 #: ../src/guestfs-actions.pod:2731
26966 #, no-wrap
26967 msgid ""
26968 " char **\n"
26969 " guestfs_grepi (guestfs_h *g,\n"
26970 "                const char *regex,\n"
26971 "                const char *path);\n"
26972 "\n"
26973 msgstr ""
26974
26975 #. type: =head2
26976 #: ../src/guestfs-actions.pod:2748
26977 msgid "guestfs_grub_install"
26978 msgstr ""
26979
26980 #. type: verbatim
26981 #: ../src/guestfs-actions.pod:2750
26982 #, no-wrap
26983 msgid ""
26984 " int\n"
26985 " guestfs_grub_install (guestfs_h *g,\n"
26986 "                       const char *root,\n"
26987 "                       const char *device);\n"
26988 "\n"
26989 msgstr ""
26990
26991 #. type: textblock
26992 #: ../src/guestfs-actions.pod:2793
26993 msgid "(Added in 1.0.17)"
26994 msgstr ""
26995
26996 #. type: =head2
26997 #: ../src/guestfs-actions.pod:2795
26998 msgid "guestfs_head"
26999 msgstr ""
27000
27001 #. type: verbatim
27002 #: ../src/guestfs-actions.pod:2797
27003 #, no-wrap
27004 msgid ""
27005 " char **\n"
27006 " guestfs_head (guestfs_h *g,\n"
27007 "               const char *path);\n"
27008 "\n"
27009 msgstr ""
27010
27011 #. type: =head2
27012 #: ../src/guestfs-actions.pod:2813
27013 msgid "guestfs_head_n"
27014 msgstr ""
27015
27016 #. type: verbatim
27017 #: ../src/guestfs-actions.pod:2815
27018 #, no-wrap
27019 msgid ""
27020 " char **\n"
27021 " guestfs_head_n (guestfs_h *g,\n"
27022 "                 int nrlines,\n"
27023 "                 const char *path);\n"
27024 "\n"
27025 msgstr ""
27026
27027 #. type: =head2
27028 #: ../src/guestfs-actions.pod:2837
27029 msgid "guestfs_hexdump"
27030 msgstr ""
27031
27032 #. type: verbatim
27033 #: ../src/guestfs-actions.pod:2839
27034 #, no-wrap
27035 msgid ""
27036 " char *\n"
27037 " guestfs_hexdump (guestfs_h *g,\n"
27038 "                  const char *path);\n"
27039 "\n"
27040 msgstr ""
27041
27042 #. type: textblock
27043 #: ../src/guestfs-actions.pod:2852 ../src/guestfs-actions.pod:7244 ../src/guestfs-actions.pod:7299
27044 msgid "(Added in 1.0.22)"
27045 msgstr ""
27046
27047 #. type: =head2
27048 #: ../src/guestfs-actions.pod:2854
27049 msgid "guestfs_initrd_cat"
27050 msgstr ""
27051
27052 #. type: verbatim
27053 #: ../src/guestfs-actions.pod:2856
27054 #, no-wrap
27055 msgid ""
27056 " char *\n"
27057 " guestfs_initrd_cat (guestfs_h *g,\n"
27058 "                     const char *initrdpath,\n"
27059 "                     const char *filename,\n"
27060 "                     size_t *size_r);\n"
27061 "\n"
27062 msgstr ""
27063
27064 #. type: textblock
27065 #: ../src/guestfs-actions.pod:2872
27066 msgid "See also C<guestfs_initrd_list>."
27067 msgstr ""
27068
27069 #. type: =head2
27070 #: ../src/guestfs-actions.pod:2883
27071 msgid "guestfs_initrd_list"
27072 msgstr ""
27073
27074 #. type: verbatim
27075 #: ../src/guestfs-actions.pod:2885
27076 #, no-wrap
27077 msgid ""
27078 " char **\n"
27079 " guestfs_initrd_list (guestfs_h *g,\n"
27080 "                      const char *path);\n"
27081 "\n"
27082 msgstr ""
27083
27084 #. type: =head2
27085 #: ../src/guestfs-actions.pod:2905
27086 msgid "guestfs_inotify_add_watch"
27087 msgstr ""
27088
27089 #. type: verbatim
27090 #: ../src/guestfs-actions.pod:2907
27091 #, no-wrap
27092 msgid ""
27093 " int64_t\n"
27094 " guestfs_inotify_add_watch (guestfs_h *g,\n"
27095 "                            const char *path,\n"
27096 "                            int mask);\n"
27097 "\n"
27098 msgstr ""
27099
27100 #. type: =head2
27101 #: ../src/guestfs-actions.pod:2926
27102 msgid "guestfs_inotify_close"
27103 msgstr ""
27104
27105 #. type: verbatim
27106 #: ../src/guestfs-actions.pod:2928
27107 #, no-wrap
27108 msgid ""
27109 " int\n"
27110 " guestfs_inotify_close (guestfs_h *g);\n"
27111 "\n"
27112 msgstr ""
27113
27114 #. type: =head2
27115 #: ../src/guestfs-actions.pod:2939
27116 msgid "guestfs_inotify_files"
27117 msgstr ""
27118
27119 #. type: verbatim
27120 #: ../src/guestfs-actions.pod:2941
27121 #, no-wrap
27122 msgid ""
27123 " char **\n"
27124 " guestfs_inotify_files (guestfs_h *g);\n"
27125 "\n"
27126 msgstr ""
27127
27128 #. type: textblock
27129 #: ../src/guestfs-actions.pod:2944
27130 msgid ""
27131 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
27132 "returns a list of pathnames of objects that were touched.  The returned "
27133 "pathnames are sorted and deduplicated."
27134 msgstr ""
27135
27136 #. type: =head2
27137 #: ../src/guestfs-actions.pod:2954
27138 msgid "guestfs_inotify_init"
27139 msgstr ""
27140
27141 #. type: verbatim
27142 #: ../src/guestfs-actions.pod:2956
27143 #, no-wrap
27144 msgid ""
27145 " int\n"
27146 " guestfs_inotify_init (guestfs_h *g,\n"
27147 "                       int maxevents);\n"
27148 "\n"
27149 msgstr ""
27150
27151 #. type: textblock
27152 #: ../src/guestfs-actions.pod:2964
27153 msgid ""
27154 "C<maxevents> is the maximum number of events which will be queued up between "
27155 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>.  If this is "
27156 "passed as C<0>, then the kernel (or previously set)  default is used.  For "
27157 "Linux 2.6.29 the default was 16384 events.  Beyond this limit, the kernel "
27158 "throws away events, but records the fact that it threw them away by setting "
27159 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
27160 "C<guestfs_inotify_read>)."
27161 msgstr ""
27162
27163 #. type: textblock
27164 #: ../src/guestfs-actions.pod:2974
27165 msgid ""
27166 "Before any events are generated, you have to add some watches to the "
27167 "internal watch list.  See: C<guestfs_inotify_add_watch>, "
27168 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
27169 msgstr ""
27170
27171 #. type: textblock
27172 #: ../src/guestfs-actions.pod:2980
27173 msgid ""
27174 "Queued up events should be read periodically by calling "
27175 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
27176 "wrapper around C<guestfs_inotify_read>).  If you don't read the events out "
27177 "often enough then you risk the internal queue overflowing."
27178 msgstr ""
27179
27180 #. type: textblock
27181 #: ../src/guestfs-actions.pod:2987
27182 msgid ""
27183 "The handle should be closed after use by calling C<guestfs_inotify_close>.  "
27184 "This also removes any watches automatically."
27185 msgstr ""
27186
27187 #. type: =head2
27188 #: ../src/guestfs-actions.pod:3000
27189 msgid "guestfs_inotify_read"
27190 msgstr ""
27191
27192 #. type: verbatim
27193 #: ../src/guestfs-actions.pod:3002
27194 #, no-wrap
27195 msgid ""
27196 " struct guestfs_inotify_event_list *\n"
27197 " guestfs_inotify_read (guestfs_h *g);\n"
27198 "\n"
27199 msgstr ""
27200
27201 #. type: textblock
27202 #: ../src/guestfs-actions.pod:3016
27203 msgid ""
27204 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
27205 "there was an error.  I<The caller must call "
27206 "C<guestfs_free_inotify_event_list> after use>."
27207 msgstr ""
27208
27209 #. type: =head2
27210 #: ../src/guestfs-actions.pod:3022
27211 msgid "guestfs_inotify_rm_watch"
27212 msgstr ""
27213
27214 #. type: verbatim
27215 #: ../src/guestfs-actions.pod:3024
27216 #, no-wrap
27217 msgid ""
27218 " int\n"
27219 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
27220 "                           int wd);\n"
27221 "\n"
27222 msgstr ""
27223
27224 #. type: textblock
27225 #: ../src/guestfs-actions.pod:3028
27226 msgid ""
27227 "Remove a previously defined inotify watch.  See "
27228 "C<guestfs_inotify_add_watch>."
27229 msgstr ""
27230
27231 #. type: =head2
27232 #: ../src/guestfs-actions.pod:3035
27233 msgid "guestfs_inspect_get_arch"
27234 msgstr ""
27235
27236 #. type: verbatim
27237 #: ../src/guestfs-actions.pod:3037
27238 #, no-wrap
27239 msgid ""
27240 " char *\n"
27241 " guestfs_inspect_get_arch (guestfs_h *g,\n"
27242 "                           const char *root);\n"
27243 "\n"
27244 msgstr ""
27245
27246 #. type: textblock
27247 #: ../src/guestfs-actions.pod:3041
27248 msgid ""
27249 "This returns the architecture of the inspected operating system.  The "
27250 "possible return values are listed under C<guestfs_file_architecture>."
27251 msgstr ""
27252
27253 #. type: =head2
27254 #: ../src/guestfs-actions.pod:3055
27255 msgid "guestfs_inspect_get_distro"
27256 msgstr ""
27257
27258 #. type: verbatim
27259 #: ../src/guestfs-actions.pod:3057
27260 #, no-wrap
27261 msgid ""
27262 " char *\n"
27263 " guestfs_inspect_get_distro (guestfs_h *g,\n"
27264 "                             const char *root);\n"
27265 "\n"
27266 msgstr ""
27267
27268 #. type: =head2
27269 #: ../src/guestfs-actions.pod:3157
27270 msgid "guestfs_inspect_get_drive_mappings"
27271 msgstr ""
27272
27273 #. type: verbatim
27274 #: ../src/guestfs-actions.pod:3159
27275 #, no-wrap
27276 msgid ""
27277 " char **\n"
27278 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
27279 "                                     const char *root);\n"
27280 "\n"
27281 msgstr ""
27282
27283 #. type: textblock
27284 #: ../src/guestfs-actions.pod:3188
27285 msgid ""
27286 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
27287 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
27288 msgstr ""
27289
27290 #. type: textblock
27291 #: ../src/guestfs-actions.pod:3192 ../src/guestfs-actions.pod:3460 ../src/guestfs-actions.pod:4263 ../src/guestfs-actions.pod:5526 ../src/guestfs-actions.pod:7601
27292 msgid ""
27293 "This function returns a NULL-terminated array of strings, or NULL if there "
27294 "was an error.  The array of strings will always have length C<2n+1>, where "
27295 "C<n> keys and values alternate, followed by the trailing NULL entry.  I<The "
27296 "caller must free the strings and the array after use>."
27297 msgstr ""
27298
27299 #. type: textblock
27300 #: ../src/guestfs-actions.pod:3198 ../src/guestfs-actions.pod:3659
27301 msgid "(Added in 1.9.17)"
27302 msgstr ""
27303
27304 #. type: =head2
27305 #: ../src/guestfs-actions.pod:3200
27306 msgid "guestfs_inspect_get_filesystems"
27307 msgstr ""
27308
27309 #. type: verbatim
27310 #: ../src/guestfs-actions.pod:3202
27311 #, no-wrap
27312 msgid ""
27313 " char **\n"
27314 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
27315 "                                  const char *root);\n"
27316 "\n"
27317 msgstr ""
27318
27319 #. type: textblock
27320 #: ../src/guestfs-actions.pod:3214
27321 msgid ""
27322 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
27323 "C<guestfs_inspect_get_mountpoints>."
27324 msgstr ""
27325
27326 #. type: =head2
27327 #: ../src/guestfs-actions.pod:3223
27328 msgid "guestfs_inspect_get_format"
27329 msgstr ""
27330
27331 #. type: verbatim
27332 #: ../src/guestfs-actions.pod:3225
27333 #, no-wrap
27334 msgid ""
27335 " char *\n"
27336 " guestfs_inspect_get_format (guestfs_h *g,\n"
27337 "                             const char *root);\n"
27338 "\n"
27339 msgstr ""
27340
27341 #. type: textblock
27342 #: ../src/guestfs-actions.pod:3259 ../src/guestfs-actions.pod:3695 ../src/guestfs-actions.pod:3711 ../src/guestfs-actions.pod:3729 ../src/guestfs-actions.pod:6493
27343 msgid "(Added in 1.9.4)"
27344 msgstr ""
27345
27346 #. type: =head2
27347 #: ../src/guestfs-actions.pod:3261
27348 msgid "guestfs_inspect_get_hostname"
27349 msgstr ""
27350
27351 #. type: verbatim
27352 #: ../src/guestfs-actions.pod:3263
27353 #, no-wrap
27354 msgid ""
27355 " char *\n"
27356 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
27357 "                               const char *root);\n"
27358 "\n"
27359 msgstr ""
27360
27361 #. type: textblock
27362 #: ../src/guestfs-actions.pod:3278
27363 msgid "(Added in 1.7.9)"
27364 msgstr ""
27365
27366 #. type: =head2
27367 #: ../src/guestfs-actions.pod:3280
27368 msgid "guestfs_inspect_get_icon"
27369 msgstr ""
27370
27371 #. type: verbatim
27372 #: ../src/guestfs-actions.pod:3282
27373 #, no-wrap
27374 msgid ""
27375 " char *\n"
27376 " guestfs_inspect_get_icon (guestfs_h *g,\n"
27377 "                           const char *root,\n"
27378 "                           size_t *size_r,\n"
27379 "                           ...);\n"
27380 "\n"
27381 msgstr ""
27382
27383 #. type: verbatim
27384 #: ../src/guestfs-actions.pod:3293
27385 #, no-wrap
27386 msgid ""
27387 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
27388 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
27389 "\n"
27390 msgstr ""
27391
27392 #. type: textblock
27393 #: ../src/guestfs-actions.pod:3360 ../src/guestfs-actions.pod:4190 ../src/guestfs-actions.pod:5425
27394 msgid "(Added in 1.11.12)"
27395 msgstr ""
27396
27397 #. type: =head2
27398 #: ../src/guestfs-actions.pod:3362
27399 msgid "guestfs_inspect_get_icon_va"
27400 msgstr ""
27401
27402 #. type: verbatim
27403 #: ../src/guestfs-actions.pod:3364
27404 #, no-wrap
27405 msgid ""
27406 " char *\n"
27407 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
27408 "                              const char *root,\n"
27409 "                              size_t *size_r,\n"
27410 "                              va_list args);\n"
27411 "\n"
27412 msgstr ""
27413
27414 #. type: textblock
27415 #: ../src/guestfs-actions.pod:3370
27416 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
27417 msgstr ""
27418
27419 #. type: =head2
27420 #: ../src/guestfs-actions.pod:3374
27421 msgid "guestfs_inspect_get_icon_argv"
27422 msgstr ""
27423
27424 #. type: verbatim
27425 #: ../src/guestfs-actions.pod:3376
27426 #, no-wrap
27427 msgid ""
27428 " char *\n"
27429 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
27430 "                                const char *root,\n"
27431 "                                size_t *size_r,\n"
27432 "                                const struct guestfs_inspect_get_icon_argv "
27433 "*optargs);\n"
27434 "\n"
27435 msgstr ""
27436
27437 #. type: textblock
27438 #: ../src/guestfs-actions.pod:3382
27439 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
27440 msgstr ""
27441
27442 #. type: =head2
27443 #: ../src/guestfs-actions.pod:3386
27444 msgid "guestfs_inspect_get_major_version"
27445 msgstr ""
27446
27447 #. type: verbatim
27448 #: ../src/guestfs-actions.pod:3388
27449 #, no-wrap
27450 msgid ""
27451 " int\n"
27452 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
27453 "                                    const char *root);\n"
27454 "\n"
27455 msgstr ""
27456
27457 #. type: =head2
27458 #: ../src/guestfs-actions.pod:3410
27459 msgid "guestfs_inspect_get_minor_version"
27460 msgstr ""
27461
27462 #. type: verbatim
27463 #: ../src/guestfs-actions.pod:3412
27464 #, no-wrap
27465 msgid ""
27466 " int\n"
27467 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
27468 "                                    const char *root);\n"
27469 "\n"
27470 msgstr ""
27471
27472 #. type: textblock
27473 #: ../src/guestfs-actions.pod:3421
27474 msgid ""
27475 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
27476 "C<guestfs_inspect_get_major_version>."
27477 msgstr ""
27478
27479 #. type: =head2
27480 #: ../src/guestfs-actions.pod:3428
27481 msgid "guestfs_inspect_get_mountpoints"
27482 msgstr ""
27483
27484 #. type: verbatim
27485 #: ../src/guestfs-actions.pod:3430
27486 #, no-wrap
27487 msgid ""
27488 " char **\n"
27489 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
27490 "                                  const char *root);\n"
27491 "\n"
27492 msgstr ""
27493
27494 #. type: textblock
27495 #: ../src/guestfs-actions.pod:3451
27496 msgid ""
27497 "For operating systems like Windows which still use drive letters, this call "
27498 "will only return an entry for the first drive \"mounted on\" C</>.  For "
27499 "information about the mapping of drive letters to partitions, see "
27500 "C<guestfs_inspect_get_drive_mappings>."
27501 msgstr ""
27502
27503 #. type: textblock
27504 #: ../src/guestfs-actions.pod:3457
27505 msgid ""
27506 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
27507 "C<guestfs_inspect_get_filesystems>."
27508 msgstr ""
27509
27510 #. type: =head2
27511 #: ../src/guestfs-actions.pod:3468
27512 msgid "guestfs_inspect_get_package_format"
27513 msgstr ""
27514
27515 #. type: verbatim
27516 #: ../src/guestfs-actions.pod:3470
27517 #, no-wrap
27518 msgid ""
27519 " char *\n"
27520 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
27521 "                                     const char *root);\n"
27522 "\n"
27523 msgstr ""
27524
27525 #. type: textblock
27526 #: ../src/guestfs-actions.pod:3474
27527 msgid ""
27528 "This function and C<guestfs_inspect_get_package_management> return the "
27529 "package format and package management tool used by the inspected operating "
27530 "system.  For example for Fedora these functions would return C<rpm> (package "
27531 "format) and C<yum> (package management)."
27532 msgstr ""
27533
27534 #. type: textblock
27535 #: ../src/guestfs-actions.pod:3493 ../src/guestfs-actions.pod:3521
27536 msgid "(Added in 1.7.5)"
27537 msgstr ""
27538
27539 #. type: =head2
27540 #: ../src/guestfs-actions.pod:3495
27541 msgid "guestfs_inspect_get_package_management"
27542 msgstr ""
27543
27544 #. type: verbatim
27545 #: ../src/guestfs-actions.pod:3497
27546 #, no-wrap
27547 msgid ""
27548 " char *\n"
27549 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
27550 "                                         const char *root);\n"
27551 "\n"
27552 msgstr ""
27553
27554 #. type: textblock
27555 #: ../src/guestfs-actions.pod:3501
27556 msgid ""
27557 "C<guestfs_inspect_get_package_format> and this function return the package "
27558 "format and package management tool used by the inspected operating system.  "
27559 "For example for Fedora these functions would return C<rpm> (package format) "
27560 "and C<yum> (package management)."
27561 msgstr ""
27562
27563 #. type: =head2
27564 #: ../src/guestfs-actions.pod:3523
27565 msgid "guestfs_inspect_get_product_name"
27566 msgstr ""
27567
27568 #. type: verbatim
27569 #: ../src/guestfs-actions.pod:3525
27570 #, no-wrap
27571 msgid ""
27572 " char *\n"
27573 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
27574 "                                   const char *root);\n"
27575 "\n"
27576 msgstr ""
27577
27578 #. type: =head2
27579 #: ../src/guestfs-actions.pod:3544
27580 msgid "guestfs_inspect_get_product_variant"
27581 msgstr ""
27582
27583 #. type: verbatim
27584 #: ../src/guestfs-actions.pod:3546
27585 #, no-wrap
27586 msgid ""
27587 " char *\n"
27588 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
27589 "                                      const char *root);\n"
27590 "\n"
27591 msgstr ""
27592
27593 #. type: textblock
27594 #: ../src/guestfs-actions.pod:3569
27595 msgid ""
27596 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
27597 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
27598 msgstr ""
27599
27600 #. type: textblock
27601 #: ../src/guestfs-actions.pod:3576
27602 msgid "(Added in 1.9.13)"
27603 msgstr ""
27604
27605 #. type: =head2
27606 #: ../src/guestfs-actions.pod:3578
27607 msgid "guestfs_inspect_get_roots"
27608 msgstr ""
27609
27610 #. type: verbatim
27611 #: ../src/guestfs-actions.pod:3580
27612 #, no-wrap
27613 msgid ""
27614 " char **\n"
27615 " guestfs_inspect_get_roots (guestfs_h *g);\n"
27616 "\n"
27617 msgstr ""
27618
27619 #. type: textblock
27620 #: ../src/guestfs-actions.pod:3583
27621 msgid ""
27622 "This function is a convenient way to get the list of root devices, as "
27623 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
27624 "the whole inspection process."
27625 msgstr ""
27626
27627 #. type: textblock
27628 #: ../src/guestfs-actions.pod:3587
27629 msgid ""
27630 "This returns an empty list if either no root devices were found or the "
27631 "caller has not called C<guestfs_inspect_os>."
27632 msgstr ""
27633
27634 #. type: textblock
27635 #: ../src/guestfs-actions.pod:3596
27636 msgid "(Added in 1.7.3)"
27637 msgstr ""
27638
27639 #. type: =head2
27640 #: ../src/guestfs-actions.pod:3598
27641 msgid "guestfs_inspect_get_type"
27642 msgstr ""
27643
27644 #. type: verbatim
27645 #: ../src/guestfs-actions.pod:3600
27646 #, no-wrap
27647 msgid ""
27648 " char *\n"
27649 " guestfs_inspect_get_type (guestfs_h *g,\n"
27650 "                           const char *root);\n"
27651 "\n"
27652 msgstr ""
27653
27654 #. type: =head2
27655 #: ../src/guestfs-actions.pod:3641
27656 msgid "guestfs_inspect_get_windows_current_control_set"
27657 msgstr ""
27658
27659 #. type: verbatim
27660 #: ../src/guestfs-actions.pod:3643
27661 #, no-wrap
27662 msgid ""
27663 " char *\n"
27664 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
27665 "                                                  const char *root);\n"
27666 "\n"
27667 msgstr ""
27668
27669 #. type: =head2
27670 #: ../src/guestfs-actions.pod:3661
27671 msgid "guestfs_inspect_get_windows_systemroot"
27672 msgstr ""
27673
27674 #. type: verbatim
27675 #: ../src/guestfs-actions.pod:3663
27676 #, no-wrap
27677 msgid ""
27678 " char *\n"
27679 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
27680 "                                         const char *root);\n"
27681 "\n"
27682 msgstr ""
27683
27684 #. type: textblock
27685 #: ../src/guestfs-actions.pod:3679
27686 msgid "(Added in 1.5.25)"
27687 msgstr ""
27688
27689 #. type: =head2
27690 #: ../src/guestfs-actions.pod:3681
27691 msgid "guestfs_inspect_is_live"
27692 msgstr ""
27693
27694 #. type: verbatim
27695 #: ../src/guestfs-actions.pod:3683
27696 #, no-wrap
27697 msgid ""
27698 " int\n"
27699 " guestfs_inspect_is_live (guestfs_h *g,\n"
27700 "                          const char *root);\n"
27701 "\n"
27702 msgstr ""
27703
27704 #. type: textblock
27705 #: ../src/guestfs-actions.pod:3687
27706 msgid ""
27707 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
27708 "disk), then this returns true if a live image was detected on the disk."
27709 msgstr ""
27710
27711 #. type: =head2
27712 #: ../src/guestfs-actions.pod:3697
27713 msgid "guestfs_inspect_is_multipart"
27714 msgstr ""
27715
27716 #. type: verbatim
27717 #: ../src/guestfs-actions.pod:3699
27718 #, no-wrap
27719 msgid ""
27720 " int\n"
27721 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
27722 "                               const char *root);\n"
27723 "\n"
27724 msgstr ""
27725
27726 #. type: textblock
27727 #: ../src/guestfs-actions.pod:3703
27728 msgid ""
27729 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
27730 "disk), then this returns true if the disk is part of a set."
27731 msgstr ""
27732
27733 #. type: =head2
27734 #: ../src/guestfs-actions.pod:3713
27735 msgid "guestfs_inspect_is_netinst"
27736 msgstr ""
27737
27738 #. type: verbatim
27739 #: ../src/guestfs-actions.pod:3715
27740 #, no-wrap
27741 msgid ""
27742 " int\n"
27743 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
27744 "                             const char *root);\n"
27745 "\n"
27746 msgstr ""
27747
27748 #. type: textblock
27749 #: ../src/guestfs-actions.pod:3719
27750 msgid ""
27751 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
27752 "disk), then this returns true if the disk is a network installer, ie. not a "
27753 "self-contained install CD but one which is likely to require network access "
27754 "to complete the install."
27755 msgstr ""
27756
27757 #. type: =head2
27758 #: ../src/guestfs-actions.pod:3731
27759 msgid "guestfs_inspect_list_applications"
27760 msgstr ""
27761
27762 #. type: verbatim
27763 #: ../src/guestfs-actions.pod:3733
27764 #, no-wrap
27765 msgid ""
27766 " struct guestfs_application_list *\n"
27767 " guestfs_inspect_list_applications (guestfs_h *g,\n"
27768 "                                    const char *root);\n"
27769 "\n"
27770 msgstr ""
27771
27772 #. type: textblock
27773 #: ../src/guestfs-actions.pod:3739
27774 msgid ""
27775 "I<Note:> This call works differently from other parts of the inspection "
27776 "API.  You have to call C<guestfs_inspect_os>, then "
27777 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
27778 "this.  Listing applications is a significantly more difficult operation "
27779 "which requires access to the full filesystem.  Also note that unlike the "
27780 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
27781 "the libguestfs handle, this call actually reads parts of the mounted "
27782 "filesystems during the call."
27783 msgstr ""
27784
27785 #. type: textblock
27786 #: ../src/guestfs-actions.pod:3829
27787 msgid ""
27788 "This function returns a C<struct guestfs_application_list *>, or NULL if "
27789 "there was an error.  I<The caller must call C<guestfs_free_application_list> "
27790 "after use>."
27791 msgstr ""
27792
27793 #. type: textblock
27794 #: ../src/guestfs-actions.pod:3833
27795 msgid "(Added in 1.7.8)"
27796 msgstr ""
27797
27798 #. type: =head2
27799 #: ../src/guestfs-actions.pod:3835
27800 msgid "guestfs_inspect_os"
27801 msgstr ""
27802
27803 #. type: verbatim
27804 #: ../src/guestfs-actions.pod:3837
27805 #, no-wrap
27806 msgid ""
27807 " char **\n"
27808 " guestfs_inspect_os (guestfs_h *g);\n"
27809 "\n"
27810 msgstr ""
27811
27812 #. type: textblock
27813 #: ../src/guestfs-actions.pod:3853
27814 msgid ""
27815 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
27816 "functions in order to query further information about each operating system, "
27817 "such as the name and version."
27818 msgstr ""
27819
27820 #. type: textblock
27821 #: ../src/guestfs-actions.pod:3858
27822 msgid ""
27823 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
27824 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
27825 "the contents.  This should be called with no disks currently mounted.  The "
27826 "function may also use Augeas, so any existing Augeas handle will be closed."
27827 msgstr ""
27828
27829 #. type: textblock
27830 #: ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:4201 ../src/guestfs-actions.pod:4283
27831 msgid "See also C<guestfs_list_filesystems>."
27832 msgstr ""
27833
27834 #. type: =head2
27835 #: ../src/guestfs-actions.pod:3878
27836 msgid "guestfs_is_blockdev"
27837 msgstr ""
27838
27839 #. type: verbatim
27840 #: ../src/guestfs-actions.pod:3880
27841 #, no-wrap
27842 msgid ""
27843 " int\n"
27844 " guestfs_is_blockdev (guestfs_h *g,\n"
27845 "                      const char *path);\n"
27846 "\n"
27847 msgstr ""
27848
27849 #. type: textblock
27850 #: ../src/guestfs-actions.pod:3887 ../src/guestfs-actions.pod:3916 ../src/guestfs-actions.pod:3946 ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:3977 ../src/guestfs-actions.pod:4033 ../src/guestfs-actions.pod:4048
27851 msgid "See also C<guestfs_stat>."
27852 msgstr ""
27853
27854 #. type: textblock
27855 #: ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:3920 ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:4037 ../src/guestfs-actions.pod:4052
27856 msgid "(Added in 1.5.10)"
27857 msgstr ""
27858
27859 #. type: =head2
27860 #: ../src/guestfs-actions.pod:3893
27861 msgid "guestfs_is_busy"
27862 msgstr ""
27863
27864 #. type: verbatim
27865 #: ../src/guestfs-actions.pod:3895
27866 #, no-wrap
27867 msgid ""
27868 " int\n"
27869 " guestfs_is_busy (guestfs_h *g);\n"
27870 "\n"
27871 msgstr ""
27872
27873 #. type: =head2
27874 #: ../src/guestfs-actions.pod:3907
27875 msgid "guestfs_is_chardev"
27876 msgstr ""
27877
27878 #. type: verbatim
27879 #: ../src/guestfs-actions.pod:3909
27880 #, no-wrap
27881 msgid ""
27882 " int\n"
27883 " guestfs_is_chardev (guestfs_h *g,\n"
27884 "                     const char *path);\n"
27885 "\n"
27886 msgstr ""
27887
27888 #. type: =head2
27889 #: ../src/guestfs-actions.pod:3922
27890 msgid "guestfs_is_config"
27891 msgstr ""
27892
27893 #. type: verbatim
27894 #: ../src/guestfs-actions.pod:3924
27895 #, no-wrap
27896 msgid ""
27897 " int\n"
27898 " guestfs_is_config (guestfs_h *g);\n"
27899 "\n"
27900 msgstr ""
27901
27902 #. type: =head2
27903 #: ../src/guestfs-actions.pod:3936
27904 msgid "guestfs_is_dir"
27905 msgstr ""
27906
27907 #. type: verbatim
27908 #: ../src/guestfs-actions.pod:3938
27909 #, no-wrap
27910 msgid ""
27911 " int\n"
27912 " guestfs_is_dir (guestfs_h *g,\n"
27913 "                 const char *path);\n"
27914 "\n"
27915 msgstr ""
27916
27917 #. type: =head2
27918 #: ../src/guestfs-actions.pod:3952
27919 msgid "guestfs_is_fifo"
27920 msgstr ""
27921
27922 #. type: verbatim
27923 #: ../src/guestfs-actions.pod:3954
27924 #, no-wrap
27925 msgid ""
27926 " int\n"
27927 " guestfs_is_fifo (guestfs_h *g,\n"
27928 "                  const char *path);\n"
27929 "\n"
27930 msgstr ""
27931
27932 #. type: =head2
27933 #: ../src/guestfs-actions.pod:3967
27934 msgid "guestfs_is_file"
27935 msgstr ""
27936
27937 #. type: verbatim
27938 #: ../src/guestfs-actions.pod:3969
27939 #, no-wrap
27940 msgid ""
27941 " int\n"
27942 " guestfs_is_file (guestfs_h *g,\n"
27943 "                  const char *path);\n"
27944 "\n"
27945 msgstr ""
27946
27947 #. type: =head2
27948 #: ../src/guestfs-actions.pod:3983
27949 msgid "guestfs_is_launching"
27950 msgstr ""
27951
27952 #. type: verbatim
27953 #: ../src/guestfs-actions.pod:3985
27954 #, no-wrap
27955 msgid ""
27956 " int\n"
27957 " guestfs_is_launching (guestfs_h *g);\n"
27958 "\n"
27959 msgstr ""
27960
27961 #. type: =head2
27962 #: ../src/guestfs-actions.pod:3997
27963 msgid "guestfs_is_lv"
27964 msgstr ""
27965
27966 #. type: verbatim
27967 #: ../src/guestfs-actions.pod:3999
27968 #, no-wrap
27969 msgid ""
27970 " int\n"
27971 " guestfs_is_lv (guestfs_h *g,\n"
27972 "                const char *device);\n"
27973 "\n"
27974 msgstr ""
27975
27976 #. type: =head2
27977 #: ../src/guestfs-actions.pod:4010
27978 msgid "guestfs_is_ready"
27979 msgstr ""
27980
27981 #. type: verbatim
27982 #: ../src/guestfs-actions.pod:4012
27983 #, no-wrap
27984 msgid ""
27985 " int\n"
27986 " guestfs_is_ready (guestfs_h *g);\n"
27987 "\n"
27988 msgstr ""
27989
27990 #. type: =head2
27991 #: ../src/guestfs-actions.pod:4024
27992 msgid "guestfs_is_socket"
27993 msgstr ""
27994
27995 #. type: verbatim
27996 #: ../src/guestfs-actions.pod:4026
27997 #, no-wrap
27998 msgid ""
27999 " int\n"
28000 " guestfs_is_socket (guestfs_h *g,\n"
28001 "                    const char *path);\n"
28002 "\n"
28003 msgstr ""
28004
28005 #. type: =head2
28006 #: ../src/guestfs-actions.pod:4039
28007 msgid "guestfs_is_symlink"
28008 msgstr ""
28009
28010 #. type: verbatim
28011 #: ../src/guestfs-actions.pod:4041
28012 #, no-wrap
28013 msgid ""
28014 " int\n"
28015 " guestfs_is_symlink (guestfs_h *g,\n"
28016 "                     const char *path);\n"
28017 "\n"
28018 msgstr ""
28019
28020 #. type: =head2
28021 #: ../src/guestfs-actions.pod:4054
28022 msgid "guestfs_is_zero"
28023 msgstr ""
28024
28025 #. type: verbatim
28026 #: ../src/guestfs-actions.pod:4056
28027 #, no-wrap
28028 msgid ""
28029 " int\n"
28030 " guestfs_is_zero (guestfs_h *g,\n"
28031 "                  const char *path);\n"
28032 "\n"
28033 msgstr ""
28034
28035 #. type: textblock
28036 #: ../src/guestfs-actions.pod:4065 ../src/guestfs-actions.pod:4079
28037 msgid "(Added in 1.11.8)"
28038 msgstr ""
28039
28040 #. type: =head2
28041 #: ../src/guestfs-actions.pod:4067
28042 msgid "guestfs_is_zero_device"
28043 msgstr ""
28044
28045 #. type: verbatim
28046 #: ../src/guestfs-actions.pod:4069
28047 #, no-wrap
28048 msgid ""
28049 " int\n"
28050 " guestfs_is_zero_device (guestfs_h *g,\n"
28051 "                         const char *device);\n"
28052 "\n"
28053 msgstr ""
28054
28055 #. type: =head2
28056 #: ../src/guestfs-actions.pod:4081
28057 msgid "guestfs_kill_subprocess"
28058 msgstr ""
28059
28060 #. type: verbatim
28061 #: ../src/guestfs-actions.pod:4083
28062 #, no-wrap
28063 msgid ""
28064 " int\n"
28065 " guestfs_kill_subprocess (guestfs_h *g);\n"
28066 "\n"
28067 msgstr ""
28068
28069 #. type: =head2
28070 #: ../src/guestfs-actions.pod:4092
28071 msgid "guestfs_launch"
28072 msgstr ""
28073
28074 #. type: verbatim
28075 #: ../src/guestfs-actions.pod:4094
28076 #, no-wrap
28077 msgid ""
28078 " int\n"
28079 " guestfs_launch (guestfs_h *g);\n"
28080 "\n"
28081 msgstr ""
28082
28083 #. type: =head2
28084 #: ../src/guestfs-actions.pod:4112
28085 msgid "guestfs_lchown"
28086 msgstr ""
28087
28088 #. type: verbatim
28089 #: ../src/guestfs-actions.pod:4114
28090 #, no-wrap
28091 msgid ""
28092 " int\n"
28093 " guestfs_lchown (guestfs_h *g,\n"
28094 "                 int owner,\n"
28095 "                 int group,\n"
28096 "                 const char *path);\n"
28097 "\n"
28098 msgstr ""
28099
28100 #. type: textblock
28101 #: ../src/guestfs-actions.pod:4120
28102 msgid ""
28103 "Change the file owner to C<owner> and group to C<group>.  This is like "
28104 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
28105 "changed, not the target."
28106 msgstr ""
28107
28108 #. type: =head2
28109 #: ../src/guestfs-actions.pod:4132
28110 msgid "guestfs_lgetxattr"
28111 msgstr ""
28112
28113 #. type: verbatim
28114 #: ../src/guestfs-actions.pod:4134
28115 #, no-wrap
28116 msgid ""
28117 " char *\n"
28118 " guestfs_lgetxattr (guestfs_h *g,\n"
28119 "                    const char *path,\n"
28120 "                    const char *name,\n"
28121 "                    size_t *size_r);\n"
28122 "\n"
28123 msgstr ""
28124
28125 #. type: textblock
28126 #: ../src/guestfs-actions.pod:4154
28127 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
28128 msgstr ""
28129
28130 #. type: =head2
28131 #: ../src/guestfs-actions.pod:4162
28132 msgid "guestfs_lgetxattrs"
28133 msgstr ""
28134
28135 #. type: verbatim
28136 #: ../src/guestfs-actions.pod:4164
28137 #, no-wrap
28138 msgid ""
28139 " struct guestfs_xattr_list *\n"
28140 " guestfs_lgetxattrs (guestfs_h *g,\n"
28141 "                     const char *path);\n"
28142 "\n"
28143 msgstr ""
28144
28145 #. type: textblock
28146 #: ../src/guestfs-actions.pod:4168
28147 msgid ""
28148 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
28149 "then it returns the extended attributes of the link itself."
28150 msgstr ""
28151
28152 #. type: =head2
28153 #: ../src/guestfs-actions.pod:4178
28154 msgid "guestfs_list_9p"
28155 msgstr ""
28156
28157 #. type: verbatim
28158 #: ../src/guestfs-actions.pod:4180
28159 #, no-wrap
28160 msgid ""
28161 " char **\n"
28162 " guestfs_list_9p (guestfs_h *g);\n"
28163 "\n"
28164 msgstr ""
28165
28166 #. type: =head2
28167 #: ../src/guestfs-actions.pod:4192
28168 msgid "guestfs_list_devices"
28169 msgstr ""
28170
28171 #. type: verbatim
28172 #: ../src/guestfs-actions.pod:4194
28173 #, no-wrap
28174 msgid ""
28175 " char **\n"
28176 " guestfs_list_devices (guestfs_h *g);\n"
28177 "\n"
28178 msgstr ""
28179
28180 #. type: =head2
28181 #: ../src/guestfs-actions.pod:4209
28182 msgid "guestfs_list_dm_devices"
28183 msgstr ""
28184
28185 #. type: verbatim
28186 #: ../src/guestfs-actions.pod:4211
28187 #, no-wrap
28188 msgid ""
28189 " char **\n"
28190 " guestfs_list_dm_devices (guestfs_h *g);\n"
28191 "\n"
28192 msgstr ""
28193
28194 #. type: textblock
28195 #: ../src/guestfs-actions.pod:4216
28196 msgid ""
28197 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
28198 "previous call to C<guestfs_luks_open>."
28199 msgstr ""
28200
28201 #. type: textblock
28202 #: ../src/guestfs-actions.pod:4219
28203 msgid ""
28204 "Device mapper devices which correspond to logical volumes are I<not> "
28205 "returned in this list.  Call C<guestfs_lvs> if you want to list logical "
28206 "volumes."
28207 msgstr ""
28208
28209 #. type: textblock
28210 #: ../src/guestfs-actions.pod:4227 ../src/guestfs-actions.pod:5664
28211 msgid "(Added in 1.11.15)"
28212 msgstr ""
28213
28214 #. type: =head2
28215 #: ../src/guestfs-actions.pod:4229
28216 msgid "guestfs_list_filesystems"
28217 msgstr ""
28218
28219 #. type: verbatim
28220 #: ../src/guestfs-actions.pod:4231
28221 #, no-wrap
28222 msgid ""
28223 " char **\n"
28224 " guestfs_list_filesystems (guestfs_h *g);\n"
28225 "\n"
28226 msgstr ""
28227
28228 #. type: textblock
28229 #: ../src/guestfs-actions.pod:4251
28230 msgid ""
28231 "This command runs other libguestfs commands, which might include "
28232 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
28233 "soon after launch and only when nothing is mounted."
28234 msgstr ""
28235
28236 #. type: textblock
28237 #: ../src/guestfs-actions.pod:4255
28238 msgid ""
28239 "Not all of the filesystems returned will be mountable.  In particular, swap "
28240 "partitions are returned in the list.  Also this command does not check that "
28241 "each filesystem found is valid and mountable, and some filesystems might be "
28242 "mountable but require special options.  Filesystems may not all belong to a "
28243 "single logical operating system (use C<guestfs_inspect_os> to look for "
28244 "OSes)."
28245 msgstr ""
28246
28247 #. type: textblock
28248 #: ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:6024
28249 msgid "(Added in 1.5.15)"
28250 msgstr ""
28251
28252 #. type: =head2
28253 #: ../src/guestfs-actions.pod:4271
28254 msgid "guestfs_list_partitions"
28255 msgstr ""
28256
28257 #. type: verbatim
28258 #: ../src/guestfs-actions.pod:4273
28259 #, no-wrap
28260 msgid ""
28261 " char **\n"
28262 " guestfs_list_partitions (guestfs_h *g);\n"
28263 "\n"
28264 msgstr ""
28265
28266 #. type: textblock
28267 #: ../src/guestfs-actions.pod:4280
28268 msgid ""
28269 "This does not return logical volumes.  For that you will need to call "
28270 "C<guestfs_lvs>."
28271 msgstr ""
28272
28273 #. type: =head2
28274 #: ../src/guestfs-actions.pod:4291
28275 msgid "guestfs_ll"
28276 msgstr ""
28277
28278 #. type: verbatim
28279 #: ../src/guestfs-actions.pod:4293
28280 #, no-wrap
28281 msgid ""
28282 " char *\n"
28283 " guestfs_ll (guestfs_h *g,\n"
28284 "             const char *directory);\n"
28285 "\n"
28286 msgstr ""
28287
28288 #. type: =head2
28289 #: ../src/guestfs-actions.pod:4308
28290 msgid "guestfs_ln"
28291 msgstr ""
28292
28293 #. type: verbatim
28294 #: ../src/guestfs-actions.pod:4310
28295 #, no-wrap
28296 msgid ""
28297 " int\n"
28298 " guestfs_ln (guestfs_h *g,\n"
28299 "             const char *target,\n"
28300 "             const char *linkname);\n"
28301 "\n"
28302 msgstr ""
28303
28304 #. type: =head2
28305 #: ../src/guestfs-actions.pod:4321
28306 msgid "guestfs_ln_f"
28307 msgstr ""
28308
28309 #. type: verbatim
28310 #: ../src/guestfs-actions.pod:4323
28311 #, no-wrap
28312 msgid ""
28313 " int\n"
28314 " guestfs_ln_f (guestfs_h *g,\n"
28315 "               const char *target,\n"
28316 "               const char *linkname);\n"
28317 "\n"
28318 msgstr ""
28319
28320 #. type: =head2
28321 #: ../src/guestfs-actions.pod:4335
28322 msgid "guestfs_ln_s"
28323 msgstr ""
28324
28325 #. type: verbatim
28326 #: ../src/guestfs-actions.pod:4337
28327 #, no-wrap
28328 msgid ""
28329 " int\n"
28330 " guestfs_ln_s (guestfs_h *g,\n"
28331 "               const char *target,\n"
28332 "               const char *linkname);\n"
28333 "\n"
28334 msgstr ""
28335
28336 #. type: =head2
28337 #: ../src/guestfs-actions.pod:4348
28338 msgid "guestfs_ln_sf"
28339 msgstr ""
28340
28341 #. type: verbatim
28342 #: ../src/guestfs-actions.pod:4350
28343 #, no-wrap
28344 msgid ""
28345 " int\n"
28346 " guestfs_ln_sf (guestfs_h *g,\n"
28347 "                const char *target,\n"
28348 "                const char *linkname);\n"
28349 "\n"
28350 msgstr ""
28351
28352 #. type: =head2
28353 #: ../src/guestfs-actions.pod:4362
28354 msgid "guestfs_lremovexattr"
28355 msgstr ""
28356
28357 #. type: verbatim
28358 #: ../src/guestfs-actions.pod:4364
28359 #, no-wrap
28360 msgid ""
28361 " int\n"
28362 " guestfs_lremovexattr (guestfs_h *g,\n"
28363 "                       const char *xattr,\n"
28364 "                       const char *path);\n"
28365 "\n"
28366 msgstr ""
28367
28368 #. type: textblock
28369 #: ../src/guestfs-actions.pod:4369
28370 msgid ""
28371 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
28372 "link, then it removes an extended attribute of the link itself."
28373 msgstr ""
28374
28375 #. type: =head2
28376 #: ../src/guestfs-actions.pod:4377
28377 msgid "guestfs_ls"
28378 msgstr ""
28379
28380 #. type: verbatim
28381 #: ../src/guestfs-actions.pod:4379
28382 #, no-wrap
28383 msgid ""
28384 " char **\n"
28385 " guestfs_ls (guestfs_h *g,\n"
28386 "             const char *directory);\n"
28387 "\n"
28388 msgstr ""
28389
28390 #. type: textblock
28391 #: ../src/guestfs-actions.pod:4387
28392 msgid ""
28393 "This command is mostly useful for interactive sessions.  Programs should "
28394 "probably use C<guestfs_readdir> instead."
28395 msgstr ""
28396
28397 #. type: =head2
28398 #: ../src/guestfs-actions.pod:4396
28399 msgid "guestfs_lsetxattr"
28400 msgstr ""
28401
28402 #. type: verbatim
28403 #: ../src/guestfs-actions.pod:4398
28404 #, no-wrap
28405 msgid ""
28406 " int\n"
28407 " guestfs_lsetxattr (guestfs_h *g,\n"
28408 "                    const char *xattr,\n"
28409 "                    const char *val,\n"
28410 "                    int vallen,\n"
28411 "                    const char *path);\n"
28412 "\n"
28413 msgstr ""
28414
28415 #. type: textblock
28416 #: ../src/guestfs-actions.pod:4405
28417 msgid ""
28418 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
28419 "then it sets an extended attribute of the link itself."
28420 msgstr ""
28421
28422 #. type: =head2
28423 #: ../src/guestfs-actions.pod:4413
28424 msgid "guestfs_lstat"
28425 msgstr ""
28426
28427 #. type: verbatim
28428 #: ../src/guestfs-actions.pod:4415
28429 #, no-wrap
28430 msgid ""
28431 " struct guestfs_stat *\n"
28432 " guestfs_lstat (guestfs_h *g,\n"
28433 "                const char *path);\n"
28434 "\n"
28435 msgstr ""
28436
28437 #. type: textblock
28438 #: ../src/guestfs-actions.pod:4421
28439 msgid ""
28440 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
28441 "link, then the link is stat-ed, not the file it refers to."
28442 msgstr ""
28443
28444 #. type: textblock
28445 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:7204
28446 msgid ""
28447 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
28448 "error.  I<The caller must call C<guestfs_free_stat> after use>."
28449 msgstr ""
28450
28451 #. type: textblock
28452 #: ../src/guestfs-actions.pod:4431 ../src/guestfs-actions.pod:7208 ../src/guestfs-actions.pod:7226 ../src/guestfs-actions.pod:7607
28453 msgid "(Added in 0.9.2)"
28454 msgstr ""
28455
28456 #. type: =head2
28457 #: ../src/guestfs-actions.pod:4433
28458 msgid "guestfs_lstatlist"
28459 msgstr ""
28460
28461 #. type: verbatim
28462 #: ../src/guestfs-actions.pod:4435
28463 #, no-wrap
28464 msgid ""
28465 " struct guestfs_stat_list *\n"
28466 " guestfs_lstatlist (guestfs_h *g,\n"
28467 "                    const char *path,\n"
28468 "                    char *const *names);\n"
28469 "\n"
28470 msgstr ""
28471
28472 #. type: textblock
28473 #: ../src/guestfs-actions.pod:4440
28474 msgid ""
28475 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
28476 "files, where all files are in the directory C<path>.  C<names> is the list "
28477 "of files from this directory."
28478 msgstr ""
28479
28480 #. type: textblock
28481 #: ../src/guestfs-actions.pod:4449
28482 msgid ""
28483 "This call is intended for programs that want to efficiently list a directory "
28484 "contents without making many round-trips.  See also C<guestfs_lxattrlist> "
28485 "for a similarly efficient call for getting extended attributes.  Very long "
28486 "directory listings might cause the protocol message size to be exceeded, "
28487 "causing this call to fail.  The caller must split up such requests into "
28488 "smaller groups of names."
28489 msgstr ""
28490
28491 #. type: textblock
28492 #: ../src/guestfs-actions.pod:4457
28493 msgid ""
28494 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
28495 "an error.  I<The caller must call C<guestfs_free_stat_list> after use>."
28496 msgstr ""
28497
28498 #. type: =head2
28499 #: ../src/guestfs-actions.pod:4463
28500 msgid "guestfs_luks_add_key"
28501 msgstr ""
28502
28503 #. type: verbatim
28504 #: ../src/guestfs-actions.pod:4465
28505 #, no-wrap
28506 msgid ""
28507 " int\n"
28508 " guestfs_luks_add_key (guestfs_h *g,\n"
28509 "                       const char *device,\n"
28510 "                       const char *key,\n"
28511 "                       const char *newkey,\n"
28512 "                       int keyslot);\n"
28513 "\n"
28514 msgstr ""
28515
28516 #. type: textblock
28517 #: ../src/guestfs-actions.pod:4477
28518 msgid ""
28519 "Note that if C<keyslot> already contains a key, then this command will "
28520 "fail.  You have to use C<guestfs_luks_kill_slot> first to remove that key."
28521 msgstr ""
28522
28523 #. type: textblock
28524 #: ../src/guestfs-actions.pod:4483 ../src/guestfs-actions.pod:4520 ../src/guestfs-actions.pod:4540 ../src/guestfs-actions.pod:4560 ../src/guestfs-actions.pod:4595 ../src/guestfs-actions.pod:4614
28525 msgid ""
28526 "This function takes a key or passphrase parameter which could contain "
28527 "sensitive material.  Read the section L</KEYS AND PASSPHRASES> for more "
28528 "information."
28529 msgstr ""
28530
28531 #. type: textblock
28532 #: ../src/guestfs-actions.pod:4487 ../src/guestfs-actions.pod:4524 ../src/guestfs-actions.pod:4544 ../src/guestfs-actions.pod:4564
28533 msgid "(Added in 1.5.2)"
28534 msgstr ""
28535
28536 #. type: =head2
28537 #: ../src/guestfs-actions.pod:4489
28538 msgid "guestfs_luks_close"
28539 msgstr ""
28540
28541 #. type: verbatim
28542 #: ../src/guestfs-actions.pod:4491
28543 #, no-wrap
28544 msgid ""
28545 " int\n"
28546 " guestfs_luks_close (guestfs_h *g,\n"
28547 "                     const char *device);\n"
28548 "\n"
28549 msgstr ""
28550
28551 #. type: textblock
28552 #: ../src/guestfs-actions.pod:4495
28553 msgid ""
28554 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
28555 "or C<guestfs_luks_open_ro>.  The C<device> parameter must be the name of the "
28556 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
28557 "underlying block device."
28558 msgstr ""
28559
28560 #. type: textblock
28561 #: ../src/guestfs-actions.pod:4503 ../src/guestfs-actions.pod:4599 ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4668 ../src/guestfs-actions.pod:4713
28562 msgid "(Added in 1.5.1)"
28563 msgstr ""
28564
28565 #. type: =head2
28566 #: ../src/guestfs-actions.pod:4505
28567 msgid "guestfs_luks_format"
28568 msgstr ""
28569
28570 #. type: verbatim
28571 #: ../src/guestfs-actions.pod:4507
28572 #, no-wrap
28573 msgid ""
28574 " int\n"
28575 " guestfs_luks_format (guestfs_h *g,\n"
28576 "                      const char *device,\n"
28577 "                      const char *key,\n"
28578 "                      int keyslot);\n"
28579 "\n"
28580 msgstr ""
28581
28582 #. type: =head2
28583 #: ../src/guestfs-actions.pod:4526
28584 msgid "guestfs_luks_format_cipher"
28585 msgstr ""
28586
28587 #. type: verbatim
28588 #: ../src/guestfs-actions.pod:4528
28589 #, no-wrap
28590 msgid ""
28591 " int\n"
28592 " guestfs_luks_format_cipher (guestfs_h *g,\n"
28593 "                             const char *device,\n"
28594 "                             const char *key,\n"
28595 "                             int keyslot,\n"
28596 "                             const char *cipher);\n"
28597 "\n"
28598 msgstr ""
28599
28600 #. type: textblock
28601 #: ../src/guestfs-actions.pod:4535
28602 msgid ""
28603 "This command is the same as C<guestfs_luks_format> but it also allows you to "
28604 "set the C<cipher> used."
28605 msgstr ""
28606
28607 #. type: =head2
28608 #: ../src/guestfs-actions.pod:4546
28609 msgid "guestfs_luks_kill_slot"
28610 msgstr ""
28611
28612 #. type: verbatim
28613 #: ../src/guestfs-actions.pod:4548
28614 #, no-wrap
28615 msgid ""
28616 " int\n"
28617 " guestfs_luks_kill_slot (guestfs_h *g,\n"
28618 "                         const char *device,\n"
28619 "                         const char *key,\n"
28620 "                         int keyslot);\n"
28621 "\n"
28622 msgstr ""
28623
28624 #. type: =head2
28625 #: ../src/guestfs-actions.pod:4566
28626 msgid "guestfs_luks_open"
28627 msgstr ""
28628
28629 #. type: verbatim
28630 #: ../src/guestfs-actions.pod:4568
28631 #, no-wrap
28632 msgid ""
28633 " int\n"
28634 " guestfs_luks_open (guestfs_h *g,\n"
28635 "                    const char *device,\n"
28636 "                    const char *key,\n"
28637 "                    const char *mapname);\n"
28638 "\n"
28639 msgstr ""
28640
28641 #. type: textblock
28642 #: ../src/guestfs-actions.pod:4586
28643 msgid ""
28644 "If this block device contains LVM volume groups, then calling "
28645 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
28646 "visible."
28647 msgstr ""
28648
28649 #. type: textblock
28650 #: ../src/guestfs-actions.pod:4590
28651 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
28652 msgstr ""
28653
28654 #. type: =head2
28655 #: ../src/guestfs-actions.pod:4601
28656 msgid "guestfs_luks_open_ro"
28657 msgstr ""
28658
28659 #. type: verbatim
28660 #: ../src/guestfs-actions.pod:4603
28661 #, no-wrap
28662 msgid ""
28663 " int\n"
28664 " guestfs_luks_open_ro (guestfs_h *g,\n"
28665 "                       const char *device,\n"
28666 "                       const char *key,\n"
28667 "                       const char *mapname);\n"
28668 "\n"
28669 msgstr ""
28670
28671 #. type: textblock
28672 #: ../src/guestfs-actions.pod:4609
28673 msgid ""
28674 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
28675 "created."
28676 msgstr ""
28677
28678 #. type: =head2
28679 #: ../src/guestfs-actions.pod:4620
28680 msgid "guestfs_lvcreate"
28681 msgstr ""
28682
28683 #. type: verbatim
28684 #: ../src/guestfs-actions.pod:4622
28685 #, no-wrap
28686 msgid ""
28687 " int\n"
28688 " guestfs_lvcreate (guestfs_h *g,\n"
28689 "                   const char *logvol,\n"
28690 "                   const char *volgroup,\n"
28691 "                   int mbytes);\n"
28692 "\n"
28693 msgstr ""
28694
28695 #. type: =head2
28696 #: ../src/guestfs-actions.pod:4635
28697 msgid "guestfs_lvm_canonical_lv_name"
28698 msgstr ""
28699
28700 #. type: verbatim
28701 #: ../src/guestfs-actions.pod:4637
28702 #, no-wrap
28703 msgid ""
28704 " char *\n"
28705 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
28706 "                                const char *lvname);\n"
28707 "\n"
28708 msgstr ""
28709
28710 #. type: textblock
28711 #: ../src/guestfs-actions.pod:4648
28712 msgid "See also C<guestfs_is_lv>."
28713 msgstr ""
28714
28715 #. type: textblock
28716 #: ../src/guestfs-actions.pod:4653
28717 msgid "(Added in 1.5.24)"
28718 msgstr ""
28719
28720 #. type: =head2
28721 #: ../src/guestfs-actions.pod:4655
28722 msgid "guestfs_lvm_clear_filter"
28723 msgstr ""
28724
28725 #. type: verbatim
28726 #: ../src/guestfs-actions.pod:4657
28727 #, no-wrap
28728 msgid ""
28729 " int\n"
28730 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
28731 "\n"
28732 msgstr ""
28733
28734 #. type: textblock
28735 #: ../src/guestfs-actions.pod:4660
28736 msgid ""
28737 "This undoes the effect of C<guestfs_lvm_set_filter>.  LVM will be able to "
28738 "see every block device."
28739 msgstr ""
28740
28741 #. type: =head2
28742 #: ../src/guestfs-actions.pod:4670
28743 msgid "guestfs_lvm_remove_all"
28744 msgstr ""
28745
28746 #. type: verbatim
28747 #: ../src/guestfs-actions.pod:4672
28748 #, no-wrap
28749 msgid ""
28750 " int\n"
28751 " guestfs_lvm_remove_all (guestfs_h *g);\n"
28752 "\n"
28753 msgstr ""
28754
28755 #. type: =head2
28756 #: ../src/guestfs-actions.pod:4682
28757 msgid "guestfs_lvm_set_filter"
28758 msgstr ""
28759
28760 #. type: verbatim
28761 #: ../src/guestfs-actions.pod:4684
28762 #, no-wrap
28763 msgid ""
28764 " int\n"
28765 " guestfs_lvm_set_filter (guestfs_h *g,\n"
28766 "                         char *const *devices);\n"
28767 "\n"
28768 msgstr ""
28769
28770 #. type: =head2
28771 #: ../src/guestfs-actions.pod:4715
28772 msgid "guestfs_lvremove"
28773 msgstr ""
28774
28775 #. type: verbatim
28776 #: ../src/guestfs-actions.pod:4717
28777 #, no-wrap
28778 msgid ""
28779 " int\n"
28780 " guestfs_lvremove (guestfs_h *g,\n"
28781 "                   const char *device);\n"
28782 "\n"
28783 msgstr ""
28784
28785 #. type: textblock
28786 #: ../src/guestfs-actions.pod:4729 ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:7977
28787 msgid "(Added in 1.0.13)"
28788 msgstr ""
28789
28790 #. type: =head2
28791 #: ../src/guestfs-actions.pod:4731
28792 msgid "guestfs_lvrename"
28793 msgstr ""
28794
28795 #. type: verbatim
28796 #: ../src/guestfs-actions.pod:4733
28797 #, no-wrap
28798 msgid ""
28799 " int\n"
28800 " guestfs_lvrename (guestfs_h *g,\n"
28801 "                   const char *logvol,\n"
28802 "                   const char *newlogvol);\n"
28803 "\n"
28804 msgstr ""
28805
28806 #. type: textblock
28807 #: ../src/guestfs-actions.pod:4742 ../src/guestfs-actions.pod:7990
28808 msgid "(Added in 1.0.83)"
28809 msgstr ""
28810
28811 #. type: =head2
28812 #: ../src/guestfs-actions.pod:4744
28813 msgid "guestfs_lvresize"
28814 msgstr ""
28815
28816 #. type: verbatim
28817 #: ../src/guestfs-actions.pod:4746
28818 #, no-wrap
28819 msgid ""
28820 " int\n"
28821 " guestfs_lvresize (guestfs_h *g,\n"
28822 "                   const char *device,\n"
28823 "                   int mbytes);\n"
28824 "\n"
28825 msgstr ""
28826
28827 #. type: =head2
28828 #: ../src/guestfs-actions.pod:4759
28829 msgid "guestfs_lvresize_free"
28830 msgstr ""
28831
28832 #. type: verbatim
28833 #: ../src/guestfs-actions.pod:4761
28834 #, no-wrap
28835 msgid ""
28836 " int\n"
28837 " guestfs_lvresize_free (guestfs_h *g,\n"
28838 "                        const char *lv,\n"
28839 "                        int percent);\n"
28840 "\n"
28841 msgstr ""
28842
28843 #. type: textblock
28844 #: ../src/guestfs-actions.pod:4774
28845 msgid "(Added in 1.3.3)"
28846 msgstr ""
28847
28848 #. type: =head2
28849 #: ../src/guestfs-actions.pod:4776
28850 msgid "guestfs_lvs"
28851 msgstr ""
28852
28853 #. type: verbatim
28854 #: ../src/guestfs-actions.pod:4778
28855 #, no-wrap
28856 msgid ""
28857 " char **\n"
28858 " guestfs_lvs (guestfs_h *g);\n"
28859 "\n"
28860 msgstr ""
28861
28862 #. type: textblock
28863 #: ../src/guestfs-actions.pod:4787
28864 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
28865 msgstr ""
28866
28867 #. type: =head2
28868 #: ../src/guestfs-actions.pod:4795
28869 msgid "guestfs_lvs_full"
28870 msgstr ""
28871
28872 #. type: verbatim
28873 #: ../src/guestfs-actions.pod:4797
28874 #, no-wrap
28875 msgid ""
28876 " struct guestfs_lvm_lv_list *\n"
28877 " guestfs_lvs_full (guestfs_h *g);\n"
28878 "\n"
28879 msgstr ""
28880
28881 #. type: textblock
28882 #: ../src/guestfs-actions.pod:4803
28883 msgid ""
28884 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
28885 "was an error.  I<The caller must call C<guestfs_free_lvm_lv_list> after "
28886 "use>."
28887 msgstr ""
28888
28889 #. type: =head2
28890 #: ../src/guestfs-actions.pod:4809
28891 msgid "guestfs_lvuuid"
28892 msgstr ""
28893
28894 #. type: verbatim
28895 #: ../src/guestfs-actions.pod:4811
28896 #, no-wrap
28897 msgid ""
28898 " char *\n"
28899 " guestfs_lvuuid (guestfs_h *g,\n"
28900 "                 const char *device);\n"
28901 "\n"
28902 msgstr ""
28903
28904 #. type: =head2
28905 #: ../src/guestfs-actions.pod:4822
28906 msgid "guestfs_lxattrlist"
28907 msgstr ""
28908
28909 #. type: verbatim
28910 #: ../src/guestfs-actions.pod:4824
28911 #, no-wrap
28912 msgid ""
28913 " struct guestfs_xattr_list *\n"
28914 " guestfs_lxattrlist (guestfs_h *g,\n"
28915 "                     const char *path,\n"
28916 "                     char *const *names);\n"
28917 "\n"
28918 msgstr ""
28919
28920 #. type: textblock
28921 #: ../src/guestfs-actions.pod:4843
28922 msgid ""
28923 "This call is intended for programs that want to efficiently list a directory "
28924 "contents without making many round-trips.  See also C<guestfs_lstatlist> for "
28925 "a similarly efficient call for getting standard stats.  Very long directory "
28926 "listings might cause the protocol message size to be exceeded, causing this "
28927 "call to fail.  The caller must split up such requests into smaller groups of "
28928 "names."
28929 msgstr ""
28930
28931 #. type: =head2
28932 #: ../src/guestfs-actions.pod:4857
28933 msgid "guestfs_mkdir"
28934 msgstr ""
28935
28936 #. type: verbatim
28937 #: ../src/guestfs-actions.pod:4859
28938 #, no-wrap
28939 msgid ""
28940 " int\n"
28941 " guestfs_mkdir (guestfs_h *g,\n"
28942 "                const char *path);\n"
28943 "\n"
28944 msgstr ""
28945
28946 #. type: =head2
28947 #: ../src/guestfs-actions.pod:4869
28948 msgid "guestfs_mkdir_mode"
28949 msgstr ""
28950
28951 #. type: verbatim
28952 #: ../src/guestfs-actions.pod:4871
28953 #, no-wrap
28954 msgid ""
28955 " int\n"
28956 " guestfs_mkdir_mode (guestfs_h *g,\n"
28957 "                     const char *path,\n"
28958 "                     int mode);\n"
28959 "\n"
28960 msgstr ""
28961
28962 #. type: textblock
28963 #: ../src/guestfs-actions.pod:4883
28964 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
28965 msgstr ""
28966
28967 #. type: =head2
28968 #: ../src/guestfs-actions.pod:4889
28969 msgid "guestfs_mkdir_p"
28970 msgstr ""
28971
28972 #. type: verbatim
28973 #: ../src/guestfs-actions.pod:4891
28974 #, no-wrap
28975 msgid ""
28976 " int\n"
28977 " guestfs_mkdir_p (guestfs_h *g,\n"
28978 "                  const char *path);\n"
28979 "\n"
28980 msgstr ""
28981
28982 #. type: =head2
28983 #: ../src/guestfs-actions.pod:4902
28984 msgid "guestfs_mkdtemp"
28985 msgstr ""
28986
28987 #. type: verbatim
28988 #: ../src/guestfs-actions.pod:4904
28989 #, no-wrap
28990 msgid ""
28991 " char *\n"
28992 " guestfs_mkdtemp (guestfs_h *g,\n"
28993 "                  const char *template);\n"
28994 "\n"
28995 msgstr ""
28996
28997 #. type: =head2
28998 #: ../src/guestfs-actions.pod:4932
28999 msgid "guestfs_mke2fs_J"
29000 msgstr ""
29001
29002 #. type: verbatim
29003 #: ../src/guestfs-actions.pod:4934
29004 #, no-wrap
29005 msgid ""
29006 " int\n"
29007 " guestfs_mke2fs_J (guestfs_h *g,\n"
29008 "                   const char *fstype,\n"
29009 "                   int blocksize,\n"
29010 "                   const char *device,\n"
29011 "                   const char *journal);\n"
29012 "\n"
29013 msgstr ""
29014
29015 #. type: textblock
29016 #: ../src/guestfs-actions.pod:4947
29017 msgid "See also C<guestfs_mke2journal>."
29018 msgstr ""
29019
29020 #. type: textblock
29021 #: ../src/guestfs-actions.pod:4951 ../src/guestfs-actions.pod:4969 ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:5003 ../src/guestfs-actions.pod:5017 ../src/guestfs-actions.pod:5031 ../src/guestfs-actions.pod:5090 ../src/guestfs-actions.pod:5367
29022 msgid "(Added in 1.0.68)"
29023 msgstr ""
29024
29025 #. type: =head2
29026 #: ../src/guestfs-actions.pod:4953
29027 msgid "guestfs_mke2fs_JL"
29028 msgstr ""
29029
29030 #. type: verbatim
29031 #: ../src/guestfs-actions.pod:4955
29032 #, no-wrap
29033 msgid ""
29034 " int\n"
29035 " guestfs_mke2fs_JL (guestfs_h *g,\n"
29036 "                    const char *fstype,\n"
29037 "                    int blocksize,\n"
29038 "                    const char *device,\n"
29039 "                    const char *label);\n"
29040 "\n"
29041 msgstr ""
29042
29043 #. type: textblock
29044 #: ../src/guestfs-actions.pod:4965
29045 msgid "See also C<guestfs_mke2journal_L>."
29046 msgstr ""
29047
29048 #. type: =head2
29049 #: ../src/guestfs-actions.pod:4971
29050 msgid "guestfs_mke2fs_JU"
29051 msgstr ""
29052
29053 #. type: verbatim
29054 #: ../src/guestfs-actions.pod:4973
29055 #, no-wrap
29056 msgid ""
29057 " int\n"
29058 " guestfs_mke2fs_JU (guestfs_h *g,\n"
29059 "                    const char *fstype,\n"
29060 "                    int blocksize,\n"
29061 "                    const char *device,\n"
29062 "                    const char *uuid);\n"
29063 "\n"
29064 msgstr ""
29065
29066 #. type: textblock
29067 #: ../src/guestfs-actions.pod:4983
29068 msgid "See also C<guestfs_mke2journal_U>."
29069 msgstr ""
29070
29071 #. type: =head2
29072 #: ../src/guestfs-actions.pod:4989
29073 msgid "guestfs_mke2journal"
29074 msgstr ""
29075
29076 #. type: verbatim
29077 #: ../src/guestfs-actions.pod:4991
29078 #, no-wrap
29079 msgid ""
29080 " int\n"
29081 " guestfs_mke2journal (guestfs_h *g,\n"
29082 "                      int blocksize,\n"
29083 "                      const char *device);\n"
29084 "\n"
29085 msgstr ""
29086
29087 #. type: =head2
29088 #: ../src/guestfs-actions.pod:5005
29089 msgid "guestfs_mke2journal_L"
29090 msgstr ""
29091
29092 #. type: verbatim
29093 #: ../src/guestfs-actions.pod:5007
29094 #, no-wrap
29095 msgid ""
29096 " int\n"
29097 " guestfs_mke2journal_L (guestfs_h *g,\n"
29098 "                        int blocksize,\n"
29099 "                        const char *label,\n"
29100 "                        const char *device);\n"
29101 "\n"
29102 msgstr ""
29103
29104 #. type: =head2
29105 #: ../src/guestfs-actions.pod:5019
29106 msgid "guestfs_mke2journal_U"
29107 msgstr ""
29108
29109 #. type: verbatim
29110 #: ../src/guestfs-actions.pod:5021
29111 #, no-wrap
29112 msgid ""
29113 " int\n"
29114 " guestfs_mke2journal_U (guestfs_h *g,\n"
29115 "                        int blocksize,\n"
29116 "                        const char *uuid,\n"
29117 "                        const char *device);\n"
29118 "\n"
29119 msgstr ""
29120
29121 #. type: =head2
29122 #: ../src/guestfs-actions.pod:5033
29123 msgid "guestfs_mkfifo"
29124 msgstr ""
29125
29126 #. type: verbatim
29127 #: ../src/guestfs-actions.pod:5035
29128 #, no-wrap
29129 msgid ""
29130 " int\n"
29131 " guestfs_mkfifo (guestfs_h *g,\n"
29132 "                 int mode,\n"
29133 "                 const char *path);\n"
29134 "\n"
29135 msgstr ""
29136
29137 #. type: textblock
29138 #: ../src/guestfs-actions.pod:5040
29139 msgid ""
29140 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>.  It "
29141 "is just a convenient wrapper around C<guestfs_mknod>."
29142 msgstr ""
29143
29144 #. type: =head2
29145 #: ../src/guestfs-actions.pod:5050
29146 msgid "guestfs_mkfs"
29147 msgstr ""
29148
29149 #. type: verbatim
29150 #: ../src/guestfs-actions.pod:5052
29151 #, no-wrap
29152 msgid ""
29153 " int\n"
29154 " guestfs_mkfs (guestfs_h *g,\n"
29155 "               const char *fstype,\n"
29156 "               const char *device);\n"
29157 "\n"
29158 msgstr ""
29159
29160 #. type: =head2
29161 #: ../src/guestfs-actions.pod:5065
29162 msgid "guestfs_mkfs_b"
29163 msgstr ""
29164
29165 #. type: verbatim
29166 #: ../src/guestfs-actions.pod:5067
29167 #, no-wrap
29168 msgid ""
29169 " int\n"
29170 " guestfs_mkfs_b (guestfs_h *g,\n"
29171 "                 const char *fstype,\n"
29172 "                 int blocksize,\n"
29173 "                 const char *device);\n"
29174 "\n"
29175 msgstr ""
29176
29177 #. type: textblock
29178 #: ../src/guestfs-actions.pod:5073
29179 msgid ""
29180 "I<This function is deprecated.> In new code, use the L</guestfs_mkfs_opts> "
29181 "call instead."
29182 msgstr ""
29183
29184 #. type: textblock
29185 #: ../src/guestfs-actions.pod:5080
29186 msgid ""
29187 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
29188 "block size of the resulting filesystem.  Supported block sizes depend on the "
29189 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
29190 msgstr ""
29191
29192 #. type: =head2
29193 #: ../src/guestfs-actions.pod:5092
29194 msgid "guestfs_mkfs_opts"
29195 msgstr ""
29196
29197 #. type: verbatim
29198 #: ../src/guestfs-actions.pod:5094
29199 #, no-wrap
29200 msgid ""
29201 " int\n"
29202 " guestfs_mkfs_opts (guestfs_h *g,\n"
29203 "                    const char *fstype,\n"
29204 "                    const char *device,\n"
29205 "                    ...);\n"
29206 "\n"
29207 msgstr ""
29208
29209 #. type: verbatim
29210 #: ../src/guestfs-actions.pod:5105
29211 #, no-wrap
29212 msgid ""
29213 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
29214 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
29215 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
29216 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
29217 "\n"
29218 msgstr ""
29219
29220 #. type: textblock
29221 #: ../src/guestfs-actions.pod:5153
29222 msgid "(Added in 1.7.19)"
29223 msgstr ""
29224
29225 #. type: =head2
29226 #: ../src/guestfs-actions.pod:5155
29227 msgid "guestfs_mkfs_opts_va"
29228 msgstr ""
29229
29230 #. type: verbatim
29231 #: ../src/guestfs-actions.pod:5157
29232 #, no-wrap
29233 msgid ""
29234 " int\n"
29235 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
29236 "                       const char *fstype,\n"
29237 "                       const char *device,\n"
29238 "                       va_list args);\n"
29239 "\n"
29240 msgstr ""
29241
29242 #. type: textblock
29243 #: ../src/guestfs-actions.pod:5163
29244 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
29245 msgstr ""
29246
29247 #. type: =head2
29248 #: ../src/guestfs-actions.pod:5167
29249 msgid "guestfs_mkfs_opts_argv"
29250 msgstr ""
29251
29252 #. type: verbatim
29253 #: ../src/guestfs-actions.pod:5169
29254 #, no-wrap
29255 msgid ""
29256 " int\n"
29257 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
29258 "                         const char *fstype,\n"
29259 "                         const char *device,\n"
29260 "                         const struct guestfs_mkfs_opts_argv *optargs);\n"
29261 "\n"
29262 msgstr ""
29263
29264 #. type: textblock
29265 #: ../src/guestfs-actions.pod:5175
29266 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
29267 msgstr ""
29268
29269 #. type: =head2
29270 #: ../src/guestfs-actions.pod:5179
29271 msgid "guestfs_mkmountpoint"
29272 msgstr ""
29273
29274 #. type: verbatim
29275 #: ../src/guestfs-actions.pod:5181
29276 #, no-wrap
29277 msgid ""
29278 " int\n"
29279 " guestfs_mkmountpoint (guestfs_h *g,\n"
29280 "                       const char *exemptpath);\n"
29281 "\n"
29282 msgstr ""
29283
29284 #. type: textblock
29285 #: ../src/guestfs-actions.pod:5185
29286 msgid ""
29287 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
29288 "that can be used to create extra mountpoints before mounting the first "
29289 "filesystem."
29290 msgstr ""
29291
29292 #. type: textblock
29293 #: ../src/guestfs-actions.pod:5209
29294 msgid ""
29295 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.  You "
29296 "may get unexpected errors if you try to mix these calls.  It is safest to "
29297 "manually unmount filesystems and remove mountpoints after use."
29298 msgstr ""
29299
29300 #. type: textblock
29301 #: ../src/guestfs-actions.pod:5213
29302 msgid ""
29303 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
29304 "first, so for this to work for manual mountpoints, you must ensure that the "
29305 "innermost mountpoints have the longest pathnames, as in the example code "
29306 "above."
29307 msgstr ""
29308
29309 #. type: textblock
29310 #: ../src/guestfs-actions.pod:5220
29311 msgid ""
29312 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
29313 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
29314 "can also trigger these issues."
29315 msgstr ""
29316
29317 #. type: textblock
29318 #: ../src/guestfs-actions.pod:5226 ../src/guestfs-actions.pod:5532 ../src/guestfs-actions.pod:6559
29319 msgid "(Added in 1.0.62)"
29320 msgstr ""
29321
29322 #. type: =head2
29323 #: ../src/guestfs-actions.pod:5228
29324 msgid "guestfs_mknod"
29325 msgstr ""
29326
29327 #. type: verbatim
29328 #: ../src/guestfs-actions.pod:5230
29329 #, no-wrap
29330 msgid ""
29331 " int\n"
29332 " guestfs_mknod (guestfs_h *g,\n"
29333 "                int mode,\n"
29334 "                int devmajor,\n"
29335 "                int devminor,\n"
29336 "                const char *path);\n"
29337 "\n"
29338 msgstr ""
29339
29340 #. type: textblock
29341 #: ../src/guestfs-actions.pod:5245
29342 msgid ""
29343 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
29344 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
29345 "regular file).  These constants are available in the standard Linux header "
29346 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
29347 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
29348 "the appropriate constant for you."
29349 msgstr ""
29350
29351 #. type: =head2
29352 #: ../src/guestfs-actions.pod:5259
29353 msgid "guestfs_mknod_b"
29354 msgstr ""
29355
29356 #. type: verbatim
29357 #: ../src/guestfs-actions.pod:5261
29358 #, no-wrap
29359 msgid ""
29360 " int\n"
29361 " guestfs_mknod_b (guestfs_h *g,\n"
29362 "                  int mode,\n"
29363 "                  int devmajor,\n"
29364 "                  int devminor,\n"
29365 "                  const char *path);\n"
29366 "\n"
29367 msgstr ""
29368
29369 #. type: textblock
29370 #: ../src/guestfs-actions.pod:5268
29371 msgid ""
29372 "This call creates a block device node called C<path> with mode C<mode> and "
29373 "device major/minor C<devmajor> and C<devminor>.  It is just a convenient "
29374 "wrapper around C<guestfs_mknod>."
29375 msgstr ""
29376
29377 #. type: =head2
29378 #: ../src/guestfs-actions.pod:5278
29379 msgid "guestfs_mknod_c"
29380 msgstr ""
29381
29382 #. type: verbatim
29383 #: ../src/guestfs-actions.pod:5280
29384 #, no-wrap
29385 msgid ""
29386 " int\n"
29387 " guestfs_mknod_c (guestfs_h *g,\n"
29388 "                  int mode,\n"
29389 "                  int devmajor,\n"
29390 "                  int devminor,\n"
29391 "                  const char *path);\n"
29392 "\n"
29393 msgstr ""
29394
29395 #. type: textblock
29396 #: ../src/guestfs-actions.pod:5287
29397 msgid ""
29398 "This call creates a char device node called C<path> with mode C<mode> and "
29399 "device major/minor C<devmajor> and C<devminor>.  It is just a convenient "
29400 "wrapper around C<guestfs_mknod>."
29401 msgstr ""
29402
29403 #. type: =head2
29404 #: ../src/guestfs-actions.pod:5297
29405 msgid "guestfs_mkswap"
29406 msgstr ""
29407
29408 #. type: verbatim
29409 #: ../src/guestfs-actions.pod:5299
29410 #, no-wrap
29411 msgid ""
29412 " int\n"
29413 " guestfs_mkswap (guestfs_h *g,\n"
29414 "                 const char *device);\n"
29415 "\n"
29416 msgstr ""
29417
29418 #. type: =head2
29419 #: ../src/guestfs-actions.pod:5309
29420 msgid "guestfs_mkswap_L"
29421 msgstr ""
29422
29423 #. type: verbatim
29424 #: ../src/guestfs-actions.pod:5311
29425 #, no-wrap
29426 msgid ""
29427 " int\n"
29428 " guestfs_mkswap_L (guestfs_h *g,\n"
29429 "                   const char *label,\n"
29430 "                   const char *device);\n"
29431 "\n"
29432 msgstr ""
29433
29434 #. type: =head2
29435 #: ../src/guestfs-actions.pod:5326
29436 msgid "guestfs_mkswap_U"
29437 msgstr ""
29438
29439 #. type: verbatim
29440 #: ../src/guestfs-actions.pod:5328
29441 #, no-wrap
29442 msgid ""
29443 " int\n"
29444 " guestfs_mkswap_U (guestfs_h *g,\n"
29445 "                   const char *uuid,\n"
29446 "                   const char *device);\n"
29447 "\n"
29448 msgstr ""
29449
29450 #. type: =head2
29451 #: ../src/guestfs-actions.pod:5339
29452 msgid "guestfs_mkswap_file"
29453 msgstr ""
29454
29455 #. type: verbatim
29456 #: ../src/guestfs-actions.pod:5341
29457 #, no-wrap
29458 msgid ""
29459 " int\n"
29460 " guestfs_mkswap_file (guestfs_h *g,\n"
29461 "                      const char *path);\n"
29462 "\n"
29463 msgstr ""
29464
29465 #. type: textblock
29466 #: ../src/guestfs-actions.pod:5347
29467 msgid ""
29468 "This command just writes a swap file signature to an existing file.  To "
29469 "create the file itself, use something like C<guestfs_fallocate>."
29470 msgstr ""
29471
29472 #. type: =head2
29473 #: ../src/guestfs-actions.pod:5354
29474 msgid "guestfs_modprobe"
29475 msgstr ""
29476
29477 #. type: verbatim
29478 #: ../src/guestfs-actions.pod:5356
29479 #, no-wrap
29480 msgid ""
29481 " int\n"
29482 " guestfs_modprobe (guestfs_h *g,\n"
29483 "                   const char *modulename);\n"
29484 "\n"
29485 msgstr ""
29486
29487 #. type: =head2
29488 #: ../src/guestfs-actions.pod:5369
29489 msgid "guestfs_mount"
29490 msgstr ""
29491
29492 #. type: verbatim
29493 #: ../src/guestfs-actions.pod:5371
29494 #, no-wrap
29495 msgid ""
29496 " int\n"
29497 " guestfs_mount (guestfs_h *g,\n"
29498 "                const char *device,\n"
29499 "                const char *mountpoint);\n"
29500 "\n"
29501 msgstr ""
29502
29503 #. type: textblock
29504 #: ../src/guestfs-actions.pod:5390
29505 msgid ""
29506 "Before libguestfs 1.13.16, this call implicitly added the options C<sync> "
29507 "and C<noatime>.  The C<sync> option greatly slowed writes and caused many "
29508 "problems for users.  If your program might need to work with older versions "
29509 "of libguestfs, use C<guestfs_mount_options> instead (using an empty string "
29510 "for the first parameter if you don't want any options)."
29511 msgstr ""
29512
29513 #. type: =head2
29514 #: ../src/guestfs-actions.pod:5401
29515 msgid "guestfs_mount_9p"
29516 msgstr ""
29517
29518 #. type: verbatim
29519 #: ../src/guestfs-actions.pod:5403
29520 #, no-wrap
29521 msgid ""
29522 " int\n"
29523 " guestfs_mount_9p (guestfs_h *g,\n"
29524 "                   const char *mounttag,\n"
29525 "                   const char *mountpoint,\n"
29526 "                   ...);\n"
29527 "\n"
29528 msgstr ""
29529
29530 #. type: verbatim
29531 #: ../src/guestfs-actions.pod:5414
29532 #, no-wrap
29533 msgid ""
29534 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
29535 "\n"
29536 msgstr ""
29537
29538 #. type: =head2
29539 #: ../src/guestfs-actions.pod:5427
29540 msgid "guestfs_mount_9p_va"
29541 msgstr ""
29542
29543 #. type: verbatim
29544 #: ../src/guestfs-actions.pod:5429
29545 #, no-wrap
29546 msgid ""
29547 " int\n"
29548 " guestfs_mount_9p_va (guestfs_h *g,\n"
29549 "                      const char *mounttag,\n"
29550 "                      const char *mountpoint,\n"
29551 "                      va_list args);\n"
29552 "\n"
29553 msgstr ""
29554
29555 #. type: textblock
29556 #: ../src/guestfs-actions.pod:5435
29557 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
29558 msgstr ""
29559
29560 #. type: =head2
29561 #: ../src/guestfs-actions.pod:5439
29562 msgid "guestfs_mount_9p_argv"
29563 msgstr ""
29564
29565 #. type: verbatim
29566 #: ../src/guestfs-actions.pod:5441
29567 #, no-wrap
29568 msgid ""
29569 " int\n"
29570 " guestfs_mount_9p_argv (guestfs_h *g,\n"
29571 "                        const char *mounttag,\n"
29572 "                        const char *mountpoint,\n"
29573 "                        const struct guestfs_mount_9p_argv *optargs);\n"
29574 "\n"
29575 msgstr ""
29576
29577 #. type: textblock
29578 #: ../src/guestfs-actions.pod:5447
29579 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
29580 msgstr ""
29581
29582 #. type: =head2
29583 #: ../src/guestfs-actions.pod:5451
29584 msgid "guestfs_mount_loop"
29585 msgstr ""
29586
29587 #. type: verbatim
29588 #: ../src/guestfs-actions.pod:5453
29589 #, no-wrap
29590 msgid ""
29591 " int\n"
29592 " guestfs_mount_loop (guestfs_h *g,\n"
29593 "                     const char *file,\n"
29594 "                     const char *mountpoint);\n"
29595 "\n"
29596 msgstr ""
29597
29598 #. type: =head2
29599 #: ../src/guestfs-actions.pod:5466
29600 msgid "guestfs_mount_options"
29601 msgstr ""
29602
29603 #. type: verbatim
29604 #: ../src/guestfs-actions.pod:5468
29605 #, no-wrap
29606 msgid ""
29607 " int\n"
29608 " guestfs_mount_options (guestfs_h *g,\n"
29609 "                        const char *options,\n"
29610 "                        const char *device,\n"
29611 "                        const char *mountpoint);\n"
29612 "\n"
29613 msgstr ""
29614
29615 #. type: textblock
29616 #: ../src/guestfs-actions.pod:5474
29617 msgid ""
29618 "This is the same as the C<guestfs_mount> command, but it allows you to set "
29619 "the mount options as for the L<mount(8)> I<-o> flag."
29620 msgstr ""
29621
29622 #. type: textblock
29623 #: ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5498 ../src/guestfs-actions.pod:5515
29624 msgid "(Added in 1.0.10)"
29625 msgstr ""
29626
29627 #. type: =head2
29628 #: ../src/guestfs-actions.pod:5486
29629 msgid "guestfs_mount_ro"
29630 msgstr ""
29631
29632 #. type: verbatim
29633 #: ../src/guestfs-actions.pod:5488
29634 #, no-wrap
29635 msgid ""
29636 " int\n"
29637 " guestfs_mount_ro (guestfs_h *g,\n"
29638 "                   const char *device,\n"
29639 "                   const char *mountpoint);\n"
29640 "\n"
29641 msgstr ""
29642
29643 #. type: textblock
29644 #: ../src/guestfs-actions.pod:5493
29645 msgid ""
29646 "This is the same as the C<guestfs_mount> command, but it mounts the "
29647 "filesystem with the read-only (I<-o ro>) flag."
29648 msgstr ""
29649
29650 #. type: =head2
29651 #: ../src/guestfs-actions.pod:5500
29652 msgid "guestfs_mount_vfs"
29653 msgstr ""
29654
29655 #. type: verbatim
29656 #: ../src/guestfs-actions.pod:5502
29657 #, no-wrap
29658 msgid ""
29659 " int\n"
29660 " guestfs_mount_vfs (guestfs_h *g,\n"
29661 "                    const char *options,\n"
29662 "                    const char *vfstype,\n"
29663 "                    const char *device,\n"
29664 "                    const char *mountpoint);\n"
29665 "\n"
29666 msgstr ""
29667
29668 #. type: textblock
29669 #: ../src/guestfs-actions.pod:5509
29670 msgid ""
29671 "This is the same as the C<guestfs_mount> command, but it allows you to set "
29672 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
29673 "I<-t> flags."
29674 msgstr ""
29675
29676 #. type: =head2
29677 #: ../src/guestfs-actions.pod:5517
29678 msgid "guestfs_mountpoints"
29679 msgstr ""
29680
29681 #. type: verbatim
29682 #: ../src/guestfs-actions.pod:5519
29683 #, no-wrap
29684 msgid ""
29685 " char **\n"
29686 " guestfs_mountpoints (guestfs_h *g);\n"
29687 "\n"
29688 msgstr ""
29689
29690 #. type: textblock
29691 #: ../src/guestfs-actions.pod:5522
29692 msgid ""
29693 "This call is similar to C<guestfs_mounts>.  That call returns a list of "
29694 "devices.  This one returns a hash table (map) of device name to directory "
29695 "where the device is mounted."
29696 msgstr ""
29697
29698 #. type: =head2
29699 #: ../src/guestfs-actions.pod:5534
29700 msgid "guestfs_mounts"
29701 msgstr ""
29702
29703 #. type: verbatim
29704 #: ../src/guestfs-actions.pod:5536
29705 #, no-wrap
29706 msgid ""
29707 " char **\n"
29708 " guestfs_mounts (guestfs_h *g);\n"
29709 "\n"
29710 msgstr ""
29711
29712 #. type: textblock
29713 #: ../src/guestfs-actions.pod:5544
29714 msgid "See also: C<guestfs_mountpoints>"
29715 msgstr ""
29716
29717 #. type: =head2
29718 #: ../src/guestfs-actions.pod:5552
29719 msgid "guestfs_mv"
29720 msgstr ""
29721
29722 #. type: verbatim
29723 #: ../src/guestfs-actions.pod:5554
29724 #, no-wrap
29725 msgid ""
29726 " int\n"
29727 " guestfs_mv (guestfs_h *g,\n"
29728 "             const char *src,\n"
29729 "             const char *dest);\n"
29730 "\n"
29731 msgstr ""
29732
29733 #. type: =head2
29734 #: ../src/guestfs-actions.pod:5566
29735 msgid "guestfs_ntfs_3g_probe"
29736 msgstr ""
29737
29738 #. type: verbatim
29739 #: ../src/guestfs-actions.pod:5568
29740 #, no-wrap
29741 msgid ""
29742 " int\n"
29743 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
29744 "                        int rw,\n"
29745 "                        const char *device);\n"
29746 "\n"
29747 msgstr ""
29748
29749 #. type: textblock
29750 #: ../src/guestfs-actions.pod:5587
29751 msgid "(Added in 1.0.43)"
29752 msgstr ""
29753
29754 #. type: =head2
29755 #: ../src/guestfs-actions.pod:5589
29756 msgid "guestfs_ntfsresize"
29757 msgstr ""
29758
29759 #. type: verbatim
29760 #: ../src/guestfs-actions.pod:5591
29761 #, no-wrap
29762 msgid ""
29763 " int\n"
29764 " guestfs_ntfsresize (guestfs_h *g,\n"
29765 "                     const char *device);\n"
29766 "\n"
29767 msgstr ""
29768
29769 #. type: textblock
29770 #: ../src/guestfs-actions.pod:5595 ../src/guestfs-actions.pod:5695
29771 msgid ""
29772 "I<This function is deprecated.> In new code, use the "
29773 "L</guestfs_ntfsresize_opts> call instead."
29774 msgstr ""
29775
29776 #. type: =head2
29777 #: ../src/guestfs-actions.pod:5619
29778 msgid "guestfs_ntfsresize_opts"
29779 msgstr ""
29780
29781 #. type: verbatim
29782 #: ../src/guestfs-actions.pod:5621
29783 #, no-wrap
29784 msgid ""
29785 " int\n"
29786 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
29787 "                          const char *device,\n"
29788 "                          ...);\n"
29789 "\n"
29790 msgstr ""
29791
29792 #. type: verbatim
29793 #: ../src/guestfs-actions.pod:5631
29794 #, no-wrap
29795 msgid ""
29796 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
29797 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
29798 "\n"
29799 msgstr ""
29800
29801 #. type: textblock
29802 #: ../src/guestfs-actions.pod:5651
29803 msgid ""
29804 "After the resize operation, the filesystem is always marked as requiring a "
29805 "consistency check (for safety).  You have to boot into Windows to perform "
29806 "this check and clear this condition.  If you I<don't> set the C<force> "
29807 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
29808 "times on a single filesystem without booting into Windows between each "
29809 "resize."
29810 msgstr ""
29811
29812 #. type: =head2
29813 #: ../src/guestfs-actions.pod:5666
29814 msgid "guestfs_ntfsresize_opts_va"
29815 msgstr ""
29816
29817 #. type: verbatim
29818 #: ../src/guestfs-actions.pod:5668
29819 #, no-wrap
29820 msgid ""
29821 " int\n"
29822 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
29823 "                             const char *device,\n"
29824 "                             va_list args);\n"
29825 "\n"
29826 msgstr ""
29827
29828 #. type: textblock
29829 #: ../src/guestfs-actions.pod:5673
29830 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
29831 msgstr ""
29832
29833 #. type: =head2
29834 #: ../src/guestfs-actions.pod:5677
29835 msgid "guestfs_ntfsresize_opts_argv"
29836 msgstr ""
29837
29838 #. type: verbatim
29839 #: ../src/guestfs-actions.pod:5679
29840 #, no-wrap
29841 msgid ""
29842 " int\n"
29843 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
29844 "                               const char *device,\n"
29845 "                               const struct guestfs_ntfsresize_opts_argv "
29846 "*optargs);\n"
29847 "\n"
29848 msgstr ""
29849
29850 #. type: textblock
29851 #: ../src/guestfs-actions.pod:5684
29852 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
29853 msgstr ""
29854
29855 #. type: =head2
29856 #: ../src/guestfs-actions.pod:5688
29857 msgid "guestfs_ntfsresize_size"
29858 msgstr ""
29859
29860 #. type: verbatim
29861 #: ../src/guestfs-actions.pod:5690
29862 #, no-wrap
29863 msgid ""
29864 " int\n"
29865 " guestfs_ntfsresize_size (guestfs_h *g,\n"
29866 "                          const char *device,\n"
29867 "                          int64_t size);\n"
29868 "\n"
29869 msgstr ""
29870
29871 #. type: textblock
29872 #: ../src/guestfs-actions.pod:5702
29873 msgid ""
29874 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
29875 "to specify the new size (in bytes) explicitly."
29876 msgstr ""
29877
29878 #. type: textblock
29879 #: ../src/guestfs-actions.pod:5707 ../src/guestfs-actions.pod:6166 ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6507 ../src/guestfs-actions.pod:8134
29880 msgid "(Added in 1.3.14)"
29881 msgstr ""
29882
29883 #. type: =head2
29884 #: ../src/guestfs-actions.pod:5709
29885 msgid "guestfs_part_add"
29886 msgstr ""
29887
29888 #. type: verbatim
29889 #: ../src/guestfs-actions.pod:5711
29890 #, no-wrap
29891 msgid ""
29892 " int\n"
29893 " guestfs_part_add (guestfs_h *g,\n"
29894 "                   const char *device,\n"
29895 "                   const char *prlogex,\n"
29896 "                   int64_t startsect,\n"
29897 "                   int64_t endsect);\n"
29898 "\n"
29899 msgstr ""
29900
29901 #. type: textblock
29902 #: ../src/guestfs-actions.pod:5718
29903 msgid ""
29904 "This command adds a partition to C<device>.  If there is no partition table "
29905 "on the device, call C<guestfs_part_init> first."
29906 msgstr ""
29907
29908 #. type: textblock
29909 #: ../src/guestfs-actions.pod:5730
29910 msgid ""
29911 "Creating a partition which covers the whole disk is not so easy.  Use "
29912 "C<guestfs_part_disk> to do that."
29913 msgstr ""
29914
29915 #. type: textblock
29916 #: ../src/guestfs-actions.pod:5735 ../src/guestfs-actions.pod:5770 ../src/guestfs-actions.pod:5823 ../src/guestfs-actions.pod:5907 ../src/guestfs-actions.pod:5945 ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:6004
29917 msgid "(Added in 1.0.78)"
29918 msgstr ""
29919
29920 #. type: =head2
29921 #: ../src/guestfs-actions.pod:5737
29922 msgid "guestfs_part_del"
29923 msgstr ""
29924
29925 #. type: verbatim
29926 #: ../src/guestfs-actions.pod:5739
29927 #, no-wrap
29928 msgid ""
29929 " int\n"
29930 " guestfs_part_del (guestfs_h *g,\n"
29931 "                   const char *device,\n"
29932 "                   int partnum);\n"
29933 "\n"
29934 msgstr ""
29935
29936 #. type: =head2
29937 #: ../src/guestfs-actions.pod:5754
29938 msgid "guestfs_part_disk"
29939 msgstr ""
29940
29941 #. type: verbatim
29942 #: ../src/guestfs-actions.pod:5756
29943 #, no-wrap
29944 msgid ""
29945 " int\n"
29946 " guestfs_part_disk (guestfs_h *g,\n"
29947 "                    const char *device,\n"
29948 "                    const char *parttype);\n"
29949 "\n"
29950 msgstr ""
29951
29952 #. type: textblock
29953 #: ../src/guestfs-actions.pod:5761
29954 msgid ""
29955 "This command is simply a combination of C<guestfs_part_init> followed by "
29956 "C<guestfs_part_add> to create a single primary partition covering the whole "
29957 "disk."
29958 msgstr ""
29959
29960 #. type: textblock
29961 #: ../src/guestfs-actions.pod:5765
29962 msgid ""
29963 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
29964 "possible values are described in C<guestfs_part_init>."
29965 msgstr ""
29966
29967 #. type: =head2
29968 #: ../src/guestfs-actions.pod:5772
29969 msgid "guestfs_part_get_bootable"
29970 msgstr ""
29971
29972 #. type: verbatim
29973 #: ../src/guestfs-actions.pod:5774
29974 #, no-wrap
29975 msgid ""
29976 " int\n"
29977 " guestfs_part_get_bootable (guestfs_h *g,\n"
29978 "                            const char *device,\n"
29979 "                            int partnum);\n"
29980 "\n"
29981 msgstr ""
29982
29983 #. type: textblock
29984 #: ../src/guestfs-actions.pod:5782
29985 msgid "See also C<guestfs_part_set_bootable>."
29986 msgstr ""
29987
29988 #. type: =head2
29989 #: ../src/guestfs-actions.pod:5788
29990 msgid "guestfs_part_get_mbr_id"
29991 msgstr ""
29992
29993 #. type: verbatim
29994 #: ../src/guestfs-actions.pod:5790
29995 #, no-wrap
29996 msgid ""
29997 " int\n"
29998 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
29999 "                          const char *device,\n"
30000 "                          int partnum);\n"
30001 "\n"
30002 msgstr ""
30003
30004 #. type: textblock
30005 #: ../src/guestfs-actions.pod:5798 ../src/guestfs-actions.pod:5980
30006 msgid ""
30007 "Note that only MBR (old DOS-style) partitions have type bytes.  You will get "
30008 "undefined results for other partition table types (see "
30009 "C<guestfs_part_get_parttype>)."
30010 msgstr ""
30011
30012 #. type: =head2
30013 #: ../src/guestfs-actions.pod:5806
30014 msgid "guestfs_part_get_parttype"
30015 msgstr ""
30016
30017 #. type: verbatim
30018 #: ../src/guestfs-actions.pod:5808
30019 #, no-wrap
30020 msgid ""
30021 " char *\n"
30022 " guestfs_part_get_parttype (guestfs_h *g,\n"
30023 "                            const char *device);\n"
30024 "\n"
30025 msgstr ""
30026
30027 #. type: textblock
30028 #: ../src/guestfs-actions.pod:5815
30029 msgid ""
30030 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
30031 "table), C<gpt> (a GPT/EFI-style partition table).  Other values are "
30032 "possible, although unusual.  See C<guestfs_part_init> for a full list."
30033 msgstr ""
30034
30035 #. type: =head2
30036 #: ../src/guestfs-actions.pod:5825
30037 msgid "guestfs_part_init"
30038 msgstr ""
30039
30040 #. type: verbatim
30041 #: ../src/guestfs-actions.pod:5827
30042 #, no-wrap
30043 msgid ""
30044 " int\n"
30045 " guestfs_part_init (guestfs_h *g,\n"
30046 "                    const char *device,\n"
30047 "                    const char *parttype);\n"
30048 "\n"
30049 msgstr ""
30050
30051 #. type: textblock
30052 #: ../src/guestfs-actions.pod:5836
30053 msgid ""
30054 "Initially there are no partitions.  Following this, you should call "
30055 "C<guestfs_part_add> for each partition required."
30056 msgstr ""
30057
30058 #. type: =head2
30059 #: ../src/guestfs-actions.pod:5909
30060 msgid "guestfs_part_list"
30061 msgstr ""
30062
30063 #. type: verbatim
30064 #: ../src/guestfs-actions.pod:5911
30065 #, no-wrap
30066 msgid ""
30067 " struct guestfs_partition_list *\n"
30068 " guestfs_part_list (guestfs_h *g,\n"
30069 "                    const char *device);\n"
30070 "\n"
30071 msgstr ""
30072
30073 #. type: textblock
30074 #: ../src/guestfs-actions.pod:5928
30075 msgid ""
30076 "Start of the partition I<in bytes>.  To get sectors you have to divide by "
30077 "the device's sector size, see C<guestfs_blockdev_getss>."
30078 msgstr ""
30079
30080 #. type: textblock
30081 #: ../src/guestfs-actions.pod:5941
30082 msgid ""
30083 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
30084 "was an error.  I<The caller must call C<guestfs_free_partition_list> after "
30085 "use>."
30086 msgstr ""
30087
30088 #. type: =head2
30089 #: ../src/guestfs-actions.pod:5947
30090 msgid "guestfs_part_set_bootable"
30091 msgstr ""
30092
30093 #. type: verbatim
30094 #: ../src/guestfs-actions.pod:5949
30095 #, no-wrap
30096 msgid ""
30097 " int\n"
30098 " guestfs_part_set_bootable (guestfs_h *g,\n"
30099 "                            const char *device,\n"
30100 "                            int partnum,\n"
30101 "                            int bootable);\n"
30102 "\n"
30103 msgstr ""
30104
30105 #. type: =head2
30106 #: ../src/guestfs-actions.pod:5966
30107 msgid "guestfs_part_set_mbr_id"
30108 msgstr ""
30109
30110 #. type: verbatim
30111 #: ../src/guestfs-actions.pod:5968
30112 #, no-wrap
30113 msgid ""
30114 " int\n"
30115 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
30116 "                          const char *device,\n"
30117 "                          int partnum,\n"
30118 "                          int idbyte);\n"
30119 "\n"
30120 msgstr ""
30121
30122 #. type: =head2
30123 #: ../src/guestfs-actions.pod:5988
30124 msgid "guestfs_part_set_name"
30125 msgstr ""
30126
30127 #. type: verbatim
30128 #: ../src/guestfs-actions.pod:5990
30129 #, no-wrap
30130 msgid ""
30131 " int\n"
30132 " guestfs_part_set_name (guestfs_h *g,\n"
30133 "                        const char *device,\n"
30134 "                        int partnum,\n"
30135 "                        const char *name);\n"
30136 "\n"
30137 msgstr ""
30138
30139 #. type: =head2
30140 #: ../src/guestfs-actions.pod:6006
30141 msgid "guestfs_part_to_dev"
30142 msgstr ""
30143
30144 #. type: verbatim
30145 #: ../src/guestfs-actions.pod:6008
30146 #, no-wrap
30147 msgid ""
30148 " char *\n"
30149 " guestfs_part_to_dev (guestfs_h *g,\n"
30150 "                      const char *partition);\n"
30151 "\n"
30152 msgstr ""
30153
30154 #. type: textblock
30155 #: ../src/guestfs-actions.pod:6016 ../src/guestfs-actions.pod:6035
30156 msgid ""
30157 "The named partition must exist, for example as a string returned from "
30158 "C<guestfs_list_partitions>."
30159 msgstr ""
30160
30161 #. type: textblock
30162 #: ../src/guestfs-actions.pod:6019
30163 msgid "See also C<guestfs_part_to_partnum>."
30164 msgstr ""
30165
30166 #. type: =head2
30167 #: ../src/guestfs-actions.pod:6026
30168 msgid "guestfs_part_to_partnum"
30169 msgstr ""
30170
30171 #. type: verbatim
30172 #: ../src/guestfs-actions.pod:6028
30173 #, no-wrap
30174 msgid ""
30175 " int\n"
30176 " guestfs_part_to_partnum (guestfs_h *g,\n"
30177 "                          const char *partition);\n"
30178 "\n"
30179 msgstr ""
30180
30181 #. type: textblock
30182 #: ../src/guestfs-actions.pod:6038
30183 msgid "See also C<guestfs_part_to_dev>."
30184 msgstr ""
30185
30186 #. type: =head2
30187 #: ../src/guestfs-actions.pod:6044
30188 msgid "guestfs_ping_daemon"
30189 msgstr ""
30190
30191 #. type: verbatim
30192 #: ../src/guestfs-actions.pod:6046
30193 #, no-wrap
30194 msgid ""
30195 " int\n"
30196 " guestfs_ping_daemon (guestfs_h *g);\n"
30197 "\n"
30198 msgstr ""
30199
30200 #. type: =head2
30201 #: ../src/guestfs-actions.pod:6058
30202 msgid "guestfs_pread"
30203 msgstr ""
30204
30205 #. type: verbatim
30206 #: ../src/guestfs-actions.pod:6060
30207 #, no-wrap
30208 msgid ""
30209 " char *\n"
30210 " guestfs_pread (guestfs_h *g,\n"
30211 "                const char *path,\n"
30212 "                int count,\n"
30213 "                int64_t offset,\n"
30214 "                size_t *size_r);\n"
30215 "\n"
30216 msgstr ""
30217
30218 #. type: textblock
30219 #: ../src/guestfs-actions.pod:6073
30220 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
30221 msgstr ""
30222
30223 #. type: =head2
30224 #: ../src/guestfs-actions.pod:6084
30225 msgid "guestfs_pread_device"
30226 msgstr ""
30227
30228 #. type: verbatim
30229 #: ../src/guestfs-actions.pod:6086
30230 #, no-wrap
30231 msgid ""
30232 " char *\n"
30233 " guestfs_pread_device (guestfs_h *g,\n"
30234 "                       const char *device,\n"
30235 "                       int count,\n"
30236 "                       int64_t offset,\n"
30237 "                       size_t *size_r);\n"
30238 "\n"
30239 msgstr ""
30240
30241 #. type: textblock
30242 #: ../src/guestfs-actions.pod:6099
30243 msgid "See also C<guestfs_pread>."
30244 msgstr ""
30245
30246 #. type: textblock
30247 #: ../src/guestfs-actions.pod:6108
30248 msgid "(Added in 1.5.21)"
30249 msgstr ""
30250
30251 #. type: =head2
30252 #: ../src/guestfs-actions.pod:6110
30253 msgid "guestfs_pvcreate"
30254 msgstr ""
30255
30256 #. type: verbatim
30257 #: ../src/guestfs-actions.pod:6112
30258 #, no-wrap
30259 msgid ""
30260 " int\n"
30261 " guestfs_pvcreate (guestfs_h *g,\n"
30262 "                   const char *device);\n"
30263 "\n"
30264 msgstr ""
30265
30266 #. type: =head2
30267 #: ../src/guestfs-actions.pod:6124
30268 msgid "guestfs_pvremove"
30269 msgstr ""
30270
30271 #. type: verbatim
30272 #: ../src/guestfs-actions.pod:6126
30273 #, no-wrap
30274 msgid ""
30275 " int\n"
30276 " guestfs_pvremove (guestfs_h *g,\n"
30277 "                   const char *device);\n"
30278 "\n"
30279 msgstr ""
30280
30281 #. type: =head2
30282 #: ../src/guestfs-actions.pod:6141
30283 msgid "guestfs_pvresize"
30284 msgstr ""
30285
30286 #. type: verbatim
30287 #: ../src/guestfs-actions.pod:6143
30288 #, no-wrap
30289 msgid ""
30290 " int\n"
30291 " guestfs_pvresize (guestfs_h *g,\n"
30292 "                   const char *device);\n"
30293 "\n"
30294 msgstr ""
30295
30296 #. type: =head2
30297 #: ../src/guestfs-actions.pod:6154
30298 msgid "guestfs_pvresize_size"
30299 msgstr ""
30300
30301 #. type: verbatim
30302 #: ../src/guestfs-actions.pod:6156
30303 #, no-wrap
30304 msgid ""
30305 " int\n"
30306 " guestfs_pvresize_size (guestfs_h *g,\n"
30307 "                        const char *device,\n"
30308 "                        int64_t size);\n"
30309 "\n"
30310 msgstr ""
30311
30312 #. type: textblock
30313 #: ../src/guestfs-actions.pod:6161
30314 msgid ""
30315 "This command is the same as C<guestfs_pvresize> except that it allows you to "
30316 "specify the new size (in bytes) explicitly."
30317 msgstr ""
30318
30319 #. type: =head2
30320 #: ../src/guestfs-actions.pod:6168
30321 msgid "guestfs_pvs"
30322 msgstr ""
30323
30324 #. type: verbatim
30325 #: ../src/guestfs-actions.pod:6170
30326 #, no-wrap
30327 msgid ""
30328 " char **\n"
30329 " guestfs_pvs (guestfs_h *g);\n"
30330 "\n"
30331 msgstr ""
30332
30333 #. type: textblock
30334 #: ../src/guestfs-actions.pod:6179
30335 msgid "See also C<guestfs_pvs_full>."
30336 msgstr ""
30337
30338 #. type: =head2
30339 #: ../src/guestfs-actions.pod:6187
30340 msgid "guestfs_pvs_full"
30341 msgstr ""
30342
30343 #. type: verbatim
30344 #: ../src/guestfs-actions.pod:6189
30345 #, no-wrap
30346 msgid ""
30347 " struct guestfs_lvm_pv_list *\n"
30348 " guestfs_pvs_full (guestfs_h *g);\n"
30349 "\n"
30350 msgstr ""
30351
30352 #. type: textblock
30353 #: ../src/guestfs-actions.pod:6195
30354 msgid ""
30355 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
30356 "was an error.  I<The caller must call C<guestfs_free_lvm_pv_list> after "
30357 "use>."
30358 msgstr ""
30359
30360 #. type: =head2
30361 #: ../src/guestfs-actions.pod:6201
30362 msgid "guestfs_pvuuid"
30363 msgstr ""
30364
30365 #. type: verbatim
30366 #: ../src/guestfs-actions.pod:6203
30367 #, no-wrap
30368 msgid ""
30369 " char *\n"
30370 " guestfs_pvuuid (guestfs_h *g,\n"
30371 "                 const char *device);\n"
30372 "\n"
30373 msgstr ""
30374
30375 #. type: =head2
30376 #: ../src/guestfs-actions.pod:6214
30377 msgid "guestfs_pwrite"
30378 msgstr ""
30379
30380 #. type: verbatim
30381 #: ../src/guestfs-actions.pod:6216
30382 #, no-wrap
30383 msgid ""
30384 " int\n"
30385 " guestfs_pwrite (guestfs_h *g,\n"
30386 "                 const char *path,\n"
30387 "                 const char *content,\n"
30388 "                 size_t content_size,\n"
30389 "                 int64_t offset);\n"
30390 "\n"
30391 msgstr ""
30392
30393 #. type: textblock
30394 #: ../src/guestfs-actions.pod:6232
30395 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
30396 msgstr ""
30397
30398 #. type: =head2
30399 #: ../src/guestfs-actions.pod:6241
30400 msgid "guestfs_pwrite_device"
30401 msgstr ""
30402
30403 #. type: verbatim
30404 #: ../src/guestfs-actions.pod:6243
30405 #, no-wrap
30406 msgid ""
30407 " int\n"
30408 " guestfs_pwrite_device (guestfs_h *g,\n"
30409 "                        const char *device,\n"
30410 "                        const char *content,\n"
30411 "                        size_t content_size,\n"
30412 "                        int64_t offset);\n"
30413 "\n"
30414 msgstr ""
30415
30416 #. type: textblock
30417 #: ../src/guestfs-actions.pod:6258
30418 msgid "See also C<guestfs_pwrite>."
30419 msgstr ""
30420
30421 #. type: textblock
30422 #: ../src/guestfs-actions.pod:6265
30423 msgid "(Added in 1.5.20)"
30424 msgstr ""
30425
30426 #. type: =head2
30427 #: ../src/guestfs-actions.pod:6267
30428 msgid "guestfs_read_file"
30429 msgstr ""
30430
30431 #. type: verbatim
30432 #: ../src/guestfs-actions.pod:6269
30433 #, no-wrap
30434 msgid ""
30435 " char *\n"
30436 " guestfs_read_file (guestfs_h *g,\n"
30437 "                    const char *path,\n"
30438 "                    size_t *size_r);\n"
30439 "\n"
30440 msgstr ""
30441
30442 #. type: textblock
30443 #: ../src/guestfs-actions.pod:6277
30444 msgid ""
30445 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
30446 "embedded ASCII NUL characters.  However unlike C<guestfs_download>, this "
30447 "function is limited in the total size of file that can be handled."
30448 msgstr ""
30449
30450 #. type: textblock
30451 #: ../src/guestfs-actions.pod:6289
30452 msgid "(Added in 1.0.63)"
30453 msgstr ""
30454
30455 #. type: =head2
30456 #: ../src/guestfs-actions.pod:6291
30457 msgid "guestfs_read_lines"
30458 msgstr ""
30459
30460 #. type: verbatim
30461 #: ../src/guestfs-actions.pod:6293
30462 #, no-wrap
30463 msgid ""
30464 " char **\n"
30465 " guestfs_read_lines (guestfs_h *g,\n"
30466 "                     const char *path);\n"
30467 "\n"
30468 msgstr ""
30469
30470 #. type: textblock
30471 #: ../src/guestfs-actions.pod:6302
30472 msgid ""
30473 "Note that this function cannot correctly handle binary files (specifically, "
30474 "files containing C<\\0> character which is treated as end of line).  For "
30475 "those you need to use the C<guestfs_read_file> function which has a more "
30476 "complex interface."
30477 msgstr ""
30478
30479 #. type: =head2
30480 #: ../src/guestfs-actions.pod:6313
30481 msgid "guestfs_readdir"
30482 msgstr ""
30483
30484 #. type: verbatim
30485 #: ../src/guestfs-actions.pod:6315
30486 #, no-wrap
30487 msgid ""
30488 " struct guestfs_dirent_list *\n"
30489 " guestfs_readdir (guestfs_h *g,\n"
30490 "                  const char *dir);\n"
30491 "\n"
30492 msgstr ""
30493
30494 #. type: textblock
30495 #: ../src/guestfs-actions.pod:6369
30496 msgid ""
30497 "This function is primarily intended for use by programs.  To get a simple "
30498 "list of names, use C<guestfs_ls>.  To get a printable directory for human "
30499 "consumption, use C<guestfs_ll>."
30500 msgstr ""
30501
30502 #. type: textblock
30503 #: ../src/guestfs-actions.pod:6373
30504 msgid ""
30505 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
30506 "was an error.  I<The caller must call C<guestfs_free_dirent_list> after "
30507 "use>."
30508 msgstr ""
30509
30510 #. type: =head2
30511 #: ../src/guestfs-actions.pod:6379
30512 msgid "guestfs_readlink"
30513 msgstr ""
30514
30515 #. type: verbatim
30516 #: ../src/guestfs-actions.pod:6381
30517 #, no-wrap
30518 msgid ""
30519 " char *\n"
30520 " guestfs_readlink (guestfs_h *g,\n"
30521 "                   const char *path);\n"
30522 "\n"
30523 msgstr ""
30524
30525 #. type: =head2
30526 #: ../src/guestfs-actions.pod:6392
30527 msgid "guestfs_readlinklist"
30528 msgstr ""
30529
30530 #. type: verbatim
30531 #: ../src/guestfs-actions.pod:6394
30532 #, no-wrap
30533 msgid ""
30534 " char **\n"
30535 " guestfs_readlinklist (guestfs_h *g,\n"
30536 "                       const char *path,\n"
30537 "                       char *const *names);\n"
30538 "\n"
30539 msgstr ""
30540
30541 #. type: =head2
30542 #: ../src/guestfs-actions.pod:6427
30543 msgid "guestfs_realpath"
30544 msgstr ""
30545
30546 #. type: verbatim
30547 #: ../src/guestfs-actions.pod:6429
30548 #, no-wrap
30549 msgid ""
30550 " char *\n"
30551 " guestfs_realpath (guestfs_h *g,\n"
30552 "                   const char *path);\n"
30553 "\n"
30554 msgstr ""
30555
30556 #. type: =head2
30557 #: ../src/guestfs-actions.pod:6441
30558 msgid "guestfs_removexattr"
30559 msgstr ""
30560
30561 #. type: verbatim
30562 #: ../src/guestfs-actions.pod:6443
30563 #, no-wrap
30564 msgid ""
30565 " int\n"
30566 " guestfs_removexattr (guestfs_h *g,\n"
30567 "                      const char *xattr,\n"
30568 "                      const char *path);\n"
30569 "\n"
30570 msgstr ""
30571
30572 #. type: textblock
30573 #: ../src/guestfs-actions.pod:6451
30574 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
30575 msgstr ""
30576
30577 #. type: =head2
30578 #: ../src/guestfs-actions.pod:6457
30579 msgid "guestfs_resize2fs"
30580 msgstr ""
30581
30582 #. type: verbatim
30583 #: ../src/guestfs-actions.pod:6459
30584 #, no-wrap
30585 msgid ""
30586 " int\n"
30587 " guestfs_resize2fs (guestfs_h *g,\n"
30588 "                    const char *device);\n"
30589 "\n"
30590 msgstr ""
30591
30592 #. type: textblock
30593 #: ../src/guestfs-actions.pod:6466
30594 msgid ""
30595 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
30596 "C<device> before calling this command.  For unknown reasons C<resize2fs> "
30597 "sometimes gives an error about this and sometimes not.  In any case, it is "
30598 "always safe to call C<guestfs_e2fsck_f> before calling this function."
30599 msgstr ""
30600
30601 #. type: =head2
30602 #: ../src/guestfs-actions.pod:6476
30603 msgid "guestfs_resize2fs_M"
30604 msgstr ""
30605
30606 #. type: verbatim
30607 #: ../src/guestfs-actions.pod:6478
30608 #, no-wrap
30609 msgid ""
30610 " int\n"
30611 " guestfs_resize2fs_M (guestfs_h *g,\n"
30612 "                      const char *device);\n"
30613 "\n"
30614 msgstr ""
30615
30616 #. type: textblock
30617 #: ../src/guestfs-actions.pod:6482
30618 msgid ""
30619 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
30620 "resized to its minimum size.  This works like the I<-M> option to the "
30621 "C<resize2fs> command."
30622 msgstr ""
30623
30624 #. type: textblock
30625 #: ../src/guestfs-actions.pod:6486
30626 msgid ""
30627 "To get the resulting size of the filesystem you should call "
30628 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values.  "
30629 "These two numbers, multiplied together, give the resulting size of the "
30630 "minimal filesystem in bytes."
30631 msgstr ""
30632
30633 #. type: =head2
30634 #: ../src/guestfs-actions.pod:6495
30635 msgid "guestfs_resize2fs_size"
30636 msgstr ""
30637
30638 #. type: verbatim
30639 #: ../src/guestfs-actions.pod:6497
30640 #, no-wrap
30641 msgid ""
30642 " int\n"
30643 " guestfs_resize2fs_size (guestfs_h *g,\n"
30644 "                         const char *device,\n"
30645 "                         int64_t size);\n"
30646 "\n"
30647 msgstr ""
30648
30649 #. type: textblock
30650 #: ../src/guestfs-actions.pod:6502
30651 msgid ""
30652 "This command is the same as C<guestfs_resize2fs> except that it allows you "
30653 "to specify the new size (in bytes) explicitly."
30654 msgstr ""
30655
30656 #. type: =head2
30657 #: ../src/guestfs-actions.pod:6509
30658 msgid "guestfs_rm"
30659 msgstr ""
30660
30661 #. type: verbatim
30662 #: ../src/guestfs-actions.pod:6511
30663 #, no-wrap
30664 msgid ""
30665 " int\n"
30666 " guestfs_rm (guestfs_h *g,\n"
30667 "             const char *path);\n"
30668 "\n"
30669 msgstr ""
30670
30671 #. type: =head2
30672 #: ../src/guestfs-actions.pod:6521
30673 msgid "guestfs_rm_rf"
30674 msgstr ""
30675
30676 #. type: verbatim
30677 #: ../src/guestfs-actions.pod:6523
30678 #, no-wrap
30679 msgid ""
30680 " int\n"
30681 " guestfs_rm_rf (guestfs_h *g,\n"
30682 "                const char *path);\n"
30683 "\n"
30684 msgstr ""
30685
30686 #. type: =head2
30687 #: ../src/guestfs-actions.pod:6535
30688 msgid "guestfs_rmdir"
30689 msgstr ""
30690
30691 #. type: verbatim
30692 #: ../src/guestfs-actions.pod:6537
30693 #, no-wrap
30694 msgid ""
30695 " int\n"
30696 " guestfs_rmdir (guestfs_h *g,\n"
30697 "                const char *path);\n"
30698 "\n"
30699 msgstr ""
30700
30701 #. type: =head2
30702 #: ../src/guestfs-actions.pod:6547
30703 msgid "guestfs_rmmountpoint"
30704 msgstr ""
30705
30706 #. type: verbatim
30707 #: ../src/guestfs-actions.pod:6549
30708 #, no-wrap
30709 msgid ""
30710 " int\n"
30711 " guestfs_rmmountpoint (guestfs_h *g,\n"
30712 "                       const char *exemptpath);\n"
30713 "\n"
30714 msgstr ""
30715
30716 #. type: textblock
30717 #: ../src/guestfs-actions.pod:6553
30718 msgid ""
30719 "This calls removes a mountpoint that was previously created with "
30720 "C<guestfs_mkmountpoint>.  See C<guestfs_mkmountpoint> for full details."
30721 msgstr ""
30722
30723 #. type: =head2
30724 #: ../src/guestfs-actions.pod:6561
30725 msgid "guestfs_scrub_device"
30726 msgstr ""
30727
30728 #. type: verbatim
30729 #: ../src/guestfs-actions.pod:6563
30730 #, no-wrap
30731 msgid ""
30732 " int\n"
30733 " guestfs_scrub_device (guestfs_h *g,\n"
30734 "                       const char *device);\n"
30735 "\n"
30736 msgstr ""
30737
30738 #. type: textblock
30739 #: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6593 ../src/guestfs-actions.pod:6612
30740 msgid "(Added in 1.0.52)"
30741 msgstr ""
30742
30743 #. type: =head2
30744 #: ../src/guestfs-actions.pod:6577
30745 msgid "guestfs_scrub_file"
30746 msgstr ""
30747
30748 #. type: verbatim
30749 #: ../src/guestfs-actions.pod:6579
30750 #, no-wrap
30751 msgid ""
30752 " int\n"
30753 " guestfs_scrub_file (guestfs_h *g,\n"
30754 "                     const char *file);\n"
30755 "\n"
30756 msgstr ""
30757
30758 #. type: =head2
30759 #: ../src/guestfs-actions.pod:6595
30760 msgid "guestfs_scrub_freespace"
30761 msgstr ""
30762
30763 #. type: verbatim
30764 #: ../src/guestfs-actions.pod:6597
30765 #, no-wrap
30766 msgid ""
30767 " int\n"
30768 " guestfs_scrub_freespace (guestfs_h *g,\n"
30769 "                          const char *dir);\n"
30770 "\n"
30771 msgstr ""
30772
30773 #. type: textblock
30774 #: ../src/guestfs-actions.pod:6601
30775 msgid ""
30776 "This command creates the directory C<dir> and then fills it with files until "
30777 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
30778 "and deletes them.  The intention is to scrub any free space on the partition "
30779 "containing C<dir>."
30780 msgstr ""
30781
30782 #. type: =head2
30783 #: ../src/guestfs-actions.pod:6614
30784 msgid "guestfs_set_append"
30785 msgstr ""
30786
30787 #. type: verbatim
30788 #: ../src/guestfs-actions.pod:6616
30789 #, no-wrap
30790 msgid ""
30791 " int\n"
30792 " guestfs_set_append (guestfs_h *g,\n"
30793 "                     const char *append);\n"
30794 "\n"
30795 msgstr ""
30796
30797 #. type: =head2
30798 #: ../src/guestfs-actions.pod:6633
30799 msgid "guestfs_set_attach_method"
30800 msgstr ""
30801
30802 #. type: verbatim
30803 #: ../src/guestfs-actions.pod:6635
30804 #, no-wrap
30805 msgid ""
30806 " int\n"
30807 " guestfs_set_attach_method (guestfs_h *g,\n"
30808 "                            const char *attachmethod);\n"
30809 "\n"
30810 msgstr ""
30811
30812 #. type: =head2
30813 #: ../src/guestfs-actions.pod:6663
30814 msgid "guestfs_set_autosync"
30815 msgstr ""
30816
30817 #. type: verbatim
30818 #: ../src/guestfs-actions.pod:6665
30819 #, no-wrap
30820 msgid ""
30821 " int\n"
30822 " guestfs_set_autosync (guestfs_h *g,\n"
30823 "                       int autosync);\n"
30824 "\n"
30825 msgstr ""
30826
30827 #. type: =head2
30828 #: ../src/guestfs-actions.pod:6681
30829 msgid "guestfs_set_direct"
30830 msgstr ""
30831
30832 #. type: verbatim
30833 #: ../src/guestfs-actions.pod:6683
30834 #, no-wrap
30835 msgid ""
30836 " int\n"
30837 " guestfs_set_direct (guestfs_h *g,\n"
30838 "                     int direct);\n"
30839 "\n"
30840 msgstr ""
30841
30842 #. type: textblock
30843 #: ../src/guestfs-actions.pod:6691
30844 msgid ""
30845 "One consequence of this is that log messages aren't caught by the library "
30846 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
30847 "stdout."
30848 msgstr ""
30849
30850 #. type: =head2
30851 #: ../src/guestfs-actions.pod:6704
30852 msgid "guestfs_set_e2label"
30853 msgstr ""
30854
30855 #. type: verbatim
30856 #: ../src/guestfs-actions.pod:6706
30857 #, no-wrap
30858 msgid ""
30859 " int\n"
30860 " guestfs_set_e2label (guestfs_h *g,\n"
30861 "                      const char *device,\n"
30862 "                      const char *label);\n"
30863 "\n"
30864 msgstr ""
30865
30866 #. type: textblock
30867 #: ../src/guestfs-actions.pod:6715
30868 msgid ""
30869 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
30870 "the existing label on a filesystem."
30871 msgstr ""
30872
30873 #. type: =head2
30874 #: ../src/guestfs-actions.pod:6722
30875 msgid "guestfs_set_e2uuid"
30876 msgstr ""
30877
30878 #. type: verbatim
30879 #: ../src/guestfs-actions.pod:6724
30880 #, no-wrap
30881 msgid ""
30882 " int\n"
30883 " guestfs_set_e2uuid (guestfs_h *g,\n"
30884 "                     const char *device,\n"
30885 "                     const char *uuid);\n"
30886 "\n"
30887 msgstr ""
30888
30889 #. type: textblock
30890 #: ../src/guestfs-actions.pod:6734
30891 msgid ""
30892 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
30893 "the existing UUID of a filesystem."
30894 msgstr ""
30895
30896 #. type: =head2
30897 #: ../src/guestfs-actions.pod:6741
30898 msgid "guestfs_set_memsize"
30899 msgstr ""
30900
30901 #. type: verbatim
30902 #: ../src/guestfs-actions.pod:6743
30903 #, no-wrap
30904 msgid ""
30905 " int\n"
30906 " guestfs_set_memsize (guestfs_h *g,\n"
30907 "                      int memsize);\n"
30908 "\n"
30909 msgstr ""
30910
30911 #. type: textblock
30912 #: ../src/guestfs-actions.pod:6747
30913 msgid ""
30914 "This sets the memory size in megabytes allocated to the qemu subprocess.  "
30915 "This only has any effect if called before C<guestfs_launch>."
30916 msgstr ""
30917
30918 #. type: =head2
30919 #: ../src/guestfs-actions.pod:6762
30920 msgid "guestfs_set_network"
30921 msgstr ""
30922
30923 #. type: verbatim
30924 #: ../src/guestfs-actions.pod:6764
30925 #, no-wrap
30926 msgid ""
30927 " int\n"
30928 " guestfs_set_network (guestfs_h *g,\n"
30929 "                      int network);\n"
30930 "\n"
30931 msgstr ""
30932
30933 #. type: textblock
30934 #: ../src/guestfs-actions.pod:6774
30935 msgid ""
30936 "You must call this before calling C<guestfs_launch>, otherwise it has no "
30937 "effect."
30938 msgstr ""
30939
30940 #. type: =head2
30941 #: ../src/guestfs-actions.pod:6781
30942 msgid "guestfs_set_path"
30943 msgstr ""
30944
30945 #. type: verbatim
30946 #: ../src/guestfs-actions.pod:6783
30947 #, no-wrap
30948 msgid ""
30949 " int\n"
30950 " guestfs_set_path (guestfs_h *g,\n"
30951 "                   const char *searchpath);\n"
30952 "\n"
30953 msgstr ""
30954
30955 #. type: =head2
30956 #: ../src/guestfs-actions.pod:6798
30957 msgid "guestfs_set_pgroup"
30958 msgstr ""
30959
30960 #. type: verbatim
30961 #: ../src/guestfs-actions.pod:6800
30962 #, no-wrap
30963 msgid ""
30964 " int\n"
30965 " guestfs_set_pgroup (guestfs_h *g,\n"
30966 "                     int pgroup);\n"
30967 "\n"
30968 msgstr ""
30969
30970 #. type: =head2
30971 #: ../src/guestfs-actions.pod:6817
30972 msgid "guestfs_set_qemu"
30973 msgstr ""
30974
30975 #. type: verbatim
30976 #: ../src/guestfs-actions.pod:6819
30977 #, no-wrap
30978 msgid ""
30979 " int\n"
30980 " guestfs_set_qemu (guestfs_h *g,\n"
30981 "                   const char *qemu);\n"
30982 "\n"
30983 msgstr ""
30984
30985 #. type: =head2
30986 #: ../src/guestfs-actions.pod:6845
30987 msgid "guestfs_set_recovery_proc"
30988 msgstr ""
30989
30990 #. type: verbatim
30991 #: ../src/guestfs-actions.pod:6847
30992 #, no-wrap
30993 msgid ""
30994 " int\n"
30995 " guestfs_set_recovery_proc (guestfs_h *g,\n"
30996 "                            int recoveryproc);\n"
30997 "\n"
30998 msgstr ""
30999
31000 #. type: textblock
31001 #: ../src/guestfs-actions.pod:6851
31002 msgid ""
31003 "If this is called with the parameter C<false> then C<guestfs_launch> does "
31004 "not create a recovery process.  The purpose of the recovery process is to "
31005 "stop runaway qemu processes in the case where the main program aborts "
31006 "abruptly."
31007 msgstr ""
31008
31009 #. type: textblock
31010 #: ../src/guestfs-actions.pod:6856
31011 msgid ""
31012 "This only has any effect if called before C<guestfs_launch>, and the default "
31013 "is true."
31014 msgstr ""
31015
31016 #. type: =head2
31017 #: ../src/guestfs-actions.pod:6869
31018 msgid "guestfs_set_selinux"
31019 msgstr ""
31020
31021 #. type: verbatim
31022 #: ../src/guestfs-actions.pod:6871
31023 #, no-wrap
31024 msgid ""
31025 " int\n"
31026 " guestfs_set_selinux (guestfs_h *g,\n"
31027 "                      int selinux);\n"
31028 "\n"
31029 msgstr ""
31030
31031 #. type: =head2
31032 #: ../src/guestfs-actions.pod:6888
31033 msgid "guestfs_set_smp"
31034 msgstr ""
31035
31036 #. type: verbatim
31037 #: ../src/guestfs-actions.pod:6890
31038 #, no-wrap
31039 msgid ""
31040 " int\n"
31041 " guestfs_set_smp (guestfs_h *g,\n"
31042 "                  int smp);\n"
31043 "\n"
31044 msgstr ""
31045
31046 #. type: textblock
31047 #: ../src/guestfs-actions.pod:6898
31048 msgid "This function must be called before C<guestfs_launch>."
31049 msgstr ""
31050
31051 #. type: =head2
31052 #: ../src/guestfs-actions.pod:6904
31053 msgid "guestfs_set_trace"
31054 msgstr ""
31055
31056 #. type: verbatim
31057 #: ../src/guestfs-actions.pod:6906
31058 #, no-wrap
31059 msgid ""
31060 " int\n"
31061 " guestfs_set_trace (guestfs_h *g,\n"
31062 "                    int trace);\n"
31063 "\n"
31064 msgstr ""
31065
31066 #. type: textblock
31067 #: ../src/guestfs-actions.pod:6920
31068 msgid ""
31069 "Trace messages are normally sent to C<stderr>, unless you register a "
31070 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
31071 msgstr ""
31072
31073 #. type: =head2
31074 #: ../src/guestfs-actions.pod:6928
31075 msgid "guestfs_set_verbose"
31076 msgstr ""
31077
31078 #. type: verbatim
31079 #: ../src/guestfs-actions.pod:6930
31080 #, no-wrap
31081 msgid ""
31082 " int\n"
31083 " guestfs_set_verbose (guestfs_h *g,\n"
31084 "                      int verbose);\n"
31085 "\n"
31086 msgstr ""
31087
31088 #. type: textblock
31089 #: ../src/guestfs-actions.pod:6939
31090 msgid ""
31091 "Verbose messages are normally sent to C<stderr>, unless you register a "
31092 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
31093 msgstr ""
31094
31095 #. type: =head2
31096 #: ../src/guestfs-actions.pod:6947
31097 msgid "guestfs_setcon"
31098 msgstr ""
31099
31100 #. type: verbatim
31101 #: ../src/guestfs-actions.pod:6949
31102 #, no-wrap
31103 msgid ""
31104 " int\n"
31105 " guestfs_setcon (guestfs_h *g,\n"
31106 "                 const char *context);\n"
31107 "\n"
31108 msgstr ""
31109
31110 #. type: =head2
31111 #: ../src/guestfs-actions.pod:6962
31112 msgid "guestfs_setxattr"
31113 msgstr ""
31114
31115 #. type: verbatim
31116 #: ../src/guestfs-actions.pod:6964
31117 #, no-wrap
31118 msgid ""
31119 " int\n"
31120 " guestfs_setxattr (guestfs_h *g,\n"
31121 "                   const char *xattr,\n"
31122 "                   const char *val,\n"
31123 "                   int vallen,\n"
31124 "                   const char *path);\n"
31125 "\n"
31126 msgstr ""
31127
31128 #. type: textblock
31129 #: ../src/guestfs-actions.pod:6975
31130 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
31131 msgstr ""
31132
31133 #. type: =head2
31134 #: ../src/guestfs-actions.pod:6981
31135 msgid "guestfs_sfdisk"
31136 msgstr ""
31137
31138 #. type: verbatim
31139 #: ../src/guestfs-actions.pod:6983
31140 #, no-wrap
31141 msgid ""
31142 " int\n"
31143 " guestfs_sfdisk (guestfs_h *g,\n"
31144 "                 const char *device,\n"
31145 "                 int cyls,\n"
31146 "                 int heads,\n"
31147 "                 int sectors,\n"
31148 "                 char *const *lines);\n"
31149 "\n"
31150 msgstr ""
31151
31152 #. type: textblock
31153 #: ../src/guestfs-actions.pod:6991 ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7063
31154 msgid ""
31155 "I<This function is deprecated.> In new code, use the L</guestfs_part_add> "
31156 "call instead."
31157 msgstr ""
31158
31159 #. type: textblock
31160 #: ../src/guestfs-actions.pod:7018
31161 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
31162 msgstr ""
31163
31164 #. type: =head2
31165 #: ../src/guestfs-actions.pod:7025
31166 msgid "guestfs_sfdiskM"
31167 msgstr ""
31168
31169 #. type: verbatim
31170 #: ../src/guestfs-actions.pod:7027
31171 #, no-wrap
31172 msgid ""
31173 " int\n"
31174 " guestfs_sfdiskM (guestfs_h *g,\n"
31175 "                  const char *device,\n"
31176 "                  char *const *lines);\n"
31177 "\n"
31178 msgstr ""
31179
31180 #. type: textblock
31181 #: ../src/guestfs-actions.pod:7039
31182 msgid ""
31183 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
31184 "partition sizes are specified in megabytes only (rounded to the nearest "
31185 "cylinder) and you don't need to specify the cyls, heads and sectors "
31186 "parameters which were rarely if ever used anyway."
31187 msgstr ""
31188
31189 #. type: textblock
31190 #: ../src/guestfs-actions.pod:7045
31191 msgid ""
31192 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
31193 "C<guestfs_part_disk>"
31194 msgstr ""
31195
31196 #. type: =head2
31197 #: ../src/guestfs-actions.pod:7052
31198 msgid "guestfs_sfdisk_N"
31199 msgstr ""
31200
31201 #. type: verbatim
31202 #: ../src/guestfs-actions.pod:7054
31203 #, no-wrap
31204 msgid ""
31205 " int\n"
31206 " guestfs_sfdisk_N (guestfs_h *g,\n"
31207 "                   const char *device,\n"
31208 "                   int partnum,\n"
31209 "                   int cyls,\n"
31210 "                   int heads,\n"
31211 "                   int sectors,\n"
31212 "                   const char *line);\n"
31213 "\n"
31214 msgstr ""
31215
31216 #. type: textblock
31217 #: ../src/guestfs-actions.pod:7073
31218 msgid ""
31219 "For other parameters, see C<guestfs_sfdisk>.  You should usually pass C<0> "
31220 "for the cyls/heads/sectors parameters."
31221 msgstr ""
31222
31223 #. type: textblock
31224 #: ../src/guestfs-actions.pod:7076
31225 msgid "See also: C<guestfs_part_add>"
31226 msgstr ""
31227
31228 #. type: =head2
31229 #: ../src/guestfs-actions.pod:7082
31230 msgid "guestfs_sfdisk_disk_geometry"
31231 msgstr ""
31232
31233 #. type: verbatim
31234 #: ../src/guestfs-actions.pod:7084
31235 #, no-wrap
31236 msgid ""
31237 " char *\n"
31238 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
31239 "                               const char *device);\n"
31240 "\n"
31241 msgstr ""
31242
31243 #. type: textblock
31244 #: ../src/guestfs-actions.pod:7088
31245 msgid ""
31246 "This displays the disk geometry of C<device> read from the partition table.  "
31247 "Especially in the case where the underlying block device has been resized, "
31248 "this can be different from the kernel's idea of the geometry (see "
31249 "C<guestfs_sfdisk_kernel_geometry>)."
31250 msgstr ""
31251
31252 #. type: =head2
31253 #: ../src/guestfs-actions.pod:7101
31254 msgid "guestfs_sfdisk_kernel_geometry"
31255 msgstr ""
31256
31257 #. type: verbatim
31258 #: ../src/guestfs-actions.pod:7103
31259 #, no-wrap
31260 msgid ""
31261 " char *\n"
31262 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
31263 "                                 const char *device);\n"
31264 "\n"
31265 msgstr ""
31266
31267 #. type: =head2
31268 #: ../src/guestfs-actions.pod:7117
31269 msgid "guestfs_sfdisk_l"
31270 msgstr ""
31271
31272 #. type: verbatim
31273 #: ../src/guestfs-actions.pod:7119
31274 #, no-wrap
31275 msgid ""
31276 " char *\n"
31277 " guestfs_sfdisk_l (guestfs_h *g,\n"
31278 "                   const char *device);\n"
31279 "\n"
31280 msgstr ""
31281
31282 #. type: textblock
31283 #: ../src/guestfs-actions.pod:7123
31284 msgid ""
31285 "I<This function is deprecated.> In new code, use the L</guestfs_part_list> "
31286 "call instead."
31287 msgstr ""
31288
31289 #. type: textblock
31290 #: ../src/guestfs-actions.pod:7134
31291 msgid "See also: C<guestfs_part_list>"
31292 msgstr ""
31293
31294 #. type: =head2
31295 #: ../src/guestfs-actions.pod:7141
31296 msgid "guestfs_sh"
31297 msgstr ""
31298
31299 #. type: verbatim
31300 #: ../src/guestfs-actions.pod:7143
31301 #, no-wrap
31302 msgid ""
31303 " char *\n"
31304 " guestfs_sh (guestfs_h *g,\n"
31305 "             const char *command);\n"
31306 "\n"
31307 msgstr ""
31308
31309 #. type: textblock
31310 #: ../src/guestfs-actions.pod:7150
31311 msgid "This is like C<guestfs_command>, but passes the command to:"
31312 msgstr ""
31313
31314 #. type: textblock
31315 #: ../src/guestfs-actions.pod:7158
31316 msgid "All the provisos about C<guestfs_command> apply to this call."
31317 msgstr ""
31318
31319 #. type: =head2
31320 #: ../src/guestfs-actions.pod:7165
31321 msgid "guestfs_sh_lines"
31322 msgstr ""
31323
31324 #. type: verbatim
31325 #: ../src/guestfs-actions.pod:7167
31326 #, no-wrap
31327 msgid ""
31328 " char **\n"
31329 " guestfs_sh_lines (guestfs_h *g,\n"
31330 "                   const char *command);\n"
31331 "\n"
31332 msgstr ""
31333
31334 #. type: textblock
31335 #: ../src/guestfs-actions.pod:7171
31336 msgid ""
31337 "This is the same as C<guestfs_sh>, but splits the result into a list of "
31338 "lines."
31339 msgstr ""
31340
31341 #. type: textblock
31342 #: ../src/guestfs-actions.pod:7174
31343 msgid "See also: C<guestfs_command_lines>"
31344 msgstr ""
31345
31346 #. type: =head2
31347 #: ../src/guestfs-actions.pod:7182
31348 msgid "guestfs_sleep"
31349 msgstr ""
31350
31351 #. type: verbatim
31352 #: ../src/guestfs-actions.pod:7184
31353 #, no-wrap
31354 msgid ""
31355 " int\n"
31356 " guestfs_sleep (guestfs_h *g,\n"
31357 "                int secs);\n"
31358 "\n"
31359 msgstr ""
31360
31361 #. type: textblock
31362 #: ../src/guestfs-actions.pod:7192
31363 msgid "(Added in 1.0.41)"
31364 msgstr ""
31365
31366 #. type: =head2
31367 #: ../src/guestfs-actions.pod:7194 ../src/guestfs-structs.pod:109
31368 msgid "guestfs_stat"
31369 msgstr ""
31370
31371 #. type: verbatim
31372 #: ../src/guestfs-actions.pod:7196
31373 #, no-wrap
31374 msgid ""
31375 " struct guestfs_stat *\n"
31376 " guestfs_stat (guestfs_h *g,\n"
31377 "               const char *path);\n"
31378 "\n"
31379 msgstr ""
31380
31381 #. type: =head2
31382 #: ../src/guestfs-actions.pod:7210 ../src/guestfs-structs.pod:135
31383 msgid "guestfs_statvfs"
31384 msgstr ""
31385
31386 #. type: verbatim
31387 #: ../src/guestfs-actions.pod:7212
31388 #, no-wrap
31389 msgid ""
31390 " struct guestfs_statvfs *\n"
31391 " guestfs_statvfs (guestfs_h *g,\n"
31392 "                  const char *path);\n"
31393 "\n"
31394 msgstr ""
31395
31396 #. type: textblock
31397 #: ../src/guestfs-actions.pod:7222
31398 msgid ""
31399 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
31400 "error.  I<The caller must call C<guestfs_free_statvfs> after use>."
31401 msgstr ""
31402
31403 #. type: =head2
31404 #: ../src/guestfs-actions.pod:7228
31405 msgid "guestfs_strings"
31406 msgstr ""
31407
31408 #. type: verbatim
31409 #: ../src/guestfs-actions.pod:7230
31410 #, no-wrap
31411 msgid ""
31412 " char **\n"
31413 " guestfs_strings (guestfs_h *g,\n"
31414 "                  const char *path);\n"
31415 "\n"
31416 msgstr ""
31417
31418 #. type: =head2
31419 #: ../src/guestfs-actions.pod:7246
31420 msgid "guestfs_strings_e"
31421 msgstr ""
31422
31423 #. type: verbatim
31424 #: ../src/guestfs-actions.pod:7248
31425 #, no-wrap
31426 msgid ""
31427 " char **\n"
31428 " guestfs_strings_e (guestfs_h *g,\n"
31429 "                    const char *encoding,\n"
31430 "                    const char *path);\n"
31431 "\n"
31432 msgstr ""
31433
31434 #. type: textblock
31435 #: ../src/guestfs-actions.pod:7253
31436 msgid ""
31437 "This is like the C<guestfs_strings> command, but allows you to specify the "
31438 "encoding of strings that are looked for in the source file C<path>."
31439 msgstr ""
31440
31441 #. type: textblock
31442 #: ../src/guestfs-actions.pod:7263
31443 msgid ""
31444 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
31445 "ISO-8859-X (this is what C<guestfs_strings> uses)."
31446 msgstr ""
31447
31448 #. type: =head2
31449 #: ../src/guestfs-actions.pod:7301
31450 msgid "guestfs_swapoff_device"
31451 msgstr ""
31452
31453 #. type: verbatim
31454 #: ../src/guestfs-actions.pod:7303
31455 #, no-wrap
31456 msgid ""
31457 " int\n"
31458 " guestfs_swapoff_device (guestfs_h *g,\n"
31459 "                         const char *device);\n"
31460 "\n"
31461 msgstr ""
31462
31463 #. type: textblock
31464 #: ../src/guestfs-actions.pod:7307
31465 msgid ""
31466 "This command disables the libguestfs appliance swap device or partition "
31467 "named C<device>.  See C<guestfs_swapon_device>."
31468 msgstr ""
31469
31470 #. type: =head2
31471 #: ../src/guestfs-actions.pod:7315
31472 msgid "guestfs_swapoff_file"
31473 msgstr ""
31474
31475 #. type: verbatim
31476 #: ../src/guestfs-actions.pod:7317
31477 #, no-wrap
31478 msgid ""
31479 " int\n"
31480 " guestfs_swapoff_file (guestfs_h *g,\n"
31481 "                       const char *file);\n"
31482 "\n"
31483 msgstr ""
31484
31485 #. type: =head2
31486 #: ../src/guestfs-actions.pod:7327
31487 msgid "guestfs_swapoff_label"
31488 msgstr ""
31489
31490 #. type: verbatim
31491 #: ../src/guestfs-actions.pod:7329
31492 #, no-wrap
31493 msgid ""
31494 " int\n"
31495 " guestfs_swapoff_label (guestfs_h *g,\n"
31496 "                        const char *label);\n"
31497 "\n"
31498 msgstr ""
31499
31500 #. type: =head2
31501 #: ../src/guestfs-actions.pod:7340
31502 msgid "guestfs_swapoff_uuid"
31503 msgstr ""
31504
31505 #. type: verbatim
31506 #: ../src/guestfs-actions.pod:7342
31507 #, no-wrap
31508 msgid ""
31509 " int\n"
31510 " guestfs_swapoff_uuid (guestfs_h *g,\n"
31511 "                       const char *uuid);\n"
31512 "\n"
31513 msgstr ""
31514
31515 #. type: =head2
31516 #: ../src/guestfs-actions.pod:7353
31517 msgid "guestfs_swapon_device"
31518 msgstr ""
31519
31520 #. type: verbatim
31521 #: ../src/guestfs-actions.pod:7355
31522 #, no-wrap
31523 msgid ""
31524 " int\n"
31525 " guestfs_swapon_device (guestfs_h *g,\n"
31526 "                        const char *device);\n"
31527 "\n"
31528 msgstr ""
31529
31530 #. type: textblock
31531 #: ../src/guestfs-actions.pod:7359
31532 msgid ""
31533 "This command enables the libguestfs appliance to use the swap device or "
31534 "partition named C<device>.  The increased memory is made available for all "
31535 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
31536 msgstr ""
31537
31538 #. type: =head2
31539 #: ../src/guestfs-actions.pod:7375
31540 msgid "guestfs_swapon_file"
31541 msgstr ""
31542
31543 #. type: verbatim
31544 #: ../src/guestfs-actions.pod:7377
31545 #, no-wrap
31546 msgid ""
31547 " int\n"
31548 " guestfs_swapon_file (guestfs_h *g,\n"
31549 "                      const char *file);\n"
31550 "\n"
31551 msgstr ""
31552
31553 #. type: textblock
31554 #: ../src/guestfs-actions.pod:7381
31555 msgid ""
31556 "This command enables swap to a file.  See C<guestfs_swapon_device> for other "
31557 "notes."
31558 msgstr ""
31559
31560 #. type: =head2
31561 #: ../src/guestfs-actions.pod:7388
31562 msgid "guestfs_swapon_label"
31563 msgstr ""
31564
31565 #. type: verbatim
31566 #: ../src/guestfs-actions.pod:7390
31567 #, no-wrap
31568 msgid ""
31569 " int\n"
31570 " guestfs_swapon_label (guestfs_h *g,\n"
31571 "                       const char *label);\n"
31572 "\n"
31573 msgstr ""
31574
31575 #. type: textblock
31576 #: ../src/guestfs-actions.pod:7394
31577 msgid ""
31578 "This command enables swap to a labeled swap partition.  See "
31579 "C<guestfs_swapon_device> for other notes."
31580 msgstr ""
31581
31582 #. type: =head2
31583 #: ../src/guestfs-actions.pod:7401
31584 msgid "guestfs_swapon_uuid"
31585 msgstr ""
31586
31587 #. type: verbatim
31588 #: ../src/guestfs-actions.pod:7403
31589 #, no-wrap
31590 msgid ""
31591 " int\n"
31592 " guestfs_swapon_uuid (guestfs_h *g,\n"
31593 "                      const char *uuid);\n"
31594 "\n"
31595 msgstr ""
31596
31597 #. type: textblock
31598 #: ../src/guestfs-actions.pod:7407
31599 msgid ""
31600 "This command enables swap to a swap partition with the given UUID.  See "
31601 "C<guestfs_swapon_device> for other notes."
31602 msgstr ""
31603
31604 #. type: =head2
31605 #: ../src/guestfs-actions.pod:7414
31606 msgid "guestfs_sync"
31607 msgstr ""
31608
31609 #. type: verbatim
31610 #: ../src/guestfs-actions.pod:7416
31611 #, no-wrap
31612 msgid ""
31613 " int\n"
31614 " guestfs_sync (guestfs_h *g);\n"
31615 "\n"
31616 msgstr ""
31617
31618 #. type: =head2
31619 #: ../src/guestfs-actions.pod:7429
31620 msgid "guestfs_tail"
31621 msgstr ""
31622
31623 #. type: verbatim
31624 #: ../src/guestfs-actions.pod:7431
31625 #, no-wrap
31626 msgid ""
31627 " char **\n"
31628 " guestfs_tail (guestfs_h *g,\n"
31629 "               const char *path);\n"
31630 "\n"
31631 msgstr ""
31632
31633 #. type: =head2
31634 #: ../src/guestfs-actions.pod:7447
31635 msgid "guestfs_tail_n"
31636 msgstr ""
31637
31638 #. type: verbatim
31639 #: ../src/guestfs-actions.pod:7449
31640 #, no-wrap
31641 msgid ""
31642 " char **\n"
31643 " guestfs_tail_n (guestfs_h *g,\n"
31644 "                 int nrlines,\n"
31645 "                 const char *path);\n"
31646 "\n"
31647 msgstr ""
31648
31649 #. type: =head2
31650 #: ../src/guestfs-actions.pod:7471
31651 msgid "guestfs_tar_in"
31652 msgstr ""
31653
31654 #. type: verbatim
31655 #: ../src/guestfs-actions.pod:7473
31656 #, no-wrap
31657 msgid ""
31658 " int\n"
31659 " guestfs_tar_in (guestfs_h *g,\n"
31660 "                 const char *tarfile,\n"
31661 "                 const char *directory);\n"
31662 "\n"
31663 msgstr ""
31664
31665 #. type: textblock
31666 #: ../src/guestfs-actions.pod:7481
31667 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
31668 msgstr ""
31669
31670 #. type: textblock
31671 #: ../src/guestfs-actions.pod:7486 ../src/guestfs-actions.pod:7503 ../src/guestfs-actions.pod:7519 ../src/guestfs-actions.pod:7535
31672 msgid "(Added in 1.0.3)"
31673 msgstr ""
31674
31675 #. type: =head2
31676 #: ../src/guestfs-actions.pod:7488
31677 msgid "guestfs_tar_out"
31678 msgstr ""
31679
31680 #. type: verbatim
31681 #: ../src/guestfs-actions.pod:7490
31682 #, no-wrap
31683 msgid ""
31684 " int\n"
31685 " guestfs_tar_out (guestfs_h *g,\n"
31686 "                  const char *directory,\n"
31687 "                  const char *tarfile);\n"
31688 "\n"
31689 msgstr ""
31690
31691 #. type: textblock
31692 #: ../src/guestfs-actions.pod:7498
31693 msgid ""
31694 "To download a compressed tarball, use C<guestfs_tgz_out> or "
31695 "C<guestfs_txz_out>."
31696 msgstr ""
31697
31698 #. type: =head2
31699 #: ../src/guestfs-actions.pod:7505
31700 msgid "guestfs_tgz_in"
31701 msgstr ""
31702
31703 #. type: verbatim
31704 #: ../src/guestfs-actions.pod:7507
31705 #, no-wrap
31706 msgid ""
31707 " int\n"
31708 " guestfs_tgz_in (guestfs_h *g,\n"
31709 "                 const char *tarball,\n"
31710 "                 const char *directory);\n"
31711 "\n"
31712 msgstr ""
31713
31714 #. type: textblock
31715 #: ../src/guestfs-actions.pod:7515
31716 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
31717 msgstr ""
31718
31719 #. type: =head2
31720 #: ../src/guestfs-actions.pod:7521
31721 msgid "guestfs_tgz_out"
31722 msgstr ""
31723
31724 #. type: verbatim
31725 #: ../src/guestfs-actions.pod:7523
31726 #, no-wrap
31727 msgid ""
31728 " int\n"
31729 " guestfs_tgz_out (guestfs_h *g,\n"
31730 "                  const char *directory,\n"
31731 "                  const char *tarball);\n"
31732 "\n"
31733 msgstr ""
31734
31735 #. type: textblock
31736 #: ../src/guestfs-actions.pod:7531
31737 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
31738 msgstr ""
31739
31740 #. type: =head2
31741 #: ../src/guestfs-actions.pod:7537
31742 msgid "guestfs_touch"
31743 msgstr ""
31744
31745 #. type: verbatim
31746 #: ../src/guestfs-actions.pod:7539
31747 #, no-wrap
31748 msgid ""
31749 " int\n"
31750 " guestfs_touch (guestfs_h *g,\n"
31751 "                const char *path);\n"
31752 "\n"
31753 msgstr ""
31754
31755 #. type: =head2
31756 #: ../src/guestfs-actions.pod:7554
31757 msgid "guestfs_truncate"
31758 msgstr ""
31759
31760 #. type: verbatim
31761 #: ../src/guestfs-actions.pod:7556
31762 #, no-wrap
31763 msgid ""
31764 " int\n"
31765 " guestfs_truncate (guestfs_h *g,\n"
31766 "                   const char *path);\n"
31767 "\n"
31768 msgstr ""
31769
31770 #. type: =head2
31771 #: ../src/guestfs-actions.pod:7567
31772 msgid "guestfs_truncate_size"
31773 msgstr ""
31774
31775 #. type: verbatim
31776 #: ../src/guestfs-actions.pod:7569
31777 #, no-wrap
31778 msgid ""
31779 " int\n"
31780 " guestfs_truncate_size (guestfs_h *g,\n"
31781 "                        const char *path,\n"
31782 "                        int64_t size);\n"
31783 "\n"
31784 msgstr ""
31785
31786 #. type: textblock
31787 #: ../src/guestfs-actions.pod:7577
31788 msgid ""
31789 "If the current file size is less than C<size> then the file is extended to "
31790 "the required size with zero bytes.  This creates a sparse file (ie. disk "
31791 "blocks are not allocated for the file until you write to it).  To create a "
31792 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
31793 msgstr ""
31794
31795 #. type: =head2
31796 #: ../src/guestfs-actions.pod:7587
31797 msgid "guestfs_tune2fs_l"
31798 msgstr ""
31799
31800 #. type: verbatim
31801 #: ../src/guestfs-actions.pod:7589
31802 #, no-wrap
31803 msgid ""
31804 " char **\n"
31805 " guestfs_tune2fs_l (guestfs_h *g,\n"
31806 "                    const char *device);\n"
31807 "\n"
31808 msgstr ""
31809
31810 #. type: =head2
31811 #: ../src/guestfs-actions.pod:7609
31812 msgid "guestfs_txz_in"
31813 msgstr ""
31814
31815 #. type: verbatim
31816 #: ../src/guestfs-actions.pod:7611
31817 #, no-wrap
31818 msgid ""
31819 " int\n"
31820 " guestfs_txz_in (guestfs_h *g,\n"
31821 "                 const char *tarball,\n"
31822 "                 const char *directory);\n"
31823 "\n"
31824 msgstr ""
31825
31826 #. type: =head2
31827 #: ../src/guestfs-actions.pod:7623
31828 msgid "guestfs_txz_out"
31829 msgstr ""
31830
31831 #. type: verbatim
31832 #: ../src/guestfs-actions.pod:7625
31833 #, no-wrap
31834 msgid ""
31835 " int\n"
31836 " guestfs_txz_out (guestfs_h *g,\n"
31837 "                  const char *directory,\n"
31838 "                  const char *tarball);\n"
31839 "\n"
31840 msgstr ""
31841
31842 #. type: =head2
31843 #: ../src/guestfs-actions.pod:7637
31844 msgid "guestfs_umask"
31845 msgstr ""
31846
31847 #. type: verbatim
31848 #: ../src/guestfs-actions.pod:7639
31849 #, no-wrap
31850 msgid ""
31851 " int\n"
31852 " guestfs_umask (guestfs_h *g,\n"
31853 "                int mask);\n"
31854 "\n"
31855 msgstr ""
31856
31857 #. type: textblock
31858 #: ../src/guestfs-actions.pod:7655
31859 msgid ""
31860 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
31861 "C<guestfs_mkdir>."
31862 msgstr ""
31863
31864 #. type: =head2
31865 #: ../src/guestfs-actions.pod:7664
31866 msgid "guestfs_umount"
31867 msgstr ""
31868
31869 #. type: verbatim
31870 #: ../src/guestfs-actions.pod:7666
31871 #, no-wrap
31872 msgid ""
31873 " int\n"
31874 " guestfs_umount (guestfs_h *g,\n"
31875 "                 const char *pathordevice);\n"
31876 "\n"
31877 msgstr ""
31878
31879 #. type: =head2
31880 #: ../src/guestfs-actions.pod:7678
31881 msgid "guestfs_umount_all"
31882 msgstr ""
31883
31884 #. type: verbatim
31885 #: ../src/guestfs-actions.pod:7680
31886 #, no-wrap
31887 msgid ""
31888 " int\n"
31889 " guestfs_umount_all (guestfs_h *g);\n"
31890 "\n"
31891 msgstr ""
31892
31893 #. type: =head2
31894 #: ../src/guestfs-actions.pod:7691
31895 msgid "guestfs_upload"
31896 msgstr ""
31897
31898 #. type: verbatim
31899 #: ../src/guestfs-actions.pod:7693
31900 #, no-wrap
31901 msgid ""
31902 " int\n"
31903 " guestfs_upload (guestfs_h *g,\n"
31904 "                 const char *filename,\n"
31905 "                 const char *remotefilename);\n"
31906 "\n"
31907 msgstr ""
31908
31909 #. type: textblock
31910 #: ../src/guestfs-actions.pod:7703
31911 msgid "See also C<guestfs_download>."
31912 msgstr ""
31913
31914 #. type: =head2
31915 #: ../src/guestfs-actions.pod:7714
31916 msgid "guestfs_upload_offset"
31917 msgstr ""
31918
31919 #. type: verbatim
31920 #: ../src/guestfs-actions.pod:7716
31921 #, no-wrap
31922 msgid ""
31923 " int\n"
31924 " guestfs_upload_offset (guestfs_h *g,\n"
31925 "                        const char *filename,\n"
31926 "                        const char *remotefilename,\n"
31927 "                        int64_t offset);\n"
31928 "\n"
31929 msgstr ""
31930
31931 #. type: textblock
31932 #: ../src/guestfs-actions.pod:7732
31933 msgid ""
31934 "Note that there is no limit on the amount of data that can be uploaded with "
31935 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
31936 "full amount unless an error occurs."
31937 msgstr ""
31938
31939 #. type: textblock
31940 #: ../src/guestfs-actions.pod:7737
31941 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
31942 msgstr ""
31943
31944 #. type: =head2
31945 #: ../src/guestfs-actions.pod:7748
31946 msgid "guestfs_utimens"
31947 msgstr ""
31948
31949 #. type: verbatim
31950 #: ../src/guestfs-actions.pod:7750
31951 #, no-wrap
31952 msgid ""
31953 " int\n"
31954 " guestfs_utimens (guestfs_h *g,\n"
31955 "                  const char *path,\n"
31956 "                  int64_t atsecs,\n"
31957 "                  int64_t atnsecs,\n"
31958 "                  int64_t mtsecs,\n"
31959 "                  int64_t mtnsecs);\n"
31960 "\n"
31961 msgstr ""
31962
31963 #. type: =head2
31964 #: ../src/guestfs-actions.pod:7779 ../src/guestfs-structs.pod:175
31965 msgid "guestfs_version"
31966 msgstr ""
31967
31968 #. type: verbatim
31969 #: ../src/guestfs-actions.pod:7781
31970 #, no-wrap
31971 msgid ""
31972 " struct guestfs_version *\n"
31973 " guestfs_version (guestfs_h *g);\n"
31974 "\n"
31975 msgstr ""
31976
31977 #. type: textblock
31978 #: ../src/guestfs-actions.pod:7809
31979 msgid ""
31980 "I<Note:> Don't use this call to test for availability of features.  In "
31981 "enterprise distributions we backport features from later versions into "
31982 "earlier versions, making this an unreliable way to test for features.  Use "
31983 "C<guestfs_available> instead."
31984 msgstr ""
31985
31986 #. type: textblock
31987 #: ../src/guestfs-actions.pod:7815
31988 msgid ""
31989 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
31990 "error.  I<The caller must call C<guestfs_free_version> after use>."
31991 msgstr ""
31992
31993 #. type: textblock
31994 #: ../src/guestfs-actions.pod:7819
31995 msgid "(Added in 1.0.58)"
31996 msgstr ""
31997
31998 #. type: =head2
31999 #: ../src/guestfs-actions.pod:7821
32000 msgid "guestfs_vfs_label"
32001 msgstr ""
32002
32003 #. type: verbatim
32004 #: ../src/guestfs-actions.pod:7823
32005 #, no-wrap
32006 msgid ""
32007 " char *\n"
32008 " guestfs_vfs_label (guestfs_h *g,\n"
32009 "                    const char *device);\n"
32010 "\n"
32011 msgstr ""
32012
32013 #. type: textblock
32014 #: ../src/guestfs-actions.pod:7832
32015 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
32016 msgstr ""
32017
32018 #. type: textblock
32019 #: ../src/guestfs-actions.pod:7837 ../src/guestfs-actions.pod:7874
32020 msgid "(Added in 1.3.18)"
32021 msgstr ""
32022
32023 #. type: =head2
32024 #: ../src/guestfs-actions.pod:7839
32025 msgid "guestfs_vfs_type"
32026 msgstr ""
32027
32028 #. type: verbatim
32029 #: ../src/guestfs-actions.pod:7841
32030 #, no-wrap
32031 msgid ""
32032 " char *\n"
32033 " guestfs_vfs_type (guestfs_h *g,\n"
32034 "                   const char *device);\n"
32035 "\n"
32036 msgstr ""
32037
32038 #. type: =head2
32039 #: ../src/guestfs-actions.pod:7858
32040 msgid "guestfs_vfs_uuid"
32041 msgstr ""
32042
32043 #. type: verbatim
32044 #: ../src/guestfs-actions.pod:7860
32045 #, no-wrap
32046 msgid ""
32047 " char *\n"
32048 " guestfs_vfs_uuid (guestfs_h *g,\n"
32049 "                   const char *device);\n"
32050 "\n"
32051 msgstr ""
32052
32053 #. type: textblock
32054 #: ../src/guestfs-actions.pod:7869
32055 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
32056 msgstr ""
32057
32058 #. type: =head2
32059 #: ../src/guestfs-actions.pod:7876
32060 msgid "guestfs_vg_activate"
32061 msgstr ""
32062
32063 #. type: verbatim
32064 #: ../src/guestfs-actions.pod:7878
32065 #, no-wrap
32066 msgid ""
32067 " int\n"
32068 " guestfs_vg_activate (guestfs_h *g,\n"
32069 "                      int activate,\n"
32070 "                      char *const *volgroups);\n"
32071 "\n"
32072 msgstr ""
32073
32074 #. type: =head2
32075 #: ../src/guestfs-actions.pod:7895
32076 msgid "guestfs_vg_activate_all"
32077 msgstr ""
32078
32079 #. type: verbatim
32080 #: ../src/guestfs-actions.pod:7897
32081 #, no-wrap
32082 msgid ""
32083 " int\n"
32084 " guestfs_vg_activate_all (guestfs_h *g,\n"
32085 "                          int activate);\n"
32086 "\n"
32087 msgstr ""
32088
32089 #. type: =head2
32090 #: ../src/guestfs-actions.pod:7910
32091 msgid "guestfs_vgcreate"
32092 msgstr ""
32093
32094 #. type: verbatim
32095 #: ../src/guestfs-actions.pod:7912
32096 #, no-wrap
32097 msgid ""
32098 " int\n"
32099 " guestfs_vgcreate (guestfs_h *g,\n"
32100 "                   const char *volgroup,\n"
32101 "                   char *const *physvols);\n"
32102 "\n"
32103 msgstr ""
32104
32105 #. type: =head2
32106 #: ../src/guestfs-actions.pod:7924
32107 msgid "guestfs_vglvuuids"
32108 msgstr ""
32109
32110 #. type: verbatim
32111 #: ../src/guestfs-actions.pod:7926
32112 #, no-wrap
32113 msgid ""
32114 " char **\n"
32115 " guestfs_vglvuuids (guestfs_h *g,\n"
32116 "                    const char *vgname);\n"
32117 "\n"
32118 msgstr ""
32119
32120 #. type: textblock
32121 #: ../src/guestfs-actions.pod:7933
32122 msgid ""
32123 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
32124 "associate logical volumes and volume groups."
32125 msgstr ""
32126
32127 #. type: textblock
32128 #: ../src/guestfs-actions.pod:7936
32129 msgid "See also C<guestfs_vgpvuuids>."
32130 msgstr ""
32131
32132 #. type: =head2
32133 #: ../src/guestfs-actions.pod:7944
32134 msgid "guestfs_vgpvuuids"
32135 msgstr ""
32136
32137 #. type: verbatim
32138 #: ../src/guestfs-actions.pod:7946
32139 #, no-wrap
32140 msgid ""
32141 " char **\n"
32142 " guestfs_vgpvuuids (guestfs_h *g,\n"
32143 "                    const char *vgname);\n"
32144 "\n"
32145 msgstr ""
32146
32147 #. type: textblock
32148 #: ../src/guestfs-actions.pod:7953
32149 msgid ""
32150 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
32151 "associate physical volumes and volume groups."
32152 msgstr ""
32153
32154 #. type: textblock
32155 #: ../src/guestfs-actions.pod:7956
32156 msgid "See also C<guestfs_vglvuuids>."
32157 msgstr ""
32158
32159 #. type: =head2
32160 #: ../src/guestfs-actions.pod:7964
32161 msgid "guestfs_vgremove"
32162 msgstr ""
32163
32164 #. type: verbatim
32165 #: ../src/guestfs-actions.pod:7966
32166 #, no-wrap
32167 msgid ""
32168 " int\n"
32169 " guestfs_vgremove (guestfs_h *g,\n"
32170 "                   const char *vgname);\n"
32171 "\n"
32172 msgstr ""
32173
32174 #. type: =head2
32175 #: ../src/guestfs-actions.pod:7979
32176 msgid "guestfs_vgrename"
32177 msgstr ""
32178
32179 #. type: verbatim
32180 #: ../src/guestfs-actions.pod:7981
32181 #, no-wrap
32182 msgid ""
32183 " int\n"
32184 " guestfs_vgrename (guestfs_h *g,\n"
32185 "                   const char *volgroup,\n"
32186 "                   const char *newvolgroup);\n"
32187 "\n"
32188 msgstr ""
32189
32190 #. type: =head2
32191 #: ../src/guestfs-actions.pod:7992
32192 msgid "guestfs_vgs"
32193 msgstr ""
32194
32195 #. type: verbatim
32196 #: ../src/guestfs-actions.pod:7994
32197 #, no-wrap
32198 msgid ""
32199 " char **\n"
32200 " guestfs_vgs (guestfs_h *g);\n"
32201 "\n"
32202 msgstr ""
32203
32204 #. type: textblock
32205 #: ../src/guestfs-actions.pod:8003
32206 msgid "See also C<guestfs_vgs_full>."
32207 msgstr ""
32208
32209 #. type: =head2
32210 #: ../src/guestfs-actions.pod:8011
32211 msgid "guestfs_vgs_full"
32212 msgstr ""
32213
32214 #. type: verbatim
32215 #: ../src/guestfs-actions.pod:8013
32216 #, no-wrap
32217 msgid ""
32218 " struct guestfs_lvm_vg_list *\n"
32219 " guestfs_vgs_full (guestfs_h *g);\n"
32220 "\n"
32221 msgstr ""
32222
32223 #. type: textblock
32224 #: ../src/guestfs-actions.pod:8019
32225 msgid ""
32226 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
32227 "was an error.  I<The caller must call C<guestfs_free_lvm_vg_list> after "
32228 "use>."
32229 msgstr ""
32230
32231 #. type: =head2
32232 #: ../src/guestfs-actions.pod:8025
32233 msgid "guestfs_vgscan"
32234 msgstr ""
32235
32236 #. type: verbatim
32237 #: ../src/guestfs-actions.pod:8027
32238 #, no-wrap
32239 msgid ""
32240 " int\n"
32241 " guestfs_vgscan (guestfs_h *g);\n"
32242 "\n"
32243 msgstr ""
32244
32245 #. type: =head2
32246 #: ../src/guestfs-actions.pod:8037
32247 msgid "guestfs_vguuid"
32248 msgstr ""
32249
32250 #. type: verbatim
32251 #: ../src/guestfs-actions.pod:8039
32252 #, no-wrap
32253 msgid ""
32254 " char *\n"
32255 " guestfs_vguuid (guestfs_h *g,\n"
32256 "                 const char *vgname);\n"
32257 "\n"
32258 msgstr ""
32259
32260 #. type: =head2
32261 #: ../src/guestfs-actions.pod:8050
32262 msgid "guestfs_wait_ready"
32263 msgstr ""
32264
32265 #. type: verbatim
32266 #: ../src/guestfs-actions.pod:8052
32267 #, no-wrap
32268 msgid ""
32269 " int\n"
32270 " guestfs_wait_ready (guestfs_h *g);\n"
32271 "\n"
32272 msgstr ""
32273
32274 #. type: textblock
32275 #: ../src/guestfs-actions.pod:8055
32276 msgid ""
32277 "I<This function is deprecated.> In new code, use the L</guestfs_launch> call "
32278 "instead."
32279 msgstr ""
32280
32281 #. type: textblock
32282 #: ../src/guestfs-actions.pod:8062
32283 msgid "This function is a no op."
32284 msgstr ""
32285
32286 #. type: textblock
32287 #: ../src/guestfs-actions.pod:8064
32288 msgid ""
32289 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
32290 "calling C<guestfs_launch> to wait for the launch to complete.  However this "
32291 "is no longer necessary because C<guestfs_launch> now does the waiting."
32292 msgstr ""
32293
32294 #. type: textblock
32295 #: ../src/guestfs-actions.pod:8069
32296 msgid ""
32297 "If you see any calls to this function in code then you can just remove them, "
32298 "unless you want to retain compatibility with older versions of the API."
32299 msgstr ""
32300
32301 #. type: =head2
32302 #: ../src/guestfs-actions.pod:8077
32303 msgid "guestfs_wc_c"
32304 msgstr ""
32305
32306 #. type: verbatim
32307 #: ../src/guestfs-actions.pod:8079
32308 #, no-wrap
32309 msgid ""
32310 " int\n"
32311 " guestfs_wc_c (guestfs_h *g,\n"
32312 "               const char *path);\n"
32313 "\n"
32314 msgstr ""
32315
32316 #. type: =head2
32317 #: ../src/guestfs-actions.pod:8090
32318 msgid "guestfs_wc_l"
32319 msgstr ""
32320
32321 #. type: verbatim
32322 #: ../src/guestfs-actions.pod:8092
32323 #, no-wrap
32324 msgid ""
32325 " int\n"
32326 " guestfs_wc_l (guestfs_h *g,\n"
32327 "               const char *path);\n"
32328 "\n"
32329 msgstr ""
32330
32331 #. type: =head2
32332 #: ../src/guestfs-actions.pod:8103
32333 msgid "guestfs_wc_w"
32334 msgstr ""
32335
32336 #. type: verbatim
32337 #: ../src/guestfs-actions.pod:8105
32338 #, no-wrap
32339 msgid ""
32340 " int\n"
32341 " guestfs_wc_w (guestfs_h *g,\n"
32342 "               const char *path);\n"
32343 "\n"
32344 msgstr ""
32345
32346 #. type: =head2
32347 #: ../src/guestfs-actions.pod:8116
32348 msgid "guestfs_write"
32349 msgstr ""
32350
32351 #. type: verbatim
32352 #: ../src/guestfs-actions.pod:8118
32353 #, no-wrap
32354 msgid ""
32355 " int\n"
32356 " guestfs_write (guestfs_h *g,\n"
32357 "                const char *path,\n"
32358 "                const char *content,\n"
32359 "                size_t content_size);\n"
32360 "\n"
32361 msgstr ""
32362
32363 #. type: textblock
32364 #: ../src/guestfs-actions.pod:8127
32365 msgid "See also C<guestfs_write_append>."
32366 msgstr ""
32367
32368 #. type: =head2
32369 #: ../src/guestfs-actions.pod:8136
32370 msgid "guestfs_write_append"
32371 msgstr ""
32372
32373 #. type: verbatim
32374 #: ../src/guestfs-actions.pod:8138
32375 #, no-wrap
32376 msgid ""
32377 " int\n"
32378 " guestfs_write_append (guestfs_h *g,\n"
32379 "                       const char *path,\n"
32380 "                       const char *content,\n"
32381 "                       size_t content_size);\n"
32382 "\n"
32383 msgstr ""
32384
32385 #. type: textblock
32386 #: ../src/guestfs-actions.pod:8147
32387 msgid "See also C<guestfs_write>."
32388 msgstr ""
32389
32390 #. type: =head2
32391 #: ../src/guestfs-actions.pod:8156
32392 msgid "guestfs_write_file"
32393 msgstr ""
32394
32395 #. type: verbatim
32396 #: ../src/guestfs-actions.pod:8158
32397 #, no-wrap
32398 msgid ""
32399 " int\n"
32400 " guestfs_write_file (guestfs_h *g,\n"
32401 "                     const char *path,\n"
32402 "                     const char *content,\n"
32403 "                     int size);\n"
32404 "\n"
32405 msgstr ""
32406
32407 #. type: textblock
32408 #: ../src/guestfs-actions.pod:8164
32409 msgid ""
32410 "I<This function is deprecated.> In new code, use the L</guestfs_write> call "
32411 "instead."
32412 msgstr ""
32413
32414 #. type: =head2
32415 #: ../src/guestfs-actions.pod:8189
32416 msgid "guestfs_zegrep"
32417 msgstr ""
32418
32419 #. type: verbatim
32420 #: ../src/guestfs-actions.pod:8191
32421 #, no-wrap
32422 msgid ""
32423 " char **\n"
32424 " guestfs_zegrep (guestfs_h *g,\n"
32425 "                 const char *regex,\n"
32426 "                 const char *path);\n"
32427 "\n"
32428 msgstr ""
32429
32430 #. type: =head2
32431 #: ../src/guestfs-actions.pod:8208
32432 msgid "guestfs_zegrepi"
32433 msgstr ""
32434
32435 #. type: verbatim
32436 #: ../src/guestfs-actions.pod:8210
32437 #, no-wrap
32438 msgid ""
32439 " char **\n"
32440 " guestfs_zegrepi (guestfs_h *g,\n"
32441 "                  const char *regex,\n"
32442 "                  const char *path);\n"
32443 "\n"
32444 msgstr ""
32445
32446 #. type: =head2
32447 #: ../src/guestfs-actions.pod:8227
32448 msgid "guestfs_zero"
32449 msgstr ""
32450
32451 #. type: verbatim
32452 #: ../src/guestfs-actions.pod:8229
32453 #, no-wrap
32454 msgid ""
32455 " int\n"
32456 " guestfs_zero (guestfs_h *g,\n"
32457 "               const char *device);\n"
32458 "\n"
32459 msgstr ""
32460
32461 #. type: textblock
32462 #: ../src/guestfs-actions.pod:8243
32463 msgid ""
32464 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
32465 "C<guestfs_is_zero_device>"
32466 msgstr ""
32467
32468 #. type: =head2
32469 #: ../src/guestfs-actions.pod:8255
32470 msgid "guestfs_zero_device"
32471 msgstr ""
32472
32473 #. type: verbatim
32474 #: ../src/guestfs-actions.pod:8257
32475 #, no-wrap
32476 msgid ""
32477 " int\n"
32478 " guestfs_zero_device (guestfs_h *g,\n"
32479 "                      const char *device);\n"
32480 "\n"
32481 msgstr ""
32482
32483 #. type: textblock
32484 #: ../src/guestfs-actions.pod:8261
32485 msgid ""
32486 "This command writes zeroes over the entire C<device>.  Compare with "
32487 "C<guestfs_zero> which just zeroes the first few blocks of a device."
32488 msgstr ""
32489
32490 #. type: textblock
32491 #: ../src/guestfs-actions.pod:8276
32492 msgid "(Added in 1.3.1)"
32493 msgstr ""
32494
32495 #. type: =head2
32496 #: ../src/guestfs-actions.pod:8278
32497 msgid "guestfs_zerofree"
32498 msgstr ""
32499
32500 #. type: verbatim
32501 #: ../src/guestfs-actions.pod:8280
32502 #, no-wrap
32503 msgid ""
32504 " int\n"
32505 " guestfs_zerofree (guestfs_h *g,\n"
32506 "                   const char *device);\n"
32507 "\n"
32508 msgstr ""
32509
32510 #. type: =head2
32511 #: ../src/guestfs-actions.pod:8299
32512 msgid "guestfs_zfgrep"
32513 msgstr ""
32514
32515 #. type: verbatim
32516 #: ../src/guestfs-actions.pod:8301
32517 #, no-wrap
32518 msgid ""
32519 " char **\n"
32520 " guestfs_zfgrep (guestfs_h *g,\n"
32521 "                 const char *pattern,\n"
32522 "                 const char *path);\n"
32523 "\n"
32524 msgstr ""
32525
32526 #. type: =head2
32527 #: ../src/guestfs-actions.pod:8318
32528 msgid "guestfs_zfgrepi"
32529 msgstr ""
32530
32531 #. type: verbatim
32532 #: ../src/guestfs-actions.pod:8320
32533 #, no-wrap
32534 msgid ""
32535 " char **\n"
32536 " guestfs_zfgrepi (guestfs_h *g,\n"
32537 "                  const char *pattern,\n"
32538 "                  const char *path);\n"
32539 "\n"
32540 msgstr ""
32541
32542 #. type: =head2
32543 #: ../src/guestfs-actions.pod:8337
32544 msgid "guestfs_zfile"
32545 msgstr ""
32546
32547 #. type: verbatim
32548 #: ../src/guestfs-actions.pod:8339
32549 #, no-wrap
32550 msgid ""
32551 " char *\n"
32552 " guestfs_zfile (guestfs_h *g,\n"
32553 "                const char *meth,\n"
32554 "                const char *path);\n"
32555 "\n"
32556 msgstr ""
32557
32558 #. type: textblock
32559 #: ../src/guestfs-actions.pod:8344
32560 msgid ""
32561 "I<This function is deprecated.> In new code, use the L</guestfs_file> call "
32562 "instead."
32563 msgstr ""
32564
32565 #. type: textblock
32566 #: ../src/guestfs-actions.pod:8356
32567 msgid ""
32568 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
32569 "files."
32570 msgstr ""
32571
32572 #. type: =head2
32573 #: ../src/guestfs-actions.pod:8364
32574 msgid "guestfs_zgrep"
32575 msgstr ""
32576
32577 #. type: verbatim
32578 #: ../src/guestfs-actions.pod:8366
32579 #, no-wrap
32580 msgid ""
32581 " char **\n"
32582 " guestfs_zgrep (guestfs_h *g,\n"
32583 "                const char *regex,\n"
32584 "                const char *path);\n"
32585 "\n"
32586 msgstr ""
32587
32588 #. type: =head2
32589 #: ../src/guestfs-actions.pod:8383
32590 msgid "guestfs_zgrepi"
32591 msgstr ""
32592
32593 #. type: verbatim
32594 #: ../src/guestfs-actions.pod:8385
32595 #, no-wrap
32596 msgid ""
32597 " char **\n"
32598 " guestfs_zgrepi (guestfs_h *g,\n"
32599 "                 const char *regex,\n"
32600 "                 const char *path);\n"
32601 "\n"
32602 msgstr ""
32603
32604 #. type: =item
32605 #: ../src/guestfs-availability.pod:3
32606 msgid "B<augeas>"
32607 msgstr ""
32608
32609 #. type: textblock
32610 #: ../src/guestfs-availability.pod:5
32611 msgid ""
32612 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
32613 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
32614 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
32615 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
32616 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
32617 msgstr ""
32618
32619 #. type: =item
32620 #: ../src/guestfs-availability.pod:21
32621 msgid "B<btrfs>"
32622 msgstr ""
32623
32624 #. type: textblock
32625 #: ../src/guestfs-availability.pod:23
32626 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
32627 msgstr ""
32628
32629 #. type: =item
32630 #: ../src/guestfs-availability.pod:26
32631 msgid "B<grub>"
32632 msgstr ""
32633
32634 #. type: textblock
32635 #: ../src/guestfs-availability.pod:28
32636 msgid "The following functions: L</guestfs_grub_install>"
32637 msgstr ""
32638
32639 #. type: =item
32640 #: ../src/guestfs-availability.pod:31
32641 msgid "B<inotify>"
32642 msgstr ""
32643
32644 #. type: textblock
32645 #: ../src/guestfs-availability.pod:33
32646 msgid ""
32647 "The following functions: L</guestfs_inotify_add_watch> "
32648 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
32649 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
32650 msgstr ""
32651
32652 #. type: =item
32653 #: ../src/guestfs-availability.pod:41
32654 msgid "B<linuxfsuuid>"
32655 msgstr ""
32656
32657 #. type: textblock
32658 #: ../src/guestfs-availability.pod:43
32659 msgid ""
32660 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
32661 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
32662 msgstr ""
32663
32664 #. type: =item
32665 #: ../src/guestfs-availability.pod:50
32666 msgid "B<linuxmodules>"
32667 msgstr ""
32668
32669 #. type: textblock
32670 #: ../src/guestfs-availability.pod:52
32671 msgid "The following functions: L</guestfs_modprobe>"
32672 msgstr ""
32673
32674 #. type: =item
32675 #: ../src/guestfs-availability.pod:55
32676 msgid "B<linuxxattrs>"
32677 msgstr ""
32678
32679 #. type: textblock
32680 #: ../src/guestfs-availability.pod:57
32681 msgid ""
32682 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
32683 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
32684 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
32685 "L</guestfs_setxattr>"
32686 msgstr ""
32687
32688 #. type: =item
32689 #: ../src/guestfs-availability.pod:68
32690 msgid "B<luks>"
32691 msgstr ""
32692
32693 #. type: textblock
32694 #: ../src/guestfs-availability.pod:70
32695 msgid ""
32696 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
32697 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
32698 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
32699 msgstr ""
32700
32701 #. type: =item
32702 #: ../src/guestfs-availability.pod:79
32703 msgid "B<lvm2>"
32704 msgstr ""
32705
32706 #. type: textblock
32707 #: ../src/guestfs-availability.pod:81
32708 msgid ""
32709 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
32710 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
32711 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
32712 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
32713 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
32714 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
32715 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
32716 "L</guestfs_vgs_full>"
32717 msgstr ""
32718
32719 #. type: =item
32720 #: ../src/guestfs-availability.pod:104
32721 msgid "B<mknod>"
32722 msgstr ""
32723
32724 #. type: textblock
32725 #: ../src/guestfs-availability.pod:106
32726 msgid ""
32727 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
32728 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
32729 msgstr ""
32730
32731 #. type: =item
32732 #: ../src/guestfs-availability.pod:112
32733 msgid "B<ntfs3g>"
32734 msgstr ""
32735
32736 #. type: textblock
32737 #: ../src/guestfs-availability.pod:114
32738 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
32739 msgstr ""
32740
32741 #. type: =item
32742 #: ../src/guestfs-availability.pod:117
32743 msgid "B<ntfsprogs>"
32744 msgstr ""
32745
32746 #. type: textblock
32747 #: ../src/guestfs-availability.pod:119
32748 msgid ""
32749 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
32750 "L</guestfs_ntfsresize_size>"
32751 msgstr ""
32752
32753 #. type: =item
32754 #: ../src/guestfs-availability.pod:124
32755 msgid "B<realpath>"
32756 msgstr ""
32757
32758 #. type: textblock
32759 #: ../src/guestfs-availability.pod:126
32760 msgid "The following functions: L</guestfs_realpath>"
32761 msgstr ""
32762
32763 #. type: =item
32764 #: ../src/guestfs-availability.pod:129
32765 msgid "B<scrub>"
32766 msgstr ""
32767
32768 #. type: textblock
32769 #: ../src/guestfs-availability.pod:131
32770 msgid ""
32771 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
32772 "L</guestfs_scrub_freespace>"
32773 msgstr ""
32774
32775 #. type: =item
32776 #: ../src/guestfs-availability.pod:136
32777 msgid "B<selinux>"
32778 msgstr ""
32779
32780 #. type: textblock
32781 #: ../src/guestfs-availability.pod:138
32782 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
32783 msgstr ""
32784
32785 #. type: =item
32786 #: ../src/guestfs-availability.pod:142
32787 msgid "B<xz>"
32788 msgstr ""
32789
32790 #. type: textblock
32791 #: ../src/guestfs-availability.pod:144
32792 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
32793 msgstr ""
32794
32795 #. type: =item
32796 #: ../src/guestfs-availability.pod:148
32797 msgid "B<zerofree>"
32798 msgstr ""
32799
32800 #. type: textblock
32801 #: ../src/guestfs-availability.pod:150
32802 msgid "The following functions: L</guestfs_zerofree>"
32803 msgstr ""
32804
32805 #. type: =head2
32806 #: ../src/guestfs-structs.pod:1
32807 msgid "guestfs_int_bool"
32808 msgstr ""
32809
32810 #. type: verbatim
32811 #: ../src/guestfs-structs.pod:3
32812 #, no-wrap
32813 msgid ""
32814 " struct guestfs_int_bool {\n"
32815 "   int32_t i;\n"
32816 "   int32_t b;\n"
32817 " };\n"
32818 " \n"
32819 msgstr ""
32820
32821 #. type: verbatim
32822 #: ../src/guestfs-structs.pod:8
32823 #, no-wrap
32824 msgid ""
32825 " struct guestfs_int_bool_list {\n"
32826 "   uint32_t len; /* Number of elements in list. */\n"
32827 "   struct guestfs_int_bool *val; /* Elements. */\n"
32828 " };\n"
32829 " \n"
32830 msgstr ""
32831
32832 #. type: verbatim
32833 #: ../src/guestfs-structs.pod:13
32834 #, no-wrap
32835 msgid ""
32836 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
32837 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
32838 "\n"
32839 msgstr ""
32840
32841 #. type: =head2
32842 #: ../src/guestfs-structs.pod:16
32843 msgid "guestfs_lvm_pv"
32844 msgstr ""
32845
32846 #. type: verbatim
32847 #: ../src/guestfs-structs.pod:18
32848 #, no-wrap
32849 msgid ""
32850 " struct guestfs_lvm_pv {\n"
32851 "   char *pv_name;\n"
32852 "   /* The next field is NOT nul-terminated, be careful when printing it: "
32853 "*/\n"
32854 "   char pv_uuid[32];\n"
32855 "   char *pv_fmt;\n"
32856 "   uint64_t pv_size;\n"
32857 "   uint64_t dev_size;\n"
32858 "   uint64_t pv_free;\n"
32859 "   uint64_t pv_used;\n"
32860 "   char *pv_attr;\n"
32861 "   int64_t pv_pe_count;\n"
32862 "   int64_t pv_pe_alloc_count;\n"
32863 "   char *pv_tags;\n"
32864 "   uint64_t pe_start;\n"
32865 "   int64_t pv_mda_count;\n"
32866 "   uint64_t pv_mda_free;\n"
32867 " };\n"
32868 " \n"
32869 msgstr ""
32870
32871 #. type: verbatim
32872 #: ../src/guestfs-structs.pod:36
32873 #, no-wrap
32874 msgid ""
32875 " struct guestfs_lvm_pv_list {\n"
32876 "   uint32_t len; /* Number of elements in list. */\n"
32877 "   struct guestfs_lvm_pv *val; /* Elements. */\n"
32878 " };\n"
32879 " \n"
32880 msgstr ""
32881
32882 #. type: verbatim
32883 #: ../src/guestfs-structs.pod:41
32884 #, no-wrap
32885 msgid ""
32886 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
32887 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
32888 "\n"
32889 msgstr ""
32890
32891 #. type: =head2
32892 #: ../src/guestfs-structs.pod:44
32893 msgid "guestfs_lvm_vg"
32894 msgstr ""
32895
32896 #. type: verbatim
32897 #: ../src/guestfs-structs.pod:46
32898 #, no-wrap
32899 msgid ""
32900 " struct guestfs_lvm_vg {\n"
32901 "   char *vg_name;\n"
32902 "   /* The next field is NOT nul-terminated, be careful when printing it: "
32903 "*/\n"
32904 "   char vg_uuid[32];\n"
32905 "   char *vg_fmt;\n"
32906 "   char *vg_attr;\n"
32907 "   uint64_t vg_size;\n"
32908 "   uint64_t vg_free;\n"
32909 "   char *vg_sysid;\n"
32910 "   uint64_t vg_extent_size;\n"
32911 "   int64_t vg_extent_count;\n"
32912 "   int64_t vg_free_count;\n"
32913 "   int64_t max_lv;\n"
32914 "   int64_t max_pv;\n"
32915 "   int64_t pv_count;\n"
32916 "   int64_t lv_count;\n"
32917 "   int64_t snap_count;\n"
32918 "   int64_t vg_seqno;\n"
32919 "   char *vg_tags;\n"
32920 "   int64_t vg_mda_count;\n"
32921 "   uint64_t vg_mda_free;\n"
32922 " };\n"
32923 " \n"
32924 msgstr ""
32925
32926 #. type: verbatim
32927 #: ../src/guestfs-structs.pod:69
32928 #, no-wrap
32929 msgid ""
32930 " struct guestfs_lvm_vg_list {\n"
32931 "   uint32_t len; /* Number of elements in list. */\n"
32932 "   struct guestfs_lvm_vg *val; /* Elements. */\n"
32933 " };\n"
32934 " \n"
32935 msgstr ""
32936
32937 #. type: verbatim
32938 #: ../src/guestfs-structs.pod:74
32939 #, no-wrap
32940 msgid ""
32941 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
32942 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
32943 "\n"
32944 msgstr ""
32945
32946 #. type: =head2
32947 #: ../src/guestfs-structs.pod:77
32948 msgid "guestfs_lvm_lv"
32949 msgstr ""
32950
32951 #. type: verbatim
32952 #: ../src/guestfs-structs.pod:79
32953 #, no-wrap
32954 msgid ""
32955 " struct guestfs_lvm_lv {\n"
32956 "   char *lv_name;\n"
32957 "   /* The next field is NOT nul-terminated, be careful when printing it: "
32958 "*/\n"
32959 "   char lv_uuid[32];\n"
32960 "   char *lv_attr;\n"
32961 "   int64_t lv_major;\n"
32962 "   int64_t lv_minor;\n"
32963 "   int64_t lv_kernel_major;\n"
32964 "   int64_t lv_kernel_minor;\n"
32965 "   uint64_t lv_size;\n"
32966 "   int64_t seg_count;\n"
32967 "   char *origin;\n"
32968 "   /* The next field is [0..100] or -1 meaning 'not present': */\n"
32969 "   float snap_percent;\n"
32970 "   /* The next field is [0..100] or -1 meaning 'not present': */\n"
32971 "   float copy_percent;\n"
32972 "   char *move_pv;\n"
32973 "   char *lv_tags;\n"
32974 "   char *mirror_log;\n"
32975 "   char *modules;\n"
32976 " };\n"
32977 " \n"
32978 msgstr ""
32979
32980 #. type: verbatim
32981 #: ../src/guestfs-structs.pod:101
32982 #, no-wrap
32983 msgid ""
32984 " struct guestfs_lvm_lv_list {\n"
32985 "   uint32_t len; /* Number of elements in list. */\n"
32986 "   struct guestfs_lvm_lv *val; /* Elements. */\n"
32987 " };\n"
32988 " \n"
32989 msgstr ""
32990
32991 #. type: verbatim
32992 #: ../src/guestfs-structs.pod:106
32993 #, no-wrap
32994 msgid ""
32995 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
32996 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
32997 "\n"
32998 msgstr ""
32999
33000 #. type: verbatim
33001 #: ../src/guestfs-structs.pod:111
33002 #, no-wrap
33003 msgid ""
33004 " struct guestfs_stat {\n"
33005 "   int64_t dev;\n"
33006 "   int64_t ino;\n"
33007 "   int64_t mode;\n"
33008 "   int64_t nlink;\n"
33009 "   int64_t uid;\n"
33010 "   int64_t gid;\n"
33011 "   int64_t rdev;\n"
33012 "   int64_t size;\n"
33013 "   int64_t blksize;\n"
33014 "   int64_t blocks;\n"
33015 "   int64_t atime;\n"
33016 "   int64_t mtime;\n"
33017 "   int64_t ctime;\n"
33018 " };\n"
33019 " \n"
33020 msgstr ""
33021
33022 #. type: verbatim
33023 #: ../src/guestfs-structs.pod:127
33024 #, no-wrap
33025 msgid ""
33026 " struct guestfs_stat_list {\n"
33027 "   uint32_t len; /* Number of elements in list. */\n"
33028 "   struct guestfs_stat *val; /* Elements. */\n"
33029 " };\n"
33030 " \n"
33031 msgstr ""
33032
33033 #. type: verbatim
33034 #: ../src/guestfs-structs.pod:132
33035 #, no-wrap
33036 msgid ""
33037 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
33038 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
33039 "\n"
33040 msgstr ""
33041
33042 #. type: verbatim
33043 #: ../src/guestfs-structs.pod:137
33044 #, no-wrap
33045 msgid ""
33046 " struct guestfs_statvfs {\n"
33047 "   int64_t bsize;\n"
33048 "   int64_t frsize;\n"
33049 "   int64_t blocks;\n"
33050 "   int64_t bfree;\n"
33051 "   int64_t bavail;\n"
33052 "   int64_t files;\n"
33053 "   int64_t ffree;\n"
33054 "   int64_t favail;\n"
33055 "   int64_t fsid;\n"
33056 "   int64_t flag;\n"
33057 "   int64_t namemax;\n"
33058 " };\n"
33059 " \n"
33060 msgstr ""
33061
33062 #. type: verbatim
33063 #: ../src/guestfs-structs.pod:151
33064 #, no-wrap
33065 msgid ""
33066 " struct guestfs_statvfs_list {\n"
33067 "   uint32_t len; /* Number of elements in list. */\n"
33068 "   struct guestfs_statvfs *val; /* Elements. */\n"
33069 " };\n"
33070 " \n"
33071 msgstr ""
33072
33073 #. type: verbatim
33074 #: ../src/guestfs-structs.pod:156
33075 #, no-wrap
33076 msgid ""
33077 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
33078 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
33079 "\n"
33080 msgstr ""
33081
33082 #. type: =head2
33083 #: ../src/guestfs-structs.pod:159
33084 msgid "guestfs_dirent"
33085 msgstr ""
33086
33087 #. type: verbatim
33088 #: ../src/guestfs-structs.pod:161
33089 #, no-wrap
33090 msgid ""
33091 " struct guestfs_dirent {\n"
33092 "   int64_t ino;\n"
33093 "   char ftyp;\n"
33094 "   char *name;\n"
33095 " };\n"
33096 " \n"
33097 msgstr ""
33098
33099 #. type: verbatim
33100 #: ../src/guestfs-structs.pod:167
33101 #, no-wrap
33102 msgid ""
33103 " struct guestfs_dirent_list {\n"
33104 "   uint32_t len; /* Number of elements in list. */\n"
33105 "   struct guestfs_dirent *val; /* Elements. */\n"
33106 " };\n"
33107 " \n"
33108 msgstr ""
33109
33110 #. type: verbatim
33111 #: ../src/guestfs-structs.pod:172
33112 #, no-wrap
33113 msgid ""
33114 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
33115 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
33116 "\n"
33117 msgstr ""
33118
33119 #. type: verbatim
33120 #: ../src/guestfs-structs.pod:177
33121 #, no-wrap
33122 msgid ""
33123 " struct guestfs_version {\n"
33124 "   int64_t major;\n"
33125 "   int64_t minor;\n"
33126 "   int64_t release;\n"
33127 "   char *extra;\n"
33128 " };\n"
33129 " \n"
33130 msgstr ""
33131
33132 #. type: verbatim
33133 #: ../src/guestfs-structs.pod:184
33134 #, no-wrap
33135 msgid ""
33136 " struct guestfs_version_list {\n"
33137 "   uint32_t len; /* Number of elements in list. */\n"
33138 "   struct guestfs_version *val; /* Elements. */\n"
33139 " };\n"
33140 " \n"
33141 msgstr ""
33142
33143 #. type: verbatim
33144 #: ../src/guestfs-structs.pod:189
33145 #, no-wrap
33146 msgid ""
33147 " void guestfs_free_version (struct guestfs_free_version *);\n"
33148 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
33149 "\n"
33150 msgstr ""
33151
33152 #. type: =head2
33153 #: ../src/guestfs-structs.pod:192
33154 msgid "guestfs_xattr"
33155 msgstr ""
33156
33157 #. type: verbatim
33158 #: ../src/guestfs-structs.pod:194
33159 #, no-wrap
33160 msgid ""
33161 " struct guestfs_xattr {\n"
33162 "   char *attrname;\n"
33163 "   /* The next two fields describe a byte array. */\n"
33164 "   uint32_t attrval_len;\n"
33165 "   char *attrval;\n"
33166 " };\n"
33167 " \n"
33168 msgstr ""
33169
33170 #. type: verbatim
33171 #: ../src/guestfs-structs.pod:201
33172 #, no-wrap
33173 msgid ""
33174 " struct guestfs_xattr_list {\n"
33175 "   uint32_t len; /* Number of elements in list. */\n"
33176 "   struct guestfs_xattr *val; /* Elements. */\n"
33177 " };\n"
33178 " \n"
33179 msgstr ""
33180
33181 #. type: verbatim
33182 #: ../src/guestfs-structs.pod:206
33183 #, no-wrap
33184 msgid ""
33185 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
33186 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
33187 "\n"
33188 msgstr ""
33189
33190 #. type: =head2
33191 #: ../src/guestfs-structs.pod:209
33192 msgid "guestfs_inotify_event"
33193 msgstr ""
33194
33195 #. type: verbatim
33196 #: ../src/guestfs-structs.pod:211
33197 #, no-wrap
33198 msgid ""
33199 " struct guestfs_inotify_event {\n"
33200 "   int64_t in_wd;\n"
33201 "   uint32_t in_mask;\n"
33202 "   uint32_t in_cookie;\n"
33203 "   char *in_name;\n"
33204 " };\n"
33205 " \n"
33206 msgstr ""
33207
33208 #. type: verbatim
33209 #: ../src/guestfs-structs.pod:218
33210 #, no-wrap
33211 msgid ""
33212 " struct guestfs_inotify_event_list {\n"
33213 "   uint32_t len; /* Number of elements in list. */\n"
33214 "   struct guestfs_inotify_event *val; /* Elements. */\n"
33215 " };\n"
33216 " \n"
33217 msgstr ""
33218
33219 #. type: verbatim
33220 #: ../src/guestfs-structs.pod:223
33221 #, no-wrap
33222 msgid ""
33223 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
33224 " void guestfs_free_inotify_event_list (struct "
33225 "guestfs_free_inotify_event_list *);\n"
33226 "\n"
33227 msgstr ""
33228
33229 #. type: =head2
33230 #: ../src/guestfs-structs.pod:226
33231 msgid "guestfs_partition"
33232 msgstr ""
33233
33234 #. type: verbatim
33235 #: ../src/guestfs-structs.pod:228
33236 #, no-wrap
33237 msgid ""
33238 " struct guestfs_partition {\n"
33239 "   int32_t part_num;\n"
33240 "   uint64_t part_start;\n"
33241 "   uint64_t part_end;\n"
33242 "   uint64_t part_size;\n"
33243 " };\n"
33244 " \n"
33245 msgstr ""
33246
33247 #. type: verbatim
33248 #: ../src/guestfs-structs.pod:235
33249 #, no-wrap
33250 msgid ""
33251 " struct guestfs_partition_list {\n"
33252 "   uint32_t len; /* Number of elements in list. */\n"
33253 "   struct guestfs_partition *val; /* Elements. */\n"
33254 " };\n"
33255 " \n"
33256 msgstr ""
33257
33258 #. type: verbatim
33259 #: ../src/guestfs-structs.pod:240
33260 #, no-wrap
33261 msgid ""
33262 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
33263 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
33264 "\n"
33265 msgstr ""
33266
33267 #. type: =head2
33268 #: ../src/guestfs-structs.pod:243
33269 msgid "guestfs_application"
33270 msgstr ""
33271
33272 #. type: verbatim
33273 #: ../src/guestfs-structs.pod:245
33274 #, no-wrap
33275 msgid ""
33276 " struct guestfs_application {\n"
33277 "   char *app_name;\n"
33278 "   char *app_display_name;\n"
33279 "   int32_t app_epoch;\n"
33280 "   char *app_version;\n"
33281 "   char *app_release;\n"
33282 "   char *app_install_path;\n"
33283 "   char *app_trans_path;\n"
33284 "   char *app_publisher;\n"
33285 "   char *app_url;\n"
33286 "   char *app_source_package;\n"
33287 "   char *app_summary;\n"
33288 "   char *app_description;\n"
33289 " };\n"
33290 " \n"
33291 msgstr ""
33292
33293 #. type: verbatim
33294 #: ../src/guestfs-structs.pod:260
33295 #, no-wrap
33296 msgid ""
33297 " struct guestfs_application_list {\n"
33298 "   uint32_t len; /* Number of elements in list. */\n"
33299 "   struct guestfs_application *val; /* Elements. */\n"
33300 " };\n"
33301 " \n"
33302 msgstr ""
33303
33304 #. type: verbatim
33305 #: ../src/guestfs-structs.pod:265
33306 #, no-wrap
33307 msgid ""
33308 " void guestfs_free_application (struct guestfs_free_application *);\n"
33309 " void guestfs_free_application_list (struct guestfs_free_application_list "
33310 "*);\n"
33311 "\n"
33312 msgstr ""
33313
33314 #. type: textblock
33315 #: ../src/guestfs.pod:5
33316 msgid "guestfs - Library for accessing and modifying virtual machine images"
33317 msgstr ""
33318
33319 #. type: verbatim
33320 #: ../src/guestfs.pod:11
33321 #, no-wrap
33322 msgid ""
33323 " guestfs_h *g = guestfs_create ();\n"
33324 " guestfs_add_drive (g, \"guest.img\");\n"
33325 " guestfs_launch (g);\n"
33326 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
33327 " guestfs_touch (g, \"/hello\");\n"
33328 " guestfs_umount (g, \"/\");\n"
33329 " guestfs_close (g);\n"
33330 "\n"
33331 msgstr ""
33332
33333 #. type: textblock
33334 #: ../src/guestfs.pod:25
33335 msgid ""
33336 "Libguestfs is a library for accessing and modifying guest disk images.  "
33337 "Amongst the things this is good for: making batch configuration changes to "
33338 "guests, getting disk used/free statistics (see also: virt-df), migrating "
33339 "between virtualization systems (see also: virt-p2v), performing partial "
33340 "backups, performing partial guest clones, cloning guests and changing "
33341 "registry/UUID/hostname info, and much else besides."
33342 msgstr ""
33343
33344 #. type: textblock
33345 #: ../src/guestfs.pod:33
33346 msgid ""
33347 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
33348 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
33349 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
33350 "qcow2, vmdk."
33351 msgstr ""
33352
33353 #. type: textblock
33354 #: ../src/guestfs.pod:38
33355 msgid ""
33356 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
33357 "what filesystem is in each LV, etc.).  It can also run commands in the "
33358 "context of the guest.  Also you can access filesystems over FUSE."
33359 msgstr ""
33360
33361 #. type: textblock
33362 #: ../src/guestfs.pod:43
33363 msgid ""
33364 "Libguestfs is a library that can be linked with C and C++ management "
33365 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
33366 "PHP, Erlang, Haskell or C#).  You can also use it from shell scripts or the "
33367 "command line."
33368 msgstr ""
33369
33370 #. type: textblock
33371 #: ../src/guestfs.pod:48
33372 msgid ""
33373 "You don't need to be root to use libguestfs, although obviously you do need "
33374 "enough permissions to access the disk images."
33375 msgstr ""
33376
33377 #. type: textblock
33378 #: ../src/guestfs.pod:51
33379 msgid ""
33380 "Libguestfs is a large API because it can do many things.  For a gentle "
33381 "introduction, please read the L</API OVERVIEW> section next."
33382 msgstr ""
33383
33384 #. type: textblock
33385 #: ../src/guestfs.pod:54
33386 msgid ""
33387 "There are also some example programs in the L<guestfs-examples(3)> manual "
33388 "page."
33389 msgstr ""
33390
33391 #. type: =head1
33392 #: ../src/guestfs.pod:57
33393 msgid "API OVERVIEW"
33394 msgstr ""
33395
33396 #. type: textblock
33397 #: ../src/guestfs.pod:59
33398 msgid ""
33399 "This section provides a gentler overview of the libguestfs API.  We also try "
33400 "to group API calls together, where that may not be obvious from reading "
33401 "about the individual calls in the main section of this manual."
33402 msgstr ""
33403
33404 #. type: =head2
33405 #: ../src/guestfs.pod:64
33406 msgid "HANDLES"
33407 msgstr ""
33408
33409 #. type: textblock
33410 #: ../src/guestfs.pod:66
33411 msgid ""
33412 "Before you can use libguestfs calls, you have to create a handle.  Then you "
33413 "must add at least one disk image to the handle, followed by launching the "
33414 "handle, then performing whatever operations you want, and finally closing "
33415 "the handle.  By convention we use the single letter C<g> for the name of the "
33416 "handle variable, although of course you can use any name you want."
33417 msgstr ""
33418
33419 #. type: textblock
33420 #: ../src/guestfs.pod:73
33421 msgid "The general structure of all libguestfs-using programs looks like this:"
33422 msgstr ""
33423
33424 #. type: verbatim
33425 #: ../src/guestfs.pod:76
33426 #, no-wrap
33427 msgid ""
33428 " guestfs_h *g = guestfs_create ();\n"
33429 " \n"
33430 msgstr ""
33431
33432 #. type: verbatim
33433 #: ../src/guestfs.pod:78
33434 #, no-wrap
33435 msgid ""
33436 " /* Call guestfs_add_drive additional times if there are\n"
33437 "  * multiple disk images.\n"
33438 "  */\n"
33439 " guestfs_add_drive (g, \"guest.img\");\n"
33440 " \n"
33441 msgstr ""
33442
33443 #. type: verbatim
33444 #: ../src/guestfs.pod:83
33445 #, no-wrap
33446 msgid ""
33447 " /* Most manipulation calls won't work until you've launched\n"
33448 "  * the handle 'g'.  You have to do this _after_ adding drives\n"
33449 "  * and _before_ other commands.\n"
33450 "  */\n"
33451 " guestfs_launch (g);\n"
33452 " \n"
33453 msgstr ""
33454
33455 #. type: verbatim
33456 #: ../src/guestfs.pod:89
33457 #, no-wrap
33458 msgid ""
33459 " /* Now you can examine what partitions, LVs etc are available.\n"
33460 "  */\n"
33461 " char **partitions = guestfs_list_partitions (g);\n"
33462 " char **logvols = guestfs_lvs (g);\n"
33463 " \n"
33464 msgstr ""
33465
33466 #. type: verbatim
33467 #: ../src/guestfs.pod:94
33468 #, no-wrap
33469 msgid ""
33470 " /* To access a filesystem in the image, you must mount it.\n"
33471 "  */\n"
33472 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
33473 " \n"
33474 msgstr ""
33475
33476 #. type: verbatim
33477 #: ../src/guestfs.pod:98
33478 #, no-wrap
33479 msgid ""
33480 " /* Now you can perform filesystem actions on the guest\n"
33481 "  * disk image.\n"
33482 "  */\n"
33483 " guestfs_touch (g, \"/hello\");\n"
33484 " \n"
33485 msgstr ""
33486
33487 #. type: verbatim
33488 #: ../src/guestfs.pod:103
33489 #, no-wrap
33490 msgid ""
33491 " /* This is only needed for libguestfs < 1.5.24.  Since then\n"
33492 "  * it is done automatically when you close the handle.  See\n"
33493 "  * discussion of autosync in this page.\n"
33494 "  */\n"
33495 " guestfs_sync (g);\n"
33496 " \n"
33497 msgstr ""
33498
33499 #. type: verbatim
33500 #: ../src/guestfs.pod:109
33501 #, no-wrap
33502 msgid ""
33503 " /* Close the handle 'g'. */\n"
33504 " guestfs_close (g);\n"
33505 "\n"
33506 msgstr ""
33507
33508 #. type: textblock
33509 #: ../src/guestfs.pod:112
33510 msgid ""
33511 "The code above doesn't include any error checking.  In real code you should "
33512 "check return values carefully for errors.  In general all functions that "
33513 "return integers return C<-1> on error, and all functions that return "
33514 "pointers return C<NULL> on error.  See section L</ERROR HANDLING> below for "
33515 "how to handle errors, and consult the documentation for each function call "
33516 "below to see precisely how they return error indications.  See "
33517 "L<guestfs-examples(3)> for fully worked examples."
33518 msgstr ""
33519
33520 #. type: =head2
33521 #: ../src/guestfs.pod:121
33522 msgid "DISK IMAGES"
33523 msgstr ""
33524
33525 #. type: textblock
33526 #: ../src/guestfs.pod:123
33527 msgid ""
33528 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
33529 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
33530 "actual block device, or simply an empty file of zeroes that you have created "
33531 "through L<posix_fallocate(3)>.  Libguestfs lets you do useful things to all "
33532 "of these."
33533 msgstr ""
33534
33535 #. type: textblock
33536 #: ../src/guestfs.pod:129
33537 msgid ""
33538 "The call you should use in modern code for adding drives is "
33539 "L</guestfs_add_drive_opts>.  To add a disk image, allowing writes, and "
33540 "specifying that the format is raw, do:"
33541 msgstr ""
33542
33543 #. type: verbatim
33544 #: ../src/guestfs.pod:133
33545 #, no-wrap
33546 msgid ""
33547 " guestfs_add_drive_opts (g, filename,\n"
33548 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
33549 "                         -1);\n"
33550 "\n"
33551 msgstr ""
33552
33553 #. type: textblock
33554 #: ../src/guestfs.pod:137
33555 msgid "You can add a disk read-only using:"
33556 msgstr ""
33557
33558 #. type: verbatim
33559 #: ../src/guestfs.pod:139
33560 #, no-wrap
33561 msgid ""
33562 " guestfs_add_drive_opts (g, filename,\n"
33563 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
33564 "                         GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
33565 "                         -1);\n"
33566 "\n"
33567 msgstr ""
33568
33569 #. type: textblock
33570 #: ../src/guestfs.pod:144
33571 msgid ""
33572 "or by calling the older function L</guestfs_add_drive_ro>.  In either case "
33573 "libguestfs won't modify the file."
33574 msgstr ""
33575
33576 #. type: textblock
33577 #: ../src/guestfs.pod:147
33578 msgid ""
33579 "Be extremely cautious if the disk image is in use, eg. if it is being used "
33580 "by a virtual machine.  Adding it read-write will almost certainly cause disk "
33581 "corruption, but adding it read-only is safe."
33582 msgstr ""
33583
33584 #. type: textblock
33585 #: ../src/guestfs.pod:151
33586 msgid ""
33587 "You must add at least one disk image, and you may add multiple disk images.  "
33588 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
33589 "first one you added), C</dev/sdb> (for the second one you added), etc."
33590 msgstr ""
33591
33592 #. type: textblock
33593 #: ../src/guestfs.pod:156
33594 msgid ""
33595 "Once L</guestfs_launch> has been called you cannot add any more images.  You "
33596 "can call L</guestfs_list_devices> to get a list of the device names, in the "
33597 "order that you added them.  See also L</BLOCK DEVICE NAMING> below."
33598 msgstr ""
33599
33600 #. type: =head2
33601 #: ../src/guestfs.pod:161
33602 msgid "MOUNTING"
33603 msgstr ""
33604
33605 #. type: textblock
33606 #: ../src/guestfs.pod:163
33607 msgid ""
33608 "Before you can read or write files, create directories and so on in a disk "
33609 "image that contains filesystems, you have to mount those filesystems using "
33610 "L</guestfs_mount_options> or L</guestfs_mount_ro>.  If you already know that "
33611 "a disk image contains (for example) one partition with a filesystem on that "
33612 "partition, then you can mount it directly:"
33613 msgstr ""
33614
33615 #. type: verbatim
33616 #: ../src/guestfs.pod:170
33617 #, no-wrap
33618 msgid ""
33619 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
33620 "\n"
33621 msgstr ""
33622
33623 #. type: textblock
33624 #: ../src/guestfs.pod:172
33625 msgid ""
33626 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
33627 "disk image that we added (C</dev/sda>).  If the disk contains Linux LVM2 "
33628 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>).  Note "
33629 "that these are libguestfs virtual devices, and are nothing to do with host "
33630 "devices."
33631 msgstr ""
33632
33633 #. type: textblock
33634 #: ../src/guestfs.pod:178
33635 msgid ""
33636 "If you are given a disk image and you don't know what it contains then you "
33637 "have to find out.  Libguestfs can do that too: use "
33638 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
33639 "and LVs, and either try mounting each to see what is mountable, or else "
33640 "examine them with L</guestfs_vfs_type> or L</guestfs_file>.  To list just "
33641 "filesystems, use L</guestfs_list_filesystems>."
33642 msgstr ""
33643
33644 #. type: textblock
33645 #: ../src/guestfs.pod:186
33646 msgid ""
33647 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
33648 "L</INSPECTION> below).  But you might find it easier to look at higher level "
33649 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
33650 msgstr ""
33651
33652 #. type: textblock
33653 #: ../src/guestfs.pod:191
33654 msgid ""
33655 "To mount a filesystem read-only, use L</guestfs_mount_ro>.  There are "
33656 "several other variations of the C<guestfs_mount_*> call."
33657 msgstr ""
33658
33659 #. type: =head2
33660 #: ../src/guestfs.pod:194
33661 msgid "FILESYSTEM ACCESS AND MODIFICATION"
33662 msgstr ""
33663
33664 #. type: textblock
33665 #: ../src/guestfs.pod:196
33666 msgid ""
33667 "The majority of the libguestfs API consists of fairly low-level calls for "
33668 "accessing and modifying the files, directories, symlinks etc on mounted "
33669 "filesystems.  There are over a hundred such calls which you can find listed "
33670 "in detail below in this man page, and we don't even pretend to cover them "
33671 "all in this overview."
33672 msgstr ""
33673
33674 #. type: textblock
33675 #: ../src/guestfs.pod:202
33676 msgid ""
33677 "Specify filenames as full paths, starting with C<\"/\"> and including the "
33678 "mount point."
33679 msgstr ""
33680
33681 #. type: textblock
33682 #: ../src/guestfs.pod:205
33683 msgid ""
33684 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
33685 "the file called C<\"etc/passwd\"> then you could do:"
33686 msgstr ""
33687
33688 #. type: verbatim
33689 #: ../src/guestfs.pod:208
33690 #, no-wrap
33691 msgid ""
33692 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
33693 "\n"
33694 msgstr ""
33695
33696 #. type: textblock
33697 #: ../src/guestfs.pod:210
33698 msgid ""
33699 "This would return C<data> as a newly allocated buffer containing the full "
33700 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
33701 "or C<NULL> if there was an error."
33702 msgstr ""
33703
33704 #. type: textblock
33705 #: ../src/guestfs.pod:214
33706 msgid ""
33707 "As another example, to create a top-level directory on that filesystem "
33708 "called C<\"var\"> you would do:"
33709 msgstr ""
33710
33711 #. type: verbatim
33712 #: ../src/guestfs.pod:217
33713 #, no-wrap
33714 msgid ""
33715 " guestfs_mkdir (g, \"/var\");\n"
33716 "\n"
33717 msgstr ""
33718
33719 #. type: textblock
33720 #: ../src/guestfs.pod:219
33721 msgid "To create a symlink you could do:"
33722 msgstr ""
33723
33724 #. type: verbatim
33725 #: ../src/guestfs.pod:221
33726 #, no-wrap
33727 msgid ""
33728 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
33729 "               \"/etc/rc3.d/S30portmap\");\n"
33730 "\n"
33731 msgstr ""
33732
33733 #. type: textblock
33734 #: ../src/guestfs.pod:224
33735 msgid ""
33736 "Libguestfs will reject attempts to use relative paths and there is no "
33737 "concept of a current working directory."
33738 msgstr ""
33739
33740 #. type: textblock
33741 #: ../src/guestfs.pod:227
33742 msgid ""
33743 "Libguestfs can return errors in many situations: for example if the "
33744 "filesystem isn't writable, or if a file or directory that you requested "
33745 "doesn't exist.  If you are using the C API (documented here)  you have to "
33746 "check for those error conditions after each call.  (Other language bindings "
33747 "turn these errors into exceptions)."
33748 msgstr ""
33749
33750 #. type: textblock
33751 #: ../src/guestfs.pod:233
33752 msgid ""
33753 "File writes are affected by the per-handle umask, set by calling "
33754 "L</guestfs_umask> and defaulting to 022.  See L</UMASK>."
33755 msgstr ""
33756
33757 #. type: =head2
33758 #: ../src/guestfs.pod:236
33759 msgid "PARTITIONING"
33760 msgstr ""
33761
33762 #. type: textblock
33763 #: ../src/guestfs.pod:238
33764 msgid ""
33765 "Libguestfs contains API calls to read, create and modify partition tables on "
33766 "disk images."
33767 msgstr ""
33768
33769 #. type: textblock
33770 #: ../src/guestfs.pod:241
33771 msgid ""
33772 "In the common case where you want to create a single partition covering the "
33773 "whole disk, you should use the L</guestfs_part_disk> call:"
33774 msgstr ""
33775
33776 #. type: verbatim
33777 #: ../src/guestfs.pod:245
33778 #, no-wrap
33779 msgid ""
33780 " const char *parttype = \"mbr\";\n"
33781 " if (disk_is_larger_than_2TB)\n"
33782 "   parttype = \"gpt\";\n"
33783 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
33784 "\n"
33785 msgstr ""
33786
33787 #. type: textblock
33788 #: ../src/guestfs.pod:250
33789 msgid ""
33790 "Obviously this effectively wipes anything that was on that disk image "
33791 "before."
33792 msgstr ""
33793
33794 #. type: =head2
33795 #: ../src/guestfs.pod:253
33796 msgid "LVM2"
33797 msgstr ""
33798
33799 #. type: textblock
33800 #: ../src/guestfs.pod:255
33801 msgid ""
33802 "Libguestfs provides access to a large part of the LVM2 API, such as "
33803 "L</guestfs_lvcreate> and L</guestfs_vgremove>.  It won't make much sense "
33804 "unless you familiarize yourself with the concepts of physical volumes, "
33805 "volume groups and logical volumes."
33806 msgstr ""
33807
33808 #. type: textblock
33809 #: ../src/guestfs.pod:260
33810 msgid ""
33811 "This author strongly recommends reading the LVM HOWTO, online at "
33812 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
33813 msgstr ""
33814
33815 #. type: =head2
33816 #: ../src/guestfs.pod:263
33817 msgid "DOWNLOADING"
33818 msgstr ""
33819
33820 #. type: textblock
33821 #: ../src/guestfs.pod:265
33822 msgid ""
33823 "Use L</guestfs_cat> to download small, text only files.  This call is "
33824 "limited to files which are less than 2 MB and which cannot contain any ASCII "
33825 "NUL (C<\\0>) characters.  However the API is very simple to use."
33826 msgstr ""
33827
33828 #. type: textblock
33829 #: ../src/guestfs.pod:269
33830 msgid ""
33831 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
33832 "bit data, since it returns a (pointer, size) pair.  However it is still "
33833 "limited to \"small\" files, less than 2 MB."
33834 msgstr ""
33835
33836 #. type: textblock
33837 #: ../src/guestfs.pod:273
33838 msgid ""
33839 "L</guestfs_download> can be used to download any file, with no limits on "
33840 "content or size (even files larger than 4 GB)."
33841 msgstr ""
33842
33843 #. type: textblock
33844 #: ../src/guestfs.pod:276
33845 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
33846 msgstr ""
33847
33848 #. type: =head2
33849 #: ../src/guestfs.pod:279
33850 msgid "UPLOADING"
33851 msgstr ""
33852
33853 #. type: textblock
33854 #: ../src/guestfs.pod:281
33855 msgid ""
33856 "It's often the case that you want to write a file or files to the disk "
33857 "image."
33858 msgstr ""
33859
33860 #. type: textblock
33861 #: ../src/guestfs.pod:284
33862 msgid ""
33863 "To write a small file with fixed content, use L</guestfs_write>.  To create "
33864 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
33865 "L</guestfs_fallocate64> (with all disk blocks allocated).  There are a "
33866 "variety of other functions for creating test files, for example "
33867 "L</guestfs_fill> and L</guestfs_fill_pattern>."
33868 msgstr ""
33869
33870 #. type: textblock
33871 #: ../src/guestfs.pod:290
33872 msgid ""
33873 "To upload a single file, use L</guestfs_upload>.  This call has no limits on "
33874 "file content or size (even files larger than 4 GB)."
33875 msgstr ""
33876
33877 #. type: textblock
33878 #: ../src/guestfs.pod:293
33879 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
33880 msgstr ""
33881
33882 #. type: textblock
33883 #: ../src/guestfs.pod:295
33884 msgid ""
33885 "However the fastest way to upload I<large numbers of arbitrary files> is to "
33886 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
33887 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>.  If you add "
33888 "the drive in a predictable way (eg. adding it last after all other drives) "
33889 "then you can get the device name from L</guestfs_list_devices> and mount it "
33890 "directly using L</guestfs_mount_ro>.  Note that squashfs images are "
33891 "sometimes non-portable between kernel versions, and they don't support "
33892 "labels or UUIDs.  If you want to pre-build an image or you need to mount it "
33893 "using a label or UUID, use an ISO image instead."
33894 msgstr ""
33895
33896 #. type: =head2
33897 #: ../src/guestfs.pod:306
33898 msgid "COPYING"
33899 msgstr ""
33900
33901 #. type: textblock
33902 #: ../src/guestfs.pod:308
33903 msgid ""
33904 "There are various different commands for copying between files and devices "
33905 "and in and out of the guest filesystem.  These are summarised in the table "
33906 "below."
33907 msgstr ""
33908
33909 #. type: =item
33910 #: ../src/guestfs.pod:314
33911 msgid "B<file> to B<file>"
33912 msgstr ""
33913
33914 #. type: textblock
33915 #: ../src/guestfs.pod:316
33916 msgid ""
33917 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
33918 "directories recursively."
33919 msgstr ""
33920
33921 #. type: textblock
33922 #: ../src/guestfs.pod:319
33923 msgid "To copy part of a file (offset and size) use L</guestfs_copy_file_to_file>."
33924 msgstr ""
33925
33926 #. type: =item
33927 #: ../src/guestfs.pod:322
33928 msgid "B<file> to B<device>"
33929 msgstr ""
33930
33931 #. type: =item
33932 #: ../src/guestfs.pod:324
33933 msgid "B<device> to B<file>"
33934 msgstr ""
33935
33936 #. type: =item
33937 #: ../src/guestfs.pod:326
33938 msgid "B<device> to B<device>"
33939 msgstr ""
33940
33941 #. type: textblock
33942 #: ../src/guestfs.pod:328
33943 msgid ""
33944 "Use L</guestfs_copy_file_to_device>, L</guestfs_copy_device_to_file>, or "
33945 "L</guestfs_copy_device_to_device>."
33946 msgstr ""
33947
33948 #. type: textblock
33949 #: ../src/guestfs.pod:331
33950 msgid "Example: duplicate the contents of an LV:"
33951 msgstr ""
33952
33953 #. type: verbatim
33954 #: ../src/guestfs.pod:333
33955 #, no-wrap
33956 msgid ""
33957 " guestfs_copy_device_to_device (g,\n"
33958 "         \"/dev/VG/Original\", \"/dev/VG/Copy\",\n"
33959 "         /* -1 marks the end of the list of optional parameters */\n"
33960 "         -1);\n"
33961 "\n"
33962 msgstr ""
33963
33964 #. type: textblock
33965 #: ../src/guestfs.pod:338
33966 msgid ""
33967 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
33968 "(C</dev/VG/Original>).  To copy less than the whole source device, use the "
33969 "optional C<size> parameter:"
33970 msgstr ""
33971
33972 #. type: verbatim
33973 #: ../src/guestfs.pod:342
33974 #, no-wrap
33975 msgid ""
33976 " guestfs_copy_device_to_device (g,\n"
33977 "         \"/dev/VG/Original\", \"/dev/VG/Copy\",\n"
33978 "         GUESTFS_COPY_DEVICE_TO_DEVICE_SIZE, 10000,\n"
33979 "         -1);\n"
33980 "\n"
33981 msgstr ""
33982
33983 #. type: =item
33984 #: ../src/guestfs.pod:347
33985 msgid "B<file on the host> to B<file or device>"
33986 msgstr ""
33987
33988 #. type: textblock
33989 #: ../src/guestfs.pod:349
33990 msgid "Use L</guestfs_upload>.  See L</UPLOADING> above."
33991 msgstr ""
33992
33993 #. type: =item
33994 #: ../src/guestfs.pod:351
33995 msgid "B<file or device> to B<file on the host>"
33996 msgstr ""
33997
33998 #. type: textblock
33999 #: ../src/guestfs.pod:353
34000 msgid "Use L</guestfs_download>.  See L</DOWNLOADING> above."
34001 msgstr ""
34002
34003 #. type: =head2
34004 #: ../src/guestfs.pod:357
34005 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
34006 msgstr ""
34007
34008 #. type: textblock
34009 #: ../src/guestfs.pod:359
34010 msgid ""
34011 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
34012 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
34013 "appears you can only upload and download to files.  However many Un*x-like "
34014 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
34015 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
34016 "stderr, and arbitrary file descriptor N."
34017 msgstr ""
34018
34019 #. type: textblock
34020 #: ../src/guestfs.pod:367
34021 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
34022 msgstr ""
34023
34024 #. type: verbatim
34025 #: ../src/guestfs.pod:370
34026 #, no-wrap
34027 msgid ""
34028 " guestfs_download (g, filename, \"/dev/stdout\");\n"
34029 "\n"
34030 msgstr ""
34031
34032 #. type: textblock
34033 #: ../src/guestfs.pod:372
34034 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
34035 msgstr ""
34036
34037 #. type: verbatim
34038 #: ../src/guestfs.pod:374
34039 #, no-wrap
34040 msgid ""
34041 " char devfd[64];\n"
34042 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
34043 " guestfs_tar_out (g, \"/\", devfd);\n"
34044 "\n"
34045 msgstr ""
34046
34047 #. type: =head2
34048 #: ../src/guestfs.pod:378
34049 msgid "LISTING FILES"
34050 msgstr ""
34051
34052 #. type: textblock
34053 #: ../src/guestfs.pod:380
34054 msgid ""
34055 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
34056 "L<guestfish(1)>-equivalent command C<ll>)."
34057 msgstr ""
34058
34059 #. type: textblock
34060 #: ../src/guestfs.pod:383
34061 msgid ""
34062 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
34063 "programs, as a flat list of strings."
34064 msgstr ""
34065
34066 #. type: textblock
34067 #: ../src/guestfs.pod:386
34068 msgid ""
34069 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
34070 "directory, plus additional information about each one.  It is more "
34071 "equivalent to using the L<readdir(3)> call on a local filesystem."
34072 msgstr ""
34073
34074 #. type: textblock
34075 #: ../src/guestfs.pod:390
34076 msgid ""
34077 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
34078 "files."
34079 msgstr ""
34080
34081 #. type: =head2
34082 #: ../src/guestfs.pod:393
34083 msgid "RUNNING COMMANDS"
34084 msgstr ""
34085
34086 #. type: textblock
34087 #: ../src/guestfs.pod:395
34088 msgid ""
34089 "Although libguestfs is primarily an API for manipulating files inside guest "
34090 "images, we also provide some limited facilities for running commands inside "
34091 "guests."
34092 msgstr ""
34093
34094 #. type: textblock
34095 #: ../src/guestfs.pod:399
34096 msgid "There are many limitations to this:"
34097 msgstr ""
34098
34099 #. type: textblock
34100 #: ../src/guestfs.pod:405
34101 msgid ""
34102 "The kernel version that the command runs under will be different from what "
34103 "it expects."
34104 msgstr ""
34105
34106 #. type: textblock
34107 #: ../src/guestfs.pod:410
34108 msgid ""
34109 "If the command needs to communicate with daemons, then most likely they "
34110 "won't be running."
34111 msgstr ""
34112
34113 #. type: textblock
34114 #: ../src/guestfs.pod:415
34115 msgid "The command will be running in limited memory."
34116 msgstr ""
34117
34118 #. type: textblock
34119 #: ../src/guestfs.pod:419
34120 msgid ""
34121 "The network may not be available unless you enable it (see "
34122 "L</guestfs_set_network>)."
34123 msgstr ""
34124
34125 #. type: textblock
34126 #: ../src/guestfs.pod:424
34127 msgid "Only supports Linux guests (not Windows, BSD, etc)."
34128 msgstr ""
34129
34130 #. type: textblock
34131 #: ../src/guestfs.pod:428
34132 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
34133 msgstr ""
34134
34135 #. type: textblock
34136 #: ../src/guestfs.pod:433
34137 msgid ""
34138 "For SELinux guests, you may need to enable SELinux and load policy first.  "
34139 "See L</SELINUX> in this manpage."
34140 msgstr ""
34141
34142 #. type: textblock
34143 #: ../src/guestfs.pod:438
34144 msgid ""
34145 "I<Security:> It is not safe to run commands from untrusted, possibly "
34146 "malicious guests.  These commands may attempt to exploit your program by "
34147 "sending unexpected output.  They could also try to exploit the Linux kernel "
34148 "or qemu provided by the libguestfs appliance.  They could use the network "
34149 "provided by the libguestfs appliance to bypass ordinary network partitions "
34150 "and firewalls.  They could use the elevated privileges or different SELinux "
34151 "context of your program to their advantage."
34152 msgstr ""
34153
34154 #. type: textblock
34155 #: ../src/guestfs.pod:447
34156 msgid ""
34157 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
34158 "(a script which runs when the guest next boots normally), and to have this "
34159 "script run the commands you want in the normal context of the running guest, "
34160 "network security and so on.  For information about other security issues, "
34161 "see L</SECURITY>."
34162 msgstr ""
34163
34164 #. type: textblock
34165 #: ../src/guestfs.pod:455
34166 msgid ""
34167 "The two main API calls to run commands are L</guestfs_command> and "
34168 "L</guestfs_sh> (there are also variations)."
34169 msgstr ""
34170
34171 #. type: textblock
34172 #: ../src/guestfs.pod:458
34173 msgid ""
34174 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
34175 "shell globs, redirections, etc will work."
34176 msgstr ""
34177
34178 #. type: =head2
34179 #: ../src/guestfs.pod:461
34180 msgid "CONFIGURATION FILES"
34181 msgstr ""
34182
34183 #. type: textblock
34184 #: ../src/guestfs.pod:463
34185 msgid ""
34186 "To read and write configuration files in Linux guest filesystems, we "
34187 "strongly recommend using Augeas.  For example, Augeas understands how to "
34188 "read and write, say, a Linux shadow password file or X.org configuration "
34189 "file, and so avoids you having to write that code."
34190 msgstr ""
34191
34192 #. type: textblock
34193 #: ../src/guestfs.pod:468
34194 msgid ""
34195 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs.  We don't "
34196 "document Augeas itself here because there is excellent documentation on the "
34197 "L<http://augeas.net/> website."
34198 msgstr ""
34199
34200 #. type: textblock
34201 #: ../src/guestfs.pod:472
34202 msgid ""
34203 "If you don't want to use Augeas (you fool!) then try calling "
34204 "L</guestfs_read_lines> to get the file as a list of lines which you can "
34205 "iterate over."
34206 msgstr ""
34207
34208 #. type: =head2
34209 #: ../src/guestfs.pod:476
34210 msgid "SELINUX"
34211 msgstr ""
34212
34213 #. type: textblock
34214 #: ../src/guestfs.pod:478
34215 msgid ""
34216 "We support SELinux guests.  To ensure that labeling happens correctly in "
34217 "SELinux guests, you need to enable SELinux and load the guest's policy:"
34218 msgstr ""
34219
34220 #. type: textblock
34221 #: ../src/guestfs.pod:486
34222 msgid "Before launching, do:"
34223 msgstr ""
34224
34225 #. type: verbatim
34226 #: ../src/guestfs.pod:488
34227 #, no-wrap
34228 msgid ""
34229 " guestfs_set_selinux (g, 1);\n"
34230 "\n"
34231 msgstr ""
34232
34233 #. type: textblock
34234 #: ../src/guestfs.pod:492
34235 msgid ""
34236 "After mounting the guest's filesystem(s), load the policy.  This is best "
34237 "done by running the L<load_policy(8)> command in the guest itself:"
34238 msgstr ""
34239
34240 #. type: verbatim
34241 #: ../src/guestfs.pod:496
34242 #, no-wrap
34243 msgid ""
34244 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
34245 "\n"
34246 msgstr ""
34247
34248 #. type: textblock
34249 #: ../src/guestfs.pod:498
34250 msgid ""
34251 "(Older versions of C<load_policy> require you to specify the name of the "
34252 "policy file)."
34253 msgstr ""
34254
34255 #. type: textblock
34256 #: ../src/guestfs.pod:503
34257 msgid ""
34258 "Optionally, set the security context for the API.  The correct security "
34259 "context to use can only be known by inspecting the guest.  As an example:"
34260 msgstr ""
34261
34262 #. type: verbatim
34263 #: ../src/guestfs.pod:507
34264 #, no-wrap
34265 msgid ""
34266 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
34267 "\n"
34268 msgstr ""
34269
34270 #. type: textblock
34271 #: ../src/guestfs.pod:511
34272 msgid "This will work for running commands and editing existing files."
34273 msgstr ""
34274
34275 #. type: textblock
34276 #: ../src/guestfs.pod:513
34277 msgid ""
34278 "When new files are created, you may need to label them explicitly, for "
34279 "example by running the external command C<restorecon pathname>."
34280 msgstr ""
34281
34282 #. type: =head2
34283 #: ../src/guestfs.pod:517
34284 msgid "UMASK"
34285 msgstr ""
34286
34287 #. type: textblock
34288 #: ../src/guestfs.pod:519
34289 msgid ""
34290 "Certain calls are affected by the current file mode creation mask (the "
34291 "\"umask\").  In particular ones which create files or directories, such as "
34292 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>.  This affects "
34293 "either the default mode that the file is created with or modifies the mode "
34294 "that you supply."
34295 msgstr ""
34296
34297 #. type: textblock
34298 #: ../src/guestfs.pod:525
34299 msgid ""
34300 "The default umask is C<022>, so files are created with modes such as C<0644> "
34301 "and directories with C<0755>."
34302 msgstr ""
34303
34304 #. type: textblock
34305 #: ../src/guestfs.pod:528
34306 msgid ""
34307 "There are two ways to avoid being affected by umask.  Either set umask to 0 "
34308 "(call C<guestfs_umask (g, 0)> early after launching).  Or call "
34309 "L</guestfs_chmod> after creating each file or directory."
34310 msgstr ""
34311
34312 #. type: textblock
34313 #: ../src/guestfs.pod:532
34314 msgid "For more information about umask, see L<umask(2)>."
34315 msgstr ""
34316
34317 #. type: textblock
34318 #: ../src/guestfs.pod:536
34319 msgid ""
34320 "Libguestfs allows you to access Linux guests which have been encrypted using "
34321 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
34322 "standard.  This includes nearly all whole disk encryption systems used by "
34323 "modern Linux guests."
34324 msgstr ""
34325
34326 #. type: textblock
34327 #: ../src/guestfs.pod:542
34328 msgid ""
34329 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
34330 "returns the string C<crypto_LUKS>)."
34331 msgstr ""
34332
34333 #. type: textblock
34334 #: ../src/guestfs.pod:545
34335 msgid ""
34336 "Then open these devices by calling L</guestfs_luks_open>.  Obviously you "
34337 "will require the passphrase!"
34338 msgstr ""
34339
34340 #. type: textblock
34341 #: ../src/guestfs.pod:548
34342 msgid ""
34343 "Opening a LUKS device creates a new device mapper device called "
34344 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
34345 "L</guestfs_luks_open>).  Reads and writes to this mapper device are "
34346 "decrypted from and encrypted to the underlying block device respectively."
34347 msgstr ""
34348
34349 #. type: textblock
34350 #: ../src/guestfs.pod:554
34351 msgid ""
34352 "LVM volume groups on the device can be made visible by calling "
34353 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>.  The logical "
34354 "volume(s) can now be mounted in the usual way."
34355 msgstr ""
34356
34357 #. type: textblock
34358 #: ../src/guestfs.pod:558
34359 msgid ""
34360 "Use the reverse process to close a LUKS device.  Unmount any logical volumes "
34361 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
34362 "[\"/dev/VG\"])>.  Then close the mapper device by calling "
34363 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
34364 "underlying encrypted block device)."
34365 msgstr ""
34366
34367 #. type: =head2
34368 #: ../src/guestfs.pod:565
34369 msgid "INSPECTION"
34370 msgstr ""
34371
34372 #. type: textblock
34373 #: ../src/guestfs.pod:567
34374 msgid ""
34375 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
34376 "contains operating systems, an install CD or a live CD.  (These APIs used to "
34377 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
34378 "version 1.5.3 the most frequently used part of this library has been "
34379 "rewritten in C and moved into the core code)."
34380 msgstr ""
34381
34382 #. type: textblock
34383 #: ../src/guestfs.pod:574
34384 msgid ""
34385 "Add all disks belonging to the unknown virtual machine and call "
34386 "L</guestfs_launch> in the usual way."
34387 msgstr ""
34388
34389 #. type: textblock
34390 #: ../src/guestfs.pod:577
34391 msgid ""
34392 "Then call L</guestfs_inspect_os>.  This function uses other libguestfs calls "
34393 "and certain heuristics, and returns a list of operating systems that were "
34394 "found.  An empty list means none were found.  A single element is the root "
34395 "filesystem of the operating system.  For dual- or multi-boot guests, "
34396 "multiple roots can be returned, each one corresponding to a separate "
34397 "operating system.  (Multi-boot virtual machines are extremely rare in the "
34398 "world of virtualization, but since this scenario can happen, we have built "
34399 "libguestfs to deal with it.)"
34400 msgstr ""
34401
34402 #. type: textblock
34403 #: ../src/guestfs.pod:586
34404 msgid ""
34405 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
34406 "to get additional details about that operating system.  For example, call "
34407 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
34408 "Windows and Linux-based operating systems respectively."
34409 msgstr ""
34410
34411 #. type: textblock
34412 #: ../src/guestfs.pod:592
34413 msgid ""
34414 "Un*x-like and Linux-based operating systems usually consist of several "
34415 "filesystems which are mounted at boot time (for example, a separate boot "
34416 "partition mounted on C</boot>).  The inspection rules are able to detect how "
34417 "filesystems correspond to mount points.  Call "
34418 "C<guestfs_inspect_get_mountpoints> to get this mapping.  It might return a "
34419 "hash table like this example:"
34420 msgstr ""
34421
34422 #. type: verbatim
34423 #: ../src/guestfs.pod:599
34424 #, no-wrap
34425 msgid ""
34426 " /boot => /dev/sda1\n"
34427 " /     => /dev/vg_guest/lv_root\n"
34428 " /usr  => /dev/vg_guest/lv_usr\n"
34429 "\n"
34430 msgstr ""
34431
34432 #. type: textblock
34433 #: ../src/guestfs.pod:603
34434 msgid ""
34435 "The caller can then make calls to L</guestfs_mount_options> to mount the "
34436 "filesystems as suggested."
34437 msgstr ""
34438
34439 #. type: textblock
34440 #: ../src/guestfs.pod:606
34441 msgid ""
34442 "Be careful to mount filesystems in the right order (eg. C</> before "
34443 "C</usr>).  Sorting the keys of the hash by length, shortest first, should "
34444 "work."
34445 msgstr ""
34446
34447 #. type: textblock
34448 #: ../src/guestfs.pod:610
34449 msgid ""
34450 "Inspection currently only works for some common operating systems.  "
34451 "Contributors are welcome to send patches for other operating systems that we "
34452 "currently cannot detect."
34453 msgstr ""
34454
34455 #. type: textblock
34456 #: ../src/guestfs.pod:614
34457 msgid ""
34458 "Encrypted disks must be opened before inspection.  See L</ENCRYPTED DISKS> "
34459 "for more details.  The L</guestfs_inspect_os> function just ignores any "
34460 "encrypted devices."
34461 msgstr ""
34462
34463 #. type: textblock
34464 #: ../src/guestfs.pod:618
34465 msgid ""
34466 "A note on the implementation: The call L</guestfs_inspect_os> performs "
34467 "inspection and caches the results in the guest handle.  Subsequent calls to "
34468 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
34469 "re-read the disks.  If you change the content of the guest disks, you can "
34470 "redo inspection by calling L</guestfs_inspect_os> again.  "
34471 "(L</guestfs_inspect_list_applications> works a little differently from the "
34472 "other calls and does read the disks.  See documentation for that function "
34473 "for details)."
34474 msgstr ""
34475
34476 #. type: =head3
34477 #: ../src/guestfs.pod:627
34478 msgid "INSPECTING INSTALL DISKS"
34479 msgstr ""
34480
34481 #. type: textblock
34482 #: ../src/guestfs.pod:629
34483 msgid ""
34484 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
34485 "CDs and more."
34486 msgstr ""
34487
34488 #. type: textblock
34489 #: ../src/guestfs.pod:632
34490 msgid ""
34491 "Call L</guestfs_inspect_get_format> to return the format of the operating "
34492 "system, which currently can be C<installed> (a regular operating system) or "
34493 "C<installer> (some sort of install disk)."
34494 msgstr ""
34495
34496 #. type: textblock
34497 #: ../src/guestfs.pod:636
34498 msgid ""
34499 "Further information is available about the operating system that can be "
34500 "installed using the regular inspection APIs like "
34501 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
34502 "etc."
34503 msgstr ""
34504
34505 #. type: textblock
34506 #: ../src/guestfs.pod:641
34507 msgid ""
34508 "Some additional information specific to installer disks is also available "
34509 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
34510 "L</guestfs_inspect_is_multipart> calls."
34511 msgstr ""
34512
34513 #. type: =head2
34514 #: ../src/guestfs.pod:646
34515 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
34516 msgstr ""
34517
34518 #. type: textblock
34519 #: ../src/guestfs.pod:648
34520 msgid ""
34521 "Libguestfs can mount NTFS partitions.  It does this using the "
34522 "L<http://www.ntfs-3g.org/> driver."
34523 msgstr ""
34524
34525 #. type: =head3
34526 #: ../src/guestfs.pod:651
34527 msgid "DRIVE LETTERS AND PATHS"
34528 msgstr ""
34529
34530 #. type: textblock
34531 #: ../src/guestfs.pod:653
34532 msgid ""
34533 "DOS and Windows still use drive letters, and the filesystems are always "
34534 "treated as case insensitive by Windows itself, and therefore you might find "
34535 "a Windows configuration file referring to a path like "
34536 "C<c:\\windows\\system32>.  When the filesystem is mounted in libguestfs, "
34537 "that directory might be referred to as C</WINDOWS/System32>."
34538 msgstr ""
34539
34540 #. type: textblock
34541 #: ../src/guestfs.pod:659
34542 msgid ""
34543 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
34544 "L</guestfs_inspect_get_drive_mappings>)"
34545 msgstr ""
34546
34547 #. type: textblock
34548 #: ../src/guestfs.pod:662
34549 msgid ""
34550 "Dealing with separator characters (backslash vs forward slash) is outside "
34551 "the scope of libguestfs, but usually a simple character replacement will "
34552 "work."
34553 msgstr ""
34554
34555 #. type: textblock
34556 #: ../src/guestfs.pod:666
34557 msgid ""
34558 "To resolve the case insensitivity of paths, call "
34559 "L</guestfs_case_sensitive_path>."
34560 msgstr ""
34561
34562 #. type: =head3
34563 #: ../src/guestfs.pod:669
34564 msgid "ACCESSING THE WINDOWS REGISTRY"
34565 msgstr ""
34566
34567 #. type: textblock
34568 #: ../src/guestfs.pod:671
34569 msgid ""
34570 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
34571 "files, through the library C<hivex> which is part of the libguestfs project "
34572 "although ships as a separate tarball.  You have to locate and download the "
34573 "hive file(s) yourself, and then pass them to C<hivex> functions.  See also "
34574 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
34575 "L<virt-win-reg(1)> for more help on this issue."
34576 msgstr ""
34577
34578 #. type: =head3
34579 #: ../src/guestfs.pod:679
34580 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
34581 msgstr ""
34582
34583 #. type: textblock
34584 #: ../src/guestfs.pod:681
34585 msgid ""
34586 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
34587 "provide something which looks like a Linux symlink.  The way it tries to do "
34588 "the rewriting is described here:"
34589 msgstr ""
34590
34591 #. type: textblock
34592 #: ../src/guestfs.pod:685
34593 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
34594 msgstr ""
34595
34596 #. type: textblock
34597 #: ../src/guestfs.pod:687
34598 msgid ""
34599 "The essential problem is that ntfs-3g simply does not have enough "
34600 "information to do a correct job.  NTFS links can contain drive letters and "
34601 "references to external device GUIDs that ntfs-3g has no way of resolving.  "
34602 "It is almost certainly the case that libguestfs callers should ignore what "
34603 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
34604 msgstr ""
34605
34606 #. type: textblock
34607 #: ../src/guestfs.pod:694
34608 msgid ""
34609 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
34610 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
34611 "attribute, and read the raw reparse data from that (you can find the format "
34612 "documented in various places around the web)."
34613 msgstr ""
34614
34615 #. type: =head3
34616 #: ../src/guestfs.pod:699
34617 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
34618 msgstr ""
34619
34620 #. type: textblock
34621 #: ../src/guestfs.pod:701
34622 msgid ""
34623 "There are other useful extended attributes that can be read from ntfs-3g "
34624 "filesystems (using L</guestfs_getxattr>).  See:"
34625 msgstr ""
34626
34627 #. type: textblock
34628 #: ../src/guestfs.pod:704
34629 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
34630 msgstr ""
34631
34632 #. type: =head2
34633 #: ../src/guestfs.pod:706
34634 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
34635 msgstr ""
34636
34637 #. type: textblock
34638 #: ../src/guestfs.pod:708
34639 msgid ""
34640 "Although we don't want to discourage you from using the C API, we will "
34641 "mention here that the same API is also available in other languages."
34642 msgstr ""
34643
34644 #. type: textblock
34645 #: ../src/guestfs.pod:711
34646 msgid ""
34647 "The API is broadly identical in all supported languages.  This means that "
34648 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
34649 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
34650 "OCaml.  In other words, a straightforward, predictable isomorphism between "
34651 "each language."
34652 msgstr ""
34653
34654 #. type: textblock
34655 #: ../src/guestfs.pod:717
34656 msgid ""
34657 "Error messages are automatically transformed into exceptions if the language "
34658 "supports it."
34659 msgstr ""
34660
34661 #. type: textblock
34662 #: ../src/guestfs.pod:720
34663 msgid ""
34664 "We don't try to \"object orientify\" parts of the API in OO languages, "
34665 "although contributors are welcome to write higher level APIs above what we "
34666 "provide in their favourite languages if they wish."
34667 msgstr ""
34668
34669 #. type: =item
34670 #: ../src/guestfs.pod:726
34671 msgid "B<C++>"
34672 msgstr ""
34673
34674 #. type: textblock
34675 #: ../src/guestfs.pod:728
34676 msgid ""
34677 "You can use the I<guestfs.h> header file from C++ programs.  The C++ API is "
34678 "identical to the C API.  C++ classes and exceptions are not used."
34679 msgstr ""
34680
34681 #. type: =item
34682 #: ../src/guestfs.pod:732
34683 msgid "B<C#>"
34684 msgstr ""
34685
34686 #. type: textblock
34687 #: ../src/guestfs.pod:734
34688 msgid ""
34689 "The C# bindings are highly experimental.  Please read the warnings at the "
34690 "top of C<csharp/Libguestfs.cs>."
34691 msgstr ""
34692
34693 #. type: =item
34694 #: ../src/guestfs.pod:737
34695 msgid "B<Erlang>"
34696 msgstr ""
34697
34698 #. type: textblock
34699 #: ../src/guestfs.pod:739
34700 msgid "See L<guestfs-erlang(3)>."
34701 msgstr ""
34702
34703 #. type: =item
34704 #: ../src/guestfs.pod:741
34705 msgid "B<Haskell>"
34706 msgstr ""
34707
34708 #. type: textblock
34709 #: ../src/guestfs.pod:743
34710 msgid ""
34711 "This is the only language binding that is working but incomplete.  Only "
34712 "calls which return simple integers have been bound in Haskell, and we are "
34713 "looking for help to complete this binding."
34714 msgstr ""
34715
34716 #. type: =item
34717 #: ../src/guestfs.pod:747
34718 msgid "B<Java>"
34719 msgstr ""
34720
34721 #. type: textblock
34722 #: ../src/guestfs.pod:749
34723 msgid ""
34724 "Full documentation is contained in the Javadoc which is distributed with "
34725 "libguestfs.  For examples, see L<guestfs-java(3)>."
34726 msgstr ""
34727
34728 #. type: =item
34729 #: ../src/guestfs.pod:752
34730 msgid "B<OCaml>"
34731 msgstr ""
34732
34733 #. type: textblock
34734 #: ../src/guestfs.pod:754
34735 msgid "See L<guestfs-ocaml(3)>."
34736 msgstr ""
34737
34738 #. type: =item
34739 #: ../src/guestfs.pod:756
34740 msgid "B<Perl>"
34741 msgstr ""
34742
34743 #. type: textblock
34744 #: ../src/guestfs.pod:758
34745 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
34746 msgstr ""
34747
34748 #. type: =item
34749 #: ../src/guestfs.pod:760
34750 msgid "B<PHP>"
34751 msgstr ""
34752
34753 #. type: textblock
34754 #: ../src/guestfs.pod:762
34755 msgid ""
34756 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
34757 "the php-libguestfs package for your distribution."
34758 msgstr ""
34759
34760 #. type: textblock
34761 #: ../src/guestfs.pod:765
34762 msgid "The PHP binding only works correctly on 64 bit machines."
34763 msgstr ""
34764
34765 #. type: =item
34766 #: ../src/guestfs.pod:767
34767 msgid "B<Python>"
34768 msgstr ""
34769
34770 #. type: textblock
34771 #: ../src/guestfs.pod:769
34772 msgid "See L<guestfs-python(3)>."
34773 msgstr ""
34774
34775 #. type: =item
34776 #: ../src/guestfs.pod:771
34777 msgid "B<Ruby>"
34778 msgstr ""
34779
34780 #. type: textblock
34781 #: ../src/guestfs.pod:773
34782 msgid "See L<guestfs-ruby(3)>."
34783 msgstr ""
34784
34785 #. type: =item
34786 #: ../src/guestfs.pod:775
34787 msgid "B<shell scripts>"
34788 msgstr ""
34789
34790 #. type: textblock
34791 #: ../src/guestfs.pod:777
34792 msgid "See L<guestfish(1)>."
34793 msgstr ""
34794
34795 #. type: =head2
34796 #: ../src/guestfs.pod:781
34797 msgid "LIBGUESTFS GOTCHAS"
34798 msgstr ""
34799
34800 #. type: textblock
34801 #: ../src/guestfs.pod:783
34802 msgid ""
34803 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
34804 "system [...] that works in the way it is documented but is counterintuitive "
34805 "and almost invites mistakes.\""
34806 msgstr ""
34807
34808 #. type: textblock
34809 #: ../src/guestfs.pod:787
34810 msgid ""
34811 "Since we developed libguestfs and the associated tools, there are several "
34812 "things we would have designed differently, but are now stuck with for "
34813 "backwards compatibility or other reasons.  If there is ever a libguestfs 2.0 "
34814 "release, you can expect these to change.  Beware of them."
34815 msgstr ""
34816
34817 #. type: =item
34818 #: ../src/guestfs.pod:795
34819 msgid "Autosync / forgetting to sync."
34820 msgstr ""
34821
34822 #. type: textblock
34823 #: ../src/guestfs.pod:797
34824 msgid ""
34825 "I<Update:> Autosync is enabled by default for all API users starting from "
34826 "libguestfs 1.5.24.  This section only applies to older versions."
34827 msgstr ""
34828
34829 #. type: textblock
34830 #: ../src/guestfs.pod:800
34831 msgid ""
34832 "When modifying a filesystem from C or another language, you B<must> unmount "
34833 "all filesystems and call L</guestfs_sync> explicitly before you close the "
34834 "libguestfs handle.  You can also call:"
34835 msgstr ""
34836
34837 #. type: verbatim
34838 #: ../src/guestfs.pod:804
34839 #, no-wrap
34840 msgid ""
34841 " guestfs_set_autosync (g, 1);\n"
34842 "\n"
34843 msgstr ""
34844
34845 #. type: textblock
34846 #: ../src/guestfs.pod:806
34847 msgid ""
34848 "to have the unmount/sync done automatically for you when the handle 'g' is "
34849 "closed.  (This feature is called \"autosync\", L</guestfs_set_autosync> "
34850 "q.v.)"
34851 msgstr ""
34852
34853 #. type: textblock
34854 #: ../src/guestfs.pod:810
34855 msgid ""
34856 "If you forget to do this, then it is entirely possible that your changes "
34857 "won't be written out, or will be partially written, or (very rarely) that "
34858 "you'll get disk corruption."
34859 msgstr ""
34860
34861 #. type: textblock
34862 #: ../src/guestfs.pod:814
34863 msgid ""
34864 "Note that in L<guestfish(3)> autosync is the default.  So quick and dirty "
34865 "guestfish scripts that forget to sync will work just fine, which can make "
34866 "this very puzzling if you are trying to debug a problem."
34867 msgstr ""
34868
34869 #. type: =item
34870 #: ../src/guestfs.pod:818
34871 msgid "Mount option C<-o sync> should not be the default."
34872 msgstr ""
34873
34874 #. type: textblock
34875 #: ../src/guestfs.pod:820
34876 msgid ""
34877 "I<Update:> L</guestfs_mount> no longer adds any options starting from "
34878 "libguestfs 1.13.16.  This section only applies to older versions."
34879 msgstr ""
34880
34881 #. type: textblock
34882 #: ../src/guestfs.pod:823
34883 msgid ""
34884 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly.  "
34885 "However C<-o sync> does not add any reliability benefit, but does have a "
34886 "very large performance impact."
34887 msgstr ""
34888
34889 #. type: textblock
34890 #: ../src/guestfs.pod:827
34891 msgid ""
34892 "The work around is to use L</guestfs_mount_options> and set the mount "
34893 "options that you actually want to use."
34894 msgstr ""
34895
34896 #. type: =item
34897 #: ../src/guestfs.pod:830
34898 msgid "Read-only should be the default."
34899 msgstr ""
34900
34901 #. type: textblock
34902 #: ../src/guestfs.pod:832
34903 msgid ""
34904 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
34905 "specify I<--rw> if you want to make changes to the image."
34906 msgstr ""
34907
34908 #. type: textblock
34909 #: ../src/guestfs.pod:835
34910 msgid "This would reduce the potential to corrupt live VM images."
34911 msgstr ""
34912
34913 #. type: textblock
34914 #: ../src/guestfs.pod:837
34915 msgid ""
34916 "Note that many filesystems change the disk when you just mount and unmount, "
34917 "even if you didn't perform any writes.  You need to use "
34918 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
34919 msgstr ""
34920
34921 #. type: =item
34922 #: ../src/guestfs.pod:841
34923 msgid "guestfish command line is hard to use."
34924 msgstr ""
34925
34926 #. type: textblock
34927 #: ../src/guestfs.pod:843
34928 msgid ""
34929 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
34930 "examination).  It tries to run a guestfish command C<disk.img> which doesn't "
34931 "exist, so it fails.  In earlier versions of guestfish the error message was "
34932 "also unintuitive, but we have corrected this since.  Like the Bourne shell, "
34933 "we should have used C<guestfish -c command> to run commands."
34934 msgstr ""
34935
34936 #. type: =item
34937 #: ../src/guestfs.pod:850
34938 msgid "guestfish megabyte modifiers don't work right on all commands"
34939 msgstr ""
34940
34941 #. type: textblock
34942 #: ../src/guestfs.pod:852
34943 msgid ""
34944 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
34945 "other modifiers).  What guestfish actually does is to multiply the number "
34946 "part by the modifier part and pass the result to the C API.  However this "
34947 "doesn't work for a few APIs which aren't expecting bytes, but are already "
34948 "expecting some other unit (eg. megabytes)."
34949 msgstr ""
34950
34951 #. type: textblock
34952 #: ../src/guestfs.pod:859
34953 msgid "The most common is L</guestfs_lvcreate>.  The guestfish command:"
34954 msgstr ""
34955
34956 #. type: verbatim
34957 #: ../src/guestfs.pod:861
34958 #, no-wrap
34959 msgid ""
34960 " lvcreate LV VG 100M\n"
34961 "\n"
34962 msgstr ""
34963
34964 #. type: textblock
34965 #: ../src/guestfs.pod:863
34966 msgid ""
34967 "does not do what you might expect.  Instead because L</guestfs_lvcreate> is "
34968 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
34969 "megabytes * megabytes) logical volume.  The error message you get from this "
34970 "is also a little obscure."
34971 msgstr ""
34972
34973 #. type: textblock
34974 #: ../src/guestfs.pod:868
34975 msgid ""
34976 "This could be fixed in the generator by specially marking parameters and "
34977 "return values which take bytes or other units."
34978 msgstr ""
34979
34980 #. type: =item
34981 #: ../src/guestfs.pod:871
34982 msgid "Ambiguity between devices and paths"
34983 msgstr ""
34984
34985 #. type: textblock
34986 #: ../src/guestfs.pod:873
34987 msgid ""
34988 "There is a subtle ambiguity in the API between a device name "
34989 "(eg. C</dev/sdb2>) and a similar pathname.  A file might just happen to be "
34990 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
34991 msgstr ""
34992
34993 #. type: textblock
34994 #: ../src/guestfs.pod:878
34995 msgid ""
34996 "In the current API we usually resolve this ambiguity by having two separate "
34997 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>.  "
34998 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
34999 "detecting if the path supplied begins with C</dev/>."
35000 msgstr ""
35001
35002 #. type: textblock
35003 #: ../src/guestfs.pod:884
35004 msgid ""
35005 "To avoid both the ambiguity and the need to duplicate some calls, we could "
35006 "make paths/devices into structured names.  One way to do this would be to "
35007 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
35008 "aspect of grub.  Another way would be to use a structured type, equivalent "
35009 "to this OCaml type:"
35010 msgstr ""
35011
35012 #. type: verbatim
35013 #: ../src/guestfs.pod:890
35014 #, no-wrap
35015 msgid ""
35016 " type path = Path of string | Device of int | Partition of int * int\n"
35017 "\n"
35018 msgstr ""
35019
35020 #. type: textblock
35021 #: ../src/guestfs.pod:892
35022 msgid "which would allow you to pass arguments like:"
35023 msgstr ""
35024
35025 #. type: verbatim
35026 #: ../src/guestfs.pod:894
35027 #, no-wrap
35028 msgid ""
35029 " Path \"/foo/bar\"\n"
35030 " Device 1            (* /dev/sdb, or perhaps /dev/sda *)\n"
35031 " Partition (1, 2)    (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
35032 " Path \"/dev/sdb2\"    (* not a device *)\n"
35033 "\n"
35034 msgstr ""
35035
35036 #. type: textblock
35037 #: ../src/guestfs.pod:899
35038 msgid ""
35039 "As you can see there are still problems to resolve even with this "
35040 "representation.  Also consider how it might work in guestfish."
35041 msgstr ""
35042
35043 #. type: =head2
35044 #: ../src/guestfs.pod:904
35045 msgid "KEYS AND PASSPHRASES"
35046 msgstr ""
35047
35048 #. type: textblock
35049 #: ../src/guestfs.pod:906
35050 msgid ""
35051 "Certain libguestfs calls take a parameter that contains sensitive key "
35052 "material, passed in as a C string."
35053 msgstr ""
35054
35055 #. type: textblock
35056 #: ../src/guestfs.pod:909
35057 msgid ""
35058 "In the future we would hope to change the libguestfs implementation so that "
35059 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
35060 "swap.  However this is I<not> done at the moment, because of the complexity "
35061 "of such an implementation."
35062 msgstr ""
35063
35064 #. type: textblock
35065 #: ../src/guestfs.pod:914
35066 msgid ""
35067 "Therefore you should be aware that any key parameter you pass to libguestfs "
35068 "might end up being written out to the swap partition.  If this is a concern, "
35069 "scrub the swap partition or don't use libguestfs on encrypted devices."
35070 msgstr ""
35071
35072 #. type: =head2
35073 #: ../src/guestfs.pod:919
35074 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
35075 msgstr ""
35076
35077 #. type: textblock
35078 #: ../src/guestfs.pod:921
35079 msgid ""
35080 "All high-level libguestfs actions are synchronous.  If you want to use "
35081 "libguestfs asynchronously then you must create a thread."
35082 msgstr ""
35083
35084 #. type: textblock
35085 #: ../src/guestfs.pod:924
35086 msgid ""
35087 "Only use the handle from a single thread.  Either use the handle exclusively "
35088 "from one thread, or provide your own mutex so that two threads cannot issue "
35089 "calls on the same handle at the same time."
35090 msgstr ""
35091
35092 #. type: textblock
35093 #: ../src/guestfs.pod:928
35094 msgid ""
35095 "See the graphical program guestfs-browser for one possible architecture for "
35096 "multithreaded programs using libvirt and libguestfs."
35097 msgstr ""
35098
35099 #. type: =head2
35100 #: ../src/guestfs.pod:931
35101 msgid "PATH"
35102 msgstr ""
35103
35104 #. type: textblock
35105 #: ../src/guestfs.pod:933
35106 msgid ""
35107 "Libguestfs needs a supermin appliance, which it finds by looking along an "
35108 "internal path."
35109 msgstr ""
35110
35111 #. type: textblock
35112 #: ../src/guestfs.pod:936
35113 msgid ""
35114 "By default it looks for these in the directory C<$libdir/guestfs> "
35115 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
35116 msgstr ""
35117
35118 #. type: textblock
35119 #: ../src/guestfs.pod:939
35120 msgid ""
35121 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
35122 "to change the directories that libguestfs will search in.  The value is a "
35123 "colon-separated list of paths.  The current directory is I<not> searched "
35124 "unless the path contains an empty element or C<.>.  For example "
35125 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
35126 "then C</usr/lib/guestfs>."
35127 msgstr ""
35128
35129 #. type: =head2
35130 #: ../src/guestfs.pod:946
35131 msgid "QEMU WRAPPERS"
35132 msgstr ""
35133
35134 #. type: textblock
35135 #: ../src/guestfs.pod:948
35136 msgid ""
35137 "If you want to compile your own qemu, run qemu from a non-standard location, "
35138 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
35139 "around qemu."
35140 msgstr ""
35141
35142 #. type: textblock
35143 #: ../src/guestfs.pod:952
35144 msgid ""
35145 "There is one important rule to remember: you I<must C<exec qemu>> as the "
35146 "last command in the shell script (so that qemu replaces the shell and "
35147 "becomes the direct child of the libguestfs-using program).  If you don't do "
35148 "this, then the qemu process won't be cleaned up correctly."
35149 msgstr ""
35150
35151 #. type: textblock
35152 #: ../src/guestfs.pod:957
35153 msgid ""
35154 "Here is an example of a wrapper, where I have built my own copy of qemu from "
35155 "source:"
35156 msgstr ""
35157
35158 #. type: verbatim
35159 #: ../src/guestfs.pod:960
35160 #, no-wrap
35161 msgid ""
35162 " #!/bin/sh -\n"
35163 " qemudir=/home/rjones/d/qemu\n"
35164 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
35165 "\"$@\"\n"
35166 "\n"
35167 msgstr ""
35168
35169 #. type: textblock
35170 #: ../src/guestfs.pod:964
35171 msgid ""
35172 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
35173 "then use it by setting the LIBGUESTFS_QEMU environment variable.  For "
35174 "example:"
35175 msgstr ""
35176
35177 #. type: verbatim
35178 #: ../src/guestfs.pod:968
35179 #, no-wrap
35180 msgid ""
35181 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
35182 "\n"
35183 msgstr ""
35184
35185 #. type: textblock
35186 #: ../src/guestfs.pod:970
35187 msgid ""
35188 "Note that libguestfs also calls qemu with the -help and -version options in "
35189 "order to determine features."
35190 msgstr ""
35191
35192 #. type: textblock
35193 #: ../src/guestfs.pod:973
35194 msgid ""
35195 "Wrappers can also be used to edit the options passed to qemu.  In the "
35196 "following example, the C<-machine ...> option (C<-machine> and the following "
35197 "argument) are removed from the command line and replaced with C<-machine "
35198 "pc,accel=tcg>.  The while loop iterates over the options until it finds the "
35199 "right one to remove, putting the remaining options into the C<args> array."
35200 msgstr ""
35201
35202 #. type: verbatim
35203 #: ../src/guestfs.pod:982
35204 #, no-wrap
35205 msgid ""
35206 " i=0\n"
35207 " while [ $# -gt 0 ]; do\n"
35208 "     case \"$1\" in\n"
35209 "     -machine)\n"
35210 "         shift 2;;\n"
35211 "     *)\n"
35212 "         args[i]=\"$1\"\n"
35213 "         (( i++ ))\n"
35214 "         shift ;;\n"
35215 "     esac\n"
35216 " done\n"
35217 " \n"
35218 msgstr ""
35219
35220 #. type: verbatim
35221 #: ../src/guestfs.pod:994
35222 #, no-wrap
35223 msgid ""
35224 " exec qemu-kvm -machine pc,accel=tcg \"${args[@]}\"\n"
35225 "\n"
35226 msgstr ""
35227
35228 #. type: =head2
35229 #: ../src/guestfs.pod:996
35230 msgid "ATTACHING TO RUNNING DAEMONS"
35231 msgstr ""
35232
35233 #. type: textblock
35234 #: ../src/guestfs.pod:998
35235 msgid ""
35236 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
35237 "babies.  Use with caution."
35238 msgstr ""
35239
35240 #. type: textblock
35241 #: ../src/guestfs.pod:1001
35242 msgid ""
35243 "I<Note (2):> This section explains how to attach to a running daemon from a "
35244 "low level perspective.  For most users, simply using virt tools such as "
35245 "L<guestfish(1)> with the I<--live> option will \"just work\"."
35246 msgstr ""
35247
35248 #. type: =head3
35249 #: ../src/guestfs.pod:1005
35250 msgid "Using guestfs_set_attach_method"
35251 msgstr ""
35252
35253 #. type: textblock
35254 #: ../src/guestfs.pod:1007
35255 msgid ""
35256 "By calling L</guestfs_set_attach_method> you can change how the library "
35257 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
35258 "L</ARCHITECTURE> for some background)."
35259 msgstr ""
35260
35261 #. type: textblock
35262 #: ../src/guestfs.pod:1011
35263 msgid ""
35264 "The normal attach method is C<appliance>, where a small appliance is created "
35265 "containing the daemon, and then the library connects to this."
35266 msgstr ""
35267
35268 #. type: textblock
35269 #: ../src/guestfs.pod:1014
35270 msgid ""
35271 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
35272 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
35273 "daemon over the Unix domain socket."
35274 msgstr ""
35275
35276 #. type: textblock
35277 #: ../src/guestfs.pod:1018
35278 msgid ""
35279 "The normal use for this is to connect to a running virtual machine that "
35280 "contains a C<guestfsd> daemon, and send commands so you can read and write "
35281 "files inside the live virtual machine."
35282 msgstr ""
35283
35284 #. type: =head3
35285 #: ../src/guestfs.pod:1022
35286 msgid "Using guestfs_add_domain with live flag"
35287 msgstr ""
35288
35289 #. type: textblock
35290 #: ../src/guestfs.pod:1024
35291 msgid ""
35292 "L</guestfs_add_domain> provides some help for getting the correct attach "
35293 "method.  If you pass the C<live> option to this function, then (if the "
35294 "virtual machine is running) it will examine the libvirt XML looking for a "
35295 "virtio-serial channel to connect to:"
35296 msgstr ""
35297
35298 #. type: verbatim
35299 #: ../src/guestfs.pod:1030
35300 #, no-wrap
35301 msgid ""
35302 " <domain>\n"
35303 "   ...\n"
35304 "   <devices>\n"
35305 "     ...\n"
35306 "     <channel type='unix'>\n"
35307 "       <source mode='bind' path='/path/to/socket'/>\n"
35308 "       <target type='virtio' name='org.libguestfs.channel.0'/>\n"
35309 "     </channel>\n"
35310 "     ...\n"
35311 "   </devices>\n"
35312 " </domain>\n"
35313 "\n"
35314 msgstr ""
35315
35316 #. type: textblock
35317 #: ../src/guestfs.pod:1042
35318 msgid ""
35319 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
35320 "method to C<unix:/path/to/socket>."
35321 msgstr ""
35322
35323 #. type: textblock
35324 #: ../src/guestfs.pod:1045
35325 msgid ""
35326 "Some of the libguestfs tools (including guestfish) support a I<--live> "
35327 "option which is passed through to L</guestfs_add_domain> thus allowing you "
35328 "to attach to and modify live virtual machines."
35329 msgstr ""
35330
35331 #. type: textblock
35332 #: ../src/guestfs.pod:1049
35333 msgid ""
35334 "The virtual machine needs to have been set up beforehand so that it has the "
35335 "virtio-serial channel and so that guestfsd is running inside it."
35336 msgstr ""
35337
35338 #. type: =head2
35339 #: ../src/guestfs.pod:1053
35340 msgid "ABI GUARANTEE"
35341 msgstr ""
35342
35343 #. type: textblock
35344 #: ../src/guestfs.pod:1055
35345 msgid ""
35346 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
35347 "actions as outlined in this section.  Although we will deprecate some "
35348 "actions, for example if they get replaced by newer calls, we will keep the "
35349 "old actions forever.  This allows you the developer to program in confidence "
35350 "against the libguestfs API."
35351 msgstr ""
35352
35353 #. type: =head2
35354 #: ../src/guestfs.pod:1061
35355 msgid "BLOCK DEVICE NAMING"
35356 msgstr ""
35357
35358 #. type: textblock
35359 #: ../src/guestfs.pod:1063
35360 msgid ""
35361 "In the kernel there is now quite a profusion of schemata for naming block "
35362 "devices (in this context, by I<block device> I mean a physical or virtual "
35363 "hard drive).  The original Linux IDE driver used names starting with "
35364 "C</dev/hd*>.  SCSI devices have historically used a different naming scheme, "
35365 "C</dev/sd*>.  When the Linux kernel I<libata> driver became a popular "
35366 "replacement for the old IDE driver (particularly for SATA devices) those "
35367 "devices also used the C</dev/sd*> scheme.  Additionally we now have virtual "
35368 "machines with paravirtualized drivers.  This has created several different "
35369 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
35370 "Xen PV disks."
35371 msgstr ""
35372
35373 #. type: textblock
35374 #: ../src/guestfs.pod:1075
35375 msgid ""
35376 "As discussed above, libguestfs uses a qemu appliance running an embedded "
35377 "Linux kernel to access block devices.  We can run a variety of appliances "
35378 "based on a variety of Linux kernels."
35379 msgstr ""
35380
35381 #. type: textblock
35382 #: ../src/guestfs.pod:1079
35383 msgid ""
35384 "This causes a problem for libguestfs because many API calls use device or "
35385 "partition names.  Working scripts and the recipe (example) scripts that we "
35386 "make available over the internet could fail if the naming scheme changes."
35387 msgstr ""
35388
35389 #. type: textblock
35390 #: ../src/guestfs.pod:1084
35391 msgid ""
35392 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>.  "
35393 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
35394 "required.  For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
35395 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
35396 msgstr ""
35397
35398 #. type: textblock
35399 #: ../src/guestfs.pod:1090
35400 msgid ""
35401 "Note that this I<only> applies to parameters.  The L</guestfs_list_devices>, "
35402 "L</guestfs_list_partitions> and similar calls return the true names of the "
35403 "devices and partitions as known to the appliance."
35404 msgstr ""
35405
35406 #. type: =head3
35407 #: ../src/guestfs.pod:1095
35408 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
35409 msgstr ""
35410
35411 #. type: textblock
35412 #: ../src/guestfs.pod:1097
35413 msgid ""
35414 "Usually this translation is transparent.  However in some (very rare)  cases "
35415 "you may need to know the exact algorithm.  Such cases include where you use "
35416 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
35417 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
35418 "devices."
35419 msgstr ""
35420
35421 #. type: textblock
35422 #: ../src/guestfs.pod:1103
35423 msgid ""
35424 "The algorithm is applied only to I<parameters> which are known to be either "
35425 "device or partition names.  Return values from functions such as "
35426 "L</guestfs_list_devices> are never changed."
35427 msgstr ""
35428
35429 #. type: textblock
35430 #: ../src/guestfs.pod:1111
35431 msgid "Is the string a parameter which is a device or partition name?"
35432 msgstr ""
35433
35434 #. type: textblock
35435 #: ../src/guestfs.pod:1115
35436 msgid "Does the string begin with C</dev/sd>?"
35437 msgstr ""
35438
35439 #. type: textblock
35440 #: ../src/guestfs.pod:1119
35441 msgid ""
35442 "Does the named device exist? If so, we use that device.  However if I<not> "
35443 "then we continue with this algorithm."
35444 msgstr ""
35445
35446 #. type: textblock
35447 #: ../src/guestfs.pod:1124
35448 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
35449 msgstr ""
35450
35451 #. type: textblock
35452 #: ../src/guestfs.pod:1126
35453 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
35454 msgstr ""
35455
35456 #. type: textblock
35457 #: ../src/guestfs.pod:1128
35458 msgid "If that named device exists, use it.  If not, continue."
35459 msgstr ""
35460
35461 #. type: textblock
35462 #: ../src/guestfs.pod:1132
35463 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
35464 msgstr ""
35465
35466 #. type: textblock
35467 #: ../src/guestfs.pod:1134
35468 msgid "If that named device exists, use it.  If not, return an error."
35469 msgstr ""
35470
35471 #. type: =head3
35472 #: ../src/guestfs.pod:1138
35473 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
35474 msgstr ""
35475
35476 #. type: textblock
35477 #: ../src/guestfs.pod:1140
35478 msgid ""
35479 "Although the standard naming scheme and automatic translation is useful for "
35480 "simple programs and guestfish scripts, for larger programs it is best not to "
35481 "rely on this mechanism."
35482 msgstr ""
35483
35484 #. type: textblock
35485 #: ../src/guestfs.pod:1144
35486 msgid ""
35487 "Where possible for maximum future portability programs using libguestfs "
35488 "should use these future-proof techniques:"
35489 msgstr ""
35490
35491 #. type: textblock
35492 #: ../src/guestfs.pod:1151
35493 msgid ""
35494 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
35495 "device names, and then use those names directly."
35496 msgstr ""
35497
35498 #. type: textblock
35499 #: ../src/guestfs.pod:1154
35500 msgid "Since those device names exist by definition, they will never be translated."
35501 msgstr ""
35502
35503 #. type: textblock
35504 #: ../src/guestfs.pod:1159
35505 msgid ""
35506 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
35507 "filesystem labels."
35508 msgstr ""
35509
35510 #. type: textblock
35511 #: ../src/guestfs.pod:1166
35512 msgid ""
35513 "This section discusses security implications of using libguestfs, "
35514 "particularly with untrusted or malicious guests or disk images."
35515 msgstr ""
35516
35517 #. type: =head2
35518 #: ../src/guestfs.pod:1169
35519 msgid "GENERAL SECURITY CONSIDERATIONS"
35520 msgstr ""
35521
35522 #. type: textblock
35523 #: ../src/guestfs.pod:1171
35524 msgid ""
35525 "Be careful with any files or data that you download from a guest (by "
35526 "\"download\" we mean not just the L</guestfs_download> command but any "
35527 "command that reads files, filenames, directories or anything else from a "
35528 "disk image).  An attacker could manipulate the data to fool your program "
35529 "into doing the wrong thing.  Consider cases such as:"
35530 msgstr ""
35531
35532 #. type: textblock
35533 #: ../src/guestfs.pod:1181
35534 msgid "the data (file etc) not being present"
35535 msgstr ""
35536
35537 #. type: textblock
35538 #: ../src/guestfs.pod:1185
35539 msgid "being present but empty"
35540 msgstr ""
35541
35542 #. type: textblock
35543 #: ../src/guestfs.pod:1189
35544 msgid "being much larger than normal"
35545 msgstr ""
35546
35547 #. type: textblock
35548 #: ../src/guestfs.pod:1193
35549 msgid "containing arbitrary 8 bit data"
35550 msgstr ""
35551
35552 #. type: textblock
35553 #: ../src/guestfs.pod:1197
35554 msgid "being in an unexpected character encoding"
35555 msgstr ""
35556
35557 #. type: textblock
35558 #: ../src/guestfs.pod:1201
35559 msgid "containing homoglyphs."
35560 msgstr ""
35561
35562 #. type: =head2
35563 #: ../src/guestfs.pod:1205
35564 msgid "SECURITY OF MOUNTING FILESYSTEMS"
35565 msgstr ""
35566
35567 #. type: textblock
35568 #: ../src/guestfs.pod:1207
35569 msgid ""
35570 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
35571 "(VFS) module can sometimes be escalated into exploits by deliberately "
35572 "creating a malicious, malformed filesystem.  These exploits are very severe "
35573 "for two reasons.  Firstly there are very many filesystem drivers in the "
35574 "kernel, and many of them are infrequently used and not much developer "
35575 "attention has been paid to the code.  Linux userspace helps potential "
35576 "crackers by detecting the filesystem type and automatically choosing the "
35577 "right VFS driver, even if that filesystem type is obscure or unexpected for "
35578 "the administrator.  Secondly, a kernel-level exploit is like a local root "
35579 "exploit (worse in some ways), giving immediate and total access to the "
35580 "system right down to the hardware level."
35581 msgstr ""
35582
35583 #. type: textblock
35584 #: ../src/guestfs.pod:1220
35585 msgid ""
35586 "That explains why you should never mount a filesystem from an untrusted "
35587 "guest on your host kernel.  How about libguestfs? We run a Linux kernel "
35588 "inside a qemu virtual machine, usually running as a non-root user.  The "
35589 "attacker would need to write a filesystem which first exploited the kernel, "
35590 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
35591 "the libguestfs protocol, and finally to be as serious as the host kernel "
35592 "exploit it would need to escalate its privileges to root.  This multi-step "
35593 "escalation, performed by a static piece of data, is thought to be extremely "
35594 "hard to do, although we never say 'never' about security issues."
35595 msgstr ""
35596
35597 #. type: textblock
35598 #: ../src/guestfs.pod:1231
35599 msgid ""
35600 "In any case callers can reduce the attack surface by forcing the filesystem "
35601 "type when mounting (use L</guestfs_mount_vfs>)."
35602 msgstr ""
35603
35604 #. type: =head2
35605 #: ../src/guestfs.pod:1234
35606 msgid "PROTOCOL SECURITY"
35607 msgstr ""
35608
35609 #. type: textblock
35610 #: ../src/guestfs.pod:1236
35611 msgid ""
35612 "The protocol is designed to be secure, being based on RFC 4506 (XDR)  with a "
35613 "defined upper message size.  However a program that uses libguestfs must "
35614 "also take care - for example you can write a program that downloads a binary "
35615 "from a disk image and executes it locally, and no amount of protocol "
35616 "security will save you from the consequences."
35617 msgstr ""
35618
35619 #. type: =head2
35620 #: ../src/guestfs.pod:1242
35621 msgid "INSPECTION SECURITY"
35622 msgstr ""
35623
35624 #. type: textblock
35625 #: ../src/guestfs.pod:1244
35626 msgid ""
35627 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
35628 "directly from the guest, and these could contain any 8 bit data.  Callers "
35629 "should be careful to escape these before printing them to a structured file "
35630 "(for example, use HTML escaping if creating a web page)."
35631 msgstr ""
35632
35633 #. type: textblock
35634 #: ../src/guestfs.pod:1250
35635 msgid ""
35636 "Guest configuration may be altered in unusual ways by the administrator of "
35637 "the virtual machine, and may not reflect reality (particularly for untrusted "
35638 "or actively malicious guests).  For example we parse the hostname from "
35639 "configuration files like C</etc/sysconfig/network> that we find in the "
35640 "guest, but the guest administrator can easily manipulate these files to "
35641 "provide the wrong hostname."
35642 msgstr ""
35643
35644 #. type: textblock
35645 #: ../src/guestfs.pod:1258
35646 msgid ""
35647 "The inspection API parses guest configuration using two external libraries: "
35648 "Augeas (Linux configuration) and hivex (Windows Registry).  Both are "
35649 "designed to be robust in the face of malicious data, although denial of "
35650 "service attacks are still possible, for example with oversized configuration "
35651 "files."
35652 msgstr ""
35653
35654 #. type: =head2
35655 #: ../src/guestfs.pod:1264
35656 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
35657 msgstr ""
35658
35659 #. type: textblock
35660 #: ../src/guestfs.pod:1266
35661 msgid ""
35662 "Be very cautious about running commands from the guest.  By running a "
35663 "command in the guest, you are giving CPU time to a binary that you do not "
35664 "control, under the same user account as the library, albeit wrapped in qemu "
35665 "virtualization.  More information and alternatives can be found in the "
35666 "section L</RUNNING COMMANDS>."
35667 msgstr ""
35668
35669 #. type: =head2
35670 #: ../src/guestfs.pod:1272
35671 msgid "CVE-2010-3851"
35672 msgstr ""
35673
35674 #. type: textblock
35675 #: ../src/guestfs.pod:1274
35676 msgid "https://bugzilla.redhat.com/642934"
35677 msgstr ""
35678
35679 #. type: textblock
35680 #: ../src/guestfs.pod:1276
35681 msgid ""
35682 "This security bug concerns the automatic disk format detection that qemu "
35683 "does on disk images."
35684 msgstr ""
35685
35686 #. type: textblock
35687 #: ../src/guestfs.pod:1279
35688 msgid ""
35689 "A raw disk image is just the raw bytes, there is no header.  Other disk "
35690 "images like qcow2 contain a special header.  Qemu deals with this by looking "
35691 "for one of the known headers, and if none is found then assuming the disk "
35692 "image must be raw."
35693 msgstr ""
35694
35695 #. type: textblock
35696 #: ../src/guestfs.pod:1284
35697 msgid ""
35698 "This allows a guest which has been given a raw disk image to write some "
35699 "other header.  At next boot (or when the disk image is accessed by "
35700 "libguestfs) qemu would do autodetection and think the disk image format was, "
35701 "say, qcow2 based on the header written by the guest."
35702 msgstr ""
35703
35704 #. type: textblock
35705 #: ../src/guestfs.pod:1289
35706 msgid ""
35707 "This in itself would not be a problem, but qcow2 offers many features, one "
35708 "of which is to allow a disk image to refer to another image (called the "
35709 "\"backing disk\").  It does this by placing the path to the backing disk "
35710 "into the qcow2 header.  This path is not validated and could point to any "
35711 "host file (eg. \"/etc/passwd\").  The backing disk is then exposed through "
35712 "\"holes\" in the qcow2 disk image, which of course is completely under the "
35713 "control of the attacker."
35714 msgstr ""
35715
35716 #. type: textblock
35717 #: ../src/guestfs.pod:1297
35718 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
35719 msgstr ""
35720
35721 #. type: textblock
35722 #: ../src/guestfs.pod:1304
35723 msgid "You have enabled the network or have opened the disk in write mode."
35724 msgstr ""
35725
35726 #. type: textblock
35727 #: ../src/guestfs.pod:1308
35728 msgid ""
35729 "You are also running untrusted code from the guest (see L</RUNNING "
35730 "COMMANDS>)."
35731 msgstr ""
35732
35733 #. type: textblock
35734 #: ../src/guestfs.pod:1313
35735 msgid ""
35736 "The way to avoid this is to specify the expected disk format when adding "
35737 "disks (the optional C<format> option to L</guestfs_add_drive_opts>).  You "
35738 "should always do this if the disk is raw format, and it's a good idea for "
35739 "other cases too."
35740 msgstr ""
35741
35742 #. type: textblock
35743 #: ../src/guestfs.pod:1318
35744 msgid ""
35745 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
35746 "format is fetched from libvirt and passed through."
35747 msgstr ""
35748
35749 #. type: textblock
35750 #: ../src/guestfs.pod:1321
35751 msgid ""
35752 "For libguestfs tools, use the I<--format> command line parameter as "
35753 "appropriate."
35754 msgstr ""
35755
35756 #. type: =head1
35757 #: ../src/guestfs.pod:1324
35758 msgid "CONNECTION MANAGEMENT"
35759 msgstr ""
35760
35761 #. type: =head2
35762 #: ../src/guestfs.pod:1326
35763 msgid "guestfs_h *"
35764 msgstr ""
35765
35766 #. type: textblock
35767 #: ../src/guestfs.pod:1328
35768 msgid ""
35769 "C<guestfs_h> is the opaque type representing a connection handle.  Create a "
35770 "handle by calling L</guestfs_create>.  Call L</guestfs_close> to free the "
35771 "handle and release all resources used."
35772 msgstr ""
35773
35774 #. type: textblock
35775 #: ../src/guestfs.pod:1332
35776 msgid ""
35777 "For information on using multiple handles and threads, see the section "
35778 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
35779 msgstr ""
35780
35781 #. type: =head2
35782 #: ../src/guestfs.pod:1335
35783 msgid "guestfs_create"
35784 msgstr ""
35785
35786 #. type: verbatim
35787 #: ../src/guestfs.pod:1337
35788 #, no-wrap
35789 msgid ""
35790 " guestfs_h *guestfs_create (void);\n"
35791 "\n"
35792 msgstr ""
35793
35794 #. type: textblock
35795 #: ../src/guestfs.pod:1339
35796 msgid "Create a connection handle."
35797 msgstr ""
35798
35799 #. type: textblock
35800 #: ../src/guestfs.pod:1341
35801 msgid ""
35802 "On success this returns a non-NULL pointer to a handle.  On error it returns "
35803 "NULL."
35804 msgstr ""
35805
35806 #. type: textblock
35807 #: ../src/guestfs.pod:1344
35808 msgid ""
35809 "You have to \"configure\" the handle after creating it.  This includes "
35810 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
35811 "handle at least once."
35812 msgstr ""
35813
35814 #. type: textblock
35815 #: ../src/guestfs.pod:1348
35816 msgid "After configuring the handle, you have to call L</guestfs_launch>."
35817 msgstr ""
35818
35819 #. type: textblock
35820 #: ../src/guestfs.pod:1350
35821 msgid ""
35822 "You may also want to configure error handling for the handle.  See the "
35823 "L</ERROR HANDLING> section below."
35824 msgstr ""
35825
35826 #. type: =head2
35827 #: ../src/guestfs.pod:1353
35828 msgid "guestfs_close"
35829 msgstr ""
35830
35831 #. type: verbatim
35832 #: ../src/guestfs.pod:1355
35833 #, no-wrap
35834 msgid ""
35835 " void guestfs_close (guestfs_h *g);\n"
35836 "\n"
35837 msgstr ""
35838
35839 #. type: textblock
35840 #: ../src/guestfs.pod:1357
35841 msgid "This closes the connection handle and frees up all resources used."
35842 msgstr ""
35843
35844 #. type: textblock
35845 #: ../src/guestfs.pod:1359
35846 msgid ""
35847 "If autosync was set on the handle and the handle was launched, then this "
35848 "implicitly calls various functions to unmount filesystems and sync the "
35849 "disk.  See L</guestfs_set_autosync> for more details."
35850 msgstr ""
35851
35852 #. type: textblock
35853 #: ../src/guestfs.pod:1363
35854 msgid "If a close callback was set on the handle, then it is called."
35855 msgstr ""
35856
35857 #. type: =head1
35858 #: ../src/guestfs.pod:1365
35859 msgid "ERROR HANDLING"
35860 msgstr ""
35861
35862 #. type: textblock
35863 #: ../src/guestfs.pod:1367
35864 msgid ""
35865 "API functions can return errors.  For example, almost all functions that "
35866 "return C<int> will return C<-1> to indicate an error."
35867 msgstr ""
35868
35869 #. type: textblock
35870 #: ../src/guestfs.pod:1370
35871 msgid ""
35872 "Additional information is available for errors: an error message string and "
35873 "optionally an error number (errno) if the thing that failed was a system "
35874 "call."
35875 msgstr ""
35876
35877 #. type: textblock
35878 #: ../src/guestfs.pod:1374
35879 msgid ""
35880 "You can get at the additional information about the last error on the handle "
35881 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
35882 "up an error handler with L</guestfs_set_error_handler>."
35883 msgstr ""
35884
35885 #. type: textblock
35886 #: ../src/guestfs.pod:1379
35887 msgid ""
35888 "When the handle is created, a default error handler is installed which "
35889 "prints the error message string to C<stderr>.  For small short-running "
35890 "command line programs it is sufficient to do:"
35891 msgstr ""
35892
35893 #. type: verbatim
35894 #: ../src/guestfs.pod:1383
35895 #, no-wrap
35896 msgid ""
35897 " if (guestfs_launch (g) == -1)\n"
35898 "   exit (EXIT_FAILURE);\n"
35899 "\n"
35900 msgstr ""
35901
35902 #. type: textblock
35903 #: ../src/guestfs.pod:1386
35904 msgid ""
35905 "since the default error handler will ensure that an error message has been "
35906 "printed to C<stderr> before the program exits."
35907 msgstr ""
35908
35909 #. type: textblock
35910 #: ../src/guestfs.pod:1389
35911 msgid ""
35912 "For other programs the caller will almost certainly want to install an "
35913 "alternate error handler or do error handling in-line like this:"
35914 msgstr ""
35915
35916 #. type: verbatim
35917 #: ../src/guestfs.pod:1392
35918 #, no-wrap
35919 msgid ""
35920 " /* This disables the default behaviour of printing errors\n"
35921 "    on stderr. */\n"
35922 " guestfs_set_error_handler (g, NULL, NULL);\n"
35923 " \n"
35924 msgstr ""
35925
35926 #. type: verbatim
35927 #: ../src/guestfs.pod:1396
35928 #, no-wrap
35929 msgid ""
35930 " if (guestfs_launch (g) == -1) {\n"
35931 "   /* Examine the error message and print it etc. */\n"
35932 "   char *msg = guestfs_last_error (g);\n"
35933 "   int errnum = guestfs_last_errno (g);\n"
35934 "   fprintf (stderr, \"%s\", msg);\n"
35935 "   if (errnum != 0)\n"
35936 "     fprintf (stderr, \": %s\", strerror (errnum));\n"
35937 "   fprintf (stderr, \"\\n\");\n"
35938 "   /* ... */\n"
35939 " }\n"
35940 "\n"
35941 msgstr ""
35942
35943 #. type: textblock
35944 #: ../src/guestfs.pod:1407
35945 msgid ""
35946 "Out of memory errors are handled differently.  The default action is to call "
35947 "L<abort(3)>.  If this is undesirable, then you can set a handler using "
35948 "L</guestfs_set_out_of_memory_handler>."
35949 msgstr ""
35950
35951 #. type: textblock
35952 #: ../src/guestfs.pod:1411
35953 msgid ""
35954 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
35955 "because there is no handle if this happens there is no way to get additional "
35956 "error information.  However L</guestfs_create> is supposed to be a "
35957 "lightweight operation which can only fail because of insufficient memory (it "
35958 "returns NULL in this case)."
35959 msgstr ""
35960
35961 #. type: =head2
35962 #: ../src/guestfs.pod:1417
35963 msgid "guestfs_last_error"
35964 msgstr ""
35965
35966 #. type: verbatim
35967 #: ../src/guestfs.pod:1419
35968 #, no-wrap
35969 msgid ""
35970 " const char *guestfs_last_error (guestfs_h *g);\n"
35971 "\n"
35972 msgstr ""
35973
35974 #. type: textblock
35975 #: ../src/guestfs.pod:1421
35976 msgid ""
35977 "This returns the last error message that happened on C<g>.  If there has not "
35978 "been an error since the handle was created, then this returns C<NULL>."
35979 msgstr ""
35980
35981 #. type: textblock
35982 #: ../src/guestfs.pod:1425
35983 msgid ""
35984 "The lifetime of the returned string is until the next error occurs, or "
35985 "L</guestfs_close> is called."
35986 msgstr ""
35987
35988 #. type: =head2
35989 #: ../src/guestfs.pod:1428
35990 msgid "guestfs_last_errno"
35991 msgstr ""
35992
35993 #. type: verbatim
35994 #: ../src/guestfs.pod:1430
35995 #, no-wrap
35996 msgid ""
35997 " int guestfs_last_errno (guestfs_h *g);\n"
35998 "\n"
35999 msgstr ""
36000
36001 #. type: textblock
36002 #: ../src/guestfs.pod:1432
36003 msgid "This returns the last error number (errno) that happened on C<g>."
36004 msgstr ""
36005
36006 #. type: textblock
36007 #: ../src/guestfs.pod:1434
36008 msgid "If successful, an errno integer not equal to zero is returned."
36009 msgstr ""
36010
36011 #. type: textblock
36012 #: ../src/guestfs.pod:1436
36013 msgid "If no error, this returns 0.  This call can return 0 in three situations:"
36014 msgstr ""
36015
36016 #. type: textblock
36017 #: ../src/guestfs.pod:1443
36018 msgid "There has not been any error on the handle."
36019 msgstr ""
36020
36021 #. type: textblock
36022 #: ../src/guestfs.pod:1447
36023 msgid ""
36024 "There has been an error but the errno was meaningless.  This corresponds to "
36025 "the case where the error did not come from a failed system call, but for "
36026 "some other reason."
36027 msgstr ""
36028
36029 #. type: textblock
36030 #: ../src/guestfs.pod:1453
36031 msgid ""
36032 "There was an error from a failed system call, but for some reason the errno "
36033 "was not captured and returned.  This usually indicates a bug in libguestfs."
36034 msgstr ""
36035
36036 #. type: textblock
36037 #: ../src/guestfs.pod:1459
36038 msgid ""
36039 "Libguestfs tries to convert the errno from inside the applicance into a "
36040 "corresponding errno for the caller (not entirely trivial: the appliance "
36041 "might be running a completely different operating system from the library "
36042 "and error numbers are not standardized across Un*xen).  If this could not be "
36043 "done, then the error is translated to C<EINVAL>.  In practice this should "
36044 "only happen in very rare circumstances."
36045 msgstr ""
36046
36047 #. type: =head2
36048 #: ../src/guestfs.pod:1467
36049 msgid "guestfs_set_error_handler"
36050 msgstr ""
36051
36052 #. type: verbatim
36053 #: ../src/guestfs.pod:1469
36054 #, no-wrap
36055 msgid ""
36056 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
36057 "                                           void *opaque,\n"
36058 "                                           const char *msg);\n"
36059 " void guestfs_set_error_handler (guestfs_h *g,\n"
36060 "                                 guestfs_error_handler_cb cb,\n"
36061 "                                 void *opaque);\n"
36062 "\n"
36063 msgstr ""
36064
36065 #. type: textblock
36066 #: ../src/guestfs.pod:1476
36067 msgid ""
36068 "The callback C<cb> will be called if there is an error.  The parameters "
36069 "passed to the callback are an opaque data pointer and the error message "
36070 "string."
36071 msgstr ""
36072
36073 #. type: textblock
36074 #: ../src/guestfs.pod:1480
36075 msgid ""
36076 "C<errno> is not passed to the callback.  To get that the callback must call "
36077 "L</guestfs_last_errno>."
36078 msgstr ""
36079
36080 #. type: textblock
36081 #: ../src/guestfs.pod:1483
36082 msgid ""
36083 "Note that the message string C<msg> is freed as soon as the callback "
36084 "function returns, so if you want to stash it somewhere you must make your "
36085 "own copy."
36086 msgstr ""
36087
36088 #. type: textblock
36089 #: ../src/guestfs.pod:1487
36090 msgid "The default handler prints messages on C<stderr>."
36091 msgstr ""
36092
36093 #. type: textblock
36094 #: ../src/guestfs.pod:1489
36095 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
36096 msgstr ""
36097
36098 #. type: =head2
36099 #: ../src/guestfs.pod:1491
36100 msgid "guestfs_get_error_handler"
36101 msgstr ""
36102
36103 #. type: verbatim
36104 #: ../src/guestfs.pod:1493
36105 #, no-wrap
36106 msgid ""
36107 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
36108 "                                                     void **opaque_rtn);\n"
36109 "\n"
36110 msgstr ""
36111
36112 #. type: textblock
36113 #: ../src/guestfs.pod:1496
36114 msgid "Returns the current error handler callback."
36115 msgstr ""
36116
36117 #. type: =head2
36118 #: ../src/guestfs.pod:1498
36119 msgid "guestfs_set_out_of_memory_handler"
36120 msgstr ""
36121
36122 #. type: verbatim
36123 #: ../src/guestfs.pod:1500
36124 #, no-wrap
36125 msgid ""
36126 " typedef void (*guestfs_abort_cb) (void);\n"
36127 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
36128 "                                         guestfs_abort_cb);\n"
36129 "\n"
36130 msgstr ""
36131
36132 #. type: textblock
36133 #: ../src/guestfs.pod:1504
36134 msgid ""
36135 "The callback C<cb> will be called if there is an out of memory situation.  "
36136 "I<Note this callback must not return>."
36137 msgstr ""
36138
36139 #. type: textblock
36140 #: ../src/guestfs.pod:1507
36141 msgid "The default is to call L<abort(3)>."
36142 msgstr ""
36143
36144 #. type: textblock
36145 #: ../src/guestfs.pod:1509
36146 msgid "You cannot set C<cb> to C<NULL>.  You can't ignore out of memory situations."
36147 msgstr ""
36148
36149 #. type: =head2
36150 #: ../src/guestfs.pod:1512
36151 msgid "guestfs_get_out_of_memory_handler"
36152 msgstr ""
36153
36154 #. type: verbatim
36155 #: ../src/guestfs.pod:1514
36156 #, no-wrap
36157 msgid ""
36158 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
36159 "\n"
36160 msgstr ""
36161
36162 #. type: textblock
36163 #: ../src/guestfs.pod:1516
36164 msgid "This returns the current out of memory handler."
36165 msgstr ""
36166
36167 #. type: =head1
36168 #: ../src/guestfs.pod:1518
36169 msgid "API CALLS"
36170 msgstr ""
36171
36172 #. type: =head1
36173 #: ../src/guestfs.pod:1522
36174 msgid "STRUCTURES"
36175 msgstr ""
36176
36177 #. type: textblock
36178 #: ../src/guestfs.pod:1524
36179 msgid "@STRUCTS@"
36180 msgstr ""
36181
36182 #. type: =head1
36183 #: ../src/guestfs.pod:1526
36184 msgid "AVAILABILITY"
36185 msgstr ""
36186
36187 #. type: =head2
36188 #: ../src/guestfs.pod:1528
36189 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
36190 msgstr ""
36191
36192 #. type: textblock
36193 #: ../src/guestfs.pod:1530
36194 msgid ""
36195 "Using L</guestfs_available> you can test availability of the following "
36196 "groups of functions.  This test queries the appliance to see if the "
36197 "appliance you are currently using supports the functionality."
36198 msgstr ""
36199
36200 #. type: textblock
36201 #: ../src/guestfs.pod:1535
36202 msgid "@AVAILABILITY@"
36203 msgstr ""
36204
36205 #. type: =head2
36206 #: ../src/guestfs.pod:1537
36207 msgid "GUESTFISH supported COMMAND"
36208 msgstr ""
36209
36210 #. type: textblock
36211 #: ../src/guestfs.pod:1539
36212 msgid ""
36213 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
36214 "prints out the available groups and whether they are supported by this build "
36215 "of libguestfs.  Note however that you have to do C<run> first."
36216 msgstr ""
36217
36218 #. type: =head2
36219 #: ../src/guestfs.pod:1544
36220 msgid "SINGLE CALLS AT COMPILE TIME"
36221 msgstr ""
36222
36223 #. type: textblock
36224 #: ../src/guestfs.pod:1546
36225 msgid ""
36226 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
36227 "function, such as:"
36228 msgstr ""
36229
36230 #. type: verbatim
36231 #: ../src/guestfs.pod:1549
36232 #, no-wrap
36233 msgid ""
36234 " #define LIBGUESTFS_HAVE_DD 1\n"
36235 "\n"
36236 msgstr ""
36237
36238 #. type: textblock
36239 #: ../src/guestfs.pod:1551
36240 msgid "if L</guestfs_dd> is available."
36241 msgstr ""
36242
36243 #. type: textblock
36244 #: ../src/guestfs.pod:1553
36245 msgid ""
36246 "Before version 1.5.8, if you needed to test whether a single libguestfs "
36247 "function is available at compile time, we recommended using build tools such "
36248 "as autoconf or cmake.  For example in autotools you could use:"
36249 msgstr ""
36250
36251 #. type: verbatim
36252 #: ../src/guestfs.pod:1558
36253 #, no-wrap
36254 msgid ""
36255 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
36256 " AC_CHECK_FUNCS([guestfs_dd])\n"
36257 "\n"
36258 msgstr ""
36259
36260 #. type: textblock
36261 #: ../src/guestfs.pod:1561
36262 msgid ""
36263 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
36264 "in your program."
36265 msgstr ""
36266
36267 #. type: =head2
36268 #: ../src/guestfs.pod:1564
36269 msgid "SINGLE CALLS AT RUN TIME"
36270 msgstr ""
36271
36272 #. type: textblock
36273 #: ../src/guestfs.pod:1566
36274 msgid ""
36275 "Testing at compile time doesn't guarantee that a function really exists in "
36276 "the library.  The reason is that you might be dynamically linked against a "
36277 "previous I<libguestfs.so> (dynamic library)  which doesn't have the call.  "
36278 "This situation unfortunately results in a segmentation fault, which is a "
36279 "shortcoming of the C dynamic linking system itself."
36280 msgstr ""
36281
36282 #. type: textblock
36283 #: ../src/guestfs.pod:1573
36284 msgid ""
36285 "You can use L<dlopen(3)> to test if a function is available at run time, as "
36286 "in this example program (note that you still need the compile time check as "
36287 "well):"
36288 msgstr ""
36289
36290 #. type: verbatim
36291 #: ../src/guestfs.pod:1577
36292 #, no-wrap
36293 msgid ""
36294 " #include <stdio.h>\n"
36295 " #include <stdlib.h>\n"
36296 " #include <unistd.h>\n"
36297 " #include <dlfcn.h>\n"
36298 " #include <guestfs.h>\n"
36299 " \n"
36300 msgstr ""
36301
36302 #. type: verbatim
36303 #: ../src/guestfs.pod:1583
36304 #, no-wrap
36305 msgid ""
36306 " main ()\n"
36307 " {\n"
36308 " #ifdef LIBGUESTFS_HAVE_DD\n"
36309 "   void *dl;\n"
36310 "   int has_function;\n"
36311 " \n"
36312 msgstr ""
36313
36314 #. type: verbatim
36315 #: ../src/guestfs.pod:1589
36316 #, no-wrap
36317 msgid ""
36318 "   /* Test if the function guestfs_dd is really available. */\n"
36319 "   dl = dlopen (NULL, RTLD_LAZY);\n"
36320 "   if (!dl) {\n"
36321 "     fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
36322 "     exit (EXIT_FAILURE);\n"
36323 "   }\n"
36324 "   has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
36325 "   dlclose (dl);\n"
36326 " \n"
36327 msgstr ""
36328
36329 #. type: verbatim
36330 #: ../src/guestfs.pod:1598
36331 #, no-wrap
36332 msgid ""
36333 "   if (!has_function)\n"
36334 "     printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
36335 "   else {\n"
36336 "     printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
36337 "     /* Now it's safe to call\n"
36338 "     guestfs_dd (g, \"foo\", \"bar\");\n"
36339 "     */\n"
36340 "   }\n"
36341 " #else\n"
36342 "   printf (\"guestfs_dd function was not found at compile time\\n\");\n"
36343 " #endif\n"
36344 "  }\n"
36345 "\n"
36346 msgstr ""
36347
36348 #. type: textblock
36349 #: ../src/guestfs.pod:1611
36350 msgid ""
36351 "You may think the above is an awful lot of hassle, and it is.  There are "
36352 "other ways outside of the C linking system to ensure that this kind of "
36353 "incompatibility never arises, such as using package versioning:"
36354 msgstr ""
36355
36356 #. type: verbatim
36357 #: ../src/guestfs.pod:1616
36358 #, no-wrap
36359 msgid ""
36360 " Requires: libguestfs >= 1.0.80\n"
36361 "\n"
36362 msgstr ""
36363
36364 #. type: =head1
36365 #: ../src/guestfs.pod:1618
36366 msgid "CALLS WITH OPTIONAL ARGUMENTS"
36367 msgstr ""
36368
36369 #. type: textblock
36370 #: ../src/guestfs.pod:1620
36371 msgid ""
36372 "A recent feature of the API is the introduction of calls which take optional "
36373 "arguments.  In C these are declared 3 ways.  The main way is as a call which "
36374 "takes variable arguments (ie. C<...>), as in this example:"
36375 msgstr ""
36376
36377 #. type: verbatim
36378 #: ../src/guestfs.pod:1625
36379 #, no-wrap
36380 msgid ""
36381 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
36382 "\n"
36383 msgstr ""
36384
36385 #. type: textblock
36386 #: ../src/guestfs.pod:1627
36387 msgid ""
36388 "Call this with a list of optional arguments, terminated by C<-1>.  So to "
36389 "call with no optional arguments specified:"
36390 msgstr ""
36391
36392 #. type: verbatim
36393 #: ../src/guestfs.pod:1630
36394 #, no-wrap
36395 msgid ""
36396 " guestfs_add_drive_opts (g, filename, -1);\n"
36397 "\n"
36398 msgstr ""
36399
36400 #. type: textblock
36401 #: ../src/guestfs.pod:1632
36402 msgid "With a single optional argument:"
36403 msgstr ""
36404
36405 #. type: verbatim
36406 #: ../src/guestfs.pod:1634
36407 #, no-wrap
36408 msgid ""
36409 " guestfs_add_drive_opts (g, filename,\n"
36410 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
36411 "                         -1);\n"
36412 "\n"
36413 msgstr ""
36414
36415 #. type: textblock
36416 #: ../src/guestfs.pod:1638
36417 msgid "With two:"
36418 msgstr ""
36419
36420 #. type: verbatim
36421 #: ../src/guestfs.pod:1640
36422 #, no-wrap
36423 msgid ""
36424 " guestfs_add_drive_opts (g, filename,\n"
36425 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
36426 "                         GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
36427 "                         -1);\n"
36428 "\n"
36429 msgstr ""
36430
36431 #. type: textblock
36432 #: ../src/guestfs.pod:1645
36433 msgid ""
36434 "and so forth.  Don't forget the terminating C<-1> otherwise Bad Things will "
36435 "happen!"
36436 msgstr ""
36437
36438 #. type: =head2
36439 #: ../src/guestfs.pod:1648
36440 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
36441 msgstr ""
36442
36443 #. type: textblock
36444 #: ../src/guestfs.pod:1650
36445 msgid ""
36446 "The second variant has the same name with the suffix C<_va>, which works the "
36447 "same way but takes a C<va_list>.  See the C manual for details.  For the "
36448 "example function, this is declared:"
36449 msgstr ""
36450
36451 #. type: verbatim
36452 #: ../src/guestfs.pod:1654
36453 #, no-wrap
36454 msgid ""
36455 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
36456 "                                va_list args);\n"
36457 "\n"
36458 msgstr ""
36459
36460 #. type: =head2
36461 #: ../src/guestfs.pod:1657
36462 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
36463 msgstr ""
36464
36465 #. type: textblock
36466 #: ../src/guestfs.pod:1659
36467 msgid ""
36468 "The third variant is useful where you need to construct these calls.  You "
36469 "pass in a structure where you fill in the optional fields.  The structure "
36470 "has a bitmask as the first element which you must set to indicate which "
36471 "fields you have filled in.  For our example function the structure and call "
36472 "are declared:"
36473 msgstr ""
36474
36475 #. type: verbatim
36476 #: ../src/guestfs.pod:1665
36477 #, no-wrap
36478 msgid ""
36479 " struct guestfs_add_drive_opts_argv {\n"
36480 "   uint64_t bitmask;\n"
36481 "   int readonly;\n"
36482 "   const char *format;\n"
36483 "   /* ... */\n"
36484 " };\n"
36485 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
36486 "              const struct guestfs_add_drive_opts_argv *optargs);\n"
36487 "\n"
36488 msgstr ""
36489
36490 #. type: textblock
36491 #: ../src/guestfs.pod:1674
36492 msgid "You could call it like this:"
36493 msgstr ""
36494
36495 #. type: verbatim
36496 #: ../src/guestfs.pod:1676
36497 #, no-wrap
36498 msgid ""
36499 " struct guestfs_add_drive_opts_argv optargs = {\n"
36500 "   .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
36501 "              GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
36502 "   .readonly = 1,\n"
36503 "   .format = \"qcow2\"\n"
36504 " };\n"
36505 " \n"
36506 msgstr ""
36507
36508 #. type: verbatim
36509 #: ../src/guestfs.pod:1683
36510 #, no-wrap
36511 msgid ""
36512 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
36513 "\n"
36514 msgstr ""
36515
36516 #. type: textblock
36517 #: ../src/guestfs.pod:1691
36518 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
36519 msgstr ""
36520
36521 #. type: textblock
36522 #: ../src/guestfs.pod:1696
36523 msgid "You do not need to fill in all fields of the structure."
36524 msgstr ""
36525
36526 #. type: textblock
36527 #: ../src/guestfs.pod:1700
36528 msgid ""
36529 "There must be a one-to-one correspondence between fields of the structure "
36530 "that are filled in, and bits set in the bitmask."
36531 msgstr ""
36532
36533 #. type: =head2
36534 #: ../src/guestfs.pod:1705
36535 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
36536 msgstr ""
36537
36538 #. type: textblock
36539 #: ../src/guestfs.pod:1707
36540 msgid ""
36541 "In other languages, optional arguments are expressed in the way that is "
36542 "natural for that language.  We refer you to the language-specific "
36543 "documentation for more details on that."
36544 msgstr ""
36545
36546 #. type: textblock
36547 #: ../src/guestfs.pod:1711
36548 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
36549 msgstr ""
36550
36551 #. type: =head2
36552 #: ../src/guestfs.pod:1713
36553 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
36554 msgstr ""
36555
36556 #. type: textblock
36557 #: ../src/guestfs.pod:1715
36558 msgid ""
36559 "B<Note:> This section documents the generic event mechanism introduced in "
36560 "libguestfs 1.10, which you should use in new code if possible.  The old "
36561 "functions C<guestfs_set_log_message_callback>, "
36562 "C<guestfs_set_subprocess_quit_callback>, "
36563 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
36564 "C<guestfs_set_progress_callback> are no longer documented in this manual "
36565 "page.  Because of the ABI guarantee, the old functions continue to work."
36566 msgstr ""
36567
36568 #. type: textblock
36569 #: ../src/guestfs.pod:1724
36570 msgid ""
36571 "Handles generate events when certain things happen, such as log messages "
36572 "being generated, progress messages during long-running operations, or the "
36573 "handle being closed.  The API calls described below let you register a "
36574 "callback to be called when events happen.  You can register multiple "
36575 "callbacks (for the same, different or overlapping sets of events), and "
36576 "individually remove callbacks.  If callbacks are not removed, then they "
36577 "remain in force until the handle is closed."
36578 msgstr ""
36579
36580 #. type: textblock
36581 #: ../src/guestfs.pod:1732
36582 msgid ""
36583 "In the current implementation, events are only generated synchronously: that "
36584 "means that events (and hence callbacks) can only happen while you are in the "
36585 "middle of making another libguestfs call.  The callback is called in the "
36586 "same thread."
36587 msgstr ""
36588
36589 #. type: textblock
36590 #: ../src/guestfs.pod:1737
36591 msgid ""
36592 "Events may contain a payload, usually nothing (void), an array of 64 bit "
36593 "unsigned integers, or a message buffer.  Payloads are discussed later on."
36594 msgstr ""
36595
36596 #. type: =head3
36597 #: ../src/guestfs.pod:1741
36598 msgid "CLASSES OF EVENTS"
36599 msgstr ""
36600
36601 #. type: =item
36602 #: ../src/guestfs.pod:1745
36603 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
36604 msgstr ""
36605
36606 #. type: textblock
36607 #: ../src/guestfs.pod:1748
36608 msgid ""
36609 "The callback function will be called while the handle is being closed "
36610 "(synchronously from L</guestfs_close>)."
36611 msgstr ""
36612
36613 #. type: textblock
36614 #: ../src/guestfs.pod:1751
36615 msgid ""
36616 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
36617 "handles that are open when the program exits.  This means that this callback "
36618 "might be called indirectly from L<exit(3)>, which can cause unexpected "
36619 "problems in higher-level languages (eg. if your HLL interpreter has already "
36620 "been cleaned up by the time this is called, and if your callback then jumps "
36621 "into some HLL function)."
36622 msgstr ""
36623
36624 #. type: textblock
36625 #: ../src/guestfs.pod:1758
36626 msgid ""
36627 "If no callback is registered: the handle is closed without any callback "
36628 "being invoked."
36629 msgstr ""
36630
36631 #. type: =item
36632 #: ../src/guestfs.pod:1761
36633 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
36634 msgstr ""
36635
36636 #. type: textblock
36637 #: ../src/guestfs.pod:1764
36638 msgid ""
36639 "The callback function will be called when the child process quits, either "
36640 "asynchronously or if killed by L</guestfs_kill_subprocess>.  (This "
36641 "corresponds to a transition from any state to the CONFIG state)."
36642 msgstr ""
36643
36644 #. type: textblock
36645 #: ../src/guestfs.pod:1768 ../src/guestfs.pod:1777 ../src/guestfs.pod:1894
36646 msgid "If no callback is registered: the event is ignored."
36647 msgstr ""
36648
36649 #. type: =item
36650 #: ../src/guestfs.pod:1770
36651 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
36652 msgstr ""
36653
36654 #. type: textblock
36655 #: ../src/guestfs.pod:1773
36656 msgid ""
36657 "The callback function will be called when the child process becomes ready "
36658 "first time after it has been launched.  (This corresponds to a transition "
36659 "from LAUNCHING to the READY state)."
36660 msgstr ""
36661
36662 #. type: =item
36663 #: ../src/guestfs.pod:1779
36664 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
36665 msgstr ""
36666
36667 #. type: textblock
36668 #: ../src/guestfs.pod:1782
36669 msgid ""
36670 "Some long-running operations can generate progress messages.  If this "
36671 "callback is registered, then it will be called each time a progress message "
36672 "is generated (usually two seconds after the operation started, and three "
36673 "times per second thereafter until it completes, although the frequency may "
36674 "change in future versions)."
36675 msgstr ""
36676
36677 #. type: textblock
36678 #: ../src/guestfs.pod:1788
36679 msgid ""
36680 "The callback receives in the payload four unsigned 64 bit numbers which are "
36681 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
36682 msgstr ""
36683
36684 #. type: textblock
36685 #: ../src/guestfs.pod:1791
36686 msgid ""
36687 "The units of C<total> are not defined, although for some operations C<total> "
36688 "may relate in some way to the amount of data to be transferred (eg. in bytes "
36689 "or megabytes), and C<position> may be the portion which has been "
36690 "transferred."
36691 msgstr ""
36692
36693 #. type: textblock
36694 #: ../src/guestfs.pod:1796
36695 msgid "The only defined and stable parts of the API are:"
36696 msgstr ""
36697
36698 #. type: textblock
36699 #: ../src/guestfs.pod:1802
36700 msgid ""
36701 "The callback can display to the user some type of progress bar or indicator "
36702 "which shows the ratio of C<position>:C<total>."
36703 msgstr ""
36704
36705 #. type: textblock
36706 #: ../src/guestfs.pod:1807
36707 msgid "0 E<lt>= C<position> E<lt>= C<total>"
36708 msgstr ""
36709
36710 #. type: textblock
36711 #: ../src/guestfs.pod:1811
36712 msgid ""
36713 "If any progress notification is sent during a call, then a final progress "
36714 "notification is always sent when C<position> = C<total> (I<unless> the call "
36715 "fails with an error)."
36716 msgstr ""
36717
36718 #. type: textblock
36719 #: ../src/guestfs.pod:1815
36720 msgid ""
36721 "This is to simplify caller code, so callers can easily set the progress "
36722 "indicator to \"100%\" at the end of the operation, without requiring special "
36723 "code to detect this case."
36724 msgstr ""
36725
36726 #. type: textblock
36727 #: ../src/guestfs.pod:1821
36728 msgid ""
36729 "For some calls we are unable to estimate the progress of the call, but we "
36730 "can still generate progress messages to indicate activity.  This is known as "
36731 "\"pulse mode\", and is directly supported by certain progress bar "
36732 "implementations (eg. GtkProgressBar)."
36733 msgstr ""
36734
36735 #. type: textblock
36736 #: ../src/guestfs.pod:1826
36737 msgid ""
36738 "For these calls, zero or more progress messages are generated with "
36739 "C<position = 0> and C<total = 1>, followed by a final message with "
36740 "C<position = total = 1>."
36741 msgstr ""
36742
36743 #. type: textblock
36744 #: ../src/guestfs.pod:1830
36745 msgid ""
36746 "As noted above, if the call fails with an error then the final message may "
36747 "not be generated."
36748 msgstr ""
36749
36750 #. type: textblock
36751 #: ../src/guestfs.pod:1835
36752 msgid ""
36753 "The callback also receives the procedure number (C<proc_nr>) and serial "
36754 "number (C<serial>) of the call.  These are only useful for debugging "
36755 "protocol issues, and the callback can normally ignore them.  The callback "
36756 "may want to print these numbers in error messages or debugging messages."
36757 msgstr ""
36758
36759 #. type: textblock
36760 #: ../src/guestfs.pod:1841
36761 msgid "If no callback is registered: progress messages are discarded."
36762 msgstr ""
36763
36764 #. type: =item
36765 #: ../src/guestfs.pod:1843
36766 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
36767 msgstr ""
36768
36769 #. type: textblock
36770 #: ../src/guestfs.pod:1846
36771 msgid ""
36772 "The callback function is called whenever a log message is generated by qemu, "
36773 "the appliance kernel, guestfsd (daemon), or utility programs."
36774 msgstr ""
36775
36776 #. type: textblock
36777 #: ../src/guestfs.pod:1849
36778 msgid ""
36779 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
36780 "(L</guestfs_launch>) then additional debug messages are generated."
36781 msgstr ""
36782
36783 #. type: textblock
36784 #: ../src/guestfs.pod:1852 ../src/guestfs.pod:1866
36785 msgid ""
36786 "If no callback is registered: the messages are discarded unless the verbose "
36787 "flag is set in which case they are sent to stderr.  You can override the "
36788 "printing of verbose messages to stderr by setting up a callback."
36789 msgstr ""
36790
36791 #. type: =item
36792 #: ../src/guestfs.pod:1857
36793 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
36794 msgstr ""
36795
36796 #. type: textblock
36797 #: ../src/guestfs.pod:1860
36798 msgid ""
36799 "The callback function is called whenever a log message is generated by the "
36800 "library part of libguestfs."
36801 msgstr ""
36802
36803 #. type: textblock
36804 #: ../src/guestfs.pod:1863
36805 msgid ""
36806 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
36807 "messages are generated."
36808 msgstr ""
36809
36810 #. type: =item
36811 #: ../src/guestfs.pod:1871
36812 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
36813 msgstr ""
36814
36815 #. type: textblock
36816 #: ../src/guestfs.pod:1874
36817 msgid ""
36818 "The callback function is called whenever a trace message is generated.  This "
36819 "only applies if the trace flag (L</guestfs_set_trace>) is set."
36820 msgstr ""
36821
36822 #. type: textblock
36823 #: ../src/guestfs.pod:1877
36824 msgid ""
36825 "If no callback is registered: the messages are sent to stderr.  You can "
36826 "override the printing of trace messages to stderr by setting up a callback."
36827 msgstr ""
36828
36829 #. type: =item
36830 #: ../src/guestfs.pod:1881
36831 msgid "GUESTFS_EVENT_ENTER (payload type: function name)"
36832 msgstr ""
36833
36834 #. type: textblock
36835 #: ../src/guestfs.pod:1884
36836 msgid "The callback function is called whenever a libguestfs function is entered."
36837 msgstr ""
36838
36839 #. type: textblock
36840 #: ../src/guestfs.pod:1887
36841 msgid ""
36842 "The payload is a string which contains the name of the function that we are "
36843 "entering (not including C<guestfs_> prefix)."
36844 msgstr ""
36845
36846 #. type: textblock
36847 #: ../src/guestfs.pod:1890
36848 msgid ""
36849 "Note that libguestfs functions can call themselves, so you may see many "
36850 "events from a single call.  A few libguestfs functions do not generate this "
36851 "event."
36852 msgstr ""
36853
36854 #. type: =head3
36855 #: ../src/guestfs.pod:1898
36856 msgid "guestfs_set_event_callback"
36857 msgstr ""
36858
36859 #. type: verbatim
36860 #: ../src/guestfs.pod:1900
36861 #, no-wrap
36862 msgid ""
36863 " int guestfs_set_event_callback (guestfs_h *g,\n"
36864 "                                 guestfs_event_callback cb,\n"
36865 "                                 uint64_t event_bitmask,\n"
36866 "                                 int flags,\n"
36867 "                                 void *opaque);\n"
36868 "\n"
36869 msgstr ""
36870
36871 #. type: textblock
36872 #: ../src/guestfs.pod:1906
36873 msgid ""
36874 "This function registers a callback (C<cb>) for all event classes in the "
36875 "C<event_bitmask>."
36876 msgstr ""
36877
36878 #. type: textblock
36879 #: ../src/guestfs.pod:1909
36880 msgid ""
36881 "For example, to register for all log message events, you could call this "
36882 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>.  "
36883 "To register a single callback for all possible classes of events, use "
36884 "C<GUESTFS_EVENT_ALL>."
36885 msgstr ""
36886
36887 #. type: textblock
36888 #: ../src/guestfs.pod:1915
36889 msgid "C<flags> should always be passed as 0."
36890 msgstr ""
36891
36892 #. type: textblock
36893 #: ../src/guestfs.pod:1917
36894 msgid ""
36895 "C<opaque> is an opaque pointer which is passed to the callback.  You can use "
36896 "it for any purpose."
36897 msgstr ""
36898
36899 #. type: textblock
36900 #: ../src/guestfs.pod:1920
36901 msgid ""
36902 "The return value is the event handle (an integer) which you can use to "
36903 "delete the callback (see below)."
36904 msgstr ""
36905
36906 #. type: textblock
36907 #: ../src/guestfs.pod:1923
36908 msgid ""
36909 "If there is an error, this function returns C<-1>, and sets the error in the "
36910 "handle in the usual way (see L</guestfs_last_error> etc.)"
36911 msgstr ""
36912
36913 #. type: textblock
36914 #: ../src/guestfs.pod:1926
36915 msgid ""
36916 "Callbacks remain in effect until they are deleted, or until the handle is "
36917 "closed."
36918 msgstr ""
36919
36920 #. type: textblock
36921 #: ../src/guestfs.pod:1929
36922 msgid ""
36923 "In the case where multiple callbacks are registered for a particular event "
36924 "class, all of the callbacks are called.  The order in which multiple "
36925 "callbacks are called is not defined."
36926 msgstr ""
36927
36928 #. type: =head3
36929 #: ../src/guestfs.pod:1933
36930 msgid "guestfs_delete_event_callback"
36931 msgstr ""
36932
36933 #. type: verbatim
36934 #: ../src/guestfs.pod:1935
36935 #, no-wrap
36936 msgid ""
36937 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
36938 "\n"
36939 msgstr ""
36940
36941 #. type: textblock
36942 #: ../src/guestfs.pod:1937
36943 msgid ""
36944 "Delete a callback that was previously registered.  C<event_handle> should be "
36945 "the integer that was returned by a previous call to "
36946 "C<guestfs_set_event_callback> on the same handle."
36947 msgstr ""
36948
36949 #. type: =head3
36950 #: ../src/guestfs.pod:1941
36951 msgid "guestfs_event_callback"
36952 msgstr ""
36953
36954 #. type: verbatim
36955 #: ../src/guestfs.pod:1943
36956 #, no-wrap
36957 msgid ""
36958 " typedef void (*guestfs_event_callback) (\n"
36959 "                  guestfs_h *g,\n"
36960 "                  void *opaque,\n"
36961 "                  uint64_t event,\n"
36962 "                  int event_handle,\n"
36963 "                  int flags,\n"
36964 "                  const char *buf, size_t buf_len,\n"
36965 "                  const uint64_t *array, size_t array_len);\n"
36966 "\n"
36967 msgstr ""
36968
36969 #. type: textblock
36970 #: ../src/guestfs.pod:1952
36971 msgid "This is the type of the event callback function that you have to provide."
36972 msgstr ""
36973
36974 #. type: textblock
36975 #: ../src/guestfs.pod:1955
36976 msgid ""
36977 "The basic parameters are: the handle (C<g>), the opaque user pointer "
36978 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
36979 "handle, and C<flags> which in the current API you should ignore."
36980 msgstr ""
36981
36982 #. type: textblock
36983 #: ../src/guestfs.pod:1959
36984 msgid ""
36985 "The remaining parameters contain the event payload (if any).  Each event may "
36986 "contain a payload, which usually relates to the event class, but for future "
36987 "proofing your code should be written to handle any payload for any event "
36988 "class."
36989 msgstr ""
36990
36991 #. type: textblock
36992 #: ../src/guestfs.pod:1964
36993 msgid ""
36994 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
36995 "there is no message buffer).  Note that this message buffer can contain "
36996 "arbitrary 8 bit data, including NUL bytes."
36997 msgstr ""
36998
36999 #. type: textblock
37000 #: ../src/guestfs.pod:1968
37001 msgid ""
37002 "C<array> and C<array_len> is an array of 64 bit unsigned integers.  At the "
37003 "moment this is only used for progress messages."
37004 msgstr ""
37005
37006 #. type: =head3
37007 #: ../src/guestfs.pod:1971
37008 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
37009 msgstr ""
37010
37011 #. type: textblock
37012 #: ../src/guestfs.pod:1973
37013 msgid ""
37014 "One motivation for the generic event API was to allow GUI programs to "
37015 "capture debug and other messages.  In libguestfs E<le> 1.8 these were sent "
37016 "unconditionally to C<stderr>."
37017 msgstr ""
37018
37019 #. type: textblock
37020 #: ../src/guestfs.pod:1977
37021 msgid ""
37022 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
37023 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>.  (Note that error "
37024 "messages are not events; you must capture error messages separately)."
37025 msgstr ""
37026
37027 #. type: textblock
37028 #: ../src/guestfs.pod:1982
37029 msgid ""
37030 "Programs have to set up a callback to capture the classes of events of "
37031 "interest:"
37032 msgstr ""
37033
37034 #. type: verbatim
37035 #: ../src/guestfs.pod:1985
37036 #, no-wrap
37037 msgid ""
37038 " int eh =\n"
37039 "   guestfs_set_event_callback\n"
37040 "     (g, message_callback,\n"
37041 "      GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
37042 "      GUESTFS_EVENT_TRACE,\n"
37043 "      0, NULL) == -1)\n"
37044 " if (eh == -1) {\n"
37045 "   // handle error in the usual way\n"
37046 " }\n"
37047 "\n"
37048 msgstr ""
37049
37050 #. type: textblock
37051 #: ../src/guestfs.pod:1995
37052 msgid ""
37053 "The callback can then direct messages to the appropriate place.  In this "
37054 "example, messages are directed to syslog:"
37055 msgstr ""
37056
37057 #. type: verbatim
37058 #: ../src/guestfs.pod:1998
37059 #, no-wrap
37060 msgid ""
37061 " static void\n"
37062 " message_callback (\n"
37063 "         guestfs_h *g,\n"
37064 "         void *opaque,\n"
37065 "         uint64_t event,\n"
37066 "         int event_handle,\n"
37067 "         int flags,\n"
37068 "         const char *buf, size_t buf_len,\n"
37069 "         const uint64_t *array, size_t array_len)\n"
37070 " {\n"
37071 "   const int priority = LOG_USER|LOG_INFO;\n"
37072 "   if (buf_len > 0)\n"
37073 "     syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
37074 " }\n"
37075 "\n"
37076 msgstr ""
37077
37078 #. type: =head1
37079 #: ../src/guestfs.pod:2013
37080 msgid "CANCELLING LONG TRANSFERS"
37081 msgstr ""
37082
37083 #. type: textblock
37084 #: ../src/guestfs.pod:2015
37085 msgid ""
37086 "Some operations can be cancelled by the caller while they are in progress.  "
37087 "Currently only operations that involve uploading or downloading data can be "
37088 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
37089 "parameters in the generator)."
37090 msgstr ""
37091
37092 #. type: =head2
37093 #: ../src/guestfs.pod:2020
37094 msgid "guestfs_user_cancel"
37095 msgstr ""
37096
37097 #. type: verbatim
37098 #: ../src/guestfs.pod:2022
37099 #, no-wrap
37100 msgid ""
37101 " void guestfs_user_cancel (guestfs_h *g);\n"
37102 "\n"
37103 msgstr ""
37104
37105 #. type: textblock
37106 #: ../src/guestfs.pod:2024
37107 msgid "C<guestfs_user_cancel> cancels the current upload or download operation."
37108 msgstr ""
37109
37110 #. type: textblock
37111 #: ../src/guestfs.pod:2027
37112 msgid ""
37113 "Unlike most other libguestfs calls, this function is signal safe and thread "
37114 "safe.  You can call it from a signal handler or from another thread, without "
37115 "needing to do any locking."
37116 msgstr ""
37117
37118 #. type: textblock
37119 #: ../src/guestfs.pod:2031
37120 msgid ""
37121 "The transfer that was in progress (if there is one) will stop shortly "
37122 "afterwards, and will return an error.  The errno (see "
37123 "L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
37124 "out if the operation was cancelled or failed because of another error."
37125 msgstr ""
37126
37127 #. type: textblock
37128 #: ../src/guestfs.pod:2037
37129 msgid ""
37130 "No cleanup is performed: for example, if a file was being uploaded then "
37131 "after cancellation there may be a partially uploaded file.  It is the "
37132 "caller's responsibility to clean up if necessary."
37133 msgstr ""
37134
37135 #. type: textblock
37136 #: ../src/guestfs.pod:2041
37137 msgid "There are two common places that you might call C<guestfs_user_cancel>."
37138 msgstr ""
37139
37140 #. type: textblock
37141 #: ../src/guestfs.pod:2043
37142 msgid ""
37143 "In an interactive text-based program, you might call it from a C<SIGINT> "
37144 "signal handler so that pressing C<^C> cancels the current operation.  (You "
37145 "also need to call L</guestfs_set_pgroup> so that child processes don't "
37146 "receive the C<^C> signal)."
37147 msgstr ""
37148
37149 #. type: textblock
37150 #: ../src/guestfs.pod:2048
37151 msgid ""
37152 "In a graphical program, when the main thread is displaying a progress bar "
37153 "with a cancel button, wire up the cancel button to call this function."
37154 msgstr ""
37155
37156 #. type: =head1
37157 #: ../src/guestfs.pod:2052
37158 msgid "PRIVATE DATA AREA"
37159 msgstr ""
37160
37161 #. type: textblock
37162 #: ../src/guestfs.pod:2054
37163 msgid ""
37164 "You can attach named pieces of private data to the libguestfs handle, fetch "
37165 "them by name, and walk over them, for the lifetime of the handle.  This is "
37166 "called the private data area and is only available from the C API."
37167 msgstr ""
37168
37169 #. type: textblock
37170 #: ../src/guestfs.pod:2059
37171 msgid "To attach a named piece of data, use the following call:"
37172 msgstr ""
37173
37174 #. type: verbatim
37175 #: ../src/guestfs.pod:2061
37176 #, no-wrap
37177 msgid ""
37178 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
37179 "\n"
37180 msgstr ""
37181
37182 #. type: textblock
37183 #: ../src/guestfs.pod:2063
37184 msgid ""
37185 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
37186 "pointer (which can be C<NULL>).  Any previous item with the same key is "
37187 "overwritten."
37188 msgstr ""
37189
37190 #. type: textblock
37191 #: ../src/guestfs.pod:2067
37192 msgid ""
37193 "You can use any C<key> you want, but your key should I<not> start with an "
37194 "underscore character.  Keys beginning with an underscore character are "
37195 "reserved for internal libguestfs purposes (eg. for implementing language "
37196 "bindings).  It is recommended that you prefix the key with some unique "
37197 "string to avoid collisions with other users."
37198 msgstr ""
37199
37200 #. type: textblock
37201 #: ../src/guestfs.pod:2073
37202 msgid "To retrieve the pointer, use:"
37203 msgstr ""
37204
37205 #. type: verbatim
37206 #: ../src/guestfs.pod:2075
37207 #, no-wrap
37208 msgid ""
37209 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
37210 "\n"
37211 msgstr ""
37212
37213 #. type: textblock
37214 #: ../src/guestfs.pod:2077
37215 msgid ""
37216 "This function returns C<NULL> if either no data is found associated with "
37217 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
37218 "C<NULL>."
37219 msgstr ""
37220
37221 #. type: textblock
37222 #: ../src/guestfs.pod:2081
37223 msgid ""
37224 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
37225 "way.  As far as libguestfs is concerned, it need not be a valid pointer at "
37226 "all.  In particular, libguestfs does I<not> try to free the data when the "
37227 "handle is closed.  If the data must be freed, then the caller must either "
37228 "free it before calling L</guestfs_close> or must set up a close callback to "
37229 "do it (see L</GUESTFS_EVENT_CLOSE>)."
37230 msgstr ""
37231
37232 #. type: textblock
37233 #: ../src/guestfs.pod:2088
37234 msgid "To walk over all entries, use these two functions:"
37235 msgstr ""
37236
37237 #. type: verbatim
37238 #: ../src/guestfs.pod:2090
37239 #, no-wrap
37240 msgid ""
37241 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
37242 "\n"
37243 msgstr ""
37244
37245 #. type: verbatim
37246 #: ../src/guestfs.pod:2092
37247 #, no-wrap
37248 msgid ""
37249 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
37250 "\n"
37251 msgstr ""
37252
37253 #. type: textblock
37254 #: ../src/guestfs.pod:2094
37255 msgid ""
37256 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
37257 "not have any particular meaning -- keys are not returned in any defined "
37258 "order).  A pointer to the key is returned in C<*key_rtn> and the "
37259 "corresponding data pointer is returned from the function.  C<NULL> is "
37260 "returned if there are no keys stored in the handle."
37261 msgstr ""
37262
37263 #. type: textblock
37264 #: ../src/guestfs.pod:2100
37265 msgid ""
37266 "C<guestfs_next_private> returns the next key, pointer pair.  The return "
37267 "value of this function is also C<NULL> is there are no further entries to "
37268 "return."
37269 msgstr ""
37270
37271 #. type: textblock
37272 #: ../src/guestfs.pod:2104
37273 msgid "Notes about walking over entries:"
37274 msgstr ""
37275
37276 #. type: textblock
37277 #: ../src/guestfs.pod:2110
37278 msgid "You must not call C<guestfs_set_private> while walking over the entries."
37279 msgstr ""
37280
37281 #. type: textblock
37282 #: ../src/guestfs.pod:2115
37283 msgid ""
37284 "The handle maintains an internal iterator which is reset when you call "
37285 "C<guestfs_first_private>.  This internal iterator is invalidated when you "
37286 "call C<guestfs_set_private>."
37287 msgstr ""
37288
37289 #. type: textblock
37290 #: ../src/guestfs.pod:2121
37291 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
37292 msgstr ""
37293
37294 #. type: verbatim
37295 #: ../src/guestfs.pod:2123
37296 #, no-wrap
37297 msgid ""
37298 " guestfs_set_private (g, key, NULL);\n"
37299 "\n"
37300 msgstr ""
37301
37302 #. type: textblock
37303 #: ../src/guestfs.pod:2125
37304 msgid "then that C<key> is not returned when walking."
37305 msgstr ""
37306
37307 #. type: textblock
37308 #: ../src/guestfs.pod:2129
37309 msgid ""
37310 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
37311 "C<guestfs_next_private> or C<guestfs_set_private>."
37312 msgstr ""
37313
37314 #. type: textblock
37315 #: ../src/guestfs.pod:2135
37316 msgid ""
37317 "The following example code shows how to print all keys and data pointers "
37318 "that are associated with the handle C<g>:"
37319 msgstr ""
37320
37321 #. type: verbatim
37322 #: ../src/guestfs.pod:2138
37323 #, no-wrap
37324 msgid ""
37325 " const char *key;\n"
37326 " void *data = guestfs_first_private (g, &key);\n"
37327 " while (data != NULL)\n"
37328 "   {\n"
37329 "     printf (\"key = %s, data = %p\\n\", key, data);\n"
37330 "     data = guestfs_next_private (g, &key);\n"
37331 "   }\n"
37332 "\n"
37333 msgstr ""
37334
37335 #. type: textblock
37336 #: ../src/guestfs.pod:2146
37337 msgid ""
37338 "More commonly you are only interested in keys that begin with an "
37339 "application-specific prefix C<foo_>.  Modify the loop like so:"
37340 msgstr ""
37341
37342 #. type: verbatim
37343 #: ../src/guestfs.pod:2149
37344 #, no-wrap
37345 msgid ""
37346 " const char *key;\n"
37347 " void *data = guestfs_first_private (g, &key);\n"
37348 " while (data != NULL)\n"
37349 "   {\n"
37350 "     if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
37351 "       printf (\"key = %s, data = %p\\n\", key, data);\n"
37352 "     data = guestfs_next_private (g, &key);\n"
37353 "   }\n"
37354 "\n"
37355 msgstr ""
37356
37357 #. type: textblock
37358 #: ../src/guestfs.pod:2158
37359 msgid ""
37360 "If you need to modify keys while walking, then you have to jump back to the "
37361 "beginning of the loop.  For example, to delete all keys prefixed with "
37362 "C<foo_>:"
37363 msgstr ""
37364
37365 #. type: verbatim
37366 #: ../src/guestfs.pod:2162
37367 #, no-wrap
37368 msgid ""
37369 "  const char *key;\n"
37370 "  void *data;\n"
37371 " again:\n"
37372 "  data = guestfs_first_private (g, &key);\n"
37373 "  while (data != NULL)\n"
37374 "    {\n"
37375 "      if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
37376 "        {\n"
37377 "          guestfs_set_private (g, key, NULL);\n"
37378 "          /* note that 'key' pointer is now invalid, and so is\n"
37379 "             the internal iterator */\n"
37380 "          goto again;\n"
37381 "        }\n"
37382 "      data = guestfs_next_private (g, &key);\n"
37383 "    }\n"
37384 "\n"
37385 msgstr ""
37386
37387 #. type: textblock
37388 #: ../src/guestfs.pod:2178
37389 msgid ""
37390 "Note that the above loop is guaranteed to terminate because the keys are "
37391 "being deleted, but other manipulations of keys within the loop might not "
37392 "terminate unless you also maintain an indication of which keys have been "
37393 "visited."
37394 msgstr ""
37395
37396 #. type: =head1
37397 #: ../src/guestfs.pod:2183
37398 msgid "SYSTEMTAP"
37399 msgstr ""
37400
37401 #. type: textblock
37402 #: ../src/guestfs.pod:2185
37403 msgid ""
37404 "The libguestfs C library can be probed using systemtap or DTrace.  This is "
37405 "true of any library, not just libguestfs.  However libguestfs also contains "
37406 "static markers to help in probing internal operations."
37407 msgstr ""
37408
37409 #. type: textblock
37410 #: ../src/guestfs.pod:2189
37411 msgid "You can list all the static markers by doing:"
37412 msgstr ""
37413
37414 #. type: verbatim
37415 #: ../src/guestfs.pod:2191
37416 #, no-wrap
37417 msgid ""
37418 " stap -l 'process(\"/usr/lib*/libguestfs.so.0\")\n"
37419 "              .provider(\"guestfs\").mark(\"*\")'\n"
37420 "\n"
37421 msgstr ""
37422
37423 #. type: textblock
37424 #: ../src/guestfs.pod:2194
37425 msgid ""
37426 "B<Note:> These static markers are I<not> part of the stable API and may "
37427 "change in future versions."
37428 msgstr ""
37429
37430 #. type: =head2
37431 #: ../src/guestfs.pod:2197
37432 msgid "SYSTEMTAP SCRIPT EXAMPLE"
37433 msgstr ""
37434
37435 #. type: textblock
37436 #: ../src/guestfs.pod:2199
37437 msgid ""
37438 "This script contains examples of displaying both the static markers and some "
37439 "ordinary C entry points:"
37440 msgstr ""
37441
37442 #. type: verbatim
37443 #: ../src/guestfs.pod:2202
37444 #, no-wrap
37445 msgid ""
37446 " global last;\n"
37447 " \n"
37448 msgstr ""
37449
37450 #. type: verbatim
37451 #: ../src/guestfs.pod:2204
37452 #, no-wrap
37453 msgid ""
37454 " function display_time () {\n"
37455 "       now = gettimeofday_us ();\n"
37456 "       delta = 0;\n"
37457 "       if (last > 0)\n"
37458 "             delta = now - last;\n"
37459 "       last = now;\n"
37460 " \n"
37461 msgstr ""
37462
37463 #. type: verbatim
37464 #: ../src/guestfs.pod:2211
37465 #, no-wrap
37466 msgid ""
37467 "       printf (\"%d (+%d):\", now, delta);\n"
37468 " }\n"
37469 " \n"
37470 msgstr ""
37471
37472 #. type: verbatim
37473 #: ../src/guestfs.pod:2214
37474 #, no-wrap
37475 msgid ""
37476 " probe begin {\n"
37477 "       last = 0;\n"
37478 "       printf (\"ready\\n\");\n"
37479 " }\n"
37480 " \n"
37481 msgstr ""
37482
37483 #. type: verbatim
37484 #: ../src/guestfs.pod:2219
37485 #, no-wrap
37486 msgid ""
37487 " /* Display all calls to static markers. */\n"
37488 " probe process(\"/usr/lib*/libguestfs.so.0\")\n"
37489 "           .provider(\"guestfs\").mark(\"*\") ? {\n"
37490 "       display_time();\n"
37491 "       printf (\"\\t%s %s\\n\", $$name, $$parms);\n"
37492 " }\n"
37493 " \n"
37494 msgstr ""
37495
37496 #. type: verbatim
37497 #: ../src/guestfs.pod:2226
37498 #, no-wrap
37499 msgid ""
37500 " /* Display all calls to guestfs_mkfs* functions. */\n"
37501 " probe process(\"/usr/lib*/libguestfs.so.0\")\n"
37502 "           .function(\"guestfs_mkfs*\") ? {\n"
37503 "       display_time();\n"
37504 "       printf (\"\\t%s %s\\n\", probefunc(), $$parms);\n"
37505 " }\n"
37506 "\n"
37507 msgstr ""
37508
37509 #. type: textblock
37510 #: ../src/guestfs.pod:2233
37511 msgid ""
37512 "The script above can be saved to C<test.stap> and run using the L<stap(1)> "
37513 "program.  Note that you either have to be root, or you have to add yourself "
37514 "to several special stap groups.  Consult the systemtap documentation for "
37515 "more information."
37516 msgstr ""
37517
37518 #. type: verbatim
37519 #: ../src/guestfs.pod:2238
37520 #, no-wrap
37521 msgid ""
37522 " # stap /tmp/test.stap\n"
37523 " ready\n"
37524 "\n"
37525 msgstr ""
37526
37527 #. type: textblock
37528 #: ../src/guestfs.pod:2241
37529 msgid "In another terminal, run a guestfish command such as this:"
37530 msgstr ""
37531
37532 #. type: textblock
37533 #: ../src/guestfs.pod:2245
37534 msgid "In the first terminal, stap trace output similar to this is shown:"
37535 msgstr ""
37536
37537 #. type: verbatim
37538 #: ../src/guestfs.pod:2247
37539 #, no-wrap
37540 msgid ""
37541 " 1318248056692655 (+0):\tlaunch_start\n"
37542 " 1318248056692850 (+195):       launch_build_appliance_start\n"
37543 " 1318248056818285 (+125435):    launch_build_appliance_end\n"
37544 " 1318248056838059 (+19774):     launch_run_qemu\n"
37545 " 1318248061071167 (+4233108):   launch_end\n"
37546 " 1318248061280324 (+209157):    guestfs_mkfs g=0x1024ab0 fstype=0x46116f "
37547 "device=0x1024e60\n"
37548 "\n"
37549 msgstr ""
37550
37551 #. type: =end
37552 #: ../src/guestfs.pod:2254 ../src/guestfs.pod:2259
37553 msgid "html"
37554 msgstr ""
37555
37556 #. type: textblock
37557 #: ../src/guestfs.pod:2256
37558 msgid ""
37559 "<!-- old anchor for the next section --> <a "
37560 "name=\"state_machine_and_low_level_event_api\"/>"
37561 msgstr ""
37562
37563 #. type: =head1
37564 #: ../src/guestfs.pod:2261
37565 msgid "ARCHITECTURE"
37566 msgstr ""
37567
37568 #. type: textblock
37569 #: ../src/guestfs.pod:2263
37570 msgid ""
37571 "Internally, libguestfs is implemented by running an appliance (a special "
37572 "type of small virtual machine) using L<qemu(1)>.  Qemu runs as a child "
37573 "process of the main program."
37574 msgstr ""
37575
37576 #. type: verbatim
37577 #: ../src/guestfs.pod:2267
37578 #, no-wrap
37579 msgid ""
37580 "  ___________________\n"
37581 " /                   \\\n"
37582 " | main program      |\n"
37583 " |                   |\n"
37584 " |                   |           child process / appliance\n"
37585 " |                   |           __________________________\n"
37586 " |                   |          / qemu                     \\\n"
37587 " +-------------------+   RPC    |      +-----------------+ |\n"
37588 " | libguestfs     <--------------------> guestfsd        | |\n"
37589 " |                   |          |      +-----------------+ |\n"
37590 " \\___________________/          |      | Linux kernel    | |\n"
37591 "                                |      +--^--------------+ |\n"
37592 "                                \\_________|________________/\n"
37593 "                                          |\n"
37594 "                                   _______v______\n"
37595 "                                  /              \\\n"
37596 "                                  | Device or    |\n"
37597 "                                  | disk image   |\n"
37598 "                                  \\______________/\n"
37599 "\n"
37600 msgstr ""
37601
37602 #. type: textblock
37603 #: ../src/guestfs.pod:2287
37604 msgid ""
37605 "The library, linked to the main program, creates the child process and hence "
37606 "the appliance in the L</guestfs_launch> function."
37607 msgstr ""
37608
37609 #. type: textblock
37610 #: ../src/guestfs.pod:2290
37611 msgid ""
37612 "Inside the appliance is a Linux kernel and a complete stack of userspace "
37613 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
37614 "L</guestfsd>.  The library talks to L</guestfsd> using remote procedure "
37615 "calls (RPC).  There is a mostly one-to-one correspondence between libguestfs "
37616 "API calls and RPC calls to the daemon.  Lastly the disk image(s) are "
37617 "attached to the qemu process which translates device access by the "
37618 "appliance's Linux kernel into accesses to the image."
37619 msgstr ""
37620
37621 #. type: textblock
37622 #: ../src/guestfs.pod:2299
37623 msgid ""
37624 "A common misunderstanding is that the appliance \"is\" the virtual machine.  "
37625 "Although the disk image you are attached to might also be used by some "
37626 "virtual machine, libguestfs doesn't know or care about this.  (But you will "
37627 "care if both libguestfs's qemu process and your virtual machine are trying "
37628 "to update the disk image at the same time, since these usually results in "
37629 "massive disk corruption)."
37630 msgstr ""
37631
37632 #. type: =head1
37633 #: ../src/guestfs.pod:2306
37634 msgid "STATE MACHINE"
37635 msgstr ""
37636
37637 #. type: textblock
37638 #: ../src/guestfs.pod:2308
37639 msgid "libguestfs uses a state machine to model the child process:"
37640 msgstr ""
37641
37642 #. type: verbatim
37643 #: ../src/guestfs.pod:2310
37644 #, no-wrap
37645 msgid ""
37646 "                         |\n"
37647 "                    guestfs_create\n"
37648 "                         |\n"
37649 "                         |\n"
37650 "                     ____V_____\n"
37651 "                    /          \\\n"
37652 "                    |  CONFIG  |\n"
37653 "                    \\__________/\n"
37654 "                     ^ ^   ^  \\\n"
37655 "                    /  |    \\  \\ guestfs_launch\n"
37656 "                   /   |    _\\__V______\n"
37657 "                  /    |   /           \\\n"
37658 "                 /     |   | LAUNCHING |\n"
37659 "                /      |   \\___________/\n"
37660 "               /       |       /\n"
37661 "              /        |  guestfs_launch\n"
37662 "             /         |     /\n"
37663 "    ______  /        __|____V\n"
37664 "   /      \\ ------> /        \\\n"
37665 "   | BUSY |         | READY  |\n"
37666 "   \\______/ <------ \\________/\n"
37667 "\n"
37668 msgstr ""
37669
37670 #. type: textblock
37671 #: ../src/guestfs.pod:2332
37672 msgid ""
37673 "The normal transitions are (1) CONFIG (when the handle is created, but there "
37674 "is no child process), (2) LAUNCHING (when the child process is booting up), "
37675 "(3) alternating between READY and BUSY as commands are issued to, and "
37676 "carried out by, the child process."
37677 msgstr ""
37678
37679 #. type: textblock
37680 #: ../src/guestfs.pod:2337
37681 msgid ""
37682 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
37683 "asynchronously at any time (eg. due to some internal error), and that causes "
37684 "the state to transition back to CONFIG."
37685 msgstr ""
37686
37687 #. type: textblock
37688 #: ../src/guestfs.pod:2341
37689 msgid ""
37690 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
37691 "issued when in the CONFIG state."
37692 msgstr ""
37693
37694 #. type: textblock
37695 #: ../src/guestfs.pod:2344
37696 msgid ""
37697 "The API offers one call that goes from CONFIG through LAUNCHING to READY.  "
37698 "L</guestfs_launch> blocks until the child process is READY to accept "
37699 "commands (or until some failure or timeout).  L</guestfs_launch> internally "
37700 "moves the state from CONFIG to LAUNCHING while it is running."
37701 msgstr ""
37702
37703 #. type: textblock
37704 #: ../src/guestfs.pod:2350
37705 msgid ""
37706 "API actions such as L</guestfs_mount> can only be issued when in the READY "
37707 "state.  These API calls block waiting for the command to be carried out "
37708 "(ie. the state to transition to BUSY and then back to READY).  There are no "
37709 "non-blocking versions, and no way to issue more than one command per handle "
37710 "at the same time."
37711 msgstr ""
37712
37713 #. type: textblock
37714 #: ../src/guestfs.pod:2356
37715 msgid ""
37716 "Finally, the child process sends asynchronous messages back to the main "
37717 "program, such as kernel log messages.  You can register a callback to "
37718 "receive these messages."
37719 msgstr ""
37720
37721 #. type: =head1
37722 #: ../src/guestfs.pod:2360
37723 msgid "INTERNALS"
37724 msgstr ""
37725
37726 #. type: =head2
37727 #: ../src/guestfs.pod:2362
37728 msgid "APPLIANCE BOOT PROCESS"
37729 msgstr ""
37730
37731 #. type: textblock
37732 #: ../src/guestfs.pod:2364
37733 msgid ""
37734 "This process has evolved and continues to evolve.  The description here "
37735 "corresponds only to the current version of libguestfs and is provided for "
37736 "information only."
37737 msgstr ""
37738
37739 #. type: textblock
37740 #: ../src/guestfs.pod:2368
37741 msgid ""
37742 "In order to follow the stages involved below, enable libguestfs debugging "
37743 "(set the environment variable C<LIBGUESTFS_DEBUG=1>)."
37744 msgstr ""
37745
37746 #. type: =item
37747 #: ../src/guestfs.pod:2373
37748 msgid "Create the appliance"
37749 msgstr ""
37750
37751 #. type: textblock
37752 #: ../src/guestfs.pod:2375
37753 msgid ""
37754 "C<febootstrap-supermin-helper> is invoked to create the kernel, a small "
37755 "initrd and the appliance."
37756 msgstr ""
37757
37758 #. type: textblock
37759 #: ../src/guestfs.pod:2378
37760 msgid ""
37761 "The appliance is cached in C</var/tmp/.guestfs-E<lt>UIDE<gt>> (or in another "
37762 "directory if C<TMPDIR> is set)."
37763 msgstr ""
37764
37765 #. type: textblock
37766 #: ../src/guestfs.pod:2381
37767 msgid ""
37768 "For a complete description of how the appliance is created and cached, read "
37769 "the L<febootstrap(8)> and L<febootstrap-supermin-helper(8)> man pages."
37770 msgstr ""
37771
37772 #. type: =item
37773 #: ../src/guestfs.pod:2385
37774 msgid "Start qemu and boot the kernel"
37775 msgstr ""
37776
37777 #. type: textblock
37778 #: ../src/guestfs.pod:2387
37779 msgid "qemu is invoked to boot the kernel."
37780 msgstr ""
37781
37782 #. type: =item
37783 #: ../src/guestfs.pod:2389
37784 msgid "Run the initrd"
37785 msgstr ""
37786
37787 #. type: textblock
37788 #: ../src/guestfs.pod:2391
37789 msgid ""
37790 "C<febootstrap-supermin-helper> builds a small initrd.  The initrd is not the "
37791 "appliance.  The purpose of the initrd is to load enough kernel modules in "
37792 "order that the appliance itself can be mounted and started."
37793 msgstr ""
37794
37795 #. type: textblock
37796 #: ../src/guestfs.pod:2395
37797 msgid ""
37798 "The initrd is a cpio archive called "
37799 "C</var/tmp/.guestfs-E<lt>UIDE<gt>/initrd>."
37800 msgstr ""
37801
37802 #. type: textblock
37803 #: ../src/guestfs.pod:2398
37804 msgid ""
37805 "When the initrd has started you will see messages showing that kernel "
37806 "modules are being loaded, similar to this:"
37807 msgstr ""
37808
37809 #. type: verbatim
37810 #: ../src/guestfs.pod:2401
37811 #, no-wrap
37812 msgid ""
37813 " febootstrap: ext2 mini initrd starting up\n"
37814 " febootstrap: mounting /sys\n"
37815 " febootstrap: internal insmod libcrc32c.ko\n"
37816 " febootstrap: internal insmod crc32c-intel.ko\n"
37817 "\n"
37818 msgstr ""
37819
37820 #. type: =item
37821 #: ../src/guestfs.pod:2406
37822 msgid "Find and mount the appliance device"
37823 msgstr ""
37824
37825 #. type: textblock
37826 #: ../src/guestfs.pod:2408
37827 msgid ""
37828 "The appliance is a sparse file containing an ext2 filesystem which contains "
37829 "a familiar (although reduced in size) Linux operating system.  It would "
37830 "normally be called C</var/tmp/.guestfs-E<lt>UIDE<gt>/root>."
37831 msgstr ""
37832
37833 #. type: textblock
37834 #: ../src/guestfs.pod:2412
37835 msgid ""
37836 "The regular disks being inspected by libguestfs are the first devices "
37837 "exposed by qemu (eg. as C</dev/vda>)."
37838 msgstr ""
37839
37840 #. type: textblock
37841 #: ../src/guestfs.pod:2415
37842 msgid ""
37843 "The last disk added to qemu is the appliance itself (eg. C</dev/vdb> if "
37844 "there was only one regular disk)."
37845 msgstr ""
37846
37847 #. type: textblock
37848 #: ../src/guestfs.pod:2418
37849 msgid ""
37850 "Thus the final job of the initrd is to locate the appliance disk, mount it, "
37851 "and switch root into the appliance, and run C</init> from the appliance."
37852 msgstr ""
37853
37854 #. type: textblock
37855 #: ../src/guestfs.pod:2422
37856 msgid "If this works successfully you will see messages such as:"
37857 msgstr ""
37858
37859 #. type: verbatim
37860 #: ../src/guestfs.pod:2424
37861 #, no-wrap
37862 msgid ""
37863 " febootstrap: picked /sys/block/vdb/dev as root device\n"
37864 " febootstrap: creating /dev/root as block special 252:16\n"
37865 " febootstrap: mounting new root on /root\n"
37866 " febootstrap: chroot\n"
37867 " Starting /init script ...\n"
37868 "\n"
37869 msgstr ""
37870
37871 #. type: textblock
37872 #: ../src/guestfs.pod:2430
37873 msgid ""
37874 "Note that C<Starting /init script ...> indicates that the appliance's init "
37875 "script is now running."
37876 msgstr ""
37877
37878 #. type: =item
37879 #: ../src/guestfs.pod:2433
37880 msgid "Initialize the appliance"
37881 msgstr ""
37882
37883 #. type: textblock
37884 #: ../src/guestfs.pod:2435
37885 msgid ""
37886 "The appliance itself now initializes itself.  This involves starting certain "
37887 "processes like C<udev>, possibly printing some debug information, and "
37888 "finally running the daemon (C<guestfsd>)."
37889 msgstr ""
37890
37891 #. type: =item
37892 #: ../src/guestfs.pod:2439
37893 msgid "The daemon"
37894 msgstr ""
37895
37896 #. type: textblock
37897 #: ../src/guestfs.pod:2441
37898 msgid ""
37899 "Finally the daemon (C<guestfsd>) runs inside the appliance.  If it runs you "
37900 "should see:"
37901 msgstr ""
37902
37903 #. type: verbatim
37904 #: ../src/guestfs.pod:2444
37905 #, no-wrap
37906 msgid ""
37907 " verbose daemon enabled\n"
37908 "\n"
37909 msgstr ""
37910
37911 #. type: textblock
37912 #: ../src/guestfs.pod:2446
37913 msgid ""
37914 "The daemon expects to see a named virtio-serial port exposed by qemu and "
37915 "connected on the other end to the library."
37916 msgstr ""
37917
37918 #. type: textblock
37919 #: ../src/guestfs.pod:2449
37920 msgid ""
37921 "The daemon connects to this port (and hence to the library) and sends a four "
37922 "byte message C<GUESTFS_LAUNCH_FLAG>, which initiates the communication "
37923 "protocol (see below)."
37924 msgstr ""
37925
37926 #. type: =head2
37927 #: ../src/guestfs.pod:2455
37928 msgid "COMMUNICATION PROTOCOL"
37929 msgstr ""
37930
37931 #. type: textblock
37932 #: ../src/guestfs.pod:2457
37933 msgid ""
37934 "Don't rely on using this protocol directly.  This section documents how it "
37935 "currently works, but it may change at any time."
37936 msgstr ""
37937
37938 #. type: textblock
37939 #: ../src/guestfs.pod:2460
37940 msgid ""
37941 "The protocol used to talk between the library and the daemon running inside "
37942 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
37943 "1014, RFC 1832, RFC 4506)."
37944 msgstr ""
37945
37946 #. type: textblock
37947 #: ../src/guestfs.pod:2464
37948 msgid ""
37949 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
37950 "this file is automatically generated)."
37951 msgstr ""
37952
37953 #. type: textblock
37954 #: ../src/guestfs.pod:2467
37955 msgid ""
37956 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
37957 "and C<FileOut> parameters, which are handled with very simple request/reply "
37958 "messages.  Then there are functions that have any C<FileIn> or C<FileOut> "
37959 "parameters, which use the same request and reply messages, but they may also "
37960 "be followed by files sent using a chunked encoding."
37961 msgstr ""
37962
37963 #. type: =head3
37964 #: ../src/guestfs.pod:2474
37965 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
37966 msgstr ""
37967
37968 #. type: textblock
37969 #: ../src/guestfs.pod:2476
37970 msgid "For ordinary functions, the request message is:"
37971 msgstr ""
37972
37973 #. type: verbatim
37974 #: ../src/guestfs.pod:2478
37975 #, no-wrap
37976 msgid ""
37977 " total length (header + arguments,\n"
37978 "      but not including the length word itself)\n"
37979 " struct guestfs_message_header (encoded as XDR)\n"
37980 " struct guestfs_<foo>_args (encoded as XDR)\n"
37981 "\n"
37982 msgstr ""
37983
37984 #. type: textblock
37985 #: ../src/guestfs.pod:2483
37986 msgid ""
37987 "The total length field allows the daemon to allocate a fixed size buffer "
37988 "into which it slurps the rest of the message.  As a result, the total length "
37989 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
37990 "effective size of any request is limited to somewhere under this size."
37991 msgstr ""
37992
37993 #. type: textblock
37994 #: ../src/guestfs.pod:2489
37995 msgid ""
37996 "Note also that many functions don't take any arguments, in which case the "
37997 "C<guestfs_I<foo>_args> is completely omitted."
37998 msgstr ""
37999
38000 #. type: textblock
38001 #: ../src/guestfs.pod:2492
38002 msgid ""
38003 "The header contains the procedure number (C<guestfs_proc>) which is how the "
38004 "receiver knows what type of args structure to expect, or none at all."
38005 msgstr ""
38006
38007 #. type: textblock
38008 #: ../src/guestfs.pod:2496
38009 msgid ""
38010 "For functions that take optional arguments, the optional arguments are "
38011 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
38012 "arguments.  A bitmask in the header indicates which optional arguments are "
38013 "meaningful.  The bitmask is also checked to see if it contains bits set "
38014 "which the daemon does not know about (eg. if more optional arguments were "
38015 "added in a later version of the library), and this causes the call to be "
38016 "rejected."
38017 msgstr ""
38018
38019 #. type: textblock
38020 #: ../src/guestfs.pod:2504
38021 msgid "The reply message for ordinary functions is:"
38022 msgstr ""
38023
38024 #. type: verbatim
38025 #: ../src/guestfs.pod:2506
38026 #, no-wrap
38027 msgid ""
38028 " total length (header + ret,\n"
38029 "      but not including the length word itself)\n"
38030 " struct guestfs_message_header (encoded as XDR)\n"
38031 " struct guestfs_<foo>_ret (encoded as XDR)\n"
38032 "\n"
38033 msgstr ""
38034
38035 #. type: textblock
38036 #: ../src/guestfs.pod:2511
38037 msgid ""
38038 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
38039 "functions that return no formal return values."
38040 msgstr ""
38041
38042 #. type: textblock
38043 #: ../src/guestfs.pod:2514
38044 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
38045 msgstr ""
38046
38047 #. type: textblock
38048 #: ../src/guestfs.pod:2517
38049 msgid ""
38050 "In the case of an error, a flag is set in the header, and the reply message "
38051 "is slightly changed:"
38052 msgstr ""
38053
38054 #. type: verbatim
38055 #: ../src/guestfs.pod:2520
38056 #, no-wrap
38057 msgid ""
38058 " total length (header + error,\n"
38059 "      but not including the length word itself)\n"
38060 " struct guestfs_message_header (encoded as XDR)\n"
38061 " struct guestfs_message_error (encoded as XDR)\n"
38062 "\n"
38063 msgstr ""
38064
38065 #. type: textblock
38066 #: ../src/guestfs.pod:2525
38067 msgid ""
38068 "The C<guestfs_message_error> structure contains the error message as a "
38069 "string."
38070 msgstr ""
38071
38072 #. type: =head3
38073 #: ../src/guestfs.pod:2528
38074 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
38075 msgstr ""
38076
38077 #. type: textblock
38078 #: ../src/guestfs.pod:2530
38079 msgid ""
38080 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest.  "
38081 "The normal request message is sent (see above).  However this is followed by "
38082 "a sequence of file chunks."
38083 msgstr ""
38084
38085 #. type: verbatim
38086 #: ../src/guestfs.pod:2534
38087 #, no-wrap
38088 msgid ""
38089 " total length (header + arguments,\n"
38090 "      but not including the length word itself,\n"
38091 "      and not including the chunks)\n"
38092 " struct guestfs_message_header (encoded as XDR)\n"
38093 " struct guestfs_<foo>_args (encoded as XDR)\n"
38094 " sequence of chunks for FileIn param #0\n"
38095 " sequence of chunks for FileIn param #1 etc.\n"
38096 "\n"
38097 msgstr ""
38098
38099 #. type: textblock
38100 #: ../src/guestfs.pod:2542
38101 msgid "The \"sequence of chunks\" is:"
38102 msgstr ""
38103
38104 #. type: verbatim
38105 #: ../src/guestfs.pod:2544
38106 #, no-wrap
38107 msgid ""
38108 " length of chunk (not including length word itself)\n"
38109 " struct guestfs_chunk (encoded as XDR)\n"
38110 " length of chunk\n"
38111 " struct guestfs_chunk (encoded as XDR)\n"
38112 "   ...\n"
38113 " length of chunk\n"
38114 " struct guestfs_chunk (with data.data_len == 0)\n"
38115 "\n"
38116 msgstr ""
38117
38118 #. type: textblock
38119 #: ../src/guestfs.pod:2552
38120 msgid ""
38121 "The final chunk has the C<data_len> field set to zero.  Additionally a flag "
38122 "is set in the final chunk to indicate either successful completion or early "
38123 "cancellation."
38124 msgstr ""
38125
38126 #. type: textblock
38127 #: ../src/guestfs.pod:2556
38128 msgid ""
38129 "At time of writing there are no functions that have more than one FileIn "
38130 "parameter.  However this is (theoretically) supported, by sending the "
38131 "sequence of chunks for each FileIn parameter one after another (from left to "
38132 "right)."
38133 msgstr ""
38134
38135 #. type: textblock
38136 #: ../src/guestfs.pod:2561
38137 msgid ""
38138 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
38139 "transfer.  The library does this by sending a chunk with a special flag set "
38140 "to indicate cancellation.  When the daemon sees this, it cancels the whole "
38141 "RPC, does I<not> send any reply, and goes back to reading the next request."
38142 msgstr ""
38143
38144 #. type: textblock
38145 #: ../src/guestfs.pod:2567
38146 msgid ""
38147 "The daemon may also cancel.  It does this by writing a special word "
38148 "C<GUESTFS_CANCEL_FLAG> to the socket.  The library listens for this during "
38149 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
38150 "cancel chunk).  The special word is chosen so that even if cancellation "
38151 "happens right at the end of the transfer (after the library has finished "
38152 "writing and has started listening for the reply), the \"spurious\" cancel "
38153 "flag will not be confused with the reply message."
38154 msgstr ""
38155
38156 #. type: textblock
38157 #: ../src/guestfs.pod:2576
38158 msgid ""
38159 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
38160 "limit), and also files where the size is not known in advance (eg. from "
38161 "pipes or sockets).  However the chunks are rather small "
38162 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
38163 "to keep much in memory."
38164 msgstr ""
38165
38166 #. type: =head3
38167 #: ../src/guestfs.pod:2582
38168 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
38169 msgstr ""
38170
38171 #. type: textblock
38172 #: ../src/guestfs.pod:2584
38173 msgid ""
38174 "The protocol for FileOut parameters is exactly the same as for FileIn "
38175 "parameters, but with the roles of daemon and library reversed."
38176 msgstr ""
38177
38178 #. type: verbatim
38179 #: ../src/guestfs.pod:2587
38180 #, no-wrap
38181 msgid ""
38182 " total length (header + ret,\n"
38183 "      but not including the length word itself,\n"
38184 "      and not including the chunks)\n"
38185 " struct guestfs_message_header (encoded as XDR)\n"
38186 " struct guestfs_<foo>_ret (encoded as XDR)\n"
38187 " sequence of chunks for FileOut param #0\n"
38188 " sequence of chunks for FileOut param #1 etc.\n"
38189 "\n"
38190 msgstr ""
38191
38192 #. type: =head3
38193 #: ../src/guestfs.pod:2595
38194 msgid "INITIAL MESSAGE"
38195 msgstr ""
38196
38197 #. type: textblock
38198 #: ../src/guestfs.pod:2597
38199 msgid ""
38200 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
38201 "which indicates that the guest and daemon is alive.  This is what "
38202 "L</guestfs_launch> waits for."
38203 msgstr ""
38204
38205 #. type: =head3
38206 #: ../src/guestfs.pod:2601
38207 msgid "PROGRESS NOTIFICATION MESSAGES"
38208 msgstr ""
38209
38210 #. type: textblock
38211 #: ../src/guestfs.pod:2603
38212 msgid ""
38213 "The daemon may send progress notification messages at any time.  These are "
38214 "distinguished by the normal length word being replaced by "
38215 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
38216 msgstr ""
38217
38218 #. type: textblock
38219 #: ../src/guestfs.pod:2607
38220 msgid ""
38221 "The library turns them into progress callbacks (see "
38222 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
38223 "them if not."
38224 msgstr ""
38225
38226 #. type: textblock
38227 #: ../src/guestfs.pod:2611
38228 msgid ""
38229 "The daemon self-limits the frequency of progress messages it sends (see "
38230 "C<daemon/proto.c:notify_progress>).  Not all calls generate progress "
38231 "messages."
38232 msgstr ""
38233
38234 #. type: =head1
38235 #: ../src/guestfs.pod:2615
38236 msgid "LIBGUESTFS VERSION NUMBERS"
38237 msgstr ""
38238
38239 #. type: textblock
38240 #: ../src/guestfs.pod:2617
38241 msgid ""
38242 "Since April 2010, libguestfs has started to make separate development and "
38243 "stable releases, along with corresponding branches in our git repository.  "
38244 "These separate releases can be identified by version number:"
38245 msgstr ""
38246
38247 #. type: verbatim
38248 #: ../src/guestfs.pod:2622
38249 #, no-wrap
38250 msgid ""
38251 "                 even numbers for stable: 1.2.x, 1.4.x, ...\n"
38252 "       .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
38253 "       |\n"
38254 "       v\n"
38255 " 1  .  3  .  5\n"
38256 " ^           ^\n"
38257 " |           |\n"
38258 " |           `-------- sub-version\n"
38259 " |\n"
38260 " `------ always '1' because we don't change the ABI\n"
38261 "\n"
38262 msgstr ""
38263
38264 #. type: textblock
38265 #: ../src/guestfs.pod:2633
38266 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
38267 msgstr ""
38268
38269 #. type: textblock
38270 #: ../src/guestfs.pod:2635
38271 msgid ""
38272 "As time passes we cherry pick fixes from the development branch and backport "
38273 "those into the stable branch, the effect being that the stable branch should "
38274 "get more stable and less buggy over time.  So the stable releases are ideal "
38275 "for people who don't need new features but would just like the software to "
38276 "work."
38277 msgstr ""
38278
38279 #. type: textblock
38280 #: ../src/guestfs.pod:2641
38281 msgid "Our criteria for backporting changes are:"
38282 msgstr ""
38283
38284 #. type: textblock
38285 #: ../src/guestfs.pod:2647
38286 msgid ""
38287 "Documentation changes which don't affect any code are backported unless the "
38288 "documentation refers to a future feature which is not in stable."
38289 msgstr ""
38290
38291 #. type: textblock
38292 #: ../src/guestfs.pod:2653
38293 msgid ""
38294 "Bug fixes which are not controversial, fix obvious problems, and have been "
38295 "well tested are backported."
38296 msgstr ""
38297
38298 #. type: textblock
38299 #: ../src/guestfs.pod:2658
38300 msgid ""
38301 "Simple rearrangements of code which shouldn't affect how it works get "
38302 "backported.  This is so that the code in the two branches doesn't get too "
38303 "far out of step, allowing us to backport future fixes more easily."
38304 msgstr ""
38305
38306 #. type: textblock
38307 #: ../src/guestfs.pod:2664
38308 msgid ""
38309 "We I<don't> backport new features, new APIs, new tools etc, except in one "
38310 "exceptional case: the new feature is required in order to implement an "
38311 "important bug fix."
38312 msgstr ""
38313
38314 #. type: textblock
38315 #: ../src/guestfs.pod:2670
38316 msgid ""
38317 "A new stable branch starts when we think the new features in development are "
38318 "substantial and compelling enough over the current stable branch to warrant "
38319 "it.  When that happens we create new stable and development versions 1.N.0 "
38320 "and 1.(N+1).0 [N is even].  The new dot-oh release won't necessarily be so "
38321 "stable at this point, but by backporting fixes from development, that branch "
38322 "will stabilize over time."
38323 msgstr ""
38324
38325 #. type: =head1
38326 #: ../src/guestfs.pod:2678
38327 msgid "EXTENDING LIBGUESTFS"
38328 msgstr ""
38329
38330 #. type: =head2
38331 #: ../src/guestfs.pod:2680
38332 msgid "ADDING A NEW API ACTION"
38333 msgstr ""
38334
38335 #. type: textblock
38336 #: ../src/guestfs.pod:2682
38337 msgid ""
38338 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
38339 "documentation) are generated, and this makes it easy to extend the "
38340 "libguestfs API."
38341 msgstr ""
38342
38343 #. type: textblock
38344 #: ../src/guestfs.pod:2686
38345 msgid "To add a new API action there are two changes:"
38346 msgstr ""
38347
38348 #. type: textblock
38349 #: ../src/guestfs.pod:2692
38350 msgid ""
38351 "You need to add a description of the call (name, parameters, return type, "
38352 "tests, documentation) to C<generator/generator_actions.ml>."
38353 msgstr ""
38354
38355 #. type: textblock
38356 #: ../src/guestfs.pod:2695
38357 msgid ""
38358 "There are two sorts of API action, depending on whether the call goes "
38359 "through to the daemon in the appliance, or is serviced entirely by the "
38360 "library (see L</ARCHITECTURE> above).  L</guestfs_sync> is an example of the "
38361 "former, since the sync is done in the appliance.  L</guestfs_set_trace> is "
38362 "an example of the latter, since a trace flag is maintained in the handle and "
38363 "all tracing is done on the library side."
38364 msgstr ""
38365
38366 #. type: textblock
38367 #: ../src/guestfs.pod:2703
38368 msgid ""
38369 "Most new actions are of the first type, and get added to the "
38370 "C<daemon_functions> list.  Each function has a unique procedure number used "
38371 "in the RPC protocol which is assigned to that action when we publish "
38372 "libguestfs and cannot be reused.  Take the latest procedure number and "
38373 "increment it."
38374 msgstr ""
38375
38376 #. type: textblock
38377 #: ../src/guestfs.pod:2709
38378 msgid ""
38379 "For library-only actions of the second type, add to the "
38380 "C<non_daemon_functions> list.  Since these functions are serviced by the "
38381 "library and do not travel over the RPC mechanism to the daemon, these "
38382 "functions do not need a procedure number, and so the procedure number is set "
38383 "to C<-1>."
38384 msgstr ""
38385
38386 #. type: textblock
38387 #: ../src/guestfs.pod:2717
38388 msgid "Implement the action (in C):"
38389 msgstr ""
38390
38391 #. type: textblock
38392 #: ../src/guestfs.pod:2719
38393 msgid ""
38394 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
38395 "C<daemon/> directory."
38396 msgstr ""
38397
38398 #. type: textblock
38399 #: ../src/guestfs.pod:2722
38400 msgid ""
38401 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
38402 "(note: double underscore) in the C<src/> directory."
38403 msgstr ""
38404
38405 #. type: textblock
38406 #: ../src/guestfs.pod:2725
38407 msgid "In either case, use another function as an example of what to do."
38408 msgstr ""
38409
38410 #. type: textblock
38411 #: ../src/guestfs.pod:2729
38412 msgid "After making these changes, use C<make> to compile."
38413 msgstr ""
38414
38415 #. type: textblock
38416 #: ../src/guestfs.pod:2731
38417 msgid ""
38418 "Note that you don't need to implement the RPC, language bindings, manual "
38419 "pages or anything else.  It's all automatically generated from the OCaml "
38420 "description."
38421 msgstr ""
38422
38423 #. type: =head2
38424 #: ../src/guestfs.pod:2735
38425 msgid "ADDING TESTS FOR AN API ACTION"
38426 msgstr ""
38427
38428 #. type: textblock
38429 #: ../src/guestfs.pod:2737
38430 msgid ""
38431 "You can supply zero or as many tests as you want per API call.  The tests "
38432 "can either be added as part of the API description "
38433 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
38434 "drop a script into C<regressions/>.  Note that adding a script to "
38435 "C<regressions/> is slower, so if possible use the first method."
38436 msgstr ""
38437
38438 #. type: textblock
38439 #: ../src/guestfs.pod:2743
38440 msgid ""
38441 "The following describes the test environment used when you add an API test "
38442 "in C<generator_actions.ml>."
38443 msgstr ""
38444
38445 #. type: textblock
38446 #: ../src/guestfs.pod:2746
38447 msgid "The test environment has 4 block devices:"
38448 msgstr ""
38449
38450 #. type: =item
38451 #: ../src/guestfs.pod:2750
38452 msgid "C</dev/sda> 500MB"
38453 msgstr ""
38454
38455 #. type: textblock
38456 #: ../src/guestfs.pod:2752
38457 msgid "General block device for testing."
38458 msgstr ""
38459
38460 #. type: =item
38461 #: ../src/guestfs.pod:2754
38462 msgid "C</dev/sdb> 50MB"
38463 msgstr ""
38464
38465 #. type: textblock
38466 #: ../src/guestfs.pod:2756
38467 msgid ""
38468 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
38469 "operations."
38470 msgstr ""
38471
38472 #. type: =item
38473 #: ../src/guestfs.pod:2759
38474 msgid "C</dev/sdc> 10MB"
38475 msgstr ""
38476
38477 #. type: textblock
38478 #: ../src/guestfs.pod:2761
38479 msgid "Used in a few tests where two block devices are needed."
38480 msgstr ""
38481
38482 #. type: =item
38483 #: ../src/guestfs.pod:2763
38484 msgid "C</dev/sdd>"
38485 msgstr ""
38486
38487 #. type: textblock
38488 #: ../src/guestfs.pod:2765
38489 msgid "ISO with fixed content (see C<images/test.iso>)."
38490 msgstr ""
38491
38492 #. type: textblock
38493 #: ../src/guestfs.pod:2769
38494 msgid ""
38495 "To be able to run the tests in a reasonable amount of time, the libguestfs "
38496 "appliance and block devices are reused between tests.  So don't try testing "
38497 "L</guestfs_kill_subprocess> :-x"
38498 msgstr ""
38499
38500 #. type: textblock
38501 #: ../src/guestfs.pod:2773
38502 msgid ""
38503 "Each test starts with an initial scenario, selected using one of the "
38504 "C<Init*> expressions, described in C<generator/generator_types.ml>.  These "
38505 "initialize the disks mentioned above in a particular way as documented in "
38506 "C<generator_types.ml>.  You should not assume anything about the previous "
38507 "contents of other disks that are not initialized."
38508 msgstr ""
38509
38510 #. type: textblock
38511 #: ../src/guestfs.pod:2779
38512 msgid ""
38513 "You can add a prerequisite clause to any individual test.  This is a "
38514 "run-time check, which, if it fails, causes the test to be skipped.  Useful "
38515 "if testing a command which might not work on all variations of libguestfs "
38516 "builds.  A test that has prerequisite of C<Always> means to run "
38517 "unconditionally."
38518 msgstr ""
38519
38520 #. type: textblock
38521 #: ../src/guestfs.pod:2785
38522 msgid ""
38523 "In addition, packagers can skip individual tests by setting environment "
38524 "variables before running C<make check>."
38525 msgstr ""
38526
38527 #. type: verbatim
38528 #: ../src/guestfs.pod:2788
38529 #, no-wrap
38530 msgid ""
38531 " SKIP_TEST_<CMD>_<NUM>=1\n"
38532 "\n"
38533 msgstr ""
38534
38535 #. type: textblock
38536 #: ../src/guestfs.pod:2790
38537 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
38538 msgstr ""
38539
38540 #. type: textblock
38541 #: ../src/guestfs.pod:2792
38542 msgid "or:"
38543 msgstr ""
38544
38545 #. type: verbatim
38546 #: ../src/guestfs.pod:2794
38547 #, no-wrap
38548 msgid ""
38549 " SKIP_TEST_<CMD>=1\n"
38550 "\n"
38551 msgstr ""
38552
38553 #. type: textblock
38554 #: ../src/guestfs.pod:2796
38555 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
38556 msgstr ""
38557
38558 #. type: textblock
38559 #: ../src/guestfs.pod:2798
38560 msgid "Packagers can run only certain tests by setting for example:"
38561 msgstr ""
38562
38563 #. type: verbatim
38564 #: ../src/guestfs.pod:2800
38565 #, no-wrap
38566 msgid ""
38567 " TEST_ONLY=\"vfs_type zerofree\"\n"
38568 "\n"
38569 msgstr ""
38570
38571 #. type: textblock
38572 #: ../src/guestfs.pod:2802
38573 msgid ""
38574 "See C<capitests/tests.c> for more details of how these environment variables "
38575 "work."
38576 msgstr ""
38577
38578 #. type: =head2
38579 #: ../src/guestfs.pod:2805
38580 msgid "DEBUGGING NEW API ACTIONS"
38581 msgstr ""
38582
38583 #. type: textblock
38584 #: ../src/guestfs.pod:2807
38585 msgid "Test new actions work before submitting them."
38586 msgstr ""
38587
38588 #. type: textblock
38589 #: ../src/guestfs.pod:2809
38590 msgid "You can use guestfish to try out new commands."
38591 msgstr ""
38592
38593 #. type: textblock
38594 #: ../src/guestfs.pod:2811
38595 msgid ""
38596 "Debugging the daemon is a problem because it runs inside a minimal "
38597 "environment.  However you can fprintf messages in the daemon to stderr, and "
38598 "they will show up if you use C<guestfish -v>."
38599 msgstr ""
38600
38601 #. type: =head2
38602 #: ../src/guestfs.pod:2815
38603 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
38604 msgstr ""
38605
38606 #. type: textblock
38607 #: ../src/guestfs.pod:2817
38608 msgid ""
38609 "Our C source code generally adheres to some basic code-formatting "
38610 "conventions.  The existing code base is not totally consistent on this "
38611 "front, but we do prefer that contributed code be formatted similarly.  In "
38612 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
38613 "indentation level, and other than that, follow the K&R style."
38614 msgstr ""
38615
38616 #. type: textblock
38617 #: ../src/guestfs.pod:2823
38618 msgid ""
38619 "If you use Emacs, add the following to one of one of your start-up files "
38620 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
38621 msgstr ""
38622
38623 #. type: verbatim
38624 #: ../src/guestfs.pod:2826
38625 #, no-wrap
38626 msgid ""
38627 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
38628 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
38629 " (add-hook 'find-file-hook\n"
38630 "     '(lambda () (if (and buffer-file-name\n"
38631 "                          (string-match \"/libguestfs\\\\>\"\n"
38632 "                              (buffer-file-name))\n"
38633 "                          (not (string-equal mode-name \"Change Log\"))\n"
38634 "                          (not (string-equal mode-name \"Makefile\")))\n"
38635 "                     (setq indent-tabs-mode nil))))\n"
38636 " \n"
38637 msgstr ""
38638
38639 #. type: verbatim
38640 #: ../src/guestfs.pod:2836
38641 #, no-wrap
38642 msgid ""
38643 " ;;; When editing C sources in libguestfs, use this style.\n"
38644 " (defun libguestfs-c-mode ()\n"
38645 "   \"C mode with adjusted defaults for use with libguestfs.\"\n"
38646 "   (interactive)\n"
38647 "   (c-set-style \"K&R\")\n"
38648 "   (setq c-indent-level 2)\n"
38649 "   (setq c-basic-offset 2))\n"
38650 " (add-hook 'c-mode-hook\n"
38651 "           '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
38652 "                               (buffer-file-name))\n"
38653 "                           (libguestfs-c-mode))))\n"
38654 "\n"
38655 msgstr ""
38656
38657 #. type: textblock
38658 #: ../src/guestfs.pod:2848
38659 msgid "Enable warnings when compiling (and fix any problems this finds):"
38660 msgstr ""
38661
38662 #. type: verbatim
38663 #: ../src/guestfs.pod:2851
38664 #, no-wrap
38665 msgid ""
38666 " ./configure --enable-gcc-warnings\n"
38667 "\n"
38668 msgstr ""
38669
38670 #. type: textblock
38671 #: ../src/guestfs.pod:2853
38672 msgid "Useful targets are:"
38673 msgstr ""
38674
38675 #. type: verbatim
38676 #: ../src/guestfs.pod:2855
38677 #, no-wrap
38678 msgid ""
38679 " make syntax-check  # checks the syntax of the C code\n"
38680 " make check         # runs the test suite\n"
38681 "\n"
38682 msgstr ""
38683
38684 #. type: =head2
38685 #: ../src/guestfs.pod:2858
38686 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
38687 msgstr ""
38688
38689 #. type: textblock
38690 #: ../src/guestfs.pod:2860
38691 msgid ""
38692 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
38693 "which are used to do shell quoting."
38694 msgstr ""
38695
38696 #. type: =item
38697 #: ../src/guestfs.pod:2865
38698 msgid "%Q"
38699 msgstr ""
38700
38701 #. type: textblock
38702 #: ../src/guestfs.pod:2867
38703 msgid ""
38704 "Simple shell quoted string.  Any spaces or other shell characters are "
38705 "escaped for you."
38706 msgstr ""
38707
38708 #. type: =item
38709 #: ../src/guestfs.pod:2870
38710 msgid "%R"
38711 msgstr ""
38712
38713 #. type: textblock
38714 #: ../src/guestfs.pod:2872
38715 msgid ""
38716 "Same as C<%Q> except the string is treated as a path which is prefixed by "
38717 "the sysroot."
38718 msgstr ""
38719
38720 #. type: verbatim
38721 #: ../src/guestfs.pod:2879
38722 #, no-wrap
38723 msgid ""
38724 " asprintf (&cmd, \"cat %R\", path);\n"
38725 "\n"
38726 msgstr ""
38727
38728 #. type: textblock
38729 #: ../src/guestfs.pod:2881
38730 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
38731 msgstr ""
38732
38733 #. type: textblock
38734 #: ../src/guestfs.pod:2883
38735 msgid ""
38736 "I<Note:> Do I<not> use these when you are passing parameters to the "
38737 "C<command{,r,v,rv}()> functions.  These parameters do NOT need to be quoted "
38738 "because they are not passed via the shell (instead, straight to exec).  You "
38739 "probably want to use the C<sysroot_path()> function however."
38740 msgstr ""
38741
38742 #. type: =head2
38743 #: ../src/guestfs.pod:2889
38744 msgid "SUBMITTING YOUR NEW API ACTIONS"
38745 msgstr ""
38746
38747 #. type: textblock
38748 #: ../src/guestfs.pod:2891
38749 msgid ""
38750 "Submit patches to the mailing list: "
38751 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
38752 "L<rjones@redhat.com>."
38753 msgstr ""
38754
38755 #. type: =head2
38756 #: ../src/guestfs.pod:2895
38757 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
38758 msgstr ""
38759
38760 #. type: textblock
38761 #: ../src/guestfs.pod:2897
38762 msgid "We support i18n (gettext anyhow) in the library."
38763 msgstr ""
38764
38765 #. type: textblock
38766 #: ../src/guestfs.pod:2899
38767 msgid ""
38768 "However many messages come from the daemon, and we don't translate those at "
38769 "the moment.  One reason is that the appliance generally has all locale files "
38770 "removed from it, because they take up a lot of space.  So we'd have to readd "
38771 "some of those, as well as copying our PO files into the appliance."
38772 msgstr ""
38773
38774 #. type: textblock
38775 #: ../src/guestfs.pod:2905
38776 msgid ""
38777 "Debugging messages are never translated, since they are intended for the "
38778 "programmers."
38779 msgstr ""
38780
38781 #. type: =head2
38782 #: ../src/guestfs.pod:2908
38783 msgid "SOURCE CODE SUBDIRECTORIES"
38784 msgstr ""
38785
38786 #. type: =item
38787 #: ../src/guestfs.pod:2912
38788 msgid "C<align>"
38789 msgstr ""
38790
38791 #. type: textblock
38792 #: ../src/guestfs.pod:2914
38793 msgid "L<virt-alignment-scan(1)> command and documentation."
38794 msgstr ""
38795
38796 #. type: textblock
38797 #: ../src/guestfs.pod:2918
38798 msgid "The libguestfs appliance, build scripts and so on."
38799 msgstr ""
38800
38801 #. type: =item
38802 #: ../src/guestfs.pod:2920
38803 msgid "C<capitests>"
38804 msgstr ""
38805
38806 #. type: textblock
38807 #: ../src/guestfs.pod:2922
38808 msgid "Automated tests of the C API."
38809 msgstr ""
38810
38811 #. type: =item
38812 #: ../src/guestfs.pod:2924
38813 msgid "C<cat>"
38814 msgstr ""
38815
38816 #. type: textblock
38817 #: ../src/guestfs.pod:2926
38818 msgid ""
38819 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
38820 "documentation."
38821 msgstr ""
38822
38823 #. type: =item
38824 #: ../src/guestfs.pod:2929
38825 msgid "C<caution>"
38826 msgstr ""
38827
38828 #. type: textblock
38829 #: ../src/guestfs.pod:2931
38830 msgid ""
38831 "Safety and liveness tests of components that libguestfs depends upon (not of "
38832 "libguestfs itself).  Mainly this is for qemu and the kernel."
38833 msgstr ""
38834
38835 #. type: =item
38836 #: ../src/guestfs.pod:2934
38837 msgid "C<clone>"
38838 msgstr ""
38839
38840 #. type: textblock
38841 #: ../src/guestfs.pod:2936
38842 msgid ""
38843 "Tools for cloning virtual machines.  Currently contains L<virt-sysprep(1)> "
38844 "command and documentation."
38845 msgstr ""
38846
38847 #. type: =item
38848 #: ../src/guestfs.pod:2939
38849 msgid "C<contrib>"
38850 msgstr ""
38851
38852 #. type: textblock
38853 #: ../src/guestfs.pod:2941
38854 msgid "Outside contributions, experimental parts."
38855 msgstr ""
38856
38857 #. type: =item
38858 #: ../src/guestfs.pod:2943
38859 msgid "C<daemon>"
38860 msgstr ""
38861
38862 #. type: textblock
38863 #: ../src/guestfs.pod:2945
38864 msgid ""
38865 "The daemon that runs inside the libguestfs appliance and carries out "
38866 "actions."
38867 msgstr ""
38868
38869 #. type: =item
38870 #: ../src/guestfs.pod:2948
38871 msgid "C<df>"
38872 msgstr ""
38873
38874 #. type: textblock
38875 #: ../src/guestfs.pod:2950
38876 msgid "L<virt-df(1)> command and documentation."
38877 msgstr ""
38878
38879 #. type: =item
38880 #: ../src/guestfs.pod:2952
38881 msgid "C<edit>"
38882 msgstr ""
38883
38884 #. type: textblock
38885 #: ../src/guestfs.pod:2954
38886 msgid "L<virt-edit(1)> command and documentation."
38887 msgstr ""
38888
38889 #. type: =item
38890 #: ../src/guestfs.pod:2956
38891 msgid "C<examples>"
38892 msgstr ""
38893
38894 #. type: textblock
38895 #: ../src/guestfs.pod:2958
38896 msgid "C API example code."
38897 msgstr ""
38898
38899 #. type: =item
38900 #: ../src/guestfs.pod:2960
38901 msgid "C<fish>"
38902 msgstr ""
38903
38904 #. type: textblock
38905 #: ../src/guestfs.pod:2962
38906 msgid ""
38907 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
38908 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
38909 "L<virt-tar-out(1)>."
38910 msgstr ""
38911
38912 #. type: =item
38913 #: ../src/guestfs.pod:2966
38914 msgid "C<fuse>"
38915 msgstr ""
38916
38917 #. type: textblock
38918 #: ../src/guestfs.pod:2968
38919 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
38920 msgstr ""
38921
38922 #. type: =item
38923 #: ../src/guestfs.pod:2970
38924 msgid "C<generator>"
38925 msgstr ""
38926
38927 #. type: textblock
38928 #: ../src/guestfs.pod:2972
38929 msgid ""
38930 "The crucially important generator, used to automatically generate large "
38931 "amounts of boilerplate C code for things like RPC and bindings."
38932 msgstr ""
38933
38934 #. type: =item
38935 #: ../src/guestfs.pod:2975
38936 msgid "C<images>"
38937 msgstr ""
38938
38939 #. type: textblock
38940 #: ../src/guestfs.pod:2977
38941 msgid "Files used by the test suite."
38942 msgstr ""
38943
38944 #. type: textblock
38945 #: ../src/guestfs.pod:2979
38946 msgid "Some \"phony\" guest images which we test against."
38947 msgstr ""
38948
38949 #. type: =item
38950 #: ../src/guestfs.pod:2981
38951 msgid "C<inspector>"
38952 msgstr ""
38953
38954 #. type: textblock
38955 #: ../src/guestfs.pod:2983
38956 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
38957 msgstr ""
38958
38959 #. type: =item
38960 #: ../src/guestfs.pod:2985
38961 msgid "C<logo>"
38962 msgstr ""
38963
38964 #. type: textblock
38965 #: ../src/guestfs.pod:2987
38966 msgid "Logo used on the website.  The fish is called Arthur by the way."
38967 msgstr ""
38968
38969 #. type: =item
38970 #: ../src/guestfs.pod:2989
38971 msgid "C<m4>"
38972 msgstr ""
38973
38974 #. type: textblock
38975 #: ../src/guestfs.pod:2991
38976 msgid "M4 macros used by autoconf."
38977 msgstr ""
38978
38979 #. type: =item
38980 #: ../src/guestfs.pod:2993
38981 msgid "C<po>"
38982 msgstr ""
38983
38984 #. type: textblock
38985 #: ../src/guestfs.pod:2995
38986 msgid "Translations of simple gettext strings."
38987 msgstr ""
38988
38989 #. type: =item
38990 #: ../src/guestfs.pod:2997
38991 msgid "C<po-docs>"
38992 msgstr ""
38993
38994 #. type: textblock
38995 #: ../src/guestfs.pod:2999
38996 msgid ""
38997 "The build infrastructure and PO files for translations of manpages and POD "
38998 "files.  Eventually this will be combined with the C<po> directory, but that "
38999 "is rather complicated."
39000 msgstr ""
39001
39002 #. type: =item
39003 #: ../src/guestfs.pod:3003
39004 msgid "C<regressions>"
39005 msgstr ""
39006
39007 #. type: textblock
39008 #: ../src/guestfs.pod:3005
39009 msgid "Regression tests."
39010 msgstr ""
39011
39012 #. type: =item
39013 #: ../src/guestfs.pod:3007
39014 msgid "C<rescue>"
39015 msgstr ""
39016
39017 #. type: textblock
39018 #: ../src/guestfs.pod:3009
39019 msgid "L<virt-rescue(1)> command and documentation."
39020 msgstr ""
39021
39022 #. type: =item
39023 #: ../src/guestfs.pod:3011
39024 msgid "C<resize>"
39025 msgstr ""
39026
39027 #. type: textblock
39028 #: ../src/guestfs.pod:3013
39029 msgid "L<virt-resize(1)> command and documentation."
39030 msgstr ""
39031
39032 #. type: =item
39033 #: ../src/guestfs.pod:3015
39034 msgid "C<sparsify>"
39035 msgstr ""
39036
39037 #. type: textblock
39038 #: ../src/guestfs.pod:3017
39039 msgid "L<virt-sparsify(1)> command and documentation."
39040 msgstr ""
39041
39042 #. type: =item
39043 #: ../src/guestfs.pod:3019
39044 msgid "C<src>"
39045 msgstr ""
39046
39047 #. type: textblock
39048 #: ../src/guestfs.pod:3021
39049 msgid "Source code to the C library."
39050 msgstr ""
39051
39052 #. type: =item
39053 #: ../src/guestfs.pod:3023
39054 msgid "C<tools>"
39055 msgstr ""
39056
39057 #. type: textblock
39058 #: ../src/guestfs.pod:3025
39059 msgid "Command line tools written in Perl (L<virt-win-reg(1)> and many others)."
39060 msgstr ""
39061
39062 #. type: =item
39063 #: ../src/guestfs.pod:3027
39064 msgid "C<test-tool>"
39065 msgstr ""
39066
39067 #. type: textblock
39068 #: ../src/guestfs.pod:3029
39069 msgid ""
39070 "Test tool for end users to test if their qemu/kernel combination will work "
39071 "with libguestfs."
39072 msgstr ""
39073
39074 #. type: =item
39075 #: ../src/guestfs.pod:3032
39076 msgid "C<csharp>"
39077 msgstr ""
39078
39079 #. type: =item
39080 #: ../src/guestfs.pod:3034
39081 msgid "C<erlang>"
39082 msgstr ""
39083
39084 #. type: =item
39085 #: ../src/guestfs.pod:3036
39086 msgid "C<haskell>"
39087 msgstr ""
39088
39089 #. type: =item
39090 #: ../src/guestfs.pod:3038
39091 msgid "C<java>"
39092 msgstr ""
39093
39094 #. type: =item
39095 #: ../src/guestfs.pod:3040
39096 msgid "C<ocaml>"
39097 msgstr ""
39098
39099 #. type: =item
39100 #: ../src/guestfs.pod:3042
39101 msgid "C<php>"
39102 msgstr ""
39103
39104 #. type: =item
39105 #: ../src/guestfs.pod:3044
39106 msgid "C<perl>"
39107 msgstr ""
39108
39109 #. type: =item
39110 #: ../src/guestfs.pod:3046
39111 msgid "C<python>"
39112 msgstr ""
39113
39114 #. type: =item
39115 #: ../src/guestfs.pod:3048
39116 msgid "C<ruby>"
39117 msgstr ""
39118
39119 #. type: textblock
39120 #: ../src/guestfs.pod:3050
39121 msgid "Language bindings."
39122 msgstr ""
39123
39124 #. type: =head2
39125 #: ../src/guestfs.pod:3054
39126 msgid "MAKING A STABLE RELEASE"
39127 msgstr ""
39128
39129 #. type: textblock
39130 #: ../src/guestfs.pod:3056
39131 msgid ""
39132 "When we make a stable release, there are several steps documented here.  See "
39133 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
39134 "branch policy."
39135 msgstr ""
39136
39137 #. type: textblock
39138 #: ../src/guestfs.pod:3064
39139 msgid "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
39140 msgstr ""
39141
39142 #. type: textblock
39143 #: ../src/guestfs.pod:3069
39144 msgid "Finalize RELEASE-NOTES."
39145 msgstr ""
39146
39147 #. type: textblock
39148 #: ../src/guestfs.pod:3073
39149 msgid "Update ROADMAP."
39150 msgstr ""
39151
39152 #. type: textblock
39153 #: ../src/guestfs.pod:3077
39154 msgid "Run C<src/api-support/update-from-tarballs.sh>."
39155 msgstr ""
39156
39157 #. type: textblock
39158 #: ../src/guestfs.pod:3081
39159 msgid "Push and pull from Transifex."
39160 msgstr ""
39161
39162 #. type: textblock
39163 #: ../src/guestfs.pod:3083
39164 msgid "Run:"
39165 msgstr ""
39166
39167 #. type: verbatim
39168 #: ../src/guestfs.pod:3085
39169 #, no-wrap
39170 msgid ""
39171 " tx push -s\n"
39172 "\n"
39173 msgstr ""
39174
39175 #. type: textblock
39176 #: ../src/guestfs.pod:3087
39177 msgid "to push the latest POT files to Transifex.  Then run:"
39178 msgstr ""
39179
39180 #. type: verbatim
39181 #: ../src/guestfs.pod:3089
39182 #, no-wrap
39183 msgid ""
39184 " ./tx-pull.sh\n"
39185 "\n"
39186 msgstr ""
39187
39188 #. type: textblock
39189 #: ../src/guestfs.pod:3091
39190 msgid "which is a wrapper to pull the latest translated C<*.po> files."
39191 msgstr ""
39192
39193 #. type: textblock
39194 #: ../src/guestfs.pod:3095
39195 msgid ""
39196 "Create new stable and development directories under "
39197 "L<http://libguestfs.org/download>."
39198 msgstr ""
39199
39200 #. type: textblock
39201 #: ../src/guestfs.pod:3100
39202 msgid "Create the branch in git:"
39203 msgstr ""
39204
39205 #. type: verbatim
39206 #: ../src/guestfs.pod:3102
39207 #, no-wrap
39208 msgid ""
39209 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
39210 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
39211 " git branch stable-1.XX\n"
39212 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
39213 "\n"
39214 msgstr ""
39215
39216 #. type: =head1
39217 #: ../src/guestfs.pod:3109
39218 msgid "LIMITS"
39219 msgstr ""
39220
39221 #. type: =head2
39222 #: ../src/guestfs.pod:3111
39223 msgid "PROTOCOL LIMITS"
39224 msgstr ""
39225
39226 #. type: textblock
39227 #: ../src/guestfs.pod:3113
39228 msgid ""
39229 "Internally libguestfs uses a message-based protocol to pass API calls and "
39230 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
39231 "plenty more detail about this).  The maximum message size used by the "
39232 "protocol is slightly less than 4 MB.  For some API calls you may need to be "
39233 "aware of this limit.  The API calls which may be affected are individually "
39234 "documented, with a link back to this section of the documentation."
39235 msgstr ""
39236
39237 #. type: textblock
39238 #: ../src/guestfs.pod:3121
39239 msgid ""
39240 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
39241 "a simple string.  Because this string is at some point internally encoded as "
39242 "a message, the maximum size that it can return is slightly under 4 MB.  If "
39243 "the requested file is larger than this then you will get an error."
39244 msgstr ""
39245
39246 #. type: textblock
39247 #: ../src/guestfs.pod:3127
39248 msgid ""
39249 "In order to transfer large files into and out of the guest filesystem, you "
39250 "need to use particular calls that support this.  The sections L</UPLOADING> "
39251 "and L</DOWNLOADING> document how to do this."
39252 msgstr ""
39253
39254 #. type: textblock
39255 #: ../src/guestfs.pod:3131
39256 msgid ""
39257 "You might also consider mounting the disk image using our FUSE filesystem "
39258 "support (L<guestmount(1)>)."
39259 msgstr ""
39260
39261 #. type: =head2
39262 #: ../src/guestfs.pod:3134
39263 msgid "MAXIMUM NUMBER OF DISKS"
39264 msgstr ""
39265
39266 #. type: textblock
39267 #: ../src/guestfs.pod:3136
39268 msgid "When using virtio disks (the default) the current limit is B<25> disks."
39269 msgstr ""
39270
39271 #. type: textblock
39272 #: ../src/guestfs.pod:3139
39273 msgid ""
39274 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
39275 "slots.  However febootstrap only understands disks with names C</dev/vda> "
39276 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
39277 "purposes."
39278 msgstr ""
39279
39280 #. type: textblock
39281 #: ../src/guestfs.pod:3144
39282 msgid ""
39283 "We are working to substantially raise this limit in future versions but it "
39284 "requires complex changes to qemu."
39285 msgstr ""
39286
39287 #. type: textblock
39288 #: ../src/guestfs.pod:3147
39289 msgid ""
39290 "In future versions of libguestfs it should also be possible to \"hot plug\" "
39291 "disks (add and remove disks after calling L</guestfs_launch>).  This also "
39292 "requires changes to qemu."
39293 msgstr ""
39294
39295 #. type: =head2
39296 #: ../src/guestfs.pod:3151
39297 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
39298 msgstr ""
39299
39300 #. type: textblock
39301 #: ../src/guestfs.pod:3153
39302 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
39303 msgstr ""
39304
39305 #. type: textblock
39306 #: ../src/guestfs.pod:3155
39307 msgid ""
39308 "This is because it reserves 4 bits for the minor device number (thus "
39309 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
39310 msgstr ""
39311
39312 #. type: textblock
39313 #: ../src/guestfs.pod:3158
39314 msgid ""
39315 "If you attach a disk with more than 15 partitions, the extra partitions are "
39316 "ignored by libguestfs."
39317 msgstr ""
39318
39319 #. type: =head2
39320 #: ../src/guestfs.pod:3161
39321 msgid "MAXIMUM SIZE OF A DISK"
39322 msgstr ""
39323
39324 #. type: textblock
39325 #: ../src/guestfs.pod:3163
39326 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
39327 msgstr ""
39328
39329 #. type: textblock
39330 #: ../src/guestfs.pod:3165
39331 msgid ""
39332 "We have tested block devices up to 1 exabyte (2**60 or "
39333 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
39334 "filesystem."
39335 msgstr ""
39336
39337 #. type: textblock
39338 #: ../src/guestfs.pod:3169
39339 msgid ""
39340 "Although libguestfs probably does not impose any limit, the underlying host "
39341 "storage will.  If you store disk images on a host ext4 filesystem, then the "
39342 "maximum size will be limited by the maximum ext4 file size (currently 16 "
39343 "TB).  If you store disk images as host logical volumes then you are limited "
39344 "by the maximum size of an LV."
39345 msgstr ""
39346
39347 #. type: textblock
39348 #: ../src/guestfs.pod:3175
39349 msgid ""
39350 "For the hugest disk image files, we recommend using XFS on the host for "
39351 "storage."
39352 msgstr ""
39353
39354 #. type: =head2
39355 #: ../src/guestfs.pod:3178
39356 msgid "MAXIMUM SIZE OF A PARTITION"
39357 msgstr ""
39358
39359 #. type: textblock
39360 #: ../src/guestfs.pod:3180
39361 msgid ""
39362 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
39363 "numbers.  Assuming a 512 byte sector size, this means that MBR cannot "
39364 "address a partition located beyond 2 TB on the disk."
39365 msgstr ""
39366
39367 #. type: textblock
39368 #: ../src/guestfs.pod:3184
39369 msgid ""
39370 "It is recommended that you use GPT partitions on disks which are larger than "
39371 "this size.  GPT uses 64 bit sector numbers and so can address partitions "
39372 "which are theoretically larger than the largest disk we could support."
39373 msgstr ""
39374
39375 #. type: =head2
39376 #: ../src/guestfs.pod:3189
39377 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
39378 msgstr ""
39379
39380 #. type: textblock
39381 #: ../src/guestfs.pod:3191
39382 msgid ""
39383 "This depends on the filesystem type.  libguestfs itself does not impose any "
39384 "known limit.  Consult Wikipedia or the filesystem documentation to find out "
39385 "what these limits are."
39386 msgstr ""
39387
39388 #. type: =head2
39389 #: ../src/guestfs.pod:3195
39390 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
39391 msgstr ""
39392
39393 #. type: textblock
39394 #: ../src/guestfs.pod:3197
39395 msgid ""
39396 "The API functions L</guestfs_upload>, L</guestfs_download>, "
39397 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
39398 "uploads and downloads."
39399 msgstr ""
39400
39401 #. type: =head2
39402 #: ../src/guestfs.pod:3201
39403 msgid "INSPECTION LIMITS"
39404 msgstr ""
39405
39406 #. type: textblock
39407 #: ../src/guestfs.pod:3203
39408 msgid ""
39409 "The inspection code has several arbitrary limits on things like the size of "
39410 "Windows Registry hive it will read, and the length of product name.  These "
39411 "are intended to stop a malicious guest from consuming arbitrary amounts of "
39412 "memory and disk space on the host, and should not be reached in practice.  "
39413 "See the source code for more information."
39414 msgstr ""
39415
39416 #. type: textblock
39417 #: ../src/guestfs.pod:3229
39418 msgid ""
39419 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages.  This has the same "
39420 "effect as calling C<guestfs_set_verbose (g, 1)>."
39421 msgstr ""
39422
39423 #. type: textblock
39424 #: ../src/guestfs.pod:3241
39425 msgid ""
39426 "Set the path that libguestfs uses to search for a supermin appliance.  See "
39427 "the discussion of paths in section L</PATH> above."
39428 msgstr ""
39429
39430 #. type: textblock
39431 #: ../src/guestfs.pod:3250
39432 msgid "See also L</QEMU WRAPPERS> above."
39433 msgstr ""
39434
39435 #. type: textblock
39436 #: ../src/guestfs.pod:3254
39437 msgid ""
39438 "Set C<LIBGUESTFS_TRACE=1> to enable command traces.  This has the same "
39439 "effect as calling C<guestfs_set_trace (g, 1)>."
39440 msgstr ""
39441
39442 #. type: textblock
39443 #: ../src/guestfs.pod:3272
39444 msgid ""
39445 "L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, "
39446 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
39447 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, "
39448 "L<virt-alignment-scan(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
39449 "L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
39450 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
39451 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
39452 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-sparsify(1)>, "
39453 "L<virt-sysprep(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
39454 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
39455 "L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<stap(1)>, "
39456 "L<http://libguestfs.org/>."
39457 msgstr ""
39458
39459 #. type: textblock
39460 #: ../src/guestfs.pod:3308
39461 msgid ""
39462 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
39463 "L<lvm(8)>, L<disktype(1)>."
39464 msgstr ""
39465
39466 #. type: =head1
39467 #: ../src/guestfs.pod:3315 ../tools/virt-make-fs.pl:571 ../tools/virt-win-reg.pl:772
39468 msgid "BUGS"
39469 msgstr ""
39470
39471 #. type: textblock
39472 #: ../src/guestfs.pod:3317
39473 msgid "To get a list of bugs against libguestfs use this link:"
39474 msgstr ""
39475
39476 #. type: textblock
39477 #: ../src/guestfs.pod:3319
39478 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
39479 msgstr ""
39480
39481 #. type: textblock
39482 #: ../src/guestfs.pod:3321
39483 msgid "To report a new bug against libguestfs use this link:"
39484 msgstr ""
39485
39486 #. type: textblock
39487 #: ../src/guestfs.pod:3323
39488 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
39489 msgstr ""
39490
39491 #. type: textblock
39492 #: ../src/guestfs.pod:3325
39493 msgid "When reporting a bug, please check:"
39494 msgstr ""
39495
39496 #. type: textblock
39497 #: ../src/guestfs.pod:3331
39498 msgid "That the bug hasn't been reported already."
39499 msgstr ""
39500
39501 #. type: textblock
39502 #: ../src/guestfs.pod:3335
39503 msgid "That you are testing a recent version."
39504 msgstr ""
39505
39506 #. type: textblock
39507 #: ../src/guestfs.pod:3339
39508 msgid "Describe the bug accurately, and give a way to reproduce it."
39509 msgstr ""
39510
39511 #. type: textblock
39512 #: ../src/guestfs.pod:3343
39513 msgid ""
39514 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
39515 "bug report."
39516 msgstr ""
39517
39518 #. type: textblock
39519 #: ../test-tool/libguestfs-test-tool.pod:5
39520 msgid "libguestfs-test-tool - Diagnostics for libguestfs"
39521 msgstr ""
39522
39523 #. type: verbatim
39524 #: ../test-tool/libguestfs-test-tool.pod:9
39525 #, no-wrap
39526 msgid ""
39527 " libguestfs-test-tool [--options]\n"
39528 "\n"
39529 msgstr ""
39530
39531 #. type: textblock
39532 #: ../test-tool/libguestfs-test-tool.pod:13
39533 msgid ""
39534 "libguestfs-test-tool is a test program shipped with libguestfs to allow you "
39535 "to check basic libguestfs functionality is working.  This is needed because "
39536 "libguestfs occasionally breaks for reasons beyond our control: usually "
39537 "because of changes in the underlying qemu or kernel packages, or the host "
39538 "environment."
39539 msgstr ""
39540
39541 #. type: textblock
39542 #: ../test-tool/libguestfs-test-tool.pod:19
39543 msgid "If you suspect a problem in libguestfs, then just run:"
39544 msgstr ""
39545
39546 #. type: verbatim
39547 #: ../test-tool/libguestfs-test-tool.pod:21
39548 #, no-wrap
39549 msgid ""
39550 " libguestfs-test-tool\n"
39551 "\n"
39552 msgstr ""
39553
39554 #. type: textblock
39555 #: ../test-tool/libguestfs-test-tool.pod:23
39556 msgid "It will print lots of diagnostic messages."
39557 msgstr ""
39558
39559 #. type: textblock
39560 #: ../test-tool/libguestfs-test-tool.pod:25
39561 msgid "If it runs to completion successfully, you will see this near the end:"
39562 msgstr ""
39563
39564 #. type: verbatim
39565 #: ../test-tool/libguestfs-test-tool.pod:27
39566 #, no-wrap
39567 msgid ""
39568 " ===== TEST FINISHED OK =====\n"
39569 "\n"
39570 msgstr ""
39571
39572 #. type: textblock
39573 #: ../test-tool/libguestfs-test-tool.pod:29
39574 msgid "and the test tool will exit with code 0."
39575 msgstr ""
39576
39577 #. type: textblock
39578 #: ../test-tool/libguestfs-test-tool.pod:31
39579 msgid ""
39580 "If it fails (and/or exits with non-zero error code), please paste the "
39581 "I<complete, unedited> output of the test tool into a bug report.  More "
39582 "information about reporting bugs can be found on the "
39583 "L<http://libguestfs.org/> website."
39584 msgstr ""
39585
39586 #. type: textblock
39587 #: ../test-tool/libguestfs-test-tool.pod:42
39588 msgid "Display short usage information and exit."
39589 msgstr ""
39590
39591 #. type: =item
39592 #: ../test-tool/libguestfs-test-tool.pod:44
39593 msgid "B<--qemu qemu_binary>"
39594 msgstr ""
39595
39596 #. type: textblock
39597 #: ../test-tool/libguestfs-test-tool.pod:46
39598 msgid ""
39599 "If you have downloaded another qemu binary, point this option at the full "
39600 "path of the binary to try it."
39601 msgstr ""
39602
39603 #. type: =item
39604 #: ../test-tool/libguestfs-test-tool.pod:49
39605 msgid "B<--qemudir qemu_source_dir>"
39606 msgstr ""
39607
39608 #. type: textblock
39609 #: ../test-tool/libguestfs-test-tool.pod:51
39610 msgid ""
39611 "If you have compiled qemu from source, point this option at the source "
39612 "directory to try it."
39613 msgstr ""
39614
39615 #. type: =item
39616 #: ../test-tool/libguestfs-test-tool.pod:54
39617 msgid "B<-t N>"
39618 msgstr ""
39619
39620 #. type: =item
39621 #: ../test-tool/libguestfs-test-tool.pod:56
39622 msgid "B<--timeout N>"
39623 msgstr ""
39624
39625 #. type: textblock
39626 #: ../test-tool/libguestfs-test-tool.pod:58
39627 msgid ""
39628 "Set the launch timeout to C<N> seconds.  The default is 600 seconds (10 "
39629 "minutes) which does not usually need to be adjusted."
39630 msgstr ""
39631
39632 #. type: =head1
39633 #: ../test-tool/libguestfs-test-tool.pod:63
39634 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
39635 msgstr ""
39636
39637 #. type: textblock
39638 #: ../test-tool/libguestfs-test-tool.pod:65
39639 msgid ""
39640 "If you have compiled another version of qemu from source and would like to "
39641 "try that, then you can use the I<--qemudir> option to point to the qemu "
39642 "source directory."
39643 msgstr ""
39644
39645 #. type: textblock
39646 #: ../test-tool/libguestfs-test-tool.pod:69
39647 msgid ""
39648 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
39649 "option to point to the binary."
39650 msgstr ""
39651
39652 #. type: textblock
39653 #: ../test-tool/libguestfs-test-tool.pod:72
39654 msgid ""
39655 "Note when using these options, you can ignore the business of qemu wrapper "
39656 "scripts (L<guestfs(3)/QEMU WRAPPERS>), since libguestfs-test-tool writes a "
39657 "wrapper script for you if one is needed."
39658 msgstr ""
39659
39660 #. type: =head1
39661 #: ../test-tool/libguestfs-test-tool.pod:76
39662 msgid "TRYING OUT A DIFFERENT KERNEL"
39663 msgstr ""
39664
39665 #. type: textblock
39666 #: ../test-tool/libguestfs-test-tool.pod:78
39667 msgid ""
39668 "If you are using febootstrap E<ge> 3.8 then you can select which kernel "
39669 "libguestfs tries.  You do this by setting the environment variables "
39670 "C<FEBOOTSTRAP_KERNEL> and/or C<FEBOOTSTRAP_MODULES>."
39671 msgstr ""
39672
39673 #. type: textblock
39674 #: ../test-tool/libguestfs-test-tool.pod:82
39675 msgid ""
39676 "Refer to L<febootstrap-supermin-helper(8)/ENVIRONMENT VARIABLES> for further "
39677 "information."
39678 msgstr ""
39679
39680 #. type: =head1
39681 #: ../test-tool/libguestfs-test-tool.pod:85
39682 msgid "SELF-DIAGNOSIS"
39683 msgstr ""
39684
39685 #. type: textblock
39686 #: ../test-tool/libguestfs-test-tool.pod:87
39687 msgid ""
39688 "Refer to L<guestfs(3)/APPLIANCE BOOT PROCESS> to understand the messages "
39689 "produced by libguestfs-test-tool and/or possible errors."
39690 msgstr ""
39691
39692 #. type: textblock
39693 #: ../test-tool/libguestfs-test-tool.pod:92
39694 msgid ""
39695 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
39696 "I<1> if there was an error."
39697 msgstr ""
39698
39699 #. type: textblock
39700 #: ../test-tool/libguestfs-test-tool.pod:97
39701 msgid ""
39702 "For the full list of environment variables which may affect libguestfs, "
39703 "please see the L<guestfs(3)> manual page."
39704 msgstr ""
39705
39706 #. type: textblock
39707 #: ../test-tool/libguestfs-test-tool.pod:102
39708 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
39709 msgstr ""
39710
39711 #. type: textblock
39712 #: ../tools/virt-list-filesystems.pl:32
39713 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
39714 msgstr ""
39715
39716 #. type: verbatim
39717 #: ../tools/virt-list-filesystems.pl:36
39718 #, no-wrap
39719 msgid ""
39720 " virt-list-filesystems [--options] domname\n"
39721 "\n"
39722 msgstr ""
39723
39724 #. type: verbatim
39725 #: ../tools/virt-list-filesystems.pl:38
39726 #, no-wrap
39727 msgid ""
39728 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
39729 "\n"
39730 msgstr ""
39731
39732 #. type: textblock
39733 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
39734 msgid ""
39735 "This tool is obsolete.  Use L<virt-filesystems(1)> as a more flexible "
39736 "replacement."
39737 msgstr ""
39738
39739 #. type: textblock
39740 #: ../tools/virt-list-filesystems.pl:45
39741 msgid ""
39742 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
39743 "are contained in a virtual machine or disk image."
39744 msgstr ""
39745
39746 #. type: textblock
39747 #: ../tools/virt-list-filesystems.pl:49
39748 msgid ""
39749 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
39750 "functionality.  For more complex cases you should look at the "
39751 "L<guestfish(1)> tool."
39752 msgstr ""
39753
39754 #. type: textblock
39755 #: ../tools/virt-list-filesystems.pl:112
39756 msgid ""
39757 "With this option, C<virt-list-filesystems> displays the type of each "
39758 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
39759 msgstr ""
39760
39761 #. type: =item
39762 #: ../tools/virt-list-filesystems.pl:119
39763 msgid "B<-a>"
39764 msgstr ""
39765
39766 #. type: textblock
39767 #: ../tools/virt-list-filesystems.pl:123
39768 msgid ""
39769 "Normally we only show mountable filesystems.  If this option is given then "
39770 "swap devices are shown too."
39771 msgstr ""
39772
39773 #. type: textblock
39774 #: ../tools/virt-list-filesystems.pl:197
39775 msgid ""
39776 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
39777 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
39778 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
39779 msgstr ""
39780
39781 #. type: textblock
39782 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
39783 msgid "Copyright (C) 2009 Red Hat Inc."
39784 msgstr ""
39785
39786 #. type: textblock
39787 #: ../tools/virt-list-partitions.pl:32
39788 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
39789 msgstr ""
39790
39791 #. type: verbatim
39792 #: ../tools/virt-list-partitions.pl:36
39793 #, no-wrap
39794 msgid ""
39795 " virt-list-partitions [--options] domname\n"
39796 "\n"
39797 msgstr ""
39798
39799 #. type: verbatim
39800 #: ../tools/virt-list-partitions.pl:38
39801 #, no-wrap
39802 msgid ""
39803 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
39804 "\n"
39805 msgstr ""
39806
39807 #. type: textblock
39808 #: ../tools/virt-list-partitions.pl:45
39809 msgid ""
39810 "C<virt-list-partitions> is a command line tool to list the partitions that "
39811 "are contained in a virtual machine or disk image.  It is mainly useful as a "
39812 "first step to using L<virt-resize(1)>."
39813 msgstr ""
39814
39815 #. type: textblock
39816 #: ../tools/virt-list-partitions.pl:50
39817 msgid ""
39818 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
39819 "functionality.  For more complex cases you should look at the "
39820 "L<guestfish(1)> tool."
39821 msgstr ""
39822
39823 #. type: textblock
39824 #: ../tools/virt-list-partitions.pl:113
39825 msgid "Show sizes in human-readable form (eg. \"1G\")."
39826 msgstr ""
39827
39828 #. type: textblock
39829 #: ../tools/virt-list-partitions.pl:123
39830 msgid ""
39831 "With this option, C<virt-list-partitions> displays the type and size of each "
39832 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
39833 msgstr ""
39834
39835 #. type: =item
39836 #: ../tools/virt-list-partitions.pl:130
39837 msgid "B<-t>"
39838 msgstr ""
39839
39840 #. type: =item
39841 #: ../tools/virt-list-partitions.pl:132
39842 msgid "B<--total>"
39843 msgstr ""
39844
39845 #. type: textblock
39846 #: ../tools/virt-list-partitions.pl:134
39847 msgid "Display the total size of each block device (as a separate row or rows)."
39848 msgstr ""
39849
39850 #. type: textblock
39851 #: ../tools/virt-list-partitions.pl:267
39852 msgid ""
39853 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
39854 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
39855 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
39856 msgstr ""
39857
39858 #. type: textblock
39859 #: ../tools/virt-list-partitions.pl:283
39860 msgid "Copyright (C) 2009-2010 Red Hat Inc."
39861 msgstr ""
39862
39863 #. type: textblock
39864 #: ../tools/virt-make-fs.pl:37
39865 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
39866 msgstr ""
39867
39868 #. type: verbatim
39869 #: ../tools/virt-make-fs.pl:41
39870 #, no-wrap
39871 msgid ""
39872 " virt-make-fs [--options] input.tar output.img\n"
39873 "\n"
39874 msgstr ""
39875
39876 #. type: verbatim
39877 #: ../tools/virt-make-fs.pl:43
39878 #, no-wrap
39879 msgid ""
39880 " virt-make-fs [--options] input.tar.gz output.img\n"
39881 "\n"
39882 msgstr ""
39883
39884 #. type: verbatim
39885 #: ../tools/virt-make-fs.pl:45
39886 #, no-wrap
39887 msgid ""
39888 " virt-make-fs [--options] directory output.img\n"
39889 "\n"
39890 msgstr ""
39891
39892 #. type: textblock
39893 #: ../tools/virt-make-fs.pl:49
39894 msgid ""
39895 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
39896 "archive or some files in a directory.  It is similar to tools like "
39897 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>.  Unlike those tools, "
39898 "it can create common filesystem types like ext2/3 or NTFS, which can be "
39899 "useful if you want to attach these filesystems to existing virtual machines "
39900 "(eg. to import large amounts of read-only data to a VM)."
39901 msgstr ""
39902
39903 #. type: textblock
39904 #: ../tools/virt-make-fs.pl:57
39905 msgid "Basic usage is:"
39906 msgstr ""
39907
39908 #. type: verbatim
39909 #: ../tools/virt-make-fs.pl:59
39910 #, no-wrap
39911 msgid ""
39912 " virt-make-fs input output.img\n"
39913 "\n"
39914 msgstr ""
39915
39916 #. type: textblock
39917 #: ../tools/virt-make-fs.pl:61
39918 msgid ""
39919 "where C<input> is either a directory containing files that you want to add, "
39920 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
39921 "C<output.img> is a disk image.  The input type is detected automatically.  "
39922 "The output disk image defaults to a raw ext2 sparse image unless you specify "
39923 "extra flags (see L</OPTIONS> below)."
39924 msgstr ""
39925
39926 #. type: =head2
39927 #: ../tools/virt-make-fs.pl:67
39928 msgid "FILESYSTEM TYPE"
39929 msgstr ""
39930
39931 #. type: textblock
39932 #: ../tools/virt-make-fs.pl:69
39933 msgid ""
39934 "The default filesystem type is C<ext2>.  Just about any filesystem type that "
39935 "libguestfs supports can be used (but I<not> read-only formats like "
39936 "ISO9660).  Here are some of the more common choices:"
39937 msgstr ""
39938
39939 #. type: =item
39940 #: ../tools/virt-make-fs.pl:75
39941 msgid "I<ext3>"
39942 msgstr ""
39943
39944 #. type: textblock
39945 #: ../tools/virt-make-fs.pl:77
39946 msgid ""
39947 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size.  If "
39948 "you are not going to use the filesystem in a way that requires the journal, "
39949 "then this is just wasted overhead."
39950 msgstr ""
39951
39952 #. type: =item
39953 #: ../tools/virt-make-fs.pl:81
39954 msgid "I<ntfs> or I<vfat>"
39955 msgstr ""
39956
39957 #. type: textblock
39958 #: ../tools/virt-make-fs.pl:83
39959 msgid "Useful if exporting data to a Windows guest."
39960 msgstr ""
39961
39962 #. type: textblock
39963 #: ../tools/virt-make-fs.pl:85
39964 msgid ""
39965 "I<Note for vfat>: The tar archive or local directory must only contain files "
39966 "which are owned by root (ie. UID:GID = 0:0).  The reason is that the tar "
39967 "program running within libguestfs is unable to change the ownership of "
39968 "non-root files, since vfat itself does not support this."
39969 msgstr ""
39970
39971 #. type: =item
39972 #: ../tools/virt-make-fs.pl:90
39973 msgid "I<minix>"
39974 msgstr ""
39975
39976 #. type: textblock
39977 #: ../tools/virt-make-fs.pl:92
39978 msgid ""
39979 "Lower overhead than C<ext2>, but certain limitations on filename length and "
39980 "total filesystem size."
39981 msgstr ""
39982
39983 #. type: =head3
39984 #: ../tools/virt-make-fs.pl:97 ../tools/virt-make-fs.pl:116 ../tools/virt-make-fs.pl:149
39985 msgid "EXAMPLE"
39986 msgstr ""
39987
39988 #. type: verbatim
39989 #: ../tools/virt-make-fs.pl:99
39990 #, no-wrap
39991 msgid ""
39992 " virt-make-fs --type=minix input minixfs.img\n"
39993 "\n"
39994 msgstr ""
39995
39996 #. type: =head2
39997 #: ../tools/virt-make-fs.pl:101
39998 msgid "TO PARTITION OR NOT TO PARTITION"
39999 msgstr ""
40000
40001 #. type: textblock
40002 #: ../tools/virt-make-fs.pl:103
40003 msgid "Optionally virt-make-fs can add a partition table to the output disk."
40004 msgstr ""
40005
40006 #. type: textblock
40007 #: ../tools/virt-make-fs.pl:105
40008 msgid ""
40009 "Adding a partition can make the disk image more compatible with certain "
40010 "virtualized operating systems which don't expect to see a filesystem "
40011 "directly located on a block device (Linux doesn't care and will happily "
40012 "handle both types)."
40013 msgstr ""
40014
40015 #. type: textblock
40016 #: ../tools/virt-make-fs.pl:110
40017 msgid ""
40018 "On the other hand, if you have a partition table then the output image is no "
40019 "longer a straight filesystem.  For example you cannot run L<fsck(8)> "
40020 "directly on a partitioned disk image.  (However libguestfs tools such as "
40021 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
40022 msgstr ""
40023
40024 #. type: textblock
40025 #: ../tools/virt-make-fs.pl:118
40026 msgid "Add an MBR partition:"
40027 msgstr ""
40028
40029 #. type: verbatim
40030 #: ../tools/virt-make-fs.pl:120
40031 #, no-wrap
40032 msgid ""
40033 " virt-make-fs --partition -- input disk.img\n"
40034 "\n"
40035 msgstr ""
40036
40037 #. type: textblock
40038 #: ../tools/virt-make-fs.pl:122
40039 msgid ""
40040 "If the output disk image could be terabyte-sized or larger, it's better to "
40041 "use an EFI/GPT-compatible partition table:"
40042 msgstr ""
40043
40044 #. type: verbatim
40045 #: ../tools/virt-make-fs.pl:125
40046 #, no-wrap
40047 msgid ""
40048 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
40049 "\n"
40050 msgstr ""
40051
40052 #. type: =head2
40053 #: ../tools/virt-make-fs.pl:127
40054 msgid "EXTRA SPACE"
40055 msgstr ""
40056
40057 #. type: textblock
40058 #: ../tools/virt-make-fs.pl:129
40059 msgid ""
40060 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
40061 "the files that it contains, but might have extra space.  Depending on how "
40062 "you are going to use the output, you might think this extra space is wasted "
40063 "and want to minimize it, or you might want to leave space so that more files "
40064 "can be added later.  Virt-make-fs defaults to minimizing the extra space, "
40065 "but you can use the I<--size> flag to leave space in the filesystem if you "
40066 "want it."
40067 msgstr ""
40068
40069 #. type: textblock
40070 #: ../tools/virt-make-fs.pl:137
40071 msgid ""
40072 "An alternative way to leave extra space but not make the output image any "
40073 "bigger is to use an alternative disk image format (instead of the default "
40074 "\"raw\" format).  Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
40075 "image format (check your hypervisor supports this before using it).  This "
40076 "allows you to choose a large I<--size> but the extra space won't actually be "
40077 "allocated in the image until you try to store something in it."
40078 msgstr ""
40079
40080 #. type: textblock
40081 #: ../tools/virt-make-fs.pl:145
40082 msgid ""
40083 "Don't forget that you can also use local commands including L<resize2fs(8)> "
40084 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
40085 "to build another image from scratch."
40086 msgstr ""
40087
40088 #. type: verbatim
40089 #: ../tools/virt-make-fs.pl:151
40090 #, no-wrap
40091 msgid ""
40092 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
40093 "\n"
40094 msgstr ""
40095
40096 #. type: textblock
40097 #: ../tools/virt-make-fs.pl:179
40098 msgid "Enable debugging information."
40099 msgstr ""
40100
40101 #. type: =item
40102 #: ../tools/virt-make-fs.pl:185
40103 msgid "B<--size=E<lt>NE<gt>>"
40104 msgstr ""
40105
40106 #. type: =item
40107 #: ../tools/virt-make-fs.pl:187
40108 msgid "B<--size=+E<lt>NE<gt>>"
40109 msgstr ""
40110
40111 #. type: =item
40112 #: ../tools/virt-make-fs.pl:189
40113 msgid "B<-s E<lt>NE<gt>>"
40114 msgstr ""
40115
40116 #. type: =item
40117 #: ../tools/virt-make-fs.pl:191
40118 msgid "B<-s +E<lt>NE<gt>>"
40119 msgstr ""
40120
40121 #. type: textblock
40122 #: ../tools/virt-make-fs.pl:193
40123 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
40124 msgstr ""
40125
40126 #. type: textblock
40127 #: ../tools/virt-make-fs.pl:196
40128 msgid ""
40129 "If this option is I<not> given, then the output image will be just large "
40130 "enough to contain all the files, with not much wasted space."
40131 msgstr ""
40132
40133 #. type: textblock
40134 #: ../tools/virt-make-fs.pl:199
40135 msgid ""
40136 "To choose a fixed size output disk, specify an absolute number followed by "
40137 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
40138 "Petabytes or Exabytes.  This must be large enough to contain all the input "
40139 "files, else you will get an error."
40140 msgstr ""
40141
40142 #. type: textblock
40143 #: ../tools/virt-make-fs.pl:204
40144 msgid ""
40145 "To leave extra space, specify C<+> (plus sign) and a number followed by "
40146 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
40147 "Petabytes or Exabytes.  For example: I<--size=+200M> means enough space for "
40148 "the input files, and (approximately) an extra 200 MB free space."
40149 msgstr ""
40150
40151 #. type: textblock
40152 #: ../tools/virt-make-fs.pl:210
40153 msgid ""
40154 "Note that virt-make-fs estimates free space, and therefore will not produce "
40155 "filesystems containing precisely the free space requested.  (It is much more "
40156 "expensive and time-consuming to produce a filesystem which has precisely the "
40157 "desired free space)."
40158 msgstr ""
40159
40160 #. type: =item
40161 #: ../tools/virt-make-fs.pl:219
40162 msgid "B<--format=E<lt>fmtE<gt>>"
40163 msgstr ""
40164
40165 #. type: =item
40166 #: ../tools/virt-make-fs.pl:221
40167 msgid "B<-F E<lt>fmtE<gt>>"
40168 msgstr ""
40169
40170 #. type: textblock
40171 #: ../tools/virt-make-fs.pl:223
40172 msgid "Choose the output disk image format."
40173 msgstr ""
40174
40175 #. type: textblock
40176 #: ../tools/virt-make-fs.pl:225
40177 msgid "The default is C<raw> (raw sparse disk image)."
40178 msgstr ""
40179
40180 #. type: textblock
40181 #: ../tools/virt-make-fs.pl:227
40182 msgid ""
40183 "For other choices, see the L<qemu-img(1)> manpage.  The only other choice "
40184 "that would really make sense here is C<qcow2>."
40185 msgstr ""
40186
40187 #. type: =item
40188 #: ../tools/virt-make-fs.pl:234
40189 msgid "B<--type=E<lt>fsE<gt>>"
40190 msgstr ""
40191
40192 #. type: =item
40193 #: ../tools/virt-make-fs.pl:236
40194 msgid "B<-t E<lt>fsE<gt>>"
40195 msgstr ""
40196
40197 #. type: textblock
40198 #: ../tools/virt-make-fs.pl:238
40199 msgid "Choose the output filesystem type."
40200 msgstr ""
40201
40202 #. type: textblock
40203 #: ../tools/virt-make-fs.pl:240
40204 msgid "The default is C<ext2>."
40205 msgstr ""
40206
40207 #. type: textblock
40208 #: ../tools/virt-make-fs.pl:242
40209 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
40210 msgstr ""
40211
40212 #. type: =item
40213 #: ../tools/virt-make-fs.pl:249
40214 msgid "B<--partition>"
40215 msgstr ""
40216
40217 #. type: =item
40218 #: ../tools/virt-make-fs.pl:251
40219 msgid "B<--partition=E<lt>parttypeE<gt>>"
40220 msgstr ""
40221
40222 #. type: textblock
40223 #: ../tools/virt-make-fs.pl:253
40224 msgid ""
40225 "If specified, this flag adds an MBR partition table to the output disk "
40226 "image."
40227 msgstr ""
40228
40229 #. type: textblock
40230 #: ../tools/virt-make-fs.pl:256
40231 msgid ""
40232 "You can change the partition table type, eg. I<--partition=gpt> for large "
40233 "disks."
40234 msgstr ""
40235
40236 #. type: textblock
40237 #: ../tools/virt-make-fs.pl:259
40238 msgid ""
40239 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
40240 "might consider the next parameter to be the partition type.  For example:"
40241 msgstr ""
40242
40243 #. type: verbatim
40244 #: ../tools/virt-make-fs.pl:263
40245 #, no-wrap
40246 msgid ""
40247 " virt-make-fs --partition input.tar output.img\n"
40248 "\n"
40249 msgstr ""
40250
40251 #. type: textblock
40252 #: ../tools/virt-make-fs.pl:265
40253 msgid ""
40254 "would cause virt-make-fs to think you wanted to use a partition type of "
40255 "C<input.tar> which is completely wrong.  To avoid this, use I<--> (a double "
40256 "dash) between options and the input and output arguments:"
40257 msgstr ""
40258
40259 #. type: verbatim
40260 #: ../tools/virt-make-fs.pl:269
40261 #, no-wrap
40262 msgid ""
40263 " virt-make-fs --partition -- input.tar output.img\n"
40264 "\n"
40265 msgstr ""
40266
40267 #. type: textblock
40268 #: ../tools/virt-make-fs.pl:271
40269 msgid "For MBR, virt-make-fs sets the partition type byte automatically."
40270 msgstr ""
40271
40272 #. type: textblock
40273 #: ../tools/virt-make-fs.pl:559
40274 msgid ""
40275 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
40276 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
40277 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
40278 msgstr ""
40279
40280 #. type: textblock
40281 #: ../tools/virt-make-fs.pl:573 ../tools/virt-win-reg.pl:774
40282 msgid ""
40283 "When reporting bugs, please enable debugging and capture the I<complete> "
40284 "output:"
40285 msgstr ""
40286
40287 #. type: verbatim
40288 #: ../tools/virt-make-fs.pl:576
40289 #, no-wrap
40290 msgid ""
40291 " export LIBGUESTFS_DEBUG=1\n"
40292 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
40293 "\n"
40294 msgstr ""
40295
40296 #. type: textblock
40297 #: ../tools/virt-make-fs.pl:579
40298 msgid ""
40299 "Attach /tmp/virt-make-fs.log to a new bug report at "
40300 "L<https://bugzilla.redhat.com/>"
40301 msgstr ""
40302
40303 #. type: textblock
40304 #: ../tools/virt-tar.pl:33
40305 msgid "virt-tar - Extract or upload files to a virtual machine"
40306 msgstr ""
40307
40308 #. type: verbatim
40309 #: ../tools/virt-tar.pl:37
40310 #, no-wrap
40311 msgid ""
40312 " virt-tar [--options] -x domname directory tarball\n"
40313 "\n"
40314 msgstr ""
40315
40316 #. type: verbatim
40317 #: ../tools/virt-tar.pl:39
40318 #, no-wrap
40319 msgid ""
40320 " virt-tar [--options] -u domname tarball directory\n"
40321 "\n"
40322 msgstr ""
40323
40324 #. type: verbatim
40325 #: ../tools/virt-tar.pl:41
40326 #, no-wrap
40327 msgid ""
40328 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
40329 "\n"
40330 msgstr ""
40331
40332 #. type: verbatim
40333 #: ../tools/virt-tar.pl:43
40334 #, no-wrap
40335 msgid ""
40336 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
40337 "\n"
40338 msgstr ""
40339
40340 #. type: =head2
40341 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
40342 msgid "NOTE"
40343 msgstr ""
40344
40345 #. type: textblock
40346 #: ../tools/virt-tar.pl:47
40347 msgid ""
40348 "This tool is obsolete.  Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
40349 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
40350 msgstr ""
40351
40352 #. type: textblock
40353 #: ../tools/virt-tar.pl:52
40354 msgid "Download C</home> from the VM into a local tarball:"
40355 msgstr ""
40356
40357 #. type: verbatim
40358 #: ../tools/virt-tar.pl:54
40359 #, no-wrap
40360 msgid ""
40361 " virt-tar -x domname /home home.tar\n"
40362 "\n"
40363 msgstr ""
40364
40365 #. type: verbatim
40366 #: ../tools/virt-tar.pl:56
40367 #, no-wrap
40368 msgid ""
40369 " virt-tar -zx domname /home home.tar.gz\n"
40370 "\n"
40371 msgstr ""
40372
40373 #. type: textblock
40374 #: ../tools/virt-tar.pl:58
40375 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
40376 msgstr ""
40377
40378 #. type: verbatim
40379 #: ../tools/virt-tar.pl:60
40380 #, no-wrap
40381 msgid ""
40382 " virt-tar -u domname uploadstuff.tar /tmp\n"
40383 "\n"
40384 msgstr ""
40385
40386 #. type: verbatim
40387 #: ../tools/virt-tar.pl:62
40388 #, no-wrap
40389 msgid ""
40390 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
40391 "\n"
40392 msgstr ""
40393
40394 #. type: textblock
40395 #: ../tools/virt-tar.pl:66
40396 msgid ""
40397 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
40398 "virtual machines.  If you do this, you risk disk corruption in the VM.  "
40399 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
40400 msgstr ""
40401
40402 #. type: textblock
40403 #: ../tools/virt-tar.pl:71
40404 msgid ""
40405 "You can use I<-x> (extract) on live virtual machines, but you might get "
40406 "inconsistent results or errors if there is filesystem activity inside the "
40407 "VM.  If the live VM is synched and quiescent, then C<virt-tar> will usually "
40408 "work, but the only way to guarantee consistent results is if the virtual "
40409 "machine is shut down."
40410 msgstr ""
40411
40412 #. type: textblock
40413 #: ../tools/virt-tar.pl:79
40414 msgid ""
40415 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
40416 "parts of a guest filesystem.  There are many possibilities: making backups, "
40417 "uploading data files, snooping on guest activity, fixing or customizing "
40418 "guests, etc."
40419 msgstr ""
40420
40421 #. type: textblock
40422 #: ../tools/virt-tar.pl:84
40423 msgid ""
40424 "If you want to just view a single file, use L<virt-cat(1)>.  If you just "
40425 "want to edit a single file, use L<virt-edit(1)>.  For more complex cases you "
40426 "should look at the L<guestfish(1)> tool."
40427 msgstr ""
40428
40429 #. type: textblock
40430 #: ../tools/virt-tar.pl:88
40431 msgid ""
40432 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
40433 "its contents (recursively) from the virtual machine into a local tarball.  "
40434 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
40435 "virtual machine.  You cannot use these two options together."
40436 msgstr ""
40437
40438 #. type: textblock
40439 #: ../tools/virt-tar.pl:94
40440 msgid ""
40441 "In addition, you may need to use the I<-z> (gZip) option to enable "
40442 "compression.  When uploading, you have to specify I<-z> if the upload file "
40443 "is compressed because virt-tar won't detect this on its own."
40444 msgstr ""
40445
40446 #. type: textblock
40447 #: ../tools/virt-tar.pl:98
40448 msgid ""
40449 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs.  For "
40450 "example it cannot do PKZip files or bzip2 compression.  If you want that "
40451 "then you'll have to rebuild the tarballs yourself.  (This is a limitation of "
40452 "the L<libguestfs(3)> API)."
40453 msgstr ""
40454
40455 #. type: =item
40456 #: ../tools/virt-tar.pl:160
40457 msgid "B<--extract>"
40458 msgstr ""
40459
40460 #. type: =item
40461 #: ../tools/virt-tar.pl:162
40462 msgid "B<--download>"
40463 msgstr ""
40464
40465 #. type: =item
40466 #: ../tools/virt-tar.pl:164
40467 msgid "B<-u>"
40468 msgstr ""
40469
40470 #. type: =item
40471 #: ../tools/virt-tar.pl:166
40472 msgid "B<--upload>"
40473 msgstr ""
40474
40475 #. type: textblock
40476 #: ../tools/virt-tar.pl:168
40477 msgid ""
40478 "Use I<-x> to extract (download) a directory from a virtual machine to a "
40479 "local tarball."
40480 msgstr ""
40481
40482 #. type: textblock
40483 #: ../tools/virt-tar.pl:171
40484 msgid ""
40485 "Use I<-u> to upload and unpack from a local tarball into a virtual machine.  "
40486 "Please read the L</WARNING> section above before using this option."
40487 msgstr ""
40488
40489 #. type: textblock
40490 #: ../tools/virt-tar.pl:175
40491 msgid "You must specify exactly one of these options."
40492 msgstr ""
40493
40494 #. type: =item
40495 #: ../tools/virt-tar.pl:181
40496 msgid "B<-z>"
40497 msgstr ""
40498
40499 #. type: =item
40500 #: ../tools/virt-tar.pl:183
40501 msgid "B<--gzip>"
40502 msgstr ""
40503
40504 #. type: textblock
40505 #: ../tools/virt-tar.pl:185
40506 msgid "Specify that the input or output tarball is gzip-compressed."
40507 msgstr ""
40508
40509 #. type: textblock
40510 #: ../tools/virt-tar.pl:298
40511 msgid ""
40512 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
40513 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
40514 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
40515 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
40516 msgstr ""
40517
40518 #. type: textblock
40519 #: ../tools/virt-win-reg.pl:37
40520 msgid ""
40521 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
40522 "guest"
40523 msgstr ""
40524
40525 #. type: verbatim
40526 #: ../tools/virt-win-reg.pl:41
40527 #, no-wrap
40528 msgid ""
40529 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
40530 "\n"
40531 msgstr ""
40532
40533 #. type: verbatim
40534 #: ../tools/virt-win-reg.pl:43
40535 #, no-wrap
40536 msgid ""
40537 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
40538 "\n"
40539 msgstr ""
40540
40541 #. type: verbatim
40542 #: ../tools/virt-win-reg.pl:45
40543 #, no-wrap
40544 msgid ""
40545 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
40546 "\n"
40547 msgstr ""
40548
40549 #. type: verbatim
40550 #: ../tools/virt-win-reg.pl:47
40551 #, no-wrap
40552 msgid ""
40553 " virt-win-reg --merge domname [input.reg ...]\n"
40554 "\n"
40555 msgstr ""
40556
40557 #. type: verbatim
40558 #: ../tools/virt-win-reg.pl:49
40559 #, no-wrap
40560 msgid ""
40561 " virt-win-reg [--options] disk.img ... # instead of domname\n"
40562 "\n"
40563 msgstr ""
40564
40565 #. type: textblock
40566 #: ../tools/virt-win-reg.pl:53
40567 msgid ""
40568 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
40569 "virtual machines.  If you do this, you I<will> get irreversible disk "
40570 "corruption in the VM.  C<virt-win-reg> tries to stop you from doing this, "
40571 "but doesn't catch all cases."
40572 msgstr ""
40573
40574 #. type: textblock
40575 #: ../tools/virt-win-reg.pl:58
40576 msgid ""
40577 "Modifying the Windows Registry is an inherently risky operation.  The format "
40578 "is deliberately obscure and undocumented, and Registry changes can leave the "
40579 "system unbootable.  Therefore when using the I<--merge> option, make sure "
40580 "you have a reliable backup first."
40581 msgstr ""
40582
40583 #. type: textblock
40584 #: ../tools/virt-win-reg.pl:65
40585 msgid ""
40586 "This program can export and merge Windows Registry entries from a Windows "
40587 "guest."
40588 msgstr ""
40589
40590 #. type: textblock
40591 #: ../tools/virt-win-reg.pl:68
40592 msgid ""
40593 "The first parameter is the libvirt guest name or the raw disk image of a "
40594 "Windows guest."
40595 msgstr ""
40596
40597 #. type: textblock
40598 #: ../tools/virt-win-reg.pl:71
40599 msgid ""
40600 "If I<--merge> is I<not> specified, then the chosen registry key is "
40601 "displayed/exported (recursively).  For example:"
40602 msgstr ""
40603
40604 #. type: verbatim
40605 #: ../tools/virt-win-reg.pl:74
40606 #, no-wrap
40607 msgid ""
40608 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
40609 "\n"
40610 msgstr ""
40611
40612 #. type: textblock
40613 #: ../tools/virt-win-reg.pl:76
40614 msgid "You can also display single values from within registry keys, for example:"
40615 msgstr ""
40616
40617 #. type: verbatim
40618 #: ../tools/virt-win-reg.pl:79
40619 #, no-wrap
40620 msgid ""
40621 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
40622 " $ virt-win-reg Windows7 $cvkey ProductName\n"
40623 " Windows 7 Enterprise\n"
40624 "\n"
40625 msgstr ""
40626
40627 #. type: textblock
40628 #: ../tools/virt-win-reg.pl:83
40629 msgid ""
40630 "With I<--merge>, you can merge a textual regedit file into the Windows "
40631 "Registry:"
40632 msgstr ""
40633
40634 #. type: verbatim
40635 #: ../tools/virt-win-reg.pl:86
40636 #, no-wrap
40637 msgid ""
40638 " $ virt-win-reg --merge Windows7 changes.reg\n"
40639 "\n"
40640 msgstr ""
40641
40642 #. type: textblock
40643 #: ../tools/virt-win-reg.pl:90
40644 msgid ""
40645 "This program is only meant for simple access to the registry.  If you want "
40646 "to do complicated things with the registry, we suggest you download the "
40647 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
40648 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
40649 "L<hivexregedit(1)>."
40650 msgstr ""
40651
40652 #. type: =item
40653 #: ../tools/virt-win-reg.pl:159
40654 msgid "B<--merge>"
40655 msgstr ""
40656
40657 #. type: textblock
40658 #: ../tools/virt-win-reg.pl:161
40659 msgid ""
40660 "In merge mode, this merges a textual regedit file into the Windows Registry "
40661 "of the virtual machine.  If this flag is I<not> given then virt-win-reg "
40662 "displays or exports Registry entries instead."
40663 msgstr ""
40664
40665 #. type: textblock
40666 #: ../tools/virt-win-reg.pl:165
40667 msgid ""
40668 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
40669 "result in disk corruption.  However exporting (without this flag)  is always "
40670 "safe."
40671 msgstr ""
40672
40673 #. type: =item
40674 #: ../tools/virt-win-reg.pl:173
40675 msgid "B<--encoding> UTF-16LE|ASCII"
40676 msgstr ""
40677
40678 #. type: textblock
40679 #: ../tools/virt-win-reg.pl:175
40680 msgid ""
40681 "When merging (only), you may need to specify the encoding for strings to be "
40682 "used in the hive file.  This is explained in detail in "
40683 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
40684 msgstr ""
40685
40686 #. type: textblock
40687 #: ../tools/virt-win-reg.pl:179
40688 msgid ""
40689 "The default is to use UTF-16LE, which should work with recent versions of "
40690 "Windows."
40691 msgstr ""
40692
40693 #. type: =item
40694 #: ../tools/virt-win-reg.pl:186
40695 msgid "B<--unsafe-printable-strings>"
40696 msgstr ""
40697
40698 #. type: textblock
40699 #: ../tools/virt-win-reg.pl:188
40700 msgid ""
40701 "When exporting (only), assume strings are UTF-16LE and print them as strings "
40702 "instead of hex sequences.  Remove the final zero codepoint from strings if "
40703 "present."
40704 msgstr ""
40705
40706 #. type: textblock
40707 #: ../tools/virt-win-reg.pl:192
40708 msgid ""
40709 "This is unsafe and does not preserve the fidelity of strings in the original "
40710 "Registry for various reasons:"
40711 msgstr ""
40712
40713 #. type: textblock
40714 #: ../tools/virt-win-reg.pl:199
40715 msgid ""
40716 "Assumes the original encoding is UTF-16LE.  ASCII strings and strings in "
40717 "other encodings will be corrupted by this transformation."
40718 msgstr ""
40719
40720 #. type: textblock
40721 #: ../tools/virt-win-reg.pl:204
40722 msgid ""
40723 "Assumes that everything which has type 1 or 2 is really a string and that "
40724 "everything else is not a string, but the type field in real Registries is "
40725 "not reliable."
40726 msgstr ""
40727
40728 #. type: textblock
40729 #: ../tools/virt-win-reg.pl:210
40730 msgid ""
40731 "Loses information about whether a zero codepoint followed the string in the "
40732 "Registry or not."
40733 msgstr ""
40734
40735 #. type: textblock
40736 #: ../tools/virt-win-reg.pl:215
40737 msgid ""
40738 "This all happens because the Registry itself contains no information about "
40739 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
40740 msgstr ""
40741
40742 #. type: textblock
40743 #: ../tools/virt-win-reg.pl:219
40744 msgid ""
40745 "You should only use this option for quick hacking and debugging of the "
40746 "Registry contents, and I<never> use it if the output is going to be passed "
40747 "into another program or stored in another Registry."
40748 msgstr ""
40749
40750 #. type: =head1
40751 #: ../tools/virt-win-reg.pl:556
40752 msgid "SUPPORTED SYSTEMS"
40753 msgstr ""
40754
40755 #. type: textblock
40756 #: ../tools/virt-win-reg.pl:558
40757 msgid ""
40758 "The program currently supports Windows NT-derived guests starting with "
40759 "Windows XP through to at least Windows 7."
40760 msgstr ""
40761
40762 #. type: textblock
40763 #: ../tools/virt-win-reg.pl:561
40764 msgid "The following Registry keys are supported:"
40765 msgstr ""
40766
40767 #. type: =item
40768 #: ../tools/virt-win-reg.pl:565
40769 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
40770 msgstr ""
40771
40772 #. type: =item
40773 #: ../tools/virt-win-reg.pl:567
40774 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
40775 msgstr ""
40776
40777 #. type: =item
40778 #: ../tools/virt-win-reg.pl:569
40779 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
40780 msgstr ""
40781
40782 #. type: =item
40783 #: ../tools/virt-win-reg.pl:571
40784 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
40785 msgstr ""
40786
40787 #. type: =item
40788 #: ../tools/virt-win-reg.pl:573
40789 msgid "C<HKEY_USERS\\.DEFAULT>"
40790 msgstr ""
40791
40792 #. type: =item
40793 #: ../tools/virt-win-reg.pl:575
40794 msgid "C<HKEY_USERS\\I<SID>>"
40795 msgstr ""
40796
40797 #. type: textblock
40798 #: ../tools/virt-win-reg.pl:577
40799 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
40800 msgstr ""
40801
40802 #. type: =item
40803 #: ../tools/virt-win-reg.pl:579
40804 msgid "C<HKEY_USERS\\I<username>>"
40805 msgstr ""
40806
40807 #. type: textblock
40808 #: ../tools/virt-win-reg.pl:581
40809 msgid "where I<username> is a local user name (this is a libguestfs extension)."
40810 msgstr ""
40811
40812 #. type: textblock
40813 #: ../tools/virt-win-reg.pl:585
40814 msgid ""
40815 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
40816 "C<HKEY_USERS>."
40817 msgstr ""
40818
40819 #. type: textblock
40820 #: ../tools/virt-win-reg.pl:588
40821 msgid ""
40822 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
40823 "supported (there is no \"current user\")."
40824 msgstr ""
40825
40826 #. type: =head1
40827 #: ../tools/virt-win-reg.pl:591
40828 msgid "ENCODING"
40829 msgstr ""
40830
40831 #. type: textblock
40832 #: ../tools/virt-win-reg.pl:593
40833 msgid ""
40834 "C<virt-win-reg> expects that regedit files have already been reencoded in "
40835 "the local encoding.  Usually on Linux hosts, this means UTF-8 with "
40836 "Unix-style line endings.  Since Windows regedit files are often in UTF-16LE "
40837 "with Windows-style line endings, you may need to reencode the whole file "
40838 "before or after processing."
40839 msgstr ""
40840
40841 #. type: textblock
40842 #: ../tools/virt-win-reg.pl:599
40843 msgid ""
40844 "To reencode a file from Windows format to Linux (before processing it with "
40845 "the I<--merge> option), you would do something like this:"
40846 msgstr ""
40847
40848 #. type: verbatim
40849 #: ../tools/virt-win-reg.pl:602
40850 #, no-wrap
40851 msgid ""
40852 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
40853 "\n"
40854 msgstr ""
40855
40856 #. type: textblock
40857 #: ../tools/virt-win-reg.pl:604
40858 msgid ""
40859 "To go in the opposite direction, after exporting and before sending the file "
40860 "to a Windows user, do something like this:"
40861 msgstr ""
40862
40863 #. type: verbatim
40864 #: ../tools/virt-win-reg.pl:607
40865 #, no-wrap
40866 msgid ""
40867 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
40868 "\n"
40869 msgstr ""
40870
40871 #. type: textblock
40872 #: ../tools/virt-win-reg.pl:609
40873 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
40874 msgstr ""
40875
40876 #. type: textblock
40877 #: ../tools/virt-win-reg.pl:611
40878 msgid ""
40879 "If you are unsure about the current encoding, use the L<file(1)> command.  "
40880 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
40881 "Windows-style (CRLF) line endings, like this:"
40882 msgstr ""
40883
40884 #. type: verbatim
40885 #: ../tools/virt-win-reg.pl:615
40886 #, no-wrap
40887 msgid ""
40888 " $ file software.reg\n"
40889 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
40890 " with CRLF line terminators\n"
40891 "\n"
40892 msgstr ""
40893
40894 #. type: textblock
40895 #: ../tools/virt-win-reg.pl:619
40896 msgid "This file would need conversion before you could I<--merge> it."
40897 msgstr ""
40898
40899 #. type: =head1
40900 #: ../tools/virt-win-reg.pl:621
40901 msgid "CurrentControlSet etc."
40902 msgstr ""
40903
40904 #. type: textblock
40905 #: ../tools/virt-win-reg.pl:623
40906 msgid ""
40907 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
40908 "Registry at the level of the hive file, and therefore you cannot modify "
40909 "these."
40910 msgstr ""
40911
40912 #. type: textblock
40913 #: ../tools/virt-win-reg.pl:627
40914 msgid ""
40915 "C<CurrentControlSet> is usually an alias for C<ControlSet001>.  In some "
40916 "circumstances it might refer to another control set.  The way to find out is "
40917 "to look at the C<HKLM\\SYSTEM\\Select> key:"
40918 msgstr ""
40919
40920 #. type: verbatim
40921 #: ../tools/virt-win-reg.pl:631
40922 #, no-wrap
40923 msgid ""
40924 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
40925 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
40926 " \"Current\"=dword:00000001\n"
40927 " \"Default\"=dword:00000001\n"
40928 " \"Failed\"=dword:00000000\n"
40929 " \"LastKnownGood\"=dword:00000002\n"
40930 "\n"
40931 msgstr ""
40932
40933 #. type: textblock
40934 #: ../tools/virt-win-reg.pl:638
40935 msgid "\"Current\" is the one which Windows will choose when it boots."
40936 msgstr ""
40937
40938 #. type: textblock
40939 #: ../tools/virt-win-reg.pl:640
40940 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
40941 msgstr ""
40942
40943 #. type: =head1
40944 #: ../tools/virt-win-reg.pl:643
40945 msgid "DELETING REGISTRY KEYS AND VALUES"
40946 msgstr ""
40947
40948 #. type: textblock
40949 #: ../tools/virt-win-reg.pl:645
40950 msgid "To delete a whole registry key, use the syntax:"
40951 msgstr ""
40952
40953 #. type: verbatim
40954 #: ../tools/virt-win-reg.pl:647
40955 #, no-wrap
40956 msgid ""
40957 " [-HKEY_LOCAL_MACHINE\\Foo]\n"
40958 "\n"
40959 msgstr ""
40960
40961 #. type: textblock
40962 #: ../tools/virt-win-reg.pl:649
40963 msgid "To delete a single value within a key, use the syntax:"
40964 msgstr ""
40965
40966 #. type: verbatim
40967 #: ../tools/virt-win-reg.pl:651
40968 #, no-wrap
40969 msgid ""
40970 " [HKEY_LOCAL_MACHINE\\Foo]\n"
40971 " \"Value\"=-\n"
40972 "\n"
40973 msgstr ""
40974
40975 #. type: =head1
40976 #: ../tools/virt-win-reg.pl:654
40977 msgid "WINDOWS TIPS"
40978 msgstr ""
40979
40980 #. type: textblock
40981 #: ../tools/virt-win-reg.pl:656
40982 msgid ""
40983 "Note that some of these tips modify the guest disk image.  The guest I<must> "
40984 "be shut off, else you will get disk corruption."
40985 msgstr ""
40986
40987 #. type: =head2
40988 #: ../tools/virt-win-reg.pl:659
40989 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
40990 msgstr ""
40991
40992 #. type: textblock
40993 #: ../tools/virt-win-reg.pl:661
40994 msgid ""
40995 "Prepare a DOS batch script, VBScript or executable.  Upload this using "
40996 "L<guestfish(1)>.  For this example the script is called C<test.bat> and it "
40997 "is uploaded into C<C:\\>:"
40998 msgstr ""
40999
41000 #. type: verbatim
41001 #: ../tools/virt-win-reg.pl:665
41002 #, no-wrap
41003 msgid ""
41004 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
41005 "\n"
41006 msgstr ""
41007
41008 #. type: textblock
41009 #: ../tools/virt-win-reg.pl:667
41010 msgid "Prepare a regedit file containing the registry change:"
41011 msgstr ""
41012
41013 #. type: verbatim
41014 #: ../tools/virt-win-reg.pl:669
41015 #, no-wrap
41016 msgid ""
41017 " cat > test.reg <<'EOF'\n"
41018 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
41019 " \"Test\"=\"c:\\\\test.bat\"\n"
41020 " EOF\n"
41021 "\n"
41022 msgstr ""
41023
41024 #. type: textblock
41025 #: ../tools/virt-win-reg.pl:674
41026 msgid ""
41027 "In this example we use the key C<RunOnce> which means that the script will "
41028 "run precisely once when the first user logs in.  If you want it to run every "
41029 "time a user logs in, replace C<RunOnce> with C<Run>."
41030 msgstr ""
41031
41032 #. type: textblock
41033 #: ../tools/virt-win-reg.pl:678
41034 msgid "Now update the registry:"
41035 msgstr ""
41036
41037 #. type: verbatim
41038 #: ../tools/virt-win-reg.pl:680
41039 #, no-wrap
41040 msgid ""
41041 " virt-win-reg --merge WindowsGuest test.reg\n"
41042 "\n"
41043 msgstr ""
41044
41045 #. type: =head2
41046 #: ../tools/virt-win-reg.pl:682
41047 msgid "INSTALLING A SERVICE"
41048 msgstr ""
41049
41050 #. type: textblock
41051 #: ../tools/virt-win-reg.pl:684
41052 msgid ""
41053 "This section assumes you are familiar with Windows services, and you either "
41054 "have a program which handles the Windows Service Control Protocol directly "
41055 "or you want to run any program using a service wrapper like SrvAny or the "
41056 "free RHSrvAny."
41057 msgstr ""
41058
41059 #. type: textblock
41060 #: ../tools/virt-win-reg.pl:689
41061 msgid ""
41062 "First upload the program and optionally the service wrapper.  In this case "
41063 "the test program is called C<test.exe> and we are using the RHSrvAny "
41064 "wrapper:"
41065 msgstr ""
41066
41067 #. type: verbatim
41068 #: ../tools/virt-win-reg.pl:693
41069 #, no-wrap
41070 msgid ""
41071 " guestfish -i -d WindowsGuest <<EOF\n"
41072 "   upload rhsrvany.exe /rhsrvany.exe\n"
41073 "   upload test.exe /test.exe\n"
41074 " EOF\n"
41075 "\n"
41076 msgstr ""
41077
41078 #. type: textblock
41079 #: ../tools/virt-win-reg.pl:698
41080 msgid ""
41081 "Prepare a regedit file containing the registry changes.  In this example, "
41082 "the first registry change is needed for the service itself or the service "
41083 "wrapper (if used).  The second registry change is only needed because I am "
41084 "using the RHSrvAny service wrapper."
41085 msgstr ""
41086
41087 #. type: verbatim
41088 #: ../tools/virt-win-reg.pl:703
41089 #, no-wrap
41090 msgid ""
41091 " cat > service.reg <<'EOF'\n"
41092 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
41093 " \"Type\"=dword:00000010\n"
41094 " \"Start\"=dword:00000002\n"
41095 " \"ErrorControl\"=dword:00000001\n"
41096 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
41097 " \"DisplayName\"=\"RHSrvAny\"\n"
41098 " \"ObjectName\"=\"NetworkService\"\n"
41099 " \n"
41100 msgstr ""
41101
41102 #. type: verbatim
41103 #: ../tools/virt-win-reg.pl:712
41104 #, no-wrap
41105 msgid ""
41106 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
41107 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
41108 " \"PWD\"=\"c:\\\\Temp\"\n"
41109 " EOF\n"
41110 "\n"
41111 msgstr ""
41112
41113 #. type: textblock
41114 #: ../tools/virt-win-reg.pl:723
41115 msgid ""
41116 "For use of C<ControlSet001> see the section above in this manual page.  You "
41117 "may need to adjust this according to the control set that is in use by the "
41118 "guest."
41119 msgstr ""
41120
41121 #. type: textblock
41122 #: ../tools/virt-win-reg.pl:729
41123 msgid ""
41124 "C<\"ObjectName\"> controls the privileges that the service will have.  An "
41125 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
41126 "privileged account."
41127 msgstr ""
41128
41129 #. type: textblock
41130 #: ../tools/virt-win-reg.pl:735
41131 msgid ""
41132 "For the meaning of the magic numbers, see this Microsoft KB article: "
41133 "L<http://support.microsoft.com/kb/103000>."
41134 msgstr ""
41135
41136 #. type: textblock
41137 #: ../tools/virt-win-reg.pl:740
41138 msgid "Update the registry:"
41139 msgstr ""
41140
41141 #. type: verbatim
41142 #: ../tools/virt-win-reg.pl:742
41143 #, no-wrap
41144 msgid ""
41145 " virt-win-reg --merge WindowsGuest service.reg\n"
41146 "\n"
41147 msgstr ""
41148
41149 #. type: textblock
41150 #: ../tools/virt-win-reg.pl:746
41151 msgid ""
41152 "Be careful when passing parameters containing C<\\> (backslash) in the "
41153 "shell.  Usually you will have to use 'single quotes' or double backslashes "
41154 "(but not both) to protect them from the shell."
41155 msgstr ""
41156
41157 #. type: textblock
41158 #: ../tools/virt-win-reg.pl:750
41159 msgid "Paths and value names are case-insensitive."
41160 msgstr ""
41161
41162 #. type: textblock
41163 #: ../tools/virt-win-reg.pl:759
41164 msgid ""
41165 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
41166 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
41167 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
41168 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
41169 msgstr ""
41170
41171 #. type: verbatim
41172 #: ../tools/virt-win-reg.pl:777
41173 #, no-wrap
41174 msgid ""
41175 " export LIBGUESTFS_DEBUG=1\n"
41176 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
41177 "\n"
41178 msgstr ""
41179
41180 #. type: textblock
41181 #: ../tools/virt-win-reg.pl:780
41182 msgid ""
41183 "Attach /tmp/virt-win-reg.log to a new bug report at "
41184 "L<https://bugzilla.redhat.com/>"
41185 msgstr ""