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