machinery-tool 1.21.0 → 1.22.0

data/manual/docs/machinery-copy.1.md

@@ -1,30 +1,25 @@
-
 # copy — Copy System Description
 
-## SYNOPSIS
+## Synopsis
 
-`machinery copy`
-    FROM_NAME TO_NAME
+`machinery copy` FROM_NAME TO_NAME
 
 `machinery` help copy
 
-
-## DESCRIPTION
+## Description
 
 The `copy` command copies a stored system description. It creates a new
 description named TO_NAME containing the same content as the description
 FROM_NAME.
 
-
-## ARGUMENTS
+## Arguments
   * `FROM_NAME` (required):
     Name of the source system description.
 
   * `TO_NAME` (required):
     Name of the target system description.
 
-
-## EXAMPLES
+## Examples
 
   * Create a copy of the system description `earth` under the name `moon`:
 

data/manual/docs/machinery-deploy.1.md

@@ -1,7 +1,6 @@
-
 # deploy — Deploy Image to OpenStack Cloud
 
-## SYNOPSIS
+## Synopsis
 
 `machinery deploy` NAME -c CONFIG_FILE | --cloud-config=CONFIG_FILE
    [-i IMAGE_DIR | --image-dir=IMAGE_DIR]
@@ -10,11 +9,10 @@
 
 `machinery` help [deploy]
 
-
-## DESCRIPTION
+## Description
 
 The `deploy` command builds and deploys an image to an OpenStack cloud.
-This command is particularly useful for testing, debugging, or for validation.
+This command is particularly useful for testing, debugging, or validation.
 
 
 > #### NOTE: Set Password for Unattended Work
@@ -30,14 +28,12 @@ This command is particularly useful for testing, debugging, or for validation.
 >
 >   export OS_PASSWORD=YOUR_PASSWORD
 
-
-## ARGUMENTS
+## Arguments
 
   * `NAME` (required):
     Name of the system description.
 
-
-## OPTIONS
+## Options
 
   * `-c CONFIG_FILE`, `--cloud-config=CONFIG_FILE` (required):
     Path to file where the cloud config (openrc.sh) is located.
@@ -53,16 +49,16 @@ This command is particularly useful for testing, debugging, or for validation.
     Allow to make "insecure" HTTPS requests, without checking the SSL
     certificate when uploading to the cloud.
 
-## PREREQUISITES
+## Prerequisites
 
  * The `deploy` command requires the packages `kiwi` for building the image
    and `python-glanceclient` for uploading the image to the cloud.
 
-## SUPPORTED ARCHITECTURES
+## Supported Architectures
 
 Machinery only supports deploying x86_64 images on x86_64 systems.
 
-## EXAMPLES
+## Examples
 
  * Build an image under the system description named `jeos`.
    Deploy it to the OpenStack cloud name `tux-cloud` by using the

data/manual/docs/machinery-export-autoyast.1.md

@@ -1,37 +1,32 @@
-
 # export-autoyast — Export System Description as AutoYasST profile
 
-## SYNOPSIS
+## Synopsis
 
-`machinery export-autoyast` -a | --autoyast-dir NAME
+`machinery export-autoyast` -a | --autoyast-dir=DIRECTORY NAME
    --force
 
 `machinery` help export-autoyast
 
+## Description
 
-## DESCRIPTION
-
-The `export-autoyast` subcommand exports a stored system description as a AutoYaST
+The `export-autoyast` subcommand exports a stored system description as an AutoYaST
 profile.
 
-
-## ARGUMENTS
+## Arguments
 
   * `NAME` (required):
     Name of the system description.
 
-
-## OPTIONS
+## Options
 
   * `-a AUTOYAST_DIR`, `--autoyast-dir=AUTOYAST_DIR` (required):
     Write the AutoYaST profile to a subdirectory at the specified directory. The directory
     will be created if it does not exist yet.
 
   * `--force` (optional):
-    Overwrite existing system description
-
+    Overwrite an existing output directory.
 
-## SYSTEM REGISTRATION
+## System Registration
 
   * To register a SLES 12 system automatically with AutoYaST, it is required to
     edit the generated profile. The following example registers the system with
