1yoshimi(1) General Commands Manual yoshimi(1)
2
6 yoshimi - a software music synthesiser
7
9 yoshimi [-option] [cmd]
10
12 Yoshimi is a polyphonic multi-part sound synthesiser utilising three
13 distinct 'engines' that can be used separately or together. These can
14 also be stacked into 'kits', typically for percussion. It fully sup‐
15 ports both JACK and ALSA for MIDI input and audio output.
16 Yoshimi can be run in a graphical interface, a command line interface,
18 or with control from both. A number of controls can also be accessed
19 via MIDI. The CLI has its own Readline parser and built-in help system
20 accessed by entering the commands '?' or 'help'.
21 The CLI help system is context sensitive, and apart from reminders of
23 common essential commands, only shows the relevant commands. However,
24 it is possible to specifically call for help from other contexts.
25 e.g. Within the 'part' context '? config' will show the commands for
27 configuration settings.
28 Yoshimi has a very extensive MIDI learn capability, exposing the major‐
30 ity of controls. The same MIDI CC and Channel pair can be linked to
31 multiple independent controls. There is also considerable post-learn
32 editing capability.
33 Other recent extensions are the ability to import and export entire
35 instrument banks in a safe and obvious manner. It is now also possible
36 to swap any instrument or bank with any other, in any bank root without
37 disrupting the rest of the structure.
38 One of the latest additions is the ability to load a list of MIDI-
40 learned settings from the command line at startup.
41 The most recent improvements are key and channel aftertouch, fully
43 resizeabe windows, MIDI sync for LFOs and Panning extensions.
44
46 -?, --help Shows command syntax.
47 -a, --alsa-midi[=<device>] Use ALSA MIDI input.
49 -A, --alsa-audio[=<device>] Use ALSA audio output.
51 -b, --buffersize=<size> Set the internal buffer size.
53 -c, --no-cmdline Disable command line interface.
55 -C, --cmdline Enable command line interface.
57 -D, --define-root Define path to new bank root dir.
59 -i, --no-gui Disable graphical interface.
61 -I, --gui Enable graphical interface.
63 Attempting 'c' and 'i' will produce a warning, and although it is pos‐
65 sible to run with both disabled (accepting only MIDI) it is not recom‐
66 mended.
67 -j, --jack-midi[=<device>] Use JACK MIDI input.
69 -J, --jack-audio[=<device>] Connect to JACK server.
71 -k, --autostart-jack Auto start JACK server.
73 -K, --auto-connect Auto connect to jack server.
75 -l, --load=<file> Load .xmz patch set.
77 -L, --load-instrument=<file> Load .xiz instrument file.
79 -M, --load-midilearn=<file> Load .xly learned list file.
81 -N, --name-tag=<tag> Add a tag to the client name.
83 -o, --oscilsize=<size> Set the AddSynth oscillater size.
85 -R, --samplerate=<rate> Set the ALSA audio sample rate.
87 -S, --state[=<file>] Load previously saved state.
89 Defaults to "HOME/.config/yoshimi/yoshimi.state"
90 -u, --jack-session-file=<file> Load named JACK session file.
92 -U, --jack-session-uuid=<uuid> Use JACK session uuid.
94 Regardless of their position on the command line file loads will always
96 be in the order: session (or state), patch set, instrument, midi-learn
97 -V, --version Print Yoshimi version.
99 "Mandatory or optional arguments for long options are also mandatory or
101 optional for any corresponding short options."
102yoshimi 2.0 2021 yoshimi(1)