[Pmplib-commits] SF.net SVN: pmplib: [102] trunk/frontend/easypmp/cui/easypmp.1

[<suc...@us...>]

Revision: 102
Author:   sucknblow
Date:     2006-07-01 19:35:37 -0700 (Sat, 01 Jul 2006)
ViewCVS:  http://svn.sourceforge.net/pmplib/?rev=102&view=rev

Log Message:
-----------
Document the --list-device and --device options.

Modified Paths:
--------------
    trunk/frontend/easypmp/cui/easypmp.1
Modified: trunk/frontend/easypmp/cui/easypmp.1
===================================================================
--- trunk/frontend/easypmp/cui/easypmp.1	2006-07-02 01:29:23 UTC (rev 101)
+++ trunk/frontend/easypmp/cui/easypmp.1	2006-07-02 02:35:37 UTC (rev 102)
@@ -50,6 +50,8 @@
 expects to find music and playlists on that device.  If the device is
 not recognised, an error message to this effect is shown.
 
+For a quick introduction on how to use \fBeasypmp\fP, see the
+\fBEXAMPLES\fP section below.
 
 .SH DEVICE SUPPORT
 \fBeasypmp\fP currently only works with media players that can be
@@ -87,7 +89,7 @@
 .SH OPTIONS
 \fBeasypmp\fP follows the usual GNU command line syntax, with long
 options starting with two dashes (`-').
-.\"A summary of options is included below."
+A summary of options is included below.
 .TP
 .B \-c, \-\-create
 Create a new music database from scratch.  The music files in the
@@ -99,7 +101,7 @@
 .TP
 .B \-u, \-\-update
 Update the music database stored on the device.  This is similar to
-the \fB-d\fP option, with the exception that, when an entry for a
+the \fB-c\fP 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.
 
@@ -145,6 +147,21 @@
 depends on the type of media player in use.  Currently, the only
 values of \fIlevel\fP that may produce different results are 0 and 1.
 .TP
+.B \-l, \-\-list-device
+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 \fB-d\fR option.
+.TP
+.B \-d \fIdevice\-id\fP, \-\-device=\fIdevice\-id\fP
+Specifies a device identifier for the player.  The device identifier
+is used to determine where \fBeasypmp\fP 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.
+.TP
 .B \-h, \-\-help
 Show summary of options.
 .TP
@@ -161,10 +178,10 @@
 
 If \fBeasypmp\fP 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
+database. Once music and playlists have been copied into these
 directories, the music database can be constructed as follows:
 
-.B easypmp -D /media/sda
+.B easypmp -c /media/sda
 
 Note that, if the current directory is the mount point.  it is not
 necessary to specify this on the command line.  Therefore, when
@@ -172,11 +189,18 @@
 mount point directory first, in order to avoid having to specify it
 repeatedly.
 
+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:
+
+.B easypmp -u /media/sda
+
 .br
 .SH AUTHOR
-\fBeasypmp\fP was written by Nyaochi <nyaochi@ny...@sa...>. who
-also wrote an initial POSIX port using the Cygwin environment.
+\fBeasypmp\fP was written by Nyaochi <nyaochi@ny...@sa...>,
+who also wrote an initial POSIX port using the Cygwin environment.
 
 This manual page was written by Martin Ellis
-<mar...@kd...>, who also updated the POSIX port to improve
-portability.
+<mar...@kd...>, who also contributed bug fixes for the
+POSIX port.


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