summary refs log tree commit diff
path: root/litterbox.1
blob: d7163da5303f3f1b0027310a00d76dff8aad9def (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
.Dd December 1, 2019
.Dt LITTERBOX 1
.Os
.
.Sh NAME
.Nm litterbox
.Nd IRC logger
.
.Sh SYNOPSIS
.Nm
.Op Fl h Ar host
.Op Fl j Ar join
.Op Fl n Ar nick
.Op Fl p Ar port
.Op Fl u Ar user
.Op Fl w Ar pass
.Op Ar path
.
.Nm
.Fl i | m
.Op Ar path
.
.Sh DESCRIPTION
The
.Nm
daemon logs IRC activity to a database
which may be queried with
.Xr scoop 1 .
.
.Pp
The arguments are as follows:
.
.Bl -tag -width "-h host"
.It Fl h Ar host
Connect to
.Ar host .
.
.It Fl i
Initialize the database.
.
.It Fl j Ar join
Join the comma-separated list of channels
.Ar join .
.
.It Fl m
Migrate the database to the latest version.
.
.It Fl n Ar nick
Set the nickname to
.Ar nick .
The default nickname is
.Dq litterbox .
.
.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 the same as the nickname.
.
.It Fl w Ar pass
Log in with the server password
.Ar pass .
.
.It Ar path
The path to the database file.
The database must be initialized with
.Fl i .
See
.Sx FILES
for the default path.
.El
.
.Sh FILES
.Bl -tag -width Ds
.It Pa $XDG_DATA_DIRS/litterbox/litterbox.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/litterbox/litterbox.sqlite
The most likely path to the database file.
.El
.
.Sh SEE ALSO
.Xr scoop 1 ,
.Xr unscoop 1
.
.Sh STANDARDS
The
.Nm
daemon implements the following:
.
.Bl -item
.It
.Rs
.%A Waldo Bastian
.%A Ryan Lortie
.%A Lennart Poettering
.%T XDG Base Directory Specification
.%D November 24, 2010
.%U https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
.Re
.
.It
.Rs
.%A C. Kalt
.%T Internet Relay Chat: Client Protocol
.%I IETF
.%N RFC 2812
.%D April 2000
.%U https://tools.ietf.org/html/rfc2812
.Re
.El
.
.Sh AUTHORS
.An June Bug Aq Mt june@causal.agency
.
.Sh BUGS
Send mail to
.Aq Mt june@causal.agency
or join
.Li #ascii.town
on
.Li chat.freenode.net .