[BACK]Return to sftp.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / ssh

Annotation of src/usr.bin/ssh/sftp.1, Revision 1.135

1.135   ! dtucker     1: .\" $OpenBSD: sftp.1,v 1.134 2021/01/22 02:44:58 dtucker Exp $
1.1       djm         2: .\"
1.9       deraadt     3: .\" Copyright (c) 2001 Damien Miller.  All rights reserved.
1.1       djm         4: .\"
                      5: .\" Redistribution and use in source and binary forms, with or without
                      6: .\" modification, are permitted provided that the following conditions
                      7: .\" are met:
                      8: .\" 1. Redistributions of source code must retain the above copyright
                      9: .\"    notice, this list of conditions and the following disclaimer.
                     10: .\" 2. Redistributions in binary form must reproduce the above copyright
                     11: .\"    notice, this list of conditions and the following disclaimer in the
                     12: .\"    documentation and/or other materials provided with the distribution.
                     13: .\"
                     14: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
                     15: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
                     16: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
                     17: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
                     18: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
                     19: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
                     20: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
                     21: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
                     22: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
                     23: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
                     24: .\"
1.135   ! dtucker    25: .Dd $Mdocdate: January 22 2021 $
1.1       djm        26: .Dt SFTP 1
                     27: .Os
                     28: .Sh NAME
                     29: .Nm sftp
1.128     jmc        30: .Nd OpenSSH secure file transfer
1.1       djm        31: .Sh SYNOPSIS
1.43      jmc        32: .Nm sftp
1.132     djm        33: .Op Fl 46AaCfNpqrv
1.46      jmc        34: .Op Fl B Ar buffer_size
1.29      markus     35: .Op Fl b Ar batchfile
1.70      djm        36: .Op Fl c Ar cipher
1.72      djm        37: .Op Fl D Ar sftp_server_path
1.46      jmc        38: .Op Fl F Ar ssh_config
1.73      jmc        39: .Op Fl i Ar identity_file
1.124     tb         40: .Op Fl J Ar destination
1.85      djm        41: .Op Fl l Ar limit
1.29      markus     42: .Op Fl o Ar ssh_option
1.72      djm        43: .Op Fl P Ar port
1.30      djm        44: .Op Fl R Ar num_requests
1.26      stevesk    45: .Op Fl S Ar program
1.46      jmc        46: .Op Fl s Ar subsystem | sftp_server
1.111     millert    47: .Ar destination
1.1       djm        48: .Sh DESCRIPTION
                     49: .Nm
1.111     millert    50: is a file transfer program, similar to
1.1       djm        51: .Xr ftp 1 ,
                     52: which performs all operations over an encrypted
                     53: .Xr ssh 1
                     54: transport.
                     55: It may also use many features of ssh, such as public key authentication and
                     56: compression.
1.111     millert    57: .Pp
                     58: The
                     59: .Ar destination
                     60: may be specified either as
1.112     jmc        61: .Sm off
                     62: .Oo user @ Oc host Op : path
                     63: .Sm on
                     64: or as a URI in the form
                     65: .Sm off
                     66: .No sftp:// Oo user @ Oc host Oo : port Oc Op / path .
                     67: .Sm on
1.111     millert    68: .Pp
                     69: If the
                     70: .Ar destination
                     71: includes a
                     72: .Ar path
                     73: and it is not a directory,
1.1       djm        74: .Nm
1.111     millert    75: will retrieve files automatically if a non-interactive
1.18      stevesk    76: authentication method is used; otherwise it will do so after
                     77: successful interactive authentication.
1.15      mouring    78: .Pp
1.111     millert    79: If no
                     80: .Ar path
                     81: is specified, or if the
                     82: .Ar path
                     83: is a directory,
1.60      jaredy     84: .Nm
1.111     millert    85: will log in to the specified
                     86: .Ar host
                     87: and enter interactive command mode, changing to the remote directory
                     88: if one was specified.
                     89: An optional trailing slash can be used to force the
                     90: .Ar path
                     91: to be interpreted as a directory.
1.1       djm        92: .Pp
1.111     millert    93: Since the destination formats use colon characters to delimit host
                     94: names from path names or port numbers, IPv6 addresses must be
                     95: enclosed in square brackets to avoid ambiguity.
