summaryrefslogtreecommitdiffstats
path: root/share/man/container-info.1.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@open-infrastructure.net>2021-06-06 13:57:35 +0000
committerDaniel Baumann <daniel.baumann@open-infrastructure.net>2021-06-29 11:19:35 +0000
commit2e67a52c2e1a25ce7b5a1b4e79bf31799079ae67 (patch)
tree205c303809658619addf0ec15b6f816b9a1b89aa /share/man/container-info.1.txt
parentUsing cnt run to determine IP addresses in container list. (diff)
downloadcompute-tools-2e67a52c2e1a25ce7b5a1b4e79bf31799079ae67.tar.xz
compute-tools-2e67a52c2e1a25ce7b5a1b4e79bf31799079ae67.zip
Adding initial container info command.
Signed-off-by: Daniel Baumann <daniel.baumann@open-infrastructure.net>
Diffstat (limited to '')
-rw-r--r--share/man/container-info.1.txt87
1 files changed, 87 insertions, 0 deletions
diff --git a/share/man/container-info.1.txt b/share/man/container-info.1.txt
new file mode 100644
index 0000000..125bdef
--- /dev/null
+++ b/share/man/container-info.1.txt
@@ -0,0 +1,87 @@
+// Copyright (C) 2014-2021 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-LIST(1)
+=================
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: compute-tools
+:man version: {revnumber}
+
+
+NAME
+----
+container-info - Show specific information of a container
+
+
+SYNOPSIS
+--------
+*container info* ['OPTIONS']
+
+
+DESCRIPTION
+-----------
+The container info command shows specific information of a container.
+
+
+OPTIONS
+-------
+The following container options are available, defaults to *--status --os --ip*:
+
+*--status*::
+ Show container status (started|stopped|other).
+
+*--os*::
+ Show container operating system (FIXME: Debian only).
+
+*--ip*::
+ Show container IP address.
+
+EXAMPLES
+--------
+*Show example.net container status:*::
+ sudo container info -n example.net --status
+
+*Show example.net container operating system:*::
+ sudo container info -n example.net --os
+
+*Show example.net container IP address:*::
+ sudo container info -n example.net --ip
+
+
+SEE ALSO
+--------
+compute-tools(7),
+container(1).
+
+
+HOMEPAGE
+--------
+More information about compute-tools and the Open Infrastructure project can be found on the homepage at 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 at https://bugs.debian.org.
+
+
+AUTHORS
+-------
+compute-tools were written by Daniel Baumann <daniel.baumann@open-infrastructure.net> and others.