man/generated/machinery.1.html in machinery-tool-1.16.2 vs man/generated/machinery.1.html in machinery-tool-1.16.3
- old
+ new
@@ -70,11 +70,11 @@
<a href="#inspect-container-Inspect-Container">inspect-container — Inspect Container</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="#move-Move-System-Description">move — Move System Description</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="#serve-Serve-System-Descriptions-Using-A-Web-Server">serve — Serve System Descriptions 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>
@@ -491,23 +491,20 @@
<h3 id="PREREQUISITES">PREREQUISITES</h3>
<ul>
-<li><p>The <code>build</code> command requires the packages <code>kiwi</code> and <code>kiwi-desc-vmbxoot</code>.</p></li>
+<li><p>The <code>build</code> command requires the packages <code>kiwi</code> and <code>kiwi-desc-vmxboot</code>.</p></li>
+<li><p>The necessary vmxboot template for the machinery being built must be
+installed (i.e. if you want to build an openSUSE Leap machine then the
+template <code>/usr/share/kiwi/image/vmxboot/suse-leap42.1</code> is required)</p></li>
<li><p>All repositories in the system description must be accessible from the
build machine on which <code>machinery build</code> is called.</p></li>
+<li><p>Machinery can only build x86_64 images on x86_64 systems at the moment.</p></li>
</ul>
-<h3 id="BUILD-SUPPORT-MATRIX">BUILD SUPPORT MATRIX</h3>
-
-<p>Machinery only supports building x86_64 images on x86_64 systems.</p>
-
-<p>To see the list of supported combinations of build hosts and targets run
-<code>machinery build --help</code>.</p>
-
<h3 id="EXAMPLES">EXAMPLES</h3>
<ul>
<li><p>To build an image from the system description named "tux" and to save the
image under the <code>/tmp/tux/</code> directory:</p>
@@ -1038,12 +1035,11 @@
<h2 id="list-List-System-Descriptions">list — List System Descriptions</h2>
<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery list</code>
- [NAME[,NAME2[,NAME3]]]</p>
+<p><code>machinery list</code> [OPTIONS] [NAME[,NAME2[,NAME3]]]</p>
<p><code>machinery</code> help list</p>
<h3 id="DESCRIPTION">DESCRIPTION</h3>
@@ -1056,10 +1052,12 @@
<dl>
<dt><code>--verbose</code> (optional)</dt><dd>Print additional information about the origin of scopes.
Currently displays [HOSTNAME] and (DATE).</dd>
<dt><code>--short</code> (optional)</dt><dd>List only descripton names.</dd>
+<dt><code>--html</code> (optional)</dt><dd>Run a web server and open the list of system descriptions in HTML format in
+your web browser using the <code>xdg-open</code> command.</dd>
</dl>
<h3 id="EXAMPLES">EXAMPLES</h3>
@@ -1074,10 +1072,13 @@
<p>$ <code>machinery</code> list --verbose</p></dd>
<dt>Lists all available system description names without any additional details:</dt><dd><p></p>
<p>$ <code>machinery</code> list --short</p></dd>
+<dt>Opens HTML view of list of all available system descriptions in web browser:</dt><dd><p></p>
+
+<p>$ <code>machinery</code> list --html</p></dd>
</dl>
<h2 id="man-Shows-Man-Page">man — Shows Man Page</h2>
@@ -1160,36 +1161,34 @@
<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>
+<h2 id="serve-Serve-System-Descriptions-Using-A-Web-Server">serve — Serve System Descriptions Using A Web Server</h2>
<h3 id="SYNOPSIS">SYNOPSIS</h3>
-<p><code>machinery serve</code> [-p PORT | --port=PORT] [--public] NAME</p>
+<p><code>machinery serve</code> [-p PORT | --port=PORT] [--public]</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
+<p>The <code>serve</code> command spawns a web server to view system descriptions as an HTML
+view.</p>
+
+<p>By default the server 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>
+<p>Specific descriptions are available from http://127.0.0.1:7585/NAME, where NAME
+is the name of the system description. If no name is specified in the URL an
+overview of all descriptions is served.</p>
-<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>
+<dt><code>-p PORT</code>, <code>--port=PORT</code> (optional)</dt><dd><p>Specify the port on which the web server will serve the HTML view: Default: 7585</p>
<p>Ports can be selected in a range between 2-65535. Ports between 2 and 1023 can only be
chosen when <code>machinery</code> will be executed as <code>root</code> user.</p></dd>
<dt><code>--public</code> (optional)</dt><dd><p>Specifying this option, lets the server listen on each configured IP address. By default
the server will only listen on the localhost IP address 127.0.0.1</p></dd>
@@ -1197,16 +1196,16 @@
<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>
+<dt>Start the server with default options:</dt><dd><p></p>
-<p>$ <code>machinery</code> serve earth</p></dd>
-<dt>Make the system description available to other machines on the network on port 3000:</dt><dd><p></p>
+<p>$ <code>machinery</code> serve</p></dd>
+<dt>Make the server available to other machines on the network on port 3000:</dt><dd><p></p>
-<p>$ <code>machinery</code> serve earth --public --port 3000</p></dd>
+<p>$ <code>machinery</code> serve --public --port 3000</p></dd>
</dl>
<h2 id="show-Show-System-Description">show — Show System Description</h2>
@@ -1378,10 +1377,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'>November 2015</li>
+ <li class='tc'>January 2016</li>
<li class='tr'>machinery(1)</li>
</ol>
</div>
</body>