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] [-o|--output=
  11 .I /path/to/file.m3u
  12 .B ] [-p|--prefix=
  13 .I /the/prefix
  14 .B ] [-r|--recursive] [-w|--windows]
  15 .I /path/to/mp3/dir1
  16 .B [
  17 .I /path/to/mp3/dir2
  18 .B ...]
  19
  20 .SH DESCRIPTION
  21 .B fapg
  22 is a tool to generate list of audio files (Wav, MP3, Ogg, etc) in various
  23 formats (M3U, PLS, HTML, etc).  It is very useful if you have a large amount
  24 of audio files and you want to quickly and frequently build a playlist.
  25 .P
  26 It is coded in C to be as fast as possible, and does not use any specific
  27 audio library (like ID3Lib).  This allow you to deploy it faster and easier,
  28 and to have better performances since the less informations are loaded.
  29 On the other hand, this tool is not (yet) compatible with all the known
  30 formats.
  31
  32 .SH OPTIONS
  33 .IP -b|--backslash
  34 Replace the '/' with '\' in Unix path.
  35 .IP -d|--debug
  36 Display useful messages if the program fails ;)
  37 .IP -f|--format=m3u|pls|html
  38 Choose which format of playlist you want to generate (default is m3u).
  39 .IP -o|--output=/path/to/file.m3u
  40 Choose the name of the playlist file to generate (default behavior is
  41 to display on standard output).
  42 .IP -p|--prefix=/the/prefix
  43 Replace the Unix path with another string (useful to give a Samba path
  44 for example).
  45 .IP -r|--recursive
  46 Recursively read the subdirectories.
  47 .IP -w|--windows
  48 Replace all Unix characters with Windows characters.
  49
  50 .SH EXAMPLES
  51 Generate a PLS playlist for an album:
  52 .B fapg --format=pls --output=~/path/to/album/list.pls ~/path/to/album
  53
  54 You have a file server using Samba which shares a large amount of
  55 audio files for Windows powered computers using Winamp. The directory
  56 on the server containing the files is
  57 .I /samba/mp3
  58 and is visible on the Windows network as
  59 .I \\\\\\\server\\\mp3
  60 :
  61 .B fapg --backslash --output=/samba/mp3/list.m3u --prefix='\\server\mp3\' --recursive --windows /samba/mp3
  62
  63 An HTML playlist for an album:
  64 .B fapg --output=fapg.html ~/path/to/album
  65
  66
  67 .SH AUTHOR
  68 Antoine Jacquet <royale@zerezo.com>, http://royale.zerezo.com/fapg/.
  69 Manpage by Thomas Kappler <thomas.kappler@stud.uni-karlsruhe.de>.