Unison

From Openmoko

(Difference between revisions)
Jump to: navigation, search
(Unison File Synchronizer)
Line 1: Line 1:
== Unison File Synchronizer ==
+
== Overview ==
  
 
[http://www.cis.upenn.edu/~bcpierce/unison Unison] is a file-synchronization tool for Unix and Windows. It determines all differences between two directory trees and lets the user decide, how to proceed with every differing file.
 
[http://www.cis.upenn.edu/~bcpierce/unison Unison] is a file-synchronization tool for Unix and Windows. It determines all differences between two directory trees and lets the user decide, how to proceed with every differing file.
Line 10: Line 10:
 
* between two directory trees on the same computer or  
 
* between two directory trees on the same computer or  
 
* between directory trees on two separate machines.
 
* between directory trees on two separate machines.
 +
 
For syncing desktop machine and Neo we use the latter. The recommended way to do this is the [http://www.cis.upenn.edu/~bcpierce/unison/download/releases/stable/unison-manual.html#rshmeth remote shell method]:
 
For syncing desktop machine and Neo we use the latter. The recommended way to do this is the [http://www.cis.upenn.edu/~bcpierce/unison/download/releases/stable/unison-manual.html#rshmeth remote shell method]:
  
 
We start unison or unison-gtk on the desktop PC. The program will connect to the Neo via ssh and start a text-only instance of unison on the Neo to retrieve new files or deltas and to modify files on the Neo.
 
We start unison or unison-gtk on the desktop PC. The program will connect to the Neo via ssh and start a text-only instance of unison on the Neo to retrieve new files or deltas and to modify files on the Neo.
 +
 +
{{note|The following deals with Unsion on '''Linux'''. It should apply for a [http://wiki.openmoko.org/wiki/Neo1973_and_Windows#USB_Ethernet_emulation network connection from a Windows machine] as well. Check [http://www.cis.upenn.edu/~bcpierce/unison/download/releases/stable/unison-manual.html#ssh-win unison manual] for details!}}
 +
 +
 +
== SSH Setup ==
  
 
For this to work, ssh must not output any text itself, because unison parses the first line of console output to determine the version of unison on the remote computer:  
 
For this to work, ssh must not output any text itself, because unison parses the first line of console output to determine the version of unison on the remote computer:  
Line 18: Line 24:
 
* So we should setup ssh for public key authentication as described under [http://wiki.openmoko.org/wiki/USB_Networking#SSH_Keys USB Networking].
 
* So we should setup ssh for public key authentication as described under [http://wiki.openmoko.org/wiki/USB_Networking#SSH_Keys USB Networking].
 
* If you are working with more than one distribution to boot from or even with more than one device, I found it convenient to make them all use the same host key (/etc/dropbear/dropbear_rsa_host_key).
 
* If you are working with more than one distribution to boot from or even with more than one device, I found it convenient to make them all use the same host key (/etc/dropbear/dropbear_rsa_host_key).
 +
 +
== Installation ==
  
 
On the Neo we use the text version of unison. Since there's no native opkg file available currently, we take the [http://packages.debian.org/lenny/armel/unison/download debian package]. Extract the file unison-2.27.57, copy it to /usr/bin on neo and create a symlink by the name of unison!  
 
On the Neo we use the text version of unison. Since there's no native opkg file available currently, we take the [http://packages.debian.org/lenny/armel/unison/download debian package]. Extract the file unison-2.27.57, copy it to /usr/bin on neo and create a symlink by the name of unison!  
Line 27: Line 35:
 
</pre>
 
</pre>
  
Unison allows for multiple configuration profiles on the desktop PC (~/.unison/Openmoko.prf). Mine look like this:
+
== Configuration ==
 +
 
 +
Unison allows for multiple configuration profiles on the desktop PC. My ~/.unison/moko.prf looks like this:
 
<pre>
 
<pre>
 
# Unison preferences file
 
# Unison preferences file
Line 54: Line 64:
 
</pre>
 
</pre>
  
On first execution of unison on the desktop, unison will create hashes for the entire directory tree. This may take a while.
+
== Using Unison ==
 +
 
 +
On first execution of unison on the desktop with the above profile
 +
<pre>
 +
unison-gtk moko
 +
</pre>
 +
unison will create hashes for the entire directory tree. This may take a while.
  
Unison supports various preferences to interactively include programs for comparing and merging files during synchronization (see the [http://www.cis.upenn.edu/~bcpierce/unison/download/releases/stable/unison-manual.html manual]).
+
Unison can integrate programs for comparing and merging files during synchronization and offers a great number of other usefull options (see the [http://www.cis.upenn.edu/~bcpierce/unison/download/releases/stable/unison-manual.html manual]).

Revision as of 15:37, 25 November 2008

Contents

Overview

Unison is a file-synchronization tool for Unix and Windows. It determines all differences between two directory trees and lets the user decide, how to proceed with every differing file.

Unison comes in two flavors:

  • Text mode only version (debian package name: unison)
  • GTK-based graphical version (debian package name: unison-gtk)

Unison can sync

  • between two directory trees on the same computer or
  • between directory trees on two separate machines.

For syncing desktop machine and Neo we use the latter. The recommended way to do this is the remote shell method:

We start unison or unison-gtk on the desktop PC. The program will connect to the Neo via ssh and start a text-only instance of unison on the Neo to retrieve new files or deltas and to modify files on the Neo.

NOTE: The following deals with Unsion on Linux. It should apply for a network connection from a Windows machine as well. Check unison manual for details!



SSH Setup

For this to work, ssh must not output any text itself, because unison parses the first line of console output to determine the version of unison on the remote computer:

  • So we should setup ssh for public key authentication as described under USB Networking.
  • If you are working with more than one distribution to boot from or even with more than one device, I found it convenient to make them all use the same host key (/etc/dropbear/dropbear_rsa_host_key).

Installation

On the Neo we use the text version of unison. Since there's no native opkg file available currently, we take the debian package. Extract the file unison-2.27.57, copy it to /usr/bin on neo and create a symlink by the name of unison!

When calling Unison via ssh, the console must only show the unison version information:

user@desktoppc:~$ ssh moko unison -version
unison version 2.27.57

Configuration

Unison allows for multiple configuration profiles on the desktop PC. My ~/.unison/moko.prf looks like this:

# Unison preferences file

label      = Syncing Openmoko

# the directories on the desktop and on the neo
root       = /home/user/Openmoko/data
root       = ssh://root@moko//media/mmc4

# common options
include Common.opt


# Do not compare modification time
times      = false

########### Music ##############
path       =      music

########### GPS Data ###########
path       =      gps
ignore     = Path gps/Maps/*
ignorenot  = Path gps/Maps/OSM

Using Unison

On first execution of unison on the desktop with the above profile

unison-gtk moko

unison will create hashes for the entire directory tree. This may take a while.

Unison can integrate programs for comparing and merging files during synchronization and offers a great number of other usefull options (see the manual).

Personal tools

Unison File Synchronizer

Unison is a file-synchronization tool for Unix and Windows. It determines all differences between two directory trees and lets the user decide, how to proceed with every differing file.

Unison comes in two flavors:

  • Text mode only version (debian package name: unison)
  • GTK-based graphical version (debian package name: unison-gtk)

Unison can sync

  • between two directory trees on the same computer or
  • between directory trees on two separate machines.

For syncing desktop machine and Neo we use the latter. The recommended way to do this is the remote shell method:

We start unison or unison-gtk on the desktop PC. The program will connect to the Neo via ssh and start a text-only instance of unison on the Neo to retrieve new files or deltas and to modify files on the Neo.

For this to work, ssh must not output any text itself, because unison parses the first line of console output to determine the version of unison on the remote computer:

  • So we should setup ssh for public key authentication as described under USB Networking.
  • If you are working with more than one distribution to boot from or even with more than one device, I found it convenient to make them all use the same host key (/etc/dropbear/dropbear_rsa_host_key).

On the Neo we use the text version of unison. Since there's no native opkg file available currently, we take the debian package. Extract the file unison-2.27.57, copy it to /usr/bin on neo and create a symlink by the name of unison!

When calling Unison via ssh, the console must only show the unison version information:

user@desktoppc:~$ ssh moko unison -version
unison version 2.27.57

Unison allows for multiple configuration profiles on the desktop PC (~/.unison/Openmoko.prf). Mine look like this:

# Unison preferences file

label      = Syncing Openmoko

# the directories on the desktop and on the neo
root       = /home/user/Openmoko/data
root       = ssh://root@moko//media/mmc4

# common options
include Common.opt


# Do not compare modification time
times      = false

########### Music ##############
path       =      music

########### GPS Data ###########
path       =      gps
ignore     = Path gps/Maps/*
ignorenot  = Path gps/Maps/OSM

On first execution of unison on the desktop, unison will create hashes for the entire directory tree. This may take a while.

Unison supports various preferences to interactively include programs for comparing and merging files during synchronization (see the manual).