Imported Upstream version 2.4.3
[platform/upstream/audit.git] / docs / ausearch_add_timestamp_item.3
1 .TH "AUSEARCH_ADD_TIMESTAMP_ITEM" "3" "Aug 2014" "Red Hat" "Linux Audit API"
2 .SH NAME
3 ausearch_add_timestamp_item \- build up search rule
4 .SH "SYNOPSIS"
5 .B #include <auparse.h>
6 .sp
7 int ausearch_add_timestamp_item(auparse_state_t *au, const char *op, time_t sec, unsigned milli, ausearch_rule_t how)
8
9 .SH "DESCRIPTION"
10
11 ausearch_add_timestamp_item adds an event time condition to the current audit search expression. The search conditions can then be used to scan logs, files, or buffers for something of interest. The op parameter specifies the desired comparison. Legal op values are \fI<\fR, \fI<=\fR, \fI>=\fR, \fI>\fR and \fI=\fR.  The left operand of the comparison operator is the timestamp of the examined event, the right operand is specified by the sec and milli parameters.
12
13 The how value determines how this search condition will affect the existing search expression if one is already defined. The possible values are:
14 .RS
15 .TP
16 .I AUSEARCH_RULE_CLEAR
17 Clear the current search expression, if any, and use only this search condition.
18 .TP
19 .I AUSEARCH_RULE_OR
20 If a search expression
21 .I E
22 is already configured, replace it by \fB(\fIE\fB || \fIthis_search_condition\fB)\fR.
23 .TP
24 .I AUSEARCH_RULE_AND
25 If a search expression
26 .I E
27 is already configured, replace it by \fB(\fIE\fB && \fIthis_search_condition\fB)\fR.
28 .RE
29
30 .SH "RETURN VALUE"
31
32 Returns \-1 if an error occurs; otherwise, 0 for success.
33
34 .SH APPLICATION USAGE
35
36 Use
37 .BR ausearch_add_item (3)
38 and
39 .BR ausearch_add_interpreted_item (3)
40 to add conditions that check audit record fields.
41 Use
42 .BR ausearch_add_expression (3)
43 to add complex search expressions using a single function call.
44
45 .SH "SEE ALSO"
46
47 .BR ausearch_add_expression (3),
48 .BR ausearch_add_item (3),
49 .BR ausearch_add_interpreted_item (3),
50 .BR ausearch_add_regex (3),
51 .BR ausearch_set_stop (3),
52 .BR ausearch_clear (3),
53 .BR ausearch_next_event (3),
54 .BR ausearch\-expression (5).
55
56 .SH AUTHOR
57 Miloslav Trmac