summary refs log tree commit diff
path: root/catgirl.1
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2020-12-08 17:19:08 -0500
committerJune McEnroe <june@causal.agency>2020-12-08 17:19:08 -0500
commit9a81456f0ad4627ec1075897aff747ebd664932c (patch)
treefd9de7e43a75c7963c8aa8e89edcbf138006d8ee /catgirl.1
parentHandle 437 ERR_UNAVAILRESOURCE like ERR_NICKNAMEINUSE (diff)
downloadcatgirl-9a81456f0ad4627ec1075897aff747ebd664932c.tar.gz
catgirl-9a81456f0ad4627ec1075897aff747ebd664932c.zip
Clarify configuration file usage example
Point to EXAMPLES and /help from the top of the manual.
Diffstat (limited to 'catgirl.1')
-rw-r--r--catgirl.125
1 files 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