Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

I miss a list of all "global options" in the man page #10566

Closed
u20221022 opened this issue Feb 19, 2023 · 6 comments
Closed

I miss a list of all "global options" in the man page #10566

u20221022 opened this issue Feb 19, 2023 · 6 comments
Labels
cmdline tool documentation enhancement

Comments

@u20221022
Copy link

I did this

curl.exe --manual | FindStr /C:"Global options" /C:"--fail-early." /N
2686: the -:, --next instruction. Global options include -v, --ver-
2687: bose, --trace, --trace-ascii and --fail-early.

I expected the following

Full and clear list of global options in manual or (better) existence of distinctive prefixes in their names.

curl/libcurl version

7.88.0
[curl -V output]
curl 7.88.0 (x86_64-w64-mingw32) libcurl/7.88.0 OpenSSL/3.0.8 (Schannel) zlib/1.2.13 brotli/1.0.9 zstd/1.5.4 WinIDN libssh2/1.10.0 nghttp2/1.52.0 ngtcp2/0.13.1 nghttp3/0.8.0 libgsasl/2.2.0
Release-Date: 2023-02-15
Protocols: dict file ftp ftps gopher gophers http https imap imaps ldap ldaps mqtt pop3 pop3s rtsp scp sftp smb smbs smtp smtps telnet tftp ws wss
Features: alt-svc AsynchDNS brotli gsasl HSTS HTTP2 HTTP3 HTTPS-proxy IDN IPv6 Kerberos Largefile libz MultiSSL NTLM SPNEGO SSL SSPI threadsafe TLS-SRP UnixSockets zstd

operating system

MS Windows 10
@bagder bagder changed the title Global options I miss a list of all "global options" in the man page Feb 19, 2023
@bagder
Copy link
Member

bagder commented Feb 19, 2023

This is not a bug. Feel free to help extend the documentation.

@u20221022
Copy link
Author

u20221022 commented Feb 19, 2023 •
edited

Feel free to help extend the documentation.

How? Is this full list:
--fail-early/--no-fail-early
--libcurl <file>
--parallel-immediate/--no-parallel-immediate
--parallel-max <num>
-Z, --parallel/--no-parallel
-#, --progress-bar/--no-progress-bar
-S, --show-error/--no-show-error
--stderr <file>/--stderr -
--styled-output/--no-styled-output
--trace-ascii <file>/--trace-ascii -
--trace-time/--no-trace-time
--trace <file>/--trace -/--trace %
-v, --verbose/--no-verbose

I can not know it better than the developers.

@bagder
Copy link
Member

bagder commented Feb 19, 2023

I can not know it better than the developers.

We're all developers. This is an open source project and everyone is encouraged to help out.

@u20221022
Copy link
Author

u20221022 commented Feb 19, 2023 •
edited

We're all developers. This is an open source project and everyone is encouraged to help out.

Specifically, how can I help? I did create the list above. And what?
Update:
I prefere prefixes in global options names, but it impossible. The structure of cURL options is very chaotic.

@bagder
Copy link
Member

bagder commented Feb 20, 2023 •
edited

You can write the docs and provide a pull-request.

The list is helpful, but we also need to figure out how and where to present that list. We should probably describe the concept of global vs non-global options in association with that list.

The structure of cURL options is very chaotic.

They have been gradually and continuously developed and added over twenty-five years and we don't break existing behavior. It's a mighty difficult task.

@u20221022
Copy link
Author

u20221022 commented Feb 20, 2023 •
edited

You can write the docs and provide a pull-request.

I know English too poorly, so I cannot clearly explain why this action is unacceptable to me. Sorry.

The list is helpful

All this list – from «curl.exe --manual» only.
Update. Please, add to manual the explicit(!) list of options, that acting immediately: «--help», «--manual» and «--version». This behavior is not at all obvious.

the concept of global vs non-global options

Prefix «no-» for negative options already exist. What about prefix for global options? Any options may be convert to global in this way.

It's a mighty difficult task.

Of course.

bagder added a commit that referenced this issue Feb 21, 2023
@bagder
docs/cmdline-opts: list global options and include in page-header
66af374 
Fixes #10566
Asked-for-by: u20221022 on github
@bagder bagder closed this as completed in 86ec17b Feb 22, 2023
bch pushed a commit to bch/curl that referenced this issue Jul 19, 2023
@bagder @bch
docs/cmdline-opts: mark all global options
cde5891 
gen.pl now outputs a generic explanations for them for each option

Fixes curl#10566
Reported-by: u20221022 on github
Closes curl#10584
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cmdline tool documentation enhancement
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bagder @u20221022