diff options
author | Sven Eden <yamakuzure@gmx.net> | 2017-02-21 07:54:50 +0100 |
---|---|---|
committer | Sven Eden <yamakuzure@gmx.net> | 2017-03-14 10:23:22 +0100 |
commit | 5f3891424cdb251a55a72099e0f04361ebafa059 (patch) | |
tree | 0f46dbdc484c62c7fe0cb5db9f6f401165f55780 /man | |
parent | 6ff57d0bf5de38bfc4df718cc596d4a3a333f290 (diff) |
Updated man pages.
Diffstat (limited to 'man')
-rw-r--r-- | man/Makefile | 8 | ||||
-rw-r--r-- | man/elogind.xml (renamed from man/logind.service.xml) | 19 | ||||
-rw-r--r-- | man/logind.xml | 121 | ||||
-rw-r--r-- | man/sd_is_fifo.xml | 187 |
4 files changed, 11 insertions, 324 deletions
diff --git a/man/Makefile b/man/Makefile index 9d0750519..1bc1831e9 100644 --- a/man/Makefile +++ b/man/Makefile @@ -1,19 +1,19 @@ -# This file is part of systemd. +# This file is part of elogind. # # Copyright 2010 Lennart Poettering # -# systemd is free software; you can redistribute it and/or modify it +# elogind is free software; you can redistribute it and/or modify it # under the terms of the GNU Lesser General Public License as published by # the Free Software Foundation; either version 2.1 of the License, or # (at your option) any later version. # -# systemd is distributed in the hope that it will be useful, but +# elogind is distributed in the hope that it will be useful, but # WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public License -# along with systemd; If not, see <http://www.gnu.org/licenses/>. +# along with elogind; If not, see <http://www.gnu.org/licenses/>. # This file is a dirty trick to simplify compilation from within # emacs. This file is not intended to be distributed. So, don't touch diff --git a/man/logind.service.xml b/man/elogind.xml index 404c45632..08a37cd54 100644 --- a/man/logind.service.xml +++ b/man/elogind.xml @@ -21,10 +21,10 @@ along with elogind; If not, see <http://www.gnu.org/licenses/>. --> -<refentry id="logind.service"> +<refentry id="elogind"> <refentryinfo> - <title>logind.service</title> + <title>elogind</title> <productname>elogind</productname> <authorgroup> @@ -38,25 +38,23 @@ </refentryinfo> <refmeta> - <refentrytitle>logind.service</refentrytitle> + <refentrytitle>elogind</refentrytitle> <manvolnum>8</manvolnum> </refmeta> <refnamediv> - <refname>logind.service</refname> - <refname>logind</refname> + <refname>elogind</refname> <refpurpose>Login manager</refpurpose> </refnamediv> <refsynopsisdiv> - <para><filename>logind.service</filename></para> - <para><filename>/usr/lib/systemd/logind</filename></para> + <para><filename>/usr/libexec/elogind/elogind</filename></para> </refsynopsisdiv> <refsect1> <title>Description</title> - <para><command>logind</command> is a system service that + <para><command>elogind</command> is a system service that manages user logins. It is responsible for:</para> <itemizedlist> @@ -79,12 +77,9 @@ <listitem><para>Device access management for users</para></listitem> - <listitem><para>Automatic spawning of text logins (gettys) on - virtual console activation and user runtime directory - management</para></listitem> </itemizedlist> - <para>User sessions are registered in logind via the + <para>User sessions are registered in elogind via the <citerefentry><refentrytitle>pam_elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry> PAM module.</para> diff --git a/man/logind.xml b/man/logind.xml deleted file mode 100644 index 7afacbf34..000000000 --- a/man/logind.xml +++ /dev/null @@ -1,121 +0,0 @@ -<?xml version='1.0'?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - -<!-- - This file is part of systemd. - - Copyright 2010 Lennart Poettering - - systemd is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as published by - the Free Software Foundation; either version 2.1 of the License, or - (at your option) any later version. - - systemd is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public License - along with systemd; If not, see <http://www.gnu.org/licenses/>. ---> - -<refentry id="logind.service"> - - <refentryinfo> - <title>logind.service</title> - <productname>systemd</productname> - - <authorgroup> - <author> - <contrib>Developer</contrib> - <firstname>Lennart</firstname> - <surname>Poettering</surname> - <email>lennart@poettering.net</email> - </author> - </authorgroup> - </refentryinfo> - - <refmeta> - <refentrytitle>logind.service</refentrytitle> - <manvolnum>8</manvolnum> - </refmeta> - - <refnamediv> - <refname>logind.service</refname> - <refname>logind</refname> - <refpurpose>Login manager</refpurpose> - </refnamediv> - - <refsynopsisdiv> - <para><filename>logind.service</filename></para> - <para><filename>/usr/lib/systemd/logind</filename></para> - </refsynopsisdiv> - - <refsect1> - <title>Description</title> - - <para><command>logind</command> is a system service that - manages user logins. It is responsible for:</para> - - <itemizedlist> - <listitem><para>Keeping track of users and sessions, their - processes and their idle state</para></listitem> - - <listitem><para>Providing PolicyKit-based access for users to - operations such as system shutdown or sleep</para></listitem> - - <listitem><para>Implementing a shutdown/sleep inhibition logic - for applications</para></listitem> - - <listitem><para>Handling of power/sleep hardware - keys</para></listitem> - - <listitem><para>Multi-seat management</para></listitem> - - <listitem><para>Session switch management</para></listitem> - - <listitem><para>Device access management for - users</para></listitem> - - <listitem><para>Automatic spawning of text logins (gettys) on - virtual console activation and user runtime directory - management</para></listitem> - </itemizedlist> - - <para>User sessions are registered in logind via the - <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry> - PAM module.</para> - - <para>See - <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> - for information about the configuration of this service.</para> - - <para>See <ulink - url="http://www.freedesktop.org/wiki/Software/systemd/multiseat">Multi-Seat - on Linux</ulink> for an introduction into basic concepts of logind - such as users, sessions and seats.</para> - - <para>See the <ulink - url="http://www.freedesktop.org/wiki/Software/systemd/logind"> - logind D-Bus API Documentation</ulink> for information about the - APIs <filename>logind</filename> provides.</para> - - <para>For more information on the inhibition logic see the <ulink - url="http://www.freedesktop.org/wiki/Software/systemd/inhibit">Inhibitor - Lock Developer Documentation</ulink>.</para> - </refsect1> - - <refsect1> - <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-user-sessions.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> - </refsect1> - -</refentry> diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml deleted file mode 100644 index f5ca8580e..000000000 --- a/man/sd_is_fifo.xml +++ /dev/null @@ -1,187 +0,0 @@ -<?xml version='1.0'?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - -<!-- - This file is part of elogind. - - Copyright 2010 Lennart Poettering - - elogind is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as published by - the Free Software Foundation; either version 2.1 of the License, or - (at your option) any later version. - - elogind is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public License - along with elogind; If not, see <http://www.gnu.org/licenses/>. ---> - -<refentry id="sd_is_fifo" - xmlns:xi="http://www.w3.org/2001/XInclude"> - - <refentryinfo> - <title>sd_is_fifo</title> - <productname>elogind</productname> - - <authorgroup> - <author> - <contrib>Developer</contrib> - <firstname>Lennart</firstname> - <surname>Poettering</surname> - <email>lennart@poettering.net</email> - </author> - </authorgroup> - </refentryinfo> - - <refmeta> - <refentrytitle>sd_is_fifo</refentrytitle> - <manvolnum>3</manvolnum> - </refmeta> - - <refnamediv> - <refname>sd_is_fifo</refname> - <refname>sd_is_socket</refname> - <refname>sd_is_socket_inet</refname> - <refname>sd_is_socket_unix</refname> - <refname>sd_is_special</refname> - <refpurpose>Check the type of a file descriptor</refpurpose> - </refnamediv> - - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo>#include <elogind/sd-daemon.h></funcsynopsisinfo> - - <funcprototype> - <funcdef>int <function>sd_is_fifo</function></funcdef> - <paramdef>int <parameter>fd</parameter></paramdef> - <paramdef>const char *<parameter>path</parameter></paramdef> - </funcprototype> - - <funcprototype> - <funcdef>int <function>sd_is_socket</function></funcdef> - <paramdef>int <parameter>fd</parameter></paramdef> - <paramdef>int <parameter>family</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>int <parameter>listening</parameter></paramdef> - </funcprototype> - - <funcprototype> - <funcdef>int <function>sd_is_socket_inet</function></funcdef> - <paramdef>int <parameter>fd</parameter></paramdef> - <paramdef>int <parameter>family</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>int <parameter>listening</parameter></paramdef> - <paramdef>uint16_t <parameter>port</parameter></paramdef> - </funcprototype> - - <funcprototype> - <funcdef>int <function>sd_is_socket_unix</function></funcdef> - <paramdef>int <parameter>fd</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>int <parameter>listening</parameter></paramdef> - <paramdef>const char *<parameter>path</parameter></paramdef> - <paramdef>size_t <parameter>length</parameter></paramdef> - </funcprototype> - - <funcprototype> - <funcdef>int <function>sd_is_special</function></funcdef> - <paramdef>int <parameter>fd</parameter></paramdef> - <paramdef>const char *<parameter>path</parameter></paramdef> - </funcprototype> - - </funcsynopsis> - </refsynopsisdiv> - - <refsect1> - <title>Description</title> - - <para><function>sd_is_fifo()</function> may be called to check - whether the specified file descriptor refers to a FIFO or pipe. If - the <parameter>path</parameter> parameter is not - <constant>NULL</constant>, it is checked whether the FIFO is bound - to the specified file system path.</para> - - <para><function>sd_is_socket()</function> may be called to check - whether the specified file descriptor refers to a socket. If the - <parameter>family</parameter> parameter is not - <constant>AF_UNSPEC</constant>, it is checked whether the socket - is of the specified family (AF_UNIX, <constant>AF_INET</constant>, - ...). If the <parameter>type</parameter> parameter is not 0, it is - checked whether the socket is of the specified type - (<constant>SOCK_STREAM</constant>, - <constant>SOCK_DGRAM</constant>, ...). If the - <parameter>listening</parameter> parameter is positive, it is - checked whether the socket is in accepting mode, i.e. - <function>listen()</function> has been called for it. If - <parameter>listening</parameter> is 0, it is checked whether the - socket is not in this mode. If the parameter is negative, no such - check is made. The <parameter>listening</parameter> parameter - should only be used for stream sockets and should be set to a - negative value otherwise.</para> - - <para><function>sd_is_socket_inet()</function> is similar to - <function>sd_is_socket()</function>, but optionally checks the - IPv4 or IPv6 port number the socket is bound to, unless - <parameter>port</parameter> is zero. For this call - <parameter>family</parameter> must be passed as either - <constant>AF_UNSPEC</constant>, <constant>AF_INET</constant>, or - <constant>AF_INET6</constant>.</para> - - <para><function>sd_is_socket_unix()</function> is similar to - <function>sd_is_socket()</function> but optionally checks the - <constant>AF_UNIX</constant> path the socket is bound to, unless - the <parameter>path</parameter> parameter is - <constant>NULL</constant>. For normal file system - <constant>AF_UNIX</constant> sockets, set the - <parameter>length</parameter> parameter to 0. For Linux abstract - namespace sockets, set the <parameter>length</parameter> to the - size of the address, including the initial 0 byte, and set the - <parameter>path</parameter> to the initial 0 byte of the socket - address.</para> - - <para><function>sd_is_special()</function> may be called to check - whether the specified file descriptor refers to a special file. If - the <parameter>path</parameter> parameter is not - <constant>NULL</constant>, it is checked whether the file - descriptor is bound to the specified file name. Special files in - this context are character device nodes and files in - <filename>/proc</filename> or <filename>/sys</filename>.</para> - </refsect1> - - <refsect1> - <title>Return Value</title> - - <para>On failure, these calls return a negative errno-style error - code. If the file descriptor is of the specified type and bound to - the specified address, a positive return value is returned, - otherwise zero.</para> - </refsect1> - - <refsect1> - <title>Notes</title> - - <xi:include href="libelogind-pkgconfig.xml" xpointer="pkgconfig-text"/> - - <para>Internally, these function use a combination of - <filename>fstat()</filename> and - <filename>getsockname()</filename> to check the file descriptor - type and where it is bound to.</para> - </refsect1> - - <refsect1> - <title>See Also</title> - <para> - <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>logind.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>elogind.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> - </refsect1> - -</refentry> |