git: e36af20691d8 - main - jail.conf.5: cleanup introduction

From: Warner Losh <imp_at_FreeBSD.org>
Date: Sat, 21 Sep 2024 13:04:13 UTC
The branch main has been updated by imp:

URL: https://cgit.FreeBSD.org/src/commit/?id=e36af20691d8922ecf416170a56d06aca62a0ccd

commit e36af20691d8922ecf416170a56d06aca62a0ccd
Author:     Ingo Schwarze <schwarze@usta.de>
AuthorDate: 2024-09-14 01:12:18 +0000
Commit:     Warner Losh <imp@FreeBSD.org>
CommitDate: 2024-09-21 13:03:21 +0000

    jail.conf.5: cleanup introduction
    
    Suggested by ingo on mandoc-tech@
    
    MFC after:      3 days
    
    Reviewed by: imp
    Pull Request: https://github.com/freebsd/freebsd-src/pull/1422
---
 usr.sbin/jail/jail.conf.5 | 36 ++++++++++++++++++------------------
 1 file changed, 18 insertions(+), 18 deletions(-)

diff --git a/usr.sbin/jail/jail.conf.5 b/usr.sbin/jail/jail.conf.5
index f2c1861cc304..627c38b0f8b6 100644
--- a/usr.sbin/jail/jail.conf.5
+++ b/usr.sbin/jail/jail.conf.5
@@ -30,29 +30,29 @@
 .Os
 .Sh NAME
 .Nm jail.conf
-.Nd configuration file for
-.Xr jail 8
+.Nd configuration file for system jails
 .Sh DESCRIPTION
-A
+The
+.Nm
+file consists of one or more jail definitions statements for use by the
 .Xr jail 8
-configuration file consists of one or more jail definitions statements,
-and parameter or variable statements within those jail definitions.
-A jail definition statement looks something like a C compound statement.
-A parameter statement looks like a C assignment,
-including a terminating semicolon.
+management program.
+A jail definition statement consists of a single word, the name of the jail,
+an opening curly brace, a list of at least two parameter assignments,
+and a closing curly brace.
+A parameter assignment consists of a single word, the parameter name,
+an equals sign, a value enclosed in double quotes, and a terminating semicolon.
 .Pp
-The general syntax of a jail definition is:
-.Bd -literal -offset indent
-jailname {
-	parameter = "value";
-	parameter = "value";
-	...
-}
+The syntax of a jail definition is as follows:
+.Bd -unfilled
+. Ar jailname Cm \&{
+.Bd -unfilled -offset indent -compact
+.Ar parameter Cm = Qq Ar value ;
+\&...
+.Ed
+.Cm \&}
 .Ed
 .Pp
-Each jail is required to have a
-.Va name
-at the front of its definition.
 This is used by
 .Xr jail 8
 to specify a jail on the command line and report the jail status,