chiark / gitweb /
Updated man pages.
authorSven Eden <yamakuzure@gmx.net>
Tue, 21 Feb 2017 06:54:50 +0000 (07:54 +0100)
committerSven Eden <yamakuzure@gmx.net>
Tue, 14 Mar 2017 09:23:22 +0000 (10:23 +0100)
Makefile-man.am
man/Makefile
man/elogind.xml [moved from man/logind.service.xml with 85% similarity]
man/logind.xml [deleted file]
man/sd_is_fifo.xml [deleted file]

index c481f83..4d51eb4 100644 (file)
@@ -8,62 +8,36 @@
 # attribute conditional="ENABLE_WHAT" or conditional="WITH_WHAT"
 # to <refentry> element.
 MANPAGES += \
+       man/elogind.8 \
        man/loginctl.1 \
        man/logind.conf.5 \
-       man/logind.service.8 \
        man/sd_id128_get_machine.3 \
        man/sd_id128_randomize.3 \
        man/sd_id128_to_string.3 \
-       man/sd_is_fifo.3 \
        man/sd_machine_get_class.3 \
        man/sd_notify.3 \
        man/sd_watchdog_enabled.3
 MANPAGES_ALIAS += \
-       man/logind.8 \
        man/sd_id128_from_string.3 \
        man/sd_id128_get_boot.3 \
-       man/sd_is_socket.3 \
-       man/sd_is_socket_inet.3 \
-       man/sd_is_socket_unix.3 \
-       man/sd_is_special.3 \
        man/sd_machine_get_ifindices.3 \
        man/sd_notifyf.3 \
        man/sd_pid_notify.3 \
        man/sd_pid_notify_with_fds.3 \
        man/sd_pid_notifyf.3
-man/logind.8: man/logind.service.8
 man/sd_id128_from_string.3: man/sd_id128_to_string.3
 man/sd_id128_get_boot.3: man/sd_id128_get_machine.3
-man/sd_is_socket.3: man/sd_is_fifo.3
-man/sd_is_socket_inet.3: man/sd_is_fifo.3
-man/sd_is_socket_unix.3: man/sd_is_fifo.3
-man/sd_is_special.3: man/sd_is_fifo.3
 man/sd_machine_get_ifindices.3: man/sd_machine_get_class.3
 man/sd_notifyf.3: man/sd_notify.3
 man/sd_pid_notify.3: man/sd_notify.3
 man/sd_pid_notify_with_fds.3: man/sd_notify.3
 man/sd_pid_notifyf.3: man/sd_notify.3
-man/logind.html: man/logind.service.html
-       $(html-alias)
-
 man/sd_id128_from_string.html: man/sd_id128_to_string.html
        $(html-alias)
 
 man/sd_id128_get_boot.html: man/sd_id128_get_machine.html
        $(html-alias)
 
-man/sd_is_socket.html: man/sd_is_fifo.html
-       $(html-alias)
-
-man/sd_is_socket_inet.html: man/sd_is_fifo.html
-       $(html-alias)
-
-man/sd_is_socket_unix.html: man/sd_is_fifo.html
-       $(html-alias)
-
-man/sd_is_special.html: man/sd_is_fifo.html
-       $(html-alias)
-
 man/sd_machine_get_ifindices.html: man/sd_machine_get_class.html
        $(html-alias)
 
@@ -201,18 +175,16 @@ endif
 # Really, do not edit this file.
 
 EXTRA_DIST += \
+       man/elogind.xml \
        man/less-variables.xml \
        man/libelogind-pkgconfig.xml \
        man/loginctl.xml \
        man/logind.conf.xml \
-       man/logind.service.xml \
-       man/logind.xml \
        man/pam_elogind.xml \
        man/sd_get_seats.xml \
        man/sd_id128_get_machine.xml \
        man/sd_id128_randomize.xml \
        man/sd_id128_to_string.xml \
-       man/sd_is_fifo.xml \
        man/sd_machine_get_class.xml \
        man/sd_notify.xml \
        man/sd_seat_get_active.xml \
index 9d07505..1bc1831 100644 (file)
@@ -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
similarity index 85%
rename from man/logind.service.xml
rename to man/elogind.xml
index 404c456..08a37cd 100644 (file)
   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>
   </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>
       <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 (file)
index 7afacbf..0000000
+++ /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 (file)
index f5ca858..0000000
+++ /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 &lt;elogind/sd-daemon.h&gt;</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>