Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_VERBOSE.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH CURLOPT_VERBOSE 3 "February 03, 2016" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_VERBOSE \- set verbose mode on/off
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_VERBOSE, long onoff);
31 .SH DESCRIPTION
32 Set the \fIonoff\fP parameter to 1 to make the library display a lot of
33 verbose information about its operations on this \fIhandle\fP. Very useful for
34 libcurl and/or protocol debugging and understanding. The verbose information
35 will be sent to stderr, or the stream set with \fICURLOPT_STDERR(3)\fP.
36
37 You hardly ever want this set in production use, you will almost always want
38 this when you debug/report problems.
39
40 To also get all the protocol data sent and received, consider using the
41 \fICURLOPT_DEBUGFUNCTION(3)\fP.
42 .SH DEFAULT
43 0, meaning disabled.
44 .SH PROTOCOLS
45 All
46 .SH EXAMPLE
47 .nf
48 CURL *curl = curl_easy_init();
49 if(curl) {
50   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
51
52   /* ask libcurl to show us the verbose output */
53   curl_easy_setopt(curl, CURLOPT_VERBOSE, 1L);
54
55   /* Perform the request */
56   curl_easy_perform(curl);
57 }
58 .fi
59 .SH AVAILABILITY
60 Always
61 .SH RETURN VALUE
62 Returns CURLE_OK
63 .SH "SEE ALSO"
64 .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "