tunnel

Package: WA2L/WinTools 1.2.08
Section: General Commands (1)
Updated: 28 January 2023
Index Return to Main Contents

 

NAME

tunnel - permanently run PuTTY tunnel session

 

SYNOPSIS

WA2LWinTools/bin/tunnel [ -h | -V | -l | -m | -p | -a ]

tunnel "putty session"

tunnel -s ( "putty session" | all )

 

AVAILABILITY

WA2L/WinTools

 

DESCRIPTION

a command line tool to permanently run PuTTY tunnel session.

With the tunnel command a PuTTY session is started in the background. As soon as the started session terminates it is restarted to ensure that a tunnel session is as reliable as possible.

The default timeout and restart settings can be changed in the optional etc/tunnel.cfg configuration file.

To use a PuTTY session in tunnel the session needs to be defined first in PuTTY in a way that no user interaction is needed on start of the session (using private/public keys to connect and no passphrase or using the pageant(1) prior to start tunnel ).

 

OPTIONS

-h
usage message.

-V
print program version.

-l
list log file entries of today.

-m
monitor log file.

-p
print all PuTTY sessions handled by tunnel.

-a
list all available (defined) PuTTY sessions. Not all sessions might be suitable tunnels.

"putty session"
a PuTTY session to be handled (restarted on connection loss) by tunnel.

-s "putty session"
stop a PuTTY session handled by tunnel.

-s all
stop all PuTTY session handled by tunnel.

 

ENVIRONMENT

-

 

EXIT STATUS

0
no error.

4
usage message displayed.

5
version message displayed.

 

FILES

etc/tunnel.cfg
optional configuration file for tunnel.

The settings MINUPTIME=seconds, FASTRESTART=seconds, SLOWRESTART=seconds and MAXRETRIES=number can be used to change the default connection and restart behavior.

var/log/tunnel.log
log file of tunnel.

HKEY_CURRENT_USER\SOFTWARE\SimonTatham\PuTTY\Sessions\session
Windows™ registry key of a PuTTY session.

 

EXAMPLES

-

 

SEE ALSO

wintoolsintro(1), pageant(1), putty(1), tunnel.cfg(4)

 

NOTES

-

 

BUGS

-

 

AUTHOR

tunnel was developed by Christian Walther. Send suggestions and bug reports to wa2l@users.sourceforge.net .

 

COPYRIGHT

Copyright © 2022 Christian Walther

This is free software; see WA2LWinTools/man/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


 

Index

NAME
SYNOPSIS
AVAILABILITY
DESCRIPTION
OPTIONS
ENVIRONMENT
EXIT STATUS
FILES
EXAMPLES
SEE ALSO
NOTES
BUGS
AUTHOR
COPYRIGHT

This document was created by man2html using the manual pages.
Time: 16:33:10 GMT, September 14, 2024