.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "fyi" "1" "2024-09-05"
.PP
.SH NAME
fyi - send desktop notifications
.PP
.SH SYNOPSIS
\fBfyi\fR [\fIOPTION\fR].\&.\&.\& \fITITLE\fR [\fIMESSAGE\fR]
.br
\fBfyi --close\fR=\fIID\fR
.br
\fBfyi --server-info\fR
.br
\fBfyi --server-capabilities\fR
.PP
.SH DESCRIPTION
.PP
\fBfyi\fR is a command line utility to send desktop notifications to the
user via a notification daemon implementing XDG desktop notifications.\&
.PP
It is similar to the well-known \fBnotify-send\fR(1) utility.\& Indeed, most
of the options are identical.\&
.PP
When used without any options, \fBfyi\fR sends the notification and
immediately exits, without printing anything on stdout.\&
.PP
Use \fB--print-id\fR to have \fBfyi\fR print the daemon assigned notification
ID on stdout, in the format:
.PP
.RS 4
\fBid=\fR\fIID\fR
.PP
.RE
To see why the notification was closed, use \fB--print-reason\fR.\& The
reason is printed on stdout, in the format:
.PP
.RS 4
\fBreason=\fR\fIREASON\fR
.PP
.RE
\fBfyi\fR can also block until the notification has been closed, using the
\fB--wait\fR option.\& Sending SIGINT to the \fBfyi\fR process will force-close
the notification.\&
.PP
\fBfyi\fR will also block if the notification has any actions.\& When an
action is triggered, \fBfyi\fR prints the name of the action on stdout, in
the format:
.PP
.RS 4
\fBaction=\fR\fINAME\fR
.PP
.RE
Some notification daemons can send an "activation token".\& This is
typically done when the user clicks the notification, or triggers the
default action.\& The token can be used to focus (activate) a window.\& To
see the token, use \fB--print-token\fR.\& The token is printed on stdout, in
the format:
.PP
.RS 4
\fBxdgtoken=\fR\fITOKEN\fR
.PP
.RE
.SH OPTIONS
.PP
\fB-a\fR,\fB--app-name\fR=\fINAME\fR
.RS 4
Application name.\& Notification daemons will either display it as
text, or use it to select an icon to show (unless \fB--icon\fR is
used).\& Default: \fIfyi\fR
.PP
.RE
\fB-i\fR,\fB--icon\fR=\fIICON\fR
.RS 4
Icon to display, either as a symbolic icon name (e.\&g.\& \fIfirefox\fR)
or a filename.\& Default: \fInone\fR
.PP
.RE
\fB-u\fR,\fB--urgency\fR=\fBlow|normal|critical\fR
.RS 4
Notification urgency.\& Shortcut for
\fB--hint=byte:urgency:0|1|2\fR.\& Default: \fInormal\fR.\&
.PP
.RE
\fB-c\fR,\fB--category\fR=\fICATEGORY\fR
.RS 4
Notification category.\& Shortcut for
\fB--hint=string:category:CATEGORY\fR.\& Default: \fInone\fR.\&
.PP
.RE
\fB-A\fR,\fB--action\fR=\fINAME\fR:\fILABEL\fR
.RS 4
Defines an action to display (e.\&g.\& as a button, or in a list,
depending on notification daemon).\& \fILABEL\fR is what the
notification daemon will display for the user.\& When the user
triggers an action, \fBfyi\fR will print the corresponding \fINAME\fR, in
the format:
.PP
.RS 4
\fBaction=\fR\fINAME\fR
.PP
.RE
This option can be specified multiple times, to define multiple
actions.\&
.PP
Using this option implies \fB--wait\fR.\&
.PP
.RE
\fB-H\fR,\fB--hint\fR=\fITYPE\fR:\fINAME\fR:\fIVALUE\fR
.RS 4
Defines a custom hint.\& How these are interpreted depends on the
notification daemon.\& One common use case is to display a progress
bar of some kind; most notification daemon recognizes
\fBint:value:<percent>\fR.\&
.PP
Another common hint is
\fBstring:x-canonical-private-synchronous:<name>\fR.\& Many notification
daemons will replace any existing notification with the same
\fIname\fR.\& This is similar to \fB--replaces\fR, except you do not need a
notification ID.\&
.PP
\fBfyi\fR recognizes the following types:
.PP
.PD 0
.IP \(bu 4
boolean
.IP \(bu 4
byte
.IP \(bu 4
int
.IP \(bu 4
double
.IP \(bu 4
string
.PD
.PP
.RE
\fB-r\fR,\fB--replaces\fR=\fIID\fR
.RS 4
If there is an existing notification with the specified ID,
replace it.\& Otherwise, create a new notification.\&
.PP
.RE
\fB-t\fR,\fB--expire-time\fR=\fITIME\fR
.RS 4
The notification will be closed automatically after \fITIME\fR
milliseconds.\&
.PP
.RE
\fB--transient\fR
.RS 4
By-pass the server'\&s persistence capability, if any.\& Shortcut for
\fB--hint=boolean:transient=true\fR.\&
.PP
.RE
\fB-C\fR,\fB--close\fR=\fIID\fR
.RS 4
If there is an existing notification with the specified ID, close
it.\&
.PP
.RE
\fB-p\fR,\fB--print-id\fR
.RS 4
Print the daemon assigned notification ID, in the format
\fBid=\fR\fIID\fR.\&
.PP
.RE
\fB-R\fR,\fB--print-reason\fR
.RS 4
Print the reason the notification was closed, in the format:
.PP
.PD 0
.IP \(bu 4
\fBreason=expired\fR
.IP \(bu 4
\fBreason=dismissed\fR
.IP \(bu 4
\fBreason=force-closed\fR
.IP \(bu 4
\fBreason=unknown\fR
.PD
.PP
Using this option implies \fB--wait\fR.\&
.PP
.RE
\fB-T\fR,\fB--print-token\fR
.RS 4
Print the activation token, if any, in the format:
.PP
.RS 4
\fBxdgtoken=\fR\fITOKEN\fR
.PP
.RE
Some notification daemons send an activation token when the
notification is dismissed; either when the notification is
clicked, or the default action is invoked.\& Others will send it
regardless of which action was invoked.\& Some will only send it
when an action is invoked, while others will send it when the
notification is dismissed, regardless of how.\&
.PP
The token can be used to focus (activate, raise) a window.\& It is
not directly useable by \fBfyi\fR, but programs using \fBfyi\fR as a
helper to display notifications can use it.\&
.PP
Using this option implies \fB--wait\fR.\&
.PP
.RE
\fB-w\fR,\fB--wait\fR
.RS 4
Wait for the notification to be closed before exiting.\& If the user
triggered an action, the name of the action will be printed (see
\fB-A\fR,\fB--action\fR).\&
.PP
This option is implied when the any of the following options are
used:
.PP
.PD 0
.IP \(bu 4
\fB-A\fR,\fB--action\fR
.IP \(bu 4
\fB-R\fR,\fB--print-reason\fR
.IP \(bu 4
\fB-T\fR,\fB--print-token\fR
.PD
.PP
.RE
\fB--image-data\fR=\fIFILE\fR
.RS 4
Sets the \fBimage-data\fR hint in the notification, with the raw pixel
data from \fIFILE\fR.\& The data is assumed to be raw RGBA data.\& You
must also provide the image size, see \fB--image-size\fR.\&
.PP
.RE
\fB--image-size=WIDTHxHEIGHT\fR
.RS 4
The dimensions of the image loaded by \fB--image-data\fR.\&
.PP
.RE
\fB--server-info\fR
.RS 4
Display notification daemon name and version.\&
.PP
.RE
\fB--server-capabilities\fR
.RS 4
Display notification daemon capabilities.\&
.PP
.RE
\fB-v\fR,\fB--version\fR
.RS 4
Show the version number and quit.\&
.PP
.RE
.SH SEE ALSO
.PP
.PD 0
.IP \(bu 4
\fBnotify-send\fR(1)
.IP \(bu 4
\fBgdbus\fR(1)