Thread: [Pmplib-commits] SF.net SVN: pmplib: [150] trunk/webpage/easypmp.html

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Revision: 150
Author:   sucknblow
Date:     2006-07-29 13:34:19 -0700 (Sat, 29 Jul 2006)
ViewCVS:  http://svn.sourceforge.net/pmplib/?rev=150&view=rev

Log Message:
-----------
It's a generated file, but it might as well be added
since its produced using 'tidy', which isn't installed
on the Sourceforge shell server.

Added Paths:
-----------
    trunk/webpage/easypmp.html
Added: trunk/webpage/easypmp.html
===================================================================

--- trunk/webpage/easypmp.html	                        (rev 0)
+++ trunk/webpage/easypmp.html	2006-07-29 20:34:19 UTC (rev 150)
@@ -0,0 +1,218 @@
+<h2>Index</h2>
+<dl>
+<dt><a href="#lbAB">NAME</a></dt>
+<dt><a href="#lbAC">SYNOPSIS</a></dt>
+<dt><a href="#lbAD">DESCRIPTION</a></dt>
+<dt><a href="#lbAE">DEVICE SUPPORT</a></dt>
+<dt><a href="#lbAF">OPTIONS</a></dt>
+<dt><a href="#lbAG">EXAMPLES</a></dt>
+<dt><a href="#lbAH">AUTHORS</a></dt>
+</dl>
+<a name="lbAB" id="lbAB">&nbsp;</a>
+<h2>NAME</h2>
+easypmp - create music databases used by portable media
+players<br />
+<a name="lbAC" id="lbAC">&nbsp;</a>
+<h2>SYNOPSIS</h2>
+<b>easypmp</b> [<b>-c</b>|<b>-u</b>] [<b>-p</b>] [<b>-m</b>]
+[<b>-t</b> <i>csv-word-list</i>] [<b>-R</b> [<b>-L</b>
+<i>level</i>]] [<b>-d</b> <i>device-id</i>]
+[<i>mount-point</i>]<br />
+<b>easypmp</b> [<b>-h</b>|<b>-v</b>|<b>-l</b>]
+<p><a name="lbAD" id="lbAD">&nbsp;</a></p>
+<h2>DESCRIPTION</h2>
+<b>easypmp</b> is a command line utility used to create and
+maintain the music database on a variety of portable media players.
+<p>Many portable music players allow the user to browse tracks by
+artist, album, genre, predefined playlists etc. In order to do this
+efficiently, they require a database of track information. Without
+this database, the player may require the user to browse tracks
+using only the directory structure. <b>easypmp</b> exists to create
+that database, based on the tracks and playlists that are stored on
+the player.</p>
+<p>Normally, <b>easypmp</b> is able to detect the type of any
+supported media player automatically. It does so by comparing the
+files and directories found at the specified mount point with the
+list of files it expects to find on each type of device that it
+supports. If no mount point is specified, the current working
+directory is assumed to be the mount point.</p>
+<p>In order to check that <b>easypmp</b> can identify the type of
+media player, the media player should be mounted as a USB device.
+The program should then be run without any command line switches
+(although the mount point should be specified if it is not the
+current directory). If the device is recognised, <b>easypmp</b>
+displays information about the device, including the directories in
+which it expects to find music and playlists on that device. If the
+device is not recognised, an error message to this effect is
+shown.</p>
+<p>For a quick introduction on how to use <b>easypmp</b>, see the
+<b>EXAMPLES</b> section below.</p>
+<p><a name="lbAE" id="lbAE">&nbsp;</a></p>
+<h2>DEVICE SUPPORT</h2>
+<b>easypmp</b> currently only works with media players that can be
+mounted as <i>USB Mass Storage</i> (UMS) devices. Specifically, it
+has been tested with the following devices:
+<ul>
+<li>iRiver&nbsp;H100&nbsp;series</li>
+<li>iRiver&nbsp;H300&nbsp;series</li>
+<li>iRiver&nbsp;H10&nbsp;UMS</li>
+<li>
+iRiver&nbsp;H10&nbsp;MTP&nbsp;(with&nbsp;emergency&nbsp;connect&nbsp;mode)</li>
+<li>iRiver&nbsp;H10Jr.&nbsp;UMS</li>
+<li>iRiver&nbsp;U10&nbsp;UMS</li>
+<li>MEDION&nbsp;MDJuke220&nbsp;and&nbsp;MDJuke440</li>
+<li>Samsung&nbsp;YH-820,&nbsp;YH-920&nbsp;and&nbsp;YH-925</li>
+</ul>
+<p>Note that some of the iRiver devices listed above may not
+support UMS as shipped. For example, in Europe and the United
+States, the iRiver U10 ships with support for a proprietary file
+transfer protocol called <i>Media Transfer Protocol</i> (MTP). In
+order to use these devices with <b>easypmp</b>, it is necessary to
+re-program (or `flash') the firmware on the device to make it
+support UMS. This can be accomplished by running the iRiver
+firmware updater for iRiver products. At the time of writing this
+works with T10, T20, T30, U10 and N12 models, with the exception of
+256MB and 2GB models in these series. The firmware updater can be
+downloaded from:<br />
+<br />
+&nbsp;&nbsp;<a href=
+"http://www.iriver.com/mtp/">http://www.iriver.com/mtp/</a></p>
+<p>Note that the iRiver firmware updater is a Windows program. The
+program requires that your computer be connected to the Internet
+when run, in order to download the latest firmware for the device.
+Please note that updating the firmware on a device using this
+program will erase any data already stored on the device.</p>
+<p><a name="lbAF" id="lbAF">&nbsp;</a></p>
+<h2>OPTIONS</h2>
+<b>easypmp</b> follows the usual GNU command line syntax, with long
+options starting with two dashes (`-'). A summary of options is
+included below.
+<dl compact="compact">
+<dt class="c1">-c, --create</dt>
+<dd>Create a new music database from scratch. The music files in
+the directory on the device used for storing music files is scanned
+recursively for music files. For each file found, the meta-data
+stored in that file - including the genre, artist, album and track
+name - is read, and used to add a record for that file in the music
+database stored on the device.</dd>
+<dt class="c1">-u, --update</dt>
+<dd>Update the music database stored on the device. This is similar
+to the <b>-c</b> option, with the exception that, when an entry for
+a given music file already exists in the database stored on the
+device, the meta-data already stored in the database is not
+updated.
+<p>Using this option means that <b>easypmp</b> does not need to
+re-read the meta-data in every music file on the device. Rather, it
+only has to read the meta-data in music files that were not on the
+device the last time the database was updated. Thus this option is
+a faster way creating the music database when only a few tracks on
+the device have been changed since the database was last created or
+updated. However, if the meta-data in existing files has changed,
+this may not be reflected in the database when using this
+option.</p>
+</dd>
+<dt class="c1">-p, --playlist</dt>
+<dd>Many programs for playing music allow playlists to be created
+and saved on disk, ready to be played later. Such playlists
+frequently have a <b>.m3u</b> extension. However, the playlists
+saved by most programs cannot be used directly on portable media
+players. Instead, it is necessary to convert (or `compile') each
+playlist into a format that the media player can read.
+<p>When the <b>-p</b>/<b>--playlist</b> option is specified,
+<b>easypmp</b> will search the playlist directory on the device for
+playlists that can be converted into a form that the media player
+can read (see the <b>DESCRIPTION</b> section above for information
+on how to determine the playlist directory for a particular media
+player).</p>
+</dd>
+<dt class="c1">-m, --music</dt>
+<dd>The <b>-m</b>/<b>--music</b> option is similar to the
+<b>-p</b>/<b>--playlist</b> option. However, instead of searching
+the playlist directory on the media player for playlists, it
+searches in the music directory on the player instead.</dd>
+<dt class="c1">-R, --repr</dt>
+<dd>Output a textual representation of the music database on
+standard output. This option is seldom used: it may be useful for
+debugging purposes, or if bored.</dd>
+<dt><b>-L</b> <i>level</i>, --repr-level=<i>level</i></dt>
+<dd>Specifies the format of the textual representation of the music
+database. This option is only meaningful if the <b>-R</b> option is
+used. The value of <i>level</i> should be an natural number: that
+is, either 0 or a positive integer. The meaning of the given value
+depends on the type of media player in use. Currently, the only
+values of <i>level</i> that may produce different results are 0 and
+1.</dd>
+<dt class="c1">-l, --list-device</dt>
+<dd>Shows the list of supported devices. This includes the names of
+the directories where music and playlists are expected to be found
+and the playlist extension used by each device. The list also
+includes the `device identifier' for each device. For more
+information on the device identifier, see the <b>-d</b>
+option.</dd>
+<dt><b>-d</b> <i>device-id</i>, --device=<i>device-id</i></dt>
+<dd>Specifies a device identifier for the player. The device
+identifier is used to determine where <b>easypmp</b> looks for
+music files and playlists, and the location and format of the
+database that it creates. It is not normally necessary to specify
+the device identifier because it is normally detected
+automatically, based on the names of system files and directories
+on the device.</dd>
+<dt><b>-t</b> <i>csv-word-list</i>,
+--strip-words=<i>csv-word-list</i></dt>
+<dd>Specify a list of words to remove from the start of artist
+names when adding new tracks to the database. The list of words
+should be comma-separated: that is, a comma (,) should be used to
+between each word.
+<p>For example, <b>easypmp&nbsp;-ct&nbsp;the</b> will strip the
+word 'The' from the start of artist names. Hence,
+'The&nbsp;Proclaimers' and 'The&nbsp;Cat&nbsp;Empire' will appear
+in the music database as 'Proclaimers' and 'Cat&nbsp;Empire'
+respectively.</p>
+<p>The list is not limited to individual words. Phrases that
+include spaces may also be specified from the command line, by
+including the whole list in quotes, separating each word or phrase
+by a comma. For example: <b>easypmp -ct 'the,pipes and drums
+of'</b>.</p>
+<p>When used with the <b>-u</b>/<b>--update</b> option, only new
+tracks that are not already in the database are affected by this
+option. To use this option with all tracks, including those that
+already exist in the database, it is necessary to re-build the
+database with <b>-c</b>/<b>--create</b>. This option does not
+modify music files, it only has an effect on the music
+database.</p>
+</dd>
+<dt class="c1">-h, --help</dt>
+<dd>Show summary of options.</dd>
+<dt class="c1">-v, --version</dt>
+<dd>Show version of program.</dd>
+</dl>
+<a name="lbAG" id="lbAG">&nbsp;</a>
+<h2>EXAMPLES</h2>
+These examples assume a media player has been mounted as a normal
+USB disk using /media/sda as a mount point.
+<p>Firstly, it is advisable to check that <b>easypmp</b> can
+support your media player:</p>
+<p class="c2">easypmp /media/sda</p>
+<p>If <b>easypmp</b> supports your device, this will show the paths
+where music and playlists should be copied to, prior to creating
+the database. Once music and playlists have been copied into these
+directories, the music database can be constructed as follows:</p>
+<p class="c2">easypmp -c /media/sda</p>
+<p>Note that, if the current directory is the mount point. it is
+not necessary to specify this on the command line. Therefore, when
+running <b>easypmp</b> several times, it is useful to change to the
+mount point directory first, in order to avoid having to specify it
+repeatedly.</p>
+<p>After adding or removing tracks from the media player, the
+database no longer reflect the files stored on the device. The
+database can be updated, without reading tags for files that
+already exist in the database:</p>
+<p class="c2">easypmp -u /media/sda</p>
+<p><br />
+<a name="lbAH" id="lbAH">&nbsp;</a></p>
+<h2>AUTHORS</h2>
+<b>easypmp</b> was written by Nyaochi , who also wrote an initial
+POSIX port using the Cygwin environment.
+<p>This manual page was written by Martin Ellis , who also
+contributed bug fixes for the POSIX port.</p>
+Time: 20:13:34 GMT, July 29, 2006


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.





Thread: [Pmplib-commits] SF.net SVN: pmplib: [150] trunk/webpage/easypmp.html

pmplib-commits