1.89      djm        96: .Pp
1.1       djm        97: The options are as follows:
                     98: .Bl -tag -width Ds
1.70      djm        99: .It Fl 4
                    100: Forces
                    101: .Nm
                    102: to use IPv4 addresses only.
                    103: .It Fl 6
                    104: Forces
                    105: .Nm
                    106: to use IPv6 addresses only.
1.132     djm       107: .It Fl A
                    108: Allows forwarding of
                    109: .Xr ssh-agent 1
                    110: to the remote system.
                    111: The default is not to forward an authentication agent.
1.94      jmc       112: .It Fl a
1.99      jmc       113: Attempt to continue interrupted transfers rather than overwriting
1.98      logan     114: existing partial or complete copies of files.
1.99      jmc       115: If the partial contents differ from those being transferred,
1.98      logan     116: then the resultant file is likely to be corrupt.
1.46      jmc       117: .It Fl B Ar buffer_size
                    118: Specify the size of the buffer that
                    119: .Nm
                    120: uses when transferring files.
                    121: Larger buffers require fewer round trips at the cost of higher
                    122: memory consumption.
                    123: The default is 32768 bytes.
1.10      deraadt   124: .It Fl b Ar batchfile
                    125: Batch mode reads a series of commands from an input
1.13      stevesk   126: .Ar batchfile
1.10      deraadt   127: instead of
1.13      stevesk   128: .Em stdin .
                    129: Since it lacks user interaction it should be used in conjunction with
1.111     millert   130: non-interactive authentication to obviate the need to enter a password
                    131: at connection time (see
                    132: .Xr sshd 8
                    133: and
                    134: .Xr ssh-keygen 1
                    135: for details).
1.122     djm       136: .Pp
1.50      djm       137: A
1.51      jmc       138: .Ar batchfile
                    139: of
                    140: .Sq \-
1.50      djm       141: may be used to indicate standard input.
1.13      stevesk   142: .Nm
1.21      itojun    143: will abort if any of the following
                    144: commands fail:
1.121     schwarze  145: .Ic get , put , reget , reput , rename , ln ,
1.41      jmc       146: .Ic rm , mkdir , chdir , ls ,
1.66      jmc       147: .Ic lchdir , chmod , chown ,
1.88      djm       148: .Ic chgrp , lpwd , df , symlink ,
1.10      deraadt   149: and
1.13      stevesk   150: .Ic lmkdir .
1.122     djm       151: .Pp
1.41      jmc       152: Termination on error can be suppressed on a command by command basis by
                    153: prefixing the command with a
1.51      jmc       154: .Sq \-
1.44      jmc       155: character (for example,
                    156: .Ic -rm /tmp/blah* ) .
1.122     djm       157: Echo of the command may be suppressed by prefixing the command with a
                    158: .Sq @
                    159: character.
                    160: These two prefixes may be combined in any order, for example
                    161: .Ic -@ls /bsd .
1.71      jmc       162: .It Fl C
                    163: Enables compression (via ssh's
                    164: .Fl C
                    165: flag).
1.70      djm       166: .It Fl c Ar cipher
                    167: Selects the cipher to use for encrypting the data transfers.
                    168: This option is directly passed to
                    169: .Xr ssh 1 .
1.72      djm       170: .It Fl D Ar sftp_server_path
                    171: Connect directly to a local sftp server
                    172: (rather than via
                    173: .Xr ssh 1 ) .
                    174: This option may be useful in debugging the client and server.
1.46      jmc       175: .It Fl F Ar ssh_config
                    176: Specifies an alternative
                    177: per-user configuration file for
                    178: .Xr ssh 1 .
                    179: This option is directly passed to
                    180: .Xr ssh 1 .
1.95      djm       181: .It Fl f
                    182: Requests that files be flushed to disk immediately after transfer.
                    183: When uploading files, this feature is only enabled if the server
                    184: implements the "fsync@openssh.com" extension.
1.70      djm       185: .It Fl i Ar identity_file
                    186: Selects the file from which the identity (private key) for public key
                    187: authentication is read.
