From a90d1809cfe2704a04761a601b0b40244a2d7f46 Mon Sep 17 00:00:00 2001
From: Thorsten Kukuk <kukuk@thkukuk.de>
Date: Mon, 7 Jan 2008 14:30:37 +0000
Subject: Relevant BUGIDs:

Purpose of commit: cleanup

Commit summary:
---------------

2008-01-07  Thorsten Kukuk <kukuk@thkukuk.de>

        * po/it.po: Fix typos.
        * po/de.po: Few new translations.
        * po/POTFILES.in: Add pam_tty_audit.c and passverify.c.
        * doc/man/pam_xauth_data.3.xml: Added to CVS.
        * doc/man/pam_xauth_data.3: Likewise.
        * modules/pam_tty_audit/README: Likewise.
        * modules/pam_tty_audit/pam_tty_audit.8: Likewise.
---
 doc/man/pam_xauth_data.3     | 70 +++++++++++++++++++++++++++++++++
 doc/man/pam_xauth_data.3.xml | 94 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 164 insertions(+)
 create mode 100644 doc/man/pam_xauth_data.3
 create mode 100644 doc/man/pam_xauth_data.3.xml

(limited to 'doc')

diff --git a/doc/man/pam_xauth_data.3 b/doc/man/pam_xauth_data.3
new file mode 100644
index 00000000..49f9c9ec
--- /dev/null
+++ b/doc/man/pam_xauth_data.3
@@ -0,0 +1,70 @@
+.\"     Title: pam_xauth_data
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
+.\"      Date: 01/07/2008
+.\"    Manual: Linux-PAM Manual
+.\"    Source: Linux-PAM Manual
+.\"
+.TH "PAM_XAUTH_DATA" "3" "01/07/2008" "Linux-PAM Manual" "Linux-PAM Manual"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+pam_xauth_data - structure containing X authentication data
+.SH "SYNOPSIS"
+.sp
+.ft B
+.nf
+#include <security/pam_appl\.h>
+.fi
+.ft
+.sp
+.RS 4
+.nf
+struct pam_xauth_data {
+    int namelen;
+    char *name;
+    int datalen;
+    char *data;
+};
+    
+.fi
+.RE
+.SH "DESCRIPTION"
+.PP
+The
+\fBpam_xauth_data\fR
+structure contains X authentication data used to make a connection to an X display\. Using this mechanism, an application can communicate X authentication data to PAM service modules\. This allows modules to make a connection to the user\'s X display in order to label the user\'s session on login, display visual feedback or for other purposes\.
+.PP
+The
+\fIname\fR
+field contains the name of the authentication method, such as "MIT\-MAGIC\-COOKIE\-1"\. The
+\fInamelen\fR
+field contains the length of this string, not including the trailing NUL character\.
+.PP
+The
+\fIdata\fR
+field contains the authentication method\-specific data corresponding to the specified name\. The
+\fIdatalen\fR
+field contains its length in bytes\.
+.PP
+The X authentication data can be changed with the
+\fIPAM_XAUTH_DATA\fR
+item\. It can be queried and set with
+\fBpam_get_item\fR(3)
+and
+\fBpam_set_item \fR(3)
+respectively\. The value used to set it should be a pointer to a pam_xauth_data structure\. An internal copy of both the structure itself and its fields is made by PAM when setting the item\.
+.SH "SEE ALSO"
+.PP
+
+\fBpam_start\fR(3),
+\fBpam_get_item\fR(3),
+.SH "STANDARDS"
+.PP
+The
+\fBpam_xauth_data\fR
+structure and
+\fIPAM_XAUTH_DATA\fR
+item are Linux\-PAM extensions\.
diff --git a/doc/man/pam_xauth_data.3.xml b/doc/man/pam_xauth_data.3.xml
new file mode 100644
index 00000000..0cd6730b
--- /dev/null
+++ b/doc/man/pam_xauth_data.3.xml
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+
+<refentry id="pam_xauth_data">
+
+  <refmeta>
+    <refentrytitle>pam_xauth_data</refentrytitle>
+    <manvolnum>3</manvolnum>
+    <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
+  </refmeta>
+
+  <refnamediv id="pam_xauth_data-name">
+    <refname>pam_xauth_data</refname>
+    <refpurpose>structure containing X authentication data</refpurpose>
+  </refnamediv>
+
+<!-- body begins here -->
+
+  <refsynopsisdiv>
+    <funcsynopsis id="pam_xauth_data-synopsis">
+      <funcsynopsisinfo>#include &lt;security/pam_appl.h&gt;</funcsynopsisinfo>
+    </funcsynopsis>
+    <programlisting>
+struct pam_xauth_data {
+    int namelen;
+    char *name;
+    int datalen;
+    char *data;
+};
+    </programlisting>
+  </refsynopsisdiv>
+
+  <refsect1 id='pam_xauth_data-description'>
+    <title>DESCRIPTION</title>
+    <para>
+      The <function>pam_xauth_data</function> structure contains X
+      authentication data used to make a connection to an X display.  
+      Using this mechanism, an application can communicate X
+      authentication data to PAM service modules.  This allows modules to
+      make a connection to the user's X display in order to label the
+      user's session on login, display visual feedback or for other
+      purposes.
+    </para>
+    <para>
+      The <emphasis>name</emphasis> field contains the name of the
+      authentication method, such as "MIT-MAGIC-COOKIE-1".  The
+      <emphasis>namelen</emphasis> field contains the length of this string,
+      not including the trailing NUL character.
+    </para>
+    <para>
+      The <emphasis>data</emphasis> field contains the authentication
+      method-specific data corresponding to the specified name.  The
+      <emphasis>datalen</emphasis> field contains its length in bytes.
+    </para>
+    <para>
+      The X authentication data can be changed with the
+      <emphasis>PAM_XAUTH_DATA</emphasis> item. It can be queried and
+      set with
+      <citerefentry>
+        <refentrytitle>pam_get_item</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>
+      and
+      <citerefentry>
+        <refentrytitle>pam_set_item </refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>  respectively.  The value used to set it should be
+      a pointer to a pam_xauth_data structure.  An internal copy of both
+      the structure itself and its fields is made by PAM when setting the
+      item.
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_xauth_data-see_also'>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+        <refentrytitle>pam_start</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>pam_get_item</refentrytitle><manvolnum>3</manvolnum>
+      </citerefentry>,
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_xauth_data-standards'>
+    <title>STANDARDS</title>
+    <para>
+      The <function>pam_xauth_data</function> structure and
+      <emphasis>PAM_XAUTH_DATA</emphasis> item are
+      Linux-PAM extensions.
+    </para>
+  </refsect1>
+
+</refentry>
-- 
cgit v1.2.3