docs/amulesig.txt

   1
   2
   3                 ------------------------------------
   4                 aMule Online Signature specification
   5                 ------------------------------------
   6
   7
   8  Introduction
   9 --------------
  10
  11   The online signature exports aMule's statistics in a simple text oriented format.
  12
  13   It can be enabled within the Preferences dialogs of aMule (Preferenes -> Online Signature).
  14
  15   Currently two formats of online signature are supported:
  16     * the original eMule online signature written to onlinesig.dat
  17     * the aMule online signature written to amulesig.dat
  18
  19   This document will detail on the later one.
  20
  21
  22  Format
  23 --------
  24
  25   The format of the file is a text file with 1 field per line.
  26
  27   The following fields are defined by now in the order they appear in the signature file:
  28
  29   Ordinal       Content
  30                 Not-running     Offline         Online                                  connecting
  31    1            0               0               1                                       2
  32    2            0               0               Server name                             0
  33    3            0               0               IP of server as dot-quad                0
  34    4            0               0               Port of server                          0
  35    5            0               0               'H' or 'L' for High-/Low-ID             0
  36    6            0.0             As online       Download speed in kB/s                  As online
  37    7            0.0             As online       Upload speed in kB/s                    As online
  38    8            0               As online       Number of clients waiting for upload    As online
  39    9            0               As online       Number of shared files                  As online
  40   10            As online       As online       Nick used on the ed2k network           As online
  41   11            As online       As online       Total download in bytes                 As online
  42   12            As online       As online       Total upload in bytes                   As online
  43   13            As online       As online       aMule version                           As online
  44   14            0               As online       Total Downloaded in Session in bytes    As online
  45   15            0               As online       Total Uploaded in Session in bytes      As online
  46   16            0               As online       aMule Uptime                            As online
  47
  48   For comments and additions on this format please contact <admin@amule.org>
  49
  50
  51  Notes for implementors of tools accessing the online signature
  52 ----------------------------------------------------------------
  53
  54   - Be prepared to see linefeeds being in either Unix or DOS format.
  55   - Be prepared of new fields/lines being added.
  56
  57  Links
  58 -------
  59
  60   Please visit:
  61   * amulesig.dat
  62       http://wiki.amule.org/index.php/Amulesig.dat_file
  63   * onlinesig.dat
  64       http://wiki.amule.org/index.php/Onlinesig.dat_file