From 567de5f602693271f610e4052138da7dfecabe1f Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 13 Jul 2016 09:50:12 +0200 Subject: i18n manpages (FIXME). Signed-off-by: Daniel Baumann --- share/man/Makefile | 26 +++- share/man/Makefile.old | 33 ++++++ share/man/bin/update-version.sh | 46 ++++++++ share/man/container-auto.1.txt | 78 ------------ share/man/container-console.1.txt | 72 ----------- share/man/container-create-debconf.1.txt | 151 ------------------------ share/man/container-create-debootstrap.1.txt | 93 --------------- share/man/container-create.1.txt | 100 ---------------- share/man/container-enter.1.txt | 75 ------------ share/man/container-limit.1.txt | 105 ---------------- share/man/container-list.1.txt | 92 --------------- share/man/container-remove.1.txt | 78 ------------ share/man/container-restart.1.txt | 72 ----------- share/man/container-shell.1.txt | 75 ------------ share/man/container-start.1.txt | 72 ----------- share/man/container-status.1.txt | 72 ----------- share/man/container-stop.1.txt | 78 ------------ share/man/container-tools.7.txt | 133 --------------------- share/man/container-version.1.txt | 69 ----------- share/man/container.1.txt | 127 -------------------- share/man/en/container-auto.1.txt | 78 ++++++++++++ share/man/en/container-console.1.txt | 72 +++++++++++ share/man/en/container-create-debconf.1.txt | 151 ++++++++++++++++++++++++ share/man/en/container-create-debootstrap.1.txt | 93 +++++++++++++++ share/man/en/container-create.1.txt | 100 ++++++++++++++++ share/man/en/container-enter.1.txt | 75 ++++++++++++ share/man/en/container-limit.1.txt | 105 ++++++++++++++++ share/man/en/container-list.1.txt | 92 +++++++++++++++ share/man/en/container-remove.1.txt | 78 ++++++++++++ share/man/en/container-restart.1.txt | 72 +++++++++++ share/man/en/container-shell.1.txt | 75 ++++++++++++ share/man/en/container-start.1.txt | 72 +++++++++++ share/man/en/container-status.1.txt | 72 +++++++++++ share/man/en/container-stop.1.txt | 78 ++++++++++++ share/man/en/container-tools.7.txt | 133 +++++++++++++++++++++ share/man/en/container-version.1.txt | 69 +++++++++++ share/man/en/container.1.txt | 127 ++++++++++++++++++++ 37 files changed, 1642 insertions(+), 1547 deletions(-) create mode 100644 share/man/Makefile.old create mode 100755 share/man/bin/update-version.sh delete mode 100644 share/man/container-auto.1.txt delete mode 100644 share/man/container-console.1.txt delete mode 100644 share/man/container-create-debconf.1.txt delete mode 100644 share/man/container-create-debootstrap.1.txt delete mode 100644 share/man/container-create.1.txt delete mode 100644 share/man/container-enter.1.txt delete mode 100644 share/man/container-limit.1.txt delete mode 100644 share/man/container-list.1.txt delete mode 100644 share/man/container-remove.1.txt delete mode 100644 share/man/container-restart.1.txt delete mode 100644 share/man/container-shell.1.txt delete mode 100644 share/man/container-start.1.txt delete mode 100644 share/man/container-status.1.txt delete mode 100644 share/man/container-stop.1.txt delete mode 100644 share/man/container-tools.7.txt delete mode 100644 share/man/container-version.1.txt delete mode 100644 share/man/container.1.txt create mode 100644 share/man/en/container-auto.1.txt create mode 100644 share/man/en/container-console.1.txt create mode 100644 share/man/en/container-create-debconf.1.txt create mode 100644 share/man/en/container-create-debootstrap.1.txt create mode 100644 share/man/en/container-create.1.txt create mode 100644 share/man/en/container-enter.1.txt create mode 100644 share/man/en/container-limit.1.txt create mode 100644 share/man/en/container-list.1.txt create mode 100644 share/man/en/container-remove.1.txt create mode 100644 share/man/en/container-restart.1.txt create mode 100644 share/man/en/container-shell.1.txt create mode 100644 share/man/en/container-start.1.txt create mode 100644 share/man/en/container-status.1.txt create mode 100644 share/man/en/container-stop.1.txt create mode 100644 share/man/en/container-tools.7.txt create mode 100644 share/man/en/container-version.1.txt create mode 100644 share/man/en/container.1.txt (limited to 'share') diff --git a/share/man/Makefile b/share/man/Makefile index decf333..86790db 100644 --- a/share/man/Makefile +++ b/share/man/Makefile @@ -22,22 +22,38 @@ A2X = a2x \ --asciidoc-opts "-a revdate=$(shell cat ../../VERSION.txt)" \ --doctype=manpage +LANGUAGES := $(shell cd po && ls) + SHELL := sh -e all: build clean: - rm -f *.[0-9] - rm -f *.xml + rm -f en/*.[0-9] + rm -f en/*.xml + rm -rf $(LANGUAGES) + +distclean: clean + rm -f po4a.cfg -build: man +build: po4a.cfg man rebuild: clean build -man: *.txt +po4a.cfg: en/*.txt + echo "[po4a_langs] $(LANGUAGES)" > po4a.cfg + echo "[po4a_paths] pot/\$$master.pot \$$lang:po/\$$lang/\$$master.po" >> po4a.cfg + + for FILE in en/*; \ + do \ + SECTION="$$(basename $${FILE} | sed -e 's|\.|\n|g' | tail -n1)"; \ + echo "[type: asciidoc] $${FILE} \$$lang:\$$lang/$$(basename $${FILE} .$${SECTION}).\$$lang.$${SECTION}" >> po4a.cfg; \ + done + +man: en/*.txt for FILE in *.txt; \ do \ $(A2X) --format=manpage $${FILE}; \ done -.PHONY: all clean build rebuild man +.PHONY: all clean distclean build rebuild po4a.cfg man diff --git a/share/man/Makefile.old b/share/man/Makefile.old new file mode 100644 index 0000000..ea32a87 --- /dev/null +++ b/share/man/Makefile.old @@ -0,0 +1,33 @@ +# Makefile + +update: + ./bin/update-version.sh + +build: check po4a.cfg + @if [ ! -x "$$(which po4a 2>/dev/null)" ]; \ + then \ + echo "E: po4a - command not found"; \ + echo "I: po4a can be obtained from:"; \ + echo "I: http://po4a.alioth.debian.org/"; \ + echo "I: On Debian based systems, po4a can be installed with:"; \ + echo "I: apt-get install po4a"; \ + exit 1; \ + fi + + po4a --copyright-holder "Open Infrastructure" --keep 0 --package-name container-tools --package-version $(shell cat ../../VERSION.txt) po4a.cfg + +check: + @echo -n "Checking the integrity of .po files " + + @if [ -x /usr/bin/msgfmt ]; \ + then \ + for POFILE in po/*/*; \ + do \ + msgfmt --check --output-file=/dev/null $${POFILE}; \ + echo -n "."; \ + done; \ + else \ + echo "WARNING: skipping po integrity check. You must install gettext."; \ + fi + + @echo " done!" diff --git a/share/man/bin/update-version.sh b/share/man/bin/update-version.sh new file mode 100755 index 0000000..1ddb2da --- /dev/null +++ b/share/man/bin/update-version.sh @@ -0,0 +1,46 @@ +#!/bin/sh + +set -e + +PROGRAM="CONTAINER\\\-TOOLS" +VERSION="$(cat ../../../VERSION.txt)" + +DATE="$(LC_ALL=C date +%Y\\\\-%m\\\\-%d)" + +DAY="$(LC_ALL=C date +%d)" +MONTH="$(LC_ALL=C date +%m)" +YEAR="$(LC_ALL=C date +%Y)" + +echo "Updating version headers..." + +for MANPAGE in en/* +do + SECTION="$(basename ${MANPAGE} | awk -F. '{ print $2 }')" + + sed -i -e "s|^.TH.*$|.TH ${PROGRAM} ${SECTION} ${DATE} ${VERSION} \"Open Infratructure\"|" ${MANPAGE} +done + +# European date format +for _LANGUAGE in de es fr it +do + if ls po/${_LANGUAGE}/*.po > /dev/null 2>&1 + then + for _FILE in po/${_LANGUAGE}/*.po + do + sed -i -e "s|^msgstr .*.2016-.*$|msgstr \"${DAY}.${MONTH}.${YEAR}\"|g" \ + -e "s|^msgstr .*.2016\"$|msgstr \"${DAY}.${MONTH}.${YEAR}\"|g" \ + "${_FILE}" + done + fi +done + +# Brazilian date format +if ls po/pt_BR/*.po > /dev/null 2>&1 +then + for _FILE in po/pt_BR/*.po + do + sed -i -e "s|^msgstr .*.2016-.*$|msgstr \"${DAY}-${MONTH}-${YEAR}\"|g" \ + -e "s|^msgstr .*-2016\"$|msgstr \"${DAY}-${MONTH}-${YEAR}\"|g" \ + "${_FILE}" + done +fi diff --git a/share/man/container-auto.1.txt b/share/man/container-auto.1.txt deleted file mode 100644 index a1f1ab3..0000000 --- a/share/man/container-auto.1.txt +++ /dev/null @@ -1,78 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER-START(1) -================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-auto - Start/stop all container automatically at boot/shutdown - - -SYNOPSIS --------- -*container auto* ['OPTIONS'] - - -DESCRIPTION ------------ -The container auto command starts or stops all container on the host system. - - -OPTIONS -------- -The following container options are available: - -*-s, --start*:: - Start all container on the host system. - -*-t, --stop*:: - Stop all container on the host system. - - -EXAMPLES --------- -*Start all container on the host system:*:: - sudo container auto --start - -*Stop all container on the host system:*:: - sudo container auto --stop - - -SEE ALSO --------- -container-tools(7), -container(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container-console.1.txt b/share/man/container-console.1.txt deleted file mode 100644 index 410ff92..0000000 --- a/share/man/container-console.1.txt +++ /dev/null @@ -1,72 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER-CONSOLE(1) -==================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-console - Attach a console to a container - - -SYNOPSIS --------- -*container console* ['OPTIONS'] - - -DESCRIPTION ------------ -The container console command attaches a console to a container. - - -OPTIONS -------- -The following container options are available: - -*-n, --name='NAME'*:: - Specify container name. - - -EXAMPLES --------- -*Attach console to example.net container:*:: - sudo container console -n example.net - - -SEE ALSO --------- -container-tools(7), -container(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container-create-debconf.1.txt b/share/man/container-create-debconf.1.txt deleted file mode 100644 index 76f86cc..0000000 --- a/share/man/container-create-debconf.1.txt +++ /dev/null @@ -1,151 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER-CREATE-DEBOOTSTRAP(1) -=============================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-create-debconf - Create an advanced Debian based container with debconf - - -SYNOPSIS --------- -*container create -s debconf* ['OPTIONS'] -*container create -s debian* ['OPTIONS'] -*container create -s progress-linux* ['OPTIONS'] - - -DESCRIPTION ------------ -The debconf container creation script uses debconf(1) to automatically create a Debian based container. - -SCOPE -~~~~~ -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. - -But: this is *not* 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. - -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) - -FUNCTIONS -~~~~~~~~~ - -This script performs the following configuration on top of a Debian based system: - - * network - * root password - * apt repositories - * ... - -MODES -~~~~~ -This container creation script can be used under two different names: debian and progress-linux. - -Alternative, calling it under the debconf name is equal to the debian mode. - -INTERACTIVE/NONINTERACTIVE -~~~~~~~~~~~~~~~~~~~~~~~~~~ -FIXME - -PRESEEDING -~~~~~~~~~~ - -Hierarchy of Preseed Files - -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). - -The general rule of 'the later preseed file overwrites the earlier' 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. - -That means that debconf values after the include statement in the main preseed -file can overwrite any values specified in the included preseed files. - - -OPTIONS -------- -The following script options are available: - -*-n, --name='NAME'*:: - Specify container name. - -*-p, --preseed-file='FILE'*:: - Specify the preseed file. - - -EXAMPLES --------- -*Create a Debian based container:*:: - sudo container create -s debian -n jessie.example.net - -*Create a Progress Linux container:*:: - sudo container create -s progress-linux -n cairon-backports.example.net - - -FILES ------ -The following files are used: - -*/etc/container-tools/config*:: - Container configuration files. - -*/usr/share/container-tools/scripts*:: - Container creation scripts. - -*/usr/share/doc/container-tools*:: - Container documentation. - -*/var/lib/machines*:: - Container directory. - -*/var/cache/container-tools*:: - Container cache directory. - -*/tmp/container-tools*:: - Container temporary directory. - - -SEE ALSO --------- -container-tools(7), -container(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container-create-debootstrap.1.txt b/share/man/container-create-debootstrap.1.txt deleted file mode 100644 index 3377ea0..0000000 --- a/share/man/container-create-debootstrap.1.txt +++ /dev/null @@ -1,93 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER-CREATE-DEBOOTSTRAP(1) -=============================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-create-debootstrap - Create a basic Debian based container with debootstrap - - -SYNOPSIS --------- -*container create -s debootstrap* ['OPTIONS'] - - -DESCRIPTION ------------ -The debootstrap container creation script uses debootstrap(8) to create a Debian based container. - -This script creates a pure Debian system with three modificiations: - - * apt cache of packages downloaded during debootstrap is cleaned - * hostname is set (container name) in /etc/hostname - * root password is set (user specified or 16 random characters) - - -OPTIONS -------- -The following script options are available: - -*-n, --name='NAME'*:: - Specify container name. - -*-a, --architecture='ARCHITECTURE'*:: - Specify the Debian architecture, defaults to the host systems architecture. - -*-d, --distribution='DISTRIBUTION'*:: - Specify the Debian distribution, defaults to jessie. - -*-m, --mirror='MIRROR'*:: - Specify the Debian mirror, defaults to http://ftp.debian.org/debian. - -*-p, --root-password='PASSWORD'*:: - Specify the root password, defaults to a random 16 character password. - - -EXAMPLES --------- -*Create a Debian 8 (jessie) based container with same architecture as the host system:*:: - sudo container create -s debootstrap -n jessie.example.net - -*Create a Debian 8 (jessie) based container with different architecture as the host system:*:: - sudo container create -s debootstrap -n jessie-i386.example.net -- -a i386 - - -SEE ALSO --------- -container-tools(7), -container(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container-create.1.txt b/share/man/container-create.1.txt deleted file mode 100644 index b7a4f01..0000000 --- a/share/man/container-create.1.txt +++ /dev/null @@ -1,100 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER-CREATE(1) -=================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-create - Create a container - - -SYNOPSIS --------- -*container create* ['OPTIONS'] - - -DESCRIPTION ------------ -The container-create command creates a container based on a script. - - -OPTIONS -------- -The following container-create options are available: - -*-n, --name='NAME'*:: - Specify container name. - -*-c, --capability='CAPABILITY'*:: - Specify capabilities to grant, see capabilities(7). - -*-d, --drop-capability='DROP_CAPABILITY'*:: - Specify capabilities to drop, see capabilities(7). - -*-s, --script='SCRIPT'*:: - Specify container creation script, defaults to debootstrap. - -*-b, --bind='DIRECTORY:DIRECTORY[:OPTIONS][;DIRECTORY:DIRECTORY[:OPTIONS]]'*:: - Specify container bind mounts, see systemd-nspawn(1) --bind option. - - -SCRIPTS -------- -The following container scripts are available: - -*debootstrap*:: - Basic script to create Debian based container, see container-create-debootstrap(1). - -*debconf*:: - Advanced script to automatically create Debian based container, see container-create-debconf(1). - -*default*:: - 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. 'sudo update-alternatives --config container-tools_script'. - - -EXAMPLES --------- -*Create example.net container using debootstrap script:*:: - sudo container create -n example.net -s debootstrap - -*Create example.net container using debconf script:*:: - sudo container create -n example.net -s debconf - -SEE ALSO --------- -container-tools(7), -container(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container-enter.1.txt b/share/man/container-enter.1.txt deleted file mode 100644 index 792cac7..0000000 --- a/share/man/container-enter.1.txt +++ /dev/null @@ -1,75 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER-CONSOLE(1) -==================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-enter - Enter a container namespace - - -SYNOPSIS --------- -*container enter* ['OPTIONS'] [-- COMMAND|"COMMANDS"] - - -DESCRIPTION ------------ -The container enter enters a container namespace. - - -OPTIONS -------- -The following container options are available: - -*-n, --name='NAME'*:: - Specify container name. - - -EXAMPLES --------- -*Enter to example.net container namespace:*:: - sudo container enter -n example.net - -*Execute 'ip a' in example.net container namespace:*:: - sudo container enter -n example.net -- 'ip a' - - -SEE ALSO --------- -container-tools(7), -container(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container-limit.1.txt b/share/man/container-limit.1.txt deleted file mode 100644 index 0ba5b74..0000000 --- a/share/man/container-limit.1.txt +++ /dev/null @@ -1,105 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER-LIMIT(1) -================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-limit - Limit ressources of a container - - -SYNOPSIS --------- -*container limit* ['OPTIONS'] - - -DESCRIPTION ------------ -The container limit command limits ressources available to a container at runtime. - - -OPTIONS -------- -The following container options are available: - -*-n, --name='NAME'*:: - Specify container name. - -*--blockio-device-weight='DEVICE WEIGHT'*:: - Specify device specific blockio weight, see systemd.resource-control(5). - -*--blockio-read-bandwith='DEVICE BYTES'*:: - Specify device specific blockio read bandwith, see systemd.resource-control(5). - -*-b, --blockio-weight='WEIGHT'*:: - Specify general blockio weight, see systemd.resource-control(5). - -*--blockio-write-bandwith='DEVICE BYTES'*:: - Specify device specific blockio write bandwith, see systemd.resource-control(5). - -*-c, --cpu-quota='QUOTA'*:: - Specify CPU quota, see systemd.resource-control(5). - -*--cpu-shares='SHARES'*:: - Specify CPU shares, see systemd.resource-control(5). - -*-m, --memory-limit='BYTES'*:: - Specify memory limit, see systemd.resource-control(5). - -*-t, --tasks-max='NUMBER'*:: - Specify tasks max, see systemd.resource-control(5). - - -EXAMPLES --------- -*Set blockio weight for the example.net container:*:: - sudo container limit -n example.net --blockio-weight 100 - -*Set CPU quota for the example.net container:*:: - sudo container limit -n example.net --cpu-quota 10% - -*Set memory limit for the example.net container to 1GB:*:: - sudo container limit -n example.net --memory-limit 1G - -*Set tasks max for the example.net container to 100:*:: - sudo container limit -n example.net --tasks-max 100 - - -SEE ALSO --------- -container-tools(7), -container(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container-list.1.txt b/share/man/container-list.1.txt deleted file mode 100644 index 8ac59c2..0000000 --- a/share/man/container-list.1.txt +++ /dev/null @@ -1,92 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER-LIST(1) -================= -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-list - List container on the system - - -SYNOPSIS --------- -*container list* ['OPTIONS'] - - -DESCRIPTION ------------ -The container list command lists container on the system. - - -OPTIONS -------- -The following container options are available, defaults to *--started --stopped*: - -*-a, --all*:: - List all available container (started, stopped, and other). - -*-f, --format='FORMAT'*:: - Use format to list container. Currently available formats are 'short' or 'full' (default). - -*-h, --host='HOSTNAME'*:: - List only container that are enabled for automatic start on the specified hostname. Defaults to list containers of the local system only. Using 'all' shows all container regardless of any automatic start configuration. - -*-o, --other*:: - List only container that are not enable for automatic start on the current system. - -*-s, --started*:: - List only started container. - -*-t, --stopped*:: - List only stopped container. - -EXAMPLES --------- -*List all started and stopped containers of the local system:*:: - sudo container list - -*List all started and stopped containers of the local system as a machine-readable list:*:: - sudo container list -f short - -*List all started and other containers:*:: - sudo container list -s -o - - -SEE ALSO --------- -container-tools(7), -container(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container-remove.1.txt b/share/man/container-remove.1.txt deleted file mode 100644 index cb9b77f..0000000 --- a/share/man/container-remove.1.txt +++ /dev/null @@ -1,78 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER-REMOVE(1) -=================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-remove - Remove a container - - -SYNOPSIS --------- -*container remove* ['OPTIONS'] - - -DESCRIPTION ------------ -The container remove command removes a container. - - -OPTIONS -------- -The following container options are available: - -*-n, --name='NAME'*:: - Specify container name. - -*-f, --force*:: - Do not prompt before removal. - - -EXAMPLES --------- -*Remove example.net container from the system:*:: - sudo container remove -n example.net - -*Remove example.net container from the system without prompt:*:: - sudo container remove -n example.net -f - - -SEE ALSO --------- -container-tools(7), -container(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container-restart.1.txt b/share/man/container-restart.1.txt deleted file mode 100644 index eda0174..0000000 --- a/share/man/container-restart.1.txt +++ /dev/null @@ -1,72 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER-RESTART(1) -==================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-restart - Restart a container - - -SYNOPSIS --------- -*container restart* ['OPTIONS'] - - -DESCRIPTION ------------ -The container restart command restarts a container. - - -OPTIONS -------- -The following container options are available: - -*-n, --name='NAME'*:: - Specify container name. - - -EXAMPLES --------- -*Restart example.net container:*:: - sudo container restart -n example.net - - -SEE ALSO --------- -container-tools(7), -container(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container-shell.1.txt b/share/man/container-shell.1.txt deleted file mode 100644 index f7e0270..0000000 --- a/share/man/container-shell.1.txt +++ /dev/null @@ -1,75 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER(1) -============ -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-shell - Manage systemd-nspawn containers (shell) - - -SYNOPSIS --------- -*container-shell* - - -DESCRIPTION ------------ -container-tools provides the system integration for managing containers using systemd-nspawn. - - -COMMANDS --------- -All container commands are available, see container(1). Additionally, the following commands are specific to container-shell: - -*about:*:: - shows introduction (manpage). - -*help:*:: - shows available commands within the container-shell. - -*help COMMAND:*:: - shows help (manpage) for a specific container command. - -*logout*, *exit:*:: - exits container-shell. - - -SEE ALSO --------- -machinectl(1), -systemd-nspawn(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container-start.1.txt b/share/man/container-start.1.txt deleted file mode 100644 index 313587d..0000000 --- a/share/man/container-start.1.txt +++ /dev/null @@ -1,72 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER-START(1) -================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-start - Start a container - - -SYNOPSIS --------- -*container start* ['OPTIONS'] - - -DESCRIPTION ------------ -The container start command starts a container. - - -OPTIONS -------- -The following container options are available: - -*-n, --name='NAME'*:: - Specify container name. - - -EXAMPLES --------- -*Start example.net container:*:: - sudo container start -n example.net - - -SEE ALSO --------- -container-tools(7), -container(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container-status.1.txt b/share/man/container-status.1.txt deleted file mode 100644 index f1688dc..0000000 --- a/share/man/container-status.1.txt +++ /dev/null @@ -1,72 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2016 Simon Spöehel -// -// 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 . - -CONTAINER-STATUS(1) -=================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-status - Show container status - - -SYNOPSIS --------- -*container status* ['OPTIONS'] - - -DESCRIPTION ------------ -The container-status command displays the status of a container. - - -OPTIONS -------- -The following container-status options are available: - -*-n, --name='NAME'*:: - Specify container name. - - -EXAMPLES --------- -*show status of example.net container:*:: - sudo container status -n example.net - - -SEE ALSO --------- -container-tools(7), -container(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container-stop.1.txt b/share/man/container-stop.1.txt deleted file mode 100644 index 7531f1c..0000000 --- a/share/man/container-stop.1.txt +++ /dev/null @@ -1,78 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER-STOP(1) -================= -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-stop - Stop a container - - -SYNOPSIS --------- -*container stop* ['OPTIONS'] - - -DESCRIPTION ------------ -The container stop command stops a container by running the proper shutdown sequence. - - -OPTIONS -------- -The following container options are available: - -*-n, --name='NAME'*:: - Specify container name. - -*-f, --force*:: - Instead of running the proper shutdown sequence, terminate all processes of the container imediatly. - - -EXAMPLES --------- -*Shutdown example.net container:*:: - sudo container stop -n example.net - -*Immediately stop example.net container:*:: - sudo container stop -n example.net -f - - -SEE ALSO --------- -container-tools(7), -container(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container-tools.7.txt b/share/man/container-tools.7.txt deleted file mode 100644 index 604683f..0000000 --- a/share/man/container-tools.7.txt +++ /dev/null @@ -1,133 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER-TOOLS(7) -================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-tools - Manage systemd-nspawn containers - - -DESCRIPTION ------------ -"[A Linux container] is an operating-system-level virtualization environment for running multiple isolated Linux systems (containers) on a single Linux control host.":: - -- Wikipedia (https://en.wikipedia.org/wiki/LXC) - -container-tools provides the system integration for managing containers using systemd-nspawn. - - -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 - * Debian Sources: https://sources.progress-linux.org/users/daniel/debian/packages/open-infrastructure-container-tools - - -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, and patches are welcome via Debian Bug Tracking System: - - * https://bugs.debian.org - -Please base them against the 'next' Git branch using common sense: - - * https://www.kernel.org/doc/Documentation/SubmittingPatches - - -KNOWN LIMITATIONS ------------------ - -container-tools currently do not work with systemd-networkd and depend on ifupdown. - - -USAGE ------ - -*Create a new container:*:: - sudo container create -n NAME - -*Start a container:*:: - sudo container start -n NAME - -*Stop a container:*:: - sudo container stop -n NAME - -*Remove a container:*:: - sudo container remove -n NAME - -*List container on the system:*:: - sudo container list - -*Show container-tools version:*:: - container version - -See container(1) for a list of all container commands. - - -LINKS ------ - -*2016-02-24: Systemd vs. Docker*:: - https://lwn.net/Articles/676831/ - -*2015-06-10: Systemd and containers*:: - https://lwn.net/Articles/647634/ - -*2014-07-07: Control groups*:: - https://lwn.net/Articles/604609/ - -*2013-11-13: Systemd-Nspawn is Chroot on Steroids [LinuxCon Europe]*:: - https://www.youtube.com/watch?v=s7LlUs5D9p4 - -*2013-11-03: Creating containers with systemd-nspawn*:: - https://lwn.net/Articles/572957/ - -*2013-02-06: Systemd lightweight containers*:: - https://lwn.net/Articles/536033/ - -*2013-01-04: Namespaces in operation*:: - https://lwn.net/Articles/531114/ - - -AUTHORS -------- - - * Daniel Baumann diff --git a/share/man/container-version.1.txt b/share/man/container-version.1.txt deleted file mode 100644 index 5e50ad4..0000000 --- a/share/man/container-version.1.txt +++ /dev/null @@ -1,69 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER-VERSION(1) -==================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container-version - Show container-tools version - - -SYNOPSIS --------- -*container version* ['OPTIONS'] - - -DESCRIPTION ------------ -The container version command shows the container-tools version number. - - -OPTIONS -------- -This command has no options. - - -EXAMPLES --------- -*Show container-tools version:*:: - container version - - -SEE ALSO --------- -container-tools(7), -container(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/container.1.txt b/share/man/container.1.txt deleted file mode 100644 index 32bd393..0000000 --- a/share/man/container.1.txt +++ /dev/null @@ -1,127 +0,0 @@ -// container-tools - Manage systemd-nspawn containers -// Copyright (C) 2014-2016 Daniel Baumann -// -// 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 . - -CONTAINER(1) -============ -:doctype: manpage -:man manual: Open Infrastructure -:man source: container-tools -:man version: {revnumber} - - -NAME ----- -container - Manage systemd-nspawn containers - - -SYNOPSIS --------- -*container* 'COMMAND' ['OPTIONS'] - - -DESCRIPTION ------------ -container-tools provides the system integration for managing containers using systemd-nspawn. - - -OPTIONS -------- -The following container common options are available: - -*-n, --name='NAME'*:: - Specify container name. - - -COMMANDS --------- -The following container commands are available: - -*create*:: - Create a new container, see container-create(1). - -*start*:: - Start a container, see container-start(1). - -*restart*:: - Restart a container, see container-restart(1). - -*stop*:: - Stop a container, see container-stop(1). - -*remove*:: - Remove a container, see container-remove(1). - -*console*:: - Attach console to a container, see container-console(1). - -*enter*:: - Enter a container namespace, see container-enter(1). - -*limit*:: - Limit ressources of a container, see container-limit(1). - -*list*:: - List container on the system, see container-list(1). - -*status*:: - Show container status, see container-status(1). - -*version*:: - Show container-tools version, see container-version(1). - - -FILES ------ -The following files are used: - -*/usr/bin/container*, */usr/bin/cnt*:: - Container program. - -*/usr/bin/container-shell*, */usr/bin/cntsh*:: - Container shell program. - -*/usr/lib/container-tools*:: - Container commands. - -*/usr/share/container-tools*:: - Container shared data. - -*/usr/share/doc/container-tools*:: - Container documentation files. - -*/var/lib/machines*:: - Container root directory. - - -SEE ALSO --------- -machinectl(1), -systemd-nspawn(1). - - -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. - - -AUTHORS -------- -container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-auto.1.txt b/share/man/en/container-auto.1.txt new file mode 100644 index 0000000..a1f1ab3 --- /dev/null +++ b/share/man/en/container-auto.1.txt @@ -0,0 +1,78 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER-START(1) +================== +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-auto - Start/stop all container automatically at boot/shutdown + + +SYNOPSIS +-------- +*container auto* ['OPTIONS'] + + +DESCRIPTION +----------- +The container auto command starts or stops all container on the host system. + + +OPTIONS +------- +The following container options are available: + +*-s, --start*:: + Start all container on the host system. + +*-t, --stop*:: + Stop all container on the host system. + + +EXAMPLES +-------- +*Start all container on the host system:*:: + sudo container auto --start + +*Stop all container on the host system:*:: + sudo container auto --stop + + +SEE ALSO +-------- +container-tools(7), +container(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-console.1.txt b/share/man/en/container-console.1.txt new file mode 100644 index 0000000..410ff92 --- /dev/null +++ b/share/man/en/container-console.1.txt @@ -0,0 +1,72 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER-CONSOLE(1) +==================== +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-console - Attach a console to a container + + +SYNOPSIS +-------- +*container console* ['OPTIONS'] + + +DESCRIPTION +----------- +The container console command attaches a console to a container. + + +OPTIONS +------- +The following container options are available: + +*-n, --name='NAME'*:: + Specify container name. + + +EXAMPLES +-------- +*Attach console to example.net container:*:: + sudo container console -n example.net + + +SEE ALSO +-------- +container-tools(7), +container(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-create-debconf.1.txt b/share/man/en/container-create-debconf.1.txt new file mode 100644 index 0000000..76f86cc --- /dev/null +++ b/share/man/en/container-create-debconf.1.txt @@ -0,0 +1,151 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER-CREATE-DEBOOTSTRAP(1) +=============================== +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-create-debconf - Create an advanced Debian based container with debconf + + +SYNOPSIS +-------- +*container create -s debconf* ['OPTIONS'] +*container create -s debian* ['OPTIONS'] +*container create -s progress-linux* ['OPTIONS'] + + +DESCRIPTION +----------- +The debconf container creation script uses debconf(1) to automatically create a Debian based container. + +SCOPE +~~~~~ +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. + +But: this is *not* 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. + +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) + +FUNCTIONS +~~~~~~~~~ + +This script performs the following configuration on top of a Debian based system: + + * network + * root password + * apt repositories + * ... + +MODES +~~~~~ +This container creation script can be used under two different names: debian and progress-linux. + +Alternative, calling it under the debconf name is equal to the debian mode. + +INTERACTIVE/NONINTERACTIVE +~~~~~~~~~~~~~~~~~~~~~~~~~~ +FIXME + +PRESEEDING +~~~~~~~~~~ + +Hierarchy of Preseed Files + +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). + +The general rule of 'the later preseed file overwrites the earlier' 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. + +That means that debconf values after the include statement in the main preseed +file can overwrite any values specified in the included preseed files. + + +OPTIONS +------- +The following script options are available: + +*-n, --name='NAME'*:: + Specify container name. + +*-p, --preseed-file='FILE'*:: + Specify the preseed file. + + +EXAMPLES +-------- +*Create a Debian based container:*:: + sudo container create -s debian -n jessie.example.net + +*Create a Progress Linux container:*:: + sudo container create -s progress-linux -n cairon-backports.example.net + + +FILES +----- +The following files are used: + +*/etc/container-tools/config*:: + Container configuration files. + +*/usr/share/container-tools/scripts*:: + Container creation scripts. + +*/usr/share/doc/container-tools*:: + Container documentation. + +*/var/lib/machines*:: + Container directory. + +*/var/cache/container-tools*:: + Container cache directory. + +*/tmp/container-tools*:: + Container temporary directory. + + +SEE ALSO +-------- +container-tools(7), +container(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-create-debootstrap.1.txt b/share/man/en/container-create-debootstrap.1.txt new file mode 100644 index 0000000..3377ea0 --- /dev/null +++ b/share/man/en/container-create-debootstrap.1.txt @@ -0,0 +1,93 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER-CREATE-DEBOOTSTRAP(1) +=============================== +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-create-debootstrap - Create a basic Debian based container with debootstrap + + +SYNOPSIS +-------- +*container create -s debootstrap* ['OPTIONS'] + + +DESCRIPTION +----------- +The debootstrap container creation script uses debootstrap(8) to create a Debian based container. + +This script creates a pure Debian system with three modificiations: + + * apt cache of packages downloaded during debootstrap is cleaned + * hostname is set (container name) in /etc/hostname + * root password is set (user specified or 16 random characters) + + +OPTIONS +------- +The following script options are available: + +*-n, --name='NAME'*:: + Specify container name. + +*-a, --architecture='ARCHITECTURE'*:: + Specify the Debian architecture, defaults to the host systems architecture. + +*-d, --distribution='DISTRIBUTION'*:: + Specify the Debian distribution, defaults to jessie. + +*-m, --mirror='MIRROR'*:: + Specify the Debian mirror, defaults to http://ftp.debian.org/debian. + +*-p, --root-password='PASSWORD'*:: + Specify the root password, defaults to a random 16 character password. + + +EXAMPLES +-------- +*Create a Debian 8 (jessie) based container with same architecture as the host system:*:: + sudo container create -s debootstrap -n jessie.example.net + +*Create a Debian 8 (jessie) based container with different architecture as the host system:*:: + sudo container create -s debootstrap -n jessie-i386.example.net -- -a i386 + + +SEE ALSO +-------- +container-tools(7), +container(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-create.1.txt b/share/man/en/container-create.1.txt new file mode 100644 index 0000000..b7a4f01 --- /dev/null +++ b/share/man/en/container-create.1.txt @@ -0,0 +1,100 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER-CREATE(1) +=================== +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-create - Create a container + + +SYNOPSIS +-------- +*container create* ['OPTIONS'] + + +DESCRIPTION +----------- +The container-create command creates a container based on a script. + + +OPTIONS +------- +The following container-create options are available: + +*-n, --name='NAME'*:: + Specify container name. + +*-c, --capability='CAPABILITY'*:: + Specify capabilities to grant, see capabilities(7). + +*-d, --drop-capability='DROP_CAPABILITY'*:: + Specify capabilities to drop, see capabilities(7). + +*-s, --script='SCRIPT'*:: + Specify container creation script, defaults to debootstrap. + +*-b, --bind='DIRECTORY:DIRECTORY[:OPTIONS][;DIRECTORY:DIRECTORY[:OPTIONS]]'*:: + Specify container bind mounts, see systemd-nspawn(1) --bind option. + + +SCRIPTS +------- +The following container scripts are available: + +*debootstrap*:: + Basic script to create Debian based container, see container-create-debootstrap(1). + +*debconf*:: + Advanced script to automatically create Debian based container, see container-create-debconf(1). + +*default*:: + 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. 'sudo update-alternatives --config container-tools_script'. + + +EXAMPLES +-------- +*Create example.net container using debootstrap script:*:: + sudo container create -n example.net -s debootstrap + +*Create example.net container using debconf script:*:: + sudo container create -n example.net -s debconf + +SEE ALSO +-------- +container-tools(7), +container(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-enter.1.txt b/share/man/en/container-enter.1.txt new file mode 100644 index 0000000..792cac7 --- /dev/null +++ b/share/man/en/container-enter.1.txt @@ -0,0 +1,75 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER-CONSOLE(1) +==================== +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-enter - Enter a container namespace + + +SYNOPSIS +-------- +*container enter* ['OPTIONS'] [-- COMMAND|"COMMANDS"] + + +DESCRIPTION +----------- +The container enter enters a container namespace. + + +OPTIONS +------- +The following container options are available: + +*-n, --name='NAME'*:: + Specify container name. + + +EXAMPLES +-------- +*Enter to example.net container namespace:*:: + sudo container enter -n example.net + +*Execute 'ip a' in example.net container namespace:*:: + sudo container enter -n example.net -- 'ip a' + + +SEE ALSO +-------- +container-tools(7), +container(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-limit.1.txt b/share/man/en/container-limit.1.txt new file mode 100644 index 0000000..0ba5b74 --- /dev/null +++ b/share/man/en/container-limit.1.txt @@ -0,0 +1,105 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER-LIMIT(1) +================== +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-limit - Limit ressources of a container + + +SYNOPSIS +-------- +*container limit* ['OPTIONS'] + + +DESCRIPTION +----------- +The container limit command limits ressources available to a container at runtime. + + +OPTIONS +------- +The following container options are available: + +*-n, --name='NAME'*:: + Specify container name. + +*--blockio-device-weight='DEVICE WEIGHT'*:: + Specify device specific blockio weight, see systemd.resource-control(5). + +*--blockio-read-bandwith='DEVICE BYTES'*:: + Specify device specific blockio read bandwith, see systemd.resource-control(5). + +*-b, --blockio-weight='WEIGHT'*:: + Specify general blockio weight, see systemd.resource-control(5). + +*--blockio-write-bandwith='DEVICE BYTES'*:: + Specify device specific blockio write bandwith, see systemd.resource-control(5). + +*-c, --cpu-quota='QUOTA'*:: + Specify CPU quota, see systemd.resource-control(5). + +*--cpu-shares='SHARES'*:: + Specify CPU shares, see systemd.resource-control(5). + +*-m, --memory-limit='BYTES'*:: + Specify memory limit, see systemd.resource-control(5). + +*-t, --tasks-max='NUMBER'*:: + Specify tasks max, see systemd.resource-control(5). + + +EXAMPLES +-------- +*Set blockio weight for the example.net container:*:: + sudo container limit -n example.net --blockio-weight 100 + +*Set CPU quota for the example.net container:*:: + sudo container limit -n example.net --cpu-quota 10% + +*Set memory limit for the example.net container to 1GB:*:: + sudo container limit -n example.net --memory-limit 1G + +*Set tasks max for the example.net container to 100:*:: + sudo container limit -n example.net --tasks-max 100 + + +SEE ALSO +-------- +container-tools(7), +container(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-list.1.txt b/share/man/en/container-list.1.txt new file mode 100644 index 0000000..8ac59c2 --- /dev/null +++ b/share/man/en/container-list.1.txt @@ -0,0 +1,92 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER-LIST(1) +================= +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-list - List container on the system + + +SYNOPSIS +-------- +*container list* ['OPTIONS'] + + +DESCRIPTION +----------- +The container list command lists container on the system. + + +OPTIONS +------- +The following container options are available, defaults to *--started --stopped*: + +*-a, --all*:: + List all available container (started, stopped, and other). + +*-f, --format='FORMAT'*:: + Use format to list container. Currently available formats are 'short' or 'full' (default). + +*-h, --host='HOSTNAME'*:: + List only container that are enabled for automatic start on the specified hostname. Defaults to list containers of the local system only. Using 'all' shows all container regardless of any automatic start configuration. + +*-o, --other*:: + List only container that are not enable for automatic start on the current system. + +*-s, --started*:: + List only started container. + +*-t, --stopped*:: + List only stopped container. + +EXAMPLES +-------- +*List all started and stopped containers of the local system:*:: + sudo container list + +*List all started and stopped containers of the local system as a machine-readable list:*:: + sudo container list -f short + +*List all started and other containers:*:: + sudo container list -s -o + + +SEE ALSO +-------- +container-tools(7), +container(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-remove.1.txt b/share/man/en/container-remove.1.txt new file mode 100644 index 0000000..cb9b77f --- /dev/null +++ b/share/man/en/container-remove.1.txt @@ -0,0 +1,78 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER-REMOVE(1) +=================== +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-remove - Remove a container + + +SYNOPSIS +-------- +*container remove* ['OPTIONS'] + + +DESCRIPTION +----------- +The container remove command removes a container. + + +OPTIONS +------- +The following container options are available: + +*-n, --name='NAME'*:: + Specify container name. + +*-f, --force*:: + Do not prompt before removal. + + +EXAMPLES +-------- +*Remove example.net container from the system:*:: + sudo container remove -n example.net + +*Remove example.net container from the system without prompt:*:: + sudo container remove -n example.net -f + + +SEE ALSO +-------- +container-tools(7), +container(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-restart.1.txt b/share/man/en/container-restart.1.txt new file mode 100644 index 0000000..eda0174 --- /dev/null +++ b/share/man/en/container-restart.1.txt @@ -0,0 +1,72 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER-RESTART(1) +==================== +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-restart - Restart a container + + +SYNOPSIS +-------- +*container restart* ['OPTIONS'] + + +DESCRIPTION +----------- +The container restart command restarts a container. + + +OPTIONS +------- +The following container options are available: + +*-n, --name='NAME'*:: + Specify container name. + + +EXAMPLES +-------- +*Restart example.net container:*:: + sudo container restart -n example.net + + +SEE ALSO +-------- +container-tools(7), +container(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-shell.1.txt b/share/man/en/container-shell.1.txt new file mode 100644 index 0000000..f7e0270 --- /dev/null +++ b/share/man/en/container-shell.1.txt @@ -0,0 +1,75 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER(1) +============ +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-shell - Manage systemd-nspawn containers (shell) + + +SYNOPSIS +-------- +*container-shell* + + +DESCRIPTION +----------- +container-tools provides the system integration for managing containers using systemd-nspawn. + + +COMMANDS +-------- +All container commands are available, see container(1). Additionally, the following commands are specific to container-shell: + +*about:*:: + shows introduction (manpage). + +*help:*:: + shows available commands within the container-shell. + +*help COMMAND:*:: + shows help (manpage) for a specific container command. + +*logout*, *exit:*:: + exits container-shell. + + +SEE ALSO +-------- +machinectl(1), +systemd-nspawn(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-start.1.txt b/share/man/en/container-start.1.txt new file mode 100644 index 0000000..313587d --- /dev/null +++ b/share/man/en/container-start.1.txt @@ -0,0 +1,72 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER-START(1) +================== +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-start - Start a container + + +SYNOPSIS +-------- +*container start* ['OPTIONS'] + + +DESCRIPTION +----------- +The container start command starts a container. + + +OPTIONS +------- +The following container options are available: + +*-n, --name='NAME'*:: + Specify container name. + + +EXAMPLES +-------- +*Start example.net container:*:: + sudo container start -n example.net + + +SEE ALSO +-------- +container-tools(7), +container(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-status.1.txt b/share/man/en/container-status.1.txt new file mode 100644 index 0000000..f1688dc --- /dev/null +++ b/share/man/en/container-status.1.txt @@ -0,0 +1,72 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2016 Simon Spöehel +// +// 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 . + +CONTAINER-STATUS(1) +=================== +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-status - Show container status + + +SYNOPSIS +-------- +*container status* ['OPTIONS'] + + +DESCRIPTION +----------- +The container-status command displays the status of a container. + + +OPTIONS +------- +The following container-status options are available: + +*-n, --name='NAME'*:: + Specify container name. + + +EXAMPLES +-------- +*show status of example.net container:*:: + sudo container status -n example.net + + +SEE ALSO +-------- +container-tools(7), +container(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-stop.1.txt b/share/man/en/container-stop.1.txt new file mode 100644 index 0000000..7531f1c --- /dev/null +++ b/share/man/en/container-stop.1.txt @@ -0,0 +1,78 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER-STOP(1) +================= +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-stop - Stop a container + + +SYNOPSIS +-------- +*container stop* ['OPTIONS'] + + +DESCRIPTION +----------- +The container stop command stops a container by running the proper shutdown sequence. + + +OPTIONS +------- +The following container options are available: + +*-n, --name='NAME'*:: + Specify container name. + +*-f, --force*:: + Instead of running the proper shutdown sequence, terminate all processes of the container imediatly. + + +EXAMPLES +-------- +*Shutdown example.net container:*:: + sudo container stop -n example.net + +*Immediately stop example.net container:*:: + sudo container stop -n example.net -f + + +SEE ALSO +-------- +container-tools(7), +container(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container-tools.7.txt b/share/man/en/container-tools.7.txt new file mode 100644 index 0000000..604683f --- /dev/null +++ b/share/man/en/container-tools.7.txt @@ -0,0 +1,133 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER-TOOLS(7) +================== +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-tools - Manage systemd-nspawn containers + + +DESCRIPTION +----------- +"[A Linux container] is an operating-system-level virtualization environment for running multiple isolated Linux systems (containers) on a single Linux control host.":: + -- Wikipedia (https://en.wikipedia.org/wiki/LXC) + +container-tools provides the system integration for managing containers using systemd-nspawn. + + +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 + * Debian Sources: https://sources.progress-linux.org/users/daniel/debian/packages/open-infrastructure-container-tools + + +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, and patches are welcome via Debian Bug Tracking System: + + * https://bugs.debian.org + +Please base them against the 'next' Git branch using common sense: + + * https://www.kernel.org/doc/Documentation/SubmittingPatches + + +KNOWN LIMITATIONS +----------------- + +container-tools currently do not work with systemd-networkd and depend on ifupdown. + + +USAGE +----- + +*Create a new container:*:: + sudo container create -n NAME + +*Start a container:*:: + sudo container start -n NAME + +*Stop a container:*:: + sudo container stop -n NAME + +*Remove a container:*:: + sudo container remove -n NAME + +*List container on the system:*:: + sudo container list + +*Show container-tools version:*:: + container version + +See container(1) for a list of all container commands. + + +LINKS +----- + +*2016-02-24: Systemd vs. Docker*:: + https://lwn.net/Articles/676831/ + +*2015-06-10: Systemd and containers*:: + https://lwn.net/Articles/647634/ + +*2014-07-07: Control groups*:: + https://lwn.net/Articles/604609/ + +*2013-11-13: Systemd-Nspawn is Chroot on Steroids [LinuxCon Europe]*:: + https://www.youtube.com/watch?v=s7LlUs5D9p4 + +*2013-11-03: Creating containers with systemd-nspawn*:: + https://lwn.net/Articles/572957/ + +*2013-02-06: Systemd lightweight containers*:: + https://lwn.net/Articles/536033/ + +*2013-01-04: Namespaces in operation*:: + https://lwn.net/Articles/531114/ + + +AUTHORS +------- + + * Daniel Baumann diff --git a/share/man/en/container-version.1.txt b/share/man/en/container-version.1.txt new file mode 100644 index 0000000..5e50ad4 --- /dev/null +++ b/share/man/en/container-version.1.txt @@ -0,0 +1,69 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER-VERSION(1) +==================== +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container-version - Show container-tools version + + +SYNOPSIS +-------- +*container version* ['OPTIONS'] + + +DESCRIPTION +----------- +The container version command shows the container-tools version number. + + +OPTIONS +------- +This command has no options. + + +EXAMPLES +-------- +*Show container-tools version:*:: + container version + + +SEE ALSO +-------- +container-tools(7), +container(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . diff --git a/share/man/en/container.1.txt b/share/man/en/container.1.txt new file mode 100644 index 0000000..32bd393 --- /dev/null +++ b/share/man/en/container.1.txt @@ -0,0 +1,127 @@ +// container-tools - Manage systemd-nspawn containers +// Copyright (C) 2014-2016 Daniel Baumann +// +// 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 . + +CONTAINER(1) +============ +:doctype: manpage +:man manual: Open Infrastructure +:man source: container-tools +:man version: {revnumber} + + +NAME +---- +container - Manage systemd-nspawn containers + + +SYNOPSIS +-------- +*container* 'COMMAND' ['OPTIONS'] + + +DESCRIPTION +----------- +container-tools provides the system integration for managing containers using systemd-nspawn. + + +OPTIONS +------- +The following container common options are available: + +*-n, --name='NAME'*:: + Specify container name. + + +COMMANDS +-------- +The following container commands are available: + +*create*:: + Create a new container, see container-create(1). + +*start*:: + Start a container, see container-start(1). + +*restart*:: + Restart a container, see container-restart(1). + +*stop*:: + Stop a container, see container-stop(1). + +*remove*:: + Remove a container, see container-remove(1). + +*console*:: + Attach console to a container, see container-console(1). + +*enter*:: + Enter a container namespace, see container-enter(1). + +*limit*:: + Limit ressources of a container, see container-limit(1). + +*list*:: + List container on the system, see container-list(1). + +*status*:: + Show container status, see container-status(1). + +*version*:: + Show container-tools version, see container-version(1). + + +FILES +----- +The following files are used: + +*/usr/bin/container*, */usr/bin/cnt*:: + Container program. + +*/usr/bin/container-shell*, */usr/bin/cntsh*:: + Container shell program. + +*/usr/lib/container-tools*:: + Container commands. + +*/usr/share/container-tools*:: + Container shared data. + +*/usr/share/doc/container-tools*:: + Container documentation files. + +*/var/lib/machines*:: + Container root directory. + + +SEE ALSO +-------- +machinectl(1), +systemd-nspawn(1). + + +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. + + +AUTHORS +------- +container-tools was written by Daniel Baumann . -- cgit v1.2.3