File: labnag.1.scd

package info (click to toggle)
labwc 0.9.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,980 kB
  • sloc: ansic: 34,416; perl: 5,836; xml: 875; sh: 162; python: 131; makefile: 12
file content (140 lines) | stat: -rw-r--r-- 3,369 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
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.

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

*--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
```