Skip to content

Commit

Permalink
Update README for NSM support.
Browse files Browse the repository at this point in the history
Update Help for NSM support.
  • Loading branch information
stazed authored and stazed committed Apr 5, 2021
1 parent 794e7c0 commit 7d70001
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 16 deletions.
3 changes: 3 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ The dependencies are:
* jackd
* libxft2
* libfftw3
* liblo (For NSM support)

If you want to compile you will also need the development packages:

Expand All @@ -40,6 +41,7 @@ If you want to compile you will also need the development packages:
* libasound2-dev
* libxft-dev
* libfftw3-dev
* liblo-dev


To build both rakarrack-plus and LV2s, from top checkout directory:
Expand Down Expand Up @@ -75,6 +77,7 @@ Important changes from previous versions:
* "Insert" preset file changed to user directory. From the main window File/Import Inserted Presets
to import from older versions.
* Some key binding has changed
* Added NSM session support.
* Custom MIDI program table can now be used without the gui
* Custom MIDI program files must be in the User Directory
* Custom MIDI program files are MIDI selectable, CC 32, MIDI learnable
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ The dependencies are:
* jackd
* libxft2
* libfftw3
* liblo (For NSM support)

If you want to compile you will also need the development packages:

Expand All @@ -40,6 +41,7 @@ If you want to compile you will also need the development packages:
* libasound2-dev
* libxft-dev
* libfftw3-dev
* liblo-dev


To build both rakarrack-plus and LV2s, from top checkout directory:
Expand Down Expand Up @@ -75,6 +77,7 @@ Important changes from previous versions:
* "Insert" preset file changed to user directory. From the main window File/Import Inserted Presets
to import from older versions.
* Some key binding has changed
* Added NSM session support.
* Custom MIDI program table can now be used without the gui
* Custom MIDI program files must be in the User Directory
* Custom MIDI program files are MIDI selectable, CC 32, MIDI learnable
Expand Down
25 changes: 9 additions & 16 deletions doc/help/general.html
Original file line number Diff line number Diff line change
Expand Up @@ -1022,22 +1022,15 @@ <h3><a name="scuts"></a>Shortcuts</h3>

<h3><a name="session"></a>Session Support</h3>

<p>Rakarrack-plus supports SIGUSR1 & SIGINT signal capture.
For session management, only the active current preset is saved per session. Use
SIGUSR1 for preset saving and SIGINT to quit without saving. LADISH and Non Session
Manager (NSM) are able to send SIGUSR1 and SIGINT signals. For signal capture, use the
<a href="#cmd">Command line options</a> -p preset option to set the file to save.
For NSM use the NSM Proxy to set command line options.</p>

<p>Rakarrack-plus supports multiple occurrences of the program. By default jack will
name each occurrence with the same name by appending the occurrence number to
the name: ex "rakarrack-plus-01". For NSM support, using multiple occurrences, the
manager will not always start each occurrence in the same order for each session.
This will result in occasional incorrect jack connections being made from different
sessions. To solve this problem, use the Command line option "-j Name" to set the
rakarrack-plus client name to a unique id for each occurrence.</p>


<p>Rakarrack-plus supports NSM, both Non Session Manager as well as New Session
Manager.
For session management, the current instance Settings/Preferences are saved as well as last
used bank and preset. In addition, gui show/hide is supported. All bank, user files,
Program Change table and "Insert" presets are global to all instances.
For each Rakarrack-plus instance in the NSM session you must set the User bank in
Settings/Preferences/User to your global user bank. SIGUSR1(save) and SIGINT(quit) signals
can also be used for session support.
</p>

<p><a href="general.html">General</a></p>
<p><a href="help.html">Table of Contents</a> - <a href="effects.html">Effects</a></p>
Expand Down

0 comments on commit 7d70001

Please sign in to comment.