Subversion Repositories or1k

.\" Copyright (c) 1985, 1989, 1990 The Regents of the University of California.

.\" All rights reserved.

.\"

.\" Redistribution and use in source and binary forms, with or without

.\" modification, are permitted provided that the following conditions

.\" are met:

.\" 1. Redistributions of source code must retain the above copyright

.\"    notice, this list of conditions and the following disclaimer.

.\" 2. Redistributions in binary form must reproduce the above copyright

.\"    notice, this list of conditions and the following disclaimer in the

.\"    documentation and/or other materials provided with the distribution.

.\" 3. All advertising materials mentioning features or use of this software

.\"    must display the following acknowledgement:

.\"     This product includes software developed by the University of

.\"     California, Berkeley and its contributors.

.\" 4. Neither the name of the University nor the names of its contributors

.\"    may be used to endorse or promote products derived from this software

.\"    without specific prior written permission.

.\"

.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND

.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE

.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

.\" SUCH DAMAGE.

.\"

.\"     from: @(#)ftp.1 6.18 (Berkeley) 7/30/91

.\"     from: ftp.1,v 1.2 1997/06/08 20:01:35 dholland Exp

.\"     $Id: netrc.5,v 1.1 2002-03-25 22:32:01 simons Exp $

.\"

.Dd September 23, 1997

.Dt NETRC 5

.Os "Linux NetKit (0.16)"

.Sh NAME

.Nm netrc, .netrc

.Nd user configuration for ftp

.Sh DESCRIPTION

This file contains configuration and autologin information for the

File Transfer Protocol client

.Xr ftp 1 .

.Pp

The

.Pa .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:

.Bl -tag -width password

.It Ic machine Ar name

Identify a remote machine

.Ar name .

The auto-login process searches the

.Pa .netrc

file for a

.Ic machine

token that matches the remote machine specified on the

.Nm ftp

command line or as an

.Ic open

command argument.

Once a match is made, the subsequent

.Pa .netrc

tokens are processed,

stopping when the end of file is reached or another

.Ic machine

or a

.Ic default

token is encountered.

.It Ic default

This is the same as

.Ic machine

.Ar name

except that

.Ic default

matches any name.

There can be only one

.Ic default

token, and it must be after all

.Ic machine

tokens.

This is normally used as:

.Pp

.Dl default login anonymous password user@site

.Pp

thereby giving the user

.Ar automatic

anonymous ftp login to

machines not specified in

.Pa .netrc .

This can be overridden

by using the

.Fl n

flag to disable auto-login.

.It Ic login Ar name

Identify a user on the remote machine.

If this token is present, the auto-login process will initiate

a login using the specified

.Ar name .

.It Ic password Ar 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.

Note that if this token is present in the

.Pa .netrc

file for any user other

than

.Ar anonymous  ,

.Nm ftp

will abort the auto-login process if the

.Pa .netrc

is readable by

anyone besides the user.

.It Ic account Ar 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, or the auto-login process will initiate an

.Dv ACCT

command if it does not.

.It Ic macdef Ar name

Define a macro.

This token functions like the

.Nm ftp

.Ic macdef

command functions.

A macro is defined with the specified name; its contents begin with the

next

.Pa .netrc

line and continue until a null line (consecutive new-line

characters) is encountered.

If a macro named

.Ic init

is defined, it is automatically executed as the last step in the

auto-login process.

.El

.Sh SEE ALSO

.Xr ftp 1 ,

.Xr ftpd 8