tizen 2.3.1 release
[external/curl.git] / docs / libcurl / opts / CURLOPT_NOPROGRESS.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 http://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_NOPROGRESS 3 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_NOPROGRESS \- switch off the progress meter
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOPROGRESS, long onoff);
30 .SH DESCRIPTION
31 If \fIonoff\fP is to 1, it tells the library to shut off the progress meter
32 completely for requests done with this \fIhandle\fP. It will also prevent the
33 \fICURLOPT_PROGRESSFUNCTION(3)\fP from getting called.
34
35 Future versions of libcurl are likely to not have any built-in progress meter
36 at all.
37 .SH DEFAULT
38 1, meaning it normally runs without a progress meter.
39 .SH RETURN VALUE
40 Returns CURLE_OK.
41 .SH "SEE ALSO"
42 .BR CURLOPT_PROGRESSFUNCTION "(3), "