diff options
Diffstat (limited to 'share/man/container-info.1')
| -rw-r--r-- | share/man/container-info.1 | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/share/man/container-info.1 b/share/man/container-info.1 new file mode 100644 index 0000000..8aa244f --- /dev/null +++ b/share/man/container-info.1 @@ -0,0 +1,118 @@ +.\" Open Infrastructure: compute-tools +.\" +.\" 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/>. +.\" +. +.TH CONTAINER-INFO 1 compute-tools "Open Infrastructure" +.SH NAME +container-info \- Show specific information of a container +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.nf +\fBcontainer info\fP [\(aqOPTIONS\(aq] +.fi +.sp +.SH DESCRIPTION +.sp +The \fBcontainer info\fP command shows specific information of a container. +.SH OPTIONS +.sp +The following \fBcontainer info\fP options are available, defaults to \(aq\-\-status +\-\-os \-\-ip\(aq: +.INDENT 0.0 +.TP +.B \-\-status: +Show container status (started|stopped|other). +.TP +.B \-\-os: +Show container operating system (FIXME: Debian only). +.TP +.B \-\-ip: +Show container IP address. +.UNINDENT +.SH EXAMPLES +.sp +Show example.net container status: +.INDENT 0.0 +.INDENT 3.5 +sudo container info \-n example.net \-\-status +.UNINDENT +.UNINDENT +.sp +Show example.net container operating system: +.INDENT 0.0 +.INDENT 3.5 +sudo container info \-n example.net \-\-os +.UNINDENT +.UNINDENT +.sp +Show example.net container IP address: +.INDENT 0.0 +.INDENT 3.5 +sudo container info \-n example.net \-\-ip +.UNINDENT +.UNINDENT +.SH SEE ALSO +.nf +compute\-tools(7), +container(1). +.fi +.sp +.SH HOMEPAGE +.sp +More information about compute\-tools and the Open Infrastructure project can be +found on the homepage (\fI\%https://open\-infrastructure.net\fP). +.SH CONTACT +.sp +Bug reports, feature requests, help, patches, support and everything else are +welcome on the Open Infrastructure Software Mailing List +<\fI\%software@lists.open\-infrastructure.net\fP>. +.sp +Debian specific bugs can also be reported in the Debian Bug Tracking System +(\fI\%https://bugs.debian.org\fP). +.SH AUTHORS +.sp +compute\-tools were written by Daniel Baumann +<\fI\%daniel.baumann@open\-infrastructure.net\fP> and others. +. |