summaryrefslogtreecommitdiffstats
path: root/network/irc.c/irc.c.1
blob: 94e7f8c4164a6049f6f92d2c06122d929ece9f96 (plain)
.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "IRC.C" 1 "2022-01-03" "20210302_490f194" "SlackBuilds.org"
.SH NAME
irc.c \- minimalist curses IRC client
.\" RST source for irc.c(1) man page. Convert with:
.
.\" rst2man.py irc.c.rst > irc.c.1
.
.\" rst2man.py comes from the SBo development/docutils package.
.
.SH SYNOPSIS
.sp
irc.c [\fI\-n NICK\fP] [\fI\-u USER\fP] [\fI\-s SERVER\fP] [\fI\-p PORT\fP] [\fI\-l LOGFILE\fP] [\fI\-t\fP] [\fI\-h\fP]
.SH DESCRIPTION
.sp
\fBirc.c\fP is a simple IRC client. Features:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
infinite scrollback
.IP \(bu 2
automatic reconnection
.IP \(bu 2
utf8 support (inputting is still to do)
.IP \(bu 2
line editing (emacs like keybindings)
.IP \(bu 2
activity markers
.IP \(bu 2
logging
.IP \(bu 2
terminal resizes (inside an xterm)
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The user interface uses multiple windows. The first window is always
the server window, and each channel or private message conversation
gets its own window. Press \fB^N\fP and \fB^P\fP for next/previous window.
.sp
There is no config file. Options are set on the command line and/or
in the environment.
.SH OPTIONS
.INDENT 0.0
.TP
.BI \-n \ NICK
Sets the nickname (default: \fBIRCNICK\fP from environment; if not set, the
username from \fB\-u\fP or \fBUSER\fP).
.TP
.BI \-u \ USER
Sets the username (default: \fBUSER\fP from environment, or \fIanonymous\fP if not set).
.TP
.BI \-s \ SERVER
Server to connect to (default: irc.oftc.net).
.TP
.BI \-p \ PORT
Port to connect to (default: 6667).
.TP
.BI \-l \ FILE
File to log recieved data (default: none). If the file already
exists, new data is appended to it.
.TP
.B  \-t
Use a secured connection. For most IRC servers, you\(aqll also have to set
\fB\-p 6697\fP (or whatever port the server uses for secure connections).
.TP
.B  \-h
Display help.
.UNINDENT
.SH COMMANDS
.sp
IRC commands are \fInot\fP prefixed with a slash, in this client.
.INDENT 0.0
.TP
.B \fBj\fP \fIchannel\fP
Join a channel and create a new window for it.
.TP
.B \fBl\fP
Leave (part) the currently displayed channel and close its window.
.TP
.B \fBm\fP \fInick\fP \fImessage\fP
Send a private message. This creates a new window for the conversation.
.TP
.B \fBr\fP \fItext\fP
Send raw \fItext\fP to the server (like \fB/QUOTE\fP in other clients).
.TP
.B \fBq\fP
Quit. There is no way to send a quit message.
.UNINDENT
.SH KEYSTROKES
.INDENT 0.0
.TP
.B \fB^N\fP
Next window.
.TP
.B \fB^P\fP
Previous window.
.TP
.B \fBPageUp\fP
Scroll up.
.TP
.B \fBPageDown\fP
Scroll down.
.UNINDENT
.sp
Emacs\-style editing keys are also supported (\fB^U\fP, \fB^W\fP, etc).
.SH ENVIRONMENT
.INDENT 0.0
.TP
.B \fBUSER\fP
The default IRC username (override with \fB\-u\fP). This is unlike other
IRC clients, which use \fBIRCUSER\fP\&.
.TP
.B \fBIRCNICK\fP
The default IRC nickname. Override with \fB\-n\fP\&.
.TP
.B \fBIRCPASS\fP
Password used to authenticate to the IRC server, if set.
.UNINDENT
.SH COPYRIGHT
.sp
The author has placed \fBirc.c\fP in the public domain.
.sp
This man page written for the SlackBuilds.org project
by B. Watson, and is licensed under the WTFPL.
.SH SEE ALSO
.sp
The irc.c homepage: \fI\%https://c9x.me/irc/\fP
.\" Generated by docutils manpage writer.
.