133 lines
3.8 KiB
Markdown
133 lines
3.8 KiB
Markdown
swaynag(1)
|
|
|
|
# NAME
|
|
|
|
swaynag - Show a warning or error message with buttons
|
|
|
|
# SYNOPSIS
|
|
|
|
_swaynag_ [options...]
|
|
|
|
# OPTIONS
|
|
|
|
*-b, --button* <text> <action>
|
|
Create a button with the text _text_ that executes _action_ when pressed.
|
|
If the environment variable _TERMINAL_ is set, _action_ will be run inside
|
|
the terminal. Otherwise, it will fallback to running directly. Multiple
|
|
buttons can be defined by providing the flag multiple times.
|
|
|
|
*-B, --button-no-terminal* <text> <action>
|
|
Create a button with the text _text_ that executes _action_ when pressed.
|
|
_action_ will be run directly instead of in a terminal. Multiple buttons
|
|
can be defined by providing the flag multiple times.
|
|
|
|
*-z, --button-dismiss* <text> <action>
|
|
Create a button with the text _text_ that executes _action_ when pressed,
|
|
and dismisses swaynag. If the environment variable _TERMINAL_ is set,
|
|
_action_ will be run inside the terminal. Otherwise, it will fallback to
|
|
running directly. Multiple buttons can be defined by providing the flag
|
|
multiple times.
|
|
|
|
*-Z, --button-dismiss-no-terminal* <text> <action>
|
|
Create a button with the text _text_ that executes _action_ when pressed,
|
|
and dismisses swaynag. _action_ will be run directly instead of in a
|
|
terminal. Multiple buttons can be defined by providing the flag multiple
|
|
times.
|
|
|
|
*-c, --config* <path>
|
|
The config file to use. By default, the following paths are checked:
|
|
_$HOME/.swaynag/config_, _$XDG\_CONFIG\_HOME/swaynag/config_, and
|
|
_SYSCONFDIR/swaynag/config_. All flags aside from this one and _debug_ are
|
|
valid options in the configuration file using the format
|
|
_long-option=value_. All leading dashes should be omitted and the equals
|
|
sign is required. See swaynag(5) for more information.
|
|
|
|
*-d, --debug*
|
|
Enable debugging.
|
|
|
|
*-e, --edge* top|bottom
|
|
Set the edge to use.
|
|
|
|
*-f, --font* <font>
|
|
Set the font to use.
|
|
|
|
*-h, --help*
|
|
Show help message and quit.
|
|
|
|
*-l, --detailed-message*
|
|
Read a detailed message from stdin. A button to toggle details will be
|
|
added. Details are shown in a scrollable multi-line text area.
|
|
|
|
*-L, --detailed-button* <text>
|
|
Set the text for the button that toggles details. This has no effect if
|
|
there is not a detailed message. The default is _Toggle details_.
|
|
|
|
*-m, --message* <msg>
|
|
Set the message text.
|
|
|
|
*-o, --output* <output>
|
|
Set the output to use. This should be the name of a _xdg\_output_.
|
|
|
|
*-s, --dismiss-button* <text>
|
|
Sets the text for the dismiss nagbar button. The default is _X_.
|
|
|
|
*-t, --type* <type>
|
|
Set the message type. Two types are created by default _error_ and
|
|
_warning_. Custom types can be defined in the config file. See
|
|
_--config_ and swaynag(5) for details. Both of the default types can be
|
|
overridden in the config file as well.
|
|
|
|
*-v, --version*
|
|
Show the version number and quit.
|
|
|
|
# APPEARANCE OPTIONS
|
|
|
|
*--background* <RRGGBB[AA]>
|
|
Set the color of the background.
|
|
|
|
*--border* <RRGGBB[AA]>
|
|
Set the color of the border.
|
|
|
|
*--border-bottom* <RRGGBB[AA]>
|
|
Set the color of the bottom border.
|
|
|
|
*--button-background* <RRGGBB[AA]>
|
|
Set the color for the background for buttons.
|
|
|
|
*--text* <RRGGBB[AA]>
|
|
Set the text color.
|
|
|
|
*--button-text* <RRGGBB[AA]>
|
|
Set the button text color.
|
|
|
|
*--border-bottom-size* <size>
|
|
Set the thickness of the bottom border.
|
|
|
|
*--message-padding* <padding>
|
|
Set the padding for the message.
|
|
|
|
*--details-background* <RRGGBB[AA]>
|
|
Set the color for the background for details.
|
|
|
|
*--details-border-size* <size>
|
|
Set the thickness for the details border.
|
|
|
|
*--button-border-size* <size>
|
|
Set the thickness for the button border.
|
|
|
|
*--button-gap* <gap>
|
|
Set the size of the gap between buttons.
|
|
|
|
*--button-dismiss-gap* <gap>
|
|
Set the size of the gap between the dismiss button and another button.
|
|
|
|
*--button-margin-right* <margin>
|
|
Set the margin from the right of the dismiss button to edge.
|
|
|
|
*--button-padding* <padding>
|
|
Set the padding for the button text.
|
|
|
|
# SEE
|
|
|
|
swaynag(5)
|