| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <[email protected]>, 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_WILDCARDMATCH 3 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_WILDCARDMATCH \- enable directory wildcard transfers |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_WILDCARDMATCH, long onoff); |
| 30 |
.SH DESCRIPTION |
| 31 |
Set \fIonoff\fP to 1 if you want to transfer multiple files according to a |
| 32 |
file name pattern. The pattern can be specified as part of the |
| 33 |
\fICURLOPT_URL(3)\fP option, using an fnmatch-like pattern (Shell Pattern |
| 34 |
Matching) in the last part of URL (file name). |
| 35 |
|
| 36 |
By default, libcurl uses its internal wildcard matching implementation. You |
| 37 |
can provide your own matching function by the |
| 38 |
\fICURLOPT_FNMATCH_FUNCTION(3)\fP option. |
| 39 |
|
| 40 |
A brief introduction of its syntax follows: |
| 41 |
.RS |
| 42 |
.IP "* - ASTERISK" |
| 43 |
\&ftp://example.com/some/path/\fB*.txt\fP (for all txt's from the root |
| 44 |
directory). Only two asterisks are allowed within the same pattern string. |
| 45 |
.RE |
| 46 |
.RS |
| 47 |
.IP "? - QUESTION MARK" |
| 48 |
Question mark matches any (exactly one) character. |
| 49 |
|
| 50 |
\&ftp://example.com/some/path/\fBphoto?.jpeg\fP |
| 51 |
.RE |
| 52 |
.RS |
| 53 |
.IP "[ - BRACKET EXPRESSION" |
| 54 |
The left bracket opens a bracket expression. The question mark and asterisk have |
| 55 |
no special meaning in a bracket expression. Each bracket expression ends by the |
| 56 |
right bracket and matches exactly one character. Some examples follow: |
| 57 |
|
| 58 |
\fB[a-zA-Z0\-9]\fP or \fB[f\-gF\-G]\fP \- character interval |
| 59 |
|
| 60 |
\fB[abc]\fP - character enumeration |
| 61 |
|
| 62 |
\fB[^abc]\fP or \fB[!abc]\fP - negation |
| 63 |
|
| 64 |
\fB[[:\fP\fIname\fP\fB:]]\fP class expression. Supported classes are |
| 65 |
\fBalnum\fP,\fBlower\fP, \fBspace\fP, \fBalpha\fP, \fBdigit\fP, \fBprint\fP, |
| 66 |
\fBupper\fP, \fBblank\fP, \fBgraph\fP, \fBxdigit\fP. |
| 67 |
|
| 68 |
\fB[][-!^]\fP - special case \- matches only '\-', ']', '[', '!' or '^'. These |
| 69 |
characters have no special purpose. |
| 70 |
|
| 71 |
\fB[\\[\\]\\\\]\fP - escape syntax. Matches '[', ']' or '\\'. |
| 72 |
|
| 73 |
Using the rules above, a file name pattern can be constructed: |
| 74 |
|
| 75 |
\&ftp://example.com/some/path/\fB[a-z[:upper:]\\\\].jpeg\fP |
| 76 |
.RE |
| 77 |
.PP |
| 78 |
.SH PROTOCOLS |
| 79 |
This feature is only supported for FTP download. |
| 80 |
.SH EXAMPLE |
| 81 |
See https://curl.haxx.se/libcurl/c/ftp-wildcard.html |
| 82 |
.SH AVAILABILITY |
| 83 |
Added in 7.21.0 |
| 84 |
.SH RETURN VALUE |
| 85 |
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| 86 |
.SH "SEE ALSO" |
| 87 |
.BR CURLOPT_FNMATCH_FUNCTION "(3), " CURLOPT_URL "(3), " |