curl/docs/cmdline-opts/progress-bar.d

c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Short: #
Long: progress-bar
Help: Display transfer progress as a bar
Category: verbose
Example: -# -O $URL
Added: 5.10
See-also: styled-output
Multi: boolean
Scope: global
---
Make curl display transfer progress as a simple progress bar instead of the
standard, more informational, meter.

This progress bar draws a single line of '#' characters across the screen and
shows a percentage if the transfer size is known. For transfers without a
known size, there will be space ship (-=o=-) that moves back and forth but
only while data is being transferred, with a set of flying hash sign symbols on
top.
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: first test version of a new man page generator kit See MANPAGE.md for the description of how this works. Each command line option is now described in a separate .d file. 2016-11-14 06:40:12 +08:00			`Short: #`
			`Long: progress-bar`
cmdline-docs: more options converted and fixed Now all options are in the new system. 2016-11-28 08:01:13 +08:00			`Help: Display transfer progress as a bar`
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: verbose`
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 $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: 5.10`
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: styled-output`
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`
docs/cmdline-opts: mark all global options gen.pl now outputs a generic explanations for them for each option Fixes #10566 Reported-by: u20221022 on github Closes #10584 2023-02-21 23:42:26 +08:00			`Scope: global`
cmdline-opts: first test version of a new man page generator kit See MANPAGE.md for the description of how this works. Each command line option is now described in a separate .d file. 2016-11-14 06:40:12 +08:00			`---`
			`Make curl display transfer progress as a simple progress bar instead of the`
			`standard, more informational, meter.`

			`This progress bar draws a single line of '#' characters across the screen and`
			`shows a percentage if the transfer size is known. For transfers without a`
progress-bar.d: update to match implementation ... since commit 993dd5651a6 Reported-by: Martin Dreher Bug: https://github.com/curl/curl/pull/2242#issuecomment-361059228 Closes #2271 2018-01-31 06:46:09 +08:00			`known size, there will be space ship (-=o=-) that moves back and forth but`
spelling fixes Detected using the `codespell` tool. Also contains one URL protocol upgrade. Closes https://github.com/curl/curl/pull/2334 2018-02-24 07:29:01 +08:00			`only while data is being transferred, with a set of flying hash sign symbols on`
progress-bar.d: update to match implementation ... since commit 993dd5651a6 Reported-by: Martin Dreher Bug: https://github.com/curl/curl/pull/2242#issuecomment-361059228 Closes #2271 2018-01-31 06:46:09 +08:00			`top.`