curl/docs/cmdline-opts/pubkey.d

c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: pubkey
Arg: <key>
Protocols: SFTP SCP
Help: SSH Public key file name
Category: sftp scp auth
Example: --pubkey file.pub sftp://example.com/
Added: 7.16.2
See-also: pass
Multi: single
---
Public key file name. Allows you to provide your public key in this separate
file.

(As of 7.39.0, curl attempts to automatically extract the public key from the
private key file, so passing this option is generally not required. Note that
this public key extraction requires libcurl to be linked against a copy of
libssh2 1.2.8 or higher that is itself linked against OpenSSL.)
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-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`Long: pubkey`
			`Arg: <key>`
			`Protocols: SFTP SCP`
			`Help: SSH Public key file name`
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: sftp scp auth`
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: --pubkey file.pub sftp://example.com/`
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: 7.16.2`
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: pass`
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: single`
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`---`
			`Public key file name. Allows you to provide your public key in this separate`
			`file.`

			`(As of 7.39.0, curl attempts to automatically extract the public key from the`
			`private key file, so passing this option is generally not required. Note that`
			`this public key extraction requires libcurl to be linked against a copy of`
			`libssh2 1.2.8 or higher that is itself linked against OpenSSL.)`