IRC client
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

catgirl.1 6.7KB

CATGIRL(1)              FreeBSD General Commands Manual             CATGIRL(1)

NAME
     catgirl – IRC client

SYNOPSIS
     catgirl [-Nv] [-W pass] [-a auth] [-h host] [-j chan] [-l path] [-n nick]
             [-p port] [-r real] [-u user] [-w pass]

DESCRIPTION
     catgirl is a curses, TLS-only IRC client.

     The arguments are as follows:

     -N       Send notifications with notify-send(1).

     -W pass  Send WEBIRC command with pass.  See ENVIRONMENT for details.

     -a auth  Authenticate with SASL PLAIN.  auth is a colon-separated
              username and password pair.

     -h host  Connect to host.

     -j chan  Join chan after connecting.  chan may be a comma-separated list.

     -l path  Log messages to subdirectories of path named by channel or nick
              in files named by date.

     -n nick  Set nickname to nick.

     -p port  Connect to port.  The default port is 6697.

     -r real  Set realname to real.  The default realname is the same as the
              nickname.

     -u user  Set username to user.  The default username is the same as the
              nickname.

     -v       Show raw IRC protocol in the <raw> window.  If standard error is
              not a terminal, output raw IRC protocol to standard error.

     -w pass  Log in with pass.

     If -h host or -n nick are not provided, they will be prompted for.

COMMANDS
     Any unique prefix may be used to abbreviate a command.

   Chat Commands
     /join chan
             Join a channel.

     /me [action]
             Send an action message.

     /names, /who
             List users in the current channel.

     /nick nick
             Change nicknames.

     /part [message]
             Leave the current channel.

     /query nick
             Open a private message view.

     /quit [message]
             Quit IRC.

     /raw command
             Send a raw IRC command.

     /topic [topic]
             Show or set the topic of the current channel.

     /whois nick
             Query information about a user.

     /znc command
             Send znc(1) command.

     Any messages entered in the <raw> window will be sent as raw IRC
     commands.

   UI Commands
     /close  Close the current window.

     /help, /man
             View this manual.

     /move num
             Move window to number.  If num starts with + or -, the number is
             relative to the current window.

     /open [range]
             Open a range of recent URLs in the current window with open(1).
             URLs are numbered from the most recent starting at 1.  The range
             may be a single number, or a hyphen- or comma-separated range.

     /open substring
             Open the most recent URL in the current window matching the
             substring.

     /raw    Toggle the <raw> window.

     /url    Hide the UI and list the most recent URLs in the current window.
             Press Enter to resume the UI.

     /window name
             Switch to window by name.

     /window num, /num
             Switch to window by number.  If num starts with + or -, the
             number is relative to the current window.

KEY BINDINGS
     catgirl provides emacs(1)-like line editing keys as well as keys for
     applying IRC formatting.  The prefixes C-, M-, S- represent the control,
     meta (alt) and shift modifiers, respectively.  M-x sequences can also be
     typed as Esc followed by x.

   Line Editing
     C-a     Move cursor to beginning of line.
     C-b     Move cursor left.
     C-d     Delete character under cursor.
     C-e     Move cursor to end of line.
     C-f     Move cursor right.
     C-k     Delete line after cursor.
     C-w     Delete word before cursor.
     M-b     Move cursor to beginning of word.
     M-d     Delete word after cursor.
     M-f     Move cursor to end of word.
     Tab     Cycle through completions for commands, nicks and channels.

   IRC Formatting
     C-o     Toggle bold.
     C-r     Set or reset color.
     C-s     Reset formatting.
     C-t     Toggle italics.
     C-u     Toggle underline.
     C-v     Toggle reverse video.  This must usually be typed as C-v C-v.

     To reset color, follow C-r by a non-digit.  To set colors, follow C-r by
     one or two digits to set the foreground color, optionally followed by a
     comma and one or two digits to set the background color.

     The color numbers are as follows:

     0    white                    8     yellow
     1    black                    9     light green
     2    blue                    10    cyan
     3    green                   11    light cyan
     4    red                     12    light blue
     5    brown (dark red)        13    pink (light magenta)
     6    magenta                 14    gray
     7    orange (dark yellow)    15    light gray

   Window Keys
     C-l       Redraw the UI.
     C-n       Switch to the next window.
     C-p       Switch to the previous window.
     M-/       Switch to the previously active window.
     M-a       Switch to next hot or unread window.
     M-l       Hide the UI and list the log for the current window.
     M-m       Insert a blank line in the window.
     M-n       Switch to window by number 0–9.
     Down      Scroll window down by one line.
     PageDown  Scroll window down by one page.
     PageUp    Scroll window up by one page.
     Up        Scroll window up by one line.

ENVIRONMENT
     SSH_CLIENT  If -W is passed and SSH_CLIENT is set, the WEBIRC command is
                 used to set the hostname to the first word of SSH_CLIENT,
                 usually the client IP address.

EXAMPLES
           catgirl -h chat.freenode.net -j '#ascii.town'

STANDARDS
     catgirl is a partial implementation of the following:

     C. Kalt, Internet Relay Chat: Client Protocol, IETF, RFC 2812,
     https://tools.ietf.org/html/rfc2812, April 2000.

     Kevin L. Mitchell, Perry Lorier, Lee Hardy, and William Pitcock, IRCv3.1
     Client Capability Negotiation, IRCv3 Working Group,
     https://ircv3.net/specs/core/capability-negotiation-3.1.html.

     Jilles Tjoelker and William Pitcock, IRCv3.1 SASL Authentication, IRCv3
     Working Group, https://ircv3.net/specs/extensions/sasl-3.1.html.

     K. Zeilenga, Ed., The PLAIN Simple Authentication and Security Layer
     (SASL) Mechanism, IETF, RFC 4616, https://tools.ietf.org/html/rfc4616,
     OpenLDAP Foundation, August 2006.

     S. Josefsson, The Base16, Base32, and Base64 Data Encodings, IETF, RFC
     4648, https://tools.ietf.org/html/rfc4648, SJD, October 2006.

CAVEATS
     catgirl does not support unencrypted connections.

FreeBSD 12.0-RELEASE-p6        February 26, 2019       FreeBSD 12.0-RELEASE-p6