src/mp3tool/mp3tool.adoc

   1 = MP3Tool
   2 :docinfo2:
   3 :icon: font
   4
   5 The MP3 files contain information about the name of the artist, the
   6 name of the album, the sound title, etc.
   7
   8 MP3Tool is a command line tool for moving a MP3 file according to these
   9 information. It can also output the information.
  10
  11 == Usage
  12
  13 === Display MP3 information
  14
  15 Displays the MP3 information of the file ‘file.mp3’:
  16
  17 ----
  18 mp3tool -i PATTERN file.mp3
  19 ----
  20
  21 The format string `PATTERN` controls the contents of the mp3tool
  22 output.  It can contains MP3 tag information variables.  Move a MP3
  23 file
  24
  25 Moves `files.mp3` to `dest`:
  26
  27 ----
  28 mp3tool -m PATTERN file.mp3
  29 ----
  30
  31 The `PATTERN` string can contain MP3 tag information variables.
  32
  33 MP3 tag information variables:
  34
  35 * %c comment
  36
  37 * %a name of the artist
  38
  39 * %l name of the album
  40
  41 * %t title
  42
  43 * %y year
  44
  45 * %% percent
  46
  47 * %n newline
  48
  49 Examples:
  50
  51 ----
  52 mp3tool -m "%a/%l/%f" file.mp3
  53 ----
  54
  55 will move `file.mp3` into the directory `artist/album`.
  56
  57 ----
  58 mp3tool -m "%a - %l - %t.mp3" file.mp3
  59 ----
  60
  61 will rename `file.mp3` to `artist – album – title.mp3`.
  62
  63 == Installation for Ubuntu
  64
  65 The easy way to install mp3tool on Ubuntu is to use the PPA:
  66
  67 ----
  68 sudo apt-add-repository ppa:jfi/mp3tool
  69 sudo apt-get update
  70 sudo apt-get install mp3tool
  71 ----
  72
  73 Alternatively, it can be installed manually by downloading Ubuntu
  74 binary packages, see the ‘Download Links’ section of this page.
  75
  76 == Installation from source archive
  77
  78 MP3Tool should compile on any Linux plateform:
  79
  80 ----
  81 make clean all
  82 ----
  83
  84 Then perform the installation:
  85
  86 ----
  87 make install
  88 ----
  89
  90 == Download Links
  91
  92 * link:files[Source archives].
  93
  94 == Contact Information
  95
  96 Bugs and comments can be sent to wpitchoune@gmail.com.
  97
  98 Released under GPLv2 license terms.