AMule Project FAQ - User contributions [en]

Making a handy amulecmd script

2010-03-03T09:57:32Z

GilesBathgate: /* Nice, but I only want to see finished downloads */

<center>
'''English''' |
[[Making_a_handy_amulecmd_script-de|Deutsch]]
</center>

== What is the goal? ==

This script is meant to display information about what your [[aMuled]] has been up to in a way pleasing to the eyes, using [[AMuleCMD]]. Because it depends on the "show log" command, make sure you use aMule version 2.1.2 or higher.

== The standard script ==

The script itself is quite simple:

#!/bin/sh
# Version 20060330

domule() {
amulecmd -c "$@" | grep "^ >"
}
domule "show log" | sed "
/: Failed to / {s/: $.*$/: `tput setaf 1`\1`tput sgr0`/;}
/: Finished downloading/ {s/: $.*$/: `tput setaf 2`\1`tput sgr0`/;}
/: Downloading / {s/: $.*$/: `tput setaf 3`\1`tput sgr0`/;}
"
echo ""
domule "status" | sed "
/Download:/ {s/$Download:$$.*$/\1`tput setaf 3`\2`tput sgr0`/;}
/Upload:/ {s/$Upload:$$.*$/\1`tput setaf 2`\2`tput sgr0`/;}
"
domule "reset" >/dev/null

Note:
* This depends on the sh shell, the grep command and the sed command. If your system does not have sh, you will either have to install or change the first line to a shell you do have, f.e., /bin/bash

When executing this script, you get something [http://qtea.nl/amule/amulelog.png like this]:

== How to change the colours ==

The "tput set <digit>" is used to insert the colour codes. The different numbers stand for different colours. See man tput for other tricks you can do with tput.

== How to remove the colours ==

If you don't want the colours at all, you can remove the sed commands:

#!/bin/sh
# Version 20060330

domule() {
amulecmd -c "$@" | grep "^ >"
}
domule "show log"
echo ""
domule "status"
domule "reset" >/dev/null

== Nice, but I only want to see finished downloads ==

This can be achieved by using the grep command:

#!/bin/sh
# Version 20060330

domule() {
amulecmd -c "$@" | grep "^ >"
}
domule "show log" | grep ": Finished downloading" || echo " > No finished downloads"

echo ""
domule "status"
domule "reset" >/dev/null

== How to use these scripts ==

Simply save them to a plain text file and make them executable (f.e., on linux by applying 'chmod u+x <yourscriptfilehere>'). This will work on most OS'es, except maybe for Windows since the standard version does not come with a useful command line shell.

== Conclusion ==

There are a hunderd different things you can do with the output of "show log", only limited by your imagination ;) If you want to change the behaviour of the script you might want to check out commands such as grep (easy), awk (a bit harder) and sed (can be quite tricky).

Making a handy amulecmd script

2010-03-03T09:57:21Z

GilesBathgate: /* How to remove the colours */

Making a handy amulecmd script

2010-03-03T09:57:08Z

GilesBathgate: /* The standard script */

FAQ amulecmd

2009-04-15T08:53:22Z

GilesBathgate: /* Show downloads in a nicely formatted list */

<center>'''English''' |
[[FAQ_amulecmd-de|Deutsch]]
</center>

== How can I configure amulecmd to schedule actions? (Linux) ==

You have to configure such jobs with crontab. Let's do it by example:<br>
:bash ~# crontab -e
:00 6   * * * amulecmd -c "set bwlimit up 30"
:00 22 * * * amulecmd -c "set bwlimit up 0"
Will set your download bandwith limit to 30 kb/s on 6:00am and unlimited on 10:00pm. For more possibilities see also [[aMuleCMD]].

== I cannot connect to [[aMuled]]. It seems [[aMuled]] does not create the listening port for connecting to it :-\? ==

You have probably not enabled [[External Connections]] in ''~/.aMule/amule.conf

'''NOTE:''' You can create the value for ''ECPassword'' like that:

echo -n yourpasswordhere | md5sum | cut -d ' ' -f 1

== How can I receive a mail every day with a summary of the files amuled downloaded? ==

First, create [[Making a handy amulecmd script|this]] script and verify that it works properly. Then you can add it to your cron in the same way as shown above. Many cron-daemons will mail output of a script to your user. You can also use utilities like sendmail to mail the output of the script.

== Usefull Scripts ==

=== Show downloads in a nicely formatted list ===

#!/bin/sh
amulecmd -c "show dl" | \
grep '.' | \
sed "1,/Succeeded/d" | \
sed -n "N;s/^ > .*[0-9A-F]\{32\} $.*$\n >.*\[$.*%$\].*]$.*$/\2 \1\3/p" | \
sort -n

=== Call amulecmd from the commandline without mess ===

#!/bin/sh
amulecmd -c "$*"

save this script as "amc" and chmod +x it, then you can call amulecmd like this:

./amc show log

or pipe the output into another program

./amc show log | grep completed

I find this slightly easier than the original

amulecmd -c "show log" | grep completed.

