xref: /aosp_15_r20/external/curl/docs/cmdline-opts/help.md (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker---
2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl
4*6236dae4SAndroid Build Coastguard WorkerLong: help
5*6236dae4SAndroid Build Coastguard WorkerArg: <subject>
6*6236dae4SAndroid Build Coastguard WorkerShort: h
7*6236dae4SAndroid Build Coastguard WorkerHelp: Get help for commands
8*6236dae4SAndroid Build Coastguard WorkerCategory: important curl
9*6236dae4SAndroid Build Coastguard WorkerAdded: 4.0
10*6236dae4SAndroid Build Coastguard WorkerMulti: custom
11*6236dae4SAndroid Build Coastguard WorkerSee-also:
12*6236dae4SAndroid Build Coastguard Worker  - verbose
13*6236dae4SAndroid Build Coastguard WorkerExample:
14*6236dae4SAndroid Build Coastguard Worker  - --help all
15*6236dae4SAndroid Build Coastguard Worker  - --help --insecure
16*6236dae4SAndroid Build Coastguard Worker  - --help -f
17*6236dae4SAndroid Build Coastguard Worker---
18*6236dae4SAndroid Build Coastguard Worker
19*6236dae4SAndroid Build Coastguard Worker# `--help`
20*6236dae4SAndroid Build Coastguard Worker
21*6236dae4SAndroid Build Coastguard WorkerUsage help. Provide help for the subject given as an optional argument.
22*6236dae4SAndroid Build Coastguard Worker
23*6236dae4SAndroid Build Coastguard WorkerIf no argument is provided, curl displays the most important command line
24*6236dae4SAndroid Build Coastguard Workerarguments.
25*6236dae4SAndroid Build Coastguard Worker
26*6236dae4SAndroid Build Coastguard WorkerThe argument can either be a **category** or a **command line option**. When a
27*6236dae4SAndroid Build Coastguard Workercategory is provided, curl shows all command line options within the given
28*6236dae4SAndroid Build Coastguard Workercategory. Specify category `all` to list all available options.
29*6236dae4SAndroid Build Coastguard Worker
30*6236dae4SAndroid Build Coastguard WorkerIf `category` is specified, curl displays all available help categories.
31*6236dae4SAndroid Build Coastguard Worker
32*6236dae4SAndroid Build Coastguard WorkerIf the provided subject is instead an existing command line option, specified
33*6236dae4SAndroid Build Coastguard Workereither in its short form with a single dash and a single letter, or in the
34*6236dae4SAndroid Build Coastguard Workerlong form with two dashes and a longer name, curl displays a help text for
35*6236dae4SAndroid Build Coastguard Workerthat option in the terminal.
36*6236dae4SAndroid Build Coastguard Worker
37*6236dae4SAndroid Build Coastguard WorkerThe help output is extensive for some options.
38*6236dae4SAndroid Build Coastguard Worker
39*6236dae4SAndroid Build Coastguard WorkerIf the provided command line option is not known, curl says so.
40