From 16c18714b8d270daa0b28322f1b1dc8fb7f9208d Mon Sep 17 00:00:00 2001 From: Ulrich Sibiller Date: Mon, 18 Nov 2019 08:56:26 +0100 Subject: nxagent manpage: improve descriptions and types Most options are . Change that and add missing defaults. Also add list of descriptions for the defer option. --- nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1 | 67 +++++++++++++++--------- 1 file changed, 42 insertions(+), 25 deletions(-) (limited to 'nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1') diff --git a/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1 b/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1 index edd54011b..3656a0894 100644 --- a/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1 +++ b/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1 @@ -510,13 +510,13 @@ disable disconnection/reconnection to the X display on SIGHUP disable use of shared memory extension .TP 8 .B \-shmem -enable use of shared memory extension +enable use of shared memory extension (default) .TP 8 .B \-noshpix disable use of shared pixmaps .TP 8 .B \-shpix -enable use of shared pixmaps +enable use of shared pixmaps (default) .TP 8 .B \-noignore don't ignore pointer and keyboard configuration changes mandated by @@ -594,17 +594,17 @@ line with comma-separated nx/nx options .TP 8 .B rootless= start \fBnxagent\fR in rootless mode, matches \-R given on the command -line, no-op when resuming (default: false) +line, no-op when resuming (default: \fI0\fR, disabled) .TP 8 .B geometry= desktop geometry when starting or resuming a session, no-op in rootless mode (default 66% of the underlying X server geometry) .TP 8 .B resize= -set resizing support (default: true) +set resizing support (default: \fI1\fR, enabled) .TP 8 .B fullscreen= -start or resume a session in fullscreen mode (default: off) +start or resume a session in fullscreen mode (default: \fI0\fR, off) .TP 8 .B keyboard= or kbtype= @@ -679,36 +679,35 @@ Limit clipboard data exchange to work only in one direction: from nxagent to rea Disable any clipboard data exchange. Clipboard will still work inside the nxagent and on the real X server, but no data exchange will be possible. .RE .TP 8 -.B streaming= -streaming support for images, not fully implemented yet and thus non-functional +.B streaming= +enable (set to \fI1\fR) or disable (set to \fI0\fR) streaming support for images, not fully implemented yet and thus non-functional. (default: disabled) .TP 8 -.B backingstore= -disable or enforce backing store support (default: BackingStoreUndefined) +.B backingstore= +disable (set to \fI0\fR) or enforce (set to \fI1\fR) backing store support (default: enforced). In rootless mode backingstore is always disabled. .TP 8 -.B composite= -enable or disable Composite support in \fBnxagent\fR (default: enabled) +.B composite= +enable (set to \fI1\fR) or disable (set to \fI0\fR) Composite support in \fBnxagent\fR (default: enabled) .TP 8 -.B xinerama= -enable or disable XINERAMA support in \fBnxagent\fR (default: enabled) +.B xinerama= +enable (set to \fI1\fR) or disable (set to \fI0\fR) XINERAMA support in \fBnxagent\fR (default: enabled) .TP 8 .B shmem= -enable using shared memory +enable/disable using shared memory. Accepted values: \fI1\fR (enable, default), \fI0\fR (disable) .TP 8 .B shpix= -enable shared pixmaps support +enable/disable shared pixmaps support. Accepted values: \fI1\fR (enable, default), \fI0\fR (disable) .TP 8 .B client= type of connecting operating system (supported: \fIlinux\fR, \fIwindows\fR, \fIsolaris\fR and \fImacosx\fR) .TP 8 -.B shadow= -start \fBnxagent\fR in shadow mode, matches \fB\-S\fR given on the -command line, no-op when resuming (default: false) +.B shadow= +define the display that should be shadowed .TP 8 .B shadowuid= unique identifier for the shadow session .TP 8 -.B shadowmode= +.B shadowmode= full access (set to \fI1\fR) or viewing-only (set to \fI0\fR, default) .TP 8 .B defer= @@ -718,6 +717,24 @@ accepts values \fI0\fR, \fI1\fR and \fI2\fR The default value can be set via the command line (\-defer). The value provided as nx/nx option is set when resuming a session, thus it overrides the command line default. + +Each defer level adds the following rules to the previous ones: +.RS 8 +.TP 8 +.I 0 +Eager encoding. +.TP 8 +.I 1 +No data is put or copied on pixmaps, marking them always as corrupted +and synchronizing them on demand, i.e. when a copy area to a window is +requested, the source is syn- chronized before copying it. +.TP 8 +.I 2 +The put images over the windows are skipped marking the destination as +corrupted. The same happens for copy area and composite operations, +spreading the corrupted regions of involved drawables. +.RE + .TP 8 .B tile= set the tile size in pixels (\fIx\fR) for bitmap data sent over the wire @@ -726,16 +743,16 @@ The default value can be set via the command line (\-tile). The value provided as nx/nx option is set when resuming a session, thus it overrides the command line default. .TP 8 -.B menu= +.B menu= support pulldown menu in \fBnxagent\fR session (only available on -proxy <-> agent remote sessions) +proxy <-> agent remote sessions) (default: \fI1\fR, enabled) .TP 8 .B magicpixel= -enable/disable magic pixel support in fullscreen mode (default: 1, enabled) +enable/disable magic pixel support in fullscreen mode (default: \fI1\fR, enabled) .TP 8 .B autodpi= enable/disable deriving session DPI automatically from real server -(default: 0, disabled); only takes effect on session startups, gets +(default: \fI0\fR, disabled); only takes effect on session startups, gets ignored when reconnecting to a suspended session .TP 8 .B sleep= @@ -769,8 +786,8 @@ means that all of these checks are essentially deactivated. This is a very bad idea. .RE .TP 8 -.B autograb= -enable or disable autograb (default: disabled) +.B autograb= +enable or disable autograb (default: \fI0\fR, disabled) .RE If you want to use \fBnxagent\fR as a replacement for Xnest or Xephyr you -- cgit v1.2.3