diff options
Diffstat (limited to 'debian/manpages')
| -rw-r--r-- | debian/manpages/VBoxBalloonCtrl.1 | 55 | ||||
| -rw-r--r-- | debian/manpages/VBoxClient.1 | 45 | ||||
| -rw-r--r-- | debian/manpages/VBoxControl.8 | 32 | ||||
| -rw-r--r-- | debian/manpages/VBoxHeadless.1 | 51 | ||||
| -rw-r--r-- | debian/manpages/VBoxManage.1 | 851 | ||||
| -rw-r--r-- | debian/manpages/VBoxSDL.1 | 107 | ||||
| -rw-r--r-- | debian/manpages/VBoxService.8 | 6 | ||||
| -rw-r--r-- | debian/manpages/VirtualBox.1 | 12 | ||||
| -rw-r--r-- | debian/manpages/mount.vboxsf.8 | 64 | ||||
| -rw-r--r-- | debian/manpages/vboxwebsrv.1 | 35 |
10 files changed, 1258 insertions, 0 deletions
diff --git a/debian/manpages/VBoxBalloonCtrl.1 b/debian/manpages/VBoxBalloonCtrl.1 new file mode 100644 index 00000000..5408fff4 --- /dev/null +++ b/debian/manpages/VBoxBalloonCtrl.1 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH VBOXBALLOONCTRL "1" "January 2019" "VBoxBalloonCtrl" "User Commands" +.SH NAME +VBoxBalloonCtrl \- x86 virtualization solution +.SH DESCRIPTION +Oracle VM VirtualBox Watchdog +(C) 2019 Oracle Corporation +All rights reserved. +.SS "Usage:" +.IP +\fI\,/usr/lib/virtualbox/VBoxBalloonCtrl\/\fP [\-v|\-\-verbose] [\-h|\-?|\-\-help] [\-P|\-\-pidfile] +[\-F|\-\-logfile=<file>] [\-R|\-\-logrotate=<num>] [\-S|\-\-logsize=<bytes>] +[\-I|\-\-loginterval=<seconds>] +[\-\-balloon\-dec=<MB>] [\-\-balloon\-groups=<string>] [\-\-balloon\-inc=<MB>] +[\-\-balloon\-interval=<ms>] [\-\-balloon\-lower\-limit=<MB>] +[\-\-balloon\-max=<MB>] +[\-\-apimon\-groups=<string[,stringN]>] +[\-\-apimon\-isln\-response=<cmd>] [\-\-apimon\-isln\-timeout=<ms>] +[\-\-apimon\-resp\-timeout=<ms>] +.SH OPTIONS +\fB\-\-background\fR, \fB\-b\fR: Run in background (daemon mode). +\fB\-\-disable\-\fR<module>: Disables a module. See module list for built\-in modules. +\fB\-\-dryrun\fR: Dryrun mode \fB\-\-\fR do not perform any actions. +\fB\-\-help\fR, \fB\-h\fR: Print this help message and exit. +\fB\-\-verbose\fR, \fB\-v\fR: +\fB\-\-pidfile\fR, \fB\-P\fR: Name of the PID file which is created when the daemon was started. +\fB\-\-logfile\fR, \fB\-F\fR: Name of file to write log to (no file). +\fB\-\-logrotate\fR, \fB\-R\fR: Number of log files (0 disables log rotation). +\fB\-\-logsize\fR, \fB\-S\fR: Maximum size of a log file to trigger rotation (bytes). +\fB\-\-loginterval\fR, \fB\-I\fR: Maximum time interval to trigger log rotation (seconds). +\fB\-\-balloon\-dec\fR Sets the ballooning decrement in MB (128 MB). +\fB\-\-balloon\-groups\fR Sets the VM groups for ballooning (all). +\fB\-\-balloon\-inc\fR Sets the ballooning increment in MB (256 MB). +\fB\-\-balloon\-interval\fR Sets the check interval in ms (30 seconds). +\fB\-\-balloon\-lower\-limit\fR Sets the ballooning lower limit in MB (64 MB). +\fB\-\-balloon\-max\fR Sets the balloon maximum limit in MB (0 MB). +.IP +Specifying "0" means disabled ballooning. +.PP +Set "VBoxInternal/Guest/BalloonSizeMax" for a per\-VM maximum ballooning size. +\fB\-\-balloon\-safety\-margin\fR Free memory when deflating a balloon in MB (1024 MB). +\fB\-\-apimon\-groups\fR Sets the VM groups for monitoring (all), +.IP +comma\-separated list. +.SS "--apimon-isln-response Sets the isolation response to one of:" +.TP +none, pause, poweroff, save, shutdown +(none). +.PP +\fB\-\-apimon\-isln\-timeout\fR Sets the isolation timeout in ms (30s). +\fB\-\-apimon\-resp\-timeout\fR Sets the response timeout in ms (30s). +.PP +Use environment variable VBOXBALLOONCTRL_RELEASE_LOG for logging options. +.PP +Valid module names are: balloon, apimon diff --git a/debian/manpages/VBoxClient.1 b/debian/manpages/VBoxClient.1 new file mode 100644 index 00000000..5c4f89d2 --- /dev/null +++ b/debian/manpages/VBoxClient.1 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH VBOXCLIENT "1" "January 2019" "VBoxClient" "User Commands" +.SH NAME +VBoxClient \- x86 virtualization solution +.SH SYNOPSIS +.B VBoxClient +\fI\,--clipboard|--draganddrop|--display|--checkhostversion|--seamless|check3d|--vmsvga|--vmsvga-x11\/\fR[\fI\,-d|--nodaemon\/\fR] +.SH DESCRIPTION +Starts the VirtualBox DRM/X Window System guest services. +.SH OPTIONS +.TP +\fB\-\-clipboard\fR +starts the shared clipboard service +.TP +\fB\-\-draganddrop\fR +starts the drag and drop service +.TP +\fB\-\-display\fR +starts the display management service +.HP +\fB\-\-checkhostversion\fR starts the host version notifier service +.TP +\fB\-\-check3d\fR +tests whether 3D pass\-through is enabled +.TP +\fB\-\-seamless\fR +starts the seamless windows service +.TP +\fB\-\-vmsvga\fR +starts VMSVGA dynamic resizing for DRM +.TP +\fB\-\-vmsvga\-x11\fR +starts VMSVGA dynamic resizing for X11 +.TP +\fB\-f\fR, \fB\-\-foreground\fR +run in the foreground (no daemonizing) +.TP +\fB\-d\fR, \fB\-\-nodaemon\fR +continues running as a system service +.TP +\fB\-h\fR, \fB\-\-help\fR +shows this help text +.TP +\fB\-V\fR, \fB\-\-version\fR +shows version information diff --git a/debian/manpages/VBoxControl.8 b/debian/manpages/VBoxControl.8 new file mode 100644 index 00000000..91b432b9 --- /dev/null +++ b/debian/manpages/VBoxControl.8 @@ -0,0 +1,32 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH VBOXCONTROL "8" "January 2019" "VBoxControl" "System Administration Utilities" +.SH NAME +VBoxControl \- x86 virtualization solution +.SH DESCRIPTION +Oracle VM VirtualBox Guest Additions Command Line Management Interface +(C) 2008\-2019 Oracle Corporation +All rights reserved. +.PP +Usage: +.PP +VBoxControl [\-V|\-\-version] print version number and exit +VBoxControl \fB\-\-nologo\fR ... suppress the logo +.PP +VBoxControl guestproperty get <property> [\-\-verbose] +VBoxControl guestproperty set <property> [<value> [\-\-flags <flags>]] +VBoxControl guestproperty delete|unset <property> +VBoxControl guestproperty enumerate [\-\-patterns <patterns>] +VBoxControl guestproperty wait <patterns> +.TP +[\-\-timestamp <last timestamp>] +[\-\-timeout <timeout in ms> +.PP +VBoxControl sharedfolder list [\-\-automount] +VBoxControl writecoredump +VBoxControl writelog [\-n|\-\-no\-newline] [\-\-] <msg> +VBoxControl takesnapshot +VBoxControl savestate +VBoxControl suspend +VBoxControl poweroff +VBoxControl help [command] +VBoxControl version diff --git a/debian/manpages/VBoxHeadless.1 b/debian/manpages/VBoxHeadless.1 new file mode 100644 index 00000000..f75bdd9d --- /dev/null +++ b/debian/manpages/VBoxHeadless.1 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH VBOXHEADLESS "1" "January 2019" "VBoxHeadless" "User Commands" +.SH NAME +VBoxHeadless \- x86 virtualization solution +.SH DESCRIPTION +Oracle VM VirtualBox Headless Interface +(C) 2008\-2019 Oracle Corporation +All rights reserved. +.SS "Usage:" +.TP +\fB\-s\fR, \fB\-startvm\fR, \fB\-\-startvm\fR <name|uuid> +Start given VM (required argument) +.TP +\fB\-v\fR, \fB\-vrde\fR, \fB\-\-vrde\fR on|off|config +Enable or disable the VRDE server +or don't change the setting (default) +.TP +\fB\-e\fR, \fB\-vrdeproperty\fR, \fB\-\-vrdeproperty\fR <name=[value]> Set a VRDE property: +"TCP/Ports" \- comma\-separated list of +.TP +ports the VRDE server can bind to; dash +between two port numbers specifies range +.TP +"TCP/Address" \- interface IP the VRDE +server will bind to +.TP +\fB\-\-settingspw\fR <pw> +Specify the settings password +.TP +\fB\-\-settingspwfile\fR <file> +Specify a file containing the +settings password +.TP +\fB\-start\-paused\fR, \fB\-\-start\-paused\fR +Start the VM in paused state +.TP +\fB\-c\fR, \fB\-record\fR, \fB\-\-record\fR +Record the VM screen output to a file +.TP +\fB\-w\fR, \fB\-\-videowidth\fR +Video frame width when recording +.TP +\fB\-h\fR, \fB\-\-videoheight\fR +Video frame height when recording +.TP +\fB\-r\fR, \fB\-\-videobitrate\fR +Recording bit rate when recording +.TP +\fB\-f\fR, \fB\-\-filename\fR +File name when recording. The codec used +will be chosen based on file extension diff --git a/debian/manpages/VBoxManage.1 b/debian/manpages/VBoxManage.1 new file mode 100644 index 00000000..150c2333 --- /dev/null +++ b/debian/manpages/VBoxManage.1 @@ -0,0 +1,851 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH VBOXMANAGE "1" "January 2019" "VBoxManage" "User Commands" +.SH NAME +VBoxManage \- x86 virtualization solution +.SH DESCRIPTION +Oracle VM VirtualBox Command Line Management Interface +(C) 2005\-2019 Oracle Corporation +All rights reserved. +.PP +Usage: +.IP +VBoxManage [<general option>] <command> +.PP +General Options: +.TP +[\-v|\-\-version] +print version number and exit +.TP +[\-q|\-\-nologo] +suppress the logo +.TP +[\-\-settingspw <pw>] +provide the settings password +.IP +[\-\-settingspwfile <file>] provide a file containing the settings password +[@<response\-file>] load arguments from the given response file (bourne style) +.PP +Commands: +.TP +list [\-\-long|\-l] [\-\-sorted|\-s] +vms|runningvms|ostypes|hostdvds|hostfloppies| +.TP +intnets|bridgedifs|hostonlyifs|natnets|dhcpservers| +hostinfo|hostcpuids|hddbackends|hdds|dvds|floppies| +usbhost|usbfilters|systemproperties|extpacks| +groups|webcams|screenshotformats|cloudproviders| +cloudprofiles +.TP +showvminfo +<uuid|vmname> [\-\-details] +[\-\-machinereadable] +.TP +showvminfo +<uuid|vmname> \fB\-\-log\fR <idx> +.TP +registervm +<filename> +.TP +unregistervm +<uuid|vmname> [\-\-delete] +.TP +createvm +\fB\-\-name\fR <name> +[\-\-groups <group>, ...] +[\-\-ostype <ostype>] +[\-\-register] +[\-\-basefolder <path>] +[\-\-uuid <uuid>] +[\-\-default] +.TP +modifyvm +<uuid|vmname> +[\-\-name <name>] +[\-\-groups <group>, ...] +[\-\-description <desc>] +[\-\-ostype <ostype>] +[\-\-iconfile <filename>] +[\-\-memory <memorysize in MB>] +[\-\-pagefusion on|off] +[\-\-vram <vramsize in MB>] +[\-\-acpi on|off] +[\-\-pciattach 03:04.0] +[\-\-pciattach 03:04.0@02:01.0] +[\-\-pcidetach 03:04.0] +[\-\-ioapic on|off] +[\-\-hpet on|off] +[\-\-triplefaultreset on|off] +[\-\-apic on|off] +[\-\-x2apic on|off] +[\-\-paravirtprovider none|default|legacy|minimal| +.TP +hyperv|kvm] +[\-\-paravirtdebug <key=value> [,<key=value> ...]] +[\-\-hwvirtex on|off] +[\-\-nestedpaging on|off] +[\-\-largepages on|off] +[\-\-vtxvpid on|off] +[\-\-vtxux on|off] +[\-\-pae on|off] +[\-\-longmode on|off] +[\-\-ibpb\-on\-vm\-exit on|off] +[\-\-ibpb\-on\-vm\-entry on|off] +[\-\-spec\-ctrl on|off] +[\-\-l1d\-flush\-on\-sched on|off] +[\-\-l1d\-flush\-on\-vm\-entry on|off] +[\-\-nested\-hw\-virt on|off] +[\-\-cpu\-profile "host|Intel 80[86|286|386]"] +[\-\-cpuid\-portability\-level <0..3> +[\-\-cpuid\-set <leaf[:subleaf]> <eax> <ebx> <ecx> <edx>] +[\-\-cpuid\-remove <leaf[:subleaf]>] +[\-\-cpuidremoveall] +[\-\-hardwareuuid <uuid>] +[\-\-cpus <number>] +[\-\-cpuhotplug on|off] +[\-\-plugcpu <id>] +[\-\-unplugcpu <id>] +[\-\-cpuexecutioncap <1\-100>] +[\-\-rtcuseutc on|off] +[\-\-graphicscontroller none|vboxvga|vmsvga|vboxsvga] +[\-\-monitorcount <number>] +[\-\-accelerate3d on|off] +[\-\-accelerate2dvideo on|off] +[\-\-firmware bios|efi|efi32|efi64] +[\-\-chipset ich9|piix3] +[\-\-bioslogofadein on|off] +[\-\-bioslogofadeout on|off] +[\-\-bioslogodisplaytime <msec>] +[\-\-bioslogoimagepath <imagepath>] +[\-\-biosbootmenu disabled|menuonly|messageandmenu] +[\-\-biosapic disabled|apic|x2apic] +[\-\-biossystemtimeoffset <msec>] +[\-\-biospxedebug on|off] +[\-\-boot<1\-4> none|floppy|dvd|disk|net>] +[\-\-nic<1\-N> none|null|nat|bridged|intnet|hostonly| +.TP +generic|natnetwork] +[\-\-nictype<1\-N> Am79C970A|Am79C973| +.TP +82540EM|82543GC|82545EM| +virtio] +.TP +[\-\-cableconnected<1\-N> on|off] +[\-\-nictrace<1\-N> on|off] +[\-\-nictracefile<1\-N> <filename>] +[\-\-nicproperty<1\-N> name=[value]] +[\-\-nicspeed<1\-N> <kbps>] +[\-\-nicbootprio<1\-N> <priority>] +[\-\-nicpromisc<1\-N> deny|allow\-vms|allow\-all] +[\-\-nicbandwidthgroup<1\-N> none|<name>] +[\-\-bridgeadapter<1\-N> none|<devicename>] +[\-\-hostonlyadapter<1\-N> none|<devicename>] +[\-\-intnet<1\-N> <network name>] +[\-\-nat\-network<1\-N> <network name>] +[\-\-nicgenericdrv<1\-N> <driver> +[\-\-natnet<1\-N> <network>|default] +[\-\-natsettings<1\-N> [<mtu>],[<socksnd>], +.TP +[<sockrcv>],[<tcpsnd>], +[<tcprcv>]] +.TP +[\-\-natpf<1\-N> [<rulename>],tcp|udp,[<hostip>], +<hostport>,[<guestip>],<guestport>] +.TP +[\-\-natpf<1\-N> delete <rulename>] +[\-\-nattftpprefix<1\-N> <prefix>] +[\-\-nattftpfile<1\-N> <file>] +[\-\-nattftpserver<1\-N> <ip>] +[\-\-natbindip<1\-N> <ip> +[\-\-natdnspassdomain<1\-N> on|off] +[\-\-natdnsproxy<1\-N> on|off] +[\-\-natdnshostresolver<1\-N> on|off] +[\-\-nataliasmode<1\-N> default|[log],[proxyonly], +.TP +[sameports]] +[\-\-macaddress<1\-N> auto|<mac>] +[\-\-mouse ps2|usb|usbtablet|usbmultitouch] +[\-\-keyboard ps2|usb +[\-\-uart<1\-N> off|<I/O base> <IRQ>] +[\-\-uartmode<1\-N> disconnected| +.TP +server <pipe>| +client <pipe>| +tcpserver <port>| +tcpclient <hostname:port>| +file <file>| +<devicename>] +.TP +[\-\-uarttype<1\-N> 16450|16550A|16750 +[\-\-lpt<1\-N> off|<I/O base> <IRQ>] +[\-\-lptmode<1\-N> <devicename>] +[\-\-guestmemoryballoon <balloonsize in MB>] +[\-\-audio none|null|oss|alsa|pulse] +[\-\-audioin on|off] +[\-\-audioout on|off] +[\-\-audiocontroller ac97|hda|sb16] +[\-\-audiocodec stac9700|ad1980|stac9221|sb16] +[\-\-clipboard disabled|hosttoguest|guesttohost| +.TP +bidirectional] +[\-\-draganddrop disabled|hosttoguest|guesttohost| +.TP +bidirectional] +[\-\-vrde on|off] +[\-\-vrdeextpack default|<name> +[\-\-vrdeproperty <name=[value]>] +[\-\-vrdeport <hostport>] +[\-\-vrdeaddress <hostip>] +[\-\-vrdeauthtype null|external|guest] +[\-\-vrdeauthlibrary default|<name> +[\-\-vrdemulticon on|off] +[\-\-vrdereusecon on|off] +[\-\-vrdevideochannel on|off] +[\-\-vrdevideochannelquality <percent>] +[\-\-usbohci on|off] +[\-\-usbehci on|off] +[\-\-usbxhci on|off] +[\-\-usbrename <oldname> <newname>] +[\-\-snapshotfolder default|<path>] +[\-\-teleporter on|off] +[\-\-teleporterport <port>] +[\-\-teleporteraddress <address|empty> +[\-\-teleporterpassword <password>] +[\-\-teleporterpasswordfile <file>|stdin] +[\-\-tracing\-enabled on|off] +[\-\-tracing\-config <config\-string>] +[\-\-tracing\-allow\-vm\-access on|off] +[\-\-usbcardreader on|off] +[\-\-autostart\-enabled on|off] +[\-\-autostart\-delay <seconds>] +[\-\-recording on|off] +[\-\-recording screens all|<screen ID> [<screen ID> ...]] +[\-\-recording filename <filename>] +[\-\-recording videores <width> <height>] +[\-\-recording videorate <rate>] +[\-\-recording videofps <fps>] +[\-\-recording maxtime <s>] +[\-\-recording maxfilesize <MB>] +[\-\-recording opts <key=value> [,<key=value> ...]] +[\-\-defaultfrontend default|<name>] +.TP +clonevm +<uuid|vmname> +[\-\-snapshot <uuid>|<name>] +[\-\-mode machine|machineandchildren|all] +[\-\-options link|keepallmacs|keepnatmacs| +.TP +keepdisknames|keephwuuids] +[\-\-name <name>] +[\-\-groups <group>, ...] +[\-\-basefolder <basefolder>] +[\-\-uuid <uuid>] +[\-\-register] +.TP +movevm +<uuid|vmname> +\fB\-\-type\fR basic +[\-\-folder <path>] +.TP +import +<ovfname/ovaname> +[\-\-dry\-run|\-n] +[\-\-options keepallmacs|keepnatmacs|importtovdi] +[more options] +(run with \fB\-n\fR to have options displayed +.IP +for a particular OVF) +.TP +export +<machines> \fB\-\-output\fR|\-o <name>.<ovf/ova/tar.gz> +[\-\-legacy09|\-\-ovf09|\-\-ovf10|\-\-ovf20|\-\-opc10] +[\-\-manifest] +[\-\-iso] +[\-\-options manifest|iso|nomacs|nomacsbutnat] +[\-\-vsys <number of virtual system>] +.TP +[\-\-vmname <name>] +[\-\-product <product name>] +[\-\-producturl <product url>] +[\-\-vendor <vendor name>] +[\-\-vendorurl <vendor url>] +[\-\-version <version info>] +[\-\-description <description info>] +[\-\-eula <license text>] +[\-\-eulafile <filename>] +.TP +[\-\-cloud <number of virtual system>] +[\-\-vmname <name>] +[\-\-cloudprofile <cloud profile name>] +[\-\-cloudshape <shape>] +[\-\-clouddomain <domain>] +[\-\-clouddisksize <disk size in GB>] +[\-\-cloudbucket <bucket name>] +[\-\-cloudocivcn <OCI vcn id>] +[\-\-cloudocisubnet <OCI subnet id>] +[\-\-cloudkeepobject <true/false>] +[\-\-cloudlaunchinstance <true/false>] +[\-\-cloudpublicip <true/false>] +.TP +startvm +<uuid|vmname>... +[\-\-type gui|sdl|headless|separate] +[\-E|\-\-putenv <NAME>[=<VALUE>]] +.TP +controlvm +<uuid|vmname> +pause|resume|reset|poweroff|savestate| +acpipowerbutton|acpisleepbutton| +keyboardputscancode <hex> [<hex> ...]| +keyboardputstring <string1> [<string2> ...]| +keyboardputfile <filename>| +setlinkstate<1\-N> on|off | +nic<1\-N> null|nat|bridged|intnet|hostonly|generic| +.TP +natnetwork [<devicename>] | +nictrace<1\-N> on|off | +nictracefile<1\-N> <filename> | +nicproperty<1\-N> name=[value] | +nicpromisc<1\-N> deny|allow\-vms|allow\-all | +natpf<1\-N> [<rulename>],tcp|udp,[<hostip>], +.TP +<hostport>,[<guestip>],<guestport> | +natpf<1\-N> delete <rulename> | +guestmemoryballoon <balloonsize in MB> | +usbattach <uuid>|<address> +.TP +[\-\-capturefile <filename>] | +usbdetach <uuid>|<address> | +audioin on|off | +audioout on|off | +clipboard disabled|hosttoguest|guesttohost| +.TP +bidirectional | +draganddrop disabled|hosttoguest|guesttohost| +.TP +bidirectional | +vrde on|off | +vrdeport <port> | +vrdeproperty <name=[value]> | +vrdevideochannelquality <percent> | +setvideomodehint <xres> <yres> <bpp> +.TP +[[<display>] [<enabled:yes|no> | +[<xorigin> <yorigin>]]] | +.TP +setscreenlayout <display> on|primary <xorigin> <yorigin> <xres> <yres> <bpp> | off +screenshotpng <file> [display] | +recording on|off | +recording screens all|none|<screen>,[<screen>...] | +recording filename <file> | +recording videores <width>x<height> | +recording videorate <rate> | +recording videofps <fps> | +recording maxtime <s> | +recording maxfilesize <MB> | +setcredentials <username> +.TP +\fB\-\-passwordfile\fR <file> | <password> +<domain> +[\-\-allowlocallogon <yes|no>] | +.TP +teleport \fB\-\-host\fR <name> \fB\-\-port\fR <port> +[\-\-maxdowntime <msec>] +[\-\-passwordfile <file> | +.TP +\fB\-\-password\fR <password>] | +plugcpu <id> | +unplugcpu <id> | +cpuexecutioncap <1\-100> +webcam <attach [path [settings]]> | <detach [path]> | <list> +addencpassword <id> +.TP +<password file>|\- +[\-\-removeonsuspend <yes|no>] +.TP +removeencpassword <id> +removeallencpasswords +changeuartmode<1\-N> disconnected| +.TP +server <pipe>| +client <pipe>| +tcpserver <port>| +tcpclient <hostname:port>| +file <file>| +<devicename>] +.TP +discardstate +<uuid|vmname> +.TP +adoptstate +<uuid|vmname> <state_file> +.TP +snapshot +<uuid|vmname> +take <name> [\-\-description <desc>] [\-\-live] +.TP +[\-\-uniquename Number,Timestamp,Space,Force] | +delete <uuid|snapname> | +restore <uuid|snapname> | +restorecurrent | +edit <uuid|snapname>|\-\-current +.TP +[\-\-name <name>] +[\-\-description <desc>] | +.TP +list [\-\-details|\-\-machinereadable] | +showvminfo <uuid|snapname> +.TP +closemedium +[disk|dvd|floppy] <uuid|filename> +[\-\-delete] +.TP +storageattach +<uuid|vmname> +\fB\-\-storagectl\fR <name> +[\-\-port <number>] +[\-\-device <number>] +[\-\-type dvddrive|hdd|fdd] +[\-\-medium none|emptydrive|additions| +.TP +<uuid|filename>|host:<drive>|iscsi] +[\-\-mtype normal|writethrough|immutable|shareable| +.TP +readonly|multiattach] +[\-\-comment <text>] +[\-\-setuuid <uuid>] +[\-\-setparentuuid <uuid>] +[\-\-passthrough on|off] +[\-\-tempeject on|off] +[\-\-nonrotational on|off] +[\-\-discard on|off] +[\-\-hotpluggable on|off] +[\-\-bandwidthgroup <name>] +[\-\-forceunmount] +[\-\-server <name>|<ip>] +[\-\-target <target>] +[\-\-tport <port>] +[\-\-lun <lun>] +[\-\-encodedlun <lun>] +[\-\-username <username>] +[\-\-password <password>] +[\-\-passwordfile <file>] +[\-\-initiator <initiator>] +[\-\-intnet] +.TP +storagectl +<uuid|vmname> +\fB\-\-name\fR <name> +[\-\-add ide|sata|scsi|floppy|sas|usb|pcie] +[\-\-controller LSILogic|LSILogicSAS|BusLogic| +.TP +IntelAHCI|PIIX3|PIIX4|ICH6|I82078| +[ USB|NVMe] +[\-\-portcount <1\-n>] +[\-\-hostiocache on|off] +[\-\-bootable on|off] +[\-\-rename <name>] +[\-\-remove] +.TP +bandwidthctl +<uuid|vmname> +add <name> \fB\-\-type\fR disk|network +.TP +\fB\-\-limit\fR <megabytes per second>[k|m|g|K|M|G] | +set <name> +.TP +\fB\-\-limit\fR <megabytes per second>[k|m|g|K|M|G] | +remove <name> | +list [\-\-machinereadable] +(limit units: k=kilobit, m=megabit, g=gigabit, +.IP +K=kilobyte, M=megabyte, G=gigabyte) +.TP +showmediuminfo +[disk|dvd|floppy] <uuid|filename> +.TP +createmedium +[disk|dvd|floppy] \fB\-\-filename\fR <filename> +[\-\-size <megabytes>|\-\-sizebyte <bytes>] +[\-\-diffparent <uuid>|<filename> +[\-\-format VDI|VMDK|VHD] (default: VDI) +[\-\-variant Standard,Fixed,Split2G,Stream,ESX, +.IP +Formatted] +.TP +modifymedium +[disk|dvd|floppy] <uuid|filename> +[\-\-type normal|writethrough|immutable|shareable| +.TP +readonly|multiattach] +[\-\-autoreset on|off] +[\-\-property <name=[value]>] +[\-\-compact] +[\-\-resize <megabytes>|\-\-resizebyte <bytes>] +[\-\-move <path>] +[\-\-setlocation <path>] +[\-\-description <description string>] +.TP +clonemedium +[disk|dvd|floppy] <uuid|inputfile> <uuid|outputfile> +[\-\-format VDI|VMDK|VHD|RAW|<other>] +[\-\-variant Standard,Fixed,Split2G,Stream,ESX] +[\-\-existing] +.TP +mediumproperty +[disk|dvd|floppy] set <uuid|filename> +<property> <value> +.TP +[disk|dvd|floppy] get <uuid|filename> +<property> +.TP +[disk|dvd|floppy] delete <uuid|filename> +<property> +.TP +encryptmedium +<uuid|filename> +[\-\-newpassword <file>|\-] +[\-\-oldpassword <file>|\-] +[\-\-cipher <cipher identifier>] +[\-\-newpasswordid <password identifier>] +.TP +checkmediumpwd +<uuid|filename> +<pwd file>|\- +.TP +convertfromraw +<filename> <outputfile> +[\-\-format VDI|VMDK|VHD] +[\-\-variant Standard,Fixed,Split2G,Stream,ESX] +[\-\-uuid <uuid>] +.TP +convertfromraw +stdin <outputfile> <bytes> +[\-\-format VDI|VMDK|VHD] +[\-\-variant Standard,Fixed,Split2G,Stream,ESX] +[\-\-uuid <uuid>] +.TP +getextradata +global|<uuid|vmname> +<key>|[enumerate] +.TP +setextradata +global|<uuid|vmname> +<key> +[<value>] (no value deletes key) +.TP +setproperty +machinefolder default|<folder> | +hwvirtexclusive on|off | +vrdeauthlibrary default|<library> | +websrvauthlibrary default|null|<library> | +vrdeextpack null|<library> | +autostartdbpath null|<folder> | +loghistorycount <value> +defaultfrontend default|<name> +logginglevel <log setting> +proxymode system|noproxy|manual +proxyurl <url> +.TP +usbfilter +add <index,0\-N> +\fB\-\-target\fR <uuid|vmname>|global +\fB\-\-name\fR <string> +\fB\-\-action\fR ignore|hold (global filters only) +[\-\-active yes|no] (yes) +[\-\-vendorid <XXXX>] (null) +[\-\-productid <XXXX>] (null) +[\-\-revision <IIFF>] (null) +[\-\-manufacturer <string>] (null) +[\-\-product <string>] (null) +[\-\-remote yes|no] (null, VM filters only) +[\-\-serialnumber <string>] (null) +[\-\-maskedinterfaces <XXXXXXXX>] +.TP +usbfilter +modify <index,0\-N> +\fB\-\-target\fR <uuid|vmname>|global +[\-\-name <string>] +[\-\-action ignore|hold] (global filters only) +[\-\-active yes|no] +[\-\-vendorid <XXXX>|""] +[\-\-productid <XXXX>|""] +[\-\-revision <IIFF>|""] +[\-\-manufacturer <string>|""] +[\-\-product <string>|""] +[\-\-remote yes|no] (null, VM filters only) +[\-\-serialnumber <string>|""] +[\-\-maskedinterfaces <XXXXXXXX>] +.TP +usbfilter +remove <index,0\-N> +\fB\-\-target\fR <uuid|vmname>|global +.TP +sharedfolder +add <uuid|vmname> +\fB\-\-name\fR <name> \fB\-\-hostpath\fR <hostpath> +[\-\-transient] [\-\-readonly] [\-\-automount] +.TP +sharedfolder +remove <uuid|vmname> +\fB\-\-name\fR <name> [\-\-transient] +.TP +guestproperty +get <uuid|vmname> +<property> [\-\-verbose] +.TP +guestproperty +set <uuid|vmname> +<property> [<value> [\-\-flags <flags>]] +.TP +guestproperty +delete|unset <uuid|vmname> +<property> +.TP +guestproperty +enumerate <uuid|vmname> +[\-\-patterns <patterns>] +.TP +guestproperty +wait <uuid|vmname> <patterns> +[\-\-timeout <msec>] [\-\-fail\-on\-timeout] +.TP +guestcontrol +<uuid|vmname> [\-\-verbose|\-v] [\-\-quiet|\-q] +.TP +[\-\-username <name>] [\-\-domain <domain>] +[\-\-passwordfile <file> | \fB\-\-password\fR <password>] +.TP +run [common\-options] +[\-\-exe <path to executable>] [\-\-timeout <msec>] +[\-E|\-\-putenv <NAME>[=<VALUE>]] [\-\-unquoted\-args] +[\-\-ignore\-operhaned\-processes] [\-\-profile] +[\-\-no\-wait\-stdout|\-\-wait\-stdout] +[\-\-no\-wait\-stderr|\-\-wait\-stderr] +[\-\-dos2unix] [\-\-unix2dos] +\fB\-\-\fR <program/arg0> [argument1] ... [argumentN]] +.TP +start [common\-options] +[\-\-exe <path to executable>] [\-\-timeout <msec>] +[\-E|\-\-putenv <NAME>[=<VALUE>]] [\-\-unquoted\-args] +[\-\-ignore\-operhaned\-processes] [\-\-profile] +\fB\-\-\fR <program/arg0> [argument1] ... [argumentN]] +.TP +copyfrom [common\-options] +[\-\-follow] [\-R|\-\-recursive] +<guest\-src0> [guest\-src1 [...]] <host\-dst> +.TP +copyfrom [common\-options] +[\-\-follow] [\-R|\-\-recursive] +[\-\-target\-directory <host\-dst\-dir>] +<guest\-src0> [guest\-src1 [...]] +.TP +copyto [common\-options] +[\-\-follow] [\-R|\-\-recursive] +<host\-src0> [host\-src1 [...]] <guest\-dst> +.TP +copyto [common\-options] +[\-\-follow] [\-R|\-\-recursive] +[\-\-target\-directory <guest\-dst>] +<host\-src0> [host\-src1 [...]] +.TP +mkdir|createdir[ectory] [common\-options] +[\-\-parents] [\-\-mode <mode>] +<guest directory> [...] +.TP +rmdir|removedir[ectory] [common\-options] +[\-R|\-\-recursive] +<guest directory> [...] +.TP +removefile|rm [common\-options] [\-f|\-\-force] +<guest file> [...] +.TP +mv|move|ren[ame] [common\-options] +<source> [source1 [...]] <dest> +.TP +mktemp|createtemp[orary] [common\-options] +[\-\-secure] [\-\-mode <mode>] [\-\-tmpdir <directory>] +<template> +.TP +stat [common\-options] +<file> [...] +.TP +guestcontrol +<uuid|vmname> [\-\-verbose|\-v] [\-\-quiet|\-q] +.IP +list <all|sessions|processes|files> [common\-opts] +.TP +closeprocess [common\-options] +< \fB\-\-session\-id\fR <ID> +.TP +| \fB\-\-session\-name\fR <name or pattern> +<PID1> [PID1 [...]] +.TP +closesession [common\-options] +< \fB\-\-all\fR | \fB\-\-session\-id\fR <ID> +.IP +| \fB\-\-session\-name\fR <name or pattern> > +.TP +updatega|updateguestadditions|updateadditions +[\-\-source <guest additions .ISO>] +[\-\-wait\-start] [common\-options] +[\-\- [<argument1>] ... [<argumentN>]] +.IP +watch [common\-options] +.TP +metrics +list [*|host|<vmname> [<metric_list>]] +.IP +(comma\-separated) +.TP +metrics +setup +[\-\-period <seconds>] (default: 1) +[\-\-samples <count>] (default: 1) +[\-\-list] +[*|host|<vmname> [<metric_list>]] +.TP +metrics +query [*|host|<vmname> [<metric_list>]] +.TP +metrics +enable +[\-\-list] +[*|host|<vmname> [<metric_list>]] +.TP +metrics +disable +[\-\-list] +[*|host|<vmname> [<metric_list>]] +.TP +metrics +collect +[\-\-period <seconds>] (default: 1) +[\-\-samples <count>] (default: 1) +[\-\-list] +[\-\-detach] +[*|host|<vmname> [<metric_list>]] +.TP +natnetwork +add \fB\-\-netname\fR <name> +\fB\-\-network\fR <network> +[\-\-enable|\-\-disable] +[\-\-dhcp on|off] +[\-\-port\-forward\-4 <rule>] +[\-\-loopback\-4 <rule>] +[\-\-ipv6 on|off] +[\-\-port\-forward\-6 <rule>] +[\-\-loopback\-6 <rule>] +.TP +natnetwork +remove \fB\-\-netname\fR <name> +.TP +natnetwork +modify \fB\-\-netname\fR <name> +[\-\-network <network>] +[\-\-enable|\-\-disable] +[\-\-dhcp on|off] +[\-\-port\-forward\-4 <rule>] +[\-\-loopback\-4 <rule>] +[\-\-ipv6 on|off] +[\-\-port\-forward\-6 <rule>] +[\-\-loopback\-6 <rule>] +.TP +natnetwork +start \fB\-\-netname\fR <name> +.TP +natnetwork +stop \fB\-\-netname\fR <name> +.TP +natnetwork +list [<pattern>] +.TP +hostonlyif +ipconfig <name> +[\-\-dhcp | +\fB\-\-ip\fR<ipv4> [\-\-netmask<ipv4> (def: 255.255.255.0)] | +\fB\-\-ipv6\fR<ipv6> [\-\-netmasklengthv6<length> (def: 64)]] +create | +remove <name> +.TP +dhcpserver +add|modify \fB\-\-netname\fR <network_name> | +.TP +\fB\-\-ifname\fR <hostonly_if_name> +[\-\-ip <ip_address> +\fB\-\-netmask\fR <network_mask> +\fB\-\-lowerip\fR <lower_ip> +\fB\-\-upperip\fR <upper_ip>] +[\-\-enable | \fB\-\-disable]\fR +[\-\-options [\-\-vm <name> \fB\-\-nic\fR <1\-N>] +.TP +\fB\-\-id\fR <number> [\-\-value <string> | \fB\-\-remove]]\fR +(multiple options allowed after \fB\-\-options\fR) +.TP +dhcpserver +remove \fB\-\-netname\fR <network_name> | +.IP +\fB\-\-ifname\fR <hostonly_if_name> +.TP +usbdevsource +add <source name> +\fB\-\-backend\fR <backend> +\fB\-\-address\fR <address> +.TP +usbdevsource +remove <source name> +.IP +Medium content access: +.IP +VBoxManage mediumio <[\-\-disk=uuid|filename] | [\-\-dvd=uuid|filename] | [\-\-floppy=uuid|filename]> [\-\-password\-file\-|filename] formatfat [\-\-quick] +.IP +VBoxManage mediumio <[\-\-disk=uuid|filename] | [\-\-dvd=uuid|filename] | [\-\-floppy=uuid|filename]> [\-\-password\-file\-|filename] cat [\-\-hex] [\-\-offset=byte\-offset] [\-\-size=bytes] [\-\-output=\-|filename] +.IP +VBoxManage mediumio <[\-\-disk=uuid|filename] | [\-\-dvd=uuid|filename] | [\-\-floppy=uuid|filename]> [\-\-password\-file\-|filename] stream [\-\-format=image\-format] [\-\-variant=image\-variant] [\-\-output=\-|filename] +.IP +Introspection and guest debugging: +.IP +VBoxManage debugvm <uuid|vmname> dumpvmcore [\-\-filename=name] +.IP +VBoxManage debugvm <uuid|vmname> info <item> [args...] +.IP +VBoxManage debugvm <uuid|vmname> injectnmi +.IP +VBoxManage debugvm <uuid|vmname> log [[\-\-release] | [\-\-debug]] [group\-settings...] +.IP +VBoxManage debugvm <uuid|vmname> logdest [[\-\-release] | [\-\-debug]] [destinations...] +.IP +VBoxManage debugvm <uuid|vmname> logflags [[\-\-release] | [\-\-debug]] [flags...] +.IP +VBoxManage debugvm <uuid|vmname> osdetect +.IP +VBoxManage debugvm <uuid|vmname> osinfo +.IP +VBoxManage debugvm <uuid|vmname> osdmesg [\-\-lines=lines] +.IP +VBoxManage debugvm <uuid|vmname> getregisters [\-\-cpu=id] [reg\-set.reg\-name...] +.IP +VBoxManage debugvm <uuid|vmname> setregisters [\-\-cpu=id] [reg\-set.reg\-name=value...] +.IP +VBoxManage debugvm <uuid|vmname> show [[\-\-human\-readable] | [\-\-sh\-export] | [\-\-sh\-eval] | [\-\-cmd\-set]] [settings\-item...] +.IP +VBoxManage debugvm <uuid|vmname> stack [\-\-cpu=id] +.IP +VBoxManage debugvm <uuid|vmname> statistics [\-\-reset] [\-\-descriptions] [\-\-pattern=pattern] +.IP +Extension package management: +.IP +VBoxManage extpack install [\-\-replace] <tarball> +.IP +VBoxManage extpack uninstall [\-\-force] <name> +.IP +VBoxManage extpack cleanup +.IP +Unattended guest OS installation: +.IP +VBoxManage unattended detect <\-\-iso=install\-iso> [\-\-machine\-readable] +.IP +VBoxManage unattended install <uuid|vmname> <\-\-iso=install\-iso> [\-\-user=login] [\-\-password=password] [\-\-password\-file=file] [\-\-full\-user\-name=name] [\-\-key=product\-key] [\-\-install\-additions] +.IP +[\-\-no\-install\-additions] [\-\-additions\-iso=add\-iso] [\-\-install\-txs] [\-\-no\-install\-txs] [\-\-validation\-kit\-iso=testing\-iso] [\-\-locale=ll_CC] [\-\-country=CC] [\-\-time\-zone=tz] [\-\-hostname=fqdn] +[\-\-package\-selection\-adjustment=keyword] [\-\-dry\-run] [\-\-auxiliary\-base\-path=path] [\-\-image\-index=number] [\-\-script\-template=file] [\-\-post\-install\-template=file] [\-\-post\-install\-command=command] +[\-\-extra\-install\-kernel\-parameters=params] [\-\-language=lang] [\-\-start\-vm=session\-type] diff --git a/debian/manpages/VBoxSDL.1 b/debian/manpages/VBoxSDL.1 new file mode 100644 index 00000000..55f5c297 --- /dev/null +++ b/debian/manpages/VBoxSDL.1 @@ -0,0 +1,107 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH VBOXSDL "1" "January 2019" "VBoxSDL" "User Commands" +.SH NAME +VBoxSDL \- x86 virtualization solution +.SH DESCRIPTION +Oracle VM VirtualBox SDL GUI version +(C) 2005\-2019 Oracle Corporation +All rights reserved. +.SS "Usage:" +.TP +\fB\-\-startvm\fR <uuid|name> +Virtual machine to start, either UUID or name +.TP +\fB\-\-separate\fR +Run a separate VM process or attach to a running VM +.TP +\fB\-\-hda\fR <file> +Set temporary first hard disk to file +.TP +\fB\-\-fda\fR <file> +Set temporary first floppy disk to file +.TP +\fB\-\-cdrom\fR <file> +Set temporary CDROM/DVD to file/device ('none' to unmount) +.TP +\fB\-\-boot\fR <a|c|d|n> +Set temporary boot device (a = floppy, c = 1st HD, d = DVD, n = network) +.TP +\fB\-\-memory\fR <size> +Set temporary memory size in megabytes +.TP +\fB\-\-vram\fR <size> +Set temporary size of video memory in megabytes +.TP +\fB\-\-fullscreen\fR +Start VM in fullscreen mode +.TP +\fB\-\-fullscreenresize\fR +Resize the guest on fullscreen +.HP +\fB\-\-fixedmode\fR <w> <h> <bpp> Use a fixed SDL video mode with given width, height and bits per pixel +.TP +\fB\-\-nofstoggle\fR +Forbid switching to/from fullscreen mode +.TP +\fB\-\-noresize\fR +Make the SDL frame non resizable +.TP +\fB\-\-nohostkey\fR +Disable all hostkey combinations +.TP +\fB\-\-nohostkeys\fR ... +Disable specific hostkey combinations, see below for valid keys +.TP +\fB\-\-nograbonclick\fR +Disable mouse/keyboard grabbing on mouse click w/o additions +.TP +\fB\-\-detecthostkey\fR +Get the hostkey identifier and modifier state +.HP +\fB\-\-hostkey\fR <key> {<key2>} <mod> Set the host key to the values obtained using \fB\-\-detecthostkey\fR +.TP +\fB\-\-termacpi\fR +Send an ACPI power button event when closing the window +.TP +\fB\-\-vrdp\fR <ports> +Listen for VRDP connections on one of specified ports (default if not specified) +.TP +\fB\-\-discardstate\fR +Discard saved state (if present) and revert to last snapshot (if present) +.TP +\fB\-\-settingspw\fR <pw> +Specify the settings password +.TP +\fB\-\-settingspwfile\fR <file> +Specify a file containing the settings password +.TP +\fB\-\-[no]rawr0\fR +Enable or disable raw ring 3 +.TP +\fB\-\-[no]rawr3\fR +Enable or disable raw ring 0 +.TP +\fB\-\-[no]patm\fR +Enable or disable PATM +.TP +\fB\-\-[no]csam\fR +Enable or disable CSAM +.TP +\fB\-\-[no]hwvirtex\fR +Permit or deny the usage of VT\-x/AMD\-V +.SS "Key bindings:" +.TP +<hostkey> + +f Switch to full screen / restore to previous view +h Press ACPI power button +n Take a snapshot and continue execution +p Pause / resume execution +q Power off +r VM reset +s Save state and power off +.TP +<del> +Send <ctrl><alt><del> +.TP +<F1>...<F12> +Send <ctrl><alt><Fx> diff --git a/debian/manpages/VBoxService.8 b/debian/manpages/VBoxService.8 new file mode 100644 index 00000000..7036a3d2 --- /dev/null +++ b/debian/manpages/VBoxService.8 @@ -0,0 +1,6 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH VBOXSERVICE "8" "January 2019" "VBoxService" "System Administration Utilities" +.SH NAME +VBoxService \- x86 virtualization solution +.SH DESCRIPTION +VBoxService: error: VbglR3Init failed with rc=VERR_FILE_NOT_FOUND diff --git a/debian/manpages/VirtualBox.1 b/debian/manpages/VirtualBox.1 new file mode 100644 index 00000000..7df2ccda --- /dev/null +++ b/debian/manpages/VirtualBox.1 @@ -0,0 +1,12 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH VIRTUALBOX "1" "January 2019" "VirtualBox" "User Commands" +.SH NAME +VirtualBox \- x86 virtualization solution +.SH DESCRIPTION +Oracle VM VirtualBox VM Selector v6.0.2_Ubuntu +(C) 2005\-2019 Oracle Corporation +All rights reserved. +.PP +No special options. +.PP +If you are looking for \fB\-\-startvm\fR and related options, you need to use VirtualBoxVM. diff --git a/debian/manpages/mount.vboxsf.8 b/debian/manpages/mount.vboxsf.8 new file mode 100644 index 00000000..e94789a7 --- /dev/null +++ b/debian/manpages/mount.vboxsf.8 @@ -0,0 +1,64 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH MOUNT.VBOXSF "8" "January 2019" "mount.vboxsf" "System Administration Utilities" +.SH NAME +mount.vboxsf \- x86 virtualization solution +.SH SYNOPSIS +.B mount.vboxsf +[\fI\,OPTIONS\/\fR] \fI\,NAME MOUNTPOINT\/\fR +.SH DESCRIPTION +Mount the VirtualBox shared folder NAME from the host system to MOUNTPOINT. +.TP +\fB\-w\fR +mount the shared folder writable (the default) +.TP +\fB\-r\fR +mount the shared folder read\-only +.TP +\fB\-n\fR +do not create an mtab entry +.TP +\fB\-s\fR +sloppy parsing, ignore unrecognized mount options +.HP +\fB\-o\fR OPTION[,OPTION...] use the mount options specified +.SS "Available mount options are:" +.TP +rw +mount writable (the default) +.TP +ro +mount read only +.TP +uid=UID +set the default file owner user id to UID +.TP +gid=GID +set the default file owner group id to GID +.TP +ttl=TTL +set the "time to live" to TID for the dentry +.TP +dmode=MODE +override the mode of all directories to (octal) MODE +.TP +fmode=MODE +override the mode of all regular files to (octal) MODE +.TP +umask=UMASK +set the umask to (octal) UMASK +.TP +dmask=UMASK +set the umask applied to directories only +.TP +fmask=UMASK +set the umask applied to regular files only +.TP +iocharset CHARSET +use the character set CHARSET for I/O operations +(default set is utf8) +.TP +convertcp CHARSET +convert the folder name from CHARSET to utf8 +.SS "Less common used options:" +.IP +noexec,exec,nodev,dev,nosuid,suid diff --git a/debian/manpages/vboxwebsrv.1 b/debian/manpages/vboxwebsrv.1 new file mode 100644 index 00000000..419cd794 --- /dev/null +++ b/debian/manpages/vboxwebsrv.1 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH VBOXWEBSRV "1" "January 2019" "vboxwebsrv" "User Commands" +.SH NAME +vboxwebsrv \- x86 virtualization solution +.SH SYNOPSIS +.B vboxwebsrv +[\fI\,options\/\fR] +.SH DESCRIPTION +Oracle VM VirtualBox web service +(C) 2007\-2019 Oracle Corporation +All rights reserved. +.PP +Supported options (default values in brackets): +\fB\-\-help\fR, \fB\-h\fR: Print this help message and exit. +\fB\-\-background\fR, \fB\-b\fR: Run in background (daemon mode). +\fB\-\-host\fR, \fB\-H\fR: The host to bind to (localhost). +\fB\-\-port\fR, \fB\-p\fR: The port to bind to (18083). +\fB\-\-ssl\fR, \fB\-s\fR: Enable SSL/TLS encryption. +\fB\-\-keyfile\fR, \fB\-K\fR: Server key and certificate file, PEM format (""). +\fB\-\-passwordfile\fR, \fB\-a\fR: File name for password to server key (""). +\fB\-\-cacert\fR, \fB\-c\fR: CA certificate file, PEM format (""). +\fB\-\-capath\fR, \fB\-C\fR: CA certificate path (""). +\fB\-\-dhfile\fR, \fB\-D\fR: DH file name or DH key length in bits (""). +\fB\-\-randfile\fR, \fB\-r\fR: File containing seed for random number generator (""). +\fB\-\-timeout\fR, \fB\-t\fR: Session timeout in seconds; 0 = disable timeouts (300). +\fB\-\-check\-interval\fR, \fB\-i\fR: Frequency of timeout checks in seconds (5). +\fB\-\-threads\fR, \fB\-T\fR: Maximum number of worker threads to run in parallel (100). +\fB\-\-keepalive\fR, \fB\-k\fR: Maximum number of requests before a socket will be closed (100). +\fB\-\-authentication\fR, \fB\-A\fR: Authentication method for the webservice (""). +\fB\-\-verbose\fR, \fB\-v\fR: Be verbose. +\fB\-\-pidfile\fR, \fB\-P\fR: Name of the PID file which is created when the daemon was started. +\fB\-\-logfile\fR, \fB\-F\fR: Name of file to write log to (no file). +\fB\-\-logrotate\fR, \fB\-R\fR: Number of log files (0 disables log rotation). +\fB\-\-logsize\fR, \fB\-S\fR: Maximum size of a log file to trigger rotation (bytes). +\fB\-\-loginterval\fR, \fB\-I\fR: Maximum time interval to trigger log rotation (seconds). |