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