X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=include%2Fpreferences.html;h=b7ec15e77d0a7a6768f76b505609aca288a0a70e;hb=3532eaf880572e65dea6acd1f391efa598303111;hp=bb5f0d5ce26c71cca5630cb1e17f858aaf218f1b;hpb=da709fc5a6b9bf256f64bb2c9fd8ccba0ccf6573;p=ardour-manual

diff --git a/include/preferences.html b/include/preferences.html
index bb5f0d5..b7ec15e 100644
--- a/include/preferences.html
+++ b/include/preferences.html
@@ -7,7 +7,7 @@
 </p>
 
 <figure class="right">
-  <img src="/images/preferences.png" alt="The Preferences window">
+  <img class="mini" style="width:600px;" src="/images/preferences.png" alt="The Preferences window">
   <figcaption>
     The Preferences window
   </figcaption>
@@ -36,6 +36,9 @@
 		<li><a href="#preferences-editor-modifiers">Modifiers</a></li>
 	</ul>
 	<li><a href="#preferences-midi">MIDI</a></li>
+	<ul>
+		<li><a href="#preferences-midi-port-config">MIDI Port Config</a></li>
+	</ul>
 	<li><a href="#preferences-transport">Transport</a></li>
 	<ul>
 		<li><a href="#preferences-transport-chase">Chase</a></li>
@@ -43,6 +46,7 @@
 	</ul>
 	<li><a href="#preferences-plugins">Plugins</a></li>
 	<ul>
+    <li><a href="#preferences-plugins-gui">GUI</li>
 		<li><a href="#preferences-plugins-vst">VST</a></li>
 		<li><a href="#preferences-plugins-audio_unit">Audio Unit</a></li>
 	</ul>
@@ -53,6 +57,7 @@
 	<li><a href="#preferences-metering">Metering</a></li>
 	<li><a href="#preferences-performance">Performance</a></li>
 	<li><a href="#preferences-video">Video</a></li>
+  <li><a href="#preferences-triggering">Triggering</a></li>
 </ul>
 
 <h2 class="clear" id="preferences-general">General</h2>
@@ -126,6 +131,12 @@
         selects, and then disables changes to, the <em>Copy files to session</em>
         option in the <a href="@@import-dialog">Add Existing Media</a> dialog.
       </li>
+      <li>
+        <strong>Cache Folder for downloaded Freesound clips</strong>: when you try
+        sounds form FreeSound.org before inserting them into the project, they need
+        to be saved locally on your computer; this is where you define the folder
+        for those temporary files.
+      </li>
     </ul>
   </li>
   <li>
@@ -146,6 +157,15 @@
       </li>
     </ul>
   </li>
+  <li>
+    <dfn>New Version Check</dfn>
+    <ul>
+      <li>
+        <dfn>Check for announcements at application start</dfn> sends an
+        anonymous request to Ardour's server to check for a new version.
+      </li>
+    </ul>
+  </li>
 </ul>
   
 <h2 id="preferences-appearance">Appearance</h2>
@@ -155,13 +175,13 @@
     <dfn>GUI Lock</dfn>
     <ul>
       <li>
-        <dfn>Lock timeout (seconds):</dfn>locks the <abbr title="Graphical User
+        <dfn>Lock timeout (seconds)</dfn>: locks the <abbr title="Graphical User
         Interface">GUI</abbr> after this many idle seconds (zero being 'never lock').
         The GUI can also be locked with <kbd class="menu">Session &gt; Lock</kbd>. When
         locked, a dialog will display a &quot;Click to unlock&quot; button.
       </li>
       <li>
-        <dfn>System Screensaver Mode:</dfn>can be used to prevent the
+        <dfn>System Screensaver Mode</dfn>: can be used to prevent the
         screensaver to be launched by the system, either while recording
         (e.g. for long and unattended recording session), when Ardour is
         simply started, or never (the screensaver is then able to start).
