From 9a81456f0ad4627ec1075897aff747ebd664932c Mon Sep 17 00:00:00 2001 From: "C. McEnroe" Date: Tue, 8 Dec 2020 17:19:08 -0500 Subject: [PATCH] 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