diff options
author | Jason McIntyre <jmc@cvs.openbsd.org> | 2015-11-22 21:24:49 +0000 |
---|---|---|
committer | Jason McIntyre <jmc@cvs.openbsd.org> | 2015-11-22 21:24:49 +0000 |
commit | f92e0169b5bd98b78d9443c3a4621e6e9ecb3410 (patch) | |
tree | 2d256b87fb518b3267392163387981fcbe9a0d47 | |
parent | 0ec5c6797982fd9b64a46d9743f95e1e548131cd (diff) |
sundry tweaks;
-rw-r--r-- | usr.sbin/vmd/vmd.8 | 36 | ||||
-rw-r--r-- | usr.sbin/vmmctl/vmm.conf.5 | 5 | ||||
-rw-r--r-- | usr.sbin/vmmctl/vmmctl.8 | 66 |
3 files changed, 56 insertions, 51 deletions
diff --git a/usr.sbin/vmd/vmd.8 b/usr.sbin/vmd/vmd.8 index a68b8d50093..bf838516d60 100644 --- a/usr.sbin/vmd/vmd.8 +++ b/usr.sbin/vmd/vmd.8 @@ -1,17 +1,19 @@ +.\" $OpenBSD: vmd.8,v 1.2 2015/11/22 21:24:48 jmc Exp $ .\" -.\"Copyright (c) 2015 Mike Larkin <mlarkin@openbsd.org> +.\" Copyright (c) 2015 Mike Larkin <mlarkin@openbsd.org> .\" -.\"Permission to use, copy, modify, and distribute this software for any -.\"purpose with or without fee is hereby granted, provided that the above -.\"copyright notice and this permission notice appear in all copies. +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.\"THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -.\"WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -.\"MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -.\"ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -.\"WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -.\"ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -.\"OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .Dd $Mdocdate: November 22 2015 $ .Dt VMD 8 .Os @@ -29,7 +31,7 @@ host. is typically started at boot time and is controlled via .Xr vmmctl 8 . .Pp -.Nm +.Nm can be enabled during system boot by setting the following in .Pa /etc/rc.conf.local : .Pp @@ -40,7 +42,8 @@ interfaces with the virtual machine monitor (VMM) built into the kernel. One instance of .Nm will be spawned for each VM running on the host, plus an extra instance -for control operations. Each child +for control operations. +Each child .Nm will in turn create one or more VCPU (virtual CPU) threads responsible for driving the VM's operations using @@ -49,14 +52,13 @@ driving the VM's operations using .Nm is also responsible for proxying various other commands/requests from .Xr vmmctl 8 , -such as stopping VMs, and retrieving information from -.Xr vmm 4 +such as stopping VMs, and retrieving information from +.Xr vmm 4 about running VMs. -.Pp .Sh SEE ALSO .Xr vmm 4 , -.Xr vmmctl 8 , .Xr rc.conf 8 , +.Xr vmmctl 8 .Sh HISTORY The .Nm diff --git a/usr.sbin/vmmctl/vmm.conf.5 b/usr.sbin/vmmctl/vmm.conf.5 index cacefa96a0d..1a6735cae53 100644 --- a/usr.sbin/vmmctl/vmm.conf.5 +++ b/usr.sbin/vmmctl/vmm.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: vmm.conf.5,v 1.1 2015/11/22 20:55:18 reyk Exp $ +.\" $OpenBSD: vmm.conf.5,v 1.2 2015/11/22 21:24:48 jmc Exp $ .\" .\" Copyright (c) 2015 Mike Larkin <mlarkin@openbsd.org> .\" Copyright (c) 2015 Reyk Floeter <reyk@openbsd.org> @@ -23,7 +23,7 @@ .Nd virtual machine configuration .Sh DESCRIPTION .Nm -is the configuration file to configure the the virtual machine monitor +is the configuration file to configure the virtual machine monitor (VMM) subsystem. A VMM manages virtual machines (VMs) on a .Ar host . @@ -150,7 +150,6 @@ vm "vm2.example.com" { kernel "/bsd" } .Ed -.Pp .Sh SEE ALSO .Xr vmm 4 , .Xr vmd 8 , diff --git a/usr.sbin/vmmctl/vmmctl.8 b/usr.sbin/vmmctl/vmmctl.8 index cc06350929e..4b9a4abd86d 100644 --- a/usr.sbin/vmmctl/vmmctl.8 +++ b/usr.sbin/vmmctl/vmmctl.8 @@ -1,17 +1,19 @@ +.\" $OpenBSD: vmmctl.8,v 1.3 2015/11/22 21:24:48 jmc Exp $ .\" -.\"Copyright (c) 2015 Mike Larkin <mlarkin@openbsd.org> +.\" Copyright (c) 2015 Mike Larkin <mlarkin@openbsd.org> .\" -.\"Permission to use, copy, modify, and distribute this software for any -.\"purpose with or without fee is hereby granted, provided that the above -.\"copyright notice and this permission notice appear in all copies. +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.\"THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -.\"WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -.\"MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -.\"ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -.\"WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -.\"ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -.\"OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .Dd $Mdocdate: November 22 2015 $ .Dt VMMCTL 8 .Os @@ -35,18 +37,18 @@ VMs. The options are as follows: .Bl -tag -width Ds .It Cm enable -Enable the VMM subsystem. The VMM subsystem must be enabled before VMs -can be managed on the host. +Enable the VMM subsystem. +The VMM subsystem must be enabled before VMs can be managed on the host. .It Cm disable -Disable the VMM subsystem. Virtual machines running on the host should be -terminated first. +Disable the VMM subsystem. +Virtual machines running on the host should be terminated first. .It Cm load Op Ar path Load the .Xr vmm.conf 5 configuration file from .Pa /etc/vmm.conf or the specified -.Ar path. +.Ar path . .El .Pp Generally, the @@ -85,6 +87,15 @@ Terminates (stops) a VM defined by the specified VM Lists VMs running on the host, optionally listing just the selected VM .Ar id . .El +.Sh FILES +.Bl -tag -width "/etc/var/run/vmd.sockXX" -compact +.It Pa /etc/vmm.conf +Default configuration file. +.It Pa /var/run/vmd.sock +.Ux Ns -domain +socket used for communication with +.Xr vmd 8 . +.El .Sh EXIT STATUS .Ex -std vmmctl .Nm @@ -106,27 +117,20 @@ Disable the VMM subsystem: Create a new disk image ('disk.img') of 4 gigabyte size: .Dl $ vmmctl create disk.img size 4G .Pp -Create a new VM with 512MB memory, 1 network interface, one disk image +Create a new VM with 512MB memory, one network interface, one disk image ('disk.img') and boot from kernel '/bsd': -.Dl $ vmmctl start "myvm" memory 512M interfaces 1 disk disk.img kernel /bsd +.Bd -literal -offset indent +$ vmmctl start "myvm" memory 512M interfaces 1 disk disk.img \e + kernel /bsd +.Ed .Pp -Terminate VM number 1 +Terminate VM number 1: .Dl $ vmmctl terminate 1 -.Pp -.Sh FILES -.Bl -tag -width "/etc/var/run/vmd.sockXX" -compact -.It Pa /etc/vmm.conf -Default configuration file. -.It Pa /var/run/vmd.sock -.Ux Ns -domain -socket used for communication with -.Xr vmd 8 . -.El .Sh SEE ALSO .Xr vmm 4 , .Xr vmm.conf 5 , -.Xr vmd 8 , -.Xr rc.conf 8 +.Xr rc.conf 8 , +.Xr vmd 8 .Sh HISTORY The .Nm |