===Search for results, until no more can be found===

#!/bin/sh
echo Searching for $1
amulecmd -c "search kad $1" > /dev/null
prevres=-1
matchcount=0
for c in `seq 1 10`;
do
sleep 5
res=`amulecmd -c "results" | grep results: | sed "s/.*results: $.*$$/\1/"`
if [ $res == $prevres ]
then
(( matchcount += 1 ))
if [ $matchcount -gt 1 ]
then
matchcount=0
break
fi
else
matchcount=0
prevres=$res
fi
done

FAQ amulecmd

2009-03-31T14:53:57Z

GilesBathgate: /* Usefull Scripts */

<center>'''English''' |
[[FAQ_amulecmd-de|Deutsch]]
</center>

== How can I configure amulecmd to schedule actions? (Linux) ==

You have to configure such jobs with crontab. Let's do it by example:<br>
:bash ~# crontab -e
:00 6   * * * amulecmd -c "set bwlimit up 30"
:00 22 * * * amulecmd -c "set bwlimit up 0"
Will set your download bandwith limit to 30 kb/s on 6:00am and unlimited on 10:00pm. For more possibilities see also [[aMuleCMD]].

== I cannot connect to [[aMuled]]. It seems [[aMuled]] does not create the listening port for connecting to it :-\? ==

You have probably not enabled [[External Connections]] in ''~/.aMule/amule.conf

'''NOTE:''' You can create the value for ''ECPassword'' like that:

echo -n yourpasswordhere | md5sum | cut -d ' ' -f 1

== How can I receive a mail every day with a summary of the files amuled downloaded? ==

First, create [[Making a handy amulecmd script|this]] script and verify that it works properly. Then you can add it to your cron in the same way as shown above. Many cron-daemons will mail output of a script to your user. You can also use utilities like sendmail to mail the output of the script.

== Usefull Scripts ==

=== Show downloads in a nicely formatted list ===

#!/bin/sh
amulecmd -c "show dl" | \
grep '.' | \
sed "1,/command list/d" | \
sed -n "N;s/^ > .*[0-9A-F]\{32\} $.*$\n >.*\[$.*%$\].*]$.*$/\2 \1\3/p" | \
sort -n

=== Call amulecmd from the commandline without mess ===

#!/bin/sh
amulecmd -c "$*"

save this script as "amc" and chmod +x it, then you can call amulecmd like this:

./amc show log

or pipe the output into another program

./amc show log | grep completed

I find this slightly easier than the original

amulecmd -c "show log" | grep completed.

===Search for results, until no more can be found===

#!/bin/sh
echo Searching for $1
amulecmd -c "search kad $1" > /dev/null
prevres=-1
matchcount=0
for c in `seq 1 10`;
do
sleep 5
res=`amulecmd -c "results" | grep results: | sed "s/.*results: $.*$$/\1/"`
if [ $res == $prevres ]
then
(( matchcount += 1 ))
if [ $matchcount -gt 1 ]
then
matchcount=0
break
fi
else
matchcount=0
prevres=$res
fi
done

FAQ amulecmd

2009-01-03T13:20:35Z

GilesBathgate:

<center>'''English''' |
[[FAQ_amulecmd-de|Deutsch]]
</center>

== How can I configure amulecmd to schedule actions? (Linux) ==

You have to configure such jobs with crontab. Let's do it by example:<br>
:bash ~# crontab -e
:00 6   * * * amulecmd -c "set bwlimit up 30"
:00 22 * * * amulecmd -c "set bwlimit up 0"
Will set your download bandwith limit to 30 kb/s on 6:00am and unlimited on 10:00pm. For more possibilities see also [[aMuleCMD]].

== I cannot connect to [[aMuled]]. It seems [[aMuled]] does not create the listening port for connecting to it :-\? ==

You have probably not enabled [[External Connections]] in ''~/.aMule/amule.conf

'''NOTE:''' You can create the value for ''ECPassword'' like that:

echo -n yourpasswordhere | md5sum | cut -d ' ' -f 1

== How can I receive a mail every day with a summary of the files amuled downloaded? ==

First, create [[Making a handy amulecmd script|this]] script and verify that it works properly. Then you can add it to your cron in the same way as shown above. Many cron-daemons will mail output of a script to your user. You can also use utilities like sendmail to mail the output of the script.

== Usefull Scripts ==

=== Show downloads in a nicely formatted list ===

#!/bin/sh
amulecmd -c "show dl" | \
grep '.' | \
sed "1,/command list/d" | \
sed -n "N;s/^ > .*[0-9A-F]\{32\} $.*$\n >.*\[$.*%$\].*]$.*$/\2 \1\3/p" | \
sort -n

=== Call amulecmd from the commandline without mess ===

#!/bin/sh
amulecmd -c "$*"

save this script as "amc" and chmod +x it, then you can call amulecmd like this:

./amc show log

or pipe the output into another program

./amc show log | grep completed

I find this slightly easier than the original

amulecmd -c "show log" | grep completed.