summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormpp <mpp@FreeBSD.org>1997-01-02 20:39:01 +0000
committermpp <mpp@FreeBSD.org>1997-01-02 20:39:01 +0000
commit099391c16ff6d8e30ac5efbfc96d901904bc4773 (patch)
tree3bdc04bd9661dddb3bbc53e699ccf422b0d3a6a1
parent6ee379ab9e01e2bb32f3d50e3504d0c3f09a0a9e (diff)
downloadFreeBSD-src-099391c16ff6d8e30ac5efbfc96d901904bc4773.zip
FreeBSD-src-099391c16ff6d8e30ac5efbfc96d901904bc4773.tar.gz
Moved these to /usr/share/examples/mdoc.
-rw-r--r--share/misc/mdoc/example.1115
-rw-r--r--share/misc/mdoc/example.3135
-rw-r--r--share/misc/mdoc/example.485
3 files changed, 0 insertions, 335 deletions
diff --git a/share/misc/mdoc/example.1 b/share/misc/mdoc/example.1
deleted file mode 100644
index 1314220..0000000
--- a/share/misc/mdoc/example.1
+++ /dev/null
@@ -1,115 +0,0 @@
-.\" Copyright (c) [year]
-.\" [you name here]. All rights reserved.
-.\"
-.\" 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.
-.\" 3. All advertising materials mentioning features or use of this software
-.\" must display the following acknowledgement:
-.\" This product includes software developed by [you name]
-.\" and its contributors.
-.\" 4. Neither the name of the University nor the names of its contributors
-.\" may be used to endorse or promote products derived from this software
-.\" without specific prior written permission.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY [you name] AND CONTRIBUTORS ``AS IS'' AND
-.\" 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.
-.\"
-.\"
-.Dd "January 2, 1997"
-.Dt EXAMPLE 1
-.\" Note: Only specify the operating system when the command
-.\" is FreeBSD specific, otherwise use the .Os macro with no
-.\" arguments.
-.Os FreeBSD 3.0
-.Sh NAME
-.Nm example
-.Nd example command manual page
-.Sh SYNOPSIS
-.Nm example
-.Op Fl abc
-.Op Fl d Ar argument
-.Ar file
-.Sh DESCRIPTION
-This is an example manual page for
-the
-.Nm
-command. It is intended
-that this example can be used as a template when writing
-a new manual page.
-.Pp
-The options are as follows:
-has several options:
-.Bl -tag -width Fl
-.It Fl a
-Example optional
-.Fl a
-option.
-.It Fl b
-Example optional
-.Fl b
-option.
-.It Fl c
-Example optional
-.Fl c
-option.
-.It Fl d Ar argument
-Example optional
-.Fl d
-option with required argument
-.Ar argument .
-.It Ar file
-Required argument
-.Ar file .
-.El
-.Sh ENVIRONMENT
-The
-.Nm
-command ignores the
-.Ev EXAMPLE
-environment variable.
-.Sh FILES
-.Bl -tag -width /dev/null -compact
-.It Pa /dev/null
-Example of a file in the
-.Sx FILES
-section.
-.El
-.Sh SEE ALSO
-.Xr example 3 ,
-.Xr example 4 ,
-.Xr mdoc 7 ,
-.Xr mdoc.samples 7
-.Sh STANDARDS
-If the command conforms to some standard, such as
-.St -p1003.2
-or
-.St -ansiC ,
-it should be noted here.
-.Sh DIAGNOSTICS
-None.
-.Sh HISTORY
-The
-.Nm
-manual page example first appeared in
-.Fx 3.0 .
-.Sh AUTHOR
-This
-manual page was written by Mike Pritchard
-.Aq mpp@FreeBSD.ORG .
-.Sh BUGS
-The actual code for this command is vaporware.
diff --git a/share/misc/mdoc/example.3 b/share/misc/mdoc/example.3
deleted file mode 100644
index b072db7..0000000
--- a/share/misc/mdoc/example.3
+++ /dev/null
@@ -1,135 +0,0 @@
-.\" Copyright (c) [year]
-.\" [you name here]. All rights reserved.
-.\"
-.\" 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.
-.\" 3. All advertising materials mentioning features or use of this software
-.\" must display the following acknowledgement:
-.\" This product includes software developed by [you name]
-.\" and its contributors.
-.\" 4. Neither the name of the University nor the names of its contributors
-.\" may be used to endorse or promote products derived from this software
-.\" without specific prior written permission.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY [you name] AND CONTRIBUTORS ``AS IS'' AND
-.\" 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.
-.\"
-.\"
-.Dd "January 2, 1997"
-.Dt EXAMPLE 3
-.\" Note: Only specify the operating system when the command
-.\" is FreeBSD specific, otherwise use the .Os macro with no
-.\" arguments.
-.Os FreeBSD 3.0
-.Sh NAME
-.Nm example
-.Nd example library function manual page
-.Sh SYNOPSIS
-.Fd #include <example.h>
-.Ft int
-.Fn example "char *ptr" "int mode"
-.Sh DESCRIPTION
-This is an example library function manual page for
-the
-.Fn example
-function. It is intended
-that this example can be used as a template when writing
-a new manual page.
-.Pp
-The
-.Fn example
-function takes two arguments:
-.Fa ptr
-and
-.Fa mode .
-The argument
-.Fa mode
-may have one of the following values:
-.Bl -tag -width EXAMPLE_ONE
-.It Dv EXAMPLE_ONE
-First example of a defined variable.
-.Dv EXAMPLE_ONE is described below.
-.It Dv EXAMPLE_TWO
-Second example.
-.El
-.Pp
-The above value are defined in
-.Aq example.h
-as follows:
-.Bd -literal
-#define EXAMPLE_ONE 1
-#define EXAMPLE_TWO 2
-.Ed
-.Sh RETURN VALUES
-A 0 value is returned if the operation succeeds,
-otherwise
-.Fn example
-returns -1 and the global variable
-.Va errno
-indicates the reason for the falure.
-.Sh ENVIRONMENT
-The
-.Fn example
-library function ignores the
-.Ev EXAMPLE
-environment variable.
-.Sh FILES
-.Bl -tag -width /dev/null -compact
-.It Pa /dev/null
-Example of a file in the
-.Sx FILES
-section.
-.El
-.Sh SEE ALSO
-.Xr example 1 ,
-.Xr example 4 ,
-.Xr mdoc 7 ,
-.Xr mdoc.samples 7
-.Sh STANDARDS
-If the command conforms to some standard, such as
-.St -p1003.2
-or
-.St -ansiC ,
-it should be noted here.
-.Sh DIAGNOSTICS
-None.
-.Sh ERRORS
-.Fn Example
-will fail if:
-.Bl -tag -width Er
-.It Bq Er EINVAL
-One of the arguments passed to
-.Fn example
-was invalid.
-.It Bq Er EPERM
-The caller did not have permission to
-use the
-.Fn example
-function.
-.El
-.Sh HISTORY
-The
-.Nm
-manual page example first appeared in
-.Fx 3.0 .
-.Sh AUTHOR
-This
-manual page was written by Mike Pritchard
-.Aq mpp@FreeBSD.ORG .
-.Sh BUGS
-The actual code for this function is vaporware.
diff --git a/share/misc/mdoc/example.4 b/share/misc/mdoc/example.4
deleted file mode 100644
index 1e26511..0000000
--- a/share/misc/mdoc/example.4
+++ /dev/null
@@ -1,85 +0,0 @@
-.\" Copyright (c) [year]
-.\" [you name here]. All rights reserved.
-.\"
-.\" 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.
-.\" 3. All advertising materials mentioning features or use of this software
-.\" must display the following acknowledgement:
-.\" This product includes software developed by [you name]
-.\" and its contributors.
-.\" 4. Neither the name of the University nor the names of its contributors
-.\" may be used to endorse or promote products derived from this software
-.\" without specific prior written permission.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY [you name] AND CONTRIBUTORS ``AS IS'' AND
-.\" 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.
-.\"
-.\"
-.Dd "January 2, 1997"
-.Dt EXAMPLE 4 i386
-.\" Note: Only specify the operating system when the command
-.\" is FreeBSD specific, otherwise use the .Os macro with no
-.\" arguments.
-.Os FreeBSD 3.0
-.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 SEE ALSO
-.Xr example 1 ,
-.Xr example 3 ,
-.Xr mdoc 7 ,
-.Xr mdoc.samples 7
-.Sh DIAGNOSTICS
-None.
-.Sh HISTORY
-The
-.Nm
-manual page example first appeared in
-.Fx 3.0 .
-.Sh AUTHOR
-This
-manual page was written by Mike Pritchard
-.Aq mpp@FreeBSD.ORG .
-.Sh BUGS
-The actual code for this device driver is vaporware.
OpenPOWER on IntegriCloud