runsocks(1)

NAME
runsocks - A script to dynamically socksify applications

SYNOPSIS
runsocks program-name args

DESCRIPTION
runsocks is a shell script that initializes environment variables to ensure that the linker uses the SOCKS shared library when you link at runtime. Use runsocks to socksify an application without recompiling. runsocks only works if you dynamically link and the operating system supports all the runsocks features.

WARNINGS
The configuration file and the environment serve a crucial role in ensuring that socksified applications work as expected. libsocks5.conf(5) contains complete details about the configuration file.

ENVIRONMENT
You can control some aspects of the socksification process through the client configuration file and the environment variable settings. The configuration file takes precedence over the environment settings. Refer to libsocks5.conf(5) for complete details about the configuration file.

All environment variables, except SOCKS5_SHLIB_RUNPATH, apply to runsocks and to socksified clients.

SOCKS5_DEBUG [val]
    Turn on debugging and optionally set the debug level to val. If you omit val, runsocks sends only warning messages.

    Valid values for val are 1, 2, and 3. If you specify other values, runsocks assumes 3. Valid values and their meanings are:

        1 LOG_NOTICE Reports non-error conditions that may require special handling

        2 LOG_INFO Reports informational messages

        3 LOG_DEBUG Reports information useful for debugging

SOCKS5_ENCRYPT
    If possible, the next server should encrypt the link. SOCKS5_ENCRYPT is only useful when the socks5 build includes Kerberos authentication.

SOCKS5_FAKEALLHOSTS
    Specify that the client library should fake all hostname lookups. Faking all hosts causes faster connections if host lookup is slow. SOCKS5_FAKEALLHOSTS and SOCKS5_LOCALDNSONLY are mutually exclusive, setting both causes all DNS lookups to fail.

SOCKS5_LOCALDNSONLY
    Specify to never fake hostnames. Preventing faking limits unnecessary connections to the server on systems on which the client can resolve the same names the server resolves. SOCKS5_FAKEALLHOSTS and SOCKS5_LOCALDNSONLY are mutually exclusive, setting both causes all DNS lookups to fail.

SOCKS5_LOG_STDERR
    Send debug output to stderr.

SOCKS5_LOG_SYSLOG
    Send debug output to syslog. When you omit the debug output destination, SOCKS5 sends the output to the system log. To send debug output to stderr and syslog, set SOCKS5_LOG_SYSLOG and SOCKS5_LOG_STDERR.

SOCKS5_NOINTCHK
    The next server should proxy the data only, and should not integrity check the data. SOCKS5_ NOINTCHK is only useful when the socks5 build includes Kerberos authentication.

SOCKS5_NONETMASKCHECK
    Instruct the client to disregard checking the client host's netmask. By default, the client checks the netmask and connects directly to hosts on the same subnet before consulting the configuration file.

SOCKS5_PASSWD [password]
    Identify the password for Username/Password authentication.

SOCKS5_PRESERVE_STDERR
    Prevent the system from closing stderr or dup2ing it. This is most useful for debugging X Windows processes that send stderr output to a window that fills up too quickly, or constantly pops up.

SOCKS5_SERVER [host|host:port]
    Identify the socks5 server the client uses and set SOCKSv5 as the default version. See server entries for additional information on specifying host and port, and proxylist for additional information on how socks5 searches for the server.

SOCKS4_SERVER [host|host:port]
    Identify the socks4 server the client uses and sets socks4 as the default version. See server entries for additional information on specifying host and port, and proxylist for additional information on how socks5 searches for the server.

SOCKS_SERVER [host|host:port]
    Specify the default socks server, version 4 or 5, to use when SOCKS5_SERVER or SOCKS4_SERVER is not set and the client requires a specific version. SOCKS_SERVER sets SOCKS5 as the default version. See server entries for additional information on specifying host port, and proxylist for additional information on how socks5 searches for the server.

SOCKS5_SHLIB_RUNPATH
    Identify the shared library location. Usually you can set this location with LD_LIBRARY_PATH. Some operating systems, especially SunOS, do not use LD_LIBRARY_PATH correctly for pre-loading. You must set the shared library location explicitly. SOCKS5_SHLIB_RUNPATH is only valid for runsocks.

SOCKS5_USER [user]
    Identify the username for Username/Password authentication.

SEE ALSO
libsocks5.conf(5)

AUTHOR
NWSL SOCKS5 Development Team
Send comments to socks5-comments@socks.nec.com