From nobody Mon Aug 28 18:25:39 2023 X-Original-To: dev-commits-src-main@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 4RZJs01Slsz4rq20; Mon, 28 Aug 2023 18:25:40 +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 4RZJs00zKsz3WZ3; Mon, 28 Aug 2023 18:25:40 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1693247140; 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=sFH3XmF4maRhpZULmepBdHu3EvBchSEVxcUpSSBbdiM=; b=mg20jaKoQBVGScMUJbr1HrprcqVk3srdqBw5KzOjaB/iiZ6+W9V25HCB/+vlselwKO9xiH RZ0vzH0p5bz9XZptXbjpVntdtu3aHeRMqSSgGvW8rOQDdWnWGFfd5xCS7y/ENqvXyvJh4E hPkI0vk/xkSAWIdjheXfHqYh7f1tFc/przFMouHlwd/mRGDCAQzi9dvmMoxBwKcSNklEL9 wfXGzN7ME1vCo09/erXHi1ih5aGecVTo3lbwh474u1fkuuDulq7FmOb4B8gyStwKvsvn2X UMW/DZxz5WpG1+Ok3iAEgduc1LoIICcHmYa6tmCcK9sMx00mbHe0e+1JzbyVvg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1693247140; a=rsa-sha256; cv=none; b=vLdpBM6YjP0Oh3HPUo6Zuzm9J7RjwCUfphj2cgUmk0u6tO/2gPAQf48WfzWjI740WUd6W/ e4oT2j5JAbPl7zQX3DJSB4qWEfgRGSKi5PPv7HKPELuTHnAQfxYR76qusPy2YQXEmTGwDk 8wgtrZxm/f501WNDEWt4zCjhod0bXaNIwCY/tEODOkOSfNq1yMPDuv+R4ZRAyUNIQrlOlA C23sCaQ+gg+sHmZcywxiNZmuFJzzygaBC3GbkaN964EKC5E84X5K3ch/jD6Suzu9b+Db43 0De64Y+3OCTCoISLYeibNBGKPL1ruTBGN51TxqswPDmpAshjJns6IqvGXuRWCA== 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=1693247140; 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=sFH3XmF4maRhpZULmepBdHu3EvBchSEVxcUpSSBbdiM=; b=sL18JqMiN0FgJPgGf/UF4ENaY54qa8+xytKFbyamRhnwB09L4RHdTqa0BIiHVxSc8/7EYv JtF0q9X5EB11tUn2mNE1k28+sGeDkOvmwT2t80dSgYHu9z54O9T0C1iI0OhoNldYpVKzjA Wh8SEfzwOokcvmQZHQRaIgIza4YWGlxySzWbucSn2Uro1Nz1RtYyhE2UzVEfEnX52eB2iP FGKSU3mqvImPh88Gg7A/CSgY5uGvyOFuYAfpOaRDmcsvb7+pQVtTUV2EB6AaqPPXq2d0JD yhD3T2bE/+01qYfLPlXtg4Q6THZqU4pE84mlgxXEfS4JSu2KB3/aYW33IxJCNA== 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 4RZJs002p4z4Nr; Mon, 28 Aug 2023 18:25:40 +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 37SIPdje061577; Mon, 28 Aug 2023 18:25:39 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 37SIPdaI061574; Mon, 28 Aug 2023 18:25:39 GMT (envelope-from git) Date: Mon, 28 Aug 2023 18:25:39 GMT Message-Id: <202308281825.37SIPdaI061574@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Jamie Gritton Subject: git: dab7fc49e7a6 - main - jail: make jail(8) man page more readable and more correct List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-main@freebsd.org X-BeenThere: dev-commits-src-main@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/main X-Git-Reftype: branch X-Git-Commit: dab7fc49e7a65379a0050e8cab0b50afacdc0fc5 Auto-Submitted: auto-generated The branch main has been updated by jamie: URL: https://cgit.FreeBSD.org/src/commit/?id=dab7fc49e7a65379a0050e8cab0b50afacdc0fc5 commit dab7fc49e7a65379a0050e8cab0b50afacdc0fc5 Author: Jamie Gritton AuthorDate: 2023-08-28 18:22:36 +0000 Commit: Jamie Gritton CommitDate: 2023-08-28 18:22:36 +0000 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- ections for the different uses of the command. Also fix up the paragraph about command-line parameter specification, including removing some clearly erroneous information. Reviewed by: dvl MFC after: 3 days Differential Revision: https://reviews.freebsd.org/D41606 --- usr.sbin/jail/jail.8 | 52 +++++++++++++++++++++++++++++----------------------- 1 file changed, 29 insertions(+), 23 deletions(-) diff --git a/usr.sbin/jail/jail.8 b/usr.sbin/jail/jail.8 index ef071aae863e..6fb5fdfa0623 100644 --- a/usr.sbin/jail/jail.8 +++ b/usr.sbin/jail/jail.8 @@ -23,32 +23,47 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd March 12, 2023 +.\" $FreeBSD$ +.\" +.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 +73,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 +249,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 +260,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