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