]> Shamusworld >> Repos - ardour-manual-diverged/commitdiff
Merge branch 'hotguac-master'
authorPaul Davis <paul@linuxaudiosystems.com>
Mon, 8 Jun 2015 21:28:19 +0000 (17:28 -0400)
committerPaul Davis <paul@linuxaudiosystems.com>
Mon, 8 Jun 2015 21:28:19 +0000 (17:28 -0400)
_manual/21_preferences-and-session-properties/01_preferences-dialog/04_audio.html
_manual/21_preferences-and-session-properties/01_preferences-dialog/05_solomute.html
_manual/21_preferences-and-session-properties/01_preferences-dialog/06_midi.html
_manual/21_preferences-and-session-properties/01_preferences-dialog/07_interaction.html
_manual/21_preferences-and-session-properties/01_preferences-dialog/10_plugins.html
_manual/21_preferences-and-session-properties/01_preferences-dialog/11_gui.html
_manual/21_preferences-and-session-properties/01_preferences-dialog/12_metering.html
_manual/21_preferences-and-session-properties/01_preferences-dialog/13_theme.html

index 2ff36154d4a1ac41d7f310a8e8a281e9c5d7deab..91d897b0998c4c1f476ba1f308ffdbb45e5d3681 100644 (file)
@@ -125,7 +125,7 @@ audio tab"/>
       <li>
        <p>
          <strong>Make new plugins active</strong> when enabled, will activate
-         a plugin when it is added to a track or buss
+         a plugin when it is added to a track or bus
          <a href="/working-with-plugins/processor-box/">Processor Box</a>.
        </p>
       </li>
index b6c059235a201cff93119758444455a7e27b439a..a41e8422db7f51b26b8a3436be42c197675f760c 100644 (file)
@@ -5,7 +5,9 @@ menu_title: Solo/Mute Tab
 ---
 
 <p>
-  This tab contains settings that affect the use of solo, muting, and panning.
+  This tab contains settings that affect the use of
+  <a href="/mixing/muting-and-soloing/">solo, muting</a>, and
+  <a href="/mixing/panning/">panning</a>.
 </p>
 
 <img src="/files/a4/a4_preferences_solomute.png" alt="preferences
@@ -19,42 +21,59 @@ solo/mute tab"/>
     <ul>
       <li>
        <p>
-         <strong>Solo-in-place mute cut</strong>
+         <strong>Solo-in-place mute cut</strong> sets the attenuation of the
+         the other tracks when another track is soloed in place. This setting
+         is also available from the <strong>Mixer</strong> monitor section.
        </p>
       </li>
       <li>
        <p>
-         <strong>Solo controls are Listen controls</strong>
+         <strong>Solo controls are Listen controls</strong> when enabled the
+         soloed track is soloed only on the monitor bus, the master fader mix
+         is not affected by the solo. This option can also be set by enabling
+         pre-fader listen or after-fader listen in the <strong>Mixer</strong>
+         monitor section.
        </p>
       </li>
       <li>
        <p>
-         <strong>Listen Position:</strong>
+         <strong>Listen Position:</strong> determines what is listened to when
+         the solo controls are used as listen controls. The options are
+         after-fader or pre-fader.
        </p>
       </li>
       <li>
        <p>
-         <strong>PFL signals come from:</strong>
+         <strong>PFL signals come from:</strong> determines whether the
+         pre-fader listen position is before or after the pre-fader processors.
        </p>
       </li>
       <li>
        <p>
-         <strong>AFL signals come from:</strong>
+         <strong>AFL signals come from:</strong> determines whether the
+         after-fader listen position is before or after the after-fader
+         processors.
        </p>
       </li>
       <li>
        <p>
-         <strong>Exclusive solo</strong>
+         <strong>Exclusive solo</strong> when enabled will only solo that last
+         track selected for solo. Previously soloed tracks will be un-soloed.
+         This setting is also available from the <strong>Mixer</strong> monitor
+         section.
        </p>
       </li>
       <li>
        <p>
-         <strong>Show solo muting</strong>
+         <strong>Show solo muting</strong> when enabled outlines the mute
+         button on tracks and busses when another track is soloed.
        </p>
       </li>
       <li>
        <p>
