diff options
Diffstat (limited to 'catgirl.1')
| -rw-r--r-- | catgirl.1 | 380 |
1 files changed, 380 insertions, 0 deletions
diff --git a/catgirl.1 b/catgirl.1 new file mode 100644 index 0000000..2ffd7d0 --- /dev/null +++ b/catgirl.1 @@ -0,0 +1,380 @@ +.Dd November 27, 2018 +.Dt CATGIRL 1 +.Os "Causal Agency" +. +.Sh NAME +.Nm catgirl +.Nd IRC client +. +.Sh SYNOPSIS +.Nm +.Op Fl Nv +.Op Fl W Ar pass +.Op Fl h Ar host +.Op Fl j Ar chan +.Op Fl l Ar path +.Op Fl n Ar nick +.Op Fl p Ar port +.Op Fl u Ar user +.Op Fl w Ar pass +. +.Sh DESCRIPTION +.Nm +is a curses IRC client +which only supports TLS. +. +.Pp +The arguments are as follows: +. +.Bl -tag -width Ds +.It Fl N +Send notifications with +.Xr notify-send 1 . +. +.It Fl W Ar pass +Send +.Ql WEBIRC +command with +.Ar pass . +See +.Sx ENVIRONMENT +for details. +. +.It Fl h Ar host +Connect to +.Ar host . +. +.It Fl j Ar chan +Join +.Ar chan +after connecting. +.Ar chan +may be a comma-separated list. +. +.It Fl l Ar path +Log messages to subdirectories by target +and files by date under +.Ar path . +. +.It Fl n Ar nick +Set nickname to +.Ar nick . +. +.It Fl p Ar port +Connect to +.Ar port . +The default port is 6697. +. +.It Fl u Ar user +Set username to +.Ar user . +The default username is +the same as the nickname. +. +.It Fl v +Show raw IRC protocol in the +.Ql ~irc +view. +. +.It Fl w Ar pass +Log in with +.Ar pass . +.El +. +.Pp +If +.Fl h +or +.Fl n +are not provided, +they will be prompted for. +. +.Sh COMMANDS +Commands may be entered +as their shortest unique prefix. +A slash followed immediately by a number +is equivalent to +.Ic /view . +. +.Bl -tag +.It Ic /close +Close the current view. +All views after the current one +are renumbered. +. +.It Ic /help +Equivalent to +.Ic /man . +. +.It Ic /join Ar chan +Join a channel. +. +.It Ic /man +View this manual. +. +.It Ic /me Ar action +Send a CTCP +.Ql ACTION +to the current target. +. +.It Ic /names +List users in the current channel. +Equivalent to +.Ic /who . +. +.It Ic /nick Ar nick +Change nicknames. +. +.It Ic /open Op Ar range +Open +.Ar range +most recent URLs +appearing in the current view +with +.Xr open 1 . +.Ar range +may be a hypen- or comma-separated range +from the most recent URL, +starting at 1. +The default +.Ar range +is 1. +. +.It Ic /open Ar substring +Open the most recent URL +appearing in the current view +matching +.Ar substring +with +.Xr open 1 . +. +.It Ic /part +Leave the current channel. +. +.It Ic /query Ar nick +Open a private message view with +.Ar nick . +. +.It Ic /quit Op Ar message +Quit IRC. +The default +.Ar message +is +.Dq Goodbye . +. +.It Ic /topic Op Ar topic +Show the topic of the current channel +or set it to +.Ar topic . +. +.It Ic /url +Hide the UI and +list the most recent URLS +which appeared in the current view. +Press +.Aq Enter +to resume the UI. +. +.It Ic /view Ar num +Switch to view number +.Ar num . +. +.It Ic /view Ar name +Switch to view for +.Ar name . +. +.It Ic /who +List users in the current channel. +.El +. +.Pp +Additionally, +messages entered in the +.Ql ~irc +view +will be sent as raw IRC commands. +. +.Sh KEY BINDINGS +.Nm +provides Emacs-like +line editing keys, +as well as keys for entering +IRC formatting codes. +. +.Ss View Keys +.Bl -tag +.It Aq C-l +Redraw the UI. +. +.It Aq M-m +Insert a blank line in the view. +. +.It Ao M-0 Ac ... Ao M-9 Ac +Switch to view by number. +See +.Ic /view . +. +.It Aq S-Left +Scroll view up by one line. +. +.It Aq S-Right +Scroll view down by one line. +. +.It Aq PageUp +Scroll view up by half a page. +. +.It Aq PageDown +Scroll view down by half a page. +.El +. +.Ss Line Editing +.Bl -tag +.It Ao C-b Ac Ao Left Ac +Move cursor left. +. +.It Ao C-f Ac Ao Right Ac +Move cursor right. +. +.It Ao C-a Ac Ao Home Ac +Move cursor to beginning of line. +. +.It Ao C-e Ac Ao End Ac +Move cursor to end of line. +. +.It Aq M-b +Move cursor to beginning of word. +. +.It Aq M-f +Move cursor to end of word. +. +.It Aq Backspace +Delete character before cursor. +. +.It Ao C-d Ac Ao Delete Ac +Delete character under cursor. +. +.It Ao C-w Ac Ao M-Backspace Ac +Delete word before cursor. +. +.It Aq M-d +Delete word after cursor. +. +.It Aq C-k +Delete line after cursor. +. +.It Aq Tab +Cycle through completions +for commands, nicks and channels. +.El +. +.Ss IRC Formatting +.Bl -tag +.It Aq C-n +Reset formatting. +. +.It Aq C-o +Toggle bold. +Note: this may need to be typed as +.Aq C-v C-o . +. +.It Aq C-t +Toggle italic. +. +.It Aq C-u +Toggle underline. +. +.It Aq C-v +Toggle reverse video. +Note: this must usually be typed as +.Aq C-v C-v . +. +.It Aq C-r +Set or reset color. +.El +. +.Pp +To reset color, +follow +.Aq C-r +by a non-digit. +To set the foreground color, +follow +.Aq C-r +by one or two digits. +To set the foreground and background colors, +follow +.Aq C-r +by one or two digits, +a comma, +and one or two digits. +. +.Pp +The colors are as follows: +.Bl -tag -width Ds -compact +.It 0 +white +.It 1 +black +.It 2 +blue +.It 3 +green +.It 4 +red +.It 5 +brown (dark red) +.It 6 +magenta +.It 7 +orange (dark yellow) +.It 8 +yellow +.It 9 +light green +.It 10 +cyan +.It 11 +light cyan +.It 12 +light blue +.It 13 +pink (light magenta) +.It 14 +gray +.It 15 +light gray +.El +. +.Sh ENVIRONMENT +.Bl -tag +.It Ev SSH_CLIENT +If +.Fl W +is passed and +.Ev SSH_CLIENT +is set, +the +.Ql WEBIRC +command is used +to set the hostname +to the first word of +.Ev SSH_CLIENT , +usually the client IP address. +.El +. +.Sh EXAMPLES +.Dl catgirl -h ascii.town -j '&catgirl' +. +.Sh STANDARDS +.Rs +.%A C. Kalt +.%T Internet Relay Chat: Client Protocol +.%I IETF +.%N RFC 2812 +.%D April 2000 +.%U https://tools.ietf.org/html/rfc2812 +.Re +. +.Sh CAVEATS +.Nm +does not support unencrypted connections. |