summaryrefslogtreecommitdiffstats
path: root/share/man/container.1.rst
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/container.1.rst')
-rw-r--r--share/man/container.1.rst171
1 files changed, 171 insertions, 0 deletions
diff --git a/share/man/container.1.rst b/share/man/container.1.rst
new file mode 100644
index 0000000..c08cbd9
--- /dev/null
+++ b/share/man/container.1.rst
@@ -0,0 +1,171 @@
+.. Open Infrastructure: compute-tools
+
+.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+..
+.. SPDX-License-Identifier: GPL-3.0+
+..
+.. This program is free software: you can redistribute it and/or modify
+.. it under the terms of the GNU General Public License as published by
+.. the Free Software Foundation, either version 3 of the License, or
+.. (at your option) any later version.
+..
+.. This program is distributed in the hope that it will be useful,
+.. but WITHOUT ANY WARRANTY; without even the implied warranty of
+.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.. GNU General Public License for more details.
+..
+.. You should have received a copy of the GNU General Public License
+.. along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+=========
+container
+=========
+
+--------------------------------
+Manage systemd-nspawn containers
+--------------------------------
+
+:manual section: 1
+:manual group: Open Infrastructure
+
+Synopsis
+========
+
+| **container** 'COMMAND' ['OPTIONS']
+| **container** 'COMMAND1','COMMAND2',... 'COMMANDn'
+
+Description
+===========
+
+compute-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:
+
+build:
+ Build a new container, see container-build(1).
+
+start:
+ Start a container, see container-start(1).
+
+rebuild:
+ Rebuild a container, see container-rebuild(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).
+
+move:
+ Rename a container, see container-move(1).
+
+console:
+ Attach console to a container, see container-console(1).
+
+enter:
+ Enter a container namespace, see container-enter(1).
+
+run:
+ Execute commands in a container namespace, see container-run(1).
+
+info:
+ Show specific information of a container, see container-info(1).
+
+key:
+ Manage GnuPG keyring for container operations, see container-key(1).
+
+limit:
+ Limit resources of a container, see container-limit(1).
+
+list:
+ List container on the system, see container-list(1).
+
+log:
+ Show container log, see container-log(1).
+
+status:
+ Show container status, see container-status(1).
+
+top:
+ Dynamic list of container on the system, see container-top(1).
+
+update:
+ Update the packages installed in a container.
+
+version:
+ Show container version, see container-version(1).
+
+Files
+=====
+
+The following files are used:
+
+/etc/compute-tools/container.conf, /etc/compute-tools/container.conf.d/\*.conf:
+ Container configuration files.
+
+/usr/bin/container, /usr/bin/cnt:
+ Container program.
+
+/usr/bin/container-shell, /usr/bin/cntsh:
+ Container shell program.
+
+/usr/libexec/container:
+ Container commands.
+
+/usr/share/compute-tools/:
+ Container shared data.
+
+/usr/share/doc/compute-tools:
+ Container documentation files.
+
+/var/cache/container:
+ Container cache directory.
+
+/var/lib/machines:
+ Container root directory.
+
+/var/log/compute-tools:
+ Container log files.
+
+See also
+========
+
+| machinectl(1),
+| systemd-nspawn(1).
+
+Homepage
+========
+
+More information about compute-tools and the Open Infrastructure project can be
+found on the homepage (https://open-infrastructure.net).
+
+Contact
+=======
+
+Bug reports, feature requests, help, patches, support and everything else are
+welcome on the Open Infrastructure Software Mailing List
+<software@lists.open-infrastructure.net>.
+
+Debian specific bugs can also be reported in the Debian Bug Tracking System
+(https://bugs.debian.org).
+
+Authors
+=======
+
+compute-tools were written by Daniel Baumann
+<daniel.baumann@open-infrastructure.net> and others.