From: <suc...@us...> - 2006-06-06 00:36:03
|
Revision: 51 Author: sucknblow Date: 2006-06-05 17:35:56 -0700 (Mon, 05 Jun 2006) ViewCVS: http://svn.sourceforge.net/pmplib/?rev=51&view=rev Log Message: ----------- It's a start of a man page. Not much to see. Added Paths: ----------- trunk/frontend/easypmp/cui/easypmp.1 Added: trunk/frontend/easypmp/cui/easypmp.1 =================================================================== --- trunk/frontend/easypmp/cui/easypmp.1 (rev 0) +++ trunk/frontend/easypmp/cui/easypmp.1 2006-06-06 00:35:56 UTC (rev 51) @@ -0,0 +1,79 @@ +.\" Hey, EMACS: -*- nroff -*- +.TH EASYPMP 1 "June 2, 2006" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +easypmp \- create music databases used by portable media players +.SH SYNOPSIS +.B easypmp +.R [ +.B -D +.R | +.B -u +.RI "] [" mount-point ] +.SH DESCRIPTION +.\" TeX users may be more comfortable with the \fB<whatever>\fP and +.\" \fI<whatever>\fP escape sequences to invode bold face and italics, +.\" respectively. + +\fBeasypmp\fP is a command line utility used to create and maintain the +music database on a variety of portable music players. + +Many Portable music players allow the user to browse tracks by artist, +album, genre, pre-defined 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. \fBeasypmp\fP exists to create that +database, based on the tracks and playlists that are stored on the +player. + +.\".SH OPTIONS" +.\"These programs follow the usual GNU command line syntax, with long" +.\"options starting with two dashes (`-')." +.\"A summary of options is included below." +.\".TP" +.\".B \-h, \-\-help" +.\"Show summary of options." +.\".TP" +.\".B \-V, \-\-version" +.\"Show version of program." +.SH EXAMPLES +These examples assume a media player has been mounted as a normal USB +disk using /media/sda as a mount point. + +Firstly, it is advisable to check that \fBeasypmp\fP can support your +media player: + +.B easypmp /media/sda + +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 +directories, the music database can be constructed as follows: + +.B easypmp -D /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 +running \fBeasypmp\fP several times, it is useful to change to the +mount point directory first, in order to avoid having to specify it +repeatedly. + +.br +.SH AUTHOR +\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. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <suc...@us...> - 2006-07-02 02:35:45
|
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. |
From: <suc...@us...> - 2006-07-02 02:38:22
|
Revision: 103 Author: sucknblow Date: 2006-07-01 19:38:18 -0700 (Sat, 01 Jul 2006) ViewCVS: http://svn.sourceforge.net/pmplib/?rev=103&view=rev Log Message: ----------- Add -d and -l to command synopsis. Modified Paths: -------------- trunk/frontend/easypmp/cui/easypmp.1 Modified: trunk/frontend/easypmp/cui/easypmp.1 =================================================================== --- trunk/frontend/easypmp/cui/easypmp.1 2006-07-02 02:35:37 UTC (rev 102) +++ trunk/frontend/easypmp/cui/easypmp.1 2006-07-02 02:38:18 UTC (rev 103) @@ -18,9 +18,11 @@ .B easypmp .RB [ -c | -u "] [" -p "] [" -m "] [" -R " [" -L .IR level "] ]" +.RB [ -d +.IR device-id ] .RI [ mount-point ] .br -.BR "easypmp " [ -h | -v ] +.BR "easypmp " [ -h | -v | -l ] .SH DESCRIPTION \fBeasypmp\fP is a command line utility used to create and maintain the This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <suc...@us...> - 2006-07-29 17:47:51
|
Revision: 148 Author: sucknblow Date: 2006-07-29 10:47:45 -0700 (Sat, 29 Jul 2006) ViewCVS: http://svn.sourceforge.net/pmplib/?rev=148&view=rev Log Message: ----------- Document the -t/--strip-words option. Modified Paths: -------------- trunk/frontend/easypmp/cui/easypmp.1 Modified: trunk/frontend/easypmp/cui/easypmp.1 =================================================================== --- trunk/frontend/easypmp/cui/easypmp.1 2006-07-29 16:17:38 UTC (rev 147) +++ trunk/frontend/easypmp/cui/easypmp.1 2006-07-29 17:47:45 UTC (rev 148) @@ -16,8 +16,10 @@ easypmp \- create music databases used by portable media players .SH SYNOPSIS .B easypmp -.RB [ -c | -u "] [" -p "] [" -m "] [" -R " [" -L -.IR level "] ]" +.RB [ -c | -u "] [" -p "] [" -m "] [" -t +.IR csv-word-list ] +.RB [ -R " [" -L +.IR level "]]" .RB [ -d .IR device-id ] .RI [ mount-point ] @@ -164,6 +166,29 @@ identifier because it is normally detected automatically, based on the names of system files and directories on the device. .TP +.B \-t \fIcsv-word-list\fP, \-\-strip-words=\fIcsv-word-list\fP +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. + +For example, \fBeasypmp\ -ct\ the\fP will strip the word 'The' +from the start of artist names. Hence, 'The\ Proclaimers' +and 'The\ Cat\ Empire' will appear in the music database +as 'Proclaimers' and 'Cat\ Empire' respectively. + +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: \fBeasypmp -ct 'the,pipes and drums of'\fP. + +When used with the \fB\-u\fP/\fB\-\-update\fP 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 +\fB\-c\fP/\fB\-\-create\fP. This option does not modify music files, +it only has an effect on the music database. +.TP .B \-h, \-\-help Show summary of options. .TP This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |