1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::Netrc 3pm"
.TH Net::Netrc 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::Netrc \- OO interface to users netrc file
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use Net::Netrc;
\&
\& $mach = Net::Netrc\->lookup(\*(Aqsome.machine\*(Aq);
\& $login = $mach\->login;
\& ($login, $password, $account) = $mach\->lpa;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Net::Netrc\*(C'\fR is a class implementing a simple interface to the .netrc file
used as by the ftp program.
.PP
\&\f(CW\*(C`Net::Netrc\*(C'\fR also implements security checks just like the ftp program,
these checks are, first that the .netrc file must be owned by the user and
second the ownership permissions should be such that only the owner has
read and write access. If these conditions are not met then a warning is
output and the .netrc file is not read.
.SS "The \fI.netrc\fP File"
.IX Subsection "The .netrc File"
The .netrc file contains login and initialization information used by the
auto-login process. It resides in the user's home directory. The following
tokens are recognized; they may be separated by spaces, tabs, or new-lines:
.IP "machine name" 4
.IX Item "machine name"
Identify a remote machine name. The auto-login process searches
the .netrc file for a machine token that matches the remote machine
specified. Once a match is made, the subsequent .netrc tokens
are processed, stopping when the end of file is reached or an\-
other machine or a default token is encountered.
.IP default 4
.IX Item "default"
This is the same as machine name except that default matches
any name. There can be only one default token, and it must be
after all machine tokens. This is normally used as:
.Sp
.Vb 1
\& default login anonymous password user@site
.Ve
.Sp
thereby giving the user automatic anonymous login to machines
not specified in .netrc.
.IP "login name" 4
.IX Item "login name"
Identify a user on the remote machine. If this token is present,
the auto-login process will initiate a login using the
specified name.
.IP "password string" 4
.IX Item "password string"
Supply a password. If this token is present, the auto-login
process will supply the specified string if the remote server
requires a password as part of the login process.
.IP "account string" 4
.IX Item "account string"
Supply an additional account password. If this token is present,
the auto-login process will supply the specified string
if the remote server requires an additional account password.
.IP "macdef name" 4
.IX Item "macdef name"
Define a macro. \f(CW\*(C`Net::Netrc\*(C'\fR only parses this field to be compatible
with \fIftp\fR.
.SS "Class Methods"
.IX Subsection "Class Methods"
The constructor for a \f(CW\*(C`Net::Netrc\*(C'\fR object is not called new as it does not
really create a new object. But instead is called \f(CW\*(C`lookup\*(C'\fR as this is
essentially what it does.
.ie n .IP """lookup($machine[, $login])""" 4
.el .IP "\f(CWlookup($machine[, $login])\fR" 4
.IX Item "lookup($machine[, $login])"
Lookup and return a reference to the entry for \f(CW$machine\fR. If \f(CW$login\fR is given
then the entry returned will have the given login. If \f(CW$login\fR is not given then
the first entry in the .netrc file for \f(CW$machine\fR will be returned.
.Sp
If a matching entry cannot be found, and a default entry exists, then a
reference to the default entry is returned.
.Sp
If there is no matching entry found and there is no default defined, or
no .netrc file is found, then \f(CW\*(C`undef\*(C'\fR is returned.
.SS "Object Methods"
.IX Subsection "Object Methods"
.ie n .IP login() 4
.el .IP \f(CWlogin()\fR 4
.IX Item "login()"
Return the login id for the netrc entry
.ie n .IP password() 4
.el .IP \f(CWpassword()\fR 4
.IX Item "password()"
Return the password for the netrc entry
.ie n .IP account() 4
.el .IP \f(CWaccount()\fR 4
.IX Item "account()"
Return the account information for the netrc entry
.ie n .IP lpa() 4
.el .IP \f(CWlpa()\fR 4
.IX Item "lpa()"
Return a list of login, password and account information for the netrc entry
.SH EXPORTS
.IX Header "EXPORTS"
\&\fINone\fR.
.SH "KNOWN BUGS"
.IX Header "KNOWN BUGS"
See <https://rt.cpan.org/Dist/Display.html?Status=Active&Queue=libnet>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::Cmd.
.SH AUTHOR
.IX Header "AUTHOR"
Graham Barr <gbarr@pobox.com <mailto:gbarr@pobox.com>>.
.PP
Steve Hay <shay@cpan.org <mailto:shay@cpan.org>> is now maintaining
libnet as of version 1.22_02.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 1995\-1998 Graham Barr. All rights reserved.
.PP
Copyright (C) 2013\-2014, 2020 Steve Hay. All rights reserved.
.SH LICENCE
.IX Header "LICENCE"
This module is free software; you can redistribute it and/or modify it under the
same terms as Perl itself, i.e. under the terms of either the GNU General Public
License or the Artistic License, as specified in the \fILICENCE\fR file.
.SH VERSION
.IX Header "VERSION"
Version 3.15
.SH DATE
.IX Header "DATE"
20 March 2023
.SH HISTORY
.IX Header "HISTORY"
See the \fIChanges\fR file.
|
