Documentation updates.
This commit is contained in:
crs
parent
68ecf48a70
commit
380369d331
28
FAQ
28
FAQ
|
|
@ -16,7 +16,8 @@ Questions
|
|||
11. Why isn't synergy ported to platform XYZ?
|
||||
12. My client can't connect. What's wrong?
|
||||
13. Linking fails on Solaris. What's wrong?
|
||||
|
||||
14. The screen saver never starts. Why not?
|
||||
15. I can't switch screens anymore for no apparent reason. Why?
|
||||
|
||||
Answers
|
||||
-------
|
||||
|
|
@ -163,3 +164,28 @@ Answers
|
|||
`configure' command line? Solaris puts the X11 includes and
|
||||
libraries in an unusual place and the above lets synergy find
|
||||
them.
|
||||
|
||||
14. The screen saver never starts. Why not?
|
||||
|
||||
If the synergy server is on X Windows then the screen saver will
|
||||
not start while the mouse is on a client screen. This is a
|
||||
consequence of how X Windows, synergy and xscreensaver work.
|
||||
|
||||
15. I can't switch screens anymore for no apparent reason. Why?
|
||||
|
||||
This sometimes happens but all the causes aren't yet known. One
|
||||
known cause is if the synergy server in running on Windows
|
||||
95/98/Me and a 16-bit application is in the foreground when the
|
||||
screen saver starts. Windows fails to notify synergy that the
|
||||
screen saver has started in this situation (which is a bug in
|
||||
Windows, not synergy) and synergy may intercept some keyboard
|
||||
input and divert it to a client when the screen saver is running.
|
||||
As a result, it's possible for the server system to believe a key
|
||||
is pressed when it really isn't. Typically, it's the return key
|
||||
and simply tapping it will allow synergy to switch screens again.
|
||||
|
||||
If this problem happens to you, try tapping the enter key to see
|
||||
if that solves the problem. If not, you can try running with
|
||||
debug logging (--debug DEBUG) and synergy will report exactly why
|
||||
it refuses to switch screens. If it claims a key is down then
|
||||
try tapping that key and see if that solves the problem.
|
||||
|
|
|
|||
118
INSTALL
118
INSTALL
|
|
@ -94,14 +94,18 @@ First configure the server. Click the `Server' radio button
|
|||
* Enter other names the server is known by
|
||||
* Click OK
|
||||
* Use `Add' to add your other computers
|
||||
* Using a computer's name as its screen name is recommended
|
||||
* Use the controls under `Layout' 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
|
||||
* 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'
|
||||
* This defaults to the computer's name (recommended)
|
||||
* Click `OK'
|
||||
* Click `Test'
|
||||
|
||||
The server will start and you'll see a console window with log messages
|
||||
|
|
@ -118,9 +122,10 @@ client computer. Then configure the client:
|
|||
* Enter the server's computer name in `Server Host Name'
|
||||
* Do not use any of the server's screen names, unless one of those
|
||||
is also the computer name
|
||||
* 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'
|
||||
* This defaults to the computer's name (recommended)
|
||||
* This must be one of the names in the server's `Screens' list
|
||||
* Click `OK'
|
||||
* Click `Test'
|
||||
|
||||
If all goes well, the client connects to the server successfully and
|
||||
|
|
@ -131,6 +136,13 @@ everything is working correctly, install the software on the other
|
|||
client computers (if any) and repeat the steps for configuring the
|
||||
client on each.
|
||||
|
||||
Once the clients and server are working you can stop the clients and
|
||||
server by clicking the `Stop' button on each computer or by right
|
||||
clicking on the tray icon (by the clock in the task bar) and choosing
|
||||
`Quit'. Then click `Start' on the server computer then on each of
|
||||
the clients. Synergy will start and the dialog window will close.
|
||||
You can stop synergy or check on its status using the tray icon.
|
||||
|
||||
See `Starting Automatically on Windows' below for configuring synergy
|
||||
to start automatically when the computer starts.
|
||||
|
||||
|
|
@ -146,30 +158,75 @@ plain text file broken into sections. Each section has the form:
|
|||
end
|
||||
|
||||
Comments are introduced by `#' and continue to the end of the line.
|
||||
The file can have the following sections.
|
||||
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
|
||||
end
|
||||
|
||||
This 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}
|
||||
This computer has a caps lock key that doesn't report a
|
||||
press and a release event when the user presses it but
|
||||
instead reports a press event when it's turned on and a
|
||||
release event when it's turned off. If caps lock acts
|
||||
strangely on all screens then you may need this option
|
||||
on the server screen. If it acts strangely on one
|
||||
screen then that screen may need the option.
|
||||
|
||||
halfDuplexNumLock = {true|false}
|
||||
This is identical to halfDuplexCapsLock except it
|
||||
applies to the num lock key.
|
||||
|
||||
shift = {shift|ctrl|alt|meta|super|none}
|
||||
ctrl = {shift|ctrl|alt|meta|super|none}
|
||||
alt = {shift|ctrl|alt|meta|super|none}
|
||||
meta = {shift|ctrl|alt|meta|super|none}
|
||||
super = {shift|ctrl|alt|meta|super|none}
|
||||
Map a modifier key pressed on the server's keyboard to
|
||||
a different modifier on this client. This option only
|
||||
has an effect on a client screen; it's accepted and
|
||||
ignored on the server screen.
|
||||
|
||||
You can map, say, the shift key to shift (the default),
|
||||
ctrl, alt, meta, super or nothing. Normally, you
|
||||
wouldn't remap shift or ctrl. You might, however, have
|
||||
an X11 server with meta bound to the Alt keys. To use
|
||||
this server effectively with a windows client, which
|
||||
doesn't use meta but uses alt extensively, you'll want
|
||||
the windows client to map meta to alt (using `meta =
|
||||
alt').
|
||||
|
||||
* 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.
|
||||
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:
|
||||
|
||||
|
|
@ -214,6 +271,47 @@ The file can have the following sections.
|
|||
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
|
||||
heatbeat = 5000
|
||||
switchDelay = 500
|
||||
end
|
||||
|
||||
You can use the following options:
|
||||
|
||||
heartbeat = N
|
||||
The server will expect each client to send a message no
|
||||
less than every N milliseconds. If no message arrives
|
||||
from a client within 3N seconds the server forces that
|
||||
client to disconnect.
|
||||
|
||||
If synergy fails to detect clients disconnecting while
|
||||
the server is sleeping or vice versa, try using this
|
||||
option.
|
||||
|
||||
switchDelay = N
|
||||
Synergy won't switch screens when the mouse reaches the
|
||||
edge of a screen unless it stays on the edge for N
|
||||
milliseconds. This helps prevent unintentional
|
||||
switching when working near the edge of a screen.
|
||||
|
||||
switchDoubleTap = N
|
||||
Synergy won't switch screens when the mouse reaches the
|
||||
edge of a screen unless it's moved away from the edge
|
||||
and then back to the edge within N milliseconds. With
|
||||
the option you have to quickly tap the edge twice to
|
||||
switch. This helps prevent unintentional switching
|
||||
when working near the edge of a screen.
|
||||
|
||||
You can use both the switchDelay and switchDoubleTap options at
|
||||
the same time. Synergy will switch when either requirement is
|
||||
satisfied.
|
||||
|
||||
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.
|
||||
|
|
@ -298,8 +396,8 @@ Starting Automatically on Windows
|
|||
|
||||
When all the clients work you're ready to have synergy start
|
||||
automatically each time the system (re)starts. Click `Stop' on all
|
||||
the clients then on the server'. Now click the `Configure' button by
|
||||
the text `Automatic Startup'. The `Auto Start' dialog will pop up.
|
||||
the clients then on the server'. Now click the `Configure...' button
|
||||
by the text `Automatic Startup'. The `Auto Start' dialog will pop up.
|
||||
If an error occurs then correct the problem and click `Configure'
|
||||
again.
|
||||
|
||||
|
|
|
|||
14
PORTING
14
PORTING
|
|
@ -169,15 +169,16 @@ following these guidelines.
|
|||
is a macro for `for' in lib/base/common.h when building under
|
||||
Microsoft Visual C++ that works around the fact that that compiler
|
||||
doesn't follow the new scoping rules. Use the macro if your
|
||||
compiler using the old scoping rules.
|
||||
compiler uses the old scoping rules.
|
||||
|
||||
* Standard C++ library
|
||||
The standard C++ library containers should always be used in favor
|
||||
of custom containers wherever reasonable. std::string is used
|
||||
throughout synergy but only as the CString typedef; always use
|
||||
CString, never std::string. Synergy avoids using auto_ptr due to
|
||||
some portability problems. Synergy makes limited use of standard
|
||||
algorithms and streams but they can be freely used in new code.
|
||||
CString, never std::string except in the arch library. Synergy
|
||||
avoids using auto_ptr due to some portability problems. Synergy
|
||||
makes limited use of standard algorithms and streams but they can
|
||||
be freely used in new code.
|
||||
|
||||
* Limited multiple inheritance
|
||||
Classes should inherit implementation from at most one superclass.
|
||||
|
|
@ -207,7 +208,7 @@ following these guidelines.
|
|||
should be private, not public or protected. This makes it much
|
||||
easier to track the use of a member when reading code. Protected
|
||||
data is not allowed because `protected' is a synonym for `public
|
||||
to my subclasses' and public data is Bad Thing. While it might
|
||||
to my subclasses' and public data is a Bad Thing. While it might
|
||||
seem okay in this limited situation, the situation is not at all
|
||||
limited since an arbitrary number of classes can be derived,
|
||||
directly or indirectly, from the class and any of those classes
|
||||
|
|
@ -219,6 +220,9 @@ following these guidelines.
|
|||
POD should have only public data members and non-copy constructors.
|
||||
It must not have any methods other than constructors, not even a
|
||||
destructor or assignment operators, nor protected or private data.
|
||||
Note that this definition of POD is not the definition used in the
|
||||
C++ standard, which limits the contained data types to types that
|
||||
have no constructors, destructors, or methods.
|
||||
|
||||
* Avoid using friend
|
||||
Avoid declaring friend functions or classes. They're sometimes
|
||||
|
|
|
|||
14
README
14
README
|
|
@ -63,7 +63,8 @@ Irix.
|
|||
Installation
|
||||
------------
|
||||
|
||||
See INSTALL for detailed build and installation instructions.
|
||||
See INSTALL for detailed build and installation instructions and for
|
||||
more information on configuring synergy.
|
||||
|
||||
|
||||
Quick Start
|
||||
|
|
@ -99,14 +100,18 @@ Third, you configure and start the server.
|
|||
* Enter other names the server is known by
|
||||
* Click OK
|
||||
* Use `Add' to add your other computers
|
||||
* Using a computer's name as its screen name is recommended
|
||||
* Use the controls under `Layout' 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
|
||||
* 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'
|
||||
* This defaults to the computer's name (recommended)
|
||||
* 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
|
||||
|
|
@ -159,9 +164,10 @@ Finally, start the clients.
|
|||
* Enter the server's computer name in `Server Host Name'
|
||||
* Do not use any of the server's screen names, unless one of those
|
||||
is also the computer name
|
||||
* 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'
|
||||
* This defaults to the computer's name (recommended)
|
||||
* This must be one of the names in the server's `Screens' list
|
||||
* Click `OK'
|
||||
* Click `Test'
|
||||
|
||||
If an error occurs you'll get a dialog box telling you synergy is
|
||||
|
|
|
|||
6
TODO
6
TODO
|
|
@ -12,9 +12,9 @@ Things to do to synergy, in no particular order:
|
|||
|
||||
* Provide taskbar feedback
|
||||
|
||||
An icon indicating synergy's state in the taskbar would be nice.
|
||||
It could also provide a means for viewing recent log messages,
|
||||
stopping synergy, and forcing disconnection.
|
||||
There's a tray icon on win32 for checking synergy's current status
|
||||
and to quit synergy. It'd be nice to have something similar on
|
||||
X11.
|
||||
|
||||
* Support non-ASCII keyboards
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue