Change all option handling to be "vm subcommand <opts>"

To reduce code we originally parsed some options globally, such as "vm -f start ...".
However this was confusing and inconsistent, especially in relation to other commands
such as zfs(8).
This commit is contained in:
Matt Churchyard
2018-06-29 09:03:27 +00:00
parent eb96491b08
commit a8e3b1c5cc
6 changed files with 60 additions and 79 deletions

44
vm.8
View File

@@ -78,8 +78,8 @@
.Ar name
.Nm
.Cm
.Op Fl f
.Cm destroy
.Op Fl f
.Ar name
.Nm
.Cm list
@@ -88,12 +88,12 @@
.Op Ar name
.Op Ar ...
.Nm
.Op Fl fi
.Cm install
.Op Fl fi
.Ar name iso
.Nm
.Op Fl fi
.Cm start
.Op Fl fi
.Ar name
.Ar ...
.Nm
@@ -115,12 +115,12 @@
.Op Fl s Ar size|switch
.Ar name
.Nm
.Op Fl f
.Cm reset
.Op Fl f
.Ar name
.Nm
.Op Fl f
.Cm poweroff
.Op Fl f
.Ar name
.Nm
.Cm startall
@@ -366,40 +366,6 @@ A pre-compiled copy of the UEFI firmware (BHYVE_UEFI_20160526.fd), as well as
instructions for creating an
unattended installation ISO can currently be obtained from
.Lk https://people.freebsd.org/~grehan/bhyve_uefi/
.\" ============ GLOBAL OPTIONS =============
.Sh GLOBAL OPTIONS
There are some options that can be specified after
.Sy vm ,
but before any subcommand.
These are global options that affect the way
.Nm
functions.
.Bl -tag -width 12n
.It Fl f
Run
.Nm
in the foreground.
This option is primarily useful with the
.Nm Cm start
or
.Nm Cm install
command and runs the guest on stdio.
.Pp
Note that for some commands, such as
.Sy destroy ,
.Sy reset ,
.Sy poweroff ,
this is interpreted as "force", and will perform the action without confirmation.
.It Fl i
Run the guest in interactive mode.
This mode is only supported when using the
.Sy tmux
console setting.
This starts the guest on a tmux session and then immediately connects to that
session.
You can detach the session, or shut the guest down to return to your original
terminal.
.El
.\" ============ SUBCOMMANDS =============
.Sh SUBCOMMANDS
.Bl -tag -width indent