netrc.md (1278B)
1 --- 2 c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 3 SPDX-License-Identifier: curl 4 Long: netrc 5 Short: n 6 Help: Must read .netrc for username and password 7 Category: auth 8 Added: 4.6 9 Mutexed: netrc-file netrc-optional 10 Multi: boolean 11 See-also: 12 - netrc-file 13 - config 14 - user 15 Example: 16 - --netrc $URL 17 --- 18 19 # `--netrc` 20 21 Make curl scan the *.netrc* file in the user's home directory for login name 22 and password. This is typically used for FTP on Unix. If used with HTTP, curl 23 enables user authentication. See *netrc(5)* and *ftp(1)* for details on the 24 file format. curl does not complain if that file does not have the right 25 permissions (it should be neither world- nor group-readable). The environment 26 variable "HOME" is used to find the home directory. 27 28 The netrc file provides credentials for a hostname independent of which 29 protocol and port number that are used. 30 31 On Windows two filenames in the home directory are checked: *.netrc* and 32 *_netrc*, preferring the former. Older versions on Windows checked for *_netrc* 33 only. 34 35 A quick and simple example of how to setup a *.netrc* to allow curl to FTP to 36 the machine host.example.com with username 'myself' and password 'secret' could 37 look similar to: 38 39 machine host.example.com 40 login myself 41 password secret