summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authorDaniel Baumann <mail@daniel-baumann.ch>2016-07-01 09:53:17 +0000
committerDaniel Baumann <mail@daniel-baumann.ch>2016-07-01 09:53:17 +0000
commita18674d73d1ef3472897c0f2049bf8131b9e4eb6 (patch)
tree0910f1df6e4648f6866cc06910314b845bf99bf1 /share/man
parentAdding upstream version 20160615. (diff)
downloadopen-infrastructure-compute-tools-a18674d73d1ef3472897c0f2049bf8131b9e4eb6.tar.xz
open-infrastructure-compute-tools-a18674d73d1ef3472897c0f2049bf8131b9e4eb6.zip
Adding upstream version 20160701.upstream/20160701
Signed-off-by: Daniel Baumann <mail@daniel-baumann.ch>
Diffstat (limited to 'share/man')
-rw-r--r--share/man/container-auto.1.txt2
-rw-r--r--share/man/container-console.1.txt2
-rw-r--r--share/man/container-create-debconf.1.txt2
-rw-r--r--share/man/container-create-debootstrap.1.txt2
-rw-r--r--share/man/container-create.1.txt2
-rw-r--r--share/man/container-enter.1.txt75
-rw-r--r--share/man/container-limit.1.txt2
-rw-r--r--share/man/container-list.1.txt18
-rw-r--r--share/man/container-remove.1.txt2
-rw-r--r--share/man/container-restart.1.txt2
-rw-r--r--share/man/container-shell.1.txt2
-rw-r--r--share/man/container-start.1.txt2
-rw-r--r--share/man/container-status.1.txt72
-rw-r--r--share/man/container-stop.1.txt2
-rw-r--r--share/man/container-tools.7.txt17
-rw-r--r--share/man/container-version.1.txt2
-rw-r--r--share/man/container.1.txt5
17 files changed, 188 insertions, 23 deletions
diff --git a/share/man/container-auto.1.txt b/share/man/container-auto.1.txt
index cdb9b2c..a1f1ab3 100644
--- a/share/man/container-auto.1.txt
+++ b/share/man/container-auto.1.txt
@@ -70,7 +70,7 @@ More information about container-tools and the Open Infrastructure project can b
BUGS
----
-Bugs can be reported by opening an issue in the GitHub repository at https://github.com/open-infrastructure/container-tools.
+Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org.
AUTHORS
diff --git a/share/man/container-console.1.txt b/share/man/container-console.1.txt
index c898c34..410ff92 100644
--- a/share/man/container-console.1.txt
+++ b/share/man/container-console.1.txt
@@ -64,7 +64,7 @@ More information about container-tools and the Open Infrastructure project can b
BUGS
----
-Bugs can be reported by opening an issue in the GitHub repository at https://github.com/open-infrastructure/container-tools.
+Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org.
AUTHORS
diff --git a/share/man/container-create-debconf.1.txt b/share/man/container-create-debconf.1.txt
index beef8b5..76f86cc 100644
--- a/share/man/container-create-debconf.1.txt
+++ b/share/man/container-create-debconf.1.txt
@@ -143,7 +143,7 @@ More information about container-tools and the Open Infrastructure project can b
BUGS
----
-Bugs can be reported by opening an issue in the GitHub repository at https://github.com/open-infrastructure/container-tools.
+Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org.
AUTHORS
diff --git a/share/man/container-create-debootstrap.1.txt b/share/man/container-create-debootstrap.1.txt
index cc6a109..3377ea0 100644
--- a/share/man/container-create-debootstrap.1.txt
+++ b/share/man/container-create-debootstrap.1.txt
@@ -85,7 +85,7 @@ More information about container-tools and the Open Infrastructure project can b
BUGS
----
-Bugs can be reported by opening an issue in the GitHub repository at https://github.com/open-infrastructure/container-tools.
+Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org.
AUTHORS
diff --git a/share/man/container-create.1.txt b/share/man/container-create.1.txt
index 2553569..b7a4f01 100644
--- a/share/man/container-create.1.txt
+++ b/share/man/container-create.1.txt
@@ -92,7 +92,7 @@ More information about container-tools and the Open Infrastructure project can b
BUGS
----
-Bugs can be reported by opening an issue in the GitHub repository at https://github.com/open-infrastructure/container-tools.
+Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org.
AUTHORS
diff --git a/share/man/container-enter.1.txt b/share/man/container-enter.1.txt
new file mode 100644
index 0000000..792cac7
--- /dev/null
+++ b/share/man/container-enter.1.txt
@@ -0,0 +1,75 @@
+// container-tools - Manage systemd-nspawn containers
+// Copyright (C) 2014-2016 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+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 <daniel.baumann@open-infrastructure.net>.
diff --git a/share/man/container-limit.1.txt b/share/man/container-limit.1.txt
index 8538fe3..0ba5b74 100644
--- a/share/man/container-limit.1.txt
+++ b/share/man/container-limit.1.txt
@@ -97,7 +97,7 @@ More information about container-tools and the Open Infrastructure project can b
BUGS
----
-Bugs can be reported by opening an issue in the GitHub repository at https://github.com/open-infrastructure/container-tools.
+Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org.
AUTHORS
diff --git a/share/man/container-list.1.txt b/share/man/container-list.1.txt
index 5474da4..8ac59c2 100644
--- a/share/man/container-list.1.txt
+++ b/share/man/container-list.1.txt
@@ -39,10 +39,10 @@ The container list command lists container on the system.
OPTIONS
-------
-The following container options are available:
+The following container options are available, defaults to *--started --stopped*:
*-a, --all*::
- List all available container.
+ List all available container (started, stopped, and other).
*-f, --format='FORMAT'*::
Use format to list container. Currently available formats are 'short' or 'full' (default).
@@ -50,7 +50,7 @@ The following container options are available:
*-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.
-*-h, --other*::
+*-o, --other*::
List only container that are not enable for automatic start on the current system.
*-s, --started*::
@@ -61,8 +61,14 @@ The following container options are available:
EXAMPLES
--------
-*List all started container on the the system as a machine-readable list:*::
- sudo container list --all --format=short
+*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
@@ -78,7 +84,7 @@ More information about container-tools and the Open Infrastructure project can b
BUGS
----
-Bugs can be reported by opening an issue in the GitHub repository at https://github.com/open-infrastructure/container-tools.
+Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org.
AUTHORS
diff --git a/share/man/container-remove.1.txt b/share/man/container-remove.1.txt
index cdd1d15..cb9b77f 100644
--- a/share/man/container-remove.1.txt
+++ b/share/man/container-remove.1.txt
@@ -70,7 +70,7 @@ More information about container-tools and the Open Infrastructure project can b
BUGS
----
-Bugs can be reported by opening an issue in the GitHub repository at https://github.com/open-infrastructure/container-tools.
+Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org.
AUTHORS
diff --git a/share/man/container-restart.1.txt b/share/man/container-restart.1.txt
index 1de7277..eda0174 100644
--- a/share/man/container-restart.1.txt
+++ b/share/man/container-restart.1.txt
@@ -64,7 +64,7 @@ More information about container-tools and the Open Infrastructure project can b
BUGS
----
-Bugs can be reported by opening an issue in the GitHub repository at https://github.com/open-infrastructure/container-tools.
+Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org.
AUTHORS
diff --git a/share/man/container-shell.1.txt b/share/man/container-shell.1.txt
index 3a8ed05..f7e0270 100644
--- a/share/man/container-shell.1.txt
+++ b/share/man/container-shell.1.txt
@@ -67,7 +67,7 @@ More information about container-tools and the Open Infrastructure project can b
BUGS
----
-Bugs can be reported by opening an issue in the GitHub repository at https://github.com/open-infrastructure/container-tools.
+Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org.
AUTHORS
diff --git a/share/man/container-start.1.txt b/share/man/container-start.1.txt
index e2405a7..313587d 100644
--- a/share/man/container-start.1.txt
+++ b/share/man/container-start.1.txt
@@ -64,7 +64,7 @@ More information about container-tools and the Open Infrastructure project can b
BUGS
----
-Bugs can be reported by opening an issue in the GitHub repository at https://github.com/open-infrastructure/container-tools.
+Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org.
AUTHORS
diff --git a/share/man/container-status.1.txt b/share/man/container-status.1.txt
new file mode 100644
index 0000000..e5c700b
--- /dev/null
+++ b/share/man/container-status.1.txt
@@ -0,0 +1,72 @@
+// container-tools - Manage systemd-nspawn containers
+// Copyright (C) 2016 Simon Spöehel <simon.spoehel@open-infrastructure.net>
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+CONTAINER-STATUS(1)
+===================
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: container-tools
+:man version: {revnumber}
+
+
+NAME
+----
+container-status - Get the status of a container
+
+
+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 <daniel.baumann@open-infrastructure.net>.
diff --git a/share/man/container-stop.1.txt b/share/man/container-stop.1.txt
index cf7ad76..7531f1c 100644
--- a/share/man/container-stop.1.txt
+++ b/share/man/container-stop.1.txt
@@ -70,7 +70,7 @@ More information about container-tools and the Open Infrastructure project can b
BUGS
----
-Bugs can be reported by opening an issue in the GitHub repository at https://github.com/open-infrastructure/container-tools.
+Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org.
AUTHORS
diff --git a/share/man/container-tools.7.txt b/share/man/container-tools.7.txt
index 95d09c8..7fd1a0f 100644
--- a/share/man/container-tools.7.txt
+++ b/share/man/container-tools.7.txt
@@ -50,8 +50,8 @@ INSTALLATION
SOURCE
~~~~~~
- 1. sudo apt install asciidoc git docbook-xml docbook-xsl libxml2-utils make xsltproc
- 2. git clone https://github.com/open-infrastructure/container-tools
+ 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
@@ -63,15 +63,21 @@ DEBIAN 9 (STRETCH) AND NEWER
DEVELOPMENT
-----------
-Bug reports, feature requests, and patches are welcome via Github:
+Bug reports, feature requests, and patches are welcome via Debian Bug Tracking System:
- * https://github.com/open-infrastructure/container-tools
+ * 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
-----
@@ -93,6 +99,9 @@ USAGE
*Attach console to a container:*::
sudo container console -n NAME
+*Enter a container namespace:*::
+ sudo container enter -n NAME
+
*limit*::
sudo container limit -n NAME --cpu-quota 10%
diff --git a/share/man/container-version.1.txt b/share/man/container-version.1.txt
index 99548cc..5e50ad4 100644
--- a/share/man/container-version.1.txt
+++ b/share/man/container-version.1.txt
@@ -61,7 +61,7 @@ More information about container-tools and the Open Infrastructure project can b
BUGS
----
-Bugs can be reported by opening an issue in the GitHub repository at https://github.com/open-infrastructure/container-tools.
+Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org.
AUTHORS
diff --git a/share/man/container.1.txt b/share/man/container.1.txt
index 7ad4f87..d660379 100644
--- a/share/man/container.1.txt
+++ b/share/man/container.1.txt
@@ -67,6 +67,9 @@ The following container commands are available:
*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).
@@ -113,7 +116,7 @@ More information about container-tools and the Open Infrastructure project can b
BUGS
----
-Bugs can be reported by opening an issue in the GitHub repository at https://github.com/open-infrastructure/container-tools.
+Bugs can be reported by sending a bug report to the Debian Bug Tracking System at https://bugs.debian.org.
AUTHORS