version 0.21

[FAPG] / fapg.1

diff --git a/fapg.1 b/fapg.1
new file mode 100644 (file)
index 0000000..096ddcf
--- /dev/null
+++ b/fapg.1
@@ -0,0 +1,69 @@
+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.TH FAPG 1 "APRIL 2004" Linux "User Manuals"
+
+.SH NAME
+fapg \- Fast Audio Playlist Generator
+
+.SH SYNOPSIS
+.B fapg [-b|--backslash] [-d|--debug] [-f|--format=m3u|pls|html] [-o|--output=
+.I /path/to/file.m3u
+.B ] [-p|--prefix=
+.I /the/prefix
+.B ] [-r|--recursive] [-w|--windows] 
+.I /path/to/mp3/dir1 
+.B [
+.I /path/to/mp3/dir2 
+.B ...] 
+
+.SH DESCRIPTION
+.B fapg
+is a tool to generate list of audio files (Wav, MP3, Ogg, etc) in various 
+formats (M3U, PLS, HTML, etc).  It is very useful if you have a large amount 
+of audio files and you want to quickly and frequently build a playlist.
+.P
+It is coded in C to be as fast as possible, and does not use any specific 
+audio library (like ID3Lib).  This allow you to deploy it faster and easier, 
+and to have better performances since the less informations are loaded.
+On the other hand, this tool is not (yet) compatible with all the known 
+formats.
+
+.SH OPTIONS
+.IP -b|--backslash
+Replace the '/' with '\' in Unix path. 
+.IP -d|--debug
+Display useful messages if the program fails ;) 
+.IP -f|--format=m3u|pls|html
+Choose which format of playlist you want to generate (default is m3u). 
+.IP -o|--output=/path/to/file.m3u
+Choose the name of the playlist file to generate (default behavior is 
+to display on standard output). 
+.IP -p|--prefix=/the/prefix
+Replace the Unix path with another string (useful to give a Samba path 
+for example). 
+.IP -r|--recursive
+Recursively read the subdirectories. 
+.IP -w|--windows
+Replace all Unix characters with Windows characters. 
+
+.SH EXAMPLES
+Generate a PLS playlist for an album:
+.B fapg --format=pls --output=~/path/to/album/list.pls ~/path/to/album
+ 
+You have a file server using Samba which shares a large amount of 
+audio files for Windows powered computers using Winamp. The directory 
+on the server containing the files is 
+.I /samba/mp3 
+and is visible on the Windows network as 
+.I \\\\\\\server\\\mp3
+:
+.B fapg --backslash --output=/samba/mp3/list.m3u --prefix='\\server\mp3\' --recursive --windows /samba/mp3
+ 
+An HTML playlist for an album:
+.B fapg --output=fapg.html ~/path/to/album
+
+
+.SH AUTHOR
+Antoine Jacquet <royale@zerezo.com>, http://royale.zerezo.com/fapg/. 
+Manpage by Thomas Kappler <thomas.kappler@stud.uni-karlsruhe.de>.