From 70e2d2b89a28edac1270b559298f6981468a9473 Mon Sep 17 00:00:00 2001 From: crs Date: Wed, 26 May 2004 20:20:23 +0000 Subject: [PATCH] Updated documentation. --- AUTHORS | 7 +- ChangeLog | 306 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ INSTALL | 43 ++++++-- NEWS | 17 +++ README | 16 ++- TODO | 4 +- 6 files changed, 372 insertions(+), 21 deletions(-) diff --git a/AUTHORS b/AUTHORS index 22f10267..c2aa5065 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,6 +1,7 @@ Synergy Authors =============== -Chris Schoeneman -- creator, maintainer, X11, Win32 -Ryan Breen -- Mac OS X port -Guido Poschta -- Windows installer +Chris Schoeneman -- Creator, owner, X11, Win32 +Ryan Breen -- Initial Mac OS X port +Guido Poschta -- Windows installer +Bertrand Landry Hetu -- Mac OS X port diff --git a/ChangeLog b/ChangeLog index 38a96f79..2e77a52c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,309 @@ +2004/05/26 19:23:32 crs +//depot/project/synergy/lib/common/MacOSXPrecomp.h +//depot/project/synergy/lib/common/common.h +//depot/project/synergy/lib/platform/COSXClipboardTextConverter.cpp +//depot/project/synergy/lib/platform/COSXClipboardTextConverter.h +//depot/project/synergy/lib/platform/COSXEventQueueBuffer.cpp +//depot/project/synergy/lib/platform/COSXKeyState.cpp +//depot/project/synergy/lib/platform/COSXKeyState.h +//depot/project/synergy/lib/platform/COSXScreen.cpp +//depot/project/synergy/lib/platform/COSXScreen.h +//depot/project/synergy/synergy.xcode/project.pbxproj + +Merged Bertrand's OS X changes. Also added support for mouse wheel +on OS X server. + +---------- +2004/05/18 20:32:13 crs +//depot/project/synergy/lib/platform/CMSWindowsScreen.cpp + +If the server manages to detect ctrl+alt+del it will no longer send +that to the client. If it did then the user could see the effect of +ctrl+alt+del on both the server and client which we never want. The +user can use ctrl+alt+pause to emulate ctrl+alt+del on the client. + +---------- +2004/05/18 20:26:48 crs +//depot/project/synergy/lib/platform/CXWindowsEventQueueBuffer.cpp +//depot/project/synergy/lib/platform/CXWindowsEventQueueBuffer.h + +Fixed bug that could allow multiple threads to simultaneously access +the X11 display connection. The only problematic method was +CXWindowsEventQueueBuffer::addEvent given that the other event queue +methods are only called from the main thread. + +---------- +2004/05/17 21:55:55 crs +//depot/project/synergy/cmd/synergyc/synergyc.cpp + +Fixed logging of connection to server. Was DEBUG now NOTE. + +---------- +2004/05/17 21:55:38 crs +//depot/project/synergy/lib/platform/CMSWindowsKeyState.cpp + +Fixed ctrl+alt+del emulation on win32 server. It was mapping +VK_DELETE to the keypad delete key. This key is not interpreted +on the client as causing ctrl+alt+del. + +---------- +2004/05/16 18:04:36 crs +//depot/project/synergy/lib/client/CServerProxy.cpp +//depot/project/synergy/lib/server/CClientProxy1_0.cpp +//depot/project/synergy/lib/synergy/ProtocolTypes.h + +Fixed handling of screen resolution changes. + +---------- +2004/05/16 18:03:36 crs +//depot/project/synergy/cmd/launcher/CAutoStart.cpp + +Changed (win NT) service to depend on the 'Browser' service to +ensure correct startup order. + +---------- +2004/05/16 18:02:49 crs +//depot/project/synergy/all.dsp +//depot/project/synergy/cmd/exec.dsp +//depot/project/synergy/cmd/launcher/launcher.dsp +//depot/project/synergy/cmd/synergyc/synergyc.dsp +//depot/project/synergy/cmd/synergys/synergys.dsp +//depot/project/synergy/dist/nullsoft/installer.dsp +//depot/project/synergy/dist/nullsoft/synergy.nsi +//depot/project/synergy/lib/arch/arch.dsp +//depot/project/synergy/lib/base/base.dsp +//depot/project/synergy/lib/client/client.dsp +//depot/project/synergy/lib/common/common.dsp +//depot/project/synergy/lib/io/io.dsp +//depot/project/synergy/lib/mt/mt.dsp +//depot/project/synergy/lib/net/net.dsp +//depot/project/synergy/lib/platform/makehook.dsp +//depot/project/synergy/lib/platform/platform.dsp +//depot/project/synergy/lib/platform/synrgyhk.dsp +//depot/project/synergy/lib/server/server.dsp +//depot/project/synergy/lib/synergy/libsynergy.dsp + +Changed VC++ projects to put release targets in ./build, debug +targets in ./debug, and intermediate files under ./gen. + +---------- +2004/05/15 19:44:05 crs +//depot/project/synergy/configure.in +//depot/project/synergy/lib/common/Version.h + +Changed version to 1.1.6. + +---------- +2004/05/15 19:43:33 crs +//depot/project/synergy/lib/platform/CMSWindowsScreen.cpp + +Avoided duplicate logging of screen size on win32. + +---------- +2004/05/15 19:41:46 crs +//depot/project/synergy/Makefile.am +//depot/project/synergy/configure.in +//depot/project/synergy/lib/common/common.h +//depot/project/synergy/lib/platform/COSXClipboard.cpp +//depot/project/synergy/lib/platform/COSXClipboard.h +//depot/project/synergy/lib/platform/COSXClipboardAnyTextConverter.cpp +//depot/project/synergy/lib/platform/COSXClipboardAnyTextConverter.h +//depot/project/synergy/lib/platform/COSXClipboardTextConverter.cpp +//depot/project/synergy/lib/platform/COSXClipboardTextConverter.h +//depot/project/synergy/lib/platform/COSXClipboardUTF16Converter.cpp +//depot/project/synergy/lib/platform/COSXClipboardUTF16Converter.h +//depot/project/synergy/lib/platform/COSXEventQueueBuffer.cpp +//depot/project/synergy/lib/platform/COSXEventQueueBuffer.h +//depot/project/synergy/lib/platform/COSXScreen.cpp +//depot/project/synergy/lib/platform/COSXScreen.h +//depot/project/synergy/lib/platform/Makefile.am +//depot/project/synergy/synergy.xcode/project.pbxproj + +Added bertrand landry hetu's mac OS X port to date. + +---------- +2004/05/12 20:28:00 crs +//depot/project/synergy/lib/platform/CXWindowsScreen.cpp +//depot/project/synergy/lib/platform/CXWindowsScreen.h + +Now restoring input focus when entering the screen to the window +that had the focus when the screen was left. + +---------- +2004/05/12 19:50:58 crs +//depot/project/synergy/lib/arch/CArchNetworkBSD.cpp +//depot/project/synergy/lib/arch/CArchNetworkWinsock.cpp + +Fixed thread reference leak in network code. + +---------- +2004/05/12 19:12:28 crs +//depot/project/synergy/configure.in + +Added configure option to enable debug builds. If not enabled then +asserts are disabled. + +---------- +2004/05/12 18:54:03 crs +//depot/project/synergy/lib/platform/CXWindowsClipboardBMPConverter.cpp + +Fixed build error in gcc 3.3. + +---------- +audrey2% ./nodist/p4tolog -p //depot/project/synergy/ -m 15 | less +audrey2% ./nodist/p4tolog -p //depot/project/synergy/ -m 15 +2004/05/26 19:23:32 crs +lib/common/MacOSXPrecomp.h +lib/common/common.h +lib/platform/COSXClipboardTextConverter.cpp +lib/platform/COSXClipboardTextConverter.h +lib/platform/COSXEventQueueBuffer.cpp +lib/platform/COSXKeyState.cpp +lib/platform/COSXKeyState.h +lib/platform/COSXScreen.cpp +lib/platform/COSXScreen.h +synergy.xcode/project.pbxproj + +Merged Bertrand's OS X changes. Also added support for mouse wheel +on OS X server. + +---------- +2004/05/18 20:32:13 crs +lib/platform/CMSWindowsScreen.cpp + +If the server manages to detect ctrl+alt+del it will no longer send +that to the client. If it did then the user could see the effect of +ctrl+alt+del on both the server and client which we never want. The +user can use ctrl+alt+pause to emulate ctrl+alt+del on the client. + +---------- +2004/05/18 20:26:48 crs +lib/platform/CXWindowsEventQueueBuffer.cpp +lib/platform/CXWindowsEventQueueBuffer.h + +Fixed bug that could allow multiple threads to simultaneously access +the X11 display connection. The only problematic method was +CXWindowsEventQueueBuffer::addEvent given that the other event queue +methods are only called from the main thread. + +---------- +2004/05/17 21:55:55 crs +cmd/synergyc/synergyc.cpp + +Fixed logging of connection to server. Was DEBUG now NOTE. + +---------- +2004/05/17 21:55:38 crs +lib/platform/CMSWindowsKeyState.cpp + +Fixed ctrl+alt+del emulation on win32 server. It was mapping +VK_DELETE to the keypad delete key. This key is not interpreted +on the client as causing ctrl+alt+del. + +---------- +2004/05/16 18:04:36 crs +lib/client/CServerProxy.cpp +lib/server/CClientProxy1_0.cpp +lib/synergy/ProtocolTypes.h + +Fixed handling of screen resolution changes. + +---------- +2004/05/16 18:03:36 crs +cmd/launcher/CAutoStart.cpp + +Changed (win NT) service to depend on the 'Browser' service to +ensure correct startup order. + +---------- +2004/05/16 18:02:49 crs +all.dsp +cmd/exec.dsp +cmd/launcher/launcher.dsp +cmd/synergyc/synergyc.dsp +cmd/synergys/synergys.dsp +dist/nullsoft/installer.dsp +dist/nullsoft/synergy.nsi +lib/arch/arch.dsp +lib/base/base.dsp +lib/client/client.dsp +lib/common/common.dsp +lib/io/io.dsp +lib/mt/mt.dsp +lib/net/net.dsp +lib/platform/makehook.dsp +lib/platform/platform.dsp +lib/platform/synrgyhk.dsp +lib/server/server.dsp +lib/synergy/libsynergy.dsp + +Changed VC++ projects to put release targets in ./build, debug +targets in ./debug, and intermediate files under ./gen. + +---------- +2004/05/15 19:44:05 crs +configure.in +lib/common/Version.h + +Changed version to 1.1.6. + +---------- +2004/05/15 19:43:33 crs +lib/platform/CMSWindowsScreen.cpp + +Avoided duplicate logging of screen size on win32. + +---------- +2004/05/15 19:41:46 crs +Makefile.am +configure.in +lib/common/common.h +lib/platform/COSXClipboard.cpp +lib/platform/COSXClipboard.h +lib/platform/COSXClipboardAnyTextConverter.cpp +lib/platform/COSXClipboardAnyTextConverter.h +lib/platform/COSXClipboardTextConverter.cpp +lib/platform/COSXClipboardTextConverter.h +lib/platform/COSXClipboardUTF16Converter.cpp +lib/platform/COSXClipboardUTF16Converter.h +lib/platform/COSXEventQueueBuffer.cpp +lib/platform/COSXEventQueueBuffer.h +lib/platform/COSXScreen.cpp +lib/platform/COSXScreen.h +lib/platform/Makefile.am +synergy.xcode/project.pbxproj + +Added bertrand landry hetu's mac OS X port to date. + +---------- +2004/05/12 20:28:00 crs +lib/platform/CXWindowsScreen.cpp +lib/platform/CXWindowsScreen.h + +Now restoring input focus when entering the screen to the window +that had the focus when the screen was left. + +---------- +2004/05/12 19:50:58 crs +lib/arch/CArchNetworkBSD.cpp +lib/arch/CArchNetworkWinsock.cpp + +Fixed thread reference leak in network code. + +---------- +2004/05/12 19:12:28 crs +configure.in + +Added configure option to enable debug builds. If not enabled then +asserts are disabled. + +---------- +2004/05/12 18:54:03 crs +lib/platform/CXWindowsClipboardBMPConverter.cpp + +Fixed build error in gcc 3.3. + +---------- 2004/05/04 20:45:06 crs cmd/launcher/CGlobalOptions.cpp cmd/launcher/launcher.rc diff --git a/INSTALL b/INSTALL index 0f2666a1..5bf35641 100644 --- a/INSTALL +++ b/INSTALL @@ -13,6 +13,9 @@ To build synergy from the sources you'll need the following: * gcc 2.95 (or up) * X11R4 or up headers and libraries + Mac OS X: + * XCode; or gcc 2.95 (or up) and make + In this document, "Unix" means any of the supported Unix or Unix-like (e.g. Linux) operating systems. @@ -20,7 +23,8 @@ In this document, "Unix" means any of the supported Unix or Unix-like Configuring the build --------------------- -This step is only necessary when building on Unix. +This step is only necessary when building on Unix or Mac OS X if not +using XCode. To configure the build for your platform use the configure script: @@ -43,9 +47,9 @@ Building Windows: Start VC++ and open `synergy.dsw'. Set the active configuration (Build | Set Active Configuration) to `All - Debug' or `All - Release' - then build. Binaries are built into ./Debug or ./Release. + then build. Binaries are built into ./debug or ./build. -Unix: +Unix or Mac OS X without XCode: Simply enter: make @@ -53,6 +57,10 @@ Unix: This will build the client and server and leave them in their respective source directories. +Mac OS X with XCode: + Start XCode and open the synery.xcode project. Build the 'all' + project using the Deployment flavor. + Installing ---------- @@ -72,12 +80,18 @@ Windows: * synergys.exe * synrgyhk.dll -Unix: +Unix or Mac OS X without XCode: make install will install the client and server into /usr/local/bin unless you specified a different directory when you ran configure. +Mac OS X with XCode: + Copy the following files from ./build to a convenient location: + + * synergyc + * synergys + See `Starting Automatically on ...' below for details on how to have synergy start up automatically when the computer starts. @@ -152,8 +166,8 @@ See `Starting Automatically on Windows' below for configuring synergy to start automatically when the computer starts. -Configuring the Server on Unix ------------------------------- +Configuring the Server on Unix or Mac OS X +------------------------------------------ The synergy server requires configuration. The configuration file is a plain text file broken into sections. Each section has the form: @@ -164,7 +178,8 @@ plain text file broken into sections. Each section has the form: Comments 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. +appear before the `links' and `aliases' sections. Use any text editor +to create the configuration file. * screens is a list of screen names, one name per line, each @@ -348,8 +363,8 @@ file if the user doesn't specify a path using the `--config' command line option. `synergys --help' reports those pathnames. -Running the Server on Unix --------------------------- +Running the Server on Unix or Mac OS X +-------------------------------------- Run the server on the computer that has the keyboard and mouse to be shared. You must have prepared a configuration file before @@ -374,8 +389,8 @@ See `Starting Automatically on Unix' below for running synergy automatically when the X server starts. -Running the Client on Unix --------------------------- +Running the Client on Unix or Mac OS X +-------------------------------------- Run the client on all computers that aren't the server using the following command line: @@ -500,6 +515,12 @@ prevent a synergy client from synthesizing mouse and keyboard input, though. +Starting Automatically on Mac OS X +---------------------------------- + +TBD + + Network Security ---------------- diff --git a/NEWS b/NEWS index e2888cab..eca065d9 100644 --- a/NEWS +++ b/NEWS @@ -1,6 +1,23 @@ Synergy News ============ +* May-26-2004 - Synergy 1.1.6 released + + Made following changes: + * Added preliminary Mac OS X support (client and server) + * Fixed ctrl+alt+del emulation on win32 + * Fixed ctrl+alt+del on win32 server acting on both client and server + * Fixed handling of screen resolution changes on win32 + * Fixed 'unexpected async reply' on X11 + * Added dependency to win32 service to avoid startup race condition + * Fixed reference count bug + * Keyboard input focus now restored on X11 (fixes loss of input in some games) + + The OS X port does not yet support: + * HTML and bitmap clipboard data + * Screen saver synchronization + * Non-US English keyboards + * May-05-2004 - Synergy 1.1.5 released Made following changes: diff --git a/README b/README index 5cdfc938..f67347a7 100644 --- a/README +++ b/README @@ -52,6 +52,8 @@ System Requirements * Microsoft Windows NT, Windows 2000, Windows XP (the Windows NT family); +* Mac OS X 10.3 (10.2 may work); + * Unix: X Windows version 11 revision 4 or up with the XTEST extension (use `xdpyinfo | grep XTEST' to check for XTEST). @@ -62,6 +64,12 @@ for other platforms are welcome (including patches that package binaries); See the contact information available off of the synergy home page or use the patch page on sourceforge. +The Mac OS X port is incomplete. It does not synchronize the screen saver, +only text clipboard data works (i.e. HTML and bitmap data do not work), +non-US English keyboards are untested and probably don't work, and there +may be problems with mouse pointer and mouse wheel acceleration. Other +problems should be filed as bugs (see BUGS). + Installation ------------ @@ -120,8 +128,8 @@ Third, you configure and start the server. read the log messages to determine the problem then correct it and try `Test' again. - Unix - ---- + Unix or MacOS X + --------------- Create a text file named synergy.conf with the following: section: screens @@ -175,8 +183,8 @@ Finally, start the clients. about to quit; read the log messages to determine the problem then correct it and try `Test' again. - Unix - ---- + Unix or MacOS X + --------------- To start a client, enter the following: diff --git a/TODO b/TODO index 5c05ce8b..bbb2a1aa 100644 --- a/TODO +++ b/TODO @@ -18,9 +18,7 @@ Things to do to synergy, in no particular order: * Port to other platforms - Most desired is MacOS X. Ryan Breen has a partial port to Mac OS X. - Only the client is ported and there is no clipboard or screen saver - support. It's available from http://www.ryanbreen.com/synergy. + The MacOS X port is still incomplete but getting close. * Write man/html pages