Add man-page for audit_syscall_to_name() (linux-audit#225)

juspence · Nov 4, 2021 · f3cbdb3 · f3cbdb3
1 parent bece15d
commit f3cbdb3
Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/docs/Makefile.am b/docs/Makefile.am
@@ -40,6 +40,7 @@ audit_set_backlog_limit.3 audit_set_enabled.3 audit_set_failure.3 \
 audit_setloginuid.3 audit_set_pid.3 audit_set_rate_limit.3 \
 audit_update_watch_perms.3 audit_value_needs_encoding.3 \
 audit_encode_value.3 auparse_add_callback.3 audit_name_to_syscall.3 \
+audit_syscall_to_name.3 \
 auparse_destroy.3 auparse_feed.3 auparse_feed_age_events.3 \
 auparse_feed_has_data.3 auparse_find_field.3 \
 auparse_find_field_next.3 auparse_first_field.3 auparse_first_record.3 \

diff --git a/docs/audit_syscall_to_name.3 b/docs/audit_syscall_to_name.3
@@ -0,0 +1,31 @@
+.TH "AUDIT_SYSCALL_TO_NAME" "3" "Nov 2021" "Red Hat" "Linux Audit API"
+.SH NAME
+audit_syscall_to_name \- Convert the numeric syscall value to the syscall name
+.SH "SYNOPSIS"
+.nf
+.B #include <libaudit.h>
+.PP
+.BI "const char *audit_syscall_to_name(int " sc ", int " machine );
+.fi
+.SH "DESCRIPTION"
+.BR audit_syscall_to_name ()
+converts the numeric syscall value to the syscall name.
+.I sc
+is the numeric syscall value.
+.I machine
+is the enum value of the machine type defined in machine_t.
+.I machine
+can be obtained by calling
+.BR audit_detect_machine (3).
+
+.SH "RETURN VALUE"
+
+Returns NULL if an error occurs; otherwise, the return value is the syscall name.
+
+.SH "SEE ALSO"
+
+.BR audit_name_to_syscall (3),
+.BR audit_detect_machine (3).
+
+.SH AUTHOR
+Steve Grubb