Skip to content

doc: revise autogenerated manpages - #498

Open
andreasglashauser wants to merge 8 commits into
QubesOS:mainfrom
andreasglashauser:manpage-review-11056
Open

andreasglashauser wants to merge 8 commits into
QubesOS:mainfrom
andreasglashauser:manpage-review-11056

Conversation

@andreasglashauser

@andreasglashauser andreasglashauser commented Aug 20, 2026

Copy link
Copy Markdown

Rewrite the eight manpages that still carried the "autogenerated from command-line parser" placeholder.

fixes QubesOS/qubes-issues#11056

Disclosure per the AI contribution guidance: I used Kimi K3 for phrasing ideas. I always reworked its suggestions into my own drafts, so i did not copy them. Commit messages were generated by a personal of mine running a small local LLM.

Describe actual behavior (resume of suspended qubes, handling of
internal qubes with --all, exit codes) and remove the autogenerated
placeholder admonition.

QubesOS/qubes-issues#11056
Explain what tags are for (qrexec policy matching, automatic
created-by-/guivm-/audiovm- tags), fix the 'del' synopsis (it accepts
exactly one tag) and remove the autogenerated placeholder admonition.

QubesOS/qubes-issues#11056
Document confirmation prompts (including IKNOWWHATIAMDOING for --all),
dependency errors, glob patterns in VMNAME, exit codes; remove the
autogenerated placeholder admonition.

QubesOS/qubes-issues#11056
Describe what exactly gets copied (volumes, properties, tags, features,
notes, firewall, devices), pool selection, and remove the autogenerated
placeholder admonition.

QubesOS/qubes-issues#11056
Document exit codes (0/1/3), AND-combination of state options, scripting
usage example; remove the autogenerated placeholder admonition.

QubesOS/qubes-issues#11056
Describe dependency startup, parallel start of multiple qubes, glob
patterns, temporary drive attachment semantics and exit codes; remove
the autogenerated placeholder admonition.

QubesOS/qubes-issues#11056
Add description of restore semantics (restore as new qubes, dom0 home
to home-restore-<timestamp>, passphrase/confirmation flow, positional
arguments, untrusted-backup considerations) and remove the autogenerated
placeholder admonition.

QubesOS/qubes-issues#11056
Explain what the tool actually does (start qubes-guid /
pacat-simple-vchan in the GUI/Audio qube), describe its three operation
modes (one-shot, --watch, --notify-monitor-layout), fix
--notify-monitory-layout typo in synopsis, document the default pidfile
path; remove the autogenerated placeholder admonition.

QubesOS/qubes-issues#11056
@andreasglashauser andreasglashauser changed the title Manpage review 11056 doc: revise autogenerated manpages Aug 20, 2026
@codecov

codecov Bot commented Aug 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.85%. Comparing base (bb41ca5) to head (4567245).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #498   +/-   ##
=======================================
  Coverage   76.84%   76.85%           
=======================================
  Files          53       53           
  Lines        9434     9436    +2     
=======================================
+ Hits         7250     7252    +2     
  Misses       2184     2184           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Review autogenerated manpages in core-admin-client

1 participant