Running Synergy

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.

Step 1 - Choose a server

The first step is to pick which keyboard and mouse you want to share. The computer with that keyboard and mouse is called the "primary screen" and it runs the synergy server. All of the other computers are "secondary screens" and run the synergy client.

Step 2 - Install the software

Second, you install the software. Choose the appropriate package and install it. For example, on Windows you would run SynergyInstaller. You must install the software on all the computers that will share the mouse and keyboard (clients and server). On OS X you'll just have a folder with some documentation and two programs. You can put this folder anywhere.

Step 3 - Configure and start the server

Next you configure the server. You'll tell synergy the name of the primary and secondary screens, which screens are next to which, and choose desired options. On Windows there's a dialog box for setting the configuration. On other systems you'll create a simple text file.

Note that when you tell synergy that screen A is to the left of screen B this does not imply that B is to the right of A. You must explicitly indicate both relations. If you don't do both then when you're running synergy you'll find you're unable to leave one of the screens.

Windows
On Windows run synergy by double clicking on the synergy file. This brings up a dialog. Configure the server:

• Click the Share this computer's keyboard and mouse (server) radio button
• Click the Screens & Links Configure... button
• Click the + button to add the server to the Screens list
  • Enter the name of server (the computer's name is the recommended name)
  • Optionally enter other names the server is known by
  • Click OK
• Use the + button to add your other computers
  • Using a computer's name as its screen name is recommended
  • Choose desired screen options on the Add Screen dialog
• Use the controls under Links to link screens together
  • Click (once) on the server's name in the Screens list
  • Choose the screen to the left of the server; use --- if there is no screen to the left of the server
  • Choose the screens to the right, above and below the server
  • Repeat the above steps for all the other screens
• Click OK to close the Screens & Links dialog
• Use Options... to set desired options
• If the server's screen name is not the server's computer name:
  • Click Advanced...
  • Enter the server's screen name next to Screen Name
  • Click OK

Now click Test. The server will start and you'll see a console window with log messages telling you about synergy's progress. If an error occurs you'll get one or more dialog boxes telling you what the errors are; read the errors to determine the problem then correct them and try Test again. See Step 5 for typical errors.

Unix or Mac OS X
Create a text file named synergy.conf with the following:

    section: screens
       screen1:
       screen2:
    end
    section: links
       screen1:
           right = screen2
       screen2:
           left = screen1
    end

Now start the server. Normally synergy wants to run "in the background." It detaches from the terminal and doesn't have a visible window, effectively disappearing from view. Until you're sure your configuration works, you should start synergy "in the foreground" using the -f command line option.

On unix type the command below in a shell. If synergys is not in your PATH then use the full pathname.

    synergys -f --config synergy.conf

    -f --config 

Step 4 - Start the clients

Next you start the client on each computer that will share the server's keyboard and mouse.

Windows
On Windows run synergy by double clicking on the synergy file. This brings up a dialog. Configure the client:

• Click the Use another computer's shared keyboard and mouse (client) radio button
• Enter the server's computer name next to Other Computer's Host Name
  • This is not the server's screen name, unless you made that the server's host name as recommended
• If the client's screen name is not the client's computer name:
  • Click Advanced...
  • Enter the client's screen name next to Screen Name
  • Click OK

Now click Test.

Unix or Mac OS X
To start a client on unix, enter the following:

    synergyc -f server-host-name

On OS X open Terminal in the Utilities folder in the Applications folder. Drag the synergyc program from the synergy folder onto the Terminal window. The path to the synergys program will appear. Add the following to the same line and press enter:

    -f server-host-name

When you added the client to the server's configuration you chose a name for the client. If that name was not client's host name then you must tell the client the name you used. Instead of the above command use this instead:

    synergyc -f --name name server-host-name

Step 5 - Test

Clients should immediately report a successful connection or one or more error messages. Some typical problems and possible solutions are below. See the troubleshooting and the FAQ pages for more help.

• failed to open screen (X11 only)

  Check permission to open the X display;
  check that the DISPLAY environment variable is set
  use the --display command line option.

• address already in use

  Another program (maybe another copy of synergy) is using the synergy port; stop the other program or choose a different port in the Advanced... dialog. If you change the port you must make the same change on all of the clients, too.

• connection forcefully rejected

  The synergy client successfully contacted the server but synergy wasn't running or it's running on a different port. You may also see this if there's a firewall blocking the host or port. Make sure synergy is running on the server and check for a firewall.

• already connected

  Check that the synergy client isn't already running.

• refused client

  Add the client to the server's configuration file.

• connection timed out

  Check that server-host-name is correct.
  Check that you don't have a firewall blocking the server or synergy port.

• connection failed

  Check that server-host-name is correct.

When successful you should be able to move the mouse off the appropriate edges of your server's screen and have it appear on a client screen. Try to move the mouse to each screen and check all the configured links. Check the mouse buttons and wheel and try the keyboard on each client. You can also cut-and-paste text, HTML, and images across computers (HTML and images are not supported on OS X yet).

Step 6 - Run

Once everything works correctly, stop all the clients then the server. Then start the server with the Start button on Windows and without the -f option on Unix and Mac OS X. Finally start the clients similarly. On Windows before clicking Start you may want to set the Logging Level to Warning so the logging window doesn't pop up (because you currently can't close it, just minimize it).

You can also configure synergy to start automatically when your computer starts or when you log in. See the autostart guide for more information.

Command Line Options Guide

Common Command Line Options
The following options are supported by synergys and synergyc.

Debug levels are from highest to lowest: FATAL, ERROR, WARNING, NOTE, INFO, DEBUG, DEBUG1, and DEBUG2. Only messages at or above the given level are logged. Messages are logged to a terminal window when running in the foreground. Unix logs messages to syslog when running as a daemon. The Windows NT family logs messages to the event log when running as a service. The Windows 95 family shows FATAL log messages in a message box and others in a terminal window when running as a service.

The --name option lets the client or server use a name other than its hostname for its screen. This name is used when checking the configuration.

Neither the client nor server will automatically restart if an error occurs that is sure to happen every time. For example, the server will exit immediately if it can't find itself in the configuration. On X11 both the client and server will also terminate if the connection to the X server is lost (usually because it died).

Server Command Line Options

    synergys [options]

address has one of the following forms:

    hostname
    :port
    hostname:port

Client Command Line Options

    synergyc [options] address[:port]