vndb/yhdev
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Lots of changes

Browse source 
- ncdc 1.6 released
- ncdc FAQ updates
- 3 new images for /dump/nccol
- added my final report to /doc
- added ncdc-transfer-stats and ncdc-share-report to /dump
This commit is contained in:
Yorhel 2011-12-07 17:02:58 +01:00
parent f1f08a5fe0
commit 0a8812e31a
11 changed files with 316 additions and 213 deletions
Download patch file Download diff file Expand all files Collapse all files

160
dat/ncdc-man
View file

@ -38,13 +38,13 @@ GETTING STARTED
/set active true
See the help text for each of the commands and settings for more information.
Of course, all of the above settings are saved to the configuration file and
will be used again on the next run.
Of course, all of the above settings are saved to the database and will be used
again on the next run.
To connect to a hub, use /open:
/open ncdc adc://dc.blicky.net:2780/
Here `ncdc' is the personal name you give to the hub, and the second argument
the URL. This URL will be saved in the config file, so the next time you want to
the URL. This URL will be saved in the database, so the next time you want to
connect to this hub, you can simply do:
/open ncdc
See the help text for '/open' and '/connect' for more information. If you want
@ -88,7 +88,7 @@ INTERACTIVE COMMANDS
/accept
Use this command to accept the TLS certificate of a hub. This command is
used only in the case the keyprint of the TLS certificate of a hub does
not match the keyprint stored in the configuration file.
not match the keyprint stored in the database.
/browse [[-f] <user>]
Without arguments, this opens a new tab where you can browse your own
@ -133,22 +133,27 @@ INTERACTIVE COMMANDS
/gc
Cleans up unused data and reorganizes existing data to allow more effi‐
cient storage and usage. Currently, this commands cleans up hashdata.dat
and dl.dat, removes unused files in inc/ and old files in fl/.
cient storage and usage. Currently, this commands removes unused hash
data, does a VACUUM on db.sqlite3, removes unused files in inc/ and old
files in fl/.
This command may take some time to complete, and will fully block ncdc
while it is running. You won't have to perform this command very often.
This command may take some time to complete, and will fully block ncdc
while it is running. It is recommended to run this command every once in
a while. Every month is a good interval. Note that when ncdc says that it
has completed this command, it's lying to you. Ncdc will still run a few
large queries on the background, which may take up to a minute to com‐
plete.
/grant [-list|<user>]
Grant someone a slot. This allows the user to download from you even if
you have no free slots. The slot will be granted for as long as ncdc
Grant someone a slot. This allows the user to download from you even if
you have no free slots. The slot will be granted for as long as ncdc
stays open or the /ungrant command is used. If you restart ncdc, the user
will have to wait for a regular slot. Unless, of course, you /grant a
will have to wait for a regular slot. Unless, of course, you /grant a
slot again.
To get a list of users whom you have granted a slot, use `/grant' without
arguments or with `-list'. Be warned that using `/grant' without argu‐
ments on a PM tab will grant the slot to the user you are talking with.
arguments or with `-list'. Be warned that using `/grant' without argu‐
ments on a PM tab will grant the slot to the user you are talking with.
Make sure to use `-all' in that case.
Note that a granted slot is specific to a single hub. If the same user is
@ -162,20 +167,20 @@ INTERACTIVE COMMANDS
/kick <user>
Kick a user from the hub. This command only works on NMDC hubs, and you
Kick a user from the hub. This command only works on NMDC hubs, and you
need to be an OP to be able to use it.
/me <message>
This allows you to talk in third person. Most clients will display your
This allows you to talk in third person. Most clients will display your
message as something like:
** Nick is doing something
Note that this command only works correctly on ADC hubs. The NMDC proto‐
col does not have this feature, and your message will be sent as-is,
Note that this command only works correctly on ADC hubs. The NMDC proto‐
col does not have this feature, and your message will be sent as-is,
including the /me.
/msg <user> [<message>]
Send a private message to a user on the currently opened hub. If no mes‐
Send a private message to a user on the currently opened hub. If no mes‐
sage is given, the tab will be opened but no message will be sent.
/nick [<nick>]
@ -183,19 +188,19 @@ INTERACTIVE COMMANDS
/open [-n] <name> [<address>]
Opens a new tab to use for a hub. The name is a (short) personal name you
use to identify the hub, and will be used for storing hub-specific con‐
use to identify the hub, and will be used for storing hub-specific con‐
figuration.
If you have specified an address or have previously connected to a hub
from a tab with the same name, /open will automatically connect to the
If you have specified an address or have previously connected to a hub
from a tab with the same name, /open will automatically connect to the
hub. Use the `-n' flag to disable this behaviour.
See /connect for more information on connecting to a hub.
/password <password>
This command can be used to send a password to the hub without saving it
to the config file. If you wish to login automatically without having to
type /password every time, use '/set password <password>'. Be warned,
This command can be used to send a password to the hub without saving it
to the database. If you wish to login automatically without having to
type /password every time, use '/set password <password>'. Be warned,
however, that your password will be saved unencrypted in that case.
/pm <user> [<message>]
@ -208,24 +213,24 @@ INTERACTIVE COMMANDS
Quit ncdc. You can also just hit ctrl+c, which is equivalent.
/reconnect
Reconnect to the hub. When your nick or the hub encoding have been
Reconnect to the hub. When your nick or the hub encoding have been
changed, the new settings will be used after the reconnect.
This command can also be used on the main tab, in which case all con‐
This command can also be used on the main tab, in which case all con‐
nected hubs will be reconnected.
/refresh [<path>]
Initiates share refresh. If no argument is given, the complete list will
be refreshed. Otherwise only the specified directory will be refreshed.
The path argument can be either an absolute filesystem path or a virtual
Initiates share refresh. If no argument is given, the complete list will
be refreshed. Otherwise only the specified directory will be refreshed.
The path argument can be either an absolute filesystem path or a virtual
path within your share.
/say <message>
Sends a chat message to the current hub or user. You normally don't have
Sends a chat message to the current hub or user. You normally don't have
to use the /say command explicitly, any command not staring with '/' will
automatically imply `/say <command>'. For example, typing `hello.' in the
command line is equivalent to `/say hello.'. Using the /say command
explicitly may be useful to send message starting with '/' to the chat,
command line is equivalent to `/say hello.'. Using the /say command
explicitly may be useful to send message starting with '/' to the chat,
for example `/say /help is what you are looking for'.
/search [options] <query>
@ -239,7 +244,7 @@ INTERACTIVE COMMANDS
-t <t> File must be of type <t>. (see below)
-tth <h> TTH root of this file must match <h>.
File sizes (<s> above) accept the following suffixes: G (GiB), M (MiB)
File sizes (<s> above) accept the following suffixes: G (GiB), M (MiB)
and K (KiB).
The following file types can be used with the -t option:
@ -251,13 +256,13 @@ INTERACTIVE COMMANDS
6 img Image files.
7 video Video files.
8 dir Directories.
Note that file type matching is done using file extensions, and is not
Note that file type matching is done using file extensions, and is not
very reliable.
/set [<key> [<value>]]
Get or set configuration variables. Use without arguments to get a list
of all settings and their current value. Changes to the settings are
automatically saved to the config file, and will not be lost after
Get or set configuration variables. Use without arguments to get a list
of all settings and their current value. Changes to the settings are
automatically saved to the config file, and will not be lost after
restarting ncdc.
To get information on a particular setting, use `/help set <key>'.
@ -265,33 +270,35 @@ INTERACTIVE COMMANDS
/share [<name> <path>]
Use /share without arguments to get a list of shared directories.
When called with a name and a path, the path will be added to your share.
Note that shell escaping may be used in the name. For example, to add a
Note that shell escaping may be used in the name. For example, to add a
directory with the name `Fun Stuff', you could do the following:
/share "Fun Stuff" /path/to/fun/stuff
Or:
/share Fun\ Stuff /path/to/fun/stuff
The full path to the directory will not be visible to others, only the
name you give it will be public. An initial `/refresh' is done automati‐
The full path to the directory will not be visible to others, only the
name you give it will be public. An initial `/refresh' is done automati‐
cally on the added directory.
/ungrant [<username>|<id>]
Revoke a granted slot.
/unset [<key>]
This command can be used to reset a configuration variable back to its
This command can be used to reset a configuration variable back to its
default value.
/unshare [<name>]
To remove a single directory from your share, use `/unshare <name>', to
To remove a single directory from your share, use `/unshare <name>', to
remove all directories from your share, use `/unshare /'.
Note that all hash data for the removed directories will be thrown away.
All files will have to be re-hashed again when the directory is later re-
added.
Note that the hash data associated with the removed files will remain in
the database. This allows you to re-add the files to your share without
needing to re-hash them. The downside is that the database file may grow
fairly large with unneeded information. See the `/gc' command to clean
that up.
/userlist
Opens the user list of the currently selected hub. Can also be accessed
Opens the user list of the currently selected hub. Can also be accessed
using Alt+u.
/version
@ -304,46 +311,45 @@ INTERACTIVE COMMANDS
SETTINGS
The following is a list of configuration settings. These settings can be changed
and queried using the `/set' command, and are stored in the config.ini file in
and queried using the `/set' command, and are stored in the db.sqlite3 file in
the session directory.
active <boolean>
Enables or disables active mode. Make sure to set `active_ip' and
Enables or disables active mode. Make sure to set `active_ip' and
`active_port' before enabling active mode.
active_bind <string>
IP address to bind to in active mode. When unset, ncdc will bind to all
IP address to bind to in active mode. When unset, ncdc will bind to all
interfaces.
active_ip <string>
Your public IP address for use in active mode. It is important that other
clients can reach you using this IP address. If you connect to a hub on
the internet, this should be your internet (WAN) IP. Likewise, if you
clients can reach you using this IP address. If you connect to a hub on
the internet, this should be your internet (WAN) IP. Likewise, if you
connect to a hub on your LAN, this should be your LAN IP.
Note that this setting is global for ncdc: it is currently not possible
to use a single instance of ncdc to connect to both internet and LAN
hubs, if you are not reachable on the same IP with both networks. In that
case you can either use passive mode or run two separate instances of
ncdc.
Unlike the other connection-related settings, this can be changed on a
per-hub basis, allowing you to have a different public IP address per
hub.
active_port <integer>
The listen port for incoming connections in active mode. Set to `0' to
automatically assign a random port. If TLS support is available, another
TCP port will be opened on the configured port + 1. Ncdc will tell you
exactly on which ports it is listening for incoming packets. If you are
behind a router or firewall, make sure that you have configured it to
The listen port for incoming connections in active mode. Set to `0' to
automatically assign a random port. If TLS support is available, another
TCP port will be opened on the configured port + 1. Ncdc will tell you
exactly on which ports it is listening for incoming packets. If you are
behind a router or firewall, make sure that you have configured it to
forward and allow these ports.
autoconnect <boolean>
Set to true to automatically connect to the current hub when ncdc starts
Set to true to automatically connect to the current hub when ncdc starts
up.
autorefresh <integer>
The time between automatic file refreshes, in minutes. Set to 0 to dis‐
able automatically refreshing the file list. This setting also determines
whether ncdc will perform a refresh on startup. See the `/refresh' com‐
mand to manually refresh your file list.
autorefresh <interval>
The time between automatic file refreshes. Recognized suffices are 's'
for seconds, 'm' for minutes, 'h' for hours and 'd' for days. Set to 0 to
disable automatically refreshing the file list. This setting also deter‐
mines whether ncdc will perform a refresh on startup. See the `/refresh'
command to manually refresh your file list.
backlog <integer>
When opening a hub or PM tab, ncdc can load a certain amount of lines
@ -683,18 +689,17 @@ FILES
should be generated automatically when ncdc starts up the first time, but
can be generated manually using ncdc-gen-cert(1).
$NCDC_DIR/config.ini
Main configuration file. It is recommended to use commands within ncdc
instead of editing this file manually. In particular, do not edit this
file while ncdc is running, otherwise you will lose your changes.
$NCDC_DIR/db.sqlite3
The database. This stores all configuration variables, hash data of
shared files, download queue information and other state information.
Manually editing this file with the `sqlite3' commandline tool is possi‐
ble but discouraged. Any changes made to the database while ncdc is run‐
ning will not be read, and may even get overwritten by ncdc.
$NCDC_DIR/dl/
Directory where completed downloads are moved to by default. Can be
changed with the `download_dir' configuration option.
$NCDC_DIR/dl.dat
Stores information about the download queue.
$NCDC_DIR/files.xml.bz2
Filelist containing a listing of all shared files.
@ -704,9 +709,6 @@ FILES
ncdc. Old file lists are deleted automatically after a configurable
interval. See the `filelist_maxage' configuration option.
$NCDC_DIR/hashdata.dat
File information and hash data for shared files.
$NCDC_DIR/history
Command history.
@ -750,8 +752,8 @@ AUTHOR
SEE ALSO
ncdc-gen-cert(1).
ncdc-gen-cert(1), ncdc-db-upgrade(1).
ncdc-1.5 November 2011 ncdc(1)
ncdc-1.6 December 2011 ncdc(1)