New API: set-smp, get-smp
[libguestfs.git] / generator / generator_actions.ml
1 (* libguestfs
2  * Copyright (C) 2009-2011 Red Hat Inc.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  *)
18
19 (* Please read generator/README first. *)
20
21 (* Note about long descriptions: When referring to another
22  * action, use the format C<guestfs_other> (ie. the full name of
23  * the C function).  This will be replaced as appropriate in other
24  * language bindings.
25  *
26  * Apart from that, long descriptions are just perldoc paragraphs.
27  *)
28
29 open Generator_types
30 open Generator_utils
31
32 (* These test functions are used in the language binding tests. *)
33
34 let test_all_args = [
35   String "str";
36   OptString "optstr";
37   StringList "strlist";
38   Bool "b";
39   Int "integer";
40   Int64 "integer64";
41   FileIn "filein";
42   FileOut "fileout";
43   BufferIn "bufferin";
44 ]
45
46 let test_all_rets = [
47   (* except for RErr, which is tested thoroughly elsewhere *)
48   "test0rint",         RInt "valout";
49   "test0rint64",       RInt64 "valout";
50   "test0rbool",        RBool "valout";
51   "test0rconststring", RConstString "valout";
52   "test0rconstoptstring", RConstOptString "valout";
53   "test0rstring",      RString "valout";
54   "test0rstringlist",  RStringList "valout";
55   "test0rstruct",      RStruct ("valout", "lvm_pv");
56   "test0rstructlist",  RStructList ("valout", "lvm_pv");
57   "test0rhashtable",   RHashtable "valout";
58 ]
59
60 let test_functions = [
61   ("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs],
62    [],
63    "internal test function - do not use",
64    "\
65 This is an internal test function which is used to test whether
66 the automatically generated bindings can handle every possible
67 parameter type correctly.
68
69 It echos the contents of each parameter to stdout.
70
71 You probably don't want to call this function.");
72 ] @ List.flatten (
73   List.map (
74     fun (name, ret) ->
75       [(name, (ret, [String "val"], []), -1, [NotInFish; NotInDocs],
76         [],
77         "internal test function - do not use",
78         "\
79 This is an internal test function which is used to test whether
80 the automatically generated bindings can handle every possible
81 return type correctly.
82
83 It converts string C<val> to the return type.
84
85 You probably don't want to call this function.");
86        (name ^ "err", (ret, [], []), -1, [NotInFish; NotInDocs],
87         [],
88         "internal test function - do not use",
89         "\
90 This is an internal test function which is used to test whether
91 the automatically generated bindings can handle every possible
92 return type correctly.
93
94 This function always returns an error.
95
96 You probably don't want to call this function.")]
97   ) test_all_rets
98 )
99
100 (* non_daemon_functions are any functions which don't get processed
101  * in the daemon, eg. functions for setting and getting local
102  * configuration values.
103  *)
104
105 let non_daemon_functions = test_functions @ [
106   ("launch", (RErr, [], []), -1, [FishAlias "run"; Progress],
107    [],
108    "launch the qemu subprocess",
109    "\
110 Internally libguestfs is implemented by running a virtual machine
111 using L<qemu(1)>.
112
113 You should call this after configuring the handle
114 (eg. adding drives) but before performing any actions.");
115
116   ("wait_ready", (RErr, [], []), -1, [NotInFish; DeprecatedBy "launch"],
117    [],
118    "wait until the qemu subprocess launches (no op)",
119    "\
120 This function is a no op.
121
122 In versions of the API E<lt> 1.0.71 you had to call this function
123 just after calling C<guestfs_launch> to wait for the launch
124 to complete.  However this is no longer necessary because
125 C<guestfs_launch> now does the waiting.
126
127 If you see any calls to this function in code then you can just
128 remove them, unless you want to retain compatibility with older
129 versions of the API.");
130
131   ("kill_subprocess", (RErr, [], []), -1, [],
132    [],
133    "kill the qemu subprocess",
134    "\
135 This kills the qemu subprocess.  You should never need to call this.");
136
137   ("add_drive", (RErr, [String "filename"], []), -1, [],
138    [],
139    "add an image to examine or modify",
140    "\
141 This function is the equivalent of calling C<guestfs_add_drive_opts>
142 with no optional parameters, so the disk is added writable, with
143 the format being detected automatically.
144
145 Automatic detection of the format opens you up to a potential
146 security hole when dealing with untrusted raw-format images.
147 See CVE-2010-3851 and RHBZ#642934.  Specifying the format closes
148 this security hole.  Therefore you should think about replacing
149 calls to this function with calls to C<guestfs_add_drive_opts>,
150 and specifying the format.");
151
152   ("add_cdrom", (RErr, [String "filename"], []), -1, [DeprecatedBy "add_drive_opts"],
153    [],
154    "add a CD-ROM disk image to examine",
155    "\
156 This function adds a virtual CD-ROM disk image to the guest.
157
158 This is equivalent to the qemu parameter I<-cdrom filename>.
159
160 Notes:
161
162 =over 4
163
164 =item *
165
166 This call checks for the existence of C<filename>.  This
167 stops you from specifying other types of drive which are supported
168 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
169 the general C<guestfs_config> call instead.
170
171 =item *
172
173 If you just want to add an ISO file (often you use this as an
174 efficient way to transfer large files into the guest), then you
175 should probably use C<guestfs_add_drive_ro> instead.
176
177 =back");
178
179   ("add_drive_ro", (RErr, [String "filename"], []), -1, [FishAlias "add-ro"],
180    [],
181    "add a drive in snapshot mode (read-only)",
182    "\
183 This function is the equivalent of calling C<guestfs_add_drive_opts>
184 with the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1,
185 so the disk is added read-only, with the format being detected
186 automatically.");
187
188   ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"], []), -1, [],
189    [],
190    "add qemu parameters",
191    "\
192 This can be used to add arbitrary qemu command line parameters
193 of the form I<-param value>.  Actually it's not quite arbitrary - we
194 prevent you from setting some parameters which would interfere with
195 parameters that we use.
196
197 The first character of C<param> string must be a C<-> (dash).
198
199 C<value> can be NULL.");
200
201   ("set_qemu", (RErr, [OptString "qemu"], []), -1, [FishAlias "qemu"],
202    [],
203    "set the qemu binary",
204    "\
205 Set the qemu binary that we will use.
206
207 The default is chosen when the library was compiled by the
208 configure script.
209
210 You can also override this by setting the C<LIBGUESTFS_QEMU>
211 environment variable.
212
213 Setting C<qemu> to C<NULL> restores the default qemu binary.
214
215 Note that you should call this function as early as possible
216 after creating the handle.  This is because some pre-launch
217 operations depend on testing qemu features (by running C<qemu -help>).
218 If the qemu binary changes, we don't retest features, and
219 so you might see inconsistent results.  Using the environment
220 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
221 the qemu binary at the same time as the handle is created.");
222
223   ("get_qemu", (RConstString "qemu", [], []), -1, [],
224    [InitNone, Always, TestRun (
225       [["get_qemu"]])],
226    "get the qemu binary",
227    "\
228 Return the current qemu binary.
229
230 This is always non-NULL.  If it wasn't set already, then this will
231 return the default qemu binary name.");
232
233   ("set_path", (RErr, [OptString "searchpath"], []), -1, [FishAlias "path"],
234    [],
235    "set the search path",
236    "\
237 Set the path that libguestfs searches for kernel and initrd.img.
238
239 The default is C<$libdir/guestfs> unless overridden by setting
240 C<LIBGUESTFS_PATH> environment variable.
241
242 Setting C<path> to C<NULL> restores the default path.");
243
244   ("get_path", (RConstString "path", [], []), -1, [],
245    [InitNone, Always, TestRun (
246       [["get_path"]])],
247    "get the search path",
248    "\
249 Return the current search path.
250
251 This is always non-NULL.  If it wasn't set already, then this will
252 return the default path.");
253
254   ("set_append", (RErr, [OptString "append"], []), -1, [FishAlias "append"],
255    [],
256    "add options to kernel command line",
257    "\
258 This function is used to add additional options to the
259 guest kernel command line.
260
261 The default is C<NULL> unless overridden by setting
262 C<LIBGUESTFS_APPEND> environment variable.
263
264 Setting C<append> to C<NULL> means I<no> additional options
265 are passed (libguestfs always adds a few of its own).");
266
267   ("get_append", (RConstOptString "append", [], []), -1, [],
268    (* This cannot be tested with the current framework.  The
269     * function can return NULL in normal operations, which the
270     * test framework interprets as an error.
271     *)
272    [],
273    "get the additional kernel options",
274    "\
275 Return the additional kernel options which are added to the
276 guest kernel command line.
277
278 If C<NULL> then no options are added.");
279
280   ("set_autosync", (RErr, [Bool "autosync"], []), -1, [FishAlias "autosync"],
281    [],
282    "set autosync mode",
283    "\
284 If C<autosync> is true, this enables autosync.  Libguestfs will make a
285 best effort attempt to make filesystems consistent and synchronized
286 when the handle is closed
287 (also if the program exits without closing handles).
288
289 This is enabled by default (since libguestfs 1.5.24, previously it was
290 disabled by default).");
291
292   ("get_autosync", (RBool "autosync", [], []), -1, [],
293    [InitNone, Always, TestOutputTrue (
294       [["get_autosync"]])],
295    "get autosync mode",
296    "\
297 Get the autosync flag.");
298
299   ("set_verbose", (RErr, [Bool "verbose"], []), -1, [FishAlias "verbose"],
300    [],
301    "set verbose mode",
302    "\
303 If C<verbose> is true, this turns on verbose messages.
304
305 Verbose messages are disabled unless the environment variable
306 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
307
308 Verbose messages are normally sent to C<stderr>, unless you
309 register a callback to send them somewhere else (see
310 C<guestfs_set_event_callback>).");
311
312   ("get_verbose", (RBool "verbose", [], []), -1, [],
313    [],
314    "get verbose mode",
315    "\
316 This returns the verbose messages flag.");
317
318   ("is_ready", (RBool "ready", [], []), -1, [],
319    [InitNone, Always, TestOutputTrue (
320       [["is_ready"]])],
321    "is ready to accept commands",
322    "\
323 This returns true iff this handle is ready to accept commands
324 (in the C<READY> state).
325
326 For more information on states, see L<guestfs(3)>.");
327
328   ("is_config", (RBool "config", [], []), -1, [],
329    [InitNone, Always, TestOutputFalse (
330       [["is_config"]])],
331    "is in configuration state",
332    "\
333 This returns true iff this handle is being configured
334 (in the C<CONFIG> state).
335
336 For more information on states, see L<guestfs(3)>.");
337
338   ("is_launching", (RBool "launching", [], []), -1, [],
339    [InitNone, Always, TestOutputFalse (
340       [["is_launching"]])],
341    "is launching subprocess",
342    "\
343 This returns true iff this handle is launching the subprocess
344 (in the C<LAUNCHING> state).
345
346 For more information on states, see L<guestfs(3)>.");
347
348   ("is_busy", (RBool "busy", [], []), -1, [],
349    [InitNone, Always, TestOutputFalse (
350       [["is_busy"]])],
351    "is busy processing a command",
352    "\
353 This returns true iff this handle is busy processing a command
354 (in the C<BUSY> state).
355
356 For more information on states, see L<guestfs(3)>.");
357
358   ("get_state", (RInt "state", [], []), -1, [],
359    [],
360    "get the current state",
361    "\
362 This returns the current state as an opaque integer.  This is
363 only useful for printing debug and internal error messages.
364
365 For more information on states, see L<guestfs(3)>.");
366
367   ("set_memsize", (RErr, [Int "memsize"], []), -1, [FishAlias "memsize"],
368    [InitNone, Always, TestOutputInt (
369       [["set_memsize"; "500"];
370        ["get_memsize"]], 500)],
371    "set memory allocated to the qemu subprocess",
372    "\
373 This sets the memory size in megabytes allocated to the
374 qemu subprocess.  This only has any effect if called before
375 C<guestfs_launch>.
376
377 You can also change this by setting the environment
378 variable C<LIBGUESTFS_MEMSIZE> before the handle is
379 created.
380
381 For more information on the architecture of libguestfs,
382 see L<guestfs(3)>.");
383
384   ("get_memsize", (RInt "memsize", [], []), -1, [],
385    [InitNone, Always, TestOutputIntOp (
386       [["get_memsize"]], ">=", 256)],
387    "get memory allocated to the qemu subprocess",
388    "\
389 This gets the memory size in megabytes allocated to the
390 qemu subprocess.
391
392 If C<guestfs_set_memsize> was not called
393 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
394 then this returns the compiled-in default value for memsize.
395
396 For more information on the architecture of libguestfs,
397 see L<guestfs(3)>.");
398
399   ("get_pid", (RInt "pid", [], []), -1, [FishAlias "pid"],
400    [InitNone, Always, TestOutputIntOp (
401       [["get_pid"]], ">=", 1)],
402    "get PID of qemu subprocess",
403    "\
404 Return the process ID of the qemu subprocess.  If there is no
405 qemu subprocess, then this will return an error.
406
407 This is an internal call used for debugging and testing.");
408
409   ("version", (RStruct ("version", "version"), [], []), -1, [],
410    [InitNone, Always, TestOutputStruct (
411       [["version"]], [CompareWithInt ("major", 1)])],
412    "get the library version number",
413    "\
414 Return the libguestfs version number that the program is linked
415 against.
416
417 Note that because of dynamic linking this is not necessarily
418 the version of libguestfs that you compiled against.  You can
419 compile the program, and then at runtime dynamically link
420 against a completely different C<libguestfs.so> library.
421
422 This call was added in version C<1.0.58>.  In previous
423 versions of libguestfs there was no way to get the version
424 number.  From C code you can use dynamic linker functions
425 to find out if this symbol exists (if it doesn't, then
426 it's an earlier version).
427
428 The call returns a structure with four elements.  The first
429 three (C<major>, C<minor> and C<release>) are numbers and
430 correspond to the usual version triplet.  The fourth element
431 (C<extra>) is a string and is normally empty, but may be
432 used for distro-specific information.
433
434 To construct the original version string:
435 C<$major.$minor.$release$extra>
436
437 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
438
439 I<Note:> Don't use this call to test for availability
440 of features.  In enterprise distributions we backport
441 features from later versions into earlier versions,
442 making this an unreliable way to test for features.
443 Use C<guestfs_available> instead.");
444
445   ("set_selinux", (RErr, [Bool "selinux"], []), -1, [FishAlias "selinux"],
446    [InitNone, Always, TestOutputTrue (
447       [["set_selinux"; "true"];
448        ["get_selinux"]])],
449    "set SELinux enabled or disabled at appliance boot",
450    "\
451 This sets the selinux flag that is passed to the appliance
452 at boot time.  The default is C<selinux=0> (disabled).
453
454 Note that if SELinux is enabled, it is always in
455 Permissive mode (C<enforcing=0>).
456
457 For more information on the architecture of libguestfs,
458 see L<guestfs(3)>.");
459
460   ("get_selinux", (RBool "selinux", [], []), -1, [],
461    [],
462    "get SELinux enabled flag",
463    "\
464 This returns the current setting of the selinux flag which
465 is passed to the appliance at boot time.  See C<guestfs_set_selinux>.
466
467 For more information on the architecture of libguestfs,
468 see L<guestfs(3)>.");
469
470   ("set_trace", (RErr, [Bool "trace"], []), -1, [FishAlias "trace"],
471    [InitNone, Always, TestOutputFalse (
472       [["set_trace"; "false"];
473        ["get_trace"]])],
474    "enable or disable command traces",
475    "\
476 If the command trace flag is set to 1, then libguestfs
477 calls, parameters and return values are traced.
478
479 If you want to trace C API calls into libguestfs (and
480 other libraries) then possibly a better way is to use
481 the external ltrace(1) command.
482
483 Command traces are disabled unless the environment variable
484 C<LIBGUESTFS_TRACE> is defined and set to C<1>.
485
486 Trace messages are normally sent to C<stderr>, unless you
487 register a callback to send them somewhere else (see
488 C<guestfs_set_event_callback>).");
489
490   ("get_trace", (RBool "trace", [], []), -1, [],
491    [],
492    "get command trace enabled flag",
493    "\
494 Return the command trace flag.");
495
496   ("set_direct", (RErr, [Bool "direct"], []), -1, [FishAlias "direct"],
497    [InitNone, Always, TestOutputFalse (
498       [["set_direct"; "false"];
499        ["get_direct"]])],
500    "enable or disable direct appliance mode",
501    "\
502 If the direct appliance mode flag is enabled, then stdin and
503 stdout are passed directly through to the appliance once it
504 is launched.
505
506 One consequence of this is that log messages aren't caught
507 by the library and handled by C<guestfs_set_log_message_callback>,
508 but go straight to stdout.
509
510 You probably don't want to use this unless you know what you
511 are doing.
512
513 The default is disabled.");
514
515   ("get_direct", (RBool "direct", [], []), -1, [],
516    [],
517    "get direct appliance mode flag",
518    "\
519 Return the direct appliance mode flag.");
520
521   ("set_recovery_proc", (RErr, [Bool "recoveryproc"], []), -1, [FishAlias "recovery-proc"],
522    [InitNone, Always, TestOutputTrue (
523       [["set_recovery_proc"; "true"];
524        ["get_recovery_proc"]])],
525    "enable or disable the recovery process",
526    "\
527 If this is called with the parameter C<false> then
528 C<guestfs_launch> does not create a recovery process.  The
529 purpose of the recovery process is to stop runaway qemu
530 processes in the case where the main program aborts abruptly.
531
532 This only has any effect if called before C<guestfs_launch>,
533 and the default is true.
534
535 About the only time when you would want to disable this is
536 if the main process will fork itself into the background
537 (\"daemonize\" itself).  In this case the recovery process
538 thinks that the main program has disappeared and so kills
539 qemu, which is not very helpful.");
540
541   ("get_recovery_proc", (RBool "recoveryproc", [], []), -1, [],
542    [],
543    "get recovery process enabled flag",
544    "\
545 Return the recovery process enabled flag.");
546
547   ("add_drive_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
548    [],
549    "add a drive specifying the QEMU block emulation to use",
550    "\
551 This is the same as C<guestfs_add_drive> but it allows you
552 to specify the QEMU interface emulation to use at run time.");
553
554   ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
555    [],
556    "add a drive read-only specifying the QEMU block emulation to use",
557    "\
558 This is the same as C<guestfs_add_drive_ro> but it allows you
559 to specify the QEMU interface emulation to use at run time.");
560
561   ("file_architecture", (RString "arch", [Pathname "filename"], []), -1, [],
562    [InitISOFS, Always, TestOutput (
563       [["file_architecture"; "/bin-i586-dynamic"]], "i386");
564     InitISOFS, Always, TestOutput (
565       [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
566     InitISOFS, Always, TestOutput (
567       [["file_architecture"; "/bin-win32.exe"]], "i386");
568     InitISOFS, Always, TestOutput (
569       [["file_architecture"; "/bin-win64.exe"]], "x86_64");
570     InitISOFS, Always, TestOutput (
571       [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
572     InitISOFS, Always, TestOutput (
573       [["file_architecture"; "/lib-i586.so"]], "i386");
574     InitISOFS, Always, TestOutput (
575       [["file_architecture"; "/lib-sparc.so"]], "sparc");
576     InitISOFS, Always, TestOutput (
577       [["file_architecture"; "/lib-win32.dll"]], "i386");
578     InitISOFS, Always, TestOutput (
579       [["file_architecture"; "/lib-win64.dll"]], "x86_64");
580     InitISOFS, Always, TestOutput (
581       [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
582     InitISOFS, Always, TestOutput (
583       [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
584     InitISOFS, Always, TestOutput (
585       [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
586    "detect the architecture of a binary file",
587    "\
588 This detects the architecture of the binary C<filename>,
589 and returns it if known.
590
591 Currently defined architectures are:
592
593 =over 4
594
595 =item \"i386\"
596
597 This string is returned for all 32 bit i386, i486, i586, i686 binaries
598 irrespective of the precise processor requirements of the binary.
599
600 =item \"x86_64\"
601
602 64 bit x86-64.
603
604 =item \"sparc\"
605
606 32 bit SPARC.
607
608 =item \"sparc64\"
609
610 64 bit SPARC V9 and above.
611
612 =item \"ia64\"
613
614 Intel Itanium.
615
616 =item \"ppc\"
617
618 32 bit Power PC.
619
620 =item \"ppc64\"
621
622 64 bit Power PC.
623
624 =back
625
626 Libguestfs may return other architecture strings in future.
627
628 The function works on at least the following types of files:
629
630 =over 4
631
632 =item *
633
634 many types of Un*x and Linux binary
635
636 =item *
637
638 many types of Un*x and Linux shared library
639
640 =item *
641
642 Windows Win32 and Win64 binaries
643
644 =item *
645
646 Windows Win32 and Win64 DLLs
647
648 Win32 binaries and DLLs return C<i386>.
649
650 Win64 binaries and DLLs return C<x86_64>.
651
652 =item *
653
654 Linux kernel modules
655
656 =item *
657
658 Linux new-style initrd images
659
660 =item *
661
662 some non-x86 Linux vmlinuz kernels
663
664 =back
665
666 What it can't do currently:
667
668 =over 4
669
670 =item *
671
672 static libraries (libfoo.a)
673
674 =item *
675
676 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
677
678 =item *
679
680 x86 Linux vmlinuz kernels
681
682 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
683 compressed code, and are horribly hard to unpack.  If you want to find
684 the architecture of a kernel, use the architecture of the associated
685 initrd or kernel module(s) instead.
686
687 =back");
688
689   ("inspect_os", (RStringList "roots", [], []), -1, [],
690    [],
691    "inspect disk and return list of operating systems found",
692    "\
693 This function uses other libguestfs functions and certain
694 heuristics to inspect the disk(s) (usually disks belonging to
695 a virtual machine), looking for operating systems.
696
697 The list returned is empty if no operating systems were found.
698
699 If one operating system was found, then this returns a list with
700 a single element, which is the name of the root filesystem of
701 this operating system.  It is also possible for this function
702 to return a list containing more than one element, indicating
703 a dual-boot or multi-boot virtual machine, with each element being
704 the root filesystem of one of the operating systems.
705
706 You can pass the root string(s) returned to other
707 C<guestfs_inspect_get_*> functions in order to query further
708 information about each operating system, such as the name
709 and version.
710
711 This function uses other libguestfs features such as
712 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
713 and unmount filesystems and look at the contents.  This should
714 be called with no disks currently mounted.  The function may also
715 use Augeas, so any existing Augeas handle will be closed.
716
717 This function cannot decrypt encrypted disks.  The caller
718 must do that first (supplying the necessary keys) if the
719 disk is encrypted.
720
721 Please read L<guestfs(3)/INSPECTION> for more details.
722
723 See also C<guestfs_list_filesystems>.");
724
725   ("inspect_get_type", (RString "name", [Device "root"], []), -1, [],
726    [],
727    "get type of inspected operating system",
728    "\
729 This returns the type of the inspected operating system.
730 Currently defined types are:
731
732 =over 4
733
734 =item \"linux\"
735
736 Any Linux-based operating system.
737
738 =item \"windows\"
739
740 Any Microsoft Windows operating system.
741
742 =item \"freebsd\"
743
744 FreeBSD.
745
746 =item \"unknown\"
747
748 The operating system type could not be determined.
749
750 =back
751
752 Future versions of libguestfs may return other strings here.
753 The caller should be prepared to handle any string.
754
755 Please read L<guestfs(3)/INSPECTION> for more details.");
756
757   ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
758    [],
759    "get architecture of inspected operating system",
760    "\
761 This returns the architecture of the inspected operating system.
762 The possible return values are listed under
763 C<guestfs_file_architecture>.
764
765 If the architecture could not be determined, then the
766 string C<unknown> is returned.
767
768 Please read L<guestfs(3)/INSPECTION> for more details.");
769
770   ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
771    [],
772    "get distro of inspected operating system",
773    "\
774 This returns the distro (distribution) of the inspected operating
775 system.
776
777 Currently defined distros are:
778
779 =over 4
780
781 =item \"archlinux\"
782
783 Arch Linux.
784
785 =item \"centos\"
786
787 CentOS.
788
789 =item \"debian\"
790
791 Debian.
792
793 =item \"fedora\"
794
795 Fedora.
796
797 =item \"gentoo\"
798
799 Gentoo.
800
801 =item \"linuxmint\"
802
803 Linux Mint.
804
805 =item \"mandriva\"
806
807 Mandriva.
808
809 =item \"meego\"
810
811 MeeGo.
812
813 =item \"pardus\"
814
815 Pardus.
816
817 =item \"redhat-based\"
818
819 Some Red Hat-derived distro.
820
821 =item \"rhel\"
822
823 Red Hat Enterprise Linux.
824
825 =item \"scientificlinux\"
826
827 Scientific Linux.
828
829 =item \"slackware\"
830
831 Slackware.
832
833 =item \"ttylinux\"
834
835 ttylinux.
836
837 =item \"ubuntu\"
838
839 Ubuntu.
840
841 =item \"unknown\"
842
843 The distro could not be determined.
844
845 =item \"windows\"
846
847 Windows does not have distributions.  This string is
848 returned if the OS type is Windows.
849
850 =back
851
852 Future versions of libguestfs may return other strings here.
853 The caller should be prepared to handle any string.
854
855 Please read L<guestfs(3)/INSPECTION> for more details.");
856
857   ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
858    [],
859    "get major version of inspected operating system",
860    "\
861 This returns the major version number of the inspected operating
862 system.
863
864 Windows uses a consistent versioning scheme which is I<not>
865 reflected in the popular public names used by the operating system.
866 Notably the operating system known as \"Windows 7\" is really
867 version 6.1 (ie. major = 6, minor = 1).  You can find out the
868 real versions corresponding to releases of Windows by consulting
869 Wikipedia or MSDN.
870
871 If the version could not be determined, then C<0> is returned.
872
873 Please read L<guestfs(3)/INSPECTION> for more details.");
874
875   ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
876    [],
877    "get minor version of inspected operating system",
878    "\
879 This returns the minor version number of the inspected operating
880 system.
881
882 If the version could not be determined, then C<0> is returned.
883
884 Please read L<guestfs(3)/INSPECTION> for more details.
885 See also C<guestfs_inspect_get_major_version>.");
886
887   ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
888    [],
889    "get product name of inspected operating system",
890    "\
891 This returns the product name of the inspected operating
892 system.  The product name is generally some freeform string
893 which can be displayed to the user, but should not be
894 parsed by programs.
895
896 If the product name could not be determined, then the
897 string C<unknown> is returned.
898
899 Please read L<guestfs(3)/INSPECTION> for more details.");
900
901   ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
902    [],
903    "get mountpoints of inspected operating system",
904    "\
905 This returns a hash of where we think the filesystems
906 associated with this operating system should be mounted.
907 Callers should note that this is at best an educated guess
908 made by reading configuration files such as C</etc/fstab>.
909 I<In particular note> that this may return filesystems
910 which are non-existent or not mountable and callers should
911 be prepared to handle or ignore failures if they try to
912 mount them.
913
914 Each element in the returned hashtable has a key which
915 is the path of the mountpoint (eg. C</boot>) and a value
916 which is the filesystem that would be mounted there
917 (eg. C</dev/sda1>).
918
919 Non-mounted devices such as swap devices are I<not>
920 returned in this list.
921
922 For operating systems like Windows which still use drive
923 letters, this call will only return an entry for the first
924 drive \"mounted on\" C</>.  For information about the
925 mapping of drive letters to partitions, see
926 C<guestfs_inspect_get_drive_mappings>.
927
928 Please read L<guestfs(3)/INSPECTION> for more details.
929 See also C<guestfs_inspect_get_filesystems>.");
930
931   ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
932    [],
933    "get filesystems associated with inspected operating system",
934    "\
935 This returns a list of all the filesystems that we think
936 are associated with this operating system.  This includes
937 the root filesystem, other ordinary filesystems, and
938 non-mounted devices like swap partitions.
939
940 In the case of a multi-boot virtual machine, it is possible
941 for a filesystem to be shared between operating systems.
942
943 Please read L<guestfs(3)/INSPECTION> for more details.
944 See also C<guestfs_inspect_get_mountpoints>.");
945
946   ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
947    [],
948    "set enable network flag",
949    "\
950 If C<network> is true, then the network is enabled in the
951 libguestfs appliance.  The default is false.
952
953 This affects whether commands are able to access the network
954 (see L<guestfs(3)/RUNNING COMMANDS>).
955
956 You must call this before calling C<guestfs_launch>, otherwise
957 it has no effect.");
958
959   ("get_network", (RBool "network", [], []), -1, [],
960    [],
961    "get enable network flag",
962    "\
963 This returns the enable network flag.");
964
965   ("list_filesystems", (RHashtable "fses", [], []), -1, [],
966    [],
967    "list filesystems",
968    "\
969 This inspection command looks for filesystems on partitions,
970 block devices and logical volumes, returning a list of devices
971 containing filesystems and their type.
972
973 The return value is a hash, where the keys are the devices
974 containing filesystems, and the values are the filesystem types.
975 For example:
976
977  \"/dev/sda1\" => \"ntfs\"
978  \"/dev/sda2\" => \"ext2\"
979  \"/dev/vg_guest/lv_root\" => \"ext4\"
980  \"/dev/vg_guest/lv_swap\" => \"swap\"
981
982 The value can have the special value \"unknown\", meaning the
983 content of the device is undetermined or empty.
984 \"swap\" means a Linux swap partition.
985
986 This command runs other libguestfs commands, which might include
987 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
988 use this soon after launch and only when nothing is mounted.
989
990 Not all of the filesystems returned will be mountable.  In
991 particular, swap partitions are returned in the list.  Also
992 this command does not check that each filesystem
993 found is valid and mountable, and some filesystems might
994 be mountable but require special options.  Filesystems may
995 not all belong to a single logical operating system
996 (use C<guestfs_inspect_os> to look for OSes).");
997
998   ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
999    [],
1000    "add an image to examine or modify",
1001    "\
1002 This function adds a virtual machine disk image C<filename> to
1003 libguestfs.  The first time you call this function, the disk
1004 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1005 so on.
1006
1007 You don't necessarily need to be root when using libguestfs.  However
1008 you obviously do need sufficient permissions to access the filename
1009 for whatever operations you want to perform (ie. read access if you
1010 just want to read the image or write access if you want to modify the
1011 image).
1012
1013 This call checks that C<filename> exists.
1014
1015 The optional arguments are:
1016
1017 =over 4
1018
1019 =item C<readonly>
1020
1021 If true then the image is treated as read-only.  Writes are still
1022 allowed, but they are stored in a temporary snapshot overlay which
1023 is discarded at the end.  The disk that you add is not modified.
1024
1025 =item C<format>
1026
1027 This forces the image format.  If you omit this (or use C<guestfs_add_drive>
1028 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1029 Possible formats include C<raw> and C<qcow2>.
1030
1031 Automatic detection of the format opens you up to a potential
1032 security hole when dealing with untrusted raw-format images.
1033 See CVE-2010-3851 and RHBZ#642934.  Specifying the format closes
1034 this security hole.
1035
1036 =item C<iface>
1037
1038 This rarely-used option lets you emulate the behaviour of the
1039 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1040
1041 =back");
1042
1043   ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1044    [],
1045    "get Windows systemroot of inspected operating system",
1046    "\
1047 This returns the Windows systemroot of the inspected guest.
1048 The systemroot is a directory path such as C</WINDOWS>.
1049
1050 This call assumes that the guest is Windows and that the
1051 systemroot could be determined by inspection.  If this is not
1052 the case then an error is returned.
1053
1054 Please read L<guestfs(3)/INSPECTION> for more details.");
1055
1056   ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1057    [],
1058    "return list of operating systems found by last inspection",
1059    "\
1060 This function is a convenient way to get the list of root
1061 devices, as returned from a previous call to C<guestfs_inspect_os>,
1062 but without redoing the whole inspection process.
1063
1064 This returns an empty list if either no root devices were
1065 found or the caller has not called C<guestfs_inspect_os>.
1066
1067 Please read L<guestfs(3)/INSPECTION> for more details.");
1068
1069   ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1070    [],
1071    "debug the QEMU command line (internal use only)",
1072    "\
1073 This returns the internal QEMU command line.  'debug' commands are
1074 not part of the formal API and can be removed or changed at any time.");
1075
1076   ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"; Bool "allowuuid"]), -1, [FishAlias "domain"],
1077    [],
1078    "add the disk(s) from a named libvirt domain",
1079    "\
1080 This function adds the disk(s) attached to the named libvirt
1081 domain C<dom>.  It works by connecting to libvirt, requesting
1082 the domain and domain XML from libvirt, parsing it for disks,
1083 and calling C<guestfs_add_drive_opts> on each one.
1084
1085 The number of disks added is returned.  This operation is atomic:
1086 if an error is returned, then no disks are added.
1087
1088 This function does some minimal checks to make sure the libvirt
1089 domain is not running (unless C<readonly> is true).  In a future
1090 version we will try to acquire the libvirt lock on each disk.
1091
1092 Disks must be accessible locally.  This often means that adding disks
1093 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1094 will fail unless those disks are accessible via the same device path
1095 locally too.
1096
1097 The optional C<libvirturi> parameter sets the libvirt URI
1098 (see L<http://libvirt.org/uri.html>).  If this is not set then
1099 we connect to the default libvirt URI (or one set through an
1100 environment variable, see the libvirt documentation for full
1101 details).
1102
1103 The optional C<live> flag controls whether this call will try
1104 to connect to a running virtual machine C<guestfsd> process if
1105 it sees a suitable E<lt>channelE<gt> element in the libvirt
1106 XML definition.  The default (if the flag is omitted) is never
1107 to try.  See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1108 information.
1109
1110 If the C<allowuuid> flag is true (default is false) then a UUID
1111 I<may> be passed instead of the domain name.  The C<dom> string is
1112 treated as a UUID first and looked up, and if that lookup fails
1113 then we treat C<dom> as a name as usual.
1114
1115 The other optional parameters are passed directly through to
1116 C<guestfs_add_drive_opts>.");
1117
1118 (*
1119 This interface is not quite baked yet. -- RWMJ 2010-11-11
1120   ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1121    [],
1122    "add the disk(s) from a libvirt domain",
1123    "\
1124 This function adds the disk(s) attached to the libvirt domain C<dom>.
1125 It works by requesting the domain XML from libvirt, parsing it for
1126 disks, and calling C<guestfs_add_drive_opts> on each one.
1127
1128 In the C API we declare C<void *dom>, but really it has type
1129 C<virDomainPtr dom>.  This is so we don't need E<lt>libvirt.hE<gt>.
1130
1131 The number of disks added is returned.  This operation is atomic:
1132 if an error is returned, then no disks are added.
1133
1134 This function does some minimal checks to make sure the libvirt
1135 domain is not running (unless C<readonly> is true).  In a future
1136 version we will try to acquire the libvirt lock on each disk.
1137
1138 Disks must be accessible locally.  This often means that adding disks
1139 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1140 will fail unless those disks are accessible via the same device path
1141 locally too.
1142
1143 The optional C<live> flag controls whether this call will try
1144 to connect to a running virtual machine C<guestfsd> process if
1145 it sees a suitable E<lt>channelE<gt> element in the libvirt
1146 XML definition.  The default (if the flag is omitted) is never
1147 to try.  See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1148 information.
1149
1150 The other optional parameters are passed directly through to
1151 C<guestfs_add_drive_opts>.");
1152 *)
1153
1154   ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1155    [],
1156    "get package format used by the operating system",
1157    "\
1158 This function and C<guestfs_inspect_get_package_management> return
1159 the package format and package management tool used by the
1160 inspected operating system.  For example for Fedora these
1161 functions would return C<rpm> (package format) and
1162 C<yum> (package management).
1163
1164 This returns the string C<unknown> if we could not determine the
1165 package format I<or> if the operating system does not have
1166 a real packaging system (eg. Windows).
1167
1168 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1169 Future versions of libguestfs may return other strings.
1170
1171 Please read L<guestfs(3)/INSPECTION> for more details.");
1172
1173   ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1174    [],
1175    "get package management tool used by the operating system",
1176    "\
1177 C<guestfs_inspect_get_package_format> and this function return
1178 the package format and package management tool used by the
1179 inspected operating system.  For example for Fedora these
1180 functions would return C<rpm> (package format) and
1181 C<yum> (package management).
1182
1183 This returns the string C<unknown> if we could not determine the
1184 package management tool I<or> if the operating system does not have
1185 a real packaging system (eg. Windows).
1186
1187 Possible strings include: C<yum>, C<up2date>,
1188 C<apt> (for all Debian derivatives),
1189 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1190 Future versions of libguestfs may return other strings.
1191
1192 Please read L<guestfs(3)/INSPECTION> for more details.");
1193
1194   ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1195    [],
1196    "get list of applications installed in the operating system",
1197    "\
1198 Return the list of applications installed in the operating system.
1199
1200 I<Note:> This call works differently from other parts of the
1201 inspection API.  You have to call C<guestfs_inspect_os>, then
1202 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1203 before calling this.  Listing applications is a significantly
1204 more difficult operation which requires access to the full
1205 filesystem.  Also note that unlike the other
1206 C<guestfs_inspect_get_*> calls which are just returning
1207 data cached in the libguestfs handle, this call actually reads
1208 parts of the mounted filesystems during the call.
1209
1210 This returns an empty list if the inspection code was not able
1211 to determine the list of applications.
1212
1213 The application structure contains the following fields:
1214
1215 =over 4
1216
1217 =item C<app_name>
1218
1219 The name of the application.  For Red Hat-derived and Debian-derived
1220 Linux guests, this is the package name.
1221
1222 =item C<app_display_name>
1223
1224 The display name of the application, sometimes localized to the
1225 install language of the guest operating system.
1226
1227 If unavailable this is returned as an empty string C<\"\">.
1228 Callers needing to display something can use C<app_name> instead.
1229
1230 =item C<app_epoch>
1231
1232 For package managers which use epochs, this contains the epoch of
1233 the package (an integer).  If unavailable, this is returned as C<0>.
1234
1235 =item C<app_version>
1236
1237 The version string of the application or package.  If unavailable
1238 this is returned as an empty string C<\"\">.
1239
1240 =item C<app_release>
1241
1242 The release string of the application or package, for package
1243 managers that use this.  If unavailable this is returned as an
1244 empty string C<\"\">.
1245
1246 =item C<app_install_path>
1247
1248 The installation path of the application (on operating systems
1249 such as Windows which use installation paths).  This path is
1250 in the format used by the guest operating system, it is not
1251 a libguestfs path.
1252
1253 If unavailable this is returned as an empty string C<\"\">.
1254
1255 =item C<app_trans_path>
1256
1257 The install path translated into a libguestfs path.
1258 If unavailable this is returned as an empty string C<\"\">.
1259
1260 =item C<app_publisher>
1261
1262 The name of the publisher of the application, for package
1263 managers that use this.  If unavailable this is returned
1264 as an empty string C<\"\">.
1265
1266 =item C<app_url>
1267
1268 The URL (eg. upstream URL) of the application.
1269 If unavailable this is returned as an empty string C<\"\">.
1270
1271 =item C<app_source_package>
1272
1273 For packaging systems which support this, the name of the source
1274 package.  If unavailable this is returned as an empty string C<\"\">.
1275
1276 =item C<app_summary>
1277
1278 A short (usually one line) description of the application or package.
1279 If unavailable this is returned as an empty string C<\"\">.
1280
1281 =item C<app_description>
1282
1283 A longer description of the application or package.
1284 If unavailable this is returned as an empty string C<\"\">.
1285
1286 =back
1287
1288 Please read L<guestfs(3)/INSPECTION> for more details.");
1289
1290   ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1291    [],
1292    "get hostname of the operating system",
1293    "\
1294 This function returns the hostname of the operating system
1295 as found by inspection of the guest's configuration files.
1296
1297 If the hostname could not be determined, then the
1298 string C<unknown> is returned.
1299
1300 Please read L<guestfs(3)/INSPECTION> for more details.");
1301
1302   ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1303    [],
1304    "get format of inspected operating system",
1305    "\
1306 This returns the format of the inspected operating system.  You
1307 can use it to detect install images, live CDs and similar.
1308
1309 Currently defined formats are:
1310
1311 =over 4
1312
1313 =item \"installed\"
1314
1315 This is an installed operating system.
1316
1317 =item \"installer\"
1318
1319 The disk image being inspected is not an installed operating system,
1320 but a I<bootable> install disk, live CD, or similar.
1321
1322 =item \"unknown\"
1323
1324 The format of this disk image is not known.
1325
1326 =back
1327
1328 Future versions of libguestfs may return other strings here.
1329 The caller should be prepared to handle any string.
1330
1331 Please read L<guestfs(3)/INSPECTION> for more details.");
1332
1333   ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1334    [],
1335    "get live flag for install disk",
1336    "\
1337 If C<guestfs_inspect_get_format> returns C<installer> (this
1338 is an install disk), then this returns true if a live image
1339 was detected on the disk.
1340
1341 Please read L<guestfs(3)/INSPECTION> for more details.");
1342
1343   ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1344    [],
1345    "get netinst (network installer) flag for install disk",
1346    "\
1347 If C<guestfs_inspect_get_format> returns C<installer> (this
1348 is an install disk), then this returns true if the disk is
1349 a network installer, ie. not a self-contained install CD but
1350 one which is likely to require network access to complete
1351 the install.
1352
1353 Please read L<guestfs(3)/INSPECTION> for more details.");
1354
1355   ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1356    [],
1357    "get multipart flag for install disk",
1358    "\
1359 If C<guestfs_inspect_get_format> returns C<installer> (this
1360 is an install disk), then this returns true if the disk is
1361 part of a set.
1362
1363 Please read L<guestfs(3)/INSPECTION> for more details.");
1364
1365   ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1366    [],
1367    "set the attach method",
1368    "\
1369 Set the method that libguestfs uses to connect to the back end
1370 guestfsd daemon.  Possible methods are:
1371
1372 =over 4
1373
1374 =item C<appliance>
1375
1376 Launch an appliance and connect to it.  This is the ordinary method
1377 and the default.
1378
1379 =item C<unix:I<path>>
1380
1381 Connect to the Unix domain socket I<path>.
1382
1383 This method lets you connect to an existing daemon or (using
1384 virtio-serial) to a live guest.  For more information, see
1385 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1386
1387 =back");
1388
1389   ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1390    [InitNone, Always, TestOutput (
1391       [["get_attach_method"]], "appliance")],
1392    "get the attach method",
1393    "\
1394 Return the current attach method.  See C<guestfs_set_attach_method>.");
1395
1396   ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1397    [],
1398    "get product variant of inspected operating system",
1399    "\
1400 This returns the product variant of the inspected operating
1401 system.
1402
1403 For Windows guests, this returns the contents of the Registry key
1404 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1405 C<InstallationType> which is usually a string such as
1406 C<Client> or C<Server> (other values are possible).  This
1407 can be used to distinguish consumer and enterprise versions
1408 of Windows that have the same version number (for example,
1409 Windows 7 and Windows 2008 Server are both version 6.1,
1410 but the former is C<Client> and the latter is C<Server>).
1411
1412 For enterprise Linux guests, in future we intend this to return
1413 the product variant such as C<Desktop>, C<Server> and so on.  But
1414 this is not implemented at present.
1415
1416 If the product variant could not be determined, then the
1417 string C<unknown> is returned.
1418
1419 Please read L<guestfs(3)/INSPECTION> for more details.
1420 See also C<guestfs_inspect_get_product_name>,
1421 C<guestfs_inspect_get_major_version>.");
1422
1423   ("inspect_get_windows_current_control_set", (RString "controlset", [Device "root"], []), -1, [],
1424    [],
1425    "get Windows CurrentControlSet of inspected operating system",
1426    "\
1427 This returns the Windows CurrentControlSet of the inspected guest.
1428 The CurrentControlSet is a registry key name such as C<ControlSet001>.
1429
1430 This call assumes that the guest is Windows and that the
1431 Registry could be examined by inspection.  If this is not
1432 the case then an error is returned.
1433
1434 Please read L<guestfs(3)/INSPECTION> for more details.");
1435
1436   ("inspect_get_drive_mappings", (RHashtable "drives", [Device "root"], []), -1, [],
1437    [],
1438    "get drive letter mappings",
1439    "\
1440 This call is useful for Windows which uses a primitive system
1441 of assigning drive letters (like \"C:\") to partitions.
1442 This inspection API examines the Windows Registry to find out
1443 how disks/partitions are mapped to drive letters, and returns
1444 a hash table as in the example below:
1445
1446  C      =>     /dev/vda2
1447  E      =>     /dev/vdb1
1448  F      =>     /dev/vdc1
1449
1450 Note that keys are drive letters.  For Windows, the key is
1451 case insensitive and just contains the drive letter, without
1452 the customary colon separator character.
1453
1454 In future we may support other operating systems that also used drive
1455 letters, but the keys for those might not be case insensitive
1456 and might be longer than 1 character.  For example in OS-9,
1457 hard drives were named C<h0>, C<h1> etc.
1458
1459 For Windows guests, currently only hard drive mappings are
1460 returned.  Removable disks (eg. DVD-ROMs) are ignored.
1461
1462 For guests that do not use drive mappings, or if the drive mappings
1463 could not be determined, this returns an empty hash table.
1464
1465 Please read L<guestfs(3)/INSPECTION> for more details.
1466 See also C<guestfs_inspect_get_mountpoints>,
1467 C<guestfs_inspect_get_filesystems>.");
1468
1469   ("inspect_get_icon", (RBufferOut "icon", [Device "root"],  [Bool "favicon"; Bool "highquality"]), -1, [],
1470    [],
1471    "get the icon corresponding to this operating system",
1472    "\
1473 This function returns an icon corresponding to the inspected
1474 operating system.  The icon is returned as a buffer containing a
1475 PNG image (re-encoded to PNG if necessary).
1476
1477 If it was not possible to get an icon this function returns a
1478 zero-length (non-NULL) buffer.  I<Callers must check for this case>.
1479
1480 Libguestfs will start by looking for a file called
1481 C</etc/favicon.png> or C<C:\\etc\\favicon.png>
1482 and if it has the correct format, the contents of this file will
1483 be returned.  You can disable favicons by passing the
1484 optional C<favicon> boolean as false (default is true).
1485
1486 If finding the favicon fails, then we look in other places in the
1487 guest for a suitable icon.
1488
1489 If the optional C<highquality> boolean is true then
1490 only high quality icons are returned, which means only icons of
1491 high resolution with an alpha channel.  The default (false) is
1492 to return any icon we can, even if it is of substandard quality.
1493
1494 Notes:
1495
1496 =over 4
1497
1498 =item *
1499
1500 Unlike most other inspection API calls, the guest's disks must be
1501 mounted up before you call this, since it needs to read information
1502 from the guest filesystem during the call.
1503
1504 =item *
1505
1506 B<Security:> The icon data comes from the untrusted guest,
1507 and should be treated with caution.  PNG files have been
1508 known to contain exploits.  Ensure that libpng (or other relevant
1509 libraries) are fully up to date before trying to process or
1510 display the icon.
1511
1512 =item *
1513
1514 The PNG image returned can be any size.  It might not be square.
1515 Libguestfs tries to return the largest, highest quality
1516 icon available.  The application must scale the icon to the
1517 required size.
1518
1519 =item *
1520
1521 Extracting icons from Windows guests requires the external
1522 C<wrestool> program from the C<icoutils> package, and
1523 several programs (C<bmptopnm>, C<pnmtopng>, C<pamcut>)
1524 from the C<netpbm> package.  These must be installed separately.
1525
1526 =item *
1527
1528 Operating system icons are usually trademarks.  Seek legal
1529 advice before using trademarks in applications.
1530
1531 =back");
1532
1533   ("set_pgroup", (RErr, [Bool "pgroup"], []), -1, [FishAlias "pgroup"],
1534    [],
1535    "set process group flag",
1536    "\
1537 If C<pgroup> is true, child processes are placed into
1538 their own process group.
1539
1540 The practical upshot of this is that signals like C<SIGINT> (from
1541 users pressing C<^C>) won't be received by the child process.
1542
1543 The default for this flag is false, because usually you want
1544 C<^C> to kill the subprocess.");
1545
1546   ("get_pgroup", (RBool "pgroup", [], []), -1, [],
1547    [],
1548    "get process group flag",
1549    "\
1550 This returns the process group flag.");
1551
1552   ("set_smp", (RErr, [Int "smp"], []), -1, [FishAlias "smp"],
1553    [],
1554    "set number of virtual CPUs in appliance",
1555    "\
1556 Change the number of virtual CPUs assigned to the appliance.  The
1557 default is C<1>.  Increasing this may improve performance, though
1558 often it has no effect.
1559
1560 This function must be called before C<guestfs_launch>.");
1561
1562   ("get_smp", (RInt "smp", [], []), -1, [],
1563    [],
1564    "get number of virtual CPUs in appliance",
1565    "\
1566 This returns the number of virtual CPUs assigned to the appliance.");
1567
1568 ]
1569
1570 (* daemon_functions are any functions which cause some action
1571  * to take place in the daemon.
1572  *)
1573
1574 let daemon_functions = [
1575   ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [DeprecatedBy "mount_options"],
1576    [InitEmpty, Always, TestOutput (
1577       [["part_disk"; "/dev/sda"; "mbr"];
1578        ["mkfs"; "ext2"; "/dev/sda1"];
1579        ["mount"; "/dev/sda1"; "/"];
1580        ["write"; "/new"; "new file contents"];
1581        ["cat"; "/new"]], "new file contents")],
1582    "mount a guest disk at a position in the filesystem",
1583    "\
1584 Mount a guest disk at a position in the filesystem.  Block devices
1585 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1586 the guest.  If those block devices contain partitions, they will have
1587 the usual names (eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style
1588 names can be used.
1589
1590 The rules are the same as for L<mount(2)>:  A filesystem must
1591 first be mounted on C</> before others can be mounted.  Other
1592 filesystems can only be mounted on directories which already
1593 exist.
1594
1595 The mounted filesystem is writable, if we have sufficient permissions
1596 on the underlying device.
1597
1598 B<Important note:>
1599 When you use this call, the filesystem options C<sync> and C<noatime>
1600 are set implicitly.  This was originally done because we thought it
1601 would improve reliability, but it turns out that I<-o sync> has a
1602 very large negative performance impact and negligible effect on
1603 reliability.  Therefore we recommend that you avoid using
1604 C<guestfs_mount> in any code that needs performance, and instead
1605 use C<guestfs_mount_options> (use an empty string for the first
1606 parameter if you don't want any options).");
1607
1608   ("sync", (RErr, [], []), 2, [],
1609    [ InitEmpty, Always, TestRun [["sync"]]],
1610    "sync disks, writes are flushed through to the disk image",
1611    "\
1612 This syncs the disk, so that any writes are flushed through to the
1613 underlying disk image.
1614
1615 You should always call this if you have modified a disk image, before
1616 closing the handle.");
1617
1618   ("touch", (RErr, [Pathname "path"], []), 3, [],
1619    [InitScratchFS, Always, TestOutputTrue (
1620       [["touch"; "/touch"];
1621        ["exists"; "/touch"]])],
1622    "update file timestamps or create a new file",
1623    "\
1624 Touch acts like the L<touch(1)> command.  It can be used to
1625 update the timestamps on a file, or, if the file does not exist,
1626 to create a new zero-length file.
1627
1628 This command only works on regular files, and will fail on other
1629 file types such as directories, symbolic links, block special etc.");
1630
1631   ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1632    [InitISOFS, Always, TestOutput (
1633       [["cat"; "/known-2"]], "abcdef\n")],
1634    "list the contents of a file",
1635    "\
1636 Return the contents of the file named C<path>.
1637
1638 Note that this function cannot correctly handle binary files
1639 (specifically, files containing C<\\0> character which is treated
1640 as end of string).  For those you need to use the C<guestfs_read_file>
1641 or C<guestfs_download> functions which have a more complex interface.");
1642
1643   ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1644    [], (* XXX Tricky to test because it depends on the exact format
1645         * of the 'ls -l' command, which changes between F10 and F11.
1646         *)
1647    "list the files in a directory (long format)",
1648    "\
1649 List the files in C<directory> (relative to the root directory,
1650 there is no cwd) in the format of 'ls -la'.
1651
1652 This command is mostly useful for interactive sessions.  It
1653 is I<not> intended that you try to parse the output string.");
1654
1655   ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1656    [InitScratchFS, Always, TestOutputList (
1657       [["mkdir"; "/ls"];
1658        ["touch"; "/ls/new"];
1659        ["touch"; "/ls/newer"];
1660        ["touch"; "/ls/newest"];
1661        ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1662    "list the files in a directory",
1663    "\
1664 List the files in C<directory> (relative to the root directory,
1665 there is no cwd).  The '.' and '..' entries are not returned, but
1666 hidden files are shown.
1667
1668 This command is mostly useful for interactive sessions.  Programs
1669 should probably use C<guestfs_readdir> instead.");
1670
1671   ("list_devices", (RStringList "devices", [], []), 7, [],
1672    [InitEmpty, Always, TestOutputListOfDevices (
1673       [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1674    "list the block devices",
1675    "\
1676 List all the block devices.
1677
1678 The full block device names are returned, eg. C</dev/sda>.
1679
1680 See also C<guestfs_list_filesystems>.");
1681
1682   ("list_partitions", (RStringList "partitions", [], []), 8, [],
1683    [InitBasicFS, Always, TestOutputListOfDevices (
1684       [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1685     InitEmpty, Always, TestOutputListOfDevices (
1686       [["part_init"; "/dev/sda"; "mbr"];
1687        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1688        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1689        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1690        ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1691    "list the partitions",
1692    "\
1693 List all the partitions detected on all block devices.
1694
1695 The full partition device names are returned, eg. C</dev/sda1>
1696
1697 This does not return logical volumes.  For that you will need to
1698 call C<guestfs_lvs>.
1699
1700 See also C<guestfs_list_filesystems>.");
1701
1702   ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1703    [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1704       [["pvs"]], ["/dev/sda1"]);
1705     InitEmpty, Always, TestOutputListOfDevices (
1706       [["part_init"; "/dev/sda"; "mbr"];
1707        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1708        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1709        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1710        ["pvcreate"; "/dev/sda1"];
1711        ["pvcreate"; "/dev/sda2"];
1712        ["pvcreate"; "/dev/sda3"];
1713        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1714    "list the LVM physical volumes (PVs)",
1715    "\
1716 List all the physical volumes detected.  This is the equivalent
1717 of the L<pvs(8)> command.
1718
1719 This returns a list of just the device names that contain
1720 PVs (eg. C</dev/sda2>).
1721
1722 See also C<guestfs_pvs_full>.");
1723
1724   ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1725    [InitBasicFSonLVM, Always, TestOutputList (
1726       [["vgs"]], ["VG"]);
1727     InitEmpty, Always, TestOutputList (
1728       [["part_init"; "/dev/sda"; "mbr"];
1729        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1730        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1731        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1732        ["pvcreate"; "/dev/sda1"];
1733        ["pvcreate"; "/dev/sda2"];
1734        ["pvcreate"; "/dev/sda3"];
1735        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1736        ["vgcreate"; "VG2"; "/dev/sda3"];
1737        ["vgs"]], ["VG1"; "VG2"])],
1738    "list the LVM volume groups (VGs)",
1739    "\
1740 List all the volumes groups detected.  This is the equivalent
1741 of the L<vgs(8)> command.
1742
1743 This returns a list of just the volume group names that were
1744 detected (eg. C<VolGroup00>).
1745
1746 See also C<guestfs_vgs_full>.");
1747
1748   ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1749    [InitBasicFSonLVM, Always, TestOutputList (
1750       [["lvs"]], ["/dev/VG/LV"]);
1751     InitEmpty, Always, TestOutputList (
1752       [["part_init"; "/dev/sda"; "mbr"];
1753        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1754        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1755        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1756        ["pvcreate"; "/dev/sda1"];
1757        ["pvcreate"; "/dev/sda2"];
1758        ["pvcreate"; "/dev/sda3"];
1759        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1760        ["vgcreate"; "VG2"; "/dev/sda3"];
1761        ["lvcreate"; "LV1"; "VG1"; "50"];
1762        ["lvcreate"; "LV2"; "VG1"; "50"];
1763        ["lvcreate"; "LV3"; "VG2"; "50"];
1764        ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1765    "list the LVM logical volumes (LVs)",
1766    "\
1767 List all the logical volumes detected.  This is the equivalent
1768 of the L<lvs(8)> command.
1769
1770 This returns a list of the logical volume device names
1771 (eg. C</dev/VolGroup00/LogVol00>).
1772
1773 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1774
1775   ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1776    [], (* XXX how to test? *)
1777    "list the LVM physical volumes (PVs)",
1778    "\
1779 List all the physical volumes detected.  This is the equivalent
1780 of the L<pvs(8)> command.  The \"full\" version includes all fields.");
1781
1782   ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1783    [], (* XXX how to test? *)
1784    "list the LVM volume groups (VGs)",
1785    "\
1786 List all the volumes groups detected.  This is the equivalent
1787 of the L<vgs(8)> command.  The \"full\" version includes all fields.");
1788
1789   ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1790    [], (* XXX how to test? *)
1791    "list the LVM logical volumes (LVs)",
1792    "\
1793 List all the logical volumes detected.  This is the equivalent
1794 of the L<lvs(8)> command.  The \"full\" version includes all fields.");
1795
1796   ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1797    [InitISOFS, Always, TestOutputList (
1798       [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1799     InitISOFS, Always, TestOutputList (
1800       [["read_lines"; "/empty"]], [])],
1801    "read file as lines",
1802    "\
1803 Return the contents of the file named C<path>.
1804
1805 The file contents are returned as a list of lines.  Trailing
1806 C<LF> and C<CRLF> character sequences are I<not> returned.
1807
1808 Note that this function cannot correctly handle binary files
1809 (specifically, files containing C<\\0> character which is treated
1810 as end of line).  For those you need to use the C<guestfs_read_file>
1811 function which has a more complex interface.");
1812
1813   ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1814    [], (* XXX Augeas code needs tests. *)
1815    "create a new Augeas handle",
1816    "\
1817 Create a new Augeas handle for editing configuration files.
1818 If there was any previous Augeas handle associated with this
1819 guestfs session, then it is closed.
1820
1821 You must call this before using any other C<guestfs_aug_*>
1822 commands.
1823
1824 C<root> is the filesystem root.  C<root> must not be NULL,
1825 use C</> instead.
1826
1827 The flags are the same as the flags defined in
1828 E<lt>augeas.hE<gt>, the logical I<or> of the following
1829 integers:
1830
1831 =over 4
1832
1833 =item C<AUG_SAVE_BACKUP> = 1
1834
1835 Keep the original file with a C<.augsave> extension.
1836
1837 =item C<AUG_SAVE_NEWFILE> = 2
1838
1839 Save changes into a file with extension C<.augnew>, and
1840 do not overwrite original.  Overrides C<AUG_SAVE_BACKUP>.
1841
1842 =item C<AUG_TYPE_CHECK> = 4
1843
1844 Typecheck lenses.
1845
1846 This option is only useful when debugging Augeas lenses.  Use
1847 of this option may require additional memory for the libguestfs
1848 appliance.  You may need to set the C<LIBGUESTFS_MEMSIZE>
1849 environment variable or call C<guestfs_set_memsize>.
1850
1851 =item C<AUG_NO_STDINC> = 8
1852
1853 Do not use standard load path for modules.
1854
1855 =item C<AUG_SAVE_NOOP> = 16
1856
1857 Make save a no-op, just record what would have been changed.
1858
1859 =item C<AUG_NO_LOAD> = 32
1860
1861 Do not load the tree in C<guestfs_aug_init>.
1862
1863 =back
1864
1865 To close the handle, you can call C<guestfs_aug_close>.
1866
1867 To find out more about Augeas, see L<http://augeas.net/>.");
1868
1869   ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1870    [], (* XXX Augeas code needs tests. *)
1871    "close the current Augeas handle",
1872    "\
1873 Close the current Augeas handle and free up any resources
1874 used by it.  After calling this, you have to call
1875 C<guestfs_aug_init> again before you can use any other
1876 Augeas functions.");
1877
1878   ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1879    [], (* XXX Augeas code needs tests. *)
1880    "define an Augeas variable",
1881    "\
1882 Defines an Augeas variable C<name> whose value is the result
1883 of evaluating C<expr>.  If C<expr> is NULL, then C<name> is
1884 undefined.
1885
1886 On success this returns the number of nodes in C<expr>, or
1887 C<0> if C<expr> evaluates to something which is not a nodeset.");
1888
1889   ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1890    [], (* XXX Augeas code needs tests. *)
1891    "define an Augeas node",
1892    "\
1893 Defines a variable C<name> whose value is the result of
1894 evaluating C<expr>.
1895
1896 If C<expr> evaluates to an empty nodeset, a node is created,
1897 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1898 C<name> will be the nodeset containing that single node.
1899
1900 On success this returns a pair containing the
1901 number of nodes in the nodeset, and a boolean flag
1902 if a node was created.");
1903
1904   ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1905    [], (* XXX Augeas code needs tests. *)
1906    "look up the value of an Augeas path",
1907    "\
1908 Look up the value associated with C<path>.  If C<path>
1909 matches exactly one node, the C<value> is returned.");
1910
1911   ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1912    [], (* XXX Augeas code needs tests. *)
1913    "set Augeas path to value",
1914    "\
1915 Set the value associated with C<path> to C<val>.
1916
1917 In the Augeas API, it is possible to clear a node by setting
1918 the value to NULL.  Due to an oversight in the libguestfs API
1919 you cannot do that with this call.  Instead you must use the
1920 C<guestfs_aug_clear> call.");
1921
1922   ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1923    [], (* XXX Augeas code needs tests. *)
1924    "insert a sibling Augeas node",
1925    "\
1926 Create a new sibling C<label> for C<path>, inserting it into
1927 the tree before or after C<path> (depending on the boolean
1928 flag C<before>).
1929
1930 C<path> must match exactly one existing node in the tree, and
1931 C<label> must be a label, ie. not contain C</>, C<*> or end
1932 with a bracketed index C<[N]>.");
1933
1934   ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1935    [], (* XXX Augeas code needs tests. *)
1936    "remove an Augeas path",
1937    "\
1938 Remove C<path> and all of its children.
1939
1940 On success this returns the number of entries which were removed.");
1941
1942   ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1943    [], (* XXX Augeas code needs tests. *)
1944    "move Augeas node",
1945    "\
1946 Move the node C<src> to C<dest>.  C<src> must match exactly
1947 one node.  C<dest> is overwritten if it exists.");
1948
1949   ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1950    [], (* XXX Augeas code needs tests. *)
1951    "return Augeas nodes which match augpath",
1952    "\
1953 Returns a list of paths which match the path expression C<path>.
1954 The returned paths are sufficiently qualified so that they match
1955 exactly one node in the current tree.");
1956
1957   ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1958    [], (* XXX Augeas code needs tests. *)
1959    "write all pending Augeas changes to disk",
1960    "\
1961 This writes all pending changes to disk.
1962
1963 The flags which were passed to C<guestfs_aug_init> affect exactly
1964 how files are saved.");
1965
1966   ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1967    [], (* XXX Augeas code needs tests. *)
1968    "load files into the tree",
1969    "\
1970 Load files into the tree.
1971
1972 See C<aug_load> in the Augeas documentation for the full gory
1973 details.");
1974
1975   ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1976    [], (* XXX Augeas code needs tests. *)
1977    "list Augeas nodes under augpath",
1978    "\
1979 This is just a shortcut for listing C<guestfs_aug_match>
1980 C<path/*> and sorting the resulting nodes into alphabetical order.");
1981
1982   ("rm", (RErr, [Pathname "path"], []), 29, [],
1983    [InitScratchFS, Always, TestRun
1984       [["mkdir"; "/rm"];
1985        ["touch"; "/rm/new"];
1986        ["rm"; "/rm/new"]];
1987     InitScratchFS, Always, TestLastFail
1988       [["rm"; "/nosuchfile"]];
1989     InitScratchFS, Always, TestLastFail
1990       [["mkdir"; "/rm2"];
1991        ["rm"; "/rm2"]]],
1992    "remove a file",
1993    "\
1994 Remove the single file C<path>.");
1995
1996   ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1997    [InitScratchFS, Always, TestRun
1998       [["mkdir"; "/rmdir"];
1999        ["rmdir"; "/rmdir"]];
2000     InitScratchFS, Always, TestLastFail
2001       [["rmdir"; "/rmdir2"]];
2002     InitScratchFS, Always, TestLastFail
2003       [["mkdir"; "/rmdir3"];
2004        ["touch"; "/rmdir3/new"];
2005        ["rmdir"; "/rmdir3/new"]]],
2006    "remove a directory",
2007    "\
2008 Remove the single directory C<path>.");
2009
2010   ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
2011    [InitScratchFS, Always, TestOutputFalse
2012       [["mkdir"; "/rm_rf"];
2013        ["mkdir"; "/rm_rf/foo"];
2014        ["touch"; "/rm_rf/foo/bar"];
2015        ["rm_rf"; "/rm_rf"];
2016        ["exists"; "/rm_rf"]]],
2017    "remove a file or directory recursively",
2018    "\
2019 Remove the file or directory C<path>, recursively removing the
2020 contents if its a directory.  This is like the C<rm -rf> shell
2021 command.");
2022
2023   ("mkdir", (RErr, [Pathname "path"], []), 32, [],
2024    [InitScratchFS, Always, TestOutputTrue
2025       [["mkdir"; "/mkdir"];
2026        ["is_dir"; "/mkdir"]];
2027     InitScratchFS, Always, TestLastFail
2028       [["mkdir"; "/mkdir2/foo/bar"]]],
2029    "create a directory",
2030    "\
2031 Create a directory named C<path>.");
2032
2033   ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
2034    [InitScratchFS, Always, TestOutputTrue
2035       [["mkdir_p"; "/mkdir_p/foo/bar"];
2036        ["is_dir"; "/mkdir_p/foo/bar"]];
2037     InitScratchFS, Always, TestOutputTrue
2038       [["mkdir_p"; "/mkdir_p2/foo/bar"];
2039        ["is_dir"; "/mkdir_p2/foo"]];
2040     InitScratchFS, Always, TestOutputTrue
2041       [["mkdir_p"; "/mkdir_p3/foo/bar"];
2042        ["is_dir"; "/mkdir_p3"]];
2043     (* Regression tests for RHBZ#503133: *)
2044     InitScratchFS, Always, TestRun
2045       [["mkdir"; "/mkdir_p4"];
2046        ["mkdir_p"; "/mkdir_p4"]];
2047     InitScratchFS, Always, TestLastFail
2048       [["touch"; "/mkdir_p5"];
2049        ["mkdir_p"; "/mkdir_p5"]]],
2050    "create a directory and parents",
2051    "\
2052 Create a directory named C<path>, creating any parent directories
2053 as necessary.  This is like the C<mkdir -p> shell command.");
2054
2055   ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
2056    [], (* XXX Need stat command to test *)
2057    "change file mode",
2058    "\
2059 Change the mode (permissions) of C<path> to C<mode>.  Only
2060 numeric modes are supported.
2061
2062 I<Note>: When using this command from guestfish, C<mode>
2063 by default would be decimal, unless you prefix it with
2064 C<0> to get octal, ie. use C<0700> not C<700>.
2065
2066 The mode actually set is affected by the umask.");
2067
2068   ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
2069    [], (* XXX Need stat command to test *)
2070    "change file owner and group",
2071    "\
2072 Change the file owner to C<owner> and group to C<group>.
2073
2074 Only numeric uid and gid are supported.  If you want to use
2075 names, you will need to locate and parse the password file
2076 yourself (Augeas support makes this relatively easy).");
2077
2078   ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
2079    [InitISOFS, Always, TestOutputTrue (
2080       [["exists"; "/empty"]]);
2081     InitISOFS, Always, TestOutputTrue (
2082       [["exists"; "/directory"]])],
2083    "test if file or directory exists",
2084    "\
2085 This returns C<true> if and only if there is a file, directory
2086 (or anything) with the given C<path> name.
2087
2088 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
2089
2090   ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
2091    [InitISOFS, Always, TestOutputTrue (
2092       [["is_file"; "/known-1"]]);
2093     InitISOFS, Always, TestOutputFalse (
2094       [["is_file"; "/directory"]])],
2095    "test if a regular file",
2096    "\
2097 This returns C<true> if and only if there is a regular file
2098 with the given C<path> name.  Note that it returns false for
2099 other objects like directories.
2100
2101 See also C<guestfs_stat>.");
2102
2103   ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
2104    [InitISOFS, Always, TestOutputFalse (
2105       [["is_dir"; "/known-3"]]);
2106     InitISOFS, Always, TestOutputTrue (
2107       [["is_dir"; "/directory"]])],
2108    "test if a directory",
2109    "\
2110 This returns C<true> if and only if there is a directory
2111 with the given C<path> name.  Note that it returns false for
2112 other objects like files.
2113
2114 See also C<guestfs_stat>.");
2115
2116   ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
2117    [InitEmpty, Always, TestOutputListOfDevices (
2118       [["part_init"; "/dev/sda"; "mbr"];
2119        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2120        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2121        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2122        ["pvcreate"; "/dev/sda1"];
2123        ["pvcreate"; "/dev/sda2"];
2124        ["pvcreate"; "/dev/sda3"];
2125        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2126    "create an LVM physical volume",
2127    "\
2128 This creates an LVM physical volume on the named C<device>,
2129 where C<device> should usually be a partition name such
2130 as C</dev/sda1>.");
2131
2132   ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
2133    [InitEmpty, Always, TestOutputList (
2134       [["part_init"; "/dev/sda"; "mbr"];
2135        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2136        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2137        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2138        ["pvcreate"; "/dev/sda1"];
2139        ["pvcreate"; "/dev/sda2"];
2140        ["pvcreate"; "/dev/sda3"];
2141        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2142        ["vgcreate"; "VG2"; "/dev/sda3"];
2143        ["vgs"]], ["VG1"; "VG2"])],
2144    "create an LVM volume group",
2145    "\
2146 This creates an LVM volume group called C<volgroup>
2147 from the non-empty list of physical volumes C<physvols>.");
2148
2149   ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
2150    [InitEmpty, Always, TestOutputList (
2151       [["part_init"; "/dev/sda"; "mbr"];
2152        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2153        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2154        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2155        ["pvcreate"; "/dev/sda1"];
2156        ["pvcreate"; "/dev/sda2"];
2157        ["pvcreate"; "/dev/sda3"];
2158        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2159        ["vgcreate"; "VG2"; "/dev/sda3"];
2160        ["lvcreate"; "LV1"; "VG1"; "50"];
2161        ["lvcreate"; "LV2"; "VG1"; "50"];
2162        ["lvcreate"; "LV3"; "VG2"; "50"];
2163        ["lvcreate"; "LV4"; "VG2"; "50"];
2164        ["lvcreate"; "LV5"; "VG2"; "50"];
2165        ["lvs"]],
2166       ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2167        "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2168    "create an LVM logical volume",
2169    "\
2170 This creates an LVM logical volume called C<logvol>
2171 on the volume group C<volgroup>, with C<size> megabytes.");
2172
2173   ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2174    [InitEmpty, Always, TestOutput (
2175       [["part_disk"; "/dev/sda"; "mbr"];
2176        ["mkfs"; "ext2"; "/dev/sda1"];
2177        ["mount_options"; ""; "/dev/sda1"; "/"];
2178        ["write"; "/new"; "new file contents"];
2179        ["cat"; "/new"]], "new file contents")],
2180    "make a filesystem",
2181    "\
2182 This creates a filesystem on C<device> (usually a partition
2183 or LVM logical volume).  The filesystem type is C<fstype>, for
2184 example C<ext3>.");
2185
2186   ("sfdisk", (RErr, [Device "device";
2187                      Int "cyls"; Int "heads"; Int "sectors";
2188                      StringList "lines"], []), 43, [DangerWillRobinson; DeprecatedBy "part_add"],
2189    [],
2190    "create partitions on a block device",
2191    "\
2192 This is a direct interface to the L<sfdisk(8)> program for creating
2193 partitions on block devices.
2194
2195 C<device> should be a block device, for example C</dev/sda>.
2196
2197 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2198 and sectors on the device, which are passed directly to sfdisk as
2199 the I<-C>, I<-H> and I<-S> parameters.  If you pass C<0> for any
2200 of these, then the corresponding parameter is omitted.  Usually for
2201 'large' disks, you can just pass C<0> for these, but for small
2202 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2203 out the right geometry and you will need to tell it.
2204
2205 C<lines> is a list of lines that we feed to C<sfdisk>.  For more
2206 information refer to the L<sfdisk(8)> manpage.
2207
2208 To create a single partition occupying the whole disk, you would
2209 pass C<lines> as a single element list, when the single element being
2210 the string C<,> (comma).
2211
2212 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2213 C<guestfs_part_init>");
2214
2215   ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2216    (* Regression test for RHBZ#597135. *)
2217    [InitScratchFS, Always, TestLastFail
2218       [["write_file"; "/write_file"; "abc"; "10000"]]],
2219    "create a file",
2220    "\
2221 This call creates a file called C<path>.  The contents of the
2222 file is the string C<content> (which can contain any 8 bit data),
2223 with length C<size>.
2224
2225 As a special case, if C<size> is C<0>
2226 then the length is calculated using C<strlen> (so in this case
2227 the content cannot contain embedded ASCII NULs).
2228
2229 I<NB.> Owing to a bug, writing content containing ASCII NUL
2230 characters does I<not> work, even if the length is specified.");
2231
2232   ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2233    [InitEmpty, Always, TestOutputListOfDevices (
2234       [["part_disk"; "/dev/sda"; "mbr"];
2235        ["mkfs"; "ext2"; "/dev/sda1"];
2236        ["mount_options"; ""; "/dev/sda1"; "/"];
2237        ["mounts"]], ["/dev/sda1"]);
2238     InitEmpty, Always, TestOutputList (
2239       [["part_disk"; "/dev/sda"; "mbr"];
2240        ["mkfs"; "ext2"; "/dev/sda1"];
2241        ["mount_options"; ""; "/dev/sda1"; "/"];
2242        ["umount"; "/"];
2243        ["mounts"]], [])],
2244    "unmount a filesystem",
2245    "\
2246 This unmounts the given filesystem.  The filesystem may be
2247 specified either by its mountpoint (path) or the device which
2248 contains the filesystem.");
2249
2250   ("mounts", (RStringList "devices", [], []), 46, [],
2251    [InitScratchFS, Always, TestOutputListOfDevices (
2252       [["mounts"]], ["/dev/sdb1"])],
2253    "show mounted filesystems",
2254    "\
2255 This returns the list of currently mounted filesystems.  It returns
2256 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2257
2258 Some internal mounts are not shown.
2259
2260 See also: C<guestfs_mountpoints>");
2261
2262   ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2263    [InitScratchFS, Always, TestOutputList (
2264       [["umount_all"];
2265        ["mounts"]], []);
2266     (* check that umount_all can unmount nested mounts correctly: *)
2267     InitEmpty, Always, TestOutputList (
2268       [["part_init"; "/dev/sda"; "mbr"];
2269        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2270        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2271        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2272        ["mkfs"; "ext2"; "/dev/sda1"];
2273        ["mkfs"; "ext2"; "/dev/sda2"];
2274        ["mkfs"; "ext2"; "/dev/sda3"];
2275        ["mount_options"; ""; "/dev/sda1"; "/"];
2276        ["mkdir"; "/mp1"];
2277        ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2278        ["mkdir"; "/mp1/mp2"];
2279        ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2280        ["mkdir"; "/mp1/mp2/mp3"];
2281        ["umount_all"];
2282        ["mounts"]], [])],
2283    "unmount all filesystems",
2284    "\
2285 This unmounts all mounted filesystems.
2286
2287 Some internal mounts are not unmounted by this call.");
2288
2289   ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2290    [],
2291    "remove all LVM LVs, VGs and PVs",
2292    "\
2293 This command removes all LVM logical volumes, volume groups
2294 and physical volumes.");
2295
2296   ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2297    [InitISOFS, Always, TestOutput (
2298       [["file"; "/empty"]], "empty");
2299     InitISOFS, Always, TestOutput (
2300       [["file"; "/known-1"]], "ASCII text");
2301     InitISOFS, Always, TestLastFail (
2302       [["file"; "/notexists"]]);
2303     InitISOFS, Always, TestOutput (
2304       [["file"; "/abssymlink"]], "symbolic link");
2305     InitISOFS, Always, TestOutput (
2306       [["file"; "/directory"]], "directory")],
2307    "determine file type",
2308    "\
2309 This call uses the standard L<file(1)> command to determine
2310 the type or contents of the file.
2311
2312 This call will also transparently look inside various types
2313 of compressed file.
2314
2315 The exact command which runs is C<file -zb path>.  Note in
2316 particular that the filename is not prepended to the output
2317 (the I<-b> option).
2318
2319 The output depends on the output of the underlying L<file(1)>
2320 command and it can change in future in ways beyond our control.
2321 In other words, the output is not guaranteed by the ABI.
2322
2323 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2324 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>.");
2325
2326   ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2327    [InitScratchFS, Always, TestOutput (
2328       [["mkdir"; "/command"];
2329        ["upload"; "test-command"; "/command/test-command"];
2330        ["chmod"; "0o755"; "/command/test-command"];
2331        ["command"; "/command/test-command 1"]], "Result1");
2332     InitScratchFS, Always, TestOutput (
2333       [["mkdir"; "/command2"];
2334        ["upload"; "test-command"; "/command2/test-command"];
2335        ["chmod"; "0o755"; "/command2/test-command"];
2336        ["command"; "/command2/test-command 2"]], "Result2\n");
2337     InitScratchFS, Always, TestOutput (
2338       [["mkdir"; "/command3"];
2339        ["upload"; "test-command"; "/command3/test-command"];
2340        ["chmod"; "0o755"; "/command3/test-command"];
2341        ["command"; "/command3/test-command 3"]], "\nResult3");
2342     InitScratchFS, Always, TestOutput (
2343       [["mkdir"; "/command4"];
2344        ["upload"; "test-command"; "/command4/test-command"];
2345        ["chmod"; "0o755"; "/command4/test-command"];
2346        ["command"; "/command4/test-command 4"]], "\nResult4\n");
2347     InitScratchFS, Always, TestOutput (
2348       [["mkdir"; "/command5"];
2349        ["upload"; "test-command"; "/command5/test-command"];
2350        ["chmod"; "0o755"; "/command5/test-command"];
2351        ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2352     InitScratchFS, Always, TestOutput (
2353       [["mkdir"; "/command6"];
2354        ["upload"; "test-command"; "/command6/test-command"];
2355        ["chmod"; "0o755"; "/command6/test-command"];
2356        ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2357     InitScratchFS, Always, TestOutput (
2358       [["mkdir"; "/command7"];
2359        ["upload"; "test-command"; "/command7/test-command"];
2360        ["chmod"; "0o755"; "/command7/test-command"];
2361        ["command"; "/command7/test-command 7"]], "");
2362     InitScratchFS, Always, TestOutput (
2363       [["mkdir"; "/command8"];
2364        ["upload"; "test-command"; "/command8/test-command"];
2365        ["chmod"; "0o755"; "/command8/test-command"];
2366        ["command"; "/command8/test-command 8"]], "\n");
2367     InitScratchFS, Always, TestOutput (
2368       [["mkdir"; "/command9"];
2369        ["upload"; "test-command"; "/command9/test-command"];
2370        ["chmod"; "0o755"; "/command9/test-command"];
2371        ["command"; "/command9/test-command 9"]], "\n\n");
2372     InitScratchFS, Always, TestOutput (
2373       [["mkdir"; "/command10"];
2374        ["upload"; "test-command"; "/command10/test-command"];
2375        ["chmod"; "0o755"; "/command10/test-command"];
2376        ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2377     InitScratchFS, Always, TestOutput (
2378       [["mkdir"; "/command11"];
2379        ["upload"; "test-command"; "/command11/test-command"];
2380        ["chmod"; "0o755"; "/command11/test-command"];
2381        ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2382     InitScratchFS, Always, TestLastFail (
2383       [["mkdir"; "/command12"];
2384        ["upload"; "test-command"; "/command12/test-command"];
2385        ["chmod"; "0o755"; "/command12/test-command"];
2386        ["command"; "/command12/test-command"]])],
2387    "run a command from the guest filesystem",
2388    "\
2389 This call runs a command from the guest filesystem.  The
2390 filesystem must be mounted, and must contain a compatible
2391 operating system (ie. something Linux, with the same
2392 or compatible processor architecture).
2393
2394 The single parameter is an argv-style list of arguments.
2395 The first element is the name of the program to run.
2396 Subsequent elements are parameters.  The list must be
2397 non-empty (ie. must contain a program name).  Note that
2398 the command runs directly, and is I<not> invoked via
2399 the shell (see C<guestfs_sh>).
2400
2401 The return value is anything printed to I<stdout> by
2402 the command.
2403
2404 If the command returns a non-zero exit status, then
2405 this function returns an error message.  The error message
2406 string is the content of I<stderr> from the command.
2407
2408 The C<$PATH> environment variable will contain at least
2409 C</usr/bin> and C</bin>.  If you require a program from
2410 another location, you should provide the full path in the
2411 first parameter.
2412
2413 Shared libraries and data files required by the program
2414 must be available on filesystems which are mounted in the
2415 correct places.  It is the caller's responsibility to ensure
2416 all filesystems that are needed are mounted at the right
2417 locations.");
2418
2419   ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2420    [InitScratchFS, Always, TestOutputList (
2421       [["mkdir"; "/command_lines"];
2422        ["upload"; "test-command"; "/command_lines/test-command"];
2423        ["chmod"; "0o755"; "/command_lines/test-command"];
2424        ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2425     InitScratchFS, Always, TestOutputList (
2426       [["mkdir"; "/command_lines2"];
2427        ["upload"; "test-command"; "/command_lines2/test-command"];
2428        ["chmod"; "0o755"; "/command_lines2/test-command"];
2429        ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2430     InitScratchFS, Always, TestOutputList (
2431       [["mkdir"; "/command_lines3"];
2432        ["upload"; "test-command"; "/command_lines3/test-command"];
2433        ["chmod"; "0o755"; "/command_lines3/test-command"];
2434        ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2435     InitScratchFS, Always, TestOutputList (
2436       [["mkdir"; "/command_lines4"];
2437        ["upload"; "test-command"; "/command_lines4/test-command"];
2438        ["chmod"; "0o755"; "/command_lines4/test-command"];
2439        ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2440     InitScratchFS, Always, TestOutputList (
2441       [["mkdir"; "/command_lines5"];
2442        ["upload"; "test-command"; "/command_lines5/test-command"];
2443        ["chmod"; "0o755"; "/command_lines5/test-command"];
2444        ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2445     InitScratchFS, Always, TestOutputList (
2446       [["mkdir"; "/command_lines6"];
2447        ["upload"; "test-command"; "/command_lines6/test-command"];
2448        ["chmod"; "0o755"; "/command_lines6/test-command"];
2449        ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2450     InitScratchFS, Always, TestOutputList (
2451       [["mkdir"; "/command_lines7"];
2452        ["upload"; "test-command"; "/command_lines7/test-command"];
2453        ["chmod"; "0o755"; "/command_lines7/test-command"];
2454        ["command_lines"; "/command_lines7/test-command 7"]], []);
2455     InitScratchFS, Always, TestOutputList (
2456       [["mkdir"; "/command_lines8"];
2457        ["upload"; "test-command"; "/command_lines8/test-command"];
2458        ["chmod"; "0o755"; "/command_lines8/test-command"];
2459        ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2460     InitScratchFS, Always, TestOutputList (
2461       [["mkdir"; "/command_lines9"];
2462        ["upload"; "test-command"; "/command_lines9/test-command"];
2463        ["chmod"; "0o755"; "/command_lines9/test-command"];
2464        ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2465     InitScratchFS, Always, TestOutputList (
2466       [["mkdir"; "/command_lines10"];
2467        ["upload"; "test-command"; "/command_lines10/test-command"];
2468        ["chmod"; "0o755"; "/command_lines10/test-command"];
2469        ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2470     InitScratchFS, Always, TestOutputList (
2471       [["mkdir"; "/command_lines11"];
2472        ["upload"; "test-command"; "/command_lines11/test-command"];
2473        ["chmod"; "0o755"; "/command_lines11/test-command"];
2474        ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2475    "run a command, returning lines",
2476    "\
2477 This is the same as C<guestfs_command>, but splits the
2478 result into a list of lines.
2479
2480 See also: C<guestfs_sh_lines>");
2481
2482   ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2483    [InitISOFS, Always, TestOutputStruct (
2484       [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2485    "get file information",
2486    "\
2487 Returns file information for the given C<path>.
2488
2489 This is the same as the C<stat(2)> system call.");
2490
2491   ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2492    [InitISOFS, Always, TestOutputStruct (
2493       [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2494    "get file information for a symbolic link",
2495    "\
2496 Returns file information for the given C<path>.
2497
2498 This is the same as C<guestfs_stat> except that if C<path>
2499 is a symbolic link, then the link is stat-ed, not the file it
2500 refers to.
2501
2502 This is the same as the C<lstat(2)> system call.");
2503
2504   ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2505    [InitISOFS, Always, TestOutputStruct (
2506       [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2507    "get file system statistics",
2508    "\
2509 Returns file system statistics for any mounted file system.
2510 C<path> should be a file or directory in the mounted file system
2511 (typically it is the mount point itself, but it doesn't need to be).
2512
2513 This is the same as the C<statvfs(2)> system call.");
2514
2515   ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2516    [], (* XXX test *)
2517    "get ext2/ext3/ext4 superblock details",
2518    "\
2519 This returns the contents of the ext2, ext3 or ext4 filesystem
2520 superblock on C<device>.
2521
2522 It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)>
2523 manpage for more details.  The list of fields returned isn't
2524 clearly defined, and depends on both the version of C<tune2fs>
2525 that libguestfs was built against, and the filesystem itself.");
2526
2527   ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2528    [InitEmpty, Always, TestOutputTrue (
2529       [["blockdev_setro"; "/dev/sda"];
2530        ["blockdev_getro"; "/dev/sda"]])],
2531    "set block device to read-only",
2532    "\
2533 Sets the block device named C<device> to read-only.
2534
2535 This uses the L<blockdev(8)> command.");
2536
2537   ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2538    [InitEmpty, Always, TestOutputFalse (
2539       [["blockdev_setrw"; "/dev/sda"];
2540        ["blockdev_getro"; "/dev/sda"]])],
2541    "set block device to read-write",
2542    "\
2543 Sets the block device named C<device> to read-write.
2544
2545 This uses the L<blockdev(8)> command.");
2546
2547   ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2548    [InitEmpty, Always, TestOutputTrue (
2549       [["blockdev_setro"; "/dev/sda"];
2550        ["blockdev_getro"; "/dev/sda"]])],
2551    "is block device set to read-only",
2552    "\
2553 Returns a boolean indicating if the block device is read-only
2554 (true if read-only, false if not).
2555
2556 This uses the L<blockdev(8)> command.");
2557
2558   ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2559    [InitEmpty, Always, TestOutputInt (
2560       [["blockdev_getss"; "/dev/sda"]], 512)],
2561    "get sectorsize of block device",
2562    "\
2563 This returns the size of sectors on a block device.
2564 Usually 512, but can be larger for modern devices.
2565
2566 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2567 for that).
2568
2569 This uses the L<blockdev(8)> command.");
2570
2571   ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2572    [InitEmpty, Always, TestOutputInt (
2573       [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2574    "get blocksize of block device",
2575    "\
2576 This returns the block size of a device.
2577
2578 (Note this is different from both I<size in blocks> and
2579 I<filesystem block size>).
2580
2581 This uses the L<blockdev(8)> command.");
2582
2583   ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2584    [], (* XXX test *)
2585    "set blocksize of block device",
2586    "\
2587 This sets the block size of a device.
2588
2589 (Note this is different from both I<size in blocks> and
2590 I<filesystem block size>).
2591
2592 This uses the L<blockdev(8)> command.");
2593
2594   ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2595    [InitEmpty, Always, TestOutputInt (
2596       [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2597    "get total size of device in 512-byte sectors",
2598    "\
2599 This returns the size of the device in units of 512-byte sectors
2600 (even if the sectorsize isn't 512 bytes ... weird).
2601
2602 See also C<guestfs_blockdev_getss> for the real sector size of
2603 the device, and C<guestfs_blockdev_getsize64> for the more
2604 useful I<size in bytes>.
2605
2606 This uses the L<blockdev(8)> command.");
2607
2608   ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2609    [InitEmpty, Always, TestOutputInt (
2610       [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2611    "get total size of device in bytes",
2612    "\
2613 This returns the size of the device in bytes.
2614
2615 See also C<guestfs_blockdev_getsz>.
2616
2617 This uses the L<blockdev(8)> command.");
2618
2619   ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2620    [InitEmpty, Always, TestRun
2621       [["blockdev_flushbufs"; "/dev/sda"]]],
2622    "flush device buffers",
2623    "\
2624 This tells the kernel to flush internal buffers associated
2625 with C<device>.
2626
2627 This uses the L<blockdev(8)> command.");
2628
2629   ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2630    [InitEmpty, Always, TestRun
2631       [["blockdev_rereadpt"; "/dev/sda"]]],
2632    "reread partition table",
2633    "\
2634 Reread the partition table on C<device>.
2635
2636 This uses the L<blockdev(8)> command.");
2637
2638   ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2639    [InitScratchFS, Always, TestOutput (
2640       (* Pick a file from cwd which isn't likely to change. *)
2641       [["mkdir"; "/upload"];
2642        ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2643        ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2644       Digest.to_hex (Digest.file "COPYING.LIB"))],
2645    "upload a file from the local machine",
2646    "\
2647 Upload local file C<filename> to C<remotefilename> on the
2648 filesystem.
2649
2650 C<filename> can also be a named pipe.
2651
2652 See also C<guestfs_download>.");
2653
2654   ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2655    [InitScratchFS, Always, TestOutput (
2656       (* Pick a file from cwd which isn't likely to change. *)
2657       [["mkdir"; "/download"];
2658        ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2659        ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2660        ["upload"; "testdownload.tmp"; "/download/upload"];
2661        ["checksum"; "md5"; "/download/upload"]],
2662       Digest.to_hex (Digest.file "COPYING.LIB"))],
2663    "download a file to the local machine",
2664    "\
2665 Download file C<remotefilename> and save it as C<filename>
2666 on the local machine.
2667
2668 C<filename> can also be a named pipe.
2669
2670 See also C<guestfs_upload>, C<guestfs_cat>.");
2671
2672   ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2673    [InitISOFS, Always, TestOutput (
2674       [["checksum"; "crc"; "/known-3"]], "2891671662");
2675     InitISOFS, Always, TestLastFail (
2676       [["checksum"; "crc"; "/notexists"]]);
2677     InitISOFS, Always, TestOutput (
2678       [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2679     InitISOFS, Always, TestOutput (
2680       [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2681     InitISOFS, Always, TestOutput (
2682       [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2683     InitISOFS, Always, TestOutput (
2684       [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2685     InitISOFS, Always, TestOutput (
2686       [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2687     InitISOFS, Always, TestOutput (
2688       [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2689     (* Test for RHBZ#579608, absolute symbolic links. *)
2690     InitISOFS, Always, TestOutput (
2691       [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2692    "compute MD5, SHAx or CRC checksum of file",
2693    "\
2694 This call computes the MD5, SHAx or CRC checksum of the
2695 file named C<path>.
2696
2697 The type of checksum to compute is given by the C<csumtype>
2698 parameter which must have one of the following values:
2699
2700 =over 4
2701
2702 =item C<crc>
2703
2704 Compute the cyclic redundancy check (CRC) specified by POSIX
2705 for the C<cksum> command.
2706
2707 =item C<md5>
2708
2709 Compute the MD5 hash (using the C<md5sum> program).
2710
2711 =item C<sha1>
2712
2713 Compute the SHA1 hash (using the C<sha1sum> program).
2714
2715 =item C<sha224>
2716
2717 Compute the SHA224 hash (using the C<sha224sum> program).
2718
2719 =item C<sha256>
2720
2721 Compute the SHA256 hash (using the C<sha256sum> program).
2722
2723 =item C<sha384>
2724
2725 Compute the SHA384 hash (using the C<sha384sum> program).
2726
2727 =item C<sha512>
2728
2729 Compute the SHA512 hash (using the C<sha512sum> program).
2730
2731 =back
2732
2733 The checksum is returned as a printable string.
2734
2735 To get the checksum for a device, use C<guestfs_checksum_device>.
2736
2737 To get the checksums for many files, use C<guestfs_checksums_out>.");
2738
2739   ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2740    [InitScratchFS, Always, TestOutput (
2741       [["mkdir"; "/tar_in"];
2742        ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2743        ["cat"; "/tar_in/hello"]], "hello\n")],
2744    "unpack tarfile to directory",
2745    "\
2746 This command uploads and unpacks local file C<tarfile> (an
2747 I<uncompressed> tar file) into C<directory>.
2748
2749 To upload a compressed tarball, use C<guestfs_tgz_in>
2750 or C<guestfs_txz_in>.");
2751
2752   ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2753    [],
2754    "pack directory into tarfile",
2755    "\
2756 This command packs the contents of C<directory> and downloads
2757 it to local file C<tarfile>.
2758
2759 To download a compressed tarball, use C<guestfs_tgz_out>
2760 or C<guestfs_txz_out>.");
2761
2762   ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2763    [InitScratchFS, Always, TestOutput (
2764       [["mkdir"; "/tgz_in"];
2765        ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2766        ["cat"; "/tgz_in/hello"]], "hello\n")],
2767    "unpack compressed tarball to directory",
2768    "\
2769 This command uploads and unpacks local file C<tarball> (a
2770 I<gzip compressed> tar file) into C<directory>.
2771
2772 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2773
2774   ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2775    [],
2776    "pack directory into compressed tarball",
2777    "\
2778 This command packs the contents of C<directory> and downloads
2779 it to local file C<tarball>.
2780
2781 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2782
2783   ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2784    [InitBasicFS, Always, TestLastFail (
2785       [["umount"; "/"];
2786        ["mount_ro"; "/dev/sda1"; "/"];
2787        ["touch"; "/new"]]);
2788     InitBasicFS, Always, TestOutput (
2789       [["write"; "/new"; "data"];
2790        ["umount"; "/"];
2791        ["mount_ro"; "/dev/sda1"; "/"];
2792        ["cat"; "/new"]], "data")],
2793    "mount a guest disk, read-only",
2794    "\
2795 This is the same as the C<guestfs_mount> command, but it
2796 mounts the filesystem with the read-only (I<-o ro>) flag.");
2797
2798   ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2799    [],
2800    "mount a guest disk with mount options",
2801    "\
2802 This is the same as the C<guestfs_mount> command, but it
2803 allows you to set the mount options as for the
2804 L<mount(8)> I<-o> flag.
2805
2806 If the C<options> parameter is an empty string, then
2807 no options are passed (all options default to whatever
2808 the filesystem uses).");
2809
2810   ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2811    [],
2812    "mount a guest disk with mount options and vfstype",
2813    "\
2814 This is the same as the C<guestfs_mount> command, but it
2815 allows you to set both the mount options and the vfstype
2816 as for the L<mount(8)> I<-o> and I<-t> flags.");
2817
2818   ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2819    [],
2820    "debugging and internals",
2821    "\
2822 The C<guestfs_debug> command exposes some internals of
2823 C<guestfsd> (the guestfs daemon) that runs inside the
2824 qemu subprocess.
2825
2826 There is no comprehensive help for this command.  You have
2827 to look at the file C<daemon/debug.c> in the libguestfs source
2828 to find out what you can do.");
2829
2830   ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2831    [InitEmpty, Always, TestOutputList (
2832       [["part_disk"; "/dev/sda"; "mbr"];
2833        ["pvcreate"; "/dev/sda1"];
2834        ["vgcreate"; "VG"; "/dev/sda1"];
2835        ["lvcreate"; "LV1"; "VG"; "50"];
2836        ["lvcreate"; "LV2"; "VG"; "50"];
2837        ["lvremove"; "/dev/VG/LV1"];
2838        ["lvs"]], ["/dev/VG/LV2"]);
2839     InitEmpty, Always, TestOutputList (
2840       [["part_disk"; "/dev/sda"; "mbr"];
2841        ["pvcreate"; "/dev/sda1"];
2842        ["vgcreate"; "VG"; "/dev/sda1"];
2843        ["lvcreate"; "LV1"; "VG"; "50"];
2844        ["lvcreate"; "LV2"; "VG"; "50"];
2845        ["lvremove"; "/dev/VG"];
2846        ["lvs"]], []);
2847     InitEmpty, Always, TestOutputList (
2848       [["part_disk"; "/dev/sda"; "mbr"];
2849        ["pvcreate"; "/dev/sda1"];
2850        ["vgcreate"; "VG"; "/dev/sda1"];
2851        ["lvcreate"; "LV1"; "VG"; "50"];
2852        ["lvcreate"; "LV2"; "VG"; "50"];
2853        ["lvremove"; "/dev/VG"];
2854        ["vgs"]], ["VG"])],
2855    "remove an LVM logical volume",
2856    "\
2857 Remove an LVM logical volume C<device>, where C<device> is
2858 the path to the LV, such as C</dev/VG/LV>.
2859
2860 You can also remove all LVs in a volume group by specifying
2861 the VG name, C</dev/VG>.");
2862
2863   ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2864    [InitEmpty, Always, TestOutputList (
2865       [["part_disk"; "/dev/sda"; "mbr"];
2866        ["pvcreate"; "/dev/sda1"];
2867        ["vgcreate"; "VG"; "/dev/sda1"];
2868        ["lvcreate"; "LV1"; "VG"; "50"];
2869        ["lvcreate"; "LV2"; "VG"; "50"];
2870        ["vgremove"; "VG"];
2871        ["lvs"]], []);
2872     InitEmpty, Always, TestOutputList (
2873       [["part_disk"; "/dev/sda"; "mbr"];
2874        ["pvcreate"; "/dev/sda1"];
2875        ["vgcreate"; "VG"; "/dev/sda1"];
2876        ["lvcreate"; "LV1"; "VG"; "50"];
2877        ["lvcreate"; "LV2"; "VG"; "50"];
2878        ["vgremove"; "VG"];
2879        ["vgs"]], [])],
2880    "remove an LVM volume group",
2881    "\
2882 Remove an LVM volume group C<vgname>, (for example C<VG>).
2883
2884 This also forcibly removes all logical volumes in the volume
2885 group (if any).");
2886
2887   ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2888    [InitEmpty, Always, TestOutputListOfDevices (
2889       [["part_disk"; "/dev/sda"; "mbr"];
2890        ["pvcreate"; "/dev/sda1"];
2891        ["vgcreate"; "VG"; "/dev/sda1"];
2892        ["lvcreate"; "LV1"; "VG"; "50"];
2893        ["lvcreate"; "LV2"; "VG"; "50"];
2894        ["vgremove"; "VG"];
2895        ["pvremove"; "/dev/sda1"];
2896        ["lvs"]], []);
2897     InitEmpty, Always, TestOutputListOfDevices (
2898       [["part_disk"; "/dev/sda"; "mbr"];
2899        ["pvcreate"; "/dev/sda1"];
2900        ["vgcreate"; "VG"; "/dev/sda1"];
2901        ["lvcreate"; "LV1"; "VG"; "50"];
2902        ["lvcreate"; "LV2"; "VG"; "50"];
2903        ["vgremove"; "VG"];
2904        ["pvremove"; "/dev/sda1"];
2905        ["vgs"]], []);
2906     InitEmpty, Always, TestOutputListOfDevices (
2907       [["part_disk"; "/dev/sda"; "mbr"];
2908        ["pvcreate"; "/dev/sda1"];
2909        ["vgcreate"; "VG"; "/dev/sda1"];
2910        ["lvcreate"; "LV1"; "VG"; "50"];
2911        ["lvcreate"; "LV2"; "VG"; "50"];
2912        ["vgremove"; "VG"];
2913        ["pvremove"; "/dev/sda1"];
2914        ["pvs"]], [])],
2915    "remove an LVM physical volume",
2916    "\
2917 This wipes a physical volume C<device> so that LVM will no longer
2918 recognise it.
2919
2920 The implementation uses the C<pvremove> command which refuses to
2921 wipe physical volumes that contain any volume groups, so you have
2922 to remove those first.");
2923
2924   ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2925    [InitBasicFS, Always, TestOutput (
2926       [["set_e2label"; "/dev/sda1"; "testlabel"];
2927        ["get_e2label"; "/dev/sda1"]], "testlabel")],
2928    "set the ext2/3/4 filesystem label",
2929    "\
2930 This sets the ext2/3/4 filesystem label of the filesystem on
2931 C<device> to C<label>.  Filesystem labels are limited to
2932 16 characters.
2933
2934 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2935 to return the existing label on a filesystem.");
2936
2937   ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2938    [],
2939    "get the ext2/3/4 filesystem label",
2940    "\
2941 This returns the ext2/3/4 filesystem label of the filesystem on
2942 C<device>.");
2943
2944   ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2945    (let uuid = uuidgen () in
2946     [InitBasicFS, Always, TestOutput (
2947        [["set_e2uuid"; "/dev/sda1"; uuid];
2948         ["get_e2uuid"; "/dev/sda1"]], uuid);
2949      InitBasicFS, Always, TestOutput (
2950        [["set_e2uuid"; "/dev/sda1"; "clear"];
2951         ["get_e2uuid"; "/dev/sda1"]], "");
2952      (* We can't predict what UUIDs will be, so just check the commands run. *)
2953      InitBasicFS, Always, TestRun (
2954        [["set_e2uuid"; "/dev/sda1"; "random"]]);
2955      InitBasicFS, Always, TestRun (
2956        [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2957    "set the ext2/3/4 filesystem UUID",
2958    "\
2959 This sets the ext2/3/4 filesystem UUID of the filesystem on
2960 C<device> to C<uuid>.  The format of the UUID and alternatives
2961 such as C<clear>, C<random> and C<time> are described in the
2962 L<tune2fs(8)> manpage.
2963
2964 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2965 to return the existing UUID of a filesystem.");
2966
2967   ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2968    (* Regression test for RHBZ#597112. *)
2969    (let uuid = uuidgen () in
2970     [InitNone, Always, TestOutput (
2971        [["mke2journal"; "1024"; "/dev/sdc"];
2972         ["set_e2uuid"; "/dev/sdc"; uuid];
2973         ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2974    "get the ext2/3/4 filesystem UUID",
2975    "\
2976 This returns the ext2/3/4 filesystem UUID of the filesystem on
2977 C<device>.");
2978
2979   ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2980    [InitBasicFS, Always, TestOutputInt (
2981       [["umount"; "/dev/sda1"];
2982        ["fsck"; "ext2"; "/dev/sda1"]], 0);
2983     InitBasicFS, Always, TestOutputInt (
2984       [["umount"; "/dev/sda1"];
2985        ["zero"; "/dev/sda1"];
2986        ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2987    "run the filesystem checker",
2988    "\
2989 This runs the filesystem checker (fsck) on C<device> which
2990 should have filesystem type C<fstype>.
2991
2992 The returned integer is the status.  See L<fsck(8)> for the
2993 list of status codes from C<fsck>.
2994
2995 Notes:
2996
2997 =over 4
2998
2999 =item *
3000
3001 Multiple status codes can be summed together.
3002
3003 =item *
3004
3005 A non-zero return code can mean \"success\", for example if
3006 errors have been corrected on the filesystem.
3007
3008 =item *
3009
3010 Checking or repairing NTFS volumes is not supported
3011 (by linux-ntfs).
3012
3013 =back
3014
3015 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
3016
3017   ("zero", (RErr, [Device "device"], []), 85, [Progress],
3018    [InitBasicFS, Always, TestRun (
3019       [["umount"; "/dev/sda1"];
3020        ["zero"; "/dev/sda1"]])],
3021    "write zeroes to the device",
3022    "\
3023 This command writes zeroes over the first few blocks of C<device>.
3024
3025 How many blocks are zeroed isn't specified (but it's I<not> enough
3026 to securely wipe the device).  It should be sufficient to remove
3027 any partition tables, filesystem superblocks and so on.
3028
3029 If blocks are already zero, then this command avoids writing
3030 zeroes.  This prevents the underlying device from becoming non-sparse
3031 or growing unnecessarily.
3032
3033 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>,
3034 C<guestfs_is_zero_device>");
3035
3036   ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [Optional "grub"],
3037    (* See:
3038     * https://bugzilla.redhat.com/show_bug.cgi?id=484986
3039     * https://bugzilla.redhat.com/show_bug.cgi?id=479760
3040     *)
3041    [InitBasicFS, Always, TestOutputTrue (
3042       [["mkdir_p"; "/boot/grub"];
3043        ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
3044        ["grub_install"; "/"; "/dev/vda"];
3045        ["is_dir"; "/boot"]])],
3046    "install GRUB 1",
3047    "\
3048 This command installs GRUB 1 (the Grand Unified Bootloader) on
3049 C<device>, with the root directory being C<root>.
3050
3051 Notes:
3052
3053 =over 4
3054
3055 =item *
3056
3057 There is currently no way in the API to install grub2, which
3058 is used by most modern Linux guests.  It is possible to run
3059 the grub2 command from the guest, although see the
3060 caveats in L<guestfs(3)/RUNNING COMMANDS>.
3061
3062 =item *
3063
3064 This uses C<grub-install> from the host.  Unfortunately grub is
3065 not always compatible with itself, so this only works in rather
3066 narrow circumstances.  Careful testing with each guest version
3067 is advisable.
3068
3069 =item *
3070
3071 If grub-install reports the error
3072 \"No suitable drive was found in the generated device map.\"
3073 it may be that you need to create a C</boot/grub/device.map>
3074 file first that contains the mapping between grub device names
3075 and Linux device names.  It is usually sufficient to create
3076 a file containing:
3077
3078  (hd0) /dev/vda
3079
3080 replacing C</dev/vda> with the name of the installation device.
3081
3082 =back");
3083
3084   ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
3085    [InitScratchFS, Always, TestOutput (
3086       [["mkdir"; "/cp"];
3087        ["write"; "/cp/old"; "file content"];
3088        ["cp"; "/cp/old"; "/cp/new"];
3089        ["cat"; "/cp/new"]], "file content");
3090     InitScratchFS, Always, TestOutputTrue (
3091       [["mkdir"; "/cp2"];
3092        ["write"; "/cp2/old"; "file content"];
3093        ["cp"; "/cp2/old"; "/cp2/new"];
3094        ["is_file"; "/cp2/old"]]);
3095     InitScratchFS, Always, TestOutput (
3096       [["mkdir"; "/cp3"];
3097        ["write"; "/cp3/old"; "file content"];
3098        ["mkdir"; "/cp3/dir"];
3099        ["cp"; "/cp3/old"; "/cp3/dir/new"];
3100        ["cat"; "/cp3/dir/new"]], "file content")],
3101    "copy a file",
3102    "\
3103 This copies a file from C<src> to C<dest> where C<dest> is
3104 either a destination filename or destination directory.");
3105
3106   ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
3107    [InitScratchFS, Always, TestOutput (
3108       [["mkdir"; "/cp_a1"];
3109        ["mkdir"; "/cp_a2"];
3110        ["write"; "/cp_a1/file"; "file content"];
3111        ["cp_a"; "/cp_a1"; "/cp_a2"];
3112        ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
3113    "copy a file or directory recursively",
3114    "\
3115 This copies a file or directory from C<src> to C<dest>
3116 recursively using the C<cp -a> command.");
3117
3118   ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
3119    [InitScratchFS, Always, TestOutput (
3120       [["mkdir"; "/mv"];
3121        ["write"; "/mv/old"; "file content"];
3122        ["mv"; "/mv/old"; "/mv/new"];
3123        ["cat"; "/mv/new"]], "file content");
3124     InitScratchFS, Always, TestOutputFalse (
3125       [["mkdir"; "/mv2"];
3126        ["write"; "/mv2/old"; "file content"];
3127        ["mv"; "/mv2/old"; "/mv2/new"];
3128        ["is_file"; "/mv2/old"]])],
3129    "move a file",
3130    "\
3131 This moves a file from C<src> to C<dest> where C<dest> is
3132 either a destination filename or destination directory.");
3133
3134   ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3135    [InitEmpty, Always, TestRun (
3136       [["drop_caches"; "3"]])],
3137    "drop kernel page cache, dentries and inodes",
3138    "\
3139 This instructs the guest kernel to drop its page cache,
3140 and/or dentries and inode caches.  The parameter C<whattodrop>
3141 tells the kernel what precisely to drop, see
3142 L<http://linux-mm.org/Drop_Caches>
3143
3144 Setting C<whattodrop> to 3 should drop everything.
3145
3146 This automatically calls L<sync(2)> before the operation,
3147 so that the maximum guest memory is freed.");
3148
3149   ("dmesg", (RString "kmsgs", [], []), 91, [],
3150    [InitEmpty, Always, TestRun (
3151       [["dmesg"]])],
3152    "return kernel messages",
3153    "\
3154 This returns the kernel messages (C<dmesg> output) from
3155 the guest kernel.  This is sometimes useful for extended
3156 debugging of problems.
3157
3158 Another way to get the same information is to enable
3159 verbose messages with C<guestfs_set_verbose> or by setting
3160 the environment variable C<LIBGUESTFS_DEBUG=1> before
3161 running the program.");
3162
3163   ("ping_daemon", (RErr, [], []), 92, [],
3164    [InitEmpty, Always, TestRun (
3165       [["ping_daemon"]])],
3166    "ping the guest daemon",
3167    "\
3168 This is a test probe into the guestfs daemon running inside
3169 the qemu subprocess.  Calling this function checks that the
3170 daemon responds to the ping message, without affecting the daemon
3171 or attached block device(s) in any other way.");
3172
3173   ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3174    [InitScratchFS, Always, TestOutputTrue (
3175       [["mkdir"; "/equal"];
3176        ["write"; "/equal/file1"; "contents of a file"];
3177        ["cp"; "/equal/file1"; "/equal/file2"];
3178        ["equal"; "/equal/file1"; "/equal/file2"]]);
3179     InitScratchFS, Always, TestOutputFalse (
3180       [["mkdir"; "/equal2"];
3181        ["write"; "/equal2/file1"; "contents of a file"];
3182        ["write"; "/equal2/file2"; "contents of another file"];
3183        ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3184     InitScratchFS, Always, TestLastFail (
3185       [["mkdir"; "/equal3"];
3186        ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3187    "test if two files have equal contents",
3188    "\
3189 This compares the two files C<file1> and C<file2> and returns
3190 true if their content is exactly equal, or false otherwise.
3191
3192 The external L<cmp(1)> program is used for the comparison.");
3193
3194   ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3195    [InitISOFS, Always, TestOutputList (
3196       [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3197     InitISOFS, Always, TestOutputList (
3198       [["strings"; "/empty"]], []);
3199     (* Test for RHBZ#579608, absolute symbolic links. *)
3200     InitISOFS, Always, TestRun (
3201       [["strings"; "/abssymlink"]])],
3202    "print the printable strings in a file",
3203    "\
3204 This runs the L<strings(1)> command on a file and returns
3205 the list of printable strings found.");
3206
3207   ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3208    [InitISOFS, Always, TestOutputList (
3209       [["strings_e"; "b"; "/known-5"]], []);
3210     InitScratchFS, Always, TestOutputList (
3211       [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3212        ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3213    "print the printable strings in a file",
3214    "\
3215 This is like the C<guestfs_strings> command, but allows you to
3216 specify the encoding of strings that are looked for in
3217 the source file C<path>.
3218
3219 Allowed encodings are:
3220
3221 =over 4
3222
3223 =item s
3224
3225 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3226 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3227
3228 =item S
3229
3230 Single 8-bit-byte characters.
3231
3232 =item b
3233
3234 16-bit big endian strings such as those encoded in
3235 UTF-16BE or UCS-2BE.
3236
3237 =item l (lower case letter L)
3238
3239 16-bit little endian such as UTF-16LE and UCS-2LE.
3240 This is useful for examining binaries in Windows guests.
3241
3242 =item B
3243
3244 32-bit big endian such as UCS-4BE.
3245
3246 =item L
3247
3248 32-bit little endian such as UCS-4LE.
3249
3250 =back
3251
3252 The returned strings are transcoded to UTF-8.");
3253
3254   ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3255    [InitISOFS, Always, TestOutput (
3256       [["hexdump"; "/known-4"]], "00000000  61 62 63 0a 64 65 66 0a  67 68 69                 |abc.def.ghi|\n0000000b\n");
3257     (* Test for RHBZ#501888c2 regression which caused large hexdump
3258      * commands to segfault.
3259      *)
3260     InitISOFS, Always, TestRun (
3261       [["hexdump"; "/100krandom"]]);
3262     (* Test for RHBZ#579608, absolute symbolic links. *)
3263     InitISOFS, Always, TestRun (
3264       [["hexdump"; "/abssymlink"]])],
3265    "dump a file in hexadecimal",
3266    "\
3267 This runs C<hexdump -C> on the given C<path>.  The result is
3268 the human-readable, canonical hex dump of the file.");
3269
3270   ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3271    [InitNone, Always, TestOutput (
3272       [["part_disk"; "/dev/sda"; "mbr"];
3273        ["mkfs"; "ext3"; "/dev/sda1"];
3274        ["mount_options"; ""; "/dev/sda1"; "/"];
3275        ["write"; "/new"; "test file"];
3276        ["umount"; "/dev/sda1"];
3277        ["zerofree"; "/dev/sda1"];
3278        ["mount_options"; ""; "/dev/sda1"; "/"];
3279        ["cat"; "/new"]], "test file")],
3280    "zero unused inodes and disk blocks on ext2/3 filesystem",
3281    "\
3282 This runs the I<zerofree> program on C<device>.  This program
3283 claims to zero unused inodes and disk blocks on an ext2/3
3284 filesystem, thus making it possible to compress the filesystem
3285 more effectively.
3286
3287 You should B<not> run this program if the filesystem is
3288 mounted.
3289
3290 It is possible that using this program can damage the filesystem
3291 or data on the filesystem.");
3292
3293   ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3294    [],
3295    "resize an LVM physical volume",
3296    "\
3297 This resizes (expands or shrinks) an existing LVM physical
3298 volume to match the new size of the underlying device.");
3299
3300   ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3301                        Int "cyls"; Int "heads"; Int "sectors";
3302                        String "line"], []), 99, [DangerWillRobinson; DeprecatedBy "part_add"],
3303    [],
3304    "modify a single partition on a block device",
3305    "\
3306 This runs L<sfdisk(8)> option to modify just the single
3307 partition C<n> (note: C<n> counts from 1).
3308
3309 For other parameters, see C<guestfs_sfdisk>.  You should usually
3310 pass C<0> for the cyls/heads/sectors parameters.
3311
3312 See also: C<guestfs_part_add>");
3313
3314   ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [DeprecatedBy "part_list"],
3315    [],
3316    "display the partition table",
3317    "\
3318 This displays the partition table on C<device>, in the
3319 human-readable output of the L<sfdisk(8)> command.  It is
3320 not intended to be parsed.
3321
3322 See also: C<guestfs_part_list>");
3323
3324   ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3325    [],
3326    "display the kernel geometry",
3327    "\
3328 This displays the kernel's idea of the geometry of C<device>.
3329
3330 The result is in human-readable format, and not designed to
3331 be parsed.");
3332
3333   ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3334    [],
3335    "display the disk geometry from the partition table",
3336    "\
3337 This displays the disk geometry of C<device> read from the
3338 partition table.  Especially in the case where the underlying
3339 block device has been resized, this can be different from the
3340 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3341
3342 The result is in human-readable format, and not designed to
3343 be parsed.");
3344
3345   ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3346    [],
3347    "activate or deactivate all volume groups",
3348    "\
3349 This command activates or (if C<activate> is false) deactivates
3350 all logical volumes in all volume groups.
3351
3352 This command is the same as running C<vgchange -a y|n>");
3353
3354   ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3355    [],
3356    "activate or deactivate some volume groups",
3357    "\
3358 This command activates or (if C<activate> is false) deactivates
3359 all logical volumes in the listed volume groups C<volgroups>.
3360
3361 This command is the same as running C<vgchange -a y|n volgroups...>
3362
3363 Note that if C<volgroups> is an empty list then B<all> volume groups
3364 are activated or deactivated.");
3365
3366   ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3367    [InitNone, Always, TestOutput (
3368       [["part_disk"; "/dev/sda"; "mbr"];
3369        ["pvcreate"; "/dev/sda1"];
3370        ["vgcreate"; "VG"; "/dev/sda1"];
3371        ["lvcreate"; "LV"; "VG"; "10"];
3372        ["mkfs"; "ext2"; "/dev/VG/LV"];
3373        ["mount_options"; ""; "/dev/VG/LV"; "/"];
3374        ["write"; "/new"; "test content"];
3375        ["umount"; "/"];
3376        ["lvresize"; "/dev/VG/LV"; "20"];
3377        ["e2fsck_f"; "/dev/VG/LV"];
3378        ["resize2fs"; "/dev/VG/LV"];
3379        ["mount_options"; ""; "/dev/VG/LV"; "/"];
3380        ["cat"; "/new"]], "test content");
3381     InitNone, Always, TestRun (
3382       (* Make an LV smaller to test RHBZ#587484. *)
3383       [["part_disk"; "/dev/sda"; "mbr"];
3384        ["pvcreate"; "/dev/sda1"];
3385        ["vgcreate"; "VG"; "/dev/sda1"];
3386        ["lvcreate"; "LV"; "VG"; "20"];
3387        ["lvresize"; "/dev/VG/LV"; "10"]])],
3388    "resize an LVM logical volume",
3389    "\
3390 This resizes (expands or shrinks) an existing LVM logical
3391 volume to C<mbytes>.  When reducing, data in the reduced part
3392 is lost.");
3393
3394   ("resize2fs", (RErr, [Device "device"], []), 106, [],
3395    [], (* lvresize tests this *)
3396    "resize an ext2, ext3 or ext4 filesystem",
3397    "\
3398 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3399 the underlying device.
3400
3401 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3402 on the C<device> before calling this command.  For unknown reasons
3403 C<resize2fs> sometimes gives an error about this and sometimes not.
3404 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3405 calling this function.");
3406
3407   ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3408    [InitBasicFS, Always, TestOutputList (
3409       [["find"; "/"]], ["lost+found"]);
3410     InitBasicFS, Always, TestOutputList (
3411       [["touch"; "/a"];
3412        ["mkdir"; "/b"];
3413        ["touch"; "/b/c"];
3414        ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3415     InitScratchFS, Always, TestOutputList (
3416       [["mkdir_p"; "/find/b/c"];
3417        ["touch"; "/find/b/c/d"];
3418        ["find"; "/find/b/"]], ["c"; "c/d"])],
3419    "find all files and directories",
3420    "\
3421 This command lists out all files and directories, recursively,
3422 starting at C<directory>.  It is essentially equivalent to
3423 running the shell command C<find directory -print> but some
3424 post-processing happens on the output, described below.
3425
3426 This returns a list of strings I<without any prefix>.  Thus
3427 if the directory structure was:
3428
3429  /tmp/a
3430  /tmp/b
3431  /tmp/c/d
3432
3433 then the returned list from C<guestfs_find> C</tmp> would be
3434 4 elements:
3435
3436  a
3437  b
3438  c
3439  c/d
3440
3441 If C<directory> is not a directory, then this command returns
3442 an error.
3443
3444 The returned list is sorted.
3445
3446 See also C<guestfs_find0>.");
3447
3448   ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3449    [], (* lvresize tests this *)
3450    "check an ext2/ext3 filesystem",
3451    "\
3452 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3453 filesystem checker on C<device>, noninteractively (I<-p>),
3454 even if the filesystem appears to be clean (I<-f>).
3455
3456 This command is only needed because of C<guestfs_resize2fs>
3457 (q.v.).  Normally you should use C<guestfs_fsck>.");
3458
3459   ("sleep", (RErr, [Int "secs"], []), 109, [],
3460    [InitNone, Always, TestRun (
3461       [["sleep"; "1"]])],
3462    "sleep for some seconds",
3463    "\
3464 Sleep for C<secs> seconds.");
3465
3466   ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3467    [InitNone, Always, TestOutputInt (
3468       [["part_disk"; "/dev/sda"; "mbr"];
3469        ["mkfs"; "ntfs"; "/dev/sda1"];
3470        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3471     InitNone, Always, TestOutputInt (
3472       [["part_disk"; "/dev/sda"; "mbr"];
3473        ["mkfs"; "ext2"; "/dev/sda1"];
3474        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3475    "probe NTFS volume",
3476    "\
3477 This command runs the L<ntfs-3g.probe(8)> command which probes
3478 an NTFS C<device> for mountability.  (Not all NTFS volumes can
3479 be mounted read-write, and some cannot be mounted at all).
3480
3481 C<rw> is a boolean flag.  Set it to true if you want to test
3482 if the volume can be mounted read-write.  Set it to false if
3483 you want to test if the volume can be mounted read-only.
3484
3485 The return value is an integer which C<0> if the operation
3486 would succeed, or some non-zero value documented in the
3487 L<ntfs-3g.probe(8)> manual page.");
3488
3489   ("sh", (RString "output", [String "command"], []), 111, [],
3490    [], (* XXX needs tests *)
3491    "run a command via the shell",
3492    "\
3493 This call runs a command from the guest filesystem via the
3494 guest's C</bin/sh>.
3495
3496 This is like C<guestfs_command>, but passes the command to:
3497
3498  /bin/sh -c \"command\"
3499
3500 Depending on the guest's shell, this usually results in
3501 wildcards being expanded, shell expressions being interpolated
3502 and so on.
3503
3504 All the provisos about C<guestfs_command> apply to this call.");
3505
3506   ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3507    [], (* XXX needs tests *)
3508    "run a command via the shell returning lines",
3509    "\
3510 This is the same as C<guestfs_sh>, but splits the result
3511 into a list of lines.
3512
3513 See also: C<guestfs_command_lines>");
3514
3515   ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3516    (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3517     * code in stubs.c, since all valid glob patterns must start with "/".
3518     * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3519     *)
3520    [InitScratchFS, Always, TestOutputList (
3521       [["mkdir_p"; "/glob_expand/b/c"];
3522        ["touch"; "/glob_expand/b/c/d"];
3523        ["touch"; "/glob_expand/b/c/e"];
3524        ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3525     InitScratchFS, Always, TestOutputList (
3526       [["mkdir_p"; "/glob_expand2/b/c"];
3527        ["touch"; "/glob_expand2/b/c/d"];
3528        ["touch"; "/glob_expand2/b/c/e"];
3529        ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3530     InitScratchFS, Always, TestOutputList (
3531       [["mkdir_p"; "/glob_expand3/b/c"];
3532        ["touch"; "/glob_expand3/b/c/d"];
3533        ["touch"; "/glob_expand3/b/c/e"];
3534        ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3535    "expand a wildcard path",
3536    "\
3537 This command searches for all the pathnames matching
3538 C<pattern> according to the wildcard expansion rules
3539 used by the shell.
3540
3541 If no paths match, then this returns an empty list
3542 (note: not an error).
3543
3544 It is just a wrapper around the C L<glob(3)> function
3545 with flags C<GLOB_MARK|GLOB_BRACE>.
3546 See that manual page for more details.");
3547
3548   ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3549    [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3550       [["scrub_device"; "/dev/sdc"]])],
3551    "scrub (securely wipe) a device",
3552    "\
3553 This command writes patterns over C<device> to make data retrieval
3554 more difficult.
3555
3556 It is an interface to the L<scrub(1)> program.  See that
3557 manual page for more details.");
3558
3559   ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3560    [InitScratchFS, Always, TestRun (
3561       [["write"; "/scrub_file"; "content"];
3562        ["scrub_file"; "/scrub_file"]])],
3563    "scrub (securely wipe) a file",
3564    "\
3565 This command writes patterns over a file to make data retrieval
3566 more difficult.
3567
3568 The file is I<removed> after scrubbing.
3569
3570 It is an interface to the L<scrub(1)> program.  See that
3571 manual page for more details.");
3572
3573   ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3574    [], (* XXX needs testing *)
3575    "scrub (securely wipe) free space",
3576    "\
3577 This command creates the directory C<dir> and then fills it
3578 with files until the filesystem is full, and scrubs the files
3579 as for C<guestfs_scrub_file>, and deletes them.
3580 The intention is to scrub any free space on the partition
3581 containing C<dir>.
3582
3583 It is an interface to the L<scrub(1)> program.  See that
3584 manual page for more details.");
3585
3586   ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3587    [InitScratchFS, Always, TestRun (
3588       [["mkdir"; "/mkdtemp"];
3589        ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3590    "create a temporary directory",
3591    "\
3592 This command creates a temporary directory.  The
3593 C<template> parameter should be a full pathname for the
3594 temporary directory name with the final six characters being
3595 \"XXXXXX\".
3596
3597 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3598 the second one being suitable for Windows filesystems.
3599
3600 The name of the temporary directory that was created
3601 is returned.
3602
3603 The temporary directory is created with mode 0700
3604 and is owned by root.
3605
3606 The caller is responsible for deleting the temporary