diff options
Diffstat (limited to 'data/man')
-rw-r--r-- | data/man/Makefile.am | 3 | ||||
-rw-r--r-- | data/man/kvirc.1 | 133 |
2 files changed, 136 insertions, 0 deletions
diff --git a/data/man/Makefile.am b/data/man/Makefile.am new file mode 100644 index 00000000..b58f2f44 --- /dev/null +++ b/data/man/Makefile.am @@ -0,0 +1,3 @@ +tmpdir = $(mandir)/man1 +tmp_DATA=kvirc.1 +EXTRA_DIST=$(tmp_DATA) diff --git a/data/man/kvirc.1 b/data/man/kvirc.1 new file mode 100644 index 00000000..f2bd16ad --- /dev/null +++ b/data/man/kvirc.1 @@ -0,0 +1,133 @@ +.TH KVIRC 1 "26/02/2005" Version 3.2.0 +.SH NAME +KVIrc - an Internet Relay Chat client. +.SH SYNOPSIS +.B kvirc [options] [server [port]] [ircurl [ircurl [...]]] + +.SH DESCRIPTION +.PP +KVIrc is a Visual Internet Relay Chat client based on the Qt library. +.PP +It is intended to be an "user friendly" interface to the IRC protocol (see \fIRFC1459\fP) +and its extensions. +.SH OPTIONS +.I +\fIKVIrc\fP accepts the following options: +.TP 8 +.B \-h, \-\-help +Display a list of all commandline options. +.TP 8 +.B \-v, \-\-version +Output the version info. +.TP 8 +.B \-c \fI<configfile>\fP +Use \fI<configfile>\fP as configuration file instead of ~/.kvircrc . +.TP 8 +.B \-n \fI<configfile>\fP +Use \fI<configfile>\fP as configuration file instead of ~/.kvircrc . +Create if it doesn't exist. +.TP 8 +.B \-f +Force a new KVIrc session, even if there is already a running one. +.TP 8 +.B \-e \fI<commands>\fP +If a KVirc session is already running on the same X display, +execute the \fI<commands>\fP in that session, +otherwise startup normally and execute \fI<commands>\fP. +\fI<commands>\fP must be a single shell token. +You can eventually use this switch more than once. +.B \-x \fI<commands>\fP +If a KVirc session is already running on the same X display, +execute the \fI<commands>\fP in that session, +otherwise do nothing and exit. +\fI<commands>\fP must be a single shell token. +You can eventually use this switch more than once. +.TP 8 +.B \-r \fI<commands>\fP +If a KVirc session is already running on the same X display, +execute the \fI<commands>\fP in that session, +otherwise startup normally (and do NOT execute). +\fI<commands>\fP must be a single shell token. +You can eventually use this switch more than once. +.TP 8 +.B \-m +If a KVIrc session is already running, show an informational popup dialog +instead of writing to the console. +This is useful when starting KVIrc from a graphical taskbar button. +.TP 8 +.B [server] +Connect to this server upon startup. +.TP 8 +.B [port] +Use this port to connect to the server. +This option requires also a server name. +.TP 8 +.B [ircurl] +An url in the following form: + + irc[6]://<server>[:<port>][/<channel>[?<pass>]] + +For each url on the commandline create a new irc-context +and attempt to connect to <server> on the specified <port>. +The optional <channel> is joined just after the connection +has been estabilished. + +.SH ENVIRONMENT +.PP +.TP 8 +.B LANG +Language setting. +If not set (or set to 'EN','POSIX' or 'C') KVIrc will use the default language (english). +.TP 8 + +.SH FILES + +\fB$PREFIX\fP/share/kvirc/\fBVERSION\fP/* +Directory with the global KVIrc settings , modules etc... + +\fB$HOME\fP/.kvircrc This is the first file that KVIrc looks for. +If the \-c commandline option is specified , the file passed +as the option parameter is used instead of this one. +If the file is found , KVIrc reads the first non-empty line +and treats it as the path to the \fIKVIrc Local directory\fP. +If the file can not be found or the \fIKVIrc Local directory\fP +is not existing , KVIrc enters the setup mode and allows +selecting a new \fIKVIrc Local directory\fP. + +\fBKVIrc Local directory\fP/* +Directory with the local (per user) KVIrc settings. +Similar to the global one. + +.SH SEE ALSO +.BR X (1) +.BR talk (1) +.SH COPYRIGHT +Copyright \(co 1999-2004 Szymon Stefanek and The KVIrc Development Team + +Permission to use, copy, modify, and distribute this software and its +documentation for any purpose and without fee is hereby granted, +provided that the above copyright notice appear in all copies and that +both that copyright notice and this permission notice appear in +supporting documentation. + +.SH SUGGESTIONS AND BUG REPORTS +Any bugs found should be reported to the following e-mail address: +\fI<pragma at kvirc dot net>\fP + +.SH OFFICIAL WWW SITE + +http://www.kvirc.net +In Russian - http://www.kvirc.net.ru + +.SH AUTHORS +Szymon 'Pragma' Stefanek \fI<pragma at kvirc dot net>\fP + +With patches, fixes, extensions, and more from +[Anodine]@efnet, Till 'BuTi@ircnet' Busch, Fritz 'KNFritz@ircnet' Elfert, RAD Kade 1 + +With bug-hunting, hard-thinking, eyes-consuming, +nights spent on IRC, great suggestions and more from lots +of people all over the net, including but not limited to +Paul 'infected@ircnet' Boehm, Olle 'Crocodile@ircnet' H\[:a]lln\[:a]s, Diablo@ircnet, +Andrew 'Drosha@ircnet' Frolov, MalboroLi@ircnet, munehiro@ircnet + |