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

mdoc: move remaining sections into consistent order

Browse Source 
This pertains mostly to FILES, HISTORY, EXIT STATUS and AUTHORS sections.

Found by:	mdocml lint run
Reviewed by:	ru
This commit is contained in:
Ulrich Spörlein 2010-05-13 12:08:11 +00:00
parent 0afc94c17a
commit 0b31f1f731
25 changed files with 165 additions and 165 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
lib/msun/man/hypot.3
View File

@ -124,14 +124,6 @@ disappear when it turns out to be irrelevant, as it does in
.Xr carg 3 ,
.Xr math 3 ,
.Xr sqrt 3
.Sh HISTORY
Both a
.Fn hypot
function and a
.Fn cabs
function
appeared in
.At v7 .
.Sh STANDARDS
The
.Fn hypot ,
@ -143,3 +135,11 @@ and
.Fn cabsl
functions conform to
.St -isoC-99 .
.Sh HISTORY
Both a
.Fn hypot
function and a
.Fn cabs
function
appeared in
.At v7 .

28
sbin/hastctl/hastctl.8
View File

@ -153,6 +153,20 @@ Print debugging information.
This option can be specified multiple times to raise the verbosity
level.
.El
.Sh FILES
.Bl -tag -width ".Pa /var/run/hastctl" -compact
.It Pa /etc/hast.conf
Configuration file for
.Nm
and
.Xr hastd 8 .
.It Pa /var/run/hastctl
Control socket used by
.Nm
to communicate with the
.Xr hastd 8
daemon.
.El
.Sh EXIT STATUS
Exit status is 0 on success, or one of the values described in
.Xr sysexits 3
@ -185,20 +199,6 @@ nodeB# fsck -t ufs /dev/hast/shared
nodeB# mount -o noatime /dev/hast/shared /shared
nodeB# application_start
.Ed
.Sh FILES
.Bl -tag -width ".Pa /var/run/hastctl" -compact
.It Pa /etc/hast.conf
Configuration file for
.Nm
and
.Xr hastd 8 .
.It Pa /var/run/hastctl
Control socket used by
.Nm
to communicate with the
.Xr hastd 8
daemon.
.El
.Sh SEE ALSO
.Xr sysexits 3 ,
.Xr geom 4 ,

26
sbin/hastd/hast.conf.5
View File

@ -224,6 +224,19 @@ the secondary node.
When operating as a secondary node only connections from this address
will be accepted.
.El
.Sh FILES
.Bl -tag -width ".Pa /var/run/hastctl" -compact
.It Pa /etc/hast.conf
The default
.Nm
configuration file.
.It Pa /var/run/hastctl
Control socket used by the
.Xr hastctl 8
control utility to communicate with the
.Xr hastd 8
daemon.
.El
.Sh EXAMPLES
The example configuration file can look as follows:
.Bd -literal -offset indent
@ -248,19 +261,6 @@ resource tank {
}
}
.Ed
.Sh FILES
.Bl -tag -width ".Pa /var/run/hastctl" -compact
.It Pa /etc/hast.conf
The default
.Nm
configuration file.
.It Pa /var/run/hastctl
Control socket used by the
.Xr hastctl 8
control utility to communicate with the
.Xr hastd 8
daemon.
.El
.Sh SEE ALSO
.Xr gethostname 3 ,
.Xr geom 4 ,

34
sbin/hastd/hastd.8
View File

@ -170,6 +170,23 @@ stored.
The default location is
.Pa /var/run/hastd.pid .
.El
.Sh FILES
.Bl -tag -width ".Pa /var/run/hastctl" -compact
.It Pa /etc/hast.conf
The configuration file for
.Nm
and
.Xr hastctl 8 .
.It Pa /var/run/hastctl
Control socket used by the
.Xr hastctl 8
control utility to communicate with
.Nm .
.It Pa /var/run/hastd.pid
The default location of the
.Nm
PID file.
.El
.Sh EXIT STATUS
Exit status is 0 on success, or one of the values described in
.Xr sysexits 3
@ -196,23 +213,6 @@ nodeA# hastctl role primary shared
nodeA# newfs -U /dev/hast/shared
nodeA# mount -o noatime /dev/hast/shared /shared
.Ed
.Sh FILES
.Bl -tag -width ".Pa /var/run/hastctl" -compact
.It Pa /etc/hast.conf
The configuration file for
.Nm
and
.Xr hastctl 8 .
.It Pa /var/run/hastctl
Control socket used by the
.Xr hastctl 8
control utility to communicate with
.Nm .
.It Pa /var/run/hastd.pid
The default location of the
.Nm
PID file.
.El
.Sh SEE ALSO
.Xr sysexits 3 ,
.Xr geom 4 ,

