summary refs log tree commit diff
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2020-01-31 18:11:30 -0500
committerJune McEnroe <june@causal.agency>2020-01-31 18:11:30 -0500
commit2ce2f493e1a8af2ea59922439e0b52725018596b (patch)
treea508b6a47c2d9d10434ebcf12a4a42aec614c750
downloadcatgirl-2ce2f493e1a8af2ea59922439e0b52725018596b.tar.gz
catgirl-2ce2f493e1a8af2ea59922439e0b52725018596b.zip
Add simple manual page
-rw-r--r--catgirl.159
1 files changed, 59 insertions, 0 deletions
diff --git a/catgirl.1 b/catgirl.1
new file mode 100644
index 0000000..ccef5ee
--- /dev/null
+++ b/catgirl.1
@@ -0,0 +1,59 @@
+.Dd January 31, 2020
+.Dt CATGIRL 1
+.Os
+.
+.Sh NAME
+.Nm catgirl
+.Nd IRC client
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl h Ar host
+.Op Fl j Ar join
+.Op Fl n Ar nick
+.Op Fl p Ar port
+.Op Fl r Ar real
+.Op Fl u Ar user
+.Op Fl w Ar pass
+.
+.Sh DESCRIPTION
+The
+.Nm
+program is a curses
+TLS-only IRC client.
+.
+.Pp
+The arguments are as follows:
+.Bl -tag -width Ds
+.It Fl h Ar host
+Connect to
+.Ar host .
+.
+.It Fl j Ar join
+Join the comma-separated list of channels
+.Ar join .
+.
+.It Fl n Ar nick
+Set nickname to
+.Ar nick .
+The default nickname is the user's name.
+.
+.It Fl p Ar port
+Connect to
+.Ar port .
+The default port is 6697.
+.
+.It Fl r Ar real
+Set realname to
+.Ar real .
+The default realname is the same as the nickname.
+.
+.It Fl u Ar user
+Set username to
+.Ar user .
+The default username is the same as the nickname.
+.
+.It Fl w Ar pass
+Log in with the server password
+.Ar pass .
+.El