Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_RANDOM_FILE.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, 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_RANDOM_FILE 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_RANDOM_FILE \- specify a source for random data
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RANDOM_FILE, char *path);
31 .SH DESCRIPTION
32 Pass a char * to a zero terminated file name. The file might be used to read
33 from to seed the random engine for SSL and more.
34
35 The application does not have to keep the string around after setting this
36 option.
37 .SH DEFAULT
38 NULL, not used
39 .SH PROTOCOLS
40 All
41 .SH EXAMPLE
42 .nf
43 CURL *curl = curl_easy_init();
44 if(curl) {
45   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
46   curl_easy_setopt(curl, CURLOPT_RANDOM_FILE, "junk.txt");
47   ret = curl_easy_perform(curl);
48   curl_easy_cleanup(curl);
49 }
50 .fi
51 .SH AVAILABILITY
52 Always
53 .SH RETURN VALUE
54 Returns CURLE_OK on success or
55 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
56 .SH "SEE ALSO"
57 .BR CURLOPT_EGDSOCKET "(3), "