share/man/man4/netrc.4

   1 '\" te
   2 .\"  Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH NETRC 4 "Aug 25, 2006"
   8 .SH NAME
   9 netrc \- file for ftp remote login data
  10 .SH DESCRIPTION
  11 .LP
  12 The \fB\&.netrc\fR file contains data for logging in to a remote host over the
  13 network for file transfers by \fBftp\fR(1). This file resides in the user's
  14 home directory on the machine initiating the file transfer. Its permissions
  15 should be set to disallow read access by group and others. See \fBchmod\fR(1).
  16 .sp
  17 .LP
  18 Tokens can be separated by \fBSPACE\fR, \fBTAB\fR, or \fBNEWLINE\fR characters.
  19 The following tokens are supported:
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fBaccount\fR \fIstring\fR\fR
  24 .ad
  25 .RS 19n
  26 Supply an additional account password. If this token is present, the auto-login
  27 process supplies the specified string if the remote server requires an
  28 additional account password. If the remote server does not require an
  29 additional account password, the auto-login process initiates an \fBACCT\fR
  30 command.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fBdefault\fR\fR
  37 .ad
  38 .RS 19n
  39 Same as \fBmachine\fR \fIname\fR, except that default matches any name. There
  40 can be only one \fBdefault\fR token, and it must be after all \fBmachine\fR
  41 tokens. The \fBdefault\fR token is normally used as follows:
  42 .sp
  43 .in +2
  44 .nf
  45 default login anonymous password \fIuser\fR@\fIsite\fR
  46 .fi
  47 .in -2
  48 .sp
  49
  50 Such an entry gives the user automatic anonymous \fBftp\fR login to machines
  51 not specified in \fB\&.netrc\fR.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBlogin\fR \fIname\fR\fR
  58 .ad
  59 .RS 19n
  60 Identify a user on the remote machine. If this token is present, the auto-login
  61 process initiates a login using the specified name.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBmachine\fR \fIname\fR\fR
  68 .ad
  69 .RS 19n
  70 Identify a remote machine name. The auto-login process searches the
  71 \fB\&.netrc\fR file for a \fBmachine\fR token that matches the remote machine
  72 specified on the \fBftp\fR command line or as an \fBopen\fR command argument.
  73 Once a match is made, the subsequent \fB\&.netrc\fR tokens are processed,
  74 stopping when the \fBEOF\fR is reached or another \fBmachine\fR token is
  75 encountered.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBmacdef\fR \fIname\fR\fR
  82 .ad
  83 .RS 19n
  84 Define a macro. This token functions the same as \fBftp\fR \fBmacdef\fR. A
  85 macro is defined with the specified name; its contents begin with the next
  86 \fB\&.netrc\fR line and continue until a null line (consecutive \fBNEWLINE\fR
  87 characters) is encountered. If a macro named \fBinit\fR is defined, it is
  88 automatically executed as the last step in the auto-login process.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBpassword\fR \fIstring\fR\fR
  95 .ad
  96 .RS 19n
  97 Supply a password. If this token is present, the auto-login process supplies
  98 the specified string if the remote server requires a password as part of the
  99 login process. If this token is present in the \fB\&.netrc\fR file, \fBftp\fR
 100 aborts the auto-login process if the \fB\&.netrc\fR is readable by anyone
 101 besides the user.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBskipsyst\fR\fR
 108 .ad
 109 .RS 19n
 110 Skip the \fBSYST\fR command that is sent by default to all remote servers upon
 111 connection. The system command is what enables the automatic use of binary mode
 112 rather than the protocol default ascii mode.
 113 .sp
 114 As some older servers cannot handle the \fBftp\fR command, this directive is
 115 provided to allow inter-operability with these servers.
 116 .RE
 117
 118 .SH EXAMPLES
 119 .LP
 120 \fBExample 1 \fRA Sample \fB\&.netrc\fR File
 121 .sp
 122 .LP
 123 A \fB\&.netrc\fR file containing the following line:
 124
 125 .sp
 126 .in +2
 127 .nf
 128 machine ray login demo password mypassword
 129 .fi
 130 .in -2
 131
 132 .sp
 133 .LP
 134 allows an autologin to the machine \fBray\fR using the login name \fBdemo\fR
 135 with password \fBmypassword\fR.
 136
 137 .SH FILES
 138 .ne 2
 139 .na
 140 \fB\fB~/.netrc\fR\fR
 141 .ad
 142 .RS 12n
 143
 144 .RE
 145
 146 .SH SEE ALSO
 147 .LP
 148 \fBchmod\fR(1), \fBftp\fR(1)