prlbackup 1.0.0

data/man/prlbackup.1

@@ -0,0 +1,168 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PRLBACKUP" "1" "May 2012" "" "PRLBACKUP MANUAL"
+.
+.SH "NAME"
+\fBprlbackup\fR \- an awesome backup tool for Parallels Server Virtual Machines
+.
+.SH "SYNOPSIS"
+\fBprlbackup\fR \fB\-h\fR|\fB\-\-help\fR
+.
+.br
+\fBprlbackup\fR [\fIOPTIONS\fR\.\.\.] \fIvm_id|vm_name\fR\.\.\.
+.
+.br
+\fBprlbackup\fR [\fIOPTIONS\fR\.\.\.] \fB\-a\fR|\fB\-\-all\fR
+.
+.br
+\fBprlbackup\fR [\fIOPTIONS\fR\.\.\.] \fB\-a\fR|\fB\-\-all\fR \fB\-e\fR|\fB\-\-exclude\fR \fIvm_id|vm_name\fR\.\.\.
+.
+.SH "DESCRIPTION"
+\fBprlbackup\fR simplifies the backup of one or multiple Virtual Machines (VM) running on Parallels Server by stoping them during backup and deleting old backups on demand\. A working installation of Parallels Server is required\.
+.
+.P
+\fBprlbackup\fR was tested under Parallels Server for Mac 4\.0 (PSfM)\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display a short help\.
+.
+.TP
+\fB\-a\fR, \fB\-\-all\fR
+Backup all virtual machines which are registered in Parallels Server\.
+.
+.TP
+\fB\-e\fR, \fB\-\-exclude\fR
+Backup all but the given virtual machines (only applicable in combination with option \fB\-\-all\fR!)\.
+.
+.TP
+\fB\-f\fR, \fB\-\-full\fR
+Create full backups (by default incremental backups are created)\. Note that the first backup for a VM is always a full backup despide of this option\.
+.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Show commands with an impact on the VMs prior to their execution\.
+.
+.TP
+\fB\-n\fR, \fB\-\-dry\-run\fR
+Don\'t do anything with the VMs, just pretend to\.
+.
+.TP
+\fB\-k\fR \fInumber_of_full_backups\fR, \fB\-\-keep\-only\fR \fInumber_of_full_backups\fR
+Delete the oldest full backup(s) until only \fInumber_of_full_backups\fR exist\. This cleanup action will be executed for each VM right after creating the corresponding backup but only if the backup was successfully created\. Incremental backups are automatically deleted by Parallels Server when their full backup is deleted\.
+.
+.SH "EXAMPLES"
+Display short help:
+.
+.IP "" 4
+.
+.nf
+
+$ prlbackup \-\-help
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Backup VMs by name:
+.
+.IP "" 4
+.
+.nf
+
+$ prlbackup Alpha Bravo Charlie
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Backup a VM by id:
+.
+.IP "" 4
+.
+.nf
+
+$ prlbackup "{97351580\-afd7\-4aff\-9960\-814196b28e37}"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Create full backups of all VMs
+.
+.IP "" 4
+.
+.nf
+
+$ prlbackup \-\-full \-\-all
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Backup all but not the given VMs:
+.
+.IP "" 4
+.
+.nf
+
+$ prlbackup \-\-all \-\-exclude Delta Echo
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Show which commands would have been run when backing up all VMs:
+.
+.IP "" 4
+.
+.nf
+
+$ prlbackup \-\-dry\-run \-\-verbose \-\-all
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Create the weekly full backup for all VMs and delete backups older than four weeks:
+.
+.IP "" 4
+.
+.nf
+
+$ prlbackup \-\-all \-\-keep\-only 5
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+.
+.IP "\(bu" 4
+prlctl(8)
+.
+.IP "\(bu" 4
+prlbackup\'s homepage \fIhttps://github\.com/bjoernalbers/prlbackup\fR
+.
+.IP "" 0
+.
+.SH "COPYRIGHT"
+Copyright (c) 2012 Bjoern Albers (\fIbjoernalbers@googlemail\.com\fR)
+.
+.P
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+.
+.P
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software\.
+.
+.P
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\.

