xref: /dragonfly/usr.sbin/nvmmctl/nvmmctl.8 (revision 634ba020)
1.\"	$NetBSD: nvmmctl.8,v 1.2.2.2 2019/11/10 12:58:29 martin Exp $
2.\"
3.\" Copyright (c) 2019 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Maxime Villard.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd October 27, 2019
31.Dt NVMMCTL 8
32.Os
33.Sh NAME
34.Nm nvmmctl
35.Nd program to control virtual machines
36.Sh SYNOPSIS
37.Nm nvmmctl
38.Ar command
39.Op Ar arguments
40.Sh DESCRIPTION
41The
42.Nm
43command can be used to control and inspect the state of virtual machines in the
44system.
45.Pp
46The first argument,
47.Ar command ,
48specifies the action to take.
49Valid commands are:
50.Bl -tag -width XXXXXXXX
51.It identify
52Display the capabilities of the system.
53.It list
54Display information on each virtual machine registered in the system.
55.El
56.Sh SEE ALSO
57.Xr libnvmm 3 ,
58.Xr nvmm 4
59.Sh AUTHORS
60The
61.Nm
62tool was written by
63.An Maxime Villard .
64