4
share/man/man3/fpgetround.3
View File

@ -170,10 +170,10 @@ At present, they are implemented only on the i386 and amd64 platforms.
.Sh SEE ALSO
.Xr fenv 3 ,
.Xr isnan 3
.Sh HISTORY
These routines are based on SysV/386 routines of the same name.
.Sh CAVEATS
After a floating point exception and before a mask is set, the sticky
flags must be reset.
If another exception occurs before the sticky
flags are reset, then a wrong exception type may be signaled.
.Sh HISTORY
These routines are based on SysV/386 routines of the same name.

10
share/man/man4/cmx.4
View File

@ -67,11 +67,6 @@ and
are supported and work as expected. An open file descriptor
will always be ready for writing, but only ready for reading
if the device indicates that it has data available.
.Sh COMPATIBILITY
Userland smartcard code written for the vendor's Linux drivers
should work with the
.Nm
driver without modification.
.Sh FILES
.Bl -tag -width /usr/ports/security/openct -compact
.It Pa /dev/cmx\fBn\fP
@ -91,6 +86,11 @@ devices.
.\".Nm
.\"devices.
.El
.Sh COMPATIBILITY
Userland smartcard code written for the vendor's Linux drivers
should work with the
.Nm
driver without modification.
.Sh SEE ALSO
.Xr pccard 4
.Sh HISTORY

8
share/man/man4/uhso.4
View File

@ -87,6 +87,10 @@ This behavior can be disabled by setting
.Va hw.usb.uhso.auto_switch
to 0 using
.Xr sysctl 8
.Sh FILES
.Bl -tag -width "XXXXXX"
.It Pa /dev/cuaU?.?
.El
.Sh EXAMPLES
Establishing a packet interface connection
.Bd -literal -offset indent
@ -112,10 +116,6 @@ The connection can be terminated with
.Bd -literal -offset indent
AT_OWANCALL=1,0,1
.Ed
.Sh FILES
.Bl -tag -width "XXXXXX"
.It Pa /dev/cuaU?.?
.El
.Sh SEE ALSO
.Xr ucom 4 ,
.Xr usb 4

10
share/man/man5/boot.config.5
View File

@ -64,6 +64,11 @@ the other options available for
are documented in detail in the
.Xr boot 8
manual page.
.Sh FILES
.Bl -tag -width /boot.config -compact
.It Pa /boot.config
parameters for the boot blocks (optional)
.El
.Sh EXAMPLES
The command:
.Bd -literal -offset indent
@ -90,11 +95,6 @@ The command:
.Ed
.Pp
will do both of the above.
.Sh FILES
.Bl -tag -width /boot.config -compact
.It Pa /boot.config
parameters for the boot blocks (optional)
.El
.Sh SEE ALSO
.Xr boot 8 ,
.Xr loader 8

8
share/man/man5/fdescfs.5
View File

@ -87,6 +87,10 @@ call other than
and
.Dv O_RDWR
are ignored.
.Sh FILES
.Bl -tag -width /dev/stderr -compact
.It Pa /dev/fd/#
.El
.Sh EXAMPLES
To mount a
.Nm
@ -94,10 +98,6 @@ volume located on
.Pa /dev/fd :
.Pp
.Dl "mount -t fdescfs null /dev/fd"
.Sh FILES
.Bl -tag -width /dev/stderr -compact
.It Pa /dev/fd/#
.El
.Sh SEE ALSO
.Xr mount 8
.Sh HISTORY

16
share/man/man5/linsysfs.5
View File

