summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/man/konversation.1186
-rw-r--r--doc/man/konversationircprotocolhandler.170
2 files changed, 256 insertions, 0 deletions
diff --git a/doc/man/konversation.1 b/doc/man/konversation.1
new file mode 100644
index 0000000..7c0cbe6
--- /dev/null
+++ b/doc/man/konversation.1
@@ -0,0 +1,186 @@
+'\" t
+.\" Title: KONVERSATION
+.\" Author: Nathaniel W Turner <nate@houseofnate.net>
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 2005-05-31
+.\" Manual: [FIXME: manual]
+.\" Source: [FIXME: source]
+.\" Language: English
+.\"
+.TH "KONVERSATION" "1" "2005\-05\-31" "[FIXME: source]" "[FIXME: manual]"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+konversation \- user friendly IRC client for TDE
+.SH "SYNOPSIS"
+.HP \w'\fBkonversation\fR\ 'u
+\fBkonversation\fR [\fB\fIQt\-options\fR\fR] [\fB\fITDE\-options\fR\fR] [\fB\fIoptions\fR\fR]
+.SH "DESCRIPTION"
+.PP
+Konversation is client for the Internet Relay Chat (IRC) protocol\&.
+.PP
+IRC is a great way to meet friends on the net, make new acquaintances and lose yourself in talk about your favorite subject\&.
+.PP
+Konversation is under active development and is currently in beta\&.
+.SH "OPTIONS"
+.PP
+All
+TDE(TM)
+and
+Qt(TM)
+programs accept a some common command\-line options\&.
+.PP
+.PP
+\fBGeneric options:\fR
+.PP
+\fB\-\-help\fR
+.RS 4
+Show help about options
+.RE
+.PP
+\fB\-\-help\-qt\fR
+.RS 4
+Show Qt specific options
+.RE
+.PP
+\fB\-\-help\-tde\fR
+.RS 4
+Show TDE specific options
+.RE
+.PP
+\fB\-\-help\-all\fR
+.RS 4
+Show all options
+.RE
+.PP
+\fB\-\-author\fR
+.RS 4
+Show author information
+.RE
+.PP
+\fB\-v\fR, \fB\-\-version\fR
+.RS 4
+Show version information
+.RE
+.PP
+\fB\-\-license\fR
+.RS 4
+Show license information
+.RE
+.PP
+\fB\-\-\fR
+.RS 4
+Indicates end of options
+.RE
+.PP
+.PP
+\fBOptions\fR
+.PP
+\fB\-\-server\fR {\fIserver\fR}
+.RS 4
+Server to connect
+.RE
+.PP
+\fB\-\-port\fR {\fIport\fR}
+.RS 4
+Port to use (default: 6667)
+.RE
+.PP
+\fB\-\-channel\fR {\fIchannel\fR}
+.RS 4
+Channel to join after connection
+.RE
+.PP
+\fB\-\-nick\fR {\fInickname\fR}
+.RS 4
+Nickname to use
+.RE
+.PP
+\fB\-\-password\fR {\fIpassword\fR}
+.RS 4
+Password for connection
+.RE
+.PP
+\fB\-\-ssl\fR
+.RS 4
+Use SSL for connection (default: false)
+.RE
+.SH "SCRIPTING"
+.PP
+Konversation looks for scripts in
+/opt/trinity/share/apps/konversation/scripts
+and in
+~/\&.trinity/share/apps/konversation/scripts\&. To execute a script, use the
+\fBexec\fR
+command:
+.HP \w'\fB/exec\fR\ 'u
+\fB/exec\fR {\fIscriptname\fR} [\fIarguments\fR]
+.PP
+For example:
+.PP
+\fB/exec gauge 75\fR
+.SH "FILES"
+.PP
+.PP
+~/\&.trinity/share/config/konversationrc
+.RS 4
+Main configuration
+.RE
+.PP
+~/\&.trinity/share/config/konversation\&.eventsrc
+.RS 4
+Notification settings
+.RE
+.PP
+~/\&.trinity/share/apps/konversation/logs
+.RS 4
+Directory containing channel log files
+.RE
+.SH "SEE ALSO"
+.PP
+The Konversation Handbook is an excellent resource for further reading\&. It can be found under the
+Help
+menu in Konversation\&.
+.PP
+The following manual pages may also be of interest:
+\fBkonversationircprotocolhandler\fR(1),
+\fBdcop\fR(1)
+.SH "COPYRIGHT"
+.PP
+This manual page was written by Nathaniel W\&. Turner
+<nate@houseofnate\&.net>
+for the
+Debian(TM)
+system (but may be used by others)\&. Permission is granted to copy, distribute and/or modify this document under the terms of the
+GNU
+General Public License, Version 2 or any later version published by the Free Software Foundation\&.
+.PP
+On Debian systems, the complete text of the GNU General Public License can be found in
+/usr/share/common\-licenses/GPL\&.
+.SH "AUTHOR"
+.PP
+\fBNathaniel W Turner\fR <\&nate@houseofnate\&.net\&>
+.RS 4
+Author.
+.RE
+.SH "COPYRIGHT"
+.br
+Copyright \(co 2004 Nathaniel W. Turner
+.br
diff --git a/doc/man/konversationircprotocolhandler.1 b/doc/man/konversationircprotocolhandler.1
new file mode 100644
index 0000000..78da0f6
--- /dev/null
+++ b/doc/man/konversationircprotocolhandler.1
@@ -0,0 +1,70 @@
+'\" t
+.\" Title: KONVERSATIONIRCPROTOCOLHANDLER
+.\" Author: Nathaniel W Turner <nate@houseofnate.net>
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 2004-07-06
+.\" Manual: [FIXME: manual]
+.\" Source: [FIXME: source]
+.\" Language: English
+.\"
+.TH "KONVERSATIONIRCPROTO" "1" "2004\-07\-06" "[FIXME: source]" "[FIXME: manual]"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+konversationircprotocolhandler \- handler for irc:// URI scheme
+.SH "SYNOPSIS"
+.HP \w'\fBkonversationircprotocolhandler\fR\ 'u
+\fBkonversationircprotocolhandler\fR {\fBURI\fR}
+.SH "DESCRIPTION"
+.PP
+This program takes a URI of the form irc://\fIserver\fR:\fIport\fR/ (or simply irc://\fIserver\fR/) and opens a connection to the specified IRC server in a running Konversation client\&.
+.PP
+This program is registered with TDE as a handler for the irc URI scheme, and TDE applications will use this program to handle such URI\&. (For example, it will be called if a user clicks on an irc:// link on a web page in Konqueror\&.)
+.PP
+This program can also be used directly, but since it is somewhat internal to Konversation, it\*(Aqs interface might change in an incompatible way, and relying on it is not advised\&. It is better to use Konversation\*(Aqs dcop interface directly\&.
+.SH "BUGS"
+.PP
+This program will only work if there is a currently running konversation process\&.
+.SH "SEE ALSO"
+.PP
+\fBkonversation\fR(1),
+\fBdcop\fR(1)
+.SH "COPYRIGHT"
+.PP
+This manual page was written by Nathaniel W\&. Turner
+<nate@houseofnate\&.net>
+for the
+Debian(TM)
+system (but may be used by others)\&. Permission is granted to copy, distribute and/or modify this document under the terms of the
+GNU
+General Public License, Version 2 or any later version published by the Free Software Foundation\&.
+.PP
+On Debian systems, the complete text of the GNU General Public License can be found in
+/usr/share/common\-licenses/GPL\&.
+.SH "AUTHOR"
+.PP
+\fBNathaniel W Turner\fR <\&nate@houseofnate\&.net\&>
+.RS 4
+Author.
+.RE
+.SH "COPYRIGHT"
+.br
+Copyright \(co 2004 Nathaniel W. Turner
+.br