talexander
/
freebsd_amp_hwpstate
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Various man page cleanup: 

- Sort xrefs
- FreeBSD.ORG -> FreeBSD.org
- Be consistent with section names as outlines in mdoc(7)
- Other misc mdoc cleanup.

PR:		doc/13144
Submitted by:	Alexy M. Zelkin <phantom@cris.net>
This commit is contained in:
Mike Pritchard 1999-08-15 09:51:25 +00:00
parent bd3a53203f
commit 74804d58a0
19 changed files with 93 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
lib/libalias/libalias.3
View File

@ -1,13 +1,11 @@
.\" $Id$
.\"
.Dd July, 1997
.Dt "libalias" 3
.Dt LIBALIAS 3
.Os
.Sh NAME
.Nm "libalias"
Packet Aliasing Library. A collection of
functions for aliasing and de-aliasing
of IP packets, intended for masquerading and
network address translation (NAT).
.Nm libalias
.Nd packet aliasing library for masquerading and address translation (NAT)
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <netinet/in.h>
@ -15,7 +13,13 @@ network address translation (NAT).
Function prototypes are given in the main body
of the text.
.Sh DESCRIPTION
The
.Nm
library is a collection of
functions for aliasing and de-aliasing
of IP packets, intended for masquerading and
network address translation (NAT).
.Sh CONTENTS
.Bd -literal -offset left
1. Introduction
@ -51,7 +55,6 @@ Appendix A: Conceptual Background
A.3 Partially Specified Links
A.4 Dynamic Link Creation
.Ed
.Sh 1. Introduction
This library is a moderately portable
set of functions designed to assist
@ -86,7 +89,6 @@ to operate in user space outside of the
kernel, without any access to private
kernel data structure, but the source code
can also be ported to a kernel environment.
.Sh 2. Initialization and Control
Two specific functions, PacketAliasInit()
and PacketAliasSetAddress(), must always be
@ -275,7 +277,6 @@ interface rather than the external one.
Set IPFW range allocated for punching firewall holes (with the
PKT_ALIAS_PUNCH_FW flag). The range will be cleared for all rules on
initialization.
.Sh 3. Packet Handling
The packet handling functions are used to
modify incoming (remote->local) and outgoing
@ -360,7 +361,6 @@ The packet was ignored and not de-aliased.
This can happen if the protocal is unrecognized,
or possibly an ICMP message type is not handled.
.El
.Sh 4. Port and Address Redirection
The functions described in this section allow machines
on the local network to be accessible in some degree
@ -495,7 +495,6 @@ functions. If an invalid pointer is passed to
PacketAliasRedirectDelete(), then a program crash
or unpredictable operation could result, so it is
necessary to be careful using this function.
.Sh 5. Fragment Handling
The functions in this section are used to deal with
incoming fragments.
@ -686,7 +685,6 @@ is the pointer to a header fragment used as a
template, and
.Em fragment
is the pointer to the packet to be de-aliased.
.Sh 6. Miscellaneous Functions
.Ss 6.1 PacketAliasSetTarget()
@ -734,7 +732,6 @@ field should be zeroed before computing the checksum.
Checksums can also be verified by operating on a block
of data including its checksum. If the checksum is
valid, PacketAliasInternetChecksum() will return zero.
.Sh 7. Authors
Charles Mott (cmott@srv.net), versions 1.0 - 1.8, 2.0 - 2.4.
@ -742,7 +739,6 @@ Eivind Eklund (eivind@freebsd.org), versions 1.8b, 1.9 and
2.5. Added IRC DCC support as well as contributing a number of
architectural improvements; added the firewall bypass
for FTP/IRC DCC.
.Sh 8. Acknowledgments
Listed below, in approximate chronological
@ -762,7 +758,6 @@ valuable comments and/or debugging assistance.
.It Andrzej Bialeki
.It Gordon Burditt
.El
.Sh Appendix: Conceptual Background
This appendix is intended for those who
are planning to modify the source code or want

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

@ -23,10 +23,10 @@
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $Id: ftok.3,v 1.9 1998/03/19 07:33:54 charnier Exp $
.\" $Id: ftok.3,v 1.10 1998/06/10 04:24:18 jdp Exp $
.Dd June 24, 1994
.Os
.Dt ftok 3
.Dt FTOK 3
.Sh NAME
.Nm ftok
.Nd create IPC identifier from path name

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

