diff options
author | Sven Eden <yamakuzure@gmx.net> | 2017-01-19 08:22:21 +0100 |
---|---|---|
committer | Sven Eden <yamakuzure@gmx.net> | 2017-03-14 10:22:37 +0100 |
commit | 167bf427227158dbcad675d951e67038f23a9486 (patch) | |
tree | e7cf1c5c559a404f5b42d1b795bc9e9857480613 /man | |
parent | 737a731daf8c570bcbc9d4939196423e209ff1df (diff) |
Remove man/sd[-_]bus[-_]error*.xml files, as elogind does not provide a systemd dbus interface to control.
Diffstat (limited to 'man')
-rw-r--r-- | man/sd-bus-errors.xml | 309 | ||||
-rw-r--r-- | man/sd_bus_error_add_map.xml | 173 |
2 files changed, 0 insertions, 482 deletions
diff --git a/man/sd-bus-errors.xml b/man/sd-bus-errors.xml deleted file mode 100644 index a1e846285..000000000 --- a/man/sd-bus-errors.xml +++ /dev/null @@ -1,309 +0,0 @@ -<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> -<!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 2015 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-errors"> - - <refentryinfo> - <title>sd-bus-errors</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>sd-bus-errors</refentrytitle> - <manvolnum>3</manvolnum> - </refmeta> - - <refnamediv> - <refname>sd-bus-errors</refname> - <refname>SD_BUS_ERROR_FAILED</refname> - <refname>SD_BUS_ERROR_NO_MEMORY</refname> - <refname>SD_BUS_ERROR_SERVICE_UNKNOWN</refname> - <refname>SD_BUS_ERROR_NAME_HAS_NO_OWNER</refname> - <refname>SD_BUS_ERROR_NO_REPLY</refname> - <refname>SD_BUS_ERROR_IO_ERROR</refname> - <refname>SD_BUS_ERROR_BAD_ADDRESS</refname> - <refname>SD_BUS_ERROR_NOT_SUPPORTED</refname> - <refname>SD_BUS_ERROR_LIMITS_EXCEEDED</refname> - <refname>SD_BUS_ERROR_ACCESS_DENIED</refname> - <refname>SD_BUS_ERROR_AUTH_FAILED</refname> - <refname>SD_BUS_ERROR_NO_SERVER</refname> - <refname>SD_BUS_ERROR_TIMEOUT</refname> - <refname>SD_BUS_ERROR_NO_NETWORK</refname> - <refname>SD_BUS_ERROR_ADDRESS_IN_USE</refname> - <refname>SD_BUS_ERROR_DISCONNECTED</refname> - <refname>SD_BUS_ERROR_INVALID_ARGS</refname> - <refname>SD_BUS_ERROR_FILE_NOT_FOUND</refname> - <refname>SD_BUS_ERROR_FILE_EXISTS</refname> - <refname>SD_BUS_ERROR_UNKNOWN_METHOD</refname> - <refname>SD_BUS_ERROR_UNKNOWN_OBJECT</refname> - <refname>SD_BUS_ERROR_UNKNOWN_INTERFACE</refname> - <refname>SD_BUS_ERROR_UNKNOWN_PROPERTY</refname> - <refname>SD_BUS_ERROR_PROPERTY_READ_ONLY</refname> - <refname>SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN</refname> - <refname>SD_BUS_ERROR_INVALID_SIGNATURE</refname> - <refname>SD_BUS_ERROR_INCONSISTENT_MESSAGE</refname> - <refname>SD_BUS_ERROR_MATCH_RULE_NOT_FOUND</refname> - <refname>SD_BUS_ERROR_MATCH_RULE_INVALID</refname> - <refname>SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED</refname> - - <refpurpose>Standard D-Bus error names</refpurpose> - </refnamediv> - - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo> - -<funcsynopsisinfo>#define SD_BUS_ERROR_FAILED "org.freedesktop.DBus.Error.Failed" -#define SD_BUS_ERROR_NO_MEMORY "org.freedesktop.DBus.Error.NoMemory" -#define SD_BUS_ERROR_SERVICE_UNKNOWN "org.freedesktop.DBus.Error.ServiceUnknown" -#define SD_BUS_ERROR_NAME_HAS_NO_OWNER "org.freedesktop.DBus.Error.NameHasNoOwner" -#define SD_BUS_ERROR_NO_REPLY "org.freedesktop.DBus.Error.NoReply" -#define SD_BUS_ERROR_IO_ERROR "org.freedesktop.DBus.Error.IOError" -#define SD_BUS_ERROR_BAD_ADDRESS "org.freedesktop.DBus.Error.BadAddress" -#define SD_BUS_ERROR_NOT_SUPPORTED "org.freedesktop.DBus.Error.NotSupported" -#define SD_BUS_ERROR_LIMITS_EXCEEDED "org.freedesktop.DBus.Error.LimitsExceeded" -#define SD_BUS_ERROR_ACCESS_DENIED "org.freedesktop.DBus.Error.AccessDenied" -#define SD_BUS_ERROR_AUTH_FAILED "org.freedesktop.DBus.Error.AuthFailed" -#define SD_BUS_ERROR_NO_SERVER "org.freedesktop.DBus.Error.NoServer" -#define SD_BUS_ERROR_TIMEOUT "org.freedesktop.DBus.Error.Timeout" -#define SD_BUS_ERROR_NO_NETWORK "org.freedesktop.DBus.Error.NoNetwork" -#define SD_BUS_ERROR_ADDRESS_IN_USE "org.freedesktop.DBus.Error.AddressInUse" -#define SD_BUS_ERROR_DISCONNECTED "org.freedesktop.DBus.Error.Disconnected" -#define SD_BUS_ERROR_INVALID_ARGS "org.freedesktop.DBus.Error.InvalidArgs" -#define SD_BUS_ERROR_FILE_NOT_FOUND "org.freedesktop.DBus.Error.FileNotFound" -#define SD_BUS_ERROR_FILE_EXISTS "org.freedesktop.DBus.Error.FileExists" -#define SD_BUS_ERROR_UNKNOWN_METHOD "org.freedesktop.DBus.Error.UnknownMethod" -#define SD_BUS_ERROR_UNKNOWN_OBJECT "org.freedesktop.DBus.Error.UnknownObject" -#define SD_BUS_ERROR_UNKNOWN_INTERFACE "org.freedesktop.DBus.Error.UnknownInterface" -#define SD_BUS_ERROR_UNKNOWN_PROPERTY "org.freedesktop.DBus.Error.UnknownProperty" -#define SD_BUS_ERROR_PROPERTY_READ_ONLY "org.freedesktop.DBus.Error.PropertyReadOnly" -#define SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN "org.freedesktop.DBus.Error.UnixProcessIdUnknown" -#define SD_BUS_ERROR_INVALID_SIGNATURE "org.freedesktop.DBus.Error.InvalidSignature" -#define SD_BUS_ERROR_INCONSISTENT_MESSAGE "org.freedesktop.DBus.Error.InconsistentMessage" -#define SD_BUS_ERROR_MATCH_RULE_NOT_FOUND "org.freedesktop.DBus.Error.MatchRuleNotFound" -#define SD_BUS_ERROR_MATCH_RULE_INVALID "org.freedesktop.DBus.Error.MatchRuleInvalid" -#define SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED \ - "org.freedesktop.DBus.Error.InteractiveAuthorizationRequired"</funcsynopsisinfo> - - </funcsynopsis> - </refsynopsisdiv> - - <refsect1> - <title>Description</title> - - <para>In addition to the error names user programs define, D-Bus - knows a number of generic, standardized error names, that are - listed below.</para> - - <para>In addition to this list, in sd-bus the special error - namespace <literal>System.Error.</literal> is used to map - arbitrary Linux system errors (as defined by <citerefentry - project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>) - to D-Bus errors and back. For example, the error - <constant>EUCLEAN</constant> is mapped to - <literal>System.Error.EUCLEAN</literal> and back.</para> - - <variablelist> - - <varlistentry> - <term><varname>SD_BUS_ERROR_FAILED</varname></term> - <listitem><para>A generic error indication. See the error - message for further details. This error name should be - avoided, in favor of a more expressive error - name.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>SD_BUS_ERROR_NO_MEMORY</varname></term> - <listitem><para>A memory allocation failed, and the requested - operation could not be completed.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>SD_BUS_ERROR_SERVICE_UNKNOWN</varname></term> - <listitem><para>The contacted bus service is unknown and - cannot be activated.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>SD_BUS_ERROR_NAME_HAS_NO_OWNER</varname></term> - <listitem><para>The specified bus service name currently has - no owner.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_NO_REPLY</varname></term> - <listitem><para>A message did not receive a reply. This error - is usually generated after a timeout.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_IO_ERROR</varname></term> - <listitem><para>Generic input/output error, for example when - accessing a socket or other IO context.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_BAD_ADDRESS</varname></term> - <listitem><para>The specified D-Bus bus address string is - malformed.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_NOT_SUPPORTED</varname></term> - <listitem><para>The requested operation is not supported on - the local system.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_LIMITS_EXCEEDED</varname></term> - <listitem><para>Some limited resource has been - exhausted.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_ACCESS_DENIED</varname></term> - <listitem><para>Access to a resource has been denied, due to security restrictions.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_AUTH_FAILED</varname></term> - <listitem><para>Authentication did not complete successfully.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_NO_SERVER</varname></term> - <listitem><para>Unable to connect to the specified server.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_TIMEOUT</varname></term> - <listitem><para>An operation timed out. Note that method calls - which timeout generate a - <varname>SD_BUS_ERROR_NO_REPLY</varname>.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_NO_NETWORK</varname></term> - <listitem><para>No network available to execute requested network operation on.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_ADDRESS_IN_USE</varname></term> - <listitem><para>The specified network address is already being listened on.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_DISCONNECTED</varname></term> - <listitem><para>The connection has been terminated.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_INVALID_ARGS</varname></term> - <listitem><para>One or more invalid arguments have been passed.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_FILE_NOT_FOUND</varname></term> - <listitem><para>The requested file could not be found.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_FILE_EXISTS</varname></term> - <listitem><para>The requested file exists already.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_UNKNOWN_METHOD</varname></term> - <listitem><para>The requested method does not exist in the selected interface.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_UNKNOWN_OBJECT</varname></term> - <listitem><para>The requested object does not exist in the selected service.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_UNKNOWN_INTERFACE</varname></term> - <listitem><para>The requested interface does not exist on the selected object.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_UNKNOWN_PROPERTY</varname></term> - <listitem><para>The requested property does not exist in the selected interface.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_PROPERTY_READ_ONLY</varname></term> - <listitem><para>A write operation was requested on a read-only property.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN</varname></term> - <listitem><para>The requested PID is not known.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_INVALID_SIGNATURE</varname></term> - <listitem><para>The specified message signature is not - valid.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_INCONSISTENT_MESSAGE</varname></term> - <listitem><para>The passed message does not validate - correctly.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_MATCH_RULE_NOT_FOUND</varname></term> - <listitem><para>The specified match rule does not exist.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_MATCH_RULE_INVALID</varname></term> - <listitem><para>The specified match rule is invalid.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED</varname></term> - <listitem><para>Access to the requested operation is not - permitted, however, it might be available after interactive - authentication. This is usually returned by method calls - supporting a framework for additional interactive - authorization, when interactive authorization was not enabled - with the - <citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry> - for the method call message.</para></listitem> - </varlistentry> - </variablelist> - </refsect1> - - <refsect1> - <title>Notes</title> - - <para>The various error definitions 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> - - <refsect1> - <title>See Also</title> - - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>strerror</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> - </refsect1> - -</refentry> diff --git a/man/sd_bus_error_add_map.xml b/man/sd_bus_error_add_map.xml deleted file mode 100644 index 3fca63be4..000000000 --- a/man/sd_bus_error_add_map.xml +++ /dev/null @@ -1,173 +0,0 @@ -<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> -<!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 2015 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_error_add_map"> - - <refentryinfo> - <title>sd_bus_error_add_map</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>sd_bus_error_add_map</refentrytitle> - <manvolnum>3</manvolnum> - </refmeta> - - <refnamediv> - <refname>sd_bus_error_add_map</refname> - <refname>sd_bus_error_map</refname> - <refname>SD_BUS_ERROR_MAP</refname> - <refname>SD_BUS_ERROR_END</refname> - - <refpurpose>Additional sd-dbus error mappings</refpurpose> - </refnamediv> - - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo> - - <funcsynopsisinfo>typedef struct { - const char *name; - int code; - ... -} sd_bus_error_map;</funcsynopsisinfo> - - </funcsynopsis> - - <para> - <constant>SD_BUS_ERROR_MAP(<replaceable>name</replaceable>, <replaceable>code</replaceable>)</constant> - </para> - <para> - <constant>SD_BUS_ERROR_MAP_END</constant> - </para> - - <funcprototype> - <funcdef>int <function>sd_bus_error_add_map</function></funcdef> - <paramdef>const sd_bus_map *<parameter>map</parameter></paramdef> - </funcprototype> - - </refsynopsisdiv> - - <refsect1> - <title>Description</title> - - <para>The <function>sd_bus_error_add_map()</function> call may be - used to register additional mappings for converting D-Bus errors - to Linux <varname>errno</varname>-style errors. The mappings - defined with this call are consulted by calls such as - <citerefentry><refentrytitle>sd_bus_error_set</refentrytitle><manvolnum>3</manvolnum></citerefentry> - or - <citerefentry><refentrytitle>sd_bus_error_get_errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>. By - default a number of generic, standardized mappings are known, as - documented in - <citerefentry><refentrytitle>sd-bus-errors</refentrytitle><manvolnum>3</manvolnum></citerefentry>. Use - this call to add further, application-specific mappings.</para> - - <para>The function takes a pointer to an array of - <structname>sd_bus_error_map</structname> structures. A reference - to the specified array is added to the lookup tables for error - mappings. Note that the structure is not copied, it is hence - essential that the array stays available and constant during the - entire remaining runtime of the process.</para> - - <para>The mapping array should be put together with a series of - <constant>SD_BUS_ERROR_MAP()</constant> macro invocations, that - take a literal name string and a (positive) - <varname>errno</varname>-style error number. The last entry of the - array should be an invocation of the - <constant>SD_BUS_ERROR_MAP_END</constant> macro. The array should not be - put together without use of these two macros.</para> - - <para>Note that the call is idempotent: it is safe to invoke it - multiple times with the parameter, which will only add the passed - mapping array once.</para> - - <para>Note that the memory allocated by this call is not intended - to be freed during the lifetime of the process. It should not be - freed explicitly.</para> - </refsect1> - - <refsect1> - <title>Return Value</title> - - <para><function>sd_bus_error_add_map()</function> returns a - positive value when the new array was added to the lookup - tables. It returns zero when the same array was already added - before. On error, a negative <varname>errno</varname>-style error - code is returned. See below for known error codes.</para> - </refsect1> - - <refsect1> - <title>Errors</title> - - <para>Returned errors may indicate the following problems:</para> - - <variablelist> - - <varlistentry> - <term><constant>-EINVAL</constant></term> - - <listitem><para>The specified mapping array is invalid.</para></listitem> - </varlistentry> - - <varlistentry> - <term><constant>-ENOMEM</constant></term> - - <listitem><para>Memory allocation failed.</para></listitem> - </varlistentry> - </variablelist> - </refsect1> - - <refsect1> - <title>Notes</title> - - <para>The various error definitions 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> - - <refsect1> - <title>See Also</title> - - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus-errors</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>strerror_r</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> - </refsect1> - -</refentry> |