@@ -232,19 +252,13 @@
     <dfn>Graphics Acceleration</dfn>
     <ul>
 	  <li>
-        <dfn>Disable Graphics Hardware Acceleration (requires restart)</dfn>
+        <dfn>Disable Graphics Hardware Acceleration (requires restart)</dfn>:
         Ardour uses hardware accelerated UI rendering by default for speed.
         Sometimes though, a buggy driver can cause this to make the system slow or
         unstable. Checking this will make Ardour draw its UI without
         hardware acceleration, in software, improving stability and responsiveness
         on those buggy systems at the expense of speed.
       </li>	
-      <li>
-        <dfn>Possibly improve slow graphical performance (requires restart)</dfn>
-        Wherever gradients appear in the UI, Ardour uses hardware accelerated
-        gradients creation. Checking this will make Ardour draw its own gradients without
-        hardware acceleration for stability on systems with buggy drivers.
-      </li>
     </ul>
   </li>
 </ul>  
@@ -256,7 +270,7 @@
     <dfn>Input Meter Layout</dfn>
     <ul>
       <li>
-        <dfn>Input Meter Layout:</dfn>In Recorder mode, determines if audio
+        <dfn>Input Meter Layout</dfn>: in Recorder mode, determines if audio
         inputs are displayed horizontally or vertically.
       </li>  
 	</ul>
@@ -296,7 +310,7 @@
         editor. Values range from 0.0, no gradient effect, to 1.0, maximum effect.
       </li>
       <li>
-        <dfn>Track name ellipsis mode:</dfn> when the track header is not 
+        <dfn>Track name ellipsize mode:</dfn> when the track header is not 
         wide enough to display the track's name in full, selects how the
         name will be shorten between:
         <ul>
@@ -316,32 +330,32 @@
     <dfn>Waveforms</dfn>
     <ul>
       <li>
-        <dfn>Show waveforms in regions</dfn> when enabled shows a visual
+        <dfn>Show waveforms in regions</dfn>: when enabled, shows a visual
         representation of the region's audio waveform.
       </li>
       <li>
-        <dfn>Show waveform while recording</dfn> when
-        enabled, will draw the audio waveform in regions being recorded, in near
-        real time. When disabled, only a region block will be drawn while recording,
+        <dfn>Show waveforms while recording</dfn>: when enabled, will draw
+        the audio waveform in regions being recorded, in near real time.
+        When disabled, only a region block will be drawn while recording,
         reducing CPU requirements.
       </li>
       <li>
-        <dfn>Show waveform clipping</dfn>: when enabled the waveform
+        <dfn>Show waveform clipping</dfn>: when enabled, the waveform
         displayed will show peaks marked in red if they exceed the clip level.
       </li>
       <li>
-        <dfn>Waveform Clip Level (dBFS):</dfn> sets the level at which the
+        <dfn>Waveform Clip Level (dBFS)</dfn>: sets the level at which the
         waveform shown in an audio region will be drawn in red to indicate
         clipping. Setting lower than 0.0&nbsp;dBFS can be useful if any tool in
         the audio chain has problems near 0.0&nbsp;dBFS.
       </li>
       <li>
-        <dfn>Waveform scale:</dfn> when waveforms are shown in audio regions,
+        <dfn>Waveform scale</dfn>: when waveforms are shown in audio regions,
         they can be displayed using a <em>linear</em> or a <em>logarithmic</em>
         scale. See <a href="@@waveform-display">Waveform display</a>.
       </li>
       <li>
-        <dfn>Waveform shape:</dfn> when waveforms are shown in audio regions,
+        <dfn>Waveform shape</dfn>: when waveforms are shown in audio regions,
         they can be displayed using a <em>traditional</em> or a <em>rectified</em>
         shape. See <a href="@@waveform-display">Waveform display</a>.
       </li>
@@ -351,7 +365,7 @@
     <dfn>Editor Meters</dfn>
     <ul>
       <li>
