1 --- wayland-1.0.4/doc/man/wl_display_connect.xml.orig 1970-01-01 01:00:00.000000000 +0100
2 +++ wayland-1.0.4/doc/man/wl_display_connect.xml 2013-01-26 13:40:06.000000000 +0100
4 +<?xml version='1.0'?> <!--*-nxml-*-->
5 +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
6 + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
9 + Written 2012 by David Herrmann <dh.herrmann@googlemail.com>
10 + Dedicated to the Public Domain
13 +<refentry id="wl_display_connect">
15 + <title>wl_display_connect</title>
16 + <productname>wayland-client</productname>
17 + <date>September 2012</date>
20 + <contrib>Developer</contrib>
21 + <firstname>David</firstname>
22 + <surname>Herrmann</surname>
23 + <email>dh.herrmann@googlemail.com</email>
29 + <refentrytitle>wl_display_connect</refentrytitle>
30 + <manvolnum>3</manvolnum>
34 + <refname>wl_display_connect</refname>
35 + <refname>wl_display_connect_to_fd</refname>
36 + <refpurpose>Connect to a wayland socket</refpurpose>
42 + <funcsynopsisinfo>#include <wayland-client.h></funcsynopsisinfo>
45 + <funcdef>struct wl_display *<function>wl_display_connect</function></funcdef>
46 + <paramdef>const char *<parameter>name</parameter></paramdef>
50 + <funcdef>struct wl_display *<function>wl_display_connect_to_fd</function></funcdef>
51 + <paramdef>int <parameter>fd</parameter></paramdef>
58 + <title>Description</title>
59 + <para><function>wl_display_connect</function> connects to a wayland socket
60 + that was previously opened by a wayland server. The server socket must
61 + be placed in <envar>XDG_RUNTIME_DIR</envar> for this function to
62 + find it. The <varname>name</varname> argument specifies the name of
63 + the socket or <constant>NULL</constant> to use the default (which is
64 + <constant>"wayland-0"</constant>). The environment variable
65 + <envar>WAYLAND_DISPLAY</envar> replaces the default value. If
66 + <envar>WAYLAND_SOCKET</envar> is set, this function behaves like
67 + <function>wl_display_connect_to_fd</function> with the file-descriptor
68 + number taken from the environment variable.</para>
70 + <para><function>wl_display_connect_to_fd</function> connects to a wayland
71 + socket with an explicit file-descriptor. The file-descriptor is passed
72 + as argument <varname>fd</varname>.</para>
76 + <title>Return Value</title>
77 + <para><function>wl_display_connect</function> and
78 + <function>wl_display_connect_to_fd</function> return a new display
79 + context object or NULL on failure. <varname>errno</varname> is set
80 + correspondingly.</para>
84 + <title>See Also</title>
86 + <citerefentry><refentrytitle>wayland-client</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
87 + <citerefentry><refentrytitle>wl_display_disconnect</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
88 + <citerefentry><refentrytitle>wl_display_iterate</refentrytitle><manvolnum>3</manvolnum></citerefentry>