userguide.html

P2P NAP的C实现 P2P在网络应用中越来越流行

If you plan to limit your upload bandwidth, please be sure to claim an
appropriate connection speed. This is out of fairness to other
users. For instance, if you limit your bandwidth to 10k/s, you should
probably set your connection speed to 56k, even if you are really on a
T3 connection. To some extent, nap will try to enforce this kind of
etiquette.

<h4><a name=5.9.></a>5.9. Direct browsing</h4>

Nap supports direct browsing, also known as client-to-client browsing.
This is implemented through a new command, <code>/browse2</code>,
which works essentially the same way as <code>/browse</code>, except
it gets the file list directly from the other client, rather than from
the server.  Nap supports both outgoing direct browsing connections
(you browsing another client's files) and incoming ones (another
client browsing your files).

<p>

Direct browsing can be useful if the server limits the number of
browse results that it returns. However, there are several caveats
which limit the usefulness of direct browsing. The most important is
that not many other clients support it. So you will be out of luck if
you are trying to directly browse a client that does not support it -
most likely, your browse request will time out after 30
seconds. Nufsi, who implemented direct browsing support for nap,
writes: "Of the Napster-branded clients, only BETA 8 and BETA 9
support it, but even those clients don't support directly browsing a
firewalled remote client.  I think the only other client I found that
supports direct browsing is Lopster."

<p>

Another caveat is that if your direct browsing request leads to an error
of some kind, there is no way to stop it, and you will not be able to
perform another search until the direct browsing request times out after
30 seconds. This is because, due to a bug in OpenNap, nap has no way
of differentiating between an error due to a direct browsing request
and any other kind of error. 

<h4><a name=5.10.></a>5.10. Sharing non-music files</h4>

By default, nap will only share files that it can validate as music
files. Currently, this means files in the mp3 or Ogg Vorbis
formats. Nap will generally refuse to share mp3 or ogg files that it
recognizes as broken.

<p>

Since nap version 1.4.7, it is also possible to share non-music
files. You have a certain amount of control over which types of files
are shared through the <code>sharetypes</code> user variable. This
variable contains a semicolon-separated list of case insensitive
filename extensions, for example "jpg;jpeg;gif". The default is empty.
Nap will share any files in your upload path which match one of these
extensions. This is <i>in addition</i> to mp3 and ogg files, which nap
will always share. Thus, there is no need to include "mp3" or "ogg"
explicitly in the variable <code>sharetypes</code>. The extension "*"
is special, as it matches all files.

<p>

Please note that whether a file is shared or not is decided at the
time the library is built, not at the time the file is
requested. Thus, any changes to <code>sharetypes</code> and
<code>upload</code> do not take effect until you rebuild your
library. You can use the <code>/update</code> or <code>/rebuild</code>
commands to rebuild the library at any time. See also <a
href=#7.5.>7.5. Building your library</a>.

<h4><a name=5.11.></a>5.11. Managing uploads and downloads from the main screen</h4>

Prior to nap version 1.5.0, the download/upload screen did not exist.
Instead there were a number of commands for managing uploads and
downloads directly from the main screen. It is no longer really
necessary to use these commands, but they are still available so we
summarize them here.

<p>

To see the download list on the main screen, type <code>/pdown</code>.
To delete the third download from the list, type
<p><pre>
        /ddown 3
</pre>
The corresponding commands for uploads are <code>/pup</code> and
<code>/dup</code>. The command <code>/retry</code> can be used to
retry a specific failed download, and the command
<code>/retryall</code> can be used to retry all of them. To force a
queued or stopped download to be (re)started immediately, use
<code>/force</code>.

<p>

Stopped downloads or uploads can be purged from the lists with the
commands <code>/purgedown</code> and <code>/purgeup</code>, or use
<code>/purge</code> to clean up both the download and upload lists
with a single command.

<p>

You can also limit the output of the <code>/pdown</code> command to
certain classes of downloads. Just type
<pre>
        /pdown [filter]
</pre>
where filter is any combinations of the letters "d", "q", "s",
"f". These stand respectively for "downloading", "queued", "succeeded",
and "failed". If a filter is given, then only the respective downloads will be
displayed.

<p>


<!---------------------------------------------------------------------->
<h2><a name=6.></a>6. Messages, channels, and hotlists</h2>

One of the nice things about napster is that it allows you to
communicate with other users. This is done through messages or
channels.

<h4><a name=6.1.></a>6.1. Private messages</h4>

A "private" message is a message that you send to a specific user. You
do this by typing
<p><pre>
        /msg <i>user</i> <i>msg</i>
</pre>
If you don't want to receive such messages from a particular user, you
can ignore the user by typing
<p><pre>
        /ignore <i>user</i>
</pre>
You will no longer see that user's messages or files. If you have
regrets later, you can also <code>/unignore</code> a user. To see a
list of users you are currently ignoring, just type
<code>/ignore</code> without any arguments. 

<p>

If you intend to carry on an extended conversation with another user,
it quickly becomes annoying to type <code>/msg <i>user</i></code> all
the time. You can tell nap which user you want to talk to by
"querying" that user:
<p><pre>
        /query <i>user</i>
</pre>
Nap will now open a private channel to that user. The name of the user
you are querying will be shown on the top blue status line, and also
at the command prompt. You can now talk to the user just by typing
messages and hitting return. Messages can be distinguished from
commands because commands start with a "/". If you query more than one
user, or you are querying a user while also on a channel, you can
switch between users and channels by pressing "Ctrl-X". If you want to
end the query with a user, just type
<p><pre>
        /part <i>user</i>
