Skip to content

Commit 10bfaaa

Browse files
committed
docs: refresh ausearch and aureport man pages
1 parent 2f1ac7a commit 10bfaaa

2 files changed

Lines changed: 14 additions & 5 deletions

File tree

docs/aureport.8

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH AUREPORT "8" "February 2023" "Red Hat" "System Administration Utilities"
1+
.TH AUREPORT "8" "March 2026" "Red Hat" "System Administration Utilities"
22
.SH NAME
33
aureport \- a tool that produces summary reports of audit daemon logs
44
.SH SYNOPSIS
@@ -27,12 +27,20 @@ Report about crypto events
2727
.BR \-\-debug
2828
Write malformed events that are skipped to stderr.
2929
.TP
30+
.BR \-\-delete
31+
When used with configuration, integrity, or MAC reports, only include
32+
delete or remove operations.
33+
.TP
3034
.BR \-\-eoe\-timeout \ \fIseconds\fP
3135
Set the end of event parsing timeout. See \fBend_of_event_timeout\fP in \fIauditd.conf(5)\fP for details. Note that setting this value will override any configured value found in /etc/auditd/auditd.conf.
3236
.TP
3337
.BR \-e ,\ \-\-event
3438
Report about events
3539
.TP
40+
.BR \-\-add
41+
When used with configuration, integrity, or MAC reports, only include
42+
add or create operations.
43+
.TP
3644
.BR \-\-escape \ \fIoption\fP
3745
This option determines if the output is escaped to make the content safer for certain uses. The options are \fIraw\fP , \fItty\fP , \fIshell\fP , and \fIshell_quote\fP. Each mode includes the characters of the preceding mode and escapes more characters. That is to say \fIshell\fP includes all characters escaped by \fItty\fP and adds more. \fItty\fP is the default.
3846
.TP

docs/ausearch.8

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
.TH AUSEARCH "8" "July 2023" "Red Hat" "System Administration Utilities"
1+
.TH AUSEARCH "8" "March 2026" "Red Hat" "System Administration Utilities"
22
.SH NAME
33
ausearch \- a tool to query audit daemon logs
44
.SH SYNOPSIS
55
.B ausearch
66
.RI [ options ]
77
.SH DESCRIPTION
8-
\fBausearch\fP is a tool that can query the audit daemon logs based for events based on different search criteria. The ausearch utility can also take input from stdin as long as the input is the raw log data. Each commandline option given forms an "and" statement. For example, searching with \fB\-m\fP and \fB\-ui\fP means return events that have both the requested type and match the user id given. An exception is the \fB\-m\fP and \fB\-n\fP options; multiple record types and nodes are allowed in a search which will return any matching node and record.
8+
\fBausearch\fP is a tool that can query the audit daemon logs for events based on different search criteria. The ausearch utility can also take input from stdin as long as the input is the raw log data. Each commandline option given forms an "and" statement. For example, searching with \fB\-m\fP and \fB\-ui\fP means return events that have both the requested type and match the user id given. An exception is the \fB\-m\fP and \fB\-n\fP options; multiple record types and nodes are allowed in a search which will return any matching node and record.
99

1010
It should also be noted that each syscall excursion from user space into the kernel and back into user space has one event ID that is unique. Any auditable event that is triggered during this trip share this ID so that they may be correlated.
1111

@@ -112,7 +112,7 @@ Flush output on every line. Most useful when stdout is connected to a pipe and t
112112
.BR \-m ,\ \-\-message \ \fImessage-type\fP\ |\ \fIcomma-sep-message-type-list\fP
113113
Search for an event matching the given \fImessage type\fP. (Message types are also known as record types.) You may also enter a \fIcomma separated list of message types\fP or multiple individual message types each with its own \fI-m\fP option. There is an \fBALL\fP message type that doesn't exist in the actual logs. It allows you to get all messages in the system. The list of valid messages types is long. The program will display the list whenever no message type is passed with this parameter. The message type can be either text or numeric. If you enter a list, there can be only commas and no spaces separating the list.
114114
.TP
115-
.BR \-n ,\ \-\-node
115+
.BR \-n ,\ \-\-node \ \fInode-name\fP
116116
Search for events originating from a specific machine. Multiple nodes are allowed, and if any nodes match, the event is matched. This search uses the node field in audit events. Also see the \-\-host command which search for events related to host information in the audit trail.
117117
.TP
118118
.BR \-o ,\ \-\-object \ \fISE-Linux-context-string\fP
@@ -174,7 +174,8 @@ You may also use the word: \fBnow\fP, \fBrecent\fP, \fBthis-hour\fP, \fBboot\fP,
174174
.na
175175
ausearch --checkpoint /etc/audit/auditd_checkpoint.txt -i
176176
_au_status=$?
177-
if test ${_au_status} eq 10 -o ${_au_status} eq 11 -o ${_au_status} eq 12
177+
if test ${_au_status} -eq 10 -o ${_au_status} -eq 11 \
178+
-o ${_au_status} -eq 12
178179
then
179180
ausearch --checkpoint /etc/audit/auditd_checkpoint.txt --start checkpoint -i
180181
fi

0 commit comments

Comments
 (0)