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