home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _d57f24e22ed12450d7d785a064de61e4 < prev    next >
Text File  |  2000-03-23  |  5KB  |  136 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>X11::Auth - Perl module to read X11 authority files</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> X11::Auth - Perl module to read X11 authority files</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#methods">METHODS</A></LI>
  26.     <UL>
  27.  
  28.         <LI><A HREF="#new">new</A></LI>
  29.         <LI><A HREF="#get_one">get_one</A></LI>
  30.         <LI><A HREF="#get_all">get_all</A></LI>
  31.         <LI><A HREF="#get_by_host">get_by_host</A></LI>
  32.     </UL>
  33.  
  34.     <LI><A HREF="#compatibility">COMPATIBILITY</A></LI>
  35.     <LI><A HREF="#author">AUTHOR</A></LI>
  36.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  37. </UL>
  38. <!-- INDEX END -->
  39.  
  40. <HR>
  41. <P>
  42. <H1><A NAME="name">NAME</A></H1>
  43. <P>X11::Auth - Perl module to read X11 authority files</P>
  44. <P>
  45. <HR>
  46. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  47. <UL>
  48. <LI>Linux</LI>
  49. <LI>Solaris</LI>
  50. </UL>
  51. <HR>
  52. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  53. <PRE>
  54.   require X11::Auth;
  55.   $a = new X11::Auth;
  56.   ($auth_type, $auth_data) = $a->get_by_host($host, $disp_num);</PRE>
  57. <P>
  58. <HR>
  59. <H1><A NAME="description">DESCRIPTION</A></H1>
  60. <P>This module is an approximate perl replacement for the libXau C library
  61. and the <CODE>xauth(1)</CODE> program. It reads and interprets the files (usually
  62. '~/.Xauthority') that hold authorization data used in connecting to
  63. X servers. Since it was written mainly for the use of X11::Protocol,
  64. its functionality is currently restricted to reading, not writing, of
  65. these files.</P>
  66. <P>
  67. <HR>
  68. <H1><A NAME="methods">METHODS</A></H1>
  69. <P>
  70. <H2><A NAME="new">new</A></H2>
  71. <PRE>
  72.   $auth = X11::Auth->new;
  73.   $auth = X11::Auth->open($filename);</PRE>
  74. <P>Open an authority file, and create an object to handle it. The filename
  75. will be taken from the XAUTHORITY environment variable, if present, or
  76. '.Xauthority' in the user's home directory, or it may be overridden by
  77. an argument. 'open' may be used as a synonym.</P>
  78. <P>
  79. <H2><A NAME="get_one">get_one</A></H2>
  80. <PRE>
  81.   ($family, $host_addr, $display_num, $auth_name, $auth_data)
  82.      = $auth->get_one;</PRE>
  83. <P>Read one entry from the file. Returns a null list at end of file.
  84. $family is usually 'Internet' or 'Local', and $display_num can
  85. be any string.</P>
  86. <P>
  87. <H2><A NAME="get_all">get_all</A></H2>
  88. <PRE>
  89.   @auth_data = $auth->get_all;</PRE>
  90. <P>Read all of the entries in the file. Each member of the array returned
  91. is an array ref similar to the list returned by get_one().</P>
  92. <P>
  93. <H2><A NAME="get_by_host">get_by_host</A></H2>
  94. <PRE>
  95.   ($auth_name, $auth_data)
  96.      = $auth->get_by_host($host, $family, $display_num);</PRE>
  97. <P>Get authentication data for a connection of type $family to display
  98. $display_num on $host. If $family is 'Internet', the host will be
  99. translated into an appropriate address by gethostbyname().</P>
  100. <P>
  101. <HR>
  102. <H1><A NAME="compatibility">COMPATIBILITY</A></H1>
  103. <P>The following table shows the (rough) correspondence between libXau
  104. calls and X11::Auth methods:</P>
  105. <PRE>
  106.   libXau                     X11::Auth
  107.   ------                     ---------
  108.   XauFileName                $ENV{XAUTHORITY}
  109.                              || "$ENV{HOME}/.Xauthority"
  110.   fopen(XauFileName(), "rb") $auth = new X11::Auth
  111.   XauReadAuth                $auth->get_one
  112.   XauWriteAuth
  113.   XauGetAuthByAddr           $auth->get_by_host
  114.   XauGetBestAuthByAddr 
  115.   XauLockAuth
  116.   XauUnlockAuth
  117.   XauDisposeAuth</PRE>
  118. <P>
  119. <HR>
  120. <H1><A NAME="author">AUTHOR</A></H1>
  121. <P>Stephen McCamant <<A HREF="mailto:alias@mcs.com">alias@mcs.com</A>></P>
  122. <P>
  123. <HR>
  124. <H1><A NAME="see also">SEE ALSO</A></H1>
  125. <P><EM>perl(1)</EM>, <A HREF="../../../site/lib/X11/Protocol.html">the X11::Protocol manpage</A>, <EM>Xau(3)</EM>, <EM>xauth(1)</EM>,
  126. lib/Xau/README in the X11 source distribution.</P>
  127. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  128. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  129. <STRONG><P CLASS=block> X11::Auth - Perl module to read X11 authority files</P></STRONG>
  130. </TD></TR>
  131. </TABLE>
  132.  
  133. </BODY>
  134.  
  135. </HTML>
  136.