mdoc(7) police: markup overhaul.

Approved by: re
2002-12-04 16:28:45 +00:00 · 2002-12-04 16:28:45 +00:00 · 3b29692060
commit 3b29692060
parent a83e5e4149
7 changed files with 82 additions and 58 deletions
--- a/lib/libc/posix1e/mac.3
+++ b/lib/libc/posix1e/mac.3
@ -1,12 +1,12 @@
 .\" Copyright (c) 2001 Networks Associates Technology, Inc.
 .\" All rights reserved.
-.\" 
+.\"
 .\" This software was developed for the FreeBSD Project by Chris
 .\" Costello at Safeport Network Services and Network Associates
 .\" Laboratories, the Security Research Division of Network Associates,
 .\" Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part
 .\" of the DARPA CHATS research program.
-.\" 
+.\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
@ -15,7 +15,7 @@
 .\" 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.
-.\" 
+.\"
 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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
@ -27,8 +27,9 @@
 .\" 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.
-.\" 
+.\"
 .\" $FreeBSD$
+.\"
 .Dd December 21, 2001
 .Dt MAC 3
 .Sh NAME
@ -120,8 +121,8 @@ into a text-form MAC label.
 .Sh IMPLEMENTATION NOTES
 .Fx Ns 's
 support for POSIX.1e interfaces and features
-is still under development
-at this time.
+is
+.Ud .
 .Sh SEE ALSO
 .Xr mac_free 3 ,
 .Xr mac_get 3 ,
@ -139,9 +140,13 @@ for more information.
 .Sh HISTORY
 Support for Mandatory Access Control was introduced in
 .Fx 5.0
-as part of the TrustedBSD Project.
+as part of the
+.Tn TrustedBSD
+Project.
 .Sh BUGS
-The TrustedBSD MAC Framework and associated policies, interfaces, and
+The
+.Tn TrustedBSD
+MAC Framework and associated policies, interfaces, and
 applications are considered to be an experimental feature in
 .Fx .
 Sites considering production deployment should keep the experimental
--- a/lib/libc/posix1e/mac_free.3
+++ b/lib/libc/posix1e/mac_free.3
@ -1,12 +1,12 @@
 .\" Copyright (c) 2001, 2002 Networks Associates Technology, Inc.
 .\" All rights reserved.
-.\" 
+.\"
 .\" This software was developed for the FreeBSD Project by Chris
 .\" Costello at Safeport Network Services and NAI Labs, the Security
 .\" Research Division of Network Associates, Inc. under DARPA/SPAWAR
 .\" contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
 .\" research program.
-.\" 
+.\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
@ -18,7 +18,7 @@
 .\" 3. The name of the author may not be used to endorse or promote
 .\"    products derived from this software without specific prior written
 .\"    permission.
-.\" 
+.\"
 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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
@ -30,8 +30,9 @@
 .\" 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.
-.\" 
+.\"
 .\" $FreeBSD$
+.\"
 .Dd December 21, 2001
 .Dt MAC_FREE 3
 .Os
@ -53,7 +54,9 @@ function frees the storage allocated to contain a
 The
 .Fn mac_free
 function always returns 0.
-WARNING: see the notes in the BUGS section regarding the use of this
+WARNING: see the notes in the
+.Sx BUGS
+section regarding the use of this
 function.
 .Sh SEE ALSO
 .Xr mac 3 ,
@ -75,7 +78,9 @@ will be used to free text strings created using
 .Xr mac_to_text 3 .
 Because
 .Vt mac_t
-is a complex structure in the TrustedBSD implementation,
+is a complex structure in the
+.Tn TrustedBSD
+implementation,
 .Fn mac_free
 is specific to that type, and must not be used to free the character
 strings returned from
--- a/lib/libc/posix1e/mac_get.3
+++ b/lib/libc/posix1e/mac_get.3
@ -1,12 +1,12 @@
 .\" Copyright (c) 2001 Networks Associates Technology, Inc.
 .\" All rights reserved.
-.\" 
+.\"
 .\" This software was developed for the FreeBSD Project by Chris
 .\" Costello at Safeport Network Services and NAI Labs, the Security
 .\" Research Division of Network Associates, Inc. under DARPA/SPAWAR
 .\" contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
 .\" research program.
-.\" 
+.\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
@ -18,7 +18,7 @@
 .\" 3. The name of the author may not be used to endorse or promote
 .\"    products derived from this software without specific prior written
 .\"    permission.
