
TkNap v0.5.20
-------------

TkNap is a bare-bones napster client written in Tcl/Tk.
For installation instructions see 'INSTALL'.

To add your shared MP3 files, use the '/uladd' command to add a base
directory to search recursively for MP3 files.  To remove a directory,
use the '/ulrem' command.  You can get a listing of your current
shared directories with the '/uldirs' command.
Every time you change the contents of any of your shared directories,
use the command '/uladd' again on the specific directory to update the
file list and notify the server of the changes.

If the '.tknaplist' file list should become "out of sync" with your
current shared directories for some reason (most probably because you
have edited the directories in '.tknaprc' outside of TkNap, which is
*not* recommended), just delete it and it will be rebuilt upon the
next invocation of the program.

Note: Try to avoid making changes to '.tknaprc' while the program is
running.  Since TkNap loads this file into memory on startup and in
in some cases writes it back to disk on exit, it will overwrite the
changes you made.


When someone initiates a download from you, the background of text
boxes will change to a brighter color as a notification.  It will "go
back to normal" when there are no longer any active uploads.


Resume of a partially downloaded file from a previous session will
only work if it has been saved with its original name.



Main window buttons
-------------------

Connect    Connect to server              keyboard shortcut: Ctrl-c
Disc       Disconnect from server         keyboard shortcut: Ctrl-d
Search     Search for MP3 files           keyboard shortcut: Ctrl-s
Browse     Browse a user's files          keyboard shortcut: Ctrl-b
Whois      Show whois info for a user     keyboard shortcut: Ctrl-w
Quit       Exit program                   keyboard shortcut: Ctrl-q



Textual commands
----------------

Commands that only work with opennap servers are marked with a (*).

Partial entry of commands is allowed (like /br for /browse), as
long as there is no ambiguity.

Some of the commands require privileges.  To be regarded as
privileged, you need either have a certain user level, or have a
higher level than the target user, depending on the type of command.
There are five user levels: 'leech', 'user', 'moderator', 'admin' and
'elite' in low to high order, with 'user' being the default for new
users.

Certain commands are only available in channel windows (where the
description mentions "the current channel").



/ban <user|ip>                   Ban user or ip from server (moderator
                                 or higher).

/browse <user>                   Browse <user>'s shared files.

/chlevel [<level>] (*)           Set the minimum level required to
                                 join the current channel (moderator
                                 or higher).  To see the current
                                 level, use the command without any
                                 parameter.

/clear [<reason>]                Clear the current channel from
                                 users with a lower level than yours.

/cloak                           Toggle your invisible state
                                 (moderator or higher).

/conn                            Connect to the last server used.

/dataport <prm1> [<prm2>]        If invoked with only one parameter,
                                 it  will change your dataport to
                                 <prm1>.  Else the first parameter is
                                 the user to change the data port for,
                                 and the second one is the port.  The
                                 latter mode is only available to
                                 moderators or higher.

/deop <user> (*)                 Remove <user> as operator on the
                                 current channel (moderator or
                                 higher).

/disc                            Disconnect from server.

/email <address>                 Change e-mail address to <address>.

/gmsg <text>                     Send global message to all users
                                 (admin or higher).

/join <channel>                  Join channel <channel>.

/kick <user> [<reason>] (*)      Kick <user> with a lower level than
                                 yours from the current channel.

/kill <user> [<reason>]          Kill (disconnect) <user> with a lower
                                 lower level than yours.

/killserv <adr> [<reason>] (*)   Kill (shutdown) server <adr> (elite
                                 only).

/level <user> <level>            Change level of <user> with a lower
                                 level than yours.

/link <adr>:<pt> [<rmt>] (*)     Attempt to link the current server to
                                 server <adr> at port <pt>.  If <rmt>
                                 is given, link from that server
                                 instead of the current one.
                                 Requires level admin or higher.

/links (*)                       Show links between servers.

/list                            List available channels.

/listbans                        List banned users and ip:s.

/me <text> (*)                   Send action description <text> on the
                                 current channel.

/msg <user> <text>               Send a private message to <user>.

/motd                            Show server's "Message Of The Day".

/muzzle <user> [<reason>]        Muzzle <user> with a lower level than
                                 yours.

/notify [+|-<user>]              Without parameters: show hotlist.
                                 +user: add user to hotlist.
                                 -user: remove user from hotlist.

/online                          Show hotlist users currently online.

