.\" 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 "labnag" "1" "2025-10-15"
.PP
.SH NAME
.PP
labnag - Show dialog with message and buttons
.PP
.SH SYNOPSIS
.PP
\fIlabnag\fR [options.\&.\&.\&]
.PP
.SH OPTIONS
.PP
\fB-B, --button\fR <text> [<action>]
.RS 4
Create a button with the text \fItext\fR that optionally executes \fIaction\fR
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.\&
.PP
.RE
\fB-Z, --button-dismiss\fR <text> [<action>]
.RS 4
Create a button with the text \fItext\fR that optionally executes \fIaction\fR
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.\&
.PP
.RE
\fB-d, --debug\fR
.RS 4
Enable debugging.\&
.PP
.RE
\fB-e, --edge\fR top|bottom
.RS 4
Set the edge to use.\&
.PP
.RE
\fB-y, --layer\fR overlay|top|bottom|background
.RS 4
Set the layer to use.\&
.PP
.RE
\fB-f, --font\fR <font>
.RS 4
Set the font to use.\&
.PP
.RE
\fB-h, --help\fR
.RS 4
Show help message and quit.\&
.PP
.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.\&
.PP
.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.\&
.PP
.RE
\fB-m, --message\fR <msg>
.RS 4
Set the message text.\&
.PP
.RE
\fB-o, --output\fR <output>
.RS 4
Set the output to use.\& This should be the name of a \fIxdg_output\fR.\&
.PP
.RE
\fB-t, --timeout\fR
.RS 4
Set duration to close dialog.\& Default is 5 seconds.\&
.PP
.RE
\fB-x, --exclusive-zone\fR
.RS 4
Use exclusive zone.\& Default is false.\&
.PP
.RE
\fB-v, --version\fR
.RS 4
Show the version number and quit.\&
.PP
.RE
.SH APPEARANCE OPTIONS
.PP
\fB--background-color\fR <RRGGBB[AA]>
.RS 4
Set the color of the background.\&
.PP
.RE
\fB--button-border-color\fR <RRGGBB[AA]>
.RS 4
Set the color of the button border.\&
.PP
.RE
\fB--border-bottom-color\fR <RRGGBB[AA]>
.RS 4
Set the color of the bottom border.\&
.PP
.RE
\fB--button-background-color\fR <RRGGBB[AA]>
.RS 4
Set the color for the background for buttons.\&
.PP
.RE
\fB--text-color\fR <RRGGBB[AA]>
.RS 4
Set the text color.\&
.PP
.RE
\fB--button-text-color\fR <RRGGBB[AA]>
.RS 4
Set the button text color.\&
.PP
.RE
\fB--border-bottom-size\fR <size>
.RS 4
Set the thickness of the bottom border.\&
.PP
.RE
\fB--message-padding\fR <padding>
.RS 4
Set the padding for the message.\&
.PP
.RE
\fB--details-background-color\fR <RRGGBB[AA]>
.RS 4
Set the color for the background for details.\&
.PP
.RE
\fB--details-border-size\fR <size>
.RS 4
Set the thickness for the details border.\&
.PP
.RE
\fB--button-border-size\fR <size>
.RS 4
Set the thickness for the button border.\&
.PP
.RE
\fB--button-gap\fR <gap>
.RS 4
Set the size of the gap between buttons.\&
.PP
.RE
\fB--button-dismiss-gap\fR <gap>
.RS 4
Set the size of the gap between the dismiss button and another button.\&
.PP
.RE
\fB--button-margin-right\fR <margin>
.RS 4
Set the margin from the right of the dismiss button to edge.\&
.PP
.RE
\fB--button-padding\fR <padding>
.RS 4
Set the padding for the button text.\&
.PP
.RE
.SH EXAMPLE
.PP
This is a simple example of a \fIlabnag\fR logout GUI.\&
.PP
.nf
.RS 4
#!/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
.fi
.RE
.PP