d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

mdoc(7): Properly mark C headers.

Browse Source
This commit is contained in:
ru 2003-09-10 19:24:35 +00:00
parent 11fbeb6f7c
commit c581c0c568
52 changed files with 72 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/libc/gen/exec.3
View File

@ -163,7 +163,7 @@ If this variable isn't specified,
the default path is set according to the
.Dv _PATH_DEFPATH
definition in
.Aq paths.h ,
.In paths.h ,
which is set to
.Dq Ev /usr/bin:/bin .
For

2
lib/libc/gen/fnmatch.3
View File

@ -69,7 +69,7 @@ is the bitwise inclusive
.Tn OR
of any of the following
constants, which are defined in the include file
.Pa fnmatch.h .
.In fnmatch.h .
.Bl -tag -width FNM_PATHNAME
.It Dv FNM_NOESCAPE
Normally, every occurrence of a backslash

2
lib/libc/gen/getdomainname.3
View File

@ -94,7 +94,7 @@ The caller tried to set the hostname and was not the super-user.
Domain names are limited to
.Dv MAXHOSTNAMELEN
(from
.Ao Pa sys/param.h Ac )
.In sys/param.h )
characters, currently 256.
.Sh HISTORY
The

4
lib/libc/gen/glob.3
View File

@ -57,7 +57,7 @@ is a pathname generator that implements the rules for file name pattern
matching used by the shell.
.Pp
The include file
.Pa glob.h
.In glob.h
defines the structure type
.Fa glob_t ,
which contains at least the following fields:
@ -121,7 +121,7 @@ is the bitwise inclusive
.Tn OR
of any of the following
values defined in
.Pa glob.h :
.In glob.h :
.Bl -tag -width GLOB_ALTDIRFUNC
.It Dv GLOB_APPEND
Append pathnames generated to the ones from a previous call (or calls)

2
lib/libc/net/inet6_option_space.3
View File

@ -71,7 +71,7 @@ ancillary data manipulation.
RFC2292 defines a set of functions to help the application.
The function prototypes for
these functions are all in the
.Aq Li netinet/in.h
.In netinet/in.h
header.
.\"
.Ss inet6_option_space

2
lib/libc/net/inet6_rthdr_space.3
View File

@ -97,7 +97,7 @@ fetch one flag from a Routing header
.El
.Pp
The function prototypes for these functions are all in the
.Aq Li netinet/in.h
.In netinet/in.h
header.
.\"
.Ss inet6_rthdr_space

2
lib/libc/net/resolver.3
View File

@ -131,7 +131,7 @@ Options
stored in
.Va _res.options
are defined in
.Pa resolv.h
.In resolv.h
and are as follows.
Options are stored as a simple bit mask containing the bitwise ``or''
of the options enabled.

2
lib/libc/stdlib/getopt.3
View File

@ -209,7 +209,7 @@ This was changed by
to decouple
.Fn getopt
from
.Pa <stdio.h> .
.In stdio.h .
.Pp
A single dash
.Dq Li -

2
lib/libc/sys/acct.2
View File

@ -69,7 +69,7 @@ produced by
For more information on the record structure used by
.Fn acct ,
see
.Pa /usr/include/sys/acct.h
.In sys/acct.h
and
.Xr acct 5 .
.Pp

2
lib/libc/sys/clock_gettime.2
View File

@ -73,7 +73,7 @@ kernel mode.
The structure pointed to by
.Fa tp
is defined in
.Ao Pa sys/time.h Ac
.In sys/time.h
as:
.Pp
.Bd -literal

4
lib/libc/sys/getitimer.2
View File

@ -53,7 +53,7 @@
.Sh DESCRIPTION
The system provides each process with three interval timers,
defined in
.Ao Pa sys/time.h Ac .
.In sys/time.h .
The
.Fn getitimer
system call returns the current value for the timer specified in
@ -139,7 +139,7 @@ in
is 100000000.
.Sh NOTES
Three macros for manipulating time values are defined in
.Ao Pa sys/time.h Ac .
.In sys/time.h .
The
.Fn timerclear
macro

6
lib/libc/sys/getsockopt.2
View File

@ -107,7 +107,7 @@ argument
and any specified options are passed uninterpreted to the appropriate
protocol module for interpretation.
The include file
.Ao Pa sys/socket.h Ac
.In sys/socket.h
contains definitions for
socket level options, described below.
Options at other protocol levels vary in format and
@ -127,7 +127,7 @@ or zero if the option is to be disabled.
uses a
.Vt "struct linger"
argument, defined in
.Ao Pa sys/socket.h Ac ,
.In sys/socket.h ,
which specifies the desired state of the option and the
linger interval (see below).
.Dv SO_SNDTIMEO
@ -136,7 +136,7 @@ and
use a
.Vt "struct timeval"
argument, defined in
.Ao Pa sys/time.h Ac .
.In sys/time.h .
.Pp
The following options are recognized at the socket level.
Except as noted, each may be examined with

2
lib/libc/sys/gettimeofday.2
View File

@ -75,7 +75,7 @@ The structures pointed to by
and
.Fa tzp
are defined in
.Ao Pa sys/time.h Ac
.In sys/time.h
as:
.Pp
.Bd -literal

2
lib/libc/sys/ioctl.2
View File

@ -85,7 +85,7 @@ in bytes.
Macros and defines used in specifying an ioctl
.Fa request
are located in the file
.Ao Pa sys/ioctl.h Ac .
.In sys/ioctl.h .
.Sh RETURN VALUES
If an error has occurred, a value of -1 is returned and
.Va errno

8
lib/libc/sys/quotactl.2
View File

@ -61,7 +61,7 @@ operates on the given filename
for the given user
.Fa id .
(NOTE: One should use the QCMD macro defined in
.Ao Pa ufs/ufs/quota.h Ac
.In ufs/ufs/quota.h
to formulate the value for
.Fa cmd . )
The address of an optional command specific data structure,
@ -118,7 +118,7 @@ argument
is a pointer to a
.Fa struct dqblk
structure (defined in
.Ao Pa ufs/ufs/quota.h Ac ) .
.In ufs/ufs/quota.h ) .
.It Dv Q_SETQUOTA
Set disk quota limits for the user or group
(as determined by the command type) with identifier
@ -129,7 +129,7 @@ argument
is a pointer to a
.Fa struct dqblk
structure (defined in
.Ao Pa ufs/ufs/quota.h Ac ) .
.In ufs/ufs/quota.h ) .
The usage fields of the
.Fa dqblk
structure are ignored.
@ -144,7 +144,7 @@ argument
is a pointer to a
.Fa struct dqblk
structure (defined in
.Ao Pa ufs/ufs/quota.h Ac ) .
.In ufs/ufs/quota.h ) .
Only the usage fields are used.
This system call is restricted to the super-user.
.It Dv Q_SYNC

4
lib/libc/sys/recv.2
View File