1.124     tb        188: This option is directly passed to
                    189: .Xr ssh 1 .
                    190: .It Fl J Ar destination
1.125     jmc       191: Connect to the target host by first making an
1.124     tb        192: .Nm
                    193: connection to the jump host described by
                    194: .Ar destination
                    195: and then establishing a TCP forwarding to the ultimate destination from
                    196: there.
                    197: Multiple jump hops may be specified separated by comma characters.
                    198: This is a shortcut to specify a
                    199: .Cm ProxyJump
                    200: configuration directive.
1.70      djm       201: This option is directly passed to
                    202: .Xr ssh 1 .
1.85      djm       203: .It Fl l Ar limit
                    204: Limits the used bandwidth, specified in Kbit/s.
1.130     jmc       205: .It Fl N
                    206: Disables quiet mode, e.g. to override the implicit quiet mode set by the
                    207: .Fl b
                    208: flag.
1.1       djm       209: .It Fl o Ar ssh_option
1.23      stevesk   210: Can be used to pass options to
                    211: .Nm ssh
1.35      stevesk   212: in the format used in
                    213: .Xr ssh_config 5 .
                    214: This is useful for specifying options
1.23      stevesk   215: for which there is no separate
                    216: .Nm sftp
1.44      jmc       217: command-line flag.
                    218: For example, to specify an alternate port use:
1.26      stevesk   219: .Ic sftp -oPort=24 .
1.46      jmc       220: For full details of the options listed below, and their possible values, see
                    221: .Xr ssh_config 5 .
                    222: .Pp
                    223: .Bl -tag -width Ds -offset indent -compact
                    224: .It AddressFamily
                    225: .It BatchMode
                    226: .It BindAddress
1.114     jmc       227: .It BindInterface
1.97      djm       228: .It CanonicalDomains
                    229: .It CanonicalizeFallbackLocal
                    230: .It CanonicalizeHostname
                    231: .It CanonicalizeMaxDots
                    232: .It CanonicalizePermittedCNAMEs
1.120     jmc       233: .It CASignatureAlgorithms
1.102     jmc       234: .It CertificateFile
1.46      jmc       235: .It ChallengeResponseAuthentication
                    236: .It CheckHostIP
                    237: .It Ciphers
                    238: .It Compression
1.110     naddy     239: .It ConnectionAttempts
1.54      dtucker   240: .It ConnectTimeout
1.55      djm       241: .It ControlMaster
                    242: .It ControlPath
1.91      djm       243: .It ControlPersist
1.46      jmc       244: .It GlobalKnownHostsFile
                    245: .It GSSAPIAuthentication
                    246: .It GSSAPIDelegateCredentials
1.61      jmc       247: .It HashKnownHosts
1.46      jmc       248: .It Host
                    249: .It HostbasedAuthentication
1.135   ! dtucker   250: .It HostbasedAcceptedAlgorithms
1.46      jmc       251: .It HostKeyAlgorithms
                    252: .It HostKeyAlias
1.126     jmc       253: .It Hostname
1.104     jmc       254: .It IdentitiesOnly
1.103     markus    255: .It IdentityAgent
1.46      jmc       256: .It IdentityFile
1.87      jmc       257: .It IPQoS
1.91      djm       258: .It KbdInteractiveAuthentication
1.58      djm       259: .It KbdInteractiveDevices
1.86      jmc       260: .It KexAlgorithms
1.133     jmc       261: .It KnownHostsCommand
1.46      jmc       262: .It LogLevel
                    263: .It MACs
                    264: .It NoHostAuthenticationForLocalhost
                    265: .It NumberOfPasswordPrompts
                    266: .It PasswordAuthentication
1.83      markus    267: .It PKCS11Provider
1.46      jmc       268: .It Port
                    269: .It PreferredAuthentications
                    270: .It ProxyCommand
1.105     jmc       271: .It ProxyJump
1.134     dtucker   272: .It PubkeyAcceptedAlgorithms
1.46      jmc       273: .It PubkeyAuthentication
1.63      dtucker   274: .It RekeyLimit
1.53      jmc       275: .It SendEnv
1.49      markus    276: .It ServerAliveInterval
                    277: .It ServerAliveCountMax