-        <dfn>Show meters in track headers</dfn>, when enabled, shows
+        <dfn>Show meters in track headers</dfn>: when enabled, shows
         a small meter in the Editor's <a href="@@audio-track-controls">track headers</a>.
         The meter is shown on the right side area of the header and provides an
         instant, if unprecise, view of the levels on this track/bus.
@@ -451,6 +465,10 @@
         <dfn>Display Monitor Section Info</dfn> toggles the visibility of the
        Monitor Info slice of the main toolbar.
       </li>
+      <li>
+        <dfn>Display Cue Rec/Play Controls</dfn> toggles the visibility of the
+       buttons that enable creating and playing back cue markers.
+      </li>
       <li>
         <dfn>Display Navigation Timeline</dfn> toggles the visibility of the
         <a href="@@mini-timeline">navigation/mini timeline</a> slice of
@@ -545,6 +563,11 @@
         allows the system window manager's rules for the windows visibility to
         supersede Ardour's.
       </li>
+      <li>
+        <dfn>Show/Hide splash screen instead of setting z-axis stack order</dfn>:
+        Hides the splash instead of re-layering it. This setting requires a restart
+        of Ardour to take effect.
+      </li>
       <li>
         <dfn>All floating windows are dialogs</dfn>: when enabled, Ardour will
         use type &quot;Dialog&quot; for all floating windows instead of using type
@@ -642,7 +665,7 @@
         scrolls when dragging the playhead outside of the visible canvas.
       </li>
       <li>
-        <dfn>Limit zooming &amp; summary view to X minutes beyond session extents:</dfn>
+        <dfn>Limit zoom &amp; summary view beyond session extents to:</dfn>
         prevents the zoom out both in the editor and the summary, to show anything past
         the chosen time after the end marker, restraining the vision to only useful
         content.
@@ -675,7 +698,7 @@
         fade shape</a> is the default.
       </li>
       <li>
-        <dfn>Regions in active edit groups are edited together:</dfn> sets
+        <dfn>Regions in edit groups are edited together:</dfn> sets
         the criteria to see if editing actions apply to tracks grouped together
         in an group.
       </li>
@@ -691,7 +714,7 @@
     <ul>
       <li>
         <dfn>After a Separate operation, in Range mode:</dfn> determines what
-        should become of the Range selection after a Separate operations:
+        should become of the Range selection after a Separate operation:
         <ul>
 			<li>Clear the Range Selection: nothing is selected anymore</li>
 			<li>Preserve the Range Selection: the range selection is kept</li>
@@ -832,6 +855,21 @@
 
     </ul>
   </li>
+  <li>
+    <dfn>Default Visible Note Range</dfn>
+    <ul>
+      <li>
+        <dfn>Default lower visible MIDI note</dfn>: this note will be the lowest
+        visible one on the timeline unless you tweak that by adjusting the vertical
+        range. E.g. C4 is C on the fourth octave.
+      </li>
+      <li>
+        <dfn>Default upper visible MIDI note</dfn>: this note will be the highest
+        visible one on the timeline unless you tweak that by adjusting the vertical
+        range. E.g. B4 is B on the fourth octave.
+      </li>
+    </ul>
+  </li>
   <li>
     <dfn>MIDI Port Options</dfn>
     <ul>
@@ -846,6 +884,24 @@
     </ul>
   </li>
 </ul>      
+
+<h3 id="preferences-midi-port-config">MIDI Port Config</h3>
+
+<p>
+  This page allows to set options for input and output MIDI devices, such as:
+</p>
+
+<ul>
+  <li><kbd class="menu">Music Data</kbd>: whether Ardour should accept/send note events from/to selected MIDI device</li>
+  <li><kbd class="menu">Control Data</kbd>: whether Ardour should accept/send control events (Control Change, or CC) from/to selected MIDI device</li>
+  <li><kbd class="menu">Follow Selection</kbd>: whether Ardour should connect this device only to a selected track (only applicable to input devices)</li>
+</ul>
+
+<p>
+  You can also give a more meaningful name to any input and output MIDI device
+  here. Double-click the name of the device, enter a new name, then press
+  <kbd>Enter</kbd> to confirm.
+</p>
   
 <h2 id="preferences-transport">Transport</h2>
 
