Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_PATH_AS_IS.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2020, 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_PATH_AS_IS 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_PATH_AS_IS \- do not handle dot dot sequences
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PATH_AS_IS, long leaveit);
                     31: .SH DESCRIPTION
                     32: Set the long \fIleaveit\fP to 1, to explicitly tell libcurl to not alter the
                     33: given path before passing it on to the server.
                     34: 
                     35: This instructs libcurl to NOT squash sequences of "/../" or "/./" that may
                     36: exist in the URL's path part and that is supposed to be removed according to
                     37: RFC 3986 section 5.2.4.
                     38: 
                     39: Some server implementations are known to (erroneously) require the dot dot
                     40: sequences to remain in the path and some clients want to pass these on in
                     41: order to try out server implementations.
                     42: 
                     43: By default libcurl will merge such sequences before using the path.
                     44: .SH DEFAULT
                     45: 0
                     46: .SH PROTOCOLS
                     47: All
                     48: .SH EXAMPLE
                     49: .nf
                     50: CURL *curl = curl_easy_init();
                     51: if(curl) {
                     52:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/../../etc/password");
                     53: 
                     54:   curl_easy_setopt(curl, CURLOPT_PATH_AS_IS, 1L);
                     55: 
                     56:   curl_easy_perform(curl);
                     57: }
                     58: .fi
                     59: .SH AVAILABILITY
                     60: Added in 7.42.0
                     61: .SH RETURN VALUE
                     62: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     63: .SH "SEE ALSO"
                     64: .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "
                     65: .BR CURLOPT_URL "(3), "

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>