diff --git a/doc/UpdateManpages.txt b/doc/UpdateManpages.txt new file mode 100644 index 00000000..cdbe86f4 --- /dev/null +++ b/doc/UpdateManpages.txt @@ -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 diff --git a/doc/barrierc.1 b/doc/barrierc.1 new file mode 100644 index 00000000..404df900 --- /dev/null +++ b/doc/barrierc.1 @@ -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 \/\fR] [\fI\,--display \/\fR] [\fI\,--no-xinitthreads\/\fR] [\fI\,--daemon|--no-daemon\/\fR] [\fI\,--name \/\fR] [\fI\,--restart|--no-restart\/\fR] [\fI\,--debug \/\fR] \fI\,\/\fR +.SH DESCRIPTION +Start the barrier client and connect to a remote server component. +.SH OPTIONS +.TP +\fB\-d\fR, \fB\-\-debug\fR +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 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 +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 +connect to the X server at +.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 +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: [][:]. 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 diff --git a/doc/barrierc.man b/doc/barrierc.man deleted file mode 100644 index a1174c67..00000000 --- a/doc/barrierc.man +++ /dev/null @@ -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 \fR] [\fI--daemon|--no-daemon\fR] [\fI--name \fR] [\fI--restart|--no-restart\fR] [\fI--debug \fR] \fI\fR -.SH DESCRIPTION -Connect to a barrier mouse/keyboard sharing server. -.TP -\fB\-d\fR, \fB\-\-debug\fR -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 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 -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 -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: [][:]. 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 diff --git a/doc/barriers.man b/doc/barriers.1 similarity index 50% rename from doc/barriers.man rename to doc/barriers.1 index 64b9c385..655d4175 100644 --- a/doc/barriers.man +++ b/doc/barriers.1 @@ -1,12 +1,13 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.38.2. -.TH BARRIERS "1" "June 2010" "barriers 1.5.0, protocol version 1.3" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH BARRIERS "1" "March 2018" "barriers 2.0.0, protocol version 1.6" "User Commands" .SH NAME -barriers \- manual page for barriers 1.5.0, protocol version 1.3 +barriers \- Barrier Keyboard/Mouse Server .SH SYNOPSIS .B barriers -[\fI--address
\fR] [\fI--config \fR] [\fI--daemon|--no-daemon\fR] [\fI--name \fR] [\fI--restart|--no-restart\fR] [\fI--debug \fR] +[\fI\,--address
\/\fR] [\fI\,--config \/\fR] [\fI\,--display \/\fR] [\fI\,--no-xinitthreads\/\fR] [\fI\,--daemon|--no-daemon\/\fR] [\fI\,--name \/\fR] [\fI\,--restart|--no-restart\/\fR] [\fI\,--debug \/\fR] .SH DESCRIPTION -Start the barrier mouse/keyboard sharing server. +Start the barrier server component. +.SH OPTIONS .TP \fB\-a\fR, \fB\-\-address\fR
listen for clients on the given address. @@ -17,23 +18,40 @@ use the named configuration file instead. \fB\-d\fR, \fB\-\-debug\fR filter out log messages with priority below level. level may be: FATAL, ERROR, WARNING, NOTE, INFO, -DEBUG, DEBUGn (1\-5). +DEBUG, DEBUG1, DEBUG2. .TP \fB\-n\fR, \fB\-\-name\fR 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\-\-restart\fR +restart the server automatically if it fails. (*) .TP \fB\-l\fR \fB\-\-log\fR 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 +connect to the X server at +.TP +\fB\-\-no\-xinitthreads\fR +do not call XInitThreads() +.TP \fB\-f\fR, \fB\-\-no\-daemon\fR run in the foreground. -.PP -* \fB\-\-daemon\fR run as a daemon. +.TP +\fB\-\-daemon\fR +run as a daemon. (*) .TP \fB\-h\fR, \fB\-\-help\fR display this help and exit. @@ -41,7 +59,7 @@ display this help and exit. \fB\-\-version\fR display version information and exit. .PP -* marks defaults. +Default options are marked with a * .PP The argument for \fB\-\-address\fR is of the form: [][:]. The 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: .IP $HOME/.barrier.conf -/etc/barrier.conf +\fI\,/etc/barrier.conf\/\fP .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 diff --git a/src/lib/barrier/App.h b/src/lib/barrier/App.h index dccf6a67..b7c77a00 100644 --- a/src/lib/barrier/App.h +++ b/src/lib/barrier/App.h @@ -160,7 +160,7 @@ private: " -n, --name use screen-name instead the hostname to identify\n" \ " this screen in the configuration.\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 write log messages to file.\n" \ " --no-tray disable the system tray icon.\n" \ " --enable-drag-drop enable file drag & drop.\n" \ @@ -183,7 +183,7 @@ private: " [--daemon|--no-daemon]" # define HELP_SYS_INFO \ " -f, --no-daemon run in the foreground.\n" \ - "* --daemon run as a daemon.\n" + " --daemon run as a daemon. (*)\n" #elif SYSAPI_WIN32 diff --git a/src/lib/barrier/ArgParser.cpp b/src/lib/barrier/ArgParser.cpp index 88906542..20e849cf 100644 --- a/src/lib/barrier/ArgParser.cpp +++ b/src/lib/barrier/ArgParser.cpp @@ -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) if (i == argc) { LOG((CLOG_PRINT "%s: a server address or name is required" BYE, diff --git a/src/lib/barrier/ClientApp.cpp b/src/lib/barrier/ClientApp.cpp index 1da57cab..6986245a 100644 --- a/src/lib/barrier/ClientApp.cpp +++ b/src/lib/barrier/ClientApp.cpp @@ -122,6 +122,8 @@ ClientApp::help() char buffer[2000]; sprintf( buffer, + "Start the barrier client and connect to a remote server component.\n" + "\n" "Usage: %s" " [--yscroll ]" WINAPI_ARG @@ -129,8 +131,7 @@ ClientApp::help() HELP_COMMON_ARGS " " "\n\n" - "Connect to a barrier mouse/keyboard sharing server.\n" - "\n" + "Options:\n" HELP_COMMON_INFO_1 WINAPI_INFO HELP_SYS_INFO @@ -138,7 +139,7 @@ ClientApp::help() " 120 by default.\n" HELP_COMMON_INFO_2 "\n" - "* marks defaults.\n" + "Default options are marked with a *\n" "\n" "The server address is of the form: [][:]. The hostname\n" "must be the address or hostname of the server. The port overrides the\n" diff --git a/src/lib/barrier/ServerApp.cpp b/src/lib/barrier/ServerApp.cpp index 78292590..eb520cac 100644 --- a/src/lib/barrier/ServerApp.cpp +++ b/src/lib/barrier/ServerApp.cpp @@ -123,6 +123,8 @@ ServerApp::help() char buffer[3000]; sprintf( buffer, + "Start the barrier server component.\n" + "\n" "Usage: %s" " [--address
]" " [--config ]" @@ -130,8 +132,7 @@ ServerApp::help() HELP_SYS_ARGS HELP_COMMON_ARGS "\n\n" - "Start the barrier mouse/keyboard sharing server.\n" - "\n" + "Options:\n" " -a, --address
listen for clients on the given address.\n" " -c, --config use the named configuration file instead.\n" HELP_COMMON_INFO_1 @@ -139,7 +140,7 @@ ServerApp::help() HELP_SYS_INFO HELP_COMMON_INFO_2 "\n" - "* marks defaults.\n" + "Default options are marked with a *\n" "\n" "The argument for --address is of the form: [][:]. The\n" "hostname must be the address or hostname of an interface on the system.\n" @@ -148,10 +149,10 @@ ServerApp::help() "\n" "If no configuration file pathname is provided then the first of the\n" "following to load successfully sets the configuration:\n" - " %s\n" + " $HOME/%s\n" " %s\n", 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() );