@ -1,4 +1,4 @@
.\" $Id: getvfsent.3,v 1.14 1998/05/30 18:20:37 steve Exp $
.\" $Id: getvfsent.3,v 1.15 1999/04/20 20:36:36 ghelmer Exp $
.\" Written by Garrett A. Wollman, September 1994.
.\" This manual page is in the public domain.
.\"
@ -148,8 +148,8 @@ fails,
may be set to one of the values documented for
.Xr kldload 2 .
.Sh SEE ALSO
.Xr mount 2 ,
.Xr kldload 2 ,
.Xr mount 2 ,
.Xr mount 8
.Sh AUTHORS
The loadable filesystem support was written by

6
lib/libc/stdlib/malloc.3
View File

@ -34,7 +34,7 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)malloc.3 8.1 (Berkeley) 6/4/93
.\" $Id: malloc.3,v 1.18 1999/03/28 14:16:04 phk Exp $
.\" $Id: malloc.3,v 1.19 1999/08/14 07:33:15 chris Exp $
.\"
.Dd August 27, 1996
.Dt MALLOC 3
@ -274,7 +274,7 @@ is still available and intact.
The
.Fn free
function returns no value.
.Sh "DEBUGGING MALLOC PROBLEMS"
.Sh DEBUGGING MALLOC PROBLEMS
.Pp
The major difference between this implementation and other allocation
implementations is that the free pages are not accessed unless allocated,
@ -333,7 +333,7 @@ would be prohibitive.
There are a number of allocation implementations available on the 'Net
which focus on detecting and pinpointing problems by trading performance
for extra sanity checks and detailed diagnostics.
.Sh "DIAGNOSTIC MESSAGES
.Sh DIAGNOSTIC MESSAGES
If
.Fn malloc ,
.Fn calloc ,

11
lib/libc/string/strtok.3
View File

@ -48,7 +48,7 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)strtok.3 8.2 (Berkeley) 2/3/94
.\" $Id$
.\" $Id: strtok.3,v 1.6 1999/07/12 20:48:13 nik Exp $
.\"
.Dd November 27, 1998
.Dt STRTOK 3
@ -161,8 +161,9 @@ value.
Since this implementation always alters the next starting point,
such a sequence of calls would always return
.Dv NULL .
.Sh AUTHOR
Wes Peters, Softweyr LLC:
.Xr <wes@softweyr.com>
.Sh AUTHORS
.An Wes Peters, Softweyr LLC: Aq wes@softweyr.com
.br
Based on the FreeBSD 3.0 implementation.
Based on the
.Fx 3.0
implementation.

10
lib/libc/sys/aio_cancel.2
View File

@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: aio_cancel.2,v 1.2 1999/07/01 21:09:55 mpp Exp $
.\" $Id: aio_cancel.2,v 1.3 1999/07/01 21:13:06 mpp Exp $
.\"
.Dd June 2, 1999
.Dt AIO_CANCEL 2
@ -49,11 +49,11 @@ inevitably fails, it returns
.Dv ENOSYS
to signify it is not supported.
.Sh SEE ALSO
.Xr aio_read 2 ,
.Xr aio_write 2 ,
.Xr aio_error 2 ,
.Xr aio_read 2 ,
.Xr aio_return 2 ,
.Xr aio_suspend 2 .
.Xr aio_suspend 2 ,
.Xr aio_write 2 .
.Sh ERRORS
The
.Fn aio_cancel
@ -72,7 +72,7 @@ The
.Nm
function first appeared in
.Fx 3.0 .
.Sh AUTHOR
.Sh AUTHORS
This
manual page was written by
.An Wes Peters Aq wes@softweyr.com .

14
lib/libc/sys/aio_error.2
View File