-.\" 
+.\"
 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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
@ -30,8 +30,9 @@
 .\" 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.
-.\" 
+.\"
 .\" $FreeBSD$
+.\"
 .Dd December 21, 2001
 .Dt MAC_GET 3
 .Sh NAME
@ -39,6 +40,8 @@
 .Nm mac_get_fd ,
 .Nm mac_get_proc
 .Nd get the label of a file, socket, socket peer or process
+.Sh LIBRARY
+.Lb libc
 .Sh SYNOPSIS
 .In sys/mac.h
 .Ft mac_t
@ -58,8 +61,9 @@ the pathname pointed to by
 .Fa path_p
 or the file descriptor specified by
 .Fa fd ,
-respectively.  Note this function will
-fail on socket descriptors.  For information on
+respectively.
+Note that this function will fail on socket descriptors.
+For information on
 getting MAC labels on socket descriptors see
 .Xr getsockopt 2 .
 The
@ -96,8 +100,8 @@ is not a directory.
 .Sh SEE ALSO
 .Xr mac 3 ,
 .Xr mac_free 3 ,
-.Xr mac_text 3 ,
-.Xr mac_set 3
+.Xr mac_set 3 ,
+.Xr mac_text 3
 .Sh STANDARDS
 POSIX.1e is described in IEEE POSIX.1e draft 17.
 Discussion of the draft
--- a/lib/libc/posix1e/mac_is_present.3
+++ b/lib/libc/posix1e/mac_is_present.3
@ -1,12 +1,12 @@
 .\" Copyright (c) 2002 Networks Associates Technology, Inc.
 .\" All rights reserved.
-.\" 
+.\"
 .\" This software was developed for the FreeBSD Project by Chris
 .\" Costello at Safeport Network Services and NAI Labs, the Security
 .\" Research Division of Network Associates, Inc. under DARPA/SPAWAR
 .\" contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
 .\" research program.
-.\" 
+.\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
@ -18,7 +18,7 @@
 .\" 3. The name of the author may not be used to endorse or promote
 .\"    products derived from this software without specific prior written
 .\"    permission.
-.\" 
+.\"
 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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
@ -30,13 +30,16 @@
 .\" 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.
-.\" 
+.\"
 .\" $FreeBSD$
+.\"
 .Dd January 9, 2002
 .Dt MAC_IS_PRESENT_NP 3
 .Sh NAME
 .Nm mac_is_present_np
 .Nd report whether the running system has MAC support
+.Sh LIBRARY
+.Lb libc
 .Sh SYNOPSIS
 .In sys/mac.h
 .Ft int
@ -48,18 +51,18 @@ function determines whether the currently-running kernel supports MAC for
 a given policy or not.
 If
 .Fa policyname
-is non-
-.Ns Dv NULL ,
+is
+.No non- Ns Dv NULL ,
 the presence of the named policy
-(e.g.
-.Dq biba , 
-.Dq mls ,
-.Dq te )
+(e.g.\&
+.Dq Li biba ,
+.Dq Li mls ,
+.Dq Li te )
 is checked, otherwise the presence of any MAC policies at all is checked.
 .Sh RETURN VALUES
 If the system supports the given MAC policy, the value 1 is returned.
 If the specified MAC policy is not supported, the value 0 is returned.
-If an error occurs, the value -1 is returned.
+If an error occurs, the value \-1 is returned.
 .Sh ERRORS
 .Bl -tag -width Er
 .It Bq Er EINVAL
--- a/lib/libc/posix1e/mac_is_present_np.3
+++ b/lib/libc/posix1e/mac_is_present_np.3
@ -1,12 +1,12 @@
 .\" Copyright (c) 2002 Networks Associates Technology, Inc.
 .\" All rights reserved.
-.\" 
+.\"
 .\" This software was developed for the FreeBSD Project by Chris
 .\" Costello at Safeport Network Services and NAI Labs, the Security
 .\" Research Division of Network Associates, Inc. under DARPA/SPAWAR
 .\" contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
 .\" research program.
-.\" 
+.\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
@ -18,7 +18,7 @@
 .\" 3. The name of the author may not be used to endorse or promote
 .\"    products derived from this software without specific prior written
 .\"    permission.
-.\" 
+.\"
 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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
@ -30,13 +30,16 @@
 .\" 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.
-.\" 
+.\"
 .\" $FreeBSD$
