Upstream tarball 9935
[amule.git] / docs / man / ed2k.1
blobb78768be1858922fb5d1bd02ea4a1a0bc0b668d1
1 .TH ED2K "1" "January 2010" "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 .RB_untranslated <eD2k-Link>
14 .B_untranslated ed2k
15 .RB_untranslated [ \-h ]
17 .B_untranslated ed2k
18 .RB_untranslated [ \-v ]
19 .SH DESCRIPTION
20 .TP
21 aMule eD2k link parser v1.5.1.
22 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.
23 .TP
24 \fB[ \-c\fR \fI<path>\fR, \fB\-\-config\-dir\fR=\fI<path>\fR \fB]\fR
25 Read config from \fI<path>\fR instead of home
26 .TP
27 \fB[ \-t\fR, \fB\-\-category\fR=\fI<num>\fR \fB]\fR
28 Set category for passed eD2k links to \fI<num>\fR
29 .TP
30 .B_untranslated [ \-e\fR, \fB\-\-emulecollection ]\fR
31 Loads all link found in the emulecollection given as \fI<ed2k-link>\fR
32 .TP
33 .B_untranslated [ \-l\fR, \fB\-\-list ]\fR
34 Lists all link found in the emulecollection given as \fI<ed2k-link>\fR
35 .TP
36 .B_untranslated [ \-h\fR, \fB\-\-help ]\fR
37 Prints a short usage description.
38 .TP
39 .B_untranslated [ \-v\fR, \fB\-\-version ]\fR
40 Displays the current version number.
41 .TP
42 .TP
43 \fB[ eD2k-Link ]\fR
44 Adds an eD2k-link to the core.
45 .TP
46 The eD2k link to be added can be:
47 .2TP
48 *) a file link (ed2k://|file|...), it will be added to the download queue;
50 .2TP
51 *) a server link (ed2k://|server|...), it will be added to the server list;
53 .2TP
54 *) a serverlist link, in which case all servers in the list will be added to the server list;
56 .2TP
57 *) a magnet link;
59 .2TP
60 *) an emulecollection file;
61 .TP
62 \fBThe order in which you give the parameters is important.\fR
63 You can give more than one link, and every link can have it's own params.
64 For example \fBed2k <link1> -t2 <link2>\fR will download \fI<link1>\fR in standard category and \fI<link2>\fR in category 2.
65 .SH FILES
66 ~/.aMule/ED2KLinks
67 .SH REPORTING BUGS
68 Please report bugs either on our forum (\fIhttp://forum.amule.org/\fR), or in our bugtracker (\fIhttp://bugs.amule.org/\fR).
69 Please do not report bugs in e-mail, neither to our mailing list nor directly to any team member.
70 .SH COPYRIGHT
71 aMule and all of its related utilities are distributed under the GNU General Public License.
72 .SH SEE ALSO
73 .B_untranslated amule\fR(1)
74 .SH AUTHOR
75 This manpage was written by Vollstrecker <amule@vollstreckernet.de>