Added Mac OS X autostart documentation from Tor Slettnes (tor@slett.net).
This commit is contained in:
crs
parent
fc3f17fd83
commit
01fe5fb0a3
|
|
@ -98,28 +98,28 @@ in that order, before and instead of <span class="code">Default</span>.
|
|||
</p>
|
||||
<p>
|
||||
For a synergy client, add the following to the first file:
|
||||
<pre>
|
||||
<span class="codeblock">
|
||||
/usr/bin/killall synergyc
|
||||
sleep 1
|
||||
/usr/bin/synergyc [<options>] <span class="arg">synergy-server-hostname</span>
|
||||
</pre>
|
||||
</span>
|
||||
Of course, the path to synergyc depends on where you installed it
|
||||
so adjust as necessary.
|
||||
</p>
|
||||
<p>
|
||||
Add to the second file:
|
||||
<pre>
|
||||
<span class="codeblock">
|
||||
/usr/bin/killall synergyc
|
||||
sleep 1
|
||||
</pre>
|
||||
</span>
|
||||
</p>
|
||||
<p>
|
||||
And to the third file:
|
||||
<pre>
|
||||
<span class="codeblock">
|
||||
/usr/bin/killall synergyc
|
||||
sleep 1
|
||||
/usr/bin/synergyc <span class="arg">[<options>]</span> <span class="arg">synergy-server-hostname</span>
|
||||
</pre>
|
||||
</span>
|
||||
Note that <a href="running.html#options"><span class="arg"><options></span></a>
|
||||
must not include
|
||||
<span class="code">-f</span> or <span class="code">--no-daemon</span> or
|
||||
|
|
@ -152,7 +152,316 @@ would add to the third file above.
|
|||
|
||||
<h4>Mac OS X</h4>
|
||||
<p>
|
||||
TBD
|
||||
[By Tor Slettnes]
|
||||
</p>
|
||||
<p>
|
||||
There are three different ways to automatically start Synergy
|
||||
(client or server) on Mac OS X:
|
||||
</p>
|
||||
<p>
|
||||
<ol>
|
||||
<li>
|
||||
The first method involves creating a <span class="code">StartupItem</span>
|
||||
at the system level, which is executed when the machine starts up
|
||||
or shuts down. This script will run in the background, and
|
||||
relaunch synergy as needed.
|
||||
</p>
|
||||
<p>
|
||||
<dl>
|
||||
<dt><b>Pros:</b></dt>
|
||||
<dd>
|
||||
Synergy is persistent, so this allows for a multi-user
|
||||
setup and interactive logins.
|
||||
</dd>
|
||||
<dt><b>Cons:</b></dt>
|
||||
<dd>
|
||||
The synergy process does not have access to the clipboard
|
||||
of the logged-in user.
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
</p>
|
||||
<p>
|
||||
<li>
|
||||
The second method will launch Synergy from the
|
||||
<span class="code">LoginWindow</span> application, once a particular
|
||||
user has logged in.
|
||||
</p>
|
||||
<p>
|
||||
<dl>
|
||||
<dt><b>Pros:</b></dt>
|
||||
<dd>
|
||||
The synergy process inherits the
|
||||
<span class="code">$SECURITYSESSIONID</span> environment variable,
|
||||
and therefore copy/paste works.
|
||||
</dd>
|
||||
<dt><b>Cons:</b></dt>
|
||||
<dd>
|
||||
Once the user logs out, synergy dies, and no remote
|
||||
control is possible.
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
</p>
|
||||
<p>
|
||||
<li>
|
||||
The third method is to launch a startup script from the
|
||||
"Startup Items" tab under System Preferences -> Accounts.
|
||||
</p>
|
||||
<p>
|
||||
<dl>
|
||||
<dt><b>Pros:</b></dt>
|
||||
<dd>
|
||||
Does not require root (Administrator) access
|
||||
</dd>
|
||||
<dt><b>Cons:</b></dt>
|
||||
<dd>
|
||||
Once the user logs out, synergy dies, and no remote
|
||||
control is possible.
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
</ol>
|
||||
</p>
|
||||
<p>
|
||||
The text below describes how to implement a Synergy client using
|
||||
the first two methods simultaneously. This way, Synergy is
|
||||
always running, and the clipboard is available when someone is
|
||||
logged in. A Mac OS X Synergy server setup will be quite similar.
|
||||
</p>
|
||||
<p>
|
||||
<b>1. Create a System Level Startup Item</b>
|
||||
</p>
|
||||
<p>
|
||||
<ul>
|
||||
<li>
|
||||
Open a <span class="code">Terminal</span> window, and become root:
|
||||
<span class="userinput">
|
||||
$ sudo su -
|
||||
</span>
|
||||
</li>
|
||||
<li>
|
||||
Create a folder for this item:
|
||||
<span class="userinput">
|
||||
# mkdir -p /Library/StartupItems/Synergy
|
||||
</span>
|
||||
</li>
|
||||
<li>
|
||||
In this folder, create a new script file by the same name as
|
||||
the directory itself, <span class="code">Synergy</span>. This script
|
||||
should contain the following text:
|
||||
</p>
|
||||
<p>
|
||||
<span class="codeblock">
|
||||
#!/bin/sh
|
||||
. /etc/rc.common
|
||||
|
||||
run=(/usr/local/bin/synergyc -n $(hostname -s) -1 -f <span class="arg">synergy-server</span>)
|
||||
|
||||
KeepAlive ()
|
||||
{
|
||||
proc=${1##*/}
|
||||
|
||||
while [ -x "$1" ]
|
||||
do
|
||||
if ! ps axco command | grep -q "^${proc}\$"
|
||||
then
|
||||
"$@"
|
||||
fi
|
||||
|
||||
sleep 3
|
||||
done
|
||||
}
|
||||
|
||||
StartService ()
|
||||
{
|
||||
ConsoleMessage "Starting Synergy"
|
||||
KeepAlive "${run[@]}" &
|
||||
}
|
||||
|
||||
StopService ()
|
||||
{
|
||||
return 0
|
||||
}
|
||||
|
||||
RestartService ()
|
||||
{
|
||||
return 0
|
||||
}
|
||||
|
||||
RunService "$1"
|
||||
</span>
|
||||
</p>
|
||||
<p>
|
||||
However, replace <span class="arg">synergy-server</span> with the actual
|
||||
name or IP address of your Synergy server.
|
||||
</p>
|
||||
<p>
|
||||
Note that this scripts takes care <em>not</em> to start
|
||||
Synergy if another instance is currently running. This
|
||||
allows it to run in the background even when synergy is also
|
||||
started independently, e.g. from the <span class="code">LoginWindow</span>
|
||||
application as described below.
|
||||
</li>
|
||||
<li>
|
||||
Make this script executable:
|
||||
<span class="userinput">
|
||||
# chmod 755 /Library/StartupItems/Synergy/Synergy
|
||||
</span>
|
||||
</li>
|
||||
<li>
|
||||
In the same folder, create a file named
|
||||
<span class="code">StartupParameters.plist</span> containing:
|
||||
</p>
|
||||
<p>
|
||||
<span class="codeblock">
|
||||
{
|
||||
Description = "Synergy Client";
|
||||
Provides = ("synergy-client");
|
||||
Requires = "Network";
|
||||
OrderPreference = "None";
|
||||
}
|
||||
</span>
|
||||
</li>
|
||||
</ul>
|
||||
</p>
|
||||
<p>
|
||||
That's it! If you want to test this setup, you can run the
|
||||
startup script as follow:
|
||||
</p>
|
||||
<p>
|
||||
<span class="userinput">
|
||||
# /Library/StartupItems/Synergy/Synergy start
|
||||
</span>
|
||||
</p>
|
||||
<p>
|
||||
Any errors, as well as output from Synergy, will be shown in
|
||||
your terminal window.
|
||||
</p>
|
||||
<p>
|
||||
Next time you reboot, Synergy should start automatically.
|
||||
</p>
|
||||
<p>
|
||||
<b>2. Run Synergy When a User Logs In</b>
|
||||
</p>
|
||||
<p>
|
||||
Each time a user successfully logs in via the console, the
|
||||
<span class="code">LoginWindow</span> application creates a unique session
|
||||
cookie and stores it in the environment variable
|
||||
<span class="code">$SECURITYSESSIONID</span>. For copy and paste operations
|
||||
to work, Synergy needs access to this environment variable. In
|
||||
other words, Synergy needs to be launched (directly or
|
||||
indirectly) via the <span class="code">LoginWindow</span> application.
|
||||
</p>
|
||||
<p>
|
||||
However, in order to kill any synergy processes started at the
|
||||
system level (as described above), we need root access. Thus,
|
||||
launching Synergy within the User's environment (e.g. via the
|
||||
Startup Items tab in System Preferences -> Accounts) is not an
|
||||
option that work in conjunction with the method above.
|
||||
</p>
|
||||
<p>
|
||||
Fortunately, the <span class="code">LoginWindow</span> application provides
|
||||
a "hook" for running a custom program (as root, with the username provided as
|
||||
the first and only argument) once a user has authenticated, but
|
||||
before the user is logged in.
|
||||
</p>
|
||||
<p>
|
||||
Unfortunately, only one such hook is available. If you have
|
||||
already installed a Login Hook, you may need to add the text
|
||||
from below to your existing script, rather than creating a new
|
||||
one.
|
||||
</p>
|
||||
<p>
|
||||
<ul>
|
||||
<li>
|
||||
Launch a Terminal window, and become root:
|
||||
<span class="userinput">
|
||||
$ sudo su -
|
||||
</li>
|
||||
</p>
|
||||
<p>
|
||||
<li>
|
||||
Find out if a LoginHook already exists:
|
||||
<span class="userinput">
|
||||
# defaults read /Library/Preferences/com.apple.loginwindow LoginHook
|
||||
</span>
|
||||
</p>
|
||||
<p>
|
||||
This will either show the full path to a script or
|
||||
executable file, or the text:
|
||||
<span class="userinput">
|
||||
The domain/default pair of (/Library/Preferences/com.apple.loginwindow, LoginHook) does not exist
|
||||
</span>
|
||||
In the former case, you need to modify your existing script,
|
||||
and/or create a "superscript" which in turn calls your
|
||||
existing script plus the one we will create here.
|
||||
</p>
|
||||
<p>
|
||||
The rest of this text assumes that this item did not already
|
||||
exist, and that we will create a new script.
|
||||
</li>
|
||||
</p>
|
||||
<p>
|
||||
<li>
|
||||
Create a folder in which we will store our custom startup
|
||||
script:
|
||||
<span class="userinput">
|
||||
# mkdir -p /Library/LoginWindow
|
||||
</span>
|
||||
</li>
|
||||
</p>
|
||||
<p>
|
||||
<li>
|
||||
In this folder, create a new script file (let's name it
|
||||
<span class="code">LoginHook.sh</span>), containing the following text:
|
||||
</p>
|
||||
<p>
|
||||
<span class="codeblock">
|
||||
#!/bin/sh
|
||||
prog=(/usr/local/bin/synergyc -n $(hostname -s) --camp <span class="arg">ip-address-of-server</span>)
|
||||
|
||||
### Stop any currently running Synergy client
|
||||
killall ${prog[0]##*/}
|
||||
|
||||
### Start the new client
|
||||
exec "${prog[@]}"
|
||||
</span>
|
||||
</li>
|
||||
</p>
|
||||
<p>
|
||||
<li>
|
||||
Create a login hook to call the script you just created:
|
||||
<span class="userinput">
|
||||
# defaults write /Library/Preferences/com.apple.loginwindow \
|
||||
LoginHook /Library/LoginWindow/LoginHook.sh
|
||||
</span>
|
||||
You can instead type the above all on one line but remove the backslash.
|
||||
</li>
|
||||
</ul>
|
||||
</p>
|
||||
<p>
|
||||
When running the Synergy client, you may need to use the IP
|
||||
address of the Synergy server rather than its host name.
|
||||
Specifically, unless you have listed the server in your
|
||||
local <span class="code">/etc/hosts</span> file or in your local NetInfo
|
||||
database, name services (i.e. DNS) may not yet be available by the
|
||||
time you log in after power-up. <span class="code">synergyc</span> will
|
||||
quit if it cannot resolve the server name.
|
||||
</p>
|
||||
<p>
|
||||
(This is not an issue with the previous method, because the
|
||||
<span class="code">StartupItems.plist</span> file specifies that this
|
||||
script should not be run until "network" is available).
|
||||
</p>
|
||||
<p>
|
||||
<b>3. Good Luck!</b>
|
||||
</p>
|
||||
<p>
|
||||
Remember to look in your system log on both your server and your
|
||||
client(s) for clues to any problems you may have
|
||||
(<span class="code">/var/log/system.log</span> on your OS X box, typically
|
||||
<span class="code">/var/log/syslog</span> on Linux boxes).
|
||||
</p>
|
||||
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -116,6 +116,14 @@ pre {
|
|||
font-family: courier;
|
||||
}
|
||||
|
||||
.userinput {
|
||||
display: block;
|
||||
white-space: pre;
|
||||
font-family: courier;
|
||||
font-size: 87.5%;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.code {
|
||||
font-family: courier;
|
||||
}
|
||||
|
|
@ -124,6 +132,20 @@ pre {
|
|||
font-size: small;
|
||||
}
|
||||
|
||||
/* block of code */
|
||||
.codeblock {
|
||||
display: block;
|
||||
white-space: pre;
|
||||
font-family: courier;
|
||||
font-size: 87.5%;
|
||||
border: 1px solid #000000;
|
||||
padding: 1em;
|
||||
padding-top: 0em;
|
||||
margin: 1em;
|
||||
background-color: #cccccc;
|
||||
color: #000000;
|
||||
}
|
||||
|
||||
.fakelink {
|
||||
color: #6699ff;
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue