Raised minimum version to 3.13 to silence warnings while detecting boost.
[amule.git] / docs / man / ed2k.1
blob5ee2bd642dbf217f099df2c72c8c90c1553b069d
1 .TH ED2K "1" "September 2016" "aMule eD2k link parser v1.5.1" "aMule utilities"
2 .als B_untranslated B
3 .als RB_untranslated RB
4 .SH NAME
5 ed2k \- aMule eD2k link parser
6 .SH SYNOPSIS
7 .B_untranslated ed2k
8 .RB [ \-c " " \fI<path> ]
9 .RB [ \-t " " \fI<num> ]
10 .RB_untranslated [ \-e ]
11 .RB_untranslated [ \-l ]
12 .I <eD2k-link>
14 .B_untranslated ed2k
15 .RB_untranslated [ \-h ]
17 .B_untranslated ed2k
18 .RB_untranslated [ \-v ]
19 .SH DESCRIPTION
20 Sends the given \fI<eD2k-link>\fR to aMule, i.e. writes it to the file ~/.aMule/ED2KLinks, which will be checked by aMule every second for links.
21 .TP
22 \fB[ \-c\fR \fI<path>\fR, \fB\-\-config\-dir\fR=\fI<path>\fR \fB]\fR
23 Read config from \fI<path>\fR instead of home
24 .TP
25 \fB[ \-t\fR, \fB\-\-category\fR=\fI<num>\fR \fB]\fR
26 Set category for passed eD2k links to \fI<num>\fR
27 .TP
28 .B_untranslated [ \-e\fR, \fB\-\-emulecollection ]\fR
29 Loads all link found in the emulecollection given as \fI<ed2k-link>\fR
30 .TP
31 .B_untranslated [ \-l\fR, \fB\-\-list ]\fR
32 Lists all link found in the emulecollection given as \fI<ed2k-link>\fR
33 .TP
34 .B_untranslated [ \-h\fR, \fB\-\-help ]\fR
35 Prints a short usage description.
36 .TP
37 .B_untranslated [ \-v\fR, \fB\-\-version ]\fR
38 Displays the current version number.
39 .TP
40 \fB[ eD2k-link ]\fR
41 Adds an eD2k-link to the core.
42 .PP
43 The eD2k link to be added can be:
44 .RS 3
45 .IP \(bu 2
46 a file link (ed2k://|file|...), it will be added to the download queue;
47 .IP \(bu 2
48 a server link (ed2k://|server|...), it will be added to the server list;
49 .IP \(bu 2
50 a serverlist link, in which case all servers in the list will be added to the server list;
51 .IP \(bu 2
52 a magnet link;
53 .IP \(bu 2
54 an emulecollection file.
55 .RE
57 \fBThe order in which you give the parameters is important.\fR
58 You can give more than one link, and every link can have it's own params.
59 For example \fBed2k <link1> -t2 <link2>\fR will download \fI<link1>\fR in standard category and \fI<link2>\fR in category 2.
60 .SH FILES
61 ~/.aMule/ED2KLinks
62 .SH REPORTING BUGS
63 Please report bugs either on our forum (\fIhttp://forum.amule.org/\fR), or in our bugtracker (\fIhttp://bugs.amule.org/\fR).
64 Please do not report bugs in e-mail, neither to our mailing list nor directly to any team member.
65 .SH COPYRIGHT
66 aMule and all of its related utilities are distributed under the GNU General Public License.
67 .SH SEE ALSO
68 .B_untranslated amule\fR(1)
69 .SH AUTHOR
70 This manpage was written by Vollstrecker <amule@vollstreckernet.de>