-         <strong>Soloing overrides muting</strong>
+         <strong>Soloing overrides muting</strong> when enabled allows a track
+         to be heard when it is soloed while muted. This setting is also
+         available from the <strong>Mixer</strong> monitor section.
        </p>
       </li>
     </ul>
@@ -62,27 +81,33 @@ solo/mute tab"/>
 
   <li>
     <p>
-      <strong>Default track/bus muting options</strong>
+      <strong>Default track/bus muting options</strong> sets the muting options
+      for a newly created tracks or bus. The mute options for an existing track
+      or bus are changed by the right-click context menu on a mute button.
     </p>
     <ul>
       <li>
        <p>
-         <strong>Mute affects pre-fader sends</strong>
+         <strong>Mute affects pre-fader sends</strong> when enabled pre-fader
+         sends will be muted by default.
        </p>
       </li>
       <li>
        <p>
-         <strong>Mute affects post-fader sends</strong>
+         <strong>Mute affects post-fader sends</strong> when enabled post-fader
+         sends will be muted by default.
        </p>
       </li>
       <li>
        <p>
-         <strong>Mute affects control outputs</strong>
+         <strong>Mute affects control outputs</strong> when enabled control
+         outputs are muted by default.
        </p>
       </li>
       <li>
        <p>
-         <strong>Mute affects main outputs</strong>
+         <strong>Mute affects main outputs</strong> when enabled main outputs
+         are muted by default.
        </p>
       </li>
     </ul>
@@ -90,12 +115,19 @@ solo/mute tab"/>
 
   <li>
     <p>
-      <strong>Send Routing</strong>
+      <strong>Send Routing</strong> affects
+      <a href="/signal-routing/aux-sends/">aux and external sends</a>.
     </p>
     <ul>
       <li>
        <p>
-         <strong>Link panners of Aux and External Sends with main panner by default</strong>
+         <strong>Link panners of Aux and External Sends with main panner by
+           default</strong> When enabled, sends follow the channel panner.
+       </p>
+       <p>
+         When disabled, sends can panned independently of the channel panner
+         and fader. Double clicking the send in the processor box toggles
+         the main panner and fader between the aux send and the channel.
        </p>
       </li>
     </ul>
index 97ecbab5e5aaa6d898388b4b31392bdadd560a7d..652b3ca6b2e0bb5f3f3bed1067202fe82c8bdaf1 100644 (file)
@@ -20,31 +20,39 @@ MIDI tab"/>
 
   <li>
     <p>
-      <strong>Send MIDI Clock</strong>
+      <strong>Send MIDI Clock</strong> when enabled Ardour will generate MIDI
+      clock on the <code>ardour:MIDI clock out</code> JACK port.
     </p>
   </li>
 
   <li>
     <p>
-      <strong>Send MIDI Time Code</strong>
+      <strong>Send MIDI Time Code</strong> when enabled Ardour will generate MIDI
+      time code on the <code>ardour:MTC out</code> JACK port.
     </p>
   </li>
 
   <li>
     <p>
-      <strong>Percentage either side of normal transport speed to transmit MTC:</strong>
+      <strong>Percentage either side of normal transport speed to transmit MTC:</strong> MIDI time code generation will be disabled when the transport speed is
+      greater than normal sped plus this percentage or less than normal minus
+      this percentage.
     </p>
   </li>
 
   <li>
     <p>
-      <strong>Obey MIDI Machine Control commands</strong>
+      <strong>Obey MIDI Machine Control commands</strong> when enabled Ardour
+      will respond to MIDI Machine Control commands received on the
+      <code>ardour:MMC in</code> JACK port.
     </p>
   </li>
 
   <li>
     <p>
-      <strong>Send MIDI Machine Control commands</strong>
+      <strong>Send MIDI Machine Control commands</strong> when enabled Ardour
+      will send MIDI Machine Control commands on the <code>ardour:MMC out</code>
+      JACK port.
     </p>
   </li>
 
@@ -56,19 +64,25 @@ MIDI tab"/>
 
   <li>
     <p>
