diff options
Diffstat (limited to 'man/XI.xml')
| -rw-r--r-- | man/XI.xml | 443 |
1 files changed, 0 insertions, 443 deletions
@@ -5284,449 +5284,6 @@ </refsect1> </refentry> -<refentry id="XPermitDevices.man"> - <refentryinfo> - <productname>__vendorversion__</productname> - <pubdate>February 14, 2008</pubdate> - <authorgroup> - <author> - <firstname>Peter</firstname><surname>Hutterer</surname> - <contrib>Specification and implementation.</contrib> - </author> - </authorgroup> - </refentryinfo> - - <refmeta> - <refentrytitle>XPermitDevices, XDenyDevices, XChangeAccessRule</refentrytitle> - <manvolnum>__libmansuffix__</manvolnum> - <refmiscinfo class='source'>__xorgversion__</refmiscinfo> - <refmiscinfo class='manual'>XINPUT FUNCTIONS</refmiscinfo> -</refmeta> - <refnamediv> - <refname>XPermitDevices</refname> - <refname>XDenyDevices</refname> - <refname>XChangeAccessRule</refname> - <refpurpose>change access rules to the window.</refpurpose> - </refnamediv> - <refsynopsisdiv> - <title>Syntax</title> - <funcsynopsis> - <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> - <funcprototype> - <funcdef>Status <function>XPermitDevices</function></funcdef> - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>Window <parameter>win</parameter></paramdef> - <paramdef>XID* <parameter>deviceids</parameter></paramdef> - <paramdef>int <parameter>num_devices</parameter></paramdef> - </funcprototype> - <funcprototype> - <funcdef>Status <function>XDenyDevices</function></funcdef> - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>Window <parameter>win</parameter></paramdef> - <paramdef>XID* <parameter>deviceids</parameter></paramdef> - <paramdef>int <parameter>num_devices</parameter></paramdef> - </funcprototype> - <funcprototype> - <funcdef>Status <function>XChangeAccessRule</function></funcdef> - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>Window <parameter>win</parameter></paramdef> - <paramdef>int <parameter>rule</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - - <refsect1><title>Arguments</title> - <para> - <variablelist> - <varlistentry> - <term><parameter>deviceids</parameter></term> - <listitem><para>Specifies a list of device IDs to - deny/restrict access. - </para></listitem> - </varlistentry> - <varlistentry> - <term><parameter>display</parameter></term> - <listitem><para>Specifies the connection to the X server. - </para></listitem> - </varlistentry> - <varlistentry> - <term><parameter>num_devices</parameter></term> - <listitem><para>Specifies the number of elements in - <parameter>deviceids</parameter>. - </para></listitem> - </varlistentry> - <varlistentry> - <term><parameter>rule</parameter></term> - <listitem> - <para>Specifies the default access rule for - <parameter>win</parameter>. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term><parameter>win</parameter></term> - <listitem> - <para> - Specifies the window. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1><title>Description</title> - <para> - Each window features an Access Control List (ACL) to permit or deny - devices from sending events from this window. This is intended to - be used to restrict devices from accessing certain UI elements - in a multi-user environment. It is not to be used as a security - feature. - </para> - <para> - Access rules work hierarchically and if any parent window has an - access rule defined, it applies to all child windows unless - overridden in the child window. - </para> - <para> - Each window's default rule determines the default access mode. If - the default rule is <constant>WindowAccessDenyAll</constant>, no - device can send events to this window. If the default rule is - <constant>WindowAccessNoRule</constant>, any device can access the - window, unless a parent has - <constant>WindowAccessDenyAll</constant> set. If the default rule - is <constant>WindowAccessAllowAll</constant>, any device can - access the window. - </para> - <para> - If a device is specified in the window's deny list, it is denied - access to this window, regardless of the access rule. - If a device is specified in the window's perm list, this - device is allowed to access this window regardless of the parent - window's settings, the deny list, and the default rule. - </para> - <para> - <function>XPermitDevices</function> and - <function>XDenyDevices</function> set the window's perm list - or deny list to the devices specified in - <parameter>deviceids</parameter>. Any previous setting is - overwritten. - </para> - <para> - <function>XPermitDevices</function> and - <function>XDenyDevices</function> can generate a - <errorname>BadDevice</errorname> and a - <errorname>BadWindow</errorname> error. - </para> - <para> - <function>XChangeAccessRule</function> sets the default acess rule - for <parameter>window</parameter>. If <parameter>rule</parameter> - is <constant>WindowAccessDenyAll</constant>, all devices are - denied access to this window. If <parameter>rule</parameter> is - <constant>WindowAccessAllowAll</constant>, all devices are - permitted access to this window. Otherwise, if - <constant>WindowAccessNoRule</constant> is given, the default rule - is reset and all devices are able to send events to the window - unless a parent window restricts access. - </para> - <para> - <function>XChangeAccessRule</function> can generate a - <errorname>BadDevice</errorname> and a - <errorname>BadValue</errorname> error. - </para> - </refsect1> - - <refsect1><title>Diagnosis</title> - <para> - <variablelist> - <varlistentry> - <term><errorname>BadDevice</errorname></term> - <listitem><para>An invalid device was specified. The - device does not exist. -</para></listitem> - - </varlistentry> - <varlistentry> - <term><errorname>BadWindow</errorname></term> - <listitem><para>A value for a Window argument does not - name a defined window. -</para></listitem> - </varlistentry> - <varlistentry> - <term><errorname>BadValue</errorname></term> - <listitem><para>Some numeric value falls out of the - allowed range. -</para></listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1><title>See also</title> - <para> - <function>XWindowClearAccess</function>, - <function>XQueryWindowAccess</function> - </para> - </refsect1> -</refentry> - -<refentry id="XWindowClearAccess.man"> - <refentryinfo> - <productname>__vendorversion__</productname> - <pubdate>February 14, 2008</pubdate> - <authorgroup> - <author> - <firstname>Peter</firstname><surname>Hutterer</surname> - <contrib>Specification and implementation.</contrib> - </author> - </authorgroup> - </refentryinfo> - - <refmeta> - <refentrytitle>XWindowClearAccess</refentrytitle> - <manvolnum>__libmansuffix__</manvolnum> - <refmiscinfo class='source'>__xorgversion__</refmiscinfo> - <refmiscinfo class='manual'>XINPUT FUNCTIONS</refmiscinfo> -</refmeta> - <refnamediv> - <refname>XWindowClearAccess</refname> - <refpurpose>remove access rules for the window.</refpurpose> - </refnamediv> - <refsynopsisdiv> - <title>Syntax</title> - <funcsynopsis> - <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> - <funcprototype> - <funcdef>Status <function>XWindowClearAccess</function></funcdef> - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>Window <parameter>win</parameter></paramdef> - <paramdef>int <parameter>what</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - - <refsect1><title>Arguments</title> - <para> - <variablelist> - <varlistentry> - <term><parameter>display</parameter></term> - <listitem><para>Specifies the connection to the X server. -</para></listitem> - </varlistentry> - <varlistentry> - <term><parameter>what</parameter></term> - <listitem><para>Specifies the access restrictions to - remove. -</para></listitem> - </varlistentry> - <varlistentry> - <term><parameter>win</parameter></term> - <listitem> - <para> - Specifies the window. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1><title>Description</title> - <para> - <function>XWindowClearAccess</function> removes an access control - restriction from <parameter>window</parameter>. The bitmask - <parameter>what</parameter> defines which restrictions to remove. - </para> - <para> - If <constant>WindowAccessClearPerm</constant> is set, the - perm list of <parameter>win</parameter> is removed. If - <constant>WindowAccessClearDeny</constant> is set, the deny list - of <parameter>win</parameter> is removed. If - <constant>WindowAccessClearRule</constant> is set, the default - rule of the window is set to - <constant>WindowAccessNoRule</constant>. If - <parameter>what</parameter> is equal to - <constant>WindowAccessClearAll</constant>, the window is reset to - the neutral state (neither explicitly permitting nor denying - access). - </para> - <para> - <function>XWindowClearAccess</function> can generate a - <errorname>BadValue</errorname> and a - <errorname>BadWindow</errorname> error. - </para> - </refsect1> - - <refsect1><title>Diagnosis</title> - <para> - <variablelist> - <varlistentry> - <term><errorname>BadValue</errorname></term> - <listitem><para>A value is outside of the permitted range. -</para></listitem> - - </varlistentry> - <varlistentry> - <term><errorname>BadWindow</errorname></term> - <listitem><para>A value for a Window argument does not - name a defined window. -</para></listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1><title>See also</title> - <para> - <function>XPermitDevices</function>, - <function>XDenyDevices</function>, - <function>XChangeAccessRule</function>, - <function>XQueryWindowAccess</function> - </para> - </refsect1> -</refentry> - -<refentry id="XQueryWindowAccess.man"> - <refentryinfo> - <productname>__vendorversion__</productname> - <pubdate>February 14, 2008</pubdate> - <authorgroup> - <author> - <firstname>Peter</firstname><surname>Hutterer</surname> - <contrib>Specification and implementation.</contrib> - </author> - </authorgroup> - </refentryinfo> - - <refmeta> - <refentrytitle>XQueryWindowAccess</refentrytitle> - <manvolnum>__libmansuffix__</manvolnum> - <refmiscinfo class='source'>__xorgversion__</refmiscinfo> - <refmiscinfo class='manual'>XINPUT FUNCTIONS</refmiscinfo> -</refmeta> - <refnamediv> - <refname>XQueryWindowAccess</refname> - <refpurpose>query access rules of the window.</refpurpose> - </refnamediv> - <refsynopsisdiv> - <title>Syntax</title> - <funcsynopsis> - <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> - <funcprototype> - <funcdef>Status <function>XQueryWindowAccess</function></funcdef> - <paramdef>Display *<parameter>display</parameter></paramdef> - <paramdef>Window <parameter>win</parameter></paramdef> - <paramdef>int *<parameter>rule_return</parameter></paramdef> - <paramdef>XID **<parameter>permdevices_return</parameter></paramdef> - <paramdef>int *<parameter>nperm_return</parameter></paramdef> - <paramdef>XID **<parameter>denydevices_return</parameter></paramdef> - <paramdef>int *<parameter>ndeny_return</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - - <refsect1><title>Arguments</title> - <para> - <variablelist> - <varlistentry> - <term><parameter>display</parameter></term> - <listitem><para>Specifies the connection to the X server. -</para></listitem> - </varlistentry> - <varlistentry> - <term><parameter>rule_return</parameter></term> - <listitem><para>The default rule of the window. -</para></listitem> - </varlistentry> - <varlistentry> - <term><parameter>permdevices_return</parameter></term> - <listitem><para>List of devices explicitly allowed to access the - window. -</para></listitem> - </varlistentry> - <varlistentry> - <term><parameter>denydevices_return</parameter></term> - <listitem><para>List of devices explicitly denied access the - window. -</para></listitem> - </varlistentry> - <varlistentry> - <term><parameter>nperm_return</parameter></term> - <listitem><para>Number of elements in - <parameter>permdevices_return</parameter>. -</para></listitem> - </varlistentry> - <varlistentry> - <term><parameter>ndeny_return</parameter></term> - <listitem><para>Number of elements in - <parameter>denydevices_return</parameter>. -</para></listitem> - </varlistentry> - <varlistentry> - <term><parameter>win</parameter></term> - <listitem> - <para> - Specifies the window. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1><title>Description</title> - <para> - <function>XQueryWindowAccess</function> queries - <parameter>win</parameter> for its current access control - restriction settings. - </para> - <para> - The value of <parameter>rule_return</parameter> can be either - <constant>WindowAccessNoRule</constant> or - <constant>WindowAccessDenyAll</constant>. - </para> - <para> - If <parameter>nperm_return</parameter> is non-zero, - <parameter>permdevices_return</parameter> points to a list of - device IDs that are permitted access to the window. - </para> - <para> - If <parameter>ndeny_return</parameter> is non-zero, - <parameter>denydevices_return</parameter> points to a list of - device IDs that are denied access to the window. - </para> - <para> - It is the caller's responsibility to free the memory returned in - <parameter>permdevices_return</parameter> and - <parameter>denydevices_return</parameter>. - </para> - <para> - <function>XQueryWindowAccess</function> can generate a - <errorname>BadWindow</errorname> error. - </para> - </refsect1> - - <refsect1><title>Diagnosis</title> - <para> - <variablelist> - <varlistentry> - <term><errorname>BadWindow</errorname></term> - <listitem><para>A value for a Window argument does not - name a defined window. -</para></listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1><title>See also</title> - <para> - <function>XPermitDevices</function>, - <function>XDenyDevices</function>, - <function>XChangeAccessRule</function>, - <function>XWindowClearAcess</function> - </para> - </refsect1> -</refentry> - <refentry id="XiSelectEvent.man"> <refentryinfo> <productname>__vendorversion__</productname> |