upstream/opnsense-src
1
0
Fork 0
mirror of https://github.com/opnsense/src.git synced 2026-02-18 18:20:26 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

MFC jail: make jail(8) man page more readable and more correct

Browse source 
The synopsis section of jail(8) is fine at showing everything that could
be on the command line, but doesn't make much sense. Add some sub-
sections for the different uses of the command.

Also fix up the paragraph about command-line parameter specification,
including removing some clearly erroneous information.

Approved by:    re (gjb)
Reviewed by:    dvl
Differential Revision:  https://reviews.freebsd.org/D41606

(cherry picked from commit dab7fc49e7a65379a0050e8cab0b50afacdc0fc5)
(cherry picked from commit db08e8ba0e7bebbd1af1ee91f0235cd36c9bb7d3)
This commit is contained in:
Jamie Gritton 2023-08-31 16:31:25 -07:00
parent 8b81116755
commit ad4f4146ef
1 changed files with 27 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
usr.sbin/jail/jail.8
View file

@ -23,32 +23,45 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd March 12, 2023
.Dd August 26, 2023
.Dt JAIL 8
.Os
.Sh NAME
.Nm jail
.Nd "manage system jails"
.Sh SYNOPSIS
.Ss From Configuration File
.Nm
.Op Fl cm
.Op Fl dqv
.Op Fl f Ar conf_file
.Op Fl p Ar limit
.Op Ar jail
.Nm
.Op Fl r
.Op Fl qv
.Op Fl f Ar conf_file
.Op Fl p Ar limit
.Op Cm * | Ar jail ...
.Ss Without Configuration File
.Nm
.Op Fl cm
.Op Fl dhilqv
.Op Fl J Ar jid_file
.Op Fl u Ar username
.Op Fl U Ar username
.Op Fl cmr
.Ar param Ns = Ns Ar value ...
.Op Cm command Ns = Ns Ar command ...
.Nm
.Op Fl dqv
.Op Fl f Ar conf_file
.Op Fl p Ar limit
.Op Fl cmr
.Op Ar jail
.Nm
.Op Fl qv
.Op Fl f Ar conf_file
.Op Fl rR
.Op Fl qv
.Op Cm * | Ar jail ...
.Ss Show Parameters
.Nm
.Op Fl f Ar conf_file
.Fl e
.Ar separator
.Ss Backward Compatibility
.Nm
.Op Fl dhilqv
.Op Fl J Ar jid_file
@ -58,10 +71,6 @@
.Op Fl s Ar securelevel
.Ar path hostname ip Ns Op Cm \&, Ns Ar ...
.Ar command ...
.Nm
.Op Fl f Ar conf_file
.Fl e
.Ar separator
.Sh DESCRIPTION
The
.Nm
@ -238,10 +247,10 @@ would apply to jails with names like
and
.Dq foo.bar.baz .
.Pp
A jail may be specified with parameters directly on the command line.
In this case, the
.Xr jail.conf 5
file will not be used.
A jail may also be specified via parameters directly on the command line in
.Dq name=value
form, ignoring the contents of
.Xr jail.conf 5 .
For backward compatibility, the command line may also have four fixed
parameters, without names:
.Ar path ,
@ -249,11 +258,6 @@ parameters, without names:
.Ar ip ,
and
.Ar command .
This mode will always create a new jail, and the
.Fl c
and
.Fl m
options do not apply (and must not be present).
.Ss Jail Parameters
Parameters in the
.Xr jail.conf 5