yhdev/dat/ncdc
Yorhel b7746b3122 Redesigned and rewrote the website
Moved most pages out of the index.cgi and into a POD file while I was at
it.
2012-01-17 20:23:53 +01:00

120 lines
3.1 KiB
Text

=pod
Ncdc is a modern and lightweight direct connect client with a friendly
ncurses interface.
=head2 Get ncdc!
=over
=item Latest version
1.7 ([dllink ncdc-1.7.tar.gz download]
- L<changes|http://dev.yorhel.nl/ncdc/changes>
- L<mirror|https://sourceforge.net/projects/ncdc/files/ncdc/>)
=item Development version
The latest development version is available from git and can be cloned using
C<git clone git://g.blicky.net/ncdc.git>. The repository is available for
L<online browsing|http://g.blicky.net/ncdc.git/>.
You are also invited to join the development hub at C<adc://dc.blicky.net:2780/>.
=item Packages and ports
Are available for the following systems:
L<Arch Linux|http://aur.archlinux.org/packages.php?ID=50949> -
L<FreeBSD|http://www.freshports.org/net-p2p/ncdc/> -
L<Frugalware|http://frugalware.org/packages/136807> -
L<Gentoo|http://packages.gentoo.org/package/net-p2p/ncdc> -
L<Mac OS X|http://www.macports.org/ports.php?by=name&substr=ncdc> -
L<OpenSUSE|http://packman.links2linux.org/package/ncdc>
=back
=head2 Features
Common features all modern DC clients (should) have:
=over
=item * Connecting to multiple hubs at the same time,
=item * Support for both ADC and NMDC protocols,
=item * Chatting and private messaging,
=item * Browsing the user list of a connected hub,
=item * Share management and file uploading,
=item * Connections and download queue management,
=item * File list browsing,
=item * Multi-source and TTH-checked file downloading,
=item * Searching for files,
=item * Secure hub (adcs:// and nmdcs://) and client connections on both protocols.
=back
And special features not commonly found in other clients:
=over
=item * Subdirectory refreshing,
=item * Nick notification and highlighting in chat windows,
=item * Detecting changes to the TLS certificate of a hub,
=item * Efficient file uploads using sendfile(),
=item * Large file lists are opened in a background thread,
=item * Doesn't trash your OS file cache (with the flush_file_cache option enabled),
=item * (Relatively...) low memory usage.
=back
=head2 What doesn't ncdc do?
Since the above list is getting larger and larger every time, it may be more
interesting to list a few features that are (relatively) common in other DC
clients, but which ncdc doesn't do. Yet.
=over
=item * Segmented downloading,
=item * Bandwidth throttling,
=item * OP features (e.g. client detection, file list scanning and other useful stuff for OPs),
=item * SOCKS support.
=back
Of course, there are many more features that could be implemented or improved.
These will all be addressed in later versions (hopefully :).
=head2 Requirements
The following libraries are required: ncurses, bzip2, sqlite3, glib2 and
libxml2. For TLS support, you will need at least glib2 version 2.28.0 and
glib-networking installed.
Ncdc has been developed on Arch Linux, but I have received reports from people
who successfully used it on CentOS, Debian, FreeBSD, Gentoo, Mac OS X,
OpenSUSE, Solaris and Ubuntu. It should be fairly trivial to port to other
POSIX-like systems.
Ncdc is entirely written in C and available under a liberal MIT license.