ScriptFanix/AtOM
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
Vincent Riquer 2013-03-09 14:36:28 +01:00
parent 3833a1cdf1
commit d334c308ed
2 changed files with 43 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README
View File

@ -1,5 +1,39 @@
AtOM: Anything to Ogg and Mp3 AtOM: Anything to Ogg and Mp3
URL: http://gitorious.org/atom
Author: Vincent Riquer <vincent+prog.atom@riquer.fr> Author: Vincent Riquer <vincent+prog.atom@riquer.fr>
Copyright/left: 2012 Vincent Riquer - GPLv3 (see doc/GPL-3) Copyright/left: 2012-2013 Vincent Riquer - GPLv3 (see doc/GPL-3)
except: transogg: WTFPL 2.0 except: transogg: WTFPL 2.0
============
Dependencies
------------
Required:
* bash (>= 4.0)
http://www.gnu.org/software/bash/bash.html
* SoX
http://sox.sourceforge.net/
* SQLite
http://www.sqlite.org/
Optional:
* vorbis-tools
http://www.vorbis.com/
* ogginfo (Ogg Vorbis tags support)
* oggenc (Ogg Vorbis destination)
* LAME MP3 Encoder
http://lame.sourceforge.net/
* lame (MP3 destination)
* FLAC
http://flac.sourceforge.net/
* metaflac (FLAC tags support)
* Musepack
http://www.musepack.net/
* mpcdec (Musepack tags support, Musepack decoding)
==================
Using the software
------------------
Configuration:
Please read doc/config before anything else.

13
doc/config
View File

@ -4,7 +4,7 @@ Default config file is ~/.atom/atom.cfg.
The file is divided in sections, beginning with [<sectionname>]. The section The file is divided in sections, beginning with [<sectionname>]. The section
ends where the next one begins. Inside each sections, properties are defined ends where the next one begins. Inside each sections, properties are defined
with <key><space><value>, where <space can be either spaces, tabulations, or a with <key><space><value>, where <space> can be either spaces, tabulations, or a
mix of both. <key> is always a single word. <value> shall never be quoted, mix of both. <key> is always a single word. <value> shall never be quoted,
whether it contains spaces or not. whether it contains spaces or not.
@ -26,13 +26,14 @@ Sections:
too quickly. Set this too high, and AtOM will not adapt quickly enough to too quickly. Set this too high, and AtOM will not adapt quickly enough to
load increase. In both cases, your hard drive will suffer. In my load increase. In both cases, your hard drive will suffer. In my
experience, 30 seconds is a good value. experience, 30 seconds is a good value.
* temporary-directory <directory>: String. Name speaks for itself:this is where FIFOs (for * temporary-directory <directory>: String. Name speaks for itself: this is
communicating with sqlite) and temporary WAVE files will be created. where FIFOs (for communicating with sqlite) and temporary WAVE files will
Note that debug logs (if enabled) will go there too. be created. Note that debug logs (if enabled) will go there too.
Default: ~/.atom/tmp Default: ~/.atom/tmp
* database <file>: String. Where the SQLite databse should be stored. * database <file>: String. Where the SQLite databse should be stored.
Default: ~/.atom/atom.db Default: ~/.atom/atom.db
* debug <level>: Integer. Currently defined values: * debug <level>: Integer. Currently defined values:
* 1: few additional status informations.
* 3: log SQL queries. * 3: log SQL queries.
[source] [source]
@ -49,8 +50,8 @@ Sections:
Common parameters: Common parameters:
Mandatory parameters: Mandatory parameters:
* path: Where files will be written * path: Where files will be written
* format: ogg or mp3 (other formats may appear in the future - feel free to * format: ogg or mp3. Other formats may appear in the future - feel free to
implement your preferred format. A good candidate is FIXME). implement your preferred format. A good candidate is Opus (RFC 6716).
Optional parameters: Optional parameters:
* normalize <yes>/<no>: Normalize output files. * normalize <yes>/<no>: Normalize output files.