+.\"
 .Dd January 9, 2002
 .Dt MAC_IS_PRESENT_NP 3
 .Sh NAME
 .Nm mac_is_present_np
 .Nd report whether the running system has MAC support
+.Sh LIBRARY
+.Lb libc
 .Sh SYNOPSIS
 .In sys/mac.h
 .Ft int
@ -48,18 +51,18 @@ function determines whether the currently-running kernel supports MAC for
 a given policy or not.
 If
 .Fa policyname
-is non-
-.Ns Dv NULL ,
+is
+.No non- Ns Dv NULL ,
 the presence of the named policy
-(e.g.
-.Dq biba , 
-.Dq mls ,
-.Dq te )
+(e.g.\&
+.Dq Li biba ,
+.Dq Li mls ,
+.Dq Li te )
 is checked, otherwise the presence of any MAC policies at all is checked.
 .Sh RETURN VALUES
 If the system supports the given MAC policy, the value 1 is returned.
 If the specified MAC policy is not supported, the value 0 is returned.
-If an error occurs, the value -1 is returned.
+If an error occurs, the value \-1 is returned.
 .Sh ERRORS
 .Bl -tag -width Er
 .It Bq Er EINVAL
--- a/lib/libc/posix1e/mac_set.3
+++ b/lib/libc/posix1e/mac_set.3
@ -1,12 +1,12 @@
 .\" Copyright (c) 2001 Networks Associates Technology, Inc.
 .\" All rights reserved.
-.\" 
+.\"
 .\" This software was developed for the FreeBSD Project by Chris
 .\" Costello at Safeport Network Services and NAI Labs, the Security
 .\" Research Division of Network Associates, Inc. under DARPA/SPAWAR
 .\" contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
 .\" research program.
-.\" 
+.\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
@ -18,7 +18,7 @@
 .\" 3. The name of the author may not be used to endorse or promote
 .\"    products derived from this software without specific prior written
 .\"    permission.
-.\" 
+.\"
 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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
@ -30,8 +30,9 @@
 .\" 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.
-.\" 
+.\"
 .\" $FreeBSD$
+.\"
 .Dd December 21, 2001
 .Dt MAC_SET 3
 .Sh NAME
@ -61,8 +62,9 @@ to the file referenced to by
 .Fa path_p ,
 or to the file descriptor
 .Fa fd ,
-respectively.  Note this function will
-fail on socket descriptors.  For information on
+respectively.
+Note that this function will fail on socket descriptors.
+For information on
 setting MAC labels on socket descriptors see
 .Xr setsockopt 2 .
 The
@ -74,7 +76,7 @@ to the calling process.
 .Pp
 A process is allowed to set a label for a file
 only if it has MAC write access to the file,
-and its effective user id is equal to
+and its effective user ID is equal to
 the owner of the file,
 or has appropriate privileges.
 .Sh RETURN VALUES
@ -117,8 +119,9 @@ A component of the pathname
 referenced by
 .Fa path_p
 is not a directory.
+.El
 .Sh SEE_ALSO
 .Xr mac 3 ,
 .Xr mac_free 3 ,
-.Xr mac_text 3 ,
-.Xr mac_get 3
+.Xr mac_get 3 ,
+.Xr mac_text 3
--- a/lib/libc/posix1e/mac_text.3
+++ b/lib/libc/posix1e/mac_text.3
@ -1,12 +1,12 @@
 .\" Copyright (c) 2001 Networks Associates Technology, Inc.
 .\" All rights reserved.
-.\" 
+.\"
 .\" This software was developed for the FreeBSD Project by Chris
 .\" Costello at Safeport Network Services and NAI Labs, the Security
 .\" Research Division of Network Associates, Inc. under DARPA/SPAWAR
 .\" contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
 .\" research program.
-.\" 
+.\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
@ -18,7 +18,7 @@
 .\" 3. The name of the author may not be used to endorse or promote
 .\"    products derived from this software without specific prior written
 .\"    permission.
-.\" 
+.\"
 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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
@ -30,8 +30,9 @@
 .\" 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.
-.\" 
+.\"
 .\" $FreeBSD$
+.\"
 .Dd December 21, 2001
 .Dt MAC_TEXT 3
 .Sh NAME
@ -51,7 +52,7 @@ The
 .Fn mac_from_text
 function converts the text representation of a label
 into the internal policy label format
-.Vt ( mac_t )
+.Pq Vt mac_t
 and places it in
 .Fa *mac ,
 which must later be freed with