xref: /freebsd/usr.sbin/jls/jls.8 (revision 195ebc7e9e4b129de810833791a19dfb4349d6a9)
1.\"
2.\" Copyright (c) 2003 Mike Barcroft <mike@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd May 27, 2009
29.Dt JLS 8
30.Os
31.Sh NAME
32.Nm jls
33.Nd "list jails"
34.Sh SYNOPSIS
35.Nm
36.Op Fl dhnqsv
37.Op Fl j Ar jail
38.Op Ar parameter ...
39.Sh DESCRIPTION
40The
41.Nm
42utility lists all active jails, or the specified jail.
43Each jail is represented by one row which contains space-separated values of
44the listed
45.Ar parameters ,
46including the pseudo-parameter
47.Va all
48which will show all available jail parameters.
49A list of available parameters can be retrieved via
50.Dq Nm sysctl Fl d Va security.jail.param .
51See
52.Xr jail 8
53for a description of some core parameters.
54.Pp
55If no
56.Ar parameters
57are given, the following four columns will be printed:
58jail identifier (jid), IP address (ip4.addr), hostname (host.hostname),
59and path (path).
60.Pp
61The following options are available:
62.Bl -tag -width indent
63.It Fl d
64List
65.Va dying
66as well as active jails.
67.It Fl h
68Print a header line containing the parameters listed.
69If no parameters are given on the command line, the default output always
70contains a header.
71.It Fl n
72Print parameters in
73.Dq name=value
74format, where each parameter is preceded by its name.
75This option is ignored for the default four-column output.
76.It Fl q
77Put quotes around parameters if they contain spaces or quotes, or are
78the empty string.
79.It Fl c
80Print parameters suitable for passing to
81.Xr jail 8 ,
82skipping read-only and unused parameters.
83Implies
84.Fl nq .
85.It Fl v
86Print a multiple-line summary per jail, with the following parameters:
87jail identifier (jid), hostname (host.hostname), path (path),
88jail name (name), jail state (dying), cpuset ID (cpuset),
89IP address(es) (ip4.addr and ip6.addr).
90.It Fl j Ar jail
91The jid or name of the
92.Ar jail
93to list.
94Without this option, all active jails will be listed.
95.El
96.Sh SEE ALSO
97.Xr jail_get 2 ,
98.Xr jail 8 ,
99.Xr jexec 8
100.Sh HISTORY
101The
102.Nm
103utility was added in
104.Fx 5.1 .
105Extensible jail parameters were introduced in
106.Fx 8.0 .
107