about summary refs log tree commit diff
path: root/unscoop.1
diff options
context:
space:
mode:
Diffstat (limited to 'unscoop.1')
-rw-r--r--unscoop.1101
1 files changed, 75 insertions, 26 deletions
diff --git a/unscoop.1 b/unscoop.1
index ed1c157..ddb0fb5 100644
--- a/unscoop.1
+++ b/unscoop.1
@@ -1,4 +1,4 @@
-.Dd September 30, 2020
+.Dd May 18, 2021
 .Dt UNSCOOP 1
 .Os
 .
@@ -16,13 +16,14 @@
 .Ar
 .
 .Nm
-.Op Fl d Ar path
 .Fl D
+.Op Fl d Ar path
 .
 .Sh DESCRIPTION
 The
 .Nm
-utility imports IRC client logs into the
+utility imports plain text IRC logs
+into the
 .Xr litterbox 1
 database.
 Network and channel or query names
@@ -31,6 +32,12 @@ can be inferred from file paths, so
 should be run from the log directory root.
 .
 .Pp
+The current path being imported
+is printed to standard output.
+Progress based on total file size
+is printed to standard error.
+.
+.Pp
 The arguments are as follows:
 .Bl -tag -width Ds
 .It Fl D
@@ -58,53 +65,95 @@ The default path is as in
 .Xr litterbox 1 .
 .
 .It Fl f Ar format
-Set the input log format to one of:
+Set the input log format.
+The default is
+.Cm generic .
+.
+.It Fl v
+Print SQL
+.Sy INSERT
+statements on standard error.
+.El
+.
+.Pp
+The formats are as follows:
 .Bl -tag -width Ds
 .It Cm catgirl
-The
+Import logs from the
 .Xr catgirl 1
 IRC client.
+.Bd -literal -offset indent
+find ~/.local/share/catgirl/log \e
+	-type f -name '*.log' -print0 |
+xargs -0 unscoop -f catgirl
+.Ed
+.
 .It Cm generic
-Matches paths of the form
-.Pa network/context/*
-and events of the following forms:
+Import logs using generic matchers.
+Network and context names are inferred
+from paths of the form
+.Pa network/context/* .
+Events of the following formats are matched:
 .Bd -literal -offset indent
 [timestamp] <nick> privmsg
 [timestamp] -nick- notice
 [timestamp] * nick action
 .Ed
+.
 .It Cm irc
-Matches IRC protocol messages tagged with
+Import logs formatted as
+IRC protocol messages tagged with
 .Sy server-time .
 The network and context must be set with
 .Fl N
 and
 .Fl c .
+.
 .It Cm textual
-The Textual IRC client.
-.El
-.Pp
-The default format is
-.Cm generic .
+Import logs from the Textual IRC client.
+.Bd -literal -offset indent
+find Textual -type f -name '*.txt' \e
+	-not -path '*/Console/*' -print0 |
+xargs -0 unscoop -f textual
+.Ed
 .
-.It Fl v
-Print SQL
-.Sy INSERT
-statements on standard error.
-.El
+.It Cm weechat
+Import logs from the WeeChat IRC client.
+.Bd -literal -offset indent
+find ~/.weechat/logs -type f -name 'irc.*.weechatlog' \e
+	-not -name 'irc.server.*.weechatlog' -print0 |
+xargs -0 unscoop -f weechat
+.Ed
+.Pp
+.Nm
+is not able to correctly infer
+network and context names
+for channel names containing dots.
+Import these logs explicitly with
+.Fl N
+and
+.Fl c .
 .
-.Sh EXAMPLES
-.Bd -literal
-find catgirl -type f -name '*.log' -print0 | xargs -0 unscoop -f catgirl
-find Textual -type f -name '*.txt' -not -path '*/Console/*' -print0 \e
-	| xargs -0 unscoop -f textual
+.It Cm znc
+Import logs from the
+.Xr znc 1
+.Sy log
+module.
+.Bd -literal -offset indent
+find ~/.znc/moddata/log \e
+	~/.znc/users/*/moddata/log \e
+	~/.znc/users/*/networks/*/moddata/log \e
+	-type f -name '*.log' \e
+	-not -path '*/status/*' -print0 |
+xargs -0 unscoop -f znc
 .Ed
+.El
 .
 .Sh SEE ALSO
 .Xr litterbox 1
 .
 .Sh AUTHORS
-.An June Bug Aq Mt june@causal.agency
+.An June McEnroe Aq Mt june@causal.agency
 .
 .Sh BUGS
 Send mail to
@@ -112,4 +161,4 @@ Send mail to
 or join
 .Li #ascii.town
 on
-.Li chat.freenode.net .
+.Li irc.tilde.chat .