]> Shamusworld >> Repos - ardour-manual/blobdiff - include/preferences.html
Edit pages to reflect jackd not being essential
[ardour-manual] / include / preferences.html
index 5bf4bd187306c7ab7072c70083b791d340c76192..cc5067bf988bb9fe9969e0766a21c6e69d7f2b5d 100644 (file)
@@ -1,3 +1,10 @@
+<figure class="right">
+  <img src="/images/preferences.png" alt="The Preferences window">
+  <figcaption>
+    The Preferences window
+  </figcaption>
+</figure>
+
 <p>
   Global <dfn>preferences</dfn> control general workflow and system
   configuration, and should apply to all sessions. They are located in <kbd
@@ -5,7 +12,29 @@
   configuration file</dfn> in the user's home directory.
 </p>
 
-<h2 id="general">General</h2>
+<p>
+       Preferences are conveniently grouped by category:
+</p>
+
+<ul>
+       <li><a href="#preferences-general">General</a></li>
+       <li><a href="#preferences-editor">Editor</a></li>
+       <li><a href="#preferences-mixer">Mixer</a></li>
+       <li><a href="#preferences-signal_flow">Signal Flow</a></li>
+       <li><a href="#preferences-audio">Audio</a></li>
+       <li><a href="#preferences-midi">MIDI</a></li>
+       <li><a href="#preferences-metronome">Metronome</a></li>
+       <li><a href="#preferences-metering">Metering</a></li>
+       <li><a href="#preferences-transport">Transport</a></li>
+       <li><a href="#preferences-sync">Sync</a></li>
+       <li><a href="#preferences-control_surfaces">Control Surfaces</a></li>
+       <li><a href="#preferences-midi_ports">MIDI Ports</a></li>
+       <li><a href="#preferences-plugins">Plugins</a></li>
+       <li><a href="#preferences-appearance">Appearance</a></li>
+       <li><a href="#preferences-video">Video</a></li>
+</ul>
+
+<h2 id="preferences-general">General</h2>
 
 <ul>
   <li>
@@ -62,7 +91,7 @@
     <dfn>Tempo</dfn>
     <ul>
       <li>
-        <dfn>Allow non quarte-note pulse</dfn>: by default, Ardour understands the <a
+        <dfn>Allow non quarter-note pulse</dfn>: by default, Ardour understands the <a
         href="@@tempo-and-meter">tempo</a> as the number of quarter notes in a minute.
         Checking this option allows to set the tempo based on any division of the note,
         from whole to 1/128th. This is reflected in the <kbd class="menu">Edit
       <li>
               <strong>Save undo history</strong> sets how many commands are saved so
               they are available to be undone after reopening the session. This can
-         also be unckecked to keep all actions undoable, at the cost of bigger
+         also be unchecked to keep all actions undoable, at the cost of bigger
          session files.
       </li>
       <li>
   </li>
 </ul>
 
-<h2 id="editor">Editor</h2>
+<h2 id="preferences-editor">Editor</h2>
 
 <ul>
   <li>
       <li>
         <dfn>Limit zooming &amp; summary view to X minutes beyond session extents</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 usefull
+        the chosen time after the end marker, restraining the vision to only useful
         content.
       </li>
       <li>
 
 <p>
   This page allows to choose how things are done in the editor. This is a very
-  flexible way for Ardour to match an existing workflow, or spped up the editing
+  flexible way for Ardour to match an existing workflow, or speed up the editing
   process based on the user's most used actions.
 </p>
 <p>
-  The <kbd class="menu">Reset to recommanded defaults</kbd> button at the bottom
+  The <kbd class="menu">Reset to recommended defaults</kbd> button at the bottom
   provides a way to revert any user made change to its default value.
 </p>
 
-<h2 id="mixer">Mixer</h2>
+<h2 id="preferences-mixer">Mixer</h2>
 
 <ul>
   <li>
          available from the <strong>Mixer</strong> monitor section.
       </li>
       <li>
-        <dfn>Solo-in-place mute cut (dB):</dfn> sets the attenuation of the
+        <dfn>Solo-in-place mute cut (dB):</dfn> sets the attenuation of
          the other tracks when another track is soloed in place. This setting
          is also available from the <strong>Mixer</strong> monitor section. The
         default is "&minus;inf" for &minus;&infin;, meaning the other tracks are
 
 </ul>
 
-<h2 id="signal_flow">Signal Flow</h2>
+<h2 id="preferences-signal_flow">Signal Flow</h2>
 
 <ul>
   <li>
   </li>
 </ul>
 
