summaryrefslogtreecommitdiffstats
path: root/share/man/container.1
blob: 2c405f3c31e3fa95a29417ee457c00fd24cda06d (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
183
184
185
'\" t
.\"     Title: container
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 20190304
.\"    Manual: Open Infrastructure
.\"    Source: compute-tools
.\"  Language: English
.\"
.TH "CONTAINER" "1" "20190304" "compute\-tools" "Open Infrastructure"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
container \- Manage systemd\-nspawn containers
.SH "SYNOPSIS"
.sp
\fBcontainer\fR \fICOMMAND\fR [\fIOPTIONS\fR] \fBcontainer\fR \fICOMMAND1\fR,\fICOMMAND2\fR,\&... \fICOMMANDn\fR
.SH "DESCRIPTION"
.sp
compute\-tools provides the system integration for managing containers using systemd\-nspawn\&.
.SH "OPTIONS"
.sp
The following container common options are available:
.PP
\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR
.RS 4
Specify container name\&.
.RE
.SH "COMMANDS"
.sp
The following container commands are available:
.PP
\fBcreate\fR
.RS 4
Create a new container, see container\-create(1)\&.
.RE
.PP
\fBstart\fR
.RS 4
Start a container, see container\-start(1)\&.
.RE
.PP
\fBrestart\fR
.RS 4
Restart a container, see container\-restart(1)\&.
.RE
.PP
\fBstop\fR
.RS 4
Stop a container, see container\-stop(1)\&.
.RE
.PP
\fBremove\fR
.RS 4
Remove a container, see container\-remove(1)\&.
.RE
.PP
\fBmove\fR
.RS 4
Rename a container, see container\-move(1)\&.
.RE
.PP
\fBconsole\fR
.RS 4
Attach console to a container, see container\-console(1)\&.
.RE
.PP
\fBenter\fR
.RS 4
Enter a container namespace, see container\-enter(1)\&.
.RE
.PP
\fBkey\fR
.RS 4
Manage GnuPG keyring for container operations, see container\-key(1)\&.
.RE
.PP
\fBlimit\fR
.RS 4
Limit ressources of a container, see container\-limit(1)\&.
.RE
.PP
\fBlist\fR
.RS 4
List container on the system, see container\-list(1)\&.
.RE
.PP
\fBlog\fR
.RS 4
Show container log, see container\-log(1)\&.
.RE
.PP
\fBstatus\fR
.RS 4
Show container status, see container\-status(1)\&.
.RE
.PP
\fBtop\fR
.RS 4
Dynamic list of container on the system, see container\-top(1)\&.
.RE
.PP
\fBversion\fR
.RS 4
Show container version, see container\-version(1)\&.
.RE
.SH "FILES"
.sp
The following files are used:
.PP
\fB/etc/open\-infrastructure/container\fR
.RS 4
Container configuration files\&.
.RE
.PP
\fB/usr/bin/container\fR, \fB/usr/bin/cnt\fR
.RS 4
Container program\&.
.RE
.PP
\fB/usr/bin/container\-shell\fR, \fB/usr/bin/cntsh\fR
.RS 4
Container shell program\&.
.RE
.PP
\fB/usr/lib/open\-infrastructure/container\fR
.RS 4
Container commands\&.
.RE
.PP
\fB/usr/share/open\-infrastructure/container\fR
.RS 4
Container shared data\&.
.RE
.PP
\fB/usr/share/doc/compute\-tools\fR
.RS 4
Container documentation files\&.
.RE
.PP
\fB/var/cache/open\-infrastructure/container\fR
.RS 4
Container cache directory\&.
.RE
.PP
\fB/var/lib/machines\fR
.RS 4
Container root directory\&.
.RE
.PP
\fB/var/log/open\-infrastructure\fR
.RS 4
Container log files\&.
.RE
.SH "SEE ALSO"
.sp
machinectl(1), systemd\-nspawn(1)\&.
.SH "HOMEPAGE"
.sp
More information about compute\-tools and the Open Infrastructure project can be found on the homepage at https://open\-infrastructure\&.net\&.
.SH "CONTACT"
.sp
Bug reports, feature requests, help, patches, support and everything else are welcome on the Open Infrastructure Software Mailing List <software@lists\&.open\-infrastructure\&.net>\&.
.sp
Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs\&.debian\&.org\&.
.SH "AUTHORS"
.sp
compute\-tools were written by Daniel Baumann <daniel\&.baumann@open\-infrastructure\&.net> and others\&.