-      <strong>Inbound MMC device ID:</strong>
+      <strong>Inbound MMC device ID:</strong> is the only device ID Ardour will
+      respond to when an MMC command is received on the
+      <code>ardour:MMC in</code> JACK port.
     </p>
   </li>
 
   <li>
     <p>
-      <strong>Outbound MMC device ID:</strong>
+      <strong>Outbound MMC device ID:</strong> is the MIDI device ID Ardour will
+      use when it sends MMC commands.
     </p>
   </li>
 
   <li>
     <p>
-      <strong>Initial program change:</strong>
+      <strong>Initial program change:</strong> Ardour will send a MIDI program
+      change message on the <code>ardour:MMC out</code> JACK port when a session
+      is loaded and whenever this field is changed. A value of -1 is for don't
+      send any program change message.
     </p>
   </li>
 
index 95d5c995b49838023308c4055793a3d9f2d94099..b7b93888108902a4fecba823b32775e658e35101 100644 (file)
@@ -25,7 +25,8 @@ user interaction tab"/>
     <ul>
       <li>
        <p>
-         <strong>Edit using:</strong>
+         <strong>Edit using:</strong> Use this keyboard and mouse combination
+         to edit a region's name, and for audio, the region gain.
        </p>
       </li>
       <li>
@@ -35,12 +36,17 @@ user interaction tab"/>
       </li>
       <li>
        <p>
-         <strong>Insert note using</strong>
+         <strong>Insert note using</strong> Using this mouse and keyboard
+         combination allows MIDI note drawing while the <strong>Editor</strong>
+         is in edit mode.
        </p>
       </li>
       <li>
        <p>
-         <strong>Ignore snap using:</strong>
+         <strong>Ignore snap using:</strong> This mouse and keyboard combination
+         temporarily changes the
+         <a href="/editing-and-arranging/snap-to-the-grid/">snap mode</a> to
+         <strong>No Grid</strong>.
        </p>
       </li>
       <li>
index 522b7732889c1ebafe4427115e86e46d8fc4cf34..29d1761bfeefc2eb4f6068a7a23d92c4c78e50c0 100644 (file)
@@ -5,7 +5,8 @@ menu_title: Plugins Tab
 ---
 
 <p>
-  This tab contains settings that do not belong on the other tabs.
+  This tab contains settings that control the discovery and availability of
+  plugins.
 </p>
 
 <img src="/files/a4/a4_preferences_plugins.png" alt="preferences
@@ -19,17 +20,22 @@ plugins tab"/>
     <ul>
       <li>
        <p>
-         <strong>Scan for Plugins</strong>
+         <strong>Scan for Plugins</strong> will initiate an immediate scan of
+         the system for available plugins.
        </p>
       </li>
       <li>
        <p>
-         <strong>Allow Display Plugin Scan Progress</strong>
+         <strong>Always Display Plugin Scan Progress</strong> When enabled a
+         popup window showing plugin scan progress is displayed for indexing
+         (cache load) and discovery (detect new plugins).
        </p>
       </li>
       <li>
        <p>
-         <strong>Scan Time Out</strong>
+         <strong>Scan Time Out</strong> Specify the default timeout for plugin
+         instantiation in 1/10 seconds. Plugins that require more time to load
+         will be blacklisted. A value of 0 disables the timeout.
        </p>
       </li>
     </ul>
@@ -42,22 +48,28 @@ plugins tab"/>
     <ul>
       <li>
        <p>
-         <strong>Clear VST Cache</strong>
+         <strong>Clear VST Cache</strong> Remove all VST plugins from the list
+         of plugins available to be inserted into the processor box.
        </p>
       </li>
       <li>
        <p>
-         <strong>Clear VST Blacklist</strong>
+         <strong>Clear VST Blacklist</strong> Make blacklisted VST plugins
+         available to be added to the processor box.
        </p>
       </li>
       <li>
        <p>
-         <strong>Scan for [new] VST Plugins on Application Start</strong>
+         <strong>Scan for [new] VST Plugins on Application Start</strong> 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.
        </p>
       </li>
       <li>
        <p>
-         <strong>Linux VST Path:</strong>
+         <strong>Linux VST Path:</strong> Launch a dialog to manage the
+         directories that will be searched for Linux VST plugins.
        </p>
       </li>
     </ul>