-<h2 id="audio">Audio</h2>
+<h2 id="preferences-audio">Audio</h2>
 
 <ul>
   <li>
       <li>
         <dfn>Replicate missing region channels</dfn>: if a track is N-channel,
         and the region has fewer channels, this option copies the existing
-        channel's data for this non-existant one. If left unckecked, the missing
+        channel's data for this non-existent one. If left unchecked, the missing
         channels will stay silent.
       </li>
     </ul>
   </li>
 </ul>
 
-<h2 id="midi">MIDI</h2>
+<h2 id="preferences-midi">MIDI</h2>
 
 <ul>
   <li>
     <ul>
       <li>
         <dfn>Initial program change:</dfn> Ardour will send a MIDI program
-        change message on the <code>ardour:MMC out</code> JACK port when a session
+        change message on the <code>ardour:MMC out</code> MIDI port when a session
         is loaded and whenever this field is changed. A value of -1 means don't
         send any program change message.
       </li>
   </li>
 </ul>
 
-<h2 id="metronome">Metronome</h2>
+<h2 id="preferences-metronome">Metronome</h2>
 
 <ul>
   <li>
   </li>
 </ul>
 
-<h2 id="metering">Metering</h2>
+<h2 id="preferences-metering">Metering</h2>
 
 <ul>
   <li>
       </li>
       <li>
         <dfn>VU Meter standard:</dfn> selects which standard to use for the zero
-        value of the vu-meters, i.e. how manu analog dBu are considered 0 on the
+        value of the vu-meters, i.e. the analog dBu value that will show as 0 on the
         VU-meter.
       </li>
       <li>
   </li>
 </ul>
 
-<h2 id="transport">Transport</h2>
+<h2 id="preferences-transport">Transport</h2>
 
 <ul>
   <li>
   </li>
 </ul>
 
-<h2 id="sync">Sync</h2>
+<h2 id="preferences-sync">Sync</h2>
 
 <ul>
   <li>
       <li>
         <dfn>Enable Mclk generator</dfn> when enabled Ardour will generate a
         (tempo dependant) beat clock at a rate of 24 pulses per quarter note on
-        the <code>ardour:MIDI clock out</code> JACK port.
+        the <code>ardour:MIDI clock out</code> port.
       </li>
     </ul>
   </li>
     <ul>
       <li>
         <dfn>Enable MTC Generator</dfn> when enabled Ardour will generate MIDI
-        time code on the <code>ardour:MTC out</code> JACK port.
+        time code on the <code>ardour:MTC out</code> MIDI port.
       </li>
       <li>
         <dfn>Percentage either side of normal transport speed to transmit MTC:</dfn>
       <li>
         <dfn>Respond to MMC commands</dfn> when enabled Ardour will respond
         to MIDI Machine Control commands received on the <code>ardour:MMC in</code>
-        JACK port.
+        MIDI port.
       </li>
       <li>
         <dfn>Send MMC commands</dfn> when enabled Ardour will send MIDI Machine
         Control commands on the <code>ardour:MMC out</code>
-        JACK port.
+        MIDI port.
       </li>
       <li>
         <dfn>Inbound MMC device ID:</dfn> is the only device ID Ardour will
         respond to when an MMC command is received on the <code>ardour:MMC in</code>
-        JACK port.
+        MIDI port.
       </li>
       <li>
         <dfn>Outbound MMC device ID:</dfn> is the MIDI device ID Ardour will
   </li>
 </ul>
 
-<h2 id="control_surfaces">Control Surfaces</h2>
+<h2 id="preferences-control_surfaces">Control Surfaces</h2>
 
 <p>
   This tab contains settings for <a href="@@control-surfaces">control surfaces</a>.
   protocol settings</kbd> (only for Generic MIDI and Open Sound Control).
 </p>
 
-<h2 id="midi_ports">MIDI Ports</h2>
+<h2 id="preferences-midi_ports">MIDI Ports</h2>
 
 <ul>
   <li>
   </li>
 </ul>
 
-<h2 id="plugins">Plugins</h2>
+<h2 id="preferences-plugins">Plugins</h2>
 
 <p class="note">
   The content of this preference page varies heavily between versions or Ardour:
   both the platform and the build-time options can make Ardour support some types
   of plugins and not others. While this documentation tries to show all possible
   options, most systems will only show a subset of the options hereunder, e.g.
