diff --git a/docs/Makefile.am b/docs/Makefile.am index b2d123e2..4091eb80 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,5 +1,8 @@ docdir = $(datadir)/doc/irssi +man_MANS = \ + irssi.1 + doc_DATA = \ botnet.txt \ design.txt \ diff --git a/docs/irssi.1 b/docs/irssi.1 new file mode 100644 index 00000000..e435ec46 --- /dev/null +++ b/docs/irssi.1 @@ -0,0 +1,113 @@ +.TH Irssi 1 "September 2002" "Irssi IRC client" +.SH NAME +Irssi \- a modular IRC client for UNIX +.SH SYNOPSIS +.B irssi +[-dv!?] [-c server] [-p port] [-n nickname] [-w password] [-h hostname] +.SH DESCRIPTION +.B Irssi +is a modular Internet Relay Chat client. It is highly extensible and +very secure. Being a fullscreen, termcap based client with many +features, +.B Irssi +is easily extensible through scripts and modules. +.SH OPTIONS +.TP +.BI "\-\-config="FILE +use +.I FILE +instead of ~/.irssi/config. +.TP +.BI "\-\-home="PATH +.I PATH +specifies the home directory of Irssi. +Default is +.BR ~/.irssi +.TP +.BI "\-\-session="PATH +this option is here just for internal use. It is needed during an /UPGRADE. +For more information see /help upgrade. +.TP +.BI "\-c, \-\-connect="SERVER +connects to +.I SERVER +.TP +.BI "\-w, \-\-password="PASSWORD +use +.I PASSWORD +for authentification. +.TP +.BI "\-p, \-\-port="PORT +automatically connect to +.I PORT +on server. +.TP +.BI "\-!, \-\-noconnect" +disables autoconnecting. +.TP +.BI "\-n, \-\-nick="NICKNAME +specify +.I NICKNAME +as your nick. +.TP +.BI "\-h, \-\-hostname="HOSTNAME +use +.I HOSTNAME +for your irc session. +.TP +.BI "\-d, \-\-dummy" +use dummy terminal mode. +.TP +.BI "\-v, \-\-version" +display the version of Irssi. +.TP +.BI "\-?, \-\-help" +show a help message. +.TP +.BI "\-\-usage" +display brief usage message. +.SH SEE ALSO +.B Irssi +has been supplied with a huge amount of documentation. Check /help or look +at the files contained by /usr/share/doc/irssi* +.SH FILES +.TP +.I /etc/irssi.conf +Global configuration file +.TP +.I ~/.irssi/config +Personal configuration file +.TP +.I ~/.irssi/config.autosave +Automatic save of the personal config file when it was changed externally +.TP +.I ~/.irssi/default.theme +Default irssi theme +.TP +.I ~/.irssi/away.log +Logged messages in away status +.TP +.I /usr/share/irssi/help/ +Directory including many help files +.TP +.I /usr/share/irssi/scripts/ +Global scripts directory +.TP +.I /usr/share/irssi/themes/ +Global themes directory +.TP +.I ~/.irssi/scripts/ +Default scripts directory +.TP +.I ~/.irssi/scripts/autorun/ +Directory containing links to scripts that should be loaded +automatically on startup +.SH AUTHORS/CREDITS +.B Irssi +was written by Timo Sirainen +.B +.sp +This manpage was written by Istvan Sebestyen +.BR +and Stefan Tomanek +.BR