Product: Synergy 1
Operating system: Windows, macOS, and Linux
Note - This is for more advanced users.
Running Synergy 1 from the command line can be useful in enterprise environments where you want to configure the software for an end-user via a text file.
Requirements
- Install Synergy
- Privileges to run commands
- Manually create a text config file for the server
Commands
First you need to move (cd) into the installation directory:
| Operating system | Command |
| Windows | cd "C:\Program Files\Synergy" |
| macOS | cd /Applications/Synergy.app/Contents/MacOS/ |
| Linux | cd /usr/bin |
Running in client mode:
| Operating system | Command |
| Windows | synergy-client [server IP] |
| macOS | ./synergy-client [server IP] |
| Linux | ./synergy-client [server IP] |
[Server IP] is unique to your setup, and is entered without square brackets ([]).
Running in server mode:
| Operating system | Command |
| Windows |
synergy-server -c [path to config file] |
| macOS | ./synergy-server -c [path to config file] |
| Linux | ./synergy-server -c [path to config file] |
[path to config file] is unique to your setup, and is entered without square brackets ([]).
Command line options
Options can be found under the --help command line option, an example below is from Windows 10:
C:\Program Files\Synergy>synergy-client --help
Usage: synergy-client [--address <address>] [--yscroll <delta>] [--sync-language] [--invert-scroll] [--host] [--service <action>] [--relaunch] [--exit-pause] [--name <screen-name>] [--restart|--no-restart] [--debug <level>] <server-address>
Connect to a Synergy mouse/keyboard sharing server.
-a, --address <address> local network interface address.
-d, --debug <level> filter out log messages with priority below level.
level may be: FATAL, ERROR, WARNING, NOTE, INFO,
DEBUG, DEBUG1, DEBUG2.
-n, --name <screen-name> use screen-name instead the hostname to identify
this screen in the configuration.
-1, --no-restart do not try to restart on failure.
* --restart restart the server automatically if it fails.
-l --log <file> write log messages to file.
--no-tray disable the system tray icon.
--enable-drag-drop enable file drag & drop.
--enable-crypto enable TLS encryption.
--tls-cert specify the path to the TLS certificate file.
--service <action> manage the windows service, valid options are:
install/uninstall/start/stop
--relaunch persistently relaunches process in current user
session (useful for vista and upward).
--exit-pause wait for key press on exit, can be useful for
reading error messages that occur on exit.
--yscroll <delta> defines the vertical scrolling delta,
which is 120 by default.
--sync-language enable language synchronization.
--invert-scroll invert scroll direction on this
computer.
--host act as a host; invert server/client mode
and listen instead of connecting.
-h, --help display this help and exit.
--version display version information and exit.
* marks defaults.
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.
Creating a text config file
Detailed explanation about the creating and editing a text config file can be found in our separate help article.