
july the eleventh, twothousandandfive


=== introduction ===

hi everyone! someone has asked me to make some documentation for the script, so here it is.


=== how to make use of the various natures of the script ===

	* to install it as a nautilus script, follow the instructions on this link: http://g-scripts.sourceforge.net/faq.php

	* to install it as a rox script, 

	* to use it as a plain bash script, provided you have access to an x session and have zenity installed, simply type: path/to/audio-convert path/to/filename... and specify as many filenames as you want. they will be processed one by one, just as it happens when you select multiple files on nautilus or rox.


=== what do some values mean? ===

	* i hope quality choice for mp3, ogg, and mpc formats are pretty self-explanatory. if they're not, please let me know. all i can explain for now is that they are in asending order. the first parameter is the lowest quality possible, whereas the last one is the highest quality. the suggested value is usually close to best.
	* as far as flac and ape formats go, maybe there is some explainin' to do. the values are all in ascending order, like all the other ones. but since these are lossless formats, why would one have to choose the quality? quality in this case stands for 'quality of compression'. the highest the quality, the more compressed the resultin' files. not that while choosin' the highest quality is generally the best thing to do, it *will* take longer to compress the files.


=== the end ===

this is it for now. i will update this document in case i feel like, or in case you suggest me some really good improvements to it. and remember, please make suggestions about how to make the script better, point me out bugs, and let me know what you think, either at the main page of this project, http://savannah.nongnu.org/projects/audio-convert/, or at my email address, <thetroublemaker@inventati.org>! enjoy! : )
