From a929d51743da4a826cf071042725d1e299fd11fc Mon Sep 17 00:00:00 2001 From: Morgan Aldridge Date: Tue, 29 Jan 2019 23:58:52 -0500 Subject: [PATCH] Added initial manual in ronn, roff, and html formats (the latter two generated by ronn) --- man/basiliskiivm.1 | 77 +++++++++++++++++++++++ man/basiliskiivm.1.html | 133 ++++++++++++++++++++++++++++++++++++++++ man/basiliskiivm.1.ronn | 62 +++++++++++++++++++ 3 files changed, 272 insertions(+) create mode 100644 man/basiliskiivm.1 create mode 100644 man/basiliskiivm.1.html create mode 100644 man/basiliskiivm.1.ronn diff --git a/man/basiliskiivm.1 b/man/basiliskiivm.1 new file mode 100644 index 0000000..d3dff51 --- /dev/null +++ b/man/basiliskiivm.1 @@ -0,0 +1,77 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BASILISKIIVM" "1" "January 2019" "" "" +. +.SH "NAME" +\fBbasiliskiivm\fR \- manage and run multiple BasiliskII VMs +. +.SH "SYNOPSIS" +\fBbasiliskiivm\fR \fIoptions\fR \fIcommand\fR +. +.SH "DESCRIPTION" +BasiliskII(1) is a free, portable 68k Mac emulator, however it only has a single configuration file and so does not easily support emulating multiple virtual Macs\. \fBbasiliskiivm\fR is a wrapper around BasiliskII which simplifies the process of creating, managing, and running multiple VMs\. It does this by packaging BasiliskII configuration files, disk images, and other state data for each VM into a *\.BasiliskIIVM directory/bundle, which can then be acted on using convenience commands\. +. +.SH "OPTIONS" +. +.TP +\fB\-h\fR, \fB\-\-help\fR +print usage instructions +. +.TP +\fB\-V\fR, \fB\-\-version\fR +print version information +. +.SH "COMMANDS" +. +.TP +\fBinfo \fR +print basic configuration info for a \.BasiliskIIVM +. +.TP +\fBlist []\fR +list all \.BasiliskIIVM in path (or none for default directory) +. +.TP +\fBpackage\fR +package the current BasiliskII configuration into a \.BasiliskIIVM +. +.TP +\fBsnapshot \fR +create a snapshot of the current state of disks in the \.BasiliskIIVM +. +.TP +\fBsnapshots \fR +list all snapshots in a \.BasiliskIIVM +. +.TP +\fBstart \fR +start a BasiliskII instance from a \.BasiliskIIVM +. +.TP +\fBstatus \fR +get the status of a \.BasiliskIIVM +. +.TP +\fBstop \fR +stop a running \.BasiliskIIVM +. +.SH "ENVIRONMENT VARIABLES" +. +.TP +\fBBASILISKII_BINARY\fR +path to your BasiliskII binary, if it\'s not in your search path +. +.TP +\fBBASILISKII_VMS_PATH\fR +path where you store your BasiliskII VMs +. +.TP +\fBBASILISKII_SNAPSHOT_COMPRESSION\fR +method used for snapshot compression (\'none\', \'gzip\') +. +.SH "SEE ALSO" +BasiliskII(1) +. +.SH "AUTHOR" +Morgan Aldridge (morgant@makkintosshu\.com) diff --git a/man/basiliskiivm.1.html b/man/basiliskiivm.1.html new file mode 100644 index 0000000..113e9dc --- /dev/null +++ b/man/basiliskiivm.1.html @@ -0,0 +1,133 @@ + + + + + + basiliskiivm(1) - manage and run multiple BasiliskII VMs + + + + +
+ + + +
    +
  1. basiliskiivm(1)
    2. +
  2. +
  3. basiliskiivm(1)
    4. +
+ +

NAME

+

+ basiliskiivm - manage and run multiple BasiliskII VMs +

+ +

SYNOPSIS

