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,205 @@
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="current">
62
+ <a href="./">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="">
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="build-build-image-from-system-description">build — Build Image from System Description</h1>
142
+ <h2 id="synopsis">Synopsis</h2>
143
+ <p><code>machinery build</code> NAME -i IMAGE-DIR | --image-dir=IMAGE-DIR</p>
144
+ <p><code>machinery</code> help build</p>
145
+ <h2 id="description">Description</h2>
146
+ <p>The <code>build</code> command builds an image from a system description. The image is a
147
+ system image in the qcow2 format, which can be used with the KVM hypervisor.
148
+ It can be run locally or deployed to a cloud environment.</p>
149
+ <p><code>machinery</code> uses the image building command line tool
150
+ <a href="http://opensuse.github.io/kiwi/">KIWI</a> to perform the actual build. KIWI
151
+ data is stored to a temporary directory and cleaned up after the build. The KIWI
152
+ log is shown as output of the <code>build</code> command format for showing progress and
153
+ diagnosing errors.</p>
154
+ <p>When building an image, Machinery filters out some files which would break the
155
+ built image. The list of filters is shown at the beginning of the build.</p>
156
+ <h2 id="arguments">Arguments</h2>
157
+ <ul>
158
+ <li><code>NAME</code> (required):
159
+ Use specified system description.</li>
160
+ </ul>
161
+ <h2 id="options">Options</h2>
162
+ <ul>
163
+ <li>
164
+ <p><code>-i IMAGE-DIR</code>, <code>--image-dir=IMAGE-DIR</code> (required):
165
+ Save image file under specified path.</p>
166
+ </li>
167
+ <li>
168
+ <p><code>-d</code>, <code>--enable-dhcp</code> (optional):
169
+ Enable DHCP client on first network card of built image</p>
170
+ </li>
171
+ <li>
172
+ <p><code>-s</code>, <code>--enable-ssh</code> (optional):
173
+ Enable SSH service in built image</p>
174
+ </li>
175
+ </ul>
176
+ <h2 id="prerequisites">Prerequisites</h2>
177
+ <ul>
178
+ <li>
179
+ <p>The <code>build</code> command requires the packages <code>kiwi</code> and <code>kiwi-desc-vmxboot</code>.</p>
180
+ </li>
181
+ <li>
182
+ <p>The necessary vmxboot template for the machinery being built must be
183
+ installed (i.e. if you want to build an openSUSE Leap machine then the
184
+ template <code>/usr/share/kiwi/image/vmxboot/suse-leap42.1</code> is required)</p>
185
+ </li>
186
+ <li>
187
+ <p>All repositories in the system description must be accessible from the
188
+ build machine on which <code>machinery build</code> is called.</p>
189
+ </li>
190
+ <li>
191
+ <p>Machinery can only build x86_64 images on x86_64 systems at the moment.</p>
192
+ </li>
193
+ </ul>
194
+ <h2 id="examples">Examples</h2>
195
+ <ul>
196
+ <li>
197
+ <p>To build an image from the system description named "tux" and to save the
198
+ image under the <code>/tmp/tux/</code> directory:</p>
199
+ <p>$ <code>machinery</code> build tux -i /tmp/tux/</p>
200
+ </li>
201
+ </ul>
202
+ </div>
203
+ </div>
204
+ </body>
205
+ </html>
@@ -0,0 +1,207 @@
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="current">
66
+ <a href="./">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="">
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="compare-compare-system-descriptions">compare — Compare System Descriptions</h1>
142
+ <h2 id="synopsis">Synopsis</h2>
143
+ <p><code>machinery compare</code> [-s SCOPE | --scope=SCOPE] [-e IGNORE-SCOPE | --ignore-scope=IGNORE-SCOPE] [--no-pager] [--show-all] [--html] NAME1 NAME2</p>
144
+ <p><code>machinery</code> help compare</p>
145
+ <h2 id="description">Description</h2>
146
+ <p>The <code>compare</code> command compares stored system descriptions. The scope option can
147
+ be used to limit the output to the given scopes.</p>
148
+ <h2 id="arguments">Arguments</h2>
149
+ <ul>
150
+ <li>
151
+ <p><code>NAME1</code> (required):
152
+ First system description to compare.</p>
153
+ </li>
154
+ <li>
155
+ <p><code>NAME2</code> (required):
156
+ Second system description to compare.</p>
157
+ </li>
158
+ </ul>
159
+ <h2 id="options">Options</h2>
160
+ <ul>
161
+ <li>
162
+ <p><code>-s SCOPE</code>, <code>--scope=SCOPE</code> (optional):
163
+ Limit output to the specified scope.
164
+ See the <a href="#Scopes">Scope section</a> for more information.</p>
165
+ </li>
166
+ <li>
167
+ <p><code>-e SCOPE</code>, <code>--ignore-scope=IGNORE-SCOPE</code> (optional):
168
+ Skip output of the specified scope.
169
+ See the <a href="#Scopes">Scope section</a> for more information.</p>
170
+ </li>
171
+ <li>
172
+ <p><code>--no-pager</code> (optional):
173
+ Do not pipe output into a pager.</p>
174
+ </li>
175
+ <li>
176
+ <p><code>--show-all</code> (optional):
177
+ Show also common properties of the descriptions (not only the differences).</p>
178
+ </li>
179
+ <li>
180
+ <p><code>--html</code> (optional):
181
+ Shows the comparison of two system descriptions in the web browser.</p>
182
+ </li>
183
+ </ul>
184
+ <h2 id="examples">Examples</h2>
185
+ <ul>
186
+ <li>
187
+ <p>Compare system descriptions saved as <code>earth</code> and <code>moon</code>:</p>
188
+ <p>$ <code>machinery</code> compare earth moon</p>
189
+ </li>
190
+ <li>
191
+ <p>Compare system descriptions, but limit the scope to repositories only:</p>
192
+ <p>$ <code>machinery</code> compare earth moon -s repositories</p>
193
+ </li>
194
+ <li>
195
+ <p>Compare lists of changed managed files and include the common ones in the
196
+ list:</p>
197
+ <p>$ <code>machinery</code> compare earth moon --scope=changed-managed-files --show-all</p>
198
+ </li>
199
+ <li>
200
+ <p>Compares system descriptions and shows the result in HTML format in your web browser:</p>
201
+ <p>$ <code>machinery</code> compare --html earth moon</p>
202
+ </li>
203
+ </ul>
204
+ </div>
205
+ </div>
206
+ </body>
207
+ </html>
@@ -0,0 +1,182 @@
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="current">
70
+ <a href="./">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="">
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="config-configure-machinery">config — Configure Machinery</h1>
142
+ <h2 id="synopsis">Synopsis</h2>
143
+ <p><code>machinery config</code></p>
144
+ <p><code>machinery config</code> KEY</p>
145
+ <p><code>machinery config</code> KEY=VALUE</p>
146
+ <p><code>machinery</code> help config</p>
147
+ <h2 id="description">Description</h2>
148
+ <p>The <code>config</code> command shows or changes machinery's configuration.</p>
149
+ <p>If no arguments are passed the <code>config</code> command lists all configuration
150
+ entries and their values. If only the key is provided its value is shown.
151
+ If key and value are specified this configuration entry is set accordingly.</p>
152
+ <p>The configuration is stored in <code>~/.machinery/machinery.config</code>.</p>
153
+ <h2 id="arguments">Arguments</h2>
154
+ <ul>
155
+ <li>
156
+ <p><code>KEY</code>:
157
+ Name of the configuration entry.</p>
158
+ </li>
159
+ <li>
160
+ <p><code>VALUE</code>:
161
+ Value of the configuration entry.</p>
162
+ </li>
163
+ </ul>
164
+ <h2 id="examples">Examples</h2>
165
+ <ul>
166
+ <li>
167
+ <p>Turn off hints:</p>
168
+ <p>$ <code>machinery</code> config hints=off</p>
169
+ </li>
170
+ <li>
171
+ <p>Show current configuration of hints:</p>
172
+ <p>$ <code>machinery</code> config hints</p>
173
+ </li>
174
+ <li>
175
+ <p>List all configuration entries and their values:</p>
176
+ <p>$ <code>machinery</code> config</p>
177
+ </li>
178
+ </ul>
179
+ </div>
180
+ </div>
181
+ </body>
182
+ </html>