xref: /curl/docs/cmdline-opts/help.md (revision 9a0cf564)
1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Long: help
5Arg: <subject>
6Short: h
7Help: Get help for commands
8Category: important curl
9Added: 4.0
10Multi: custom
11See-also:
12  - verbose
13Example:
14  - --help all
15  - --help --insecure
16  - --help -f
17---
18
19# `--help`
20
21Usage help. Provide help for the subject given as an optional argument.
22
23If no argument is provided, curl displays the most important command line
24arguments.
25
26The argument can either be a **category** or a **command line option**. When a
27category is provided, curl shows all command line options within the given
28category. Specify category `all` to list all available options.
29
30If `category` is specified, curl displays all available help categories.
31
32If the provided subject is instead an existing command line option, specified
33either in its short form with a single dash and a single letter, or in the
34long form with two dashes and a longer name, curl displays a help text for
35that option in the terminal.
36
37The help output is extensive for some options.
38
39If the provided command line option is not known, curl says so.
40