docs/man/amulecmd.1

   1 .TH AMULECMD 1 "September 2016" "aMuleCmd v2.3.2" "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> ] " " }
  17
  18 .B_untranslated amulecmd
  19 .RB [ \-\-create\-config\-from = \fI<path> ]
  20
  21 .B_untranslated amulecmd
  22 .RB_untranslated [ \-\-version ]
  23
  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.
  73
  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
  83
  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.
  89
  90 This will connect to all networks that are enabled in Preferences.
  91
  92 With the optional parameter you can specify which network to connect to. Giving
  93 a server address in the form of IP:Port (where IP is either a dotted decimal
  94 IPv4 address or a resolvable DNS name) aMule will connect to that server only.
  95 .SS_untranslated Disconnect [ \fIed2k\fP | \fIkad\fP ]
  96 Disconnect from all networks you are connected to, or just disconnect from the
  97 specified network.
  98 .SS Download \fI<number>\fP
  99 Start downloading a file.
 100
 101 The \fI<number>\fR of a file from the last search has to be given.
 102 Example: `download 12' will start to download the file with the number 12 of the
 103 previous search.
 104 .SS_untranslated Exit
 105 Disconnect from amule/amuled and quit amulecmd.
 106 .SS Get \fI<what>\fP
 107 Get and display a preference value.
 108
 109 Available values for \fI<what>\fR:
 110 .RS
 111 .IP BwLimits 10
 112 Get bandwidth limits.
 113 .IP IPFilter 10
 114 Get IPFilter preferences.
 115 .RE
 116 .SS Help [ \fI<command>\fP ]
 117 Prints a short usage description.
 118 If called without parameter, it shows a list of available commands.
 119 If called with \fI<command>\fR, it shows a short description of the given command.
 120 .SS Pause \fI<hash>\fP | \fI<number>\fP
 121 Pauses the download specified by \fI<hash>\fR or \fI<number>\fR. To get the value use \fBshow\fR.
 122 .SS Priority \fI<priority>\fP \fI<hash>\fP | \fI<number>\fP
 123 Set priority of a download specified by \fI<hash>\fR or \fI<number>\fR.
 124
 125 Available values for \fI<priority>\fR:
 126 .RS
 127 .IP Auto 10
 128 Automatic priority.
 129 .IP High 10
 130 High priority.
 131 .IP Low 10
 132 Low priority.
 133 .IP Normal 10
 134 Normal priority.
 135 .RE
 136 .SS_untranslated Progress
 137 Shows the progress of an on\-going search.
 138 .SS_untranslated Quit
 139 A synonim of the \fBexit\fR command.
 140 .SS Reload \fI<what>\fP
 141 Reloads a given object.
 142
 143 Available values for \fI<what>\fR:
 144 .RS
 145 .IP Shared 10
 146 Reload shared files list.
 147 .IP IPFilter 10
 148 Reload IP filter tables.
 149 .RE
 150 .SS_untranslated Reset
 151 Reset the log.
 152 .SS_untranslated Results
 153 Shows you the results of the last search.
 154 .SS Resume \fI<hash>\fP | \fI<number>\fP
 155 Resumes the download specified by \fI<hash>\fR or \fI<number>\fR. To get the value use \fBshow\fR.
 156 .SS Search \fI<type>\fP \fI<keyword>\fR
 157 Makes a search for the given \fI<keyword>\fR. A search type and a keyword to search is mandatory to do this.
 158 Example: `search kad amule' performs a kad search for `amule'.
 159
 160 Available search types:
 161 .RS
 162 .IP Global 10
 163 Performs a global search.
 164 .IP Kad 10
 165 Performs a search on the Kademlia network.
 166 .IP Local 10
 167 Performs a local search.
 168 .RE
 169 .SS Set \fI<what>\fR
 170 Sets a given preferences value.
 171
 172 Available values for \fI<what>\fR:
 173 .RS
 174 .IP BwLimits 10
 175 Set bandwidth limits.
 176 .IP IPFilter 10
 177 Set IPFilter preferences.
 178 .RE
 179 .SS Show \fI<what>\fR
 180 Shows upload/download queue, servers list or shared files list.
 181
 182 Available values for \fI<what>\fR:
 183 .RS
 184 .IP DL 10
 185 Show download queue.
 186 .IP Log 10
 187 Show log.
 188 .IP Servers 10
 189 Show servers list.
 190 .IP UL 10
 191 Show upload queue.
 192 .RE
 193 .SS_untranslated Shutdown
 194 Shutdown the remote running core (amule/amuled).
 195 This will also shut down the text client, since it is unusable without a running core.
 196 .SS Statistics [ \fI<number>\fP ]
 197 Show statistics tree.
 198
 199 The optional \fI<number>\fR in the range of 0-255 can be passed as argument to this
 200 command, which tells how many entries of the client version subtree should be
 201 shown. Passing 0, or omitting it means `unlimited'.
 202
 203 Example: `statistics 5' will show only the top 5 versions for each client
 204 type.
 205 .SS_untranslated Status
 206 Show connection status, current up/download speeds, etc.
 207 .SH NOTES
 208 .SS Paths
 209 For all options which take a \fI<path>\fR value, if the \fIpath\fR contains no
 210 directory part (i.e. just a plain filename), then it is considered to be under
 211 the aMule configuration directory, \fI~/.aMule\fR.
 212 .SS Languages
 213 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]
 214 where \fIlang\fR is the primary language, \fILANG\fR is a sublanguage/territory,
 215 \fIencoding\fR is the character set to use and \fImodifier\fR
 216 allows the user to select a specific instance of localization data within a
 217 single category.
 218
 219 For example, the following strings are valid:
 220 .RS
 221 .RB_untranslated de
 222 .br
 223 .RB_untranslated de_DE
 224 .br
 225 .RB_untranslated de_DE.iso88591
 226 .br
 227 .RB_untranslated de_DE@euro
 228 .br
 229 .RB_untranslated de_DE.iso88591@euro
 230 .RE
 231
 232 Though all the above strings are accepted as valid language definitions,
 233 \fIencoding\fR and \fImodifier\fR are yet unused.
 234
 235 In addition to the format above, you can also specify full language names in
 236 English - so \fB\-l german\fR is also valid and is equal to \fB\-l de_DE\fR.
 237
 238 When no locale is defined, either on command-line or in config file, system
 239 default language will be used.
 240 .SH FILES
 241 ~/.aMule/remote.conf
 242 .SH EXAMPLE
 243 Typically amulecmd will be first run as:
 244 .PP
 245 \fBamulecmd\fR \fB\-h\fR \fIhostname\fR \fB\-p\fR \fIECport\fR \fB\-P\fR \fIECpassword\fR \fB\-w\fR
 246 .PP
 247 or
 248 .PP
 249 \fBamulecmd\fR \fB\-\-create-config-from\fR=\fI/home/username/.aMule/amule.conf\fR
 250 .PP
 251 These will save settings to \fI$HOME/.aMule/remote.conf\fR, and later you only need to type:
 252
 253 .B_untranslated amulecmd
 254
 255 Of course, you don't have to follow this example.
 256 .SH REPORTING BUGS
 257 Please report bugs either on our forum (\fIhttp://forum.amule.org/\fR), or in our bugtracker (\fIhttp://bugs.amule.org/\fR).
 258 Please do not report bugs in e-mail, neither to our mailing list nor directly to any team member.
 259 .SH COPYRIGHT
 260 aMule and all of its related utilities are distributed under the GNU General Public License.
 261 .SH SEE ALSO
 262 .B_untranslated amule\fR(1), \fBamuled\fR(1)
 263 .SH AUTHOR
 264 This manpage was written by Vollstrecker <amule@vollstreckernet.de>