\S{using-cleanup} \i\c{-cleanup}If invoked with the \c{-cleanup} option, rather than running asnormal, PuTTY will remove its registry entries and random seed filefrom the local machine (after confirming with the user).\S{using-general-opts} Standard command-line optionsPuTTY and its associated tools support a range of command-lineoptions, most of which are consistent across all the tools. Thissection lists the available options in all tools. Options which arespecific to a particular tool are covered in the chapter about thattool.\S2{using-cmdline-load} \i\c{-load}: load a saved session\I{saved sessions, loading from command line}The \c{-load} optioncauses PuTTY to load configuration details out of a saved session.If these details include a host name, then this option is all youneed to make PuTTY start a session.You need double quotes around the session name if it contains spaces.If you want to create a Windows shortcut to start a PuTTY savedsession, this is the option you should use: your shortcut shouldcall something like\c d:\path\to\putty.exe -load "my session"(Note that PuTTY itself supports an alternative form of this option,for backwards compatibility. If you execute \c{putty @sessionname}it will have the same effect as \c{putty -load "sessionname"}. Withthe \c{@} form, no double quotes are required, and the \c{@} signmust be the very first thing on the command line. This form of theoption is deprecated.)\S2{using-cmdline-protocol} Selecting a protocol: \c{-ssh},\c{-telnet}, \c{-rlogin}, \c{-raw}To choose which protocol you want to connect with, you can use oneof these options:\b \i\c{-ssh} selects the SSH protocol.\b \i\c{-telnet} selects the Telnet protocol.\b \i\c{-rlogin} selects the Rlogin protocol.\b \i\c{-raw} selects the raw protocol.These options are not available in the file transfer tools PSCP andPSFTP (which only work with the SSH protocol).These options are equivalent to the \i{protocol selection} buttonsin the Session panel of the PuTTY configuration box (see\k{config-hostname}).\S2{using-cmdline-v} \i\c{-v}: increase verbosity\I{verbose mode}Most of the PuTTY tools can be made to tell you moreabout what they are doing by supplying the \c{-v} option. If you arehaving trouble when making a connection, or you're simply curious,you can turn this switch on and hope to find out more about what ishappening.\S2{using-cmdline-l} \i\c{-l}: specify a \i{login name}You can specify the user name to log in as on the remote serverusing the \c{-l} option. For example, \c{plink login.example.com -lfred}.These options are equivalent to the username selection box in theConnection panel of the PuTTY configuration box (see\k{config-username}).\S2{using-cmdline-portfwd} \I{-L-upper}\c{-L}, \I{-R-upper}\c{-R}and \I{-D-upper}\c{-D}: set up \i{port forwardings}As well as setting up port forwardings in the PuTTY configuration(see \k{config-ssh-portfwd}), you can also set up forwardings on thecommand line. The command-line options work just like the ones inUnix \c{ssh} programs.To forward a local port (say 5110) to a remote destination (say\cw{popserver.example.com} port 110), you can write something likeone of these:\c putty -L 5110:popserver.example.com:110 -load mysession\c plink mysession -L 5110:popserver.example.com:110To forward a remote port to a local destination, just use the \c{-R}option instead of \c{-L}:\c putty -R 5023:mytelnetserver.myhouse.org:23 -load mysession\c plink mysession -R 5023:mytelnetserver.myhouse.org:23To specify an IP address for the listening end of the tunnel,prepend it to the argument:\c plink -L 127.0.0.5:23:localhost:23 myhostTo set up SOCKS-based dynamic port forwarding on a local port, usethe \c{-D} option. For this one you only have to pass the portnumber:\c putty -D 4096 -load mysessionFor general information on port forwarding, see\k{using-port-forwarding}.These options are not available in the file transfer tools PSCP andPSFTP.\S2{using-cmdline-m} \i\c{-m}: read a remote command or script froma fileThe \i\c{-m} option performs a similar function to the \q{Remotecommand} box in the SSH panel of the PuTTY configuration box (see\k{config-command}). However, the \c{-m} option expects to be givena local file name, and it will read a command from that file. Onmost Unix systems, you can even put multiple lines in this file andexecute more than one command in sequence, or a whole shell script;but this will not work on all servers (and is known not to workwith certain \q{embedded} servers such as routers).This option is not available in the file transfer tools PSCP andPSFTP.\S2{using-cmdline-p} \I{-P-upper}\c{-P}: specify a \i{port number}The \c{-P} option is used to specify the port number to connect to. Ifyou have a Telnet server running on port 9696 of a machine instead ofport 23, for example:\c putty -telnet -P 9696 host.name\c plink -telnet -P 9696 host.name(Note that this option is more useful in Plink than in PuTTY,because in PuTTY you can write \c{putty -telnet host.name 9696} inany case.)This option is equivalent to the port number control in the Sessionpanel of the PuTTY configuration box (see \k{config-hostname}).\S2{using-cmdline-pw} \i\c{-pw}: specify a \i{password}A simple way to automate a remote login is to supply your passwordon the command line. This is \e{not recommended} for reasons ofsecurity. If you possibly can, we recommend you set up public-keyauthentication instead. See \k{pubkey} for details.Note that the \c{-pw} option only works when you are using the SSHprotocol. Due to fundamental limitations of Telnet and Rlogin, theseprotocols do not support automated password authentication.\S2{using-cmdline-agent} \I{-A-upper}\c{-A} and \i\c{-a}: control \i{agentforwarding}The \c{-A} option turns on SSH agent forwarding, and \c{-a} turns itoff. These options are only meaningful if you are using SSH.See \k{pageant} for general information on \i{Pageant}, and\k{pageant-forward} for information on agent forwarding. Note thatthere is a security risk involved with enabling this option; see\k{pageant-security} for details.These options are equivalent to the agent forwarding checkbox in theAuth panel of the PuTTY configuration box (see \k{config-ssh-agentfwd}).These options are not available in the file transfer tools PSCP andPSFTP.\S2{using-cmdline-x11} \I{-X-upper}\c{-X} and \i\c{-x}: control \i{X11forwarding}The \c{-X} option turns on X11 forwarding in SSH, and \c{-x} turnsit off. These options are only meaningful if you are using SSH.For information on X11 forwarding, see \k{using-x-forwarding}.These options are equivalent to the X11 forwarding checkbox in theTunnels panel of the PuTTY configuration box (see\k{config-ssh-x11}).These options are not available in the file transfer tools PSCP andPSFTP.\S2{using-cmdline-pty} \i\c{-t} and \I{-T-upper}\c{-T}: control\i{pseudo-terminal allocation}The \c{-t} option ensures PuTTY attempts to allocate apseudo-terminal at the server, and \c{-T} stops it from allocatingone. These options are only meaningful if you are using SSH.These options are equivalent to the \q{Don't allocate apseudo-terminal} checkbox in the SSH panel of the PuTTYconfiguration box (see \k{config-ssh-pty}).These options are not available in the file transfer tools PSCP andPSFTP.\S2{using-cmdline-noshell} \I{-N-upper}\c{-N}: suppress starting ashell or commandThe \c{-N} option prevents PuTTY from attempting to start a shell orcommand on the remote server. You might want to use this option ifyou are only using the SSH connection for port forwarding, and youruser account on the server does not have the ability to run a shell.This feature is only available in SSH protocol version 2 (since theversion 1 protocol assumes you will always want to run a shell).This option is equivalent to the \q{Don't start a shell or commandat all} checkbox in the SSH panel of the PuTTY configuration box(see \k{config-ssh-noshell}).This option is not available in the file transfer tools PSCP andPSFTP.\S2{using-cmdline-compress} \I{-C-upper}\c{-C}: enable \i{compression}The \c{-C} option enables compression of the data sent across thenetwork. This option is only meaningful if you are using SSH.This option is equivalent to the \q{Enable compression} checkbox inthe SSH panel of the PuTTY configuration box (see\k{config-ssh-comp}).\S2{using-cmdline-sshprot} \i\c{-1} and \i\c{-2}: specify an \i{SSHprotocol version}The \c{-1} and \c{-2} options force PuTTY to use version \I{SSH1}1or version \I{SSH2}2 of the SSH protocol. These options are onlymeaningful if you are using SSH.These options are equivalent to selecting your preferred SSHprotocol version as \q{1 only} or \q{2 only} in the SSH panel of thePuTTY configuration box (see \k{config-ssh-prot}).\S2{using-cmdline-identity} \i\c{-i}: specify an SSH \i{private key}The \c{-i} option allows you to specify the name of a private keyfile in \c{*.PPK} format which PuTTY will use to authenticate with theserver. This option is only meaningful if you are using SSH.For general information on \i{public-key authentication}, see\k{pubkey}.This option is equivalent to the \q{Private key file forauthentication} box in the Auth panel of the PuTTY configuration box(see \k{config-ssh-privkey}).