games/kmuddy/kmuddy.1

0001 .TH KMuddy 1 "3 January 2009" "Version 1.0" "KMuddy Manual Pages"
0002 .SH NAME
0003 KMuddy \- a feature-rich MUD client by KDE
0004 .SH SYNOPSIS
0005 .B kmuddy
0006 [\-\-help] [--help-qt] [--help-kde] [--help-all] [--author]
0007 [-v,--version] [--license] [--]
0008 .SH DESCRIPTION
0009 \fIKMuddy\fP is a feature-rich MUD(Multi-User Dungeon) client by KDE.
0010
0011 Currently supported features include ANSI color, tabbed connection
0012 window, MCCP v1/v2 compression, configurable colors and short-cuts,
0013 split-screen output history, command history, connection profiles,
0014 intelligent word-wrapping, flexible aliases and triggers with POSIX
0015 regular expressions, session transcripts, macro keys, external
0016 scripting, scripting variables, Mud Sound Protocol, and more.
0017
0018 For more detailed information, see the KMuddy Handbook in the KDE help
0019 section.
0020 .SH OPTIONS
0021 KMuddy accepts the following commandline options:
0022 .TP
0023 .B \-\-help
0024 Show summary of options.
0025 .TP
0026 .B \-\-help\-qt
0027 Show QT-related options.
0028 .TP
0029 .B \-\-help\-kde
0030 Show KDE-related options.
0031 .TP
0032 .B \-\-help\-all
0033 Show all commandline options.
0034 .TP
0035 .B \-\-author
0036 Display information on KMuddy's author.
0037 .TP
0038 .B \-\-license
0039 Output a full copy of KMuddy's software license
0040 .TP
0041 .B \-v, \-\-version
0042 Print version number and exit.
0043 .TP
0044 .B \-\-
0045 End of options.
0046 .SH FILES
0047 .TP
0048 ~/.kde/share/config/kmuddyrc
0049 Per-user global configuration file.
0050 .TP
0051 ~/.kmuddy/
0052 Connection profile(s).  For each seperate profile, things like triggers,
0053 aliases, etc. are kept.
0054 .TP
0055 ${KDEDIR}/share/doc/HTML/en/kmuddy
0056 The KMuddy Handbook lives here.
0057 .TP
0058 ${KDEDIR}/share/kmuddy/
0059 KMuddy example and test scripts in C, C++, and Perl.
0060 .TP
0061 ${KDEDIR}/bin/kmuddy
0062 The actual binary executable.
0063 .SH ENVIRONMENT
0064 .TP 12
0065 .B KMUDDY_SOCKET
0066 To communicate variables back and forth with scripts in realtime, KMuddy
0067 uses a temporary socket.  When KMuddy executes an external script with
0068 variable-communication enabled, this environment variable is set.
0069 .SH OTHER INFO
0070 The webpage for KMuddy is at http://www.kmuddy.com.  Here you can find
0071 info about KMuddy, download the latest version, investigate the
0072 web-board, etc.
0073 .SH COPYRIGHT NOTICE
0074 KMuddy is (c) 2002-2009 Tomas Mecir and distributed under the terms of
0075 the GPL v2, see \fIkmuddy --license\fP