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

104 lines
2.9 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$
.\" Note: All FreeBSD man pages should have a FreeBSD revision
.\" control id to make it easier for translation teams to track
.\" changes.
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.
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
.Dd December 8, 1999
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
.\" Note: Only specify the operating system when the command
.\" is FreeBSD specific, otherwise use the .Os macro with no
.\" arguments.
These will appear in 2.2, not 3.0. Pointed out by: wosch
1997-02-17 16:39:53 +00:00
.Os FreeBSD 2.2
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
.Nd example device driver manual page
.Sh SYNOPSIS
.Cd pseudo-device example
.Sh DESCRIPTION
This is an example device driver manual page for
the
.Nm example
driver. It is intended
that this example can be used as a template when writing
a new manual page.
.Pp
The
.Nm
driver supports the following ioctls:
.Bl -tag -width XXXXXXXXXXX
.It Dv EIOCEX
Example ioctl.
.It Dv EIOCNULL
Example ioctl.
.El
.Sh FILES
.Bl -tag -width /dev/null -compact
.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
.It example%d: example diagnostic message.
An example of a diagnostic message.
.It example%d: another example diagnostic message.
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 ,
.Xr mdoc 7 ,
.Xr mdoc.samples 7
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
manual page example 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
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
This
Use the .An macro in the AUTHOR section.
1997-03-20 16:14:21 +00:00
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