Expanded the -auditlog entries in the man pages of the server processes

The expanded auditlog explanation includes what information is recorded
in the auditlog.

LICENSE BSD

Reviewed-on: http://gerrit.openafs.org/213
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>

diff --git a/doc/man-pages/pod8/bosserver.pod b/doc/man-pages/pod8/bosserver.pod
index 27dc055c64b477f0daaa86eafc5fa22ba020c049..6b68cf8b8e3b1ffb3a69ce56b3f999832cafe6ad 100644 (file)
--- a/doc/man-pages/pod8/bosserver.pod
+++ b/doc/man-pages/pod8/bosserver.pod
@@ -95,7 +95,11 @@ listed in the F</usr/afs/etc/UserList> file).
 
 =item B<-auditlog> <I<log path>>
 
-Turns on audit logging, and sets the path for the audit log.
+Turns on audit logging, and sets the path for the audit log.  The audit
+log shows one entry per RPC call. Each entry records the name of the RPC
+call, the host that submitted the call, the authenticated entity (user)
+that issued the call, the parameters for the call, and if the call
+succeeded or failed.
 
 =item B<-audit-interface> (file | sysvmq)
 

diff --git a/doc/man-pages/pod8/buserver.pod b/doc/man-pages/pod8/buserver.pod
index 38af3e60b281359d7e3cba9c09ffeb8a12aa5878..838c6195f82ad202162362cf46d6f108ec160756 100644 (file)
--- a/doc/man-pages/pod8/buserver.pod
+++ b/doc/man-pages/pod8/buserver.pod
@@ -62,7 +62,11 @@ the default is the F</usr/afs/db> directory.
 
 =item B<-auditlog> <I<log path>>
 
-Turns on audit logging, and sets the path for the audit log.
+Turns on audit logging, and sets the path for the audit log.  The audit
+log shows one entry per RPC call. Each entry records the name of the RPC
+call, the host that submitted the call, the authenticated entity (user)
+that issued the call, the parameters for the call, and if the call
+succeeded or failed.
 
 =item B<-audit-interface> (file | sysvmq)
 

diff --git a/doc/man-pages/pod8/fileserver.pod b/doc/man-pages/pod8/fileserver.pod
index 9cf1a78b21dda163cb5335d4c06116e2ecebd67b..1e76e05e07751d0985267066c13a95bf3dac688c 100644 (file)
--- a/doc/man-pages/pod8/fileserver.pod
+++ b/doc/man-pages/pod8/fileserver.pod
@@ -256,7 +256,11 @@ length.
 
 =item B<-auditlog> <I<log path>>
 
-Set and enable auditing.
+Turns on audit logging, and sets the path for the audit log.  The audit
+log shows one entry per RPC call. Each entry records the name of the RPC
+call, the host that submitted the call, the authenticated entity (user)
+that issued the call, the parameters for the call, and if the call
+succeeded or failed.
 
 =item B<-audit-interface> (file | sysvmq)
 
@@ -767,6 +771,8 @@ L<FileLog(5)>,
 L<bos_create(8)>,
 L<bos_getlog(8)>,
 L<fs_setacl(1)>,
+L<msgget(2)>,
+L<msgrcv(2)>,
 L<salvager(8)>,
 L<volserver(8)>,
 L<vos_examine(1)>

diff --git a/doc/man-pages/pod8/kaserver.pod b/doc/man-pages/pod8/kaserver.pod
index 48fc766196fb0a04a0420da75840035003655397..cc7248132a7be5404311980fac9a8a9b30b03424 100644 (file)
--- a/doc/man-pages/pod8/kaserver.pod
+++ b/doc/man-pages/pod8/kaserver.pod
@@ -94,7 +94,11 @@ is probably inappropriate.
 
 =item B<-auditlog> <I<log path>>
 
-Turns on audit logging, and sets the path for the audit log.
+Turns on audit logging, and sets the path for the audit log.  The audit
+log shows one entry per RPC call. Each entry records the name of the RPC
+call, the host that submitted the call, the authenticated entity (user)
+that issued the call, the parameters for the call, and if the call
+succeeded or failed.
 
 =item B<-audit-interface> (file | sysvmq)
 

diff --git a/doc/man-pages/pod8/ptserver.pod b/doc/man-pages/pod8/ptserver.pod
index 43eb359da93471b31b12b5df282e4571a6ae392f..3eac52388621c7205b787bfba4e002ef12a5da57 100644 (file)
--- a/doc/man-pages/pod8/ptserver.pod
+++ b/doc/man-pages/pod8/ptserver.pod
@@ -153,7 +153,11 @@ with the string "ptserver".
 
 =item B<-auditlog> <I<log path>>
 
-Turns on audit logging, and sets the path for the audit log.
+Turns on audit logging, and sets the path for the audit log.  The audit
+log shows one entry per RPC call. Each entry records the name of the RPC
+call, the host that submitted the call, the authenticated entity (user)
+that issued the call, the parameters for the call, and if the call
+succeeded or failed.
 
 =item B<-audit-interface> (file | sysvmq)
 

diff --git a/doc/man-pages/pod8/vlserver.pod b/doc/man-pages/pod8/vlserver.pod
index bb100e2aa886ba90ea9e2534d1d4fd6b31964ecd..ce5ac760b87e8b3d0e95b6e0150fa7c9096c19d3 100644 (file)
--- a/doc/man-pages/pod8/vlserver.pod
+++ b/doc/man-pages/pod8/vlserver.pod
@@ -107,7 +107,11 @@ with this option.
 
 =item B<-auditlog> <I<log path>>
 
-Turns on audit logging, and sets the path for the audit log.
+Turns on audit logging, and sets the path for the audit log.  The audit
+log shows one entry per RPC call. Each entry records the name of the RPC
+call, the host that submitted the call, the authenticated entity (user)
+that issued the call, the parameters for the call, and if the call
+succeeded or failed.
 
 =item B<-audit-interface> (file | sysvmq)
 

diff --git a/doc/man-pages/pod8/volserver.pod b/doc/man-pages/pod8/volserver.pod
index 3f8c4e9b15c87d35157122b6ab7c89228e344741..7773f3726a9840c0d90c02c2109f76c6442b7822 100644 (file)
--- a/doc/man-pages/pod8/volserver.pod
+++ b/doc/man-pages/pod8/volserver.pod
@@ -69,7 +69,11 @@ integer between C<4> and C<16>. The default is C<9>.
 
 =item B<-auditlog> <I<log path>>
 
-Turns on audit logging, and sets the path for the audit log.
+Turns on audit logging, and sets the path for the audit log.  The audit
+log shows one entry per RPC call. Each entry records the name of the RPC
+call, the host that submitted the call, the authenticated entity (user)
+that issued the call, the parameters for the call, and if the call
+succeeded or failed.
 
 =item B<-audit-interface> (file | sysvmq)