mirrors/libguestfs
1
0
Fork 0
mirror of https://github.com/libguestfs/libguestfs.git synced 2026-03-21 22:53:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

java: Document how to use optional parameters in the guestfs-java(3) man page.

Browse Source
This commit is contained in:
Richard W.M. Jones
2014-03-08 12:13:46 +00:00
parent 1ba2e3e14a
commit 2b3131cf40
1 changed files with 37 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
java/examples/guestfs-java.pod
View File

@@ -70,6 +70,43 @@ The output looks similar to this:
EVENT_TRACE: add_drive_ro = 0
// etc.
=head2 OPTIONAL ARGUMENTS
Some methods take an optional map of optional parameters. An example
of this is C<g.add_drive> which can be called in one of two ways:
g.add_drive ("disk.img");
or with optional arguments:
Map<String, Object> optargs =
new HashMap<String, Object>() {
{
put ("readonly", Boolean.TRUE);
put ("format", "raw");
}
};
g.add_drive ("disk.img", optargs);
For more information on this topic, see
L<guestfs(3)/CALLS WITH OPTIONAL ARGUMENTS>.
=head3 Optional handle parameters
When creating the handle you can also pass a map of optional
parameters:
Map<String, Object> optargs =
new HashMap<String, Object>() {
{
put ("close_on_exit", Boolean.FALSE);
put ("environment", Boolean.TRUE);
}
};
GuestFS g = new GuestFS (optargs);
For more information, see L<guestfs(3)/guestfs_create_flags>.
=head1 EXAMPLE 1: CREATE A DISK IMAGE
@EXAMPLE1@