summaryrefslogtreecommitdiff
path: root/sftp.0
diff options
context:
space:
mode:
authorColin Watson <cjwatson@debian.org>2003-09-01 00:45:47 +0000
committerColin Watson <cjwatson@debian.org>2003-09-01 00:45:47 +0000
commitd984a3c6658e950881edcfb2aae464add93f68d4 (patch)
treeed2052b4001227cf8179393cba172ae470e6c097 /sftp.0
parent3e36f9f4fff8f5b573f163eecd12a677ce66fe89 (diff)
Import OpenSSH 3.4p1.
Diffstat (limited to 'sftp.0')
-rw-r--r--sftp.0169
1 files changed, 169 insertions, 0 deletions
diff --git a/sftp.0 b/sftp.0
new file mode 100644
index 000000000..562b685e4
--- /dev/null
+++ b/sftp.0
@@ -0,0 +1,169 @@
1SFTP(1) System General Commands Manual SFTP(1)
2
3NAME
4 sftp - Secure file transfer program
5
6SYNOPSIS
7 sftp [-vC1] [-b batchfile] [-o ssh_option] [-s subsystem | sftp_server]
8 [-B buffer_size] [-F ssh_config] [-P sftp_server path]
9 [-R num_requests] [-S program] host
10 sftp [[user@]host[:file [file]]]
11 sftp [[user@]host[:dir[/]]]
12
13DESCRIPTION
14 sftp is an interactive file transfer program, similar to ftp(1), which
15 performs all operations over an encrypted ssh(1) transport. It may also
16 use many features of ssh, such as public key authentication and compresM--
17 sion. sftp connects and logs into the specified host, then enters an
18 interactive command mode.
19
20 The second usage format will retrieve files automatically if a non-interM--
21 active authentication method is used; otherwise it will do so after sucM--
22 cessful interactive authentication.
23
24 The last usage format allows the sftp client to start in a remote direcM--
25 tory.
26
27 The options are as follows:
28
29 -b batchfile
30 Batch mode reads a series of commands from an input batchfile
31 instead of stdin. Since it lacks user interaction it should be
32 used in conjunction with non-interactive authentication. sftp
33 will abort if any of the following commands fail: get, put,
34 rename, ln, rm, mkdir, chdir, lchdir and lmkdir.
35
36 -o ssh_option
37 Can be used to pass options to ssh in the format used in
38 ssh_config(5). This is useful for specifying options for which
39 there is no separate sftp command-line flag. For example, to
40 specify an alternate port use: sftp -oPort=24.
41
42 -s subsystem | sftp_server
43 Specifies the SSH2 subsystem or the path for an sftp server on
44 the remote host. A path is useful for using sftp over protocol
45 version 1, or when the remote sshd does not have an sftp subsysM--
46 tem configured.
47
48 -v Raise logging level. This option is also passed to ssh.
49
50 -B buffer_size
51 Specify the size of the buffer that sftp uses when transferring
52 files. Larger buffers require fewer round trips at the cost of
53 higher memory consumption. The default is 32768 bytes.
54
55 -C Enables compression (via ssh's -C flag).
56
57 -F ssh_config
58 Specifies an alternative per-user configuration file for ssh.
59 This option is directly passed to ssh(1).
60
61 -P sftp_server path
62 Connect directly to a local sftp-server (rather than via ssh)
63 This option may be useful in debugging the client and server.
64
65 -R num_requests
66 Specify how many requests may be outstanding at any one time.
67 Increasing this may slightly improve file transfer speed but will
68 increase memory usage. The default is 16 outstanding requests.
69
70 -S program
71 Name of the program to use for the encrypted connection. The
72 program must understand ssh(1) options.
73
74 -1 Specify the use of protocol version 1.
75
76INTERACTIVE COMMANDS
77 Once in interactive mode, sftp understands a set of commands similar to
78 those of ftp(1). Commands are case insensitive and pathnames may be
79 enclosed in quotes if they contain spaces.
80
81 bye Quit sftp.
82
83 cd path
84 Change remote directory to path.
85
86 lcd path
87 Change local directory to path.
88
89 chgrp grp path
90 Change group of file path to grp. grp must be a numeric GID.
91
92 chmod mode path
93 Change permissions of file path to mode.
94
95 chown own path
96 Change owner of file path to own. own must be a numeric UID.
97
98 exit Quit sftp.
99
100 get [flags] remote-path [local-path]
101 Retrieve the remote-path and store it on the local machine. If
102 the local path name is not specified, it is given the same name
103 it has on the remote machine. If the -P flag is specified, then
104 the file's full permission and access time are copied too.
105
106 help Display help text.
107
108 lls [ls-options [path]]
109 Display local directory listing of either path or current direcM--
110 tory if path is not specified.
111
112 lmkdir path
113 Create local directory specified by path.
114
115 ln oldpath newpath
116 Create a symbolic link from oldpath to newpath.
117
118 lpwd Print local working directory.
119
120 ls [path]
121 Display remote directory listing of either path or current direcM--
122 tory if path is not specified.
123
124 lumask umask
125 Set local umask to umask.
126
127 mkdir path
128 Create remote directory specified by path.
129
130 put [flags] local-path [local-path]
131 Upload local-path and store it on the remote machine. If the
132 remote path name is not specified, it is given the same name it
133 has on the local machine. If the -P flag is specified, then the
134 file's full permission and access time are copied too.
135
136 pwd Display remote working directory.
137
138 quit Quit sftp.
139
140 rename oldpath newpath
141 Rename remote file from oldpath to newpath.
142
143 rmdir path
144 Remove remote directory specified by path.
145
146 rm path
147 Delete remote file specified by path.
148
149 symlink oldpath newpath
150 Create a symbolic link from oldpath to newpath.
151
152 ! command
153 Execute command in local shell.
154
155 ! Escape to local shell.
156
157 ? Synonym for help.
158
159AUTHORS
160 Damien Miller <djm@mindrot.org>
161
162SEE ALSO
163 scp(1), ssh(1), ssh-add(1), ssh-keygen(1), ssh_config(5), sftp-server(8),
164 sshd(8)
165
166 T. Ylonen and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh-
167 filexfer-00.txt, January 2001, work in progress material.
168
169BSD February 4, 2001 BSD