diff options
Diffstat (limited to 'litterbox.1')
| -rw-r--r-- | litterbox.1 | 86 |
1 files changed, 48 insertions, 38 deletions
diff --git a/litterbox.1 b/litterbox.1 index b66d609..c54a576 100644 --- a/litterbox.1 +++ b/litterbox.1 @@ -1,4 +1,4 @@ -.Dd August 22, 2020 +.Dd April 3, 2021 .Dt LITTERBOX 1 .Os . @@ -19,17 +19,18 @@ .Op Fl l Ar limit .Op Fl n Ar nick .Op Fl p Ar port +.Op Fl t Ar trust .Op Fl u Ar user .Op Fl w Ar pass .Op Ar config ... . .Nm -.Op Fl d Ar path .Fl i | m +.Op Fl d Ar path . .Nm -.Op Fl d Ar path .Fl b Ar path +.Op Fl d Ar path . .Sh DESCRIPTION The @@ -39,7 +40,7 @@ which may be queried with .Xr scoop 1 . Messages, notices, joins, parts, quits, kicks, nick changes, -topic changes +topic changes, bans and unbans are recorded in the database. The contents of messages are indexed for full-text search. @@ -64,10 +65,13 @@ it will be migrated automatically when starts, or can be migrated explicitly with .Fl m . +Live backups of the database +can be made with +.Fl b . Instances of .Nm connected to different IRC networks -can share the same database. +will share the same database. . .Pp Options can be loaded from @@ -75,9 +79,10 @@ files listed on the command line. Files are searched for in .Pa $XDG_CONFIG_DIRS/litterbox unless the path starts with -.Ql / +.Ql / , +.Ql \&./ or -.Ql \&. . +.Ql \&../ . Each option is placed on a line, and lines beginning with .Ql # @@ -89,13 +94,13 @@ following their corresponding flags. The arguments are as follows: . .Bl -tag -width "-h host" -.It Fl N Ar name , Cm network = Ar name +.It Fl N Ar name | Cm network = Ar name Set the network name to be used if the server does not send .Sy RPL_ISUPPORT NETWORK . The default is the server hostname. . -.It Fl Q , Cm public-query +.It Fl Q | Cm public-query Enable the public search query interface. This allows anyone to perform searches in private messages to @@ -111,10 +116,8 @@ The searchable columns are .Li user , .Li target , .Li message . -For search query syntax, see -.Aq Lk https://www.sqlite.org/fts5.html#full_text_query_syntax . . -.It Fl U Ar url , Cm scooper-url = Ar url +.It Fl U Ar url | Cm scooper-url = Ar url Set the base URL of a .Xr scooper 1 instance @@ -130,7 +133,7 @@ Perform a live database backup to and exit. This operation requires SQLite version 3.27.0 or newer. . -.It Fl c Ar path , Cm cert = Ar path +.It Fl c Ar path | Cm cert = Ar path Load the TLS client certificate from .Ar path and authenticate with SASL EXTERNAL, @@ -143,23 +146,24 @@ If the private key is in a separate file, it is loaded with .Fl k . . -.It Fl d Ar path , Cm database = Ar path +.It Fl d Ar path | Cm database = Ar path Set the path to the database file. -The default paths are documented in -.Sx FILES . +See +.Sx FILES +for the default paths. . -.It Fl h Ar host , Cm host = Ar host +.It Fl h Ar host | Cm host = Ar host Connect to .Ar host . . .It Fl i Initialize the database and exit. . -.It Fl j Ar chan , Cm join = Ar chan +.It Fl j Ar chan | Cm join = Ar chan Join the comma-separated list of channels .Ar chan . . -.It Fl k Ar path , Cm priv = Ar path +.It Fl k Ar path | Cm priv = Ar path Load the TLS client private key from .Ar path . The @@ -167,7 +171,7 @@ The is searched for in the same manner as configuration files. . -.It Fl l Ar limit , Cm limit = Ar limit +.It Fl l Ar limit | Cm limit = Ar limit Limit the number of results in the search query interface enabled by @@ -180,18 +184,18 @@ The default limit is 10. Migrate the database to the latest format and exit. . -.It Fl n Ar nick , Cm nick = Ar nick +.It Fl n Ar nick | Cm nick = Ar nick Set the nickname to .Ar nick . The default nickname is .Dq litterbox . . -.It Fl p Ar port , Cm port = Ar port +.It Fl p Ar port | Cm port = Ar port Connect to .Ar port . The default port is 6697. . -.It Fl q , Cm private-query +.It Fl q | Cm private-query Enable the private search query interface. When connected to .Xr pounce 1 , @@ -209,20 +213,27 @@ The searchable columns are .Li user , .Li target , .Li message . -For search query syntax, see -.Aq Lk https://www.sqlite.org/fts5.html#full_text_query_syntax . . -.It Fl u Ar user , Cm user = Ar user +.It Fl t Ar path | Cm trust = Ar path +Trust the self-signed certificate loaded from +.Ar path +and disable server name verification. +The +.Ar path +is searched for in the same manner +as configuration files. +. +.It Fl u Ar user | Cm user = Ar user Set the username to .Ar user . The default username is the same as the nickname. . -.It Fl v , Cm verbose +.It Fl v | Cm verbose Write sent and received IRC messages as well as SQL INSERT statements to standard error. . -.It Fl w Ar pass , Cm pass = Ar pass +.It Fl w Ar pass | Cm pass = Ar pass Log in with the server password .Ar pass . .El @@ -235,9 +246,7 @@ Configuration files are searched for first in usually .Pa ~/.config , followed by the colon-separated list of paths -.Ev $XDG_CONFIG_DIRS , -usually -.Pa /etc/xdg . +.Ev $XDG_CONFIG_DIRS . . .It Pa $XDG_DATA_DIRS/litterbox/litterbox.sqlite The database file is searched for first in @@ -245,11 +254,10 @@ The database file is searched for first in usually .Pa ~/.local/share , followed by the colon-separated list of paths -.Ev $XDG_DATA_DIRS , -usually -.Pa /usr/local/share:/usr/share . +.Ev $XDG_DATA_DIRS . +. .It Pa ~/.local/share/litterbox/litterbox.sqlite -The most likely default path to the database file. +The most likely default path of the database file. .El . .Sh EXAMPLES @@ -269,6 +277,8 @@ public-query .Sh SEE ALSO .Xr scoop 1 , .Xr unscoop 1 +.Pp +.Lk https://www.sqlite.org/fts5.html#full_text_query_syntax "Full-text Query Syntax" . .Sh STANDARDS .Bl -item @@ -321,11 +331,11 @@ daemon implements the and .Sy causal.agency/passive vendor-specific IRCv3 capabilities -implemented by +offered by .Xr pounce 1 . . .Sh AUTHORS -.An June Bug Aq Mt june@causal.agency +.An June McEnroe Aq Mt june@causal.agency . .Sh BUGS Send mail to @@ -333,4 +343,4 @@ Send mail to or join .Li #ascii.town on -.Li chat.freenode.net . +.Li irc.tilde.chat . |