index b0714dbf0cf772090f0831e0e4c95c023b3942c6..25c47a1164964cd9e2ac8c91d3abedaf25d82466 100644 (file)
@@ -20,64 +20,47 @@ gui tab"/>
   </li>
   <li>
     <p>
-      <strong>Use name highlight bars in region display</strong>
+      <strong>Use name highlight bars in region display</strong> When enabled the
+      region name is displayed, in the editor,  in it's own bar at the bottom of
+      the region. When disabled, the region name is display at the top of the
+      region, possibly over audio waveforms or MIDI notes.
     </p>
   </li>
   <li>
     <p>
-      <strong>Font scaling</strong>
+      <strong>Font scaling</strong> allows the display size of some text in the
+      user interface to be scaled up or down. May require a restart to take
+      affect.
     </p>
   </li>
   <li>
     <p>
-      <strong>Update transport clock display at FPS</strong>
+      <strong>Update transport clock display at FPS</strong> when enabled the transport clock
+      will update at the synchronization framerate instead of the default 100&nbsp;ms rate.
     </p>
   </li>
   <li>
     <p>
-      <strong>Lock timeout</strong>
+      <strong>Lock timeout</strong> Lock GUI after this many idle seconds (zero to never
+      lock). GUI may also be locked with <kbd class="menu">Session &gt; Lock</kbd>. When
+      locked a dialog will display a &quot;Click to unlock&quot; button.
     </p>
   </li>
   <li>
     <p>
-      <strong>Mixer Strip</strong>
+      <strong>Mixer Strip</strong> Enable (checked) or disable (unchecked) display of
+      controls in the mixer strip. Controls whose display can be toggled are
+      <strong>Input</strong>, <strong>Phase&nbsp;Invert</strong>,
+      <strong>Record&nbsp;&amp;&nbsp;Monitor</strong>, <strong>Solo&nbsp;Iso/Lock</strong>,
+      <strong>Output</strong>, and <strong>Comments</strong>.
+    </p>
+  </li>
+  <li>
+    <p>
+      <strong>Use narrow strips in the mixer by default</strong> When enabled, new mixer
+      strips are created in narrow format. When disabled, they are created in wide format.
+      Existing mixer strips width can be toggled with the width control at the top left of
+      the mixer stip.
     </p>
-    <ul>
-      <li>
-       <p>
-         <strong>Input</strong>
-       </p>
-      </li>
-      <li>
-       <p>
-         <strong>Phase Invert</strong>
-       </p>
-      </li>
-      <li>
-       <p>
-         <strong>Record &amp; Monitor</strong>
-       </p>
-      </li>
-      <li>
-       <p>
-         <strong>Solo Iso/Lock</strong>
-       </p>
-      </li>
-      <li>
-       <p>
-         <strong>Output</strong>
-       </p>
-      </li>
-      <li>
-       <p>
-         <strong>Comments</strong>
-       </p>
-      </li>
-      <li>
-       <p>
-         <strong>Use narrow strips in the mixer by default</strong>
-       </p>
-      </li>
-    </ul>
   </li>
 </ul>
index 18c811468b1d87f1cb8e58728ba4fad21b35f68e..6ce721f8d2d519ff2dc2df1afaa92d0a90f0c772 100644 (file)
@@ -5,7 +5,8 @@ menu_title: Metering Tab
 ---
 
 <p>
-  This tab contains settings that affect the display and behavior of meters.
+  This tab contains settings that affect <a href="/ardours-interface/meters/">
+    Metering</a> in Ardour.
 </p>
 
 <img src="/files/a4/a4_preferences_metering.png" alt="preferences
@@ -14,7 +15,9 @@ metering tab"/>
 <ul>
   <li>
     <p>
-      <strong>Peak hold time:</strong>
+      <strong>Peak hold time:</strong> Some meter types that have a peak
+      indicator that has a user controlled hold time. The options are off, short,
+      medium, or long.
     </p>
   </li>
   <li>
index 3599ba3dc1a5400de93e231d6b8daff23fbdcbc9..9fd5498d0a9858157684e0f7a92fe80f9340f50d 100644 (file)
@@ -14,72 +14,108 @@ theme tab"/>
 <ul>
   <li>
     <p>
