.TH "KIO::NetRC" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIO::NetRC \- A Singleton class that provides access to passwords stored in .netrc files for automatic login purposes. An interface to the ftp .netrc files.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <authinfo.h>\fP
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBLookUpMode\fP { \fBexactOnly\fP =  0x0002, \fBdefaultOnly\fP =  0x0004, \fBpresetOnly\fP =  0x0008 }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "bool \fBlookup\fP (const \fBKURL\fP &url, \fBAutoLogin\fP &login, bool userealnetrc=false, \fBQString\fP type=QString::null, int mode=(exactOnly|defaultOnly))"
.br
.ti -1c
.RI "void \fBreload\fP ()"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBNetRC\fP * \fBself\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBQString\fP \fBextract\fP (const char *, const char *, int &)"
.br
.ti -1c
.RI "int \fBopenf\fP (const \fBQString\fP &)"
.br
.ti -1c
.RI "bool \fBparse\fP (int)"
.br
.in -1c
.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBAutoLogin\fP"
.br
.RI "\fIContains auto login information. \fP"
.in -1c
.SH "Detailed Description"
.PP 
A Singleton class that provides access to passwords stored in .netrc files for automatic login purposes. An interface to the ftp .netrc files. 

This is only meant to address backward compatability with old automated ftp client style logins...
.PP
\fBAuthor:\fP
.RS 4
Dawit Alemayehu <adawit@kde.org> 
.RE
.PP

.PP
Definition at line 240 of file authinfo.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKIO::NetRC::LookUpMode\fP"
.PP
Specifies the mode to be used when searching for a matching automatic login info for a given site :. 
.PP
.PD 0
.IP "\(bu" 2
exactOnly search entries with exact host name matches. 
.IP "\(bu" 2
defaultOnly search entries that are specified as 'default'. 
.IP "\(bu" 2
presetOnly search entries that are specified as 'preset'.
.PP
\fBSee also:\fP
.RS 4
\fBlookup\fP 
.RE
.PP

.PP
Definition at line 254 of file authinfo.h.
.SH "Member Function Documentation"
.PP 
.SS "\fBNetRC\fP * NetRC::self ()\fC [static]\fP"
.PP
A reference to the instance of the class. 
.PP
\fBReturns:\fP
.RS 4
the class 
.RE
.PP

.PP
Definition at line 115 of file authinfo.cpp.
.SS "bool NetRC::lookup (const \fBKURL\fP & url, \fBAutoLogin\fP & login, bool userealnetrc = \fCfalse\fP, \fBQString\fP type = \fCQString::null\fP, int mode = \fC(exactOnly|defaultOnly)\fP)"
.PP
Looks up the \fClogin\fP information for the given \fCurl\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the url whose login information will be checked 
.br
\fIlogin\fP the login information will be writte here 
.br
\fIuserealnetrc\fP if true, use $HOME/.netrc fle 
.br
\fItype\fP the type of the login. If null, the \fCurl's\fP protocol will be taken 
.br
\fImode\fP the LookUpMode flags (ORed) for the query 
.RE
.PP

.PP
Definition at line 122 of file authinfo.cpp.
.PP
References QValueList::begin(), QMap::clear(), QMap::contains(), QValueList::end(), QDir::homeDirPath(), QValueList::isEmpty(), QMap::isEmpty(), QString::isEmpty(), locateLocal(), KIO::NetRC::AutoLogin::login, KIO::NetRC::AutoLogin::macdef, KIO::NetRC::AutoLogin::machine, KIO::NetRC::AutoLogin::password, QDir::separator(), and KIO::NetRC::AutoLogin::type.
.SS "void KIO::NetRC::reload ()\fC [inline]\fP"
.PP
Reloads the auto login information. 
.PP
Definition at line 297 of file authinfo.h.

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
