summaryrefslogtreecommitdiffstats
path: root/debian/manpages/VBoxHeadless.1
blob: 8f23ef76bdafd0f7e2ec9b00b547b04d56c81d7a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.1.
.TH VBOXHEADLESS "1" "January 2023" "VBoxHeadless" "User Commands"
.SH NAME
VBoxHeadless \- x86 virtualization solution
.SH DESCRIPTION
Oracle VM VirtualBox Headless Interface 7.0.6
Copyright \(co 2008\-2023 Oracle and/or its affiliates
.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 VirtualBox settings password
.TP
\fB\-\-settingspwfile\fR <file>
Specify a file containing the
VirtualBox settings password
.TP
\fB\-\-password\fR <file>|\-
Specify the VM password. Either file containing
the VM password or "\-" to read it from console
.TP
\fB\-\-password\-id\fR <id>
Specify the password id for the VM 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