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

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

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.