1.116     jmc       278: .It SetEnv
1.46      jmc       279: .It StrictHostKeyChecking
1.48      markus    280: .It TCPKeepAlive
1.100     djm       281: .It UpdateHostKeys
1.46      jmc       282: .It User
                    283: .It UserKnownHostsFile
                    284: .It VerifyHostKeyDNS
                    285: .El
1.72      djm       286: .It Fl P Ar port
                    287: Specifies the port to connect to on the remote host.
1.74      djm       288: .It Fl p
                    289: Preserves modification times, access times, and modes from the
                    290: original files transferred.
1.70      djm       291: .It Fl q
                    292: Quiet mode: disables the progress meter as well as warning and
                    293: diagnostic messages from
                    294: .Xr ssh 1 .
1.30      djm       295: .It Fl R Ar num_requests
1.44      jmc       296: Specify how many requests may be outstanding at any one time.
                    297: Increasing this may slightly improve file transfer speed
                    298: but will increase memory usage.
1.67      djm       299: The default is 64 outstanding requests.
1.74      djm       300: .It Fl r
                    301: Recursively copy entire directories when uploading and downloading.
                    302: Note that
                    303: .Nm
                    304: does not follow symbolic links encountered in the tree traversal.
1.26      stevesk   305: .It Fl S Ar program
                    306: Name of the
                    307: .Ar program
                    308: to use for the encrypted connection.
                    309: The program must understand
                    310: .Xr ssh 1
                    311: options.
1.46      jmc       312: .It Fl s Ar subsystem | sftp_server
                    313: Specifies the SSH2 subsystem or the path for an sftp server
                    314: on the remote host.
1.109     jmc       315: A path is useful when the remote
1.46      jmc       316: .Xr sshd 8
                    317: does not have an sftp subsystem configured.
                    318: .It Fl v
                    319: Raise logging level.
                    320: This option is also passed to ssh.
1.1       djm       321: .El
                    322: .Sh INTERACTIVE COMMANDS
1.2       djm       323: Once in interactive mode,
                    324: .Nm
1.21      itojun    325: understands a set of commands similar to those of
1.1       djm       326: .Xr ftp 1 .
1.60      jaredy    327: Commands are case insensitive.
                    328: Pathnames that contain spaces must be enclosed in quotes.
                    329: Any special characters contained within pathnames that are recognized by
                    330: .Xr glob 3
                    331: must be escaped with backslashes
                    332: .Pq Sq \e .
                    333: .Bl -tag -width Ds
1.22      markus    334: .It Ic bye
1.44      jmc       335: Quit
                    336: .Nm sftp .
1.113     djm       337: .It Ic cd Op Ar path
1.21      itojun    338: Change remote directory to
1.3       deraadt   339: .Ar path .
1.113     djm       340: If
                    341: .Ar path
                    342: is not specified, then change directory to the one the session started in.
1.123     djm       343: .It Xo Ic chgrp
                    344: .Op Fl h
                    345: .Ar grp
                    346: .Ar path
                    347: .Xc
1.21      itojun    348: Change group of file
1.5       stevesk   349: .Ar path
                    350: to
1.1       djm       351: .Ar grp .
1.123     djm       352: If the
                    353: .Fl h
                    354: flag is specified, then symlinks will not be followed.
1.60      jaredy    355: .Ar path
                    356: may contain
1.118     kn        357: .Xr glob 7
1.60      jaredy    358: characters and may match multiple files.
1.1       djm       359: .Ar grp
1.5       stevesk   360: must be a numeric GID.
1.123     djm       361: .It Xo Ic chmod
                    362: .Op Fl h
                    363: .Ar mode
                    364: .Ar path
                    365: .Xc
1.21      itojun    366: Change permissions of file
1.5       stevesk   367: .Ar path
                    368: to
1.3       deraadt   369: .Ar mode .
1.123     djm       370: If the
                    371: .Fl h
                    372: flag is specified, then symlinks will not be followed.
1.60      jaredy    373: .Ar path
                    374: may contain
