d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
bded3c3768
freebsd-skq/share/examples/mdoc/example.4

126 lines
3.2 KiB
Groff
Raw Normal View History

Synced with the C example copyright. Cosmetic except for removing clause 3, which was removed on 1996/08/03 in the C example.
1997-02-28 10:09:09 +00:00
.\" Copyright (c) [year] [your name]
.\" All rights reserved.
Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc, since it seemed like a better place, and the makefiles for /usr/share/examples didn't need to be fussed with. The old stuff can be removed from the Attic.
1997-01-02 20:37:25 +00:00
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
Synced with the C example copyright. Cosmetic except for removing clause 3, which was removed on 1996/08/03 in the C example.
1997-02-28 10:09:09 +00:00
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc, since it seemed like a better place, and the makefiles for /usr/share/examples didn't need to be fussed with. The old stuff can be removed from the Attic.
1997-01-02 20:37:25 +00:00
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
Add $FreeBSD$ lines to these example man pages, along with a note that says all man pages should contain a FreeBSD revision control id to make it easier for translation teams.
1999-08-28 23:32:12 +00:00
.\" $FreeBSD$
Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc, since it seemed like a better place, and the makefiles for /usr/share/examples didn't need to be fussed with. The old stuff can be removed from the Attic.
1997-01-02 20:37:25 +00:00
.\"
Add some real example diagnostics to example.[14] Add all of the possible errno's to example.3. Show examples of the .Bx (BSD) and .At (AT&T UNIX) macros in the various HISTORY sections. Add some .Rs/.Re (used for referencing things other than man pages) in the SEE ALSO sections. Suggested by: wollman
1997-01-09 06:32:22 +00:00
.\" Note: The date here should be updated whenever a non-trivial
.\" change is made to the manual page.
Add a standard boilerplate to the SYNOPSIS section that mentions how to load a kernel module. MFC after: 3 days
2006-04-01 10:10:36 +00:00
.Dd April 1, 2006
Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc, since it seemed like a better place, and the makefiles for /usr/share/examples didn't need to be fussed with. The old stuff can be removed from the Attic.
1997-01-02 20:37:25 +00:00
.Dt EXAMPLE 4 i386
The semantics of the .Os call has been changed. For CURRENT, this currently implies the default argument of "FreeBSD 5.0".
2001-04-23 15:15:49 +00:00
.Os
Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc, since it seemed like a better place, and the makefiles for /usr/share/examples didn't need to be fussed with. The old stuff can be removed from the Attic.
1997-01-02 20:37:25 +00:00
.Sh NAME
.Nm example
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.
2001-07-18 10:04:34 +00:00
.Nd "example device driver manual page"
Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc, since it seemed like a better place, and the makefiles for /usr/share/examples didn't need to be fussed with. The old stuff can be removed from the Attic.
1997-01-02 20:37:25 +00:00
.Sh SYNOPSIS
Revert my previous change as it does not seem to be entirely correct and popular.
2006-09-27 21:28:44 +00:00
To compile the
driver into the kernel,
place the following lines in the
kernel configuration file:
Add a standard boilerplate to the SYNOPSIS section that mentions how to load a kernel module. MFC after: 3 days
2006-04-01 10:10:36 +00:00
.Bd -ragged -offset indent
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.
2001-07-18 10:04:34 +00:00
.Cd "device example"
.Cd "options EXAMPLE_DEBUG"
Add a standard boilerplate to the SYNOPSIS section that mentions how to load a kernel module. MFC after: 3 days
2006-04-01 10:10:36 +00:00
.Ed
.Pp
Fix wording to what I intended originally.
2006-09-18 15:18:54 +00:00
Alternatively, to load the
Revert my previous change as it does not seem to be entirely correct and popular.
2006-09-27 21:28:44 +00:00
driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
Add a standard boilerplate to the SYNOPSIS section that mentions how to load a kernel module. MFC after: 3 days
2006-04-01 10:10:36 +00:00
.Bd -literal -offset indent
example_load="YES"
.Ed
Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc, since it seemed like a better place, and the makefiles for /usr/share/examples didn't need to be fussed with. The old stuff can be removed from the Attic.
1997-01-02 20:37:25 +00:00
.Sh DESCRIPTION
Remove an example of bad sentence breaking style.
2001-07-18 08:51:04 +00:00
This is an example device driver manual page for the
mdoc(7) police: use the new features of the Nm macro.
2000-11-20 16:52:27 +00:00
.Nm
Remove an example of bad sentence breaking style.
2001-07-18 08:51:04 +00:00
driver.
It is intended that this example can be used as a template
when writing a new manual page.
Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc, since it seemed like a better place, and the makefiles for /usr/share/examples didn't need to be fussed with. The old stuff can be removed from the Attic.
1997-01-02 20:37:25 +00:00
.Pp
The
.Nm
driver supports the following ioctls:
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.
2001-07-18 10:04:34 +00:00
.Bl -tag -width ".Dv EIOCNULL"
Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc, since it seemed like a better place, and the makefiles for /usr/share/examples didn't need to be fussed with. The old stuff can be removed from the Attic.
1997-01-02 20:37:25 +00:00
.It Dv EIOCEX
Example ioctl.
.It Dv EIOCNULL
Example ioctl.
.El
We don't use the "pseudo-device" configuration option any longer, so update the example to use the correct definition. Add an example for documenting kernel compile options, along with a small example of how to reference them in the main text of the man page (I.e. the .Dv macro). Inspired-by: a brief exchange I saw in in the commit messages mail
2001-04-05 09:37:55 +00:00
.Pp
If the kernel is compiled with the
.Dv EXAMPLE_DEBUG
option, then additional debugging messages will be displayed.
Add a HARDWARE section to the example section 4 manual page. Reviewed by: ru MFC after: 3 days
2004-08-18 07:05:35 +00:00
.Sh HARDWARE
The
.Nm
driver supports the following example hardware:
.Pp
.Bl -bullet -compact
.It
Example device 4201
.It
Example device 4202
.El
Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc, since it seemed like a better place, and the makefiles for /usr/share/examples didn't need to be fussed with. The old stuff can be removed from the Attic.
1997-01-02 20:37:25 +00:00
.Sh FILES
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.
2001-07-18 10:04:34 +00:00
.Bl -tag -width ".Pa /dev/null" -compact
Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc, since it seemed like a better place, and the makefiles for /usr/share/examples didn't need to be fussed with. The old stuff can be removed from the Attic.
1997-01-02 20:37:25 +00:00
.It Pa /dev/null
Example of a file in the
.Sx FILES
section.
.El
.Sh DIAGNOSTICS
Add some real example diagnostics to example.[14] Add all of the possible errno's to example.3. Show examples of the .Bx (BSD) and .At (AT&T UNIX) macros in the various HISTORY sections. Add some .Rs/.Re (used for referencing things other than man pages) in the SEE ALSO sections. Suggested by: wollman
1997-01-09 06:32:22 +00:00
.Bl -diag
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.
2001-07-18 10:04:34 +00:00
.It "example%d: example diagnostic message."
Add some real example diagnostics to example.[14] Add all of the possible errno's to example.3. Show examples of the .Bx (BSD) and .At (AT&T UNIX) macros in the various HISTORY sections. Add some .Rs/.Re (used for referencing things other than man pages) in the SEE ALSO sections. Suggested by: wollman
1997-01-09 06:32:22 +00:00
An example of a diagnostic message.
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.
2001-07-18 10:04:34 +00:00
.It "example%d: another example diagnostic message."
Add some real example diagnostics to example.[14] Add all of the possible errno's to example.3. Show examples of the .Bx (BSD) and .At (AT&T UNIX) macros in the various HISTORY sections. Add some .Rs/.Re (used for referencing things other than man pages) in the SEE ALSO sections. Suggested by: wollman
1997-01-09 06:32:22 +00:00
Self explanatory.
.El
Make share/examples/mdoc and share/misc/mdoc.template internally consistent, and consistent with mdoc(7) and mdoc.samples(7). PR: doc/15352, doc/15353
1999-12-08 22:15:09 +00:00
.Sh SEE ALSO
.Xr example 1 ,
.Xr example 3 ,
Cross-reference the newly added example.9
2005-01-12 20:56:15 +00:00
.Xr mdoc 7 ,
.Xr example 9
Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc, since it seemed like a better place, and the makefiles for /usr/share/examples didn't need to be fussed with. The old stuff can be removed from the Attic.
1997-01-02 20:37:25 +00:00
.Sh HISTORY
The
.Nm
Make this example more real world usable: When the manpage first appeared is not interesting, when the driver appeared is. Most people who use this example leave the manpage appearance date in and the driver date out. MFC after: 3 days
2006-05-20 09:49:05 +00:00
device driver first appeared in
These will appear in 2.2, not 3.0. Pointed out by: wosch
1997-02-17 16:39:53 +00:00
.Fx 2.2 .
Add some real example diagnostics to example.[14] Add all of the possible errno's to example.3. Show examples of the .Bx (BSD) and .At (AT&T UNIX) macros in the various HISTORY sections. Add some .Rs/.Re (used for referencing things other than man pages) in the SEE ALSO sections. Suggested by: wollman
1997-01-09 06:32:22 +00:00
.Pp
Some other common
.Sx HISTORY
section examples are:
.Pp
The
.Nm
manual page example first appeared in
.Bx 4.4 .
.Pp
The
.Nm
manual page example first appeared in
.At v6 .
.Sh AUTHOR -> .Sh AUTHORS.
1998-04-01 06:24:20 +00:00
.Sh AUTHORS
Join two lines.
2005-05-07 11:02:34 +00:00
This manual page was written by
.Sh AUTHOR -> .Sh AUTHORS.
1998-04-01 06:24:20 +00:00
.An Mike Pritchard Aq mpp@FreeBSD.org .
Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc, since it seemed like a better place, and the makefiles for /usr/share/examples didn't need to be fussed with. The old stuff can be removed from the Attic.
1997-01-02 20:37:25 +00:00
.Sh BUGS
The actual code for this device driver is vaporware.
Reference in New Issue Copy Permalink