-  AudioUnits are MacOs only&hellip;
+  AudioUnits are macOS only&hellip;
 </p>
 
 <ul>
     <ul>
       <li>
         <dfn>Scan for Plugins</dfn> will initiate an immediate scan of the system
-        for available plugins. Usefull to get a newly installed plugin recognised
+        for available plugins. Useful to get a newly installed plugin recognised
         by Ardour.
       </li>
     </ul>
         only be shown when <kbd class="mouse">double clicking</kbd> it.
       </li>
       <li>
-        <dfn>Show Plugin Inline Display on Mixestrip by default</dfn> allows Ardour
+        <dfn>Show Plugin Inline Display on Mixestrip 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
         <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, superseeds it and hides the plugin GUI at creation if it has an
+        is checked, supercedes it and hides the plugin GUI at creation if it has an
         Inline Display, like Ardour's own <code>a-*</code> plugins.
       </li>
     </ul>
       <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 &infinity; disables the timeout.
+        blacklisted. A value of &infin; disables the timeout.
       </li>
       <li>
         <dfn>VST Cache:</dfn> Clicking the <kbd class="menu">Clear</kbd> button
         removes all VST plugins from the list of plugins available to be
-        inserted into the processor box. A new VST plugins scan is then required.
+        inserted into the processor box. A new VST plugin scan is then required.
       </li>
       <li>
         <dfn>VST Blacklist:</dfn> Clicking the <kbd class="menu">Clear</kbd>
     <ul>
       <li>
         <dfn>Scan for [new] AudioUnit Plugins on Application Start</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.
+        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.
       </li>
       <li>
         <dfn>AU Cache:</dfn> Clicking the <kbd class="menu">Clear</kbd> button
   </li>
 </ul>
 
-<h2 id="appearance">Appearance</h2>
+<h2 id="preferences-appearance">Appearance</h2>
 
 <ul>
   <li>
       <li>
         <dfn>Blink Alert indicators</dfn>: when enabled, the Alert indicators (like
         the <kbd class="menu">Error Log</kbd> or the <kbd class="menu">Feedback</kbd>
-        button) will blink when they are active (when resp. an error or a feedback
-        has been detected) When disabled, the indicators will turn red instead of
+        button) will blink when they are active (when an error or feedback
+        has been detected, respectively). When disabled, the indicators will turn red instead of
         blinking.
       </li>
       <li>
       <li>
         <dfn>Use name highlight bars in region displays (requires a restart)</dfn>:
         when enabled, the region name is displayed, in the editor, in its own opaque bar
-        at the bottom of the region. When disabled, the region name is overlayed
+        at the bottom of the region. When disabled, the region name is overlaid
         at the top of the region, possibly over audio waveforms or MIDI notes.
       </li>
       <li>
         <dfn>Region color follows track color</dfn>: when enabled,
-        the background color of regions in the editor will be displayed using the
+        the background color of regions in the editor will be displayed using
         the color assigned to the track. When disabled the default region
         background color will be used.
       </li>
       <li>
         <dfn>LED meter style</dfn> if checked, the bar meters in the editor and
         mixer will be styled to look like if they were made of LEDs, with a dotted
-        bar. Unckeking this option makes the bars flat and continuous.
+        bar. Unchecking this option makes the bars flat and continuous.
       </li>
       <li>
         <dfn>Waveforms color gradient depth:</dfn> determines how much gradient
       <li>
         <dfn>Use visibility information provided by your Window Manager/Desktop</dfn>
         allows the system window manager's rules for the windows visibility to
-        superseed Ardour's.
+        supercede Ardour's.
       </li>
       <li>
         <dfn>All floating windows are dialogs</dfn>: when enabled, Ardour will
   </li>
 </ul>
 
-<h2 id="video">Video</h2>
+<h2 id="preferences-video">Video</h2>
 
 <ul>
   <li>
     <ul>
       <li>
         <dfn>Show Video Export Info before export</dfn> Shows a warning message
-        when exporting a video about licencing and offers to open the
+        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.
-        This options shows the server's startup dialog (usefull for degbugging a
-        malfunctionning video).
+        This options shows the server's startup dialog (useful for debugging a
+        malfunctioning video).
       </li>
       <li>
         <dfn>Advanced Setup (remote video server)</dfn> can be used when the setup
       </li>
       <li>
         <dfn>Video Server URL:</dfn> Base URL of the video server delivering the video
-        through the network (<code>http://IP-or-adress:port</code>).
+        through the network (<code>http://IP-or-address:port</code>).
       </li>
       <li>
         <dfn>Video folder</dfn> is the server's local path to the document-root,