PERFORCE change 90631 for review

[Robert Watson]

http://perforce.freebsd.org/chv.cgi?CH=90631

Change 90631 by rwatson at rwatson_peppercorn on 2006/01/29 18:20:42

	Man page cleanup:
	
	- Remove event_code.5, it's a good idea, but its time has not yet
	  come.
	- Use .Fn when naming system calls instead of .Nm, as that's not
	  the same thing.
	- Remove references to FreeBSD as being the point of appearance of
	  some calls, as they actually first appeared in Mac OS X/Solaris.
	- Use .Os instead of .Os Mac OS X in man page headers, as these
	  man pages will be used on several operating systems.
	- Add authors/history information to additional pages.
	- Document auditctl() a bit better.
	- Document that A_SENDTRIGGER is specific to Mac OS X and FreeBSD.

Affected files ...

.. //depot/projects/trustedbsd/audit3/contrib/openbsm/man/Makefile#3 edit
.. //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit.2#3 edit
.. //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_class.5#4 edit
.. //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_control.5#4 edit
.. //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_event.5#4 edit
.. //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_user.5#4 edit
.. //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_warn.5#4 edit
.. //depot/projects/trustedbsd/audit3/contrib/openbsm/man/auditctl.2#3 edit
.. //depot/projects/trustedbsd/audit3/contrib/openbsm/man/auditon.2#4 edit
.. //depot/projects/trustedbsd/audit3/contrib/openbsm/man/event_code.5#3 delete
.. //depot/projects/trustedbsd/audit3/contrib/openbsm/man/getaudit.2#3 edit
.. //depot/projects/trustedbsd/audit3/contrib/openbsm/man/getauid.2#3 edit
.. //depot/projects/trustedbsd/audit3/contrib/openbsm/man/setaudit.2#3 edit
.. //depot/projects/trustedbsd/audit3/contrib/openbsm/man/setauid.2#3 edit

Differences ...

==== //depot/projects/trustedbsd/audit3/contrib/openbsm/man/Makefile#3 (text+ko) ====

@@ -1,5 +1,5 @@
 #
-# $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/Makefile#2 $
+# $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/Makefile#3 $
 #
 
 MAN=	audit.2								\
@@ -14,7 +14,6 @@
 	audit_control.5							\
 	audit_event.5							\
 	audit_user.5							\
-	audit_warn.5							\
-	event_code.5
+	audit_warn.5
 
 .include <bsd.prog.mk>

==== //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit.2#3 (text+ko) ====

@@ -24,7 +24,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit.2#2 $
+.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit.2#3 $
 .\"
 .Dd April 19, 2005
 .Dt AUDIT 2
@@ -37,7 +37,7 @@
 .Ft int
 .Fn audit "const char *record" "u_int length"
 .Sh DESCRIPTION
-.Nm
+.Fn audit
 submits a completed BSM audit record to the system audit log.
 .Pp
 .Fa record
@@ -88,11 +88,6 @@
 division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
 It was subsequently adopted by the TrustedBSD Project as the foundation for
 the OpenBSM distribution.
-.Pp
-The
-.Fn audit
-function first appeared in
-.Fx
 .Sh BUGS
 The
 .Fx

==== //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_class.5#4 (text+ko) ====

@@ -25,11 +25,11 @@
 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_class.5#3 $
+.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_class.5#4 $
 .\"
 .Dd Jan 24, 2004
 .Dt AUDIT_CLASS 5
-.Os "Mac OS X"
+.Os
 .Sh NAME
 .Nm audit_class
 .Nd "contains audit event class descriptions"
@@ -56,3 +56,15 @@
 .Bl -tag -width "/etc/security/audit_class" -compact
 .It Pa /etc/security/audit_class
 .El
+.Sh AUTHORS
+This software was created by McAfee Research, the security research division
+of McAfee, Inc., under contract to Apple Computer Inc.
+Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
+.Pp
+The Basic Security Module (BSM) interface to audit records and audit event
+stream format were defined by Sun Microsystems.
+.Sh HISTORY
+The OpenBSM implementation was created by McAfee Research, the security
+division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
+It was subsequently adopted by the TrustedBSD Project as the foundation for
+the OpenBSM distribution.

==== //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_control.5#4 (text+ko) ====

@@ -25,17 +25,17 @@
 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_control.5#3 $
+.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_control.5#4 $
 .\"
 .Dd Jan 24, 2004
 .Dt AUDIT_CONTROL 5
-.Os "Mac OS X"
+.Os
 .Sh NAME
 .Nm audit_control
 .Nd "contains audit system parameters"
 .Sh DESCRIPTION
 The
-.Nm 
+.Nm
 file contains several audit system parameters.
 Each line of this file is of the form:
 .Dl parameter:value.
@@ -107,3 +107,15 @@
 .Xr auditd 8 ,
 .Xr audit_class 5 ,
 .Xr audit_user 5
