Imported Upstream version 7.48.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 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_VERBOSE \- set verbose mode on/off
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_VERBOSE, long onoff);
30 .SH DESCRIPTION
31 Set the \fIonoff\fP parameter to 1 to make the library display a lot of
32 verbose information about its operations on this \fIhandle\fP. Very useful for
33 libcurl and/or protocol debugging and understanding. The verbose information
34 will be sent to stderr, or the stream set with \fICURLOPT_STDERR(3)\fP.
35
36 You hardly ever want this set in production use, you will almost always want
37 this when you debug/report problems.
38
39 To also get all the protocol data sent and received, consider using the
40 \fICURLOPT_DEBUGFUNCTION(3)\fP.
41 .SH DEFAULT
42 0, meaning disabled.
43 .SH PROTOCOLS
44 All
45 .SH EXAMPLE
46 .nf
47 CURL *curl = curl_easy_init();
48 if(curl) {
49   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
50
51   /* ask libcurl to show us the verbose output */
52   curl_easy_setopt(curl, CURLOPT_VERBOSE, 1L);
53
54   /* Perform the request */
55   curl_easy_perform(curl);
56 }
57 .fi
58 .SH AVAILABILITY
59 Always
60 .SH RETURN VALUE
61 Returns CURLE_OK
62 .SH "SEE ALSO"
63 .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "