Linux Certif

Toute la documentation sur la certification Linux LPI

synergys

NAME

synergys --- Synergy serv

SYNOPSIS

synergys [--adress address | -a address ] [--config pathname | -c pathname ] [--debug level | -d level ] [--daemon | { --no-daemon | -f } ] [--name name | -n name ] [--restart | { --no-restart | -1 } ] address

synergys { --help | -h }

synergys --version

DESCRIPTION

This manual page documents briefly the synergys command.

synergys is the server program of Synergy. It allows you to share it's mouse and keyboard with other Synergy clients.

This manual page was written for the Debian distribution because the original program does not have a manual page. The contents is mainly taken from the file INSTALL from the upstream package.

OPTIONS

This program follows the usual GNU command line syntax, with long options starting with two dashes (`-'). A summary of options is included below.

-a address --address address

Listen for connections on the given address.

address has one of the following forms:
 

•

hostname

•

:port

•

hostname:port

 

hostname is a hostname or address of a network interface on the server system. port is a port number from 1 to 65535. hostname defaults to the system's hostname and port defaults to 24800.
 

-c pathname --config pathname

Red configuration from pathname.

If no configuration file pathname is provided then the first of the following to load sets the configuration:
 

•

~/.synergy.conf

•

/etc/synergy.conf

 

If no configuration file can be loaded then the configuration uses its defaults with just the server screen.
 

-d level --debug level

Use debugging level level.

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, and to syslog when running as a daemon.

--daemon

Run as a daemon.

-f --no-daemon

Run in the foreground.

-n name --name name

Use name instead of the hostname.

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

--restart

Automatically retart on failure.

The server will not automatically restart if an error occurs that is sure to happen every time, e. g. if it can't find itself in the configuration file or if the connection to the X server is lost.

-1 --no-restart

Do not restart on failure.

-h --help

Print help and exit.

--version

Print 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> 
 end 
 

Comments are introduced by `#' and continue to the end of the line. The file can have the following 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.

Example:

 
           section: screens 
             moe: 
             larry: 
             curly: 
           end 
 

This declares three screens named: moe, larry, and curly.

•

links

args is a list of screen names just like in the `screens' section except each screen is followed by a list of links. 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 
           end 
 

This 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 `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 
           end 
 

Screen `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.)

The synergy server will try certain pathnames to load the configuration file if the user doesn't specify a path using the `--config' command line option. `synergys --help' reports those pathnames.

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:

synergys-f [--config config-pathname]
  Replace config-pathname with the path to the configuration file. See OPTIONS for the default locations of the configuration file. The `-f' option causes synergys to run in the foreground. This is recommended until you've verified that the configuration works. If you didn't include the system's hostname in the configuration file (either as a screen name or an alias) then you'll have to add `--name screen-name' to the command line, where screen-name is a name in the configuration file. You can use `synergys --help' for a list of command line options.

STARTING AUTOMATICALLY

Synergy requires an X server. That means a server must be running and synergy must be authorized to connect to that server. I recommend to start the synergy server from a start script of your desktop environment or window manager. The commands should look something like this:

pkill synergys

synergys [options] [--config config-pathname]

If you are using GNOME, you can add the synergy server to the list of the non-session-managed startup programs. For doing this, start the control center, choose `Session Properties & Startup' and then `Startup Programs'. Add a new entry with the startup command /usr/bin/synergys.

options must not include `-f' or `--no-daemon'. It's important to make sure no old copies of synergy are running so they can't interfere with the new one.

SEE ALSO

synergyc(1)

AUTHOR

This manual page was written by Daniel Lutz <danlutz@debian.org> for the Debian system.