annotate docs/man/man8/fbhyve.rst @ 467:6ecd16725818

Begin refactoring bhyve into fbhyve. Planned: - more consistent naming (analogous to jails) - using bhyve configuration files instead of RC variables for bhyve devices - more docs
author Franz Glasner <fzglas.hg@dom66.de>
date Fri, 14 Jun 2024 09:40:04 +0200
parents
children 57f253106ed6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
467
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 fbhyve
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 ======
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 Synopsis
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7 --------
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 **service fbhyve** [ **start** | **stop** | **poll** | **status** ] [**name**]...
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12 Description
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13 -----------
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 An :file:`rc.d` script to start :manpage:`bhyve(8)` virtual machines
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
16
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
17
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
18 Configuration Variables
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
19 ~~~~~~~~~~~~~~~~~~~~~~~
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
20
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
21 `fbhyve_enable`
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
22 Default: NO
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
23
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
24 `fbhyve_list`
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
25 The name of VMs to start to (aka. "profiles" or "sessions")
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
26
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
27
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
28 Files
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
29 -----
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
30
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
31 - :file:`/usr/local/etc/fbhyve`
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
32
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33 Default-directory where all the configuration files with relative
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34 filenames are looked up.
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37 See also
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
38 --------
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
40 :manpage:`bhyve(8)`, :manpage:`rc.conf(5)`, :manpage:`tmux(1)`