@@ -47,11 +42,9 @@ profile.
 </suse_register>
 ```
 
-  * More information can be found at the SUSE AutoYaST documentation.
-    https://www.suse.com/documentation/sles-12/singlehtml/book_autoyast/book_autoyast.html
-
+  * More information can be found at the [SUSE AutoYaST documentation](https://www.suse.com/documentation/sles-12/singlehtml/book_autoyast/book_autoyast.html).
 
-## EXAMPLES
+## Examples
 
  * Export the `myhost` system description to `/tmp/myhost-autoyast`:
 

data/manual/docs/machinery-export-html.1.md

@@ -0,0 +1,32 @@
+# export-html — Export System Description as HTML
+
+## Synopsis
+
+`machinery export-html` -d | --html-dir=DIRECTORY NAME
+   --force
+
+`machinery` help export-html
+
+## Description
+
+The `export-html` subcommand exports a stored system description as HTML.
+
+## Arguments
+
+  * `NAME` (required):
+    Name of the system description.
+
+## Options
+
+  * `-d DIRECTORY`, `--html-dir=DIRECTORY` (required):
+    Write the HTML page and assets to this directory. The directory will
+    be created if it does not exist yet.
+
+  * `--force` (optional):
+    Delete the directory if it exists and recreate it.
+
+## Examples
+
+ * Export the `myhost` system description to `/tmp/myhost-html`:
+
+    $ `machinery` export-html --html-dir=/tmp myhost

data/manual/docs/machinery-export-kiwi.1.md

@@ -1,37 +1,32 @@
-
 # export-kiwi — Export System Description as KIWI Image Description
 
-## SYNOPSIS
+## Synopsis
 
-`machinery export-kiwi` -k | --kiwi-dir NAME
+`machinery export-kiwi` -k | --kiwi-dir=DIRECTORY NAME
    --force
 
 `machinery` help export-kiwi
 
-
-## DESCRIPTION
+## Description
 
 The `export-kiwi` subcommand exports a stored system description as a KIWI
 image description.
 
-
-## ARGUMENTS
+## Arguments
 
   * `NAME` (required):
     Name of the system description.
 
-
-## OPTIONS
+## Options
 
   * `-k KIWI_DIR`, `--kiwi-dir=KIWI_DIR` (required):
     Write the KIWI image description to a subdirectory at the specified directory. The directory
     will be created if it does not exist yet.
 
   * `--force` (optional):
-    Overwrite existing system description
-
+    Overwrite an existing output directory.
 
-## EXAMPLES
+## Examples
 
  * Export the `myhost` system description to `/tmp/myhost-kiwi`:
 

data/manual/docs/{machinery-inspect-docker.1.md → machinery-inspect-container.1.md}

@@ -1,7 +1,6 @@
-
 # inspect-container — Inspect Container
 
-## SYNOPSIS
+## Synopsis
 
 `machinery inspect-container` [OPTIONS] IMAGENAME
 
@@ -9,8 +8,7 @@
 
 `machinery` help inspect-container
 
-
-## DESCRIPTION
+## Description
 
 The `inspect-container` command inspects a container image. It creates and starts the container from the provided image before inspection
 and generates a system description from the gathered data. After the inspection the container will be killed and removed again.
@@ -25,27 +23,25 @@ The system data is structured into scopes, controlled by the
 Machinery will always inspect all specified scopes, and skip scopes which
 trigger errors.
 
-
-## ARGUMENTS
+## Arguments
 
   * `IMAGENAME / IMAGEID` (required):
-    The name or id of the image to be inspected. The provided name or id will also be
+    The name or ID of the image to be inspected. The provided name or ID will also be
     used as the name of the stored system description unless another name is
     provided with the `--name` option.
 
-
-## OPTIONS
+## Options
 
   * `-n NAME`, `--name=NAME` (optional):
     Store the system description under the specified name.
 
   * `-s SCOPE`, `--scope=SCOPE` (optional):
     Inspect image for specified scope.
-    See the [Scope section](#Scopes) for more information.
+    See the [Scope section](machinery_main_scopes.1/) for more information.
 
   * `-e SCOPE`, `--ignore-scope=IGNORE-SCOPE` (optional):
     Inspect image for all scopes except the specified scope.
-    See the [Scope section](#Scopes) for more information.
+    See the [Scope section](machinery_main_scopes.1/) for more information.
 
   * `-x`, `--extract-files` (optional):
     Extract changed configuration and unmanaged files from the inspected container.
@@ -79,10 +75,9 @@ trigger errors.
   * `--verbose` (optional):
     Display the filters which are used during inspection.
 
+## Prerequisites
 
-## PREREQUISITES
-
-  * Inspecting a container requires an image specified by the name or id.
+  * Inspecting a container requires an image specified by the name or ID.
 
   * The image to be inspected needs to have the following commands:
 
@@ -93,7 +88,7 @@ trigger errors.
     * `sed`
     * `find`
 
-## EXAMPLES
+## Examples
 
   * Inspect Docker container `myimage` and save system description under name 'MyContainer':
 

data/manual/docs/machinery-inspect.1.md

@@ -1,14 +1,12 @@
-
 # inspect — Inspect Running System
 
-## SYNOPSIS
+## Synopsis
 
 `machinery inspect` [OPTIONS] HOSTNAME
 
 `machinery` help inspect
 
-
-## DESCRIPTION
+## Description
 
 The `inspect` command inspects a running system and generates a system
 description from the gathered data.
@@ -23,32 +21,30 @@ trigger errors.
 **Note**:
 Tasks on Debian-like systems are treated as patterns.
 
-
-## ARGUMENTS
+## Arguments
 
   * `HOSTNAME` (required):
     The host name of the system to be inspected. The host name will also be
     used as the name of the stored system description unless another name is
     provided with the `--name` option.
 
-
-## OPTIONS
+## Options
 
   * `-n NAME`, `--name=NAME` (optional):
     Store the system description under the specified name.
 
   * `-s SCOPE`, `--scope=SCOPE` (optional):
     Inspect system for specified scope.
-    See the [Scope section](machinery_main_scopes.1/index.html) for more information.
+    See the [Scope section](machinery_main_scopes.1/) for more information.
 
   * `-e SCOPE`, `--ignore-scope=IGNORE-SCOPE` (optional):
     Inspect system for all scopes except the specified scope.
-    See the [Scope section](machinery_main_scopes.1/index.html) for more information.
+    See the [Scope section](machinery_main_scopes.1/) for more information.
 
   * `-r USER`, `--remote-user=USER` (optional):
     Defines the user which is used to access the inspected system via SSH.
     This user needs to be allowed to run certain commands using sudo (see
-    PREREQUISITES for more information).
+    Prerequisites for more information).
     To change the default-user use `machinery config remote-user=USER`
 
   * `-p SSH-PORT`, `--ssh-port SSH-PORT` (optional):
@@ -91,15 +87,14 @@ Tasks on Debian-like systems are treated as patterns.
   * `--verbose` (optional):
     Display the filters which are used during inspection.
 
-
-## PREREQUISITES
+## Prerequisites
 
   * Inspecting a local system requires running `machinery` as root.
 
   * Inspecting a remote system requires passwordless SSH login as root on the
     inspected system.
     Use `ssh-agent` or asymmetric keys (you can transfer the current SSH key
-    via `ssh-copy-id` to the inspected host, e.g.: `ssh-copy-id root@HOSTNAME`)
+    via `ssh-copy-id` to the inspected host, e.g.: `ssh-copy-id root@HOSTNAME`).
 
   * The system to be inspected needs to have the following commands:
 
@@ -126,7 +121,7 @@ Tasks on Debian-like systems are treated as patterns.
 
     \# `passwd` machinery
 
-## EXAMPLES
+## Examples
 
   * Inspect remote system `myhost` and save system description under name
     'MySystem':

data/manual/docs/machinery-list.1.md

@@ -1,22 +1,19 @@
-
 # list — List System Descriptions
 
-## SYNOPSIS
+## Synopsis
 
 `machinery list` [OPTIONS] [NAME[,NAME2[,NAME3]]]
 
 `machinery` help list
 
-
-## DESCRIPTION
+## Description
 
 List the specified system descriptions if parameter name is given.
 List all available system descriptions in the internal database if no name parameter is given.
 The list is sorted alphabetically and contains a name and the
 scopes for each system.
 
-
-## OPTIONS
+## Options
 
   * `--verbose` (optional):
     Print additional information about the origin of scopes.
@@ -27,8 +24,7 @@ scopes for each system.
     Run a web server and open the list of system descriptions in HTML format in
     your web browser using the `xdg-open` command.
 
-
-## EXAMPLES
+## Examples
 
   * Lists the two specified system descriptions `a` and `b`:
 

data/manual/docs/machinery-man.1.md

@@ -1,16 +1,14 @@
-
 # man — Shows Man Page
 
-## SYNOPSIS
+## Synopsis
 
   `machinery man` [OPTIONS]
 
-## OPTIONS
+## Options
 
   * `--html` (optional):
-    Run a web server and open the documentation in HTML format in your web browser using the
-    `xdg-open` command.
+    Run a web server and open the documentation in HTML format in your web browser.
 
-## DESCRIPTION
+## Description
 
 The `man` command shows the Machinery man page.