Git

1 .\" Process this file with
2 .\" groff -man -Tascii foo.1
3 .\"
4 .TH FAPG 1 "JANUARY 2007" Linux "User Manuals"
6 .SH NAME
7 fapg \- Fast Audio Playlist Generator
9 .SH SYNOPSIS
10 .B fapg [
11 .I options
12 .B ]
13 .I /path/to/mp3/dir1 
14 .B [
15 .I /path/to/mp3/dir2 
16 .B ... ]
18 .SH DESCRIPTION
19 .B fapg
20 is a tool to generate list of audio files (Wav, MP2, MP3, Ogg, etc) in various 
21 formats (M3U, PLS, HTML, RSS, etc).  It is very useful if you have a large amount 
22 of audio files and you want to quickly and frequently build a playlist.
23 .P
24 It is coded in C to be as fast as possible, and does not use any specific 
25 audio library (like ID3Lib).  This allow you to deploy it faster and easier, 
26 and to have better performances since the less informations are loaded.
27 On the other hand, this tool is not (yet) compatible with all the known 
28 formats.
30 .SH OPTIONS
31 .IP -b|--backslash
32 Replace the '/' with '\' in Unix path. 
33 .IP -d|--debug
34 Display useful messages if the program fails ;) 
35 .IP -f|--format=m3u|pls|html|rss|pla
36 Choose which format of playlist you want to generate (default is m3u). 
37 .IP -g|--genre=#:#:...
38 Choose which genres (numerical values only) will be included in the generated playlist (default is all).
39 .IP -n|--nohardlink
40 Avoid to parse twice the files because of hardlinks.
41 .IP -o|--output=/path/to/file.m3u
42 Choose the name of the playlist file to generate (default behavior is 
43 to display on standard output). 
44 .IP -p|--prefix=/the/prefix
45 Replace the Unix path with another string (useful to give a Samba path 
46 for example). 
47 .IP -r|--recursive
48 Recursively read the subdirectories. 
49 .IP -w|--windows
50 Replace all Unix characters with Windows characters. 
51 .IP -x|--exclude=#:#:...
52 Choose which genres (numerical values only) will be excluded in the generated playlist (default is none). 
54 .SH EXAMPLES
55 Generate a PLS playlist for an album:
56 .B fapg --format=pls --output=~/path/to/album/list.pls ~/path/to/album
57  
58 You have a file server using Samba which shares a large amount of 
59 audio files for Windows powered computers using Winamp. The directory 
60 on the server containing the files is 
61 .I /samba/mp3 
62 and is visible on the Windows network as 
63 .I \\\\\\\\server\\\\mp3
64 :
65 .B cd /samba/mp3 && fapg --backslash --output=/samba/mp3/list.m3u --prefix='\\\\\\\\server\\\\mp3\\\\' --recursive --windows ./
66  
67 An HTML playlist for an album:
68 .B fapg --output=fapg.html ~/path/to/album
70 A playlist that contains all your classical tracks may receive the genres to include (or exclude) in one or multiple portions
71 .B fapg --genre=32:105 --genre=106:104:103 /path/to/all/music
73 Generate a podcasting XML file using an external program rss.sh to generate a detailed description:
74 .B fapg --output=dir.xml -f rss -c /usr/local/bin/rss.sh -r --prefix=http://thisserver/basedir path/to/mp3
76 Generate a playlist that will work on a Sansa e200 series MP3 player:
77 .B fapg -f pla -o /path/to/playlist.pla /path/to/all/music
79 if command starts with
80 .I intern
81 the build-in description (Author,Title,Link) is generated.
82 Please note that in all given directories ( and in ...basedir/xml ) files called podcast.jpg are referenced.
83 Many header fields are set to defaults using environment variables like LOGNAME or LANG.
86 .SH AUTHOR
87 Antoine Jacquet <royale@zerezo.com>, http://royale.zerezo.com/fapg/. 
88 Manpage by Thomas Kappler <thomas.kappler@stud.uni-karlsruhe.de>.