diff options
author | June McEnroe <june@causal.agency> | 2019-12-27 17:07:29 -0500 |
---|---|---|
committer | June McEnroe <june@causal.agency> | 2019-12-27 17:07:29 -0500 |
commit | 07b73fd69da1a43270596003eb163eb5c5cfdcf9 (patch) | |
tree | 158cd24825db15cbd1638d518fa360f19c157002 /litterbox.1 | |
parent | Use bsearch to find handler (diff) | |
download | litterbox-07b73fd69da1a43270596003eb163eb5c5cfdcf9.tar.gz litterbox-07b73fd69da1a43270596003eb163eb5c5cfdcf9.zip |
Add search query interface
Diffstat (limited to '')
-rw-r--r-- | litterbox.1 | 42 |
1 files changed, 40 insertions, 2 deletions
diff --git a/litterbox.1 b/litterbox.1 index 98766e2..3f0446a 100644 --- a/litterbox.1 +++ b/litterbox.1 @@ -1,4 +1,4 @@ -.Dd December 17, 2019 +.Dd December 27, 2019 .Dt LITTERBOX 1 .Os . @@ -8,7 +8,7 @@ . .Sh SYNOPSIS .Nm -.Op Fl v +.Op Fl Qqv .Op Fl d Ar path .Op Fl h Ar host .Op Fl j Ar join @@ -32,6 +32,24 @@ which may be queried with The arguments are as follows: . .Bl -tag -width "-h host" +.It Fl Q +Enable public search query interface. +This allows anyone to perform searches +in private messages to +.Nm . +Search results are limited +to channels on the current network. +. +.Pp +The searchable columns are +.Li channel , +.Li nick , +.Li user , +.Li target , +.Li message . +For search query syntax, see +.Lk https://www.sqlite.org/fts5.html#full_text_query_syntax +. .It Fl d Ar path Set the path to the database file. The database must be initialized with @@ -65,6 +83,26 @@ Connect to .Ar port . The default port is 6697. . +.It Fl q +Enable private search query interface. +This allows search queries in private messages to +.Nm +from itself, +which is likely only useful when connected to +.Xr pounce 1 . +Search results are limited to the current network. +. +.Pp +The searchable columns are +.Li channel , +.Li query , +.Li nick , +.Li user , +.Li target , +.Li message . +For search query syntax, see +.Lk https://www.sqlite.org/fts5.html#full_text_query_syntax +. .It Fl u Ar user Set the username to .Ar user . |