@@ -1085,18 +1141,38 @@
         for available plugins. Useful to get a newly installed plugin recognised
         by Ardour.
       </li>
+      <li>
+        <dfn>Scan Time Out</dfn> sets the time that Ardour will try to find
+        any plugins in known paths until it gives up.
+      </li>
     </ul>
   </li>
   <li>
     <dfn>General</dfn>
     <ul>
+	  <li>
+        <dfn>Scan for [new] Plugins on Application Start</dfn> When
+    	  enabled new plugins are searched, tested and added to the cache
+    	  index on application start. When disabled new plugins will only be
+    	  available after triggering a 'Scan' manually.
+      </li>
       <li>
         <dfn>Always Display Plugin Scan Progress</dfn> When enabled a
         popup window showing plugin scan progress is displayed for indexing
         (cache load) and discovery (detect new plugins).
       </li>
       <li>
-        <dfn>Make new plugins active</dfn> when enabled, any plugin added to a track
+        <dfn>Verbose Plugin Scan</dfn>: adds information about the plugin in the
+        <a href="@@status-bar">Log window</a>.
+      </li>
+      <li>
+        <dfn>Open Plugin manager window when missing plugins are found</dfn>:
+        when enabled</b>, the Plugin Manager is displayed at session load if the
+        session contains any plugins that are missing, or plugins have been
+        updated and require a rescan.
+      </li>
+      <li>
+        <dfn>Make new plugins active</dfn>: when enabled, any plugin added to a track
         will be in active mode. If unchecked, the plugins will be added in inactive
         mode by default, hence have no processing effect on the track/bus.
       </li>
@@ -1112,33 +1188,6 @@
       </li>
     </ul>
   </li>
-  <li>
-    <dfn>Plugin GUI</dfn>
-    <ul>
-      <li>
-        <dfn>Automatically open the plugin GUI when adding a new plugin</dfn>
-        shows the plugins GUI as soon as it is added to the processing box. If
-        unchecked, the plugin will be added in the processor box but the GUI will
-        only be shown when <kbd class="mouse">double clicking</kbd> it.
-      </li>
-      <li>
-        <dfn>Show Plugin Inline Display on Mixer strip by default</dfn> allows Ardour
-        to show, in the <a href="@@audiomidi-mixer-strips">mixer strips</a>, a
-        visual rendering of the effect. These Inline Display are a special feature
-        of Ardour, so not all plugins are able to show this display. Most of Ardour's
-        <a href="@@plugins-bundled-with-ardour">own plugins</a> have an Inline Display.
-        At any time, the plugin's Inline Display can be toggled on or off by
-        <kbd class="mod3n"></kbd>double-clicking it.
-      </li>
-      <li>
-        <dfn>Don't automatically open the plugin GUI when the plugin has an inline
-        display mode</dfn>: this option, available only if
-        <kbd class="option">Automatically open the plugin GUI when adding a new plugin</kbd>
-        is checked, supercedes it and hides the plugin GUI at creation if it has an
-        Inline Display, like Ardour's own <code>ACE *</code> plugins.
-      </li>
-    </ul>
-  </li>
   <li>
     <dfn>Instrument</dfn>
     <ul>
@@ -1176,6 +1225,57 @@
   </li>
 </ul>
 
