dzwdz
/
catboy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clarify configuration file usage example 

Point to EXAMPLES and /help from the top of the manual.
master
C. McEnroe 2020-12-08 17:19:08 -05:00
parent 997c932e83
commit 9a81456f0a
1 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
catgirl.1
View File

@ -38,6 +38,16 @@ program is a TLS-only
curses IRC client. curses IRC client.
. .
.Pp .Pp
See
.Sx EXAMPLES
to get started.
Type
.Ic /help
inside
.Nm
to view this manual again.
.
.Pp
Options can be loaded from files Options can be loaded from files
listed on the command line. listed on the command line.
Files are searched for in Files are searched for in
@ -599,18 +609,27 @@ if the connection is lost,
and >0 if an error occurs. and >0 if an error occurs.
. .
.Sh EXAMPLES .Sh EXAMPLES
Command line: Join
.Li #ascii.town
from the command line:
.Bd -literal -offset indent .Bd -literal -offset indent
catgirl -h chat.freenode.net -j '#ascii.town' catgirl -h chat.freenode.net -j '#ascii.town'
.Ed .Ed
.Pp .Pp
Configuration file: Create a configuration file in
.Pa ~/.config/catgirl/freenode :
.Bd -literal -offset indent .Bd -literal -offset indent
host = chat.freenode.net host = chat.freenode.net
join = #ascii.town join = #ascii.town
.Ed .Ed
.Pp .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 .Bd -literal -offset indent
ignore = * [JPQ][OAU][IR][NT] #example ignore = * [JPQ][OAU][IR][NT] #example
.Ed .Ed