diff options
Diffstat (limited to 'share/man/container-list.1')
| -rw-r--r-- | share/man/container-list.1 | 184 |
1 files changed, 184 insertions, 0 deletions
diff --git a/share/man/container-list.1 b/share/man/container-list.1 new file mode 100644 index 0000000..751ab88 --- /dev/null +++ b/share/man/container-list.1 @@ -0,0 +1,184 @@ +.\" 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/>. +.\" +. +.TH CONTAINER-LIST 1 compute-tools "Open Infrastructure" +.SH NAME +container-list \- List container on the system +. +.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 list\fP [\(aqOPTIONS\(aq] +\fBcnt ls\fP [\(aqOPTIONS\(aq] +.fi +.sp +.SH DESCRIPTION +.sp +The \fBcontainer list\fP command lists container on the system. +.SH OPTIONS +.sp +The following \fBcontainer list\fP options are available, defaults to \(aq\-\-started +\-\-stopped\(aq: +.INDENT 0.0 +.TP +.B \-a, \-\-all: +List all available container (started, stopped, and other). +.TP +.B \-\-csv\-separator=\(aqSEPARATOR\(aq: +Specify custom CSV separator, defaults to \(aq,\(aq. +.TP +.B \-f, \-\-format=\(aqFORMAT\(aq: +Use format to list container. Currently available formats are \(aqcli\(aq (default), +\(aqcsv\(aq, \(aqjson\(aq, \(aqnwdiag\(aq, \(aqshell\(aq, \(aqsh\(aq, \(aqyaml\(aq, or \(aqxml\(aq. +.TP +.B \-h, \-\-host=\(aqHOSTNAME\(aq: +List only container that are enabled for automatic start on the specified +hostname. Defaults to list containers of the local system only. Using \(aqall\(aq +shows all container regardless of any automatic start configuration. +.TP +.B \-\-nwdiag\-color=\(aqCOLOR\(aq: +Specify custom nwdiag color for the host box, defaults to \(aq#3465a4\(aq. +.TP +.B \-\-nwdiag\-label=\(aqLABEL\(aq: +Specify custom nwdiag label for the diagram, defaults to empty. +.TP +.B \-o, \-\-other: +List only container that are not enable for automatic start on the current +system. +.TP +.B \-s, \-\-started: +List only started container. +.TP +.B \-t, \-\-stopped: +List only stopped container. +.UNINDENT +.SH EXAMPLES +.sp +List all started and stopped containers of the local system: +.INDENT 0.0 +.INDENT 3.5 +sudo container list +.UNINDENT +.UNINDENT +.sp +List all started and other containers: +.INDENT 0.0 +.INDENT 3.5 +sudo container list \-s \-o +.UNINDENT +.UNINDENT +.sp +Create a CSV export of all started and stopped containers: +.INDENT 0.0 +.INDENT 3.5 +sudo container list \-f csv +.UNINDENT +.UNINDENT +.sp +Create a JSON export of all started and stopped containers: +.INDENT 0.0 +.INDENT 3.5 +sudo container list \-f json +.UNINDENT +.UNINDENT +.sp +Create a nwdiag export of all started and stopped containers: +.INDENT 0.0 +.INDENT 3.5 +sudo container list \-f nwdiag +.UNINDENT +.UNINDENT +.sp +Create a SVG image via nwdiag of all started and stopped containers: +.INDENT 0.0 +.INDENT 3.5 +sudo container list \-f nwdiag | nwdiag \-T svg \-o cnt\-list.svg \- +.UNINDENT +.UNINDENT +.sp +Create a shell export of all started and stopped containers: +.INDENT 0.0 +.INDENT 3.5 +sudo container list \-f shell +sudo container list \-f sh +.UNINDENT +.UNINDENT +.sp +Create a YAML export of all started and stopped containers: +.INDENT 0.0 +.INDENT 3.5 +sudo container list \-f yaml +.UNINDENT +.UNINDENT +.sp +Create a XML export of all started and stopped containers: +.INDENT 0.0 +.INDENT 3.5 +sudo container list \-f xml +.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. +. |