mirror of
https://github.com/swaywm/sway.git
synced 2026-04-26 06:46:26 -04:00
Move scdoc files to new doc directory.
This commit is contained in:
Krayfaus
parent
533acbe679
commit
4aa8f872ab
10 changed files with 0 additions and 0 deletions
113
swaynag/doc/swaynag.1.scd
Normal file
113
swaynag/doc/swaynag.1.scd
Normal file
|
|
@ -0,0 +1,113 @@
|
|||
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.
|
||||
|
||||
*-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.
|
||||
|
||||
*--border-bottom-size* <size>
|
||||
Set the thickness of the bottom border.
|
||||
|
||||
*--message-padding* <padding>
|
||||
Set the padding for the message.
|
||||
|
||||
*--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)
|
||||
100
swaynag/doc/swaynag.5.scd
Normal file
100
swaynag/doc/swaynag.5.scd
Normal file
|
|
@ -0,0 +1,100 @@
|
|||
swaynag(5)
|
||||
|
||||
# NAME
|
||||
|
||||
swaynag - swaynag configuration file
|
||||
|
||||
# SYNOPSIS
|
||||
|
||||
$HOME/.swaynag/config, $XDG\_CONFIG\_HOME/swaynag/config,
|
||||
SYSCONFDIR/swaynag/config
|
||||
|
||||
# CONFIG FILE
|
||||
|
||||
At the top of the config file, _swaynag_ options can be set using the format
|
||||
_long-option=value_. These will be used as default values if _swaynag_ is not
|
||||
given the option. This can be useful for setting a preferred font, output, and
|
||||
edge.
|
||||
|
||||
Below the options, custom types may be defined. To define a type, use the
|
||||
following format:
|
||||
|
||||
```
|
||||
[name-of-type]
|
||||
option=value
|
||||
```
|
||||
|
||||
All colors may be given in the form _RRGGBB_ or _RRGGBBAA_. The following
|
||||
colors can be set:
|
||||
|
||||
*background=<color>*
|
||||
The background color for _swaynag_.
|
||||
|
||||
*border=<color>*
|
||||
The color to use for borders of buttons.
|
||||
|
||||
*border-bottom=<color>*
|
||||
The color of the border line at the bottom of _swaynag_.
|
||||
|
||||
*button-background=<color>*
|
||||
The background color for the buttons.
|
||||
|
||||
*text=<color>*
|
||||
The color of the text.
|
||||
|
||||
The following sizing options can also be set:
|
||||
|
||||
*border-bottom-size=<size>*
|
||||
Set the thickness of the bottom border.
|
||||
|
||||
*message-padding=<padding>*
|
||||
Set the padding for the message.
|
||||
|
||||
*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.
|
||||
|
||||
Additionally, the following options can be assigned a default per-type:
|
||||
|
||||
*edge=top|bottom*
|
||||
Set the edge to use.
|
||||
|
||||
*font=<font>*
|
||||
Set the font to use.
|
||||
|
||||
*output=<output>*
|
||||
Set the output to use. This should be the name of a _xdg\_output_.
|
||||
|
||||
# EXAMPLE
|
||||
|
||||
```
|
||||
font=Monospace 12
|
||||
edge=bottom
|
||||
|
||||
[green]
|
||||
edge=top
|
||||
background=00AA00
|
||||
border=006600
|
||||
border-bottom=004400
|
||||
text=FFFFFF
|
||||
button-background=00CC00
|
||||
message-padding=10
|
||||
```
|
||||
|
||||
# SEE
|
||||
|
||||
swaynag(1)
|
||||
Loading…
Add table
Add a link
Reference in a new issue