-      <strong>Restore Defaults</strong>
+      <strong>Restore Defaults</strong> When clicked will change all settings
+      on the Theme tab back to Ardour's default values.
     </p>
   </li>
   <li>
     <p>
-      <strong>All floating windows are dialogs</strong>
+      <strong>All floating windows are dialogs</strong> When enabled Ardour will
+      use type &quot;Dialog&quot; for all floating windows instead of using type
+      &quot;Utility&quot; for some of them. This may help usability with some
+      window managers. This setting requires a restart of Ardour to take effect.
     </p>
   </li>
   <li>
     <p>
-      <strong>Transient windows follow front window</strong>
+      <strong>Transient windows follow front window</strong> When enabled
+      transient windows will follow the front window when toggling between the
+      editor and mixer. This setting requires a restart of Ardour to take effect.
     </p>
   </li>
   <li>
     <p>
-      <strong>Draw &quot;flat&quot; buttons</strong>
+      <strong>Draw &quot;flat&quot; buttons</strong> When enabled button controls
+      in the user interface will be drawn with a flat look. When disabled button
+      controls will have a slight 3D appearence.
     </p>
   </li>
   <li>
     <p>
-      <strong>Blink Rec-Arm buttons</strong>
+      <strong>Blink Rec-Arm buttons</strong> When enabled the record-armed
+      buttons on tracks will blink when they are armed but not currently
+      recording. When disabled the record-armed buttons on tracks will be
+      outlined in red instead of blinking.
     </p>
   </li>
   <li>
     <p>
-      <strong>Color regions using their track's color</strong>
+      <strong>Color regions using their track's color</strong> When enabled
+      the background color of regions in the editor will be displayed using the
+      the color assigned to the track. When disabled the default region
+      background color will be used.
     </p>
   </li>
   <li>
     <p>
-      <strong>Show waveform clipping</strong>
+      <strong>Show waveform clipping</strong> When enalbled the waveform
+      displayed will show peaks marked in red if they exceed the clip level. The
+      Waveform Clip Level is set with a slider on the Preferences
+      <a href="/preferences-and-session-properties/preferences-dialog/editor/">
+       Editor tab</a>
     </p>
   </li>
   <li>
     <p>
-      <strong>Icon Set</strong>
+      <strong>Icon Set</strong> Changes the mouse cursor icons used to indicate
+      different tool modes in the editor. An example would be the icons used to
+      indicate whether the cursor will select a region or change the length of a
+      region.
     </p>
   </li>
   <li>
     <p>
-      <strong>Waveforms color gradient depth</strong>
+      <strong>Waveforms color gradient depth</strong> Determines how much
+      gradient effect is applied to audio waveforms displayed in the editor.
+      Values range from 0.00, no graident effect, to 0.95, maximum effect.
     </p>
   </li>
   <li>
     <p>
-      <strong>Timeline item gradient depth</strong>
+      <strong>Timeline item gradient depth</strong> Determines how much
+      gradient effect is applied to the backgrounds of regions displayed in the
+      editor. Values range from 0.00, no graident effect, to 0.95, maximum
+      effect.
     </p>
   </li>
   <li>
     <p>
-      <strong>Colors</strong>
+      <strong>Colors</strong> The color of an item in the user interface is
+      determined by which named color is assigned to it, the color displayed for
+      each named color in the palette, and in some cases, the transparency of
+      stacked items.
     </p>
     <ul>
       <li>
        <p>
-         <strong>Items</strong>
+         <strong>Items</strong> Each display item has a named color assigned to
+         it from the palette. Example color names are
+         &quot;meter&nbsp;color9&quot; and &quot;color&nbsp;4&quot;.
+       </p>
+       <p>
+         Click on an item's color example to change the named color choice.
        </p>
       </li>
       <li>
        <p>
-         <strong>Palette</strong>
+         <strong>Palette</strong> Hover over a color to display it's name. Click
+         on a color to open a color chooser dialog.
        </p>
       </li>
       <li>
        <p>
-         <strong>Transparency</strong>
+         <strong>Transparency</strong> Some items have a transparency value.
+         Transparency can be changed from opaque to totally transparent.
        </p>
       </li>
     </ul>