rayelliott
/
barrier
mirror of https://github.com/debauchee/barrier.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
barrier/doc/barriers.1

88 lines
2.6 KiB
Groff
Raw Normal View History

Man page: fix incorrect name of user conf file in barriers.1 The leading dot was lost in documentation in previous change while moving file to another directory. The usage of leading dot in non-home folder is not a common practice, but this is the current behavior, and this commit just update man page to match the code. Also the man pages has a not that they are auto-generated by help2man. I used help2man to update them, but it's output has some problems (wrong formatting of copyrights). So in addition to the only important change (naming fix) there is some more changes: * Formatting manually added to the list of config files. * New option --screen-change-script auto-added by help2man * Man files themselves and doc/UpdateManpages.txt now mention that some manual work is needed after help2man
2019-11-21 18:13:45 +00:00
.\" See UpdateManpages.txt about modification of this file. Most of it was generated by help2man 1.47.8.
Prepare for v2.3.3 release
2020-07-14 17:37:45 +00:00
.TH BARRIERS "1" "November 2019" "barriers 2.3.3-release" "User Commands"
moving 1.4 to trunk
2012-06-10 16:50:54 +00:00
.SH NAME
update manpages and --help output. fixes #23
2018-03-13 20:55:07 +00:00
barriers \- Barrier Keyboard/Mouse Server
moving 1.4 to trunk
2012-06-10 16:50:54 +00:00
.SH SYNOPSIS
rebranding symless/synergy to debauchee/barrier
2018-01-27 21:48:17 +00:00
.B barriers
update manpages and --help output. fixes #23
2018-03-13 20:55:07 +00:00
[\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]
moving 1.4 to trunk
2012-06-10 16:50:54 +00:00
.SH DESCRIPTION
update manpages and --help output. fixes #23
2018-03-13 20:55:07 +00:00
Start the barrier server component.
.SH OPTIONS
moving 1.4 to trunk
2012-06-10 16:50:54 +00:00
.TP
\fB\-a\fR, \fB\-\-address\fR <address>
listen for clients on the given address.
.TP
\fB\-c\fR, \fB\-\-config\fR <pathname>
use the named configuration file instead.
.TP
\fB\-d\fR, \fB\-\-debug\fR <level>
filter out log messages with priority below level.
level may be: FATAL, ERROR, WARNING, NOTE, INFO,
update manpages and --help output. fixes #23
2018-03-13 20:55:07 +00:00
DEBUG, DEBUG1, DEBUG2.
moving 1.4 to trunk
2012-06-10 16:50:54 +00:00
.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.
update manpages and --help output. fixes #23
2018-03-13 20:55:07 +00:00
.TP
\fB\-\-restart\fR
restart the server automatically if it fails. (*)
moving 1.4 to trunk
2012-06-10 16:50:54 +00:00
.TP
\fB\-l\fR \fB\-\-log\fR <file>
write log messages to file.
.TP
update manpages and --help output. fixes #23
2018-03-13 20:55:07 +00:00
\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
Man page: fix incorrect name of user conf file in barriers.1 The leading dot was lost in documentation in previous change while moving file to another directory. The usage of leading dot in non-home folder is not a common practice, but this is the current behavior, and this commit just update man page to match the code. Also the man pages has a not that they are auto-generated by help2man. I used help2man to update them, but it's output has some problems (wrong formatting of copyrights). So in addition to the only important change (naming fix) there is some more changes: * Formatting manually added to the list of config files. * New option --screen-change-script auto-added by help2man * Man files themselves and doc/UpdateManpages.txt now mention that some manual work is needed after help2man
2019-11-21 18:13:45 +00:00
\fB\-\-screen\-change\-script\fR <path>
full path to script to run on screen change
first argument is the new screen name
.TP
moving 1.4 to trunk
2012-06-10 16:50:54 +00:00
\fB\-f\fR, \fB\-\-no\-daemon\fR
run in the foreground.
update manpages and --help output. fixes #23
2018-03-13 20:55:07 +00:00
.TP
\fB\-\-daemon\fR
run as a daemon. (*)
moving 1.4 to trunk
2012-06-10 16:50:54 +00:00
.TP
\fB\-h\fR, \fB\-\-help\fR
display this help and exit.
.TP
\fB\-\-version\fR
display version information and exit.
.PP
update manpages and --help output. fixes #23
2018-03-13 20:55:07 +00:00
Default options are marked with a *
moving 1.4 to trunk
2012-06-10 16:50:54 +00:00
.PP
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.
update manpages
2018-05-12 22:35:18 +00:00
Placing brackets around an IPv6 address is required when also specifying
a port number and optional otherwise. The default is to listen on all
interfaces using port number 24800.
Man page: fix incorrect name of user conf file in barriers.1 The leading dot was lost in documentation in previous change while moving file to another directory. The usage of leading dot in non-home folder is not a common practice, but this is the current behavior, and this commit just update man page to match the code. Also the man pages has a not that they are auto-generated by help2man. I used help2man to update them, but it's output has some problems (wrong formatting of copyrights). So in addition to the only important change (naming fix) there is some more changes: * Formatting manually added to the list of config files. * New option --screen-change-script auto-added by help2man * Man files themselves and doc/UpdateManpages.txt now mention that some manual work is needed after help2man
2019-11-21 18:13:45 +00:00
.SH FILES
moving 1.4 to trunk
2012-06-10 16:50:54 +00:00
If no configuration file pathname is provided then the first of the
following to load successfully sets the configuration:
.IP
Man page: fix incorrect name of user conf file in barriers.1 The leading dot was lost in documentation in previous change while moving file to another directory. The usage of leading dot in non-home folder is not a common practice, but this is the current behavior, and this commit just update man page to match the code. Also the man pages has a not that they are auto-generated by help2man. I used help2man to update them, but it's output has some problems (wrong formatting of copyrights). So in addition to the only important change (naming fix) there is some more changes: * Formatting manually added to the list of config files. * New option --screen-change-script auto-added by help2man * Man files themselves and doc/UpdateManpages.txt now mention that some manual work is needed after help2man
2019-11-21 18:13:45 +00:00
.I $HOME/.local/share/barrier/.barrier.conf
.br
.I /etc/barrier.conf
moving 1.4 to trunk
2012-06-10 16:50:54 +00:00
.SH COPYRIGHT
update manpages and --help output. fixes #23
2018-03-13 20:55:07 +00:00
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