summaryrefslogtreecommitdiffstats
path: root/share/examples/mdoc/example.4
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2001-07-18 10:04:34 +0000
committerru <ru@FreeBSD.org>2001-07-18 10:04:34 +0000
commitf24cad11ffba09a2fd48e40e9afb8b7f7453033c (patch)
tree7dc9663cd616b2208667d9155a0c11f4d6b1243f /share/examples/mdoc/example.4
parent06fdcd5035e75a5e46d2049a186d4ceed2d03ece (diff)
downloadFreeBSD-src-f24cad11ffba09a2fd48e40e9afb8b7f7453033c.zip
FreeBSD-src-f24cad11ffba09a2fd48e40e9afb8b7f7453033c.tar.gz
Removed the comment that required all FreeBSD manpages
to have the $FreeBSD$ keyword, as this is now enforced by the CVSROOT/commit_prep.pl script. Fold multi-word macro arguments into a single argument by putting the surrounding double quotes - this speeds up the -mdoc processing drastically (of course if used systematically). Use the new features of -mdoc: exact -width specifiers, .In macro as an ``.Fd #include'' replacement.
Diffstat (limited to 'share/examples/mdoc/example.4')
-rw-r--r--share/examples/mdoc/example.417
1 files changed, 7 insertions, 10 deletions
diff --git a/share/examples/mdoc/example.4 b/share/examples/mdoc/example.4
index 1bb8f13..80ed2a4 100644
--- a/share/examples/mdoc/example.4
+++ b/share/examples/mdoc/example.4
@@ -23,9 +23,6 @@
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
-.\" Note: All FreeBSD man pages should have a FreeBSD revision
-.\" control id to make it easier for translation teams to track
-.\" changes.
.\"
.\" Note: The date here should be updated whenever a non-trivial
.\" change is made to the manual page.
@@ -34,10 +31,10 @@
.Os
.Sh NAME
.Nm example
-.Nd example device driver manual page
+.Nd "example device driver manual page"
.Sh SYNOPSIS
-.Cd device example
-.Cd options EXAMPLE_DEBUG
+.Cd "device example"
+.Cd "options EXAMPLE_DEBUG"
.Sh DESCRIPTION
This is an example device driver manual page for the
.Nm
@@ -48,7 +45,7 @@ when writing a new manual page.
The
.Nm
driver supports the following ioctls:
-.Bl -tag -width XXXXXXXXXXX
+.Bl -tag -width ".Dv EIOCNULL"
.It Dv EIOCEX
Example ioctl.
.It Dv EIOCNULL
@@ -59,7 +56,7 @@ If the kernel is compiled with the
.Dv EXAMPLE_DEBUG
option, then additional debugging messages will be displayed.
.Sh FILES
-.Bl -tag -width /dev/null -compact
+.Bl -tag -width ".Pa /dev/null" -compact
.It Pa /dev/null
Example of a file in the
.Sx FILES
@@ -67,9 +64,9 @@ section.
.El
.Sh DIAGNOSTICS
.Bl -diag
-.It example%d: example diagnostic message.
+.It "example%d: example diagnostic message."
An example of a diagnostic message.
-.It example%d: another example diagnostic message.
+.It "example%d: another example diagnostic message."
Self explanatory.
.El
.Sh SEE ALSO
OpenPOWER on IntegriCloud