-
Notifications
You must be signed in to change notification settings - Fork 74
/
README.html
230 lines (169 loc) · 19.9 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
<h1>EiskaltDC++ – file sharing program using Direct Connect protocols</h1>
<p>Website: <a href="https://github.com/eiskaltdcpp/eiskaltdcpp">https://github.com/eiskaltdcpp/eiskaltdcpp</a> <br>
Sources: <a href="https://github.com/eiskaltdcpp/eiskaltdcpp">https://github.com/eiskaltdcpp/eiskaltdcpp</a></p>
<p>Public chat room: https://gitter.im/eiskaltdcpp/eiskaltdcpp <br>
Wiki: https://github.com/eiskaltdcpp/eiskaltdcpp/wiki</p>
<h2>License</h2>
<p>This program is licensed under the GNU General Public License. See the <a href="https://github.com/eiskaltdcpp/eiskaltdcpp/blob/master/COPYING">COPYING</a> file for more information.</p>
<h2>Description</h2>
<p>EiskaltDC++ is a cross-platform program that uses the <a href="https://en.wikipedia.org/wiki/Direct_Connect_(protocol)">Direct Connect</a> (DC aka NMDC) and <a href="https://en.wikipedia.org/wiki/Advanced_Direct_Connect">Advanced Direct Connect</a> (ADC) protocols. It is compatible with DC++, AirDC++, FlylinkDC++ and other <a href="https://en.wikipedia.org/wiki/Comparison_of_ADC_software#Client_software">DC clients</a>. EiskaltDC++ also interoperates with all common DC hub software.</p>
<p>Currently supported systems (in order of decreasing importance): GNU/Linux, macOS, MS Windows, FreeBSD, Haiku and GNU/Hurd.</p>
<p>Currently supported features (not full list):</p>
<ul>
<li>Programs with graphical user interface (UI) on Qt (main) and GTK+ (alternative), plus daemon which may be controlled from command line or from Web UI (connected via JSON-RPC).</li>
<li>Multi-threaded download (download fragments of a single file from several sources at once).</li>
<li>Support of PFSR (partial file sharing): users may download parts of file from each other during file download even when no one of them do not have fully downloaded file.</li>
<li>Support of DHT (allows one to search file by TTH and exchange these files without connection to any hub). Implementation of this feature is based on StrongDC++ code and compatible with all versions of StrongDC++, ApexDC++, RSX++, FlylinkDC++ and Pulse++K where this feature exists. (Some DC clients have dropped the support of this function in latest versions.)</li>
<li>Support of UPnP (simplifies network connection configuration when user Wi-Fi router supports this feature).</li>
<li>Support of binding to specific network interface or address (in case when user system has few network connections simultaneously).</li>
<li>Support of auto updating of external IPv4 address via DynDNS services.</li>
<li>Support of case-sensitive file lists. This feature is extremely important on all supported systems except MS Windows (in fact even NTFS supports case-sensitive file names, but MS Windows does not use this feature.).</li>
<li>User interface is translated to many languages.</li>
<li>GUI programs allow to place list of widgets on sidebar, on multiline tabbar panel or on single-line tabbar.</li>
<li>GUI program based on Qt has support of hiding the program menu (it will be available by special button to the toolbar).</li>
<li>Advanced search with the ability to group results; black list for search results.</li>
<li>Lists of downloaded and uploaded files; ability to save logs of downloads.</li>
<li>Lists of public and favorite hubs. Public hubs lists have multiple sources; favorite hubs are extremely flexible in configuration features.</li>
<li>Lists of favorite users (they will receive extra slot for downloading files, etc.).</li>
<li>List of active transfers (downloads/uploads), including the queue of users waiting for the slot (user may temporary grant extra slot for them).</li>
<li>Flexible settings for downloading files (lists of destination directories, directory for incomplete downloads, limitation of number of simultaneous downloads, compressed transfers, check of check sums, etc.).</li>
<li>Indicator of free space on disk where main downloads directory is located.</li>
<li>Support of IP filter and basic antispam.</li>
<li>Search spy (allows one to see search phrases which send other users, but without identifying users of course).</li>
<li>ADL search with support for Perl-style regular expressions (using PCRE library).</li>
<li>Flexible filter (with regular expressions support) in users list, search results, public hubs lists, file lists, etc.. (Use ##<regexp> string and read about Qt QRegExp syntax.)</li>
<li>Full-featured chat (different fonts, nick coloring, parsing of magnet links and other links, emoticons, chat search, chat commands, BBCode support, disable/enable/clear chat, spell check (Aspell is used), keywords highlighting in the chat, separator for unread messages, saving of chat logs, the ability to display IP addresses and countries of users in the chat (depends on hub settings: some of them hide this data for usual users).</li>
<li>User commands on hub.</li>
<li>Secretary (allows you do not read tons of useless messages in many chats to find something interesting, for example, messages with magnet links or with keywords).</li>
<li>Flexible keyboard shortcuts settings.</li>
<li>Text and sound notifications for different events.</li>
<li>Highlighting of duplicates in shared files.</li>
<li>Flexible settings for files hashing (speed of hashing, filters for ignoring files, etc.).</li>
<li>Indicator of hashing progress in program status bar.</li>
<li>Special tool for calculating of TTH for any file (without necessity to share this file) and preparing magnet link or web maget link for it.</li>
<li>Support of limitations of download/upload speed (permanent or by timetable).</li>
<li>Support of limitations by size of shared files. (Yes, this is questionable feature, but it is highly demanded by users.)</li>
<li>Support of handling of magnet links, web magnet links and hub links transferred via command line from other programs (for example from web browsers).</li>
<li>Support of files drag-and-drop into field for entering messages (if file is present in user file list, magnet link to it will be added).</li>
<li>Support of automatic replies to private messages in case of user absent.</li>
<li>Support of user extensions on QtScript (only in Qt based GUI in GNU/Linux) and on Lua (in all supported systems).</li>
<li>Support of IDN2 (recognition of national domain names).</li>
<li>Support of URL encoded strings for hub addresses.</li>
<li>Support of traffic encryption.</li>
</ul>
<p><a href="https://tehnick.github.io/eiskaltdcpp/eiskaltdcpp-qt-2.2.10-588_search_widget.png" title="Example of search results">
<img src="https://tehnick.github.io/eiskaltdcpp/eiskaltdcpp-qt-2.2.10-588_search_widget.png" width="99%">
</a></p>
<h2>Versions history</h2>
<p>See <a href="https://github.com/eiskaltdcpp/eiskaltdcpp/blob/master/ChangeLog.txt">ChangeLog.txt</a> file.</p>
<h2>Installation</h2>
<p>For build from sources see <a href="https://github.com/eiskaltdcpp/eiskaltdcpp/blob/master/INSTALL">INSTALL</a> file.</p>
<p>GNU/Linux and FreeBSD users may install <a href="https://github.com/eiskaltdcpp/eiskaltdcpp#packages-and-installers">packages</a> from official and unofficial repositories, ports, etc.</p>
<p>macOS users may install and update official builds using <a href="https://brew.sh/">Homebrew</a> cask:</p>
<p><code>
brew install --cask eiskaltdcpp
</code></p>
<p>or download app bundles from <a href="https://github.com/eiskaltdcpp/eiskaltdcpp#packages-and-installers">SourceForge</a> and install them manually. Program doesn't have embedded mechanism of updates, so in this case users should monitor updates themselves.</p>
<p>Haiku users may install official package from HaikuPorts:</p>
<p><code>
pkgman install eiskaltdcpp
</code></p>
<p>MS Windows users may download official installers and portable builds from <a href="https://github.com/eiskaltdcpp/eiskaltdcpp#packages-and-installers">SourceForge</a>. Program doesn't have embedded mechanism of updates, so users should monitor updates themselves.</p>
<h2>Usage</h2>
<p>EiskaltDC++ is designed mostly for experienced users who know how DC works, which settings should be used with their type of network connection, etc.. This short introduction is not intended to describe such basic things.</p>
<p>Here are small recommendations for initial configuration after first launch of program:</p>
<ol>
<li>Open Preferences dialog and set nickname (it is important!), default encoding for DC hubs (for example, WINDOWS-1251 for Russian hubs), type of incoming connections (active mode, firewall with UPnP or passive mode) and downloads directory.</li>
<li>Open Public Hubs widget and connect to few popular public hubs (you may sort list by amount of users or by total amount of shared data).</li>
<li>Open Search widget and try to search any popular file. (Do not forget to use spaces as words separator.)</li>
<li>Add few hubs to list of Favourite hubs and enable auto connection to hubs during program startup.</li>
<li>Program settings will be saved on program exit.</li>
</ol>
<p>All programs from EiskaltDC++ project (<code>eiskaltdcpp-qt</code>, <code>eiskaltdcpp-gtk</code> and <code>eiskaltdcpp-daemon</code>) use the same common settings. So once you have correctly configured connections in EiskaltDC++ Qt, for example, you may launch <code>eiskaltdcpp-daemon</code> and use Web UI for ruling it (search files, add them to downloads queue, etc.).</p>
<h2>Development</h2>
<p>During the development EiskaltDC++ in past years we have used different CVS (Subversion first and then Git) and different development models. Currently the process looks like this:</p>
<ul>
<li>All development of is done in git <code>work</code> branch or special (feature) branches detached from <code>work</code> branch.</li>
<li>Changelog file should be updated together with changes in source code. It may be done in a same git commit or in a separate git commit depending on situation. Just use common sense for this. (There were no rule of updating change log in the past which leads to significant delaying of stable releases.)</li>
<li>Once the changes from <code>work</code> branch are ready for usage and build of program is tested for most important systems (Linux, macOS, Windows) they may be merged to <code>master</code> branch.</li>
<li>Daily builds of program for testers, active users and just curious people should be done from git <code>master</code> branch.</li>
<li>Version scheme for builds from git snapshots should look like: <code><major>.<minor>.<patch>-<commits>-g<hash></code> (where <code><major></code>, <code><minor></code> and <code><patch></code> are not digits but numbers). <code><major>.<minor>.<patch></code> is last git tag (for stable release), <code><commits></code> – the number of commits since last git tag and <code><hash></code> – short hash of current git commit.</li>
<li>Once there is noticeable amount of changes since last stable release or if there are very important bug fixes which should be quickly delivered to users new git tag (<code>v<major>.<minor>.<patch></code>) is created and tarballs with sources are uploaded to SourceForge.</li>
<li>In case of noticeable changes in Core of program (library libeiskaltdcpp) the <code><minor></code> or <code><major></code> part of program version should be changed.</li>
<li>In case of significant changes (for example, total code refactoring) in any part of program the <code><minor></code> or <code><major></code> part of program version should be changed.</li>
<li>In case when where are very few changes since last stable release, but they are important and should be quickly delivered to users the <code><patch></code> part of program version should be changed.</li>
<li>There are no limits for changes suitable for a new <code><patch></code> releases if they do not affect Core of program: they may contain new features and noticeable changes in any part of GUI.</li>
</ul>
<p>During development all changes are tested on Continuous Integration services <a href="https://travis-ci.com/github/eiskaltdcpp/eiskaltdcpp">Travis CI</a> and <a href="https://sibuserv-ci.org/projects/eiskaltdcpp">Sibuserv CI</a>.</p>
<h2>Developers</h2>
<h3>Main developers</h3>
<ul>
<li>Main developers of EiskaltDC++ are listed in <a href="https://github.com/eiskaltdcpp/eiskaltdcpp/blob/master/AUTHORS">AUTHORS</a> file.</li>
<li>Program contains source code from other free and and open-source projects. All copyright information from them is pedantically documented in <a href="https://github.com/eiskaltdcpp/eiskaltdcpp/blob/master/full.copyrights.info.in.Debian.style">special file</a>.</li>
<li>Part of program with GTK+ UI contains additional <a href="https://github.com/eiskaltdcpp/eiskaltdcpp/blob/master/eiskaltdcpp-gtk/Credits.txt">Credits.txt</a> file. (This is just a list of contributors from LinuxDC++ and FreeDC++ projects, not all of them are copyright holders.)</li>
</ul>
<h3>Other contributors</h3>
<p>There are a lot of people who were involved into EiskaltDC++ development. Some of them are listed in license headers in source files, some of them might be found only in the history of commits in our git repository. Also there are <a href="https://github.com/eiskaltdcpp/eiskaltdcpp/blob/master/AUTHORS">translators</a>, testers and just active users. We are thankful to all them!</p>
<h2>How you can help</h2>
<h3>Bug reports</h3>
<p>If you found a bug please report about it in our <a href="https://github.com/eiskaltdcpp/eiskaltdcpp/issues">Bug Tracker</a>.</p>
<h3>Beta testing</h3>
<p>You may use daily builds of program or program compiled from sources by yourself (from git <code>master</code> branch) for testing and suggesting of new features, and for reporting about new bugs (if they happen).</p>
<h3>Comments and wishes</h3>
<p>We like constructive comments and wishes to functions of program. You may contact with us in public chat room for discussing of your ideas. Some of them will be drawn up as feature requests in our <a href="https://github.com/eiskaltdcpp/eiskaltdcpp/issues">Bug Tracker</a>.</p>
<h3>Translations</h3>
<p>The work of translators is quite routine and boring. People who do it usually lose interests and their translations become incomplete. If you see such situation for translation to your native language, please join to our <a href="https://www.transifex.com/tehnick/eiskaltdcpp/">translations team</a>. It is extremely welcome!</p>
<p>Some useful notes about translation process you may find at <a href="https://github.com/eiskaltdcpp/eiskaltdcpp/wiki/Translations">special wiki page</a>.</p>
<h3>Graphics</h3>
<p>There are many ways to contribute to the EiskaltDC++ project, if you think you can do a better job with any of the EiskaltDC++ graphics, then go right ahead!</p>
<h3>Programming</h3>
<p>Patches are welcome! Contact to EiskaltDC++ developers if you are working on them.</p>
<h3>Packaging</h3>
<p>Currently we have active package maintainers for Debian and Ubuntu distros, for macOS and MS Windows. If you have suggestions about improving of packaging, just contact with them.</p>
<p>If you want to prepare personal builds of EiskaltDC++ for MS Windows and macOS systems, it is very welcome! We may add links to them into our documentation. Becoming an official maintainer for these systems is more complicated, but also possible.</p>
<p>For other GNU/Linux and *BSD systems the situation is quite clear: just update packages (pkgbuilds, ebuild, etc.) in official repositories of your favorite distributions or make a Personal Package Archive (PPA) with them. We will add links to them into our documentation.</p>
<h3>Donations</h3>
<p>We do not accept donations for EiskaltDC++ project as a whole, because there are no expenditures for infrastructure and such like. (Thanks to owners of GitHub, SourceForge, Transifex and Travis CI services for their support of FOSS projects!)</p>
<p>But you may send donations to project contributors (developers, maintainers, translators, etc.) on personal basis. Just contact with them using the contact information from <a href="https://github.com/eiskaltdcpp/eiskaltdcpp/blob/master/AUTHORS">AUTHORS</a> file.</p>
<h2>Packages and installers</h2>
<ul>
<li><a href="https://launchpad.net/~tehnick/+archive/ubuntu/direct-connect">Official PPA for Ubuntu and distros based on it</a> (stable releases)</li>
<li><a href="https://launchpad.net/~tehnick/+archive/ubuntu/direct-connect-devel">Official PPA for Ubuntu and distros based on it</a> (daily builds)</li>
<li><a href="https://snapcraft.io/eiskaltdcpp">Official Snap packages for Ubuntu and other distros</a> (daily builds)</li>
<li><a href="https://sourceforge.net/projects/eiskaltdcpp/files/Windows/">Official builds for Windows</a></li>
<li><a href="https://sourceforge.net/projects/eiskaltdcpp/files/macOS/">Official builds for macOS</a></li>
<li><a href="https://sourceforge.net/projects/eiskaltdcpp/files/Linux/">Official builds for Linux</a></li>
<li><a href="https://tracker.debian.org/pkg/eiskaltdcpp">Official packages in Debian</a></li>
<li><a href="https://launchpad.net/ubuntu/+source/eiskaltdcpp">Official packages in Ubuntu</a></li>
<li><a href="https://src.fedoraproject.org/rpms/eiskaltdcpp">Official packages in Fedora</a></li>
<li><a href="https://packages.gentoo.org/packages/net-p2p/eiskaltdcpp">Official packages in Gentoo Linux</a></li>
<li><a href="https://packages.altlinux.org/en/sisyphus/srpms/eiskaltdcpp">Official packages in ALT Linux</a></li>
<li><a href="https://depot.haiku-os.org/eiskaltdcpp">Official packages in Haiku</a></li>
<li><a href="https://www.freshports.org/search.php?query=eiskaltdcpp">Official packages in FreeBSD</a></li>
<li><a href="https://software.opensuse.org/package/eiskaltdcpp">Packages for openSUSE</a> (official and unofficial)</li>
<li><a href="https://aur.archlinux.org/packages?K=eiskaltdcpp">Packages for Arch Linux</a> (in AUR)</li>
<li><a href="https://repology.org/metapackage/eiskaltdcpp/versions">Packages for different Linux distros</a> (the best aggregator of links)</li>
<li><a href="https://pkgs.org/download/eiskaltdcpp">Packages for different Linux distros</a> (alternative aggregator of links)</li>
<li><a href="https://notesalexp.org/debian/index-old.html">Unofficial PPA for Debian and Ubuntu</a> (maintained by Alex_P)</li>
<li><a href="https://ports.macports.org/port/eiskaltdcpp/details">MacPorts (macOS 10.5+)</a></li>
</ul>
<h2>Extra links</h2>
<ul>
<li><a href="https://github.com/eiskaltdcpp/eiskaltdcpp/graphs/contributors">Project statistics on GitHub</a></li>
<li><a href="https://www.openhub.net/p/eiskaltdcpp">Project statistics on OpenHub</a></li>
<li><a href="https://github.com/eiskaltdcpp/freedcpp">Project FreeDC++ (was basis of eiskaltdcpp-gtk)</a> (sources)</li>
<li><a href="https://github.com/eiskaltdcpp/eiskaltdcpp-web">Official Web UI for eiskaltdcpp-daemon</a> (sources)</li>
<li><a href="https://github.com/eiskaltdcpp/icecult">Alternative Web UI for eiskaltdcpp-daemon </a> (sources)</li>
<li><a href="https://tehnick.github.io/eiskaltdcpp/en/screenshots.html">Old screenshots</a> (in English)</li>
<li><a href="https://tehnick.github.io/eiskaltdcpp/screenshots.html">Old screenshots</a> (in Russian)</li>
<li><a href="https://tehnick.github.io/eiskaltdcpp/">Old notes about EiskaltDC++</a> (in Russian)</li>
<li><a href="https://tehnick.github.io/freedcpp/">Old notes about FreeDC++</a> (in Russian)</li>
<li><a href="https://tehnick.github.io/eiskaltdcpp/faq.html">Old FAQ about EiskaltDC++</a> (in Russian)</li>
<li><a href="https://tehnick.github.io/dc_clients/magnet-links.html">Setting up interception of magnet links from web browsers</a> (in Russian)</li>
<li><a href="https://tehnick.github.io/dc_clients/">Review of DC clients for Linux</a> (in Russian)</li>
<li><a href="https://en.wikipedia.org/wiki/DC%2B%2B">DC++ and programs based on it at Wikipedia</a> (in English)</li>
<li><a href="https://ru.wikipedia.org/wiki/DC%2B%2B">DC++ and programs based on it at Wikipedia</a> (in Russian)</li>
<li><a href="https://en.wikipedia.org/wiki/Valknut_(software)">Valknut and programs based on it at Wikipedia</a> (in English)</li>
<li><a href="https://ru.wikipedia.org/wiki/EiskaltDC%2B%2B">EiskaltDC++ at Wikipedia</a> (in Russian)</li>
</ul>
<p>Have fun!</p>