labnag(1)

NAME

labnag - Show dialog with message and buttons

SYNOPSIS

labnag [options...]

OPTIONS

-B, --button <text> [<action>]
    Create a button with the text text that optionally executes action when pressed. Multiple buttons can be defined by providing the flag multiple times. Buttons will appear in the order they are provided from left to right.

-Z, --button-dismiss <text> [<action>]
    Create a button with the text text that optionally executes action when pressed, and dismisses labnag. Multiple buttons can be defined by providing the flag multiple times. Buttons will appear in the order they are provided from left to right.

-d, --debug
    Enable debugging.

-e, --edge top|bottom
    Set the edge to use.

-y, --layer overlay|top|bottom|background
    Set the layer to use.

-k, --keyboard-focus none|exclusive|on-demand
    Set the policy for keyboard focus.

-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.

-t, --timeout
    Set duration to close dialog. Default is 5 seconds.

-x, --exclusive-zone
    Use exclusive zone. Default is false.

-v, --version
    Show the version number and quit.

APPEARANCE OPTIONS

--background-color <RRGGBB[AA]>
    Set the color of the background.

--button-border-color <RRGGBB[AA]>
    Set the color of the button border.

--border-bottom-color <RRGGBB[AA]>
    Set the color of the bottom border.

--button-background-color <RRGGBB[AA]>
    Set the color for the background for buttons.

--text-color <RRGGBB[AA]>
    Set the text color.

--button-text-color <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-color <RRGGBB[AA]>
    Set the color for the background for details.

--details-border-size <size>
    Set the thickness for the details border.

--details-border-color <RRGGBB[AA]>
    Set the color of the details border.

--details-margin <margin>
    Set the margin for the details.

--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.

EXAMPLE

This is a simple example of a labnag logout GUI.

    #!/bin/sh
    # logout with labnag
    labnag \
     -f "Hack Regular 10"\
     -m "Choose your logout option"\
     -Z "  Lock   " "gtklock -d"\
     -Z " Logout  " "labwc -e"\
     -Z "Shutdown " "systemctl poweroff"\
     -Z " Reboot  " "systemctl reboot"\
     -Z "Hibernate" "systemctl hibernate"\
     -Z " Suspend " "systemctl suspend"\
     -Z " Cancel  "\
     --background-color 00ffff\
     --button-background-color 00ffff\
     --button-border-color 00ccccaa\
     --text-color 000000\
     --button-text-color 000000\
     --button-gap 8\
     --button-margin-right 0\
     --button-padding 5\
     --button-border-size 2\
     -t 60