xref: /curl/src/tool_help.h (revision a362962b)
1 #ifndef HEADER_CURL_TOOL_HELP_H
2 #define HEADER_CURL_TOOL_HELP_H
3 /***************************************************************************
4  *                                  _   _ ____  _
5  *  Project                     ___| | | |  _ \| |
6  *                             / __| | | | |_) | |
7  *                            | (__| |_| |  _ <| |___
8  *                             \___|\___/|_| \_\_____|
9  *
10  * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
11  *
12  * This software is licensed as described in the file COPYING, which
13  * you should have received as part of this distribution. The terms
14  * are also available at https://curl.se/docs/copyright.html.
15  *
16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17  * copies of the Software, and permit persons to whom the Software is
18  * furnished to do so, under the terms of the COPYING file.
19  *
20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21  * KIND, either express or implied.
22  *
23  * SPDX-License-Identifier: curl
24  *
25  ***************************************************************************/
26 #include "tool_setup.h"
27 
28 void tool_help(char *category);
29 void tool_list_engines(void);
30 void tool_version_info(void);
31 
32 typedef unsigned int curlhelp_t;
33 
34 struct helptxt {
35   const char *opt;
36   const char *desc;
37   curlhelp_t categories;
38 };
39 
40 /*
41  * The bitmask output is generated with the following command
42  ------------------------------------------------------------
43   make -C docs/cmdline-opts listcats
44  */
45 
46 #define CURLHELP_HIDDEN 1u << 0u
47 #define CURLHELP_AUTH 1u << 1u
48 #define CURLHELP_CONNECTION 1u << 2u
49 #define CURLHELP_CURL 1u << 3u
50 #define CURLHELP_DNS 1u << 4u
51 #define CURLHELP_FILE 1u << 5u
52 #define CURLHELP_FTP 1u << 6u
53 #define CURLHELP_HTTP 1u << 7u
54 #define CURLHELP_IMAP 1u << 8u
55 #define CURLHELP_IMPORTANT 1u << 9u
56 #define CURLHELP_IPFS 1u << 10u
57 #define CURLHELP_MISC 1u << 11u
58 #define CURLHELP_OUTPUT 1u << 12u
59 #define CURLHELP_POP3 1u << 13u
60 #define CURLHELP_POST 1u << 14u
61 #define CURLHELP_PROXY 1u << 15u
62 #define CURLHELP_SCP 1u << 16u
63 #define CURLHELP_SFTP 1u << 17u
64 #define CURLHELP_SMTP 1u << 18u
65 #define CURLHELP_SSH 1u << 19u
66 #define CURLHELP_TELNET 1u << 20u
67 #define CURLHELP_TFTP 1u << 21u
68 #define CURLHELP_TLS 1u << 22u
69 #define CURLHELP_UPLOAD 1u << 23u
70 #define CURLHELP_VERBOSE 1u << 24u
71 #define CURLHELP_ECH 1u << 25u
72 
73 extern const struct helptxt helptext[];
74 
75 #endif /* HEADER_CURL_TOOL_HELP_H */
76