summaryrefslogtreecommitdiff
path: root/doc/soundconverter.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/soundconverter.1')
-rw-r--r--doc/soundconverter.149
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/soundconverter.1 b/doc/soundconverter.1
new file mode 100644
index 0000000..d25f075
--- /dev/null
+++ b/doc/soundconverter.1
@@ -0,0 +1,49 @@
+.TH SOUNDCONVERTER 1 2009-06-10 "GNOME" "GNOME User's Manual"
+.SH NAME
+soundconverter \- convert sound files to other formats
+.SH SYNOPSIS
+.BR soundconverter " [options] [file...]"
+.SH DESCRIPTION
+.B soundconverter
+is a simple tool for converting sound files to other formats.
+It can work from the command line, but is really meant for interactive
+use in the GNOME environment.
+.SH OPTIONS
+.TP
+.BR \-h ", "\-\-help
+Print out a usage summary.
+.TP
+.BR \-b ", "\-\-batch
+Convert in batch mode, from command line, without a graphical user interface.
+You can use this from, say, shell scripts.
+.TP
+.BR \-m ", "\-\-mime\-type " \fIarg\fR"
+Set the output MIME type for batch mode.
+The default is audio/x-vorbis.
+Note that you probably want to set the output suffix as well.
+You can also use shortcuts: aac, flac, mp3, vorbis, wav.
+.TP
+.BR \-q ", "\-\-quiet
+Be quiet.
+Don't write normal output, only errors.
+.TP
+.BR \-d ", "\-\-debug
+Print additional debug information.
+.TP
+.BR \-s ", "\-\-suffix " \fIarg\fR"
+Set the output filename suffix for batch mode.
+The default is .ogg.
+Note that the suffix does not affect the output MIME type.
+.TP
+.BR \-t ", "\-\-tags
+Show tags for input files instead of converting them.
+This indicates command line batch mode and disables the
+graphical user interface.
+.TP
+.BR \-j ", "\-\-jobs= "
+Force number of concurent conversions.
+Default is one per present CPU.
+.SH AUTHOR
+Lars Wirzenius (liw@iki.fi).
+Gautier Portet (kassoulet@gmail.com)
+Uwe Bugla (uwe.bugla@gmx.de).