Skip to content

Commit b9c4482

Browse files
committed
Align man pages to glibc style pt2
1 parent b13faa3 commit b9c4482

File tree

66 files changed

+142
-244
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+142
-244
lines changed

docs/audit_log_acct_message.3

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,33 @@ audit_log_acct_message \- log a user account message
44
.SH SYNOPSIS
55
.B #include <libaudit.h>
66
.sp
7-
int audit_log_acct_message(int audit_fd, int type, const char *pgname,
8-
const char *op, const char *name, unsigned int id, const char *host,
9-
const char *addr, const char *tty, int result)
7+
.BI "int audit_log_acct_message(int" audit_fd, int" type, const char *" pgname, const char *" op, const char *" name, unsigned int" id, const char *" host, const char *" addr, const char *" tty, int" result);"
108

119
.SH DESCRIPTION
1210
This function will log a message to the audit system using a predefined message format. It should be used for all account manipulation operations. The function
1311
parameters are as follows:
1412

1513
.RS
1614
.TP
17-
audit_fd - The fd returned by audit_open
15+
\fIaudit_fd\fP - The fd returned by audit_open
1816
.TP
19-
type - type of message: AUDIT_USER_CHAUTHTOK for changing any account attributes.
17+
\fItype\fP - type of message: AUDIT_USER_CHAUTHTOK for changing any account attributes.
2018
.TP
21-
pgname - program's name, if NULL will attempt to figure out
19+
\fIpgname\fP - program's name, if NULL will attempt to figure out
2220
.TP
2321
op - operation. Ex: "adding-user", "changing-finger-info", "deleting-group". This value should have a dash or underscore between the words so that report parsers group them together.
2422
.TP
25-
name - user's account or group name. If not available use NULL.
23+
\fIname\fP - user's account or group name. If not available use NULL.
2624
.TP
2725
id - uid or gid that the operation is being performed on. If the user is unknown, pass a \-1 and fill in the name parameter. This is used only when user is NULL.
2826
.TP
29-
host - The hostname if known. If not available pass a NULL.
27+
\fIhost\fP - The hostname if known. If not available pass a NULL.
3028
.TP
31-
addr - The network address of the user. If not available pass a NULL.
29+
\fIaddr\fP - The network address of the user. If not available pass a NULL.
3230
.TP
3331
tty - The tty of the user, if NULL will attempt to figure out
3432
.TP
35-
result - 1 is "success" and 0 is "failed"
33+
\fIresult\fP - 1 is "success" and 0 is "failed"
3634
.RE
3735

3836
.SH "RETURN VALUE"

docs/audit_log_semanage_message.3

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,7 @@ audit_log_semanage_message \- log a semanage message
44
.SH SYNOPSIS
55
.B #include <libaudit.h>
66
.sp
7-
.B int audit_log_semanage_message(int audit_fd, int type,
8-
.B const char *pgname, const char *op, const char *name, unsigned int id,
9-
.B const char *new_seuser, const char *new_role, const char *new_range,
10-
.B const char *old_seuser, const char *old_role, const char *old_range,
11-
.B const char *host, const char *addr, const char *tty, int result)
7+
.BI "int audit_log_semanage_message(int" audit_fd, int" type, .B const char *" pgname, const char *" op, const char *" name, unsigned int" id, .B const char *" new_seuser, const char *" new_role, const char *" new_range, .B const char *" old_seuser, const char *" old_role, const char *" old_range, .B const char *" host, const char *" addr, const char *" tty, int" result);"
128

139
.SH DESCRIPTION
1410

@@ -17,22 +13,22 @@ message format. It should be used for all SE Linux user and role
1713
manipulation operations. The function parameters are as follows:
1814

