man: add systemd-dbus-proxy@.service(8) and systemd-dbus.proxy(8)

This commit is contained in:
Zbigniew Jędrzejewski-Szmek
2013-12-21 18:34:40 -05:00
parent 9818fa6d6d
commit 2dc38ed00f
4 changed files with 215 additions and 1 deletions
+12
View File
@@ -48,6 +48,7 @@ MANPAGES += \
man/systemd-analyze.1 \
man/systemd-ask-password-console.service.8 \
man/systemd-ask-password.1 \
man/systemd-bus-proxyd.8 \
man/systemd-cat.1 \
man/systemd-cgls.1 \
man/systemd-cgtop.1 \
@@ -683,6 +684,17 @@ man/systemd-hostnamed.html: man/systemd-hostnamed.service.html
endif
if ENABLE_KDBUS
MANPAGES += \
man/systemd-bus-proxyd@.service.8
MANPAGES_ALIAS += \
man/systemd-bus-proxyd.socket.8
man/systemd-bus-proxyd.socket.8: man/systemd-bus-proxyd@.service.8
man/systemd-bus-proxyd.socket.html: man/systemd-bus-proxyd@.service.html
$(html-alias)
endif
if ENABLE_LOCALED
MANPAGES += \
man/localectl.1 \
+121
View File
@@ -0,0 +1,121 @@
<?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 2013 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="systemd-bus-proxyd">
<refentryinfo>
<title>systemd-bus-proxyd</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>systemd-bus-proxyd</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-bus-proxyd</refname>
<refpurpose>Connect STDIO or a socket to a given bus address</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>/usr/lib/systemd/systemd-bus-proxyd</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="opt"><replaceable>PLACEHOLDER</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><command>systemd-bus-proxyd</command> will proxy D-Bus
messages to and from a bus. The will be either the system bus or
the bus specified with <option>--address</option> when that option
is given. Messages will be proxied to/from stdin and stdout, or
the socket received through socket activation.</para>
<para>This program can be used to connect a program using classic
D-Bus to kdbus.</para>
</refsect1>
<refsect1>
<title>Options and Arguments</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>--address=<replaceable>ADDRESS</replaceable><optional>:<replaceable>ADDRESS...</replaceable></optional></option></term>
<listitem>
<para>Connect to the bus specified by
<replaceable>ADDRESS</replaceable>. Multiple colon-seperated
addresses can be specified, in which case
<command>systemd-bus-proxyd</command> will attempt to
connect to them in turn.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem>
<para>Prints a short version string and exits.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem><para>Prints a short help
text and exits.</para></listitem>
</varlistentry>
</variablelist>
<para><replaceable>PLACEHOLDER</replaceable> if given must be a string
of <literal>x</literal> and will be used to display information about
the process that <command>systemd-bus-proxyd</command> is forwarding
messages for.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>
<ulink url="https://code.google.com/p/d-bus/">kdbus</ulink>
</para>
</refsect1>
</refentry>
+81
View File
@@ -0,0 +1,81 @@
<?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 2013 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="systemd-bus-proxyd@.service" conditional='ENABLE_KDBUS'>
<refentryinfo>
<title>systemd-bus-proxyd@.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>systemd-bus-proxyd@.service</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-bus-proxyd@.service</refname>
<refname>systemd-bus-proxyd.socket</refname>
<refpurpose>Proxy classic D-Bus clients to kdbus</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename>systemd-bus-proxyd@.service</filename></para>
<para><filename>systemd-bus-proxyd.socket</filename></para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><filename>systemd-bus-proxyd.socket</filename> will launch
<filename>systemd-bus-proxyd@.service</filename> for connections
to the classic D-Bus socket in
<filename>/run/dbus/system_bus_socket</filename>.</para>
<para><filename>systemd-bus-proxyd@.service</filename> is launched
for an existing D-Bus connection and will use
<command>systemd-bus-proxyd</command> to proxy messages from this
connection to the system bus (either kdbus or classic D-Bus).
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd-bus-proxyd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
<citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>
<ulink url="https://code.google.com/p/d-bus/">kdbus</ulink>
</para>
</refsect1>
</refentry>
+1 -1
View File
@@ -85,7 +85,7 @@ static int parse_argv(int argc, char *argv[]) {
assert(argc >= 0);
assert(argv);
while ((c = getopt_long(argc, argv, "hsup:", options, NULL)) >= 0) {
while ((c = getopt_long(argc, argv, "h", options, NULL)) >= 0) {
switch (c) {