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

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

2 files changed, 51 insertions, 6 deletions

diff --git a/nxcomp/src/Misc.cpp b/nxcomp/src/Misc.cpp
index 6d9ce08b7..7e468f1e2 100644
--- a/nxcomp/src/Misc.cpp
+++ b/nxcomp/src/Misc.cpp
@@ -132,6 +132,20 @@ static const char UsageInfo[] =
 \n\
   -v           Print version information.\n\
 \n\
+  -d <n>       Set log level (0=FATAL, 1=ERROR, 2=WARNING, 3=INFO,\n\
+               4=DEBUG). Default is 0.\n\
+\n\
+  -o <file>    Name of the logfile. Default is stderr.\n\
+\n\
+  -f <string>  Specify log format. The characters in <string> define\n\
+               how the loglines are formatted. The following characters\n\
+               are supported, default is 0:\n\
+               0       only the plain text without any additions\n\
+               u       include time\n\
+               l       include loglevel\n\
+               T       include thread ids\n\
+               L       include the source code location of the log\n\
+\n\
   host:port    Put at the end, specifies the host and port of the\n\
                listening proxy.\n\
 \n\
@@ -165,7 +179,7 @@ static const char UsageInfo[] =
 \n\
   port=n       Remote port used for the connection.\n\
 \n\
-  retry=n      Number of connection atempts.\n\
+  retry=n      Number of connection attempts.\n\
 \n\
   root=s       The root directory for the session. Usually is the\n\
                C-* or S-* in the .nx directory in the user's home,\n\
@@ -177,8 +191,8 @@ static const char UsageInfo[] =
   errors=s     Name of the log file used by the proxy. The default\n\
                is the name 'errors' in the session directory.\n\
 \n\
-  stats=s      Name of the file where are written the proxy stat-\n\
-               istics. The default is a file 'stats' in the session\n\
+  stats=s      Name of the file where the proxy statistics are writ-\n\
+               ten to. The default is a file 'stats' in the session\n\
                directory. The proxy replaces the data in the file\n\
                whenever it receives a SIGUSR1 or SIGUSR2 signal:\n\
 \n\
@@ -226,8 +240,8 @@ static const char UsageInfo[] =
 \n\
   limit=n      Specify a bitrate limit allowed for this session.\n\
 \n\
-  memory=n     Trigger memory optimizations used to keep small the\n\
-               size of X buffers. This is useful on embedded plat-\n\
+  memory=n     Trigger memory optimizations used to keep the size\n\
+               of X buffers small. This is useful on embedded plat-\n\
                forms, or where memory is scarce.\n\
 \n\
   cache=n      Size of the in-memory X message cache. Setting the\n\
@@ -331,6 +345,7 @@ tile=s\n\
 menu=n\n\
 sleep=n\n\
 tolerancechecks=s\n\
+keyconv=s\n\
                These options are interpreted by the NX agent. They\n\
                are ignored by the proxy.\n\
 \n\
@@ -360,6 +375,8 @@ tolerancechecks=s\n\
                Mac where nxclient is located in a different direct-\n\
                ory compared to the other programs, to make easier\n\
                for the user to execute the program from the shell.\n\
+               The nxclient executable will be used for displaying\n\
+               the menu and request windows to the user.\n\
 \n\
   NX_SLAVE_CMD The full path to the slave channel handler. When the\n\
                slave channel is enabled, the agent will listen on a\n\
@@ -377,7 +394,7 @@ tolerancechecks=s\n\
                ory is not set, null or invalid.\n\
 \n\
   PATH         The path where all executables are searched, except\n\
-               nxclient. If NX_CLIENT is not set, also the client\n\
+               nxclient. If NX_CLIENT is not set, also the nxclient\n\
                executable is searched in the system path.\n\
 \n\
   LD_LIBRARY_PATH\n\
diff --git a/nxproxy/man/nxproxy.1 b/nxproxy/man/nxproxy.1
index ecfe3b0d6..702c7a606 100644
--- a/nxproxy/man/nxproxy.1
+++ b/nxproxy/man/nxproxy.1
@@ -36,6 +36,34 @@ Print this message.
 .B -v
 Print version information.
 .TP 8
+.B -d <int>
+Set log level (0 for FATAL, 1 for ERROR, 2 for WARNING, 3 for INFO, 4 for
+DEBUG). The default is 0.
+.TP 8
+.B -o <string>
+Name of the log file. Default is stderr.
+.TP 8
+.B -f <string>
+Specify log format. The characters in <string> define how the loglines
+are formatted. The following characters are supported, default is '0':
+.RS 8
+.TP 8
+.I 0
+only the plain text without any additions. This is the default.
+.TP 8
+.I u
+include time
+.TP 8
+.I l
+include loglevel
+.TP 8
+.I T
+include thread ids
+.TP 8
+.I L
+include the location of the log call in the source code
+.RE
+.TP 8
 .B <host>:<port>
 Put at the end, specifies the host and port of the listening proxy.