@ -55,14 +55,6 @@ registered driver name for these devices.
.It Pa device
A symlink to the PCI device directory.
.El
.Sh EXAMPLES
The most common usage follows:
.Pp
.Dl "mount -t linsysfs linsys /compat/linux/sys"
.Pp
where
.Pa /compat/linux/sys
is a mount point.
.Sh FILES
.Bl -tag -width ".Pa /compat/linux/sys/devices/pci0000:00" -compact
.It Pa /compat/linux/sys
@ -73,6 +65,14 @@ The storage host node.
.It Pa /compat/linux/sys/devices/pci0000:00
The PCI device hierarchy node.
.El
.Sh EXAMPLES
The most common usage follows:
.Pp
.Dl "mount -t linsysfs linsys /compat/linux/sys"
.Pp
where
.Pa /compat/linux/sys
is a mount point.
.Sh SEE ALSO
.Xr nmount 2 ,
.Xr unmount 2 ,

8
share/man/man9/namei.9
View File

@ -319,6 +319,10 @@ function.
If successful,
.Fn namei
will return 0, otherwise it will return an error.
.Sh FILES
.Bl -tag
.It Pa src/sys/kern/vfs_lookup.c
.El
.Sh ERRORS
Errors which
.Fn namei
@ -343,10 +347,6 @@ An attempt is made to open a directory with write mode specified.
.It Bq Er EROFS
An attempt is made to modify a file or directory on a read-only file system.
.El
.Sh FILES
.Bl -tag
.It Pa src/sys/kern/vfs_lookup.c
.El
.Sh SEE ALSO
.Xr uio 9 ,
.Xr uma 9 ,

24
share/man/man9/uio.9
View File

@ -115,18 +115,6 @@ space.
On success
.Fn uiomove
will return 0, on error it will return an appropriate errno.
.Sh ERRORS
.Fn uiomove
will fail and return the following error code if:
.Bl -tag -width Er
.It Bq Er EFAULT
The invoked
.Xr copyin 9
or
.Xr copyout 9
returned
.Er EFAULT
.El
.Sh EXAMPLES
The idea is that the driver maintains a private buffer for its data,
and processes the request in chunks of maximal the size of this
@ -167,6 +155,18 @@ fooread(dev_t dev, struct uio *uio, int flag)
return (rv);
}
.Ed
.Sh ERRORS
.Fn uiomove
will fail and return the following error code if:
.Bl -tag -width Er
.It Bq Er EFAULT
The invoked
.Xr copyin 9
or
.Xr copyout 9
returned
.Er EFAULT
.El
.Sh SEE ALSO
.Xr read 2 ,
.Xr readv 2 ,

22
usr.bin/killall/killall.1
View File

@ -121,6 +121,17 @@ for this job (e.g.\&
.Dq Li "kill -TERM -1
or as root
.Dq Li "echo kill -TERM -1 | su -m <user>" ) .
.Sh IMPLEMENTATION NOTES
This
.Fx
implementation of
.Nm
has completely different semantics as compared to the traditional
.Ux
System V behavior of
.Nm .
The latter will kill all processes that the current user is able to
kill, and is intended to be used by the system shutdown process only.
.Sh EXIT STATUS
The
.Nm
@ -145,17 +156,6 @@ command appeared in
It has been modeled after the
.Nm
command as available on other platforms.
.Sh IMPLEMENTATION NOTES
This
.Fx
implementation of
.Nm
has completely different semantics as compared to the traditional
.Ux
System V behavior of
.Nm .
The latter will kill all processes that the current user is able to
kill, and is intended to be used by the system shutdown process only.
.Sh AUTHORS
.An -nosplit
The

14
usr.bin/setchannel/setchannel.1
View File

@ -85,13 +85,6 @@ Channel number to set.
.It Cm freq
Frequency in MHz (must include decimal point).
.El
.Sh AUTHORS
.An -nosplit
This program is made by
.An John Wehle <john@feith.com>
.Pp
This man page is made by
.An Edwin Groothuis <edwin@FreeBSD.org>
.Sh SEE ALSO
.Xr cxm 4 ,
.Xr bktr 4 ,
@ -102,3 +95,10 @@ The
program first appeared in the -multimedia mailing-list in January 2004. The
.Nm
program first appeared in the FreeBSD Ports collection in October 2004.
.Sh AUTHORS
.An -nosplit
This program is made by
.An John Wehle <john@feith.com>
.Pp
This man page is made by
.An Edwin Groothuis <edwin@FreeBSD.org>

