.\" Generated by scdoc 1.11.0
.\" 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 "swaynag" "1" "2020-11-05"
.P
.SH NAME
.P
swaynag - Show a warning or error message with buttons
.P
.SH SYNOPSIS
.P
\fIswaynag\fR [options...]
.P
.SH OPTIONS
.P
\fB-b, --button\fR <text> <action>
.RS 4
Create a button with the text \fItext\fR that executes \fIaction\fR when pressed.
If the environment variable \fITERMINAL\fR is set, \fIaction\fR will be run inside
the terminal. Otherwise, it will fallback to running directly. Multiple
buttons can be defined by providing the flag multiple times.
.P
.RE
\fB-B, --button-no-terminal\fR <text> <action>
.RS 4
Create a button with the text \fItext\fR that executes \fIaction\fR when pressed.
\fIaction\fR will be run directly instead of in a terminal. Multiple buttons
can be defined by providing the flag multiple times.
.P
.RE
\fB-z, --button-dismiss\fR <text> <action>
.RS 4
Create a button with the text \fItext\fR that executes \fIaction\fR when pressed,
and dismisses swaynag. If the environment variable \fITERMINAL\fR is set,
\fIaction\fR will be run inside the terminal. Otherwise, it will fallback to
running directly. Multiple buttons can be defined by providing the flag
multiple times.
.P
.RE
\fB-Z, --button-dismiss-no-terminal\fR <text> <action>
.RS 4
Create a button with the text \fItext\fR that executes \fIaction\fR when pressed,
and dismisses swaynag. \fIaction\fR will be run directly instead of in a
terminal. Multiple buttons can be defined by providing the flag multiple
times.
.P
.RE
\fB-c, --config\fR <path>
.RS 4
The config file to use. By default, the following paths are checked:
\fI$HOME/.swaynag/config\fR, \fI$XDG_CONFIG_HOME/swaynag/config\fR, and
\fISYSCONFDIR/swaynag/config\fR. All flags aside from this one and \fIdebug\fR are
valid options in the configuration file using the format
\fIlong-option=value\fR. All leading dashes should be omitted and the equals
sign is required. See swaynag(5) for more information.
.P
.RE
\fB-d, --debug\fR
.RS 4
Enable debugging.
.P
.RE
\fB-e, --edge\fR top|bottom
.RS 4
Set the edge to use.
.P
.RE
\fB-f, --font\fR <font>
.RS 4
Set the font to use.
.P
.RE
\fB-h, --help\fR
.RS 4
Show help message and quit.
.P
.RE
\fB-l, --detailed-message\fR
.RS 4
Read a detailed message from stdin. A button to toggle details will be
added. Details are shown in a scrollable multi-line text area.
.P
.RE
\fB-L, --detailed-button\fR <text>
.RS 4
Set the text for the button that toggles details. This has no effect if
there is not a detailed message. The default is \fIToggle details\fR.
.P
.RE
\fB-m, --message\fR <msg>
.RS 4
Set the message text.
.P
.RE
\fB-o, --output\fR <output>
.RS 4
Set the output to use. This should be the name of a \fIxdg_output\fR.
.P
.RE
\fB-s, --dismiss-button\fR <text>
.RS 4
Sets the text for the dismiss nagbar button. The default is \fIX\fR.
.P
.RE
\fB-t, --type\fR <type>
.RS 4
Set the message type. Two types are created by default \fIerror\fR and
\fIwarning\fR. Custom types can be defined in the config file. See
\fI--config\fR and swaynag(5) for details. Both of the default types can be
overridden in the config file as well.
.P
.RE
\fB-v, --version\fR
.RS 4
Show the version number and quit.
.P
.RE
.SH APPEARANCE OPTIONS
.P
\fB--background\fR <RRGGBB[AA]>
.RS 4
Set the color of the background.
.P
.RE
\fB--border\fR <RRGGBB[AA]>
.RS 4
Set the color of the border.
.P
.RE
\fB--border-bottom\fR <RRGGBB[AA]>
.RS 4
Set the color of the bottom border.
.P
.RE
\fB--button-background\fR <RRGGBB[AA]>
.RS 4
Set the color for the background for buttons.
.P
.RE
\fB--text\fR <RRGGBB[AA]>
.RS 4
Set the text color.
.P
.RE
\fB--border-bottom-size\fR <size>
.RS 4
Set the thickness of the bottom border.
.P
.RE
\fB--message-padding\fR <padding>
.RS 4
Set the padding for the message.
.P
.RE
\fB--details-border-size\fR <size>
.RS 4
Set the thickness for the details border.
.P
.RE
\fB--button-border-size\fR <size>
.RS 4
Set the thickness for the button border.
.P
.RE
\fB--button-gap\fR <gap>
.RS 4
Set the size of the gap between buttons.
.P
.RE
\fB--button-dismiss-gap\fR <gap>
.RS 4
Set the size of the gap between the dismiss button and another button.
.P
.RE
\fB--button-margin-right\fR <margin>
.RS 4
Set the margin from the right of the dismiss button to edge.
.P
.RE
\fB--button-padding\fR <padding>
.RS 4
Set the padding for the button text.
.P
.RE
.SH SEE
.P
swaynag(5)