From 397b4ce6bd9064aa36f8b9c264e4bbc226822d6f Mon Sep 17 00:00:00 2001 From: June McEnroe Date: Sat, 12 Feb 2022 13:26:38 -0500 Subject: Prompt for empty server or SASL passwords --- catgirl.1 | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'catgirl.1') diff --git a/catgirl.1 b/catgirl.1 index 34b9718..065002b 100644 --- a/catgirl.1 +++ b/catgirl.1 @@ -1,4 +1,4 @@ -.Dd February 3, 2022 +.Dd February 12, 2022 .Dt CATGIRL 1 .Os . @@ -222,11 +222,9 @@ Authenticate as with .Ar pass using SASL PLAIN. -Since this requires the account password -in plain text, -it is recommended to use CertFP instead. -See -.Sx Configuring CertFP . +Leave +.Ar pass +blank to prompt for the password. . .It Fl c Ar path | Cm cert No = Ar path Load the TLS client certificate from @@ -375,6 +373,9 @@ if it is not a terminal. .It Fl w Ar pass | Cm pass No = Ar pass Log in with the server password .Ar pass . +Leave +.Ar pass +blank to prompt for the password. .El . .Ss Configuring CertFP -- cgit 1.4.1 From 5b3b798c499971abbd243e47ad0df908679c8cc5 Mon Sep 17 00:00:00 2001 From: June McEnroe Date: Tue, 22 Feb 2022 20:04:42 -0500 Subject: Document the interface --- catgirl.1 | 100 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 99 insertions(+), 1 deletion(-) (limited to 'catgirl.1') diff --git a/catgirl.1 b/catgirl.1 index 065002b..21eb82e 100644 --- a/catgirl.1 +++ b/catgirl.1 @@ -1,4 +1,4 @@ -.Dd February 12, 2022 +.Dd February 22, 2022 .Dt CATGIRL 1 .Os . @@ -429,6 +429,104 @@ trust = example.pem .Ed .El . +.Sh INTERFACE +The +.Nm +interface is split +into three areas. +. +.Ss Status Line +The top line of the terminal +shows window statuses. +Only the currently active window +and windows with activity are listed. +The status line for a window +might look like this: +.Bd -literal -offset indent +1+ #ascii.town +3 ~7 @ +.Ed +.Pp +The number on the left +is the window number. +Following it may be one of +.Ql - , +.Ql + , +.Ql ++ , +as well as +.Ql = . +These indicate +the message visibility threshold +and mute status +of the window. +.Pp +On the right side, +the number following +.Ql + +indicates the number of unread messages. +The number following +.Ql ~ +indicates how many lines +are below the scroll position. +An +.Ql @ +indicates that there is unsent input +in the window's +.Sx Input Line . +.Pp +.Nm +will also set the terminal title, +if possible, +to the name of the network +and active window, +followed by the unread count +for that window, +and the unread count +for all other windows +in parentheses. +. +.Ss Chat Area +The chat area shows +messages and events. +Regular messages are shown +with the nick between +.Ql <> +angle brackets. +Actions are shown +with the nick preceded by +.Ql * . +Notices are shown +with the nick between +.Ql - +hyphens. +.Pp +Blank lines are inserted into the chat +as unread markers. +.Pp +While scrolling, +the most recent 5 lines of chat +are kept visible below a marker line. +. +.Ss Input Line +The bottom line of the terminal +is where messages and commands are entered. +When entering a message, action or notice, +your nick appears on the left, +as it would in the +.Sx Chat Area . +When entering a command, +no nick is shown. +.Pp +Formatting codes are shown +in the input line +as reverse-video uppercase letters. +These will not appear in the sent message. +.Pp +Input that is too long +to send as a single message +will have a red background +starting at the point where it will be split +into a second message. +. .Sh COMMANDS Any unique prefix can be used to abbreviate a command. For example, -- cgit 1.4.1 From f51e7b4d2cc601bef8f22d5061ff8fafb012d671 Mon Sep 17 00:00:00 2001 From: June McEnroe Date: Wed, 23 Feb 2022 18:05:10 -0500 Subject: Give examples of "general events" --- catgirl.1 | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'catgirl.1') diff --git a/catgirl.1 b/catgirl.1 index 21eb82e..e9b124b 100644 --- a/catgirl.1 +++ b/catgirl.1 @@ -326,7 +326,8 @@ The default port is 6697. .It Fl q | Cm quiet Raise the default message visibility threshold for new windows, -hiding general events. +hiding general events +(joins, quits, etc.). . .It Fl r Ar real | Cm real No = Ar real Set realname to @@ -765,7 +766,8 @@ Scroll down a page. .It Ic M-+ Raise message visibility threshold, hiding ignored messages, -general events, +general events +(joins, quits, etc.), or non-highlighted messages. .It Ic M-- Lower message visibility threshold, -- cgit 1.4.1