Service: manual section + menu-list sweep
Local checkpoint - NOT for public release. - New manual section "24. The lock-screen service (send only)": what it is, the send-only/WASAPI-only limits, the yield-to-the-app behaviour, the Service menu (configure/install/start/stop), and the good-to-know notes (direct peers, firewall, updates picked up on next restart, install both ends for two-way). - Swept the two stale "Menus (File, Record, Options, Help)" references to include Service; added a Service-menu pointer at the end of the Menus section. - Updater needs NO change: UpdateApplier renames the old exe aside (survives the running service's lock) then copies the new one in, so the service keeps running the previous version until its next restart and never blocks a swap. Documented. MANUAL.md regenerates from readme.html at release time (sync-manual.py), so untouched. Gate 20/20. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 4.8
parent
f4551517e5
commit
6e84f491e8
+36
-4
@@ -31,7 +31,7 @@ ul, ol { padding-left: 1.4em; }
|
|||||||
<li><a href="#quick-start">Quick start</a></li>
|
<li><a href="#quick-start">Quick start</a></li>
|
||||||
<li><a href="#profiles">Profiles</a></li>
|
<li><a href="#profiles">Profiles</a></li>
|
||||||
<li><a href="#main-window">The main window: menu bar and tabs</a></li>
|
<li><a href="#main-window">The main window: menu bar and tabs</a></li>
|
||||||
<li><a href="#menu-bar">Menus (File, Record, Options, Help)</a></li>
|
<li><a href="#menu-bar">Menus (File, Record, Options, Service, Help)</a></li>
|
||||||
<li><a href="#tab-connectivity">Connectivity tab</a></li>
|
<li><a href="#tab-connectivity">Connectivity tab</a></li>
|
||||||
<li><a href="#tab-io">Audio inputs and outputs tab</a></li>
|
<li><a href="#tab-io">Audio inputs and outputs tab</a></li>
|
||||||
<li><a href="#tab-profile">Audio profile tab</a></li>
|
<li><a href="#tab-profile">Audio profile tab</a></li>
|
||||||
@@ -50,6 +50,7 @@ ul, ol { padding-left: 1.4em; }
|
|||||||
<li><a href="#recording">Recording to a file</a></li>
|
<li><a href="#recording">Recording to a file</a></li>
|
||||||
<li><a href="#logs">Logs and diagnostics</a></li>
|
<li><a href="#logs">Logs and diagnostics</a></li>
|
||||||
<li><a href="#command-line">Command-line options</a></li>
|
<li><a href="#command-line">Command-line options</a></li>
|
||||||
|
<li><a href="#service">The lock-screen service (send only)</a></li>
|
||||||
<li><a href="#troubleshooting">Troubleshooting</a></li>
|
<li><a href="#troubleshooting">Troubleshooting</a></li>
|
||||||
<li><a href="#glossary">Glossary</a></li>
|
<li><a href="#glossary">Glossary</a></li>
|
||||||
</ol>
|
</ol>
|
||||||
@@ -272,7 +273,7 @@ ul, ol { padding-left: 1.4em; }
|
|||||||
<li><strong>Cancel</strong> — do nothing.</li>
|
<li><strong>Cancel</strong> — do nothing.</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2 id="menu-bar">5. Menus (File, Record, Options, Help)</h2>
|
<h2 id="menu-bar">5. Menus (File, Record, Options, Service, Help)</h2>
|
||||||
|
|
||||||
<p>There are four menus on the main window: <strong>File (Alt+F)</strong>, <strong>Record (Alt+K)</strong>, <strong>Options (Alt+O)</strong> and <strong>Help (Alt+H)</strong>. The Record menu opens with Alt+K rather than Alt+R because Alt+R is already used by the <strong>Receive audio</strong> checkbox on the main window. The menu's title is shown as “Record (Alt+K)” so you can find the shortcut even though there is no K in the word.</p>
|
<p>There are four menus on the main window: <strong>File (Alt+F)</strong>, <strong>Record (Alt+K)</strong>, <strong>Options (Alt+O)</strong> and <strong>Help (Alt+H)</strong>. The Record menu opens with Alt+K rather than Alt+R because Alt+R is already used by the <strong>Receive audio</strong> checkbox on the main window. The menu's title is shown as “Record (Alt+K)” so you can find the shortcut even though there is no K in the word.</p>
|
||||||
|
|
||||||
@@ -363,6 +364,8 @@ ul, ol { padding-left: 1.4em; }
|
|||||||
<tr><td><strong>Enable the remembered peers list on the Connectivity tab</strong></td><td>Alt+R</td><td>On by default. Untick to hide the Remembered peers list from the Connectivity tab.</td></tr>
|
<tr><td><strong>Enable the remembered peers list on the Connectivity tab</strong></td><td>Alt+R</td><td>On by default. Untick to hide the Remembered peers list from the Connectivity tab.</td></tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
<p>The <strong>Service</strong> menu (Alt+S) installs and controls the optional <a href="#service">lock-screen service</a> that keeps sending your audio when you are not at the machine. See that section for the details.</p>
|
||||||
|
|
||||||
<h2 id="tab-connectivity">6. Connectivity tab</h2>
|
<h2 id="tab-connectivity">6. Connectivity tab</h2>
|
||||||
|
|
||||||
<p>This is where you manage peers and reach the logging options. The controls on this tab, in tab order:</p>
|
<p>This is where you manage peers and reach the logging options. The controls on this tab, in tab order:</p>
|
||||||
@@ -1381,7 +1384,36 @@ RemSound.exe --connect 192.168.1.42
|
|||||||
|
|
||||||
<p>A common support sequence: ask the person to run <code>--diagnostics</code> and send you the file, then have them run <code>--selftest</code> — if that says PASS, capture, encoding and the audio path are all sound on their machine and the problem is somewhere in the connection between you.</p>
|
<p>A common support sequence: ask the person to run <code>--diagnostics</code> and send you the file, then have them run <code>--selftest</code> — if that says PASS, capture, encoding and the audio path are all sound on their machine and the problem is somewhere in the connection between you.</p>
|
||||||
|
|
||||||
<h2 id="troubleshooting">24. Troubleshooting</h2>
|
<h2 id="service">24. The lock-screen service (send only)</h2>
|
||||||
|
|
||||||
|
<p>Normally RemSound runs as an app you open and close. The <strong>lock-screen service</strong> is a second, silent way to run it: a Windows service that keeps <em>sending</em> this machine's audio to your peers even when the screen is locked, when you have signed out, and when nobody is logged in at all (for example after an unattended restart). It is useful when a machine needs to stream its audio continuously without someone sitting at it.</p>
|
||||||
|
|
||||||
|
<p>It is deliberately limited:</p>
|
||||||
|
<ul>
|
||||||
|
<li><strong>Send only.</strong> The service captures and sends; it never plays received audio. (Windows silences audio output when no one is logged in, so receiving on the lock screen is not possible.) Use the normal app for listening.</li>
|
||||||
|
<li><strong>WASAPI only.</strong> ASIO devices cannot be used by a Windows service. If you need ASIO, use the normal app.</li>
|
||||||
|
<li><strong>It gets out of your way.</strong> Whenever you open the normal RemSound app, the service automatically stops sending and hands over to you — so you are always in control while you are at the machine. When you close the app (or it crashes, or you sign out), the service takes over again a couple of seconds later, re-reading its profile so any changes you made are picked up. You never need to stop it by hand to make a change.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Setting it up</h3>
|
||||||
|
<p>Everything lives in the <strong>Service</strong> menu on the menu bar:</p>
|
||||||
|
<ol>
|
||||||
|
<li><strong>Configure service profile…</strong> — opens a small window with three tabs (Audio send, Audio profile, Connectivity) where you choose what to send, how to send it, and who to send it to, plus a password. This is a separate profile from your normal ones and does not appear in the usual profile list. There is no “send my audio” switch because the service always sends. The <strong>Additional options</strong> button lets you turn the connect/disconnect sounds and the service's own log on or off.</li>
|
||||||
|
<li><strong>Install service</strong> — registers it with Windows so it starts automatically at every boot. Windows asks for administrator permission (one prompt). Do this once.</li>
|
||||||
|
<li><strong>Start service</strong> / <strong>Stop service</strong> — run or halt it now without waiting for a reboot. Also administrator actions.</li>
|
||||||
|
<li><strong>Uninstall service</strong> — removes it entirely.</li>
|
||||||
|
</ol>
|
||||||
|
<p>The top of the Service menu always shows the current state: not installed, installed and running, or installed and stopped.</p>
|
||||||
|
|
||||||
|
<h3>Good to know</h3>
|
||||||
|
<ul>
|
||||||
|
<li>The service sends to the exact peer addresses you list in its profile (a computer on your network, or a reachable address across the internet). Automatic peer discovery and hole-punching are handled by the normal app, not the service.</li>
|
||||||
|
<li>Because the service runs even when you are not logged in, it sends from the system account — the installer arranges the firewall so its audio can get out.</li>
|
||||||
|
<li>When RemSound updates itself, the service keeps running the previous version until its next restart (or the next reboot), then picks up the new one. Nothing breaks in the meantime.</li>
|
||||||
|
<li>If two computers should each stream to the other unattended, install the service on both.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2 id="troubleshooting">25. Troubleshooting</h2>
|
||||||
|
|
||||||
<h3>I don't hear my friend</h3>
|
<h3>I don't hear my friend</h3>
|
||||||
<ol>
|
<ol>
|
||||||
@@ -1456,7 +1488,7 @@ RemSound.exe --connect 192.168.1.42
|
|||||||
</ul>
|
</ul>
|
||||||
<p>If none of those apply, just fall back to Tailscale — it works without involving the router at all.</p>
|
<p>If none of those apply, just fall back to Tailscale — it works without involving the router at all.</p>
|
||||||
|
|
||||||
<h2 id="glossary">25. Glossary</h2>
|
<h2 id="glossary">26. Glossary</h2>
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
<tr><th>Term</th><th>Meaning</th></tr>
|
<tr><th>Term</th><th>Meaning</th></tr>
|
||||||
|
|||||||
Reference in New Issue
Block a user