@ -152,7 +152,7 @@ system call uses a
.Fa msghdr
structure to minimize the number of directly supplied arguments.
This structure has the following form, as defined in
.Ao Pa sys/socket.h Ac :
.In sys/socket.h :
.Pp
.Bd -literal
struct msghdr {
@ -226,7 +226,7 @@ In this case,
should be a structure of type
.Fa cmsgcred ,
which is defined in
.Ao Pa sys/socket.h Ac
.In sys/socket.h
as follows:
.Pp
.Bd -literal

2
lib/libc/sys/setgroups.2
View File

@ -59,7 +59,7 @@ indicates the number of entries in the array and must be no
more than
.Dv NGROUPS ,
as defined in
.Ao Pa sys/param.h Ac .
.In sys/param.h .
.Pp
Only the super-user may set new groups.
.Sh RETURN VALUES

4
lib/libc/sys/socket.2
View File

@ -57,7 +57,7 @@ argument specifies a communications domain within which
communication will take place; this selects the protocol family
which should be used.
These families are defined in the include file
.Ao Pa sys/socket.h Ac .
.In sys/socket.h .
The currently understood formats are:
.Pp
.Bd -literal -offset indent -compact
@ -225,7 +225,7 @@ via
The operation of sockets is controlled by socket level
.Em options .
These options are defined in the file
.Ao Pa sys/socket.h Ac .
.In sys/socket.h .
The
.Xr setsockopt 2
and

2
lib/libc/sys/sysarch.2
View File

@ -64,7 +64,7 @@ arguments of the function.
Symbolic constants and argument structures
for the architecture-dependent
functions can be found in the header file
.Ao Pa machine/sysarch.h Ac .
.In machine/sysarch.h .
.Pp
The
.Fn sysarch

2
lib/libc/sys/syscall.2
View File

@ -57,7 +57,7 @@ interface has the specified
.Fa number
with the specified arguments.
Symbolic constants for system calls can be found in the header file
.Ao Pa sys/syscall.h Ac .
.In sys/syscall.h .
The
.Fn __syscall
form should be used when one or more of the arguments is a

2
lib/libipsec/ipsec_strerror.3
View File

@ -42,7 +42,7 @@
.Fn ipsec_strerror
.\"
.Sh DESCRIPTION
.Pa netinet6/ipsec.h
.In netinet6/ipsec.h
declares
.Pp
.Dl extern int ipsec_errcode;

4
lib/libstand/libstand.3
View File

@ -176,7 +176,7 @@ Returns error messages for the subset of errno values supported by
.It Fn assert expression
.Pp
Requires
.In assert.h
.In assert.h .
.It Xo
.Ft int
.Fn setjmp "jmp_buf env"
@ -191,7 +191,7 @@ Defined as
and
.Fn _longjmp
respectively as there is no signal state to manipulate. Requires
.In setjmp.h
.In setjmp.h .
.El
.Sh CHARACTER I/O
.Bl -hang -width 10n

2
lib/libutil/realhostname.3
View File

@ -74,7 +74,7 @@ will not be NUL terminated.
The
.Fn realhostname
function will return one of the following constants which are defined in
.Pa libutil.h :
.In libutil.h :
.Pp
.Bl -tag -width XXX -offset XXX
.It Li HOSTNAME_FOUND

2
lib/libutil/realhostname_sa.3
View File

@ -103,7 +103,7 @@ will not be NUL terminated.
The
.Fn realhostname_sa
function will return one of the following constants which are defined in
.Pa libutil.h :
.In libutil.h :
.Pp
.Bl -tag -width XXX -offset XXX
.It Li HOSTNAME_FOUND

2
sbin/bsdlabel/bsdlabel.5
View File

@ -103,7 +103,7 @@ All of these operations are normally done using
.Xr disklabel 8 .
.Pp
The format of the disk label, as specified in
.Pa <sys/disklabel.h> ,
.In sys/disklabel.h ,
is
.Bd -literal
#ifndef _SYS_DISKLABEL_H_

2
sbin/disklabel/disklabel.5
View File

@ -103,7 +103,7 @@ All of these operations are normally done using
.Xr disklabel 8 .
.Pp
The format of the disk label, as specified in
.Pa <sys/disklabel.h> ,
.In sys/disklabel.h ,
is
.Bd -literal
#ifndef _SYS_DISKLABEL_H_

2
sbin/ip6fw/ip6fw.8
View File

@ -328,7 +328,7 @@ A range may only be specified as the first value,
and the length of the port list is limited to
.Dv IPV6_FW_MAX_PORTS
(as defined in
.Pa /usr/src/sys/netinet6/ip6_fw.h )
.In netinet6/ip6_fw.h )
ports.
.Pp
Fragmented packets which have a non-zero offset (i.e. not the first

2
share/man/man3/sysexits.3
View File

@ -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.

2
share/man/man4/icmp6.4
View File

@ -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

2
share/man/man4/man4.i386/apm.4
View File

@ -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.

2
share/man/man4/man4.i386/mcd.4
View File

@ -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

2
share/man/man4/man4.i386/mse.4
View File

@ -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

2
share/man/man4/man4.i386/spkr.4
View File

@ -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,

2
share/man/man4/man4.i386/svr4.4
View File

@ -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.

2
share/man/man4/ng_vjc.4
View File

@ -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

2
share/man/man4/psm.4
View File

@ -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

2
share/man/man4/spkr.4
View File

@ -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,

2
share/man/man4/syscons.4
View File

@ -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.

2
share/man/man4/sysmouse.4
View File

@ -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.

4
share/man/man5/a.out.5
View File

@ -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

2
share/man/man5/dir.5
View File

@ -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_

12
share/man/man5/elf.5
View File

@ -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

6
share/man/man5/procfs.5
View File

@ -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

2
share/man/man8/sticky.8
View File

@ -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

4
share/man/man9/DECLARE_MODULE.9
View File

@ -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 ,

2
share/man/man9/devstat.9
View File

@ -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

2
share/man/man9/mbuf.9
View File

@ -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:

2
share/man/man9/pbuf.9
View File

@ -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

4
share/man/man9/sysctl_add_oid.9
View File

@ -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

2
share/man/man9/vm_set_page_size.9
View File

@ -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

2
usr.sbin/adduser/adduser.8
View File

@ -77,7 +77,7 @@ such a basic fundamental parameter in
You can change
.Dv UT_NAMESIZE
in
.Pa /usr/include/utmp.h
.In utmp.h
and recompile the
world; people have done this and it works, but you will have problems
with any precompiled programs, or source that assumes the 8-character

2
usr.sbin/edquota/edquota.8
View File

@ -205,7 +205,7 @@ for a grace period that may be specified per file system.
Once the grace period has expired,
the soft limit is enforced as a hard limit.
The default grace period for a file system is specified in
.Pa /usr/include/ufs/ufs/quota.h .
.In ufs/ufs/quota.h .
The
.Fl t
flag can be used to change the grace period.