aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrodri <rgl@antares-labs.eu>2021-10-21 16:46:23 +0000
committerrodri <rgl@antares-labs.eu>2021-10-21 16:46:23 +0000
commitdd0b1c5f57c0b9cf1a2abb0680cb5f08fadbb16b (patch)
tree868bddf956533ae6c5857fdfc998ce062c0ba52d
parent0bef22e73c45f37eb1f9f91fccb58caf4956c910 (diff)
downloadbhyve-rc.d-front.tar.gz
bhyve-rc.d-front.tar.bz2
bhyve-rc.d-front.zip
document how the service is meant to be used.HEADfront
-rw-r--r--readme.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index fd2b099..5b1dbac 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,9 @@
# rc.d services for Bhyve VM management
These are some of the services I use to run the VMs in my internal grid under FreeBSD. It offers very basic management and monitoring at the moment.
+
+# Usage
+
+ # service bhyve_vm {start,stop,status}
+
+> When you run `service <srvname>` it usually lists a bunch of default commands implemented in the `rc.subr` script. Except for the three listed above, their behavior is **undefined**.