=================================================================== RCS file: /cvs/mandoc/mdoc.7,v retrieving revision 1.295 retrieving revision 1.296 diff -u -p -r1.295 -r1.296 --- mandoc/mdoc.7 2025/01/02 13:52:26 1.295 +++ mandoc/mdoc.7 2025/01/27 03:17:33 1.296 @@ -1,4 +1,4 @@ -.\" $Id: mdoc.7,v 1.295 2025/01/02 13:52:26 schwarze Exp $ +.\" $Id: mdoc.7,v 1.296 2025/01/27 03:17:33 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons .\" Copyright (c) 2010, 2011, 2013-2020 Ingo Schwarze @@ -15,7 +15,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: January 2 2025 $ +.Dd $Mdocdate: January 27 2025 $ .Dt MDOC 7 .Os .Sh NAME @@ -2297,14 +2297,15 @@ Close single-quoted context opened by Begin a new section. For a list of conventional manual sections, see .Sx MANUAL STRUCTURE . -These sections should be used unless it's absolutely necessary that -custom sections be used. +Use the conventional sections where applicable. +For unusually long and complicated manual pages, +adding custom sections is occasionally useful. .Pp -Section names should be unique so that they may be keyed by +Avoid using macros inside the +.Ar TITLE LINE +and keep that line unique within the manual page, +such that it can be pointed to with .Ic \&Sx . -Although this macro is parsed, it should not consist of child node or it -may not be linked with -.Ic \&Sx . .Pp See also .Ic \&Pp , @@ -2353,10 +2354,10 @@ the conventional sections described in .Sx MANUAL STRUCTURE rarely have subsections. .Pp -Sub-section names should be unique so that they may be keyed by -.Ic \&Sx . -Although this macro is parsed, it should not consist of child node or it -may not be linked with +Avoid using macros inside the +.Ar Title line +and keep that line unique within the manual page, +such that it can be pointed to with .Ic \&Sx . .Pp See also