Merge branch 'calf-updates'
[lmms.git] / lmms.1
blob3e7955911be823dbdb17ccf466b1e986880aba68
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH LMMS 1 "September 28, 2006"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 lmms \- software for easy music production
20 .SH SYNOPSIS
21 .B lmms
22 .RB "[ \--\fBrender\fP \fIfile\fP ] [options]"
23 .br
24 .B lmms
25 .RB "[ \--\fBupgrade\fP \fIin\fP \fIout\fP ]"
26 .br
27 .B lmms
28 .RB "[ \--\fBdump\fP \fIin\fP ]"
29 .br
30 .B lmms
31 .RI "[ file ]"
32 .SH DESCRIPTION
33 .PP
34 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
35 .\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
36 .\" respectively.
37 .B LMMS
38 aims to be a free alternative to popular (but commercial and closed-source) programs such as FL Studio, Cubase and Logic giving you the ability of producing music with your computer by creating cool loops, synthesizing and mixing sounds and processing effects on them, arranging samples, having fun with your MIDI-keyboard and much more...
40 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.
42 .SH OPTIONS
43 .IP "\fB\-r, --render\fP \fIproject-file\fP
44 Render given file to either a wav\- or ogg\-file. See \fB\-f\fP for details
45 .IP "\fB\-o, --output\fP \fIfile\fP
46 render into \fIfile\fP
47 .IP "\fB\-f, --output-format\fP \fIformat\fP
48 Specify format of render-output where \fIformat\fP is either 'wav' or 'ogg'
49 .IP "\fB\-s, --samplerate\fP \fIsamplerate\fP
50 Specify output samplerate in Hz - range is 44100 (default) to 192000
51 .IP "\fB\-b, --bitrate\fP \fIbitrate\fP
52 Specify output bitrate in kHz (for OGG encoding only), default is 160
53 .IP "\fB\-i, --interpolation\fP \fImethod\fP
54 Specify interpolation method - possible values are \fIlinear\fP, \fIsincfastest\fP (default), \fIsincmedium\fP, \fIsincbest\fP
55 .IP "\fB\-i, --interpolation\fP \fImethod\fP
56 Specify interpolation method - possible values are \fIlinear\fP, \fIsincfastest\fP (default), \fIsincmedium\fP, \fIsincbest\fP
57 .IP "\fB\-x, --oversampling\fP \fIvalue\fP
58 Specify oversampling, possible values: 1, 2 (default), 4, 8
59 .IP "\fB\-u, --upgrade\fP \fIin\fP \fIout\fP
60 Upgrade file \fIin\fP and save as \fIout\fP
61 .IP "\fB\-d, --dump\fP \fIin\fP
62 Dump XML of compressed file \fIin\fP (i.e. MMPZ-file)
63 .IP "\fB\-v, --version
64 Show version information and exit.
65 .IP "\fB\-h, --help
66 Show usage information and exit.
67 .SH SEE ALSO
68 .BR http://lmms.sf.net/
69 .BR http://lmms.sf.net/wiki/
70 .SH AUTHORS
71 .BR Tobias Doerffel <tobydox/at/users.sourceforge.net>, Paul Giblock and others. See AUTHORS for details.