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