]> Shamusworld >> Repos - ardour-manual/blobdiff - include/preferences.html
whitespace change to test commit hook
[ardour-manual] / include / preferences.html
index bb5f0d5ce26c71cca5630cb1e17f858aaf218f1b..5dd57c2cdcd36f6a3ac955c50b88f649448daf0a 100644 (file)
       </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>
     <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).
     <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
         on those buggy systems at the expense of speed.
       </li>    
       <li>
-        <dfn>Possibly improve slow graphical performance (requires restart)</dfn>
+        <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.
     <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>
     <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>
     <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.
         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
         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.
         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>
     </ul>
   </li>
 </ul>      
+
+<h3 id="preferences-midi-port-config">Modifiers</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>
 
         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>Verbose Plugin Scan</dfn>: adds information about the plugin in the
+        <a href="@@status-bar">Log window</a>.
+      </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
     <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>
         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>
         <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
         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
     <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.
         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>
           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>