Skip to content

Commit ccdc422

Browse files
committed
Add dunstify manpage
1 parent ce9140e commit ccdc422

File tree

6 files changed

+91
-8
lines changed

6 files changed

+91
-8
lines changed

Makefile

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ functional-tests: dunst dunstify
128128
PREFIX=. ./test/functional-tests/test.sh
129129

130130
.PHONY: doc doc-doxygen
131-
doc: docs/dunst.1 docs/dunst.5 docs/dunstctl.1
131+
doc: docs/dunst.1 docs/dunst.5 docs/dunstctl.1 docs/dunstify.1
132132

133133
# Can't dedup this as we need to explicitly provide the name and title text to
134134
# pod2man :(
@@ -138,6 +138,8 @@ docs/dunst.5: docs/dunst.5.pod
138138
${POD2MAN} --name=dunst -c "Dunst Reference" --section=5 --release=${VERSION} $< > $@
139139
docs/dunstctl.1: docs/dunstctl.pod
140140
${POD2MAN} --name=dunstctl -c "dunstctl reference" --section=1 --release=${VERSION} $< > $@
141+
docs/dunstify.1: docs/dunstify.pod
142+
${POD2MAN} --name=dunstify -c "dunstify reference" --section=1 --release=${VERSION} $< > $@
141143

142144
doc-doxygen:
143145
${DOXYGEN} docs/internal/Doxyfile
@@ -195,6 +197,7 @@ clean-doc:
195197
rm -f docs/dunst.1
196198
rm -f docs/dunst.5
197199
rm -f docs/dunstctl.1
200+
rm -f docs/dunstify.1
198201
rm -fr docs/internal/html
199202
rm -fr docs/internal/coverage
200203

@@ -224,6 +227,7 @@ install-dunst: dunst doc
224227
install -Dm644 docs/dunst.1 ${DESTDIR}${MANPREFIX}/man1/dunst.1
225228
install -Dm644 docs/dunst.5 ${DESTDIR}${MANPREFIX}/man5/dunst.5
226229
install -Dm644 docs/dunstctl.1 ${DESTDIR}${MANPREFIX}/man1/dunstctl.1
230+
install -Dm644 docs/dunstify.1 ${DESTDIR}${MANPREFIX}/man1/dunstify.1
227231

228232
install-dunstctl: dunstctl
229233
install -Dm755 dunstctl ${DESTDIR}${BINDIR}/dunstctl
@@ -273,6 +277,7 @@ uninstall-keepconf: uninstall-service uninstall-dunstctl uninstall-completions
273277
rm -f ${DESTDIR}${MANPREFIX}/man1/dunst.1
274278
rm -f ${DESTDIR}${MANPREFIX}/man5/dunst.5
275279
rm -f ${DESTDIR}${MANPREFIX}/man1/dunstctl.1
280+
rm -f ${DESTDIR}${MANPREFIX}/man1/dunstify.1
276281

277282
uninstall-dunstrc:
278283
rm -f ${DESTDIR}${SYSCONFFILE}

docs/dunst.1.pod

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
=head1 NAME
22

3-
dunst - A customizable and lightweight notification-daemon
3+
dunst - a customizable and lightweight notification-daemon
44

55
=head1 SYNOPSIS
66

@@ -197,4 +197,4 @@ If you feel that copyrights are violated, please send me an email.
197197

198198
=head1 SEE ALSO
199199

200-
dunst(5), dunstctl(1), dmenu(1), notify-send(1)
200+
dunst(5), dunstctl(1), dmenu(1), notify-send(1), dunstify(1)

docs/dunst.5.pod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1235,4 +1235,4 @@ If you feel that copyrights are violated, please send me an email.
12351235

12361236
=head1 SEE ALSO
12371237

1238-
dunst(1), dunstctl(1), dmenu(1), notify-send(1)
1238+
dunst(1), dunstctl(1), dmenu(1), notify-send(1), dunstify(1)

docs/dunstctl.pod

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
=head1 NAME
22

3-
dunstctl - Command line control utility for dunst, a customizable and
4-
lightweight notification-daemon
3+
dunstctl - command line control utility for dunst
54

65
=head1 SYNOPSIS
76

docs/dunstify.pod

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
=head1 NAME
2+
3+
dunstify - a program to send desktop notifications
4+
5+
=head1 SYNOPSIS
6+
7+
dunstify [OPTION...] SUMMARY [BODY]
8+
9+
=head1 DESCRIPTION
10+
11+
Dunstify is a notify-send alternative that can be used to
12+
send desktop notifications from the command line.
13+
14+
=head1 OPTIONS
15+
16+
=over 4
17+
18+
=item B<-?, --help>
19+
20+
Show help options.
21+
22+
=item B<-a, --appname=NAME>
23+
24+
Set the app name of the notification.
25+
26+
=item B<-u, --urgency=URG>
27+
28+
Set the urgency level (low, normal, critical) of the notification.
29+
30+
=item B<-h, --hints=HINT>
31+
32+
Specifies hints to pass. Valid types are BOOLEAN, INT, DOUBLE, STRING, BYTE and VARIANT.
33+
34+
=item B<-A, --action=ACTION>
35+
36+
Specifies the actions to display to the user.
37+
38+
=item B<-t, --timeout=TIMEOUT>
39+
40+
The time in milliseconds until the notification expires.
41+
42+
=item B<-i, --icon=ICON>
43+
44+
Specifies an icon to display with the notification.
45+
46+
=item B<-I, --raw_icon=PATH>
47+
48+
Path to the icon to be sent as raw image data.
49+
50+
=item B<-c, --capabilities>
51+
52+
Print the server capabilities and exit.
53+
54+
=item B<-s, --serverinfo>
55+
56+
Print server information and exit.
57+
58+
=item B<-p, --printid>
59+
60+
Print id, which can be used to update/replace this notification.
61+
62+
=item B<-r, --replace=ID>
63+
64+
Set the id of this notification to The ID of the notification to replace.
65+
66+
=item B<-C, --close=ID>
67+
68+
Close the notification with the specified ID.
69+
70+
=item B<-b, --block>
71+
72+
Block until notification is closed and print close reason.
73+
74+
=back
75+
76+
=head1 SEE ALSO
77+
78+
notify-send(1), dunst(5), dunstctl(1), dunst(1)
79+

dunstify.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ static GOptionEntry entries[] =
3030
{ "hints", 'h', 0, G_OPTION_ARG_STRING_ARRAY, &hint_strs, "User specified hints", "HINT" },
3131
{ "action", 'A', 0, G_OPTION_ARG_STRING_ARRAY, &action_strs, "Actions the user can invoke", "ACTION" },
3232
{ "timeout", 't', 0, G_OPTION_ARG_INT, &timeout, "The time in milliseconds until the notification expires", "TIMEOUT" },
33-
{ "icon", 'i', 0, G_OPTION_ARG_STRING, &icon, "An Icon that should be displayed with the notification", "ICON" },
33+
{ "icon", 'i', 0, G_OPTION_ARG_STRING, &icon, "An icon that should be displayed with the notification", "ICON" },
3434
{ "raw_icon", 'I', 0, G_OPTION_ARG_STRING, &raw_icon_path, "Path to the icon to be sent as raw image data", "RAW_ICON"},
3535
{ "capabilities", 'c', 0, G_OPTION_ARG_NONE, &capabilities, "Print the server capabilities and exit", NULL},
3636
{ "serverinfo", 's', 0, G_OPTION_ARG_NONE, &serverinfo, "Print server information and exit", NULL},
@@ -108,7 +108,7 @@ void parse_commandline(int argc, char *argv[])
108108
GError *error = NULL;
109109
GOptionContext *context;
110110

111-
context = g_option_context_new("SUMMARY BODY");
111+
context = g_option_context_new("SUMMARY [BODY]");
112112
g_option_context_add_main_entries(context, entries, NULL);
113113
if (!g_option_context_parse(context, &argc, &argv, &error)){
114114
g_printerr("Invalid commandline: %s\n", error->message);

0 commit comments

Comments
 (0)