machinery-tool 1.24.0 → 1.24.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (109) hide show
  1. checksums.yaml +4 -4
  2. data/.git_revision +1 -1
  3. data/NEWS +4 -0
  4. data/lib/man_task.rb +1 -1
  5. data/lib/version.rb +1 -1
  6. data/machinery-helper/version.go +1 -1
  7. data/man/generated/machinery.1.gz +0 -0
  8. data/manual/{docs/README.md → README.md} +0 -0
  9. data/manual/custom_theme/{base.html → main.html} +5 -5
  10. data/manual/docs/css/custom.css +17 -1
  11. data/manual/docs/{docs.md → docs/index.md} +1 -1
  12. data/manual/docs/{machinery-analyze.1.md → docs/machinery-analyze.1.md} +0 -0
  13. data/manual/docs/{machinery-build.1.md → docs/machinery-build.1.md} +0 -0
  14. data/manual/docs/{machinery-compare.1.md → docs/machinery-compare.1.md} +0 -0
  15. data/manual/docs/{machinery-config.1.md → docs/machinery-config.1.md} +0 -0
  16. data/manual/docs/{machinery-copy.1.md → docs/machinery-copy.1.md} +0 -0
  17. data/manual/docs/{machinery-deploy.1.md → docs/machinery-deploy.1.md} +0 -0
  18. data/manual/docs/{machinery-export-autoyast.1.md → docs/machinery-export-autoyast.1.md} +0 -0
  19. data/manual/docs/{machinery-export-html.1.md → docs/machinery-export-html.1.md} +0 -0
  20. data/manual/docs/{machinery-export-kiwi.1.md → docs/machinery-export-kiwi.1.md} +0 -0
  21. data/manual/docs/{machinery-inspect-container.1.md → docs/machinery-inspect-container.1.md} +2 -2
  22. data/manual/docs/{machinery-inspect.1.md → docs/machinery-inspect.1.md} +2 -2
  23. data/manual/docs/{machinery-list.1.md → docs/machinery-list.1.md} +0 -0
  24. data/manual/docs/{machinery-man.1.md → docs/machinery-man.1.md} +0 -0
  25. data/manual/docs/{machinery-move.1.md → docs/machinery-move.1.md} +0 -0
  26. data/manual/docs/{machinery-remove.1.md → docs/machinery-remove.1.md} +0 -0
  27. data/manual/docs/{machinery-serve.1.md → docs/machinery-serve.1.md} +0 -0
  28. data/manual/docs/{machinery-show.1.md → docs/machinery-show.1.md} +2 -2
  29. data/manual/docs/{machinery-upgrade-format.1.md → docs/machinery-upgrade-format.1.md} +0 -0
  30. data/manual/docs/{machinery-validate.1.md → docs/machinery-validate.1.md} +0 -0
  31. data/manual/docs/{machinery_main_general.1.md → docs/machinery_main_general.1.md} +1 -1
  32. data/manual/docs/{machinery_main_scopes.1.md → docs/machinery_main_scopes.1.md} +0 -0
  33. data/manual/docs/{machinery_main_security_implications.1.md → docs/machinery_main_security_implications.1.md} +3 -3
  34. data/manual/docs/{machinery_main_usecases.1.md → docs/machinery_main_usecases.1.md} +0 -0
  35. data/manual/mkdocs.yml +40 -26
  36. data/manual/site/css/custom.css +17 -1
  37. data/manual/site/docs/index.html +49 -4
  38. data/manual/site/docs/machinery-analyze.1/index.html +174 -0
  39. data/manual/site/docs/machinery-build.1/index.html +205 -0
  40. data/manual/site/docs/machinery-compare.1/index.html +207 -0
  41. data/manual/site/docs/machinery-config.1/index.html +182 -0
  42. data/manual/site/{machinery-analyze.1 → docs/machinery-copy.1}/index.html +55 -30
  43. data/manual/site/docs/machinery-deploy.1/index.html +207 -0
  44. data/manual/site/docs/machinery-export-autoyast.1/index.html +194 -0
  45. data/manual/site/docs/machinery-export-html.1/index.html +175 -0
  46. data/manual/site/docs/machinery-export-kiwi.1/index.html +176 -0
  47. data/manual/site/docs/machinery-inspect-container.1/index.html +249 -0
  48. data/manual/site/docs/machinery-inspect.1/index.html +292 -0
  49. data/manual/site/docs/machinery-list.1/index.html +187 -0
  50. data/manual/site/{machinery-config.1 → docs/machinery-man.1}/index.html +39 -30
  51. data/manual/site/{machinery-compare.1 → docs/machinery-move.1}/index.html +54 -30
  52. data/manual/site/docs/machinery-remove.1/index.html +182 -0
  53. data/manual/site/docs/machinery-serve.1/index.html +181 -0
  54. data/manual/site/docs/machinery-show.1/index.html +206 -0
  55. data/manual/site/docs/machinery-upgrade-format.1/index.html +180 -0
  56. data/manual/site/docs/machinery-validate.1/index.html +168 -0
  57. data/manual/site/docs/machinery_main_general.1/index.html +253 -0
  58. data/manual/site/docs/machinery_main_scopes.1/index.html +249 -0
  59. data/manual/site/docs/machinery_main_security_implications.1/index.html +228 -0
  60. data/manual/site/{machinery_main_usecases.1 → docs/machinery_main_usecases.1}/index.html +47 -28
  61. data/manual/site/index.html +390 -135
  62. data/manual/site/search/search_index.json +1 -1
  63. data/manual/site/sitemap.xml +24 -24
  64. data/manual/site/sitemap.xml.gz +0 -0
  65. metadata +51 -76
  66. data/manual/docs/custom.css +0 -804
  67. data/manual/docs/hand3.png +0 -0
  68. data/manual/docs/wheels.png +0 -0
  69. data/manual/site/404.html +0 -145
  70. data/manual/site/css/base.css +0 -324
  71. data/manual/site/css/bootstrap-custom.min.css +0 -1
  72. data/manual/site/css/font-awesome.min.css +0 -4
  73. data/manual/site/custom.css +0 -804
  74. data/manual/site/fonts/fontawesome-webfont.eot +0 -0
  75. data/manual/site/fonts/fontawesome-webfont.svg +0 -2671
  76. data/manual/site/fonts/fontawesome-webfont.ttf +0 -0
  77. data/manual/site/fonts/fontawesome-webfont.woff +0 -0
  78. data/manual/site/fonts/fontawesome-webfont.woff2 +0 -0
  79. data/manual/site/fonts/glyphicons-halflings-regular.eot +0 -0
  80. data/manual/site/fonts/glyphicons-halflings-regular.svg +0 -288
  81. data/manual/site/fonts/glyphicons-halflings-regular.ttf +0 -0
  82. data/manual/site/fonts/glyphicons-halflings-regular.woff +0 -0
  83. data/manual/site/fonts/glyphicons-halflings-regular.woff2 +0 -0
  84. data/manual/site/hand3.png +0 -0
  85. data/manual/site/img/favicon.ico +0 -0
  86. data/manual/site/img/grid.png +0 -0
  87. data/manual/site/js/base.js +0 -216
  88. data/manual/site/js/bootstrap-3.0.3.min.js +0 -7
  89. data/manual/site/js/jquery-1.10.2.min.js +0 -6
  90. data/manual/site/machinery-build.1/index.html +0 -145
  91. data/manual/site/machinery-copy.1/index.html +0 -145
  92. data/manual/site/machinery-deploy.1/index.html +0 -145
  93. data/manual/site/machinery-export-autoyast.1/index.html +0 -145
  94. data/manual/site/machinery-export-html.1/index.html +0 -145
  95. data/manual/site/machinery-export-kiwi.1/index.html +0 -145
  96. data/manual/site/machinery-inspect-container.1/index.html +0 -145
  97. data/manual/site/machinery-inspect.1/index.html +0 -145
  98. data/manual/site/machinery-list.1/index.html +0 -145
  99. data/manual/site/machinery-man.1/index.html +0 -145
  100. data/manual/site/machinery-move.1/index.html +0 -145
  101. data/manual/site/machinery-remove.1/index.html +0 -145
  102. data/manual/site/machinery-serve.1/index.html +0 -145
  103. data/manual/site/machinery-show.1/index.html +0 -145
  104. data/manual/site/machinery-upgrade-format.1/index.html +0 -145
  105. data/manual/site/machinery-validate.1/index.html +0 -145
  106. data/manual/site/machinery_main_general.1/index.html +0 -145
  107. data/manual/site/machinery_main_scopes.1/index.html +0 -145
  108. data/manual/site/machinery_main_security_implications.1/index.html +0 -145
  109. data/manual/site/wheels.png +0 -0
