| blob | 2115a2e302a65d080c9b66978689d92e527967a6 |
1 .TH AMULECMD 1 "January 2010" "aMuleCmd v2.3.0" "aMule utilities"
2 .als B_untranslated B
3 .als RB_untranslated RB
4 .als SS_untranslated SS
5 .SH NAME
6 amulecmd \- Console-based program to control aMule
7 .SH SYNOPSIS
8 .B_untranslated amulecmd
9 .RB [ \-h " " \fI<host> ]
10 .RB [ \-p " " \fI<port> ]
11 .RB [ \-P " " \fI<password> ]
12 .RB [ \-f " " \fI<path> ]
13 .RB_untranslated [ \-q ]
14 .RB_untranslated [ \-v ]
15 .RB [ \-l " " \fI<lang> ]
16 .RB { " " [ \-w ] " " | " " [ \-c " " \fI<command> ] " " }
18 .B_untranslated amulecmd
19 .RB [ \-\-create\-config\-from = \fI<path> ]
21 .B_untranslated amulecmd
22 .RB_untranslated [ \-\-version ]
24 .B_untranslated amulecmd
25 .RB_untranslated [ \-\-help ]
26 .SH DESCRIPTION
27 .B amulecmd
28 is a console-based client to control aMule.
29 .TP
30 \fB[ \-h\fR \fI<host>\fR, \fB\-\-host\fR=\fI<host>\fR \fB]\fR
31 Host where aMule is running (default: \fIlocalhost\fR).
32 \fI<host>\fR might be an IP address or a DNS name
33 .TP
34 \fB[ \-p\fR \fI<port>\fR, \fB\-\-port\fR=\fI<port>\fR \fB]\fR
35 aMule's port for External Connections, as set in Preferences->Remote Controls (default: \fI4712\fR)
36 .TP
37 \fB[ \-P\fR \fI<password>\fR, \fB\-\-password\fR=\fI<password>\fR \fB]\fR
38 External Connections password.
39 .TP
40 \fB[ \-f\fR \fI<path>\fR, \fB\-\-config\-file\fR=\fI<path>\fR \fB]\fR
41 Use the given configuration file.
42 Default configuration file is \fI~/.aMule/remote.conf\fR
43 .TP
44 .B_untranslated [ \-q\fR, \fB\-\-quiet ]\fR
45 Do not print any output to stdout.
46 .TP
47 .B_untranslated [ \-v\fR, \fB\-\-verbose ]\fR
48 Be verbose \-
49 show also debug messages.
50 .TP
51 \fB[ \-l\fR \fI<lang>\fR, \fB\-\-locale\fR=\fI<lang>\fR \fB]\fR
52 Sets program locale (language).
53 See the \fBNOTES\fR section for the description of the \fI<lang>\fR parameter.
54 .TP
55 .B_untranslated [ \-w\fR, \fB\-\-write\-config ]\fR
56 Write command line options to config file and exit
57 .TP
58 \fB[ \-c\fR \fI<command>\fR, \fB\-\-command\fR=\fI<command>\fR \fB]\fR
59 Execute \fI<command>\fR as if it was entered at amulecmd's prompt and exit.
60 .TP
61 \fB[ \-\-create\-config\-from\fR=\fI<path>\fR \fB]\fR
62 Create config file based upon \fI<path>\fR, which must point to a valid aMule config file, and then exit.
63 .TP
64 .B_untranslated [ \-v\fR, \fB\-\-version ]\fR
65 Displays the current version number.
66 .TP
67 .B_untranslated [ \-h\fR, \fB\-\-help ]\fR
68 Prints a short usage description.
69 .SH COMMANDS
70 All commands are case insensitive.
71 .SS Add \fI<eD2k-link>\fP | \fI<magnet-link>\fP
72 Adds an eD2k-link or a magnet-link to the core.
74 The eD2k link to be added can be:
75 .RS 3
76 .IP \(bu 2
77 a file link (ed2k://|file|...), it will be added to the download queue;
78 .IP \(bu 2
79 a server link (ed2k://|server|...), it will be added to the server list;
80 .IP \(bu 2
81 a serverlist link, in which case all servers in the list will be added to the server list.
82 .RE
84 The magnet link must contain the eD2k hash and file length.
85 .SS Cancel \fI<hash>\fP | \fI<number>\fP
86 Cancels the download specified by \fI<hash>\fR or \fI<number>\fR. To get the value use \fBshow\fR.
87 .SS Connect [ \fIkad\fP | \fIed2k\fP | \fI<ip|name>\fP ]
88 Connect to the network.
90 This will connect to all networks that are enabled in Preferences.
92 When giving ed2k as parameter, it connects only to eD2k-network, to servers in your
93 serverlist. You may also optionally specify a server address in IP:Port form, to
94 connect to that server only. The IP must be a dotted decimal IPv4 address, or a
95 resolvable DNS name.
97 When giving kad, it connects to Kad only.
98 .SS_untranslated Disconnect [ \fIed2k\fP | \fIkad\fP ]
99 Disconnect from all networks you are connected to, or just disconnect from the
100 specified network.
101 .SS Download \fI<number>\fP
102 Start downloading a file.
104 The \fI<number>\fR of a file from the last search has to be given.
105 Example: `download 12' will start to download the file with the number 12 of the
106 previous search.
107 .SS_untranslated Exit
108 Disconnect from amule/amuled and quit amulecmd.
109 .SS Get \fI<what>\fP
110 Get and display a preference value.
112 Available values for \fI<what>\fR:
113 .RS
114 .IP BwLimits 10
115 Get bandwidth limits.
116 .IP IPFilter 10
117 Get IPFilter preferences.
118 .RE
119 .SS Help [ \fI<command>\fP ]
120 Prints a short usage description.
121 If called without parameter, it shows a list of available commands.
122 If called with \fI<command>\fR, it shows a short description of the given command.
123 .SS Pause \fI<hash>\fP | \fI<number>\fP
124 Pauses the download specified by \fI<hash>\fR or \fI<number>\fR. To get the value use \fBshow\fR.
125 .SS Priority \fI<priority>\fP \fI<hash>\fP | \fI<number>\fP
126 Set priority of a download specified by \fI<hash>\fR or \fI<number>\fR.
128 Available values for \fI<priority>\fR:
129 .RS
130 .IP Auto 10
131 Automatic priority.
132 .IP High 10
133 High priority.
134 .IP Low 10
135 Low priority.
136 .IP Normal 10
137 Normal priority.
138 .RE
139 .SS_untranslated Progress
140 Shows the progress of an on\-going search.
141 .SS_untranslated Quit
142 A synonim of the \fBexit\fR command.
143 .SS Reload \fI<what>\fP
144 Reloads a given object.
146 Available values for \fI<what>\fR:
147 .RS
148 .IP Shared 10
149 Reload shared files list.
150 .IP IPFilter 10
151 Reload IP filter tables.
152 .RE
153 .SS_untranslated Reset
154 Reset the log.
155 .SS_untranslated Results
156 Shows you the results of the last search.
157 .SS Resume \fI<hash>\fP | \fI<number>\fP
158 Resumes the download specified by \fI<hash>\fR or \fI<number>\fR. To get the value use \fBshow\fR.
159 .SS Search \fI<type>\fP \fI<keyword>\fR
160 Makes a search for the given \fI<keyword>\fR. A search type and a keyword to search is mandatory to do this.
161 Example: `search kad amule' performs a kad search for `amule'.
163 Available search types:
164 .RS
165 .IP Global 10
166 Performs a global search.
167 .IP Kad 10
168 Performs a search on the Kademlia network.
169 .IP Local 10
170 Performs a local search.
171 .RE
172 .SS Set \fI<what>\fR
173 Sets a given preferences value.
175 Available values for \fI<what>\fR:
176 .RS
177 .IP BwLimits 10
178 Set bandwidth limits.
179 .IP IPFilter 10
180 Set IPFilter preferences.
181 .RE
182 .SS Show \fI<what>\fR
183 Shows upload/download queue, servers list or shared files list.
185 Available values for \fI<what>\fR:
186 .RS
187 .IP DL 10
188 Show download queue.
189 .IP Log 10
190 Show log.
191 .IP Servers 10
192 Show servers list.
193 .IP UL 10
194 Show upload queue.
195 .RE
196 .SS_untranslated Shutdown
197 Shutdown the remote running core (amule/amuled).
198 This will also shut down the text client, since it is unusable without a running core.
199 .SS Statistics [ \fI<number>\fP ]
200 Show statistics tree.
202 The optional \fI<number>\fR in the range of 0-255 can be passed as argument to this
203 command, which tells how many entries of the client version subtree should be
204 shown. Passing 0, or omitting it means `unlimited'.
206 Example: `statistics 5' will show only the top 5 versions for each client
207 type.
208 .SS_untranslated Status
209 Show connection status, current up/download speeds, etc.
210 .SH NOTES
211 .SS Paths
212 For all options which take a \fI<path>\fR value, if the \fIpath\fR contains no
213 directory part (i.e. just a plain filename), then it is considered to be under
214 the aMule configuration directory, \fI~/.aMule\fR.
215 .SS Languages
216 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]
217 where \fIlang\fR is the primary language, \fILANG\fR is a sublanguage/territory,
218 \fIencoding\fR is the character set to use and \fImodifier\fR
219 allows the user to select a specific instance of localization data within a
220 single category.
222 For example, the following strings are valid:
223 .RS
224 .RB_untranslated de
225 .br
226 .RB_untranslated de_DE
227 .br
228 .RB_untranslated de_DE.iso88591
229 .br
230 .RB_untranslated de_DE@euro
231 .br
232 .RB_untranslated de_DE.iso88591@euro
233 .RE
235 Though all the above strings are accepted as valid language definitions,
236 \fIencoding\fR and \fImodifier\fR are yet unused.
238 In addition to the format above, you can also specify full language names in
239 English - so \fB\-l german\fR is also valid and is equal to \fB\-l de_DE\fR.
241 When no locale is defined, either on command-line or in config file, system
242 default language will be used.
243 .SH FILES
244 ~/.aMule/remote.conf
245 .SH EXAMPLE
246 Typically amulecmd will be first run as:
247 .PP
248 \fBamulecmd\fR \fB\-h\fR \fIhostname\fR \fB\-p\fR \fIECport\fR \fB\-P\fR \fIECpassword\fR \fB\-w\fR
249 .PP
250 or
251 .PP
252 \fBamulecmd\fR \fB\-\-create-config-from\fR=\fI/home/username/.aMule/amule.conf\fR
253 .PP
254 These will save settings to \fI$HOME/.aMule/remote.conf\fR, and later you only need to type:
256 .B_untranslated amulecmd
258 Of course, you don't have to follow this example.
259 .SH REPORTING BUGS
260 Please report bugs either on our forum (\fIhttp://forum.amule.org/\fR), or in our bugtracker (\fIhttp://bugs.amule.org/\fR).
261 Please do not report bugs in e-mail, neither to our mailing list nor directly to any team member.
262 .SH COPYRIGHT
263 aMule and all of its related utilities are distributed under the GNU General Public License.
264 .SH SEE ALSO
265 .B_untranslated amule\fR(1), \fBamuled\fR(1)
266 .SH AUTHOR
267 This manpage was written by Vollstrecker <amule@vollstreckernet.de>