.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "AA-NOTIFY 8"
.TH AA-NOTIFY 8 2024-03-25 "AppArmor 3.0.13" AppArmor
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
aa\-notify \- display information about logged AppArmor messages.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBaa-notify\fR [option]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBaa-notify\fR will display a summary or provide desktop notifications
for AppArmor DENIED messages.
.SH OPTIONS
.IX Header "OPTIONS"
\&\fBaa-notify\fR accepts the following arguments:
.IP "\-p, \-\-poll" 4
.IX Item "-p, --poll"
poll AppArmor logs and display desktop notifications. Can be used with '\-s'
option to display a summary on startup.
.ie n .IP "\-\-display $DISPLAY" 4
.el .IP "\-\-display \f(CW$DISPLAY\fR" 4
.IX Item "--display $DISPLAY"
set the DISPLAY environment variable to \f(CW$DISPLAY\fR
(might be needed if sudo resets \f(CW$DISPLAY\fR)
.IP "\-f FILE, \-\-file=FILE" 4
.IX Item "-f FILE, --file=FILE"
search FILE for AppArmor messages
.IP "\-l, \-\-since\-last" 4
.IX Item "-l, --since-last"
show summary since last login.
.IP "\-s NUM, \-\-since\-days=NUM" 4
.IX Item "-s NUM, --since-days=NUM"
show summary for last NUM of days.
.IP "\-u USER, \-\-user=USER" 4
.IX Item "-u USER, --user=USER"
user to drop privileges to when running privileged. When used with the \-p
option, this should be set to the user that will receive desktop notifications.
This has no effect when running under sudo.
.IP "\-w NUM, \-\-wait=NUM" 4
.IX Item "-w NUM, --wait=NUM"
wait NUM seconds before displaying notifications (for use with \-p)
.IP "\-v, \-\-verbose" 4
.IX Item "-v, --verbose"
show messages with summaries.
.IP "\-h, \-\-help" 4
.IX Item "-h, --help"
displays a short usage statement.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
System-wide configuration for \fBaa-notify\fR is done via
/etc/apparmor/notify.conf:
.PP
.Vb 2
\&  # set to \*(Aqyes\*(Aq to enable AppArmor DENIED notifications
\&  show_notifications="yes"
\&
\&  # only people in use_group can use aa\-notify
\&  use_group="admin"
\&
\&  # OPTIONAL \- custom notification message body
\&  message_body="This is a custom notification message."
\&
\&  # OPTIONAL \- custom notification message footer
\&  message_footer="For more information visit https://foo.com"
.Ve
.PP
Per-user configuration is done via \f(CW$XDG_CONFIG_HOME\fR/apparmor/notify.conf (or
the deprecated ~/.apparmor/notify.conf if it exists):
.PP
.Vb 2
\&  # set to \*(Aqyes\*(Aq to enable AppArmor DENIED notifications
\&  show_notifications="yes"
.Ve
.SH BUGS
.IX Header "BUGS"
\&\fBaa-notify\fR needs to be able to read the logfiles containing the
AppArmor DENIED messages.
.PP
If you find any additional bugs, please report them to Gitlab at
<https://gitlab.com/apparmor/apparmor/\-/issues>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBapparmor\fR\|(7)