@@ -0,0 +1,181 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8"/>
5
+ <link href="../../css/custom.css" rel="stylesheet">
6
+ </head>
7
+ <body id="manpage">
8
+ <div id="back">
9
+ <a href="../..">
10
+ <img src="../../img/hand3.png" class="hand3"/>
11
+ <div class="goback">Go back to the web site</div>
12
+ </a>
13
+ </div>
14
+ <div class="mp">
15
+ <div class="nav">
16
+ <ul>
17
+
18
+
19
+ <li class="">
20
+ <a href="../">Welcome</a>
21
+ </li>
22
+
23
+
24
+
25
+
26
+ <li class="">
27
+ <a href="../machinery_main_general.1/">General Overview</a>
28
+ </li>
29
+
30
+
31
+
32
+
33
+ <li class="">
34
+ <a href="../machinery_main_scopes.1/">Scopes</a>
35
+ </li>
36
+
37
+
38
+
39
+
40
+ <li class="">
41
+ <a href="../machinery_main_usecases.1/">Use cases</a>
42
+ </li>
43
+
44
+
45
+
46
+
47
+ <li class="">
48
+ <a href="../machinery_main_security_implications.1/">Security Implications</a>
49
+ </li>
50
+
51
+
52
+
53
+
54
+ <li>Commands
55
+ <ul>
56
+
57
+ <li class="">
58
+ <a href="../machinery-analyze.1/">Analyze</a>
59
+ </li>
60
+
61
+ <li class="">
62
+ <a href="../machinery-build.1/">Build</a>
63
+ </li>
64
+
65
+ <li class="">
66
+ <a href="../machinery-compare.1/">Compare</a>
67
+ </li>
68
+
69
+ <li class="">
70
+ <a href="../machinery-config.1/">Config</a>
71
+ </li>
72
+
73
+ <li class="">
74
+ <a href="../machinery-copy.1/">Copy</a>
75
+ </li>
76
+
77
+ <li class="">
78
+ <a href="../machinery-deploy.1/">Deploy</a>
79
+ </li>
80
+
81
+ <li class="">
82
+ <a href="../machinery-export-autoyast.1/">Export AutoYaST</a>
83
+ </li>
84
+
85
+ <li class="">
86
+ <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
87
+ </li>
88
+
89
+ <li class="">
90
+ <a href="../machinery-export-html.1/">Export HTML</a>
91
+ </li>
92
+
93
+ <li class="">
94
+ <a href="../machinery-inspect.1/">Inspect</a>
95
+ </li>
96
+
97
+ <li class="">
98
+ <a href="../machinery-inspect-container.1/">Inspect Container</a>
99
+ </li>
100
+
101
+ <li class="">
102
+ <a href="../machinery-list.1/">List</a>
103
+ </li>
104
+
105
+ <li class="">
106
+ <a href="../machinery-man.1/">Man</a>
107
+ </li>
108
+
109
+ <li class="">
110
+ <a href="../machinery-move.1/">Move</a>
111
+ </li>
112
+
113
+ <li class="">
114
+ <a href="../machinery-remove.1/">Remove</a>
115
+ </li>
116
+
117
+ <li class="current">
118
+ <a href="./">Serve</a>
119
+ </li>
120
+
121
+ <li class="">
122
+ <a href="../machinery-show.1/">Show</a>
123
+ </li>
124
+
125
+ <li class="">
126
+ <a href="../machinery-upgrade-format.1/">Upgrade Format</a>
127
+ </li>
128
+
129
+ <li class="">
130
+ <a href="../machinery-validate.1/">Validate</a>
131
+ </li>
132
+
133
+ </ul>
134
+ </li>
135
+
136
+
137
+
138
+ </ul>
139
+ </div>
140
+ <div class="content">
141
+ <h1 id="serve-serve-system-descriptions-using-a-web-server">serve — Serve System Descriptions Using a Web Server</h1>
142
+ <h2 id="synopsis">Synopsis</h2>
143
+ <p><code>machinery serve</code> [-p PORT | --port=PORT] [--public]</p>
144
+ <p><code>machinery</code> help serve</p>
145
+ <h2 id="description">Description</h2>
146
+ <p>The <code>serve</code> command spawns a web server to view system descriptions as an HTML
147
+ view.</p>
148
+ <p>By default the server is available from http://127.0.0.1:7585 but both the
149
+ IP address and the port can be configured using the according options.</p>
150
+ <p>Specific descriptions are available from http://127.0.0.1:7585/NAME, where NAME
151
+ is the name of the system description. If no name is specified in the URL an
152
+ overview of all descriptions is served.</p>
153
+ <h2 id="options">Options</h2>
154
+ <ul>
155
+ <li>
156
+ <p><code>-p PORT</code>, <code>--port=PORT</code> (optional):
157
+ Specify the port on which the web server will serve the HTML view: Default: 7585</p>
158
+ <p>Ports can be selected in a range between 2-65535. Ports between 2 and 1023 can only be
159
+ chosen when <code>machinery</code> will be executed as <code>root</code> user.</p>
160
+ </li>
161
+ <li>
162
+ <p><code>--public</code> (optional):
163
+ Specifying this option, lets the server listen on each configured IP address. By default
164
+ the server will only listen on the localhost IP address 127.0.0.1</p>
165
+ </li>
166
+ </ul>
167
+ <h2 id="examples">Examples</h2>
168
+ <ul>
169
+ <li>
170
+ <p>Start the server with default options:</p>
171
+ <p>$ <code>machinery</code> serve</p>
172
+ </li>
173
+ <li>
174
+ <p>Make the server available to other machines on the network on port 3000:</p>
175
+ <p>$ <code>machinery</code> serve --public --port 3000</p>
176
+ </li>
177
+ </ul>
178
+ </div>
179
+ </div>
180
+ </body>
181
+ </html>
@@ -0,0 +1,206 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8"/>
5
+ <link href="../../css/custom.css" rel="stylesheet">
6
+ </head>
7
+ <body id="manpage">
8
+ <div id="back">
9
+ <a href="../..">
10
+ <img src="../../img/hand3.png" class="hand3"/>
11
+ <div class="goback">Go back to the web site</div>
12
+ </a>
13
+ </div>
14
+ <div class="mp">
15
+ <div class="nav">
16
+ <ul>
17
+
18
+
19
+ <li class="">
20
+ <a href="../">Welcome</a>
21
+ </li>
22
+
23
+
24
+
25
+
26
+ <li class="">
27
+ <a href="../machinery_main_general.1/">General Overview</a>
28
+ </li>
29
+
30
+
31
+
32
+
33
+ <li class="">
34
+ <a href="../machinery_main_scopes.1/">Scopes</a>
35
+ </li>
36
+
37
+
38
+
39
+
40
+ <li class="">
41
+ <a href="../machinery_main_usecases.1/">Use cases</a>
42
+ </li>
43
+
44
+
45
+
46
+
47
+ <li class="">
48
+ <a href="../machinery_main_security_implications.1/">Security Implications</a>
49
+ </li>
50
+
51
+
52
+
53
+
54
+ <li>Commands
55
+ <ul>
56
+
57
+ <li class="">
58
+ <a href="../machinery-analyze.1/">Analyze</a>
59
+ </li>
60
+
61
+ <li class="">
62
+ <a href="../machinery-build.1/">Build</a>
63
+ </li>
64
+
65
+ <li class="">
66
+ <a href="../machinery-compare.1/">Compare</a>
67
+ </li>
68
+
69
+ <li class="">
70
+ <a href="../machinery-config.1/">Config</a>
71
+ </li>
72
+
73
+ <li class="">
74
+ <a href="../machinery-copy.1/">Copy</a>
75
+ </li>
76
+
77
+ <li class="">
78
+ <a href="../machinery-deploy.1/">Deploy</a>
79
+ </li>
80
+
81
+ <li class="">
82
+ <a href="../machinery-export-autoyast.1/">Export AutoYaST</a>
83
+ </li>
84
+
85
+ <li class="">
86
+ <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
87
+ </li>
88
+
89
+ <li class="">
90
+ <a href="../machinery-export-html.1/">Export HTML</a>
91
+ </li>
92
+
93
+ <li class="">
94
+ <a href="../machinery-inspect.1/">Inspect</a>
95
+ </li>
96
+
97
+ <li class="">
98
+ <a href="../machinery-inspect-container.1/">Inspect Container</a>
99
+ </li>
100
+
101
+ <li class="">
102
+ <a href="../machinery-list.1/">List</a>
103
+ </li>
104
+
105
+ <li class="">
106
+ <a href="../machinery-man.1/">Man</a>
107
+ </li>
108
+
109
+ <li class="">
110
+ <a href="../machinery-move.1/">Move</a>
111
+ </li>
112
+
113
+ <li class="">
114
+ <a href="../machinery-remove.1/">Remove</a>
115
+ </li>
116
+
117
+ <li class="">
118
+ <a href="../machinery-serve.1/">Serve</a>
119
+ </li>
120
+
121
+ <li class="current">
122
+ <a href="./">Show</a>
123
+ </li>
124
+
125
+ <li class="">
126
+ <a href="../machinery-upgrade-format.1/">Upgrade Format</a>
127
+ </li>
128
+
129
+ <li class="">
130
+ <a href="../machinery-validate.1/">Validate</a>
131
+ </li>
132
+
133
+ </ul>
134
+ </li>
135
+
136
+
137
+
138
+ </ul>
139
+ </div>
140
+ <div class="content">
141
+ <h1 id="show-show-system-description">show — Show System Description</h1>
142
+ <h2 id="synopsis">Synopsis</h2>
143
+ <p><code>machinery show</code> [-s SCOPE | --scope=SCOPE] [-e IGNORE-SCOPE | --ignore-scope=IGNORE-SCOPE] [--no-pager] [--show-diffs] [--html] NAME</p>
144
+ <p><code>machinery</code> help show</p>
145
+ <h2 id="description">Description</h2>
146
+ <p>The <code>show</code> command displays a stored system description.
147
+ Scopes are supported and limit the output to the given scope.
148
+ The hostname of the inspected system and the last modification
149
+ in local time are shown in the title of each scope section.</p>
150
+ <h2 id="arguments">Arguments</h2>
151
+ <ul>
152
+ <li><code>NAME</code> (required):
153
+ Use specified system description.</li>
154
+ </ul>
155
+ <h2 id="options">Options</h2>
156
+ <ul>
157
+ <li>
158
+ <p><code>-s SCOPE</code>, <code>--scope=SCOPE</code> (optional):
159
+ Limit output to the specified scope.
160
+ See the <a href="../machinery_main_scopes.1/">Scope section</a> for more information.
161
+ If displaying information related to a scope fails, <code>show</code> will print an error message what has failed.
162
+ In case of an error, no content is displayed.</p>
163
+ </li>
164
+ <li>
165
+ <p><code>-e IGNORE-SCOPE</code>, <code>--ignore-scope=IGNORE-SCOPE</code> (optional):
166
+ Skip output of the specified scope.
167
+ See the <a href="../machinery_main_scopes.1/">Scope section</a> for more information.</p>
168
+ </li>
169
+ <li>
170
+ <p><code>--no-pager</code> (optional):
171
+ Do not pipe output into a pager.</p>
172
+ </li>
173
+ <li>
174
+ <p><code>--show-diffs</code> (optional):
175
+ Include the generated diffs in the output if available (see <code>machinery help analyze</code>
176
+ for more information).</p>
177
+ </li>
178
+ <li>
179
+ <p><code>--html</code> (optional):
180
+ Run a web server and open the system description in HTML format in your web browser using the
181
+ <code>xdg-open</code> command.</p>
182
+ </li>
183
+ <li>
184
+ <p><code>--verbose</code> (optional):
185
+ Display the filters which were applied before showing the system description.</p>
186
+ </li>
187
+ </ul>
188
+ <h2 id="examples">Examples</h2>
189
+ <ul>
190
+ <li>
191
+ <p>Show the system description taken from the last inspection, saved as <code>earth</code>:</p>
192
+ <p>$ <code>machinery</code> show earth</p>
193
+ </li>
194
+ <li>
195
+ <p>Show the system description, but limit the scope to repositories only:</p>
196
+ <p>$ <code>machinery</code> show earth -s repositories</p>
197
+ </li>
198
+ <li>
199
+ <p>Show the list of changed managed files:</p>
200
+ <p>$ <code>machinery</code> show earth --scope=changed-managed-files</p>
201
+ </li>
202
+ </ul>
203
+ </div>
204
+ </div>
205
+ </body>
206
+ </html>
@@ -0,0 +1,180 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8"/>
5
+ <link href="../../css/custom.css" rel="stylesheet">
6
+ </head>
7
+ <body id="manpage">
8
+ <div id="back">
9
+ <a href="../..">
10
+ <img src="../../img/hand3.png" class="hand3"/>
11
+ <div class="goback">Go back to the web site</div>
12
+ </a>
13
+ </div>
14
+ <div class="mp">
15
+ <div class="nav">
16
+ <ul>
17
+
18
+
19
+ <li class="">
20
+ <a href="../">Welcome</a>
21
+ </li>
22
+
23
+
24
+
25
+
26
+ <li class="">
27
+ <a href="../machinery_main_general.1/">General Overview</a>
28
+ </li>
29
+
30
+
31
+
32
+
33
+ <li class="">
34
+ <a href="../machinery_main_scopes.1/">Scopes</a>
35
+ </li>
36
+
37
+
38
+
39
+
40
+ <li class="">
41
+ <a href="../machinery_main_usecases.1/">Use cases</a>
42
+ </li>
43
+
44
+
45
+
46
+
47
+ <li class="">
48
+ <a href="../machinery_main_security_implications.1/">Security Implications</a>
49
+ </li>
50
+
51
+
52
+
53
+
54
+ <li>Commands
55
+ <ul>
56
+
57
+ <li class="">
58
+ <a href="../machinery-analyze.1/">Analyze</a>
59
+ </li>
60
+
61
+ <li class="">
62
+ <a href="../machinery-build.1/">Build</a>
63
+ </li>
64
+
65
+ <li class="">
66
+ <a href="../machinery-compare.1/">Compare</a>
67
+ </li>
68
+
69
+ <li class="">
70
+ <a href="../machinery-config.1/">Config</a>
71
+ </li>
72
+
73
+ <li class="">
74
+ <a href="../machinery-copy.1/">Copy</a>
75
+ </li>
76
+
77
+ <li class="">
78
+ <a href="../machinery-deploy.1/">Deploy</a>
79
+ </li>
80
+
81
+ <li class="">
82
+ <a href="../machinery-export-autoyast.1/">Export AutoYaST</a>
83
+ </li>
84
+
85
+ <li class="">
86
+ <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
87
+ </li>
88
+
89
+ <li class="">
90
+ <a href="../machinery-export-html.1/">Export HTML</a>
91
+ </li>
92
+
93
+ <li class="">
94
+ <a href="../machinery-inspect.1/">Inspect</a>
95
+ </li>
96
+
97
+ <li class="">
98
+ <a href="../machinery-inspect-container.1/">Inspect Container</a>
99
+ </li>
100
+
101
+ <li class="">
102
+ <a href="../machinery-list.1/">List</a>
103
+ </li>
104
+
105
+ <li class="">
106
+ <a href="../machinery-man.1/">Man</a>
107
+ </li>
108
+
109
+ <li class="">
110
+ <a href="../machinery-move.1/">Move</a>
111
+ </li>
112
+
113
+ <li class="">
114
+ <a href="../machinery-remove.1/">Remove</a>
115
+ </li>
116
+
117
+ <li class="">
118
+ <a href="../machinery-serve.1/">Serve</a>
119
+ </li>
120
+
121
+ <li class="">
122
+ <a href="../machinery-show.1/">Show</a>
123
+ </li>
124
+
125
+ <li class="current">
126
+ <a href="./">Upgrade Format</a>
127
+ </li>
128
+
129
+ <li class="">
130
+ <a href="../machinery-validate.1/">Validate</a>
131
+ </li>
132
+
133
+ </ul>
134
+ </li>
135
+
136
+
137
+
138
+ </ul>
139
+ </div>
140
+ <div class="content">
141
+ <h1 id="upgrade-format-upgrade-system-description">upgrade-format — Upgrade System Description</h1>
142
+ <h2 id="synopsis">Synopsis</h2>
143
+ <p><code>machinery upgrade-format</code> --all</p>
144
+ <p><code>machinery upgrade-format</code> NAME</p>
145
+ <p><code>machinery</code> help upgrade-format</p>
146
+ <h2 id="description">Description</h2>
147
+ <p>The <code>upgrade-format</code> command upgrades a system description to the latest format
148
+ version.</p>
149
+ <p>The <code>format</code> in this context is the structure of the internal system description
150
+ data. If the format version of a system description does not match the current
151
+ <code>machinery</code> format version, <code>machinery</code> is no longer able to work with the data
152
+ until it is upgraded. The current format version can be retrieved using
153
+ <code>machinery --version</code>. The format version of a system description can be found
154
+ in the <code>meta</code> section of the according <code>manifest.json</code> file.</p>
155
+ <p>If the <code>--all</code> switch is given all local descriptions will be upgraded.</p>
156
+ <h2 id="options">Options</h2>
157
+ <ul>
158
+ <li><code>--all</code> (optional):
159
+ Upgrade all stored system descriptions.</li>
160
+ </ul>
161
+ <h2 id="arguments">Arguments</h2>
162
+ <ul>
163
+ <li><code>NAME</code> (optional):
164
+ Upgrade specified system description.</li>
165
+ </ul>
166
+ <h2 id="examples">Examples</h2>
167
+ <ul>
168
+ <li>
169
+ <p>Upgrade the system description stored as <code>earth</code>:</p>
170
+ <p>$ <code>machinery</code> upgrade-format earth</p>
171
+ </li>
172
+ <li>
173
+ <p>Upgrade all stored system descriptions:</p>
174
+ <p>$ <code>machinery</code> upgrade-format --all</p>
175
+ </li>
176
+ </ul>
177
+ </div>
178
+ </div>
179
+ </body>
180
+ </html>