d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

style.mdoc.5: Document the conventions for -width

Browse Source 
Reviewed by:	debdrup
MFC after:	2 weeks
Differential Revision:	https://reviews.freebsd.org/D33394
This commit is contained in:
Mateusz Piotrowski 2022-01-29 22:23:49 +01:00
parent 60401b3883
commit 79afae3b3f
1 changed files with 38 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
share/man/man5/style.mdoc.5
View File

@ -1,7 +1,7 @@
.\"
.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
.\"
.\" Copyright (c) 2018-2021 Mateusz Piotrowski <0mp@FreeBSD.org>
.\" Copyright (c) 2018-2022 Mateusz Piotrowski <0mp@FreeBSD.org>
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@ -26,7 +26,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd December 3, 2021
.Dd January 29, 2022
.Dt STYLE.MDOC 5
.Os
.Sh NAME
@ -121,6 +121,42 @@ It is good to know this command.
.El
.Ed
.El
.Ss Lists
.Bl -dash -width ""
.It
The
.Fl width
argument to the
.Sy \&.Bl
macro should match the length of the longest item in the list, e.g.:
.Bd -literal -offset indent
\&.Bl -tag -width "-a address"
\&.It Fl a Ar address
Set the address.
\&.It Fl v
Print the version.
\&.El
.Ed
.Pp
In case the longest item is too long and hurts readability,
the recommendation is to set
the
.Fl width
argument
to
.Ql indent ,
e.g.:
.Bd -literal -offset indent
\&.Bl -tag -width "indent"
\&.It Cm build
Build the port.
\&.It Cm install
Install the port.
\&.It Fl install-missing-packages
Install the missing packages.
\&.El
.Ed
.El
.Ss Synopsis Formatting
.Bl -dash -width ""
.It