diff --git a/ChangeLog b/ChangeLog index a7ebd1654..dccd02a77 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,9 @@ 2008-08-19 Tobias Doerffel + * src/core/main.cpp: + * lmms.1: + improved documentation of commandline options + * src/core/main.cpp: * src/core/project_renderer.cpp: improved progress information when rendering at console diff --git a/lmms.1 b/lmms.1 index 12c6542f1..03ff31f73 100644 --- a/lmms.1 +++ b/lmms.1 @@ -19,8 +19,13 @@ lmms \- software for easy music-production .SH SYNOPSIS .B lmms -.RB "[ \-\fBr\fP \fIfile\fP ]" -.RB "[ \-\fBo\fP \fIformat\fP ]" +.RB "[ \--\fBrender\fP \fIfile\fP ] [options]" +.br +.B lmms +.RB "[ \--\fBupgrade\fP \fIin\fP \fIout\fP ]" +.br +.B lmms +.RB "[ \--\fBdump\fP \fIin\fP ]" .br .B lmms .RI "[ file ]" @@ -35,16 +40,32 @@ aims to be a free alternative to popular (but commercial and closed-source) prog LMMS combines the features of a sequencer-program (pattern-/channel-/sample-/song-/effect-management) and those of powerful instrument-plugins and plugin-hosters (such as LADSPA and VST) in a modern, user-friendly and easy to use graphical user-interface. .SH OPTIONS -.IP "\fB\-r, --render\fP \fIfile\fP -Render given file to either a wav\- or ogg\-file. See \fB\-o\fP for details -.IP "\fB\-o, --output\fP \fIformat\fP +.IP "\fB\-r, --render\fP \fIproject-file\fP +Render given file to either a wav\- or ogg\-file. See \fB\-f\fP for details +.IP "\fB\-o, --output\fP \fIfile\fP +render into \fIfile\fP +.IP "\fB\-f, --output-format\fP \fIformat\fP Specify format of render-output where \fIformat\fP is either 'wav' or 'ogg' +.IP "\fB\-s, --samplerate\fP \fIsamplerate\fP +Specify output samplerate in Hz - range is 44100 (default) to 192000 +.IP "\fB\-b, --bitrate\fP \fIbitrate\fP +Specify output bitrate in kHz (for OGG encoding only), default is 160 +.IP "\fB\-i, --interpolation\fP \fImethod\fP +Specify interpolation method - possible values are \fIlinear\fP, \fIsincfastest\fP (default), \fIsincmedium\fP, \fIsincbest\fP +.IP "\fB\-i, --interpolation\fP \fImethod\fP +Specify interpolation method - possible values are \fIlinear\fP, \fIsincfastest\fP (default), \fIsincmedium\fP, \fIsincbest\fP +.IP "\fB\-x, --oversampling\fP \fIvalue\fP +Specify oversampling, posible values: 1, 2 (default), 4, 8 +.IP "\fB\-u, --upgrade\fP \fIin\fP \fIout\fP +Upgrade file \fIin\fP and save as \fIout\fP +.IP "\fB\-d, --dump\fP \fIin\fP +Dump XML of compressed file \fIin\fP (i.e. MMPZ-file) +.IP "\fB\-v, --version +Show version information and exit. +.IP "\fB\-h, --help +Show usage information and exit. .SH SEE ALSO .BR http://lmms.sf.net/ - -.BR http://wiki.mindrules.net/ -.SH AUTHOR -lmms was written by Tobias Doerffel and others. See AUTHORS for details. -.PP -This manual page was written by Florian Ragwitz and -Tobias Doerffel , for the Debian project (but may be used by others). +.BR http://lmms.sf.net/wiki/ +.SH AUTHORS +.BR Tobias Doerffel , Paul Giblock and others. See AUTHORS for details. diff --git a/src/core/main.cpp b/src/core/main.cpp index f6d5b356b..f1ed75a71 100644 --- a/src/core/main.cpp +++ b/src/core/main.cpp @@ -129,32 +129,32 @@ int main( int argc, char * * argv ) { printf( "\nLinux MultiMedia Studio %s\n" "Copyright (c) 2004-2008 LMMS developers.\n\n" - "usage: lmms [ -r [ -f ] [ -s ]\n" - " [ -b ] [ -i ] [ -x ] [ -h ]\n" - " [ ]\n\n" + "usage: lmms [ -r ] [ options ]\n" + " [ -u ]\n" + " [ -d ]\n" + " [ -h ]\n" + " [ ]\n\n" "-r, --render render given project file\n" "-o, --output render into \n" "-f, --output-format specify format of render-output where\n" " format is either 'wav' or 'ogg'.\n" "-s, --samplerate specify output samplerate in Hz\n" - " range: 44100 to 192000\n" - " default: 44100.\n" - "-b, --bitrate specify output bitrate in kHz\n" + " range: 44100 (default) to 192000\n" + "-b, --bitrate specify output bitrate in kHz\n" " default: 160.\n" "-i, --interpolation specify interpolation method\n" " possible values:\n" - " - linear.\n" - " - sincfastest.\n" - " - sincmedium.\n" - " - sincbest.\n" - " default: sincfastest.\n" + " - linear\n" + " - sincfastest (default)\n" + " - sincmedium\n" + " - sincbest\n" "-x, --oversampling specify oversampling\n" " possible values: 1, 2, 4, 8\n" " default: 2\n" "-u, --upgrade upgrade file and save as \n" - "-d, --dump dump XML of compressed file \n" + "-d, --dump dump XML of compressed file \n" "-v, --version show version information and exit.\n" - "-h, --help show this usage message and exit.\n\n", + "-h, --help show this usage information and exit.\n\n", LMMS_VERSION ); return( EXIT_SUCCESS ); }