Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_NOSIGNAL.3, revision 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_NOSIGNAL 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
! 24:
! 25: .SH NAME
! 26: CURLOPT_NOSIGNAL \- skip all signal handling
! 27: .SH SYNOPSIS
! 28: #include <curl/curl.h>
! 29:
! 30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOSIGNAL, long onoff);
! 31: .SH DESCRIPTION
! 32: If \fIonoff\fP is 1, libcurl will not use any functions that install signal
! 33: handlers or any functions that cause signals to be sent to the process. This
! 34: option is here to allow multi-threaded unix applications to still set/use all
! 35: timeout options etc, without risking getting signals.
! 36:
! 37: If this option is set and libcurl has been built with the standard name
! 38: resolver, timeouts will not occur while the name resolve takes place.
! 39: Consider building libcurl with the c-ares or threaded resolver backends to
! 40: enable asynchronous DNS lookups, to enable timeouts for name resolves without
! 41: the use of signals.
! 42:
! 43: Setting \fICURLOPT_NOSIGNAL(3)\fP to 1 makes libcurl NOT ask the system to
! 44: ignore SIGPIPE signals, which otherwise are sent by the system when trying to
! 45: send data to a socket which is closed in the other end. libcurl makes an
! 46: effort to never cause such SIGPIPEs to trigger, but some operating systems
! 47: have no way to avoid them and even on those that have there are some corner
! 48: cases when they may still happen, contrary to our desire. In addition, using
! 49: \fICURLAUTH_NTLM_WB\fP authentication could cause a SIGCHLD signal to be
! 50: raised.
! 51: .SH DEFAULT
! 52: 0
! 53: .SH AVAILABILITY
! 54: Added in 7.10
! 55: .SH RETURN VALUE
! 56: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>