4
usr.bin/tar/bsdtar.1
View File

@ -647,8 +647,6 @@ Note that, unlike other
implementations, this implementation recognizes gzip compression
automatically when reading archives.
.El
.Sh EXIT STATUS
.Ex -std
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm :
@ -672,6 +670,8 @@ See
.Xr environ 7
for more information.
.El
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES
The following creates a new archive
called

4
usr.bin/wtmpcvt/wtmpcvt.1
View File

@ -55,6 +55,8 @@ The
.Nm
utility appeared in
.Fx 9.0 .
.Sh AUTHORS
.An Ed Schouten Aq ed@FreeBSD.org
.Sh BUGS
The application assumes the
.Ar input
@ -62,5 +64,3 @@ file has the same byte order as the host system.
The
.Ar output
file can be used on any architecture.
.Sh AUTHORS
.An Ed Schouten Aq ed@FreeBSD.org

4
usr.sbin/bluetooth/btpand/btpand.8
View File

@ -181,8 +181,6 @@ After
has set up the client or server connection and opened the
.Xr tap 4
interface, it will create a pid file and detach.
.Sh EXIT STATUS
.Ex -std
.Sh FILES
.Bl -tag -compact
.It Pa /dev/tap
@ -190,6 +188,8 @@ interface, it will create a pid file and detach.
.It Pa /var/run/sdp
.It Pa /var/run/tap Ns Em N Ns No .pid
.El
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES
.Dl ifconfig tap1 create
.Dl btpand -a host -d mydevice -s NAP -i tap1

14
usr.sbin/bluetooth/sdpcontrol/sdpcontrol.8
View File

@ -90,6 +90,13 @@ are:
.It Cm Browse
.It Cm Search
.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr bluetooth 3 ,
.Xr sdp 3
.Sh AUTHORS
.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
.Sh CAVEATS
The
.Nm
@ -109,10 +116,3 @@ Protocol Descriptor List
.It
Bluetooth Profile Descriptor List
.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr bluetooth 3 ,
.Xr sdp 3
.Sh AUTHORS
.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com

10
usr.sbin/mptutil/mptutil.8
View File

@ -348,6 +348,11 @@ as a global hot spare:
.Dl Nm Cm add da3
.Sh SEE ALSO
.Xr mpt 4
.Sh HISTORY
The
.Nm
utility first appeared in
.Fx 8.0 .
.Sh BUGS
.Pp
The handling of spare drives appears to be unreliable.
@ -379,8 +384,3 @@ configurations may not work reliably.
.Pp
Drive configuration commands result in an excessive flood of messages on the
console.
.Sh HISTORY
The
.Nm
utility first appeared in
.Fx 8.0 .

14
usr.sbin/newsyslog/newsyslog.8
View File

@ -238,6 +238,13 @@ this has been changed to a colon (``:'') character so that user and group
names may contain the dot character.
The dot (``.'') character is still
accepted for backwards compatibility.
.Sh SEE ALSO
.Xr bzip2 1 ,
.Xr gzip 1 ,
.Xr syslog 3 ,
.Xr newsyslog.conf 5 ,
.Xr chown 8 ,
.Xr syslogd 8
.Sh HISTORY
The
.Nm
@ -250,12 +257,5 @@ and first appeared in
MIT Project Athena
.Pp
Copyright 1987, Massachusetts Institute of Technology
.Sh "SEE ALSO"
.Xr bzip2 1 ,
.Xr gzip 1 ,
.Xr syslog 3 ,
.Xr newsyslog.conf 5 ,
.Xr chown 8 ,
.Xr syslogd 8
.Sh BUGS
Does not yet automatically read the logs to find security breaches.

28
usr.sbin/pkg_install/updating/pkg_updating.1
View File

