git - mp3togo/blob

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2
   3 <!-- Process this file with docbook-to-man to generate an nroff manual
   4      page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
   5      the manual page with: `docbook-to-man manpage.sgml | nroff -man |
   6      less'.  A typical entry in a Makefile or Makefile.am is:
   7
   8 manpage.1: manpage.sgml
   9         docbook-to-man $< > $@
  10
  11
  12         The docbook-to-man binary is found in the docbook-to-man package.
  13         Please remember that if you create the nroff version in one of the
  14         debian/rules file targets (such as build), you will need to include
  15         docbook-to-man in your Build-Depends control field.
  16
  17   -->
  18
  19   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  20   <!ENTITY dhfirstname "<firstname>Simeon</firstname>">
  21   <!ENTITY dhsurname   "<surname>Veldstra</surname>">
  22   <!-- Please adjust the date whenever revising the manpage. -->
  23   <!ENTITY dhdate      "<date>April 26, 2006</date>">
  24   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  25        allowed: see man(7), man(1). -->
  26   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  27   <!ENTITY dhemail     "<email>reallifesim@gmail.com</email>">
  28   <!ENTITY dhusername  "Simeon Veldstra">
  29   <!ENTITY dhucpackage "<refentrytitle>MP3TOGO</refentrytitle>">
  30   <!ENTITY dhpackage   "mp3togo">
  31
  32   <!ENTITY debian      "<productname>Debian</productname>">
  33   <!ENTITY gnu         "<acronym>GNU</acronym>">
  34   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  35 ]>
  36
  37 <refentry>
  38   <refentryinfo>
  39     <address>
  40       &dhemail;
  41     </address>
  42     <author>
  43       &dhfirstname;
  44       &dhsurname;
  45     </author>
  46     <copyright>
  47       <year>2003</year>
  48       <holder>&dhusername;</holder>
  49     </copyright>
  50     &dhdate;
  51   </refentryinfo>
  52   <refmeta>
  53     &dhucpackage;
  54
  55     &dhsection;
  56   </refmeta>
  57   <refnamediv>
  58     <refname>&dhpackage;</refname>
  59
  60     <refpurpose>program to load music on a mp3 player</refpurpose>
  61   </refnamediv>
  62   <refsynopsisdiv>
  63     <cmdsynopsis>
  64       <command>&dhpackage;</command>
  65
  66       <arg><option>options</option></arg>
  67
  68       <arg><option><replaceable>file(s)</replaceable></option></arg>
  69     </cmdsynopsis>
  70   </refsynopsisdiv>
  71
  72   <refsect1>
  73     <title>DESCRIPTION</title>
  74
  75     <para>This manual page documents briefly the
  76       <command>&dhpackage;</command> commands.</para>
  77
  78     <para><command>&dhpackage;</command> is a program that creates
  79           files for a portable mp3 player or a mp3 CD from higher quality
  80           files in various formats in a permanent archive.</para>
  81   </refsect1>
  82
  83   <refsect1>
  84     <title>OPTIONS</title>
  85
  86     <para>This program follow the usual &gnu; command line syntax,
  87       with long options starting with two dashes (`-').  A summary of
  88       options is included below.</para>
  89
  90     <!-- See mp3togo.setup.Options().manpage() for a cheat. -->
  91     <variablelist>
  92       <varlistentry>
  93         <term>
  94           <option>-c</option>
  95           <option>--config</option>
  96         </term>
  97         <listitem>
  98           <para> The location of the config file. (If it exists.)
  99           </para>
 100         </listitem>
 101       </varlistentry>
 102       <varlistentry>
 103         <term>
 104           <option>-s</option>
 105           <option>--save-config</option>
 106         </term>
 107         <listitem>
 108           <para> Write out a new config file with the options given and
 109              exit. To save the configuration to a different file, set
 110              --config to the desired filename. The file, if it exists, will
 111              be overwritten.
 112           </para>
 113         </listitem>
 114       </varlistentry>
 115       <varlistentry>
 116         <term>
 117           <option>--no-config-file</option>
 118         </term>
 119         <listitem>
 120           <para> Disable reading from and writing to the config file.
 121           </para>
 122         </listitem>
 123       </varlistentry>
 124       <varlistentry>
 125         <term>
 126           <option>-v</option>
 127           <option>--verbose</option>
 128         </term>
 129         <listitem>
 130           <para> Set the verbosity level. A value of 0 will produce no
 131              output (except option parsing errors).
 132           </para>
 133         </listitem>
 134       </varlistentry>
 135       <varlistentry>
 136         <term>
 137           <option>-h</option>
 138           <option>--help</option>
 139         </term>
 140         <listitem>
 141           <para> Print this message.
 142           </para>
 143         </listitem>
 144       </varlistentry>
 145       <varlistentry>
 146         <term>
 147           <option>-t</option>
 148           <option>--file-tag</option>
 149         </term>
 150         <listitem>
 151           <para> A string appended to the name of the file to indicate it
 152              has been recoded.
 153           </para>
 154         </listitem>
 155       </varlistentry>
 156       <varlistentry>
 157         <term>
 158           <option>-w</option>
 159           <option>--work-dir</option>
 160         </term>
 161         <listitem>
 162           <para> The path to store temporary files. This could need several
 163              hundred megabytes free.
 164           </para>
 165         </listitem>
 166       </varlistentry>
 167       <varlistentry>
 168         <term>
 169           <option>-d</option>
 170           <option>--tree-depth</option>
 171         </term>
 172         <listitem>
 173           <para> The number of directory levels to preserve in the output
 174              tree. Use 0 to put all output files directly into the target
 175              directory. Use 2 to create a directory for the Artist and then
 176              the Album (Assuming your music collection is organized in
 177              directories by artist then album).
 178           </para>
 179         </listitem>
 180       </varlistentry>
 181       <varlistentry>
 182         <term>
 183           <option>-m</option>
 184           <option>--max-size</option>
 185         </term>
 186         <listitem>
 187           <para> The disk space available to use in bytes. Append 'M' for
 188              megabytes, 'G' for gigabytes or 'K' for kilobytes. Use 0 to
 189              use all available space on the filesystem.
 190           </para>
 191         </listitem>
 192       </varlistentry>
 193       <varlistentry>
 194         <term>
 195           <option>-F</option>
 196           <option>--force</option>
 197         </term>
 198         <listitem>
 199           <para> Overwrite files if they already exist.
 200           </para>
 201         </listitem>
 202       </varlistentry>
 203       <varlistentry>
 204         <term>
 205           <option>-C</option>
 206           <option>--encoder</option>
 207         </term>
 208         <listitem>
 209           <para> The encoder to use to create the output files. Options are
 210              wave, lame or oggenc.
 211           </para>
 212         </listitem>
 213       </varlistentry>
 214       <varlistentry>
 215         <term>
 216           <option>-E</option>
 217           <option>--encoder-options</option>
 218         </term>
 219         <listitem>
 220           <para> Compression options for the encoder.
 221           </para>
 222         </listitem>
 223       </varlistentry>
 224       <varlistentry>
 225         <term>
 226           <option>-z</option>
 227           <option>--compression-factor</option>
 228         </term>
 229         <listitem>
 230           <para> If you change the lame options, you must change this
 231              factor to match the compression rate of the new options. This
 232              is used to estimate completed file size.
 233           </para>
 234         </listitem>
 235       </varlistentry>
 236       <varlistentry>
 237         <term>
 238           <option>-h</option>
 239           <option>--help</option>
 240         </term>
 241         <listitem>
 242           <para> Print this message.
 243           </para>
 244         </listitem>
 245       </varlistentry>
 246       <varlistentry>
 247         <term>
 248           <option>-p</option>
 249           <option>--playlist</option>
 250         </term>
 251         <listitem>
 252           <para> The playlist to convert. Playlists can be simple lists of
 253              file paths, one per line, or .m3u files or the native XMMS
 254              playlist file format.
 255           </para>
 256         </listitem>
 257       </varlistentry>
 258       <varlistentry>
 259         <term>
 260           <option>-x</option>
 261           <option>--import-xmms</option>
 262         </term>
 263         <listitem>
 264           <para> Get playlist from running instance of XMMS. (You must have
 265              xmms-shell installed)
 266           </para>
 267         </listitem>
 268       </varlistentry>
 269       <varlistentry>
 270         <term>
 271           <option>-o</option>
 272           <option>--output-dir</option>
 273         </term>
 274         <listitem>
 275           <para> Where to write the output files.
 276           </para>
 277         </listitem>
 278       </varlistentry>
 279       <varlistentry>
 280         <term>
 281           <option>--index</option>
 282         </term>
 283         <listitem>
 284           <para> Create an index file when in wav output mode.
 285           </para>
 286         </listitem>
 287       </varlistentry>
 288       <varlistentry>
 289         <term>
 290           <option>--no-normalize</option>
 291         </term>
 292         <listitem>
 293           <para> Don't normalize the wav file before encoding.
 294           </para>
 295         </listitem>
 296       </varlistentry>
 297     </variablelist>
 298   </refsect1>
 299
 300   <refsect1>
 301     <title>FILES</title>
 302         <para>mp3togo will read ~./mp3togo for configuration values if it
 303           exists. This can be overridden with the --config command line
 304           option.</para>
 305   </refsect1>
 306
 307   <refsect1>
 308     <title>SEE ALSO</title>
 309     <para>lame (1), oggenc (1).</para>
 310   </refsect1>
 311
 312   <refsect1>
 313     <title>EXAMPLES</title>
 314
 315         <para>Load the files in playlist.m3u to the player mounted
 316           on /mnt/usb:
 317           <command>mp3togo -p playlist.m3u -o /mnt/usb</command>
 318         </para>
 319
 320         <para>Load a single file to the player:
 321           <command>mp3togo -o /mnt/usb /home/media/Music/Nina_Simone/The_Blues/Turn_Me_On.ogg</command>
 322         </para>
 323
 324         <para>Load the playlist from the running XMMS to /mnt/usb in
 325           ogg vorbis format: (requires xmms-shell)
 326           <command>mp3togo -C oggenc -x -o /mnt/usb</command>
 327         </para>
 328
 329         <para>Create wav files in ~/audio-cd to burn a CD from playlist.m3u:
 330           <command>mp3togo -C wave -p playlist.m3u -m 700M -o ~/audio-cd</command>
 331         </para>
 332
 333         <para>Create mp3 files on a mounted ISO CD image at /mnt/loop to
 334           burn a mp3 CD:
 335           <command>mp3togo -p playlist.m3u -o /mnt/loop</command>
 336         </para>
 337   </refsect1>
 338
 339   <refsect1>
 340     <title>AUTHOR</title>
 341
 342     <para>This manual page was written by &dhusername; &dhemail; for
 343       the &debian; system (but may be used by others).  Permission is
 344       granted to copy, distribute and/or modify this document under
 345       the terms of the &gnu; General Public License, Version 2 any
 346           later version published by the Free Software Foundation.
 347     </para>
 348         <para>
 349           On Debian systems, the complete text of the GNU General Public
 350           License can be found in /usr/share/common-licenses/GPL.
 351         </para>
 352     <para>
 353           mp3togo can be found online at http://puddle.ca/mp3togo
 354         </para>
 355   </refsect1>
 356 </refentry>
 357
 358 <!-- Keep this comment at the end of the file
 359 Local variables:
 360 mode: sgml
 361 sgml-omittag:t
 362 sgml-shorttag:t
 363 sgml-minimize-attributes:nil
 364 sgml-always-quote-attributes:t
 365 sgml-indent-step:2
 366 sgml-indent-data:t
 367 sgml-parent-document:nil
 368 sgml-default-dtd-file:nil
 369 sgml-exposed-tags:nil
 370 sgml-local-catalogs:nil
 371 sgml-local-ecat-files:nil
 372 End:
 373 -->
 374
 375