]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/sd_bus_request_name.xml
man: use same header for all files
[thirdparty/systemd.git] / man / sd_bus_request_name.xml
index 9e668f0b025aa4aead96f9bdbc62a22a10196f22..0edba533faa8729b178966e3eba46a2b83aa06d3 100644 (file)
@@ -1,42 +1,14 @@
 <?xml version='1.0'?> <!--*-nxml-*-->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
 
-<!--
-  SPDX-License-Identifier: LGPL-2.1+
-
-  This file is part of systemd.
-
-  Copyright 2013 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="sd_bus_request_name">
+<refentry id="sd_bus_request_name"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
   <refentryinfo>
     <title>sd_bus_request_name</title>
     <productname>systemd</productname>
-
-    <authorgroup>
-      <author>
-        <contrib>Developer</contrib>
-        <firstname>Lennart</firstname>
-        <surname>Poettering</surname>
-        <email>lennart@poettering.net</email>
-      </author>
-    </authorgroup>
   </refentryinfo>
 
   <refmeta>
 
     <variablelist>
       <varlistentry>
-        <term><varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname></term>
+        <term><constant>SD_BUS_NAME_ALLOW_REPLACEMENT</constant></term>
 
         <listitem><para>After acquiring the name successfully, permit other peers to take over the name when they try
-        to acquire it with the <varname>SD_BUS_NAME_REPLACE_EXISTING</varname> flag set. If
-        <varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname> is not set on the original request, such a request by other
+        to acquire it with the <constant>SD_BUS_NAME_REPLACE_EXISTING</constant> flag set. If
+        <constant>SD_BUS_NAME_ALLOW_REPLACEMENT</constant> is not set on the original request, such a request by other
         peers will be denied.</para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><varname>SD_BUS_NAME_REPLACE_EXISTING</varname></term>
+        <term><constant>SD_BUS_NAME_REPLACE_EXISTING</constant></term>
 
         <listitem><para>Take over the name if it is already acquired by another peer, and that other peer has permitted
-        takeover by setting <varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname> while acquiring it.</para></listitem>
+        takeover by setting <constant>SD_BUS_NAME_ALLOW_REPLACEMENT</constant> while acquiring it.</para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><varname>SD_BUS_NAME_QUEUE</varname></term>
+        <term><constant>SD_BUS_NAME_QUEUE</constant></term>
 
         <listitem><para>Queue the acquisition of the name when the name is already taken.</para></listitem>
       </varlistentry>
     <para><function>sd_bus_request_name()</function> operates in a synchronous fashion: a message requesting the name
     is sent to the bus broker, and the call waits until the broker responds.</para>
 
-    <para><function>sd_bus_request_name_async()</function> is an asynchronous version of of
+    <para><function>sd_bus_request_name_async()</function> is an asynchronous version of
     <function>sd_bus_release_name()</function>. Instead of waiting for the request to complete, the request message is
     enqueued. The specified <parameter>callback</parameter> will be called when the broker's response is received. If
     the parameter is specified as <constant>NULL</constant> a default implementation is used instead which will
     <para>On success, these calls return 0 or a positive integer. On failure, these calls return a negative errno-style
     error code.</para>
 
-    <para>If <varname>SD_BUS_NAME_QUEUE</varname> is specified, <function>sd_bus_request_name()</function> will return
+    <para>If <constant>SD_BUS_NAME_QUEUE</constant> is specified, <function>sd_bus_request_name()</function> will return
     0 when the name is already taken by another peer and the client has been added to the queue for the name. In that
     case, the caller can subscribe to <literal>NameOwnerChanged</literal> signals to be notified when the name is
     successfully acquired.  <function>sd_bus_request_name()</function> returns &gt; 0 when the name has immediately
     </variablelist>
   </refsect1>
 
-  <refsect1>
-    <title>Notes</title>
-
-    <para>The <function>sd_bus_acquire_name()</function> and the other interfaces described here are available as a
-    shared library, which can be compiled and linked to with the <constant>libsystemd</constant> <citerefentry
-    project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para>
-  </refsect1>
+  <xi:include href="libsystemd-pkgconfig.xml" />
 
   <refsect1>
     <title>See Also</title>