diff options
author | June McEnroe <june@causal.agency> | 2021-05-17 19:22:55 -0400 |
---|---|---|
committer | June McEnroe <june@causal.agency> | 2021-05-17 19:22:55 -0400 |
commit | fe8c89db1bdb65e81e8faf288db55f47e88f031b (patch) | |
tree | 82a7b40b40eb1a4ba5e392e4b22f377b6870ba79 /unscoop.1 | |
parent | Print paths to stdout and progress to stderr (diff) | |
download | litterbox-fe8c89db1bdb65e81e8faf288db55f47e88f031b.tar.gz litterbox-fe8c89db1bdb65e81e8faf288db55f47e88f031b.zip |
Clean up manuals
Diffstat (limited to '')
-rw-r--r-- | unscoop.1 | 62 |
1 files changed, 36 insertions, 26 deletions
diff --git a/unscoop.1 b/unscoop.1 index ed1c157..4dbd01e 100644 --- a/unscoop.1 +++ b/unscoop.1 @@ -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 @@ -57,35 +64,45 @@ which must have been initialized by The default path is as in .Xr litterbox 1 . . -.It Fl f Ar format -Set the input log format to one of: -.Bl -tag -width Ds -.It Cm catgirl -The +.It Fl f Cm catgirl +Import logs from the .Xr catgirl 1 IRC client. -.It Cm generic -Matches paths of the form -.Pa network/context/* -and events of the following forms: +.Bd -literal -offset indent +find ~/.local/share/catgirl/log \e + -type f -name '*.log' -print0 | +xargs -0 unscoop -f catgirl +.Ed +. +.It Fl f Cm generic +Import logs using generic matchers. +This is the default. +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 +. +.It Fl f Cm irc +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 . +. +.It Fl f Cm textual +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 @@ -93,13 +110,6 @@ Print SQL statements on standard error. .El . -.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 -.Ed -. .Sh SEE ALSO .Xr litterbox 1 . |