From 9a81456f0ad4627ec1075897aff747ebd664932c Mon Sep 17 00:00:00 2001 From: "C. McEnroe" Date: Tue, 8 Dec 2020 17:19:08 -0500 Subject: Clarify configuration file usage example Point to EXAMPLES and /help from the top of the manual. --- catgirl.1 | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/catgirl.1 b/catgirl.1 index 160ba6f..1e6ce12 100644 --- a/catgirl.1 +++ b/catgirl.1 @@ -38,6 +38,16 @@ program is a TLS-only curses IRC client. . .Pp +See +.Sx EXAMPLES +to get started. +Type +.Ic /help +inside +.Nm +to view this manual again. +. +.Pp Options can be loaded from files listed on the command line. Files are searched for in @@ -599,18 +609,27 @@ if the connection is lost, and >0 if an error occurs. . .Sh EXAMPLES -Command line: +Join +.Li #ascii.town +from the command line: .Bd -literal -offset indent catgirl -h chat.freenode.net -j '#ascii.town' .Ed .Pp -Configuration file: +Create a configuration file in +.Pa ~/.config/catgirl/freenode : .Bd -literal -offset indent host = chat.freenode.net join = #ascii.town .Ed .Pp -Filtering joins, parts and quits from a channel: +Load the configuration file: +.Bd -literal -offset indent +catgirl freenode +.Ed +. +.Ss Tips +Hide joins, parts and quits from a channel: .Bd -literal -offset indent ignore = * [JPQ][OAU][IR][NT] #example .Ed -- cgit 1.4.0 f='/pounce/diff/.gitignore?h=1.0p2&id=8ccc5a2207cebf034051d45961aa7059a7ce656a&follow=1'>diff
path: root/.gitignore (unfollow)
Commit message (Expand)Author
2019-10-28Move entire login flow to state and reorganize itJune McEnroe
2019-10-27Wait for SASL success before sending CAP ENDJune McEnroe
2019-10-27Only increment consumer after successful sendJune McEnroe
2019-10-27Set SO_REUSEADDR on bindsJune McEnroe
2019-10-27Output ring info on SIGINFOJune McEnroe
2019-10-27Improve client/server error messagesJune McEnroe
2019-10-27Add reload cmd to rc scriptJune McEnroe
2019-10-27Reload certificate on SIGUSR1June McEnroe
2019-10-27Drop clients on zero-length readsJune McEnroe
2019-10-27Explicitly tls_handshake new clientsJune McEnroe
2019-10-26Document rationaleJune McEnroe
2019-10-26Handle nick collisionJune McEnroe
2019-10-26Wait for AUTHENTICATE + from serverJune McEnroe
2019-10-26Respond to PING with same parameterJune McEnroe
2019-10-26Add undocumented flag to disable verificationJune McEnroe
2019-10-26Do not require RPL_ISUPPORT for stateReadyJune McEnroe
2019-10-26Implement graceful shutdownJune McEnroe
2019-10-26Require PASS before USERJune McEnroe
2019-10-26Track channel topicsJune McEnroe
2019-10-26Set AWAY when no clients are connectedJune McEnroe
2019-10-26Add flags to request TOPIC and NAMES on client connectJune McEnroe
2019-10-26OopsJune McEnroe
2019-10-26Disconnect client on unknown commandJune McEnroe
2019-10-26Allow reading sensitive information from filesJune McEnroe
2019-10-26Add rc scriptJune McEnroe
2019-10-25Add install and uninstall targetsJune McEnroe
2019-10-25Expand documentationJune McEnroe
2019-10-25Add AGPLv3 notice on client registrationJune McEnroe
2019-10-25Rename project pounceJune McEnroe