1yoshimi(1)                  General Commands Manual                 yoshimi(1)
2
3
4

NAME

6       yoshimi - a software music synthesiser
7

SYNOPSIS

9       yoshimi [-option] [cmd]
10

DESCRIPTION

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
17       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
22       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
26       e.g.  Within  the  'part' context '? config' will show the commands for
27       configuration settings.
28
29       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
34       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

COMMANDS

40       -?, --help Shows command syntax.
41
42       -a, --alsa-midi[=<device>] Use ALSA MIDI input.
43
44       -A, --alsa-audio[=<device>] Use ALSA audio output.
45
46       -b, --buffersize=<size> Set the internal buffer size.
47
48       -c, --no-cmdline Disable command line interface.
49
50       -C, --cmdline Enable command line interface.
51
52       -D, --define-root Define path to new bank root dir.
53
54       -i, --no-gui Disable graphical interface.
55
56       -I, --gui Enable graphical interface.
57
58       Attempting 'c' and 'i' will produce a warning, and although it is  pos‐
59       sible  to run with both disabled (accepting only MIDI) it is not recom‐
60       mended.
61
62       -j, --jack-midi[=<device>] Use JACK MIDI input.
63
64       -J, --jack-audio[=<device>] Connect to JACK server.
65
66       -k, --autostart-jack Auto start JACK server.
67
68       -K, --auto-connect Auto connect to jack server.
69
70       -l, --load=<file> Load .xmz patch set.
71
72       -L, --load-instrument=<file> Load .xiz instrument file.
73
74       -N, --name-tag=<tag> Add a tag to the client name.
75
76       -o, --oscilsize=<size> Set the AddSynth oscillater size.
77
78       -R, --samplerate=<rate> Set the ALSA audio sample rate.
79
80       -S, --state[=<file>]  Load previously saved state.
81              Defaults to "HOME/.config/yoshimi/yoshimi.state"
82
83       -u, --jack-session-file=<file> Load named JACK session file.
84
85       -U, --jack-session-uuid=<uuid> Use JACK session uuid.
86
87       -V, --version Print Yoshimi version.
88
89       "Mandatory or optional arguments for long options are also mandatory or
90       optional for any corresponding short options."
91
92
93
94
95
96yoshimi 1.5.10                   January 2019                       yoshimi(1)
Impressum