From nobody Thu Aug 31 23:32:34 2023 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4RcHWl1LZCz4rlqv; Thu, 31 Aug 2023 23:32:35 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4RcHWk73RMz3T8y; Thu, 31 Aug 2023 23:32:34 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1693524755; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=4QJMQg2+VnbCBsXxnSTl8eW4KJuiuwHqQCksLhVqwIg=; b=DhTWaxY4tgjuOocrm6Wyox2KGBUFegAviRbpxDOKz1wTFC30exf44fBf4NG2JQkjriH605 gtkwIUxtmVld9WQRxhHJPLg+1Qn2triljdgzqJslrMudT+UfTPSp/NXfjBL13utF9ExrPf x9C+EY4KuXkyKKkNgHKEAMgolnj9Nxb/VQQLGG2UiliG2FXk+3PjdmYOBFEosgmVFRKhIX cnIDXOCbOEPudqlOBhQl7gTvUTl0tmYCC1QYxLJiI+UaS7yxM2XKE6EEKybq+r9wDz4rAq X/Zn56L/NHxwJdlHqC9a1qLXYkmTvQM+mlsASbU5cfV+JIcvRjY/6hymarmK5g== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1693524755; a=rsa-sha256; cv=none; b=PWyNup4wrjFIcDqv0rbLtK1F/ATaxgI8GLvUriSclJv+m47QdkRxPpm4SSkQjN92EIvC27 JeqJIdbyuZniX29JrYgxmfyT51qDN7nhIYd6ukt122uDfegLhsO1flhx3+U5WUZbMtyCYL OSP8gVf50LZqzZp2F8j9EF4xqO3rJgAusL5IahX0rU4+Qv2aiyTQo9aEnDK+kWyTgR5hbE 9mfCz28iXAZKfgAyZmW0wWEU4IO2v3i3Q/PygJ+Cj4SAkpYzb2aBUY0YOBrcckY+lYes46 y3J+h5dYjF2pEYnAFQsLyUfqpHVmqPiI+JE5YtiF06jhgjPnf/MswCJeSpi1xg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1693524755; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=4QJMQg2+VnbCBsXxnSTl8eW4KJuiuwHqQCksLhVqwIg=; b=J28mJqkGGjQrrC6TTh+d+jNGyjoYAHRynYjc0hlAXdkaMLoJpWkMHWj+ue++fCOQ6E9CQ7 06PfArSLsu9MfHDdXmdDMRWHLdA5Hz/GPxvcM5jtKMuZrweGlrXD6/CCKVxmyDgw67OVCN D8nCBrThfR+P5fupUZEBV/TJIxw7ate+g3W3WY20vMMQcxJKDws8dkywfMggFofA965E43 GtGcI8iK6KDylU0nLMMQxQkw0/vhRP5zuClsk5buW2sJdYHQKQ3UAAGdlkWB5kdr8eleJr IEnBZbkUO+tWzLni5RcPxziRL496wD8oyGoeBfiMiF9OxVUPvc5/3VuyOUq8tw== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4RcHWk5vkyzd0k; Thu, 31 Aug 2023 23:32:34 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 37VNWYPq043905; Thu, 31 Aug 2023 23:32:34 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 37VNWYiB043902; Thu, 31 Aug 2023 23:32:34 GMT (envelope-from git) Date: Thu, 31 Aug 2023 23:32:34 GMT Message-Id: <202308312332.37VNWYiB043902@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Jamie Gritton Subject: git: ad4f4146ef30 - stable/14 - MFC jail: make jail(8) man page more readable and more correct List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: jamie X-Git-Repository: src X-Git-Refname: refs/heads/stable/14 X-Git-Reftype: branch X-Git-Commit: ad4f4146ef30b52890593a5f00ff151be75d729b Auto-Submitted: auto-generated The branch stable/14 has been updated by jamie: URL: https://cgit.FreeBSD.org/src/commit/?id=ad4f4146ef30b52890593a5f00ff151be75d729b commit ad4f4146ef30b52890593a5f00ff151be75d729b Author: Jamie Gritton AuthorDate: 2023-08-31 23:31:25 +0000 Commit: Jamie Gritton CommitDate: 2023-08-31 23:31:25 +0000 MFC jail: make jail(8) man page more readable and more correct 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) --- usr.sbin/jail/jail.8 | 50 +++++++++++++++++++++++++++----------------------- 1 file changed, 27 insertions(+), 23 deletions(-) diff --git a/usr.sbin/jail/jail.8 b/usr.sbin/jail/jail.8 index ef071aae863e..0e98914795a2 100644 --- a/usr.sbin/jail/jail.8 +++ b/usr.sbin/jail/jail.8 @@ -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 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 cm .Op Fl dqv .Op Fl f Ar conf_file .Op Fl p Ar limit -.Op Fl cmr .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 +.Ar param Ns = Ns Ar value ... +.Op Cm command Ns = Ns Ar command ... +.Nm .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