Change OpenSSL context mode flags.

[ffftp/ffftp.git] / putty / DOC / PSFTP.BUT

\define{versionidpsftp} \versionid $Id: psftp.but 8325 2008-11-24 18:19:55Z jacob $\r
\r
\C{psftp} Using \i{PSFTP} to transfer files securely\r
\r
\i{PSFTP}, the PuTTY SFTP client, is a tool for \i{transferring files}\r
securely between computers using an SSH connection.\r
\r
PSFTP differs from PSCP in the following ways:\r
\r
\b PSCP should work on virtually every SSH server. PSFTP uses the\r
new \i{SFTP} protocol, which is a feature of SSH-2 only. (PSCP will also\r
use this protocol if it can, but there is an SSH-1 equivalent it can\r
fall back to if it cannot.)\r
\r
\b PSFTP allows you to run an interactive file transfer session,\r
much like the Windows \i\c{ftp} program. You can list the contents of\r
directories, browse around the file system, issue multiple \c{get}\r
and \c{put} commands, and eventually log out. By contrast, PSCP is\r
designed to do a single file transfer operation and immediately\r
terminate.\r
\r
\H{psftp-starting} Starting PSFTP\r
\r
The usual way to start PSFTP is from a command prompt, much like\r
PSCP. To do this, it will need either to be on your \i{\c{PATH}} or\r
in your current directory.  To add the directory containing PSFTP to\r
your \c{PATH} environment variable, type into the console window:\r
\r
\c set PATH=C:\path\to\putty\directory;%PATH%\r
\r
Unlike PSCP, however, PSFTP has no complex command-line syntax; you\r
just specify a host name and perhaps a user name:\r
\r
\c psftp server.example.com\r
\r
or perhaps\r
\r
\c psftp fred@server.example.com\r
\r
Alternatively, if you just type \c{psftp} on its own (or\r
double-click the PSFTP icon in the Windows GUI), you will see the\r
PSFTP prompt, and a message telling you PSFTP has not connected to\r
any server:\r
\r
\c C:\>psftp\r
\c psftp: no hostname specified; use "open host.name" to connect\r
\c psftp>\r
\r
At this point you can type \c{open server.example.com} or \c{open\r
fred@server.example.com} to start a session.\r
\r
PSFTP accepts all the general command line options supported by the\r
PuTTY tools, except the ones which make no sense in a file transfer\r
utility. See \k{using-general-opts} for a description of these\r
options. (The ones not supported by PSFTP are clearly marked.)\r
\r
PSFTP also supports some of its own options. The following sections\r
describe PSFTP's specific command-line options.\r
\r
\S{psftp-option-b} \I{-b-PSFTP}\c{-b}: specify a file containing batch commands\r
\r
In normal operation, PSFTP is an interactive program which displays\r
a command line and accepts commands from the keyboard.\r
\r
If you need to do automated tasks with PSFTP, you would probably\r
prefer to \I{batch scripts in PSFTP}specify a set of commands in\r
advance and have them executed automatically. The \c{-b} option\r
allows you to do this. You use it with a file name containing batch\r
commands. For example, you might create a file called \c{myscript.scr}\r
containing lines like this:\r
\r
\c cd /home/ftp/users/jeff\r
\c del jam-old.tar.gz\r
\c ren jam.tar.gz jam-old.tar.gz\r
\c put jam.tar.gz\r
\c chmod a+r jam.tar.gz\r
\r
and then you could run the script by typing\r
\r
\c psftp user@hostname -b myscript.scr\r
\r
When you run a batch script in this way, PSFTP will abort the script\r
if any command fails to complete successfully. To change this\r
behaviour, you can add the \c{-be} option (\k{psftp-option-be}).\r
\r
PSFTP will terminate after it finishes executing the batch script.\r
\r
\S{psftp-option-bc} \I{-bc-PSFTP}\c{-bc}: display batch commands as they are run\r
\r
The \c{-bc} option alters what PSFTP displays while processing a\r
batch script specified with \c{-b}. With the \c{-bc} option, PSFTP\r
will display prompts and commands just as if the commands had been\r
typed at the keyboard. So instead of seeing this:\r
\r
\c C:\>psftp fred@hostname -b batchfile\r
\c Sent username "fred"\r
\c Remote working directory is /home/fred\r
\c Listing directory /home/fred/lib\r
\c drwxrwsr-x    4 fred     fred         1024 Sep  6 10:42 .\r
\c drwxr-sr-x   25 fred     fred         2048 Dec 14 09:36 ..\r
\c drwxrwsr-x    3 fred     fred         1024 Apr 17  2000 jed\r
\c lrwxrwxrwx    1 fred     fred           24 Apr 17  2000 timber\r
\c drwxrwsr-x    2 fred     fred         1024 Mar 13  2000 trn\r
\r
you might see this:\r
\r
\c C:\>psftp fred@hostname -bc -b batchfile\r
\c Sent username "fred"\r
\c Remote working directory is /home/fred\r
\c psftp> dir lib\r
\c Listing directory /home/fred/lib\r
\c drwxrwsr-x    4 fred     fred         1024 Sep  6 10:42 .\r
\c drwxr-sr-x   25 fred     fred         2048 Dec 14 09:36 ..\r
\c drwxrwsr-x    3 fred     fred         1024 Apr 17  2000 jed\r
\c lrwxrwxrwx    1 fred     fred           24 Apr 17  2000 timber\r
\c drwxrwsr-x    2 fred     fred         1024 Mar 13  2000 trn\r
\c psftp> quit\r
\r
\S{psftp-option-be} \I{-be-PSFTP}\c{-be}: continue batch processing on errors\r
\r
When running a batch file, this additional option causes PSFTP to\r
continue processing even if a command fails to complete successfully.\r
\r
You might want this to happen if you wanted to delete a file and\r
didn't care if it was already not present, for example.\r
\r
\S{psftp-usage-options-batch} \I{-batch-PSFTP}\c{-batch}: avoid\r
interactive prompts\r
\r
If you use the \c{-batch} option, PSFTP will never give an\r
interactive prompt while establishing the connection. If the\r
server's host key is invalid, for example (see \k{gs-hostkey}), then\r
the connection will simply be abandoned instead of asking you what\r
to do next.\r
\r
This may help PSFTP's behaviour when it is used in automated\r
scripts: using \c{-batch}, if something goes wrong at connection\r
time, the batch job will fail rather than hang.\r
\r
\H{psftp-commands} Running PSFTP\r
\r
Once you have started your PSFTP session, you will see a \c{psftp>}\r
prompt. You can now type commands to perform file-transfer\r
functions. This section lists all the available commands.\r
\r
Any line starting with a \cw{#} will be treated as a \i{comment}\r
and ignored.\r
\r
\S{psftp-quoting} \I{quoting, in PSFTP}General quoting rules for PSFTP commands\r
\r
Most PSFTP commands are considered by the PSFTP command interpreter\r
as a sequence of words, separated by spaces. For example, the\r
command \c{ren oldfilename newfilename} splits up into three words:\r
\c{ren} (the command name), \c{oldfilename} (the name of the file to\r
be renamed), and \c{newfilename} (the new name to give the file).\r
\r
Sometimes you will need to specify \I{spaces in filenames}file names\r
that \e{contain} spaces. In order to do this, you can surround\r
the file name with double quotes. This works equally well for\r
local file names and remote file names:\r
\r
\c psftp> get "spacey file name.txt" "save it under this name.txt"\r
\r
The double quotes themselves will not appear as part of the file\r
names; they are removed by PSFTP and their only effect is to stop\r
the spaces inside them from acting as word separators.\r
\r
If you need to \e{use} a double quote (on some types of remote\r
system, such as Unix, you are allowed to use double quotes in file\r
names), you can do this by doubling it. This works both inside and\r
outside double quotes. For example, this command\r
\r
\c psftp> ren ""this"" "a file with ""quotes"" in it"\r
\r
will take a file whose current name is \c{"this"} (with a double\r
quote character at the beginning and the end) and rename it to a\r
file whose name is \c{a file with "quotes" in it}.\r
\r
(The one exception to the PSFTP quoting rules is the \c{!} command,\r
which passes its command line straight to Windows without splitting\r
it up into words at all. See \k{psftp-cmd-pling}.)\r
\r
\S{psftp-wildcards} Wildcards in PSFTP\r
\r
Several commands in PSFTP support \q{\i{wildcards}} to select multiple\r
files.\r
\r
For \e{local} file specifications (such as the first argument to\r
\c{put}), wildcard rules for the local operating system are used. For\r
instance, PSFTP running on Windows might require the use of \c{*.*}\r
where PSFTP on Unix would need \c{*}.\r
\r
For \e{remote} file specifications (such as the first argument to\r
\c{get}), PSFTP uses a standard wildcard syntax (similar to \i{POSIX}\r
wildcards):\r
\r
\b \c{*} matches any sequence of characters (including a zero-length\r
sequence).\r
\r
\b \c{?} matches exactly one character.\r
\r
\b \c{[abc]} matches exactly one character which can be \cw{a},\r
\cw{b}, or \cw{c}.\r
\r
\lcont{\r
\r
\c{[a-z]} matches any character in the range \cw{a} to \cw{z}.\r
\r
\c{[^abc]} matches a single character that is \e{not} \cw{a}, \cw{b},\r
or \cw{c}.\r
\r
Special cases: \c{[-a]} matches a literal hyphen (\cw{-}) or \cw{a};\r
\c{[^-a]} matches all other characters. \c{[a^]} matches a literal\r
caret (\cw{^}) or \cw{a}.\r
\r
}\r
\r
\b \c{\\} (backslash) before any of the above characters (or itself)\r
removes that character's special meaning.\r
\r
A leading period (\cw{.}) on a filename is not treated specially,\r
unlike in some Unix contexts; \c{get *} will fetch all files, whether\r
or not they start with a leading period.\r
\r
\S{psftp-cmd-open} The \c{open} command: start a session\r
\r
If you started PSFTP by double-clicking in the GUI, or just by\r
typing \c{psftp} at the command line, you will need to open a\r
connection to an SFTP server before you can issue any other\r
commands (except \c{help} and \c{quit}).\r
\r
To create a connection, type \c{open host.name}, or if you need to\r
specify a user name as well you can type \c{open user@host.name}.\r
You can optionally specify a port as well:\r
\c{open user@host.name 22}.\r
\r
Once you have issued this command, you will not be able to issue it\r
again, \e{even} if the command fails (for example, if you mistype\r
the host name or the connection times out). So if the connection is\r
not opened successfully, PSFTP will terminate immediately.\r
\r
\S{psftp-cmd-quit} The \c{quit} command: end your session\r
\r
When you have finished your session, type the command \c{quit} to\r
close the connection, terminate PSFTP and return to the command line\r
(or just close the PSFTP console window if you started it from the\r
GUI).\r
\r
You can also use the \c{bye} and \c{exit} commands, which have\r
exactly the same effect.\r
\r
\S{psftp-cmd-close} The \c{close} command: close your connection\r
\r
If you just want to close the network connection but keep PSFTP\r
running, you can use the \c{close} command. You can then use the\r
\c{open} command to open a new connection.\r
\r
\S{psftp-cmd-help} The \c{help} command: get quick online help\r
\r
If you type \c{help}, PSFTP will give a short list of the available\r
commands.\r
\r
If you type \c{help} with a command name - for example, \c{help get}\r
- then PSFTP will give a short piece of help on that particular\r
command.\r
\r
\S{psftp-cmd-cd} The \c{cd} and \c{pwd} commands: changing the\r
remote \i{working directory}\r
\r
PSFTP maintains a notion of your \q{working directory} on the\r
server. This is the default directory that other commands will\r
operate on. For example, if you type \c{get filename.dat} then PSFTP\r
will look for \c{filename.dat} in your remote working directory on\r
the server.\r
\r
To change your remote working directory, use the \c{cd} command. If\r
you don't provide an argument, \c{cd} will return you to your home\r
directory on the server (more precisely, the remote directory you were\r
in at the start of the connection).\r
\r
To display your current remote working directory, type \c{pwd}.\r
\r
\S{psftp-cmd-lcd} The \c{lcd} and \c{lpwd} commands: changing the\r
local \i{working directory}\r
\r
As well as having a working directory on the remote server, PSFTP\r
also has a working directory on your local machine (just like any\r
other Windows process). This is the default local directory that\r
other commands will operate on. For example, if you type \c{get\r
filename.dat} then PSFTP will save the resulting file as\r
\c{filename.dat} in your local working directory.\r
\r
To change your local working directory, use the \c{lcd} command. To\r
display your current local working directory, type \c{lpwd}.\r
\r
\S{psftp-cmd-get} The \c{get} command: fetch a file from the server\r
\r
To \i{download a file} from the server and store it on your local PC,\r
you use the \c{get} command.\r
\r
In its simplest form, you just use this with a file name:\r
\r
\c get myfile.dat\r
\r
If you want to store the file locally under a different name,\r
specify the local file name after the remote one:\r
\r
\c get myfile.dat newname.dat\r
\r
This will fetch the file on the server called \c{myfile.dat}, but\r
will save it to your local machine under the name \c{newname.dat}.\r
\r
To fetch an entire directory \i{recursive}ly, you can use the \c{-r}\r
option:\r
\r
\c get -r mydir\r
\c get -r mydir newname\r
\r
(If you want to fetch a file whose name starts with a hyphen, you\r
may have to use the \c{--} special argument, which stops \c{get}\r
from interpreting anything as a switch after it. For example,\r
\cq{get -- -silly-name-}.)\r
\r
\S{psftp-cmd-put} The \c{put} command: send a file to the server\r
\r
To \i{upload a file} to the server from your local PC, you use the\r
\c{put} command.\r
\r
In its simplest form, you just use this with a file name:\r
\r
\c put myfile.dat\r
\r
If you want to store the file remotely under a different name,\r
specify the remote file name after the local one:\r
\r
\c put myfile.dat newname.dat\r
\r
This will send the local file called \c{myfile.dat}, but will store\r
it on the server under the name \c{newname.dat}.\r
\r
To send an entire directory \i{recursive}ly, you can use the \c{-r}\r
option:\r
\r
\c put -r mydir\r
\c put -r mydir newname\r
\r
(If you want to send a file whose name starts with a hyphen, you may\r
have to use the \c{--} special argument, which stops \c{put} from\r
interpreting anything as a switch after it. For example, \cq{put --\r
-silly-name-}.)\r
\r
\S{psftp-cmd-mgetput} The \c{mget} and \c{mput} commands: fetch or\r
send multiple files\r
\r
\c{mget} works almost exactly like \c{get}, except that it allows\r
you to specify more than one file to fetch at once. You can do this\r
in two ways:\r
\r
\b by giving two or more explicit file names (\cq{mget file1.txt\r
file2.txt})\r
\r
\b by using a wildcard (\cq{mget *.txt}).\r
\r
Every argument to \c{mget} is treated as the name of a file to fetch\r
(unlike \c{get}, which will interpret at most one argument like\r
that, and a second argument will be treated as an alternative name\r
under which to store the retrieved file), or a \i{wildcard} expression\r
matching more than one file.\r
\r
The \c{-r} and \c{--} options from \c{get} are also available with\r
\c{mget}.\r
\r
\c{mput} is similar to \c{put}, with the same differences.\r
\r
\S{psftp-cmd-regetput} The \c{reget} and \c{reput} commands:\r
\i{resuming file transfers}\r
\r
If a file transfer fails half way through, and you end up with half\r
the file stored on your disk, you can resume the file transfer using\r
the \c{reget} and \c{reput} commands. These work exactly like the\r
\c{get} and \c{put} commands, but they check for the presence of the\r
half-written destination file and start transferring from where the\r
last attempt left off.\r
\r
The syntax of \c{reget} and \c{reput} is exactly the same as the\r
syntax of \c{get} and \c{put}:\r
\r
\c reget myfile.dat\r
\c reget myfile.dat newname.dat\r
\c reget -r mydir\r
\r
These commands are intended mainly for resuming interrupted transfers.\r
They assume that the remote file or directory structure has not\r
changed in any way; if there have been changes, you may end up with\r
corrupted files. In particular, the \c{-r} option will not pick up\r
changes to files or directories already transferred in full.\r
\r
\S{psftp-cmd-dir} The \c{dir} command: \I{listing files}list remote files\r
\r
To list the files in your remote working directory, just type\r
\c{dir}.\r
\r
You can also list the contents of a different directory by typing\r
\c{dir} followed by the directory name:\r
\r
\c dir /home/fred\r
\c dir sources\r
\r
And you can list a subset of the contents of a directory by\r
providing a wildcard:\r
\r
\c dir /home/fred/*.txt\r
\c dir sources/*.c\r
\r
The \c{ls} command works exactly the same way as \c{dir}.\r
\r
\S{psftp-cmd-chmod} The \c{chmod} command: change permissions on\r
remote files\r
\r
\I{changing permissions on files}PSFTP\r
allows you to modify the file permissions on files and\r
directories on the server. You do this using the \c{chmod} command,\r
which works very much like the Unix \c{chmod} command.\r
\r
The basic syntax is \c{chmod modes file}, where \c{modes} represents\r
a modification to the file permissions, and \c{file} is the filename\r
to modify. You can specify multiple files or wildcards. For example:\r
\r
\c chmod go-rwx,u+w privatefile\r
\c chmod a+r public*\r
\c chmod 640 groupfile1 groupfile2\r
\r
The \c{modes} parameter can be a set of octal digits in the Unix\r
style. (If you don't know what this means, you probably don't want\r
to be using it!) Alternatively, it can be a list of permission\r
modifications, separated by commas. Each modification consists of:\r
\r
\b The people affected by the modification. This can be \c{u} (the\r
owning user), \c{g} (members of the owning group), or \c{o}\r
(everybody else - \q{others}), or some combination of those. It can\r
also be \c{a} (\q{all}) to affect everybody at once.\r
\r
\b A \c{+} or \c{-} sign, indicating whether permissions are to be\r
added or removed.\r
\r
\b The actual permissions being added or removed. These can be\r
\I{read permission}\c{r} (permission to read the file),\r
\I{write permission}\c{w} (permission to write to the file), and\r
\I{execute permission}\c{x} (permission to execute the file, or in\r
the case of a directory, permission to access files within the\r
directory).\r
\r
So the above examples would do:\r
\r
\b The first example: \c{go-rwx} removes read, write and execute\r
permissions for members of the owning group and everybody else (so\r
the only permissions left are the ones for the file owner). \c{u+w}\r
adds write permission for the file owner.\r
\r
\b The second example: \c{a+r} adds read permission for everybody to\r
all files and directories starting with \q{public}.\r
\r
In addition to all this, there are a few extra special cases for\r
\i{Unix} systems. On non-Unix systems these are unlikely to be useful:\r
\r
\b You can specify \c{u+s} and \c{u-s} to add or remove the Unix\r
\i{set-user-ID bit}. This is typically only useful for special purposes;\r
refer to your Unix documentation if you're not sure about it.\r
\r
\b You can specify \c{g+s} and \c{g-s} to add or remove the Unix\r
\i{set-group-ID bit}. On a file, this works similarly to the set-user-ID\r
bit (see your Unix documentation again); on a directory it ensures\r
that files created in the directory are accessible by members of the\r
group that owns the directory.\r
\r
\b You can specify \c{+t} and \c{-t} to add or remove the Unix\r
\q{\i{sticky bit}}. When applied to a directory, this means that the\r
owner of a file in that directory can delete the file (whereas\r
normally only the owner of the \e{directory} would be allowed to).\r
\r
\S{psftp-cmd-del} The \c{del} command: delete remote files\r
\r
To \I{deleting files}delete a file on the server, type \c{del} and\r
then the filename or filenames:\r
\r
\c del oldfile.dat\r
\c del file1.txt file2.txt\r
\c del *.o\r
\r
Files will be deleted without further prompting, even if multiple files\r
are specified.\r
\r
\c{del} will only delete files. You cannot use it to delete\r
directories; use \c{rmdir} for that.\r
\r
The \c{rm} command works exactly the same way as \c{del}.\r
\r
\S{psftp-cmd-mkdir} The \c{mkdir} command: create remote directories\r
\r
To \i{create a directory} on the server, type \c{mkdir} and then the\r
directory name:\r
\r
\c mkdir newstuff\r
\r
You can specify multiple directories to create at once:\r
\r
\c mkdir dir1 dir2 dir3\r
\r
\S{psftp-cmd-rmdir} The \c{rmdir} command: remove remote directories\r
\r
To \i{remove a directory} on the server, type \c{rmdir} and then the\r
directory name or names:\r
\r
\c rmdir oldstuff\r
\c rmdir *.old ancient\r
\r
Directories will be deleted without further prompting, even if\r
multiple directories are specified.\r
\r
Most SFTP servers will probably refuse to remove a directory if the\r
directory has anything in it, so you will need to delete the\r
contents first.\r
\r
\S{psftp-cmd-mv} The \c{mv} command: move and \i{rename remote files}\r
\r
To rename a single file on the server, type \c{mv}, then the current\r
file name, and then the new file name:\r
\r
\c mv oldfile newname\r
\r
You can also move the file into a different directory and change the\r
name:\r
\r
\c mv oldfile dir/newname\r
\r
To move one or more files into an existing subdirectory, specify the\r
files (using wildcards if desired), and then the destination\r
directory:\r
\r
\c mv file dir\r
\c mv file1 dir1/file2 dir2\r
\c mv *.c *.h ..\r
\r
The \c{rename} and \c{ren} commands work exactly the same way as\r
\c{mv}.\r
\r
\S{psftp-cmd-pling} The \c{!} command: run a \i{local Windows command}\r
\r
You can run local Windows commands using the \c{!} command. This is\r
the only PSFTP command that is not subject to the command quoting\r
rules given in \k{psftp-quoting}. If any command line begins with\r
the \c{!} character, then the rest of the line will be passed\r
straight to Windows without further translation.\r
\r
For example, if you want to move an existing copy of a file out of\r
the way before downloading an updated version, you might type:\r
\r
\c psftp> !ren myfile.dat myfile.bak\r
\c psftp> get myfile.dat\r
\r
using the Windows \c{ren} command to rename files on your local PC.\r
\r
\H{psftp-pubkey} Using \i{public key authentication} with PSFTP\r
\r
Like PuTTY, PSFTP can authenticate using a public key instead of a\r
password. There are three ways you can do this.\r
\r
Firstly, PSFTP can use PuTTY saved sessions in place of hostnames.\r
So you might do this:\r
\r
\b Run PuTTY, and create a PuTTY saved session (see\r
\k{config-saving}) which specifies your private key file (see\r
\k{config-ssh-privkey}). You will probably also want to specify a\r
username to log in as (see \k{config-username}).\r
\r
\b In PSFTP, you can now use the name of the session instead of a\r
hostname: type \c{psftp sessionname}, where \c{sessionname} is\r
replaced by the name of your saved session.\r
\r
Secondly, you can supply the name of a private key file on the command\r
line, with the \c{-i} option. See \k{using-cmdline-identity} for more\r
information.\r
\r
Thirdly, PSFTP will attempt to authenticate using Pageant if Pageant\r
is running (see \k{pageant}). So you would do this:\r
\r
\b Ensure Pageant is running, and has your private key stored in it.\r
\r
\b Specify a user and host name to PSFTP as normal. PSFTP will\r
automatically detect Pageant and try to use the keys within it.\r
\r
For more general information on public-key authentication, see\r
\k{pubkey}.\r