PodSleuth
This introduction is a placeholder, and is the README file from the module
PodSleuth is a tool to discover detailed model information about an Apple (TM) iPod (TM). Its primary role is to be run as a callout by HAL (http://freedesktop.org/wiki/Software_2fhal) because root access is needed to scan the device for required information. When the model information is discovered, it is merged into HAL as properties for other applications to use.
With PodSleuth installed, applications can expect to have rich iPod (TM) metadata merged into the device tree on the iPod data volume node. PodSleuth metadata properties are in the org.banshee-project.podsleuth namespace.
PodSleuth is based on lessons learned from the old libipoddevice project. It is a cumulation of 2 years of research, backwards and forwards device compatibility, and extensive device coverage and user testing. It deprecates the libipoddevice project in use and simplifies information access for top level applications.
Getting PodSleuth
Currently PodSleuth is under heavy development, and while usable, has not yet seen an initial release. It is available in GNOME Subversion:
svn co svn://svn.gnome.org/svn/podsleuth/trunk podsleuth
Building PodSleuth
PodSleuth has the following dependencies:
- Mono 1.1.10 or better
- HAL 0.5.6 or better
- sgutiils
PodSleuth can be compiled and installed from source. Note that it must be configured and installed with the same prefix as HAL (typically this will be /usr).
./autogen.sh --prefix=/usr make sudo make install
Optionally you can pass --with-update-dir=/some/other/path to autogen.sh or configure if you do not want /var/cache/podsleuth to be used to store updates.
Running PodSleuth
PodSleuth is not meant to be a standalone application. It is a tool run transparently and behind the scenes automatically by HAL when an iPod is plugged in. Information it collects is then available to any application directly via HAL. However, PodSleuth does come with a debugging tool, called podsleuth.
Run podsleuth --help to view all of its options. This tool can be used to list properties of any iPods that are plugged into the system. It can also update the iPod model table via the --update flag, which may be useful if your iPod is not currently known by PodSleuth. The only value this adds is that the right device class (Video, Nano, Mini, etc.) and shell color will be available, if the iPod is listed in the table.
If the iPod is not listed in the table, you can submit your iPod information directly to us for inclusion in the table.
You can also view the most up to date model table (http://banshee-project.org/files/podsleuth/ipod-model-table).