+<h3 id="preferences-plugins-gui">GUI</h3>
+
+<ul>
+  <li>
+    <dfn>Plugin GUI</dfn>
+    <ul>
+      <li>
+        <dfn>Automatically open the plugin GUI when adding a new plugin</dfn>
+        shows the plugins GUI as soon as it is added to the processing box. If
+        unchecked, the plugin will be added in the processor box but the GUI will
+        only be shown when <kbd class="mouse">double clicking</kbd> it.
+      </li>
+      <li>
+        <dfn>Show only one plugin window at a time</dfn>: when enabled, only
+        one plugin window will be displayed on the screen; when disabled, you
+        can open as many plugin windows as you like.
+      </li>
+      <li>
+        <dfn>Closing a Plugin GUI Window</dfn>: this allows users deciding how
+        Ardour should treat plugin windows aftre closing them. Hiding means a
+        complex plugin window can be re-opened fast because it's saved in
+        memory, but it uses sustem resources. Destroying means the window isn't
+        saved, which frees up system resources, however some plugins will take
+        longer to showup on the screen.
+      </li>
+    </ul>
+  </li>
+  <li>
+    <dfn>Mixer Strip Inline Display</dfn>
+    <ul>
+      <li>
+        <dfn>Show Plugin Inline Display on Mixer strip by default</dfn> allows Ardour
+        to show, in the <a href="@@audiomidi-mixer-strips">mixer strips</a>, a
+        visual rendering of the effect. These Inline Display are a special feature
+        of Ardour, so not all plugins are able to show this display. Most of Ardour's
+        <a href="@@plugins-bundled-with-ardour">own plugins</a> have an Inline Display.
+        At any time, the plugin's Inline Display can be toggled on or off by
+        <kbd class="mod3n"></kbd>double-clicking it.
+      </li>
+      <li>
+        <dfn>Don't automatically open the plugin GUI when the plugin has an inline
+        display mode</dfn>: this option, available only if
+        <kbd class="option">Automatically open the plugin GUI when adding a new plugin</kbd>
+        is checked, supercedes it and hides the plugin GUI at creation if it has an
+        Inline Display, like Ardour's own <code>ACE *</code> plugins.
+      </li>
+    </ul>
+  </li>
+</li>
+</ul>
+
 <h3 id="preferences-plugins-vst">VST</h3>
 
 <ul>
@@ -1183,24 +1283,17 @@
     <dfn>VST</dfn>
     <ul>
       <li>
-        <dfn>Enable Mac VST support (requires restart or re-scan)</dfn> makes a
+        <dfn>Enable Mac VST2 support (requires restart or re-scan)</dfn> makes a
         MacOs system able to run VST-Mac plugins. As stated, a new scan for plugins
         is required, be it manually or by restarting Ardour.
       </li>
       <li>
-        <dfn>Scan for [new] VST Plugins on Application Start</dfn> When
-    	  enabled new VST plugins are searched, tested and added to the cache
-    	  index on application start. When disabled new plugins will only be
-    	  available after triggering a 'Scan' manually.
+        <dfn>Enable Linux VST2 support (requires restart or re-scan)</dfn> makes a
+        Linux system able to run VST2 plugins.
       </li>
       <li>
-        <dfn>Verbose Plugin Scan</dfn>: adds information about the plugin in the
-        <a href="@@status-bar">Log window</a>.
-      </li>
-      <li>
-        <dfn>Scan Time Out</dfn> Specifies the default timeout for plugin
-    	  instantiation. Plugins that require more time to load will be
-        blacklisted. A value of &infin; disables the timeout.
+        <dfn>Enable VST3 support (requires restart or re-scan)</dfn> makes any
+        system able to run VST3 plugins.
       </li>
     </ul>
   </li>
@@ -1213,8 +1306,8 @@
         inserted into the processor box. A new VST plugin scan is then required.
       </li>
       <li>
-        <dfn>VST 2 Blacklist:</dfn> Clicking the <kbd class="menu">Clear</kbd>
-        button makes blacklisted VST plugins available to be added to the processor
+        <dfn>VST 2 Ignorelist:</dfn> Clicking the <kbd class="menu">Clear</kbd>
+        button makes ignored VST plugins available to be added to the processor
         box.
       </li>
       <li>
@@ -1242,7 +1335,7 @@
         <dfn>VST 3 Cache:</dfn> Same as above, for VST 3
       </li>
       <li>
