New API: inspect-get-hostname to return the hostname of the guest.
[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    [InitBasicFS, Always, TestOutputTrue (
1346       [["touch"; "/new"];
1347        ["exists"; "/new"]])],
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    [InitBasicFS, Always, TestOutputList (
1383       [["touch"; "/new"];
1384        ["touch"; "/newer"];
1385        ["touch"; "/newest"];
1386        ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1387    "list the files in a directory",
1388    "\
1389 List the files in C<directory> (relative to the root directory,
1390 there is no cwd).  The '.' and '..' entries are not returned, but
1391 hidden files are shown.
1392
1393 This command is mostly useful for interactive sessions.  Programs
1394 should probably use C<guestfs_readdir> instead.");
1395
1396   ("list_devices", (RStringList "devices", [], []), 7, [],
1397    [InitEmpty, Always, TestOutputListOfDevices (
1398       [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1399    "list the block devices",
1400    "\
1401 List all the block devices.
1402
1403 The full block device names are returned, eg. C</dev/sda>.
1404
1405 See also C<guestfs_list_filesystems>.");
1406
1407   ("list_partitions", (RStringList "partitions", [], []), 8, [],
1408    [InitBasicFS, Always, TestOutputListOfDevices (
1409       [["list_partitions"]], ["/dev/sda1"]);
1410     InitEmpty, Always, TestOutputListOfDevices (
1411       [["part_init"; "/dev/sda"; "mbr"];
1412        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1413        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1414        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1415        ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1416    "list the partitions",
1417    "\
1418 List all the partitions detected on all block devices.
1419
1420 The full partition device names are returned, eg. C</dev/sda1>
1421
1422 This does not return logical volumes.  For that you will need to
1423 call C<guestfs_lvs>.
1424
1425 See also C<guestfs_list_filesystems>.");
1426
1427   ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1428    [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1429       [["pvs"]], ["/dev/sda1"]);
1430     InitEmpty, Always, TestOutputListOfDevices (
1431       [["part_init"; "/dev/sda"; "mbr"];
1432        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1433        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1434        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1435        ["pvcreate"; "/dev/sda1"];
1436        ["pvcreate"; "/dev/sda2"];
1437        ["pvcreate"; "/dev/sda3"];
1438        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1439    "list the LVM physical volumes (PVs)",
1440    "\
1441 List all the physical volumes detected.  This is the equivalent
1442 of the L<pvs(8)> command.
1443
1444 This returns a list of just the device names that contain
1445 PVs (eg. C</dev/sda2>).
1446
1447 See also C<guestfs_pvs_full>.");
1448
1449   ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1450    [InitBasicFSonLVM, Always, TestOutputList (
1451       [["vgs"]], ["VG"]);
1452     InitEmpty, Always, TestOutputList (
1453       [["part_init"; "/dev/sda"; "mbr"];
1454        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1455        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1456        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1457        ["pvcreate"; "/dev/sda1"];
1458        ["pvcreate"; "/dev/sda2"];
1459        ["pvcreate"; "/dev/sda3"];
1460        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1461        ["vgcreate"; "VG2"; "/dev/sda3"];
1462        ["vgs"]], ["VG1"; "VG2"])],
1463    "list the LVM volume groups (VGs)",
1464    "\
1465 List all the volumes groups detected.  This is the equivalent
1466 of the L<vgs(8)> command.
1467
1468 This returns a list of just the volume group names that were
1469 detected (eg. C<VolGroup00>).
1470
1471 See also C<guestfs_vgs_full>.");
1472
1473   ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1474    [InitBasicFSonLVM, Always, TestOutputList (
1475       [["lvs"]], ["/dev/VG/LV"]);
1476     InitEmpty, Always, TestOutputList (
1477       [["part_init"; "/dev/sda"; "mbr"];
1478        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1479        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1480        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1481        ["pvcreate"; "/dev/sda1"];
1482        ["pvcreate"; "/dev/sda2"];
1483        ["pvcreate"; "/dev/sda3"];
1484        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1485        ["vgcreate"; "VG2"; "/dev/sda3"];
1486        ["lvcreate"; "LV1"; "VG1"; "50"];
1487        ["lvcreate"; "LV2"; "VG1"; "50"];
1488        ["lvcreate"; "LV3"; "VG2"; "50"];
1489        ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1490    "list the LVM logical volumes (LVs)",
1491    "\
1492 List all the logical volumes detected.  This is the equivalent
1493 of the L<lvs(8)> command.
1494
1495 This returns a list of the logical volume device names
1496 (eg. C</dev/VolGroup00/LogVol00>).
1497
1498 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1499
1500   ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1501    [], (* XXX how to test? *)
1502    "list the LVM physical volumes (PVs)",
1503    "\
1504 List all the physical volumes detected.  This is the equivalent
1505 of the L<pvs(8)> command.  The \"full\" version includes all fields.");
1506
1507   ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1508    [], (* XXX how to test? *)
1509    "list the LVM volume groups (VGs)",
1510    "\
1511 List all the volumes groups detected.  This is the equivalent
1512 of the L<vgs(8)> command.  The \"full\" version includes all fields.");
1513
1514   ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1515    [], (* XXX how to test? *)
1516    "list the LVM logical volumes (LVs)",
1517    "\
1518 List all the logical volumes detected.  This is the equivalent
1519 of the L<lvs(8)> command.  The \"full\" version includes all fields.");
1520
1521   ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1522    [InitISOFS, Always, TestOutputList (
1523       [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1524     InitISOFS, Always, TestOutputList (
1525       [["read_lines"; "/empty"]], [])],
1526    "read file as lines",
1527    "\
1528 Return the contents of the file named C<path>.
1529
1530 The file contents are returned as a list of lines.  Trailing
1531 C<LF> and C<CRLF> character sequences are I<not> returned.
1532
1533 Note that this function cannot correctly handle binary files
1534 (specifically, files containing C<\\0> character which is treated
1535 as end of line).  For those you need to use the C<guestfs_read_file>
1536 function which has a more complex interface.");
1537
1538   ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1539    [], (* XXX Augeas code needs tests. *)
1540    "create a new Augeas handle",
1541    "\
1542 Create a new Augeas handle for editing configuration files.
1543 If there was any previous Augeas handle associated with this
1544 guestfs session, then it is closed.
1545
1546 You must call this before using any other C<guestfs_aug_*>
1547 commands.
1548
1549 C<root> is the filesystem root.  C<root> must not be NULL,
1550 use C</> instead.
1551
1552 The flags are the same as the flags defined in
1553 E<lt>augeas.hE<gt>, the logical I<or> of the following
1554 integers:
1555
1556 =over 4
1557
1558 =item C<AUG_SAVE_BACKUP> = 1
1559
1560 Keep the original file with a C<.augsave> extension.
1561
1562 =item C<AUG_SAVE_NEWFILE> = 2
1563
1564 Save changes into a file with extension C<.augnew>, and
1565 do not overwrite original.  Overrides C<AUG_SAVE_BACKUP>.
1566
1567 =item C<AUG_TYPE_CHECK> = 4
1568
1569 Typecheck lenses (can be expensive).
1570
1571 =item C<AUG_NO_STDINC> = 8
1572
1573 Do not use standard load path for modules.
1574
1575 =item C<AUG_SAVE_NOOP> = 16
1576
1577 Make save a no-op, just record what would have been changed.
1578
1579 =item C<AUG_NO_LOAD> = 32
1580
1581 Do not load the tree in C<guestfs_aug_init>.
1582
1583 =back
1584
1585 To close the handle, you can call C<guestfs_aug_close>.
1586
1587 To find out more about Augeas, see L<http://augeas.net/>.");
1588
1589   ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1590    [], (* XXX Augeas code needs tests. *)
1591    "close the current Augeas handle",
1592    "\
1593 Close the current Augeas handle and free up any resources
1594 used by it.  After calling this, you have to call
1595 C<guestfs_aug_init> again before you can use any other
1596 Augeas functions.");
1597
1598   ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1599    [], (* XXX Augeas code needs tests. *)
1600    "define an Augeas variable",
1601    "\
1602 Defines an Augeas variable C<name> whose value is the result
1603 of evaluating C<expr>.  If C<expr> is NULL, then C<name> is
1604 undefined.
1605
1606 On success this returns the number of nodes in C<expr>, or
1607 C<0> if C<expr> evaluates to something which is not a nodeset.");
1608
1609   ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1610    [], (* XXX Augeas code needs tests. *)
1611    "define an Augeas node",
1612    "\
1613 Defines a variable C<name> whose value is the result of
1614 evaluating C<expr>.
1615
1616 If C<expr> evaluates to an empty nodeset, a node is created,
1617 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1618 C<name> will be the nodeset containing that single node.
1619
1620 On success this returns a pair containing the
1621 number of nodes in the nodeset, and a boolean flag
1622 if a node was created.");
1623
1624   ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1625    [], (* XXX Augeas code needs tests. *)
1626    "look up the value of an Augeas path",
1627    "\
1628 Look up the value associated with C<path>.  If C<path>
1629 matches exactly one node, the C<value> is returned.");
1630
1631   ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1632    [], (* XXX Augeas code needs tests. *)
1633    "set Augeas path to value",
1634    "\
1635 Set the value associated with C<path> to C<val>.
1636
1637 In the Augeas API, it is possible to clear a node by setting
1638 the value to NULL.  Due to an oversight in the libguestfs API
1639 you cannot do that with this call.  Instead you must use the
1640 C<guestfs_aug_clear> call.");
1641
1642   ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1643    [], (* XXX Augeas code needs tests. *)
1644    "insert a sibling Augeas node",
1645    "\
1646 Create a new sibling C<label> for C<path>, inserting it into
1647 the tree before or after C<path> (depending on the boolean
1648 flag C<before>).
1649
1650 C<path> must match exactly one existing node in the tree, and
1651 C<label> must be a label, ie. not contain C</>, C<*> or end
1652 with a bracketed index C<[N]>.");
1653
1654   ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1655    [], (* XXX Augeas code needs tests. *)
1656    "remove an Augeas path",
1657    "\
1658 Remove C<path> and all of its children.
1659
1660 On success this returns the number of entries which were removed.");
1661
1662   ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1663    [], (* XXX Augeas code needs tests. *)
1664    "move Augeas node",
1665    "\
1666 Move the node C<src> to C<dest>.  C<src> must match exactly
1667 one node.  C<dest> is overwritten if it exists.");
1668
1669   ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1670    [], (* XXX Augeas code needs tests. *)
1671    "return Augeas nodes which match augpath",
1672    "\
1673 Returns a list of paths which match the path expression C<path>.
1674 The returned paths are sufficiently qualified so that they match
1675 exactly one node in the current tree.");
1676
1677   ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1678    [], (* XXX Augeas code needs tests. *)
1679    "write all pending Augeas changes to disk",
1680    "\
1681 This writes all pending changes to disk.
1682
1683 The flags which were passed to C<guestfs_aug_init> affect exactly
1684 how files are saved.");
1685
1686   ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1687    [], (* XXX Augeas code needs tests. *)
1688    "load files into the tree",
1689    "\
1690 Load files into the tree.
1691
1692 See C<aug_load> in the Augeas documentation for the full gory
1693 details.");
1694
1695   ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1696    [], (* XXX Augeas code needs tests. *)
1697    "list Augeas nodes under augpath",
1698    "\
1699 This is just a shortcut for listing C<guestfs_aug_match>
1700 C<path/*> and sorting the resulting nodes into alphabetical order.");
1701
1702   ("rm", (RErr, [Pathname "path"], []), 29, [],
1703    [InitBasicFS, Always, TestRun
1704       [["touch"; "/new"];
1705        ["rm"; "/new"]];
1706     InitBasicFS, Always, TestLastFail
1707       [["rm"; "/new"]];
1708     InitBasicFS, Always, TestLastFail
1709       [["mkdir"; "/new"];
1710        ["rm"; "/new"]]],
1711    "remove a file",
1712    "\
1713 Remove the single file C<path>.");
1714
1715   ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1716    [InitBasicFS, Always, TestRun
1717       [["mkdir"; "/new"];
1718        ["rmdir"; "/new"]];
1719     InitBasicFS, Always, TestLastFail
1720       [["rmdir"; "/new"]];
1721     InitBasicFS, Always, TestLastFail
1722       [["touch"; "/new"];
1723        ["rmdir"; "/new"]]],
1724    "remove a directory",
1725    "\
1726 Remove the single directory C<path>.");
1727
1728   ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1729    [InitBasicFS, Always, TestOutputFalse
1730       [["mkdir"; "/new"];
1731        ["mkdir"; "/new/foo"];
1732        ["touch"; "/new/foo/bar"];
1733        ["rm_rf"; "/new"];
1734        ["exists"; "/new"]]],
1735    "remove a file or directory recursively",
1736    "\
1737 Remove the file or directory C<path>, recursively removing the
1738 contents if its a directory.  This is like the C<rm -rf> shell
1739 command.");
1740
1741   ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1742    [InitBasicFS, Always, TestOutputTrue
1743       [["mkdir"; "/new"];
1744        ["is_dir"; "/new"]];
1745     InitBasicFS, Always, TestLastFail
1746       [["mkdir"; "/new/foo/bar"]]],
1747    "create a directory",
1748    "\
1749 Create a directory named C<path>.");
1750
1751   ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1752    [InitBasicFS, Always, TestOutputTrue
1753       [["mkdir_p"; "/new/foo/bar"];
1754        ["is_dir"; "/new/foo/bar"]];
1755     InitBasicFS, Always, TestOutputTrue
1756       [["mkdir_p"; "/new/foo/bar"];
1757        ["is_dir"; "/new/foo"]];
1758     InitBasicFS, Always, TestOutputTrue
1759       [["mkdir_p"; "/new/foo/bar"];
1760        ["is_dir"; "/new"]];
1761     (* Regression tests for RHBZ#503133: *)
1762     InitBasicFS, Always, TestRun
1763       [["mkdir"; "/new"];
1764        ["mkdir_p"; "/new"]];
1765     InitBasicFS, Always, TestLastFail
1766       [["touch"; "/new"];
1767        ["mkdir_p"; "/new"]]],
1768    "create a directory and parents",
1769    "\
1770 Create a directory named C<path>, creating any parent directories
1771 as necessary.  This is like the C<mkdir -p> shell command.");
1772
1773   ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1774    [], (* XXX Need stat command to test *)
1775    "change file mode",
1776    "\
1777 Change the mode (permissions) of C<path> to C<mode>.  Only
1778 numeric modes are supported.
1779
1780 I<Note>: When using this command from guestfish, C<mode>
1781 by default would be decimal, unless you prefix it with
1782 C<0> to get octal, ie. use C<0700> not C<700>.
1783
1784 The mode actually set is affected by the umask.");
1785
1786   ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1787    [], (* XXX Need stat command to test *)
1788    "change file owner and group",
1789    "\
1790 Change the file owner to C<owner> and group to C<group>.
1791
1792 Only numeric uid and gid are supported.  If you want to use
1793 names, you will need to locate and parse the password file
1794 yourself (Augeas support makes this relatively easy).");
1795
1796   ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1797    [InitISOFS, Always, TestOutputTrue (
1798       [["exists"; "/empty"]]);
1799     InitISOFS, Always, TestOutputTrue (
1800       [["exists"; "/directory"]])],
1801    "test if file or directory exists",
1802    "\
1803 This returns C<true> if and only if there is a file, directory
1804 (or anything) with the given C<path> name.
1805
1806 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1807
1808   ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1809    [InitISOFS, Always, TestOutputTrue (
1810       [["is_file"; "/known-1"]]);
1811     InitISOFS, Always, TestOutputFalse (
1812       [["is_file"; "/directory"]])],
1813    "test if a regular file",
1814    "\
1815 This returns C<true> if and only if there is a regular file
1816 with the given C<path> name.  Note that it returns false for
1817 other objects like directories.
1818
1819 See also C<guestfs_stat>.");
1820
1821   ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1822    [InitISOFS, Always, TestOutputFalse (
1823       [["is_dir"; "/known-3"]]);
1824     InitISOFS, Always, TestOutputTrue (
1825       [["is_dir"; "/directory"]])],
1826    "test if a directory",
1827    "\
1828 This returns C<true> if and only if there is a directory
1829 with the given C<path> name.  Note that it returns false for
1830 other objects like files.
1831
1832 See also C<guestfs_stat>.");
1833
1834   ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1835    [InitEmpty, Always, TestOutputListOfDevices (
1836       [["part_init"; "/dev/sda"; "mbr"];
1837        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1838        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1839        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1840        ["pvcreate"; "/dev/sda1"];
1841        ["pvcreate"; "/dev/sda2"];
1842        ["pvcreate"; "/dev/sda3"];
1843        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1844    "create an LVM physical volume",
1845    "\
1846 This creates an LVM physical volume on the named C<device>,
1847 where C<device> should usually be a partition name such
1848 as C</dev/sda1>.");
1849
1850   ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1851    [InitEmpty, Always, TestOutputList (
1852       [["part_init"; "/dev/sda"; "mbr"];
1853        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1854        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1855        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1856        ["pvcreate"; "/dev/sda1"];
1857        ["pvcreate"; "/dev/sda2"];
1858        ["pvcreate"; "/dev/sda3"];
1859        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1860        ["vgcreate"; "VG2"; "/dev/sda3"];
1861        ["vgs"]], ["VG1"; "VG2"])],
1862    "create an LVM volume group",
1863    "\
1864 This creates an LVM volume group called C<volgroup>
1865 from the non-empty list of physical volumes C<physvols>.");
1866
1867   ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1868    [InitEmpty, Always, TestOutputList (
1869       [["part_init"; "/dev/sda"; "mbr"];
1870        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1871        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1872        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1873        ["pvcreate"; "/dev/sda1"];
1874        ["pvcreate"; "/dev/sda2"];
1875        ["pvcreate"; "/dev/sda3"];
1876        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1877        ["vgcreate"; "VG2"; "/dev/sda3"];
1878        ["lvcreate"; "LV1"; "VG1"; "50"];
1879        ["lvcreate"; "LV2"; "VG1"; "50"];
1880        ["lvcreate"; "LV3"; "VG2"; "50"];
1881        ["lvcreate"; "LV4"; "VG2"; "50"];
1882        ["lvcreate"; "LV5"; "VG2"; "50"];
1883        ["lvs"]],
1884       ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1885        "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1886    "create an LVM logical volume",
1887    "\
1888 This creates an LVM logical volume called C<logvol>
1889 on the volume group C<volgroup>, with C<size> megabytes.");
1890
1891   ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1892    [InitEmpty, Always, TestOutput (
1893       [["part_disk"; "/dev/sda"; "mbr"];
1894        ["mkfs"; "ext2"; "/dev/sda1"];
1895        ["mount_options"; ""; "/dev/sda1"; "/"];
1896        ["write"; "/new"; "new file contents"];
1897        ["cat"; "/new"]], "new file contents")],
1898    "make a filesystem",
1899    "\
1900 This creates a filesystem on C<device> (usually a partition
1901 or LVM logical volume).  The filesystem type is C<fstype>, for
1902 example C<ext3>.");
1903
1904   ("sfdisk", (RErr, [Device "device";
1905                      Int "cyls"; Int "heads"; Int "sectors";
1906                      StringList "lines"], []), 43, [DangerWillRobinson],
1907    [],
1908    "create partitions on a block device",
1909    "\
1910 This is a direct interface to the L<sfdisk(8)> program for creating
1911 partitions on block devices.
1912
1913 C<device> should be a block device, for example C</dev/sda>.
1914
1915 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1916 and sectors on the device, which are passed directly to sfdisk as
1917 the I<-C>, I<-H> and I<-S> parameters.  If you pass C<0> for any
1918 of these, then the corresponding parameter is omitted.  Usually for
1919 'large' disks, you can just pass C<0> for these, but for small
1920 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1921 out the right geometry and you will need to tell it.
1922
1923 C<lines> is a list of lines that we feed to C<sfdisk>.  For more
1924 information refer to the L<sfdisk(8)> manpage.
1925
1926 To create a single partition occupying the whole disk, you would
1927 pass C<lines> as a single element list, when the single element being
1928 the string C<,> (comma).
1929
1930 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1931 C<guestfs_part_init>");
1932
1933   ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1934    (* Regression test for RHBZ#597135. *)
1935    [InitBasicFS, Always, TestLastFail
1936       [["write_file"; "/new"; "abc"; "10000"]]],
1937    "create a file",
1938    "\
1939 This call creates a file called C<path>.  The contents of the
1940 file is the string C<content> (which can contain any 8 bit data),
1941 with length C<size>.
1942
1943 As a special case, if C<size> is C<0>
1944 then the length is calculated using C<strlen> (so in this case
1945 the content cannot contain embedded ASCII NULs).
1946
1947 I<NB.> Owing to a bug, writing content containing ASCII NUL
1948 characters does I<not> work, even if the length is specified.");
1949
1950   ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1951    [InitEmpty, Always, TestOutputListOfDevices (
1952       [["part_disk"; "/dev/sda"; "mbr"];
1953        ["mkfs"; "ext2"; "/dev/sda1"];
1954        ["mount_options"; ""; "/dev/sda1"; "/"];
1955        ["mounts"]], ["/dev/sda1"]);
1956     InitEmpty, Always, TestOutputList (
1957       [["part_disk"; "/dev/sda"; "mbr"];
1958        ["mkfs"; "ext2"; "/dev/sda1"];
1959        ["mount_options"; ""; "/dev/sda1"; "/"];
1960        ["umount"; "/"];
1961        ["mounts"]], [])],
1962    "unmount a filesystem",
1963    "\
1964 This unmounts the given filesystem.  The filesystem may be
1965 specified either by its mountpoint (path) or the device which
1966 contains the filesystem.");
1967
1968   ("mounts", (RStringList "devices", [], []), 46, [],
1969    [InitBasicFS, Always, TestOutputListOfDevices (
1970       [["mounts"]], ["/dev/sda1"])],
1971    "show mounted filesystems",
1972    "\
1973 This returns the list of currently mounted filesystems.  It returns
1974 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1975
1976 Some internal mounts are not shown.
1977
1978 See also: C<guestfs_mountpoints>");
1979
1980   ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1981    [InitBasicFS, Always, TestOutputList (
1982       [["umount_all"];
1983        ["mounts"]], []);
1984     (* check that umount_all can unmount nested mounts correctly: *)
1985     InitEmpty, Always, TestOutputList (
1986       [["part_init"; "/dev/sda"; "mbr"];
1987        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1988        ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1989        ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1990        ["mkfs"; "ext2"; "/dev/sda1"];
1991        ["mkfs"; "ext2"; "/dev/sda2"];
1992        ["mkfs"; "ext2"; "/dev/sda3"];
1993        ["mount_options"; ""; "/dev/sda1"; "/"];
1994        ["mkdir"; "/mp1"];
1995        ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1996        ["mkdir"; "/mp1/mp2"];
1997        ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1998        ["mkdir"; "/mp1/mp2/mp3"];
1999        ["umount_all"];
2000        ["mounts"]], [])],
2001    "unmount all filesystems",
2002    "\
2003 This unmounts all mounted filesystems.
2004
2005 Some internal mounts are not unmounted by this call.");
2006
2007   ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2008    [],
2009    "remove all LVM LVs, VGs and PVs",
2010    "\
2011 This command removes all LVM logical volumes, volume groups
2012 and physical volumes.");
2013
2014   ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2015    [InitISOFS, Always, TestOutput (
2016       [["file"; "/empty"]], "empty");
2017     InitISOFS, Always, TestOutput (
2018       [["file"; "/known-1"]], "ASCII text");
2019     InitISOFS, Always, TestLastFail (
2020       [["file"; "/notexists"]]);
2021     InitISOFS, Always, TestOutput (
2022       [["file"; "/abssymlink"]], "symbolic link");
2023     InitISOFS, Always, TestOutput (
2024       [["file"; "/directory"]], "directory")],
2025    "determine file type",
2026    "\
2027 This call uses the standard L<file(1)> command to determine
2028 the type or contents of the file.
2029
2030 This call will also transparently look inside various types
2031 of compressed file.
2032
2033 The exact command which runs is C<file -zb path>.  Note in
2034 particular that the filename is not prepended to the output
2035 (the C<-b> option).
2036
2037 This command can also be used on C</dev/> devices
2038 (and partitions, LV names).  You can for example use this
2039 to determine if a device contains a filesystem, although
2040 it's usually better to use C<guestfs_vfs_type>.
2041
2042 If the C<path> does not begin with C</dev/> then
2043 this command only works for the content of regular files.
2044 For other file types (directory, symbolic link etc) it
2045 will just return the string C<directory> etc.");
2046
2047   ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2048    [InitBasicFS, Always, TestOutput (
2049       [["upload"; "test-command"; "/test-command"];
2050        ["chmod"; "0o755"; "/test-command"];
2051        ["command"; "/test-command 1"]], "Result1");
2052     InitBasicFS, Always, TestOutput (
2053       [["upload"; "test-command"; "/test-command"];
2054        ["chmod"; "0o755"; "/test-command"];
2055        ["command"; "/test-command 2"]], "Result2\n");
2056     InitBasicFS, Always, TestOutput (
2057       [["upload"; "test-command"; "/test-command"];
2058        ["chmod"; "0o755"; "/test-command"];
2059        ["command"; "/test-command 3"]], "\nResult3");
2060     InitBasicFS, Always, TestOutput (
2061       [["upload"; "test-command"; "/test-command"];
2062        ["chmod"; "0o755"; "/test-command"];
2063        ["command"; "/test-command 4"]], "\nResult4\n");
2064     InitBasicFS, Always, TestOutput (
2065       [["upload"; "test-command"; "/test-command"];
2066        ["chmod"; "0o755"; "/test-command"];
2067        ["command"; "/test-command 5"]], "\nResult5\n\n");
2068     InitBasicFS, Always, TestOutput (
2069       [["upload"; "test-command"; "/test-command"];
2070        ["chmod"; "0o755"; "/test-command"];
2071        ["command"; "/test-command 6"]], "\n\nResult6\n\n");
2072     InitBasicFS, Always, TestOutput (
2073       [["upload"; "test-command"; "/test-command"];
2074        ["chmod"; "0o755"; "/test-command"];
2075        ["command"; "/test-command 7"]], "");
2076     InitBasicFS, Always, TestOutput (
2077       [["upload"; "test-command"; "/test-command"];
2078        ["chmod"; "0o755"; "/test-command"];
2079        ["command"; "/test-command 8"]], "\n");
2080     InitBasicFS, Always, TestOutput (
2081       [["upload"; "test-command"; "/test-command"];
2082        ["chmod"; "0o755"; "/test-command"];
2083        ["command"; "/test-command 9"]], "\n\n");
2084     InitBasicFS, Always, TestOutput (
2085       [["upload"; "test-command"; "/test-command"];
2086        ["chmod"; "0o755"; "/test-command"];
2087        ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
2088     InitBasicFS, Always, TestOutput (
2089       [["upload"; "test-command"; "/test-command"];
2090        ["chmod"; "0o755"; "/test-command"];
2091        ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
2092     InitBasicFS, Always, TestLastFail (
2093       [["upload"; "test-command"; "/test-command"];
2094        ["chmod"; "0o755"; "/test-command"];
2095        ["command"; "/test-command"]])],
2096    "run a command from the guest filesystem",
2097    "\
2098 This call runs a command from the guest filesystem.  The
2099 filesystem must be mounted, and must contain a compatible
2100 operating system (ie. something Linux, with the same
2101 or compatible processor architecture).
2102
2103 The single parameter is an argv-style list of arguments.
2104 The first element is the name of the program to run.
2105 Subsequent elements are parameters.  The list must be
2106 non-empty (ie. must contain a program name).  Note that
2107 the command runs directly, and is I<not> invoked via
2108 the shell (see C<guestfs_sh>).
2109
2110 The return value is anything printed to I<stdout> by
2111 the command.
2112
2113 If the command returns a non-zero exit status, then
2114 this function returns an error message.  The error message
2115 string is the content of I<stderr> from the command.
2116
2117 The C<$PATH> environment variable will contain at least
2118 C</usr/bin> and C</bin>.  If you require a program from
2119 another location, you should provide the full path in the
2120 first parameter.
2121
2122 Shared libraries and data files required by the program
2123 must be available on filesystems which are mounted in the
2124 correct places.  It is the caller's responsibility to ensure
2125 all filesystems that are needed are mounted at the right
2126 locations.");
2127
2128   ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2129    [InitBasicFS, Always, TestOutputList (
2130       [["upload"; "test-command"; "/test-command"];
2131        ["chmod"; "0o755"; "/test-command"];
2132        ["command_lines"; "/test-command 1"]], ["Result1"]);
2133     InitBasicFS, Always, TestOutputList (
2134       [["upload"; "test-command"; "/test-command"];
2135        ["chmod"; "0o755"; "/test-command"];
2136        ["command_lines"; "/test-command 2"]], ["Result2"]);
2137     InitBasicFS, Always, TestOutputList (
2138       [["upload"; "test-command"; "/test-command"];
2139        ["chmod"; "0o755"; "/test-command"];
2140        ["command_lines"; "/test-command 3"]], ["";"Result3"]);
2141     InitBasicFS, Always, TestOutputList (
2142       [["upload"; "test-command"; "/test-command"];
2143        ["chmod"; "0o755"; "/test-command"];
2144        ["command_lines"; "/test-command 4"]], ["";"Result4"]);
2145     InitBasicFS, Always, TestOutputList (
2146       [["upload"; "test-command"; "/test-command"];
2147        ["chmod"; "0o755"; "/test-command"];
2148        ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
2149     InitBasicFS, Always, TestOutputList (
2150       [["upload"; "test-command"; "/test-command"];
2151        ["chmod"; "0o755"; "/test-command"];
2152        ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
2153     InitBasicFS, Always, TestOutputList (
2154       [["upload"; "test-command"; "/test-command"];
2155        ["chmod"; "0o755"; "/test-command"];
2156        ["command_lines"; "/test-command 7"]], []);
2157     InitBasicFS, Always, TestOutputList (
2158       [["upload"; "test-command"; "/test-command"];
2159        ["chmod"; "0o755"; "/test-command"];
2160        ["command_lines"; "/test-command 8"]], [""]);
2161     InitBasicFS, Always, TestOutputList (
2162       [["upload"; "test-command"; "/test-command"];
2163        ["chmod"; "0o755"; "/test-command"];
2164        ["command_lines"; "/test-command 9"]], ["";""]);
2165     InitBasicFS, Always, TestOutputList (
2166       [["upload"; "test-command"; "/test-command"];
2167        ["chmod"; "0o755"; "/test-command"];
2168        ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
2169     InitBasicFS, Always, TestOutputList (
2170       [["upload"; "test-command"; "/test-command"];
2171        ["chmod"; "0o755"; "/test-command"];
2172        ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
2173    "run a command, returning lines",
2174    "\
2175 This is the same as C<guestfs_command>, but splits the
2176 result into a list of lines.
2177
2178 See also: C<guestfs_sh_lines>");
2179
2180   ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2181    [InitISOFS, Always, TestOutputStruct (
2182       [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2183    "get file information",
2184    "\
2185 Returns file information for the given C<path>.
2186
2187 This is the same as the C<stat(2)> system call.");
2188
2189   ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2190    [InitISOFS, Always, TestOutputStruct (
2191       [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2192    "get file information for a symbolic link",
2193    "\
2194 Returns file information for the given C<path>.
2195
2196 This is the same as C<guestfs_stat> except that if C<path>
2197 is a symbolic link, then the link is stat-ed, not the file it
2198 refers to.
2199
2200 This is the same as the C<lstat(2)> system call.");
2201
2202   ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2203    [InitISOFS, Always, TestOutputStruct (
2204       [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2205    "get file system statistics",
2206    "\
2207 Returns file system statistics for any mounted file system.
2208 C<path> should be a file or directory in the mounted file system
2209 (typically it is the mount point itself, but it doesn't need to be).
2210
2211 This is the same as the C<statvfs(2)> system call.");
2212
2213   ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2214    [], (* XXX test *)
2215    "get ext2/ext3/ext4 superblock details",
2216    "\
2217 This returns the contents of the ext2, ext3 or ext4 filesystem
2218 superblock on C<device>.
2219
2220 It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)>
2221 manpage for more details.  The list of fields returned isn't
2222 clearly defined, and depends on both the version of C<tune2fs>
2223 that libguestfs was built against, and the filesystem itself.");
2224
2225   ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2226    [InitEmpty, Always, TestOutputTrue (
2227       [["blockdev_setro"; "/dev/sda"];
2228        ["blockdev_getro"; "/dev/sda"]])],
2229    "set block device to read-only",
2230    "\
2231 Sets the block device named C<device> to read-only.
2232
2233 This uses the L<blockdev(8)> command.");
2234
2235   ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2236    [InitEmpty, Always, TestOutputFalse (
2237       [["blockdev_setrw"; "/dev/sda"];
2238        ["blockdev_getro"; "/dev/sda"]])],
2239    "set block device to read-write",
2240    "\
2241 Sets the block device named C<device> to read-write.
2242
2243 This uses the L<blockdev(8)> command.");
2244
2245   ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2246    [InitEmpty, Always, TestOutputTrue (
2247       [["blockdev_setro"; "/dev/sda"];
2248        ["blockdev_getro"; "/dev/sda"]])],
2249    "is block device set to read-only",
2250    "\
2251 Returns a boolean indicating if the block device is read-only
2252 (true if read-only, false if not).
2253
2254 This uses the L<blockdev(8)> command.");
2255
2256   ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2257    [InitEmpty, Always, TestOutputInt (
2258       [["blockdev_getss"; "/dev/sda"]], 512)],
2259    "get sectorsize of block device",
2260    "\
2261 This returns the size of sectors on a block device.
2262 Usually 512, but can be larger for modern devices.
2263
2264 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2265 for that).
2266
2267 This uses the L<blockdev(8)> command.");
2268
2269   ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2270    [InitEmpty, Always, TestOutputInt (
2271       [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2272    "get blocksize of block device",
2273    "\
2274 This returns the block size of a device.
2275
2276 (Note this is different from both I<size in blocks> and
2277 I<filesystem block size>).
2278
2279 This uses the L<blockdev(8)> command.");
2280
2281   ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2282    [], (* XXX test *)
2283    "set blocksize of block device",
2284    "\
2285 This sets the block size of a device.
2286
2287 (Note this is different from both I<size in blocks> and
2288 I<filesystem block size>).
2289
2290 This uses the L<blockdev(8)> command.");
2291
2292   ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2293    [InitEmpty, Always, TestOutputInt (
2294       [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2295    "get total size of device in 512-byte sectors",
2296    "\
2297 This returns the size of the device in units of 512-byte sectors
2298 (even if the sectorsize isn't 512 bytes ... weird).
2299
2300 See also C<guestfs_blockdev_getss> for the real sector size of
2301 the device, and C<guestfs_blockdev_getsize64> for the more
2302 useful I<size in bytes>.
2303
2304 This uses the L<blockdev(8)> command.");
2305
2306   ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2307    [InitEmpty, Always, TestOutputInt (
2308       [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2309    "get total size of device in bytes",
2310    "\
2311 This returns the size of the device in bytes.
2312
2313 See also C<guestfs_blockdev_getsz>.
2314
2315 This uses the L<blockdev(8)> command.");
2316
2317   ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2318    [InitEmpty, Always, TestRun
2319       [["blockdev_flushbufs"; "/dev/sda"]]],
2320    "flush device buffers",
2321    "\
2322 This tells the kernel to flush internal buffers associated
2323 with C<device>.
2324
2325 This uses the L<blockdev(8)> command.");
2326
2327   ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2328    [InitEmpty, Always, TestRun
2329       [["blockdev_rereadpt"; "/dev/sda"]]],
2330    "reread partition table",
2331    "\
2332 Reread the partition table on C<device>.
2333
2334 This uses the L<blockdev(8)> command.");
2335
2336   ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [],
2337    [InitBasicFS, Always, TestOutput (
2338       (* Pick a file from cwd which isn't likely to change. *)
2339       [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2340        ["checksum"; "md5"; "/COPYING.LIB"]],
2341       Digest.to_hex (Digest.file "COPYING.LIB"))],
2342    "upload a file from the local machine",
2343    "\
2344 Upload local file C<filename> to C<remotefilename> on the
2345 filesystem.
2346
2347 C<filename> can also be a named pipe.
2348
2349 See also C<guestfs_download>.");
2350
2351   ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2352    [InitBasicFS, Always, TestOutput (
2353       (* Pick a file from cwd which isn't likely to change. *)
2354       [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2355        ["download"; "/COPYING.LIB"; "testdownload.tmp"];
2356        ["upload"; "testdownload.tmp"; "/upload"];
2357        ["checksum"; "md5"; "/upload"]],
2358       Digest.to_hex (Digest.file "COPYING.LIB"))],
2359    "download a file to the local machine",
2360    "\
2361 Download file C<remotefilename> and save it as C<filename>
2362 on the local machine.
2363
2364 C<filename> can also be a named pipe.
2365
2366 See also C<guestfs_upload>, C<guestfs_cat>.");
2367
2368   ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2369    [InitISOFS, Always, TestOutput (
2370       [["checksum"; "crc"; "/known-3"]], "2891671662");
2371     InitISOFS, Always, TestLastFail (
2372       [["checksum"; "crc"; "/notexists"]]);
2373     InitISOFS, Always, TestOutput (
2374       [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2375     InitISOFS, Always, TestOutput (
2376       [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2377     InitISOFS, Always, TestOutput (
2378       [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2379     InitISOFS, Always, TestOutput (
2380       [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2381     InitISOFS, Always, TestOutput (
2382       [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2383     InitISOFS, Always, TestOutput (
2384       [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2385     (* Test for RHBZ#579608, absolute symbolic links. *)
2386     InitISOFS, Always, TestOutput (
2387       [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2388    "compute MD5, SHAx or CRC checksum of file",
2389    "\
2390 This call computes the MD5, SHAx or CRC checksum of the
2391 file named C<path>.
2392
2393 The type of checksum to compute is given by the C<csumtype>
2394 parameter which must have one of the following values:
2395
2396 =over 4
2397
2398 =item C<crc>
2399
2400 Compute the cyclic redundancy check (CRC) specified by POSIX
2401 for the C<cksum> command.
2402
2403 =item C<md5>
2404
2405 Compute the MD5 hash (using the C<md5sum> program).
2406
2407 =item C<sha1>
2408
2409 Compute the SHA1 hash (using the C<sha1sum> program).
2410
2411 =item C<sha224>
2412
2413 Compute the SHA224 hash (using the C<sha224sum> program).
2414
2415 =item C<sha256>
2416
2417 Compute the SHA256 hash (using the C<sha256sum> program).
2418
2419 =item C<sha384>
2420
2421 Compute the SHA384 hash (using the C<sha384sum> program).
2422
2423 =item C<sha512>
2424
2425 Compute the SHA512 hash (using the C<sha512sum> program).
2426
2427 =back
2428
2429 The checksum is returned as a printable string.
2430
2431 To get the checksum for a device, use C<guestfs_checksum_device>.
2432
2433 To get the checksums for many files, use C<guestfs_checksums_out>.");
2434
2435   ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2436    [InitBasicFS, Always, TestOutput (
2437       [["tar_in"; "../images/helloworld.tar"; "/"];
2438        ["cat"; "/hello"]], "hello\n")],
2439    "unpack tarfile to directory",
2440    "\
2441 This command uploads and unpacks local file C<tarfile> (an
2442 I<uncompressed> tar file) into C<directory>.
2443
2444 To upload a compressed tarball, use C<guestfs_tgz_in>
2445 or C<guestfs_txz_in>.");
2446
2447   ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2448    [],
2449    "pack directory into tarfile",
2450    "\
2451 This command packs the contents of C<directory> and downloads
2452 it to local file C<tarfile>.
2453
2454 To download a compressed tarball, use C<guestfs_tgz_out>
2455 or C<guestfs_txz_out>.");
2456
2457   ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2458    [InitBasicFS, Always, TestOutput (
2459       [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2460        ["cat"; "/hello"]], "hello\n")],
2461    "unpack compressed tarball to directory",
2462    "\
2463 This command uploads and unpacks local file C<tarball> (a
2464 I<gzip compressed> tar file) into C<directory>.
2465
2466 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2467
2468   ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2469    [],
2470    "pack directory into compressed tarball",
2471    "\
2472 This command packs the contents of C<directory> and downloads
2473 it to local file C<tarball>.
2474
2475 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2476
2477   ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2478    [InitBasicFS, Always, TestLastFail (
2479       [["umount"; "/"];
2480        ["mount_ro"; "/dev/sda1"; "/"];
2481        ["touch"; "/new"]]);
2482     InitBasicFS, Always, TestOutput (
2483       [["write"; "/new"; "data"];
2484        ["umount"; "/"];
2485        ["mount_ro"; "/dev/sda1"; "/"];
2486        ["cat"; "/new"]], "data")],
2487    "mount a guest disk, read-only",
2488    "\
2489 This is the same as the C<guestfs_mount> command, but it
2490 mounts the filesystem with the read-only (I<-o ro>) flag.");
2491
2492   ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2493    [],
2494    "mount a guest disk with mount options",
2495    "\
2496 This is the same as the C<guestfs_mount> command, but it
2497 allows you to set the mount options as for the
2498 L<mount(8)> I<-o> flag.
2499
2500 If the C<options> parameter is an empty string, then
2501 no options are passed (all options default to whatever
2502 the filesystem uses).");
2503
2504   ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2505    [],
2506    "mount a guest disk with mount options and vfstype",
2507    "\
2508 This is the same as the C<guestfs_mount> command, but it
2509 allows you to set both the mount options and the vfstype
2510 as for the L<mount(8)> I<-o> and I<-t> flags.");
2511
2512   ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2513    [],
2514    "debugging and internals",
2515    "\
2516 The C<guestfs_debug> command exposes some internals of
2517 C<guestfsd> (the guestfs daemon) that runs inside the
2518 qemu subprocess.
2519
2520 There is no comprehensive help for this command.  You have
2521 to look at the file C<daemon/debug.c> in the libguestfs source
2522 to find out what you can do.");
2523
2524   ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2525    [InitEmpty, Always, TestOutputList (
2526       [["part_disk"; "/dev/sda"; "mbr"];
2527        ["pvcreate"; "/dev/sda1"];
2528        ["vgcreate"; "VG"; "/dev/sda1"];
2529        ["lvcreate"; "LV1"; "VG"; "50"];
2530        ["lvcreate"; "LV2"; "VG"; "50"];
2531        ["lvremove"; "/dev/VG/LV1"];
2532        ["lvs"]], ["/dev/VG/LV2"]);
2533     InitEmpty, Always, TestOutputList (
2534       [["part_disk"; "/dev/sda"; "mbr"];
2535        ["pvcreate"; "/dev/sda1"];
2536        ["vgcreate"; "VG"; "/dev/sda1"];
2537        ["lvcreate"; "LV1"; "VG"; "50"];
2538        ["lvcreate"; "LV2"; "VG"; "50"];
2539        ["lvremove"; "/dev/VG"];
2540        ["lvs"]], []);
2541     InitEmpty, Always, TestOutputList (
2542       [["part_disk"; "/dev/sda"; "mbr"];
2543        ["pvcreate"; "/dev/sda1"];
2544        ["vgcreate"; "VG"; "/dev/sda1"];
2545        ["lvcreate"; "LV1"; "VG"; "50"];
2546        ["lvcreate"; "LV2"; "VG"; "50"];
2547        ["lvremove"; "/dev/VG"];
2548        ["vgs"]], ["VG"])],
2549    "remove an LVM logical volume",
2550    "\
2551 Remove an LVM logical volume C<device>, where C<device> is
2552 the path to the LV, such as C</dev/VG/LV>.
2553
2554 You can also remove all LVs in a volume group by specifying
2555 the VG name, C</dev/VG>.");
2556
2557   ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2558    [InitEmpty, Always, TestOutputList (
2559       [["part_disk"; "/dev/sda"; "mbr"];
2560        ["pvcreate"; "/dev/sda1"];
2561        ["vgcreate"; "VG"; "/dev/sda1"];
2562        ["lvcreate"; "LV1"; "VG"; "50"];
2563        ["lvcreate"; "LV2"; "VG"; "50"];
2564        ["vgremove"; "VG"];
2565        ["lvs"]], []);
2566     InitEmpty, Always, TestOutputList (
2567       [["part_disk"; "/dev/sda"; "mbr"];
2568        ["pvcreate"; "/dev/sda1"];
2569        ["vgcreate"; "VG"; "/dev/sda1"];
2570        ["lvcreate"; "LV1"; "VG"; "50"];
2571        ["lvcreate"; "LV2"; "VG"; "50"];
2572        ["vgremove"; "VG"];
2573        ["vgs"]], [])],
2574    "remove an LVM volume group",
2575    "\
2576 Remove an LVM volume group C<vgname>, (for example C<VG>).
2577
2578 This also forcibly removes all logical volumes in the volume
2579 group (if any).");
2580
2581   ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2582    [InitEmpty, Always, TestOutputListOfDevices (
2583       [["part_disk"; "/dev/sda"; "mbr"];
2584        ["pvcreate"; "/dev/sda1"];
2585        ["vgcreate"; "VG"; "/dev/sda1"];
2586        ["lvcreate"; "LV1"; "VG"; "50"];
2587        ["lvcreate"; "LV2"; "VG"; "50"];
2588        ["vgremove"; "VG"];
2589        ["pvremove"; "/dev/sda1"];
2590        ["lvs"]], []);
2591     InitEmpty, Always, TestOutputListOfDevices (
2592       [["part_disk"; "/dev/sda"; "mbr"];
2593        ["pvcreate"; "/dev/sda1"];
2594        ["vgcreate"; "VG"; "/dev/sda1"];
2595        ["lvcreate"; "LV1"; "VG"; "50"];
2596        ["lvcreate"; "LV2"; "VG"; "50"];
2597        ["vgremove"; "VG"];
2598        ["pvremove"; "/dev/sda1"];
2599        ["vgs"]], []);
2600     InitEmpty, Always, TestOutputListOfDevices (
2601       [["part_disk"; "/dev/sda"; "mbr"];
2602        ["pvcreate"; "/dev/sda1"];
2603        ["vgcreate"; "VG"; "/dev/sda1"];
2604        ["lvcreate"; "LV1"; "VG"; "50"];
2605        ["lvcreate"; "LV2"; "VG"; "50"];
2606        ["vgremove"; "VG"];
2607        ["pvremove"; "/dev/sda1"];
2608        ["pvs"]], [])],
2609    "remove an LVM physical volume",
2610    "\
2611 This wipes a physical volume C<device> so that LVM will no longer
2612 recognise it.
2613
2614 The implementation uses the C<pvremove> command which refuses to
2615 wipe physical volumes that contain any volume groups, so you have
2616 to remove those first.");
2617
2618   ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2619    [InitBasicFS, Always, TestOutput (
2620       [["set_e2label"; "/dev/sda1"; "testlabel"];
2621        ["get_e2label"; "/dev/sda1"]], "testlabel")],
2622    "set the ext2/3/4 filesystem label",
2623    "\
2624 This sets the ext2/3/4 filesystem label of the filesystem on
2625 C<device> to C<label>.  Filesystem labels are limited to
2626 16 characters.
2627
2628 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2629 to return the existing label on a filesystem.");
2630
2631   ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2632    [],
2633    "get the ext2/3/4 filesystem label",
2634    "\
2635 This returns the ext2/3/4 filesystem label of the filesystem on
2636 C<device>.");
2637
2638   ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2639    (let uuid = uuidgen () in
2640     [InitBasicFS, Always, TestOutput (
2641        [["set_e2uuid"; "/dev/sda1"; uuid];
2642         ["get_e2uuid"; "/dev/sda1"]], uuid);
2643      InitBasicFS, Always, TestOutput (
2644        [["set_e2uuid"; "/dev/sda1"; "clear"];
2645         ["get_e2uuid"; "/dev/sda1"]], "");
2646      (* We can't predict what UUIDs will be, so just check the commands run. *)
2647      InitBasicFS, Always, TestRun (
2648        [["set_e2uuid"; "/dev/sda1"; "random"]]);
2649      InitBasicFS, Always, TestRun (
2650        [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2651    "set the ext2/3/4 filesystem UUID",
2652    "\
2653 This sets the ext2/3/4 filesystem UUID of the filesystem on
2654 C<device> to C<uuid>.  The format of the UUID and alternatives
2655 such as C<clear>, C<random> and C<time> are described in the
2656 L<tune2fs(8)> manpage.
2657
2658 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2659 to return the existing UUID of a filesystem.");
2660
2661   ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2662    (* Regression test for RHBZ#597112. *)
2663    (let uuid = uuidgen () in
2664     [InitBasicFS, Always, TestOutput (
2665        [["mke2journal"; "1024"; "/dev/sdb"];
2666         ["set_e2uuid"; "/dev/sdb"; uuid];
2667         ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2668    "get the ext2/3/4 filesystem UUID",
2669    "\
2670 This returns the ext2/3/4 filesystem UUID of the filesystem on
2671 C<device>.");
2672
2673   ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2674    [InitBasicFS, Always, TestOutputInt (
2675       [["umount"; "/dev/sda1"];
2676        ["fsck"; "ext2"; "/dev/sda1"]], 0);
2677     InitBasicFS, Always, TestOutputInt (
2678       [["umount"; "/dev/sda1"];
2679        ["zero"; "/dev/sda1"];
2680        ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2681    "run the filesystem checker",
2682    "\
2683 This runs the filesystem checker (fsck) on C<device> which
2684 should have filesystem type C<fstype>.
2685
2686 The returned integer is the status.  See L<fsck(8)> for the
2687 list of status codes from C<fsck>.
2688
2689 Notes:
2690
2691 =over 4
2692
2693 =item *
2694
2695 Multiple status codes can be summed together.
2696
2697 =item *
2698
2699 A non-zero return code can mean \"success\", for example if
2700 errors have been corrected on the filesystem.
2701
2702 =item *
2703
2704 Checking or repairing NTFS volumes is not supported
2705 (by linux-ntfs).
2706
2707 =back
2708
2709 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2710
2711   ("zero", (RErr, [Device "device"], []), 85, [Progress],
2712    [InitBasicFS, Always, TestOutput (
2713       [["umount"; "/dev/sda1"];
2714        ["zero"; "/dev/sda1"];
2715        ["file"; "/dev/sda1"]], "data")],
2716    "write zeroes to the device",
2717    "\
2718 This command writes zeroes over the first few blocks of C<device>.
2719
2720 How many blocks are zeroed isn't specified (but it's I<not> enough
2721 to securely wipe the device).  It should be sufficient to remove
2722 any partition tables, filesystem superblocks and so on.
2723
2724 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2725
2726   ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2727    (* See:
2728     * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2729     * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2730     *)
2731    [InitBasicFS, Always, TestOutputTrue (
2732       [["mkdir_p"; "/boot/grub"];
2733        ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2734        ["grub_install"; "/"; "/dev/vda"];
2735        ["is_dir"; "/boot"]])],
2736    "install GRUB",
2737    "\
2738 This command installs GRUB (the Grand Unified Bootloader) on
2739 C<device>, with the root directory being C<root>.
2740
2741 Note: If grub-install reports the error
2742 \"No suitable drive was found in the generated device map.\"
2743 it may be that you need to create a C</boot/grub/device.map>
2744 file first that contains the mapping between grub device names
2745 and Linux device names.  It is usually sufficient to create
2746 a file containing:
2747
2748  (hd0) /dev/vda
2749
2750 replacing C</dev/vda> with the name of the installation device.");
2751
2752   ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2753    [InitBasicFS, Always, TestOutput (
2754       [["write"; "/old"; "file content"];
2755        ["cp"; "/old"; "/new"];
2756        ["cat"; "/new"]], "file content");
2757     InitBasicFS, Always, TestOutputTrue (
2758       [["write"; "/old"; "file content"];
2759        ["cp"; "/old"; "/new"];
2760        ["is_file"; "/old"]]);
2761     InitBasicFS, Always, TestOutput (
2762       [["write"; "/old"; "file content"];
2763        ["mkdir"; "/dir"];
2764        ["cp"; "/old"; "/dir/new"];
2765        ["cat"; "/dir/new"]], "file content")],
2766    "copy a file",
2767    "\
2768 This copies a file from C<src> to C<dest> where C<dest> is
2769 either a destination filename or destination directory.");
2770
2771   ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2772    [InitBasicFS, Always, TestOutput (
2773       [["mkdir"; "/olddir"];
2774        ["mkdir"; "/newdir"];
2775        ["write"; "/olddir/file"; "file content"];
2776        ["cp_a"; "/olddir"; "/newdir"];
2777        ["cat"; "/newdir/olddir/file"]], "file content")],
2778    "copy a file or directory recursively",
2779    "\
2780 This copies a file or directory from C<src> to C<dest>
2781 recursively using the C<cp -a> command.");
2782
2783   ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2784    [InitBasicFS, Always, TestOutput (
2785       [["write"; "/old"; "file content"];
2786        ["mv"; "/old"; "/new"];
2787        ["cat"; "/new"]], "file content");
2788     InitBasicFS, Always, TestOutputFalse (
2789       [["write"; "/old"; "file content"];
2790        ["mv"; "/old"; "/new"];
2791        ["is_file"; "/old"]])],
2792    "move a file",
2793    "\
2794 This moves a file from C<src> to C<dest> where C<dest> is
2795 either a destination filename or destination directory.");
2796
2797   ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2798    [InitEmpty, Always, TestRun (
2799       [["drop_caches"; "3"]])],
2800    "drop kernel page cache, dentries and inodes",
2801    "\
2802 This instructs the guest kernel to drop its page cache,
2803 and/or dentries and inode caches.  The parameter C<whattodrop>
2804 tells the kernel what precisely to drop, see
2805 L<http://linux-mm.org/Drop_Caches>
2806
2807 Setting C<whattodrop> to 3 should drop everything.
2808
2809 This automatically calls L<sync(2)> before the operation,
2810 so that the maximum guest memory is freed.");
2811
2812   ("dmesg", (RString "kmsgs", [], []), 91, [],
2813    [InitEmpty, Always, TestRun (
2814       [["dmesg"]])],
2815    "return kernel messages",
2816    "\
2817 This returns the kernel messages (C<dmesg> output) from
2818 the guest kernel.  This is sometimes useful for extended
2819 debugging of problems.
2820
2821 Another way to get the same information is to enable
2822 verbose messages with C<guestfs_set_verbose> or by setting
2823 the environment variable C<LIBGUESTFS_DEBUG=1> before
2824 running the program.");
2825
2826   ("ping_daemon", (RErr, [], []), 92, [],
2827    [InitEmpty, Always, TestRun (
2828       [["ping_daemon"]])],
2829    "ping the guest daemon",
2830    "\
2831 This is a test probe into the guestfs daemon running inside
2832 the qemu subprocess.  Calling this function checks that the
2833 daemon responds to the ping message, without affecting the daemon
2834 or attached block device(s) in any other way.");
2835
2836   ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2837    [InitBasicFS, Always, TestOutputTrue (
2838       [["write"; "/file1"; "contents of a file"];
2839        ["cp"; "/file1"; "/file2"];
2840        ["equal"; "/file1"; "/file2"]]);
2841     InitBasicFS, Always, TestOutputFalse (
2842       [["write"; "/file1"; "contents of a file"];
2843        ["write"; "/file2"; "contents of another file"];
2844        ["equal"; "/file1"; "/file2"]]);
2845     InitBasicFS, Always, TestLastFail (
2846       [["equal"; "/file1"; "/file2"]])],
2847    "test if two files have equal contents",
2848    "\
2849 This compares the two files C<file1> and C<file2> and returns
2850 true if their content is exactly equal, or false otherwise.
2851
2852 The external L<cmp(1)> program is used for the comparison.");
2853
2854   ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2855    [InitISOFS, Always, TestOutputList (
2856       [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2857     InitISOFS, Always, TestOutputList (
2858       [["strings"; "/empty"]], []);
2859     (* Test for RHBZ#579608, absolute symbolic links. *)
2860     InitISOFS, Always, TestRun (
2861       [["strings"; "/abssymlink"]])],
2862    "print the printable strings in a file",
2863    "\
2864 This runs the L<strings(1)> command on a file and returns
2865 the list of printable strings found.");
2866
2867   ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2868    [InitISOFS, Always, TestOutputList (
2869       [["strings_e"; "b"; "/known-5"]], []);
2870     InitBasicFS, Always, TestOutputList (
2871       [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2872        ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2873    "print the printable strings in a file",
2874    "\
2875 This is like the C<guestfs_strings> command, but allows you to
2876 specify the encoding of strings that are looked for in
2877 the source file C<path>.
2878
2879 Allowed encodings are:
2880
2881 =over 4
2882
2883 =item s
2884
2885 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2886 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2887
2888 =item S
2889
2890 Single 8-bit-byte characters.
2891
2892 =item b
2893
2894 16-bit big endian strings such as those encoded in
2895 UTF-16BE or UCS-2BE.
2896
2897 =item l (lower case letter L)
2898
2899 16-bit little endian such as UTF-16LE and UCS-2LE.
2900 This is useful for examining binaries in Windows guests.
2901
2902 =item B
2903
2904 32-bit big endian such as UCS-4BE.
2905
2906 =item L
2907
2908 32-bit little endian such as UCS-4LE.
2909
2910 =back
2911
2912 The returned strings are transcoded to UTF-8.");
2913
2914   ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2915    [InitISOFS, Always, TestOutput (
2916       [["hexdump"; "/known-4"]], "00000000  61 62 63 0a 64 65 66 0a  67 68 69                 |abc.def.ghi|\n0000000b\n");
2917     (* Test for RHBZ#501888c2 regression which caused large hexdump
2918      * commands to segfault.
2919      *)
2920     InitISOFS, Always, TestRun (
2921       [["hexdump"; "/100krandom"]]);
2922     (* Test for RHBZ#579608, absolute symbolic links. *)
2923     InitISOFS, Always, TestRun (
2924       [["hexdump"; "/abssymlink"]])],
2925    "dump a file in hexadecimal",
2926    "\
2927 This runs C<hexdump -C> on the given C<path>.  The result is
2928 the human-readable, canonical hex dump of the file.");
2929
2930   ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2931    [InitNone, Always, TestOutput (
2932       [["part_disk"; "/dev/sda"; "mbr"];
2933        ["mkfs"; "ext3"; "/dev/sda1"];
2934        ["mount_options"; ""; "/dev/sda1"; "/"];
2935        ["write"; "/new"; "test file"];
2936        ["umount"; "/dev/sda1"];
2937        ["zerofree"; "/dev/sda1"];
2938        ["mount_options"; ""; "/dev/sda1"; "/"];
2939        ["cat"; "/new"]], "test file")],
2940    "zero unused inodes and disk blocks on ext2/3 filesystem",
2941    "\
2942 This runs the I<zerofree> program on C<device>.  This program
2943 claims to zero unused inodes and disk blocks on an ext2/3
2944 filesystem, thus making it possible to compress the filesystem
2945 more effectively.
2946
2947 You should B<not> run this program if the filesystem is
2948 mounted.
2949
2950 It is possible that using this program can damage the filesystem
2951 or data on the filesystem.");
2952
2953   ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
2954    [],
2955    "resize an LVM physical volume",
2956    "\
2957 This resizes (expands or shrinks) an existing LVM physical
2958 volume to match the new size of the underlying device.");
2959
2960   ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2961                        Int "cyls"; Int "heads"; Int "sectors";
2962                        String "line"], []), 99, [DangerWillRobinson],
2963    [],
2964    "modify a single partition on a block device",
2965    "\
2966 This runs L<sfdisk(8)> option to modify just the single
2967 partition C<n> (note: C<n> counts from 1).
2968
2969 For other parameters, see C<guestfs_sfdisk>.  You should usually
2970 pass C<0> for the cyls/heads/sectors parameters.
2971
2972 See also: C<guestfs_part_add>");
2973
2974   ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
2975    [],
2976    "display the partition table",
2977    "\
2978 This displays the partition table on C<device>, in the
2979 human-readable output of the L<sfdisk(8)> command.  It is
2980 not intended to be parsed.
2981
2982 See also: C<guestfs_part_list>");
2983
2984   ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
2985    [],
2986    "display the kernel geometry",
2987    "\
2988 This displays the kernel's idea of the geometry of C<device>.
2989
2990 The result is in human-readable format, and not designed to
2991 be parsed.");
2992
2993   ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
2994    [],
2995    "display the disk geometry from the partition table",
2996    "\
2997 This displays the disk geometry of C<device> read from the
2998 partition table.  Especially in the case where the underlying
2999 block device has been resized, this can be different from the
3000 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3001
3002 The result is in human-readable format, and not designed to
3003 be parsed.");
3004
3005   ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3006    [],
3007    "activate or deactivate all volume groups",
3008    "\
3009 This command activates or (if C<activate> is false) deactivates
3010 all logical volumes in all volume groups.
3011 If activated, then they are made known to the
3012 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
3013 then those devices disappear.
3014
3015 This command is the same as running C<vgchange -a y|n>");
3016
3017   ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3018    [],
3019    "activate or deactivate some volume groups",
3020    "\
3021 This command activates or (if C<activate> is false) deactivates
3022 all logical volumes in the listed volume groups C<volgroups>.
3023 If activated, then they are made known to the
3024 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
3025 then those devices disappear.
3026
3027 This command is the same as running C<vgchange -a y|n volgroups...>
3028
3029 Note that if C<volgroups> is an empty list then B<all> volume groups
3030 are activated or deactivated.");
3031
3032   ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3033    [InitNone, Always, TestOutput (
3034       [["part_disk"; "/dev/sda"; "mbr"];
3035        ["pvcreate"; "/dev/sda1"];
3036        ["vgcreate"; "VG"; "/dev/sda1"];
3037        ["lvcreate"; "LV"; "VG"; "10"];
3038        ["mkfs"; "ext2"; "/dev/VG/LV"];
3039        ["mount_options"; ""; "/dev/VG/LV"; "/"];
3040        ["write"; "/new"; "test content"];
3041        ["umount"; "/"];
3042        ["lvresize"; "/dev/VG/LV"; "20"];
3043        ["e2fsck_f"; "/dev/VG/LV"];
3044        ["resize2fs"; "/dev/VG/LV"];
3045        ["mount_options"; ""; "/dev/VG/LV"; "/"];
3046        ["cat"; "/new"]], "test content");
3047     InitNone, Always, TestRun (
3048       (* Make an LV smaller to test RHBZ#587484. *)
3049       [["part_disk"; "/dev/sda"; "mbr"];
3050        ["pvcreate"; "/dev/sda1"];
3051        ["vgcreate"; "VG"; "/dev/sda1"];
3052        ["lvcreate"; "LV"; "VG"; "20"];
3053        ["lvresize"; "/dev/VG/LV"; "10"]])],
3054    "resize an LVM logical volume",
3055    "\
3056 This resizes (expands or shrinks) an existing LVM logical
3057 volume to C<mbytes>.  When reducing, data in the reduced part
3058 is lost.");
3059
3060   ("resize2fs", (RErr, [Device "device"], []), 106, [],
3061    [], (* lvresize tests this *)
3062    "resize an ext2, ext3 or ext4 filesystem",
3063    "\
3064 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3065 the underlying device.
3066
3067 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3068 on the C<device> before calling this command.  For unknown reasons
3069 C<resize2fs> sometimes gives an error about this and sometimes not.
3070 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3071 calling this function.");
3072
3073   ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3074    [InitBasicFS, Always, TestOutputList (
3075       [["find"; "/"]], ["lost+found"]);
3076     InitBasicFS, Always, TestOutputList (
3077       [["touch"; "/a"];
3078        ["mkdir"; "/b"];
3079        ["touch"; "/b/c"];
3080        ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3081     InitBasicFS, Always, TestOutputList (
3082       [["mkdir_p"; "/a/b/c"];
3083        ["touch"; "/a/b/c/d"];
3084        ["find"; "/a/b/"]], ["c"; "c/d"])],
3085    "find all files and directories",
3086    "\
3087 This command lists out all files and directories, recursively,
3088 starting at C<directory>.  It is essentially equivalent to
3089 running the shell command C<find directory -print> but some
3090 post-processing happens on the output, described below.
3091
3092 This returns a list of strings I<without any prefix>.  Thus
3093 if the directory structure was:
3094
3095  /tmp/a
3096  /tmp/b
3097  /tmp/c/d
3098
3099 then the returned list from C<guestfs_find> C</tmp> would be
3100 4 elements:
3101
3102  a
3103  b
3104  c
3105  c/d
3106
3107 If C<directory> is not a directory, then this command returns
3108 an error.
3109
3110 The returned list is sorted.
3111
3112 See also C<guestfs_find0>.");
3113
3114   ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3115    [], (* lvresize tests this *)
3116    "check an ext2/ext3 filesystem",
3117    "\
3118 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3119 filesystem checker on C<device>, noninteractively (C<-p>),
3120 even if the filesystem appears to be clean (C<-f>).
3121
3122 This command is only needed because of C<guestfs_resize2fs>
3123 (q.v.).  Normally you should use C<guestfs_fsck>.");
3124
3125   ("sleep", (RErr, [Int "secs"], []), 109, [],
3126    [InitNone, Always, TestRun (
3127       [["sleep"; "1"]])],
3128    "sleep for some seconds",
3129    "\
3130 Sleep for C<secs> seconds.");
3131
3132   ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3133    [InitNone, Always, TestOutputInt (
3134       [["part_disk"; "/dev/sda"; "mbr"];
3135        ["mkfs"; "ntfs"; "/dev/sda1"];
3136        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3137     InitNone, Always, TestOutputInt (
3138       [["part_disk"; "/dev/sda"; "mbr"];
3139        ["mkfs"; "ext2"; "/dev/sda1"];
3140        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3141    "probe NTFS volume",
3142    "\
3143 This command runs the L<ntfs-3g.probe(8)> command which probes
3144 an NTFS C<device> for mountability.  (Not all NTFS volumes can
3145 be mounted read-write, and some cannot be mounted at all).
3146
3147 C<rw> is a boolean flag.  Set it to true if you want to test
3148 if the volume can be mounted read-write.  Set it to false if
3149 you want to test if the volume can be mounted read-only.
3150
3151 The return value is an integer which C<0> if the operation
3152 would succeed, or some non-zero value documented in the
3153 L<ntfs-3g.probe(8)> manual page.");
3154
3155   ("sh", (RString "output", [String "command"], []), 111, [],
3156    [], (* XXX needs tests *)
3157    "run a command via the shell",
3158    "\
3159 This call runs a command from the guest filesystem via the
3160 guest's C</bin/sh>.
3161
3162 This is like C<guestfs_command>, but passes the command to:
3163
3164  /bin/sh -c \"command\"
3165
3166 Depending on the guest's shell, this usually results in
3167 wildcards being expanded, shell expressions being interpolated
3168 and so on.
3169
3170 All the provisos about C<guestfs_command> apply to this call.");
3171
3172   ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3173    [], (* XXX needs tests *)
3174    "run a command via the shell returning lines",
3175    "\
3176 This is the same as C<guestfs_sh>, but splits the result
3177 into a list of lines.
3178
3179 See also: C<guestfs_command_lines>");
3180
3181   ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3182    (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3183     * code in stubs.c, since all valid glob patterns must start with "/".
3184     * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3185     *)
3186    [InitBasicFS, Always, TestOutputList (
3187       [["mkdir_p"; "/a/b/c"];
3188        ["touch"; "/a/b/c/d"];
3189        ["touch"; "/a/b/c/e"];
3190        ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
3191     InitBasicFS, Always, TestOutputList (
3192       [["mkdir_p"; "/a/b/c"];
3193        ["touch"; "/a/b/c/d"];
3194        ["touch"; "/a/b/c/e"];
3195        ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
3196     InitBasicFS, Always, TestOutputList (
3197       [["mkdir_p"; "/a/b/c"];
3198        ["touch"; "/a/b/c/d"];
3199        ["touch"; "/a/b/c/e"];
3200        ["glob_expand"; "/a/*/x/*"]], [])],
3201    "expand a wildcard path",
3202    "\
3203 This command searches for all the pathnames matching
3204 C<pattern> according to the wildcard expansion rules
3205 used by the shell.
3206
3207 If no paths match, then this returns an empty list
3208 (note: not an error).
3209
3210 It is just a wrapper around the C L<glob(3)> function
3211 with flags C<GLOB_MARK|GLOB_BRACE>.
3212 See that manual page for more details.");
3213
3214   ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3215    [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3216       [["scrub_device"; "/dev/sdc"]])],
3217    "scrub (securely wipe) a device",
3218    "\
3219 This command writes patterns over C<device> to make data retrieval
3220 more difficult.
3221
3222 It is an interface to the L<scrub(1)> program.  See that
3223 manual page for more details.");
3224
3225   ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3226    [InitBasicFS, Always, TestRun (
3227       [["write"; "/file"; "content"];
3228        ["scrub_file"; "/file"]])],
3229    "scrub (securely wipe) a file",
3230    "\
3231 This command writes patterns over a file to make data retrieval
3232 more difficult.
3233
3234 The file is I<removed> after scrubbing.
3235
3236 It is an interface to the L<scrub(1)> program.  See that
3237 manual page for more details.");
3238
3239   ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3240    [], (* XXX needs testing *)
3241    "scrub (securely wipe) free space",
3242    "\
3243 This command creates the directory C<dir> and then fills it
3244 with files until the filesystem is full, and scrubs the files
3245 as for C<guestfs_scrub_file>, and deletes them.
3246 The intention is to scrub any free space on the partition
3247 containing C<dir>.
3248
3249 It is an interface to the L<scrub(1)> program.  See that
3250 manual page for more details.");
3251
3252   ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3253    [InitBasicFS, Always, TestRun (
3254       [["mkdir"; "/tmp"];
3255        ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
3256    "create a temporary directory",
3257    "\
3258 This command creates a temporary directory.  The
3259 C<template> parameter should be a full pathname for the
3260 temporary directory name with the final six characters being
3261 \"XXXXXX\".
3262
3263 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3264 the second one being suitable for Windows filesystems.
3265
3266 The name of the temporary directory that was created
3267 is returned.
3268
3269 The temporary directory is created with mode 0700
3270 and is owned by root.
3271
3272 The caller is responsible for deleting the temporary
3273 directory and its contents after use.
3274
3275 See also: L<mkdtemp(3)>");
3276
3277   ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3278    [InitISOFS, Always, TestOutputInt (
3279       [["wc_l"; "/10klines"]], 10000);
3280     (* Test for RHBZ#579608, absolute symbolic links. *)
3281     InitISOFS, Always, TestOutputInt (
3282       [["wc_l"; "/abssymlink"]], 10000)],
3283    "count lines in a file",
3284    "\
3285 This command counts the lines in a file, using the
3286 C<wc -l> external command.");
3287
3288   ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3289    [InitISOFS, Always, TestOutputInt (
3290       [["wc_w"; "/10klines"]], 10000)],
3291    "count words in a file",
3292    "\
3293 This command counts the words in a file, using the
3294 C<wc -w> external command.");
3295
3296   ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3297    [InitISOFS, Always, TestOutputInt (
3298       [["wc_c"; "/100kallspaces"]], 102400)],
3299    "count characters in a file",
3300    "\
3301 This command counts the characters in a file, using the
3302 C<wc -c> external command.");
3303
3304   ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3305    [InitISOFS, Always, TestOutputList (
3306       [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3307     (* Test for RHBZ#579608, absolute symbolic links. *)
3308     InitISOFS, Always, TestOutputList (
3309       [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3310    "return first 10 lines of a file",
3311    "\
3312 This command returns up to the first 10 lines of a file as
3313 a list of strings.");
3314
3315   ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3316    [InitISOFS, Always, TestOutputList (
3317       [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3318     InitISOFS, Always, TestOutputList (
3319       [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3320     InitISOFS, Always, TestOutputList (
3321       [["head_n"; "0"; "/10klines"]], [])],
3322    "return first N lines of a file",
3323    "\
3324 If the parameter C<nrlines> is a positive number, this returns the first
3325 C<nrlines> lines of the file C<path>.
3326
3327 If the parameter C<nrlines> is a negative number, this returns lines
3328 from the file C<path>, excluding the last C<nrlines> lines.
3329
3330 If the parameter C<nrlines> is zero, this returns an empty list.");
3331
3332   ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3333    [InitISOFS, Always, TestOutputList (
3334       [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3335    "return last 10 lines of a file",
3336    "\
3337 This command returns up to the last 10 lines of a file as
3338 a list of strings.");
3339
3340   ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3341    [InitISOFS, Always, TestOutputList (
3342       [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3343     InitISOFS, Always, TestOutputList (
3344       [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3345     InitISOFS, Always, TestOutputList (
3346       [["tail_n"; "0"; "/10klines"]], [])],
3347    "return last N lines of a file",
3348    "\
3349 If the parameter C<nrlines> is a positive number, this returns the last
3350 C<nrlines> lines of the file C<path>.
3351
3352 If the parameter C<nrlines> is a negative number, this returns lines
3353 from the file C<path>, starting with the C<-nrlines>th line.
3354
3355 If the parameter C<nrlines> is zero, this returns an empty list.");
3356
3357   ("df", (RString "output", [], []), 125, [],
3358    [], (* XXX Tricky to test because it depends on the exact format
3359         * of the 'df' command and other imponderables.
3360         *)
3361    "report file system disk space usage",
3362    "\
3363 This command runs the C<df> command to report disk space used.
3364
3365 This command is mostly useful for interactive sessions.  It
3366 is I<not> intended that you try to parse the output string.
3367 Use C<statvfs> from programs.");
3368
3369   ("df_h", (RString "output", [], []), 126, [],
3370    [], (* XXX Tricky to test because it depends on the exact format
3371         * of the 'df' command and other imponderables.
3372         *)
3373    "report file system disk space usage (human readable)",
3374    "\
3375 This command runs the C<df -h> command to report disk space used
3376 in human-readable format.
3377
3378 This command is mostly useful for interactive sessions.  It
3379 is I<not> intended that you try to parse the output string.
3380 Use C<statvfs> from programs.");
3381
3382   ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3383    [InitISOFS, Always, TestOutputInt (
3384       [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3385    "estimate file space usage",
3386    "\
3387 This command runs the C<du -s> command to estimate file space
3388 usage for C<path>.
3389
3390 C<path> can be a file or a directory.  If C<path> is a directory
3391 then the estimate includes the contents of the directory and all
3392 subdirectories (recursively).
3393
3394 The result is the estimated size in I<kilobytes>
3395 (ie. units of 1024 bytes).");
3396
3397   ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3398    [InitISOFS, Always, TestOutputList (
3399       [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3400    "list files in an initrd",
3401    "\
3402 This command lists out files contained in an initrd.
3403
3404 The files are listed without any initial C</> character.  The
3405 files are listed in the order they appear (not necessarily
3406 alphabetical).  Directory names are listed as separate items.
3407
3408 Old Linux kernels (2.4 and earlier) used a compressed ext2
3409 filesystem as initrd.  We I<only> support the newer initramfs
3410 format (compressed cpio files).");
3411
3412   ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3413    [],
3414    "mount a file using the loop device",
3415    "\
3416 This command lets you mount C<file> (a filesystem image
3417 in a file) on a mount point.  It is entirely equivalent to
3418 the command C<mount -o loop file mountpoint>.");
3419
3420   ("mkswap", (RErr, [Device "device"], []), 130, [],
3421    [InitEmpty, Always, TestRun (
3422       [["part_disk"; "/dev/sda"; "mbr"];
3423        ["mkswap"; "/dev/sda1"]])],
3424    "create a swap partition",
3425    "\
3426 Create a swap partition on C<device>.");
3427
3428   ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3429    [InitEmpty, Always, TestRun (
3430       [["part_disk"; "/dev/sda"; "mbr"];
3431        ["mkswap_L"; "hello"; "/dev/sda1"]])],
3432    "create a swap partition with a label",
3433    "\
3434 Create a swap partition on C<device> with label C<label>.
3435
3436 Note that you cannot attach a swap label to a block device
3437 (eg. C</dev/sda>), just to a partition.  This appears to be
3438 a limitation of the kernel or swap tools.");
3439
3440   ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3441    (let uuid = uuidgen () in
3442     [InitEmpty, Always, TestRun (
3443        [["part_disk"; "/dev/sda"; "mbr"];
3444         ["mkswap_U"; uuid; "/dev/sda1"]])]),
3445    "create a swap partition with an explicit UUID",
3446    "\
3447 Create a swap partition on C<device> with UUID C<uuid>.");
3448
3449   ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3450    [InitBasicFS, Always, TestOutputStruct (
3451       [["mknod"; "0o10777"; "0"; "0"; "/node"];
3452        (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3453        ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3454     InitBasicFS, Always, TestOutputStruct (
3455       [["mknod"; "0o60777"; "66"; "99"; "/node"];
3456        ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3457    "make block, character or FIFO devices",
3458    "\
3459 This call creates block or character special devices, or
3460 named pipes (FIFOs).
3461
3462 The C<mode> parameter should be the mode, using the standard
3463 constants.  C<devmajor> and C<devminor> are the
3464 device major and minor numbers, only used when creating block
3465 and character special devices.
3466
3467 Note that, just like L<mknod(2)>, the mode must be bitwise
3468 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3469 just creates a regular file).  These constants are
3470 available in the standard Linux header files, or you can use
3471 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3472 which are wrappers around this command which bitwise OR
3473 in the appropriate constant for you.
3474
3475 The mode actually set is affected by the umask.");
3476
3477   ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3478    [InitBasicFS, Always, TestOutputStruct (
3479       [["mkfifo"; "0o777"; "/node"];
3480        ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3481    "make FIFO (named pipe)",
3482    "\
3483 This call creates a FIFO (named pipe) called C<path> with
3484 mode C<mode>.  It is just a convenient wrapper around
3485 C<guestfs_mknod>.
3486
3487 The mode actually set is affected by the umask.");
3488
3489   ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3490    [InitBasicFS, Always, TestOutputStruct (
3491       [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3492        ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3493    "make block device node",
3494    "\
3495 This call creates a block device node called C<path> with
3496 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3497 It is just a convenient wrapper around C<guestfs_mknod>.
3498
3499 The mode actually set is affected by the umask.");
3500
3501   ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3502    [InitBasicFS, Always, TestOutputStruct (
3503       [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3504        ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3505    "make char device node",
3506    "\
3507 This call creates a char device node called C<path> with
3508 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3509 It is just a convenient wrapper around C<guestfs_mknod>.
3510
3511 The mode actually set is affected by the umask.");
3512
3513   ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3514    [InitEmpty, Always, TestOutputInt (
3515       [["umask"; "0o22"]], 0o22)],
3516    "set file mode creation mask (umask)",
3517    "\
3518 This function sets the mask used for creating new files and
3519 device nodes to C<mask & 0777>.
3520
3521 Typical umask values would be C<022> which creates new files
3522 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3523 C<002> which creates new files with permissions like
3524 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3525
3526 The default umask is C<022>.  This is important because it
3527 means that directories and device nodes will be created with
3528 C<0644> or C<0755> mode even if you specify C<0777>.
3529
3530 See also C<guestfs_get_umask>,
3531 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3532
3533 This call returns the previous umask.");
3534
3535   ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3536    [],
3537    "read directories entries",
3538    "\
3539 This returns the list of directory entries in directory C<dir>.
3540
3541 All entries in the directory are returned, including C<.> and
3542 C<..>.  The entries are I<not> sorted, but returned in the same
3543 order as the underlying filesystem.
3544
3545 Also this call returns basic file type information about each
3546 file.  The C<ftyp> field will contain one of the following characters:
3547
3548 =over 4
3549
3550 =item 'b'
3551
3552 Block special
3553
3554 =item 'c'
3555
3556 Char special
3557
3558 =item 'd'
3559
3560 Directory
3561
3562 =item 'f'
3563
3564 FIFO (named pipe)
3565
3566 =item 'l'
3567
3568 Symbolic link
3569
3570 =item 'r'
3571
3572 Regular file
3573
3574 =item 's'
3575
3576 Socket
3577
3578 =item 'u'
3579
3580 Unknown file type
3581
3582 =item '?'
3583
3584 The L<readdir(3)> call returned a C<d_type> field with an
3585 unexpected value
3586
3587 =back
3588
3589 This function is primarily intended for use by programs.  To
3590 get a simple list of names, use C<guestfs_ls>.  To get a printable
3591 directory for human consumption, use C<guestfs_ll>.");
3592
3593   ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3594    [],
3595    "create partitions on a block device",
3596    "\
3597 This is a simplified interface to the C<guestfs_sfdisk>
3598 command, where partition sizes are specified in megabytes
3599 only (rounded to the nearest cylinder) and you don't need
3600 to specify the cyls, heads and sectors parameters which
3601 were rarely if ever used anyway.
3602
3603 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3604 and C<guestfs_part_disk>");
3605
3606   ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3607    [],
3608    "determine file type inside a compressed file",
3609    "\
3610 This command runs C<file> after first decompressing C<path>
3611 using C<method>.
3612
3613 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3614
3615 Since 1.0.63, use C<guestfs_file> instead which can now
3616 process compressed files.");
3617
3618   ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3619    [],
3620    "list extended attributes of a file or directory",
3621    "\
3622 This call lists the extended attributes of the file or directory
3623 C<path>.
3624
3625 At the system call level, this is a combination of the
3626 L<listxattr(2)> and L<getxattr(2)> calls.
3627
3628 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3629
3630   ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3631    [],
3632    "list extended attributes of a file or directory",
3633    "\
3634 This is the same as C<guestfs_getxattrs>, but if C<path>
3635 is a symbolic link, then it returns the extended attributes
3636 of the link itself.");
3637
3638   ("setxattr", (RErr, [String "xattr";
3639                        String "val"; Int "vallen"; (* will be BufferIn *)
3640                        Pathname "path"], []), 143, [Optional "linuxxattrs"],
3641    [],
3642    "set extended attribute of a file or directory",
3643    "\
3644 This call sets the extended attribute named C<xattr>
3645 of the file C<path> to the value C<val> (of length C<vallen>).
3646 The value is arbitrary 8 bit data.
3647
3648 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3649
3650   ("lsetxattr", (RErr, [String "xattr";
3651                         String "val"; Int "vallen"; (* will be BufferIn *)
3652                         Pathname "path"], []), 144, [Optional "linuxxattrs"],
3653    [],
3654    "set extended attribute of a file or directory",
3655    "\
3656 This is the same as C<guestfs_setxattr>, but if C<path>
3657 is a symbolic link, then it sets an extended attribute
3658 of the link itself.");
3659
3660   ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3661    [],
3662    "remove extended attribute of a file or directory",
3663    "\
3664 This call removes the extended attribute named C<xattr>
3665 of the file C<path>.
3666
3667 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3668
3669   ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3670    [],
3671    "remove extended attribute of a file or directory",
3672    "\
3673 This is the same as C<guestfs_removexattr>, but if C<path>
3674 is a symbolic link, then it removes an extended attribute
3675 of the link itself.");
3676
3677   ("mountpoints", (RHashtable "mps", [], []), 147, [],
3678    [],
3679    "show mountpoints",
3680    "\
3681 This call is similar to C<guestfs_mounts>.  That call returns
3682 a list of devices.  This one returns a hash table (map) of
3683 device name to directory where the device is mounted.");
3684
3685   ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3686    (* This is a special case: while you would expect a parameter
3687     * of type "Pathname", that doesn't work, because it implies
3688     * NEED_ROOT in the generated calling code in stubs.c, and
3689     * this function cannot use NEED_ROOT.
3690     *)
3691    [],
3692    "create a mountpoint",
3693    "\
3694 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3695 specialized calls that can be used to create extra mountpoints
3696 before mounting the first filesystem.
3697
3698 These calls are I<only> necessary in some very limited circumstances,
3699 mainly the case where you want to mount a mix of unrelated and/or
3700 read-only filesystems together.
3701
3702 For example, live CDs often contain a \"Russian doll\" nest of
3703 filesystems, an ISO outer layer, with a squashfs image inside, with
3704 an ext2/3 image inside that.  You can unpack this as follows
3705 in guestfish:
3706
3707  add-ro Fedora-11-i686-Live.iso
3708  run
3709  mkmountpoint /cd
3710  mkmountpoint /sqsh
3711  mkmountpoint /ext3fs
3712  mount /dev/sda /cd
3713  mount-loop /cd/LiveOS/squashfs.img /sqsh
3714  mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3715
3716 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3717
3718 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3719 You may get unexpected errors if you try to mix these calls.  It is
3720 safest to manually unmount filesystems and remove mountpoints after use.
3721
3722 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3723 longest first, so for this to work for manual mountpoints, you
3724 must ensure that the innermost mountpoints have the longest
3725 pathnames, as in the example code above.
3726
3727 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3728
3729 Autosync [see C<guestfs_set_autosync>, this is set by default on
3730 handles] means that C<guestfs_umount_all> is called when the handle
3731 is closed which can also trigger these issues.");
3732
3733   ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3734    [],
3735    "remove a mountpoint",
3736    "\
3737 This calls removes a mountpoint that was previously created
3738 with C<guestfs_mkmountpoint>.  See C<guestfs_mkmountpoint>
3739 for full details.");
3740
3741   ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3742    [InitISOFS, Always, TestOutputBuffer (
3743       [["read_file"; "/known-4"]], "abc\ndef\nghi");
3744     (* Test various near large, large and too large files (RHBZ#589039). *)
3745     InitBasicFS, Always, TestLastFail (
3746       [["touch"; "/a"];
3747        ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3748        ["read_file"; "/a"]]);
3749     InitBasicFS, Always, TestLastFail (
3750       [["touch"; "/a"];
3751        ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3752        ["read_file"; "/a"]]);
3753     InitBasicFS, Always, TestLastFail (
3754       [["touch"; "/a"];
3755        ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3756        ["read_file"; "/a"]])],
3757    "read a file",
3758    "\
3759 This calls returns the contents of the file C<path> as a
3760 buffer.
3761
3762 Unlike C<guestfs_cat>, this function can correctly
3763 handle files that contain embedded ASCII NUL characters.
3764 However unlike C<guestfs_download>, this function is limited
3765 in the total size of file that can be handled.");
3766
3767   ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3768    [InitISOFS, Always, TestOutputList (
3769       [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3770     InitISOFS, Always, TestOutputList (
3771       [["grep"; "nomatch"; "/test-grep.txt"]], []);
3772     (* Test for RHBZ#579608, absolute symbolic links. *)
3773     InitISOFS, Always, TestOutputList (
3774       [["grep"; "nomatch"; "/abssymlink"]], [])],
3775    "return lines matching a pattern",
3776    "\
3777 This calls the external C<grep> program and returns the
3778 matching lines.");
3779
3780   ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3781    [InitISOFS, Always, TestOutputList (
3782       [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3783    "return lines matching a pattern",
3784    "\
3785 This calls the external C<egrep> program and returns the
3786 matching lines.");
3787
3788   ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3789    [InitISOFS, Always, TestOutputList (
3790       [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3791    "return lines matching a pattern",
3792    "\
3793 This calls the external C<fgrep> program and returns the
3794 matching lines.");
3795
3796   ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3797    [InitISOFS, Always, TestOutputList (
3798       [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3799    "return lines matching a pattern",
3800    "\
3801 This calls the external C<grep -i> program and returns the
3802 matching lines.");
3803
3804   ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3805    [InitISOFS, Always, TestOutputList (
3806       [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3807    "return lines matching a pattern",
3808    "\
3809 This calls the external C<egrep -i> program and returns the
3810 matching lines.");
3811
3812   ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3813    [InitISOFS, Always, TestOutputList (
3814       [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3815    "return lines matching a pattern",
3816    "\
3817 This calls the external C<fgrep -i> program and returns the
3818 matching lines.");
3819
3820   ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3821    [InitISOFS, Always, TestOutputList (
3822       [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3823    "return lines matching a pattern",
3824    "\
3825 This calls the external C<zgrep> program and returns the
3826 matching lines.");
3827
3828   ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3829    [InitISOFS, Always, TestOutputList (
3830       [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3831    "return lines matching a pattern",
3832    "\
3833 This calls the external C<zegrep> program and returns the
3834 matching lines.");
3835
3836   ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3837    [InitISOFS, Always, TestOutputList (
3838       [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3839    "return lines matching a pattern",
3840    "\
3841 This calls the external C<zfgrep> program and returns the
3842 matching lines.");
3843
3844   ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3845    [InitISOFS, Always, TestOutputList (
3846       [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3847    "return lines matching a pattern",
3848    "\
3849 This calls the external C<zgrep -i> program and returns the
3850 matching lines.");
3851
3852   ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3853    [InitISOFS, Always, TestOutputList (
3854       [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3855    "return lines matching a pattern",
3856    "\
3857 This calls the external C<zegrep -i> program and returns the
3858 matching lines.");
3859
3860   ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3861    [InitISOFS, Always, TestOutputList (
3862       [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3863    "return lines matching a pattern",
3864    "\
3865 This calls the external C<zfgrep -i> program and returns the
3866 matching lines.");
3867
3868   ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3869    [InitISOFS, Always, TestOutput (
3870       [["realpath"; "/../directory"]], "/directory")],
3871    "canonicalized absolute pathname",
3872    "\
3873 Return the canonicalized absolute pathname of C<path>.  The
3874 returned path has no C<.>, C<..> or symbolic link path elements.");
3875
3876   ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3877    [InitBasicFS, Always, TestOutputStruct (
3878       [["touch"; "/a"];
3879        ["ln"; "/a"; "/b"];
3880        ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3881    "create a hard link",
3882    "\
3883 This command creates a hard link using the C<ln> command.");
3884
3885   ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3886    [InitBasicFS, Always, TestOutputStruct (
3887       [["touch"; "/a"];
3888        ["touch"; "/b"];
3889        ["ln_f"; "/a"; "/b"];
3890        ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3891    "create a hard link",
3892    "\
3893 This command creates a hard link using the C<ln -f> command.
3894 The C<-f> option removes the link (C<linkname>) if it exists already.");
3895
3896   ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3897    [InitBasicFS, Always, TestOutputStruct (
3898       [["touch"; "/a"];
3899        ["ln_s"; "a"; "/b"];
3900        ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3901    "create a symbolic link",
3902    "\
3903 This command creates a symbolic link using the C<ln -s> command.");
3904
3905   ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3906    [InitBasicFS, Always, TestOutput (
3907       [["mkdir_p"; "/a/b"];
3908        ["touch"; "/a/b/c"];
3909        ["ln_sf"; "../d"; "/a/b/c"];
3910        ["readlink"; "/a/b/c"]], "../d")],
3911    "create a symbolic link",
3912    "\
3913 This command creates a symbolic link using the C<ln -sf> command,
3914 The C<-f> option removes the link (C<linkname>) if it exists already.");
3915
3916   ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3917    [] (* XXX tested above *),
3918    "read the target of a symbolic link",
3919    "\
3920 This command reads the target of a symbolic link.");
3921
3922   ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3923    [InitBasicFS, Always, TestOutputStruct (
3924       [["fallocate"; "/a"; "1000000"];
3925        ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3926    "preallocate a file in the guest filesystem",
3927    "\
3928 This command preallocates a file (containing zero bytes) named
3929 C<path> of size C<len> bytes.  If the file exists already, it
3930 is overwritten.
3931
3932 Do not confuse this with the guestfish-specific
3933 C<alloc> command which allocates a file in the host and
3934 attaches it as a device.");
3935
3936   ("swapon_device", (RErr, [Device "device"], []), 170, [],
3937    [InitPartition, Always, TestRun (
3938       [["mkswap"; "/dev/sda1"];
3939        ["swapon_device"; "/dev/sda1"];
3940        ["swapoff_device"; "/dev/sda1"]])],
3941    "enable swap on device",
3942    "\
3943 This command enables the libguestfs appliance to use the
3944 swap device or partition named C<device>.  The increased
3945 memory is made available for all commands, for example
3946 those run using C<guestfs_command> or C<guestfs_sh>.
3947
3948 Note that you should not swap to existing guest swap
3949 partitions unless you know what you are doing.  They may
3950 contain hibernation information, or other information that
3951 the guest doesn't want you to trash.  You also risk leaking
3952 information about the host to the guest this way.  Instead,
3953 attach a new host device to the guest and swap on that.");
3954
3955   ("swapoff_device", (RErr, [Device "device"], []), 171, [],
3956    [], (* XXX tested by swapon_device *)
3957    "disable swap on device",
3958    "\
3959 This command disables the libguestfs appliance swap
3960 device or partition named C<device>.
3961 See C<guestfs_swapon_device>.");
3962
3963   ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
3964    [InitBasicFS, Always, TestRun (
3965       [["fallocate"; "/swap"; "8388608"];
3966        ["mkswap_file"; "/swap"];
3967        ["swapon_file"; "/swap"];
3968        ["swapoff_file"; "/swap"]])],
3969    "enable swap on file",
3970    "\
3971 This command enables swap to a file.
3972 See C<guestfs_swapon_device> for other notes.");
3973
3974   ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
3975    [], (* XXX tested by swapon_file *)
3976    "disable swap on file",
3977    "\
3978 This command disables the libguestfs appliance swap on file.");
3979
3980   ("swapon_label", (RErr, [String "label"], []), 174, [],
3981    [InitEmpty, Always, TestRun (
3982       [["part_disk"; "/dev/sdb"; "mbr"];
3983        ["mkswap_L"; "swapit"; "/dev/sdb1"];
3984        ["swapon_label"; "swapit"];
3985        ["swapoff_label"; "swapit"];
3986        ["zero"; "/dev/sdb"];
3987        ["blockdev_rereadpt"; "/dev/sdb"]])],
3988    "enable swap on labeled swap partition",
3989    "\
3990 This command enables swap to a labeled swap partition.
3991 See C<guestfs_swapon_device> for other notes.");
3992
3993   ("swapoff_label", (RErr, [String "label"], []), 175, [],
3994    [], (* XXX tested by swapon_label *)
3995    "disable swap on labeled swap partition",
3996    "\
3997 This command disables the libguestfs appliance swap on
3998 labeled swap partition.");
3999
4000   ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4001    (let uuid = uuidgen () in
4002     [InitEmpty, Always, TestRun (
4003        [["mkswap_U"; uuid; "/dev/sdb"];
4004         ["swapon_uuid"; uuid];
4005         ["swapoff_uuid"; uuid]])]),
4006    "enable swap on swap partition by UUID",
4007    "\
4008 This command enables swap to a swap partition with the given UUID.
4009 See C<guestfs_swapon_device> for other notes.");
4010
4011   ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4012    [], (* XXX tested by swapon_uuid *)
4013    "disable swap on swap partition by UUID",
4014    "\
4015 This command disables the libguestfs appliance swap partition
4016 with the given UUID.");
4017
4018   ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4019    [InitBasicFS, Always, TestRun (
4020       [["fallocate"; "/swap"; "8388608"];
4021        ["mkswap_file"; "/swap"]])],
4022    "create a swap file",
4023    "\
4024 Create a swap file.
4025
4026 This command just writes a swap file signature to an existing
4027 file.  To create the file itself, use something like C<guestfs_fallocate>.");
4028
4029   ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4030    [InitISOFS, Always, TestRun (
4031       [["inotify_init"; "0"]])],
4032    "create an inotify handle",
4033    "\
4034 This command creates a new inotify handle.
4035 The inotify subsystem can be used to notify events which happen to
4036 objects in the guest filesystem.
4037
4038 C<maxevents> is the maximum number of events which will be
4039 queued up between calls to C<guestfs_inotify_read> or
4040 C<guestfs_inotify_files>.
4041 If this is passed as C<0>, then the kernel (or previously set)
4042 default is used.  For Linux 2.6.29 the default was 16384 events.
4043 Beyond this limit, the kernel throws away events, but records
4044 the fact that it threw them away by setting a flag
4045 C<IN_Q_OVERFLOW> in the returned structure list (see
4046 C<guestfs_inotify_read>).
4047
4048 Before any events are generated, you have to add some
4049 watches to the internal watch list.  See:
4050 C<guestfs_inotify_add_watch>,
4051 C<guestfs_inotify_rm_watch> and
4052 C<guestfs_inotify_watch_all>.
4053
4054 Queued up events should be read periodically by calling
4055 C<guestfs_inotify_read>
4056 (or C<guestfs_inotify_files> which is just a helpful
4057 wrapper around C<guestfs_inotify_read>).  If you don't
4058 read the events out often enough then you risk the internal
4059 queue overflowing.
4060
4061 The handle should be closed after use by calling
4062 C<guestfs_inotify_close>.  This also removes any
4063 watches automatically.
4064
4065 See also L<inotify(7)> for an overview of the inotify interface
4066 as exposed by the Linux kernel, which is roughly what we expose
4067 via libguestfs.  Note that there is one global inotify handle
4068 per libguestfs instance.");
4069
4070   ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4071    [InitBasicFS, Always, TestOutputList (
4072       [["inotify_init"; "0"];
4073        ["inotify_add_watch"; "/"; "1073741823"];
4074        ["touch"; "/a"];
4075        ["touch"; "/b"];
4076        ["inotify_files"]], ["a"; "b"])],
4077    "add an inotify watch",
4078    "\
4079 Watch C<path> for the events listed in C<mask>.
4080
4081 Note that if C<path> is a directory then events within that
4082 directory are watched, but this does I<not> happen recursively
4083 (in subdirectories).
4084
4085 Note for non-C or non-Linux callers: the inotify events are
4086 defined by the Linux kernel ABI and are listed in
4087 C</usr/include/sys/inotify.h>.");
4088
4089   ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4090    [],
4091    "remove an inotify watch",
4092    "\
4093 Remove a previously defined inotify watch.
4094 See C<guestfs_inotify_add_watch>.");
4095
4096   ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4097    [],
4098    "return list of inotify events",
4099    "\
4100 Return the complete queue of events that have happened
4101 since the previous read call.
4102
4103 If no events have happened, this returns an empty list.
4104
4105 I<Note>: In order to make sure that all events have been
4106 read, you must call this function repeatedly until it
4107 returns an empty list.  The reason is that the call will
4108 read events up to the maximum appliance-to-host message
4109 size and leave remaining events in the queue.");
4110
4111   ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4112    [],
4113    "return list of watched files that had events",
4114    "\
4115 This function is a helpful wrapper around C<guestfs_inotify_read>
4116 which just returns a list of pathnames of objects that were
4117 touched.  The returned pathnames are sorted and deduplicated.");
4118
4119   ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4120    [],
4121    "close the inotify handle",
4122    "\
4123 This closes the inotify handle which was previously
4124 opened by inotify_init.  It removes all watches, throws
4125 away any pending events, and deallocates all resources.");
4126
4127   ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4128    [],
4129    "set SELinux security context",
4130    "\
4131 This sets the SELinux security context of the daemon
4132 to the string C<context>.
4133
4134 See the documentation about SELINUX in L<guestfs(3)>.");
4135
4136   ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4137    [],
4138    "get SELinux security context",
4139    "\
4140 This gets the SELinux security context of the daemon.
4141
4142 See the documentation about SELINUX in L<guestfs(3)>,
4143 and C<guestfs_setcon>");
4144
4145   ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [],
4146    [InitEmpty, Always, TestOutput (
4147       [["part_disk"; "/dev/sda"; "mbr"];
4148        ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4149        ["mount_options"; ""; "/dev/sda1"; "/"];
4150        ["write"; "/new"; "new file contents"];
4151        ["cat"; "/new"]], "new file contents");
4152     InitEmpty, Always, TestRun (
4153       [["part_disk"; "/dev/sda"; "mbr"];
4154        ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4155     InitEmpty, Always, TestLastFail (
4156       [["part_disk"; "/dev/sda"; "mbr"];
4157        ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4158     InitEmpty, Always, TestLastFail (
4159       [["part_disk"; "/dev/sda"; "mbr"];
4160        ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4161     InitEmpty, IfAvailable "ntfsprogs", TestRun (
4162       [["part_disk"; "/dev/sda"; "mbr"];
4163        ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4164    "make a filesystem with block size",
4165    "\
4166 This call is similar to C<guestfs_mkfs>, but it allows you to
4167 control the block size of the resulting filesystem.  Supported
4168 block sizes depend on the filesystem type, but typically they
4169 are C<1024>, C<2048> or C<4096> only.
4170
4171 For VFAT and NTFS the C<blocksize> parameter is treated as
4172 the requested cluster size.");
4173
4174   ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4175    [InitEmpty, Always, TestOutput (
4176       [["part_init"; "/dev/sda"; "mbr"];
4177        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4178        ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4179        ["mke2journal"; "4096"; "/dev/sda1"];
4180        ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4181        ["mount_options"; ""; "/dev/sda2"; "/"];
4182        ["write"; "/new"; "new file contents"];
4183        ["cat"; "/new"]], "new file contents")],
4184    "make ext2/3/4 external journal",
4185    "\
4186 This creates an ext2 external journal on C<device>.  It is equivalent
4187 to the command:
4188
4189  mke2fs -O journal_dev -b blocksize device");
4190
4191   ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4192    [InitEmpty, Always, TestOutput (
4193       [["part_init"; "/dev/sda"; "mbr"];
4194        ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4195        ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4196        ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4197        ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4198        ["mount_options"; ""; "/dev/sda2"; "/"];