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