Page Menu
Home
FreeBSD
Search
Configure Global Search
Log In
Files
F102620343
D33394.diff
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Flag For Later
Award Token
Size
1 KB
Referenced Files
None
Subscribers
None
D33394.diff
View Options
diff --git a/share/man/man5/style.mdoc.5 b/share/man/man5/style.mdoc.5
--- a/share/man/man5/style.mdoc.5
+++ b/share/man/man5/style.mdoc.5
@@ -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 @@
.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
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Fri, Nov 15, 10:11 PM (20 h, 32 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
14648737
Default Alt Text
D33394.diff (1 KB)
Attached To
Mode
D33394: style.mdoc.5: Document the conventions for -width
Attached
Detach File
Event Timeline
Log In to Comment