From 9edb5d8185a5ae97c7ec46bc1de4902f8d133f4d Mon Sep 17 00:00:00 2001
From: Ed Ward <edwsaintesprit@hotmail.com>
Date: Thu, 12 Jan 2017 20:11:12 +0100
Subject: [PATCH] Documenting the satus bar

---
 master-doc.txt | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/master-doc.txt b/master-doc.txt
index b4b1828..d3aed91 100644
--- a/master-doc.txt
+++ b/master-doc.txt
@@ -7009,16 +7009,35 @@ title: Status Bar
 part: chapter
 ---
 
-<p class="fixme">Add content</p>
+<img src="/images/status-bar.png" alt="The status bar">
+<p>The status bar is an informative bar at the top of the window, showing:</p>
+<ul>
+  <li><dfn>File:</dfn> the file format used in the session, including when recording</li>
+  <li><dfn>TC:</dfn> is the timecode, i.e. the number of frames per second used by the session (for videos)</li>
+  <li><dfn>Audio:</dfn> gives the sample rate used in the session, and the latency computed from the buffer size</li>
+  <li><dfn>Buffers:</dfn> decribe how much data is buffered, see below</li>
+  <li><dfn>DSP:</dfn> for Digital Sound Processing, shows how much of the CPU is used by Ardour and its plugins</li>
+  <li><dfn>X:</dfn> shows the number of xruns since Ardour's launch, see below</li>
+  <li><dfn>Disk:</dfn> reports the remaining hard disk space as the time that can be recorded with the current session setting</li>
+  <li><dfn>a Clock</dfn> showing the system time</li>
+  <li><dfn>a Log button</dfn> that indicates if Ardour has encountered any warning or error.</li>
+</ul>
 
+<p>The buffers are labelled as <kbd class="menu">p</kbd> for playback and <kbd class="menu">c</kbd> for capture. If the
+system is fast enough, these buffers should be 100% full at all times, showing the system has time to precompute
+all the data before delivering it to the audio system. A buffer constantly under 20% is a sign of an underpowered
+computer system or of too much processing.</p>
+
+<p>An Xrun (short for buffer over- or under-run) happens when the system has been forced to skip audio frames, e.g. if the latency
+asked is too short for the computing power of the machine. It usually results in clicks, pops and crackles if it happens while recording.</p>
+
+<p>The log button turns yellow when a warning is shows, and red when an error occurs. Clicking the log button gives acces to the log.</p>
 
 ---
 title: Transport bar and times
 part: chapter
 ---
 
-<p class="fixme">There is no discussion of starting playback anywhere in here. Starting/stopping needs to be explained</p>
-
 <p>
   Ardour offers many ways to <dfn>control playback</dfn> of your session, including the transport bar, key bindings and remote controls. You can also use markers to define locations or ranges within the session and rapidly move around between them.
 </p>
-- 
2.37.2