6324 Add an `ndp' tool for manipulating the neighbors table
[illumos-gate.git] / usr / src / man / man1m / praudit.1m
blob84070e673cf3292bdad51be533aa1c96cbbee350
1 '\" te
2 .\" Copyright (c) 2003, Sun Microsystems, Inc.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH PRAUDIT 1M "Jul 26, 2009"
7 .SH NAME
8 praudit \- print contents of an audit trail file
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBpraudit\fR [\fB-lrsx\fR] [\fB-d\fR\fIdel\fR] [\fIfilename\fR]...
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 \fBpraudit\fR reads the listed \fIfilename\fRs (or standard input, if no
19 \fIfilename\fR is specified) and interprets the data as audit trail records as
20 defined in \fBaudit.log\fR(4). By default, times, user and group \fBIDs\fR
21 (UIDs and \fBGIDs,\fR respectively) are converted to their \fBASCII\fR
22 representation. Record type and event fields are converted to their \fBASCII\fR
23 representation. A maximum of 100 audit files can be specified on the command
24 line.
25 .SH OPTIONS
26 .sp
27 .LP
28 The following options are supported:
29 .sp
30 .ne 2
31 .na
32 \fB\fB-d\fR\fIdel\fR\fR
33 .ad
34 .sp .6
35 .RS 4n
36 Use \fIdel\fR as the field delimiter instead of the default delimiter, which is
37 the comma. If \fIdel\fR has special meaning for the shell, it must be quoted.
38 The maximum size of a delimiter is three characters. The delimiter is not
39 meaningful and is not used when the \fB-x\fR option is specified.
40 .RE
42 .sp
43 .ne 2
44 .na
45 \fB\fB-l\fR\fR
46 .ad
47 .sp .6
48 .RS 4n
49 Print one line per record.
50 .RE
52 .sp
53 .ne 2
54 .na
55 \fB\fB-r\fR\fR
56 .ad
57 .sp .6
58 .RS 4n
59 Print records in their raw form. Times, \fBUIDs,\fR \fBGIDs,\fR record types,
60 and events are displayed as integers. This option is useful when naming
61 services are offline. The \fB-r\fR option and the \fB-s\fR option are
62 exclusive. If both are used, a format usage error message is output.
63 .RE
65 .sp
66 .ne 2
67 .na
68 \fB\fB-s\fR\fR
69 .ad
70 .sp .6
71 .RS 4n
72 Display records in their short form. Numeric fields' ASCII equivalents are
73 looked up by means of the sources specified in the \fB/etc/nsswitch.conf\fR
74 file (see \fBnsswitch.conf\fR(4)). All numeric fields are converted to ASCII
75 and then displayed. The short \fBASCII\fR representations for the record type
76 and event fields are used. This option and the \fB-r\fR option are exclusive.
77 If both are used, a format usage error message is output.
78 .RE
80 .sp
81 .ne 2
82 .na
83 \fB\fB-x\fR\fR
84 .ad
85 .sp .6
86 .RS 4n
87 Print records in XML form. Tags are included in the output to identify tokens
88 and fields within tokens. Output begins with a valid XML prolog, which includes
89 identification of the DTD which can be used to parse the XML.
90 .RE
92 .SH FILES
93 .sp
94 .ne 2
95 .na
96 \fB\fB/etc/security/audit_event\fR\fR
97 .ad
98 .sp .6
99 .RS 4n
100 Audit event definition and class mappings.
104 .ne 2
106 \fB\fB/etc/security/audit_class\fR\fR
108 .sp .6
109 .RS 4n
110 Audit class definitions.
114 .ne 2
116 \fB\fB/usr/share/lib/xml/dtd\fR\fR
118 .sp .6
119 .RS 4n
120 Directory containing the verisioned DTD file referenced in XML output, for
121 example, \fBadt_record.dtd.1\fR.
125 .ne 2
127 \fB\fB/usr/share/lib/xml/style\fR\fR
129 .sp .6
130 .RS 4n
131 Directory containing the versioned XSL file referenced in XML output, for
132 example, \fBadt_record.xsl.1\fR.
135 .SH ATTRIBUTES
138 See \fBattributes\fR(5) for descriptions of the following attributes:
143 box;
144 c | c
145 l | l .
146 ATTRIBUTE TYPE  ATTRIBUTE VALUE
148 Interface Stability     See below
153 The command stability is evolving. The output format is unstable.
154 .SH SEE ALSO
157 \fBbsmconv\fR(1M), \fBgetent\fR(1M), \fBaudit\fR(2), \fBgetauditflags\fR(3BSM),
158 \fBgetpwuid\fR(3C), \fBgethostbyaddr\fR(3NSL), \fBethers\fR(3SOCKET),
159 \fBgetipnodebyaddr\fR(3SOCKET), \fBaudit.log\fR(4), \fBaudit_class\fR(4),
160 \fBaudit_event\fR(4), \fBgroup\fR(4), \fBnsswitch.conf\fR(4), \fBpasswd\fR(4),
161 \fBattributes\fR(5)
164 See the section on Solaris Auditing in \fISystem Administration Guide: Security
165 Services\fR.
166 .SH NOTES
169 This functionality is available only if the Solaris Auditing feature has been
170 enabled. See \fBbsmconv\fR(1M) for more information.