49dee9a86c
This adds a man-page infrastructure based on Docbook XML files. This allows us to integrate the man-pages into the publican books later. An example page for wl_display_connect() (with an alias wl_display_connect_to_fd()) is also added. Feel free to add more man-pages. Function calls are put in man3 and overview pages into man7. All pages (including aliases) have to be added to the Makefile. Docbook does generate aliases automatically from the additional names that were put in the XML file. However, a small SED script is needed to fixup the include-paths in the generated troff files. If someone knows how to avoid that (or even install them gzip'ped), please fix it up. Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
89 lines
3.2 KiB
XML
89 lines
3.2 KiB
XML
<?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">
|
|
|
|
<!--
|
|
Written 2012 by David Herrmann <dh.herrmann@googlemail.com>
|
|
Dedicated to the Public Domain
|
|
-->
|
|
|
|
<refentry id="wl_display_connect">
|
|
<refentryinfo>
|
|
<title>wl_display_connect</title>
|
|
<productname>wayland-client</productname>
|
|
<date>September 2012</date>
|
|
<authorgroup>
|
|
<author>
|
|
<contrib>Developer</contrib>
|
|
<firstname>David</firstname>
|
|
<surname>Herrmann</surname>
|
|
<email>dh.herrmann@googlemail.com</email>
|
|
</author>
|
|
</authorgroup>
|
|
</refentryinfo>
|
|
|
|
<refmeta>
|
|
<refentrytitle>wl_display_connect</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>wl_display_connect</refname>
|
|
<refname>wl_display_connect_to_fd</refname>
|
|
<refpurpose>Connect to a wayland socket</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
|
|
<funcsynopsisinfo>#include <wayland-client.h></funcsynopsisinfo>
|
|
|
|
<funcprototype>
|
|
<funcdef>struct wl_display *<function>wl_display_connect</function></funcdef>
|
|
<paramdef>const char *<parameter>name</parameter></paramdef>
|
|
</funcprototype>
|
|
|
|
<funcprototype>
|
|
<funcdef>struct wl_display *<function>wl_display_connect_to_fd</function></funcdef>
|
|
<paramdef>int <parameter>fd</parameter></paramdef>
|
|
</funcprototype>
|
|
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para><function>wl_display_connect</function> connects to a wayland socket
|
|
that was previously opened by a wayland server. The server socket must
|
|
be placed in <envar>XDG_RUNTIME_DIR</envar> for this function to
|
|
find it. The <varname>name</varname> argument specifies the name of
|
|
the socket or <constant>NULL</constant> to use the default (which is
|
|
<constant>"wayland-0"</constant>). The environment variable
|
|
<envar>WAYLAND_DISPLAY</envar> replaces the default value. If
|
|
<envar>WAYLAND_SOCKET</envar> is set, this function behaves like
|
|
<function>wl_display_connect_to_fd</function> with the file-descriptor
|
|
number taken from the environment variable.</para>
|
|
|
|
<para><function>wl_display_connect_to_fd</function> connects to a wayland
|
|
socket with an explicit file-descriptor. The file-descriptor is passed
|
|
as argument <varname>fd</varname>.</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Return Value</title>
|
|
<para><function>wl_display_connect</function> and
|
|
<function>wl_display_connect_to_fd</function> return a new display
|
|
context object or NULL on failure. <varname>errno</varname> is set
|
|
correspondingly.</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>wayland-client</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
|
|
<citerefentry><refentrytitle>wl_display_disconnect</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
<citerefentry><refentrytitle>wl_display_iterate</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|