e2811155f1
Discovered during investigation into the PR - the description of AT_FDCWD was somewhat confusing. PR: 222632 Submitted by: Jan Kokemüller <jan.kokemueller@gmail.com> MFC after: 1 week
109 lines
3.0 KiB
Groff
109 lines
3.0 KiB
Groff
.\" Copyright (c) 2013 The FreeBSD Foundation
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" This documentation was written by Pawel Jakub Dawidek under sponsorship from
|
|
.\" the FreeBSD Foundation.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd February 13, 2013
|
|
.Dt CONNECTAT 2
|
|
.Os
|
|
.Sh NAME
|
|
.Nm connectat
|
|
.Nd initiate a connection on a socket
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In sys/types.h
|
|
.In sys/socket.h
|
|
.Pp
|
|
.In fcntl.h
|
|
.Ft int
|
|
.Fn connectat "int fd" "int s" "const struct sockaddr *name" "socklen_t namelen"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn connectat
|
|
system call initiates a connection on a socket.
|
|
When passed the special value
|
|
.Dv AT_FDCWD
|
|
in the
|
|
.Fa fd
|
|
parameter, the behavior is identical to a call to
|
|
.Xr connect 2 .
|
|
Otherwise,
|
|
.Fn connectat
|
|
works like the
|
|
.Xr connect 2
|
|
system call with two exceptions:
|
|
.Pp
|
|
.Bl -enum -offset indent -compact
|
|
.It
|
|
It is limited to sockets in the PF_LOCAL domain.
|
|
.Pp
|
|
.It
|
|
If the file path stored in the
|
|
.Fa sun_path
|
|
field of the sockaddr_un structure is a relative path, it is located relative
|
|
to the directory associated with the file descriptor
|
|
.Fa fd .
|
|
.El
|
|
.Sh RETURN VALUES
|
|
.Rv -std connectat
|
|
.Sh ERRORS
|
|
The
|
|
.Fn connectat
|
|
system call may fail with the same errors as the
|
|
.Xr connect 2
|
|
system call or with the following errors:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EBADF
|
|
The
|
|
.Fa sun_path
|
|
field does not specify an absolute path and the
|
|
.Fa fd
|
|
argument is neither
|
|
.Dv AT_FDCWD
|
|
nor a valid file descriptor.
|
|
.It Bq Er ENOTDIR
|
|
The
|
|
.Fa sun_path
|
|
field is not an absolute path and
|
|
.Fa fd
|
|
is neither
|
|
.Dv AT_FDCWD
|
|
nor a file descriptor associated with a directory.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr bindat 2 ,
|
|
.Xr connect 2 ,
|
|
.Xr socket 2 ,
|
|
.Xr unix 4
|
|
.Sh AUTHORS
|
|
The
|
|
.Nm
|
|
was developed by
|
|
.An Pawel Jakub Dawidek Aq Mt pawel@dawidek.net
|
|
under sponsorship from the FreeBSD Foundation.
|