Added initial manual in ronn, roff, and html formats (the latter two generated by ronn)
This commit is contained in:
Morgan Aldridge
parent
6732cc8f17
commit
a929d51743
|
|
@ -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 <vm>\fR
|
||||
print basic configuration info for a \.BasiliskIIVM
|
||||
.
|
||||
.TP
|
||||
\fBlist [<path>]\fR
|
||||
list all \.BasiliskIIVM in path (or none for default directory)
|
||||
.
|
||||
.TP
|
||||
\fBpackage\fR
|
||||
package the current BasiliskII configuration into a \.BasiliskIIVM
|
||||
.
|
||||
.TP
|
||||
\fBsnapshot <vm>\fR
|
||||
create a snapshot of the current state of disks in the \.BasiliskIIVM
|
||||
.
|
||||
.TP
|
||||
\fBsnapshots <vm>\fR
|
||||
list all snapshots in a \.BasiliskIIVM
|
||||
.
|
||||
.TP
|
||||
\fBstart <vm>\fR
|
||||
start a BasiliskII instance from a \.BasiliskIIVM
|
||||
.
|
||||
.TP
|
||||
\fBstatus <vm>\fR
|
||||
get the status of a \.BasiliskIIVM
|
||||
.
|
||||
.TP
|
||||
\fBstop <vm>\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)
|
||||
|
|
@ -0,0 +1,133 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv='content-type' value='text/html;charset=utf8'>
|
||||
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
|
||||
<title>basiliskiivm(1) - manage and run multiple BasiliskII VMs</title>
|
||||
<style type='text/css' media='all'>
|
||||
/* style: man */
|
||||
body#manpage {margin:0}
|
||||
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
|
||||
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
|
||||
.mp h2 {margin:10px 0 0 0}
|
||||
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
|
||||
.mp h3 {margin:0 0 0 4ex}
|
||||
.mp dt {margin:0;clear:left}
|
||||
.mp dt.flush {float:left;width:8ex}
|
||||
.mp dd {margin:0 0 0 9ex}
|
||||
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
|
||||
.mp pre {margin-bottom:20px}
|
||||
.mp pre+h2,.mp pre+h3 {margin-top:22px}
|
||||
.mp h2+pre,.mp h3+pre {margin-top:5px}
|
||||
.mp img {display:block;margin:auto}
|
||||
.mp h1.man-title {display:none}
|
||||
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
|
||||
.mp h2 {font-size:16px;line-height:1.25}
|
||||
.mp h1 {font-size:20px;line-height:2}
|
||||
.mp {text-align:justify;background:#fff}
|
||||
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
|
||||
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
|
||||
.mp u {text-decoration:underline}
|
||||
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
|
||||
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
|
||||
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
|
||||
.mp b.man-ref {font-weight:normal;color:#434241}
|
||||
.mp pre {padding:0 4ex}
|
||||
.mp pre code {font-weight:normal;color:#434241}
|
||||
.mp h2+pre,h3+pre {padding-left:0}
|
||||
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
|
||||
ol.man-decor {width:100%}
|
||||
ol.man-decor li.tl {text-align:left}
|
||||
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
|
||||
ol.man-decor li.tr {text-align:right;float:right}
|
||||
</style>
|
||||
</head>
|
||||
<!--
|
||||
The following styles are deprecated and will be removed at some point:
|
||||
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
|
||||
|
||||
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
|
||||
.man-navigation should be used instead.
|
||||
-->
|
||||
<body id='manpage'>
|
||||
<div class='mp' id='man'>
|
||||
|
||||
<div class='man-navigation' style='display:none'>
|
||||
<a href="#NAME">NAME</a>
|
||||
<a href="#SYNOPSIS">SYNOPSIS</a>
|
||||
<a href="#DESCRIPTION">DESCRIPTION</a>
|
||||
<a href="#OPTIONS">OPTIONS</a>
|
||||
<a href="#COMMANDS">COMMANDS</a>
|
||||
<a href="#ENVIRONMENT-VARIABLES">ENVIRONMENT VARIABLES</a>
|
||||
<a href="#SEE-ALSO">SEE ALSO</a>
|
||||
<a href="#AUTHOR">AUTHOR</a>
|
||||
</div>
|
||||
|
||||
<ol class='man-decor man-head man head'>
|
||||
<li class='tl'>basiliskiivm(1)</li>
|
||||
<li class='tc'></li>
|
||||
<li class='tr'>basiliskiivm(1)</li>
|
||||
</ol>
|
||||
|
||||
<h2 id="NAME">NAME</h2>
|
||||
<p class="man-name">
|
||||
<code>basiliskiivm</code> - <span class="man-whatis">manage and run multiple BasiliskII VMs</span>
|
||||
</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<p><code>basiliskiivm</code> <a href="#OPTIONS" title="OPTIONS" data-bare-link="true">options</a> <var>command</var></p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<p><span class="man-ref">BasiliskII<span class="s">(1)</span></span> 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. <code>basiliskiivm</code> 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.</p>
|
||||
|
||||
<h2 id="OPTIONS">OPTIONS</h2>
|
||||
|
||||
<dl>
|
||||
<dt><code>-h</code>, <code>--help</code></dt><dd><p>print usage instructions</p></dd>
|
||||
<dt><code>-V</code>, <code>--version</code></dt><dd><p>print version information</p></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<h2 id="COMMANDS">COMMANDS</h2>
|
||||
|
||||
<dl>
|
||||
<dt><code>info <vm></code></dt><dd><p>print basic configuration info for a .BasiliskIIVM</p></dd>
|
||||
<dt><code>list [<path>]</code></dt><dd><p>list all .BasiliskIIVM in path (or none for default directory)</p></dd>
|
||||
<dt class="flush"><code>package</code></dt><dd><p>package the current BasiliskII configuration into a .BasiliskIIVM</p></dd>
|
||||
<dt><code>snapshot <vm></code></dt><dd><p>create a snapshot of the current state of disks in the .BasiliskIIVM</p></dd>
|
||||
<dt><code>snapshots <vm></code></dt><dd><p>list all snapshots in a .BasiliskIIVM</p></dd>
|
||||
<dt><code>start <vm></code></dt><dd><p>start a BasiliskII instance from a .BasiliskIIVM</p></dd>
|
||||
<dt><code>status <vm></code></dt><dd><p>get the status of a .BasiliskIIVM</p></dd>
|
||||
<dt><code>stop <vm></code></dt><dd><p>stop a running .BasiliskIIVM</p></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<h2 id="ENVIRONMENT-VARIABLES">ENVIRONMENT VARIABLES</h2>
|
||||
|
||||
<dl>
|
||||
<dt><code>BASILISKII_BINARY</code></dt><dd><p>path to your BasiliskII binary, if it's not in your search path</p></dd>
|
||||
<dt><code>BASILISKII_VMS_PATH</code></dt><dd><p>path where you store your BasiliskII VMs</p></dd>
|
||||
<dt><code>BASILISKII_SNAPSHOT_COMPRESSION</code></dt><dd><p>method used for snapshot compression ('none', 'gzip')</p></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<p><span class="man-ref">BasiliskII<span class="s">(1)</span></span></p>
|
||||
|
||||
<h2 id="AUTHOR">AUTHOR</h2>
|
||||
|
||||
<p>Morgan Aldridge (morgant@makkintosshu.com)</p>
|
||||
|
||||
|
||||
<ol class='man-decor man-foot man foot'>
|
||||
<li class='tl'></li>
|
||||
<li class='tc'>January 2019</li>
|
||||
<li class='tr'>basiliskiivm(1)</li>
|
||||
</ol>
|
||||
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
# basiliskiivm(1) -- 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)
|
||||
Loading…
Reference in New Issue