From d4088aa09ba78d3c93d81505bfab9cacf13f5168 Mon Sep 17 00:00:00 2001
From: Junker der Provinz <133605895+junkerderprovinz@users.noreply.github.com>
Date: Wed, 15 Jul 2026 22:38:38 +0200
Subject: [PATCH] doc: describe the cadence of JSON status messages (#21954)

---
 doc/075_scripting.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/075_scripting.rst b/doc/075_scripting.rst
index cd16bb282..6492e940b 100644
--- a/doc/075_scripting.rst
+++ b/doc/075_scripting.rst
@@ -243,6 +243,13 @@ Several commands, in particular long running ones or those that generate a large
 use a format also known as JSON lines. It consists of a stream of new-line separated JSON
 messages. You can determine the nature of the message using the ``message_type`` field.
 
+Messages with type ``status`` are emitted at a regular interval while the command runs,
+by default about ten times per second, regardless of whether the output is a terminal
+or a pipe. Passing ``--quiet`` disables them. The ``RESTIC_PROGRESS_FPS`` environment
+variable overrides both: it sets the number of status updates per second and re-enables
+them even when ``--quiet`` is set. Values below 1 are allowed, for example ``0.0166``
+results in roughly one status message per minute, which is useful when capturing logs.
+
 backup
 ------