[PATCH 0/3] Several manpages fixes

[PATCH 0/3] Several manpages fixes

[Laurent Bigonville]

From: Laurent Bigonville <bigon@bigon.be>

Hi,

Please find here some patches for the audit manpages.

Cheers,

Laurent Bigonville

[PATCH 1/3] audisp/plugins/prelude/audisp-prelude.conf.5: Fix typo

[Laurent Bigonville]

From: Laurent Bigonville <bigon@bigon.be>

---
 audisp/plugins/prelude/audisp-prelude.conf.5 |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/audisp/plugins/prelude/audisp-prelude.conf.5 b/audisp/plugins/prelude/audisp-prelude.conf.5
index 66a5131..b7228ed 100644
--- a/audisp/plugins/prelude/audisp-prelude.conf.5
+++ b/audisp/plugins/prelude/audisp-prelude.conf.5
@@ -112,5 +112,5 @@ This is an action that determines what response should be taken whenever a user
 .TP
 .I watched_accounts
-This option is a whitespace and comma separated list of accounts to watch. The accounts may be numeric or alphanumeric. If you want to include a range of accounts, separate them with a dash but no spaces. For example, to watch logins from bin to lp, use "bin-lp". Only successful logins logins are recorded.
+This option is a whitespace and comma separated list of accounts to watch. The accounts may be numeric or alphanumeric. If you want to include a range of accounts, separate them with a dash but no spaces. For example, to watch logins from bin to lp, use "bin-lp". Only successful logins are recorded.
 .TP
 .I detect_watched_syscall
-- 
1.7.10.4

[PATCH 2/3] Use "\-" (minus) instead of plain "-" (hyphen) in manpages

[Laurent Bigonville]

From: Laurent Bigonville <bigon@bigon.be>

This makes it possible for people using UTF-8 encoding to easily
copy/paste options from the manpages.

This fix Debian lintian warnings: hyphen-used-as-minus-sign
---
 docs/audit_log_acct_message.3 |    2 +-
 docs/auditctl.8               |    2 +-
 docs/auditd.conf.5            |    2 +-
 tools/auvirt/auvirt.8         |    4 ++--
 4 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/docs/audit_log_acct_message.3 b/docs/audit_log_acct_message.3
index a99d646..87ff160 100644
--- a/docs/audit_log_acct_message.3
+++ b/docs/audit_log_acct_message.3
@@ -19,5 +19,5 @@ pgname - program's name, if NULL will attempt to figure out
 op  -  operation. Ex: "adding user", "changing finger info", "deleting group"
 name - user's account or group name. If not available use NULL.
-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.
+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.
 host - The hostname if known. If not available pass a NULL.
 addr - The network address of the user. If not available pass a NULL.
diff --git a/docs/auditctl.8 b/docs/auditctl.8
index e4404ab..37d5eef 100644
--- a/docs/auditctl.8
+++ b/docs/auditctl.8
@@ -98,5 +98,5 @@ Delete rule from \fIlist\fP with \fIaction\fP. The rule is deleted only if it ex
 .TP
 .B \-D
-Delete all rules and watches. This can take a key option (-k), too.
+Delete all rules and watches. This can take a key option (\-k), too.
 .TP
 \fB\-S\fP [\fISyscall name or number\fP|\fBall\fP]
diff --git a/docs/auditd.conf.5 b/docs/auditd.conf.5
index 9572542..703135e 100644
--- a/docs/auditd.conf.5
+++ b/docs/auditd.conf.5
@@ -90,5 +90,5 @@ means that it takes the hostname and resolves it with dns for a fully qualified
 domain name of that machine.
 .IR Numeric
-is similar to fqd except it resolves the IP address of the machine. In order to use this option, you might want to test that 'hostname -i' or 'domainname -i' returns a numeric address. Also, this option is not recommended if dhcp is used because you could have different addresses over time for the same machine.
+is similar to fqd except it resolves the IP address of the machine. In order to use this option, you might want to test that 'hostname \-i' or 'domainname \-i' returns a numeric address. Also, this option is not recommended if dhcp is used because you could have different addresses over time for the same machine.
 .IR User
 is an admin defined string from the name option. The default value is
diff --git a/tools/auvirt/auvirt.8 b/tools/auvirt/auvirt.8
index 86266f7..96123f4 100644
--- a/tools/auvirt/auvirt.8
+++ b/tools/auvirt/auvirt.8
@@ -16,5 +16,5 @@ that started the guest, the time when the guest was started and the time when
 the guest was stoped.
 
-If the option "--all-events" is given a more detailed output is shown. In this
+If the option "\-\-all\-events" is given a more detailed output is shown. In this
 mode other records are shown for guest's stops, resource
 assignments, host shutdowns and AVC and anomaly events. The first field
@@ -111,5 +111,5 @@ Only show events related to the guest with the given name.
 To see all the records in this month for a guest
 
-\fBauvirt --start this-month --vm GuestVmName --all-events\fP
+\fBauvirt \-\-start this\-month \-\-vm GuestVmName \-\-all\-events\fP
 
 .SH SEE ALSO
-- 
1.7.10.4

[PATCH 3/3] docs/audit_open.3: Document that audit_open() is setting errno on failure

[Laurent Bigonville]

From: Laurent Bigonville <bigon@bigon.be>

Thanks to Jonathan Nieder <jrnieder@gmail.com>

See: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=642501
---
 docs/audit_open.3 |   12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs/audit_open.3 b/docs/audit_open.3
index 0feb782..6ec8eb0 100644
--- a/docs/audit_open.3
+++ b/docs/audit_open.3
@@ -15,4 +15,16 @@ audit_open creates a NETLINK_AUDIT socket for communication with the kernel part
 Returns \-1 if an error occurs; otherwise, the return value is a descriptor referencing the socket.
 
+.SH ERRORS
+
+The
+.BR audit_open ()
+function may fail and set
+.I errno
+for any of the errors specified for the
+.BR socket (2)
+and
+.BR fcntl (2)
+routines.
+
 .SH "SEE ALSO"
 
-- 
1.7.10.4

Re: [PATCH 0/3] Several manpages fixes

[Steve Grubb]

Hello,

On Saturday, February 09, 2013 04:50:32 PM Laurent Bigonville wrote:
> Please find here some patches for the audit manpages.

All are applied. Thanks!

-Steve