From f0966c697855767e3cd7d92f96f0801099e14f38 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Tue, 22 Nov 2016 16:09:51 +0100 Subject: Merging upstream version 20161122. Signed-off-by: Daniel Baumann --- share/man/container-list.1 | 108 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 108 insertions(+) create mode 100644 share/man/container-list.1 (limited to 'share/man/container-list.1') diff --git a/share/man/container-list.1 b/share/man/container-list.1 new file mode 100644 index 0000000..c446346 --- /dev/null +++ b/share/man/container-list.1 @@ -0,0 +1,108 @@ +'\" t +.\" Title: container-list +.\" Author: [see the "AUTHORS" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 20161112 +.\" Manual: Open Infrastructure +.\" Source: container-tools +.\" Language: English +.\" +.TH "CONTAINER\-LIST" "1" "20161112" "container\-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] +.sp +\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\-f, \-\-format=\fR\fB\fIFORMAT\fR\fR +.RS 4 +Use format to list container\&. Currently available formats are +\fIshort\fR +or +\fIfull\fR +(default)\&. +.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\-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 stopped containers of the local system as a machine\-readable list:\fR +.RS 4 +sudo container list \-f short +.RE +.PP +\fBList all started and other containers:\fR +.RS 4 +sudo container list \-s \-o +.RE +.SH "SEE ALSO" +.sp +container\-tools(7), container(1)\&. +.SH "HOMEPAGE" +.sp +More information about container\-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 +container\-tools was written by Daniel Baumann \&. -- cgit v1.2.3