nxproxy --version (return code: 0)
Error: Invalid command line option '--version'.
Usage: nxproxy [OPTIONS] host:port
-C Specify that nxproxy has to run on the 'X client'
side, listening for connections and impersonating
an X server.
-S Specify that nxproxy has to run in 'X server' mode,
thus forwarding the connections to daemons running
on the client.
-h Print this message.
-v Print version information.
host:port Put at the end, specifies the host and port of the
listening proxy.
name=value Set the NX option to the provided value.
Multiple NX options can be specified in the DISPLAY environment
or on the command line, by using the nx/nx,option=value notation.
Options:
link=s An indication of the link speed that is going to be
used between the proxies. Usually the compression
and the other link parameters depend on this setting.
The value can be either 'modem', 'isdn', 'adsl',
'wan', 'lan', 'local' or a bandwidth specification,
like for example '56k', '1m', '100m', etc.
type=s Type of session, for example 'windows', 'unix-kde'.
'unix-application', etc.
display=s Specify the real display where X connections have
to be forwarded by the proxy running on the client.
listen=n Local port used for accepting the proxy connection.
accept=s Name or IP of host that can connect to the proxy.
connect=s Name or IP of host that the proxy will connect to.
port=n Remote port used for the connection.
retry=n Number of connection atempts.
root=s The root directory for the session. Usually is the
C-* or S-* in the .nx directory in the user's home,
with '*' being the virtual display.
session=s Name of the session file. The default is the name
'session' in the session directory.
errors=s Name of the log file used by the proxy. The default
is the name 'errors' in the session directory.
stats=s Name of the file where are written the proxy stat-
istics. The default is a file 'stats' in the session
directory. The proxy replaces the data in the file
whenever it receives a SIGUSR1 or SIGUSR2 signal:
SIGUSR1 Gives total statistics, i.e. statistics
collected since the beginning of the
session.
SIGUSR2 Gives partial statistics, i.e. statist-
ics collected since the last time this
signal was received.
cookie=s Use the provided cookie for authenticating to the
remote proxy. The same cookie is used as the fake
value used for the X authorization. The fake cookie
is replaced on the X server side with the real cookie
to be used for the display, so that the real cookie
doesn't have to travel over the net. When not using
a proxy cookie, any host will be able to connect to
the proxy. See also the 'accept' parameter.
nodelay=b A boolean indicating if TCP_NODELAY has to be set
on the proxy link. Old Linux kernels had problems
with handling TCP_NODELAY on PPP links.
policy=b Let or not the agent decide when it is the best time
to flush the proxy link. If set to 0, the proxy will
flush any encoded data immediately. The option has
only effect on the X client side proxy.
render=b Enable or disable use of the RENDER extension.
taint=b Try to suppress trivial sources of X roundtrips by
generating the reply on the X client side.
delta=b Enable X differential compression.
data=n Enable or disable the ZLIB data compression. It is
possible to specify a value between 0 and 9. Usual-
ly the value is chosen automatically based on the
requested link setting.
stream=n Enable or disable the ZLIB stream compression. The
value, between 0 and 9, is usually determined accor-
ding to the requested link setting.
limit=n Specify a bitrate limit allowed for this session.
memory=n Trigger memory optimizations used to keep small the
size of X buffers. This is useful on embedded plat-
forms, or where memory is scarce.
cache=n Size of the in-memory X message cache. Setting the
value to 0 will disable the memory cache as well
as the NX differential compression.
images=n Size of the persistent image cache.
shseg=n Enable the use of the MIT-SHM extension between the
NX client proxy and the real X server. A value greater
than 1 is assumed to be the size of requested shared
memory segment. By default, the size of the segment is
determined based on the size of the in-memory cache.
load=b Enable loading a persistent X message cache at the
proxy startup.
save=b Enable saving a persistent X message cache at the
end of session.
cups=n Enable or disable forwarding of CUPS connections,
by listening on the optional port 'n'.
aux=n Enable or disable forwarding of the auxiliary X chan-
nel used for controlling the keyboard. The 'keybd=n'
form is accepted for backward compatibility.
smb=n Enable or disable forwarding of SMB connections. The
'samba=n' form is accepted for backward compatibility.
media=n Enable forwarding of audio connections.
http=n Enable forwarding of HTTP connections.
font=n Enable forwarding of reversed connections to a font
server running on the NX server.
file=n Enable forwarding of file transfer connections.
mask=n Determine the distribution of channel ids between the
proxies. By default, channels whose ids are multiple
of 8 (starting from 0) are reserved for the NX client
side. All the other channels can be allocated by the
NX server side.
timeout=t Specify the keep-alive timeout used by proxies to
determine if there is a network problem preventing
communication with the remote peer. A value of 0
disables the check.
cleanup=t Specify the number of seconds the proxy has to wait
at session shutdown before closing all channels.
The feature is used by the NX server to ensure that
services are disconnected before shutting down the
link.
pack=s Determine the method used to compress images.
product=s The product id of the client or server. The value is
ignored by the proxy, but the client or server can
provide it to facilitate the support.
core=b Enable production of core dumps when aborting the
proxy connection.
options=s Specify an additional file containing options that
has to be merged with option read from the command
line or the environment.
kill=n Add the given process to the list of daemons that
must be terminated at session shutdown. Multiple
'kill=n' options can be specified. The proxy will
send them a SIGTERM signal just before exiting.
strict=b Optimize for responsiveness, rather than for the best
use of all the available bandwidth.
encryption=b Should be set to 1 if the proxy is running as part of
a program providing encryption of the point to point
communication.
rootless=b
geometry=s
resize=b
fullscreen=b
keyboard=s
clipboard=n
streaming=n
backingstore=n
composite=n
shmem=b
shpix=b
kbtype=s
client=s
shadow=n
shadowuid=n
shadowmode=s
defer=n
tile=s
menu=n These options are interpreted by the NX agent. They
are ignored by the proxy.
Environment:
NX_ROOT The root NX directory is the place where the session
directory and the cache files are created. This is
usually overridden by passing the 'root=' option. By
default, the root NX directory is assumed to be the
directory '.nx' in the user's home.
NX_SYSTEM The directory where NX programs and libraries reside.
If not set, the value is assumed to be '/usr/NX'.
Programs, libraries and data files are respectedly
searched in the 'bin', 'lib' and 'share' subdirecto-
ries.
NX_HOME The NX user's home directory. If NX_ROOT is not set
or invalid, the user's NX directory is created here.
NX_TEMP The directory where the X11 Unix Domain Sockets and
all temporary files are to be created.
NX_CLIENT The full path to the nxclient executable. If the va-
riable is not set, the nxclient executable will be
run assuming that the program is in the system path.
This can be useful on platforms like Windows and the
Mac where nxclient is located in a different direct-
ory compared to the other programs, to make easier
for the user to execute the program from the shell.
Shell environment:
HOME The variable is checked in the case NX_HOME is not
set, null or invalid.
TEMP The variable is checked whenever the NX_TEMP direct-
ory is not set, null or invalid.
PATH The path where all executables are searched, except
nxclient. If NX_CLIENT is not set, also the client
executable is searched in the system path.
LD_LIBRARY_PATH
System-wide library search order. This should be set
by the program invoking the proxy.
DISPLAY On the X server side, the DISPLAY variable indicates
the location of the X11 server. When nxcomp is used
as a transport library, the DISPLAY may represent a
NX transport specification and options can passed in
the form nx/nx,option=value...
XAUTHORITY This is the file containing the X11 authorization
cookie. If not set, the file is assumed to be in
the user's home (either NX_HOME or HOME).
Error: NX transport initialization failed.
nxproxy --help (return code: 0)
Error: Invalid command line option '--help'.
Usage: nxproxy [OPTIONS] host:port
-C Specify that nxproxy has to run on the 'X client'
side, listening for connections and impersonating
an X server.
-S Specify that nxproxy has to run in 'X server' mode,
thus forwarding the connections to daemons running
on the client.
-h Print this message.
-v Print version information.
host:port Put at the end, specifies the host and port of the
listening proxy.
name=value Set the NX option to the provided value.
Multiple NX options can be specified in the DISPLAY environment
or on the command line, by using the nx/nx,option=value notation.
Options:
link=s An indication of the link speed that is going to be
used between the proxies. Usually the compression
and the other link parameters depend on this setting.
The value can be either 'modem', 'isdn', 'adsl',
'wan', 'lan', 'local' or a bandwidth specification,
like for example '56k', '1m', '100m', etc.
type=s Type of session, for example 'windows', 'unix-kde'.
'unix-application', etc.
display=s Specify the real display where X connections have
to be forwarded by the proxy running on the client.
listen=n Local port used for accepting the proxy connection.
accept=s Name or IP of host that can connect to the proxy.
connect=s Name or IP of host that the proxy will connect to.
port=n Remote port used for the connection.
retry=n Number of connection atempts.
root=s The root directory for the session. Usually is the
C-* or S-* in the .nx directory in the user's home,
with '*' being the virtual display.
session=s Name of the session file. The default is the name
'session' in the session directory.
errors=s Name of the log file used by the proxy. The default
is the name 'errors' in the session directory.
stats=s Name of the file where are written the proxy stat-
istics. The default is a file 'stats' in the session
directory. The proxy replaces the data in the file
whenever it receives a SIGUSR1 or SIGUSR2 signal:
SIGUSR1 Gives total statistics, i.e. statistics
collected since the beginning of the
session.
SIGUSR2 Gives partial statistics, i.e. statist-
ics collected since the last time this
signal was received.
cookie=s Use the provided cookie for authenticating to the
remote proxy. The same cookie is used as the fake
value used for the X authorization. The fake cookie
is replaced on the X server side with the real cookie
to be used for the display, so that the real cookie
doesn't have to travel over the net. When not using
a proxy cookie, any host will be able to connect to
the proxy. See also the 'accept' parameter.
nodelay=b A boolean indicating if TCP_NODELAY has to be set
on the proxy link. Old Linux kernels had problems
with handling TCP_NODELAY on PPP links.
policy=b Let or not the agent decide when it is the best time
to flush the proxy link. If set to 0, the proxy will
flush any encoded data immediately. The option has
only effect on the X client side proxy.
render=b Enable or disable use of the RENDER extension.
taint=b Try to suppress trivial sources of X roundtrips by
generating the reply on the X client side.
delta=b Enable X differential compression.
data=n Enable or disable the ZLIB data compression. It is
possible to specify a value between 0 and 9. Usual-
ly the value is chosen automatically based on the
requested link setting.
stream=n Enable or disable the ZLIB stream compression. The
value, between 0 and 9, is usually determined accor-
ding to the requested link setting.
limit=n Specify a bitrate limit allowed for this session.
memory=n Trigger memory optimizations used to keep small the
size of X buffers. This is useful on embedded plat-
forms, or where memory is scarce.
cache=n Size of the in-memory X message cache. Setting the
value to 0 will disable the memory cache as well
as the NX differential compression.
images=n Size of the persistent image cache.
shseg=n Enable the use of the MIT-SHM extension between the
NX client proxy and the real X server. A value greater
than 1 is assumed to be the size of requested shared
memory segment. By default, the size of the segment is
determined based on the size of the in-memory cache.
load=b Enable loading a persistent X message cache at the
proxy startup.
save=b Enable saving a persistent X message cache at the
end of session.
cups=n Enable or disable forwarding of CUPS connections,
by listening on the optional port 'n'.
aux=n Enable or disable forwarding of the auxiliary X chan-
nel used for controlling the keyboard. The 'keybd=n'
form is accepted for backward compatibility.
smb=n Enable or disable forwarding of SMB connections. The
'samba=n' form is accepted for backward compatibility.
media=n Enable forwarding of audio connections.
http=n Enable forwarding of HTTP connections.
font=n Enable forwarding of reversed connections to a font
server running on the NX server.
file=n Enable forwarding of file transfer connections.
mask=n Determine the distribution of channel ids between the
proxies. By default, channels whose ids are multiple
of 8 (starting from 0) are reserved for the NX client
side. All the other channels can be allocated by the
NX server side.
timeout=t Specify the keep-alive timeout used by proxies to
determine if there is a network problem preventing
communication with the remote peer. A value of 0
disables the check.
cleanup=t Specify the number of seconds the proxy has to wait
at session shutdown before closing all channels.
The feature is used by the NX server to ensure that
services are disconnected before shutting down the
link.
pack=s Determine the method used to compress images.
product=s The product id of the client or server. The value is
ignored by the proxy, but the client or server can
provide it to facilitate the support.
core=b Enable production of core dumps when aborting the
proxy connection.
options=s Specify an additional file containing options that
has to be merged with option read from the command
line or the environment.
kill=n Add the given process to the list of daemons that
must be terminated at session shutdown. Multiple
'kill=n' options can be specified. The proxy will
send them a SIGTERM signal just before exiting.
strict=b Optimize for responsiveness, rather than for the best
use of all the available bandwidth.
encryption=b Should be set to 1 if the proxy is running as part of
a program providing encryption of the point to point
communication.
rootless=b
geometry=s
resize=b
fullscreen=b
keyboard=s
clipboard=n
streaming=n
backingstore=n
composite=n
shmem=b
shpix=b
kbtype=s
client=s
shadow=n
shadowuid=n
shadowmode=s
defer=n
tile=s
menu=n These options are interpreted by the NX agent. They
are ignored by the proxy.
Environment:
NX_ROOT The root NX directory is the place where the session
directory and the cache files are created. This is
usually overridden by passing the 'root=' option. By
default, the root NX directory is assumed to be the
directory '.nx' in the user's home.
NX_SYSTEM The directory where NX programs and libraries reside.
If not set, the value is assumed to be '/usr/NX'.
Programs, libraries and data files are respectedly
searched in the 'bin', 'lib' and 'share' subdirecto-
ries.
NX_HOME The NX user's home directory. If NX_ROOT is not set
or invalid, the user's NX directory is created here.
NX_TEMP The directory where the X11 Unix Domain Sockets and
all temporary files are to be created.
NX_CLIENT The full path to the nxclient executable. If the va-
riable is not set, the nxclient executable will be
run assuming that the program is in the system path.
This can be useful on platforms like Windows and the
Mac where nxclient is located in a different direct-
ory compared to the other programs, to make easier
for the user to execute the program from the shell.
Shell environment:
HOME The variable is checked in the case NX_HOME is not
set, null or invalid.
TEMP The variable is checked whenever the NX_TEMP direct-
ory is not set, null or invalid.
PATH The path where all executables are searched, except
nxclient. If NX_CLIENT is not set, also the client
executable is searched in the system path.
LD_LIBRARY_PATH
System-wide library search order. This should be set
by the program invoking the proxy.
DISPLAY On the X server side, the DISPLAY variable indicates
the location of the X11 server. When nxcomp is used
as a transport library, the DISPLAY may represent a
NX transport specification and options can passed in
the form nx/nx,option=value...
XAUTHORITY This is the file containing the X11 authorization
cookie. If not set, the file is assumed to be in
the user's home (either NX_HOME or HOME).
Error: NX transport initialization failed.