Merge branch 'uli42-pr/xnest_manpages' into 3.6.x

Attributes GH PR #751: https://github.com/ArcticaProject/nx-libs/pull/751

1 files changed, 103 insertions, 8 deletions

diff --git a/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1 b/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1
index 9dd4c8485..3b616272a 100644
--- a/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1
+++ b/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1
@@ -199,15 +199,97 @@ e.g.:
 display number string written to STDERR is beautified with some human-readable
 (machine-parseable) text.
 .TP 8
+.B \-sync
+This option tells \fBnxagent\fR to synchronize its window and graphics
+operations with the real server.  This is a useful option for
+debugging, but it will slow down \fBnxagent\fR's performance
+considerably.  It should not be used unless absolutely necessary.
+.TP 8
+.B \-full
+This option tells \fBnxagent\fR to utilize full regeneration of real
+server objects and reopen a new connection to the real server each
+time \fBnxagent\fR regenerates.  The sample server implementation
+regenerates all objects in the server when the last client of this
+server terminates.  When this happens, \fBnxagent\fR by default
+maintains the same top-level window and the same real server
+connection in each new generation.  If the user selects full
+regeneration, even the top-level window and the connection to the real
+server will be regenerated for each server generation.
+.TP 8
+.B \-class \fIstring\fP
+This option specifies the default visual class of the nested server.
+It is similar to the
+.B \-cc
+option from the set of standard options except that it will accept a string
+rather than a number for the visual class specification.
+The
+.I string
+must be one of the following six values:
+.BR StaticGray ,
+.BR GrayScale ,
+.BR StaticColor ,
+.BR PseudoColor ,
+.BR TrueColor ,
+or
+.BR DirectColor .
+If both the
+.B \-class
+and
+.B \-cc
+options are specified, the last instance of either option takes precedence.
+The class of the default visual of the nested server need not be the same as the
+class of the default visual of the real server, but it must be supported by the
+real server.
+Use
+.BR xdpyinfo (__appmansuffix__)
+to obtain a list of supported visual classes on the real server before
+starting \fBnxagent\fR.  If the user chooses a static class, all the
+colors in the default color map will be preallocated.  If the user
+chooses a dynamic class, colors in the default color map will be
+available to individual clients for allocation.
+.TP 8
 .B \-deferglyphs \fIwhichfonts\fP
-specifies the types of fonts for which the server should attempt to use
-deferred glyph loading.  \fIwhichfonts\fP can be all (all fonts),
+specifies the types of fonts for which the server should attempt to
+use deferred glyph loading.  \fIwhichfonts\fP can be all (all fonts),
 none (no fonts), or 16 (16 bit fonts only).
 .TP 8
+.B \-depth \fIint\fP
+This option specifies the default visual depth of the nested server.
+The depth of the default visual of the nested server need not be the
+same as the depth of the default visual of the real server, but it
+must be supported by the real server.  Use
+.BR xdpyinfo (__appmansuffix__)
+to obtain a list of supported visual depths on the real server before
+starting \fBnxagent\fR.
+.TP 8
+.B \-geometry \fIW\fBx\fIH\fB+\fIX\fB+\fIY\fP
+This option specifies the geometry parameters for the top-level
+\fBnxagent\fR window.  See \(lqGEOMETRY SPECIFICATIONS\(rq in
+.BR X (__miscmansuffix__)
+for a discusson of this option's syntax.  This window corresponds to
+the root window of the nested server.  The width
+.I W
+and height
+.I H
+specified with this option will be the maximum width and height of
+each top-level \fBnxagent\fR window.  \fBnxagent\fR will allow the
+user to make any top-level window smaller, but it will not actually
+change the size of the nested server root window.  If this option is
+not specified, \fBnxagent\fR will choose
+.I W
+and
+.I H
+to be 3/4ths the dimensions of the root window of the real server.
+.TP 8
 .B \-dpi \fIresolution\fP
-sets the resolution for all screens, in dots per inch.
-To be used when the server cannot determine the screen size(s) from the
-hardware.
+sets the resolution for all screens, in dots per inch. If this option
+is not specified \fBnxagent\fR will assume 96. There's also
+.B \-autodpi
+which will clone the real server's dpi. Note that the resolution specified via
+.B \-dpi
+is a per session setting. It cannot be changed on reconnect! This means that
+clients may look "wrong" when reconnecting a session that had been
+started with a different dpi than the current real xserver.
 .TP 8
 .B dpms
 enables DPMS (display power management services), where supported.  The
@@ -243,6 +325,11 @@ sets the maximum big request to
 .I size
 MB.
 .TP 8
+.B \-name string
+This option specifies the name of the top-level \fBnxagent\fR window as
+.IR string .
+The default value is the program name.
+.TP 8
 .B \-nolisten \fItrans-type\fP
 disables a transport type.  For example, TCP/IP connections can be disabled
 with
@@ -391,11 +478,19 @@ auto-disconnect timeout in seconds (minimum allowed: 60)
 don't exit if there are no clients in rootless mode
 .TP 8
 .B \-autodpi
-detect real server's DPI and set it in the agent session; the \fI-dpi <dpi>\fR cmdline option overrides \fI-autodpi\fR
+detect real server's DPI and set it in the agent session; the
+.B \-dpi\fP cmdline option overrides
+.B \-autodpi\fP.
+Note that using
+.B \-autodpi
+will also adapt the DPI on reconnect which will cause
+newly started clients respecting the new DPI while clients that had
+been started before the reconnect still use the old DPI. This may lead
+to applications looking "weird".
 .TP 8
 .B \-nomagicpixel
-disable magic pixel support at session startup, can be re-enabled via nx/nx option on session
-resumption
+disable magic pixel support at session startup, can be re-enabled via
+nx/nx option on session resumption
 .TP 8
 .B \-norender
 disable the use of the render extension