[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.127

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