curl/docs/cmdline-opts/netrc.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

39 lines
1.1 KiB
Markdown
Raw Normal View History

---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
2016-11-16 21:20:36 +08:00
Long: netrc
Short: n
Help: Must read .netrc for username and password
Category: curl
Added: 4.6
Mutexed: netrc-file netrc-optional
Multi: boolean
See-also:
- netrc-file
- config
- user
Example:
- --netrc $URL
2016-11-16 21:20:36 +08:00
---
# `--netrc`
Makes curl scan the *.netrc* file in the user's home directory for login name
and password. This is typically used for FTP on Unix. If used with HTTP, curl
enables user authentication. See *netrc(5)* and *ftp(1)* for details on the
file format. Curl does not complain if that file does not have the right
permissions (it should be neither world- nor group-readable). The environment
variable "HOME" is used to find the home directory.
On Windows two filenames in the home directory are checked: *.netrc* and
*_netrc*, preferring the former. Older versions on Windows checked for *_netrc*
only.
2016-11-16 21:20:36 +08:00
A quick and simple example of how to setup a *.netrc* to allow curl to FTP to
the machine host.domain.com with username 'myself' and password 'secret' could
look similar to:
2016-11-16 21:20:36 +08:00
machine host.domain.com
login myself
password secret