/op [<user>] (*)                 Set <user> as operator on the current
                                 channel (moderator or higher).  If
                                 you omit the <user> parameter, a list
                                 of current channel operators will be
                                 returned in the form of a private
                                 message from pseudo-user 'ChanServ'.

/opmsg <text>                    Send a message to all users with
                                 level moderator or higher (moderator
                                 or higher).

/part                            Part the current channel.

/password <password>             Change password to <password>.

/ping <user>                     Ping <user>.

/qinfo <user>                    "Quick info", displays the number of
                                 shared files and link type of a user
                                 in the current channel.

/quit                            Exit program.

/remserv <srv> [<reason>] (*)    Request server <srv> to be removed
                                 from the list of allowed links (elite
                                 only).

/search [<word ...>]             Search for artist or title containing
                                 the word(s) you enter.
                                 Only the artist field is used in this
                                 case (the title field is cleared),
                                 but that doesn't have any impact on
                                 the search result since the server
                                 treats the artist and title fields
                                 equal when searching for MP3 files.
                                 If you don't enter any search word,
                                 the  usual search dialog box will pop
                                 up.

/server [<adr>:<pt>:<meta>]      Connect to server <adr> at port <pt>,
                                 treating the server as a "metaserver"
                                 (like the usual napster.com servers)
                                 if <meta> is '1', else like a normal
                                 server.  If you omit the server
                                 string, a window with your server
                                 list will pop up which lets you
                                 choose a server from the list.

/showpath [<0|1>]                Hide/show file paths in browse and
                                 search results.  To see the current
                                 state, use the command without any
                                 parameter.

/speed <prm1> [<prm2>]           If invoked with only one parameter,
                                 it will change your link speed to
                                 <prm1>.  Else the first parameter is
                                 the user to change the link speed
                                 for, and the second one is the
                                 speed.  The latter mode is only
                                 available to moderators or higher.

/stats (*)                       Show server statistics.

/topic <chn> <topic>             Set the topic of channel <chn> to
                                 <topic> (moderator or higher).

/uladd [<dir>]                   Add/refresh shared directory <dir>.
                                 If you leave out <dir>, you will get
                                 a directory selection dialog.

/uldirs                          Show current shared directories.

/ulrem [<dir>]                   Remove shared directory <dir>.
                                 If you leave out <dir>, you will get
                                 a directory selection dialog.

/ulstats                         Display statistics about active
                                 uploads.

/unban <user|ip>                 Remove the ban on a user or ip
                                 (moderator or higher).

/unlink <adr> [<reason>] (*)     Unlink the current server from server
                                 <adr> (admin or higher).

/unmuzzle <user>                 Unmuzzle <user> with a lower level
                                 than yours.

/unreg                           Make yourself appear as unregistered
                                 the next time you log in order to
                                 repeat the registration process.
                                 What this command does is simply
                                 resetting 'nap(registered)' to 0.

/usermode [<parms>] (*)          Set user mode.  See the opennap
                                 documentation for an explanation of
                                 the parameter syntax.  This command
                                 seems to work for all users, although
                                 it is mainly of interest to users
                                 with level moderator or higher.
                                 NOTE: The user mode will be reset
                                 upon next login, either by the
                                 server, or, if you have defined
                                 'usermode' as a command to invoke in
                                 'nap(auto_commands)', to that
                                 setting.  In other words, regard the
                                 changes you make with this command
                                 as temporary.
                                 To see the current state, use the
                                 command without parameters.

/username <username>             Change username to <username> (only
                                 available when disconnected).

/version                         Show server version (moderator or
                                 higher).

/whois <user>                    Show whois info for <user>.




The pop-up menu in channel windows and private message windows
--------------------------------------------------------------

If you press the right mouse button in the user list of a channel
window or anywhere in a private message window, you will get a pop-up
menu with various commands.


Keyboard shortcuts for the channel window user list only:

m                            Message
i                            Quick info
w                            Whois
b                            Browse
p                            Ping
Cntrl-o (*)                  Op
Cntrl-d (*)                  DeOp
Cntrl-m                      Muzzle
Cntrl-u                      Unmuzzle
Cntrl-k (*)                  Kick
Cntrl-l                      Kill
Cntrl-b                      Ban



If any problem occurs, don't hesitate to write me.
My E-mail address is <mats_peterson@swipnet.se>

Good Luck!