+.Sh AUTHORS
+This software was created by McAfee Research, the security research division
+of McAfee, Inc., under contract to Apple Computer Inc.
+Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
+.Pp
+The Basic Security Module (BSM) interface to audit records and audit event
+stream format were defined by Sun Microsystems.
+.Sh HISTORY
+The OpenBSM implementation was created by McAfee Research, the security
+division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
+It was subsequently adopted by the TrustedBSD Project as the foundation for
+the OpenBSM distribution.

==== //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_event.5#4 (text+ko) ====

@@ -25,11 +25,11 @@
 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_event.5#3 $
+.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_event.5#4 $
 .\"
 .Dd Jan 24, 2004
 .Dt AUDIT_EVENT 5
-.Os "Mac OS X"
+.Os
 .Sh NAME
 .Nm audit_event
 .Nd "contains audit event descriptions"
@@ -60,3 +60,15 @@
 .El
 .Sh SEE ALSO
 .Xr audit_class 5
+.Sh AUTHORS
+This software was created by McAfee Research, the security research division
+of McAfee, Inc., under contract to Apple Computer Inc.
+Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
+.Pp
+The Basic Security Module (BSM) interface to audit records and audit event
+stream format were defined by Sun Microsystems.
+.Sh HISTORY
+The OpenBSM implementation was created by McAfee Research, the security
+division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
+It was subsequently adopted by the TrustedBSD Project as the foundation for
+the OpenBSM distribution.

==== //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_user.5#4 (text+ko) ====

@@ -25,11 +25,11 @@
 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_user.5#3 $
+.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_user.5#4 $
 .\"
 .Dd Jan 24, 2004
 .Dt AUDIT_USER 5
-.Os "Mac OS X"
+.Os
 .Sh NAME
 .Nm audit_user
 .Nd "specifies events to be audited for the given users"
@@ -77,3 +77,15 @@
 .El
 .Sh SEE ALSO
 .Xr audit_control 5
+.Sh AUTHORS
+This software was created by McAfee Research, the security research division
+of McAfee, Inc., under contract to Apple Computer Inc.
+Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
+.Pp
+The Basic Security Module (BSM) interface to audit records and audit event
+stream format were defined by Sun Microsystems.
+.Sh HISTORY
+The OpenBSM implementation was created by McAfee Research, the security
+division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
+It was subsequently adopted by the TrustedBSD Project as the foundation for
+the OpenBSM distribution.

==== //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_warn.5#4 (text+ko) ====

@@ -25,11 +25,11 @@
 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_warn.5#3 $
+.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/audit_warn.5#4 $
 .\"
 .Dd Mar 17, 2004
 .Dt AUDIT_WARN 5
-.Os "Mac OS X"
+.Os
 .Sh NAME
 .Nm audit_warn
 .Nd "alert when audit daemon issues warnings"
@@ -55,3 +55,15 @@
 .El
 .Sh SEE ALSO
 .Xr auditd 8
+.Sh AUTHORS
+This software was created by McAfee Research, the security research division
+of McAfee, Inc., under contract to Apple Computer Inc.
+Additional authors include Wayne Salamon, Robert Watson, and SPARTA Inc.
+.Pp
+The Basic Security Module (BSM) interface to audit records and audit event
+stream format were defined by Sun Microsystems.
+.Sh HISTORY
+The OpenBSM implementation was created by McAfee Research, the security
+division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
+It was subsequently adopted by the TrustedBSD Project as the foundation for
+the OpenBSM distribution.

==== //depot/projects/trustedbsd/audit3/contrib/openbsm/man/auditctl.2#3 (text+ko) ====

@@ -1,5 +1,5 @@
 .\"-
-.\" Copyright (c) 2005 Robert N. M. Watson
+.\" Copyright (c) 2005-2006 Robert N. M. Watson
 .\" All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
@@ -23,7 +23,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/auditctl.2#2 $
+.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/auditctl.2#3 $
 .\"
 .Dd April 19, 2005
 .Dt AUDITCTL 2
@@ -34,26 +34,33 @@
 .Sh SYNOPSIS
 .In bsm/audit.h
 .Ft int
-.Fn auditon "int cmd" "char *path"
+.Fn auditon "const char *path"
 .Sh DESCRIPTION
-
-XXXXXXXXXXXXXXXX
-
+The
+.Fn auditctl
+system call directs the kernel to open a new audit trail log file.
+.Fn auditctl
+requires appropriate privilege.
+In the
+.Fx
+implementation,
+.Fn auditctl
+opens new files, but
+.Fn auditon
+is used to disable the audit log.
+In the Mac OS X implementation, passing
+.Va NULL
+to
+.Fn auditctl
+will disable the audit log.
 .Sh RETURN VALUES
 .Nm
 returns 0 on success, or returns -1 on failure, providing additional error
 information via
 .Va errno .
 .Sh SEE ALSO
