upstream/opnsense-src
1
0
Fork 0
mirror of https://github.com/opnsense/src.git synced 2026-06-06 15:22:34 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

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