@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: aio_error.2,v 1.2 1999/07/01 21:09:55 mpp Exp $
.\" $Id: aio_error.2,v 1.3 1999/07/01 21:13:06 mpp Exp $
.\"
.Dd June 2, 1999
.Dt AIO_ERROR 2
@ -69,14 +69,14 @@ function will fail if:
does not reference an outstanding asynchronous I/O request.
.El
.Sh SEE ALSO
.Xr aio_return 2 ,
.Xr aio_read 2 ,
.Xr aio_write 2 ,
.Xr aio_cancel 2 ,
.Xr aio_read 2 ,
.Xr aio_return 2 ,
.Xr aio_suspend 2 ,
.Xr aio_write 2 ,
.Xr fsync 2 ,
.Xr read 2 ,
.Xr write 2 ,
.Xr fsync 2 .
.Xr write 2 .
.Sh STANDARDS
.Fn aio_error
is expected to conform to the
@ -87,7 +87,7 @@ The
.Nm
function first appeared in
.Fx 3.0 .
.Sh AUTHOR
.Sh AUTHORS
This
manual page was written by
.An Wes Peters Aq wes@softweyr.com .

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

@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: aio_read.2,v 1.3 1999/07/01 19:58:10 wes Exp $
.\" $Id: aio_read.2,v 1.4 1999/07/01 21:09:56 mpp Exp $
.\"
.Dd November 17, 1998
.Dt AIO_READ 2
@ -188,7 +188,7 @@ The
.Nm
function first appeared in
.Fx 3.0 .
.Sh AUTHOR
.Sh AUTHORS
This
manual page was written by
.An Terry Lambert Aq terry@whistle.com .

12
lib/libc/sys/aio_return.2
View File

@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: aio_return.2,v 1.2 1999/07/01 21:09:56 mpp Exp $
.\" $Id: aio_return.2,v 1.3 1999/07/01 21:13:06 mpp Exp $
.\"
.Dd June 2, 1999
.Dt AIO_RETURN 2
@ -62,14 +62,14 @@ and sets
.Dv errno
to indicate the error condition.
.Sh SEE ALSO
.Xr aio_cancel 2 ,
.Xr aio_error 2 ,
.Xr aio_read 2 ,
.Xr aio_write 2 ,
.Xr aio_cancel 2 ,
.Xr aio_suspend 2 ,
.Xr aio_write 2 ,
.Xr fsync 2 ,
.Xr read 2 ,
.Xr write 2 ,
.Xr fsync 2 .
.Xr write 2 .
.Sh ERRORS
The
.Fn aio_return
@ -89,7 +89,7 @@ The
.Nm
function first appeared in
.Fx 3.0 .
.Sh AUTHOR
.Sh AUTHORS
This
manual page was written by
.An Wes Peters Aq wes@softweyr.com .

10
lib/libc/sys/aio_suspend.2
View File

@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: aio_suspend.2,v 1.2 1999/07/01 21:09:57 mpp Exp $
.\" $Id: aio_suspend.2,v 1.3 1999/07/01 21:13:06 mpp Exp $
.\"
.Dd June 2, 1999
.Dt AIO_SUSPEND 2
@ -56,11 +56,11 @@ expired,
is returned. Other return values indicate an error condition as
detailed below.
.Sh SEE ALSO
.Xr aio_cancel 2 ,
.Xr aio_error 2 ,
.Xr aio_read 2 ,
.Xr aio_write 2 ,
.Xr aio_cancel 2 ,
.Xr aio_suspend 2.
.Xr aio_suspend 2 ,
.Xr aio_write 2 .
.Sh ERRORS
The
.Fn aio_suspend
@ -84,7 +84,7 @@ The
.Nm
function first appeared in
.Fx 3.0 .
.Sh AUTHOR
.Sh AUTHORS
This
manual page was written by
.An Wes Peters Aq wes@softweyr.com .

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

@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: aio_write.2,v 1.1 1999/07/01 19:58:12 wes Exp $
.\" $Id: aio_write.2,v 1.2 1999/07/01 21:09:57 mpp Exp $
.\"
.Dd June 2, 1999
.Dt AIO_WRITE 2
@ -181,7 +181,7 @@ The
.Nm
Function first appeared in
.Fx 3.0 .
.Sh AUTHOR
.Sh AUTHORS
This manual page was written by
.An Wes Peters Aq wes@softweyr.com .
.Sh BUGS

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