1.118     kn        375: .Xr glob 7
1.60      jaredy    376: characters and may match multiple files.
1.123     djm       377: .It Xo Ic chown
                    378: .Op Fl h
                    379: .Ar own
                    380: .Ar path
                    381: .Xc
1.21      itojun    382: Change owner of file
1.5       stevesk   383: .Ar path
                    384: to
1.1       djm       385: .Ar own .
1.123     djm       386: If the
                    387: .Fl h
                    388: flag is specified, then symlinks will not be followed.
1.60      jaredy    389: .Ar path
                    390: may contain
1.118     kn        391: .Xr glob 7
1.60      jaredy    392: characters and may match multiple files.
1.1       djm       393: .Ar own
                    394: must be a numeric UID.
1.65      djm       395: .It Xo Ic df
                    396: .Op Fl hi
                    397: .Op Ar path
                    398: .Xc
                    399: Display usage information for the filesystem holding the current directory
                    400: (or
                    401: .Ar path
                    402: if specified).
                    403: If the
                    404: .Fl h
                    405: flag is specified, the capacity information will be displayed using
                    406: "human-readable" suffixes.
                    407: The
                    408: .Fl i
                    409: flag requests display of inode information in addition to capacity information.
                    410: This command is only supported on servers that implement the
                    411: .Dq statvfs@openssh.com
                    412: extension.
1.11      deraadt   413: .It Ic exit
1.44      jmc       414: Quit
                    415: .Nm sftp .
1.7       djm       416: .It Xo Ic get
1.127     jmc       417: .Op Fl afpR
1.7       djm       418: .Ar remote-path
                    419: .Op Ar local-path
                    420: .Xc
1.1       djm       421: Retrieve the
1.5       stevesk   422: .Ar remote-path
1.1       djm       423: and store it on the local machine.
                    424: If the local
1.21      itojun    425: path name is not specified, it is given the same name it has on the
1.44      jmc       426: remote machine.
1.60      jaredy    427: .Ar remote-path
                    428: may contain
1.118     kn        429: .Xr glob 7
1.60      jaredy    430: characters and may match multiple files.
                    431: If it does and
                    432: .Ar local-path
                    433: is specified, then
                    434: .Ar local-path
                    435: must specify a directory.
1.74      djm       436: .Pp
1.92      djm       437: If the
                    438: .Fl a
                    439: flag is specified, then attempt to resume partial transfers of existing files.
                    440: Note that resumption assumes that any partial copy of the local file matches
                    441: the remote copy.
1.93      djm       442: If the remote file contents differ from the partial local copy then the
                    443: resultant file is likely to be corrupt.
1.92      djm       444: .Pp
1.95      djm       445: If the
                    446: .Fl f
                    447: flag is specified, then
                    448: .Xr fsync 2
1.96      jmc       449: will be called after the file transfer has completed to flush the file
1.95      djm       450: to disk.
                    451: .Pp
1.127     jmc       452: If the
1.74      djm       453: .Fl p
1.127     jmc       454: .\" undocumented redundant alias
                    455: .\" or
                    456: .\" .Fl P
1.60      jaredy    457: flag is specified, then full file permissions and access times are
1.7       djm       458: copied too.
1.74      djm       459: .Pp
                    460: If the
1.127     jmc       461: .Fl R
                    462: .\" undocumented redundant alias
                    463: .\" or
                    464: .\" .Fl r
1.74      djm       465: flag is specified then directories will be copied recursively.
                    466: Note that
                    467: .Nm
                    468: does not follow symbolic links when performing recursive transfers.
1.11      deraadt   469: .It Ic help
                    470: Display help text.
1.113     djm       471: .It Ic lcd Op Ar path
1.46      jmc       472: Change local directory to
                    473: .Ar path .
1.113     djm       474: If
                    475: .Ar path
                    476: is not specified, then change directory to the local user's home directory.
1.3       deraadt   477: .It Ic lls Op Ar ls-options Op Ar path
1.21      itojun    478: Display local directory listing of either
1.1       djm       479: .Ar path
                    480: or current directory if
                    481: .Ar path
1.5       stevesk   482: is not specified.
1.60      jaredy    483: .Ar ls-options
                    484: may contain any flags supported by the local system's
                    485: .Xr ls 1
                    486: command.
                    487: .Ar path
                    488: may contain
