summaryrefslogtreecommitdiffstats
path: root/man/userdbctl.xml
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2024-10-23 15:19:36 +0200
committerLennart Poettering <lennart@poettering.net>2024-10-24 10:17:23 +0200
commitad5de3222f70747eda758cacaf8a932d2c57b5ca (patch)
tree88ed5f2da9db45a919f3fafcea1a81a72d0f027a /man/userdbctl.xml
parentman: insert a comma before 'and' (diff)
downloadsystemd-ad5de3222f70747eda758cacaf8a932d2c57b5ca.tar.xz
systemd-ad5de3222f70747eda758cacaf8a932d2c57b5ca.zip
userdbctl: add some basic client-side filtering
This adds some basic client-side user/group filtering to "userdbctl": 1. by uid/gid min/max 2. by user "disposition" (i.e. show only regular users with "userdbctl user -R") 3. by fuzzy name (i.e. search by substring/levenshtein of user name, real name, and other identifiers of the user/group record). In the long run we also want to support this server side, but let's start out with doing this client-side, since many backends won't support server-side filtering anytime soon anyway, so we need it in either case.
Diffstat (limited to 'man/userdbctl.xml')
-rw-r--r--man/userdbctl.xml51
1 files changed, 51 insertions, 0 deletions
diff --git a/man/userdbctl.xml b/man/userdbctl.xml
index a7b438ad91..03309f8a52 100644
--- a/man/userdbctl.xml
+++ b/man/userdbctl.xml
@@ -174,6 +174,57 @@
<xi:include href="version-info.xml" xpointer="v250"/></listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>--fuzzy</option></term>
+ <term><option>-z</option></term>
+
+ <listitem><para>When used with the <command>user</command> or <command>group</command> command, do a
+ fuzzy string search. Any specified arguments will be matched against the user name, the real name of
+ the user record, the email address, and other descriptive strings of the user or group
+ record. Moreover, instead of precise matching, a substring match or a match allowing slight
+ deviations in spelling is applied.</para>
+
+ <xi:include href="version-info.xml" xpointer="v257"/></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--disposition=</option></term>
+
+ <listitem><para>When used with the <command>user</command> or <command>group</command> command,
+ filters by disposition of the record. Takes one of <literal>intrinsic</literal>,
+ <literal>system</literal>, <literal>regular</literal>, <literal>dynamic</literal>,
+ <literal>container</literal>. May be used multiple times, in which case only users matching any of
+ the specified dispositions are shown.</para>
+
+ <xi:include href="version-info.xml" xpointer="v257"/></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-I</option></term>
+ <term><option>-S</option></term>
+ <term><option>-R</option></term>
+
+ <listitem><para>Shortcuts for <option>--disposition=intrinsic</option>,
+ <option>--disposition=system</option>, <option>--disposition=regular</option>,
+ respectively.</para>
+
+ <xi:include href="version-info.xml" xpointer="v257"/></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--uid-min=</option></term>
+ <term><option>--uid-max=</option></term>
+
+ <listitem><para>When used with the <command>user</command> or <command>group</command> command,
+ filters the output by UID/GID ranges. Takes numeric minimum resp. maximum UID/GID values. Shows only
+ records within the specified range. When applied to the <command>user</command> command matches
+ against UIDs, when applied to the <command>group</command> command against GIDs (despite the name of
+ the switch). If unspecified defaults to 0 (for the minimum) and 4294967294 (for the maximum), i.e. by
+ default no filtering is applied as the whole UID/GID range is covered.</para>
+
+ <xi:include href="version-info.xml" xpointer="v257"/></listitem>
+ </varlistentry>
+
<xi:include href="standard-options.xml" xpointer="no-pager" />
<xi:include href="standard-options.xml" xpointer="no-legend" />
<xi:include href="standard-options.xml" xpointer="help" />