Add 'append', LIBGUESTFS_APPEND to set additional kernel options.

[libguestfs.git] / java / com / redhat / et / libguestfs / GuestFS.java

diff --git a/java/com/redhat/et/libguestfs/GuestFS.java b/java/com/redhat/et/libguestfs/GuestFS.java
index 0d9ae9d..d0b3446 100644 (file)
--- a/java/com/redhat/et/libguestfs/GuestFS.java
+++ b/java/com/redhat/et/libguestfs/GuestFS.java
@@ -316,6 +316,54 @@ public class GuestFS {
     throws LibGuestFSException;
 
   /**
+   * add options to kernel command line
+   *
+   * This function is used to add additional options to the
+   * guest kernel command line.
+   * 
+   * The default is "NULL" unless overridden by setting
+   * "LIBGUESTFS_APPEND" environment variable.
+   * 
+   * The string "append" is stashed in the libguestfs handle,
+   * so the caller must make sure it remains valid for the
+   * lifetime of the handle.
+   * 
+   * Setting "append" to "NULL" means *no* additional options
+   * are passed (libguestfs always adds a few of its own).
+   * 
+   * @throws LibGuestFSException
+   */
+  public void set_append (String append)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("set_append: handle is closed");
+    _set_append (g, append);
+  }
+  private native void _set_append (long g, String append)
+    throws LibGuestFSException;
+
+  /**
+   * get the additional kernel options
+   *
+   * Return the additional kernel options which are added to
+   * the guest kernel command line.
+   * 
+   * If "NULL" then no options are added.
+   * 
+   * @throws LibGuestFSException
+   */
+  public String get_append ()
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("get_append: handle is closed");
+    return _get_append (g);
+  }
+  private native String _get_append (long g)
+    throws LibGuestFSException;
+
+  /**
    * set autosync mode
    *
    * If "autosync" is true, this enables autosync. Libguestfs
@@ -535,6 +583,27 @@ public class GuestFS {
     throws LibGuestFSException;
 
   /**
+   * leave the busy state
+   *
+   * This sets the state to "READY", or if in "CONFIG" then
+   * it leaves the state as is. This is only used when
+   * implementing actions using the low-level API.
+   * 
+   * For more information on states, see guestfs(3).
+   * 
+   * @throws LibGuestFSException
+   */
+  public void end_busy ()
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("end_busy: handle is closed");
+    _end_busy (g);
+  }
+  private native void _end_busy (long g)
+    throws LibGuestFSException;
+
+  /**
    * mount a guest disk at a position in the filesystem
    *
    * Mount a guest disk at a position in the filesystem.
@@ -1625,6 +1694,13 @@ public class GuestFS {
    * Subsequent elements are parameters. The list must be
    * non-empty (ie. must contain a program name).
    * 
+   * The return value is anything printed to *stdout* by the
+   * command.
+   * 
+   * If the command returns a non-zero exit status, then this
+   * function returns an error message. The error message
+   * string is the content of *stderr* from the command.
+   * 
    * The $PATH environment variable will contain at least
    * "/usr/bin" and "/bin". If you require a program from
    * another location, you should provide the full path in
@@ -1636,6 +1712,10 @@ public class GuestFS {
    * ensure all filesystems that are needed are mounted at
    * the right locations.
    * 
+   * Because of the message protocol, there is a transfer
+   * limit of somewhere between 2MB and 4MB. To transfer
+   * large files you should use FTP.
+   * 
    * @throws LibGuestFSException
    */
   public String command (String[] arguments)
@@ -1654,6 +1734,10 @@ public class GuestFS {
    * This is the same as "g.command", but splits the result
    * into a list of lines.
    * 
+   * Because of the message protocol, there is a transfer
+   * limit of somewhere between 2MB and 4MB. To transfer
+   * large files you should use FTP.
+   * 
    * @throws LibGuestFSException
    */
   public String[] command_lines (String[] arguments)