-.Xr audit 2 ,
-.Xr auditon 2 ,
-.Xr getauid 2 ,
-.Xr setauid 2 ,
-.Xr getaudit 2 ,
-.Xr setaudit 2 ,
-.Xr getaudit_addr 2 ,
-.Xr setaudit_addr 2 ,
-.Xr libbsm 3
+.Xr libbsm 3 ,
+.Xr auditd 8
 .Sh AUTHORS
 This software was created by McAfee Research, the security research division
 of McAfee, Inc., under contract to Apple Computer Inc.
@@ -61,9 +68,11 @@
 .Pp
 The Basic Security Module (BSM) interface to audit records and audit event
 stream format were defined by Sun Microsystems.
+.Pp
+This manual page was written by
+.An Robert Watson Aq rwatson at FreeBSD.org .
 .Sh HISTORY
 The OpenBSM implementation was created by McAfee Research, the security
 division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
 It was subsequently adopted by the TrustedBSD Project as the foundation for
 the OpenBSM distribution.
-.Sh BUGS

==== //depot/projects/trustedbsd/audit3/contrib/openbsm/man/auditon.2#4 (text+ko) ====

@@ -25,7 +25,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/auditon.2#3 $
+.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/auditon.2#4 $
 .\"
 .Dd April 19, 2005
 .Dt AUDITON 2
@@ -252,6 +252,12 @@
 The process does not have sufficient permission to complete
 the operation.
 .El
+.Pp
+The
+.Dv A_SENDTRIGGER
+command is specific to the
+.Fx
+and Mac OS X implementations, and is not present in Solaris.
 .Sh SEE ALSO
 .Xr audit 2 ,
 .Xr auditctl 2 ,
@@ -280,8 +286,3 @@
 division of McAfee Inc., under contract to Apple Computer Inc. in 2003.
 It was subsequently adopted by the TrustedBSD Project as the foundation for
 the OpenBSM distribution.
-.Pp
-The
-.Fn auditon
-function first appeared in
-.Fx 6.0 .

==== //depot/projects/trustedbsd/audit3/contrib/openbsm/man/getaudit.2#3 (text+ko) ====

@@ -23,7 +23,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/getaudit.2#2 $
+.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/getaudit.2#3 $
 .\"
 .Dd April 19, 2005
 .Dt GETAUDIT 2
@@ -70,6 +70,9 @@
 .Pp
 The Basic Security Module (BSM) interface to audit records and audit event
 stream format were defined by Sun Microsystems.
+.Pp
+This manual page was written by
+.An Robert Watson Aq rwatson at FreeBSD.org .
 .Sh HISTORY
 The OpenBSM implementation was created by McAfee Research, the security
 division of McAfee Inc., under contract to Apple Computer Inc. in 2004.

==== //depot/projects/trustedbsd/audit3/contrib/openbsm/man/getauid.2#3 (text+ko) ====

@@ -23,7 +23,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/getauid.2#2 $
+.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/getauid.2#3 $
 .\"
 .Dd April 19, 2005
 .Dt GETAUID 2
@@ -64,6 +64,9 @@
 .Pp
 The Basic Security Module (BSM) interface to audit records and audit event
 stream format were defined by Sun Microsystems.
+.Pp
+This manual page was written by
+.An Robert Watson Aq rwatson at FreeBSD.org .
 .Sh HISTORY
 The OpenBSM implementation was created by McAfee Research, the security
 division of McAfee Inc., under contract to Apple Computer Inc. in 2004.

==== //depot/projects/trustedbsd/audit3/contrib/openbsm/man/setaudit.2#3 (text+ko) ====

@@ -23,7 +23,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/setaudit.2#2 $
+.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/setaudit.2#3 $
 .\"
 .Dd April 19, 2005
 .Dt SETAUDIT 2
@@ -71,6 +71,9 @@
 .Pp
 The Basic Security Module (BSM) interface to audit records and audit event
 stream format were defined by Sun Microsystems.
+.Pp
+This manual page was written by
+.An Robert Watson Aq rwatson at FreeBSD.org .
 .Sh HISTORY
 The OpenBSM implementation was created by McAfee Research, the security
 division of McAfee Inc., under contract to Apple Computer Inc. in 2004.

==== //depot/projects/trustedbsd/audit3/contrib/openbsm/man/setauid.2#3 (text+ko) ====

@@ -23,7 +23,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/setauid.2#2 $
+.\" $P4: //depot/projects/trustedbsd/audit3/contrib/openbsm/man/setauid.2#3 $
 .\"
 .Dd April 19, 2005
 .Dt SETAUID 2
@@ -64,6 +64,9 @@
 .Pp
 The Basic Security Module (BSM) interface to audit records and audit event
 stream format were defined by Sun Microsystems.
+.Pp
+This manual page was written by
+.An Robert Watson Aq rwatson at FreeBSD.org .
 .Sh HISTORY
 The OpenBSM implementation was created by McAfee Research, the security
 division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
To Unsubscribe: send mail to majordomo at trustedbsd.org
with "unsubscribe trustedbsd-cvs" in the body of the message