| blob | 3609d3b28f8ca5bb173c1c38fb2bb47f95ccfa6c |
1 .TH AMULECMD 1 "January 2010" "aMuleCmd v2.2.6" "aMule utilities"
2 .als B_untranslated B
3 .als RB_untranslated RB
4 .SH NAME
5 amulecmd \- Console-based program to control aMule
6 .SH SYNOPSIS
7 .B_untranslated amulecmd
8 .RB [ \-h " " \fI<host> ]
9 .RB [ \-p " " \fI<port> ]
10 .RB [ \-P " " \fI<password> ]
11 .RB [ \-f " " \fI<path> ]
12 .RB_untranslated [ \-q ]
13 .RB_untranslated [ \-v ]
14 .RB [ \-l " " \fI<lang> ]
15 .RB { " " [ \-w ] " " | " " [ \-c " " \fI<command> ] " " }
17 .B_untranslated amulecmd
18 .RB [ \-\-create\-config\-from " " \fI<path> ]
20 .B_untranslated amulecmd
21 .RB_untranslated [ \-\-version ]
23 .B_untranslated amulecmd
24 .RB_untranslated [ \-\-help ]
25 .SH DESCRIPTION
26 .B_untranslated amulecmd
27 is a console-based client to control aMule.
28 .TP
29 \fB[ \-h\fR \fI<host>\fR, \fB\-\-host\fR=\fI<host>\fR \fB]\fR
30 Host where aMule is running (default: \fIlocalhost\fR).
31 \fI<host>\fR might be an IP address or a DNS name
32 .TP
33 \fB[ \-p\fR \fI<port>\fR, \fB\-\-port\fR=\fI<port>\fR \fB]\fR
34 aMule's port for External Connections, as set in Preferences->Remote Controls (default: \fI4712\fR)
35 .TP
36 \fB[ \-P\fR \fI<password>\fR, \fB\-\-password\fR=\fI<password>\fR \fB]\fR
37 External Connections password.
38 .TP
39 \fB[ \-f\fR \fI<path>\fR, \fB\-\-config\-file\fR=\fI<path>\fR \fB]\fR
40 Use the given configuration file.
41 Default configuration file is \fI~/.aMule/remote.conf\fR
42 .TP
43 .B_untranslated [ \-q\fR, \fB\-\-quiet ]\fR
44 Do not print any output to stdout.
45 .TP
46 .B_untranslated [ \-v\fR, \fB\-\-verbose ]\fR
47 Be verbose \-
48 show also debug messages.
49 .TP
50 \fB[ \-l\fR \fI<lang>\fR, \fB\-\-locale\fR=\fI<lang>\fR \fB]\fR
51 Sets program locale (language).
52 See section \fBLANGUAGES\fR for the description of the \fI<lang>\fR parameter.
53 .TP
54 .B_untranslated [ \-w\fR, \fB\-\-write\-config ]\fR
55 Write command line options to config file and exit
56 .TP
57 \fB[ \-c\fR \fI<command>\fR, \fB\-\-command\fR=\fI<command>\fR \fB]\fR
58 Execute \fI<command>\fR as if it was entered at amulecmd's prompt and exit.
59 .TP
60 \fB[ \-\-create\-config\-from\fR=\fI<path>\fR \fB]\fR
61 Create config file based upon \fI<path>\fR, which must point to a valid aMule config file, and then exit
62 .TP
63 .B_untranslated [ \-v\fR, \fB\-\-version ]\fR
64 Displays the current version number.
65 .TP
66 .B_untranslated [ \-h\fR, \fB\-\-help ]\fR
67 Prints a short usage description.
68 .SH COMMANDS
69 All commands are case insensitive.
70 .SS \fBAdd\fR \fI<eD2k-link>\fR \fB|\fR \fI<magnet-link>\fR
71 Adds an eD2k-link or an magnet-link to the core.
72 .TP
73 The eD2k link to be added can be:
74 .2TP
75 *) a file link (ed2k://|file|...), it will be added to the download queue;
77 .2TP
78 *) a server link (ed2k://|server|...), it will be added to the server list;
80 .2TP
81 *) a serverlist link, in which case all servers in the list will be added to the server list;
83 .TP
84 The magnet link must contain the eD2k hash and file length.
85 .TP
86 This command must have an argument.
87 .SS \fBCancel\fR \fI<hash>\fR \fB|\fR \fI<number>\fR
88 Cancels the download specified by \fI<hash>\fR or \fI<number>\fR. To get the value use \fIshow\fR.
89 .SS \fBConnect\fR \fB[\fR \fIkad\fR \fB|\fR \fIed2k\fR \fB|\fR \fI<ip|name>\fR \fB]\fR
90 Connect to the network.
92 This will connect to all networks that are enabled in Preferences.
94 When giving ed2k as parameter, it connects only to eD2k-network to servers in your
95 serverlist. You may also optionally specify a server address in IP:Port form, to
96 connect to that server only. The IP must be a dotted decimal IPv4 address, or a
97 resolvable DNS name.
99 When giving kad, it connects to Kad only.
100 .SS \fBDisconnect\fR \fB[\fR \fI<ed2k>\fR \fB|\fR \fI<kad>\fR \fB]\FR
102 Disconnect from all networks you are connected to, or just disconnect from the
103 specified network.
104 .SS \fBDownload\fR \fI<number>\fR
105 Start downloading a file.
107 The \fI<number>\fR of a file from the last search has to be given.
108 Example: 'download 12' will start to download the file with the number 12 of the
109 previous search.
111 This command must have an argument.
112 .SS \fBExit\fR
113 Disconnect from amule/amuled and quit amulecmd.
114 .SS \fBGet\fR \fI<value>\fR
115 .TP
116 Get and display a preference value.
117 .TP
118 This command is incomplete, available values are listed below.
119 .TP
120 Available values:
121 .2TP
122 BwLimits
123 \[u0009] Get
124 bandwidth limits.
126 .2TP
127 IPFilter
128 \[u0009] Get
129 IPFilter preferences.
130 .SS \fBHelp [\fR \fI<command>\fR \fB]\fR
131 Prints a short usage description.
132 If called without parameter, it shows a list of available commands.
133 If called with \fI<command>\fR, it shows a short description of the given command.
134 .SS \fBPause\fR \fI<hash>\fR \fB|\fR \fI<number>\fR
135 Pauses the download specified by \fI<hash>\fR or \fI<number>\fR. To get the value use \fIshow\fR.
136 .SS \fBPriority\fR \fI<priority>\fR
137 .TP
138 Set priority of a download to Low, Normal, High or Auto.
139 .TP
140 This command must have an argument.
141 .TP
142 This command is incomplete, available values are listed below.
143 .TP
144 Available values:
145 .2TP
146 Auto
147 \[u0009] Set priority to auto.
149 .2TP
150 High
151 \[u0009] Set priority to high.
153 .2TP
154 Low
155 \[u0009] Set priority to low.
157 .2TP
158 Normal
159 \[u0009] Set priority to normal.
160 .SS \fBProgress\fR
161 Shows the progress of an on\-going search.
163 This command can't have an argument.
164 .SS \fBQuit\fR
165 Exits the App.
167 This command can't have an argument.
168 .SS \fBReload\fR \fI<object>\fR
169 .TP
170 Reloads a given object.
171 .TP
172 This command is incomplete, available values are listed below.
173 .TP
174 Available values:
175 .2TP
176 BwLimits
177 \[u0009] Reload
178 bandwidth limits.
180 .2TP
181 IPFilter
182 \[u0009] Reload
183 IPFilter preferences.
184 .SS \fBReset\fR
185 Reset the log.
187 This command can't have an argument.
188 .SS Results\fR
189 Shows you the results of the last search.
191 This command can't have an argument.
192 .SS \fBResume\fR \fI<hash>\fR \fB|\fR \fI<number>\fR
193 Resumes the download specified by \fI<hash>\fR or \fI<number>\fR. To get the value use \fIshow\fR.
194 .SS \fBSearch\fR \fIglobal\fR \fB|\fR \fIkad\fR \fB|\fR \fIlocal\fR \fI<file>\fR
195 Makes a search for the given \fI<file>\fR. A searchtype and a file to search is mandatory to do this.
196 \fIExample\fR 'search kad amule' performs a kad search for amule.
197 .TP
198 Available values:
199 .2TP
200 global
201 \[u0009] performs a global search
203 .2TP
204 kad
205 \[u0009] performs a search on kad network
207 .2TP
208 local
209 \[u0009] performs a local search
210 .SS \fBSet\fR \fI<value>\fR
211 Sets a given preferences value.
213 This command is incomplete, available values are listed below.
214 .TP
215 Available values:
216 .2TP
217 BwLimits
218 \[u0009] Set
219 bandwidth limits.
221 .2TP
222 IPFilter
223 \[u0009] Set
224 IPFilter preferences.
225 .SS \fBShow\fR \fIDL\fR \fB|\fR \fILog\fR \fB|\fR \fIServers\fR \fB|\fR \fIUL\fR
226 Shows upload/download queue, servers list or shared files list.
228 This command must have an argument.
230 This command is incomplete, available values are listed below.
231 .TP
232 Available values:
233 .2TP
234 DL
235 \[u0009] Show download queue.
237 .2TP
238 Log
239 \[u0009] Show log.
241 .2TP
242 Servers
243 \[u0009] Show servers list.
245 .2TP
246 UL
247 \[u0009] Show upload queue.
248 .SS \fBShutdown\fR
249 Shutdown the remote running core (amule/amuled).
250 This will also shut down the text client, since it is unusable without a running core.
252 This command can't have an argument.
253 .SS \fBStatistics\fR <number>
254 Show statistics tree.
256 The optional \fInumber\fR in the range of 0-255 can be passed as argument to this
257 command, which tells how many entries of the client version subtree should be
258 shown. Passing 0, or omitting it means 'unlimited'.
260 \fIExample:\fR 'statistics 5' will show only the top 5 versions for each client
261 type.
262 .SS \fBStatus\fR
263 Show connection status, current up/download speeds, etc.
265 .SH NOTES
266 .SS Paths
267 For all options which take a \fI<path>\fR value, if the \fIpath\fR contains no
268 directory part (i.e. just a plain filename), then it is considered to be under
269 the aMule configuration directory, \fI~/.aMule\fR.
270 .SS LANGUAGES
271 The \fI<lang>\fR parameter for the \fB\-l\fR option has the following form: \fIlang\fR[\fB_\fILANG\fR][\fB.\fIencoding\fR][\fB@\fImodifier\fR]
272 where \fIlang\fR is the primary language, \fILANG\fR is a sublanguage/territory,
273 \fIencoding\fR is the character set to use and \fImodifier\fR
274 allows the user to select a specific instance of localization data within a
275 single category.
276 .TP
277 For example, the following strings are valid:
278 .2TP
279 de
281 .2TP
282 de_DE
284 .2TP
285 de_DE.iso88591
287 .2TP
288 de_DE@euro
290 .2TP
291 de_DE.iso88591@euro
292 .P
293 Though all the above strings are accepted as valid language definitions,
294 \fIencoding\fR and \fImodifier\fR are yet unused.
296 In addition to the format above, you can also specify full language names in
297 English - so \fB\-l german\fR is also valid and is equal to \fB-l de_DE\fR.
299 When no locale is defined, either on command-line or in config file, system
300 default language will be used.
301 .SH FILES
302 ~/.aMule/remote.conf
303 .SH EXAMPLE
304 Typically amulecmd will be first run as:
305 .PP
306 \fBamulecmd\fR \fB\-h\fR \fIhostname\fR \fB\-p\fR \fIECport\fR \fB\-P\fR \fIECpassword\fR \fB\-w\fR
307 .PP
308 or
309 .PP
310 \fBamulecmd\fR \fB\-\-create-config-from\fR=\fI/home/username/.aMule/amule.conf\fR
311 .PP
312 These will save settings to \fI$HOME/.aMule/remote.conf\fR, and later you only need to type:
314 .B_untranslated amulecmd
316 Of course, you don't have to follow this example.
317 .SH REPORTING BUGS
318 Please report bugs either on our forum (\fIhttp://forum.amule.org/\fR), or in our bugtracker (\fIhttp://bugs.amule.org/\fR).
319 Please do not report bugs in e-mail, neither to our mailing list nor directly to any team member.
320 .SH COPYRIGHT
321 aMule and all of its related utilities are distributed under the GNU General Public License.
322 .SH SEE ALSO
323 .B_untranslated amule\fR(1), \fBamuled\fR(1)
324 .SH AUTHOR
325 This manpage was written by Vollstrecker <amule@vollstreckernet.de>