Add a build test for the 'umask' command.
[libguestfs.git] / src / generator.ml
1 #!/usr/bin/env ocaml
2 (* libguestfs
3  * Copyright (C) 2009-2010 Red Hat Inc.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  *)
19
20 (* This script generates a large amount of code and documentation for
21  * all the daemon actions.
22  *
23  * To add a new action there are only two files you need to change,
24  * this one to describe the interface (see the big table of
25  * 'daemon_functions' below), and daemon/<somefile>.c to write the
26  * implementation.
27  *
28  * After editing this file, run it (./src/generator.ml) to regenerate
29  * all the output files.  'make' will rerun this automatically when
30  * necessary.  Note that if you are using a separate build directory
31  * you must run generator.ml from the _source_ directory.
32  *
33  * IMPORTANT: This script should NOT print any warnings.  If it prints
34  * warnings, you should treat them as errors.
35  *
36  * OCaml tips:
37  * (1) In emacs, install tuareg-mode to display and format OCaml code
38  * correctly.  'vim' comes with a good OCaml editing mode by default.
39  * (2) Read the resources at http://ocaml-tutorial.org/
40  *)
41
42 #load "unix.cma";;
43 #load "str.cma";;
44 #directory "+xml-light";;
45 #directory "+../pkg-lib/xml-light";; (* for GODI users *)
46 #load "xml-light.cma";;
47
48 open Unix
49 open Printf
50
51 type style = ret * args
52 and ret =
53     (* "RErr" as a return value means an int used as a simple error
54      * indication, ie. 0 or -1.
55      *)
56   | RErr
57
58     (* "RInt" as a return value means an int which is -1 for error
59      * or any value >= 0 on success.  Only use this for smallish
60      * positive ints (0 <= i < 2^30).
61      *)
62   | RInt of string
63
64     (* "RInt64" is the same as RInt, but is guaranteed to be able
65      * to return a full 64 bit value, _except_ that -1 means error
66      * (so -1 cannot be a valid, non-error return value).
67      *)
68   | RInt64 of string
69
70     (* "RBool" is a bool return value which can be true/false or
71      * -1 for error.
72      *)
73   | RBool of string
74
75     (* "RConstString" is a string that refers to a constant value.
76      * The return value must NOT be NULL (since NULL indicates
77      * an error).
78      *
79      * Try to avoid using this.  In particular you cannot use this
80      * for values returned from the daemon, because there is no
81      * thread-safe way to return them in the C API.
82      *)
83   | RConstString of string
84
85     (* "RConstOptString" is an even more broken version of
86      * "RConstString".  The returned string may be NULL and there
87      * is no way to return an error indication.  Avoid using this!
88      *)
89   | RConstOptString of string
90
91     (* "RString" is a returned string.  It must NOT be NULL, since
92      * a NULL return indicates an error.  The caller frees this.
93      *)
94   | RString of string
95
96     (* "RStringList" is a list of strings.  No string in the list
97      * can be NULL.  The caller frees the strings and the array.
98      *)
99   | RStringList of string
100
101     (* "RStruct" is a function which returns a single named structure
102      * or an error indication (in C, a struct, and in other languages
103      * with varying representations, but usually very efficient).  See
104      * after the function list below for the structures.
105      *)
106   | RStruct of string * string          (* name of retval, name of struct *)
107
108     (* "RStructList" is a function which returns either a list/array
109      * of structures (could be zero-length), or an error indication.
110      *)
111   | RStructList of string * string      (* name of retval, name of struct *)
112
113     (* Key-value pairs of untyped strings.  Turns into a hashtable or
114      * dictionary in languages which support it.  DON'T use this as a
115      * general "bucket" for results.  Prefer a stronger typed return
116      * value if one is available, or write a custom struct.  Don't use
117      * this if the list could potentially be very long, since it is
118      * inefficient.  Keys should be unique.  NULLs are not permitted.
119      *)
120   | RHashtable of string
121
122     (* "RBufferOut" is handled almost exactly like RString, but
123      * it allows the string to contain arbitrary 8 bit data including
124      * ASCII NUL.  In the C API this causes an implicit extra parameter
125      * to be added of type <size_t *size_r>.  The extra parameter
126      * returns the actual size of the return buffer in bytes.
127      *
128      * Other programming languages support strings with arbitrary 8 bit
129      * data.
130      *
131      * At the RPC layer we have to use the opaque<> type instead of
132      * string<>.  Returned data is still limited to the max message
133      * size (ie. ~ 2 MB).
134      *)
135   | RBufferOut of string
136
137 and args = argt list    (* Function parameters, guestfs handle is implicit. *)
138
139     (* Note in future we should allow a "variable args" parameter as
140      * the final parameter, to allow commands like
141      *   chmod mode file [file(s)...]
142      * This is not implemented yet, but many commands (such as chmod)
143      * are currently defined with the argument order keeping this future
144      * possibility in mind.
145      *)
146 and argt =
147   | String of string    (* const char *name, cannot be NULL *)
148   | Device of string    (* /dev device name, cannot be NULL *)
149   | Pathname of string  (* file name, cannot be NULL *)
150   | Dev_or_Path of string (* /dev device name or Pathname, cannot be NULL *)
151   | OptString of string (* const char *name, may be NULL *)
152   | StringList of string(* list of strings (each string cannot be NULL) *)
153   | DeviceList of string(* list of Device names (each cannot be NULL) *)
154   | Bool of string      (* boolean *)
155   | Int of string       (* int (smallish ints, signed, <= 31 bits) *)
156   | Int64 of string     (* any 64 bit int *)
157     (* These are treated as filenames (simple string parameters) in
158      * the C API and bindings.  But in the RPC protocol, we transfer
159      * the actual file content up to or down from the daemon.
160      * FileIn: local machine -> daemon (in request)
161      * FileOut: daemon -> local machine (in reply)
162      * In guestfish (only), the special name "-" means read from
163      * stdin or write to stdout.
164      *)
165   | FileIn of string
166   | FileOut of string
167 (* Not implemented:
168     (* Opaque buffer which can contain arbitrary 8 bit data.
169      * In the C API, this is expressed as <char *, int> pair.
170      * Most other languages have a string type which can contain
171      * ASCII NUL.  We use whatever type is appropriate for each
172      * language.
173      * Buffers are limited by the total message size.  To transfer
174      * large blocks of data, use FileIn/FileOut parameters instead.
175      * To return an arbitrary buffer, use RBufferOut.
176      *)
177   | BufferIn of string
178 *)
179
180 type flags =
181   | ProtocolLimitWarning  (* display warning about protocol size limits *)
182   | DangerWillRobinson    (* flags particularly dangerous commands *)
183   | FishAlias of string   (* provide an alias for this cmd in guestfish *)
184   | FishAction of string  (* call this function in guestfish *)
185   | FishOutput of fish_output_t (* how to display output in guestfish *)
186   | NotInFish             (* do not export via guestfish *)
187   | NotInDocs             (* do not add this function to documentation *)
188   | DeprecatedBy of string (* function is deprecated, use .. instead *)
189   | Optional of string    (* function is part of an optional group *)
190
191 and fish_output_t =
192   | FishOutputOctal       (* for int return, print in octal *)
193   | FishOutputHexadecimal (* for int return, print in hex *)
194
195 (* You can supply zero or as many tests as you want per API call.
196  *
197  * Note that the test environment has 3 block devices, of size 500MB,
198  * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
199  * a fourth ISO block device with some known files on it (/dev/sdd).
200  *
201  * Note for partitioning purposes, the 500MB device has 1015 cylinders.
202  * Number of cylinders was 63 for IDE emulated disks with precisely
203  * the same size.  How exactly this is calculated is a mystery.
204  *
205  * The ISO block device (/dev/sdd) comes from images/test.iso.
206  *
207  * To be able to run the tests in a reasonable amount of time,
208  * the virtual machine and block devices are reused between tests.
209  * So don't try testing kill_subprocess :-x
210  *
211  * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
212  *
213  * Don't assume anything about the previous contents of the block
214  * devices.  Use 'Init*' to create some initial scenarios.
215  *
216  * You can add a prerequisite clause to any individual test.  This
217  * is a run-time check, which, if it fails, causes the test to be
218  * skipped.  Useful if testing a command which might not work on
219  * all variations of libguestfs builds.  A test that has prerequisite
220  * of 'Always' is run unconditionally.
221  *
222  * In addition, packagers can skip individual tests by setting the
223  * environment variables:     eg:
224  *   SKIP_TEST_<CMD>_<NUM>=1  SKIP_TEST_COMMAND_3=1  (skips test #3 of command)
225  *   SKIP_TEST_<CMD>=1        SKIP_TEST_ZEROFREE=1   (skips all zerofree tests)
226  *)
227 type tests = (test_init * test_prereq * test) list
228 and test =
229     (* Run the command sequence and just expect nothing to fail. *)
230   | TestRun of seq
231
232     (* Run the command sequence and expect the output of the final
233      * command to be the string.
234      *)
235   | TestOutput of seq * string
236
237     (* Run the command sequence and expect the output of the final
238      * command to be the list of strings.
239      *)
240   | TestOutputList of seq * string list
241
242     (* Run the command sequence and expect the output of the final
243      * command to be the list of block devices (could be either
244      * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
245      * character of each string).
246      *)
247   | TestOutputListOfDevices of seq * string list
248
249     (* Run the command sequence and expect the output of the final
250      * command to be the integer.
251      *)
252   | TestOutputInt of seq * int
253
254     (* Run the command sequence and expect the output of the final
255      * command to be <op> <int>, eg. ">=", "1".
256      *)
257   | TestOutputIntOp of seq * string * int
258
259     (* Run the command sequence and expect the output of the final
260      * command to be a true value (!= 0 or != NULL).
261      *)
262   | TestOutputTrue of seq
263
264     (* Run the command sequence and expect the output of the final
265      * command to be a false value (== 0 or == NULL, but not an error).
266      *)
267   | TestOutputFalse of seq
268
269     (* Run the command sequence and expect the output of the final
270      * command to be a list of the given length (but don't care about
271      * content).
272      *)
273   | TestOutputLength of seq * int
274
275     (* Run the command sequence and expect the output of the final
276      * command to be a buffer (RBufferOut), ie. string + size.
277      *)
278   | TestOutputBuffer of seq * string
279
280     (* Run the command sequence and expect the output of the final
281      * command to be a structure.
282      *)
283   | TestOutputStruct of seq * test_field_compare list
284
285     (* Run the command sequence and expect the final command (only)
286      * to fail.
287      *)
288   | TestLastFail of seq
289
290 and test_field_compare =
291   | CompareWithInt of string * int
292   | CompareWithIntOp of string * string * int
293   | CompareWithString of string * string
294   | CompareFieldsIntEq of string * string
295   | CompareFieldsStrEq of string * string
296
297 (* Test prerequisites. *)
298 and test_prereq =
299     (* Test always runs. *)
300   | Always
301
302     (* Test is currently disabled - eg. it fails, or it tests some
303      * unimplemented feature.
304      *)
305   | Disabled
306
307     (* 'string' is some C code (a function body) that should return
308      * true or false.  The test will run if the code returns true.
309      *)
310   | If of string
311
312     (* As for 'If' but the test runs _unless_ the code returns true. *)
313   | Unless of string
314
315 (* Some initial scenarios for testing. *)
316 and test_init =
317     (* Do nothing, block devices could contain random stuff including
318      * LVM PVs, and some filesystems might be mounted.  This is usually
319      * a bad idea.
320      *)
321   | InitNone
322
323     (* Block devices are empty and no filesystems are mounted. *)
324   | InitEmpty
325
326     (* /dev/sda contains a single partition /dev/sda1, with random
327      * content.  /dev/sdb and /dev/sdc may have random content.
328      * No LVM.
329      *)
330   | InitPartition
331
332     (* /dev/sda contains a single partition /dev/sda1, which is formatted
333      * as ext2, empty [except for lost+found] and mounted on /.
334      * /dev/sdb and /dev/sdc may have random content.
335      * No LVM.
336      *)
337   | InitBasicFS
338
339     (* /dev/sda:
340      *   /dev/sda1 (is a PV):
341      *     /dev/VG/LV (size 8MB):
342      *       formatted as ext2, empty [except for lost+found], mounted on /
343      * /dev/sdb and /dev/sdc may have random content.
344      *)
345   | InitBasicFSonLVM
346
347     (* /dev/sdd (the ISO, see images/ directory in source)
348      * is mounted on /
349      *)
350   | InitISOFS
351
352 (* Sequence of commands for testing. *)
353 and seq = cmd list
354 and cmd = string list
355
356 (* Note about long descriptions: When referring to another
357  * action, use the format C<guestfs_other> (ie. the full name of
358  * the C function).  This will be replaced as appropriate in other
359  * language bindings.
360  *
361  * Apart from that, long descriptions are just perldoc paragraphs.
362  *)
363
364 (* Generate a random UUID (used in tests). *)
365 let uuidgen () =
366   let chan = open_process_in "uuidgen" in
367   let uuid = input_line chan in
368   (match close_process_in chan with
369    | WEXITED 0 -> ()
370    | WEXITED _ ->
371        failwith "uuidgen: process exited with non-zero status"
372    | WSIGNALED _ | WSTOPPED _ ->
373        failwith "uuidgen: process signalled or stopped by signal"
374   );
375   uuid
376
377 (* These test functions are used in the language binding tests. *)
378
379 let test_all_args = [
380   String "str";
381   OptString "optstr";
382   StringList "strlist";
383   Bool "b";
384   Int "integer";
385   Int64 "integer64";
386   FileIn "filein";
387   FileOut "fileout";
388 ]
389
390 let test_all_rets = [
391   (* except for RErr, which is tested thoroughly elsewhere *)
392   "test0rint",         RInt "valout";
393   "test0rint64",       RInt64 "valout";
394   "test0rbool",        RBool "valout";
395   "test0rconststring", RConstString "valout";
396   "test0rconstoptstring", RConstOptString "valout";
397   "test0rstring",      RString "valout";
398   "test0rstringlist",  RStringList "valout";
399   "test0rstruct",      RStruct ("valout", "lvm_pv");
400   "test0rstructlist",  RStructList ("valout", "lvm_pv");
401   "test0rhashtable",   RHashtable "valout";
402 ]
403
404 let test_functions = [
405   ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
406    [],
407    "internal test function - do not use",
408    "\
409 This is an internal test function which is used to test whether
410 the automatically generated bindings can handle every possible
411 parameter type correctly.
412
413 It echos the contents of each parameter to stdout.
414
415 You probably don't want to call this function.");
416 ] @ List.flatten (
417   List.map (
418     fun (name, ret) ->
419       [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
420         [],
421         "internal test function - do not use",
422         "\
423 This is an internal test function which is used to test whether
424 the automatically generated bindings can handle every possible
425 return type correctly.
426
427 It converts string C<val> to the return type.
428
429 You probably don't want to call this function.");
430        (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
431         [],
432         "internal test function - do not use",
433         "\
434 This is an internal test function which is used to test whether
435 the automatically generated bindings can handle every possible
436 return type correctly.
437
438 This function always returns an error.
439
440 You probably don't want to call this function.")]
441   ) test_all_rets
442 )
443
444 (* non_daemon_functions are any functions which don't get processed
445  * in the daemon, eg. functions for setting and getting local
446  * configuration values.
447  *)
448
449 let non_daemon_functions = test_functions @ [
450   ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
451    [],
452    "launch the qemu subprocess",
453    "\
454 Internally libguestfs is implemented by running a virtual machine
455 using L<qemu(1)>.
456
457 You should call this after configuring the handle
458 (eg. adding drives) but before performing any actions.");
459
460   ("wait_ready", (RErr, []), -1, [NotInFish],
461    [],
462    "wait until the qemu subprocess launches (no op)",
463    "\
464 This function is a no op.
465
466 In versions of the API E<lt> 1.0.71 you had to call this function
467 just after calling C<guestfs_launch> to wait for the launch
468 to complete.  However this is no longer necessary because
469 C<guestfs_launch> now does the waiting.
470
471 If you see any calls to this function in code then you can just
472 remove them, unless you want to retain compatibility with older
473 versions of the API.");
474
475   ("kill_subprocess", (RErr, []), -1, [],
476    [],
477    "kill the qemu subprocess",
478    "\
479 This kills the qemu subprocess.  You should never need to call this.");
480
481   ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
482    [],
483    "add an image to examine or modify",
484    "\
485 This function adds a virtual machine disk image C<filename> to the
486 guest.  The first time you call this function, the disk appears as IDE
487 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
488 so on.
489
490 You don't necessarily need to be root when using libguestfs.  However
491 you obviously do need sufficient permissions to access the filename
492 for whatever operations you want to perform (ie. read access if you
493 just want to read the image or write access if you want to modify the
494 image).
495
496 This is equivalent to the qemu parameter
497 C<-drive file=filename,cache=off,if=...>.
498
499 C<cache=off> is omitted in cases where it is not supported by
500 the underlying filesystem.
501
502 C<if=...> is set at compile time by the configuration option
503 C<./configure --with-drive-if=...>.  In the rare case where you
504 might need to change this at run time, use C<guestfs_add_drive_with_if>
505 or C<guestfs_add_drive_ro_with_if>.
506
507 Note that this call checks for the existence of C<filename>.  This
508 stops you from specifying other types of drive which are supported
509 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
510 the general C<guestfs_config> call instead.");
511
512   ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
513    [],
514    "add a CD-ROM disk image to examine",
515    "\
516 This function adds a virtual CD-ROM disk image to the guest.
517
518 This is equivalent to the qemu parameter C<-cdrom filename>.
519
520 Notes:
521
522 =over 4
523
524 =item *
525
526 This call checks for the existence of C<filename>.  This
527 stops you from specifying other types of drive which are supported
528 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
529 the general C<guestfs_config> call instead.
530
531 =item *
532
533 If you just want to add an ISO file (often you use this as an
534 efficient way to transfer large files into the guest), then you
535 should probably use C<guestfs_add_drive_ro> instead.
536
537 =back");
538
539   ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
540    [],
541    "add a drive in snapshot mode (read-only)",
542    "\
543 This adds a drive in snapshot mode, making it effectively
544 read-only.
545
546 Note that writes to the device are allowed, and will be seen for
547 the duration of the guestfs handle, but they are written
548 to a temporary file which is discarded as soon as the guestfs
549 handle is closed.  We don't currently have any method to enable
550 changes to be committed, although qemu can support this.
551
552 This is equivalent to the qemu parameter
553 C<-drive file=filename,snapshot=on,readonly=on,if=...>.
554
555 C<if=...> is set at compile time by the configuration option
556 C<./configure --with-drive-if=...>.  In the rare case where you
557 might need to change this at run time, use C<guestfs_add_drive_with_if>
558 or C<guestfs_add_drive_ro_with_if>.
559
560 C<readonly=on> is only added where qemu supports this option.
561
562 Note that this call checks for the existence of C<filename>.  This
563 stops you from specifying other types of drive which are supported
564 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
565 the general C<guestfs_config> call instead.");
566
567   ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
568    [],
569    "add qemu parameters",
570    "\
571 This can be used to add arbitrary qemu command line parameters
572 of the form C<-param value>.  Actually it's not quite arbitrary - we
573 prevent you from setting some parameters which would interfere with
574 parameters that we use.
575
576 The first character of C<param> string must be a C<-> (dash).
577
578 C<value> can be NULL.");
579
580   ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
581    [],
582    "set the qemu binary",
583    "\
584 Set the qemu binary that we will use.
585
586 The default is chosen when the library was compiled by the
587 configure script.
588
589 You can also override this by setting the C<LIBGUESTFS_QEMU>
590 environment variable.
591
592 Setting C<qemu> to C<NULL> restores the default qemu binary.
593
594 Note that you should call this function as early as possible
595 after creating the handle.  This is because some pre-launch
596 operations depend on testing qemu features (by running C<qemu -help>).
597 If the qemu binary changes, we don't retest features, and
598 so you might see inconsistent results.  Using the environment
599 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
600 the qemu binary at the same time as the handle is created.");
601
602   ("get_qemu", (RConstString "qemu", []), -1, [],
603    [InitNone, Always, TestRun (
604       [["get_qemu"]])],
605    "get the qemu binary",
606    "\
607 Return the current qemu binary.
608
609 This is always non-NULL.  If it wasn't set already, then this will
610 return the default qemu binary name.");
611
612   ("set_path", (RErr, [String "searchpath"]), -1, [FishAlias "path"],
613    [],
614    "set the search path",
615    "\
616 Set the path that libguestfs searches for kernel and initrd.img.
617
618 The default is C<$libdir/guestfs> unless overridden by setting
619 C<LIBGUESTFS_PATH> environment variable.
620
621 Setting C<path> to C<NULL> restores the default path.");
622
623   ("get_path", (RConstString "path", []), -1, [],
624    [InitNone, Always, TestRun (
625       [["get_path"]])],
626    "get the search path",
627    "\
628 Return the current search path.
629
630 This is always non-NULL.  If it wasn't set already, then this will
631 return the default path.");
632
633   ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
634    [],
635    "add options to kernel command line",
636    "\
637 This function is used to add additional options to the
638 guest kernel command line.
639
640 The default is C<NULL> unless overridden by setting
641 C<LIBGUESTFS_APPEND> environment variable.
642
643 Setting C<append> to C<NULL> means I<no> additional options
644 are passed (libguestfs always adds a few of its own).");
645
646   ("get_append", (RConstOptString "append", []), -1, [],
647    (* This cannot be tested with the current framework.  The
648     * function can return NULL in normal operations, which the
649     * test framework interprets as an error.
650     *)
651    [],
652    "get the additional kernel options",
653    "\
654 Return the additional kernel options which are added to the
655 guest kernel command line.
656
657 If C<NULL> then no options are added.");
658
659   ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
660    [],
661    "set autosync mode",
662    "\
663 If C<autosync> is true, this enables autosync.  Libguestfs will make a
664 best effort attempt to run C<guestfs_umount_all> followed by
665 C<guestfs_sync> when the handle is closed
666 (also if the program exits without closing handles).
667
668 This is disabled by default (except in guestfish where it is
669 enabled by default).");
670
671   ("get_autosync", (RBool "autosync", []), -1, [],
672    [InitNone, Always, TestRun (
673       [["get_autosync"]])],
674    "get autosync mode",
675    "\
676 Get the autosync flag.");
677
678   ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
679    [],
680    "set verbose mode",
681    "\
682 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
683
684 Verbose messages are disabled unless the environment variable
685 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
686
687   ("get_verbose", (RBool "verbose", []), -1, [],
688    [],
689    "get verbose mode",
690    "\
691 This returns the verbose messages flag.");
692
693   ("is_ready", (RBool "ready", []), -1, [],
694    [InitNone, Always, TestOutputTrue (
695       [["is_ready"]])],
696    "is ready to accept commands",
697    "\
698 This returns true iff this handle is ready to accept commands
699 (in the C<READY> state).
700
701 For more information on states, see L<guestfs(3)>.");
702
703   ("is_config", (RBool "config", []), -1, [],
704    [InitNone, Always, TestOutputFalse (
705       [["is_config"]])],
706    "is in configuration state",
707    "\
708 This returns true iff this handle is being configured
709 (in the C<CONFIG> state).
710
711 For more information on states, see L<guestfs(3)>.");
712
713   ("is_launching", (RBool "launching", []), -1, [],
714    [InitNone, Always, TestOutputFalse (
715       [["is_launching"]])],
716    "is launching subprocess",
717    "\
718 This returns true iff this handle is launching the subprocess
719 (in the C<LAUNCHING> state).
720
721 For more information on states, see L<guestfs(3)>.");
722
723   ("is_busy", (RBool "busy", []), -1, [],
724    [InitNone, Always, TestOutputFalse (
725       [["is_busy"]])],
726    "is busy processing a command",
727    "\
728 This returns true iff this handle is busy processing a command
729 (in the C<BUSY> state).
730
731 For more information on states, see L<guestfs(3)>.");
732
733   ("get_state", (RInt "state", []), -1, [],
734    [],
735    "get the current state",
736    "\
737 This returns the current state as an opaque integer.  This is
738 only useful for printing debug and internal error messages.
739
740 For more information on states, see L<guestfs(3)>.");
741
742   ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
743    [InitNone, Always, TestOutputInt (
744       [["set_memsize"; "500"];
745        ["get_memsize"]], 500)],
746    "set memory allocated to the qemu subprocess",
747    "\
748 This sets the memory size in megabytes allocated to the
749 qemu subprocess.  This only has any effect if called before
750 C<guestfs_launch>.
751
752 You can also change this by setting the environment
753 variable C<LIBGUESTFS_MEMSIZE> before the handle is
754 created.
755
756 For more information on the architecture of libguestfs,
757 see L<guestfs(3)>.");
758
759   ("get_memsize", (RInt "memsize", []), -1, [],
760    [InitNone, Always, TestOutputIntOp (
761       [["get_memsize"]], ">=", 256)],
762    "get memory allocated to the qemu subprocess",
763    "\
764 This gets the memory size in megabytes allocated to the
765 qemu subprocess.
766
767 If C<guestfs_set_memsize> was not called
768 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
769 then this returns the compiled-in default value for memsize.
770
771 For more information on the architecture of libguestfs,
772 see L<guestfs(3)>.");
773
774   ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
775    [InitNone, Always, TestOutputIntOp (
776       [["get_pid"]], ">=", 1)],
777    "get PID of qemu subprocess",
778    "\
779 Return the process ID of the qemu subprocess.  If there is no
780 qemu subprocess, then this will return an error.
781
782 This is an internal call used for debugging and testing.");
783
784   ("version", (RStruct ("version", "version"), []), -1, [],
785    [InitNone, Always, TestOutputStruct (
786       [["version"]], [CompareWithInt ("major", 1)])],
787    "get the library version number",
788    "\
789 Return the libguestfs version number that the program is linked
790 against.
791
792 Note that because of dynamic linking this is not necessarily
793 the version of libguestfs that you compiled against.  You can
794 compile the program, and then at runtime dynamically link
795 against a completely different C<libguestfs.so> library.
796
797 This call was added in version C<1.0.58>.  In previous
798 versions of libguestfs there was no way to get the version
799 number.  From C code you can use ELF weak linking tricks to find out if
800 this symbol exists (if it doesn't, then it's an earlier version).
801
802 The call returns a structure with four elements.  The first
803 three (C<major>, C<minor> and C<release>) are numbers and
804 correspond to the usual version triplet.  The fourth element
805 (C<extra>) is a string and is normally empty, but may be
806 used for distro-specific information.
807
808 To construct the original version string:
809 C<$major.$minor.$release$extra>
810
811 I<Note:> Don't use this call to test for availability
812 of features.  Distro backports makes this unreliable.  Use
813 C<guestfs_available> instead.");
814
815   ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
816    [InitNone, Always, TestOutputTrue (
817       [["set_selinux"; "true"];
818        ["get_selinux"]])],
819    "set SELinux enabled or disabled at appliance boot",
820    "\
821 This sets the selinux flag that is passed to the appliance
822 at boot time.  The default is C<selinux=0> (disabled).
823
824 Note that if SELinux is enabled, it is always in
825 Permissive mode (C<enforcing=0>).
826
827 For more information on the architecture of libguestfs,
828 see L<guestfs(3)>.");
829
830   ("get_selinux", (RBool "selinux", []), -1, [],
831    [],
832    "get SELinux enabled flag",
833    "\
834 This returns the current setting of the selinux flag which
835 is passed to the appliance at boot time.  See C<guestfs_set_selinux>.
836
837 For more information on the architecture of libguestfs,
838 see L<guestfs(3)>.");
839
840   ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
841    [InitNone, Always, TestOutputFalse (
842       [["set_trace"; "false"];
843        ["get_trace"]])],
844    "enable or disable command traces",
845    "\
846 If the command trace flag is set to 1, then commands are
847 printed on stdout before they are executed in a format
848 which is very similar to the one used by guestfish.  In
849 other words, you can run a program with this enabled, and
850 you will get out a script which you can feed to guestfish
851 to perform the same set of actions.
852
853 If you want to trace C API calls into libguestfs (and
854 other libraries) then possibly a better way is to use
855 the external ltrace(1) command.
856
857 Command traces are disabled unless the environment variable
858 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
859
860   ("get_trace", (RBool "trace", []), -1, [],
861    [],
862    "get command trace enabled flag",
863    "\
864 Return the command trace flag.");
865
866   ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
867    [InitNone, Always, TestOutputFalse (
868       [["set_direct"; "false"];
869        ["get_direct"]])],
870    "enable or disable direct appliance mode",
871    "\
872 If the direct appliance mode flag is enabled, then stdin and
873 stdout are passed directly through to the appliance once it
874 is launched.
875
876 One consequence of this is that log messages aren't caught
877 by the library and handled by C<guestfs_set_log_message_callback>,
878 but go straight to stdout.
879
880 You probably don't want to use this unless you know what you
881 are doing.
882
883 The default is disabled.");
884
885   ("get_direct", (RBool "direct", []), -1, [],
886    [],
887    "get direct appliance mode flag",
888    "\
889 Return the direct appliance mode flag.");
890
891   ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
892    [InitNone, Always, TestOutputTrue (
893       [["set_recovery_proc"; "true"];
894        ["get_recovery_proc"]])],
895    "enable or disable the recovery process",
896    "\
897 If this is called with the parameter C<false> then
898 C<guestfs_launch> does not create a recovery process.  The
899 purpose of the recovery process is to stop runaway qemu
900 processes in the case where the main program aborts abruptly.
901
902 This only has any effect if called before C<guestfs_launch>,
903 and the default is true.
904
905 About the only time when you would want to disable this is
906 if the main process will fork itself into the background
907 (\"daemonize\" itself).  In this case the recovery process
908 thinks that the main program has disappeared and so kills
909 qemu, which is not very helpful.");
910
911   ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
912    [],
913    "get recovery process enabled flag",
914    "\
915 Return the recovery process enabled flag.");
916
917   ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
918    [],
919    "add a drive specifying the QEMU block emulation to use",
920    "\
921 This is the same as C<guestfs_add_drive> but it allows you
922 to specify the QEMU interface emulation to use at run time.");
923
924   ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
925    [],
926    "add a drive read-only specifying the QEMU block emulation to use",
927    "\
928 This is the same as C<guestfs_add_drive_ro> but it allows you
929 to specify the QEMU interface emulation to use at run time.");
930
931 ]
932
933 (* daemon_functions are any functions which cause some action
934  * to take place in the daemon.
935  *)
936
937 let daemon_functions = [
938   ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
939    [InitEmpty, Always, TestOutput (
940       [["part_disk"; "/dev/sda"; "mbr"];
941        ["mkfs"; "ext2"; "/dev/sda1"];
942        ["mount"; "/dev/sda1"; "/"];
943        ["write_file"; "/new"; "new file contents"; "0"];
944        ["cat"; "/new"]], "new file contents")],
945    "mount a guest disk at a position in the filesystem",
946    "\
947 Mount a guest disk at a position in the filesystem.  Block devices
948 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
949 the guest.  If those block devices contain partitions, they will have
950 the usual names (eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style
951 names can be used.
952
953 The rules are the same as for L<mount(2)>:  A filesystem must
954 first be mounted on C</> before others can be mounted.  Other
955 filesystems can only be mounted on directories which already
956 exist.
957
958 The mounted filesystem is writable, if we have sufficient permissions
959 on the underlying device.
960
961 The filesystem options C<sync> and C<noatime> are set with this
962 call, in order to improve reliability.");
963
964   ("sync", (RErr, []), 2, [],
965    [ InitEmpty, Always, TestRun [["sync"]]],
966    "sync disks, writes are flushed through to the disk image",
967    "\
968 This syncs the disk, so that any writes are flushed through to the
969 underlying disk image.
970
971 You should always call this if you have modified a disk image, before
972 closing the handle.");
973
974   ("touch", (RErr, [Pathname "path"]), 3, [],
975    [InitBasicFS, Always, TestOutputTrue (
976       [["touch"; "/new"];
977        ["exists"; "/new"]])],
978    "update file timestamps or create a new file",
979    "\
980 Touch acts like the L<touch(1)> command.  It can be used to
981 update the timestamps on a file, or, if the file does not exist,
982 to create a new zero-length file.");
983
984   ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
985    [InitISOFS, Always, TestOutput (
986       [["cat"; "/known-2"]], "abcdef\n")],
987    "list the contents of a file",
988    "\
989 Return the contents of the file named C<path>.
990
991 Note that this function cannot correctly handle binary files
992 (specifically, files containing C<\\0> character which is treated
993 as end of string).  For those you need to use the C<guestfs_read_file>
994 or C<guestfs_download> functions which have a more complex interface.");
995
996   ("ll", (RString "listing", [Pathname "directory"]), 5, [],
997    [], (* XXX Tricky to test because it depends on the exact format
998         * of the 'ls -l' command, which changes between F10 and F11.
999         *)
1000    "list the files in a directory (long format)",
1001    "\
1002 List the files in C<directory> (relative to the root directory,
1003 there is no cwd) in the format of 'ls -la'.
1004
1005 This command is mostly useful for interactive sessions.  It
1006 is I<not> intended that you try to parse the output string.");
1007
1008   ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1009    [InitBasicFS, Always, TestOutputList (
1010       [["touch"; "/new"];
1011        ["touch"; "/newer"];
1012        ["touch"; "/newest"];
1013        ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1014    "list the files in a directory",
1015    "\
1016 List the files in C<directory> (relative to the root directory,
1017 there is no cwd).  The '.' and '..' entries are not returned, but
1018 hidden files are shown.
1019
1020 This command is mostly useful for interactive sessions.  Programs
1021 should probably use C<guestfs_readdir> instead.");
1022
1023   ("list_devices", (RStringList "devices", []), 7, [],
1024    [InitEmpty, Always, TestOutputListOfDevices (
1025       [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1026    "list the block devices",
1027    "\
1028 List all the block devices.
1029
1030 The full block device names are returned, eg. C</dev/sda>");
1031
1032   ("list_partitions", (RStringList "partitions", []), 8, [],
1033    [InitBasicFS, Always, TestOutputListOfDevices (
1034       [["list_partitions"]], ["/dev/sda1"]);
1035     InitEmpty, Always, TestOutputListOfDevices (
1036       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1037        ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1038    "list the partitions",
1039    "\
1040 List all the partitions detected on all block devices.
1041
1042 The full partition device names are returned, eg. C</dev/sda1>
1043
1044 This does not return logical volumes.  For that you will need to
1045 call C<guestfs_lvs>.");
1046
1047   ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1048    [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1049       [["pvs"]], ["/dev/sda1"]);
1050     InitEmpty, Always, TestOutputListOfDevices (
1051       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1052        ["pvcreate"; "/dev/sda1"];
1053        ["pvcreate"; "/dev/sda2"];
1054        ["pvcreate"; "/dev/sda3"];
1055        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1056    "list the LVM physical volumes (PVs)",
1057    "\
1058 List all the physical volumes detected.  This is the equivalent
1059 of the L<pvs(8)> command.
1060
1061 This returns a list of just the device names that contain
1062 PVs (eg. C</dev/sda2>).
1063
1064 See also C<guestfs_pvs_full>.");
1065
1066   ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1067    [InitBasicFSonLVM, Always, TestOutputList (
1068       [["vgs"]], ["VG"]);
1069     InitEmpty, Always, TestOutputList (
1070       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1071        ["pvcreate"; "/dev/sda1"];
1072        ["pvcreate"; "/dev/sda2"];
1073        ["pvcreate"; "/dev/sda3"];
1074        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1075        ["vgcreate"; "VG2"; "/dev/sda3"];
1076        ["vgs"]], ["VG1"; "VG2"])],
1077    "list the LVM volume groups (VGs)",
1078    "\
1079 List all the volumes groups detected.  This is the equivalent
1080 of the L<vgs(8)> command.
1081
1082 This returns a list of just the volume group names that were
1083 detected (eg. C<VolGroup00>).
1084
1085 See also C<guestfs_vgs_full>.");
1086
1087   ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1088    [InitBasicFSonLVM, Always, TestOutputList (
1089       [["lvs"]], ["/dev/VG/LV"]);
1090     InitEmpty, Always, TestOutputList (
1091       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1092        ["pvcreate"; "/dev/sda1"];
1093        ["pvcreate"; "/dev/sda2"];
1094        ["pvcreate"; "/dev/sda3"];
1095        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1096        ["vgcreate"; "VG2"; "/dev/sda3"];
1097        ["lvcreate"; "LV1"; "VG1"; "50"];
1098        ["lvcreate"; "LV2"; "VG1"; "50"];
1099        ["lvcreate"; "LV3"; "VG2"; "50"];
1100        ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1101    "list the LVM logical volumes (LVs)",
1102    "\
1103 List all the logical volumes detected.  This is the equivalent
1104 of the L<lvs(8)> command.
1105
1106 This returns a list of the logical volume device names
1107 (eg. C</dev/VolGroup00/LogVol00>).
1108
1109 See also C<guestfs_lvs_full>.");
1110
1111   ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1112    [], (* XXX how to test? *)
1113    "list the LVM physical volumes (PVs)",
1114    "\
1115 List all the physical volumes detected.  This is the equivalent
1116 of the L<pvs(8)> command.  The \"full\" version includes all fields.");
1117
1118   ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1119    [], (* XXX how to test? *)
1120    "list the LVM volume groups (VGs)",
1121    "\
1122 List all the volumes groups detected.  This is the equivalent
1123 of the L<vgs(8)> command.  The \"full\" version includes all fields.");
1124
1125   ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1126    [], (* XXX how to test? *)
1127    "list the LVM logical volumes (LVs)",
1128    "\
1129 List all the logical volumes detected.  This is the equivalent
1130 of the L<lvs(8)> command.  The \"full\" version includes all fields.");
1131
1132   ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1133    [InitISOFS, Always, TestOutputList (
1134       [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1135     InitISOFS, Always, TestOutputList (
1136       [["read_lines"; "/empty"]], [])],
1137    "read file as lines",
1138    "\
1139 Return the contents of the file named C<path>.
1140
1141 The file contents are returned as a list of lines.  Trailing
1142 C<LF> and C<CRLF> character sequences are I<not> returned.
1143
1144 Note that this function cannot correctly handle binary files
1145 (specifically, files containing C<\\0> character which is treated
1146 as end of line).  For those you need to use the C<guestfs_read_file>
1147 function which has a more complex interface.");
1148
1149   ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1150    [], (* XXX Augeas code needs tests. *)
1151    "create a new Augeas handle",
1152    "\
1153 Create a new Augeas handle for editing configuration files.
1154 If there was any previous Augeas handle associated with this
1155 guestfs session, then it is closed.
1156
1157 You must call this before using any other C<guestfs_aug_*>
1158 commands.
1159
1160 C<root> is the filesystem root.  C<root> must not be NULL,
1161 use C</> instead.
1162
1163 The flags are the same as the flags defined in
1164 E<lt>augeas.hE<gt>, the logical I<or> of the following
1165 integers:
1166
1167 =over 4
1168
1169 =item C<AUG_SAVE_BACKUP> = 1
1170
1171 Keep the original file with a C<.augsave> extension.
1172
1173 =item C<AUG_SAVE_NEWFILE> = 2
1174
1175 Save changes into a file with extension C<.augnew>, and
1176 do not overwrite original.  Overrides C<AUG_SAVE_BACKUP>.
1177
1178 =item C<AUG_TYPE_CHECK> = 4
1179
1180 Typecheck lenses (can be expensive).
1181
1182 =item C<AUG_NO_STDINC> = 8
1183
1184 Do not use standard load path for modules.
1185
1186 =item C<AUG_SAVE_NOOP> = 16
1187
1188 Make save a no-op, just record what would have been changed.
1189
1190 =item C<AUG_NO_LOAD> = 32
1191
1192 Do not load the tree in C<guestfs_aug_init>.
1193
1194 =back
1195
1196 To close the handle, you can call C<guestfs_aug_close>.
1197
1198 To find out more about Augeas, see L<http://augeas.net/>.");
1199
1200   ("aug_close", (RErr, []), 26, [Optional "augeas"],
1201    [], (* XXX Augeas code needs tests. *)
1202    "close the current Augeas handle",
1203    "\
1204 Close the current Augeas handle and free up any resources
1205 used by it.  After calling this, you have to call
1206 C<guestfs_aug_init> again before you can use any other
1207 Augeas functions.");
1208
1209   ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1210    [], (* XXX Augeas code needs tests. *)
1211    "define an Augeas variable",
1212    "\
1213 Defines an Augeas variable C<name> whose value is the result
1214 of evaluating C<expr>.  If C<expr> is NULL, then C<name> is
1215 undefined.
1216
1217 On success this returns the number of nodes in C<expr>, or
1218 C<0> if C<expr> evaluates to something which is not a nodeset.");
1219
1220   ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1221    [], (* XXX Augeas code needs tests. *)
1222    "define an Augeas node",
1223    "\
1224 Defines a variable C<name> whose value is the result of
1225 evaluating C<expr>.
1226
1227 If C<expr> evaluates to an empty nodeset, a node is created,
1228 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1229 C<name> will be the nodeset containing that single node.
1230
1231 On success this returns a pair containing the
1232 number of nodes in the nodeset, and a boolean flag
1233 if a node was created.");
1234
1235   ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1236    [], (* XXX Augeas code needs tests. *)
1237    "look up the value of an Augeas path",
1238    "\
1239 Look up the value associated with C<path>.  If C<path>
1240 matches exactly one node, the C<value> is returned.");
1241
1242   ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1243    [], (* XXX Augeas code needs tests. *)
1244    "set Augeas path to value",
1245    "\
1246 Set the value associated with C<path> to C<val>.
1247
1248 In the Augeas API, it is possible to clear a node by setting
1249 the value to NULL.  Due to an oversight in the libguestfs API
1250 you cannot do that with this call.  Instead you must use the
1251 C<guestfs_aug_clear> call.");
1252
1253   ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1254    [], (* XXX Augeas code needs tests. *)
1255    "insert a sibling Augeas node",
1256    "\
1257 Create a new sibling C<label> for C<path>, inserting it into
1258 the tree before or after C<path> (depending on the boolean
1259 flag C<before>).
1260
1261 C<path> must match exactly one existing node in the tree, and
1262 C<label> must be a label, ie. not contain C</>, C<*> or end
1263 with a bracketed index C<[N]>.");
1264
1265   ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1266    [], (* XXX Augeas code needs tests. *)
1267    "remove an Augeas path",
1268    "\
1269 Remove C<path> and all of its children.
1270
1271 On success this returns the number of entries which were removed.");
1272
1273   ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1274    [], (* XXX Augeas code needs tests. *)
1275    "move Augeas node",
1276    "\
1277 Move the node C<src> to C<dest>.  C<src> must match exactly
1278 one node.  C<dest> is overwritten if it exists.");
1279
1280   ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1281    [], (* XXX Augeas code needs tests. *)
1282    "return Augeas nodes which match augpath",
1283    "\
1284 Returns a list of paths which match the path expression C<path>.
1285 The returned paths are sufficiently qualified so that they match
1286 exactly one node in the current tree.");
1287
1288   ("aug_save", (RErr, []), 25, [Optional "augeas"],
1289    [], (* XXX Augeas code needs tests. *)
1290    "write all pending Augeas changes to disk",
1291    "\
1292 This writes all pending changes to disk.
1293
1294 The flags which were passed to C<guestfs_aug_init> affect exactly
1295 how files are saved.");
1296
1297   ("aug_load", (RErr, []), 27, [Optional "augeas"],
1298    [], (* XXX Augeas code needs tests. *)
1299    "load files into the tree",
1300    "\
1301 Load files into the tree.
1302
1303 See C<aug_load> in the Augeas documentation for the full gory
1304 details.");
1305
1306   ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1307    [], (* XXX Augeas code needs tests. *)
1308    "list Augeas nodes under augpath",
1309    "\
1310 This is just a shortcut for listing C<guestfs_aug_match>
1311 C<path/*> and sorting the resulting nodes into alphabetical order.");
1312
1313   ("rm", (RErr, [Pathname "path"]), 29, [],
1314    [InitBasicFS, Always, TestRun
1315       [["touch"; "/new"];
1316        ["rm"; "/new"]];
1317     InitBasicFS, Always, TestLastFail
1318       [["rm"; "/new"]];
1319     InitBasicFS, Always, TestLastFail
1320       [["mkdir"; "/new"];
1321        ["rm"; "/new"]]],
1322    "remove a file",
1323    "\
1324 Remove the single file C<path>.");
1325
1326   ("rmdir", (RErr, [Pathname "path"]), 30, [],
1327    [InitBasicFS, Always, TestRun
1328       [["mkdir"; "/new"];
1329        ["rmdir"; "/new"]];
1330     InitBasicFS, Always, TestLastFail
1331       [["rmdir"; "/new"]];
1332     InitBasicFS, Always, TestLastFail
1333       [["touch"; "/new"];
1334        ["rmdir"; "/new"]]],
1335    "remove a directory",
1336    "\
1337 Remove the single directory C<path>.");
1338
1339   ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1340    [InitBasicFS, Always, TestOutputFalse
1341       [["mkdir"; "/new"];
1342        ["mkdir"; "/new/foo"];
1343        ["touch"; "/new/foo/bar"];
1344        ["rm_rf"; "/new"];
1345        ["exists"; "/new"]]],
1346    "remove a file or directory recursively",
1347    "\
1348 Remove the file or directory C<path>, recursively removing the
1349 contents if its a directory.  This is like the C<rm -rf> shell
1350 command.");
1351
1352   ("mkdir", (RErr, [Pathname "path"]), 32, [],
1353    [InitBasicFS, Always, TestOutputTrue
1354       [["mkdir"; "/new"];
1355        ["is_dir"; "/new"]];
1356     InitBasicFS, Always, TestLastFail
1357       [["mkdir"; "/new/foo/bar"]]],
1358    "create a directory",
1359    "\
1360 Create a directory named C<path>.");
1361
1362   ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1363    [InitBasicFS, Always, TestOutputTrue
1364       [["mkdir_p"; "/new/foo/bar"];
1365        ["is_dir"; "/new/foo/bar"]];
1366     InitBasicFS, Always, TestOutputTrue
1367       [["mkdir_p"; "/new/foo/bar"];
1368        ["is_dir"; "/new/foo"]];
1369     InitBasicFS, Always, TestOutputTrue
1370       [["mkdir_p"; "/new/foo/bar"];
1371        ["is_dir"; "/new"]];
1372     (* Regression tests for RHBZ#503133: *)
1373     InitBasicFS, Always, TestRun
1374       [["mkdir"; "/new"];
1375        ["mkdir_p"; "/new"]];
1376     InitBasicFS, Always, TestLastFail
1377       [["touch"; "/new"];
1378        ["mkdir_p"; "/new"]]],
1379    "create a directory and parents",
1380    "\
1381 Create a directory named C<path>, creating any parent directories
1382 as necessary.  This is like the C<mkdir -p> shell command.");
1383
1384   ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1385    [], (* XXX Need stat command to test *)
1386    "change file mode",
1387    "\
1388 Change the mode (permissions) of C<path> to C<mode>.  Only
1389 numeric modes are supported.
1390
1391 I<Note>: When using this command from guestfish, C<mode>
1392 by default would be decimal, unless you prefix it with
1393 C<0> to get octal, ie. use C<0700> not C<700>.");
1394
1395   ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1396    [], (* XXX Need stat command to test *)
1397    "change file owner and group",
1398    "\
1399 Change the file owner to C<owner> and group to C<group>.
1400
1401 Only numeric uid and gid are supported.  If you want to use
1402 names, you will need to locate and parse the password file
1403 yourself (Augeas support makes this relatively easy).");
1404
1405   ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1406    [InitISOFS, Always, TestOutputTrue (
1407       [["exists"; "/empty"]]);
1408     InitISOFS, Always, TestOutputTrue (
1409       [["exists"; "/directory"]])],
1410    "test if file or directory exists",
1411    "\
1412 This returns C<true> if and only if there is a file, directory
1413 (or anything) with the given C<path> name.
1414
1415 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1416
1417   ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1418    [InitISOFS, Always, TestOutputTrue (
1419       [["is_file"; "/known-1"]]);
1420     InitISOFS, Always, TestOutputFalse (
1421       [["is_file"; "/directory"]])],
1422    "test if file exists",
1423    "\
1424 This returns C<true> if and only if there is a file
1425 with the given C<path> name.  Note that it returns false for
1426 other objects like directories.
1427
1428 See also C<guestfs_stat>.");
1429
1430   ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1431    [InitISOFS, Always, TestOutputFalse (
1432       [["is_dir"; "/known-3"]]);
1433     InitISOFS, Always, TestOutputTrue (
1434       [["is_dir"; "/directory"]])],
1435    "test if file exists",
1436    "\
1437 This returns C<true> if and only if there is a directory
1438 with the given C<path> name.  Note that it returns false for
1439 other objects like files.
1440
1441 See also C<guestfs_stat>.");
1442
1443   ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1444    [InitEmpty, Always, TestOutputListOfDevices (
1445       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1446        ["pvcreate"; "/dev/sda1"];
1447        ["pvcreate"; "/dev/sda2"];
1448        ["pvcreate"; "/dev/sda3"];
1449        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1450    "create an LVM physical volume",
1451    "\
1452 This creates an LVM physical volume on the named C<device>,
1453 where C<device> should usually be a partition name such
1454 as C</dev/sda1>.");
1455
1456   ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1457    [InitEmpty, Always, TestOutputList (
1458       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1459        ["pvcreate"; "/dev/sda1"];
1460        ["pvcreate"; "/dev/sda2"];
1461        ["pvcreate"; "/dev/sda3"];
1462        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1463        ["vgcreate"; "VG2"; "/dev/sda3"];
1464        ["vgs"]], ["VG1"; "VG2"])],
1465    "create an LVM volume group",
1466    "\
1467 This creates an LVM volume group called C<volgroup>
1468 from the non-empty list of physical volumes C<physvols>.");
1469
1470   ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1471    [InitEmpty, Always, TestOutputList (
1472       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1473        ["pvcreate"; "/dev/sda1"];
1474        ["pvcreate"; "/dev/sda2"];
1475        ["pvcreate"; "/dev/sda3"];
1476        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1477        ["vgcreate"; "VG2"; "/dev/sda3"];
1478        ["lvcreate"; "LV1"; "VG1"; "50"];
1479        ["lvcreate"; "LV2"; "VG1"; "50"];
1480        ["lvcreate"; "LV3"; "VG2"; "50"];
1481        ["lvcreate"; "LV4"; "VG2"; "50"];
1482        ["lvcreate"; "LV5"; "VG2"; "50"];
1483        ["lvs"]],
1484       ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1485        "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1486    "create an LVM logical volume",
1487    "\
1488 This creates an LVM logical volume called C<logvol>
1489 on the volume group C<volgroup>, with C<size> megabytes.");
1490
1491   ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1492    [InitEmpty, Always, TestOutput (
1493       [["part_disk"; "/dev/sda"; "mbr"];
1494        ["mkfs"; "ext2"; "/dev/sda1"];
1495        ["mount_options"; ""; "/dev/sda1"; "/"];
1496        ["write_file"; "/new"; "new file contents"; "0"];
1497        ["cat"; "/new"]], "new file contents")],
1498    "make a filesystem",
1499    "\
1500 This creates a filesystem on C<device> (usually a partition
1501 or LVM logical volume).  The filesystem type is C<fstype>, for
1502 example C<ext3>.");
1503
1504   ("sfdisk", (RErr, [Device "device";
1505                      Int "cyls"; Int "heads"; Int "sectors";
1506                      StringList "lines"]), 43, [DangerWillRobinson],
1507    [],
1508    "create partitions on a block device",
1509    "\
1510 This is a direct interface to the L<sfdisk(8)> program for creating
1511 partitions on block devices.
1512
1513 C<device> should be a block device, for example C</dev/sda>.
1514
1515 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1516 and sectors on the device, which are passed directly to sfdisk as
1517 the I<-C>, I<-H> and I<-S> parameters.  If you pass C<0> for any
1518 of these, then the corresponding parameter is omitted.  Usually for
1519 'large' disks, you can just pass C<0> for these, but for small
1520 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1521 out the right geometry and you will need to tell it.
1522
1523 C<lines> is a list of lines that we feed to C<sfdisk>.  For more
1524 information refer to the L<sfdisk(8)> manpage.
1525
1526 To create a single partition occupying the whole disk, you would
1527 pass C<lines> as a single element list, when the single element being
1528 the string C<,> (comma).
1529
1530 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1531 C<guestfs_part_init>");
1532
1533   ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1534    [InitBasicFS, Always, TestOutput (
1535       [["write_file"; "/new"; "new file contents"; "0"];
1536        ["cat"; "/new"]], "new file contents");
1537     InitBasicFS, Always, TestOutput (
1538       [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1539        ["cat"; "/new"]], "\nnew file contents\n");
1540     InitBasicFS, Always, TestOutput (
1541       [["write_file"; "/new"; "\n\n"; "0"];
1542        ["cat"; "/new"]], "\n\n");
1543     InitBasicFS, Always, TestOutput (
1544       [["write_file"; "/new"; ""; "0"];
1545        ["cat"; "/new"]], "");
1546     InitBasicFS, Always, TestOutput (
1547       [["write_file"; "/new"; "\n\n\n"; "0"];
1548        ["cat"; "/new"]], "\n\n\n");
1549     InitBasicFS, Always, TestOutput (
1550       [["write_file"; "/new"; "\n"; "0"];
1551        ["cat"; "/new"]], "\n")],
1552    "create a file",
1553    "\
1554 This call creates a file called C<path>.  The contents of the
1555 file is the string C<content> (which can contain any 8 bit data),
1556 with length C<size>.
1557
1558 As a special case, if C<size> is C<0>
1559 then the length is calculated using C<strlen> (so in this case
1560 the content cannot contain embedded ASCII NULs).
1561
1562 I<NB.> Owing to a bug, writing content containing ASCII NUL
1563 characters does I<not> work, even if the length is specified.
1564 We hope to resolve this bug in a future version.  In the meantime
1565 use C<guestfs_upload>.");
1566
1567   ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1568    [InitEmpty, Always, TestOutputListOfDevices (
1569       [["part_disk"; "/dev/sda"; "mbr"];
1570        ["mkfs"; "ext2"; "/dev/sda1"];
1571        ["mount_options"; ""; "/dev/sda1"; "/"];
1572        ["mounts"]], ["/dev/sda1"]);
1573     InitEmpty, Always, TestOutputList (
1574       [["part_disk"; "/dev/sda"; "mbr"];
1575        ["mkfs"; "ext2"; "/dev/sda1"];
1576        ["mount_options"; ""; "/dev/sda1"; "/"];
1577        ["umount"; "/"];
1578        ["mounts"]], [])],
1579    "unmount a filesystem",
1580    "\
1581 This unmounts the given filesystem.  The filesystem may be
1582 specified either by its mountpoint (path) or the device which
1583 contains the filesystem.");
1584
1585   ("mounts", (RStringList "devices", []), 46, [],
1586    [InitBasicFS, Always, TestOutputListOfDevices (
1587       [["mounts"]], ["/dev/sda1"])],
1588    "show mounted filesystems",
1589    "\
1590 This returns the list of currently mounted filesystems.  It returns
1591 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1592
1593 Some internal mounts are not shown.
1594
1595 See also: C<guestfs_mountpoints>");
1596
1597   ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1598    [InitBasicFS, Always, TestOutputList (
1599       [["umount_all"];
1600        ["mounts"]], []);
1601     (* check that umount_all can unmount nested mounts correctly: *)
1602     InitEmpty, Always, TestOutputList (
1603       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1604        ["mkfs"; "ext2"; "/dev/sda1"];
1605        ["mkfs"; "ext2"; "/dev/sda2"];
1606        ["mkfs"; "ext2"; "/dev/sda3"];
1607        ["mount_options"; ""; "/dev/sda1"; "/"];
1608        ["mkdir"; "/mp1"];
1609        ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1610        ["mkdir"; "/mp1/mp2"];
1611        ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1612        ["mkdir"; "/mp1/mp2/mp3"];
1613        ["umount_all"];
1614        ["mounts"]], [])],
1615    "unmount all filesystems",
1616    "\
1617 This unmounts all mounted filesystems.
1618
1619 Some internal mounts are not unmounted by this call.");
1620
1621   ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1622    [],
1623    "remove all LVM LVs, VGs and PVs",
1624    "\
1625 This command removes all LVM logical volumes, volume groups
1626 and physical volumes.");
1627
1628   ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1629    [InitISOFS, Always, TestOutput (
1630       [["file"; "/empty"]], "empty");
1631     InitISOFS, Always, TestOutput (
1632       [["file"; "/known-1"]], "ASCII text");
1633     InitISOFS, Always, TestLastFail (
1634       [["file"; "/notexists"]])],
1635    "determine file type",
1636    "\
1637 This call uses the standard L<file(1)> command to determine
1638 the type or contents of the file.  This also works on devices,
1639 for example to find out whether a partition contains a filesystem.
1640
1641 This call will also transparently look inside various types
1642 of compressed file.
1643
1644 The exact command which runs is C<file -zbsL path>.  Note in
1645 particular that the filename is not prepended to the output
1646 (the C<-b> option).");
1647
1648   ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1649    [InitBasicFS, Always, TestOutput (
1650       [["upload"; "test-command"; "/test-command"];
1651        ["chmod"; "0o755"; "/test-command"];
1652        ["command"; "/test-command 1"]], "Result1");
1653     InitBasicFS, Always, TestOutput (
1654       [["upload"; "test-command"; "/test-command"];
1655        ["chmod"; "0o755"; "/test-command"];
1656        ["command"; "/test-command 2"]], "Result2\n");
1657     InitBasicFS, Always, TestOutput (
1658       [["upload"; "test-command"; "/test-command"];
1659        ["chmod"; "0o755"; "/test-command"];
1660        ["command"; "/test-command 3"]], "\nResult3");
1661     InitBasicFS, Always, TestOutput (
1662       [["upload"; "test-command"; "/test-command"];
1663        ["chmod"; "0o755"; "/test-command"];
1664        ["command"; "/test-command 4"]], "\nResult4\n");
1665     InitBasicFS, Always, TestOutput (
1666       [["upload"; "test-command"; "/test-command"];
1667        ["chmod"; "0o755"; "/test-command"];
1668        ["command"; "/test-command 5"]], "\nResult5\n\n");
1669     InitBasicFS, Always, TestOutput (
1670       [["upload"; "test-command"; "/test-command"];
1671        ["chmod"; "0o755"; "/test-command"];
1672        ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1673     InitBasicFS, Always, TestOutput (
1674       [["upload"; "test-command"; "/test-command"];
1675        ["chmod"; "0o755"; "/test-command"];
1676        ["command"; "/test-command 7"]], "");
1677     InitBasicFS, Always, TestOutput (
1678       [["upload"; "test-command"; "/test-command"];
1679        ["chmod"; "0o755"; "/test-command"];
1680        ["command"; "/test-command 8"]], "\n");
1681     InitBasicFS, Always, TestOutput (
1682       [["upload"; "test-command"; "/test-command"];
1683        ["chmod"; "0o755"; "/test-command"];
1684        ["command"; "/test-command 9"]], "\n\n");
1685     InitBasicFS, Always, TestOutput (
1686       [["upload"; "test-command"; "/test-command"];
1687        ["chmod"; "0o755"; "/test-command"];
1688        ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1689     InitBasicFS, Always, TestOutput (
1690       [["upload"; "test-command"; "/test-command"];
1691        ["chmod"; "0o755"; "/test-command"];
1692        ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1693     InitBasicFS, Always, TestLastFail (
1694       [["upload"; "test-command"; "/test-command"];
1695        ["chmod"; "0o755"; "/test-command"];
1696        ["command"; "/test-command"]])],
1697    "run a command from the guest filesystem",
1698    "\
1699 This call runs a command from the guest filesystem.  The
1700 filesystem must be mounted, and must contain a compatible
1701 operating system (ie. something Linux, with the same
1702 or compatible processor architecture).
1703
1704 The single parameter is an argv-style list of arguments.
1705 The first element is the name of the program to run.
1706 Subsequent elements are parameters.  The list must be
1707 non-empty (ie. must contain a program name).  Note that
1708 the command runs directly, and is I<not> invoked via
1709 the shell (see C<guestfs_sh>).
1710
1711 The return value is anything printed to I<stdout> by
1712 the command.
1713
1714 If the command returns a non-zero exit status, then
1715 this function returns an error message.  The error message
1716 string is the content of I<stderr> from the command.
1717
1718 The C<$PATH> environment variable will contain at least
1719 C</usr/bin> and C</bin>.  If you require a program from
1720 another location, you should provide the full path in the
1721 first parameter.
1722
1723 Shared libraries and data files required by the program
1724 must be available on filesystems which are mounted in the
1725 correct places.  It is the caller's responsibility to ensure
1726 all filesystems that are needed are mounted at the right
1727 locations.");
1728
1729   ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1730    [InitBasicFS, Always, TestOutputList (
1731       [["upload"; "test-command"; "/test-command"];
1732        ["chmod"; "0o755"; "/test-command"];
1733        ["command_lines"; "/test-command 1"]], ["Result1"]);
1734     InitBasicFS, Always, TestOutputList (
1735       [["upload"; "test-command"; "/test-command"];
1736        ["chmod"; "0o755"; "/test-command"];
1737        ["command_lines"; "/test-command 2"]], ["Result2"]);
1738     InitBasicFS, Always, TestOutputList (
1739       [["upload"; "test-command"; "/test-command"];
1740        ["chmod"; "0o755"; "/test-command"];
1741        ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1742     InitBasicFS, Always, TestOutputList (
1743       [["upload"; "test-command"; "/test-command"];
1744        ["chmod"; "0o755"; "/test-command"];
1745        ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1746     InitBasicFS, Always, TestOutputList (
1747       [["upload"; "test-command"; "/test-command"];
1748        ["chmod"; "0o755"; "/test-command"];
1749        ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1750     InitBasicFS, Always, TestOutputList (
1751       [["upload"; "test-command"; "/test-command"];
1752        ["chmod"; "0o755"; "/test-command"];
1753        ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1754     InitBasicFS, Always, TestOutputList (
1755       [["upload"; "test-command"; "/test-command"];
1756        ["chmod"; "0o755"; "/test-command"];
1757        ["command_lines"; "/test-command 7"]], []);
1758     InitBasicFS, Always, TestOutputList (
1759       [["upload"; "test-command"; "/test-command"];
1760        ["chmod"; "0o755"; "/test-command"];
1761        ["command_lines"; "/test-command 8"]], [""]);
1762     InitBasicFS, Always, TestOutputList (
1763       [["upload"; "test-command"; "/test-command"];
1764        ["chmod"; "0o755"; "/test-command"];
1765        ["command_lines"; "/test-command 9"]], ["";""]);
1766     InitBasicFS, Always, TestOutputList (
1767       [["upload"; "test-command"; "/test-command"];
1768        ["chmod"; "0o755"; "/test-command"];
1769        ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1770     InitBasicFS, Always, TestOutputList (
1771       [["upload"; "test-command"; "/test-command"];
1772        ["chmod"; "0o755"; "/test-command"];
1773        ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1774    "run a command, returning lines",
1775    "\
1776 This is the same as C<guestfs_command>, but splits the
1777 result into a list of lines.
1778
1779 See also: C<guestfs_sh_lines>");
1780
1781   ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1782    [InitISOFS, Always, TestOutputStruct (
1783       [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1784    "get file information",
1785    "\
1786 Returns file information for the given C<path>.
1787
1788 This is the same as the C<stat(2)> system call.");
1789
1790   ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1791    [InitISOFS, Always, TestOutputStruct (
1792       [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1793    "get file information for a symbolic link",
1794    "\
1795 Returns file information for the given C<path>.
1796
1797 This is the same as C<guestfs_stat> except that if C<path>
1798 is a symbolic link, then the link is stat-ed, not the file it
1799 refers to.
1800
1801 This is the same as the C<lstat(2)> system call.");
1802
1803   ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1804    [InitISOFS, Always, TestOutputStruct (
1805       [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1806    "get file system statistics",
1807    "\
1808 Returns file system statistics for any mounted file system.
1809 C<path> should be a file or directory in the mounted file system
1810 (typically it is the mount point itself, but it doesn't need to be).
1811
1812 This is the same as the C<statvfs(2)> system call.");
1813
1814   ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1815    [], (* XXX test *)
1816    "get ext2/ext3/ext4 superblock details",
1817    "\
1818 This returns the contents of the ext2, ext3 or ext4 filesystem
1819 superblock on C<device>.
1820
1821 It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)>
1822 manpage for more details.  The list of fields returned isn't
1823 clearly defined, and depends on both the version of C<tune2fs>
1824 that libguestfs was built against, and the filesystem itself.");
1825
1826   ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1827    [InitEmpty, Always, TestOutputTrue (
1828       [["blockdev_setro"; "/dev/sda"];
1829        ["blockdev_getro"; "/dev/sda"]])],
1830    "set block device to read-only",
1831    "\
1832 Sets the block device named C<device> to read-only.
1833
1834 This uses the L<blockdev(8)> command.");
1835
1836   ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1837    [InitEmpty, Always, TestOutputFalse (
1838       [["blockdev_setrw"; "/dev/sda"];
1839        ["blockdev_getro"; "/dev/sda"]])],
1840    "set block device to read-write",
1841    "\
1842 Sets the block device named C<device> to read-write.
1843
1844 This uses the L<blockdev(8)> command.");
1845
1846   ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1847    [InitEmpty, Always, TestOutputTrue (
1848       [["blockdev_setro"; "/dev/sda"];
1849        ["blockdev_getro"; "/dev/sda"]])],
1850    "is block device set to read-only",
1851    "\
1852 Returns a boolean indicating if the block device is read-only
1853 (true if read-only, false if not).
1854
1855 This uses the L<blockdev(8)> command.");
1856
1857   ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1858    [InitEmpty, Always, TestOutputInt (
1859       [["blockdev_getss"; "/dev/sda"]], 512)],
1860    "get sectorsize of block device",
1861    "\
1862 This returns the size of sectors on a block device.
1863 Usually 512, but can be larger for modern devices.
1864
1865 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1866 for that).
1867
1868 This uses the L<blockdev(8)> command.");
1869
1870   ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1871    [InitEmpty, Always, TestOutputInt (
1872       [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1873    "get blocksize of block device",
1874    "\
1875 This returns the block size of a device.
1876
1877 (Note this is different from both I<size in blocks> and
1878 I<filesystem block size>).
1879
1880 This uses the L<blockdev(8)> command.");
1881
1882   ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1883    [], (* XXX test *)
1884    "set blocksize of block device",
1885    "\
1886 This sets the block size of a device.
1887
1888 (Note this is different from both I<size in blocks> and
1889 I<filesystem block size>).
1890
1891 This uses the L<blockdev(8)> command.");
1892
1893   ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1894    [InitEmpty, Always, TestOutputInt (
1895       [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1896    "get total size of device in 512-byte sectors",
1897    "\
1898 This returns the size of the device in units of 512-byte sectors
1899 (even if the sectorsize isn't 512 bytes ... weird).
1900
1901 See also C<guestfs_blockdev_getss> for the real sector size of
1902 the device, and C<guestfs_blockdev_getsize64> for the more
1903 useful I<size in bytes>.
1904
1905 This uses the L<blockdev(8)> command.");
1906
1907   ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1908    [InitEmpty, Always, TestOutputInt (
1909       [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1910    "get total size of device in bytes",
1911    "\
1912 This returns the size of the device in bytes.
1913
1914 See also C<guestfs_blockdev_getsz>.
1915
1916 This uses the L<blockdev(8)> command.");
1917
1918   ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1919    [InitEmpty, Always, TestRun
1920       [["blockdev_flushbufs"; "/dev/sda"]]],
1921    "flush device buffers",
1922    "\
1923 This tells the kernel to flush internal buffers associated
1924 with C<device>.
1925
1926 This uses the L<blockdev(8)> command.");
1927
1928   ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1929    [InitEmpty, Always, TestRun
1930       [["blockdev_rereadpt"; "/dev/sda"]]],
1931    "reread partition table",
1932    "\
1933 Reread the partition table on C<device>.
1934
1935 This uses the L<blockdev(8)> command.");
1936
1937   ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1938    [InitBasicFS, Always, TestOutput (
1939       (* Pick a file from cwd which isn't likely to change. *)
1940       [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1941        ["checksum"; "md5"; "/COPYING.LIB"]],
1942       Digest.to_hex (Digest.file "COPYING.LIB"))],
1943    "upload a file from the local machine",
1944    "\
1945 Upload local file C<filename> to C<remotefilename> on the
1946 filesystem.
1947
1948 C<filename> can also be a named pipe.
1949
1950 See also C<guestfs_download>.");
1951
1952   ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1953    [InitBasicFS, Always, TestOutput (
1954       (* Pick a file from cwd which isn't likely to change. *)
1955       [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1956        ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1957        ["upload"; "testdownload.tmp"; "/upload"];
1958        ["checksum"; "md5"; "/upload"]],
1959       Digest.to_hex (Digest.file "COPYING.LIB"))],
1960    "download a file to the local machine",
1961    "\
1962 Download file C<remotefilename> and save it as C<filename>
1963 on the local machine.
1964
1965 C<filename> can also be a named pipe.
1966
1967 See also C<guestfs_upload>, C<guestfs_cat>.");
1968
1969   ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1970    [InitISOFS, Always, TestOutput (
1971       [["checksum"; "crc"; "/known-3"]], "2891671662");
1972     InitISOFS, Always, TestLastFail (
1973       [["checksum"; "crc"; "/notexists"]]);
1974     InitISOFS, Always, TestOutput (
1975       [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1976     InitISOFS, Always, TestOutput (
1977       [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1978     InitISOFS, Always, TestOutput (
1979       [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1980     InitISOFS, Always, TestOutput (
1981       [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1982     InitISOFS, Always, TestOutput (
1983       [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1984     InitISOFS, Always, TestOutput (
1985       [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6")],
1986    "compute MD5, SHAx or CRC checksum of file",
1987    "\
1988 This call computes the MD5, SHAx or CRC checksum of the
1989 file named C<path>.
1990
1991 The type of checksum to compute is given by the C<csumtype>
1992 parameter which must have one of the following values:
1993
1994 =over 4
1995
1996 =item C<crc>
1997
1998 Compute the cyclic redundancy check (CRC) specified by POSIX
1999 for the C<cksum> command.
2000
2001 =item C<md5>
2002
2003 Compute the MD5 hash (using the C<md5sum> program).
2004
2005 =item C<sha1>
2006
2007 Compute the SHA1 hash (using the C<sha1sum> program).
2008
2009 =item C<sha224>
2010
2011 Compute the SHA224 hash (using the C<sha224sum> program).
2012
2013 =item C<sha256>
2014
2015 Compute the SHA256 hash (using the C<sha256sum> program).
2016
2017 =item C<sha384>
2018
2019 Compute the SHA384 hash (using the C<sha384sum> program).
2020
2021 =item C<sha512>
2022
2023 Compute the SHA512 hash (using the C<sha512sum> program).
2024
2025 =back
2026
2027 The checksum is returned as a printable string.");
2028
2029   ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
2030    [InitBasicFS, Always, TestOutput (
2031       [["tar_in"; "../images/helloworld.tar"; "/"];
2032        ["cat"; "/hello"]], "hello\n")],
2033    "unpack tarfile to directory",
2034    "\
2035 This command uploads and unpacks local file C<tarfile> (an
2036 I<uncompressed> tar file) into C<directory>.
2037
2038 To upload a compressed tarball, use C<guestfs_tgz_in>
2039 or C<guestfs_txz_in>.");
2040
2041   ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2042    [],
2043    "pack directory into tarfile",
2044    "\
2045 This command packs the contents of C<directory> and downloads
2046 it to local file C<tarfile>.
2047
2048 To download a compressed tarball, use C<guestfs_tgz_out>
2049 or C<guestfs_txz_out>.");
2050
2051   ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
2052    [InitBasicFS, Always, TestOutput (
2053       [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2054        ["cat"; "/hello"]], "hello\n")],
2055    "unpack compressed tarball to directory",
2056    "\
2057 This command uploads and unpacks local file C<tarball> (a
2058 I<gzip compressed> tar file) into C<directory>.
2059
2060 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2061
2062   ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2063    [],
2064    "pack directory into compressed tarball",
2065    "\
2066 This command packs the contents of C<directory> and downloads
2067 it to local file C<tarball>.
2068
2069 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2070
2071   ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2072    [InitBasicFS, Always, TestLastFail (
2073       [["umount"; "/"];
2074        ["mount_ro"; "/dev/sda1"; "/"];
2075        ["touch"; "/new"]]);
2076     InitBasicFS, Always, TestOutput (
2077       [["write_file"; "/new"; "data"; "0"];
2078        ["umount"; "/"];
2079        ["mount_ro"; "/dev/sda1"; "/"];
2080        ["cat"; "/new"]], "data")],
2081    "mount a guest disk, read-only",
2082    "\
2083 This is the same as the C<guestfs_mount> command, but it
2084 mounts the filesystem with the read-only (I<-o ro>) flag.");
2085
2086   ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2087    [],
2088    "mount a guest disk with mount options",
2089    "\
2090 This is the same as the C<guestfs_mount> command, but it
2091 allows you to set the mount options as for the
2092 L<mount(8)> I<-o> flag.");
2093
2094   ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2095    [],
2096    "mount a guest disk with mount options and vfstype",
2097    "\
2098 This is the same as the C<guestfs_mount> command, but it
2099 allows you to set both the mount options and the vfstype
2100 as for the L<mount(8)> I<-o> and I<-t> flags.");
2101
2102   ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2103    [],
2104    "debugging and internals",
2105    "\
2106 The C<guestfs_debug> command exposes some internals of
2107 C<guestfsd> (the guestfs daemon) that runs inside the
2108 qemu subprocess.
2109
2110 There is no comprehensive help for this command.  You have
2111 to look at the file C<daemon/debug.c> in the libguestfs source
2112 to find out what you can do.");
2113
2114   ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2115    [InitEmpty, Always, TestOutputList (
2116       [["part_disk"; "/dev/sda"; "mbr"];
2117        ["pvcreate"; "/dev/sda1"];
2118        ["vgcreate"; "VG"; "/dev/sda1"];
2119        ["lvcreate"; "LV1"; "VG"; "50"];
2120        ["lvcreate"; "LV2"; "VG"; "50"];
2121        ["lvremove"; "/dev/VG/LV1"];
2122        ["lvs"]], ["/dev/VG/LV2"]);
2123     InitEmpty, Always, TestOutputList (
2124       [["part_disk"; "/dev/sda"; "mbr"];
2125        ["pvcreate"; "/dev/sda1"];
2126        ["vgcreate"; "VG"; "/dev/sda1"];
2127        ["lvcreate"; "LV1"; "VG"; "50"];
2128        ["lvcreate"; "LV2"; "VG"; "50"];
2129        ["lvremove"; "/dev/VG"];
2130        ["lvs"]], []);
2131     InitEmpty, Always, TestOutputList (
2132       [["part_disk"; "/dev/sda"; "mbr"];
2133        ["pvcreate"; "/dev/sda1"];
2134        ["vgcreate"; "VG"; "/dev/sda1"];
2135        ["lvcreate"; "LV1"; "VG"; "50"];
2136        ["lvcreate"; "LV2"; "VG"; "50"];
2137        ["lvremove"; "/dev/VG"];
2138        ["vgs"]], ["VG"])],
2139    "remove an LVM logical volume",
2140    "\
2141 Remove an LVM logical volume C<device>, where C<device> is
2142 the path to the LV, such as C</dev/VG/LV>.
2143
2144 You can also remove all LVs in a volume group by specifying
2145 the VG name, C</dev/VG>.");
2146
2147   ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2148    [InitEmpty, Always, TestOutputList (
2149       [["part_disk"; "/dev/sda"; "mbr"];
2150        ["pvcreate"; "/dev/sda1"];
2151        ["vgcreate"; "VG"; "/dev/sda1"];
2152        ["lvcreate"; "LV1"; "VG"; "50"];
2153        ["lvcreate"; "LV2"; "VG"; "50"];
2154        ["vgremove"; "VG"];
2155        ["lvs"]], []);
2156     InitEmpty, Always, TestOutputList (
2157       [["part_disk"; "/dev/sda"; "mbr"];
2158        ["pvcreate"; "/dev/sda1"];
2159        ["vgcreate"; "VG"; "/dev/sda1"];
2160        ["lvcreate"; "LV1"; "VG"; "50"];
2161        ["lvcreate"; "LV2"; "VG"; "50"];
2162        ["vgremove"; "VG"];
2163        ["vgs"]], [])],
2164    "remove an LVM volume group",
2165    "\
2166 Remove an LVM volume group C<vgname>, (for example C<VG>).
2167
2168 This also forcibly removes all logical volumes in the volume
2169 group (if any).");
2170
2171   ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2172    [InitEmpty, Always, TestOutputListOfDevices (
2173       [["part_disk"; "/dev/sda"; "mbr"];
2174        ["pvcreate"; "/dev/sda1"];
2175        ["vgcreate"; "VG"; "/dev/sda1"];
2176        ["lvcreate"; "LV1"; "VG"; "50"];
2177        ["lvcreate"; "LV2"; "VG"; "50"];
2178        ["vgremove"; "VG"];
2179        ["pvremove"; "/dev/sda1"];
2180        ["lvs"]], []);
2181     InitEmpty, Always, TestOutputListOfDevices (
2182       [["part_disk"; "/dev/sda"; "mbr"];
2183        ["pvcreate"; "/dev/sda1"];
2184        ["vgcreate"; "VG"; "/dev/sda1"];
2185        ["lvcreate"; "LV1"; "VG"; "50"];
2186        ["lvcreate"; "LV2"; "VG"; "50"];
2187        ["vgremove"; "VG"];
2188        ["pvremove"; "/dev/sda1"];
2189        ["vgs"]], []);
2190     InitEmpty, Always, TestOutputListOfDevices (
2191       [["part_disk"; "/dev/sda"; "mbr"];
2192        ["pvcreate"; "/dev/sda1"];
2193        ["vgcreate"; "VG"; "/dev/sda1"];
2194        ["lvcreate"; "LV1"; "VG"; "50"];
2195        ["lvcreate"; "LV2"; "VG"; "50"];
2196        ["vgremove"; "VG"];
2197        ["pvremove"; "/dev/sda1"];
2198        ["pvs"]], [])],
2199    "remove an LVM physical volume",
2200    "\
2201 This wipes a physical volume C<device> so that LVM will no longer
2202 recognise it.
2203
2204 The implementation uses the C<pvremove> command which refuses to
2205 wipe physical volumes that contain any volume groups, so you have
2206 to remove those first.");
2207
2208   ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2209    [InitBasicFS, Always, TestOutput (
2210       [["set_e2label"; "/dev/sda1"; "testlabel"];
2211        ["get_e2label"; "/dev/sda1"]], "testlabel")],
2212    "set the ext2/3/4 filesystem label",
2213    "\
2214 This sets the ext2/3/4 filesystem label of the filesystem on
2215 C<device> to C<label>.  Filesystem labels are limited to
2216 16 characters.
2217
2218 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2219 to return the existing label on a filesystem.");
2220
2221   ("get_e2label", (RString "label", [Device "device"]), 81, [],
2222    [],
2223    "get the ext2/3/4 filesystem label",
2224    "\
2225 This returns the ext2/3/4 filesystem label of the filesystem on
2226 C<device>.");
2227
2228   ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2229    (let uuid = uuidgen () in
2230     [InitBasicFS, Always, TestOutput (
2231        [["set_e2uuid"; "/dev/sda1"; uuid];
2232         ["get_e2uuid"; "/dev/sda1"]], uuid);
2233      InitBasicFS, Always, TestOutput (
2234        [["set_e2uuid"; "/dev/sda1"; "clear"];
2235         ["get_e2uuid"; "/dev/sda1"]], "");
2236      (* We can't predict what UUIDs will be, so just check the commands run. *)
2237      InitBasicFS, Always, TestRun (
2238        [["set_e2uuid"; "/dev/sda1"; "random"]]);
2239      InitBasicFS, Always, TestRun (
2240        [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2241    "set the ext2/3/4 filesystem UUID",
2242    "\
2243 This sets the ext2/3/4 filesystem UUID of the filesystem on
2244 C<device> to C<uuid>.  The format of the UUID and alternatives
2245 such as C<clear>, C<random> and C<time> are described in the
2246 L<tune2fs(8)> manpage.
2247
2248 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2249 to return the existing UUID of a filesystem.");
2250
2251   ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [],
2252    [],
2253    "get the ext2/3/4 filesystem UUID",
2254    "\
2255 This returns the ext2/3/4 filesystem UUID of the filesystem on
2256 C<device>.");
2257
2258   ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [FishOutput FishOutputHexadecimal],
2259    [InitBasicFS, Always, TestOutputInt (
2260       [["umount"; "/dev/sda1"];
2261        ["fsck"; "ext2"; "/dev/sda1"]], 0);
2262     InitBasicFS, Always, TestOutputInt (
2263       [["umount"; "/dev/sda1"];
2264        ["zero"; "/dev/sda1"];
2265        ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2266    "run the filesystem checker",
2267    "\
2268 This runs the filesystem checker (fsck) on C<device> which
2269 should have filesystem type C<fstype>.
2270
2271 The returned integer is the status.  See L<fsck(8)> for the
2272 list of status codes from C<fsck>.
2273
2274 Notes:
2275
2276 =over 4
2277
2278 =item *
2279
2280 Multiple status codes can be summed together.
2281
2282 =item *
2283
2284 A non-zero return code can mean \"success\", for example if
2285 errors have been corrected on the filesystem.
2286
2287 =item *
2288
2289 Checking or repairing NTFS volumes is not supported
2290 (by linux-ntfs).
2291
2292 =back
2293
2294 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2295
2296   ("zero", (RErr, [Device "device"]), 85, [],
2297    [InitBasicFS, Always, TestOutput (
2298       [["umount"; "/dev/sda1"];
2299        ["zero"; "/dev/sda1"];
2300        ["file"; "/dev/sda1"]], "data")],
2301    "write zeroes to the device",
2302    "\
2303 This command writes zeroes over the first few blocks of C<device>.
2304
2305 How many blocks are zeroed isn't specified (but it's I<not> enough
2306 to securely wipe the device).  It should be sufficient to remove
2307 any partition tables, filesystem superblocks and so on.
2308
2309 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2310
2311   ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2312    (* Test disabled because grub-install incompatible with virtio-blk driver.
2313     * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2314     *)
2315    [InitBasicFS, Disabled, TestOutputTrue (
2316       [["grub_install"; "/"; "/dev/sda1"];
2317        ["is_dir"; "/boot"]])],
2318    "install GRUB",
2319    "\
2320 This command installs GRUB (the Grand Unified Bootloader) on
2321 C<device>, with the root directory being C<root>.");
2322
2323   ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2324    [InitBasicFS, Always, TestOutput (
2325       [["write_file"; "/old"; "file content"; "0"];
2326        ["cp"; "/old"; "/new"];
2327        ["cat"; "/new"]], "file content");
2328     InitBasicFS, Always, TestOutputTrue (
2329       [["write_file"; "/old"; "file content"; "0"];
2330        ["cp"; "/old"; "/new"];
2331        ["is_file"; "/old"]]);
2332     InitBasicFS, Always, TestOutput (
2333       [["write_file"; "/old"; "file content"; "0"];
2334        ["mkdir"; "/dir"];
2335        ["cp"; "/old"; "/dir/new"];
2336        ["cat"; "/dir/new"]], "file content")],
2337    "copy a file",
2338    "\
2339 This copies a file from C<src> to C<dest> where C<dest> is
2340 either a destination filename or destination directory.");
2341
2342   ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2343    [InitBasicFS, Always, TestOutput (
2344       [["mkdir"; "/olddir"];
2345        ["mkdir"; "/newdir"];
2346        ["write_file"; "/olddir/file"; "file content"; "0"];
2347        ["cp_a"; "/olddir"; "/newdir"];
2348        ["cat"; "/newdir/olddir/file"]], "file content")],
2349    "copy a file or directory recursively",
2350    "\
2351 This copies a file or directory from C<src> to C<dest>
2352 recursively using the C<cp -a> command.");
2353
2354   ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2355    [InitBasicFS, Always, TestOutput (
2356       [["write_file"; "/old"; "file content"; "0"];
2357        ["mv"; "/old"; "/new"];
2358        ["cat"; "/new"]], "file content");
2359     InitBasicFS, Always, TestOutputFalse (
2360       [["write_file"; "/old"; "file content"; "0"];
2361        ["mv"; "/old"; "/new"];
2362        ["is_file"; "/old"]])],
2363    "move a file",
2364    "\
2365 This moves a file from C<src> to C<dest> where C<dest> is
2366 either a destination filename or destination directory.");
2367
2368   ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2369    [InitEmpty, Always, TestRun (
2370       [["drop_caches"; "3"]])],
2371    "drop kernel page cache, dentries and inodes",
2372    "\
2373 This instructs the guest kernel to drop its page cache,
2374 and/or dentries and inode caches.  The parameter C<whattodrop>
2375 tells the kernel what precisely to drop, see
2376 L<http://linux-mm.org/Drop_Caches>
2377
2378 Setting C<whattodrop> to 3 should drop everything.
2379
2380 This automatically calls L<sync(2)> before the operation,
2381 so that the maximum guest memory is freed.");
2382
2383   ("dmesg", (RString "kmsgs", []), 91, [],
2384    [InitEmpty, Always, TestRun (
2385       [["dmesg"]])],
2386    "return kernel messages",
2387    "\
2388 This returns the kernel messages (C<dmesg> output) from
2389 the guest kernel.  This is sometimes useful for extended
2390 debugging of problems.
2391
2392 Another way to get the same information is to enable
2393 verbose messages with C<guestfs_set_verbose> or by setting
2394 the environment variable C<LIBGUESTFS_DEBUG=1> before
2395 running the program.");
2396
2397   ("ping_daemon", (RErr, []), 92, [],
2398    [InitEmpty, Always, TestRun (
2399       [["ping_daemon"]])],
2400    "ping the guest daemon",
2401    "\
2402 This is a test probe into the guestfs daemon running inside
2403 the qemu subprocess.  Calling this function checks that the
2404 daemon responds to the ping message, without affecting the daemon
2405 or attached block device(s) in any other way.");
2406
2407   ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2408    [InitBasicFS, Always, TestOutputTrue (
2409       [["write_file"; "/file1"; "contents of a file"; "0"];
2410        ["cp"; "/file1"; "/file2"];
2411        ["equal"; "/file1"; "/file2"]]);
2412     InitBasicFS, Always, TestOutputFalse (
2413       [["write_file"; "/file1"; "contents of a file"; "0"];
2414        ["write_file"; "/file2"; "contents of another file"; "0"];
2415        ["equal"; "/file1"; "/file2"]]);
2416     InitBasicFS, Always, TestLastFail (
2417       [["equal"; "/file1"; "/file2"]])],
2418    "test if two files have equal contents",
2419    "\
2420 This compares the two files C<file1> and C<file2> and returns
2421 true if their content is exactly equal, or false otherwise.
2422
2423 The external L<cmp(1)> program is used for the comparison.");
2424
2425   ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2426    [InitISOFS, Always, TestOutputList (
2427       [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2428     InitISOFS, Always, TestOutputList (
2429       [["strings"; "/empty"]], [])],
2430    "print the printable strings in a file",
2431    "\
2432 This runs the L<strings(1)> command on a file and returns
2433 the list of printable strings found.");
2434
2435   ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2436    [InitISOFS, Always, TestOutputList (
2437       [["strings_e"; "b"; "/known-5"]], []);
2438     InitBasicFS, Disabled, TestOutputList (
2439       [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2440        ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2441    "print the printable strings in a file",
2442    "\
2443 This is like the C<guestfs_strings> command, but allows you to
2444 specify the encoding.
2445
2446 See the L<strings(1)> manpage for the full list of encodings.
2447
2448 Commonly useful encodings are C<l> (lower case L) which will
2449 show strings inside Windows/x86 files.
2450
2451 The returned strings are transcoded to UTF-8.");
2452
2453   ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2454    [InitISOFS, Always, TestOutput (
2455       [["hexdump"; "/known-4"]], "00000000  61 62 63 0a 64 65 66 0a  67 68 69                 |abc.def.ghi|\n0000000b\n");
2456     (* Test for RHBZ#501888c2 regression which caused large hexdump
2457      * commands to segfault.
2458      *)
2459     InitISOFS, Always, TestRun (
2460       [["hexdump"; "/100krandom"]])],
2461    "dump a file in hexadecimal",
2462    "\
2463 This runs C<hexdump -C> on the given C<path>.  The result is
2464 the human-readable, canonical hex dump of the file.");
2465
2466   ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2467    [InitNone, Always, TestOutput (
2468       [["part_disk"; "/dev/sda"; "mbr"];
2469        ["mkfs"; "ext3"; "/dev/sda1"];
2470        ["mount_options"; ""; "/dev/sda1"; "/"];
2471        ["write_file"; "/new"; "test file"; "0"];
2472        ["umount"; "/dev/sda1"];
2473        ["zerofree"; "/dev/sda1"];
2474        ["mount_options"; ""; "/dev/sda1"; "/"];
2475        ["cat"; "/new"]], "test file")],
2476    "zero unused inodes and disk blocks on ext2/3 filesystem",
2477    "\
2478 This runs the I<zerofree> program on C<device>.  This program
2479 claims to zero unused inodes and disk blocks on an ext2/3
2480 filesystem, thus making it possible to compress the filesystem
2481 more effectively.
2482
2483 You should B<not> run this program if the filesystem is
2484 mounted.
2485
2486 It is possible that using this program can damage the filesystem
2487 or data on the filesystem.");
2488
2489   ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2490    [],
2491    "resize an LVM physical volume",
2492    "\
2493 This resizes (expands or shrinks) an existing LVM physical
2494 volume to match the new size of the underlying device.");
2495
2496   ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2497                        Int "cyls"; Int "heads"; Int "sectors";
2498                        String "line"]), 99, [DangerWillRobinson],
2499    [],
2500    "modify a single partition on a block device",
2501    "\
2502 This runs L<sfdisk(8)> option to modify just the single
2503 partition C<n> (note: C<n> counts from 1).
2504
2505 For other parameters, see C<guestfs_sfdisk>.  You should usually
2506 pass C<0> for the cyls/heads/sectors parameters.
2507
2508 See also: C<guestfs_part_add>");
2509
2510   ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2511    [],
2512    "display the partition table",
2513    "\
2514 This displays the partition table on C<device>, in the
2515 human-readable output of the L<sfdisk(8)> command.  It is
2516 not intended to be parsed.
2517
2518 See also: C<guestfs_part_list>");
2519
2520   ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2521    [],
2522    "display the kernel geometry",
2523    "\
2524 This displays the kernel's idea of the geometry of C<device>.
2525
2526 The result is in human-readable format, and not designed to
2527 be parsed.");
2528
2529   ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2530    [],
2531    "display the disk geometry from the partition table",
2532    "\
2533 This displays the disk geometry of C<device> read from the
2534 partition table.  Especially in the case where the underlying
2535 block device has been resized, this can be different from the
2536 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2537
2538 The result is in human-readable format, and not designed to
2539 be parsed.");
2540
2541   ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2542    [],
2543    "activate or deactivate all volume groups",
2544    "\
2545 This command activates or (if C<activate> is false) deactivates
2546 all logical volumes in all volume groups.
2547 If activated, then they are made known to the
2548 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
2549 then those devices disappear.
2550
2551 This command is the same as running C<vgchange -a y|n>");
2552
2553   ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2554    [],
2555    "activate or deactivate some volume groups",
2556    "\
2557 This command activates or (if C<activate> is false) deactivates
2558 all logical volumes in the listed volume groups C<volgroups>.
2559 If activated, then they are made known to the
2560 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
2561 then those devices disappear.
2562
2563 This command is the same as running C<vgchange -a y|n volgroups...>
2564
2565 Note that if C<volgroups> is an empty list then B<all> volume groups
2566 are activated or deactivated.");
2567
2568   ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2569    [InitNone, Always, TestOutput (
2570       [["part_disk"; "/dev/sda"; "mbr"];
2571        ["pvcreate"; "/dev/sda1"];
2572        ["vgcreate"; "VG"; "/dev/sda1"];
2573        ["lvcreate"; "LV"; "VG"; "10"];
2574        ["mkfs"; "ext2"; "/dev/VG/LV"];
2575        ["mount_options"; ""; "/dev/VG/LV"; "/"];
2576        ["write_file"; "/new"; "test content"; "0"];
2577        ["umount"; "/"];
2578        ["lvresize"; "/dev/VG/LV"; "20"];
2579        ["e2fsck_f"; "/dev/VG/LV"];
2580        ["resize2fs"; "/dev/VG/LV"];
2581        ["mount_options"; ""; "/dev/VG/LV"; "/"];
2582        ["cat"; "/new"]], "test content")],
2583    "resize an LVM logical volume",
2584    "\
2585 This resizes (expands or shrinks) an existing LVM logical
2586 volume to C<mbytes>.  When reducing, data in the reduced part
2587 is lost.");
2588
2589   ("resize2fs", (RErr, [Device "device"]), 106, [],
2590    [], (* lvresize tests this *)
2591    "resize an ext2/ext3 filesystem",
2592    "\
2593 This resizes an ext2 or ext3 filesystem to match the size of
2594 the underlying device.
2595
2596 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2597 on the C<device> before calling this command.  For unknown reasons
2598 C<resize2fs> sometimes gives an error about this and sometimes not.
2599 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2600 calling this function.");
2601
2602   ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2603    [InitBasicFS, Always, TestOutputList (
2604       [["find"; "/"]], ["lost+found"]);
2605     InitBasicFS, Always, TestOutputList (
2606       [["touch"; "/a"];
2607        ["mkdir"; "/b"];
2608        ["touch"; "/b/c"];
2609        ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2610     InitBasicFS, Always, TestOutputList (
2611       [["mkdir_p"; "/a/b/c"];
2612        ["touch"; "/a/b/c/d"];
2613        ["find"; "/a/b/"]], ["c"; "c/d"])],
2614    "find all files and directories",
2615    "\
2616 This command lists out all files and directories, recursively,
2617 starting at C<directory>.  It is essentially equivalent to
2618 running the shell command C<find directory -print> but some
2619 post-processing happens on the output, described below.
2620
2621 This returns a list of strings I<without any prefix>.  Thus
2622 if the directory structure was:
2623
2624  /tmp/a
2625  /tmp/b
2626  /tmp/c/d
2627
2628 then the returned list from C<guestfs_find> C</tmp> would be
2629 4 elements:
2630
2631  a
2632  b
2633  c
2634  c/d
2635
2636 If C<directory> is not a directory, then this command returns
2637 an error.
2638
2639 The returned list is sorted.
2640
2641 See also C<guestfs_find0>.");
2642
2643   ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2644    [], (* lvresize tests this *)
2645    "check an ext2/ext3 filesystem",
2646    "\
2647 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2648 filesystem checker on C<device>, noninteractively (C<-p>),
2649 even if the filesystem appears to be clean (C<-f>).
2650
2651 This command is only needed because of C<guestfs_resize2fs>
2652 (q.v.).  Normally you should use C<guestfs_fsck>.");
2653
2654   ("sleep", (RErr, [Int "secs"]), 109, [],
2655    [InitNone, Always, TestRun (
2656       [["sleep"; "1"]])],
2657    "sleep for some seconds",
2658    "\
2659 Sleep for C<secs> seconds.");
2660
2661   ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2662    [InitNone, Always, TestOutputInt (
2663       [["part_disk"; "/dev/sda"; "mbr"];
2664        ["mkfs"; "ntfs"; "/dev/sda1"];
2665        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2666     InitNone, Always, TestOutputInt (
2667       [["part_disk"; "/dev/sda"; "mbr"];
2668        ["mkfs"; "ext2"; "/dev/sda1"];
2669        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2670    "probe NTFS volume",
2671    "\
2672 This command runs the L<ntfs-3g.probe(8)> command which probes
2673 an NTFS C<device> for mountability.  (Not all NTFS volumes can
2674 be mounted read-write, and some cannot be mounted at all).
2675
2676 C<rw> is a boolean flag.  Set it to true if you want to test
2677 if the volume can be mounted read-write.  Set it to false if
2678 you want to test if the volume can be mounted read-only.
2679
2680 The return value is an integer which C<0> if the operation
2681 would succeed, or some non-zero value documented in the
2682 L<ntfs-3g.probe(8)> manual page.");
2683
2684   ("sh", (RString "output", [String "command"]), 111, [],
2685    [], (* XXX needs tests *)
2686    "run a command via the shell",
2687    "\
2688 This call runs a command from the guest filesystem via the
2689 guest's C</bin/sh>.
2690
2691 This is like C<guestfs_command>, but passes the command to:
2692
2693  /bin/sh -c \"command\"
2694
2695 Depending on the guest's shell, this usually results in
2696 wildcards being expanded, shell expressions being interpolated
2697 and so on.
2698
2699 All the provisos about C<guestfs_command> apply to this call.");
2700
2701   ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2702    [], (* XXX needs tests *)
2703    "run a command via the shell returning lines",
2704    "\
2705 This is the same as C<guestfs_sh>, but splits the result
2706 into a list of lines.
2707
2708 See also: C<guestfs_command_lines>");
2709
2710   ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2711    (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2712     * code in stubs.c, since all valid glob patterns must start with "/".
2713     * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2714     *)
2715    [InitBasicFS, Always, TestOutputList (
2716       [["mkdir_p"; "/a/b/c"];
2717        ["touch"; "/a/b/c/d"];
2718        ["touch"; "/a/b/c/e"];
2719        ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2720     InitBasicFS, Always, TestOutputList (
2721       [["mkdir_p"; "/a/b/c"];
2722        ["touch"; "/a/b/c/d"];
2723        ["touch"; "/a/b/c/e"];
2724        ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2725     InitBasicFS, Always, TestOutputList (
2726       [["mkdir_p"; "/a/b/c"];
2727        ["touch"; "/a/b/c/d"];
2728        ["touch"; "/a/b/c/e"];
2729        ["glob_expand"; "/a/*/x/*"]], [])],
2730    "expand a wildcard path",
2731    "\
2732 This command searches for all the pathnames matching
2733 C<pattern> according to the wildcard expansion rules
2734 used by the shell.
2735
2736 If no paths match, then this returns an empty list
2737 (note: not an error).
2738
2739 It is just a wrapper around the C L<glob(3)> function
2740 with flags C<GLOB_MARK|GLOB_BRACE>.
2741 See that manual page for more details.");
2742
2743   ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2744    [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2745       [["scrub_device"; "/dev/sdc"]])],
2746    "scrub (securely wipe) a device",
2747    "\
2748 This command writes patterns over C<device> to make data retrieval
2749 more difficult.
2750
2751 It is an interface to the L<scrub(1)> program.  See that
2752 manual page for more details.");
2753
2754   ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2755    [InitBasicFS, Always, TestRun (
2756       [["write_file"; "/file"; "content"; "0"];
2757        ["scrub_file"; "/file"]])],
2758    "scrub (securely wipe) a file",
2759    "\
2760 This command writes patterns over a file to make data retrieval
2761 more difficult.
2762
2763 The file is I<removed> after scrubbing.
2764
2765 It is an interface to the L<scrub(1)> program.  See that
2766 manual page for more details.");
2767
2768   ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2769    [], (* XXX needs testing *)
2770    "scrub (securely wipe) free space",
2771    "\
2772 This command creates the directory C<dir> and then fills it
2773 with files until the filesystem is full, and scrubs the files
2774 as for C<guestfs_scrub_file>, and deletes them.
2775 The intention is to scrub any free space on the partition
2776 containing C<dir>.
2777
2778 It is an interface to the L<scrub(1)> program.  See that
2779 manual page for more details.");
2780
2781   ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2782    [InitBasicFS, Always, TestRun (
2783       [["mkdir"; "/tmp"];
2784        ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2785    "create a temporary directory",
2786    "\
2787 This command creates a temporary directory.  The
2788 C<template> parameter should be a full pathname for the
2789 temporary directory name with the final six characters being
2790 \"XXXXXX\".
2791
2792 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2793 the second one being suitable for Windows filesystems.
2794
2795 The name of the temporary directory that was created
2796 is returned.
2797
2798 The temporary directory is created with mode 0700
2799 and is owned by root.
2800
2801 The caller is responsible for deleting the temporary
2802 directory and its contents after use.
2803
2804 See also: L<mkdtemp(3)>");
2805
2806   ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2807    [InitISOFS, Always, TestOutputInt (
2808       [["wc_l"; "/10klines"]], 10000)],
2809    "count lines in a file",
2810    "\
2811 This command counts the lines in a file, using the
2812 C<wc -l> external command.");
2813
2814   ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2815    [InitISOFS, Always, TestOutputInt (
2816       [["wc_w"; "/10klines"]], 10000)],
2817    "count words in a file",
2818    "\
2819 This command counts the words in a file, using the
2820 C<wc -w> external command.");
2821
2822   ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2823    [InitISOFS, Always, TestOutputInt (
2824       [["wc_c"; "/100kallspaces"]], 102400)],
2825    "count characters in a file",
2826    "\
2827 This command counts the characters in a file, using the
2828 C<wc -c> external command.");
2829
2830   ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2831    [InitISOFS, Always, TestOutputList (
2832       [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2833    "return first 10 lines of a file",
2834    "\
2835 This command returns up to the first 10 lines of a file as
2836 a list of strings.");
2837
2838   ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2839    [InitISOFS, Always, TestOutputList (
2840       [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2841     InitISOFS, Always, TestOutputList (
2842       [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2843     InitISOFS, Always, TestOutputList (
2844       [["head_n"; "0"; "/10klines"]], [])],
2845    "return first N lines of a file",
2846    "\
2847 If the parameter C<nrlines> is a positive number, this returns the first
2848 C<nrlines> lines of the file C<path>.
2849
2850 If the parameter C<nrlines> is a negative number, this returns lines
2851 from the file C<path>, excluding the last C<nrlines> lines.
2852
2853 If the parameter C<nrlines> is zero, this returns an empty list.");
2854
2855   ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2856    [InitISOFS, Always, TestOutputList (
2857       [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2858    "return last 10 lines of a file",
2859    "\
2860 This command returns up to the last 10 lines of a file as
2861 a list of strings.");
2862
2863   ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2864    [InitISOFS, Always, TestOutputList (
2865       [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2866     InitISOFS, Always, TestOutputList (
2867       [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2868     InitISOFS, Always, TestOutputList (
2869       [["tail_n"; "0"; "/10klines"]], [])],
2870    "return last N lines of a file",
2871    "\
2872 If the parameter C<nrlines> is a positive number, this returns the last
2873 C<nrlines> lines of the file C<path>.
2874
2875 If the parameter C<nrlines> is a negative number, this returns lines
2876 from the file C<path>, starting with the C<-nrlines>th line.
2877
2878 If the parameter C<nrlines> is zero, this returns an empty list.");
2879
2880   ("df", (RString "output", []), 125, [],
2881    [], (* XXX Tricky to test because it depends on the exact format
2882         * of the 'df' command and other imponderables.
2883         *)
2884    "report file system disk space usage",
2885    "\
2886 This command runs the C<df> command to report disk space used.
2887
2888 This command is mostly useful for interactive sessions.  It
2889 is I<not> intended that you try to parse the output string.
2890 Use C<statvfs> from programs.");
2891
2892   ("df_h", (RString "output", []), 126, [],
2893    [], (* XXX Tricky to test because it depends on the exact format
2894         * of the 'df' command and other imponderables.
2895         *)
2896    "report file system disk space usage (human readable)",
2897    "\
2898 This command runs the C<df -h> command to report disk space used
2899 in human-readable format.
2900
2901 This command is mostly useful for interactive sessions.  It
2902 is I<not> intended that you try to parse the output string.
2903 Use C<statvfs> from programs.");
2904
2905   ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2906    [InitISOFS, Always, TestOutputInt (
2907       [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2908    "estimate file space usage",
2909    "\
2910 This command runs the C<du -s> command to estimate file space
2911 usage for C<path>.
2912
2913 C<path> can be a file or a directory.  If C<path> is a directory
2914 then the estimate includes the contents of the directory and all
2915 subdirectories (recursively).
2916
2917 The result is the estimated size in I<kilobytes>
2918 (ie. units of 1024 bytes).");
2919
2920   ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2921    [InitISOFS, Always, TestOutputList (
2922       [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2923    "list files in an initrd",
2924    "\
2925 This command lists out files contained in an initrd.
2926
2927 The files are listed without any initial C</> character.  The
2928 files are listed in the order they appear (not necessarily
2929 alphabetical).  Directory names are listed as separate items.
2930
2931 Old Linux kernels (2.4 and earlier) used a compressed ext2
2932 filesystem as initrd.  We I<only> support the newer initramfs
2933 format (compressed cpio files).");
2934
2935   ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
2936    [],
2937    "mount a file using the loop device",
2938    "\
2939 This command lets you mount C<file> (a filesystem image
2940 in a file) on a mount point.  It is entirely equivalent to
2941 the command C<mount -o loop file mountpoint>.");
2942
2943   ("mkswap", (RErr, [Device "device"]), 130, [],
2944    [InitEmpty, Always, TestRun (
2945       [["part_disk"; "/dev/sda"; "mbr"];
2946        ["mkswap"; "/dev/sda1"]])],
2947    "create a swap partition",
2948    "\
2949 Create a swap partition on C<device>.");
2950
2951   ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
2952    [InitEmpty, Always, TestRun (
2953       [["part_disk"; "/dev/sda"; "mbr"];
2954        ["mkswap_L"; "hello"; "/dev/sda1"]])],
2955    "create a swap partition with a label",
2956    "\
2957 Create a swap partition on C<device> with label C<label>.
2958
2959 Note that you cannot attach a swap label to a block device
2960 (eg. C</dev/sda>), just to a partition.  This appears to be
2961 a limitation of the kernel or swap tools.");
2962
2963   ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
2964    (let uuid = uuidgen () in
2965     [InitEmpty, Always, TestRun (
2966        [["part_disk"; "/dev/sda"; "mbr"];
2967         ["mkswap_U"; uuid; "/dev/sda1"]])]),
2968    "create a swap partition with an explicit UUID",
2969    "\
2970 Create a swap partition on C<device> with UUID C<uuid>.");
2971
2972   ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
2973    [InitBasicFS, Always, TestOutputStruct (
2974       [["mknod"; "0o10777"; "0"; "0"; "/node"];
2975        (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2976        ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2977     InitBasicFS, Always, TestOutputStruct (
2978       [["mknod"; "0o60777"; "66"; "99"; "/node"];
2979        ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2980    "make block, character or FIFO devices",
2981    "\
2982 This call creates block or character special devices, or
2983 named pipes (FIFOs).
2984
2985 The C<mode> parameter should be the mode, using the standard
2986 constants.  C<devmajor> and C<devminor> are the
2987 device major and minor numbers, only used when creating block
2988 and character special devices.");
2989
2990   ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
2991    [InitBasicFS, Always, TestOutputStruct (
2992       [["mkfifo"; "0o777"; "/node"];
2993        ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2994    "make FIFO (named pipe)",
2995    "\
2996 This call creates a FIFO (named pipe) called C<path> with
2997 mode C<mode>.  It is just a convenient wrapper around
2998 C<guestfs_mknod>.");
2999
3000   ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3001    [InitBasicFS, Always, TestOutputStruct (
3002       [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3003        ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3004    "make block device node",
3005    "\
3006 This call creates a block device node called C<path> with
3007 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3008 It is just a convenient wrapper around C<guestfs_mknod>.");
3009
3010   ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3011    [InitBasicFS, Always, TestOutputStruct (
3012       [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3013        ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3014    "make char device node",
3015    "\
3016 This call creates a char device node called C<path> with
3017 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3018 It is just a convenient wrapper around C<guestfs_mknod>.");
3019
3020   ("umask", (RInt "oldmask", [Int "mask"]), 137, [FishOutput FishOutputOctal],
3021    [InitEmpty, Always, TestOutputInt (
3022       [["umask"; "0o22"]], 0o22)],
3023    "set file mode creation mask (umask)",
3024    "\
3025 This function sets the mask used for creating new files and
3026 device nodes to C<mask & 0777>.
3027
3028 Typical umask values would be C<022> which creates new files
3029 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3030 C<002> which creates new files with permissions like
3031 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3032
3033 The default umask is C<022>.  This is important because it
3034 means that directories and device nodes will be created with
3035 C<0644> or C<0755> mode even if you specify C<0777>.
3036
3037 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3038
3039 This call returns the previous umask.");
3040
3041   ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3042    [],
3043    "read directories entries",
3044    "\
3045 This returns the list of directory entries in directory C<dir>.
3046
3047 All entries in the directory are returned, including C<.> and
3048 C<..>.  The entries are I<not> sorted, but returned in the same
3049 order as the underlying filesystem.
3050
3051 Also this call returns basic file type information about each
3052 file.  The C<ftyp> field will contain one of the following characters:
3053
3054 =over 4
3055
3056 =item 'b'
3057
3058 Block special
3059
3060 =item 'c'
3061
3062 Char special
3063
3064 =item 'd'
3065
3066 Directory
3067
3068 =item 'f'
3069
3070 FIFO (named pipe)
3071
3072 =item 'l'
3073
3074 Symbolic link
3075
3076 =item 'r'
3077
3078 Regular file
3079
3080 =item 's'
3081
3082 Socket
3083
3084 =item 'u'
3085
3086 Unknown file type
3087
3088 =item '?'
3089
3090 The L<readdir(3)> returned a C<d_type> field with an
3091 unexpected value
3092
3093 =back
3094
3095 This function is primarily intended for use by programs.  To
3096 get a simple list of names, use C<guestfs_ls>.  To get a printable
3097 directory for human consumption, use C<guestfs_ll>.");
3098
3099   ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3100    [],
3101    "create partitions on a block device",
3102    "\
3103 This is a simplified interface to the C<guestfs_sfdisk>
3104 command, where partition sizes are specified in megabytes
3105 only (rounded to the nearest cylinder) and you don't need
3106 to specify the cyls, heads and sectors parameters which
3107 were rarely if ever used anyway.
3108
3109 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3110 and C<guestfs_part_disk>");
3111
3112   ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3113    [],
3114    "determine file type inside a compressed file",
3115    "\
3116 This command runs C<file> after first decompressing C<path>
3117 using C<method>.
3118
3119 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3120
3121 Since 1.0.63, use C<guestfs_file> instead which can now
3122 process compressed files.");
3123
3124   ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3125    [],
3126    "list extended attributes of a file or directory",
3127    "\
3128 This call lists the extended attributes of the file or directory
3129 C<path>.
3130
3131 At the system call level, this is a combination of the
3132 L<listxattr(2)> and L<getxattr(2)> calls.
3133
3134 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3135
3136   ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3137    [],
3138    "list extended attributes of a file or directory",
3139    "\
3140 This is the same as C<guestfs_getxattrs>, but if C<path>
3141 is a symbolic link, then it returns the extended attributes
3142 of the link itself.");
3143
3144   ("setxattr", (RErr, [String "xattr";
3145                        String "val"; Int "vallen"; (* will be BufferIn *)
3146                        Pathname "path"]), 143, [Optional "linuxxattrs"],
3147    [],
3148    "set extended attribute of a file or directory",
3149    "\
3150 This call sets the extended attribute named C<xattr>
3151 of the file C<path> to the value C<val> (of length C<vallen>).
3152 The value is arbitrary 8 bit data.
3153
3154 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3155
3156   ("lsetxattr", (RErr, [String "xattr";
3157                         String "val"; Int "vallen"; (* will be BufferIn *)
3158                         Pathname "path"]), 144, [Optional "linuxxattrs"],
3159    [],
3160    "set extended attribute of a file or directory",
3161    "\
3162 This is the same as C<guestfs_setxattr>, but if C<path>
3163 is a symbolic link, then it sets an extended attribute
3164 of the link itself.");
3165
3166   ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3167    [],
3168    "remove extended attribute of a file or directory",
3169    "\
3170 This call removes the extended attribute named C<xattr>
3171 of the file C<path>.
3172
3173 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3174
3175   ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3176    [],
3177    "remove extended attribute of a file or directory",
3178    "\
3179 This is the same as C<guestfs_removexattr>, but if C<path>
3180 is a symbolic link, then it removes an extended attribute
3181 of the link itself.");
3182
3183   ("mountpoints", (RHashtable "mps", []), 147, [],
3184    [],
3185    "show mountpoints",
3186    "\
3187 This call is similar to C<guestfs_mounts>.  That call returns
3188 a list of devices.  This one returns a hash table (map) of
3189 device name to directory where the device is mounted.");
3190
3191   ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3192    (* This is a special case: while you would expect a parameter
3193     * of type "Pathname", that doesn't work, because it implies
3194     * NEED_ROOT in the generated calling code in stubs.c, and
3195     * this function cannot use NEED_ROOT.
3196     *)
3197    [],
3198    "create a mountpoint",
3199    "\
3200 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3201 specialized calls that can be used to create extra mountpoints
3202 before mounting the first filesystem.
3203
3204 These calls are I<only> necessary in some very limited circumstances,
3205 mainly the case where you want to mount a mix of unrelated and/or
3206 read-only filesystems together.
3207
3208 For example, live CDs often contain a \"Russian doll\" nest of
3209 filesystems, an ISO outer layer, with a squashfs image inside, with
3210 an ext2/3 image inside that.  You can unpack this as follows
3211 in guestfish:
3212
3213  add-ro Fedora-11-i686-Live.iso
3214  run
3215  mkmountpoint /cd
3216  mkmountpoint /squash
3217  mkmountpoint /ext3
3218  mount /dev/sda /cd
3219  mount-loop /cd/LiveOS/squashfs.img /squash
3220  mount-loop /squash/LiveOS/ext3fs.img /ext3
3221
3222 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3223
3224   ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3225    [],
3226    "remove a mountpoint",
3227    "\
3228 This calls removes a mountpoint that was previously created
3229 with C<guestfs_mkmountpoint>.  See C<guestfs_mkmountpoint>
3230 for full details.");
3231
3232   ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3233    [InitISOFS, Always, TestOutputBuffer (
3234       [["read_file"; "/known-4"]], "abc\ndef\nghi")],
3235    "read a file",
3236    "\
3237 This calls returns the contents of the file C<path> as a
3238 buffer.
3239
3240 Unlike C<guestfs_cat>, this function can correctly
3241 handle files that contain embedded ASCII NUL characters.
3242 However unlike C<guestfs_download>, this function is limited
3243 in the total size of file that can be handled.");
3244
3245   ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3246    [InitISOFS, Always, TestOutputList (
3247       [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3248     InitISOFS, Always, TestOutputList (
3249       [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3250    "return lines matching a pattern",
3251    "\
3252 This calls the external C<grep> program and returns the
3253 matching lines.");
3254
3255   ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3256    [InitISOFS, Always, TestOutputList (
3257       [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3258    "return lines matching a pattern",
3259    "\
3260 This calls the external C<egrep> program and returns the
3261 matching lines.");
3262
3263   ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3264    [InitISOFS, Always, TestOutputList (
3265       [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3266    "return lines matching a pattern",
3267    "\
3268 This calls the external C<fgrep> program and returns the
3269 matching lines.");
3270
3271   ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3272    [InitISOFS, Always, TestOutputList (
3273       [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3274    "return lines matching a pattern",
3275    "\
3276 This calls the external C<grep -i> program and returns the
3277 matching lines.");
3278
3279   ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3280    [InitISOFS, Always, TestOutputList (
3281       [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3282    "return lines matching a pattern",
3283    "\
3284 This calls the external C<egrep -i> program and returns the
3285 matching lines.");
3286
3287   ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3288    [InitISOFS, Always, TestOutputList (
3289       [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3290    "return lines matching a pattern",
3291    "\
3292 This calls the external C<fgrep -i> program and returns the
3293 matching lines.");
3294
3295   ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3296    [InitISOFS, Always, TestOutputList (
3297       [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3298    "return lines matching a pattern",
3299    "\
3300 This calls the external C<zgrep> program and returns the
3301 matching lines.");
3302
3303   ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3304    [InitISOFS, Always, TestOutputList (
3305       [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3306    "return lines matching a pattern",
3307    "\
3308 This calls the external C<zegrep> program and returns the
3309 matching lines.");
3310
3311   ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3312    [InitISOFS, Always, TestOutputList (
3313       [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3314    "return lines matching a pattern",
3315    "\
3316 This calls the external C<zfgrep> program and returns the
3317 matching lines.");
3318
3319   ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3320    [InitISOFS, Always, TestOutputList (
3321       [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3322    "return lines matching a pattern",
3323    "\
3324 This calls the external C<zgrep -i> program and returns the
3325 matching lines.");
3326
3327   ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3328    [InitISOFS, Always, TestOutputList (
3329       [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3330    "return lines matching a pattern",
3331    "\
3332 This calls the external C<zegrep -i> program and returns the
3333 matching lines.");
3334
3335   ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3336    [InitISOFS, Always, TestOutputList (
3337       [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3338    "return lines matching a pattern",
3339    "\
3340 This calls the external C<zfgrep -i> program and returns the
3341 matching lines.");
3342
3343   ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3344    [InitISOFS, Always, TestOutput (
3345       [["realpath"; "/../directory"]], "/directory")],
3346    "canonicalized absolute pathname",
3347    "\
3348 Return the canonicalized absolute pathname of C<path>.  The
3349 returned path has no C<.>, C<..> or symbolic link path elements.");
3350
3351   ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3352    [InitBasicFS, Always, TestOutputStruct (
3353       [["touch"; "/a"];
3354        ["ln"; "/a"; "/b"];
3355        ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3356    "create a hard link",
3357    "\
3358 This command creates a hard link using the C<ln> command.");
3359
3360   ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3361    [InitBasicFS, Always, TestOutputStruct (
3362       [["touch"; "/a"];
3363        ["touch"; "/b"];
3364        ["ln_f"; "/a"; "/b"];
3365        ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3366    "create a hard link",
3367    "\
3368 This command creates a hard link using the C<ln -f> command.
3369 The C<-f> option removes the link (C<linkname>) if it exists already.");
3370
3371   ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3372    [InitBasicFS, Always, TestOutputStruct (
3373       [["touch"; "/a"];
3374        ["ln_s"; "a"; "/b"];
3375        ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3376    "create a symbolic link",
3377    "\
3378 This command creates a symbolic link using the C<ln -s> command.");
3379
3380   ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3381    [InitBasicFS, Always, TestOutput (
3382       [["mkdir_p"; "/a/b"];
3383        ["touch"; "/a/b/c"];
3384        ["ln_sf"; "../d"; "/a/b/c"];
3385        ["readlink"; "/a/b/c"]], "../d")],
3386    "create a symbolic link",
3387    "\
3388 This command creates a symbolic link using the C<ln -sf> command,
3389 The C<-f> option removes the link (C<linkname>) if it exists already.");
3390
3391   ("readlink", (RString "link", [Pathname "path"]), 168, [],
3392    [] (* XXX tested above *),
3393    "read the target of a symbolic link",
3394    "\
3395 This command reads the target of a symbolic link.");
3396
3397   ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [],
3398    [InitBasicFS, Always, TestOutputStruct (
3399       [["fallocate"; "/a"; "1000000"];
3400        ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3401    "preallocate a file in the guest filesystem",
3402    "\
3403 This command preallocates a file (containing zero bytes) named
3404 C<path> of size C<len> bytes.  If the file exists already, it
3405 is overwritten.
3406
3407 Do not confuse this with the guestfish-specific
3408 C<alloc> command which allocates a file in the host and
3409 attaches it as a device.");
3410
3411   ("swapon_device", (RErr, [Device "device"]), 170, [],
3412    [InitPartition, Always, TestRun (
3413       [["mkswap"; "/dev/sda1"];
3414        ["swapon_device"; "/dev/sda1"];
3415        ["swapoff_device"; "/dev/sda1"]])],
3416    "enable swap on device",
3417    "\
3418 This command enables the libguestfs appliance to use the
3419 swap device or partition named C<device>.  The increased
3420 memory is made available for all commands, for example
3421 those run using C<guestfs_command> or C<guestfs_sh>.
3422
3423 Note that you should not swap to existing guest swap
3424 partitions unless you know what you are doing.  They may
3425 contain hibernation information, or other information that
3426 the guest doesn't want you to trash.  You also risk leaking
3427 information about the host to the guest this way.  Instead,
3428 attach a new host device to the guest and swap on that.");
3429
3430   ("swapoff_device", (RErr, [Device "device"]), 171, [],
3431    [], (* XXX tested by swapon_device *)
3432    "disable swap on device",
3433    "\
3434 This command disables the libguestfs appliance swap
3435 device or partition named C<device>.
3436 See C<guestfs_swapon_device>.");
3437
3438   ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3439    [InitBasicFS, Always, TestRun (
3440       [["fallocate"; "/swap"; "8388608"];
3441        ["mkswap_file"; "/swap"];
3442        ["swapon_file"; "/swap"];
3443        ["swapoff_file"; "/swap"]])],
3444    "enable swap on file",
3445    "\
3446 This command enables swap to a file.
3447 See C<guestfs_swapon_device> for other notes.");
3448
3449   ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3450    [], (* XXX tested by swapon_file *)
3451    "disable swap on file",
3452    "\
3453 This command disables the libguestfs appliance swap on file.");
3454
3455   ("swapon_label", (RErr, [String "label"]), 174, [],
3456    [InitEmpty, Always, TestRun (
3457       [["part_disk"; "/dev/sdb"; "mbr"];
3458        ["mkswap_L"; "swapit"; "/dev/sdb1"];
3459        ["swapon_label"; "swapit"];
3460        ["swapoff_label"; "swapit"];
3461        ["zero"; "/dev/sdb"];
3462        ["blockdev_rereadpt"; "/dev/sdb"]])],
3463    "enable swap on labeled swap partition",
3464    "\
3465 This command enables swap to a labeled swap partition.
3466 See C<guestfs_swapon_device> for other notes.");
3467
3468   ("swapoff_label", (RErr, [String "label"]), 175, [],
3469    [], (* XXX tested by swapon_label *)
3470    "disable swap on labeled swap partition",
3471    "\
3472 This command disables the libguestfs appliance swap on
3473 labeled swap partition.");
3474
3475   ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3476    (let uuid = uuidgen () in
3477     [InitEmpty, Always, TestRun (
3478        [["mkswap_U"; uuid; "/dev/sdb"];
3479         ["swapon_uuid"; uuid];
3480         ["swapoff_uuid"; uuid]])]),
3481    "enable swap on swap partition by UUID",
3482    "\
3483 This command enables swap to a swap partition with the given UUID.
3484 See C<guestfs_swapon_device> for other notes.");
3485
3486   ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3487    [], (* XXX tested by swapon_uuid *)
3488    "disable swap on swap partition by UUID",
3489    "\
3490 This command disables the libguestfs appliance swap partition
3491 with the given UUID.");
3492
3493   ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3494    [InitBasicFS, Always, TestRun (
3495       [["fallocate"; "/swap"; "8388608"];
3496        ["mkswap_file"; "/swap"]])],
3497    "create a swap file",
3498    "\
3499 Create a swap file.
3500
3501 This command just writes a swap file signature to an existing
3502 file.  To create the file itself, use something like C<guestfs_fallocate>.");
3503
3504   ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3505    [InitISOFS, Always, TestRun (
3506       [["inotify_init"; "0"]])],
3507    "create an inotify handle",
3508    "\
3509 This command creates a new inotify handle.
3510 The inotify subsystem can be used to notify events which happen to
3511 objects in the guest filesystem.
3512
3513 C<maxevents> is the maximum number of events which will be
3514 queued up between calls to C<guestfs_inotify_read> or
3515 C<guestfs_inotify_files>.
3516 If this is passed as C<0>, then the kernel (or previously set)
3517 default is used.  For Linux 2.6.29 the default was 16384 events.
3518 Beyond this limit, the kernel throws away events, but records
3519 the fact that it threw them away by setting a flag
3520 C<IN_Q_OVERFLOW> in the returned structure list (see
3521 C<guestfs_inotify_read>).
3522
3523 Before any events are generated, you have to add some
3524 watches to the internal watch list.  See:
3525 C<guestfs_inotify_add_watch>,
3526 C<guestfs_inotify_rm_watch> and
3527 C<guestfs_inotify_watch_all>.
3528
3529 Queued up events should be read periodically by calling
3530 C<guestfs_inotify_read>
3531 (or C<guestfs_inotify_files> which is just a helpful
3532 wrapper around C<guestfs_inotify_read>).  If you don't
3533 read the events out often enough then you risk the internal
3534 queue overflowing.
3535
3536 The handle should be closed after use by calling
3537 C<guestfs_inotify_close>.  This also removes any
3538 watches automatically.
3539
3540 See also L<inotify(7)> for an overview of the inotify interface
3541 as exposed by the Linux kernel, which is roughly what we expose
3542 via libguestfs.  Note that there is one global inotify handle
3543 per libguestfs instance.");
3544
3545   ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3546    [InitBasicFS, Always, TestOutputList (
3547       [["inotify_init"; "0"];
3548        ["inotify_add_watch"; "/"; "1073741823"];
3549        ["touch"; "/a"];
3550        ["touch"; "/b"];
3551        ["inotify_files"]], ["a"; "b"])],
3552    "add an inotify watch",
3553    "\
3554 Watch C<path> for the events listed in C<mask>.
3555
3556 Note that if C<path> is a directory then events within that
3557 directory are watched, but this does I<not> happen recursively
3558 (in subdirectories).
3559
3560 Note for non-C or non-Linux callers: the inotify events are
3561 defined by the Linux kernel ABI and are listed in
3562 C</usr/include/sys/inotify.h>.");
3563
3564   ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3565    [],
3566    "remove an inotify watch",
3567    "\
3568 Remove a previously defined inotify watch.
3569 See C<guestfs_inotify_add_watch>.");
3570
3571   ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3572    [],
3573    "return list of inotify events",
3574    "\
3575 Return the complete queue of events that have happened
3576 since the previous read call.
3577
3578 If no events have happened, this returns an empty list.
3579
3580 I<Note>: In order to make sure that all events have been
3581 read, you must call this function repeatedly until it
3582 returns an empty list.  The reason is that the call will
3583 read events up to the maximum appliance-to-host message
3584 size and leave remaining events in the queue.");
3585
3586   ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3587    [],
3588    "return list of watched files that had events",
3589    "\
3590 This function is a helpful wrapper around C<guestfs_inotify_read>
3591 which just returns a list of pathnames of objects that were
3592 touched.  The returned pathnames are sorted and deduplicated.");
3593
3594   ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3595    [],
3596    "close the inotify handle",
3597    "\
3598 This closes the inotify handle which was previously
3599 opened by inotify_init.  It removes all watches, throws
3600 away any pending events, and deallocates all resources.");
3601
3602   ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3603    [],
3604    "set SELinux security context",
3605    "\
3606 This sets the SELinux security context of the daemon
3607 to the string C<context>.
3608
3609 See the documentation about SELINUX in L<guestfs(3)>.");
3610
3611   ("getcon", (RString "context", []), 186, [Optional "selinux"],
3612    [],
3613    "get SELinux security context",
3614    "\
3615 This gets the SELinux security context of the daemon.
3616
3617 See the documentation about SELINUX in L<guestfs(3)>,
3618 and C<guestfs_setcon>");
3619
3620   ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3621    [InitEmpty, Always, TestOutput (
3622       [["part_disk"; "/dev/sda"; "mbr"];
3623        ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3624        ["mount_options"; ""; "/dev/sda1"; "/"];
3625        ["write_file"; "/new"; "new file contents"; "0"];
3626        ["cat"; "/new"]], "new file contents")],
3627    "make a filesystem with block size",
3628    "\
3629 This call is similar to C<guestfs_mkfs>, but it allows you to
3630 control the block size of the resulting filesystem.  Supported
3631 block sizes depend on the filesystem type, but typically they
3632 are C<1024>, C<2048> or C<4096> only.");
3633
3634   ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3635    [InitEmpty, Always, TestOutput (
3636       [["sfdiskM"; "/dev/sda"; ",100 ,"];
3637        ["mke2journal"; "4096"; "/dev/sda1"];
3638        ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3639        ["mount_options"; ""; "/dev/sda2"; "/"];
3640        ["write_file"; "/new"; "new file contents"; "0"];
3641        ["cat"; "/new"]], "new file contents")],
3642    "make ext2/3/4 external journal",
3643    "\
3644 This creates an ext2 external journal on C<device>.  It is equivalent
3645 to the command:
3646
3647  mke2fs -O journal_dev -b blocksize device");
3648
3649   ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3650    [InitEmpty, Always, TestOutput (
3651       [["sfdiskM"; "/dev/sda"; ",100 ,"];
3652        ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3653        ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3654        ["mount_options"; ""; "/dev/sda2"; "/"];
3655        ["write_file"; "/new"; "new file contents"; "0"];
3656        ["cat"; "/new"]], "new file contents")],
3657    "make ext2/3/4 external journal with label",
3658    "\
3659 This creates an ext2 external journal on C<device> with label C<label>.");
3660
3661   ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3662    (let uuid = uuidgen () in
3663     [InitEmpty, Always, TestOutput (
3664        [["sfdiskM"; "/dev/sda"; ",100 ,"];
3665         ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3666         ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3667         ["mount_options"; ""; "/dev/sda2"; "/"];
3668         ["write_file"; "/new"; "new file contents"; "0"];
3669         ["cat"; "/new"]], "new file contents")]),
3670    "make ext2/3/4 external journal with UUID",
3671    "\
3672 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3673
3674   ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3675    [],
3676    "make ext2/3/4 filesystem with external journal",
3677    "\
3678 This creates an ext2/3/4 filesystem on C<device> with
3679 an external journal on C<journal>.  It is equivalent
3680 to the command:
3681
3682  mke2fs -t fstype -b blocksize -J device=<journal> <device>
3683
3684 See also C<guestfs_mke2journal>.");
3685
3686   ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3687    [],
3688    "make ext2/3/4 filesystem with external journal",
3689    "\
3690 This creates an ext2/3/4 filesystem on C<device> with
3691 an external journal on the journal labeled C<label>.
3692
3693 See also C<guestfs_mke2journal_L>.");
3694
3695   ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3696    [],
3697    "make ext2/3/4 filesystem with external journal",
3698    "\
3699 This creates an ext2/3/4 filesystem on C<device> with
3700 an external journal on the journal with UUID C<uuid>.
3701
3702 See also C<guestfs_mke2journal_U>.");
3703
3704   ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3705    [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3706    "load a kernel module",
3707    "\
3708 This loads a kernel module in the appliance.
3709
3710 The kernel module must have been whitelisted when libguestfs
3711 was built (see C<appliance/kmod.whitelist.in> in the source).");
3712
3713   ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3714    [InitNone, Always, TestOutput (
3715       [["echo_daemon"; "This is a test"]], "This is a test"
3716     )],
3717    "echo arguments back to the client",
3718    "\
3719 This command concatenate the list of C<words> passed with single spaces between
3720 them and returns the resulting string.
3721
3722 You can use this command to test the connection through to the daemon.
3723
3724 See also C<guestfs_ping_daemon>.");
3725
3726   ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3727    [], (* There is a regression test for this. *)
3728    "find all files and directories, returning NUL-separated list",
3729    "\
3730 This command lists out all files and directories, recursively,
3731 starting at C<directory>, placing the resulting list in the
3732 external file called C<files>.
3733
3734 This command works the same way as C<guestfs_find> with the
3735 following exceptions:
3736
3737 =over 4
3738
3739 =item *
3740
3741 The resulting list is written to an external file.
3742
3743 =item *
3744
3745 Items (filenames) in the result are separated
3746 by C<\\0> characters.  See L<find(1)> option I<-print0>.
3747
3748 =item *
3749
3750 This command is not limited in the number of names that it
3751 can return.
3752
3753 =item *
3754
3755 The result list is not sorted.
3756
3757 =back");
3758
3759   ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3760    [InitISOFS, Always, TestOutput (
3761       [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3762     InitISOFS, Always, TestOutput (
3763       [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3764     InitISOFS, Always, TestOutput (
3765       [["case_sensitive_path"; "/Known-1"]], "/known-1");
3766     InitISOFS, Always, TestLastFail (
3767       [["case_sensitive_path"; "/Known-1/"]]);
3768     InitBasicFS, Always, TestOutput (
3769       [["mkdir"; "/a"];
3770        ["mkdir"; "/a/bbb"];
3771        ["touch"; "/a/bbb/c"];
3772        ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3773     InitBasicFS, Always, TestOutput (
3774       [["mkdir"; "/a"];
3775        ["mkdir"; "/a/bbb"];
3776        ["touch"; "/a/bbb/c"];
3777        ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3778     InitBasicFS, Always, TestLastFail (
3779       [["mkdir"; "/a"];
3780        ["mkdir"; "/a/bbb"];
3781        ["touch"; "/a/bbb/c"];
3782        ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3783    "return true path on case-insensitive filesystem",
3784    "\
3785 This can be used to resolve case insensitive paths on
3786 a filesystem which is case sensitive.  The use case is
3787 to resolve paths which you have read from Windows configuration
3788 files or the Windows Registry, to the true path.
3789
3790 The command handles a peculiarity of the Linux ntfs-3g
3791 filesystem driver (and probably others), which is that although
3792 the underlying filesystem is case-insensitive, the driver
3793 exports the filesystem to Linux as case-sensitive.
3794
3795 One consequence of this is that special directories such
3796 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3797 (or other things) depending on the precise details of how
3798 they were created.  In Windows itself this would not be
3799 a problem.
3800
3801 Bug or feature?  You decide:
3802 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3803
3804 This function resolves the true case of each element in the
3805 path and returns the case-sensitive path.
3806
3807 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3808 might return C<\"/WINDOWS/system32\"> (the exact return value
3809 would depend on details of how the directories were originally
3810 created under Windows).
3811
3812 I<Note>:
3813 This function does not handle drive names, backslashes etc.
3814
3815 See also C<guestfs_realpath>.");
3816
3817   ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3818    [InitBasicFS, Always, TestOutput (
3819       [["vfs_type"; "/dev/sda1"]], "ext2")],
3820    "get the Linux VFS type corresponding to a mounted device",
3821    "\
3822 This command gets the block device type corresponding to
3823 a mounted device called C<device>.
3824
3825 Usually the result is the name of the Linux VFS module that
3826 is used to mount this device (probably determined automatically
3827 if you used the C<guestfs_mount> call).");
3828
3829   ("truncate", (RErr, [Pathname "path"]), 199, [],
3830    [InitBasicFS, Always, TestOutputStruct (
3831       [["write_file"; "/test"; "some stuff so size is not zero"; "0"];
3832        ["truncate"; "/test"];
3833        ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3834    "truncate a file to zero size",
3835    "\
3836 This command truncates C<path> to a zero-length file.  The
3837 file must exist already.");
3838
3839   ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3840    [InitBasicFS, Always, TestOutputStruct (
3841       [["touch"; "/test"];
3842        ["truncate_size"; "/test"; "1000"];
3843        ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3844    "truncate a file to a particular size",
3845    "\
3846 This command truncates C<path> to size C<size> bytes.  The file
3847 must exist already.  If the file is smaller than C<size> then
3848 the file is extended to the required size with null bytes.");
3849
3850   ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3851    [InitBasicFS, Always, TestOutputStruct (
3852       [["touch"; "/test"];
3853        ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
3854        ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
3855    "set timestamp of a file with nanosecond precision",
3856    "\
3857 This command sets the timestamps of a file with nanosecond
3858 precision.
3859
3860 C<atsecs, atnsecs> are the last access time (atime) in secs and
3861 nanoseconds from the epoch.
3862
3863 C<mtsecs, mtnsecs> are the last modification time (mtime) in
3864 secs and nanoseconds from the epoch.
3865
3866 If the C<*nsecs> field contains the special value C<-1> then
3867 the corresponding timestamp is set to the current time.  (The
3868 C<*secs> field is ignored in this case).
3869
3870 If the C<*nsecs> field contains the special value C<-2> then
3871 the corresponding timestamp is left unchanged.  (The
3872 C<*secs> field is ignored in this case).");
3873
3874   ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
3875    [InitBasicFS, Always, TestOutputStruct (
3876       [["mkdir_mode"; "/test"; "0o111"];
3877        ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
3878    "create a directory with a particular mode",
3879    "\
3880 This command creates a directory, setting the initial permissions
3881 of the directory to C<mode>.  See also C<guestfs_mkdir>.");
3882
3883   ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
3884    [], (* XXX *)
3885    "change file owner and group",
3886    "\
3887 Change the file owner to C<owner> and group to C<group>.
3888 This is like C<guestfs_chown> but if C<path> is a symlink then
3889 the link itself is changed, not the target.
3890
3891 Only numeric uid and gid are supported.  If you want to use
3892 names, you will need to locate and parse the password file
3893 yourself (Augeas support makes this relatively easy).");
3894
3895   ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
3896    [], (* XXX *)
3897    "lstat on multiple files",
3898    "\
3899 This call allows you to perform the C<guestfs_lstat> operation
3900 on multiple files, where all files are in the directory C<path>.
3901 C<names> is the list of files from this directory.
3902
3903 On return you get a list of stat structs, with a one-to-one
3904 correspondence to the C<names> list.  If any name did not exist
3905 or could not be lstat'd, then the C<ino> field of that structure
3906 is set to C<-1>.
3907
3908 This call is intended for programs that want to efficiently
3909 list a directory contents without making many round-trips.
3910 See also C<guestfs_lxattrlist> for a similarly efficient call
3911 for getting extended attributes.  Very long directory listings
3912 might cause the protocol message size to be exceeded, causing
3913 this call to fail.  The caller must split up such requests
3914 into smaller groups of names.");
3915
3916   ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
3917    [], (* XXX *)
3918    "lgetxattr on multiple files",
3919    "\
3920 This call allows you to get the extended attributes
3921 of multiple files, where all files are in the directory C<path>.
3922 C<names> is the list of files from this directory.
3923
3924 On return you get a flat list of xattr structs which must be
3925 interpreted sequentially.  The first xattr struct always has a zero-length
3926 C<attrname>.  C<attrval> in this struct is zero-length
3927 to indicate there was an error doing C<lgetxattr> for this
3928 file, I<or> is a C string which is a decimal number
3929 (the number of following attributes for this file, which could
3930 be C<\"0\">).  Then after the first xattr struct are the
3931 zero or more attributes for the first named file.
3932 This repeats for the second and subsequent files.
3933
3934 This call is intended for programs that want to efficiently
3935 list a directory contents without making many round-trips.
3936 See also C<guestfs_lstatlist> for a similarly efficient call
3937 for getting standard stats.  Very long directory listings
3938 might cause the protocol message size to be exceeded, causing
3939 this call to fail.  The caller must split up such requests
3940 into smaller groups of names.");
3941
3942   ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
3943    [], (* XXX *)
3944    "readlink on multiple files",
3945    "\
3946 This call allows you to do a C<readlink> operation
3947 on multiple files, where all files are in the directory C<path>.
3948 C<names> is the list of files from this directory.
3949
3950 On return you get a list of strings, with a one-to-one
3951 correspondence to the C<names> list.  Each string is the
3952 value of the symbol link.
3953
3954 If the C<readlink(2)> operation fails on any name, then
3955 the corresponding result string is the empty string C<\"\">.
3956 However the whole operation is completed even if there
3957 were C<readlink(2)> errors, and so you can call this
3958 function with names where you don't know if they are
3959 symbolic links already (albeit slightly less efficient).
3960
3961 This call is intended for programs that want to efficiently
3962 list a directory contents without making many round-trips.
3963 Very long directory listings might cause the protocol
3964 message size to be exceeded, causing
3965 this call to fail.  The caller must split up such requests
3966 into smaller groups of names.");
3967
3968   ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
3969    [InitISOFS, Always, TestOutputBuffer (
3970       [["pread"; "/known-4"; "1"; "3"]], "\n");
3971     InitISOFS, Always, TestOutputBuffer (
3972       [["pread"; "/empty"; "0"; "100"]], "")],
3973    "read part of a file",
3974    "\
3975 This command lets you read part of a file.  It reads C<count>
3976 bytes of the file, starting at C<offset>, from file C<path>.
3977
3978 This may read fewer bytes than requested.  For further details
3979 see the L<pread(2)> system call.");
3980
3981   ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
3982    [InitEmpty, Always, TestRun (
3983       [["part_init"; "/dev/sda"; "gpt"]])],
3984    "create an empty partition table",
3985    "\
3986 This creates an empty partition table on C<device> of one of the
3987 partition types listed below.  Usually C<parttype> should be
3988 either C<msdos> or C<gpt> (for large disks).
3989
3990 Initially there are no partitions.  Following this, you should
3991 call C<guestfs_part_add> for each partition required.
3992
3993 Possible values for C<parttype> are:
3994
3995 =over 4
3996
3997 =item B<efi> | B<gpt>
3998
3999 Intel EFI / GPT partition table.
4000
4001 This is recommended for >= 2 TB partitions that will be accessed
4002 from Linux and Intel-based Mac OS X.  It also has limited backwards
4003 compatibility with the C<mbr> format.
4004
4005 =item B<mbr> | B<msdos>
4006
4007 The standard PC \"Master Boot Record\" (MBR) format used
4008 by MS-DOS and Windows.  This partition type will B<only> work
4009 for device sizes up to 2 TB.  For large disks we recommend
4010 using C<gpt>.
4011
4012 =back
4013
4014 Other partition table types that may work but are not
4015 supported include:
4016
4017 =over 4
4018
4019 =item B<aix>
4020
4021 AIX disk labels.
4022
4023 =item B<amiga> | B<rdb>
4024
4025 Amiga \"Rigid Disk Block\" format.
4026
4027 =item B<bsd>
4028
4029 BSD disk labels.
4030
4031 =item B<dasd>
4032
4033 DASD, used on IBM mainframes.
4034
4035 =item B<dvh>
4036
4037 MIPS/SGI volumes.
4038
4039 =item B<mac>
4040
4041 Old Mac partition format.  Modern Macs use C<gpt>.
4042
4043 =item B<pc98>
4044
4045 NEC PC-98 format, common in Japan apparently.
4046
4047 =item B<sun>
4048
4049 Sun disk labels.
4050
4051 =back");
4052
4053   ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
4054    [InitEmpty, Always, TestRun (
4055       [["part_init"; "/dev/sda"; "mbr"];
4056        ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4057     InitEmpty, Always, TestRun (
4058       [["part_init"; "/dev/sda"; "gpt"];
4059        ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4060        ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4061     InitEmpty, Always, TestRun (
4062       [["part_init"; "/dev/sda"; "mbr"];
4063        ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4064        ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4065        ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4066        ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4067    "add a partition to the device",
4068    "\
4069 This command adds a partition to C<device>.  If there is no partition
4070 table on the device, call C<guestfs_part_init> first.
4071
4072 The C<prlogex> parameter is the type of partition.  Normally you
4073 should pass C<p> or C<primary> here, but MBR partition tables also
4074 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4075 types.
4076
4077 C<startsect> and C<endsect> are the start and end of the partition
4078 in I<sectors>.  C<endsect> may be negative, which means it counts
4079 backwards from the end of the disk (C<-1> is the last sector).
4080
4081 Creating a partition which covers the whole disk is not so easy.
4082 Use C<guestfs_part_disk> to do that.");
4083
4084   ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4085    [InitEmpty, Always, TestRun (
4086       [["part_disk"; "/dev/sda"; "mbr"]]);
4087     InitEmpty, Always, TestRun (
4088       [["part_disk"; "/dev/sda"; "gpt"]])],
4089    "partition whole disk with a single primary partition",
4090    "\
4091 This command is simply a combination of C<guestfs_part_init>
4092 followed by C<guestfs_part_add> to create a single primary partition
4093 covering the whole disk.
4094
4095 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4096 but other possible values are described in C<guestfs_part_init>.");
4097
4098   ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4099    [InitEmpty, Always, TestRun (
4100       [["part_disk"; "/dev/sda"; "mbr"];
4101        ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4102    "make a partition bootable",
4103    "\
4104 This sets the bootable flag on partition numbered C<partnum> on
4105 device C<device>.  Note that partitions are numbered from 1.
4106
4107 The bootable flag is used by some operating systems (notably
4108 Windows) to determine which partition to boot from.  It is by
4109 no means universally recognized.");
4110
4111   ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4112    [InitEmpty, Always, TestRun (
4113       [["part_disk"; "/dev/sda"; "gpt"];
4114        ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4115    "set partition name",
4116    "\
4117 This sets the partition name on partition numbered C<partnum> on
4118 device C<device>.  Note that partitions are numbered from 1.
4119
4120 The partition name can only be set on certain types of partition
4121 table.  This works on C<gpt> but not on C<mbr> partitions.");
4122
4123   ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4124    [], (* XXX Add a regression test for this. *)
4125    "list partitions on a device",
4126    "\
4127 This command parses the partition table on C<device> and
4128 returns the list of partitions found.
4129
4130 The fields in the returned structure are:
4131
4132 =over 4
4133
4134 =item B<part_num>
4135
4136 Partition number, counting from 1.
4137
4138 =item B<part_start>
4139
4140 Start of the partition I<in bytes>.  To get sectors you have to
4141 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4142
4143 =item B<part_end>
4144
4145 End of the partition in bytes.
4146
4147 =item B<part_size>
4148
4149 Size of the partition in bytes.
4150
4151 =back");
4152
4153   ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4154    [InitEmpty, Always, TestOutput (
4155       [["part_disk"; "/dev/sda"; "gpt"];
4156        ["part_get_parttype"; "/dev/sda"]], "gpt")],
4157    "get the partition table type",
4158    "\
4159 This command examines the partition table on C<device> and
4160 returns the partition table type (format) being used.
4161
4162 Common return values include: C<msdos> (a DOS/Windows style MBR
4163 partition table), C<gpt> (a GPT/EFI-style partition table).  Other
4164 values are possible, although unusual.  See C<guestfs_part_init>
4165 for a full list.");
4166
4167   ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4168    [InitBasicFS, Always, TestOutputBuffer (
4169       [["fill"; "0x63"; "10"; "/test"];
4170        ["read_file"; "/test"]], "cccccccccc")],
4171    "fill a file with octets",
4172    "\
4173 This command creates a new file called C<path>.  The initial
4174 content of the file is C<len> octets of C<c>, where C<c>
4175 must be a number in the range C<[0..255]>.
4176
4177 To fill a file with zero bytes (sparsely), it is
4178 much more efficient to use C<guestfs_truncate_size>.");
4179
4180   ("available", (RErr, [StringList "groups"]), 216, [],
4181    [InitNone, Always, TestRun [["available"; ""]]],
4182    "test availability of some parts of the API",
4183    "\
4184 This command is used to check the availability of some
4185 groups of functionality in the appliance, which not all builds of
4186 the libguestfs appliance will be able to provide.
4187
4188 The libguestfs groups, and the functions that those
4189 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4190
4191 The argument C<groups> is a list of group names, eg:
4192 C<[\"inotify\", \"augeas\"]> would check for the availability of
4193 the Linux inotify functions and Augeas (configuration file
4194 editing) functions.
4195
4196 The command returns no error if I<all> requested groups are available.
4197
4198 It fails with an error if one or more of the requested
4199 groups is unavailable in the appliance.
4200
4201 If an unknown group name is included in the
4202 list of groups then an error is always returned.
4203
4204 I<Notes:>
4205
4206 =over 4
4207
4208 =item *
4209
4210 You must call C<guestfs_launch> before calling this function.
4211
4212 The reason is because we don't know what groups are
4213 supported by the appliance/daemon until it is running and can
4214 be queried.
4215
4216 =item *
4217
4218 If a group of functions is available, this does not necessarily
4219 mean that they will work.  You still have to check for errors
4220 when calling individual API functions even if they are
4221 available.
4222
4223 =item *
4224
4225 It is usually the job of distro packagers to build
4226 complete functionality into the libguestfs appliance.
4227 Upstream libguestfs, if built from source with all
4228 requirements satisfied, will support everything.
4229
4230 =item *
4231
4232 This call was added in version C<1.0.80>.  In previous
4233 versions of libguestfs all you could do would be to speculatively
4234 execute a command to find out if the daemon implemented it.
4235 See also C<guestfs_version>.
4236
4237 =back");
4238
4239   ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4240    [InitBasicFS, Always, TestOutputBuffer (
4241       [["write_file"; "/src"; "hello, world"; "0"];
4242        ["dd"; "/src"; "/dest"];
4243        ["read_file"; "/dest"]], "hello, world")],
4244    "copy from source to destination using dd",
4245    "\
4246 This command copies from one source device or file C<src>
4247 to another destination device or file C<dest>.  Normally you
4248 would use this to copy to or from a device or partition, for
4249 example to duplicate a filesystem.
4250
4251 If the destination is a device, it must be as large or larger
4252 than the source file or device, otherwise the copy will fail.
4253 This command cannot do partial copies (see C<guestfs_copy_size>).");
4254
4255   ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4256    [InitBasicFS, Always, TestOutputInt (
4257       [["write_file"; "/file"; "hello, world"; "0"];
4258        ["filesize"; "/file"]], 12)],
4259    "return the size of the file in bytes",
4260    "\
4261 This command returns the size of C<file> in bytes.
4262
4263 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4264 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4265 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4266
4267   ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4268    [InitBasicFSonLVM, Always, TestOutputList (
4269       [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4270        ["lvs"]], ["/dev/VG/LV2"])],
4271    "rename an LVM logical volume",
4272    "\
4273 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4274
4275   ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"]), 220, [],
4276    [InitBasicFSonLVM, Always, TestOutputList (
4277       [["umount"; "/"];
4278        ["vg_activate"; "false"; "VG"];
4279        ["vgrename"; "VG"; "VG2"];
4280        ["vg_activate"; "true"; "VG2"];
4281        ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4282        ["vgs"]], ["VG2"])],
4283    "rename an LVM volume group",
4284    "\
4285 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4286
4287   ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [ProtocolLimitWarning],
4288    [InitISOFS, Always, TestOutputBuffer (
4289       [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4290    "list the contents of a single file in an initrd",
4291    "\
4292 This command unpacks the file C<filename> from the initrd file
4293 called C<initrdpath>.  The filename must be given I<without> the
4294 initial C</> character.
4295
4296 For example, in guestfish you could use the following command
4297 to examine the boot script (usually called C</init>)
4298 contained in a Linux initrd or initramfs image:
4299
4300  initrd-cat /boot/initrd-<version>.img init
4301
4302 See also C<guestfs_initrd_list>.");
4303
4304   ("pvuuid", (RString "uuid", [Device "device"]), 222, [],
4305    [],
4306    "get the UUID of a physical volume",
4307    "\
4308 This command returns the UUID of the LVM PV C<device>.");
4309
4310   ("vguuid", (RString "uuid", [String "vgname"]), 223, [],
4311    [],
4312    "get the UUID of a volume group",
4313    "\
4314 This command returns the UUID of the LVM VG named C<vgname>.");
4315
4316   ("lvuuid", (RString "uuid", [Device "device"]), 224, [],
4317    [],
4318    "get the UUID of a logical volume",
4319    "\
4320 This command returns the UUID of the LVM LV C<device>.");
4321
4322   ("vgpvuuids", (RStringList "uuids", [String "vgname"]), 225, [],
4323    [],
4324    "get the PV UUIDs containing the volume group",
4325    "\
4326 Given a VG called C<vgname>, this returns the UUIDs of all
4327 the physical volumes that this volume group resides on.
4328
4329 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4330 calls to associate physical volumes and volume groups.
4331
4332 See also C<guestfs_vglvuuids>.");
4333
4334   ("vglvuuids", (RStringList "uuids", [String "vgname"]), 226, [],
4335    [],
4336    "get the LV UUIDs of all LVs in the volume group",
4337    "\
4338 Given a VG called C<vgname>, this returns the UUIDs of all
4339 the logical volumes created in this volume group.
4340
4341 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4342 calls to associate logical volumes and volume groups.
4343
4344 See also C<guestfs_vgpvuuids>.");
4345
4346   ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"]), 227, [],
4347    [InitBasicFS, Always, TestOutputBuffer (
4348       [["write_file"; "/src"; "hello, world"; "0"];
4349        ["copy_size"; "/src"; "/dest"; "5"];
4350        ["read_file"; "/dest"]], "hello")],
4351    "copy size bytes from source to destination using dd",
4352    "\
4353 This command copies exactly C<size> bytes from one source device
4354 or file C<src> to another destination device or file C<dest>.
4355
4356 Note this will fail if the source is too short or if the destination
4357 is not large enough.");
4358
4359   ("zero_device", (RErr, [Device "device"]), 228, [DangerWillRobinson],
4360    [InitBasicFSonLVM, Always, TestRun (
4361       [["zero_device"; "/dev/VG/LV"]])],
4362    "write zeroes to an entire device",
4363    "\
4364 This command writes zeroes over the entire C<device>.  Compare
4365 with C<guestfs_zero> which just zeroes the first few blocks of
4366 a device.");
4367
4368   ("txz_in", (RErr, [FileIn "tarball"; String "directory"]), 229, [],
4369    [InitBasicFS, Always, TestOutput (
4370       [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4371        ["cat"; "/hello"]], "hello\n")],
4372    "unpack compressed tarball to directory",
4373    "\
4374 This command uploads and unpacks local file C<tarball> (an
4375 I<xz compressed> tar file) into C<directory>.");
4376
4377   ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 230, [],
4378    [],
4379    "pack directory into compressed tarball",
4380    "\
4381 This command packs the contents of C<directory> and downloads
4382 it to local file C<tarball> (as an xz compressed tar archive).");
4383
4384   ("ntfsresize", (RErr, [Device "device"]), 231, [Optional "ntfsprogs"],
4385    [],
4386    "resize an NTFS filesystem",
4387    "\
4388 This command resizes an NTFS filesystem, expanding or
4389 shrinking it to the size of the underlying device.
4390 See also L<ntfsresize(8)>.");
4391
4392   ("vgscan", (RErr, []), 232, [],
4393    [InitEmpty, Always, TestRun (
4394       [["vgscan"]])],
4395    "rescan for LVM physical volumes, volume groups and logical volumes",
4396    "\
4397 This rescans all block devices and rebuilds the list of LVM
4398 physical volumes, volume groups and logical volumes.");
4399
4400   ("part_del", (RErr, [Device "device"; Int "partnum"]), 233, [],
4401    [InitEmpty, Always, TestRun (
4402       [["part_init"; &