</pre>
You can also just type <code>/part</code> to end the current query.

<p>

If you're going to be away from your computer, and you are worried
that other users might consider you rude for not replying to them, you
can set the user variable "autoreply" to any string which will then be
used as an automated reply. For instance, you can set it to "Hi, this
is an automated reply. I'm away from my computer. Sorry for not
responding personally." Nap will not autoreply a second time to a user
it has just autoreplied to; this is to discourage infinite chats
between two autoreplying clients!

<h4><a name=6.2.></a>6.2. Napster channels</h4>

When you join a channel, you can post messages to the channel and see
what other users on the channel are saying. Type
<p><pre>
        /clist
or      /clist2
</pre>
to see a list of available channels. <code>/clist</code> lists only
the official channels, while <code>/clist2</code> also lists
user-defined ones (see <a href=#6.3.>6.3. Creating your own channel</a>).  To
join a channel, type 
<p><pre>
        /join <i>channel</i>
</pre>
Being on a channel is very similar to querying a user. You can be on
several channels simultaneously. To switch between channels, press
"Ctrl-X". The top blue status line shows the "topic" of the current
channel. Press "Ctrl-T" to scroll the topic if it does not all fit on
the screen. To leave a channel, type 
<p><pre> 
        /part <i>channel</i>
</pre>
You can omit the channel name if you want to leave the current channel.
You can save the set of currently open channels to a file, or join all
the channels previously saved in a file, by typing
<p><pre>
        /savechannels <i>[filename]</i>
and     /loadchannels <i>[filename]</i>
</pre>
If you omit the filename, the default file
<code>.nap/channels-<i>username</i></code> (relative to your home
directory) will be used. Also, if the user variable
<code>savechannels</code> is set to "1", nap will save your channels
automatically when quitting and rejoin them when starting. See <a
href=#7.2.>7.2. User variables</a>.

<p>

While you're on a channel, you will see a special prompt telling you
what channel is currently active. To say something on that channel,
simply type the message. This is why all command names start with a
slash "/": so that when you're on a channel, nap can distinguish
between a command and a post to a channel. 

<p>

A word of caution about double quotes ("). The napster protocol is
extremely dumb when it comes to double quotes. It cannot tolerate any
data which contains double quotes. Thus nap will replace double quotes
by single quotes when you say something to a user or on a channel.

<p>

To see a list of all channels you are currently on, type
<code>/pchans</code>. To see a list of users on your active channels,
type <code>/names</code>. 

<p>

Just like for private messages, you can <code>/ignore</code> a user that is
bothering you. More severe punishments are also available for users
that behave truly inappropriately: you can request to kick a user from
a channel or all channels, or request that a user be muzzled, killed,
or banned. Such measures should of course be taken only under extreme
circumstances, and might be subject to review by the administrators of
your napster server. The corresponding commands are called
<code>/kick</code>, <code>/kickall</code>, <code>/muzzle</code>,
<code>/kill</code>, and <code>/ban</code>. Try 
<p><pre>
        /help <i>command</i>
</pre> 
for more info.

<p>

<h4><a name=6.3.></a>6.3. Creating your own channel</h4>

You can easily create a new channel. Simply join a channel that does
not already exist, and it will be created. Normally, such channels
have names that start with "#", although the official Napster servers
do not enforce this. Once you have created your channel, you are
probably the only person on it, but you can invite others to join the
channel as well. The channel will continue to exist as long as there
are users on it; it will be deleted when the last user parts. You can
see a list of all channels, including user-defined ones, by typing
<code>/clist2</code>.

<p>

You can set or change the topic on a channel by typing
<p><pre>
        /topic <i>channel</i> <i>topic</i>
</pre>
However, this does not work on the official Napster servers. It works
on OpenNap servers, if you are the user who created the channel.

<h4><a name=6.4.></a>6.4. IRC channels</h4>

Nap can also be used as an IRC client. I have not yet have time to
find out how, so probably there will be more information here in a
future version of this User Guide.

<h4><a name=6.5.></a>6.5. The hotlist</h4>

Napster allows you to specify a "hotlist" of users, and you will be
notified whenever these users log on or off napster. In nap, simply
type
<p><pre>
        /notify <i>user</i>
and     /unnotify <i>user</i>
</pre>
to add a user to your hotlist, or respectively, to remove a user.  To
see who is on your hotlist, and which of those users are currently on
napster, just type <code>/notify</code> without argument.
<code>/hotlist</code> and <code>/unhotlist</code> are alternative
names for <code>/notify</code> and <code>/unnotify</code>.

<p>

Hotlists in nap are permanent; each time you make a change to your
hotlist, it is automatically saved to a file (usually
<code>~/.nap/hotlist-<i>username</i></code>).  The hotlist is
automatically loaded when nap starts.

<!---------------------------------------------------------------------->
<h2><a name=7.></a>7. Configuration and user variables</h2>

<h4><a name=7.1.></a>7.1. The configuration files</h4>

Nap uses a configuration file, by default <code>~/.nap/napconf</code>,
to store information about your default settings. If the configuration
file does not already exist, nap will prompt you for the relevant
information and create a new configuration file. It is possible to
edit this file if you want to change your default settings. The format
of the configuration file looks something like this (except that the
actual file is rather longer):

<p>

<table><tr><td bgcolor=#c0c0c0>
<pre>
# nap config file. Note: for boolean options, 1=true, 0=false

# your napster username
user=yourname

# your napster password - optional
pass=yourpasswd