@ -30,7 +30,7 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)execve.2 8.5 (Berkeley) 6/1/94
.\" $Id: execve.2,v 1.12 1999/04/27 03:56:10 hoek Exp $
.\" $Id: execve.2,v 1.13 1999/08/14 06:17:24 chris Exp $
.\"
.Dd June 1, 1994
.Dt EXECVE 2
@ -273,14 +273,14 @@ the real
is ``root'', then the program has some of the powers
of a super-user as well.
.Sh SEE ALSO
.Xr ktrace 1 ,
.Xr _exit 2 ,
.Xr fork 2 ,
.Xr execl 3 ,
.Xr exit 3 ,
.Xr sysctl 3 ,
.Xr mount 8 ,
.Xr ktrace 1 ,
.Xr environ 7
.Xr environ 7 ,
.Xr mount 8
.Sh HISTORY
The
.Fn execve

11
lib/libc/sys/jail.2
View File

@ -6,7 +6,7 @@
.\"this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp
.\"----------------------------------------------------------------------------
.\"
.\"$Id: jail.2,v 1.3 1999/06/17 23:43:35 green Exp $
.\"$Id: jail.2,v 1.4 1999/07/09 21:35:37 phk Exp $
.\"
.\"
.Dd April 28, 1999
@ -78,15 +78,16 @@ Please consult the
.Xr chroot 2
manual page for details.
.Sh SEE ALSO
.Xr chroot 2 ,
.Xr chdir 2
.Xr chdir 2 ,
.Xr chroot 2
.Sh HISTORY
The
.Fn jail
function call appeared in
.Fx 4.0 .
.Pp
The jail feature was written by Poul-Henning Kamp for
R&D Associates
The jail feature was written by
.An Poul-Henning Kamp
for R&D Associates
.Dq Li http://www.rndassociates.com/
who contributed it to FreeBSD.

13
lib/libc/sys/sendfile.2
View File

@ -23,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: sendfile.2,v 1.2 1998/11/06 19:35:58 dg Exp $
.\" $Id: sendfile.2,v 1.3 1999/07/26 09:37:47 sheldonh Exp $
.\"
.Dd November 5, 1998
.Dt SENDFILE 2
@ -140,13 +140,16 @@ If specified, the number of bytes successfully sent will be returned in
.El
.Sh SEE ALSO
.Xr open 2 ,
.Xr socket 2 ,
.Xr send 2 ,
.Xr socket 2 ,
.Xr writev 2
.Sh HISTORY
.Fn sendfile
first appeared in FreeBSD 3.0.
This manual page first appeared in FreeBSD 3.1.
first appeared in
.Fx 3.0 .
This manual page first appeared in
.Fx 3.1 .
.Sh AUTHORS
.Fn sendfile
and this manual page were written by David Greenman <dg@root.com>.
and this manual page were written by
.An David Greenman Aq dg@root.com .

6
lib/libcam/cam.3
View File

@ -25,7 +25,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: cam.3,v 1.1 1998/10/14 06:20:36 ken Exp $
.\" $Id: cam.3,v 1.2 1999/03/05 17:11:37 bde Exp $
.\"
.Dd October 10, 1998
.Os FreeBSD 3.0
@ -395,12 +395,12 @@ characters long.
.Sh SEE ALSO
.Xr cam_cdbparse 3 ,
.Xr pass 4 ,
.Xr camcontrol 8 ,
.Xr camcontrol 8
.Sh HISTORY
The CAM library first appeared in
.Fx 3.0 .
.Sh AUTHORS
.An Kenneth Merry Aq ken@FreeBSD.ORG
.An Kenneth Merry Aq ken@FreeBSD.org
.Sh BUGS
.Fn cam_open_device
doesn't check to see if the

4
lib/libftpio/ftpio.3
View File

@ -22,10 +22,10 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: ftpio.3,v 1.16 1998/02/10 07:01:51 jkh Exp $
.\" $Id: ftpio.3,v 1.17 1998/03/19 07:34:09 charnier Exp $
.\"
.Dd June 17, 1996
.Dt ftpio 3
.Dt FTPIO 3
.Os
.Sh NAME
.Nm ftpLogin ,

8
lib/libutil/property.3
View File

