debian: fix build-deps for focal
[amule.git] / docs / man / amule.1
blob0b12c355d04c8ebacee63fb422df21b1e6e9a2e6
1 .TH AMULE 1 "September 2016" "aMule v2.3.2" "aMule"
2 .als B_untranslated B
3 .als RB_untranslated RB
4 .SH NAME
5 amule \- the all\-platform eMule p2p client
6 .SH SYNOPSIS
7 .B_untranslated amule
8 .RB [ \-c " " \fI<path> ]
9 .RB [ \-geometry " " \fI<geom> ]
10 .RB_untranslated [ \-o ]
11 .RB_untranslated [ \-r ]
12 .RB [ \-w " " \fI<path> ]
13 .RB_untranslated [ \-d ]
14 .RB_untranslated [ \-i ]
15 .RB [ \-t " " \fI<num> ]
16 .RI [ eD2k-link ]
18 .B_untranslated amule
19 .RB_untranslated [ \-v ]
21 .B_untranslated amule
22 .RB_untranslated [ \-h ]
24 .SH DESCRIPTION
25 .TP
26 \fB[ \-c\fR \fI<path>\fR, \fB\-\-config\-dir\fR=\fI<path>\fR \fB]\fR
27 Read config from \fI<path>\fR instead of home
28 .TP
29 \fB[ \-geometry \fI<geom>\fR \fB]\fR
30 Sets the geometry of the app. \fI<geom>\fR uses the same format as standard X11 apps:   [\fB=\fR][\fI<width>\fR{\fBxX\fR}\fI<height>\fR][{\fB+-\fR}\fI<xoffset>\fR{\fB+-\fR}\fI<yoffset>\fR]
31 .TP
32 .B_untranslated [ \-o\fR, \fB\-\-log\-stdout ]\fR
33 Prints log messages to stdout.
34 .TP
35 .B_untranslated [ \-r\fR, \fB\-\-reset\-config ]\fR
36 Resets config to default values.
37 .TP
38 \fB[ \-w\fR \fI<path>\fR, \fB\-\-use\-amuleweb\fR=\fI<path>\fR \fB]\fR
39 Specify location of amuleweb binary to \fI<path>\fR.
40 .TP
41 .B_untranslated [ \-d\fR, \fB\-\-disable\-fatal ]\fR
42 Does not handle fatal exception.
43 .TP
44 .B_untranslated [ \-i\fR, \fB\-\-enable\-stdin ]\fR
45 Does not disable stdin.
46 .TP
47 \fB[ \-t\fR, \fB\-\-category\fR=\fI<num>\fR \fB]\fR
48 Set category for passed eD2k links to \fI<num>\fR
49 .TP
50 .B_untranslated [ \-v\fR, \fB\-\-version ]\fR
51 Displays the current version number.
52 .TP
53 .B_untranslated [ \-h\fR, \fB\-\-help ]\fR
54 Prints a short usage description.
55 .TP
56 \fB[ eD2k-link ]\fR
57 Adds an eD2k-link to the core.
58 .PP
59 The eD2k link to be added can be:
60 .RS 3
61 .IP \(bu 2
62 a file link (ed2k://|file|...), it will be added to the download queue;
63 .IP \(bu 2
64 a server link (ed2k://|server|...), it will be added to the server list;
65 .IP \(bu 2
66 a serverlist link, in which case all servers in the list will be added to the server list;
67 .IP \(bu 2
68 a magnet link.
69 .RE
70 .SH NOTES
71 .SS Paths
72 For all options which take a \fI<path>\fR value, if the \fIpath\fR contains no
73 directory part (i.e. just a plain filename), then it is considered to be under
74 the aMule configuration directory, \fI~/.aMule\fR.
75 .SH FILES
76 ~/.aMule/*
77 .SH REPORTING BUGS
78 Please report bugs either on our forum (\fIhttp://forum.amule.org/\fR), or in our bugtracker (\fIhttp://bugs.amule.org/\fR).
79 Please do not report bugs in e-mail, neither to our mailing list nor directly to any team member.
80 .SH COPYRIGHT
81 aMule and all of its related utilities are distributed under the GNU General Public License.
82 .SH SEE ALSO
83 .B_untranslated alc\fR(1), \fBalcc\fR(1), \fBamuled\fR(1), \fBamulecmd\fR(1), \fBamulegui\fR(1), \fBamuleweb\fR(1), \fBcas\fR(1), \fBed2k\fR(1), \fBwxcas\fR(1), \fBxas\fR(1)
84 .SH AUTHOR
85 This manpage was written by Vollstrecker <amule@vollstreckernet.de>