other versions
- wheezy 1.3.8-2
- wheezy-backports 1.4.16-1~bpo70+1
- jessie 1.4.16-1+deb8u1
- testing 1.4.16-2
- unstable 1.4.16-2
- experimental 1.8.7-stable+dfsg.1-2
SYNERGYS(1) | SYNERGYS(1) |
NAME¶
synergys - synergy serverSYNOPSIS¶
synergys [ -a address | --address address ] [ -c pathname | --config pathname ] [ --crypto-pass password ] [ -d level | --debug level ] [ --display display ] [ --daemon | { --no-daemon | -f } ] [ -l log-file | --log log-file ] [ -n screen-name | --name screen-name ] [ --no-tray ] [ --no-xinitthreads ] [ --restart | { --no-restart | -1 } ] addressDESCRIPTION¶
Starts the synergys mouse/keyboard sharing server. Synergy lets you use one keyboard and mouse across multiple computers. To do so it requires that all the computers are connected to each other via TCP/IP networking. Most systems come with this installed. This manual page was written for the Debian distribution because the original program does not have a manual page.OPTIONS¶
- -a address --address address
- listen for clients on the given address.
- -c pathname --config pathname
- use the named configuration file instead.
- •
- ~/.synergy.conf
- •
- /etc/synergy.conf
- --crypto-pass password
- use password as the password for authenticating to the synergy server.
- -d level --debug level
- filter out log messages with priority below level.
- --display display
- connect to the X server at display
- --daemon
- run the server as a daemon.
- -f --no-daemon
- run the server in the foreground.
- -l log-file --log log-file
- write log messages to log-file
- -n screen-name --name screen-name
- use screen-name instead of the hostname to identify
this screen in the configuration.
- --no-tray
- disable the system tray icon.
- --no-xinitthreads
- disable Xlib threading support.
- --restart
- restart the server automatically if it fails.
- -1 --no-restart
- do not try to restart the server if it fails for some reason.
- -h --help
- display help and exit.
- --version
- display version information and exit.
CONFIGURING THE SERVER¶
The synergy server requires configuration. The configuration file is a plain text file broken into sections. Each section has the form:section: <name> <args> endComments are introduced by `#' and continue to the end of the line. The file can have the following sections. The `screens' section must appear before the `links' and `aliases' sections.
SCREENS¶
<args> is a list of screen names, one name per line, each followed by a colon. Names are arbitrary strings but they must be unique. The hostname of each computer is recommended. There must be a screen name for the server and each client. Each screen can specify a number of options. Options have the form `name = value' and a listed one per line after the screen name. Example:section: screens moe: larry: halfDuplexCapsLock = true halfDuplexNumLock = true curly: meta = alt endThis declares three screens named: moe, larry, and curly. Screen `larry' has half-duplex caps lock and num lock keys (see below) and screen `curly' converts the meta modifier key to the alt key. Screen can have the following options:
- •
- halfDuplexCapsLock = {true|false}
- •
- halfDuplexNumLock = {true|false}
- •
- xtestIsXineramaUnaware = {true|false}
- •
- Modifier keys:
LINKS¶
<args> is a list of screen names just like in the `screens' section except each screen is followed by a list of links, one per line. Each link has the form `<left|right|up|down> = <name>'. A link indicates which screen is adjacent in the given direction. Example:section: links moe: right = larry up = curly larry: left = moe up = curly curly: down = larry endThis indicates that screen `larry' is to the right of screen `moe' (so moving the cursor off the right edge of moe would make it appear at the left edge of larry), `curly' is above `moe', `moe' is to the left of `larry', `curly' is above `larry', and `larry' is below `curly'. Note that links do not have to be symmetrical; moving up from moe then down from curly lands the cursor on larry.
ALIASES¶
<args> is a list of screen names just like in the `screens' section except each screen is followed by a list of aliases, one per line *not* followed by a colon. An alias is a screen name and must be unique. During screen name lookup each alias is equivalent to the screen name it aliases. So a client can connect using its canonical screen name or any of its aliases. Example:section: aliases larry: larry.stooges.com curly: shemp endScreen `larry' is also known as `larry.stooges.com' and can connect as either name. Screen `curly' is also known as `shemp'. (Hey, it's just an example.)
OPTIONS¶
<args> is a list of lines of the form `name = value'. These set the global options. Example:section: options heartbeat = 5000 switchDelay = 500 endYou can use the following options:
- •
- heartbeat = N
- •
- switchDelay = N
- •
- switchDoubleTap = N
- •
- screenSaverSync = {true|false}
RUNNING THE SERVER¶
Run the server on the computer that has the keyboard and mouse to be shared. You must have prepared a configuration file before starting the server. The server should be started before the clients but that's not required. Run the synergy server on the server system using the following command line:CONFIGURE SYNERGY TO START AUTOMATICALLY¶
Synergy requires an X server. That means a server must be running and synergy must be authorized to connect to that server. It's best to have the display manager start synergy. You'll need the necessary (probably root) permission to modify the display manager configuration files. If you don't have that permission you can start synergy after logging in via the .xsession file. To start the server use something like:NETWORK SECURITY¶
By default, Synergy does not secure its communications in any way. This is dangerous, as all clipboard and mouse and keyboard events (e.g. typed passwords) are easily examined by anyone listening on the network. To turn on encryption and authentication support, use the --crypto-pass option on both client and server. In this mode, the connection will be encrypted, and the server will check the client's password against the one it was started with. If this level of security is not sufficient for some reason (see the BUGS section below for a possible reason), you can use SSH (secure shell) to provide strong authentication and encryption to synergy. SSH is available on Debian systems in the "openssh-server" and "openssh-client" packages, or from http://www.openssh.com/. On Windows you can use the Cygwin version of OpenSSH.24800:server-hostname:24800 server-hostname
BUGS¶
The cryptography support is fairly new, and to the extent it has been tested, it has not done well. Users are advised to further secure their synergy sessions using methods such as the SSH method described in the NETWORK SECURITY section above until its security has been verified independently.FILES¶
~/.synergy.conf, /etc/synergy.confSEE ALSO¶
synergyc(1), ssh(1)AUTHOR¶
This manual page was written by Daniel Lutz <danlutz@debian.org> for the Debian system. Edited by Titus Barik <barik@ieee.org> and Jeff Licquia <licquia@debian.org>.June 2, 2013 |