1915
.nf
20-
audit_fd - The fd returned by audit_open
21-
type - type of message: AUDIT_ROLE_ASSIGN/REMOVE for changing any SE Linux user or role attributes.
22-
pgname - program's name
16+
\fIaudit_fd\fP - The fd returned by audit_open
17+
\fItype\fP - type of message: AUDIT_ROLE_ASSIGN/REMOVE for changing any SE Linux user or role attributes.
18+
\fIpgname\fP - program's name
2319
op - operation. "adding-user", "adding-role", "deleting-user", "deleting-role"
24-
name - user's account. If not available use NULL.
20+
\fIname\fP - user's account. If not available use NULL.
2521
id - uid that the operation is being performed on. This is used only when name is NULL.
26-
new_seuser - the new seuser that the login user is getting
27-
new_role - the new_role that the login user is getting
28-
new_range - the new mls range that the login user is getting
29-
old_seuser - the old seuser that the login usr had
30-
old_role - the old role that the login user had
31-
old_range - the old mls range that the login usr had
32-
host - The hostname if known
33-
addr - The network address of the user
22+
\fInew_seuser\fP - the new seuser that the login user is getting
23+
\fInew_role\fP - the new_role that the login user is getting
24+
\fInew_range\fP - the new mls range that the login user is getting
25+
\fIold_seuser\fP - the old seuser that the login usr had
26+
\fIold_role\fP - the old role that the login user had
27+
\fIold_range\fP - the old mls range that the login usr had
28+
\fIhost\fP - The hostname if known
29+
\fIaddr\fP - The network address of the user
3430
tty - The tty of the user
35-
result - 1 is "success" and 0 is "failed"
31+
\fIresult\fP - 1 is "success" and 0 is "failed"
3632
.fi
3733

3834
.SH "RETURN VALUE"

docs/audit_log_user_avc_message.3

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,20 @@ audit_log_user_avc_message \- log a user avc message
44
.SH SYNOPSIS
55
.B #include <libaudit.h>
66
.sp
7-
.B int audit_log_user_avc_message(int audit_fd, int type, const char *message,
8-
const char *hostname, const char *addr, const char *tty, uid_t auid)
7+
.BI "int audit_log_user_avc_message(int" audit_fd, int" type, const char *" message, const char *" hostname, const char *" addr, const char *" tty, uid_t" auid);"
98

109
.SH DESCRIPTION
1110

1211
This function will log a message to the audit system using a predefined message format. This function should be used by all apps that are SE Linux object managers. The function parameters are as follows:
1312

1413
.nf
15-
audit_fd - The fd returned by audit_open
16-
type - type of message, ex: AUDIT_USER_AVC
17-
message - the message being sent
18-
hostname - the hostname if known
19-
addr - The network address of the user
20-
tty - The tty of the user, if NULL will attempt to figure out
21-
auid - The auid of the person related to the avc message
14+
\fIaudit_fd\fP - The fd returned by audit_open
15+
\fItype\fP - type of message, ex: AUDIT_USER_AVC
16+
\fImessage\fP - the message being sent
17+
\fIhostname\fP - the hostname if known
18+
\fIaddr\fP - The network address of the user
19+
\fItty\fP - The tty of the user, if NULL will attempt to figure out
20+
\fIauid\fP - The auid of the person related to the avc message
2221
.fi
2322

2423
These values should correspond to who the message is about.

docs/audit_log_user_comm_message.3

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,20 @@ audit_log_user_comm_message \- log a user message from a console app
44
.SH SYNOPSIS
55
.B #include <libaudit.h>
66
.sp
7-
int audit_log_user_comm_message(int audit_fd, int type, const char *message,
8-
const char *comm, const char *hostname, const char *addr, const char *tty,
9-
int result)
7+
.BI "int audit_log_user_comm_message(int" audit_fd, int" type, const char *" message, const char *" comm, const char *" hostname, const char *" addr, const char *" tty, int" result);"
108

119
.SH DESCRIPTION
1210
This function will log a message to the audit system using a predefined message format. This function should be used by all non-ELF console apps that do not manipulate accounts, groups, or need to log execution of a script. An example would be a Python script recording an event. The function parameters are as follows:
1311

