man/generated/machinery.1.html in machinery-tool-1.9.1 vs man/generated/machinery.1.html in machinery-tool-1.10.0
- old
+ new
@@ -63,14 +63,15 @@
<a href="#config-Configure-Machinery">config — Configure Machinery</a>
<a href="#copy-Copy-System-Description">copy — Copy System Description</a>
<a href="#deploy-Deploy-Image-to-OpenStack-Cloud">deploy — Deploy Image to OpenStack Cloud</a>
<a href="#export-autoyast-Export-System-Description-as-AutoYasST-profile">export-autoyast — Export System Description as AutoYasST profile</a>
<a href="#export-kiwi-Export-System-Description-as-KIWI-Image-Description">export-kiwi — Export System Description as KIWI Image Description</a>
- <a href="#generate-html-Generate-an-HTML-view-of-a-System-Description">generate-html — Generate an HTML view of a System Description</a>
<a href="#inspect-Inspect-Running-System">inspect — Inspect Running System</a>
<a href="#list-List-System-Descriptions">list — List System Descriptions</a>
+ <a href="#man-Shows-Man-Page">man — Shows Man Page</a>
<a href="#remove-Remove-System-Descriptions">remove — Remove System Descriptions</a>
+ <a href="#serve-Serve-A-System-Description-Using-A-Web-Server">serve — Serve A System Description Using A Web Server</a>
<a href="#show-Show-System-Description">show — Show System Description</a>
<a href="#upgrade-format-Upgrade-System-Description">upgrade-format — Upgrade System Description</a>
<a href="#validate-Validate-System-Description">validate — Validate System Description</a>
<a href="#FILES-AND-DEVICES">FILES AND DEVICES</a>
<a href="#ENVIRONMENT">ENVIRONMENT</a>
@@ -775,40 +776,10 @@
<p>$ <code>machinery</code> export-kiwi myhost --kiwi-dir=/tmp</p></dd>
</dl>
-<h2 id="generate-html-Generate-an-HTML-view-of-a-System-Description">generate-html — Generate an HTML view of a System Description</h2>
-
-<h3 id="SYNOPSIS">SYNOPSIS</h3>
-
-<p><code>machinery generate-html</code> NAME</p>
-
-<p><code>machinery</code> help generate-html</p>
-
-<h3 id="DESCRIPTION">DESCRIPTION</h3>
-
-<p>The <code>generate-html</code> generates an HTML view of a system description. The
-index.html file can be found in the according system description directory, e.g.
-~/.machinery/NAME/index.html.</p>
-
-<h3 id="ARGUMENTS">ARGUMENTS</h3>
-
-<dl>
-<dt><code>NAME</code> (required)</dt><dd>Name of the system description.</dd>
-</dl>
-
-
-<h3 id="EXAMPLES">EXAMPLES</h3>
-
-<dl>
-<dt>Create an HTML view of the <code>moon</code> system description:</dt><dd><p></p>
-
-<p>$ <code>machinery</code> generate-html moon</p></dd>
-</dl>
-
-
<h2 id="inspect-Inspect-Running-System">inspect — Inspect Running System</h2>
<h3 id="SYNOPSIS">SYNOPSIS</h3>
<p><code>machinery inspect</code> <a href="#OPTIONS" title="OPTIONS" data-bare-link="true">OPTIONS</a> HOSTNAME</p>
@@ -956,10 +927,20 @@
<p>$ <code>machinery</code> list --short</p></dd>
</dl>
+<h2 id="man-Shows-Man-Page">man — Shows Man Page</h2>
+
+<h3 id="SYNOPSIS">SYNOPSIS</h3>
+
+<p> <code>machinery man</code></p>
+
+<h3 id="DESCRIPTION">DESCRIPTION</h3>
+
+<p>The <code>man</code> command shows the Machinery man page.</p>
+
<h2 id="remove-Remove-System-Descriptions">remove — Remove System Descriptions</h2>
<h3 id="SYNOPSIS">SYNOPSIS</h3>
<p><code>machinery remove</code> [--all]
@@ -999,15 +980,57 @@
<p>$ <code>machinery</code> remove --all</p></dd>
</dl>
+<h2 id="serve-Serve-A-System-Description-Using-A-Web-Server">serve — Serve A System Description Using A Web Server</h2>
+
+<h3 id="SYNOPSIS">SYNOPSIS</h3>
+
+<p><code>machinery serve</code> [-p PORT | --port=PORT] [-i IP | --ip=IP] NAME</p>
+
+<p><code>machinery</code> help serve</p>
+
+<h3 id="DESCRIPTION">DESCRIPTION</h3>
+
+<p>The <code>serve</code> command spawns a web server and serves a stored system description on
+it.
+By default the description is available from http://127.0.0.1:7585 but both the
+IP address and the port can be configured using the according options.</p>
+
+<h3 id="ARGUMENTS">ARGUMENTS</h3>
+
+<dl>
+<dt><code>NAME</code> (required)</dt><dd>Use specified system description.</dd>
+</dl>
+
+
+<h3 id="OPTIONS">OPTIONS</h3>
+
+<dl>
+<dt><code>-p PORT</code>, <code>--port=PORT</code> (optional)</dt><dd><p>Specify the port on which the web server will serve the system description: Default: 7585</p></dd>
+<dt><code>-i IP</code>, <code>--ip=IP</code> (optional)</dt><dd><p>Specify the IP address on which the web server will be made available. Default: 127.0.0.1</p></dd>
+</dl>
+
+
+<h3 id="EXAMPLES">EXAMPLES</h3>
+
+<dl>
+<dt>Serve the system description taken from the last inspection, saved as <code>earth</code>:</dt><dd><p></p>
+
+<p>$ <code>machinery</code> serve earth</p></dd>
+<dt>Make the system description available to other machines on the network:</dt><dd><p></p>
+
+<p>$ <code>machinery</code> serve earth -i 10.10.100.123 -p 3000</p></dd>
+</dl>
+
+
<h2 id="show-Show-System-Description">show — Show System Description</h2>
<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery show</code> [-s SCOPE | --scope=SCOPE] [-e EXCLUDE-SCOPE | --exclude-scope=EXCLUDE-SCOPE] [--no-pager] [--show-diffs] [--html] NAME</p>
+<p><code>machinery show</code> [-s SCOPE | --scope=SCOPE] [-e EXCLUDE-SCOPE | --exclude-scope=EXCLUDE-SCOPE] [--no-pager] [--show-diffs] [--html] [-p PORT | --port=PORT] [-i IP | --ip=IP] NAME</p>
<p><code>machinery</code> help show</p>
<h3 id="DESCRIPTION">DESCRIPTION</h3>
@@ -1033,11 +1056,14 @@
<dt><code>-e EXCLUDE-SCOPE</code>, <code>--exclude-scope=EXCLUDE-SCOPE</code> (optional)</dt><dd><p>Skip output of the specified scope.
See the <a href="#Scopes" data-bare-link="true">Scope section</a> for more information.</p></dd>
<dt><code>--no-pager</code> (optional)</dt><dd><p>Do not pipe output into a pager.</p></dd>
<dt><code>--show-diffs</code> (optional)</dt><dd><p>Include the generated diffs in the output if available (see <code>machinery help analyze</code>
for more information).</p></dd>
-<dt><code>--html</code> (optional)</dt><dd><p>Open the system description in HTML format in your web browser using the <code>xdg-open</code> command.</p></dd>
+<dt><code>--html</code> (optional)</dt><dd><p>Run a web server and open the system description in HTML format in your web browser using the
+<code>xdg-open</code> command.</p></dd>
+<dt><code>-p PORT</code>, <code>--port=PORT</code> (optional)</dt><dd><p>Specify the port on which the web server will serve the system description: Default: 7585</p></dd>
+<dt><code>-i IP</code>, <code>--ip=IP</code> (optional)</dt><dd><p>Specify the IP address on which the web server will be made available. Default: 127.0.0.1</p></dd>
<dt><code>--verbose</code> (optional)</dt><dd><p>Display the filters which were applied before showing the system description.</p></dd>
</dl>
<h3 id="EXAMPLES">EXAMPLES</h3>
@@ -1170,10 +1196,10 @@
<p>Copyright (c) 2013-2015 <a href="http://www.suse.com">SUSE LLC</a></p>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
- <li class='tc'>June 2015</li>
+ <li class='tc'>July 2015</li>
<li class='tr'>machinery(1)</li>
</ol>
</div>
</body>