git - mp3togo/blob

   1 .TH "MP3TOGO" "1"
   2 .SH "NAME"
   3 mp3togo \(em program to load music on a mp3 player
   4 .SH "SYNOPSIS"
   5 .PP
   6 \fBmp3togo\fR [\fBoptions\fP]  [\fB\fIfile(s)\fR\fP]
   7 .SH "DESCRIPTION"
   8 .PP
   9 This manual page documents briefly the
  10 \fBmp3togo\fR commands.
  11 .PP
  12 \fBmp3togo\fR is a program that creates
  13 files for a portable mp3 player or a mp3 CD from higher quality
  14 files in various formats in a permanent archive.
  15 .SH "OPTIONS"
  16 .PP
  17 This program follow the usual GNU command line syntax,
  18 with long options starting with two dashes (`\-').  A summary of
  19 options is included below.
  20 .IP "          \fB-c\fP           \fB\-\-config\fP         " 10
  21 The location of the config file. (If it exists.)
  22
  23 .IP "          \fB-s\fP           \fB\-\-save-config\fP         " 10
  24 Write out a new config file with the options given and
  25 exit. To save the configuration to a different file, set
  26 \-\-config to the desired filename. The file, if it exists, will
  27 be overwritten.
  28
  29 .IP "          \fB\-\-no-config-file\fP         " 10
  30 Disable reading from and writing to the config file.
  31
  32 .IP "          \fB-v\fP           \fB\-\-verbose\fP         " 10
  33 Set the verbosity level. A value of 0 will produce no
  34 output (except option parsing errors).
  35
  36 .IP "          \fB-h\fP           \fB\-\-help\fP         " 10
  37 Print this message.
  38
  39 .IP "          \fB-t\fP           \fB\-\-file-tag\fP         " 10
  40 A string appended to the name of the file to indicate it
  41 has been recoded.
  42
  43 .IP "          \fB-w\fP           \fB\-\-work-dir\fP         " 10
  44 The path to store temporary files. This could need several
  45 hundred megabytes free.
  46
  47 .IP "          \fB-d\fP           \fB\-\-tree-depth\fP         " 10
  48 The number of directory levels to preserve in the output
  49 tree. Use 0 to put all output files directly into the target
  50 directory. Use 2 to create a directory for the Artist and then
  51 the Album (Assuming your music collection is organized in
  52 directories by artist then album).
  53
  54 .IP "          \fB-m\fP           \fB\-\-max-size\fP         " 10
  55 The disk space available to use in bytes. Append 'M' for
  56 megabytes, 'G' for gigabytes or 'K' for kilobytes. Use 0 to
  57 use all available space on the filesystem.
  58
  59 .IP "          \fB-F\fP           \fB\-\-force\fP         " 10
  60 Overwrite files if they already exist.
  61
  62 .IP "          \fB-C\fP           \fB\-\-encoder\fP         " 10
  63 The encoder to use to create the output files. Options are
  64 wave, lame or oggenc.
  65
  66 .IP "          \fB-E\fP           \fB\-\-encoder-options\fP         " 10
  67 Compression options for the encoder.
  68
  69 .IP "          \fB-z\fP           \fB\-\-compression-factor\fP         " 10
  70 If you change the lame options, you must change this
  71 factor to match the compression rate of the new options. This
  72 is used to estimate completed file size.
  73
  74 .IP "          \fB-h\fP           \fB\-\-help\fP         " 10
  75 Print this message.
  76
  77 .IP "          \fB-p\fP           \fB\-\-playlist\fP         " 10
  78 The playlist to convert. Playlists can be simple lists of
  79 file paths, one per line, or .m3u files or the native XMMS
  80 playlist file format.
  81
  82 .IP "          \fB-x\fP           \fB\-\-import-xmms\fP         " 10
  83 Get playlist from running instance of XMMS. (You must have
  84 xmms-shell installed)
  85
  86 .IP "          \fB-o\fP           \fB\-\-output-dir\fP         " 10
  87 Where to write the output files.
  88
  89 .IP "          \fB\-\-index\fP         " 10
  90 Create an index file when in wav output mode.
  91
  92 .IP "          \fB\-\-no-normalize\fP         " 10
  93 Don't normalize the wav file before encoding.
  94
  95 .SH "FILES"
  96 .PP
  97 mp3togo will read ~./mp3togo for configuration values if it
  98 exists. This can be overridden with the \-\-config command line
  99 option.
 100 .SH "SEE ALSO"
 101 .PP
 102 lame (1), oggenc (1).
 103 .SH "EXAMPLES"
 104 .PP
 105 Load the files in playlist.m3u to the player mounted
 106 on /mnt/usb:
 107 \fBmp3togo \-p playlist.m3u \-o /mnt/usb\fR
 108 .PP
 109 Load a single file to the player:
 110 \fBmp3togo \-o /mnt/usb /home/media/Music/Nina_Simone/The_Blues/Turn_Me_On.ogg\fR
 111 .PP
 112 Load the playlist from the running XMMS to /mnt/usb in
 113 ogg vorbis format: (requires xmms-shell)
 114 \fBmp3togo \-C oggenc \-x \-o /mnt/usb\fR
 115 .PP
 116 Create wav files in ~/audio-cd to burn a CD from playlist.m3u:
 117 \fBmp3togo \-C wave \-p playlist.m3u \-m 700M \-o ~/audio-cd\fR
 118 .PP
 119 Create mp3 files on a mounted ISO CD image at /mnt/loop to
 120 burn a mp3 CD:
 121 \fBmp3togo \-p playlist.m3u \-o /mnt/loop\fR
 122 .SH "AUTHOR"
 123 .PP
 124 This manual page was written by Simeon Veldstra reallifesim@gmail.com for
 125 the \fBDebian\fP system (but may be used by others).  Permission is
 126 granted to copy, distribute and/or modify this document under
 127 the terms of the GNU General Public License, Version 2 any
 128 later version published by the Free Software Foundation.
 129
 130 .PP
 131 On Debian systems, the complete text of the GNU General Public
 132 License can be found in /usr/share/common-licenses/GPL.
 133
 134 .PP
 135 mp3togo can be found online at http://puddle.ca/mp3togo
 136
 137 .\" created by instant / docbook-to-man, Tue 04 Jul 2006, 06:03