summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2003-09-10 19:24:35 +0000
committerru <ru@FreeBSD.org>2003-09-10 19:24:35 +0000
commit1edcd1b018b1c6b16090b99f84f1fa3300795d0b (patch)
treeeef4036b4299212e7d9f218a5394cd119824ab1f /share/man
parent3cab909501be5c044500f26980d1f9eea870312b (diff)
downloadFreeBSD-src-1edcd1b018b1c6b16090b99f84f1fa3300795d0b.zip
FreeBSD-src-1edcd1b018b1c6b16090b99f84f1fa3300795d0b.tar.gz
mdoc(7): Properly mark C headers.
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man3/sysexits.32
-rw-r--r--share/man/man4/icmp6.42
-rw-r--r--share/man/man4/man4.i386/apm.42
-rw-r--r--share/man/man4/man4.i386/mcd.42
-rw-r--r--share/man/man4/man4.i386/mse.42
-rw-r--r--share/man/man4/man4.i386/spkr.42
-rw-r--r--share/man/man4/man4.i386/svr4.42
-rw-r--r--share/man/man4/ng_vjc.42
-rw-r--r--share/man/man4/psm.42
-rw-r--r--share/man/man4/spkr.42
-rw-r--r--share/man/man4/syscons.42
-rw-r--r--share/man/man4/sysmouse.42
-rw-r--r--share/man/man5/a.out.54
-rw-r--r--share/man/man5/dir.52
-rw-r--r--share/man/man5/elf.512
-rw-r--r--share/man/man5/procfs.56
-rw-r--r--share/man/man8/sticky.82
-rw-r--r--share/man/man9/DECLARE_MODULE.94
-rw-r--r--share/man/man9/devstat.92
-rw-r--r--share/man/man9/mbuf.92
-rw-r--r--share/man/man9/pbuf.92
-rw-r--r--share/man/man9/sysctl_add_oid.94
-rw-r--r--share/man/man9/vm_set_page_size.92
23 files changed, 33 insertions, 33 deletions
diff --git a/share/man/man3/sysexits.3 b/share/man/man3/sysexits.3
index 019c1da..648fb06 100644
--- a/share/man/man3/sysexits.3
+++ b/share/man/man3/sysexits.3
@@ -127,6 +127,6 @@ file appeared somewhere after
This man page has been written by
.An J\(:org Wunsch
after the comments in
-.Pa <sysexits.h> .
+.In sysexits.h .
.Sh BUGS
The choice of an appropriate exit value is often ambiguous.
diff --git a/share/man/man4/icmp6.4 b/share/man/man4/icmp6.4
index 93c8146..ccaf059 100644
--- a/share/man/man4/icmp6.4
+++ b/share/man/man4/icmp6.4
@@ -135,7 +135,7 @@ raw socket has an associated filter whose datatype is defined as
.Pp
This structure, along with the macros and constants defined later in
this section, are defined as a result of including the
-.Aq Li netinet/icmp6.h
+.In netinet/icmp6.h
header.
.Pp
The current filter is fetched and stored using
diff --git a/share/man/man4/man4.i386/apm.4 b/share/man/man4/man4.i386/apm.4
index a098344..ec44015 100644
--- a/share/man/man4/man4.i386/apm.4
+++ b/share/man/man4/man4.i386/apm.4
@@ -48,7 +48,7 @@ exports an application interface as a character device. Applications
can control APM, or retrieve APM status information via this interface.
.Nm
exports the following interfaces. These symbols are defined in
-.Dq Pa /usr/include/machine/apm_bios.h .
+.In machine/apm_bios.h .
.Bl -tag -width 4n -offset indent
.It Sy APMIO_SUSPEND
Suspend system.
diff --git a/share/man/man4/man4.i386/mcd.4 b/share/man/man4/man4.i386/mcd.4
index 8793083..33b9d04 100644
--- a/share/man/man4/man4.i386/mcd.4
+++ b/share/man/man4/man4.i386/mcd.4
@@ -149,7 +149,7 @@ Until the DMA features are
supported, the only interrupts that the board generates are those that
aren't supported by the driver anyway.
.Sh SEE ALSO
-.Pa /usr/include/sys/cdio.h
+.In sys/cdio.h
.Sh AUTHORS
.An -nosplit
The driver was written by
diff --git a/share/man/man4/man4.i386/mse.4 b/share/man/man4/man4.i386/mse.4
index d79b6bf..a6dfa69 100644
--- a/share/man/man4/man4.i386/mse.4
+++ b/share/man/man4/man4.i386/mse.4
@@ -160,7 +160,7 @@ There are a few
.Xr ioctl 2
commands for mouse drivers.
These commands and related structures and constants are defined in
-.Ao Pa sys/mouse.h Ac .
+.In sys/mouse.h .
General description of the commands is given in
.Xr mouse 4 .
This section explains the features specific to the
diff --git a/share/man/man4/man4.i386/spkr.4 b/share/man/man4/man4.i386/spkr.4
index dec3264..199a131 100644
--- a/share/man/man4/man4.i386/spkr.4
+++ b/share/man/man4/man4.i386/spkr.4
@@ -47,7 +47,7 @@ on a speaker file descriptor to control the
speaker driver directly; definitions for the
.Xr ioctl 2
interface are in
-.Pa /usr/include/machine/speaker.h .
+.In machine/speaker.h .
The
.Li tone_t
structure used in these calls has two fields,
diff --git a/share/man/man4/man4.i386/svr4.4 b/share/man/man4/man4.i386/svr4.4
index 8f2d456..44c96a5 100644
--- a/share/man/man4/man4.i386/svr4.4
+++ b/share/man/man4/man4.i386/svr4.4
@@ -91,7 +91,7 @@ variable to define a "default" ABI for unbranded executables.
Value ELFOSABI_SOLARIS represents Solaris; ELFOSABI_SYSV represents other
SysVR4 operating systems.
See
-.Pa /usr/include/sys/elf_common.h
+.In sys/elf_common.h
for ELFOSABI branding definitions, and
.Xr brandelf 1
for information on branding executables.
diff --git a/share/man/man4/ng_vjc.4 b/share/man/man4/ng_vjc.4
index cadffd0..a32f97b 100644
--- a/share/man/man4/ng_vjc.4
+++ b/share/man/man4/ng_vjc.4
@@ -167,7 +167,7 @@ below).
This command returns the node's current state described by the
.Dv "struct slcompress"
structure, which is defined in
-.Pa net/slcompress.h .
+.In net/slcompress.h .
.It Dv NGM_VJC_CLR_STATS
Clears the node statistics counters.
Statistics are also cleared whenever the
diff --git a/share/man/man4/psm.4 b/share/man/man4/psm.4
index e54aaef..7294d33 100644
--- a/share/man/man4/psm.4
+++ b/share/man/man4/psm.4
@@ -353,7 +353,7 @@ There are a few
.Xr ioctl 2
commands for mouse drivers.
These commands and related structures and constants are defined in
-.Ao Pa sys/mouse.h Ac .
+.In sys/mouse.h .
General description of the commands is given in
.Xr mouse 4 .
This section explains the features specific to the
diff --git a/share/man/man4/spkr.4 b/share/man/man4/spkr.4
index dec3264..199a131 100644
--- a/share/man/man4/spkr.4
+++ b/share/man/man4/spkr.4
@@ -47,7 +47,7 @@ on a speaker file descriptor to control the
speaker driver directly; definitions for the
.Xr ioctl 2
interface are in
-.Pa /usr/include/machine/speaker.h .
+.In machine/speaker.h .
The
.Li tone_t
structure used in these calls has two fields,
diff --git a/share/man/man4/syscons.4 b/share/man/man4/syscons.4
index 68fd7cf..a99324f 100644
--- a/share/man/man4/syscons.4
+++ b/share/man/man4/syscons.4
@@ -329,7 +329,7 @@ above.
.It Dv SC_KERNEL_CONS_REV_ATTR=_attribute_
These options will set the default colors.
Available colors are defined in
-.Pa /usr/include/machine/pc/display.h .
+.In machine/pc/display.h .
See
.Sx EXAMPLES
below.
diff --git a/share/man/man4/sysmouse.4 b/share/man/man4/sysmouse.4
index 1b8c4be..9b81aa0 100644
--- a/share/man/man4/sysmouse.4
+++ b/share/man/man4/sysmouse.4
@@ -421,7 +421,7 @@ The
field specifies the signal to be delivered to the process.
It must be
one of the values defined in
-.Ao Pa signal.h Ac .
+.In signal.h .
The
.Dv mode
field is currently unused.
diff --git a/share/man/man5/a.out.5 b/share/man/man5/a.out.5
index ad87477..ac186d5 100644
--- a/share/man/man5/a.out.5
+++ b/share/man/man5/a.out.5
@@ -188,7 +188,7 @@ Contains the size in bytes of the data relocation table.
.El
.Pp
The
-.Pa a.out.h
+.In a.out.h
include file defines several macros which use an
.Fa exec
structure to test consistency or to locate section offsets in the binary file.
@@ -444,7 +444,7 @@ is always 4 on 32-bit machines.
.Xr stab 5
.Sh HISTORY
The
-.Pa a.out.h
+.In a.out.h
include file appeared in
.At v7 .
.Sh BUGS
diff --git a/share/man/man5/dir.5 b/share/man/man5/dir.5
index 02b37e2..6c5a387 100644
--- a/share/man/man5/dir.5
+++ b/share/man/man5/dir.5
@@ -80,7 +80,7 @@ and
.Xr mount 8 . )
.Pp
The directory entry format is defined in the file
-.Aq sys/dirent.h
+.In sys/dirent.h
(which should not be included directly by applications):
.Bd -literal
#ifndef _SYS_DIRENT_H_
diff --git a/share/man/man5/elf.5 b/share/man/man5/elf.5
index 2be201f..e4c1137 100644
--- a/share/man/man5/elf.5
+++ b/share/man/man5/elf.5
@@ -51,7 +51,7 @@ the file.
.Pp
Applications which wish to process ELF binary files for their native
architecture only should include
-.Pa elf.h
+.In elf.h
in their source code.
These applications should need to refer to
all the types and structures by their generic names
@@ -63,11 +63,11 @@ regardless whether the host is 32-bit or 64-bit.
.Pp
Should an application need to process ELF files of an unknown
architecture then the application needs to include both
-.Pa sys/elf32.h
+.In sys/elf32.h
and
-.Pa sys/elf64.h
+.In sys/elf64.h
instead of
-.Pa elf.h .
+.In elf.h .
Furthermore, all types and structures need to be identified by either
.Dq Elf32_xxx
or
@@ -78,9 +78,9 @@ or
.Dq ELF64_xxx .
.Pp
Whatever the system's architecture is, it will always include
-.Pa sys/elf_common.h
+.In sys/elf_common.h
as well as
-.Pa sys/elf_generic.h .
+.In sys/elf_generic.h .
.Pp
These header files describe the above mentioned headers as C structures
and also include structures for dynamic sections, relocation sections and
diff --git a/share/man/man5/procfs.5 b/share/man/man5/procfs.5
index cdb3971..169421e 100644
--- a/share/man/man5/procfs.5
+++ b/share/man/man5/procfs.5
@@ -78,7 +78,7 @@ in which case that signal is delivered to the process
The debug registers as defined by
.Dv "struct dbregs"
in
-.Pa <machine/reg.h> .
+.In machine/reg.h .
.Pa dbregs
is currently only implemented on the i386 architecture.
.It Pa etype
@@ -95,7 +95,7 @@ If the file cannot be found, the link target is
The floating point registers as defined by
.Dv "struct fpregs"
in
-.Pa <machine/reg.h> .
+.In machine/reg.h .
.Pa fpregs
is only implemented on machines which have distinct general
purpose and floating point register sets.
@@ -115,7 +115,7 @@ Allows read and write access to the process' register set.
This file contains a binary data structure
.Dv "struct regs"
defined in
-.Pa <machine/reg.h> .
+.In machine/reg.h .
.Pa regs
can only be written when the process is stopped.
.It Pa rlimit
diff --git a/share/man/man8/sticky.8 b/share/man/man8/sticky.8
index a12a757..cbf886d 100644
--- a/share/man/man8/sticky.8
+++ b/share/man/man8/sticky.8
@@ -49,7 +49,7 @@ See
.Xr chmod 2
or
the file
-.Pa /usr/include/sys/stat.h
+.In sys/stat.h
for an explanation of file modes.
.Sh STICKY DIRECTORIES
A directory whose `sticky bit' is set
diff --git a/share/man/man9/DECLARE_MODULE.9 b/share/man/man9/DECLARE_MODULE.9
index 1a24eec..190ccb7 100644
--- a/share/man/man9/DECLARE_MODULE.9
+++ b/share/man/man9/DECLARE_MODULE.9
@@ -80,7 +80,7 @@ Valid values for this are contained in the
.Vt sysinit_sub_id
enumeration
(see
-.Pa kernel.h )
+.In sys/kernel.h )
and specify the type of system startup interfaces.
The
.Xr DRIVER_MODULE 9
@@ -99,7 +99,7 @@ It represents the KLDs order of initialization within the subsystem.
Valid values are defined in the
.Vt sysinit_elem_order
enumeration
-.Pa ( kernel.h ) .
+.Pq In sys/kernel.h .
.Sh SEE ALSO
.Xr DEV_MODULE 9 ,
.Xr DRIVER_MODULE 9 ,
diff --git a/share/man/man9/devstat.9 b/share/man/man9/devstat.9
index ea52d0a..af9164c 100644
--- a/share/man/man9/devstat.9
+++ b/share/man/man9/devstat.9
@@ -369,7 +369,7 @@ from the CCB is ORed with 0xf to determine the tag type to pass in to
There is a macro,
.Dv DEVSTAT_VERSION
that is defined in
-.Aq sys/devicestat.h .
+.In sys/devicestat.h .
This is the current version of the
.Nm
subsystem, and it should be incremented each time a change is made that
diff --git a/share/man/man9/mbuf.9 b/share/man/man9/mbuf.9
index 1bc4c28..12e0c94 100644
--- a/share/man/man9/mbuf.9
+++ b/share/man/man9/mbuf.9
@@ -153,7 +153,7 @@ The total size of an
.Vt mbuf ,
.Dv MSIZE ,
is a machine-dependent constant defined in
-.Pa machine/param.h .
+.In machine/param.h .
The
.Vt mbuf
header includes:
diff --git a/share/man/man9/pbuf.9 b/share/man/man9/pbuf.9
index 977f2a0..4329ac9 100644
--- a/share/man/man9/pbuf.9
+++ b/share/man/man9/pbuf.9
@@ -64,7 +64,7 @@ available.
The number of buffers is stored in
.Va nswbuf
which is defined in
-.Pa sys/buf.h
+.In sys/buf.h
and initialized in
.Fn cpu_startup .
A recommended initialization value is 1/2
diff --git a/share/man/man9/sysctl_add_oid.9 b/share/man/man9/sysctl_add_oid.9
index cc7ee83..46beea2 100644
--- a/share/man/man9/sysctl_add_oid.9
+++ b/share/man/man9/sysctl_add_oid.9
@@ -182,7 +182,7 @@ for creating and deleting sysctl oids at runtime
(e.g. during lifetime of a module).
The alternative method,
based on linker sets (see
-.Aq sys/linker_set.h
+.In sys/linker_set.h
and
.\" XXX Manual pages should avoid referencing source files
.Pa src/sys/kern/kern_sysctl.c
@@ -271,7 +271,7 @@ The newly created oid will contain a copy of the name.
.It Fa kind
The kind of oid,
specified as a bit mask of the type and access values defined in the
-.Aq sys/sysctl.h
+.In sys/sysctl.h
header file.
Oids created dynamically always have the
.Dv CTLFLAG_DYN
diff --git a/share/man/man9/vm_set_page_size.9 b/share/man/man9/vm_set_page_size.9
index 91d1464..9433a05 100644
--- a/share/man/man9/vm_set_page_size.9
+++ b/share/man/man9/vm_set_page_size.9
@@ -45,7 +45,7 @@ function initializes the system page size.
If
.Va cnt.v_page_size
(see
-.Pa sys/vmmeter.h )
+.In sys/vmmeter.h )
equals 0,
.Dv PAGE_SIZE
is used; otherwise, the value stored in
OpenPOWER on IntegriCloud