data/man/prlbackup.1.html

@@ -0,0 +1,195 @@
+<!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>prlbackup(1) - an awesome backup tool for Parallels Server Virtual Machines</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>
+  <style type='text/css' media='all'>
+  /* style: toc */
+  .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
+  .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
+  .man-navigation a:hover {color:#111;text-decoration:underline}
+  </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="#EXAMPLES">EXAMPLES</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+    <a href="#COPYRIGHT">COPYRIGHT</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>prlbackup(1)</li>
+    <li class='tc'>PRLBACKUP MANUAL</li>
+    <li class='tr'>prlbackup(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>prlbackup</code> - <span class="man-whatis">an awesome backup tool for Parallels Server Virtual Machines</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>prlbackup</code> <code>-h</code>|<code>--help</code><br />
+<code>prlbackup</code> [<var>OPTIONS</var>...] <var>vm_id|vm_name</var>...<br />
+<code>prlbackup</code> [<var>OPTIONS</var>...] <code>-a</code>|<code>--all</code><br />
+<code>prlbackup</code> [<var>OPTIONS</var>...] <code>-a</code>|<code>--all</code> <code>-e</code>|<code>--exclude</code> <var>vm_id|vm_name</var>...</p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p><code>prlbackup</code> simplifies the backup of one or multiple Virtual Machines
+(VM) running on Parallels Server by stoping them during backup and
+deleting old backups on demand.  A working installation of Parallels
+Server is required.</p>
+
+<p><code>prlbackup</code> was tested under Parallels Server for Mac 4.0 (PSfM).</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<dl>
+<dt><code>-h</code>, <code>--help</code></dt><dd><p>Display a short help.</p></dd>
+<dt><code>-a</code>, <code>--all</code></dt><dd><p>Backup all virtual machines which are registered in Parallels Server.</p></dd>
+<dt><code>-e</code>, <code>--exclude</code></dt><dd><p>Backup all but the given virtual machines (only applicable in
+combination with option <code>--all</code>!).</p></dd>
+<dt><code>-f</code>, <code>--full</code></dt><dd><p>Create full backups (by default incremental backups are created).
+Note that the first backup for a VM is always a full backup despide
+of this option.</p></dd>
+<dt><code>-v</code>, <code>--verbose</code></dt><dd><p>Show commands with an impact on the VMs prior to their execution.</p></dd>
+<dt><code>-n</code>, <code>--dry-run</code></dt><dd><p>Don't do anything with the VMs, just pretend to.</p></dd>
+<dt><code>-k</code> <var>number_of_full_backups</var>, <code>--keep-only</code> <var>number_of_full_backups</var></dt><dd><p>Delete the oldest full backup(s) until only <var>number_of_full_backups</var> exist.
+This cleanup action will be executed for each VM right after creating the
+corresponding backup but only if the backup was successfully created.
+Incremental backups are automatically deleted by Parallels Server when their
+full backup is deleted.</p></dd>
+</dl>
+
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<p>Display short help:</p>
+
+<pre><code>$ prlbackup --help
+</code></pre>
+
+<p>Backup VMs by name:</p>
+
+<pre><code>$ prlbackup Alpha Bravo Charlie
+</code></pre>
+
+<p>Backup a VM by id:</p>
+
+<pre><code>$ prlbackup "{97351580-afd7-4aff-9960-814196b28e37}"
+</code></pre>
+
+<p>Create full backups of all VMs</p>
+
+<pre><code>$ prlbackup --full --all
+</code></pre>
+
+<p>Backup all but not the given VMs:</p>
+
+<pre><code>$ prlbackup --all --exclude Delta Echo
+</code></pre>
+
+<p>Show which commands would have been run when backing up all VMs:</p>
+
+<pre><code>$ prlbackup --dry-run --verbose --all
+</code></pre>
+
+<p>Create the weekly full backup for all VMs and delete backups older than four weeks:</p>
+
+<pre><code>$ prlbackup --all --keep-only 5
+</code></pre>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<ul>
+<li><span class="man-ref">prlctl<span class="s">(8)</span></span></li>
+<li><a href="https://github.com/bjoernalbers/prlbackup">prlbackup's homepage</a></li>
+</ul>
+
+
+<h2 id="COPYRIGHT">COPYRIGHT</h2>
+
+<p>Copyright (c) 2012 Bjoern Albers (<a href="&#x6d;&#97;&#x69;&#x6c;&#116;&#111;&#58;&#98;&#x6a;&#111;&#101;&#114;&#110;&#x61;&#x6c;&#x62;&#x65;&#x72;&#115;&#x40;&#x67;&#111;&#111;&#x67;&#108;&#x65;&#109;&#x61;&#x69;&#x6c;&#x2e;&#99;&#111;&#109;" data-bare-link="true">&#98;&#106;&#x6f;&#101;&#114;&#110;&#97;&#108;&#98;&#101;&#114;&#115;&#64;&#x67;&#x6f;&#111;&#103;&#108;&#x65;&#109;&#x61;&#x69;&#x6c;&#x2e;&#x63;&#111;&#x6d;</a>)</p>
+
+<p>Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:</p>
+
+<p>The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.</p>
+
+<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>May 2012</li>
+    <li class='tr'>prlbackup(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>

data/man/prlbackup.1.ronn

@@ -0,0 +1,107 @@
+prlbackup(1) -- an awesome backup tool for Parallels Server Virtual Machines
+============================================================================
+
+## SYNOPSIS
+
+`prlbackup` `-h`|`--help`<br>
+`prlbackup` [<OPTIONS>...] <vm_id|vm_name>...<br>
+`prlbackup` [<OPTIONS>...] `-a`|`--all`<br>
+`prlbackup` [<OPTIONS>...] `-a`|`--all` `-e`|`--exclude` <vm_id|vm_name>...
+
+## DESCRIPTION
+
+`prlbackup` simplifies the backup of one or multiple Virtual Machines
+(VM) running on Parallels Server by stoping them during backup and
+deleting old backups on demand.  A working installation of Parallels
+Server is required.
+
+`prlbackup` was tested under Parallels Server for Mac 4.0 (PSfM).
+
+## OPTIONS
+
+  * `-h`, `--help`:
+    Display a short help.
+
+  * `-a`, `--all`:
+    Backup all virtual machines which are registered in Parallels Server.
+
+  * `-e`, `--exclude`:
+    Backup all but the given virtual machines (only applicable in
+    combination with option `--all`!).
+
+  * `-f`, `--full`:
+    Create full backups (by default incremental backups are created).
+    Note that the first backup for a VM is always a full backup despide
+    of this option.
+
+  * `-v`, `--verbose`:
+    Show commands with an impact on the VMs prior to their execution.
+
+  * `-n`, `--dry-run`:
+    Don't do anything with the VMs, just pretend to.
+
+  * `-k` <number_of_full_backups>, `--keep-only` <number_of_full_backups>:
+    Delete the oldest full backup(s) until only <number_of_full_backups> exist.
+    This cleanup action will be executed for each VM right after creating the
+    corresponding backup but only if the backup was successfully created.
+    Incremental backups are automatically deleted by Parallels Server when their
+    full backup is deleted.
+
+## EXAMPLES
+
+Display short help:
+
+    $ prlbackup --help
+
+Backup VMs by name:
+
+    $ prlbackup Alpha Bravo Charlie
+
+Backup a VM by id:
+
+    $ prlbackup "{97351580-afd7-4aff-9960-814196b28e37}"
+
+Create full backups of all VMs
+
+    $ prlbackup --full --all
+
+Backup all but not the given VMs:
+
+    $ prlbackup --all --exclude Delta Echo
+
+Show which commands would have been run when backing up all VMs:
+
+    $ prlbackup --dry-run --verbose --all
+
+Create the weekly full backup for all VMs and delete backups older than four weeks:
+
+    $ prlbackup --all --keep-only 5
+
+## SEE ALSO
+
+  * prlctl(8)
+  * [prlbackup's homepage](https://github.com/bjoernalbers/prlbackup)
+
+## COPYRIGHT
+
+Copyright (c) 2012 Bjoern Albers (<bjoernalbers@googlemail.com>)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+