userguide.html

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

# your napster email address
email=[e-mail]

# list of upload directories, separated by semicolon
upload=/home/yourname/music

# your download directory
download=/home/yourname/download

# your directory for incomplete files
incomplete=/home/yourname/incomplete

# your connection speed, according to the following chart:
#
# Connection | Number
# -------------------
# Unknown    |  0
# 14.4       |  1
# 28.8       |  2
# 33.6       |  3
# 56.7       |  4
# 64K ISDN   |  5
# 128K ISDN  |  6
# Cable      |  7
# DSL        |  8
# T1         |  9
# T3 or >    | 10
connection=4

# maximal number of simultaneous uploads allowed
#maxuploads=

# maximum number of simultaneous uploads per user
#maxupuser=

# maximum number of simultaneous downloads allowed
#maxdownloads=

# maximum number of simultaneous downloads per user
#maxdownuser=

# list of servers, separated by semicolon (note: this is now ignored
# and overwritten unless nometa is set)
#servers=

# port or range of ports to use for client-client connections
dataport=6699-6799

# log file for transfer logs
#logfile=

# log file for logging everything
#logallfile=
</pre>
</td></tr></table>

<p>

This is the file which nap will create automatically for you, except
it will use the settings that you enter.  Note that the password entry
is left blank or set to a question mark. If you want, you can edit
your configuration file and put your password in it; in this case, nap
will not prompt you for it in the future. But nap will never save your
password for you; whenever you save your config file, your password
will show up as a question mark.

<p>

If you tend to use several different accounts on napster, and you
don't want to be prompted for passwords, you can now also specify
passwords and email addresses for each different account. Simply add
some lines such as
<p><pre>
        pass.<i>username1</i>=<i>passwd1</i>
        pass.<i>username2</i>=<i>passwd2</i>
        email.<i>username1</i>=<i>email1</i>
        email.<i>username2</i>=<i>email2</i>
</pre>
to your config file. If you specify passwords in this way, it is
understood that you don't want to be prompted for them; thus, such
passwords never get be replaced by "?".

<p>

Any options that are set in the configuration file can be overridden
on the command line, by using the "-o" option. It is also possible to
have more than one alternative configuration file (for instance, if
you have two different napster accounts with different usernames and
passwords), and to specify on the command line which one to use.

<p>

There is also the possibility to read a <i>global</i> configuration
file, usually called <code>/etc/naprc</code>. This file, which follows
the same format as the user configuration file discussed above, is
only read if it exists, and it is read <i>after</i> the user's
configuration file. However, any options previously set will not be
overwritten, so in effect, the user's configuration file takes
precedence over the global one. It is even possible to change the
location of the global configuration file by defining the variable
<code>globalconfigfile</code> in the user's configuration file.  

<h4><a name=7.2.></a>7.2. User variables <font size=3 color=#00ff00><b>[updated 1.5.1]</b></font></h4>

Nap has a general mechanism called "user variables". These are
internal variables that correspond to nap's settings; for instance,
anything you specify in your config file corresponds to such a
setting.  You can type 
<p><pre>
        /set <i>variable</i> <i>value</i>
and     /unset <i>variable</i>
</pre>
to set a variable to a value, or to unset a variable. If you just type
<p><pre>
        /set <i>variable</i>
</pre>
then the current value of this variable will be displayed. Finally, if
you just type <code>/set</code>, a list of all currently set variables
and their values will be displayed.

<p>

Here is an alphabetical list of most user variables that have a
special meaning.

<ul>

<li><code><b>announcepongs</b></code>: If this variable is set to 1,
nap will announce when it receives a PONG packet from the
server. I am not sure why this feature is useful, but it once used to
be the default behavior, so I kept this in case someone needs it.

<li><code><b>autopurge</b></code>: If this variable is set to a
number, stopped item (i.e., failed, finished, incomplete, timed out)
will be automatically deleted from the download list after this many
seconds. If not set or set to -1, stopped items will remain in the
download items indefinitely, until you explicitly remove them.

<li><code><b>autopurgedown</b></code>: Like <code>autopurge</code>,
but for downloads only.

<li><code><b>autopurgeup</b></code>: Like <code>autopurge</code>,
but for uploads only.

<li><code><b>autoreply</b></code>: If this variable is set, it
represents a string which will be sent as an automatic reply to any
user who sends you a private message. This might be handy if you are running
nap non-interactively, and you don't want to appear rude by not
replying.

<li><code><b>autorestart</b></code>: If this variable is set to 1, we
attempt to automatically reconnect to a server when the connection to
the server is lost. Same as the command line option of the same name. 

<li><code><b>bandwidthdown</b></code>: global limit on the bandwidth
for downloads, in kB/s.

<li><code><b>bandwidthdown1</b></code>: limit on the bandwidth of a
single download, in kB/s.

<li><code><b>bandwidthup</b></code>: global limit on the bandwidth
for uploads, in kB/s.

<li><code><b>bandwidthup1</b></code>: limit on the bandwidth of a
single upload, in kB/s.

<li><code><b>configfile</b></code>: Predictably, this is the name of
your configuration file. I'm not sure why you would want to change it
in the middle of a session, but you can.

<li><code><b>connection</b></code>: Your connection speed. This is a
number from 0 to 10. See the chart in the sample configuration file
above. 

<li><code><b>connecttimeout</b></code>: The number of seconds until
nap times out while making a connection to any one server. The default
is 5 seconds. When set to 0, there is no timeout at all (which can
cause nap to hang indefinitely when trying to connect to a
non-responsive server).

<li><code><b>cursorfollowsscreen</b></code>: If set to 1, the behavior
of the "PgUp" and "PgDn" keys on the search result screen will be
"cursor follows screen", else "screen follows cursor". In case you care.