+ +

basiliskiivm options command

+ +

DESCRIPTION

+ +

BasiliskII(1) is a free, portable 68k Mac emulator, however it only has a single configuration file and so does not easily support emulating multiple virtual Macs. basiliskiivm is a wrapper around BasiliskII which simplifies the process of creating, managing, and running multiple VMs. It does this by packaging BasiliskII configuration files, disk images, and other state data for each VM into a *.BasiliskIIVM directory/bundle, which can then be acted on using convenience commands.

+ +

OPTIONS

+ +
+
-h, --help

print usage instructions

+
-V, --version

print version information

+
+ + +

COMMANDS

+ +
+
info <vm>

print basic configuration info for a .BasiliskIIVM

+
list [<path>]

list all .BasiliskIIVM in path (or none for default directory)

+
package

package the current BasiliskII configuration into a .BasiliskIIVM

+
snapshot <vm>

create a snapshot of the current state of disks in the .BasiliskIIVM

+
snapshots <vm>

list all snapshots in a .BasiliskIIVM

+
start <vm>

start a BasiliskII instance from a .BasiliskIIVM

+
status <vm>

get the status of a .BasiliskIIVM

+
stop <vm>

stop a running .BasiliskIIVM

+
+ + +

ENVIRONMENT VARIABLES

+ +
+
BASILISKII_BINARY

path to your BasiliskII binary, if it's not in your search path

+
BASILISKII_VMS_PATH

path where you store your BasiliskII VMs

+
BASILISKII_SNAPSHOT_COMPRESSION

method used for snapshot compression ('none', 'gzip')

+
+ + +

SEE ALSO

+ +

BasiliskII(1)

+ +

AUTHOR

+ +

Morgan Aldridge (morgant@makkintosshu.com)

+ + +
    +
  1. +
  2. January 2019
    3. +
  3. basiliskiivm(1)
    4. +
+ +
+ + diff --git a/man/basiliskiivm.1.ronn b/man/basiliskiivm.1.ronn new file mode 100644 index 0000000..a243898 --- /dev/null +++ b/man/basiliskiivm.1.ronn @@ -0,0 +1,62 @@ +# basiliskiivm(1) -- manage and run multiple BasiliskII VMs + +## SYNOPSIS + +`basiliskiivm` [options] + +## DESCRIPTION + +BasiliskII(1) is a free, portable 68k Mac emulator, however it only has a single configuration file and so does not easily support emulating multiple virtual Macs. `basiliskiivm` is a wrapper around BasiliskII which simplifies the process of creating, managing, and running multiple VMs. It does this by packaging BasiliskII configuration files, disk images, and other state data for each VM into a *.BasiliskIIVM directory/bundle, which can then be acted on using convenience commands. + +## OPTIONS + +* `-h`, `--help`: + print usage instructions + +* `-V`, `--version`: + print version information + +## COMMANDS + +* `info `: + print basic configuration info for a .BasiliskIIVM + +* `list []`: + list all .BasiliskIIVM in path (or none for default directory) + +* `package`: + package the current BasiliskII configuration into a .BasiliskIIVM + +* `snapshot `: + create a snapshot of the current state of disks in the .BasiliskIIVM + +* `snapshots `: + list all snapshots in a .BasiliskIIVM + +* `start `: + start a BasiliskII instance from a .BasiliskIIVM + +* `status `: + get the status of a .BasiliskIIVM + +* `stop `: + stop a running .BasiliskIIVM + +## ENVIRONMENT VARIABLES + +* `BASILISKII_BINARY`: + path to your BasiliskII binary, if it's not in your search path + +* `BASILISKII_VMS_PATH`: + path where you store your BasiliskII VMs + +* `BASILISKII_SNAPSHOT_COMPRESSION`: + method used for snapshot compression ('none', 'gzip') + +## SEE ALSO + +BasiliskII(1) + +## AUTHOR + +Morgan Aldridge (morgant@makkintosshu.com)