Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
2 | .\" | |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
5 | .de Sh \" Subsection heading | |
6 | .br | |
7 | .if t .Sp | |
8 | .ne 5 | |
9 | .PP | |
10 | \fB\\$1\fR | |
11 | .PP | |
12 | .. | |
13 | .de Sp \" Vertical space (when we can't use .PP) | |
14 | .if t .sp .5v | |
15 | .if n .sp | |
16 | .. | |
17 | .de Vb \" Begin verbatim text | |
18 | .ft CW | |
19 | .nf | |
20 | .ne \\$1 | |
21 | .. | |
22 | .de Ve \" End verbatim text | |
23 | .ft R | |
24 | .fi | |
25 | .. | |
26 | .\" Set up some character translations and predefined strings. \*(-- will | |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a | |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to | |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' | |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. | |
32 | .tr \(*W-|\(bv\*(Tr | |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
34 | .ie n \{\ | |
35 | . ds -- \(*W- | |
36 | . ds PI pi | |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
39 | . ds L" "" | |
40 | . ds R" "" | |
41 | . ds C` "" | |
42 | . ds C' "" | |
43 | 'br\} | |
44 | .el\{\ | |
45 | . ds -- \|\(em\| | |
46 | . ds PI \(*p | |
47 | . ds L" `` | |
48 | . ds R" '' | |
49 | 'br\} | |
50 | .\" | |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
54 | .\" output yourself in some meaningful fashion. | |
55 | .if \nF \{\ | |
56 | . de IX | |
57 | . tm Index:\\$1\t\\n%\t"\\$2" | |
58 | .. | |
59 | . nr % 0 | |
60 | . rr F | |
61 | .\} | |
62 | .\" | |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes | |
64 | .\" way too many mistakes in technical documents. | |
65 | .hy 0 | |
66 | .if n .na | |
67 | .\" | |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
70 | . \" fudge factors for nroff and troff | |
71 | .if n \{\ | |
72 | . ds #H 0 | |
73 | . ds #V .8m | |
74 | . ds #F .3m | |
75 | . ds #[ \f1 | |
76 | . ds #] \fP | |
77 | .\} | |
78 | .if t \{\ | |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
80 | . ds #V .6m | |
81 | . ds #F 0 | |
82 | . ds #[ \& | |
83 | . ds #] \& | |
84 | .\} | |
85 | . \" simple accents for nroff and troff | |
86 | .if n \{\ | |
87 | . ds ' \& | |
88 | . ds ` \& | |
89 | . ds ^ \& | |
90 | . ds , \& | |
91 | . ds ~ ~ | |
92 | . ds / | |
93 | .\} | |
94 | .if t \{\ | |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
101 | .\} | |
102 | . \" troff and (daisy-wheel) nroff accents | |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
110 | .ds ae a\h'-(\w'a'u*4/10)'e | |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
112 | . \" corrections for vroff | |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
115 | . \" for low resolution devices (crt and lpr) | |
116 | .if \n(.H>23 .if \n(.V>19 \ | |
117 | \{\ | |
118 | . ds : e | |
119 | . ds 8 ss | |
120 | . ds o a | |
121 | . ds d- d\h'-1'\(ga | |
122 | . ds D- D\h'-1'\(hy | |
123 | . ds th \o'bp' | |
124 | . ds Th \o'LP' | |
125 | . ds ae ae | |
126 | . ds Ae AE | |
127 | .\} | |
128 | .rm #[ #] #H #V #F C | |
129 | .\" ======================================================================== | |
130 | .\" | |
131 | .IX Title "Net::Netrc 3" | |
132 | .TH Net::Netrc 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide" | |
133 | .SH "NAME" | |
134 | Net::Netrc \- OO interface to users netrc file | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | .Vb 1 | |
138 | \& use Net::Netrc; | |
139 | .Ve | |
140 | .PP | |
141 | .Vb 3 | |
142 | \& $mach = Net::Netrc->lookup('some.machine'); | |
143 | \& $login = $mach->login; | |
144 | \& ($login, $password, $account) = $mach->lpa; | |
145 | .Ve | |
146 | .SH "DESCRIPTION" | |
147 | .IX Header "DESCRIPTION" | |
148 | \&\f(CW\*(C`Net::Netrc\*(C'\fR is a class implementing a simple interface to the .netrc file | |
149 | used as by the ftp program. | |
150 | .PP | |
151 | \&\f(CW\*(C`Net::Netrc\*(C'\fR also implements security checks just like the ftp program, | |
152 | these checks are, first that the .netrc file must be owned by the user and | |
153 | second the ownership permissions should be such that only the owner has | |
154 | read and write access. If these conditions are not met then a warning is | |
155 | output and the .netrc file is not read. | |
156 | .SH "THE .netrc FILE" | |
157 | .IX Header "THE .netrc FILE" | |
158 | The .netrc file contains login and initialization information used by the | |
159 | auto-login process. It resides in the user's home directory. The following | |
160 | tokens are recognized; they may be separated by spaces, tabs, or new\-lines: | |
161 | .IP "machine name" 4 | |
162 | .IX Item "machine name" | |
163 | Identify a remote machine name. The auto-login process searches | |
164 | the .netrc file for a machine token that matches the remote machine | |
165 | specified. Once a match is made, the subsequent .netrc tokens | |
166 | are processed, stopping when the end of file is reached or an\- | |
167 | other machine or a default token is encountered. | |
168 | .IP "default" 4 | |
169 | .IX Item "default" | |
170 | This is the same as machine name except that default matches | |
171 | any name. There can be only one default token, and it must be | |
172 | after all machine tokens. This is normally used as: | |
173 | .Sp | |
174 | .Vb 1 | |
175 | \& default login anonymous password user@site | |
176 | .Ve | |
177 | .Sp | |
178 | thereby giving the user automatic anonymous login to machines | |
179 | not specified in .netrc. | |
180 | .IP "login name" 4 | |
181 | .IX Item "login name" | |
182 | Identify a user on the remote machine. If this token is present, | |
183 | the auto-login process will initiate a login using the | |
184 | specified name. | |
185 | .IP "password string" 4 | |
186 | .IX Item "password string" | |
187 | Supply a password. If this token is present, the auto-login | |
188 | process will supply the specified string if the remote server | |
189 | requires a password as part of the login process. | |
190 | .IP "account string" 4 | |
191 | .IX Item "account string" | |
192 | Supply an additional account password. If this token is present, | |
193 | the auto-login process will supply the specified string | |
194 | if the remote server requires an additional account password. | |
195 | .IP "macdef name" 4 | |
196 | .IX Item "macdef name" | |
197 | Define a macro. \f(CW\*(C`Net::Netrc\*(C'\fR only parses this field to be compatible | |
198 | with \fIftp\fR. | |
199 | .SH "CONSTRUCTOR" | |
200 | .IX Header "CONSTRUCTOR" | |
201 | The constructor for a \f(CW\*(C`Net::Netrc\*(C'\fR object is not called new as it does not | |
202 | really create a new object. But instead is called \f(CW\*(C`lookup\*(C'\fR as this is | |
203 | essentially what it does. | |
204 | .IP "lookup ( \s-1MACHINE\s0 [, \s-1LOGIN\s0 ])" 4 | |
205 | .IX Item "lookup ( MACHINE [, LOGIN ])" | |
206 | Lookup and return a reference to the entry for \f(CW\*(C`MACHINE\*(C'\fR. If \f(CW\*(C`LOGIN\*(C'\fR is given | |
207 | then the entry returned will have the given login. If \f(CW\*(C`LOGIN\*(C'\fR is not given then | |
208 | the first entry in the .netrc file for \f(CW\*(C`MACHINE\*(C'\fR will be returned. | |
209 | .Sp | |
210 | If a matching entry cannot be found, and a default entry exists, then a | |
211 | reference to the default entry is returned. | |
212 | .Sp | |
213 | If there is no matching entry found and there is no default defined, or | |
214 | no .netrc file is found, then \f(CW\*(C`undef\*(C'\fR is returned. | |
215 | .SH "METHODS" | |
216 | .IX Header "METHODS" | |
217 | .IP "login ()" 4 | |
218 | .IX Item "login ()" | |
219 | Return the login id for the netrc entry | |
220 | .IP "password ()" 4 | |
221 | .IX Item "password ()" | |
222 | Return the password for the netrc entry | |
223 | .IP "account ()" 4 | |
224 | .IX Item "account ()" | |
225 | Return the account information for the netrc entry | |
226 | .IP "lpa ()" 4 | |
227 | .IX Item "lpa ()" | |
228 | Return a list of login, password and account information fir the netrc entry | |
229 | .SH "AUTHOR" | |
230 | .IX Header "AUTHOR" | |
231 | Graham Barr <gbarr@pobox.com> | |
232 | .SH "SEE ALSO" | |
233 | .IX Header "SEE ALSO" | |
234 | Net::Netrc | |
235 | Net::Cmd | |
236 | .SH "COPYRIGHT" | |
237 | .IX Header "COPYRIGHT" | |
238 | Copyright (c) 1995\-1998 Graham Barr. All rights reserved. | |
239 | This program is free software; you can redistribute it and/or modify | |
240 | it under the same terms as Perl itself. | |
241 | .PP | |
242 | $Id: //depot/libnet/Net/Netrc.pm#13 $ |