summaryrefslogtreecommitdiffstats
path: root/share/man/container.1
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/container.1')
-rw-r--r--share/man/container.1175
1 files changed, 175 insertions, 0 deletions
diff --git a/share/man/container.1 b/share/man/container.1
new file mode 100644
index 0000000..dc68a0a
--- /dev/null
+++ b/share/man/container.1
@@ -0,0 +1,175 @@
+'\" t
+.\" Title: container
+.\" Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\" Date: 20170701
+.\" Manual: Open Infrastructure
+.\" Source: container-tools
+.\" Language: English
+.\"
+.TH "CONTAINER" "1" "20170701" "container\-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
+container\-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
+\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\-tools version, see container\-version(1)\&.
+.RE
+.SH "FILES"
+.sp
+The following files are used:
+.PP
+\fB/etc/container\-tools\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/container\-tools\fR
+.RS 4
+Container commands\&.
+.RE
+.PP
+\fB/usr/share/container\-tools\fR
+.RS 4
+Container shared data\&.
+.RE
+.PP
+\fB/usr/share/doc/container\-tools\fR
+.RS 4
+Container documentation files\&.
+.RE
+.PP
+\fB/var/lib/machines\fR
+.RS 4
+Container root directory\&.
+.RE
+.PP
+\fB/var/log/container\-tools\fR
+.RS 4
+Container log files\&.
+.RE
+.SH "SEE ALSO"
+.sp
+machinectl(1), systemd\-nspawn(1)\&.
+.SH "HOMEPAGE"
+.sp
+More information about container\-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
+container\-tools was written by Daniel Baumann <daniel\&.baumann@open\-infrastructure\&.net>\&.