man: document new varlinkctl feature

This commit is contained in:
Lennart Poettering
2026-02-09 10:54:18 +01:00
parent 607152c742
commit e2f23b6deb
2 changed files with 48 additions and 0 deletions
+47
View File
@@ -181,6 +181,16 @@
<xi:include href="version-info.xml" xpointer="v255"/></listitem>
</varlistentry>
<varlistentry>
<term><command>list-registry</command></term>
<listitem><para>Shows a list of Varlink services currently registered in the service registry, plus
their entrypoint sockets. (Currently, this simply enumerates the sockets and symlinked sockets in
<filename>/run/varlink/registry/</filename>, see below.)</para>
<xi:include href="version-info.xml" xpointer="v260"/></listitem>
</varlistentry>
<varlistentry>
<term><command>validate-idl</command> [<replaceable>FILE</replaceable>]</term>
@@ -354,6 +364,18 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option></term>
<term><option>--user</option></term>
<listitem>
<para>Determines whether to query to the per-system or per-user registry when using the
<command>list-registry</command> command. By default, the per-system registry is queried.</para>
</listitem>
<xi:include href="version-info.xml" xpointer="v260"/>
</varlistentry>
<xi:include href="standard-options.xml" xpointer="no-ask-password" />
<xi:include href="standard-options.xml" xpointer="no-pager" />
<xi:include href="standard-options.xml" xpointer="help" />
@@ -361,6 +383,31 @@
</variablelist>
</refsect1>
<refsect1>
<title>Files &amp; Directories</title>
<variablelist>
<varlistentry>
<term><filename>/run/varlink/registry/</filename></term>
<listitem>
<para>Directory containing <constant>AF_UNIX</constant> entrypoint socket inodes (or symlinks to
them) of well-known, public Varlink interfaces on the local system. They are named after the
Varlink interface they implement.</para>
<para>Use <command>varlinkctl list-registry</command> to show the contents of this
directory.</para>
<para>(Inodes that neither qualify as socket inodes nor as symlinks to them shall be ignored. A
future extension might introduce regular files and directories to enhance the registry
functionality.)</para>
<xi:include href="version-info.xml" xpointer="v260"/>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
+1
View File
@@ -572,3 +572,4 @@ loader.conf.xml ./refsect1[title="Options"]/variablelist/varlistentry[term="rebo
loader.conf.xml ./refsect1[title="Options"]/variablelist/varlistentry[term="reboot-on-error"]/listitem/para/variablelist/varlistentry[term="auto"]
loader.conf.xml ./refsect1[title="Options"]/variablelist/varlistentry[term="secure-boot-enroll-action"]/listitem/variablelist/varlistentry[term="reboot"]
loader.conf.xml ./refsect1[title="Options"]/variablelist/varlistentry[term="secure-boot-enroll-action"]/listitem/variablelist/varlistentry[term="shutdown"]
varlinkctl.xml ./refsect1[title="Options"]/variablelist/varlistentry[term="--system"]