summaryrefslogtreecommitdiffstats
path: root/debian/manpages/VBoxService.8
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--debian/manpages/VBoxService.8156
1 files changed, 156 insertions, 0 deletions
diff --git a/debian/manpages/VBoxService.8 b/debian/manpages/VBoxService.8
new file mode 100644
index 00000000..eec88f81
--- /dev/null
+++ b/debian/manpages/VBoxService.8
@@ -0,0 +1,156 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
+.TH VBOXSERVICE "1" "October 2022" "VBoxService" "User Commands"
+.SH NAME
+VBoxService \- x86 virtualization solution
+.SH SYNOPSIS
+.B VBoxService
+[\fI\,-f|--foreground\/\fR] [\fI\,-v|--verbose\/\fR] [\fI\,-l|--logfile <file>\/\fR]
+.SH DESCRIPTION
+.IP
+[\-p|\-\-pidfile <file>] [\-i|\-\-interval <seconds>]
+[\-\-disable\-<service>] [\-\-enable\-<service>]
+[\-\-only\-<service>] [\-h|\-?|\-\-help]
+[\-\-control\-interval <ms>]
+[\-\-timesync\-interval <ms>] [\-\-timesync\-min\-adjust <ms>]
+[\-\-timesync\-latency\-factor <x>] [\-\-timesync\-max\-latency <ms>]
+[\-\-timesync\-set\-threshold <ms>]
+[\-\-timesync\-set\-start|\-\-timesync\-no\-set\-start]
+[\-\-timesync\-set\-on\-restore|\-\-timesync\-no\-set\-on\-restore]
+[\-\-timesync\-verbosity <level>]
+[\-\-vminfo\-interval <ms>] [\-\-vminfo\-user\-idle\-threshold <ms>]
+.SH OPTIONS
+.TP
+\fB\-i\fR | \fB\-\-interval\fR
+The default interval.
+.TP
+\fB\-f\fR | \fB\-\-foreground\fR
+Don't daemonize the program. For debugging.
+.TP
+\fB\-l\fR | \fB\-\-logfile\fR <file>
+Enables logging to a file.
+.TP
+\fB\-p\fR | \fB\-\-pidfile\fR <file>
+Write the process ID to a file.
+.TP
+\fB\-v\fR | \fB\-\-verbose\fR
+Increment the verbosity level. For debugging.
+.TP
+\fB\-V\fR | \fB\-\-version\fR
+Show version information.
+.TP
+\fB\-h\fR | \-? | \fB\-\-help\fR
+Show this message and exit with status 1.
+.SS "Service-specific options:"
+.TP
+\fB\-\-enable\-control\fR
+Enables the control service. (default)
+.TP
+\fB\-\-disable\-control\fR
+Disables the control service.
+.TP
+\fB\-\-only\-control\fR
+Only enables the control service.
+.TP
+\fB\-\-control\-interval\fR
+Specifies the interval at which to check for
+new control messages. The default is 1000 ms.
+.TP
+\fB\-\-enable\-timesync\fR
+Enables the timesync service. (default)
+.TP
+\fB\-\-disable\-timesync\fR
+Disables the timesync service.
+.TP
+\fB\-\-only\-timesync\fR
+Only enables the timesync service.
+.TP
+\fB\-\-timesync\-interval\fR
+Specifies the interval at which to synchronize the
+time with the host. The default is 10000 ms.
+.TP
+\fB\-\-timesync\-min\-adjust\fR
+The minimum absolute drift value measured in
+milliseconds to make adjustments for.
+The default is 1000 ms on OS/2 and 100 ms elsewhere.
+.TP
+\fB\-\-timesync\-latency\-factor\fR
+The factor to multiply the time query latency with
+to calculate the dynamic minimum adjust time.
+The default is 8 times.
+.TP
+\fB\-\-timesync\-max\-latency\fR
+The max host timer query latency to accept.
+The default is 250 ms.
+.TP
+\fB\-\-timesync\-set\-threshold\fR
+The absolute drift threshold, given as milliseconds,
+where to start setting the time instead of trying to
+adjust it. The default is 20 min.
+.TP
+\fB\-\-timesync\-set\-start\fR, \fB\-\-timesync\-no\-set\-start\fR
+Set the time when starting the time sync service.
+Default: \fB\-\-timesync\-no\-set\-start\fR
+.TP
+\fB\-\-timesync\-set\-on\-restore\fR, \fB\-\-timesync\-no\-set\-on\-restore\fR
+Whether to immediately set the time when the VM is
+restored or not. Default: \fB\-\-timesync\-set\-on\-restore\fR
+.TP
+\fB\-\-timesync\-verbosity\fR
+Sets the verbosity level. Defaults to service wide
+verbosity level.
+.TP
+\fB\-\-enable\-vminfo\fR
+Enables the vminfo service. (default)
+.TP
+\fB\-\-disable\-vminfo\fR
+Disables the vminfo service.
+.TP
+\fB\-\-only\-vminfo\fR
+Only enables the vminfo service.
+.TP
+\fB\-\-vminfo\-interval\fR
+Specifies the interval at which to retrieve the
+VM information. The default is 10000 ms.
+.TP
+\fB\-\-vminfo\-user\-idle\-threshold\fR <ms>
+Specifies the user idle threshold (in ms) for
+considering a guest user as being idle. The default
+is 5000 (5 seconds).
+.TP
+\fB\-\-enable\-cpuhotplug\fR
+Enables the cpuhotplug service. (default)
+.TP
+\fB\-\-disable\-cpuhotplug\fR
+Disables the cpuhotplug service.
+.TP
+\fB\-\-only\-cpuhotplug\fR
+Only enables the cpuhotplug service.
+.TP
+\fB\-\-enable\-memballoon\fR
+Enables the memballoon service. (default)
+.TP
+\fB\-\-disable\-memballoon\fR
+Disables the memballoon service.
+.TP
+\fB\-\-only\-memballoon\fR
+Only enables the memballoon service.
+.TP
+\fB\-\-enable\-vmstats\fR
+Enables the vmstats service. (default)
+.TP
+\fB\-\-disable\-vmstats\fR
+Disables the vmstats service.
+.TP
+\fB\-\-only\-vmstats\fR
+Only enables the vmstats service.
+.TP
+\fB\-\-enable\-automount\fR
+Enables the automount service. (default)
+.TP
+\fB\-\-disable\-automount\fR
+Disables the automount service.
+.TP
+\fB\-\-only\-automount\fR
+Only enables the automount service.
+.IP
+Copyright (C) 2009\-2022 Oracle and/or its affiliates