[Pkg-nx-commits] r70 - nxproxy2/trunk/debian

Tue Sep 19 18:51:41 UTC 2006

Author: pelle
Date: 2006-09-19 18:51:40 +0000 (Tue, 19 Sep 2006)
New Revision: 70

Added:
   nxproxy2/trunk/debian/manpages
   nxproxy2/trunk/debian/nxproxy.1
Modified:
   nxproxy2/trunk/debian/rules
Log:
manual page for nxproxy

Added: nxproxy2/trunk/debian/manpages
===================================================================

--- nxproxy2/trunk/debian/manpages	                        (rev 0)
+++ nxproxy2/trunk/debian/manpages	2006-09-19 18:51:40 UTC (rev 70)
@@ -0,0 +1 @@
+debian/nxproxy.1

Added: nxproxy2/trunk/debian/nxproxy.1
===================================================================
--- nxproxy2/trunk/debian/nxproxy.1	                        (rev 0)
+++ nxproxy2/trunk/debian/nxproxy.1	2006-09-19 18:51:40 UTC (rev 70)
@@ -0,0 +1,332 @@
+.TH NXPROXY "1" "September 2006" "nxproxy" "User Commands"
+.SH NAME
+nxproxy \- proxy X connections using NX compression technology
+.SH SYNOPSIS
+.B nxproxy
+[\fIOPTIONS\fR]
+.I host:port
+.SH DESCRIPTION
+.TP
+\fB\-C\fR
+Specify that nxproxy has to run on the 'X client'
+side, listening for connections and impersonating
+an X server.
+.TP
+\fB\-S\fR
+Specify that nxproxy has to run in 'X server' mode,
+thus forwarding the connections to daemons running
+on the client.
+.TP
+\fB\-h\fR
+Print help message.
+.TP
+\fB\-v\fR
+Print version information.
+.TP
+host:port
+Put at the end, specifies the host and port of the
+listening proxy.
+.TP
+name=value
+Set the NX option to the provided value.
+.IP
+Multiple NX options can be specified in the DISPLAY environment
+or on the command line, by using the nx/nx,option=value notation.
+.SH OPTIONS
+.TP
+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.
+.TP
+type=s
+Type of session, for example 'windows', 'unix\-kde'.
+\&'unix\-application', etc.
+.TP
+display=s
+Specify the real display where X connections have
+to be forwarded by the proxy running on the client.
+.TP
+listen=n
+Local port used for accepting the proxy connection.
+.TP
+accept=s
+Name or IP of host that can connect to the proxy.
+.TP
+connect=s
+Name or IP of host that the proxy will connect to.
+.TP
+port=n
+Remote port used for the connection.
+.TP
+retry=n
+Number of connection atempts.
+.TP
+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.
+.TP
+session=s
+Name of the session file. The default is the name
+\&'session' in the session directory.
+.TP
+errors=s
+Name of the log file used by the proxy. The default
+is the name 'errors' in the session directory.
+.TP
+stats=s
+Name of the file where are written the proxy statistics. 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:
+.IP
+SIGUSR1 - Gives total statistics, i.e. statistics collected since the
+beginning of the session.
+.IP
+SIGUSR2 - Gives partial statistics, i.e. statistics collected since
+the last time this signal was received.
+.TP
+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.
+.TP
+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.
+.TP
+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.
+.TP
+render=b
+Enable or disable use of the RENDER extension.
+.TP
+taint=b
+Try to suppress trivial sources of X roundtrips by
+generating the reply on the X client side.
+.TP
+delta=b
+Enable X differential compression.
+.TP
+data=n
+Enable or disable the ZLIB data compression. It is
+possible to specify a value between 0 and 9. Usually the value is chosen automatically based on the
+requested link setting.
+.TP
+stream=n
+Enable or disable the ZLIB stream compression. The
+value, between 0 and 9, is usually determined according to the requested link setting.
+.TP
+limit=n
+Specify a bitrate limit allowed for this session.
+.TP
+memory=n
+Trigger memory optimizations used to keep small the
+size of X buffers. This is useful on embedded platforms, or where memory is scarce.
+.TP
+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.
+.TP
+images=n
+Size of the persistent image cache.
+.TP
+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.
+.TP
+load=b
+Enable loading a persistent X message cache at the
+proxy startup.
+.TP
+save=b
+Enable saving a persistent X message cache at the
+end of session.
+.TP
+cups=n
+Enable or disable forwarding of CUPS connections,
+by listening on the optional port 'n'.
+.TP
+aux=n
+Enable or disable forwarding of the auxiliary X channel used for controlling the keyboard. The 'keybd=n'
+form is accepted for backward compatibility.
+.TP
+smb=n
+Enable or disable forwarding of SMB connections. The
+\&'samba=n' form is accepted for backward compatibility.
+.TP
+media=n
+Enable forwarding of audio connections.
+.TP
+http=n
+Enable forwarding of HTTP connections.
+.TP
+font=n
+Enable forwarding of reversed connections to a font
+server running on the NX server.
+.TP
+file=n
+Enable forwarding of file transfer connections.
+.TP
+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.
+.TP
+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.
+.TP
+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.
+.TP
+pack=s
+Determine the method used to compress images.
+.TP
+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.
+.TP
+core=b
+Enable production of core dumps when aborting the
+proxy connection.
+.TP
+options=s
+Specify an additional file containing options that
+has to be merged with option read from the command
+line or the environment.
+.TP
+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.
+.TP
+strict=b
+Optimize for responsiveness, rather than for the best
+use of all the available bandwidth.
+.TP
+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.
+.PP
+rootless=b
+.br
+geometry=s
+.br
+resize=b
+.br
+fullscreen=b
+.br
+keyboard=s
+.br
+clipboard=n
+.br
+streaming=n
+.br
+backingstore=n
+.br
+rdpcolors=n
+.br
+rdpcache=n
+.br
+shmem=b
+.br
+shpix=b
+.br
+kbtype=s
+.br
+client=s
+.IP
+These options are interpreted by the NX agents. They have no
+effect on the proxy.
+.IP
+.SH ENVIRONMENT VARIABLES
+.TP
+.B 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.
+.TP
+.B 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' subdirectories.
+.TP
+.B NX_HOME
+The NX user's home directory. If NX_ROOT is not set
+or invalid, the user's NX directory is created here.
+.TP
+.B NX_TEMP
+The directory where the X11 Unix Domain Sockets and
+all temporary files are to be created.
+.TP
+.B NX_CLIENT
+The full path to the nxclient executable. If the variable 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 directory compared to the other programs, to make easier
+for the user to execute the program from the shell.
+.IP
+.SH SHELL ENVIRONMENT
+.TP
+.B HOME
+The variable is checked in the case NX_HOME is not
+set, null or invalid.
+.TP
+.B TEMP
+The variable is checked whenever the NX_TEMP directory is not set, null or invalid.
+.TP
+.B 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.
+.TP
+.B LD_LIBRARY_PATH
+System\-wide library search order. This should be set
+by the program invoking the proxy.
+.TP
+.B 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...
+.TP
+.B 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).
+.SH AUTHOR
+Copyright (c) 2001, 2006 NoMachine, http://www.nomachine.com/
+.PP
+Manual page created by Per Olofsson <pelle at debian.org> using the help
+text from nxproxy.

Modified: nxproxy2/trunk/debian/rules
===================================================================
--- nxproxy2/trunk/debian/rules	2006-09-19 18:13:56 UTC (rev 69)
+++ nxproxy2/trunk/debian/rules	2006-09-19 18:51:40 UTC (rev 70)
@@ -58,6 +58,7 @@
 	dh_testroot
 	dh_installchangelogs CHANGELOG
 	dh_installdocs
+	dh_installman
 	dh_link
 	dh_strip
 	dh_compress


