summaryrefslogtreecommitdiffstats
path: root/share/man/container-list.1
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/container-list.1')
-rw-r--r--share/man/container-list.1158
1 files changed, 158 insertions, 0 deletions
diff --git a/share/man/container-list.1 b/share/man/container-list.1
new file mode 100644
index 0000000..dff50ee
--- /dev/null
+++ b/share/man/container-list.1
@@ -0,0 +1,158 @@
+'\" t
+.\" Title: container-list
+.\" Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\" Date: 20190304
+.\" Manual: Open Infrastructure
+.\" Source: compute-tools
+.\" Language: English
+.\"
+.TH "CONTAINER\-LIST" "1" "20190304" "compute\-tools" "Open Infrastructure"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+container-list \- List container on the system
+.SH "SYNOPSIS"
+.sp
+\fBcontainer list\fR [\fIOPTIONS\fR] \fBcontainer ls\fR [\fIOPTIONS\fR]
+.SH "DESCRIPTION"
+.sp
+The container list command lists container on the system\&.
+.SH "OPTIONS"
+.sp
+The following container options are available, defaults to \fB\-\-started \-\-stopped\fR:
+.PP
+\fB\-a, \-\-all\fR
+.RS 4
+List all available container (started, stopped, and other)\&.
+.RE
+.PP
+\fB\-\-csv\-separator=\fR\fB\fISEPARATOR\fR\fR
+.RS 4
+Specify custom CSV separator, defaults to
+\fI,\fR\&.
+.RE
+.PP
+\fB\-f, \-\-format=\fR\fB\fIFORMAT\fR\fR
+.RS 4
+Use format to list container\&. Currently available formats are
+\fIcli\fR
+(default),
+\fIcsv\fR,
+\fIjson\fR,
+\fInwdiag\fR,
+\fIshell\fR,
+\fIsh\fR,
+\fIyaml\fR, or
+\fIxml\fR\&.
+.RE
+.PP
+\fB\-h, \-\-host=\fR\fB\fIHOSTNAME\fR\fR
+.RS 4
+List only container that are enabled for automatic start on the specified hostname\&. Defaults to list containers of the local system only\&. Using
+\fIall\fR
+shows all container regardless of any automatic start configuration\&.
+.RE
+.PP
+\fB\-\-nwdiag\-color=\fR\fB\fICOLOR\fR\fR
+.RS 4
+Specify custom nwdiag color for the host box, defaults to
+\fI#3465a4\fR\&.
+.RE
+.PP
+\fB\-\-nwdiag\-label=\fR\fB\fILABEL\fR\fR
+.RS 4
+Specify custom nwdiag label for the diagram, defaults to empty\&.
+.RE
+.PP
+\fB\-o, \-\-other\fR
+.RS 4
+List only container that are not enable for automatic start on the current system\&.
+.RE
+.PP
+\fB\-s, \-\-started\fR
+.RS 4
+List only started container\&.
+.RE
+.PP
+\fB\-t, \-\-stopped\fR
+.RS 4
+List only stopped container\&.
+.RE
+.SH "EXAMPLES"
+.PP
+\fBList all started and stopped containers of the local system:\fR
+.RS 4
+sudo container list
+.RE
+.PP
+\fBList all started and other containers:\fR
+.RS 4
+sudo container list \-s \-o
+.RE
+.PP
+\fBCreate a CSV export of all started and stopped containers:\fR
+.RS 4
+sudo container list \-f csv
+.RE
+.PP
+\fBCreate a JSON export of all started and stopped containers:\fR
+.RS 4
+sudo container list \-f json
+.RE
+.PP
+\fBCreate a nwdiag export of all started and stopped containers:\fR
+.RS 4
+sudo container list \-f nwdiag
+.RE
+.PP
+\fBCreate a SVG image via nwdiag of all started and stopped containers:\fR
+.RS 4
+sudo container list \-f nwdiag | nwdiag \-T svg \-o cnt\-list\&.svg \-
+.RE
+.PP
+\fBCreate a shell export of all started and stopped containers:\fR
+.RS 4
+sudo container list \-f shell sudo container list \-f sh
+.RE
+.PP
+\fBCreate a YAML export of all started and stopped containers:\fR
+.RS 4
+sudo container list \-f yaml
+.RE
+.PP
+\fBCreate a XML export of all started and stopped containers:\fR
+.RS 4
+sudo container list \-f xml
+.RE
+.SH "SEE ALSO"
+.sp
+compute\-tools(7), container(1)\&.
+.SH "HOMEPAGE"
+.sp
+More information about compute\-tools and the Open Infrastructure project can be found on the homepage at https://open\-infrastructure\&.net\&.
+.SH "CONTACT"
+.sp
+Bug reports, feature requests, help, patches, support and everything else are welcome on the Open Infrastructure Software Mailing List <software@lists\&.open\-infrastructure\&.net>\&.
+.sp
+Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs\&.debian\&.org\&.
+.SH "AUTHORS"
+.sp
+compute\-tools were written by Daniel Baumann <daniel\&.baumann@open\-infrastructure\&.net> and others\&.