version 0.41

[FAPG] / fapg.1

diff --git a/fapg.1 b/fapg.1
index 096ddcf..9085fdd 100644 (file)
--- a/fapg.1
+++ b/fapg.1
@@ -1,26 +1,24 @@
 .\" Process this file with
 .\" groff -man -Tascii foo.1
 .\"
-.TH FAPG 1 "APRIL 2004" Linux "User Manuals"
+.TH FAPG 1 "JANUARY 2007" 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] 
+.B fapg [
+.I options
+.B ]
 .I /path/to/mp3/dir1 
 .B [
 .I /path/to/mp3/dir2 
-.B ...] 
+.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 
+is a tool to generate list of audio files (Wav, MP2, MP3, Ogg, etc) in various 
+formats (M3U, PLS, XSPF, HTML, RSS, 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 
@@ -34,8 +32,12 @@ formats.
 Replace the '/' with '\' in Unix path. 
 .IP -d|--debug
 Display useful messages if the program fails ;) 
-.IP -f|--format=m3u|pls|html
+.IP -f|--format=m3u|pls|xspf|html|rss|pla|txx
 Choose which format of playlist you want to generate (default is m3u). 
+.IP -g|--genre=#:#:...
+Choose which genres (numerical values only) will be included in the generated playlist (default is all).
+.IP -n|--nohardlink
+Avoid to parse twice the files because of hardlinks.
 .IP -o|--output=/path/to/file.m3u
 Choose the name of the playlist file to generate (default behavior is 
 to display on standard output). 
@@ -46,6 +48,12 @@ for example).
 Recursively read the subdirectories. 
 .IP -w|--windows
 Replace all Unix characters with Windows characters. 
+.IP -x|--exclude=#:#:...
+Choose which genres (numerical values only) will be excluded in the generated playlist (default is none). 
+.IP -c|--command=<intern|...>
+External binary or script that produces additional fields for RSS feeds (slow).
+.IP -s|--stdin
+Read filenames and/or directories from standard input instead of command line.
 
 .SH EXAMPLES
 Generate a PLS playlist for an album:
@@ -56,13 +64,28 @@ 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
+.I \\\\\\\\server\\\\mp3
 :
-.B fapg --backslash --output=/samba/mp3/list.m3u --prefix='\\server\mp3\' --recursive --windows /samba/mp3
+.B cd /samba/mp3 && fapg --backslash --output=/samba/mp3/list.m3u --prefix='\\\\\\\\server\\\\mp3\\\\' --recursive --windows ./
  
 An HTML playlist for an album:
 .B fapg --output=fapg.html ~/path/to/album
 
+A playlist that contains all your classical tracks may receive the genres to include (or exclude) in one or multiple portions
+.B fapg --genre=32:105 --genre=106:104:103 /path/to/all/music
+
+Generate a podcasting XML file using an external program rss.sh to generate a detailed description:
+.B fapg --output=dir.xml -f rss -c /usr/local/bin/rss.sh -r --prefix=http://thisserver/basedir path/to/mp3
+
+Generate a playlist that will work on a Sansa e200 series MP3 player:
+.B fapg -f pla -o /path/to/playlist.pla /path/to/all/music
+
+if command starts with
+.I intern
+the build-in description (Author,Title,Link) is generated.
+Please note that in all given directories ( and in ...basedir/xml ) files called podcast.jpg are referenced.
+Many header fields are set to defaults using environment variables like LOGNAME or LANG.
+
 
 .SH AUTHOR
 Antoine Jacquet <royale@zerezo.com>, http://royale.zerezo.com/fapg/.