Changes between Version 106 and Version 107 of VboxApps


Ignore:
Timestamp:
Jan 29, 2017, 12:32:05 PM (8 years ago)
Author:
davea
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • VboxApps

    v106 v107  
    110110   [ <completion_trigger_file>filename</completion_trigger_file> ]
    111111   [ <copy_to_shared>filename</copy_to_shared> ]
     112   [ <copy_cmdline_to_shared>0|1</copy_cmdline_to_shared> ]
    112113   [ <enable_cache_disk>0|1</enable_cache_disk> ]
    113114   [ <enable_cern_dataformat>0|1</enable_cern_dataformat> ]
     
    137138Required elements:
    138139
    139  '''memory_size_mb''':: the amount of physical memory allocated to the VM, in megabytes.
    140  '''os_name''':: the name of the guest OS as defined by !VirtualBox,
     140 '''memory_size_mb''':: The amount of physical memory allocated to the VM, in megabytes.
     141 '''os_name''':: The name of the guest OS as defined by !VirtualBox,
    141142   e.g. "Linux26", "Linux26_64", "Linux24", etc.
    142143   To see a list of all available OS names, install !VirtualBox on a system,
     
    153154   If vboxwrapper finds this file,
    154155   it cleans up the VM and exits with the given code (default 0).
    155  '''copy_to_shared''':: copy the given file from the slot directory the shared directory before launch.
     156 '''copy_to_shared''':: Copy the given file from the slot directory the shared directory before launch.
    156157  For example, you can use to copy '''init_data.xml''' into the VM.
    157158  This directive can be used more than once.
     159 '''copy_cmdline_to_shared''':: Write vboxwrapper's command line to a file '''shared/cmdline'''.
     160  This lets you pass information into the VM without input files.
     161  The max size of the command line is on the order of 60KB.
    158162 '''enable_cache_disk''':: Mount a virtual disk in the VM.
    159163   The virtual disk is described by a VDI file in the app version
    160164   with logical name '''vm_cache.vdi''' and the '''copy_file''' attribute.
    161  '''enable_cern_dataformat'''::  if '''enable_floppyio''' is used (see below)
     165 '''enable_cern_dataformat'''::  If '''enable_floppyio''' is used (see below)
    162166   initialize the floppy disk image to contain user and host ID and credit
    163167   as name=value pairs.
    164  '''enable_isocontextualization''':: the VM image is an ISO file named '''vm_isocontext.iso''',
     168 '''enable_isocontextualization''':: The VM image is an ISO file named '''vm_isocontext.iso''',
    165169   rather than a VDI file.
    166170   Also, vboxwrapper will mount the host's guest additions ISO (VBoxGuestAdditions.iso)
    167171   as a DVD in the VM.
    168  '''enable_floppyio''':: create a floppy disk image in the VM,
     172 '''enable_floppyio''':: Create a floppy disk image in the VM,
    169173  containing the contents of init_data.xml.
    170  '''enable_network''':: if present, allow the VM to do network access.
     174 '''enable_network''':: If present, allow the VM to do network access.
    171175 '''enable_remotedesktop''':: If the Oracle VirtualBox Extension are installed, it'll enable
    172176  the use of a remote desktop client to view the console of the VM.
    173  '''enable_shared_directory''':: if present, create a directory that is shared
     177 '''enable_shared_directory''':: If present, create a directory that is shared
    174178   between the host OS and the guest OS.
    175179   Must be set if your application has input or output files.
    176  '''enable_graphics_support''':: if present, creates and updates a [BasicApi#GraphicsStatus graphics status] file.
     180 '''enable_graphics_support''':: If present, creates and updates a [BasicApi#GraphicsStatus graphics status] file.
    177181   This is used by [http://boinc.berkeley.edu/trac/wiki/HTMLGfx HTMLGfx]. (v26155+)
    178182 '''boot_iso''':: if both a disk and an ISO are specified to be attached to the VM, by default the VM will
    179183   first attempt to boot from the disk. with '''boot_iso''' given, it will instead first boot from the ISO.
    180  '''fraction_done_filename''':: the name of a file to which the app will
     184 '''fraction_done_filename''':: The name of a file to which the app will
    181185  periodically write its fraction done (0 to 1).
    182186  This is used by the wrapper to report overall fraction done.
    183  '''intermediate_upload_file'''::: specifies the name of an output file that,
     187 '''intermediate_upload_file'''::: Specifies the name of an output file that,
    184188  when present, should be uploaded as soon as possible.
    185  '''job_duration''':: this specifies the maximum elapsed time of the job,
     189 '''job_duration''':: Specifies the maximum elapsed time of the job,
    186190  after which vboxwrapper will kill the VM and exit normally.
    187  '''minimum_checkpoint_interval''':: minimum number of seconds before a checkpoint/snapshot can be created.
     191 '''minimum_checkpoint_interval''':: Minimum number of seconds before a checkpoint/snapshot can be created.
    188192  Defaults to 10 minutes. (v26086+)
    189  '''network_bridged_mode''':: if '''enable_network''' is set, use bridged mode; default is NAT mode.
    190  '''pf_guest_port''':: enable port forwarding to port N within the VM.
     193 '''network_bridged_mode''':: If '''enable_network''' is set, use bridged mode; default is NAT mode.
     194 '''pf_guest_port''':: Enable port forwarding to port N within the VM.
    191195  This is assumed to be a web server providing application graphics.
    192  '''port_forward''':: defines a port forwarding between the given host and guest ports.
     196 '''port_forward''':: Defines a port forwarding between the given host and guest ports.
    193197    If '''nports''' is specified, N ports will be forwarded:
    194198    H to G, H+1 to G+1, ... H+N-1 to G+N-1.
     
    196200    otherwise they can be accessed only from processes on this computer.
    197201   There may be more than one of these elements.
    198  '''temporary_exit_trigger_file''':: specifies the name of a file that, if present,
     202 '''temporary_exit_trigger_file''':: Specifies the name of a file that, if present,
    199203   causes the wrapper to temporarily exit.
    200  '''trickle_trigger_file''':: provides a mechanism for the VM to send trickle-up messages.
     204 '''trickle_trigger_file''':: Provides a mechanism for the VM to send trickle-up messages.
    201205   If a file of the given name appears in the shared directory,
    202206   vboxwrapper sends a [TrickleApi trickle-up message] whose variety is the filename
    203207   and whose contents is the contents of the file, then deletes the file.
    204  '''vm_disk_controller_model''':: which disk controller model to emulate.
    205  '''vm_disk_controller_type''':: which disk controller type to emulate.
     208 '''vm_disk_controller_model''':: Which disk controller model to emulate.
     209 '''vm_disk_controller_type''':: Which disk controller type to emulate.
    206210
    207211== Vboxwrapper command-line options ==