<li><code><b>dataport</b></code>: The port on your local machine which
remote clients will connect to. It is advisable to give a range or
ports, for instance, 6699-6799, in case your chosen port is already
taken by another program. You should set this to 0 if you are behind a
firewall.

<li><code><b>debug</b></code>: This is the same as the debug level set with
the "-d" option, or with the command <code>/debug</code>.

<li><code><b>download</b></code>: Your download directory, i.e., where
you want complete downloaded files to go. Incomplete files will go to
the incomplete directory.

<li><code><b>email</b></code>: Your email address, as sent to the
server. It is perfectly acceptable to leave this blank. You can also
set email addresses for different usernames by defining variables of
the form <code>email.<i>user</i></code>. 

<li><code><b>globalconfigfile</b></code>: The name of a global
configuration file (default <code>/etc/naprc</code>) which is read
<i>after</i> the user's configuration file, but in a special mode
where no values that are already set are overwritten. This file is
only read on startup.

<li><code><b>hash</b></code>: If set, calculate MD5 hashes of shared
files. This used to be the default until 1.5.0. But since most servers
don't use the hashes anyway, by default, we don't calculate hashes
any more. <font size=3 color=#00ff00><b>[new 1.5.1]</b></font>

<li><code><b>identity</b></code>: This value, if set, defines a fake
client identification string. Normally the nap client identifies
itself to the server with an identification string such as <nobr>"nap
v1.5.2"</nobr>. Some dumb servers have been found to refuse
connections from the nap client, and in such cases, you can set
<code>identity</code> to a different value, e.g. <nobr>"WinMX
1.0"</nobr>, to fool the server. <font size=3 color=#ff0000><b>[new
1.5.2]</b></font>

<li><code><b>incomplete</b></code>: Your incomplete directory, i.e.,
where you want incomplete files to go. Completed downloads are moved
to the download directory.

<li><code><b>incompletesuffix</b></code>: The suffix added to the
filenames of incomplete files. Default is ".incomplete".

<li><code><b>libraryfile</b></code>: The location of your library
file. The default is <code>~/.nap/shared</code> in your home
directory.

<li><code><b>logallfile</b></code>: If set, this is the name of a file
to which everything that appears on the main screen will be logged.

<li><code><b>logfile</b></code>: If set, this is the name of a file to
which a record of all transfers (up- and downloads) will be logged.

<li><code><b>maxdownloads</b></code>: limits the number of
simultaneous downloads.

<li><code><b>maxdownuser</b></code>: limits the number of
simultaneous downloads for any one user.

<li><code><b>maxuploads</b></code>: limits the number of
simultaneous uploads.

<li><code><b>maxupuser</b></code>: limits the number of
simultaneous uploads for any one user.

<li><code><b>metaserver</b></code>: the URL of a napigator-style
metaserver to retrieve a server list from. The default is
http://www.napigator.com/servers.php.

<li><code><b>metatimeout</b></code>: If non-zero, this specifies the
maximum number of seconds nap will spend trying to connect to the
metaserver. The default is 5 seconds.

<li><code><b>napping</b></code>: The name of the "napping" program to
use. This can also be an absolute filename. The default is "napping"
and is searched for in your $PATH. See also <a href=#5.2.>5.2. Pings</a>.

<li><code><b>newstimeout</b></code>: If non-zero, this specifies the
maximum number of seconds nap will spend looking for news about new
releases while starting up. The default is 5 seconds.

<li><code><b>noechosets</b></code>: If this is set to "1", then the
<code>/set</code> command will not echo back its values to you.

<li><code><b>nomasq</b></code>: Set this to "1" to disable filename
masquerading. By default, nap hides the absolute pathnames of your
upload directories from the server and other clients. For instance, if
your upload directory is /home/username/music, and you are sharing a
file /home/username/music/classical/Beethoven.mp3, then this will be
reported to the server as /1/classical/Beethoven.mp3. Corresponding
download requests will be converted to the original pathnames.
<font size=3 color=#00ff00><b>[new 1.5.1]</b></font>

<li><code><b>nometa</b></code>: If set to "1", prevents nap from
contacting the meta-server on startup. This is useful if you would
like to specify your own "servers" variable in your config file.

<li><code><b>nonews</b></code>: If set to "1", nap will not attempt to
look for news about new releases while starting up.

<li><code><b>noresultscreen</b></code>: If this is set to "1", search
results will be listed on the main screen, and not on a special search
results screen. You can then download files with the <code>/get</code>
or <code>/g</code> command.

<li><code><b>noscroll</b></code>: If this is set to "1", then the main
screen does not automatically scroll to the bottom on output.

<li><code><b>pass</b></code>: your napster password. You can also set
passwords for different users by defining variables of the form
<code>email.<i>user</i></code>.

<li><code><b>proxy</b></code>: if you are behind a firewall and need
to use an http proxy to be able to access the world-wide web, then set
<code>proxy</code> to the URL of your proxy server,
e.g. <code>http://proxy.mydomain.com/</code>.

<li><code><b>savechannels</b></code>: If set to "1" while quitting,
nap will save your open channels to the file
<code>~/.nap/channels-<i>username</i></code>. If set to "1" while
starting, load and join channels from that file.

<li><code><b>savepass</b></code>: If this is set to "1", nap considers
it okay to store your password in your configuration file. By default,
nap will only store a "?", which means you will be promted for the
password next time you start nap.

<li><code><b>scrollsize</b></code>: If set, this defines a limit on
the number of lines that are saved on the main screen. The default is
10000. If you set this to 0, there will be no limit.

<li><code><b>sdefaults</b></code>: A string which determines the
default layout of the search results screen. This is essentially a
sequence of keystrokes which will be execute