1412
.nf
15-
audit_fd - The fd returned by audit_open
16-
type - type of message, ex: AUDIT_USYS_CONFIG, AUDIT_USER_LOGIN
17-
message - the message text being sent
18-
comm - the program command line name, NULL if unknown
19-
hostname - the hostname if known, NULL if unknown
20-
addr - The network address of the user, NULL if unknown
21-
tty - The tty of the user, if NULL will attempt to figure out
22-
result - 1 is "success" and 0 is "failed"
13+
\fIaudit_fd\fP - The fd returned by audit_open
14+
\fItype\fP - type of message, ex: AUDIT_USYS_CONFIG, AUDIT_USER_LOGIN
15+
\fImessage\fP - the message text being sent
16+
\fIcomm\fP - the program command line name, NULL if unknown
17+
\fIhostname\fP - the hostname if known, NULL if unknown
18+
\fIaddr\fP - The network address of the user, NULL if unknown
19+
\fItty\fP - The tty of the user, if NULL will attempt to figure out
20+
\fIresult\fP - 1 is "success" and 0 is "failed"
2321
.fi
2422

2523
.SH "RETURN VALUE"

docs/audit_log_user_command.3

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ audit_log_user_command \- log a user command
44
.SH SYNOPSIS
55
.B #include <libaudit.h>
66
.sp
7-
.B int audit_log_user_command(int audit_fd, int type, const char *command, const char *tty, int result);
7+
.BI "int audit_log_user_command(int" audit_fd, int" type, const char *" command, const char *" tty, int" result);"
88

99
.SH DESCRIPTION
1010
This function will log a command to the audit system using a predefined message format. It encodes the command as the audit system expects for untrusted strings. This function should be used by all apps need to record commands. The function parameters are as follows:
1111

1212
.nf
13-
audit_fd - The fd returned by audit_open
14-
type - type of message, ex: AUDIT_USYS_CONFIG, AUDIT_USER_LOGIN
15-
command - the command being logged
16-
tty - The tty of the user, if NULL will attempt to figure out
17-
result - 1 is "success" and 0 is "failed"
13+
\fIaudit_fd\fP - The fd returned by audit_open
14+
\fItype\fP - type of message, ex: AUDIT_USYS_CONFIG, AUDIT_USER_LOGIN
15+
\fIcommand\fP - the command being logged
16+
\fItty\fP - The tty of the user, if NULL will attempt to figure out
17+
\fIresult\fP - 1 is "success" and 0 is "failed"
1818
.fi
1919

2020
.SH "RETURN VALUE"

docs/audit_request_rules_list_data.3

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ audit_request_rules_list_data \- Request list of current audit rules
44
.SH "SYNOPSIS"
55
.B #include <libaudit.h>
66
.sp
7-
int audit_request_rules_list_data(int fd);
7+
.BI "int audit_request_rules_list_data(int" fd);"
88

99
.SH "DESCRIPTION"
1010

docs/audit_request_signal_info.3

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ audit_request_signal_info \- Request signal info for the audit system
44
.SH "SYNOPSIS"
55
.B #include <libaudit.h>
66
.sp
7-
int audit_request_signal_info(int fd);
7+
.BI "int audit_request_signal_info(int" fd);"
88

99
.SH "DESCRIPTION"
1010

docs/audit_set_enabled.3

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ audit_set_enabled \- Enable or disable auditing
55

66
.B #include <libaudit.h>
77
.sp
8-
int audit_set_enabled(int fd, uint32_t enabled);
8+
.BI "int audit_set_enabled(int" fd, uint32_t" enabled);"
99

1010
.SH "DESCRIPTION"
1111

docs/audit_set_failure.3

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ audit_set_failure \- Set audit failure flag
55

66
.B #include <libaudit.h>
77
.sp
8-
int audit_set_failure(int fd, uint32_t failure);
8+
.BI "int audit_set_failure(int" fd, uint32_t" failure);"
99

1010
.SH "DESCRIPTION"
1111

docs/audit_setloginuid.3

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ audit_setloginuid \- Set a program's loginuid value
44
.SH SYNOPSIS
55
.B #include <libaudit.h>
66
.sp
7-
int audit_setloginuid(uid_t uid);
7+
.BI "int audit_setloginuid(uid_t" uid);"
88

99
.SH "DESCRIPTION"
1010

0 commit comments

Comments
 (0)