1.118     kn        489: .Xr glob 7
1.60      jaredy    490: characters and may match multiple files.
1.3       deraadt   491: .It Ic lmkdir Ar path
1.1       djm       492: Create local directory specified by
1.3       deraadt   493: .Ar path .
1.88      djm       494: .It Xo Ic ln
                    495: .Op Fl s
                    496: .Ar oldpath
                    497: .Ar newpath
                    498: .Xc
                    499: Create a link from
1.12      djm       500: .Ar oldpath
                    501: to
                    502: .Ar newpath .
1.88      djm       503: If the
                    504: .Fl s
                    505: flag is specified the created link is a symbolic link, otherwise it is
                    506: a hard link.
1.3       deraadt   507: .It Ic lpwd
                    508: Print local working directory.
1.36      djm       509: .It Xo Ic ls
1.82      jmc       510: .Op Fl 1afhlnrSt
1.36      djm       511: .Op Ar path
                    512: .Xc
1.60      jaredy    513: Display a remote directory listing of either
1.1       djm       514: .Ar path
1.60      jaredy    515: or the current directory if
1.5       stevesk   516: .Ar path
1.44      jmc       517: is not specified.
1.60      jaredy    518: .Ar path
                    519: may contain
1.118     kn        520: .Xr glob 7
1.60      jaredy    521: characters and may match multiple files.
                    522: .Pp
                    523: The following flags are recognized and alter the behaviour of
                    524: .Ic ls
                    525: accordingly:
                    526: .Bl -tag -width Ds
                    527: .It Fl 1
                    528: Produce single columnar output.
                    529: .It Fl a
                    530: List files beginning with a dot
                    531: .Pq Sq \&. .
                    532: .It Fl f
                    533: Do not sort the listing.
                    534: The default sort order is lexicographical.
1.81      djm       535: .It Fl h
                    536: When used with a long format option, use unit suffixes: Byte, Kilobyte,
                    537: Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce
                    538: the number of digits to four or fewer using powers of 2 for sizes (K=1024,
                    539: M=1048576, etc.).
1.82      jmc       540: .It Fl l
                    541: Display additional details including permissions
                    542: and ownership information.
1.60      jaredy    543: .It Fl n
                    544: Produce a long listing with user and group information presented
1.56      djm       545: numerically.
1.60      jaredy    546: .It Fl r
                    547: Reverse the sort order of the listing.
                    548: .It Fl S
                    549: Sort the listing by file size.
                    550: .It Fl t
                    551: Sort the listing by last modification time.
                    552: .El
1.3       deraadt   553: .It Ic lumask Ar umask
1.21      itojun    554: Set local umask to
1.3       deraadt   555: .Ar umask .
                    556: .It Ic mkdir Ar path
1.1       djm       557: Create remote directory specified by
1.3       deraadt   558: .Ar path .
1.40      fgsch     559: .It Ic progress
                    560: Toggle display of progress meter.
1.7       djm       561: .It Xo Ic put
1.127     jmc       562: .Op Fl afpR
1.7       djm       563: .Ar local-path
1.37      djm       564: .Op Ar remote-path
1.7       djm       565: .Xc
1.1       djm       566: Upload
1.5       stevesk   567: .Ar local-path
1.44      jmc       568: and store it on the remote machine.
                    569: If the remote path name is not specified, it is given the same name it has
                    570: on the local machine.
1.60      jaredy    571: .Ar local-path
                    572: may contain
1.118     kn        573: .Xr glob 7
1.60      jaredy    574: characters and may match multiple files.
                    575: If it does and
                    576: .Ar remote-path
                    577: is specified, then
                    578: .Ar remote-path
                    579: must specify a directory.
1.95      djm       580: .Pp
                    581: If the
1.99      jmc       582: .Fl a
1.98      logan     583: flag is specified, then attempt to resume partial
                    584: transfers of existing files.
1.99      jmc       585: Note that resumption assumes that any partial copy of the remote file
1.98      logan     586: matches the local copy.
                    587: If the local file contents differ from the remote local copy then
                    588: the resultant file is likely to be corrupt.
                    589: .Pp
                    590: If the
