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
data/manual/site/docs/machinery-export-html.1/index.html ADDED
@@ -0,0 +1,175 @@
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="current">
90
+ <a href="./">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="export-html-export-system-description-as-html">export-html — Export System Description as HTML</h1>
142
+ <h2 id="synopsis">Synopsis</h2>
143
+ <p><code>machinery export-html</code> -d | --html-dir=DIRECTORY NAME
144
+ --force</p>
145
+ <p><code>machinery</code> help export-html</p>
146
+ <h2 id="description">Description</h2>
147
+ <p>The <code>export-html</code> subcommand exports a stored system description as HTML.</p>
148
+ <h2 id="arguments">Arguments</h2>
149
+ <ul>
150
+ <li><code>NAME</code> (required):
151
+ Name of the system description.</li>
152
+ </ul>
153
+ <h2 id="options">Options</h2>
154
+ <ul>
155
+ <li>
156
+ <p><code>-d DIRECTORY</code>, <code>--html-dir=DIRECTORY</code> (required):
157
+ Write the HTML page and assets to this directory. The directory will
158
+ be created if it does not exist yet.</p>
159
+ </li>
160
+ <li>
161
+ <p><code>--force</code> (optional):
162
+ Delete the directory if it exists and recreate it.</p>
163
+ </li>
164
+ </ul>
165
+ <h2 id="examples">Examples</h2>
166
+ <ul>
167
+ <li>
168
+ <p>Export the <code>myhost</code> system description to <code>/tmp/myhost-html</code>:</p>
169
+ <p>$ <code>machinery</code> export-html --html-dir=/tmp myhost</p>
170
+ </li>
171
+ </ul>
172
+ </div>
173
+ </div>
174
+ </body>
175
+ </html>
data/manual/site/docs/machinery-export-kiwi.1/index.html ADDED
@@ -0,0 +1,176 @@
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="current">
86
+ <a href="./">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="export-kiwi-export-system-description-as-kiwi-image-description">export-kiwi — Export System Description as KIWI Image Description</h1>
142
+ <h2 id="synopsis">Synopsis</h2>
143
+ <p><code>machinery export-kiwi</code> -k | --kiwi-dir=DIRECTORY NAME
144
+ --force</p>
145
+ <p><code>machinery</code> help export-kiwi</p>
146
+ <h2 id="description">Description</h2>
147
+ <p>The <code>export-kiwi</code> subcommand exports a stored system description as a KIWI
148
+ image description.</p>
149
+ <h2 id="arguments">Arguments</h2>
150
+ <ul>
151
+ <li><code>NAME</code> (required):
152
+ Name of the system description.</li>
153
+ </ul>
154
+ <h2 id="options">Options</h2>
155
+ <ul>
156
+ <li>
157
+ <p><code>-k KIWI_DIR</code>, <code>--kiwi-dir=KIWI_DIR</code> (required):
158
+ Write the KIWI image description to a subdirectory at the specified directory. The directory
159
+ will be created if it does not exist yet.</p>
160
+ </li>
161
+ <li>
162
+ <p><code>--force</code> (optional):
163
+ Overwrite an existing output directory.</p>
164
+ </li>
165
+ </ul>
166
+ <h2 id="examples">Examples</h2>
167
+ <ul>
168
+ <li>
169
+ <p>Export the <code>myhost</code> system description to <code>/tmp/myhost-kiwi</code>:</p>
170
+ <p>$ <code>machinery</code> export-kiwi myhost --kiwi-dir=/tmp</p>
171
+ </li>
172
+ </ul>
173
+ </div>
174
+ </div>
175
+ </body>
176
+ </html>
data/manual/site/docs/machinery-inspect-container.1/index.html ADDED
@@ -0,0 +1,249 @@
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="current">
98
+ <a href="./">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="inspect-container-inspect-container">inspect-container — Inspect Container</h1>
142
+ <h2 id="synopsis">Synopsis</h2>
143
+ <p><code>machinery inspect-container</code> [OPTIONS] IMAGENAME</p>
144
+ <p><code>machinery inspect-container</code> [OPTIONS] IMAGEID</p>
145
+ <p><code>machinery</code> help inspect-container</p>
146
+ <h2 id="description">Description</h2>
147
+ <p>The <code>inspect-container</code> command inspects a container image. It creates and starts the container from the provided image before inspection
148
+ and generates a system description from the gathered data. After the inspection the container will be killed and removed again.
149
+ This approach ensures that no containers and images are affected by the inspection.</p>
150
+ <p>Right now the container inspection only supports Docker images.</p>
151
+ <p>The system data is structured into scopes, controlled by the
152
+ <code>--scope</code> option.</p>
153
+ <p><strong>Note</strong>:
154
+ Machinery will always inspect all specified scopes, and skip scopes which
155
+ trigger errors.</p>
156
+ <h2 id="arguments">Arguments</h2>
157
+ <ul>
158
+ <li><code>IMAGENAME / IMAGEID</code> (required):
159
+ The name or ID of the image to be inspected. The provided name or ID will also be
160
+ used as the name of the stored system description unless another name is
161
+ provided with the <code>--name</code> option.</li>
162
+ </ul>
163
+ <h2 id="options">Options</h2>
164
+ <ul>
165
+ <li>
166
+ <p><code>-n NAME</code>, <code>--name=NAME</code> (optional):
167
+ Store the system description under the specified name.</p>
168
+ </li>
169
+ <li>
170
+ <p><code>-s SCOPE</code>, <code>--scope=SCOPE</code> (optional):
171
+ Inspect image for specified scope.
172
+ See the <a href="../machinery_main_scopes.1/">Scope section</a> for more information.</p>
173
+ </li>
174
+ <li>
175
+ <p><code>-e SCOPE</code>, <code>--ignore-scope=IGNORE-SCOPE</code> (optional):
176
+ Inspect image for all scopes except the specified scope.
177
+ See the <a href="../machinery_main_scopes.1/">Scope section</a> for more information.</p>
178
+ </li>
179
+ <li>
180
+ <p><code>-x</code>, <code>--extract-files</code> (optional):
181
+ Extract changed configuration and unmanaged files from the inspected container.
182
+ Shortcut for the combination of <code>--extract-changed-config-files</code>,
183
+ <code>--extract-unmanaged-files</code>, and <code>--extract-changed-managed-files</code></p>
184
+ </li>
185
+ <li>
186
+ <p><code>--extract-changed-config-files</code> (optional):
187
+ Extract changed configuration files from the inspected image.</p>
188
+ </li>
189
+ <li>
190
+ <p><code>--extract-unmanaged-files</code> (optional):
191
+ Extract unmanaged files from the inspected image.</p>
192
+ </li>
193
+ <li>
194
+ <p><code>--extract-changed-managed-files</code> (optional):
195
+ Extract changed managed files from inspected image.</p>
196
+ </li>
197
+ <li>
198
+ <p><code>--skip-files</code> (optional):
199
+ Do not consider given files or directories during inspection. Either provide
200
+ one file or directory name or a list of names separated by commas. You can
201
+ also point to a file which contains a list of files to filter (one per line)
202
+ by adding an '@' before the path, e.g.</p>
203
+ <p>$ <code>machinery</code> inspect-container --skip-files=@/path/to/filter_file myimage</p>
204
+ <p>If a filename contains a comma it needs to be escaped, e.g.</p>
205
+ <p>$ <code>machinery</code> inspect-container --skip-files=/file\,with_comma myimage</p>
206
+ <p><strong>Note</strong>: File or directory names are not expanded, e.g. '../path' is taken
207
+ literally and not expanded.</p>
208
+ </li>
209
+ <li>
210
+ <p><code>--verbose</code> (optional):
211
+ Display the filters which are used during inspection.</p>
212
+ </li>
213
+ </ul>
214
+ <h2 id="prerequisites">Prerequisites</h2>
215
+ <ul>
216
+ <li>
217
+ <p>Inspecting a container requires an image specified by the name or ID.</p>
218
+ </li>
219
+ <li>
220
+ <p>The image to be inspected needs to have the following commands:</p>
221
+ <ul>
222
+ <li><code>rpm</code> or <code>dpkg</code></li>
223
+ <li><code>zypper</code>, <code>yum</code> or <code>apt-cache</code></li>
224
+ <li><code>rsync</code></li>
225
+ <li><code>cat</code></li>
226
+ <li><code>sed</code></li>
227
+ <li><code>find</code></li>
228
+ </ul>
229
+ </li>
230
+ </ul>
231
+ <h2 id="examples">Examples</h2>
232
+ <ul>
233
+ <li>
234
+ <p>Inspect Docker container <code>myimage</code> and save system description under name 'MyContainer':</p>
235
+ <p>$ <code>machinery</code> inspect-container --name=MyContainer myimage</p>
236
+ </li>
237
+ <li>
238
+ <p>Inspect Docker container <code>076f46c1bef1</code> and save system description under name 'MySecondContainer':</p>
239
+ <p>$ <code>machinery</code> inspect-container --name=MySecondContainer 076f46c1bef1</p>
240
+ </li>
241
+ <li>
242
+ <p>Extract changed managed files and save them:</p>
243
+ <p>$ <code>machinery</code> inspect-container --scope=changed-managed-files --extract-files myimage</p>
244
+ </li>
245
+ </ul>
246
+ </div>
247
+ </div>
248
+ </body>
249
+ </html>