curl/docs/cmdline-opts/remote-name.d

c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: remote-name
Short: O
Help: Write output to a file named as the remote file
Category: important output
Example: -O https://example.com/filename
Added: 4.0
See-also: remote-name-all output-dir remote-header-name
Multi: append
---
Write output to a local file named like the remote file we get. (Only the file
part of the remote file is used, the path is cut off.)

The file will be saved in the current working directory. If you want the file
saved in a different directory, make sure you change the current working
directory before invoking curl with this option or use --output-dir.

The remote file name to use for saving is extracted from the given URL,
nothing else, and if it already exists it will be overwritten. If you want the
server to be able to choose the file name refer to --remote-header-name which
can be used in addition to this option. If the server chooses a file name and
that name already exists it will not be overwritten.

There is no URL decoding done on the file name. If it has %20 or other URL
encoded parts of the name, they will end up as-is as file name.

You may use this option as many times as the number of URLs you have.
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			`c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.`
			`SPDX-License-Identifier: curl`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00			`Long: remote-name`
			`Short: O`
			`Help: Write output to a file named as the remote file`
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: important output`
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: -O https://example.com/filename`
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.0`
remote-name.d: mention --output-dir plus add two see-alsos Closes #8945 2022-06-01 06:33:17 +08:00			`See-also: remote-name-all output-dir remote-header-name`
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: append`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00			`---`
			`Write output to a local file named like the remote file we get. (Only the file`
			`part of the remote file is used, the path is cut off.)`

			`The file will be saved in the current working directory. If you want the file`
			`saved in a different directory, make sure you change the current working`
remote-name.d: mention --output-dir plus add two see-alsos Closes #8945 2022-06-01 06:33:17 +08:00			`directory before invoking curl with this option or use --output-dir.`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00
			`The remote file name to use for saving is extracted from the given URL,`
			`nothing else, and if it already exists it will be overwritten. If you want the`
			`server to be able to choose the file name refer to --remote-header-name which`
			`can be used in addition to this option. If the server chooses a file name and`
			`that name already exists it will not be overwritten.`

			`There is no URL decoding done on the file name. If it has %20 or other URL`
			`encoded parts of the name, they will end up as-is as file name.`

			`You may use this option as many times as the number of URLs you have.`