diff options
| author | Lennart Poettering <lennart@poettering.net> | 2014-03-11 19:03:50 +0100 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2014-03-11 19:03:50 +0100 |
| commit | a6278b88305b237b02eabff0d870b57fe851822d (patch) | |
| tree | d826e248d401a18f07c45cfc0832907e861a2877 /man/sd_bus_label_escape.xml | |
| parent | 2be56ff1e49c8954a0899da701233acf053e95a4 (diff) | |
bus: replace sd_bus_label_{escape,unescape}() by new sd_bus_path_{encode,decode}()
The new calls work similarly, but enforce a that a common, fixed bus
path prefix is used.
This follows discussions with Simon McVittie on IRC that it should be a
good idea to make sure that people don't use the escaping applied here
too wildly as anything other than the last label of a bus path.
Diffstat (limited to 'man/sd_bus_label_escape.xml')
| -rw-r--r-- | man/sd_bus_label_escape.xml | 111 |
1 files changed, 0 insertions, 111 deletions
diff --git a/man/sd_bus_label_escape.xml b/man/sd_bus_label_escape.xml deleted file mode 100644 index 0b5564f15d..0000000000 --- a/man/sd_bus_label_escape.xml +++ /dev/null @@ -1,111 +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 2014 Zbigniew Jędrzejewski-Szmek - -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_label_escape" conditional="ENABLE_KDBUS"> - - <refentryinfo> - <title>sd_bus_label_escape</title> - <productname>systemd</productname> - - <authorgroup> - <author> - <contrib>A monkey with a typewriter</contrib> - <firstname>Zbigniew</firstname> - <surname>Jędrzejewski-Szmek</surname> - <email>zbyszek@in.waw.pl</email> - </author> - </authorgroup> - </refentryinfo> - - <refmeta> - <refentrytitle>sd_bus_label_escape</refentrytitle> - <manvolnum>3</manvolnum> - </refmeta> - - <refnamediv> - <refname>sd_bus_label_escape</refname> - <refname>sd_bus_label_unescape</refname> - - <refpurpose>Escape D-Bus object path special characters</refpurpose> - </refnamediv> - - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo> - - <funcprototype> - <funcdef>char *<function>sd_bus_label_escape</function></funcdef> - <paramdef>const char *<parameter>s</parameter></paramdef> - </funcprototype> - - <funcprototype> - <funcdef>char *<function>sd_bus_label_unescape</function></funcdef> - <paramdef>const char *<parameter>f</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - - <refsect1> - <title>Description</title> - - <para><function>sd_bus_label_escape()</function> takes a - <constant>NUL</constant>-terminated string as a argument. It will - replace all characters which are invalid in a D-Bus object path by - <literal>_</literal> and a hexadecimal number. As a special case, - the empty string will be replaced by a lone <literal>_</literal>. - <function>sd_bus_label_unescape()</function> can be used to - reverse this process.</para> - </refsect1> - - <refsect1> - <title>Return Value</title> - - <para>On success, a new <constant>NUL</constant>-terminated string - will be returned. It must be - <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>d - by the caller. If a memory allocation failure occurs, - <constant>NULL</constant> will be returned. - </para> - </refsect1> - - <refsect1> - <title>Notes</title> - - <para><function>sd_bus_label_escape()</function> and - <function>sd_bus_label_unescape()</function> are available as a - shared library, which can be compiled and linked to with the - <constant>libsystemd</constant> <citerefentry><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>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> - </refsect1> - -</refentry> |