mirror/freebsd
1
0
Fork 0
mirror of https://git.FreeBSD.org/src.git synced 2024-10-18 02:19:39 +00:00
Code Issues Releases Activity

style.mdoc.5: maintenence

Browse Source 
- description: increase visibility by s/file/manual page/
- examples: s/No Doing Something/Doing Something/
- examples: remove depreciated .Li macro
- examples: remove extra newline (one display block)
- see also: link roff language reference for mandoc

Reviewed by: imp
Pull Request: https://github.com/freebsd/freebsd-src/pull/1130
This commit is contained in:
Alexander Ziaee 2024-04-12 16:28:12 -06:00 committed by Warner Losh
parent 2b2cd97844
commit e7ff917057
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,4 +1,4 @@
.\"
.\"-
.\" SPDX-License-Identifier: BSD-2-Clause
.\"
.\" Copyright (c) 2018-2022 Mateusz Piotrowski <0mp@FreeBSD.org>
@ -24,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd January 29, 2022
.Dd April 12, 2024
.Dt STYLE.MDOC 5
.Os
.Sh NAME
@ -32,7 +32,7 @@
.Nd
.Fx
.Xr mdoc 7
file style guide
manual page style guide
.Sh DESCRIPTION
This file specifies the preferred style for manual pages in the
.Fx
@ -82,17 +82,17 @@ Format the
section in the following way:
.Bd -literal -offset indent
\&.Bl -tag -width 0n
\&.It Sy Example 1\\&: No Doing Something
\&.It Sy Example 1\\&: Doing Something
\&.Pp
The following command does something.
\&.Bd -literal -offset 2n
\&.Li # Ic make -VLEGAL
\&.Ic # make -VLEGAL
\&.Ed
\&.It Sy Example 2\\&: No Doing Something Different
\&.It Sy Example 2\\&: Doing Something Different
\&.Pp
The following command does something different.
\&.Bd -literal -offset 2n
\&.Li # Ic bectl list
\&.Ic # bectl list
\&.Ed
\&.Pp
It is good to know this command.
@ -100,24 +100,22 @@ It is good to know this command.
.Ed
.Pp
which renders as:
.Bd -filled -offset indent
.Bl -tag -width 0n
.It Sy Example 1\&: No Doing Something
.It Sy Example 1\&: Doing Something
.Pp
The following command does something.
.Bd -literal -offset 2n
.Li # Ic make -VLEGAL
.Ic # make -VLEGAL
.Ed
.It Sy Example 2\&: No Doing Something Different
.It Sy Example 2\&: Doing Something Different
.Pp
The following command does something different.
.Bd -literal -offset 2n
.Li # Ic bectl list
.Ic # bectl list
.Ed
.Pp
It is good to know this command.
.El
.Ed
.El
.Ss Lists
.Bl -dash -width ""
@ -285,6 +283,7 @@ that would be rendered as:
.Xr man 1 ,
.Xr mandoc 1 ,
.Xr mdoc 7 ,
.Xr roff 7 ,
.Xr style 9
.Sh HISTORY
This manual page first appeared in