mirrors/systemd
0
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-12-03 23:33:38 +08:00
Code Issues Packages Projects Releases Wiki Activity
d91c7c91bf
systemd/man/sd_uid_get_state.xml

216 lines
9.1 KiB
XML
Raw Normal View History

man: document the sd-login interfaces
2011-12-19 10:02:17 +08:00
<?xml version='1.0'?> <!--*-nxml-*-->
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 21:40:58 +08:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: use same version in public and system ident.
2023-12-25 22:48:33 +08:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 12:23:58 +08:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: document the sd-login interfaces
2011-12-19 10:02:17 +08:00
man: xinclude the generic text to talk about libsystemd pkgconfig The only difference is that functions are not individually listed by name, but that seems completely pointless, since all functions that are documented are always exported, so the generic text tells the user all she or he needs to know.
2018-06-06 17:59:04 +08:00
<refentry id="sd_uid_get_state" conditional='HAVE_PAM'
xmlns:xi="http://www.w3.org/2001/XInclude">
man: document the sd-login interfaces
2011-12-19 10:02:17 +08:00
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<refentryinfo>
<title>sd_uid_get_state</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>sd_uid_get_state</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>sd_uid_get_state</refname>
<refname>sd_uid_is_on_seat</refname>
<refname>sd_uid_get_sessions</refname>
<refname>sd_uid_get_seats</refname>
<refname>sd_uid_get_display</refname>
sd-login: add sd_uid_get_login_time interface #26574
2023-02-24 16:47:52 +08:00
<refname>sd_uid_get_login_time</refname>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<refpurpose>Determine login state of a specific Unix user ID</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;systemd/sd-login.h&gt;</funcsynopsisinfo>
<funcprototype>
<funcdef>int <function>sd_uid_get_state</function></funcdef>
<paramdef>uid_t <parameter>uid</parameter></paramdef>
<paramdef>char **<parameter>state</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_uid_is_on_seat</function></funcdef>
<paramdef>uid_t <parameter>uid</parameter></paramdef>
<paramdef>int <parameter>require_active</parameter></paramdef>
<paramdef>const char *<parameter>seat</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_uid_get_sessions</function></funcdef>
<paramdef>uid_t <parameter>uid</parameter></paramdef>
<paramdef>int <parameter>require_active</parameter></paramdef>
<paramdef>char ***<parameter>sessions</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_uid_get_seats</function></funcdef>
<paramdef>uid_t <parameter>uid</parameter></paramdef>
<paramdef>int <parameter>require_active</parameter></paramdef>
<paramdef>char ***<parameter>seats</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_uid_get_display</function></funcdef>
<paramdef>uid_t <parameter>uid</parameter></paramdef>
<paramdef>char **<parameter>session</parameter></paramdef>
</funcprototype>
sd-login: add sd_uid_get_login_time interface #26574
2023-02-24 16:47:52 +08:00
man: fix docbook syntax for function docs This fixes sd_bus_error_add_map and man/sd_uid_get_state
2023-09-25 20:14:13 +08:00
<funcprototype>
<funcdef>int <function>sd_uid_get_login_time</function></funcdef>
<paramdef>uid_t <parameter>uid</parameter></paramdef>
<paramdef>uint64_t *<parameter>usec</parameter></paramdef>
</funcprototype>
</funcsynopsis>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><function>sd_uid_get_state()</function> may be used to
determine the login state of a specific Unix user identifier. The
following states are currently known: <literal>offline</literal>
(user not logged in at all), <literal>lingering</literal> (user
not logged in, but some user services running),
<literal>online</literal> (user logged in, but not active, i.e.
has no session in the foreground), <literal>active</literal> (user
logged in, and has at least one active session, i.e. one session
in the foreground), <literal>closing</literal> (user not logged
in, and not lingering, but some processes are still around). In
the future additional states might be defined, client code should
be written to be robust in regards to additional state strings
being returned. The returned string needs to be freed with the
libc
<citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use.</para>
<para><function>sd_uid_is_on_seat()</function> may be used to
determine whether a specific user is logged in or active on a
specific seat. Accepts a Unix user identifier and a seat
identifier string as parameters. The
<parameter>require_active</parameter> parameter is a boolean
value. If non-zero (true), this function will test if the user is
active (i.e. has a session that is in the foreground and accepting
user input) on the specified seat, otherwise (false) only if the
user is logged in (and possibly inactive) on the specified
seat.</para>
<para><function>sd_uid_get_sessions()</function> may be used to
determine the current sessions of the specified user. Accepts a
Unix user identifier as parameter. The
<parameter>require_active</parameter> parameter controls whether
the returned list shall consist of only those sessions where the
user is currently active (&gt; 0), where the user is currently
man: fix description of sd_uid_get_sessions
2021-12-02 20:07:07 +08:00
online but possibly inactive (= 0), or logged in but
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
possibly closing the session (&lt; 0). The call returns a
<constant>NULL</constant> terminated string array of session
identifiers in <parameter>sessions</parameter> which needs to be
freed by the caller with the libc
<citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use, including all the strings referenced. If the
string array parameter is passed as <constant>NULL</constant>, the
array will not be filled in, but the return code still indicates
the number of current sessions. Note that instead of an empty
array <constant>NULL</constant> may be returned and should be
considered equivalent to an empty array.</para>
<para>Similarly, <function>sd_uid_get_seats()</function> may be
used to determine the list of seats on which the user currently
has sessions. Similar semantics apply, however note that the user
may have multiple sessions on the same seat as well as sessions
with no attached seat and hence the number of entries in the
returned array may differ from the one returned by
<function>sd_uid_get_sessions()</function>.</para>
<para><function>sd_uid_get_display()</function> returns the name
of the "primary" session of a user. If the user has graphical
sessions, it will be the oldest graphical session. Otherwise, it
will be the oldest open session.</para>
sd-login: add sd_uid_get_login_time interface #26574
2023-02-24 16:47:52 +08:00
<para><function>sd_uid_get_login_time()</function> may be used to
determine the time the user's service manager has been invoked,
which is the time when the user's first active session, since which
they stayed logged in continuously, began. The <parameter>usec</parameter>
is in microseconds since the epoch (<constant>CLOCK_REALTIME</constant>).
This call will fail with <constant>-ENXIO</constant> if the user is not
currently logged in.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</refsect1>
<refsect1>
<title>Return Value</title>
sd-login: add sd_uid_get_login_time interface #26574
2023-02-24 16:47:52 +08:00
<para>On success, <function>sd_uid_get_state()</function> and
<function>sd_uid_get_login_time()</function> returns 0 or a positive
integer. If the test succeeds, <function>sd_uid_is_on_seat()</function>
returns a positive integer; if it fails, 0. <function>sd_uid_get_sessions()</function>
and <function>sd_uid_get_seats()</function> return the number of entries
in the returned arrays. <function>sd_uid_get_display()</function>
returns a non-negative code on success. On failure, these calls return
a negative errno-style error code.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<refsect2>
<title>Errors</title>
sd-login: rework error handling Makre sure we always return sensible errors for the various, following the same rules, and document them in a comment in sd-login.c. Also, update all relevant man pages accordingly.
2015-09-04 15:05:52 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<para>Returned errors may indicate the following problems:</para>
sd-login: rework error handling Makre sure we always return sensible errors for the various, following the same rules, and document them in a comment in sd-login.c. Also, update all relevant man pages accordingly.
2015-09-04 15:05:52 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<variablelist>
sd-login: rework error handling Makre sure we always return sensible errors for the various, following the same rules, and document them in a comment in sd-login.c. Also, update all relevant man pages accordingly.
2015-09-04 15:05:52 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<varlistentry>
<term><constant>-ENODATA</constant></term>
sd-login: rework error handling Makre sure we always return sensible errors for the various, following the same rules, and document them in a comment in sd-login.c. Also, update all relevant man pages accordingly.
2015-09-04 15:05:52 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<listitem><para>The given field is not specified for the described user.</para>
</listitem>
</varlistentry>
sd-login: rework error handling Makre sure we always return sensible errors for the various, following the same rules, and document them in a comment in sd-login.c. Also, update all relevant man pages accordingly.
2015-09-04 15:05:52 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<varlistentry>
<term><constant>-ENXIO</constant></term>
sd-login: rework error handling Makre sure we always return sensible errors for the various, following the same rules, and document them in a comment in sd-login.c. Also, update all relevant man pages accordingly.
2015-09-04 15:05:52 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<listitem><para>The specified seat is unknown.</para>
</listitem>
</varlistentry>
sd-login: rework error handling Makre sure we always return sensible errors for the various, following the same rules, and document them in a comment in sd-login.c. Also, update all relevant man pages accordingly.
2015-09-04 15:05:52 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<varlistentry>
<term><constant>-EINVAL</constant></term>
sd-login: rework error handling Makre sure we always return sensible errors for the various, following the same rules, and document them in a comment in sd-login.c. Also, update all relevant man pages accordingly.
2015-09-04 15:05:52 +08:00
man: set constant tag to NUL or NULL
2020-11-12 15:58:00 +08:00
<listitem><para>An input parameter was invalid (out of range, or <constant>NULL</constant>,
where that is not accepted). This is also returned if the passed user ID is
<constant>0xFFFF</constant> or <constant>0xFFFFFFFF</constant>, which are undefined on Linux.
</para></listitem>
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
</varlistentry>
sd-login: rework error handling Makre sure we always return sensible errors for the various, following the same rules, and document them in a comment in sd-login.c. Also, update all relevant man pages accordingly.
2015-09-04 15:05:52 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<varlistentry>
<term><constant>-ENOMEM</constant></term>
sd-login: rework error handling Makre sure we always return sensible errors for the various, following the same rules, and document them in a comment in sd-login.c. Also, update all relevant man pages accordingly.
2015-09-04 15:05:52 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
sd-login: rework error handling Makre sure we always return sensible errors for the various, following the same rules, and document them in a comment in sd-login.c. Also, update all relevant man pages accordingly.
2015-09-04 15:05:52 +08:00
</refsect1>
man: xinclude the generic text to talk about libsystemd pkgconfig The only difference is that functions are not individually listed by name, but that seems completely pointless, since all functions that are documented are always exported, so the generic text tells the user all she or he needs to know.
2018-06-06 17:59:04 +08:00
<xi:include href="libsystemd-pkgconfig.xml" />
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: add version information for functions
2023-09-04 20:46:35 +08:00
<refsect1>
<title>History</title>
<para><function>sd_uid_get_display()</function> was added in version 213.</para>
<para><function>sd_uid_get_login_time()</function> was added in version 254.</para>
</refsect1>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<refsect1>
<title>See Also</title>
man: use <simplelist> for 'See also' sections This is just a slight markup improvement; there should be no difference in rendering.
2023-12-23 02:09:32 +08:00
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>sd_pid_get_owner_uid</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
</simplelist></para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</refsect1>
man: document the sd-login interfaces
2011-12-19 10:02:17 +08:00
</refentry>
Reference in New Issue Copy Permalink