@ -43,6 +43,20 @@ Defines a alternative location of the UPDATING
.It Fl h , -help
Print help message.
.El
.Sh ENVIRONMENT
.Bl -tag -width PKG_DBDIR
.It Ev PKG_DBDIR
Specifies an alternative location for the installed package database.
.It Ev PORTSDIR
Location of the ports tree.
.El
.Sh FILES
.Bl -tag -width /var/db/pkg -compact
.It Pa /var/db/pkg
Default location of the installed package database.
.It Pa /usr/ports
The default ports directory and default location of the UPDATING file
.El
.Sh EXAMPLES
Shows all entries of all installed ports:
.Dl % pkg_updating
@ -63,20 +77,6 @@ installed ports:
Fetch UPDATING file from ftp mirror and show all entries of all
installed ports:
.Dl % pkg_updating -f ftp://ftp.freebsd.org/pub/FreeBSD/ports/packages/UPDATING
.Sh ENVIRONMENT
.Bl -tag -width PKG_DBDIR
.It Ev PKG_DBDIR
Specifies an alternative location for the installed package database.
.It Ev PORTSDIR
Location of the ports tree.
.El
.Sh FILES
.Bl -tag -width /var/db/pkg -compact
.It Pa /var/db/pkg
Default location of the installed package database.
.It Pa /usr/ports
The default ports directory and default location of the UPDATING file
.El
.Sh SEE ALSO
.Xr pkg_add 1 ,
.Xr pkg_create 1 ,

4
usr.sbin/rtadvd/rtadvd.8
View File

@ -162,8 +162,6 @@ In this case,
will transmit router advertisement with router lifetime 0
to all the interfaces
.Pq in accordance with RFC2461 6.2.5 .
.Sh EXIT STATUS
.Ex -std
.Sh FILES
.Bl -tag -width Pa -compact
.It Pa /etc/rtadvd.conf
@ -176,6 +174,8 @@ The file in which
.Nm
dumps its internal state.
.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr rtadvd.conf 5 ,
.Xr rtsol 8

6
usr.sbin/rtsold/rtsold.8
View File

@ -222,9 +222,6 @@ must be the absolute path from root to the script file, be a regular
file, and be created by the same owner who runs
.Nm .
.El
.Sh EXIT STATUS
.Ex -std
.\"
.Sh FILES
.Bl -tag -width /var/run/rtsold.dump -compact
.It Pa /var/run/rtsold.pid
@ -234,6 +231,9 @@ the pid of the currently running
dumps internal state on.
.El
.\"
.Sh EXIT STATUS
.Ex -std
.\"
.Sh SEE ALSO
.Xr rtadvd 8 ,
.Xr sysctl 8

4
usr.sbin/sa/sa.8
View File

@ -234,6 +234,8 @@ per-user accounting summary database
.Xr acct 5 ,
.Xr ac 8 ,
.Xr accton 8
.Sh AUTHORS
.An Chris G. Demetriou Aq cgd@postgres.berkeley.edu
.Sh CAVEATS
While the behavior of the options in this version of
.Nm
@ -251,8 +253,6 @@ The formats of the summary files created by this version of
are very different from the those used by the original version.
This is not considered a problem, however, because the accounting record
format has changed as well (since user ids are now 32 bits).
.Sh AUTHORS
.An Chris G. Demetriou Aq cgd@postgres.berkeley.edu
.Sh BUGS
The number of options to this program is absurd, especially considering
that there is not much logic behind their lettering.

10
usr.sbin/wpa/wpa_supplicant/wpa_supplicant.conf.5
View File

@ -456,6 +456,11 @@ openssl pkcs12 -in example.pfx -out user.pem -clcerts
# convert CA certificate (if included in PFX file) to PEM format
openssl pkcs12 -in example.pfx -out ca.pem -cacerts -nokeys
.Ed
.Sh FILES
.Bl -tag -width ".Pa /usr/share/examples/etc/wpa_supplicant.conf" -compact
.It Pa /etc/wpa_supplicant.conf
.It Pa /usr/share/examples/etc/wpa_supplicant.conf
.El
.Sh EXAMPLES
WPA-Personal (PSK) as a home network and WPA-Enterprise with EAP-TLS
as a work network:
@ -538,11 +543,6 @@ network={
wep_key0=42FEEDDEAFBABEDEAFBEEFAA55
}
.Ed
.Sh FILES
.Bl -tag -width ".Pa /usr/share/examples/etc/wpa_supplicant.conf" -compact
.It Pa /etc/wpa_supplicant.conf
.It Pa /usr/share/examples/etc/wpa_supplicant.conf
.El
.Sh SEE ALSO
.Xr wpa_cli 8 ,
.Xr wpa_passphrase 8 ,