]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/sd_listen_fds.xml
travis: use UBSan checks from OSS-Fuzz
[thirdparty/systemd.git] / man / sd_listen_fds.xml
index ccd1266318e331a6ceecae6a6c4a5432033514ce..9a66ee33bae74f7ee5a17510280424936ae09376 100644 (file)
@@ -1,25 +1,7 @@
-<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+<?xml version='1.0'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//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/>.
--->
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
 
 <refentry id="sd_listen_fds"
   xmlns:xi="http://www.w3.org/2001/XInclude">
@@ -27,15 +9,6 @@
   <refentryinfo>
     <title>sd_listen_fds</title>
     <productname>systemd</productname>
-
-    <authorgroup>
-      <author>
-        <contrib>Developer</contrib>
-        <firstname>Lennart</firstname>
-        <surname>Poettering</surname>
-        <email>lennart@poettering.net</email>
-      </author>
-    </authorgroup>
   </refentryinfo>
 
   <refmeta>
     daemon to check for file descriptors passed by the service manager as
     part of the socket-based activation logic. It returns the number
     of received file descriptors. If no file descriptors have been
-    received zero is returned. The first file descriptor may be found
+    received, zero is returned. The first file descriptor may be found
     at file descriptor number 3
     (i.e. <constant>SD_LISTEN_FDS_START</constant>), the remaining
-    descriptors follow at 4, 5, 6, ..., if any.</para>
+    descriptors follow at 4, 5, 6, , if any.</para>
 
     <para>If a daemon receives more than one file descriptor, they
     will be passed in the same order as configured in the systemd
     passed file descriptors to avoid further inheritance to children
     of the calling process.</para>
 
-    <para>If multiple socket units activate the same service the order
+    <para>If multiple socket units activate the same service, the order
     of the file descriptors passed to its main process is undefined.
     If additional file descriptors have been passed to the service
     manager using
     variables are no longer inherited by child processes.</para>
 
     <para><function>sd_listen_fds_with_names()</function> is like
-    <function>sd_listen_fds()</function> but optionally also returns
+    <function>sd_listen_fds()</function>, but optionally also returns
     an array of strings with identification names for the passed file
-    descriptors, if that is available, and the
+    descriptors, if that is available and the
     <parameter>names</parameter> parameter is non-NULL. This
     information is read from the <varname>$LISTEN_FDNAMES</varname>
     variable, which may contain a colon-separated list of names. For
     files, see
     <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
     for details. For file descriptors pushed into the file descriptor
-    store (see above) the name is set via the
+    store (see above), the name is set via the
     <varname>FDNAME=</varname> field transmitted via
     <function>sd_pid_notify_with_fds()</function>. The primary usecase
     for these names are services which accept a variety of file
     <function>sd_is_socket()</function> and related calls is not
     sufficient. Note that the names used are not unique in any
     way. The returned array of strings has as many entries as file
-    descriptors has been received, plus a final NULL pointer
+    descriptors have been received, plus a final NULL pointer
     terminating the array. The caller needs to free the array itself
     and each of its elements with libc's <function>free()</function>
     call after use. If the <parameter>names</parameter> parameter is
-    NULL the call is entirely equivalent to
+    NULL, the call is entirely equivalent to
     <function>sd_listen_fds()</function>.</para>
 
-    <para>Under specific conditions the following automatic file
+    <para>Under specific conditions, the following automatic file
     descriptor names are returned:
 
     <table>