1.95      djm       591: .Fl f
                    592: flag is specified, then a request will be sent to the server to call
                    593: .Xr fsync 2
                    594: after the file has been transferred.
                    595: Note that this is only supported by servers that implement
                    596: the "fsync@openssh.com" extension.
1.74      djm       597: .Pp
1.127     jmc       598: If the
1.74      djm       599: .Fl p
1.127     jmc       600: .\" undocumented redundant alias
                    601: .\" or
                    602: .\" .Fl P
1.74      djm       603: flag is specified, then full file permissions and access times are
1.7       djm       604: copied too.
1.74      djm       605: .Pp
                    606: If the
1.127     jmc       607: .Fl R
                    608: .\" undocumented redundant alias
                    609: .\" or
                    610: .\" .Fl r
1.74      djm       611: flag is specified then directories will be copied recursively.
                    612: Note that
                    613: .Nm
                    614: does not follow symbolic links when performing recursive transfers.
1.3       deraadt   615: .It Ic pwd
                    616: Display remote working directory.
                    617: .It Ic quit
1.44      jmc       618: Quit
                    619: .Nm sftp .
1.92      djm       620: .It Xo Ic reget
1.127     jmc       621: .Op Fl fpR
1.92      djm       622: .Ar remote-path
                    623: .Op Ar local-path
                    624: .Xc
                    625: Resume download of
                    626: .Ar remote-path .
                    627: Equivalent to
                    628: .Ic get
                    629: with the
1.98      logan     630: .Fl a
                    631: flag set.
                    632: .It Xo Ic reput
1.127     jmc       633: .Op Fl fpR
                    634: .Ar local-path
                    635: .Op Ar remote-path
1.98      logan     636: .Xc
                    637: Resume upload of
1.127     jmc       638: .Ar local-path .
1.98      logan     639: Equivalent to
                    640: .Ic put
1.99      jmc       641: with the
1.92      djm       642: .Fl a
                    643: flag set.
1.131     jmc       644: .It Ic rename Ar oldpath newpath
1.1       djm       645: Rename remote file from
                    646: .Ar oldpath
                    647: to
1.3       deraadt   648: .Ar newpath .
1.46      jmc       649: .It Ic rm Ar path
                    650: Delete remote file specified by
                    651: .Ar path .
1.3       deraadt   652: .It Ic rmdir Ar path
1.1       djm       653: Remove remote directory specified by
1.3       deraadt   654: .Ar path .
1.131     jmc       655: .It Ic symlink Ar oldpath newpath
1.21      itojun    656: Create a symbolic link from
1.12      djm       657: .Ar oldpath
                    658: to
                    659: .Ar newpath .
1.38      fgsch     660: .It Ic version
                    661: Display the
                    662: .Nm
                    663: protocol version.
1.69      sobrado   664: .It Ic \&! Ns Ar command
1.21      itojun    665: Execute
1.1       djm       666: .Ar command
1.3       deraadt   667: in local shell.
1.45      jmc       668: .It Ic \&!
1.3       deraadt   669: Escape to local shell.
1.45      jmc       670: .It Ic \&?
1.5       stevesk   671: Synonym for help.
1.4       itojun    672: .El
1.1       djm       673: .Sh SEE ALSO
1.46      jmc       674: .Xr ftp 1 ,
1.60      jaredy    675: .Xr ls 1 ,
1.17      markus    676: .Xr scp 1 ,
1.1       djm       677: .Xr ssh 1 ,
                    678: .Xr ssh-add 1 ,
                    679: .Xr ssh-keygen 1 ,
1.119     jmc       680: .Xr ssh_config 5 ,
1.118     kn        681: .Xr glob 7 ,
1.17      markus    682: .Xr sftp-server 8 ,
                    683: .Xr sshd 8
                    684: .Rs
1.20      deraadt   685: .%A T. Ylonen
                    686: .%A S. Lehtinen
1.17      markus    687: .%T "SSH File Transfer Protocol"
                    688: .%N draft-ietf-secsh-filexfer-00.txt
                    689: .%D January 2001
                    690: .%O work in progress material
                    691: .Re