|
 |
62f96b |
From d80c3cbfaae6683e0e1685e5337b7dfe3a36692a Mon Sep 17 00:00:00 2001
|
|
|
62f96b |
From: Debarshi Ray <debarshir@freedesktop.org>
|
|
|
62f96b |
Date: Mon, 22 Jun 2020 17:02:42 +0200
|
|
|
62f96b |
Subject: [PATCH] Add a manual
|
|
|
62f96b |
|
|
|
62f96b |
https://github.com/phako/dleyna-renderer/pull/1
|
|
|
62f96b |
---
|
|
|
62f96b |
Makefile.am | 2 +-
|
|
|
62f96b |
configure.ac | 6 +
|
|
|
62f96b |
doc/Makefile.am | 18 +++
|
|
|
62f96b |
doc/dleyna-renderer-service.conf.xml | 182 +++++++++++++++++++++++++++
|
|
|
62f96b |
4 files changed, 207 insertions(+), 1 deletion(-)
|
|
|
62f96b |
create mode 100644 doc/Makefile.am
|
|
|
62f96b |
create mode 100644 doc/dleyna-renderer-service.conf.xml
|
|
|
62f96b |
|
|
|
62f96b |
diff --git a/Makefile.am b/Makefile.am
|
|
|
62f96b |
index 200e1967f0e5..35bd628faf47 100644
|
|
|
62f96b |
--- a/Makefile.am
|
|
|
62f96b |
+++ b/Makefile.am
|
|
|
62f96b |
@@ -1,4 +1,4 @@
|
|
|
62f96b |
-SUBDIRS = libdleyna/renderer
|
|
|
62f96b |
+SUBDIRS = doc libdleyna/renderer
|
|
|
62f96b |
|
|
|
62f96b |
if BUILD_SERVER
|
|
|
62f96b |
SUBDIRS += server
|
|
|
62f96b |
diff --git a/configure.ac b/configure.ac
|
|
|
62f96b |
index 271ee92ead00..4d96903c67a3 100644
|
|
|
62f96b |
--- a/configure.ac
|
|
|
62f96b |
+++ b/configure.ac
|
|
|
62f96b |
@@ -34,6 +34,11 @@ LT_PREREQ([2.2.6])
|
|
|
62f96b |
LT_INIT([dlopen disable-static])
|
|
|
62f96b |
LT_LANG([C])
|
|
|
62f96b |
|
|
|
62f96b |
+AC_PATH_PROG([XSLTPROC], [xsltproc])
|
|
|
62f96b |
+if test -z "$XSLTPROC"; then
|
|
|
62f96b |
+ AC_MSG_ERROR([xsltproc not found])
|
|
|
62f96b |
+fi
|
|
|
62f96b |
+
|
|
|
62f96b |
# Checks for libraries.
|
|
|
62f96b |
PKG_PROG_PKG_CONFIG(0.16)
|
|
|
62f96b |
PKG_CHECK_MODULES([GLIB], [glib-2.0 >= 2.28])
|
|
|
62f96b |
@@ -231,6 +236,7 @@ AC_SUBST([with_log_level])
|
|
|
62f96b |
AC_SUBST([with_log_type])
|
|
|
62f96b |
|
|
|
62f96b |
AC_CONFIG_FILES([Makefile \
|
|
|
62f96b |
+ doc/Makefile \
|
|
|
62f96b |
libdleyna/renderer/Makefile \
|
|
|
62f96b |
libdleyna/renderer/dleyna-renderer-service.conf \
|
|
|
62f96b |
server/dleyna-renderer-service-1.0.pc \
|
|
|
62f96b |
diff --git a/doc/Makefile.am b/doc/Makefile.am
|
|
|
62f96b |
new file mode 100644
|
|
|
62f96b |
index 000000000000..80069b1c82e7
|
|
|
62f96b |
--- /dev/null
|
|
|
62f96b |
+++ b/doc/Makefile.am
|
|
|
62f96b |
@@ -0,0 +1,18 @@
|
|
|
62f96b |
+XSLTPROC_FLAGS = \
|
|
|
62f96b |
+ --nonet \
|
|
|
62f96b |
+ --stringparam man.output.quietly 1 \
|
|
|
62f96b |
+ --stringparam funcsynopsis.style ansi \
|
|
|
62f96b |
+ --stringparam man.authors.section.enabled 0 \
|
|
|
62f96b |
+ --stringparam man.copyright.section.enabled 0
|
|
|
62f96b |
+
|
|
|
62f96b |
+.xml.5:
|
|
|
62f96b |
+ $(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
|
|
|
62f96b |
+
|
|
|
62f96b |
+man_MANS = \
|
|
|
62f96b |
+ dleyna-renderer-service.conf.5
|
|
|
62f96b |
+
|
|
|
62f96b |
+xml_files = $(man_MANS:.5=.xml)
|
|
|
62f96b |
+
|
|
|
62f96b |
+EXTRA_DIST = $(xml_files)
|
|
|
62f96b |
+
|
|
|
62f96b |
+CLEANFILES = $(man_MANS)
|
|
|
62f96b |
diff --git a/doc/dleyna-renderer-service.conf.xml b/doc/dleyna-renderer-service.conf.xml
|
|
|
62f96b |
new file mode 100644
|
|
|
62f96b |
index 000000000000..e6be27411cf9
|
|
|
62f96b |
--- /dev/null
|
|
|
62f96b |
+++ b/doc/dleyna-renderer-service.conf.xml
|
|
|
62f96b |
@@ -0,0 +1,182 @@
|
|
|
62f96b |
+
|
|
|
62f96b |
+<refentry id="dleyna-renderer-service.conf.5">
|
|
|
62f96b |
+ <refentryinfo>
|
|
|
62f96b |
+ <title>dleyna-renderer-service.conf</title>
|
|
|
62f96b |
+ <date>June 2020</date>
|
|
|
62f96b |
+ <productname>dLeyna</productname>
|
|
|
62f96b |
+ </refentryinfo>
|
|
|
62f96b |
+
|
|
|
62f96b |
+ <refmeta>
|
|
|
62f96b |
+ <refentrytitle>dleyna-renderer-service.conf</refentrytitle>
|
|
|
62f96b |
+ <manvolnum>5</manvolnum>
|
|
|
62f96b |
+ <refmiscinfo class="manual">Linux Programmer's Manual</refmiscinfo>
|
|
|
62f96b |
+ </refmeta>
|
|
|
62f96b |
+
|
|
|
62f96b |
+ <refnamediv>
|
|
|
62f96b |
+ <refname>dleyna-renderer-service.conf</refname>
|
|
|
62f96b |
+ <refpurpose>Configuration file for dleyna-renderer</refpurpose>
|
|
|
62f96b |
+ </refnamediv>
|
|
|
62f96b |
+
|
|
|
62f96b |
+ <refsynopsisdiv>
|
|
|
62f96b |
+ <cmdsynopsis>
|
|
|
62f96b |
+ <command>/etc/dleyna-renderer-service.conf</command>
|
|
|
62f96b |
+ </cmdsynopsis>
|
|
|
62f96b |
+ </refsynopsisdiv>
|
|
|
62f96b |
+
|
|
|
62f96b |
+
|
|
|
62f96b |
+ <refsect1>
|
|
|
62f96b |
+ <title>DESCRIPTION</title>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ The <command>dleyna-renderer-service</command> program provides the
|
|
|
62f96b |
+ <emphasis>com.intel.dleyna-renderer</emphasis> name on the session
|
|
|
62f96b |
+ message bus. It is a service for discovering and manipulating DLNA
|
|
|
62f96b |
+ Digital Media Renderers (or DMRs).
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ Users or administrators should never need to start this daemon as it will
|
|
|
62f96b |
+ be automatically started by
|
|
|
62f96b |
+ <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
|
|
62f96b |
+ whenever a process sends a D-Bus message to the
|
|
|
62f96b |
+ <emphasis>com.intel.dleyna-renderer</emphasis> name on the session bus.
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ This file can be used to configure the behaviour of the
|
|
|
62f96b |
+ <command>dleyna-renderer-service</command> program.
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ </refsect1>
|
|
|
62f96b |
+
|
|
|
62f96b |
+ <refsect1>
|
|
|
62f96b |
+ <title>FILE FORMAT</title>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ The configuration file format is the so-called key file (sort of
|
|
|
62f96b |
+ ini-style) format. It consists of sections (or groups) of key-value
|
|
|
62f96b |
+ Lines beginning with a '#' and blank lines are considered comments.
|
|
|
62f96b |
+ Sections are started by a header line containing the section enclosed
|
|
|
62f96b |
+ in '[' and ']', and ended implicitly by the start of the next section
|
|
|
62f96b |
+ or the end of the file. Each key-value pair must be contained in a
|
|
|
62f96b |
+ section.
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ </refsect1>
|
|
|
62f96b |
+
|
|
|
62f96b |
+ <refsect1>
|
|
|
62f96b |
+ <title>GENERAL SECTION</title>
|
|
|
62f96b |
+ <variablelist>
|
|
|
62f96b |
+ <varlistentry>
|
|
|
62f96b |
+ <term><option>connector-name=dbus</option></term>
|
|
|
62f96b |
+ <listitem>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ The name of the inter-process communication method to be used.
|
|
|
62f96b |
+ The only supported value is <emphasis>dbus</emphasis>.
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ </listitem>
|
|
|
62f96b |
+ </varlistentry>
|
|
|
62f96b |
+ <varlistentry>
|
|
|
62f96b |
+ <term><option>never-quit=false|true</option></term>
|
|
|
62f96b |
+ <listitem>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ Whether the process should stay alive forever or quit when the
|
|
|
62f96b |
+ last client disconnects. The default value is
|
|
|
62f96b |
+ <emphasis>false</emphasis>.
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ </listitem>
|
|
|
62f96b |
+ </varlistentry>
|
|
|
62f96b |
+ <varlistentry>
|
|
|
62f96b |
+ <term><option>port</option></term>
|
|
|
62f96b |
+ <listitem>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ Source port for Simple Service Discovery Protocol (or SSDP)
|
|
|
62f96b |
+ messages. The default value is <emphasis>0</emphasis> which
|
|
|
62f96b |
+ means that a random available port will be used.
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ </listitem>
|
|
|
62f96b |
+ </varlistentry>
|
|
|
62f96b |
+ <varlistentry>
|
|
|
62f96b |
+ <term><option>push-host-port</option></term>
|
|
|
62f96b |
+ <listitem>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ Port for push host file server. The default value is
|
|
|
62f96b |
+ <emphasis>0</emphasis> which means that a random available
|
|
|
62f96b |
+ port will be used.
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ </listitem>
|
|
|
62f96b |
+ </varlistentry>
|
|
|
62f96b |
+ </variablelist>
|
|
|
62f96b |
+ </refsect1>
|
|
|
62f96b |
+
|
|
|
62f96b |
+ <refsect1>
|
|
|
62f96b |
+ <title>LOG SECTION</title>
|
|
|
62f96b |
+ <variablelist>
|
|
|
62f96b |
+ <varlistentry>
|
|
|
62f96b |
+ <term><option>log-type=0|1|2</option></term>
|
|
|
62f96b |
+ <listitem>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ The logging method to be used. Three technologies are supported.
|
|
|
62f96b |
+ 0 for syslog, 1 for GLib, and 2 for file. The default value is
|
|
|
62f96b |
+ <emphasis>0</emphasis>.
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ </listitem>
|
|
|
62f96b |
+ </varlistentry>
|
|
|
62f96b |
+ <varlistentry>
|
|
|
62f96b |
+ <term><option>log-level=0|1|2|...|8</option></term>
|
|
|
62f96b |
+ <listitem>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ Comma-separated list of logging levels. The levels are 1 for
|
|
|
62f96b |
+ critical, 2 for error, 3 for warning, 4 for message, 5 for info
|
|
|
62f96b |
+ and 6 for debug. 0 excludes all levels, 7 is a combination of
|
|
|
62f96b |
+ critical, error and info, and 8 includes all levels.
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ The default value is <emphasis>7</emphasis>.
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ </listitem>
|
|
|
62f96b |
+ </varlistentry>
|
|
|
62f96b |
+ </variablelist>
|
|
|
62f96b |
+ </refsect1>
|
|
|
62f96b |
+
|
|
|
62f96b |
+ <refsect1>
|
|
|
62f96b |
+ <title>NETF SECTION</title>
|
|
|
62f96b |
+ <variablelist>
|
|
|
62f96b |
+ <varlistentry>
|
|
|
62f96b |
+ <term><option>netf-enabled=false|true</option></term>
|
|
|
62f96b |
+ <listitem>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ Whether network filtering should be enabled or not. The default
|
|
|
62f96b |
+ values is <emphasis>false</emphasis>.
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ </listitem>
|
|
|
62f96b |
+ </varlistentry>
|
|
|
62f96b |
+ <varlistentry>
|
|
|
62f96b |
+ <term><option>netf-list</option></term>
|
|
|
62f96b |
+ <listitem>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ Comma-separated list of interface names, service set identifiers
|
|
|
62f96b |
+ (or SSIDs), and Internet Protocol (or IP) addresses. If network
|
|
|
62f96b |
+ filtering is requested but the list is empty, then filtering
|
|
|
62f96b |
+ remains disabled.
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ The list is empty by default.
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ </listitem>
|
|
|
62f96b |
+ </varlistentry>
|
|
|
62f96b |
+ </variablelist>
|
|
|
62f96b |
+ </refsect1>
|
|
|
62f96b |
+
|
|
|
62f96b |
+ <refsect1>
|
|
|
62f96b |
+ <title>BUGS</title>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ Please send bug reports to either the distribution bug tracker
|
|
|
62f96b |
+ or the upstream bug tracker at
|
|
|
62f96b |
+ <ulink url="https://github.com/intel/dleyna-renderer/issues"></ulink>.
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ </refsect1>
|
|
|
62f96b |
+
|
|
|
62f96b |
+ <refsect1>
|
|
|
62f96b |
+ <title>SEE ALSO</title>
|
|
|
62f96b |
+ <para>
|
|
|
62f96b |
+ <citerefentry>
|
|
|
62f96b |
+ <refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum>
|
|
|
62f96b |
+ </citerefentry>
|
|
|
62f96b |
+ </para>
|
|
|
62f96b |
+ </refsect1>
|
|
|
62f96b |
+</refentry>
|
|
|
62f96b |
--
|
|
|
62f96b |
2.25.4
|
|
|
62f96b |
|