-        <dfn>VST 3 Blacklist:</dfn> Same as above, for VST 3
+        <dfn>VST 3 Ignorelist:</dfn> Same as above, for VST 3
       </li>
       <li>
         <dfn>Additional VST3 Path:</dfn> The VST 3 specs clearly define where
@@ -1250,6 +1343,16 @@
         way to search other directories for plugin, it is out of spec and not
         recommanded.
       </li>
+      <li>
+        <dfn>Automatically show 'Micro Edit' tagged controls on the mixer-strip:</dfn>
+        displays the plugin's UI directly inside each mixer strip (inline), if the plugin
+        has a 'Micro Edit' <a hreg="@@plugin-selector">tag</a>.
+      </li>
+    </ul>
+  </li>
+  <li>
+    <dfn>VST2/VST3</dfn>
+    <ul>
       <li>
         <dfn>Conceal VST2 Plugin if matching LV3 exists</dfn> When 
         enabled, gives precedence to the VST3 (more up-to-date) version of
@@ -1266,7 +1369,7 @@
     <dfn>Audio Unit</dfn>
     <ul>
       <li>
-        <dfn>Scan for [new] AudioUnit Plugins on Application Start</dfn> When
+        <dfn>Enable Audio Unit support (requires restart or re-scan)</dfn> When
         enabled, new AU plugins are searched, tested and added to the cache
         index on application start. When disabled, new plugins will only be
         available after triggering a 'Scan' manually.
@@ -1277,8 +1380,8 @@
         inserted into the processor box. A new AU plugins scan is then required.
       </li>
       <li>
-        <dfn>AU Blacklist:</dfn> Clicking the <kbd class="menu">Clear</kbd>
-        button makes blacklisted AU plugins available to be added to the processor
+        <dfn>AU Ignorelist:</dfn> Clicking the <kbd class="menu">Clear</kbd>
+        button makes ignored AU plugins available to be added to the processor
         box.
       </li>
     </ul>
@@ -1587,6 +1690,14 @@
           used to do signal processing. It can be set to use one up to all
           processors.
       </li>
+      <li>
+        <dfn>Power Management, CPU DMA latency: </dfn> modern processors try
+        to aggressively transition to power saving when idle, even for a few
+        microseconds, hurting realtime performance by needing to wake to a
+        more active state. This setting counters this behaviour by setting
+        a maximum response time while low latency operation is desired.
+        <kbd class="menu">0</em> is the fastest response time.
+      </li>
     </ul>
   </li>
   <li>
@@ -1676,12 +1787,6 @@
   <li>
     <dfn>Video Server</dfn>
     <ul>
-      <li>
-        <dfn>Show Video Export Info before export</dfn> Shows a warning message
-        when exporting a video about licensing and offers to open the
-        <a href="@@workflow-amp-operations#export">export video</a> section of
-        this manual.
-      </li>
       <li>
         <dfn>Show Video Server Startup Dialog</dfn>: when using video inside Ardour,
         this video is accessed via Xjadeo from a source file through a Video Server.
@@ -1719,3 +1824,31 @@
   </li>
 </ul>
 
+<h2 id="preferences-triggering">Triggering</h2>
+
+<ul>
+  <li>
+    <dfn>Triggering</dfn>
+    <ul>
+      <li>
+        <dfn>Default trigger input</dfn>: this is where you choose a MIDI device
+        that will send notes to tiggers boxes in the Cue window. This is typically
+        a grid controller like monome, Novation Launchpad, Ableton Push etc.
+      </li>
+    </ul>
+  </li>
+  <li>
+    <dfn>Clip Library</dfn>
+    <ul>
+      <li>
+        <dfn>User writable Clip Library</dfn>: this is a folder where your custom
+        reusable clips will be saved to.
+      </li>
+      <li>
+        <dfn>Reset Clip Library Dir</dfn>: this will reset the location of your
+        custom reusable clips to a default location.
+      </li>
+    </ul>
+  </li>
+</ul>
+