Imported Upstream version 12.1.0
[contrib/python-twisted.git] / doc / conch / man / cftp.1
1 .Dd October 8, 2005
2 .Dt CFTP 1
3 .Os
4 .Sh NAME
5 .Nm cftp
6 .Nd Conch command-line SFTP client
7 .Sh SYNOPSIS
8 .Nm cftp
9 .Op Fl B Ar buffer_size
10 .Op Fl b Ar command_file
11 .Op Fl R Ar num_requests
12 .Op Fl s Ar subsystem
13 .Os
14 .Sh DESCRIPTION
15 .Nm
16 is a client for logging into a remote machine and executing commands to send and receive file information. It can wrap a number of file transfer subsystems
17 .Pp
18 The options are as follows:
19 .Bl -tag -width Ds
20 .It Fl B
21 Specifies the default size of the buffer to use for sending and receiving. (Default value: 32768 bytes.)
22 .It Fl b
23 File to read commands from, '-' for stdin. (Default value: interactive/stdin.)
24 .It Fl R
25 Number of requests to make before waiting for a reply.
26 .It Fl s
27 Subsystem/server program to connect to.
28 .El
29 .Pp
30 The following commands are recognised by
31 .Nm
32 :
33 .Bl -tag -width Ds
34 .It Ic cd Ar path
35 Change the remote directory to 'path'.
36 .It Ic chgrp Ar gid Ar path
37 Change the gid of 'path' to 'gid'.
38 .It Ic chmod Ar mode Ar path
39 Change mode of 'path' to 'mode'.
40 .It Ic chown Ar uid Ar path
41 Change uid of 'path' to 'uid'.
42 .It Ic exit
43 Disconnect from the server.
44 .It Ic get Ar remote-path Op Ar local-path
45 Get remote file and optionally store it at specified local path.
46 .It Ic help
47 Get a list of available commands.
48 .It Ic lcd Ar path
49 Change local directory to 'path'.
50 .It Ic lls Op Ar ls-options Op Ar path
51 Display local directory listing.
52 .It Ic lmkdir Ar path
53 Create local directory.
54 .It Ic ln Ar linkpath Ar targetpath
55 Symlink remote file.
56 .It Ic lpwd
57 Print the local working directory.
58 .It Ic ls Op Ar -l Op Ar path
59 Display remote directory listing.
60 .It Ic mkdir Ar path
61 Create remote directory.
62 .It Ic progress
63 Toggle progress bar.
64 .It Ic put Ar local-path Op Ar remote-path
65 Transfer local file to remote location
66 .It Ic pwd
67 Print the remote working directory.
68 .It Ic quit
69 Disconnect from the server.
70 .It Ic rename Ar oldpath Ar newpath
71 Rename remote file.
72 .It Ic rmdir Ar path
73 Remove remote directory.
74 .It Ic rm Ar path
75 Remove remote file.
76 .It Ic version
77 Print the SFTP version.
78 .It Ic ?
79 Synonym for 'help'.
80 .El
81 .Sh AUTHOR
82 cftp by Paul Swartz <z3p@twistedmatrix.com>. Man page by Mary Gardiner <mary@twistedmatrix.com>.
83 .Sh "REPORTING BUGS"
84 Report bugs to \fIhttp://twistedmatrix.com/bugs/\fR
85 .Sh COPYRIGHT
86 Copyright \(co 2005-2008 Twisted Matrix Laboratories
87 .br 
88 This is free software; see the source for copying conditions.  There is NO
89 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.