Merge remote-tracking branch 'github/master'
[zynaddsubfx-code.git] / doc / zynaddsubfx.1.txt
blob1377d121baa79be089262c72ebf2267399ea56e4
1 ZYNADDSUBFX(1)
2 ==============
3 :doctype: manpage
5 NAME
6 ----
7 zynaddsubfx - a software synthesizer
9 SYNOPSIS
10 --------
11 *zynaddsubfx* ['OPTIONS']
13 DESCRIPTION
14 -----------
16 *zynaddsubfx* is a polyphonic multimbral synthesizer, which supports three
17 synthesis engines and numerous effects to generate sound.
19 1) ADsynth generates sounds by adding a number of voices.
20    Each voice has filters, envelopes, LFOs, morphing, modulation
21    (Ring Modulation, Phase Modulation... the modulators can have any
22    shape), resonance, etc...
23    Each voice includes a waveform generator with up to 128 sine/non-sine
24    harmonics.
25    You can use Fourier synthesis or if you don't like it you
26    can wave-shaping/filtering of functions.
28 2) SUBsynth is a simple engine which makes sounds through
29    harmonic filtering of white noise
31 3) PADsynth is an engine that makes very beautiful pads and other instruments,
32    which can be exported for use with other programs.
34 Midi and audio support exists for OSS, ALSA, JACK, and others...
36 OPTIONS
37 -------
39 *-h, --help*::
40     Display command-line help and exit
41 *-v, --version*::
42     Display version and exit
43 *-l, --load=FILE*::
44     Loads a .xmz file
45 *-L, --load-instrument*=FILE::
46     Loads a .xiz file
47 *-r --sample-rate*=SR::
48     Set the sample rate SR
49 *-b, --buffer-size*=SR::
50     Set the buffer size, which determines the granularity of how often parameter
51     changes can be applied
52 *-o, --oscil-size*=OS::
53     Set the ADsynth oscillator size
54 *-S, --swap*::
55     Swap Left and Right output channels
56 *-D, --dump*::
57     Dumps midi note ON/OFF commands
58 *-U, --no-gui*::
59     Run ZynAddSubFX without user interface
60 *-N, --named*=Name::
61     Postfix IO Name when possible
62 *-a, --auto-connect*::
63     AutoConnect when using JACK
64 *-O, --output*=engine::
65     Set Output Engine
66 *-I, --input*=engine::
67     Set Input Engine
68 *-e, --exec-after-init*=command::
69     Run post-initialization script. This script will be run after midi and audio
70     drivers have been initialized.
71 *-M, --midi-learn*=FILE::
72     Load a midi learn binding (.xlz) file.
74 BUGS
75 ----
76 Please report any bugs to either the mailing list
77     zynaddsubfx-user@lists.sourceforge.net
78 or the bugtracker
79     http://sourceforge.net/tracker/?group_id=62934
81 AUTHOR
82 ------
83 ZynAddSubFX was originally written by Nasca Octavian Paul. It is currently being
84 maintained by Mark McCurry.