jrd/irssi
1
0
Fork 0
forked from PsychoticNinja/irssi
Code Issues Pull Requests Projects Releases Wiki Activity

Updated the man page (#251)

Browse Source 
Updated the man page (#251)
This commit is contained in:
Geert Hauwaerts 2015-06-12 20:41:47 +02:00
parent a663d2f674
commit e2eb2483b7
1 changed files with 23 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
docs/irssi.1
View File

@ -1,12 +1,13 @@
.TH Irssi 1 "September 2002" "Irssi IRC client" .TH Irssi 1 "June 2015" "Irssi IRC client"
.SH NAME .SH NAME
Irssi \- a modular IRC client for UNIX Irssi \- a modular IRC client for UNIX
.SH SYNOPSIS .SH SYNOPSIS
.B irssi .B irssi
[-dv!?] [-c server] [-p port] [-n nickname] [-w password] [-h hostname] [--config=PATH] [--home=PATH] [-dv!?] [-c server] [-p port] [-n nickname]
[-w password] [-h hostname]
.SH DESCRIPTION .SH DESCRIPTION
.B Irssi .B Irssi
is a modular Internet Relay Chat client. It is highly extensible and is a modular Internet Relay Chat client; it is highly extensible and
very secure. Being a fullscreen, termcap based client with many very secure. Being a fullscreen, termcap based client with many
features, features,
.B Irssi .B Irssi
@ -16,16 +17,15 @@ is easily extensible through scripts and modules.
.BI "\-\-config="FILE .BI "\-\-config="FILE
use use
.I FILE .I FILE
instead of ~/.irssi/config. instead of ~/.irssi/config
.TP .TP
.BI "\-\-home="PATH .BI "\-\-home="PATH
.I PATH .I PATH
specifies the home directory of Irssi. specifies the home directory of Irssi; default is
Default is
.BR ~/.irssi .BR ~/.irssi
.TP .TP
.BI "\-c, \-\-connect="SERVER .BI "\-c, \-\-connect="SERVER
connects to connect to
.I SERVER .I SERVER
.TP .TP
.BI "\-w, \-\-password="PASSWORD .BI "\-w, \-\-password="PASSWORD
@ -39,71 +39,53 @@ automatically connect to
on server. on server.
.TP .TP
.BI "\-!, \-\-noconnect" .BI "\-!, \-\-noconnect"
disables autoconnecting. disable autoconnecting of servers
.TP .TP
.BI "\-n, \-\-nick="NICKNAME .BI "\-n, \-\-nick="NICKNAME
specify specify
.I NICKNAME .I NICKNAME
as your nick. as your nick
.TP .TP
.BI "\-h, \-\-hostname="HOSTNAME .BI "\-h, \-\-hostname="HOSTNAME
use use
.I HOSTNAME .I HOSTNAME
for your irc session. for your irc session
.TP .TP
.BI "\-d, \-\-dummy" .BI "\-d, \-\-dummy"
use dummy terminal mode. use dummy terminal mode
.TP .TP
.BI "\-v, \-\-version" .BI "\-v, \-\-version"
display the version of Irssi. display the version of Irssi
.TP .TP
.BI "\-?, \-\-help" .BI "\-?, \-\-help"
show a help message. show a help message
.SH SEE ALSO .SH SEE ALSO
.B Irssi .B Irssi
has been supplied with a huge amount of documentation. Check /help or look has a solid amount of documentation available; check /HELP or look online
at the files contained by /usr/share/doc/irssi* at http://www.irssi.org
.SH FILES .SH FILES
.TP .TP
.I /etc/irssi.conf
Global configuration file
.TP
.I ~/.irssi/config .I ~/.irssi/config
Personal configuration file personal configuration file
.TP .TP
.I ~/.irssi/config.autosave .I ~/.irssi/config.autosave
Automatic save of the personal config file when it was changed externally automatic save of the personal config file when it was changed externally
.TP .TP
.I ~/.irssi/default.theme .I ~/.irssi/default.theme
Default irssi theme default irssi theme
.TP .TP
.I ~/.irssi/away.log .I ~/.irssi/away.log
Logged messages in away status 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 .TP
.I ~/.irssi/scripts/ .I ~/.irssi/scripts/
Default scripts directory default scripts directory
.TP .TP
.I ~/.irssi/scripts/autorun/ .I ~/.irssi/scripts/autorun/
Directory containing links to scripts that should be loaded directory containing links to scripts that should be loaded
automatically on startup automatically on startup
.TP .TP
.I ~/.irssi/startup .I ~/.irssi/startup
File containing a list of commands to execute on startup file containing a list of commands to execute on startup
.SH AUTHORS/CREDITS .SH AUTHORS/CREDITS
.B Irssi .B Irssi
was written by Timo Sirainen was written by Timo Sirainen; this manpage was written by Istvan Sebestyen, Stefan Tomanek, Geert Hauwaerts.
.B <cras@irssi.org>
.sp
This manpage was written by Istvan Sebestyen
.BR <stevee@alphanet.ch>
and Stefan Tomanek
.BR <stefan@pico.ruhr.de>