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