diff options
| author | Daniel Baumann <mail@daniel-baumann.ch> | 2016-11-22 15:09:21 +0000 |
|---|---|---|
| committer | Daniel Baumann <mail@daniel-baumann.ch> | 2016-12-11 12:27:10 +0000 |
| commit | 5557e970bdf2ae2b32e549b945bc336d180d17c2 (patch) | |
| tree | 32e40bb0c9e46456b24da4a0a401d10d2644e0b2 /share/man | |
| parent | Adding upstream version 20161112. (diff) | |
| download | open-infrastructure-compute-tools-5557e970bdf2ae2b32e549b945bc336d180d17c2.tar.xz open-infrastructure-compute-tools-5557e970bdf2ae2b32e549b945bc336d180d17c2.zip | |
Adding upstream version 20161122.
Signed-off-by: Daniel Baumann <mail@daniel-baumann.ch>
Diffstat (limited to 'share/man')
36 files changed, 2047 insertions, 59 deletions
diff --git a/share/man/container-auto.1 b/share/man/container-auto.1 new file mode 100644 index 0000000..ae4b9d2 --- /dev/null +++ b/share/man/container-auto.1 @@ -0,0 +1,75 @@ +'\" t +.\" Title: container-start +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-START" "1" "20161112" "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-auto \- Start/stop all container automatically at boot/shutdown +.SH "SYNOPSIS" +.sp +\fBcontainer auto\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The container auto command starts or stops all container on the host system\&. +.SH "OPTIONS" +.sp +The following container options are available: +.PP +\fB\-s, \-\-start\fR +.RS 4 +Start all container on the host system\&. +.RE +.PP +\fB\-t, \-\-stop\fR +.RS 4 +Stop all container on the host system\&. +.RE +.SH "EXAMPLES" +.PP +\fBStart all container on the host system:\fR +.RS 4 +sudo container auto \-\-start +.RE +.PP +\fBStop all container on the host system:\fR +.RS 4 +sudo container auto \-\-stop +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-auto.1.txt b/share/man/container-auto.1.txt index a1f1ab3..e3ece8a 100644 --- a/share/man/container-auto.1.txt +++ b/share/man/container-auto.1.txt @@ -68,9 +68,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-console.1 b/share/man/container-console.1 new file mode 100644 index 0000000..a15aa58 --- /dev/null +++ b/share/man/container-console.1 @@ -0,0 +1,65 @@ +'\" t +.\" Title: container-console +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-CONSOLE" "1" "20161112" "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-console \- Attach a console to a container +.SH "SYNOPSIS" +.sp +\fBcontainer console\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The container console command attaches a console to a container\&. +.SH "OPTIONS" +.sp +The following container options are available: +.PP +\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR +.RS 4 +Specify container name\&. +.RE +.SH "EXAMPLES" +.PP +\fBAttach console to example\&.net container:\fR +.RS 4 +sudo container console \-n example\&.net +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-console.1.txt b/share/man/container-console.1.txt index 410ff92..65f1621 100644 --- a/share/man/container-console.1.txt +++ b/share/man/container-console.1.txt @@ -62,9 +62,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-create-curl.1 b/share/man/container-create-curl.1 new file mode 100644 index 0000000..ab6b3f5 --- /dev/null +++ b/share/man/container-create-curl.1 @@ -0,0 +1,156 @@ +'\" t +.\" Title: container-create-curl +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-CREATE\-C" "1" "20161112" "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-create-curl \- Create a Debian based container by downloading a tarball over the network +.SH "SYNOPSIS" +.sp +\fBcontainer create \-s curl\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The curl container creation script uses curl(1) to download a tarball over the network to create a Debian based container\&. +.sp +Depending on the tarball this script otherwise creates a pure Debian system with three modificiations: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +hostname is set (container name) in /etc/hostname +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +systemd machine\-id is generated in /etc/machine\-id +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +root password is set (user specified or 16 random characters) +.RE +.SH "OPTIONS" +.sp +The following script options are available: +.PP +\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR +.RS 4 +Specify container name\&. +.RE +.PP +"\-\-clean* +.RS 4 +Remove downloaded tarball after successfull container creation\&. +.RE +.PP +\fB\-\-image=\fR\fB\fIIMAGE\fR\fR +.RS 4 +.RE +.PP +\fB\-\-server=\fR\fB\fISERVER\fR\fR +.RS 4 +Specify the image server to download from, defaults to +https://files\&.open\-infrastructure\&.net/images/container\-tools/current\&. +.RE +.PP +\fB\-p, \-\-root\-password=\fR\fB\fIPASSWORD\fR\fR +.RS 4 +Specify the root password, defaults to a random 16 character password\&. +.RE +.SH "EXAMPLES" +.PP +\fBCreate a Debian 9 (stretch) based container with same architecture as the host system:\fR +.RS 4 +sudo container create \-s curl \-n stretch\&.example\&.net +.RE +.PP +\fBCreate a Debian 9 (stretch) based container with different architecture as the host system:\fR +.RS 4 +sudo container create \-s curl \-n stretch\-i386\&.example\&.net \(em \-\-image debian\-stretch\-i386\&.tar\&.xz +.RE +.SH "FILES" +.sp +The following files are used: +.PP +\fB/etc/container\-tools/config\fR +.RS 4 +Container configuration files\&. +.RE +.PP +\fB/usr/share/container\-tools/scripts\fR +.RS 4 +Container creation scripts\&. +.RE +.PP +\fB/usr/share/doc/container\-tools\fR +.RS 4 +Container documentation\&. +.RE +.PP +\fB/var/lib/machines\fR +.RS 4 +Container directory\&. +.RE +.PP +\fB/var/cache/container\-tools\fR +.RS 4 +Container cache directory\&. +.RE +.SH "CONTAINER IMAGES" +.sp +container\-tools will download tarballs from a server expecting that the images are tarballs with either gzip, lzip, xz, or no compression\&. See container\-images\&.sh as an example on how to create your own container images\&. +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-create-curl.1.txt b/share/man/container-create-curl.1.txt index f310eaf..68fc0e2 100644 --- a/share/man/container-create-curl.1.txt +++ b/share/man/container-create-curl.1.txt @@ -51,6 +51,9 @@ The following script options are available: *-n, --name='NAME'*:: Specify container name. +"--clean*:: + Remove downloaded tarball after successfull container creation. + *--image='IMAGE'*:: Specify the image name to download, defaults to debian-stretch-${ARCHITECTURE}.tar.xz (where ${ARCHITECTURE} is the host systems architecture). @@ -106,9 +109,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-create-debconf.1 b/share/man/container-create-debconf.1 new file mode 100644 index 0000000..1e2db07 --- /dev/null +++ b/share/man/container-create-debconf.1 @@ -0,0 +1,179 @@ +'\" t +.\" Title: container-create-debootstrap +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-CREATE\-D" "1" "20161112" "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-create-debconf \- Create an advanced Debian based container with debconf +.SH "SYNOPSIS" +.sp +\fBcontainer create \-s debconf\fR [\fIOPTIONS\fR] \fBcontainer create \-s debian\fR [\fIOPTIONS\fR] \fBcontainer create \-s progress\-linux\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The debconf container creation script uses debconf(1) to automatically create a Debian based container\&. +.SS "SCOPE" +.sp +Note that this container creation script can do a few things more than just automatically debootstrap based on a preseed file\&. It also allows you to set a root password, configure the network, install certain packages and execute hooks\&. +.sp +But: this is \fBnot\fR a replacement for a configuration management system (like ansible, puppet, etc\&.)\&. The intenion of this script is to create the initial container to that extend that a configuration managment system can take over\&. +.sp +As an analogy, think of debian\-installer: d\-i sets up your system to make it ready to boot and connect to the network\&. Everything after that is out of scope\&. Same goes for this script\&. (FIXME) +.SS "FUNCTIONS" +.sp +This script performs the following configuration on top of a Debian based system: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +network +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +root password +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +apt repositories +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\&... +.RE +.SS "MODES" +.sp +This container creation script can be used under two different names: debian and progress\-linux\&. +.sp +Alternative, calling it under the debconf name is equal to the debian mode\&. +.SS "INTERACTIVE/NONINTERACTIVE" +.sp +FIXME +.SS "PRESEEDING" +.sp +Hierarchy of Preseed Files +.sp +The debconf script can be fully preseeded\&. Such preseed files can include one or more preseed files themselfs (currently, only one layer of includes is supported, no nested or recursive includes)\&. +.sp +The general rule of \fIthe later preseed file overwrites the earlier\fR applies\&. The debconf script reads the main preseed file (specified either on command line or by debconf selection/input dialog) after any included preseed files in there\&. +.sp +That means that debconf values after the include statement in the main preseed file can overwrite any values specified in the included preseed files\&. +.SH "OPTIONS" +.sp +The following script options are available: +.PP +\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR +.RS 4 +Specify container name\&. +.RE +.PP +\fB\-p, \-\-preseed\-file=\fR\fB\fIFILE\fR\fR +.RS 4 +Specify the preseed file\&. +.RE +.SH "EXAMPLES" +.PP +\fBCreate a Debian based container:\fR +.RS 4 +sudo container create \-s debian \-n stretch\&.example\&.net +.RE +.PP +\fBCreate a Progress Linux container:\fR +.RS 4 +sudo container create \-s progress\-linux \-n cairon\-backports\&.example\&.net +.RE +.SH "FILES" +.sp +The following files are used: +.PP +\fB/etc/container\-tools/config\fR +.RS 4 +Container configuration files\&. +.RE +.PP +\fB/usr/share/container\-tools/scripts\fR +.RS 4 +Container creation scripts\&. +.RE +.PP +\fB/usr/share/doc/container\-tools\fR +.RS 4 +Container documentation\&. +.RE +.PP +\fB/var/lib/machines\fR +.RS 4 +Container directory\&. +.RE +.PP +\fB/var/cache/container\-tools\fR +.RS 4 +Container cache directory\&. +.RE +.PP +\fB/tmp/container\-tools\fR +.RS 4 +Container temporary directory\&. +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-create-debconf.1.txt b/share/man/container-create-debconf.1.txt index 9593415..9e765f3 100644 --- a/share/man/container-create-debconf.1.txt +++ b/share/man/container-create-debconf.1.txt @@ -141,9 +141,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-create-debootstrap.1 b/share/man/container-create-debootstrap.1 new file mode 100644 index 0000000..b95f31c --- /dev/null +++ b/share/man/container-create-debootstrap.1 @@ -0,0 +1,126 @@ +'\" t +.\" Title: container-create-debootstrap +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-CREATE\-D" "1" "20161112" "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-create-debootstrap \- Create a basic Debian based container with debootstrap +.SH "SYNOPSIS" +.sp +\fBcontainer create \-s debootstrap\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The debootstrap container creation script uses debootstrap(8) to create a Debian based container\&. +.sp +This script creates a pure Debian system with three modificiations: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +apt cache of packages downloaded during debootstrap is cleaned +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +hostname is set (container name) in /etc/hostname +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +root password is set (user specified or 16 random characters) +.RE +.SH "OPTIONS" +.sp +The following script options are available: +.PP +\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR +.RS 4 +Specify container name\&. +.RE +.PP +\fB\-a, \-\-architecture=\fR\fB\fIARCHITECTURE\fR\fR +.RS 4 +Specify the Debian architecture, defaults to the host systems architecture\&. +.RE +.PP +\fB\-d, \-\-distribution=\fR\fB\fIDISTRIBUTION\fR\fR +.RS 4 +Specify the Debian distribution, defaults to stretch\&. +.RE +.PP +\fB\-m, \-\-mirror=\fR\fB\fIMIRROR\fR\fR +.RS 4 +Specify the Debian mirror, defaults to +https://deb\&.debian\&.org/debian\&. +.RE +.PP +\fB\-p, \-\-root\-password=\fR\fB\fIPASSWORD\fR\fR +.RS 4 +Specify the root password, defaults to a random 16 character password\&. +.RE +.SH "EXAMPLES" +.PP +\fBCreate a Debian 9 (stretch) based container with same architecture as the host system:\fR +.RS 4 +sudo container create \-s debootstrap \-n stretch\&.example\&.net +.RE +.PP +\fBCreate a Debian 9 (stretch) based container with different architecture as the host system:\fR +.RS 4 +sudo container create \-s debootstrap \-n stretch\-i386\&.example\&.net \(em \-a i386 +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-create-debootstrap.1.txt b/share/man/container-create-debootstrap.1.txt index 7f7d8fb..4c7bbcb 100644 --- a/share/man/container-create-debootstrap.1.txt +++ b/share/man/container-create-debootstrap.1.txt @@ -83,9 +83,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-create.1 b/share/man/container-create.1 new file mode 100644 index 0000000..cb81968 --- /dev/null +++ b/share/man/container-create.1 @@ -0,0 +1,124 @@ +'\" t +.\" Title: container-create +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-CREATE" "1" "20161112" "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-create \- Create a container +.SH "SYNOPSIS" +.sp +\fBcontainer create\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The container\-create command creates a container based on a script\&. +.SH "OPTIONS" +.sp +The following container\-create options are available: +.PP +\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR +.RS 4 +Specify container name\&. +.RE +.PP +\fB\-c, \-\-capability=\fR\fB\fICAPABILITY\fR\fR +.RS 4 +Specify capabilities to grant, see capabilities(7)\&. +.RE +.PP +\fB\-d, \-\-drop\-capability=\fR\fB\fIDROP_CAPABILITY\fR\fR +.RS 4 +Specify capabilities to drop, see capabilities(7)\&. +.RE +.PP +\fB\-s, \-\-script=\fR\fB\fISCRIPT\fR\fR +.RS 4 +Specify container creation script, defaults to debootstrap\&. +.RE +.PP +\fB\-b, \-\-bind=\fR\fB\fIDIRECTORY:DIRECTORY[:OPTIONS][;DIRECTORY:DIRECTORY[:OPTIONS]]\fR\fR +.RS 4 +Specify container bind mounts, see systemd\-nspawn(1) \-\-bind option\&. +.RE +.PP +\fB\-\-cnt\-overlay=\fR\fB\fIDIRECTORY_LOWER:DIRECTORY_UPPER:DIRECTORY_WORK:DIRECTORY_MERGED[;DIRECTORY_UPPER:DIRECTORY_LOWER:DIRECTORY_WORK:DIRECTORY_MERGED]\fR\fR +.RS 4 +Specify container overlay mounts, see Documentation/filesystems/overlayfs\&.txt\&. +.RE +.SH "SCRIPTS" +.sp +The following container scripts are available: +.PP +\fBcurl\fR +.RS 4 +Basic script to create Debian based container, see container\-create\-curl(1)\&. +.RE +.PP +\fBdebootstrap\fR +.RS 4 +Basic script to create Debian based container, see container\-create\-debootstrap(1)\&. +.RE +.PP +\fBdebconf\fR +.RS 4 +Advanced script to automatically create Debian based container, see container\-create\-debconf(1)\&. +.RE +.PP +\fBdefault\fR +.RS 4 +Symlink (if existing) to a container script which is used if no script was specified\&. On Debian based system this can be managed through update\-alternatives(1), i\&.e\&. +\fIsudo update\-alternatives \-\-config container\-tools_script\fR\&. +.RE +.SH "EXAMPLES" +.PP +\fBCreate example\&.net container using curl script:\fR +.RS 4 +sudo container create \-n example\&.net \-s curl +.RE +.PP +\fBCreate example\&.net container using debootstrap script:\fR +.RS 4 +sudo container create \-n example\&.net \-s debootstrap +.RE +.PP +\fBCreate example\&.net container using debconf script:\fR +.RS 4 +sudo container create \-n example\&.net \-s debconf +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-create.1.txt b/share/man/container-create.1.txt index 6918585..fa6b713 100644 --- a/share/man/container-create.1.txt +++ b/share/man/container-create.1.txt @@ -99,9 +99,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-enter.1 b/share/man/container-enter.1 new file mode 100644 index 0000000..3eed67f --- /dev/null +++ b/share/man/container-enter.1 @@ -0,0 +1,65 @@ +'\" t +.\" Title: container-console +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-CONSOLE" "1" "20161112" "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-enter \- Enter a container namespace +.SH "SYNOPSIS" +.sp +\fBcontainer enter\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The container enter enters a container namespace\&. +.SH "OPTIONS" +.sp +The following container options are available: +.PP +\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR +.RS 4 +Specify container name\&. +.RE +.SH "EXAMPLES" +.PP +\fBEnter to example\&.net container namespace:\fR +.RS 4 +sudo container enter \-n example\&.net +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-enter.1.txt b/share/man/container-enter.1.txt index 61c0f66..6339e74 100644 --- a/share/man/container-enter.1.txt +++ b/share/man/container-enter.1.txt @@ -62,9 +62,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-limit.1 b/share/man/container-limit.1 new file mode 100644 index 0000000..d4c4938 --- /dev/null +++ b/share/man/container-limit.1 @@ -0,0 +1,120 @@ +'\" t +.\" Title: container-limit +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-LIMIT" "1" "20161112" "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-limit \- Limit ressources of a container +.SH "SYNOPSIS" +.sp +\fBcontainer limit\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The container limit command limits ressources available to a container at runtime\&. +.SH "OPTIONS" +.sp +The following container options are available: +.PP +\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR +.RS 4 +Specify container name\&. +.RE +.PP +\fB\-\-blockio\-device\-weight=\fR\fB\fIDEVICE WEIGHT\fR\fR +.RS 4 +Specify device specific blockio weight, see systemd\&.resource\-control(5)\&. +.RE +.PP +\fB\-\-blockio\-read\-bandwith=\fR\fB\fIDEVICE BYTES\fR\fR +.RS 4 +Specify device specific blockio read bandwith, see systemd\&.resource\-control(5)\&. +.RE +.PP +\fB\-b, \-\-blockio\-weight=\fR\fB\fIWEIGHT\fR\fR +.RS 4 +Specify general blockio weight, see systemd\&.resource\-control(5)\&. +.RE +.PP +\fB\-\-blockio\-write\-bandwith=\fR\fB\fIDEVICE BYTES\fR\fR +.RS 4 +Specify device specific blockio write bandwith, see systemd\&.resource\-control(5)\&. +.RE +.PP +\fB\-c, \-\-cpu\-quota=\fR\fB\fIQUOTA\fR\fR +.RS 4 +Specify CPU quota, see systemd\&.resource\-control(5)\&. +.RE +.PP +\fB\-\-cpu\-shares=\fR\fB\fISHARES\fR\fR +.RS 4 +Specify CPU shares, see systemd\&.resource\-control(5)\&. +.RE +.PP +\fB\-m, \-\-memory\-limit=\fR\fB\fIBYTES\fR\fR +.RS 4 +Specify memory limit, see systemd\&.resource\-control(5)\&. +.RE +.PP +\fB\-t, \-\-tasks\-max=\fR\fB\fINUMBER\fR\fR +.RS 4 +Specify tasks max, see systemd\&.resource\-control(5)\&. +.RE +.SH "EXAMPLES" +.PP +\fBSet blockio weight for the example\&.net container:\fR +.RS 4 +sudo container limit \-n example\&.net \-\-blockio\-weight 100 +.RE +.PP +\fBSet CPU quota for the example\&.net container:\fR +.RS 4 +sudo container limit \-n example\&.net \-\-cpu\-quota 10% +.RE +.PP +\fBSet memory limit for the example\&.net container to 1GB:\fR +.RS 4 +sudo container limit \-n example\&.net \-\-memory\-limit 1G +.RE +.PP +\fBSet tasks max for the example\&.net container to 100:\fR +.RS 4 +sudo container limit \-n example\&.net \-\-tasks\-max 100 +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-limit.1.txt b/share/man/container-limit.1.txt index 0ba5b74..7fedc5b 100644 --- a/share/man/container-limit.1.txt +++ b/share/man/container-limit.1.txt @@ -95,9 +95,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-list.1 b/share/man/container-list.1 new file mode 100644 index 0000000..c446346 --- /dev/null +++ b/share/man/container-list.1 @@ -0,0 +1,108 @@ +'\" t +.\" Title: container-list +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-LIST" "1" "20161112" "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-list \- List container on the system +.SH "SYNOPSIS" +.sp +\fBcontainer list\fR [\fIOPTIONS\fR] +.sp +\fBcontainer ls\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The container list command lists container on the system\&. +.SH "OPTIONS" +.sp +The following container options are available, defaults to \fB\-\-started \-\-stopped\fR: +.PP +\fB\-a, \-\-all\fR +.RS 4 +List all available container (started, stopped, and other)\&. +.RE +.PP +\fB\-f, \-\-format=\fR\fB\fIFORMAT\fR\fR +.RS 4 +Use format to list container\&. Currently available formats are +\fIshort\fR +or +\fIfull\fR +(default)\&. +.RE +.PP +\fB\-h, \-\-host=\fR\fB\fIHOSTNAME\fR\fR +.RS 4 +List only container that are enabled for automatic start on the specified hostname\&. Defaults to list containers of the local system only\&. Using +\fIall\fR +shows all container regardless of any automatic start configuration\&. +.RE +.PP +\fB\-o, \-\-other\fR +.RS 4 +List only container that are not enable for automatic start on the current system\&. +.RE +.PP +\fB\-s, \-\-started\fR +.RS 4 +List only started container\&. +.RE +.PP +\fB\-t, \-\-stopped\fR +.RS 4 +List only stopped container\&. +.RE +.SH "EXAMPLES" +.PP +\fBList all started and stopped containers of the local system:\fR +.RS 4 +sudo container list +.RE +.PP +\fBList all started and stopped containers of the local system as a machine\-readable list:\fR +.RS 4 +sudo container list \-f short +.RE +.PP +\fBList all started and other containers:\fR +.RS 4 +sudo container list \-s \-o +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-list.1.txt b/share/man/container-list.1.txt index e0c8fb7..5aa9f22 100644 --- a/share/man/container-list.1.txt +++ b/share/man/container-list.1.txt @@ -84,9 +84,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-remove.1 b/share/man/container-remove.1 new file mode 100644 index 0000000..47f19ae --- /dev/null +++ b/share/man/container-remove.1 @@ -0,0 +1,82 @@ +'\" t +.\" Title: container-remove +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-REMOVE" "1" "20161112" "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-remove \- Remove a container +.SH "SYNOPSIS" +.sp +\fBcontainer remove\fR [\fIOPTIONS\fR] +.sp +\fBcontainer rm\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The container remove command removes a container\&. +.SH "OPTIONS" +.sp +The following container options are available: +.PP +\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR +.RS 4 +Specify container name\&. +.RE +.PP +\fB\-f, \-\-force\fR +.RS 4 +Do not prompt before removal\&. +.RE +.PP +\fB\-v, \-\-verbose\fR +.RS 4 +Explain what is being done\&. +.RE +.SH "EXAMPLES" +.PP +\fBRemove example\&.net container from the system:\fR +.RS 4 +sudo container remove \-n example\&.net +.RE +.PP +\fBRemove example\&.net container from the system without prompt:\fR +.RS 4 +sudo container remove \-n example\&.net \-f +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-remove.1.txt b/share/man/container-remove.1.txt index 03c29c2..d5724bd 100644 --- a/share/man/container-remove.1.txt +++ b/share/man/container-remove.1.txt @@ -73,9 +73,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-restart.1 b/share/man/container-restart.1 new file mode 100644 index 0000000..dda4596 --- /dev/null +++ b/share/man/container-restart.1 @@ -0,0 +1,65 @@ +'\" t +.\" Title: container-restart +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-RESTART" "1" "20161112" "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-restart \- Restart a container +.SH "SYNOPSIS" +.sp +\fBcontainer restart\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The container restart command restarts a container\&. +.SH "OPTIONS" +.sp +The following container options are available: +.PP +\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR +.RS 4 +Specify container name\&. +.RE +.SH "EXAMPLES" +.PP +\fBRestart example\&.net container:\fR +.RS 4 +sudo container restart \-n example\&.net +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-restart.1.txt b/share/man/container-restart.1.txt index eda0174..181c754 100644 --- a/share/man/container-restart.1.txt +++ b/share/man/container-restart.1.txt @@ -62,9 +62,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-shell.1 b/share/man/container-shell.1 new file mode 100644 index 0000000..2edcb42 --- /dev/null +++ b/share/man/container-shell.1 @@ -0,0 +1,74 @@ +'\" t +.\" Title: container +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER" "1" "20161112" "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-shell \- Manage systemd\-nspawn containers (shell) +.SH "SYNOPSIS" +.sp +\fBcontainer\-shell\fR +.SH "DESCRIPTION" +.sp +container\-tools provides the system integration for managing containers using systemd\-nspawn\&. +.SH "COMMANDS" +.sp +All container commands are available, see container(1)\&. Additionally, the following commands are specific to container\-shell: +.PP +\fBabout:\fR +.RS 4 +shows introduction (manpage)\&. +.RE +.PP +\fBhelp:\fR +.RS 4 +shows available commands within the container\-shell\&. +.RE +.PP +\fBhelp COMMAND:\fR +.RS 4 +shows help (manpage) for a specific container command\&. +.RE +.PP +\fBlogout\fR, \fBexit:\fR +.RS 4 +exits container\-shell\&. +.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>\&. diff --git a/share/man/container-shell.1.txt b/share/man/container-shell.1.txt index f7e0270..1059d0e 100644 --- a/share/man/container-shell.1.txt +++ b/share/man/container-shell.1.txt @@ -65,9 +65,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-start.1 b/share/man/container-start.1 new file mode 100644 index 0000000..0b83d27 --- /dev/null +++ b/share/man/container-start.1 @@ -0,0 +1,70 @@ +'\" t +.\" Title: container-start +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-START" "1" "20161112" "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-start \- Start a container +.SH "SYNOPSIS" +.sp +\fBcontainer start\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The container start command starts a container\&. +.SH "OPTIONS" +.sp +The following container options are available: +.PP +\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR +.RS 4 +Specify container name\&. +.RE +.PP +\fB\-f, \-\-force\*(Aq\fR +.RS 4 +Removing stray lock file if existing\&. +.RE +.SH "EXAMPLES" +.PP +\fBStart example\&.net container:\fR +.RS 4 +sudo container start \-n example\&.net +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-start.1.txt b/share/man/container-start.1.txt index bf1d8de..a225a7c 100644 --- a/share/man/container-start.1.txt +++ b/share/man/container-start.1.txt @@ -65,9 +65,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-status.1 b/share/man/container-status.1 new file mode 100644 index 0000000..026d01b --- /dev/null +++ b/share/man/container-status.1 @@ -0,0 +1,65 @@ +'\" t +.\" Title: container-status +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-STATUS" "1" "20161112" "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-status \- Show container status +.SH "SYNOPSIS" +.sp +\fBcontainer status\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The container\-status command displays the status of a container\&. +.SH "OPTIONS" +.sp +The following container\-status options are available: +.PP +\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR +.RS 4 +Specify container name\&. +.RE +.SH "EXAMPLES" +.PP +\fBshow status of example\&.net container:\fR +.RS 4 +sudo container status \-n example\&.net +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-status.1.txt b/share/man/container-status.1.txt index f1688dc..db81d3b 100644 --- a/share/man/container-status.1.txt +++ b/share/man/container-status.1.txt @@ -62,9 +62,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-stop.1 b/share/man/container-stop.1 new file mode 100644 index 0000000..f0e84ec --- /dev/null +++ b/share/man/container-stop.1 @@ -0,0 +1,75 @@ +'\" t +.\" Title: container-stop +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-STOP" "1" "20161112" "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-stop \- Stop a container +.SH "SYNOPSIS" +.sp +\fBcontainer stop\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The container stop command stops a container by running the proper shutdown sequence\&. +.SH "OPTIONS" +.sp +The following container options are available: +.PP +\fB\-n, \-\-name=\fR\fB\fINAME\fR\fR +.RS 4 +Specify container name\&. +.RE +.PP +\fB\-f, \-\-force\fR +.RS 4 +Instead of running the proper shutdown sequence, terminate all processes of the container imediatly\&. +.RE +.SH "EXAMPLES" +.PP +\fBShutdown example\&.net container:\fR +.RS 4 +sudo container stop \-n example\&.net +.RE +.PP +\fBImmediately stop example\&.net container:\fR +.RS 4 +sudo container stop \-n example\&.net \-f +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-stop.1.txt b/share/man/container-stop.1.txt index 7531f1c..6113fd5 100644 --- a/share/man/container-stop.1.txt +++ b/share/man/container-stop.1.txt @@ -68,9 +68,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container-tools.7 b/share/man/container-tools.7 new file mode 100644 index 0000000..273abbd --- /dev/null +++ b/share/man/container-tools.7 @@ -0,0 +1,281 @@ +'\" t +.\" Title: container-tools +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-TOOLS" "7" "20161112" "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-tools \- Manage systemd\-nspawn containers +.SH "DESCRIPTION" +.PP +"[A Linux container] is an operating\-system\-level virtualization environment for running multiple isolated Linux systems (containers) on a single Linux control host\&." +.RS 4 + \(em Wikipedia (https://en\&.wikipedia\&.org/wiki/LXC) +.RE +.sp +container\-tools provides the system integration for managing containers using systemd\-nspawn\&. +.SH "DOWNLOAD" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Upstream Releases: +https://files\&.open\-infrastructure\&.net/software/container\-tools/upstream +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Upstream Sources: +https://sources\&.open\-infrastructure\&.net/software/container\-tools +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Debian Releases: +https://files\&.open\-infrastructure\&.net/software/container\-tools/debian +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Debian Sources: +https://sources\&.progress\-linux\&.org/users/daniel/debian/packages/open\-infrastructure\-container\-tools +.RE +.SH "INSTALLATION" +.SS "SOURCE" +.sp +.RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +sudo apt install asciidoc git docbook\-xml docbook\-xsl libxml2\-utils make xsltproc dbus systemd\-container +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +git clone +https://sources\&.open\-infrastructure\&.net/software/container\-tools +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 3.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 3." 4.2 +.\} +cd container\-tools && sudo make install +.RE +.SS "DEBIAN 9 (STRETCH) AND NEWER" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +sudo apt install container\-tools +.RE +.SH "DEVELOPMENT" +.sp +Bug reports, feature requests, help, patches, support and everything else are welcome on the Open Infrastructure Software Mailing List: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +https://lists\&.open\-infrastructure\&.net/listinfo/software +.RE +.sp +Please base patches against the \fInext\fR Git branch using common sense: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +https://www\&.kernel\&.org/doc/Documentation/SubmittingPatches +.RE +.sp +Debian specific bugs can also be reported in the Debian Bug Tracking System: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +https://bugs\&.debian\&.org +.RE +.SH "KNOWN LIMITATIONS" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +This version of container\-tools currently do not work with systemd\-networkd and depend on ifupdown\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Using overlay, the upper directory can not be an NFS mount due to limitations in Linux\*(Aq overlay filesystem, see +https://git\&.kernel\&.org/cgit/linux/kernel/git/torvalds/linux\&.git/tree/Documentation/filesystems/overlayfs\&.txt +.RE +.SH "USAGE" +.PP +\fBCreate a new container:\fR +.RS 4 +sudo container create \-n NAME +.RE +.PP +\fBStart a container:\fR +.RS 4 +sudo container start \-n NAME +.RE +.PP +\fBStop a container:\fR +.RS 4 +sudo container stop \-n NAME +.RE +.PP +\fBRemove a container:\fR +.RS 4 +sudo container remove \-n NAME +.RE +.PP +\fBList container on the system:\fR +.RS 4 +sudo container list +.RE +.PP +\fBShow container\-tools version:\fR +.RS 4 +container version +.RE +.sp +See container(1) for a list of all container commands\&. +.SH "LINKS" +.PP +\fB2016\-02\-24: Systemd vs\&. Docker\fR +.RS 4 +https://lwn\&.net/Articles/676831/ +.RE +.PP +\fB2015\-06\-10: Systemd and containers\fR +.RS 4 +https://lwn\&.net/Articles/647634/ +.RE +.PP +\fB2014\-07\-07: Control groups\fR +.RS 4 +https://lwn\&.net/Articles/604609/ +.RE +.PP +\fB2013\-11\-13: Systemd\-Nspawn is Chroot on Steroids [LinuxCon Europe]\fR +.RS 4 +https://www\&.youtube\&.com/watch?v=s7LlUs5D9p4 +.RE +.PP +\fB2013\-11\-03: Creating containers with systemd\-nspawn\fR +.RS 4 +https://lwn\&.net/Articles/572957/ +.RE +.PP +\fB2013\-02\-06: Systemd lightweight containers\fR +.RS 4 +https://lwn\&.net/Articles/536033/ +.RE +.PP +\fB2013\-01\-04: Namespaces in operation\fR +.RS 4 +https://lwn\&.net/Articles/531114/ +.RE +.SH "AUTHORS" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Daniel Baumann <daniel\&.baumann@open\-infrastructure\&.net> +.RE diff --git a/share/man/container-tools.7.txt b/share/man/container-tools.7.txt index 23f8403..b6c83d6 100644 --- a/share/man/container-tools.7.txt +++ b/share/man/container-tools.7.txt @@ -37,7 +37,6 @@ container-tools provides the system integration for managing containers using sy DOWNLOAD -------- - * Upstream Releases: https://files.open-infrastructure.net/software/container-tools/upstream * Upstream Sources: https://sources.open-infrastructure.net/software/container-tools * Debian Releases: https://files.open-infrastructure.net/software/container-tools/debian @@ -49,20 +48,17 @@ INSTALLATION SOURCE ~~~~~~ - 1. sudo apt install asciidoc git docbook-xml docbook-xsl libxml2-utils make xsltproc dbus systemd-container 2. git clone https://sources.open-infrastructure.net/software/container-tools 3. cd container-tools && sudo make install DEBIAN 9 (STRETCH) AND NEWER ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - * sudo apt install container-tools DEVELOPMENT ----------- - Bug reports, feature requests, help, patches, support and everything else are welcome on the Open Infrastructure Software Mailing List: @@ -79,7 +75,6 @@ Debian specific bugs can also be reported in the Debian Bug Tracking System: KNOWN LIMITATIONS ----------------- - * This version of container-tools currently do not work with systemd-networkd and depend on ifupdown. * Using overlay, the upper directory can not be an NFS mount due to limitations in Linux' overlay filesystem, see https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/filesystems/overlayfs.txt @@ -87,7 +82,6 @@ KNOWN LIMITATIONS USAGE ----- - *Create a new container:*:: sudo container create -n NAME @@ -111,7 +105,6 @@ See container(1) for a list of all container commands. LINKS ----- - *2016-02-24: Systemd vs. Docker*:: https://lwn.net/Articles/676831/ @@ -136,5 +129,4 @@ LINKS AUTHORS ------- - * Daniel Baumann <daniel.baumann@open-infrastructure.net> diff --git a/share/man/container-version.1 b/share/man/container-version.1 new file mode 100644 index 0000000..08157d6 --- /dev/null +++ b/share/man/container-version.1 @@ -0,0 +1,62 @@ +'\" t +.\" Title: container-version +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-VERSION" "1" "20161112" "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-version \- Show container\-tools version +.SH "SYNOPSIS" +.sp +\fBcontainer version\fR [\fIOPTIONS\fR] +.sp +\fBcontainer ver\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The container version command shows the container\-tools version number\&. +.SH "OPTIONS" +.sp +This command has no options\&. +.SH "EXAMPLES" +.PP +\fBShow container\-tools version:\fR +.RS 4 +container version +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(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>\&. diff --git a/share/man/container-version.1.txt b/share/man/container-version.1.txt index 9b0ae5e..d4a8713 100644 --- a/share/man/container-version.1.txt +++ b/share/man/container-version.1.txt @@ -61,9 +61,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS diff --git a/share/man/container.1 b/share/man/container.1 new file mode 100644 index 0000000..3d71ac7 --- /dev/null +++ b/share/man/container.1 @@ -0,0 +1,150 @@ +'\" t +.\" Title: container +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER" "1" "20161112" "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] +.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 +\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 +\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 +\fBversion\fR +.RS 4 +Show container\-tools version, see container\-version(1)\&. +.RE +.SH "FILES" +.sp +The following files are used: +.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 +.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>\&. diff --git a/share/man/container.1.txt b/share/man/container.1.txt index 32bd393..aea09c4 100644 --- a/share/man/container.1.txt +++ b/share/man/container.1.txt @@ -117,9 +117,12 @@ HOMEPAGE More information about container-tools and the Open Infrastructure project can be found on the homepage at https://open-infrastructure.net. -BUGS ----- -Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org. +CONTACT +------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List software@lists.open-infrastructure.net. + +Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org. AUTHORS |