lxc-ls.sgml.in revision 250b1eec71b074acdff1c5f6b5a1f0d7d2c20b77
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoolxc: linux Container library
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo(C) Copyright IBM Corp. 2007, 2008
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooThis library is free software; you can redistribute it and/or
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoomodify it under the terms of the GNU Lesser General Public
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooLicense as published by the Free Software Foundation; either
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yooversion 2.1 of the License, or (at your option) any later version.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooThis library is distributed in the hope that it will be useful,
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoobut WITHOUT ANY WARRANTY; without even the implied warranty of
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooLesser General Public License for more details.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooYou should have received a copy of the GNU Lesser General Public
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooLicense along with this library; if not, write to the Free Software
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooFoundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<!DOCTYPE refentry PUBLIC @docdtd@ [
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <refentrytitle>lxc-ls</refentrytitle>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <manvolnum>1</manvolnum>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <refnamediv>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <refname>lxc-ls</refname>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <refpurpose>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo list the containers existing on the system
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </refpurpose>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </refnamediv>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <refsynopsisdiv>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <cmdsynopsis>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <command>lxc-ls</command>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <arg choice="opt">-1</arg>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <arg choice="opt">--active</arg>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <arg choice="opt">--frozen</arg>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <arg choice="opt">--running</arg>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <arg choice="opt">--stopped</arg>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <arg choice="opt">--fancy</arg>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <arg choice="opt">--fancy-format</arg>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <arg choice="opt">--nesting</arg>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <arg choice="opt">filter</arg>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </cmdsynopsis>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </refsynopsisdiv>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <title>Description</title>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <command>lxc-ls</command> list the containers existing on the
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <title>Options</title>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <variablelist>
76072aec5c984b9e91bd4344ab013e38d8bff311Sungbae Yoo <varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <option><optional>-1</optional></option>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo Show one entry per line. (default when /dev/stdout isn't a tty)
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <option><optional>--active</optional></option>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo List only active containers (same as --frozen --running).
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <option><optional>--frozen</optional></option>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo List only frozen containers.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <option><optional>--running</optional></option>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo List only running containers.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <option><optional>--stopped</optional></option>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo List only stopped containers.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <option><optional>--fancy</optional></option>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo Use a fancy, column-based output.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <option><optional>--fancy-format</optional></option>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo Comma separate list of column to show in the fancy output.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo Valid values are: name, state, ipv4, ipv6 and pid
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo Default is: name,state,ipv4,ipv6
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <option><optional>--nesting</optional></option>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo Show nested containers.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <varlistentry>
76072aec5c984b9e91bd4344ab013e38d8bff311Sungbae Yoo <option><optional>filter</optional></option>
76072aec5c984b9e91bd4344ab013e38d8bff311Sungbae Yoo The filter passed to <command>lxc-ls</command> will be
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo applied to the container name. The format is a regular expression.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </variablelist>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <title>See Also</title>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <citerefentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <refentrytitle>ls</refentrytitle>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <manvolnum>1</manvolnum>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </citerefentry>,
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <title>Examples</title>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <variablelist>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <term>lxc-ls --fancy</term>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo list all the containers, listing one per line along with its
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo name, state, ipv4 and ipv6 addresses.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <varlistentry>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo <term>lxc-ls --active -1</term>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo list active containers and display the list in one column.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo </varlistentry>