curl/docs/cmdline-opts/netrc.d

c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: netrc
Short: n
Help: Must read .netrc for user name and password
Category: curl
Example: --netrc $URL
Added: 4.6
See-also: netrc-file config user
Mutexed: netrc-file netrc-optional
Multi: boolean
---
Makes curl scan the *.netrc* (*_netrc* on Windows) 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.

A quick and simple example of how to setup a *.netrc* to allow curl to FTP to
the machine host.domain.com with user name 'myself' and password 'secret'
could look similar to:

 machine host.domain.com
 login myself
 password secret
copyright: update all copyright lines and remove year ranges - they are mostly pointless in all major jurisdictions - many big corporations and projects already don't use them - saves us from pointless churn - git keeps history for us - the year range is kept in COPYING checksrc is updated to allow non-year using copyright statements Closes #10205 2023-01-02 20:51:48 +08:00			`c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.`
docs/cmdline-opts: add copyright and license identifier to each file gen.pl now insists on C: and SPDX-License-Identifier: fields to be present in all files. Closes #9002 2022-06-14 06:12:03 +08:00			`SPDX-License-Identifier: curl`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00			`Long: netrc`
			`Short: n`
			`Help: Must read .netrc for user name and password`
docs: add categories to all cmdline opts Adapted gen.pl with 'listcats' This commit is a part of "--help me if you can" Closes #5680 2020-07-13 20:15:04 +08:00			`Category: curl`
curl.1: provide examples for each option The file format for each option now features a "Example:" header that can provide one or more examples that get rendered appropriately in the output. All options MUST have at least one example or gen.pl complains at build-time. This fix also does a few other minor format and consistency cleanups. Closes #7654 2021-08-31 22:37:14 +08:00			`Example: --netrc $URL`
cmdline-opts: made the 'Added:' field mandatory Since "too old" versions are no longer included in the generated man page, this field is now mandatory so that it won't be forgotten and then not included in the documentation. Closes #7786 2021-09-28 17:50:07 +08:00			`Added: 4.6`
curl.1: require "see also" for every documented option gen.pl now generates a warning if the "See Also" field is not filled in for a command line option All command line options now provide one or more related options. 167 "See alsos" added! Closes #8019 2021-11-15 22:58:20 +08:00			`See-also: netrc-file config user`
netrc.d: provide mutext info Reported-by: xianghongai on github Fixes #9899 Closes #9901 2022-11-14 06:14:38 +08:00			`Mutexed: netrc-file netrc-optional`
cmdline/docs: add a required 'multi' keyword for each option The keyword specifies how option works when specified multiple times: - single: the last provided value replaces the earlier ones - append: it supports being provided multiple times - boolean: on/off values - mutex: flag-like option that disable anoter flag The 'gen.pl' script then outputs the proper and unified language for each option's multi-use behavior in the generated man page. The multi: header is requires in each .d file and will cause build error if missing or set to an unknown value. Closes #9759 2022-10-18 16:39:43 +08:00			`Multi: boolean`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00			`---`
docs: make gen.pl support italic and bold Remove some nroffisms from the cmdline doc files to simplify editing, and instead support this markdown style. Closes #6771 2021-03-22 23:50:57 +08:00			`Makes curl scan the .netrc (_netrc on Windows) file in the user's home`
			`directory for login name and password. This is typically used for FTP on`
cmdline-docs: use present tense, not future + some smaller cleanups Closes #11821 2023-09-08 20:32:29 +08:00			`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.`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00
docs: reduce use of "very" "Very" should be avoided in most texts. If intensifiers are needed, try find better words instead. Closes #7936 2021-11-01 20:43:11 +08:00			`A quick and simple example of how to setup a .netrc to allow curl to FTP to`
docs/cmdline-opts: remove \& escapes from all .d files gen.pl escapes them itself now 2022-08-23 19:42:49 +08:00			`the machine host.domain.com with user name 'myself' and password 'secret'`
netrc.d: edit the .netrc example to look nicer Works nicely thanks to d1828b470f43d Closes #8025 2021-11-16 21:58:36 +08:00			`could look similar to:`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00
netrc.d: edit the .netrc example to look nicer Works nicely thanks to d1828b470f43d Closes #8025 2021-11-16 21:58:36 +08:00			`machine host.domain.com`
			`login myself`
netrc.d: remove spurious quote Closes #9111 2022-07-06 15:45:07 +08:00			`password secret`