@ -23,11 +23,11 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $Id: property.3,v 1.4 1998/11/22 13:20:09 jkh Exp $
.\" $Id: property.3,v 1.5 1999/03/05 17:08:23 bde Exp $
.\" "
.Dd October 7, 1998
.Os
.Dt properties 3
.Dt PROPERTIES 3
.Sh NAME
.Nm properties_read ,
.Nm propery_find ,
@ -93,5 +93,5 @@ be a comment and will be ignored.
.Xr auth_getval 3
.Sh BUGS
Simplistic.
.Sh AUTHOR
Jordan Hubbard
.Sh AUTHORS
.An Jordan Hubbard

4
lib/libutil/uucplock.3
View File

@ -23,11 +23,11 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $Id: uucplock.3,v 1.10 1997/10/07 07:24:50 joerg Exp $
.\" $Id: uucplock.3,v 1.11 1998/05/28 23:17:08 brian Exp $
.\" "
.Dd March 30, 1997
.Os
.Dt uucplock 3
.Dt UUCPLOCK 3
.Sh NAME
.Nm uu_lock ,
.Nm uu_unlock ,

29
sys/netinet/libalias/libalias.3
View File

@ -1,13 +1,11 @@
.\" $Id$
.\"
.Dd July, 1997
.Dt "libalias" 3
.Dt LIBALIAS 3
.Os
.Sh NAME
.Nm "libalias"
Packet Aliasing Library. A collection of
functions for aliasing and de-aliasing
of IP packets, intended for masquerading and
network address translation (NAT).
.Nm libalias
.Nd packet aliasing library for masquerading and address translation (NAT)
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <netinet/in.h>
@ -15,7 +13,13 @@ network address translation (NAT).
Function prototypes are given in the main body
of the text.
.Sh DESCRIPTION
The
.Nm
library is a collection of
functions for aliasing and de-aliasing
of IP packets, intended for masquerading and
network address translation (NAT).
.Sh CONTENTS
.Bd -literal -offset left
1. Introduction
@ -51,7 +55,6 @@ Appendix A: Conceptual Background
A.3 Partially Specified Links
A.4 Dynamic Link Creation
.Ed
.Sh 1. Introduction
This library is a moderately portable
set of functions designed to assist
@ -86,7 +89,6 @@ to operate in user space outside of the
kernel, without any access to private
kernel data structure, but the source code
can also be ported to a kernel environment.
.Sh 2. Initialization and Control
Two specific functions, PacketAliasInit()
and PacketAliasSetAddress(), must always be
@ -275,7 +277,6 @@ interface rather than the external one.
Set IPFW range allocated for punching firewall holes (with the
PKT_ALIAS_PUNCH_FW flag). The range will be cleared for all rules on
initialization.
.Sh 3. Packet Handling
The packet handling functions are used to
modify incoming (remote->local) and outgoing
@ -360,7 +361,6 @@ The packet was ignored and not de-aliased.
This can happen if the protocal is unrecognized,
or possibly an ICMP message type is not handled.
.El
.Sh 4. Port and Address Redirection
The functions described in this section allow machines
on the local network to be accessible in some degree
@ -495,7 +495,6 @@ functions. If an invalid pointer is passed to
PacketAliasRedirectDelete(), then a program crash
or unpredictable operation could result, so it is
necessary to be careful using this function.
.Sh 5. Fragment Handling
The functions in this section are used to deal with
incoming fragments.
@ -686,7 +685,6 @@ is the pointer to a header fragment used as a
template, and
.Em fragment
is the pointer to the packet to be de-aliased.
.Sh 6. Miscellaneous Functions
.Ss 6.1 PacketAliasSetTarget()
@ -734,7 +732,6 @@ field should be zeroed before computing the checksum.
Checksums can also be verified by operating on a block
of data including its checksum. If the checksum is
valid, PacketAliasInternetChecksum() will return zero.
.Sh 7. Authors
Charles Mott (cmott@srv.net), versions 1.0 - 1.8, 2.0 - 2.4.
@ -742,7 +739,6 @@ Eivind Eklund (eivind@freebsd.org), versions 1.8b, 1.9 and
2.5. Added IRC DCC support as well as contributing a number of
architectural improvements; added the firewall bypass
for FTP/IRC DCC.
.Sh 8. Acknowledgments
Listed below, in approximate chronological
@ -762,7 +758,6 @@ valuable comments and/or debugging assistance.
.It Andrzej Bialeki
.It Gordon Burditt
.El
.Sh Appendix: Conceptual Background
This appendix is intended for those who
are planning to modify the source code or want