Commit 72c1f83f authored by Ulrich Sibiller's avatar Ulrich Sibiller

nxagent manpage: some minor formatting improvements and typo fixes

delete trailing whitespace, break long lines, always emphasize nxagent and nxproxy, emphassize options identcially everywhere
parent e788a70c
...@@ -103,7 +103,7 @@ described further below. ...@@ -103,7 +103,7 @@ described further below.
Last but not least, \fBnxagent\fR accepts several more options, the Last but not least, \fBnxagent\fR accepts several more options, the
so-called nx/nx options, provided via the $DISPLAY environment so-called nx/nx options, provided via the $DISPLAY environment
variable or the -options command line option. See below for further variable or the \fB-options\fR command line option. See below for further
details. details.
.SH STANDARD XSERVER OPTIONS .SH STANDARD XSERVER OPTIONS
...@@ -167,7 +167,7 @@ Not obeyed by all servers. ...@@ -167,7 +167,7 @@ Not obeyed by all servers.
reads more options from the given file. Options in the file may be separated reads more options from the given file. Options in the file may be separated
by newlines if desired. If a '#' character appears on a line, all characters by newlines if desired. If a '#' character appears on a line, all characters
between it and the next newline are ignored, providing a simple commenting between it and the next newline are ignored, providing a simple commenting
facility. The \fB\-config\fP option itself may appear in the file. facility. The \fB\-config\fR option itself may appear in the file.
.BR NOTE : .BR NOTE :
This option is disabled when the Xserver is run with an effective uid This option is disabled when the Xserver is run with an effective uid
different from the user's real uid. different from the user's real uid.
...@@ -177,11 +177,12 @@ different from the user's real uid. ...@@ -177,11 +177,12 @@ different from the user's real uid.
causes the server to generate a core dump on fatal errors. causes the server to generate a core dump on fatal errors.
.TP 8 .TP 8
.B \-displayfd \fIfd\fP .B \-displayfd \fIfd\fP
specifies a file descriptor in the launching process. Rather than specifying specifies a file descriptor in the launching process. Rather than
a display number, the X server will attempt to listen on successively higher specifying a display number, the X server will attempt to listen on
display numbers, and upon finding a free one, will write the port number back successively higher display numbers, and upon finding a free one, will
on this file descriptor as a newline-terminated string. The \fB\-pn\fR option is write the port number back on this file descriptor as a
ignored when using \fB\-displayfd\fR. newline-terminated string. The \fB\-pn\fR option is ignored when
using \fB\-displayfd\fR.
nxagent specific: nxagent specific:
...@@ -194,7 +195,7 @@ e.g.: ...@@ -194,7 +195,7 @@ e.g.:
\fBnxagent\fR \fI\-displayfd 2 :50\fR \fBnxagent\fR \fI\-displayfd 2 :50\fR
(2) If -displayfd <X> is given with <X> equaling 2 (STDERR), then the (2) If \fB\-displayfd\fR <X> is given with <X> equaling 2 (STDERR), then the
display number string written to STDERR is beautified with some human-readable display number string written to STDERR is beautified with some human-readable
(machine-parseable) text. (machine-parseable) text.
.TP 8 .TP 8
...@@ -320,9 +321,10 @@ enables(+) or disables(-) XINERAMA provided via the PanoramiX extension. This is ...@@ -320,9 +321,10 @@ enables(+) or disables(-) XINERAMA provided via the PanoramiX extension. This is
set to off by default. set to off by default.
.TP 8 .TP 8
.B [+-]rrxinerama .B [+-]rrxinerama
enables(+) or disables(-) XINERAMA provided via the RandR extension. By enables(+) or disables(-) XINERAMA provided via the RandR
default, this feature is enabled. To disable XINERAMA completely, make extension. By default, this feature is enabled. To disable XINERAMA
sure to use both options (-xinerama -rrxinerama) on the command line. completely, make sure to use both options (\fB\-xinerama\fR and
\fB\-rrxinerama\fR) on the command line.
.SH SERVER DEPENDENT OPTIONS .SH SERVER DEPENDENT OPTIONS
\fBnxagent\fR additionally accepts the following non-standard options: \fBnxagent\fR additionally accepts the following non-standard options:
...@@ -367,16 +369,23 @@ milliseconds. ...@@ -367,16 +369,23 @@ milliseconds.
The nx-X11 system adds the following command line arguments: The nx-X11 system adds the following command line arguments:
.TP 8 .TP 8
.B \-forcenx .B \-forcenx
force use of NX protocol messages assuming communication through nxproxy force use of NX protocol messages assuming communication through \fBnxproxy\fR
.TP 8 .TP 8
.B \-nxrealwindowprop .B \-nxrealwindowprop
set property NX_REAL_WINDOW for each X11 client inside NX Agent, providing the window XID of the corresponding window object on the X server that NX Agent runs on set property NX_REAL_WINDOW for each X11 client inside \fBnxagent\fR,
providing the window XID of the corresponding window object on the X
server that \fBnxagent\fR runs on
.TP 8 .TP 8
.B \-reportwids .B \-reportwids
explicitly tell NX Agent to report its externally exposed X11 window IDs to the session log (in machine readable form), so that external parsers can obtain that information from there explicitly tell \fBnxagent\fR to report its externally exposed X11 window
IDs to the session log (in machine readable form), so that external
parsers can obtain that information from there
.TP 8 .TP 8
.B \-reportprivatewids .B \-reportprivatewids
explicitly tell NX Agent to report X11 window IDs of internally created window objects to the session log (in machine readable form), so that external parsers can obtain that information from there; this creates a lot of output and may affect performance explicitly tell \fBnxagent\fR to report X11 window IDs of internally
created window objects to the session log (in machine readable form),
so that external parsers can obtain that information from there; this
creates a lot of output and may affect performance
.TP 8 .TP 8
.B \-timeout \fIint\fP .B \-timeout \fIint\fP
auto-disconnect timeout in seconds (minimum allowed: 60) auto-disconnect timeout in seconds (minimum allowed: 60)
...@@ -444,7 +453,7 @@ agent), you will normally set the $DISPLAY variable like this: ...@@ -444,7 +453,7 @@ agent), you will normally set the $DISPLAY variable like this:
.PP .PP
.nf .nf
$ export DISPLAY=nx/nx,listen=<proxy-port>,options=<options.file>:<nx-display-port> $ export DISPLAY=nx/nx,listen=<proxy-port>,options=<options.file>:<nx-display-port>
$ nxagent <cmdline-options> :<nx-display-port> $ nxagent <command-line-options> :<nx-display-port>
.fi .fi
.PP .PP
The value for <nx-display-port> is some value of a not-yet-used X11 The value for <nx-display-port> is some value of a not-yet-used X11
...@@ -462,13 +471,16 @@ Available \fBnxagent\fR options (as an addition to nx/nx options supported ...@@ -462,13 +471,16 @@ Available \fBnxagent\fR options (as an addition to nx/nx options supported
by nxcomp already): by nxcomp already):
.TP 8 .TP 8
.B options=<string> .B options=<string>
read options from file, this text file can contain a single loooong line with comma-separated nx/nx options read options from file, this text file can contain a single loooong
line with comma-separated nx/nx options
.TP 8 .TP 8
.B rootless=<bool> .B rootless=<bool>
start \fBnxagent\fR in rootless mode, matches \-R given on the command line, no-op when resuming (default: false) start \fBnxagent\fR in rootless mode, matches \-R given on the command
line, no-op when resuming (default: false)
.TP 8 .TP 8
.B geometry=<string> .B geometry=<string>
desktop geometry when starting or resuming a session, no-op in rootless mode (default 66% of the underlying X server geometry) desktop geometry when starting or resuming a session, no-op in
rootless mode (default 66% of the underlying X server geometry)
.TP 8 .TP 8
.B resize=<bool> .B resize=<bool>
set resizing support (default: true) set resizing support (default: true)
...@@ -483,7 +495,9 @@ set remote keyboard layout ...@@ -483,7 +495,9 @@ set remote keyboard layout
.BR both | client | server | none .BR both | client | server | none
enable / disable (set to: \fInone\fR) clipboard support, uni-directional (\fIserver\fR or \fIclient\fR) or bi-directional (\fIboth\fR, default setting) support enable / disable (set to: \fInone\fR) clipboard support,
uni-directional (\fIserver\fR or \fIclient\fR) or bi-directional
(\fIboth\fR, default setting) support
.TP 8 .TP 8
.B streaming=<int> .B streaming=<int>
streaming support for images, not fully implemented yet and thus non-functional streaming support for images, not fully implemented yet and thus non-functional
...@@ -492,7 +506,7 @@ streaming support for images, not fully implemented yet and thus non-functional ...@@ -492,7 +506,7 @@ streaming support for images, not fully implemented yet and thus non-functional
disable or enforce backing store support (default: BackingStoreUndefined) disable or enforce backing store support (default: BackingStoreUndefined)
.TP 8 .TP 8
.B composite=<int> .B composite=<int>
enable or disable Compsite support in \fBnxagent\fR (default: enabled) enable or disable Composite support in \fBnxagent\fR (default: enabled)
.TP 8 .TP 8
.B xinerama=<int> .B xinerama=<int>
enable or disable XINERAMA support in \fBnxagent\fR (default: enabled) enable or disable XINERAMA support in \fBnxagent\fR (default: enabled)
...@@ -507,10 +521,12 @@ enable shared pixmaps support ...@@ -507,10 +521,12 @@ enable shared pixmaps support
set remote keyboard type set remote keyboard type
.TP 8 .TP 8
.B client=<string> .B client=<string>
type of connecting operating system (supported: \fIlinux\fR, \fIwindows\fR, \fIsolaris\fR and \fImacosx\fR) type of connecting operating system (supported: \fIlinux\fR,
\fIwindows\fR, \fIsolaris\fR and \fImacosx\fR)
.TP 8 .TP 8
.B shadow=<int> .B shadow=<int>
start \fBnxagent\fR in shadow mode, matches \-S given on the command line, no-op when resuming (default: false) start \fBnxagent\fR in shadow mode, matches \fB\-S\fR given on the
command line, no-op when resuming (default: false)
.TP 8 .TP 8
.B shadowuid=<int> .B shadowuid=<int>
unique identifier for the shadow session unique identifier for the shadow session
...@@ -519,25 +535,28 @@ unique identifier for the shadow session ...@@ -519,25 +535,28 @@ unique identifier for the shadow session
full access (set to \fI1\fR) or viewing-only (set to \fI0\fR, default) full access (set to \fI1\fR) or viewing-only (set to \fI0\fR, default)
.TP 8 .TP 8
.B defer=<int> .B defer=<int>
defer image updates (enabled for all connection types except LAN), accepts values \fI0\fR, \fI1\fR and \fI2\fR defer image updates (enabled for all connection types except LAN),
accepts values \fI0\fR, \fI1\fR and \fI2\fR
The default value can be set via the cmd line (\-defer). The value 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 provided as nx/nx option is set when resuming a session, thus it
overrides the cmd line default. overrides the command line default.
.TP 8 .TP 8
.B tile=<string> .B tile=<string>
set the tile size in pixels (\fI<W>x<H>\fR) for bitmap data sent over the wire set the tile size in pixels (\fI<W>x<H>\fR) for bitmap data sent over the wire
The default value can be set via the cmd line (\-tile). The value 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 provided as nx/nx option is set when resuming a session, thus it
overrides the cmd line default. overrides the command line default.
.TP 8 .TP 8
.B menu=<int> .B menu=<int>
support pulldown menu in \fBnxagent\fR session (only available on proxy <-> agent remote sessions) support pulldown menu in \fBnxagent\fR session (only available on
proxy <-> agent remote sessions)
.TP 8 .TP 8
.B sleep=<int> .B sleep=<int>
delay X server operations when suspended (provided in msec), set to \fI0\fR to keep \fBnxagent\fR session delay X server operations when suspended (provided in msec), set to
fully functional when suspended (e.g. useful when mirroring an \fBnxagent\fR session via VNC) \fI0\fR to keep \fBnxagent\fR session fully functional when suspended
(e.g. useful when mirroring an \fBnxagent\fR session via VNC)
.TP 8 .TP 8
.B tolerancechecks=<string> .B tolerancechecks=<string>
...@@ -570,7 +589,7 @@ can pass options like this: ...@@ -570,7 +589,7 @@ can pass options like this:
.PP .PP
.nf .nf
$ echo nx/nx,fullscreen=1$DISPLAY >/tmp/opt $ echo nx/nx,fullscreen=1$DISPLAY >/tmp/opt
$ nxagent <cmdline-options> -options /tmp/opt :<nx-display-port> $ nxagent <command-line-options> -options /tmp/opt :<nx-display-port>
.fi .fi
.SH XDMCP OPTIONS .SH XDMCP OPTIONS
...@@ -901,7 +920,7 @@ XDM-AUTHORIZATION-2, SUN-DES-1, and MIT-KERBEROS-5. See the ...@@ -901,7 +920,7 @@ XDM-AUTHORIZATION-2, SUN-DES-1, and MIT-KERBEROS-5. See the
operation of these protocols. operation of these protocols.
.PP .PP
Authorization data required by the above protocols is passed to the Authorization data required by the above protocols is passed to the
server in a private file named with the \fB\-auth\fP command line server in a private file named with the \fB\-auth\fR command line
option. Each time the server is about to accept the first connection option. Each time the server is about to accept the first connection
after a reset (or when the server is starting), it reads this file. after a reset (or when the server is starting), it reads this file.
If this file contains any authorization records, the local host is not If this file contains any authorization records, the local host is not
...@@ -988,7 +1007,7 @@ by the \fIfont path\fP. ...@@ -988,7 +1007,7 @@ by the \fIfont path\fP.
The default font path is The default font path is
__default_font_path__ . __default_font_path__ .
.LP .LP
The font path can be set with the \fB\-fp\fP option or by \fIxset\fP(1) The font path can be set with the \fB\-fp\fR option or by \fIxset\fP(1)
after the server has started. after the server has started.
.SH FILES .SH FILES
.TP 30 .TP 30
...@@ -1056,4 +1075,3 @@ Gabriel <mike.gabriel@das-netzwerkteam.de>. In 2016, the original ...@@ -1056,4 +1075,3 @@ Gabriel <mike.gabriel@das-netzwerkteam.de>. In 2016, the original
Xserver.man page shipped with nx-X11 was merged into the \fBnxagent\fR Xserver.man page shipped with nx-X11 was merged into the \fBnxagent\fR
man page and received a major update by Mike Gabriel man page and received a major update by Mike Gabriel
<mike.gabriel@das-netzwerkteam.de>. <mike.gabriel@das-netzwerkteam.de>.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment