royale.zerezo.com Git - FAPG/blob - fapg.1

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