update manpages and --help output. fixes #23
This commit is contained in:
parent
3389a980ea
commit
63a7936e9f
|
@ -0,0 +1,5 @@
|
||||||
|
To recreate the barrierc manpage use a command like:
|
||||||
|
help2man -N --output=barrierc.1 --name='Barrier Keyboard/Mouse Client' /path/to/barrierc
|
||||||
|
|
||||||
|
And for barriers:
|
||||||
|
help2man -N --output=barriers.1 --name='Barrier Keyboard/Mouse Server' /path/to/barriers
|
|
@ -0,0 +1,72 @@
|
||||||
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
|
||||||
|
.TH BARRIERC "1" "March 2018" "barrierc 2.0.0, protocol version 1.6" "User Commands"
|
||||||
|
.SH NAME
|
||||||
|
barrierc \- Barrier Keyboard/Mouse Client
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B barrierc
|
||||||
|
[\fI\,--yscroll <delta>\/\fR] [\fI\,--display <display>\/\fR] [\fI\,--no-xinitthreads\/\fR] [\fI\,--daemon|--no-daemon\/\fR] [\fI\,--name <screen-name>\/\fR] [\fI\,--restart|--no-restart\/\fR] [\fI\,--debug <level>\/\fR] \fI\,<server-address>\/\fR
|
||||||
|
.SH DESCRIPTION
|
||||||
|
Start the barrier client and connect to a remote server component.
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
\fB\-d\fR, \fB\-\-debug\fR <level>
|
||||||
|
filter out log messages with priority below level.
|
||||||
|
level may be: FATAL, ERROR, WARNING, NOTE, INFO,
|
||||||
|
DEBUG, DEBUG1, DEBUG2.
|
||||||
|
.TP
|
||||||
|
\fB\-n\fR, \fB\-\-name\fR <screen\-name> use screen\-name instead the hostname to identify
|
||||||
|
this screen in the configuration.
|
||||||
|
.TP
|
||||||
|
\fB\-1\fR, \fB\-\-no\-restart\fR
|
||||||
|
do not try to restart on failure.
|
||||||
|
.TP
|
||||||
|
\fB\-\-restart\fR
|
||||||
|
restart the server automatically if it fails. (*)
|
||||||
|
.TP
|
||||||
|
\fB\-l\fR \fB\-\-log\fR <file>
|
||||||
|
write log messages to file.
|
||||||
|
.TP
|
||||||
|
\fB\-\-no\-tray\fR
|
||||||
|
disable the system tray icon.
|
||||||
|
.TP
|
||||||
|
\fB\-\-enable\-drag\-drop\fR
|
||||||
|
enable file drag & drop.
|
||||||
|
.TP
|
||||||
|
\fB\-\-enable\-crypto\fR
|
||||||
|
enable the crypto (ssl) plugin.
|
||||||
|
.TP
|
||||||
|
\fB\-\-display\fR <display>
|
||||||
|
connect to the X server at <display>
|
||||||
|
.TP
|
||||||
|
\fB\-\-no\-xinitthreads\fR
|
||||||
|
do not call XInitThreads()
|
||||||
|
.TP
|
||||||
|
\fB\-f\fR, \fB\-\-no\-daemon\fR
|
||||||
|
run in the foreground.
|
||||||
|
.TP
|
||||||
|
\fB\-\-daemon\fR
|
||||||
|
run as a daemon. (*)
|
||||||
|
.TP
|
||||||
|
\fB\-\-yscroll\fR <delta>
|
||||||
|
defines the vertical scrolling delta, which is
|
||||||
|
120 by default.
|
||||||
|
.TP
|
||||||
|
\fB\-h\fR, \fB\-\-help\fR
|
||||||
|
display this help and exit.
|
||||||
|
.TP
|
||||||
|
\fB\-\-version\fR
|
||||||
|
display version information and exit.
|
||||||
|
.PP
|
||||||
|
Default options are marked with a *
|
||||||
|
.PP
|
||||||
|
The server address is of the form: [<hostname>][:<port>]. The hostname
|
||||||
|
must be the address or hostname of the server. The port overrides the
|
||||||
|
default port, 24800.
|
||||||
|
.SH COPYRIGHT
|
||||||
|
Copyright \(co 2018 Debauchee Open Source Group
|
||||||
|
.br
|
||||||
|
Copyright \(co 2012\-2016 Symless Ltd.
|
||||||
|
.br
|
||||||
|
Copyright \(co 2008\-2014 Nick Bolton
|
||||||
|
.br
|
||||||
|
Copyright \(co 2002\-2014 Chris Schoeneman
|
|
@ -1,47 +0,0 @@
|
||||||
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.38.2.
|
|
||||||
.TH BARRIERC "1" "June 2010" "barrierc 1.5.0, protocol version 1.3" "User Commands"
|
|
||||||
.SH NAME
|
|
||||||
barrierc \- manual page for barrierc 1.5.0, protocol version 1.3
|
|
||||||
.SH SYNOPSIS
|
|
||||||
.B barrierc
|
|
||||||
[\fI--yscroll <delta>\fR] [\fI--daemon|--no-daemon\fR] [\fI--name <screen-name>\fR] [\fI--restart|--no-restart\fR] [\fI--debug <level>\fR] \fI<server-address>\fR
|
|
||||||
.SH DESCRIPTION
|
|
||||||
Connect to a barrier mouse/keyboard sharing server.
|
|
||||||
.TP
|
|
||||||
\fB\-d\fR, \fB\-\-debug\fR <level>
|
|
||||||
filter out log messages with priority below level.
|
|
||||||
level may be: FATAL, ERROR, WARNING, NOTE, INFO,
|
|
||||||
DEBUG, DEBUGn (1\-5).
|
|
||||||
.TP
|
|
||||||
\fB\-n\fR, \fB\-\-name\fR <screen\-name> use screen\-name instead the hostname to identify
|
|
||||||
this screen in the configuration.
|
|
||||||
.TP
|
|
||||||
\fB\-1\fR, \fB\-\-no\-restart\fR
|
|
||||||
do not try to restart on failure.
|
|
||||||
.PP
|
|
||||||
* \fB\-\-restart\fR restart the server automatically if it fails.
|
|
||||||
.TP
|
|
||||||
\fB\-l\fR \fB\-\-log\fR <file>
|
|
||||||
write log messages to file.
|
|
||||||
.TP
|
|
||||||
\fB\-f\fR, \fB\-\-no\-daemon\fR
|
|
||||||
run in the foreground.
|
|
||||||
.PP
|
|
||||||
* \fB\-\-daemon\fR run as a daemon.
|
|
||||||
.TP
|
|
||||||
\fB\-\-yscroll\fR <delta>
|
|
||||||
defines the vertical scrolling delta, which is
|
|
||||||
.TP
|
|
||||||
\fB\-h\fR, \fB\-\-help\fR
|
|
||||||
display this help and exit.
|
|
||||||
.TP
|
|
||||||
\fB\-\-version\fR
|
|
||||||
display version information and exit.
|
|
||||||
.PP
|
|
||||||
* marks defaults.
|
|
||||||
.PP
|
|
||||||
The server address is of the form: [<hostname>][:<port>]. The hostname
|
|
||||||
must be the address or hostname of the server. The port overrides the
|
|
||||||
default port, 24800.
|
|
||||||
.SH COPYRIGHT
|
|
||||||
Copyright \(co 2010 Chris Schoeneman, Nick Bolton, Sorin Sbarnea
|
|
|
@ -1,12 +1,13 @@
|
||||||
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.38.2.
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
|
||||||
.TH BARRIERS "1" "June 2010" "barriers 1.5.0, protocol version 1.3" "User Commands"
|
.TH BARRIERS "1" "March 2018" "barriers 2.0.0, protocol version 1.6" "User Commands"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
barriers \- manual page for barriers 1.5.0, protocol version 1.3
|
barriers \- Barrier Keyboard/Mouse Server
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B barriers
|
.B barriers
|
||||||
[\fI--address <address>\fR] [\fI--config <pathname>\fR] [\fI--daemon|--no-daemon\fR] [\fI--name <screen-name>\fR] [\fI--restart|--no-restart\fR] [\fI--debug <level>\fR]
|
[\fI\,--address <address>\/\fR] [\fI\,--config <pathname>\/\fR] [\fI\,--display <display>\/\fR] [\fI\,--no-xinitthreads\/\fR] [\fI\,--daemon|--no-daemon\/\fR] [\fI\,--name <screen-name>\/\fR] [\fI\,--restart|--no-restart\/\fR] [\fI\,--debug <level>\/\fR]
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
Start the barrier mouse/keyboard sharing server.
|
Start the barrier server component.
|
||||||
|
.SH OPTIONS
|
||||||
.TP
|
.TP
|
||||||
\fB\-a\fR, \fB\-\-address\fR <address>
|
\fB\-a\fR, \fB\-\-address\fR <address>
|
||||||
listen for clients on the given address.
|
listen for clients on the given address.
|
||||||
|
@ -17,23 +18,40 @@ use the named configuration file instead.
|
||||||
\fB\-d\fR, \fB\-\-debug\fR <level>
|
\fB\-d\fR, \fB\-\-debug\fR <level>
|
||||||
filter out log messages with priority below level.
|
filter out log messages with priority below level.
|
||||||
level may be: FATAL, ERROR, WARNING, NOTE, INFO,
|
level may be: FATAL, ERROR, WARNING, NOTE, INFO,
|
||||||
DEBUG, DEBUGn (1\-5).
|
DEBUG, DEBUG1, DEBUG2.
|
||||||
.TP
|
.TP
|
||||||
\fB\-n\fR, \fB\-\-name\fR <screen\-name> use screen\-name instead the hostname to identify
|
\fB\-n\fR, \fB\-\-name\fR <screen\-name> use screen\-name instead the hostname to identify
|
||||||
this screen in the configuration.
|
this screen in the configuration.
|
||||||
.TP
|
.TP
|
||||||
\fB\-1\fR, \fB\-\-no\-restart\fR
|
\fB\-1\fR, \fB\-\-no\-restart\fR
|
||||||
do not try to restart on failure.
|
do not try to restart on failure.
|
||||||
.PP
|
.TP
|
||||||
* \fB\-\-restart\fR restart the server automatically if it fails.
|
\fB\-\-restart\fR
|
||||||
|
restart the server automatically if it fails. (*)
|
||||||
.TP
|
.TP
|
||||||
\fB\-l\fR \fB\-\-log\fR <file>
|
\fB\-l\fR \fB\-\-log\fR <file>
|
||||||
write log messages to file.
|
write log messages to file.
|
||||||
.TP
|
.TP
|
||||||
|
\fB\-\-no\-tray\fR
|
||||||
|
disable the system tray icon.
|
||||||
|
.TP
|
||||||
|
\fB\-\-enable\-drag\-drop\fR
|
||||||
|
enable file drag & drop.
|
||||||
|
.TP
|
||||||
|
\fB\-\-enable\-crypto\fR
|
||||||
|
enable the crypto (ssl) plugin.
|
||||||
|
.TP
|
||||||
|
\fB\-\-display\fR <display>
|
||||||
|
connect to the X server at <display>
|
||||||
|
.TP
|
||||||
|
\fB\-\-no\-xinitthreads\fR
|
||||||
|
do not call XInitThreads()
|
||||||
|
.TP
|
||||||
\fB\-f\fR, \fB\-\-no\-daemon\fR
|
\fB\-f\fR, \fB\-\-no\-daemon\fR
|
||||||
run in the foreground.
|
run in the foreground.
|
||||||
.PP
|
.TP
|
||||||
* \fB\-\-daemon\fR run as a daemon.
|
\fB\-\-daemon\fR
|
||||||
|
run as a daemon. (*)
|
||||||
.TP
|
.TP
|
||||||
\fB\-h\fR, \fB\-\-help\fR
|
\fB\-h\fR, \fB\-\-help\fR
|
||||||
display this help and exit.
|
display this help and exit.
|
||||||
|
@ -41,7 +59,7 @@ display this help and exit.
|
||||||
\fB\-\-version\fR
|
\fB\-\-version\fR
|
||||||
display version information and exit.
|
display version information and exit.
|
||||||
.PP
|
.PP
|
||||||
* marks defaults.
|
Default options are marked with a *
|
||||||
.PP
|
.PP
|
||||||
The argument for \fB\-\-address\fR is of the form: [<hostname>][:<port>]. The
|
The argument for \fB\-\-address\fR is of the form: [<hostname>][:<port>]. The
|
||||||
hostname must be the address or hostname of an interface on the system.
|
hostname must be the address or hostname of an interface on the system.
|
||||||
|
@ -52,6 +70,12 @@ If no configuration file pathname is provided then the first of the
|
||||||
following to load successfully sets the configuration:
|
following to load successfully sets the configuration:
|
||||||
.IP
|
.IP
|
||||||
$HOME/.barrier.conf
|
$HOME/.barrier.conf
|
||||||
/etc/barrier.conf
|
\fI\,/etc/barrier.conf\/\fP
|
||||||
.SH COPYRIGHT
|
.SH COPYRIGHT
|
||||||
Copyright \(co 2010 Chris Schoeneman, Nick Bolton, Sorin Sbarnea
|
Copyright \(co 2018 Debauchee Open Source Group
|
||||||
|
.br
|
||||||
|
Copyright \(co 2012\-2016 Symless Ltd.
|
||||||
|
.br
|
||||||
|
Copyright \(co 2008\-2014 Nick Bolton
|
||||||
|
.br
|
||||||
|
Copyright \(co 2002\-2014 Chris Schoeneman
|
|
@ -160,7 +160,7 @@ private:
|
||||||
" -n, --name <screen-name> use screen-name instead the hostname to identify\n" \
|
" -n, --name <screen-name> use screen-name instead the hostname to identify\n" \
|
||||||
" this screen in the configuration.\n" \
|
" this screen in the configuration.\n" \
|
||||||
" -1, --no-restart do not try to restart on failure.\n" \
|
" -1, --no-restart do not try to restart on failure.\n" \
|
||||||
"* --restart restart the server automatically if it fails.\n" \
|
" --restart restart the server automatically if it fails. (*)\n" \
|
||||||
" -l --log <file> write log messages to file.\n" \
|
" -l --log <file> write log messages to file.\n" \
|
||||||
" --no-tray disable the system tray icon.\n" \
|
" --no-tray disable the system tray icon.\n" \
|
||||||
" --enable-drag-drop enable file drag & drop.\n" \
|
" --enable-drag-drop enable file drag & drop.\n" \
|
||||||
|
@ -183,7 +183,7 @@ private:
|
||||||
" [--daemon|--no-daemon]"
|
" [--daemon|--no-daemon]"
|
||||||
# define HELP_SYS_INFO \
|
# define HELP_SYS_INFO \
|
||||||
" -f, --no-daemon run in the foreground.\n" \
|
" -f, --no-daemon run in the foreground.\n" \
|
||||||
"* --daemon run as a daemon.\n"
|
" --daemon run as a daemon. (*)\n"
|
||||||
|
|
||||||
#elif SYSAPI_WIN32
|
#elif SYSAPI_WIN32
|
||||||
|
|
||||||
|
|
|
@ -112,6 +112,9 @@ ArgParser::parseClientArgs(ClientArgs& args, int argc, const char* const* argv)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (args.m_shouldExit)
|
||||||
|
return true;
|
||||||
|
|
||||||
// exactly one non-option argument (server-address)
|
// exactly one non-option argument (server-address)
|
||||||
if (i == argc) {
|
if (i == argc) {
|
||||||
LOG((CLOG_PRINT "%s: a server address or name is required" BYE,
|
LOG((CLOG_PRINT "%s: a server address or name is required" BYE,
|
||||||
|
|
|
@ -122,6 +122,8 @@ ClientApp::help()
|
||||||
char buffer[2000];
|
char buffer[2000];
|
||||||
sprintf(
|
sprintf(
|
||||||
buffer,
|
buffer,
|
||||||
|
"Start the barrier client and connect to a remote server component.\n"
|
||||||
|
"\n"
|
||||||
"Usage: %s"
|
"Usage: %s"
|
||||||
" [--yscroll <delta>]"
|
" [--yscroll <delta>]"
|
||||||
WINAPI_ARG
|
WINAPI_ARG
|
||||||
|
@ -129,8 +131,7 @@ ClientApp::help()
|
||||||
HELP_COMMON_ARGS
|
HELP_COMMON_ARGS
|
||||||
" <server-address>"
|
" <server-address>"
|
||||||
"\n\n"
|
"\n\n"
|
||||||
"Connect to a barrier mouse/keyboard sharing server.\n"
|
"Options:\n"
|
||||||
"\n"
|
|
||||||
HELP_COMMON_INFO_1
|
HELP_COMMON_INFO_1
|
||||||
WINAPI_INFO
|
WINAPI_INFO
|
||||||
HELP_SYS_INFO
|
HELP_SYS_INFO
|
||||||
|
@ -138,7 +139,7 @@ ClientApp::help()
|
||||||
" 120 by default.\n"
|
" 120 by default.\n"
|
||||||
HELP_COMMON_INFO_2
|
HELP_COMMON_INFO_2
|
||||||
"\n"
|
"\n"
|
||||||
"* marks defaults.\n"
|
"Default options are marked with a *\n"
|
||||||
"\n"
|
"\n"
|
||||||
"The server address is of the form: [<hostname>][:<port>]. The hostname\n"
|
"The server address is of the form: [<hostname>][:<port>]. The hostname\n"
|
||||||
"must be the address or hostname of the server. The port overrides the\n"
|
"must be the address or hostname of the server. The port overrides the\n"
|
||||||
|
|
|
@ -123,6 +123,8 @@ ServerApp::help()
|
||||||
char buffer[3000];
|
char buffer[3000];
|
||||||
sprintf(
|
sprintf(
|
||||||
buffer,
|
buffer,
|
||||||
|
"Start the barrier server component.\n"
|
||||||
|
"\n"
|
||||||
"Usage: %s"
|
"Usage: %s"
|
||||||
" [--address <address>]"
|
" [--address <address>]"
|
||||||
" [--config <pathname>]"
|
" [--config <pathname>]"
|
||||||
|
@ -130,8 +132,7 @@ ServerApp::help()
|
||||||
HELP_SYS_ARGS
|
HELP_SYS_ARGS
|
||||||
HELP_COMMON_ARGS
|
HELP_COMMON_ARGS
|
||||||
"\n\n"
|
"\n\n"
|
||||||
"Start the barrier mouse/keyboard sharing server.\n"
|
"Options:\n"
|
||||||
"\n"
|
|
||||||
" -a, --address <address> listen for clients on the given address.\n"
|
" -a, --address <address> listen for clients on the given address.\n"
|
||||||
" -c, --config <pathname> use the named configuration file instead.\n"
|
" -c, --config <pathname> use the named configuration file instead.\n"
|
||||||
HELP_COMMON_INFO_1
|
HELP_COMMON_INFO_1
|
||||||
|
@ -139,7 +140,7 @@ ServerApp::help()
|
||||||
HELP_SYS_INFO
|
HELP_SYS_INFO
|
||||||
HELP_COMMON_INFO_2
|
HELP_COMMON_INFO_2
|
||||||
"\n"
|
"\n"
|
||||||
"* marks defaults.\n"
|
"Default options are marked with a *\n"
|
||||||
"\n"
|
"\n"
|
||||||
"The argument for --address is of the form: [<hostname>][:<port>]. The\n"
|
"The argument for --address is of the form: [<hostname>][:<port>]. The\n"
|
||||||
"hostname must be the address or hostname of an interface on the system.\n"
|
"hostname must be the address or hostname of an interface on the system.\n"
|
||||||
|
@ -148,10 +149,10 @@ ServerApp::help()
|
||||||
"\n"
|
"\n"
|
||||||
"If no configuration file pathname is provided then the first of the\n"
|
"If no configuration file pathname is provided then the first of the\n"
|
||||||
"following to load successfully sets the configuration:\n"
|
"following to load successfully sets the configuration:\n"
|
||||||
" %s\n"
|
" $HOME/%s\n"
|
||||||
" %s\n",
|
" %s\n",
|
||||||
args().m_pname, kDefaultPort,
|
args().m_pname, kDefaultPort,
|
||||||
ARCH->concatPath(ARCH->getUserDirectory(), USR_CONFIG_NAME).c_str(),
|
USR_CONFIG_NAME,
|
||||||
ARCH->concatPath(ARCH->getSystemDirectory(), SYS_CONFIG_NAME).c_str()
|
ARCH->concatPath(ARCH->getSystemDirectory(), SYS_CONFIG_NAME).c_str()
|
||||||
);
|
);
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue