blob: 187b8ee888378a29d6845b60d5d6f471f5b6cc54 (
plain) (
blame)
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
141
142
|
.Dd August 11, 2020
.Dt POUNCE-PALAVER 1
.Os
.
.Sh NAME
.Nm pounce-palaver
.Nd Palaver push notifications for pounce
.
.Sh SYNOPSIS
.Nm
.Op Fl v
.Op Fl c Ar cert
.Op Fl d Ar path
.Op Fl k Ar priv
.Op Fl p Ar port
.Op Fl u Ar user
.Op Fl w Ar pass
.Ar host
.
.Sh DESCRIPTION
The
.Nm
daemon provides push notifications
for the Palaver IRC app via the
.Xr pounce 1
IRC bouncer.
The
.Cm palaver
option must be enabled in
.Xr pounce 1 .
.
.Pp
The arguments are as follows:
.Bl -tag -width Ds
.It Fl c Ar cert
Load the TLS client certificate from
.Ar path .
If the private key is in a separate file,
it is loaded with
.Fl k .
.It Fl d Ar path
Set the path to the database file
used to store notification preferences.
The default path is documented in
.Sx FILES .
.It Fl k Ar priv
Load the TLS client private key from
.Ar path .
.It Fl p Ar port
Connect to
.Ar port .
The default port is 6697.
.It Fl u Ar user
Set the username to
.Ar user .
The default username is
.Dq pounce-palaver .
.It Fl v
Log IRC protocol, SQL and HTTP to standard error.
.It Fl w Ar pass
Log in with the server password
.Ar pass .
.It Ar host
Connect to
.Ar host .
.El
.
.Ss Service Configuration
Add the following to
.Pa /etc/rc.conf
to enable the
.Nm
daemon:
.Bd -literal -offset indent
pounce_palaver_enable="YES"
.Ed
.
.Pp
To use the preferences database of a user,
add the following:
.Bd -literal -offset indent
pounce_palaver_user="user"
pounce_palaver_env="HOME=/home/user"
.Ed
.
.Pp
The
.Nm
service supports profiles
for running multiple instances.
Set
.Va pounce_palaver_profiles
to a space-separated list of names.
Flags for each profile
will be set from
.Va pounce_palaver_${profile}_flags .
For example:
.Bd -literal -offset indent
pounce_palaver_profiles="example1 example2"
pounce_palaver_example1_flags="example1.irc.example.org"
pounce_palaver_example2_flags="example2.irc.example.org"
.Ed
.Pp
The commands
.Cm start , stop ,
etc.\&
will operate on the profile
given as an additional argument,
or on all profiles
without an additional argument.
.
.Sh FILES
.Bl -tag -width Ds
.It Pa $XDG_DATA_DIRS/pounce-palaver/preferences.sqlite
The database file is searched for first in
.Ev $XDG_DATA_HOME ,
usually
.Pa ~/.local/share ,
followed by the colon-separated list of paths
.Ev $XDG_DATA_DIRS ,
usually
.Pa /usr/local/share:/usr/share .
.It Pa ~/.local/share/pounce-palaver/preferences.sqlite
The most likely default path to the database file.
.El
.
.Sh SEE ALSO
.Xr pounce 1
.
.Sh STANDARDS
.Lk https://github.com/cocodelabs/palaver-irc-capability "Palaver IRC Capability"
.
.Sh AUTHORS
.An June Bug Aq Mt june@causal.agency
.
.Sh BUGS
Send mail to
.Aq Mt list+pounce@causal.agency
or join
.Li #ascii.town
on
.Li chat.freenode.net .
|