summaryrefslogtreecommitdiffstats
path: root/share/man/container.1
blob: 3a154ef82ac5c1071d7831a5c36563b6d541e84f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
.\" Open Infrastructure: compute-tools
.\"
.\" Copyright (C) 2014-2021 Daniel Baumann <daniel.baumann@open-infrastructure.net>
.\"
.\" SPDX-License-Identifier: GPL-3.0+
.\"
.\" This program is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program.  If not, see <https://www.gnu.org/licenses/>.
.\"
.
.TH CONTAINER 1  compute-tools "Open Infrastructure"
.SH NAME
container \- Manage systemd-nspawn containers
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.nf
\fBcontainer\fP \(aqCOMMAND\(aq [\(aqOPTIONS\(aq]
\fBcontainer\fP \(aqCOMMAND1\(aq,\(aqCOMMAND2\(aq,... \(aqCOMMANDn\(aq
.fi
.sp
.SH DESCRIPTION
.sp
compute\-tools provides the system integration for managing containers using
systemd\-nspawn.
.SH OPTIONS
.sp
The following \fBcontainer\fP common options are available:
.INDENT 0.0
.TP
.B \-n, \-\-name=\(aqNAME\(aq:
Specify container name.
.UNINDENT
.SH COMMANDS
.sp
The following \fBcontainer\fP commands are available:
.INDENT 0.0
.TP
.B build:
Build a new container, see container\-build(1).
.TP
.B start:
Start a container, see container\-start(1).
.TP
.B restart:
Restart a container, see container\-restart(1).
.TP
.B stop:
Stop a container, see container\-stop(1).
.TP
.B remove:
Remove a container, see container\-remove(1).
.TP
.B move:
Rename a container, see container\-move(1).
.TP
.B console:
Attach console to a container, see container\-console(1).
.TP
.B enter:
Enter a container namespace, see container\-enter(1).
.TP
.B run:
Execute commands in a container namespace, see container\-run(1).
.TP
.B info:
Show specific information of a container, see container\-info(1).
.TP
.B key:
Manage GnuPG keyring for container operations, see container\-key(1).
.TP
.B limit:
Limit resources of a container, see container\-limit(1).
.TP
.B list:
List container on the system, see container\-list(1).
.TP
.B log:
Show container log, see container\-log(1).
.TP
.B status:
Show container status, see container\-status(1).
.TP
.B top:
Dynamic list of container on the system, see container\-top(1).
.TP
.B update:
Update the packages installed in a container.
.TP
.B version:
Show container version, see container\-version(1).
.UNINDENT
.SH FILES
.sp
The following files are used:
.INDENT 0.0
.TP
.B /etc/compute\-tools/container.conf, /etc/compute\-tools/container.conf.d/*.conf:
Container configuration files.
.TP
.B /usr/bin/container, /usr/bin/cnt:
Container program.
.TP
.B /usr/bin/container\-shell, /usr/bin/cntsh:
Container shell program.
.TP
.B /usr/libexec/container:
Container commands.
.TP
.B /usr/share/compute\-tools/:
Container shared data.
.TP
.B /usr/share/doc/compute\-tools:
Container documentation files.
.TP
.B /var/cache/container:
Container cache directory.
.TP
.B /var/lib/machines:
Container root directory.
.TP
.B /var/log/compute\-tools:
Container log files.
.UNINDENT
.SH SEE ALSO
.nf
machinectl(1),
systemd\-nspawn(1).
.fi
.sp
.SH HOMEPAGE
.sp
More information about compute\-tools and the Open Infrastructure project can be
found on the homepage (\fI\%https://open\-infrastructure.net\fP).
.SH CONTACT
.sp
Bug reports, feature requests, help, patches, support and everything else are
welcome on the Open Infrastructure Software Mailing List
<\fI\%software@lists.open\-infrastructure.net\fP>.
.sp
Debian specific bugs can also be reported in the Debian Bug Tracking System
(\fI\%https://bugs.debian.org\fP).
.SH AUTHORS
.sp
compute\-tools were written by Daniel Baumann
<\fI\%daniel.baumann@open\-infrastructure.net\fP> and others.
.