Skip to content

Commit 9c17ecf

Browse files
committed
docs: add serialization interval
1 parent 2025d51 commit 9c17ecf

File tree

5 files changed

+35
-5
lines changed

5 files changed

+35
-5
lines changed

docs/src/options.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,18 @@ Options:
270270
pane_viewport_serialization 100
271271
```
272272

273+
### serialization_interval
274+
How often in seconds sessions are serialized to disk (if `session_serialization` is enabled).
275+
276+
*Note: this might incur higher resource utilization (and certainly a higher cache folder usage...)*
277+
278+
Options:
279+
- `int`: the interval in seconds
280+
281+
```javascript
282+
serialization_interval 60
283+
```
284+
273285
### disable_session_metadata
274286
Enable or disable writing of session metadata to disk
275287

@@ -305,7 +317,7 @@ Options:
305317
show_startup_tips true
306318
```
307319

308-
### show_release_nodes
320+
### show_release_notes
309321
Show release notes on first run of a new version. These can also be browsed through the `about` plugin with `Ctrl o` + `a`.
310322

311323
Options:

static/documentation/options.html

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,15 @@ <h3 id="scrollback_lines_to_serialize"><a class="header" href="#scrollback_lines
338338
</ul>
339339
<pre><code class="language-javascript">pane_viewport_serialization 100
340340
</code></pre>
341+
<h3 id="serialization_interval"><a class="header" href="#serialization_interval">serialization_interval</a></h3>
342+
<p>How often in seconds sessions are serialized to disk (if <code>session_serialization</code> is enabled).</p>
343+
<p><em>Note: this might incur higher resource utilization (and certainly a higher cache folder usage...)</em></p>
344+
<p>Options:</p>
345+
<ul>
346+
<li><code>int</code>: the interval in seconds</li>
347+
</ul>
348+
<pre><code class="language-javascript">serialization_interval 60
349+
</code></pre>
341350
<h3 id="disable_session_metadata"><a class="header" href="#disable_session_metadata">disable_session_metadata</a></h3>
342351
<p>Enable or disable writing of session metadata to disk</p>
343352
<p><em>Note: If disabled, other sessions might not know metadata info on this session, so features such as the session-manager and session listing might not work properly.</em></p>
@@ -366,7 +375,7 @@ <h3 id="show_startup_tips"><a class="header" href="#show_startup_tips">show_star
366375
</ul>
367376
<pre><code class="language-javascript">show_startup_tips true
368377
</code></pre>
369-
<h3 id="show_release_nodes"><a class="header" href="#show_release_nodes">show_release_nodes</a></h3>
378+
<h3 id="show_release_notes"><a class="header" href="#show_release_notes">show_release_notes</a></h3>
370379
<p>Show release notes on first run of a new version. These can also be browsed through the <code>about</code> plugin with <code>Ctrl o</code> + <code>a</code>.</p>
371380
<p>Options:</p>
372381
<ul>

static/documentation/print.html

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -620,6 +620,15 @@ <h3 id="scrollback_lines_to_serialize"><a class="header" href="#scrollback_lines
620620
</ul>
621621
<pre><code class="language-javascript">pane_viewport_serialization 100
622622
</code></pre>
623+
<h3 id="serialization_interval"><a class="header" href="#serialization_interval">serialization_interval</a></h3>
624+
<p>How often in seconds sessions are serialized to disk (if <code>session_serialization</code> is enabled).</p>
625+
<p><em>Note: this might incur higher resource utilization (and certainly a higher cache folder usage...)</em></p>
626+
<p>Options:</p>
627+
<ul>
628+
<li><code>int</code>: the interval in seconds</li>
629+
</ul>
630+
<pre><code class="language-javascript">serialization_interval 60
631+
</code></pre>
623632
<h3 id="disable_session_metadata"><a class="header" href="#disable_session_metadata">disable_session_metadata</a></h3>
624633
<p>Enable or disable writing of session metadata to disk</p>
625634
<p><em>Note: If disabled, other sessions might not know metadata info on this session, so features such as the session-manager and session listing might not work properly.</em></p>
@@ -648,7 +657,7 @@ <h3 id="show_startup_tips"><a class="header" href="#show_startup_tips">show_star
648657
</ul>
649658
<pre><code class="language-javascript">show_startup_tips true
650659
</code></pre>
651-
<h3 id="show_release_nodes"><a class="header" href="#show_release_nodes">show_release_nodes</a></h3>
660+
<h3 id="show_release_notes"><a class="header" href="#show_release_notes">show_release_notes</a></h3>
652661
<p>Show release notes on first run of a new version. These can also be browsed through the <code>about</code> plugin with <code>Ctrl o</code> + <code>a</code>.</p>
653662
<p>Options:</p>
654663
<ul>

static/documentation/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

static/documentation/searchindex.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)