docs/man/amulecmd.1

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