.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::SFTP::Foreign::Constants 3pm"
.TH Net::SFTP::Foreign::Constants 3pm "2019-01-30" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::SFTP::Foreign::Constants \- Constant definitions for
Net::SFTP::Foreign
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use Net::SFTP::Foreign::Constants qw(:tag SSH2_FILEXFER_VERSION);
\&    print "Protocol version is ", SSH2_FILEXFER_VERSION;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Net::SFTP::Foreign::Constants provides a list of exportable \s-1SFTP\s0
constants: for \s-1SFTP\s0 messages and commands, for file-open flags,
for status messages, etc. Constants can be exported individually,
or in sets identified by tag names.
.PP
Net::SFTP::Foreign::Constants provides values for all of the constants
listed in the \s-1SFTP\s0 protocol version 3 draft; the only thing to note is
that the constants are listed with the prefix \f(CW\*(C`SSH2_\*(C'\fR instead of
\&\f(CW\*(C`SSH_\*(C'\fR. So, for example, to import the constant for the file-open
command, you would write:
.PP
.Vb 1
\&    use Net::SFTP::Foreign::Constants qw( SSH2_FXP_OPEN );
.Ve
.SH "TAGS"
.IX Header "TAGS"
As mentioned above, constants can either be imported individually
or in sets grouped by tag names. The tag names are:
.IP ":fxp" 4
.IX Item ":fxp"
Imports all of the \f(CW\*(C`SSH2_FXP_*\*(C'\fR constants: these are the
constants used in the messaging protocol.
.IP ":flags" 4
.IX Item ":flags"
Imports all of the \f(CW\*(C`SSH2_FXF_*\*(C'\fR constants: these are constants
used as flags sent to the server when opening files.
.IP ":att" 4
.IX Item ":att"
Imports all of the \f(CW\*(C`SSH2_FILEXFER_ATTR_*\*(C'\fR constants: these are
the constants used to construct the flag in the serialized
attributes. The flag describes what types of file attributes
are listed in the buffer.
.IP ":status" 4
.IX Item ":status"
Imports all of the \f(CW\*(C`SSH2_FX_*\*(C'\fR constants: these are constants
returned from a server \f(CW\*(C`SSH2_FXP_STATUS\*(C'\fR message and indicate
the status of a particular operation.
.IP ":error" 4
.IX Item ":error"
Imports all the \f(CW\*(C`SFTP_ERR_*\*(C'\fR constants used to represent high level
errors: \f(CW\*(C`SFTP_ERR_LOCAL_ALREADY_EXISTS\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_LOCAL_CHMOD_FAILED\*(C'\fR, \f(CW\*(C`SFTP_ERR_LOCAL_OPEN_FAILED\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_LOCAL_READ_ERROR\*(C'\fR, \f(CW\*(C`SFTP_ERR_LOCAL_STAT_FAILED\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_LOCAL_UTIME_FAILED\*(C'\fR, \f(CW\*(C`SFTP_ERR_LOCAL_WRITE_FAILED\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_REMOTE_BAD_PACKET_SEQUENCE\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_REMOTE_BAD_PERMISSIONS\*(C'\fR, \f(CW\*(C`SFTP_ERR_REMOTE_BAD_TIME\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_REMOTE_BLOCK_TOO_SMALL\*(C'\fR, \f(CW\*(C`SFTP_ERR_REMOTE_CLOSE_FAILED\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_REMOTE_FSETSTAT_FAILED\*(C'\fR, \f(CW\*(C`SFTP_ERR_REMOTE_FSTAT_FAILED\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_REMOTE_LSTAT_FAILED\*(C'\fR, \f(CW\*(C`SFTP_ERR_REMOTE_MKDIR_FAILED\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_REMOTE_OPENDIR_FAILED\*(C'\fR, \f(CW\*(C`SFTP_ERR_REMOTE_OPEN_FAILED\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_REMOTE_READDIR_FAILED\*(C'\fR, \f(CW\*(C`SFTP_ERR_REMOTE_READ_FAILED\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_REMOTE_REALPATH_FAILED\*(C'\fR, \f(CW\*(C`SFTP_ERR_REMOTE_REMOVE_FAILED\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_REMOTE_RENAME_FAILED\*(C'\fR, \f(CW\*(C`SFTP_ERR_REMOTE_RMDIR_FAILED\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_REMOTE_READLINK_FAILED\*(C'\fR, \f(CW\*(C`SFTP_ERR_REMOTE_SYMLINK_FAILED\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_REMOTE_SETSTAT_FAILED\*(C'\fR, \f(CW\*(C`SFTP_ERR_REMOTE_STAT_FAILED\*(C'\fR,
\&\f(CW\*(C`SFTP_ERR_REMOTE_WRITE_FAILED\*(C'\fR and
\&\f(CW\*(C`SFTP_ERR_REMOTE_HARDLINK_FAILED\*(C'\fR.
.Sp
Note: these constants are not defined on the \s-1SFTP\s0 draft.
.IP ":ext" 4
.IX Item ":ext"
Import all the \f(CW\*(C`SSH2_FXE_*\*(C'\fR constants: there are the constants
defined for usage with \s-1SFTP\s0 extensions.
.Sp
Currently, these are supported: \f(CW\*(C`SSH2_FXE_STATVFS_ST_RDONLY\*(C'\fR,
\&\f(CW\*(C`SSH_FXE_STATVFS_ST_NOSUID\*(C'\fR.
.PP
There is one constant that does not fit into any of the
tag sets: \f(CW\*(C`SSH2_FILEXFER_VERSION\*(C'\fR, which holds the value
of the \s-1SFTP\s0 protocol implemented by Net::SFTP::Foreign.
.SH "AUTHOR & COPYRIGHTS"
.IX Header "AUTHOR & COPYRIGHTS"
Please see the Net::SFTP::Foreign manpage for author, copyright,
and license information.