1 .\" Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH UNISON 1 "September 23, 2001"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh disable hyphenation
10 .\" .hy enable hyphenation
11 .\" .ad l left justify
12 .\" .ad b justify to both left and right margins
13 .\" .nf disable filling
14 .\" .fi enable filling
15 .\" .br insert line break
16 .\" .sp <n> insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 unison \- a file-synchronization tool for Unix and Windows
20 .SH SYNOPSIS
21 .B unison
22 .RI [ options ]
23 .br
24 .B unison
25 root1 root2
26 .RI [ options ]
27 .br
28 .B unison
29 profilename
30 .RI [ options ]
31 .br
32 .B unison-gtk
33 .RI [ options ]
34 .SH DESCRIPTION
35 This manual page briefly documents Unison, and was written for the
36 Debian GNU/Linux distribution because the original program does not
37 have a manual page. For a full description, please refer to the
38 inbuilt documentation or the manuals in /usr/share/doc/unison/. The
39 unison-gtk binary has similar command-line options, but allows the user
40 to select and create profiles and configure options from within the
41 program.
42 .PP
43 Unison is a file-synchronization tool for Unix and Windows. It allows
44 two replicas of a collection of files and directories to be stored on
45 different hosts (or different disks on the same host), modified
46 separately, and then brought up to date by propagating the changes in
47 each replica to the other.
48 .PP
49 Unison offers several advantages over various synchronization methods
50 such as CVS, Coda, rsync, Intellisync, etc. Unison can run on and
51 synchronize between Windows and many UNIX platforms. Unison requires
52 no root privileges, system access or kernel changes to function. Unison
53 can synchronize changes to files and directories in both directions,
54 on the same machine, or across a network using ssh or a direct
55 socket connection.
56 .PP
57 Transfers are optimised using a version of the rsync protocol, making
58 it ideal for slower links. Unison has a clear and precise specification,
59 and is resilient to failure due to its careful handling of the replicas
60 and its private structures.
61 .SH OPTIONS
62 All Unison options are long, starting with one dash (`-') only.
63 A summary of options is included here. For a complete description,
64 see the inbuilt documentation or the manuals in /usr/share/doc/unison/.
65 .TP
66 .B \-addprefsto
67 specify a file to add new preferences to in interactive mode
68 .TP
69 .B \-addversionno
70 add version number to name of unison executable on server
71 .TP
72 .B \-auto
73 automatically accept default actions
74 .TP
75 .B \-backup xxx
76 add a regexp to the backup list
77 .TP
78 .B \-backups
79 keep backup copies of files (deprecated: use 'backup')
80 .TP
81 .B \-batch
82 batch mode: ask no questions at all
83 .TP
84 .B \-contactquietly
85 suppress the 'contacting server' message during startup
86 .TP
87 .B \-debug xxx
88 debug module xxx ('all' -> everything, 'verbose' -> more)
89 .TP
90 .B \-doc xxx
91 show documentation ('-doc topics' lists topics)
92 .TP
93 .B \-dumbtty
94 do not try to change terminal settings in text UI
95 .TP
96 .B \-editor xxx
97 command for displaying the output of the -merge program
98 .TP
99 .B \-fastcheck
100 do fast (and slightly unsafe) update detection on windows
101 .TP
102 .B \-follow xxx
103 add a regexp to the follow list
104 .TP
105 .B \-force xxx
106 force changes from this replica to the other
107 .TP
108 .B \-group
109 synchronize group
110 .TP
111 .B \-height n
112 height (in lines) of main window in graphical interface
113 .TP
114 .B \-ignore xxx
115 add a regexp to the ignore list
116 .TP
117 .B \-ignorecase
118 ignore upper/lowercase spelling of filenames
119 .TP
120 .B \-ignorenot xxx
121 add a regexp to the ignorenot list
122 .TP
123 .B \-killserver
124 kill server when done (even when using sockets)
125 .TP
126 .B \-log
127 record actions in file specified by logfile preference
128 .TP
129 .B \-logfile xxx
130 log file name
131 .TP
132 .B \-maxbackups n
133 number of backed up versions of a file to keep
134 .TP
135 .B \-merge xxx
136 command for merging conflicting files
137 .TP
138 .B \-merge2 xxx
139 command for merging files (when no common version exists)
140 .TP
141 .B \-numericids
142 don't map uid/gid values by user/group names
143 .TP
144 .B \-owner
145 synchronize owner
146 .TP
147 .B \-path xxx
148 path to synchronize
149 .TP
150 .B \-perms n
151 part of the permissions which is synchronized
152 .TP
153 .B \-prefer xxx
154 choose this replica's version in case of conflict
155 .TP
156 .B \-root xxx
157 root of a replica
158 .TP
159 .B \-rootalias xxx
160 register alias for canonical root names
161 .TP
162 .B \-rshargs xxx
163 other arguments (if any) for remote shell command
164 .TP
165 .B \-rshcmd xxx
166 path to the rsh executable
167 .TP
168 .B \-servercmd xxx
169 name of unison executable on remote server
170 .TP
171 .B \-silent
172 print nothing (except error messages)
173 .TP
174 .B \-socket xxx
175 act as a server on a socket
176 .TP
177 .B \-sortbysize
178 list changed files by size, not name
179 .TP
180 .B \-sortfirst xxx
181 add a regexp to the sortfirst list
182 .TP
183 .B \-sortlast xxx
184 add a regexp to the sortlast list
185 .TP
186 .B \-sortnewfirst
187 list new before changed files
188 .TP
189 .B \-sshcmd xxx
190 path to the ssh executable
191 .TP
192 .B \-statusdepth n
193 status display depth for local files
194 .TP
195 .B \-terse
196 suppress status messages
197 .TP
198 .B \-testserver
199 exit immediately after the connection to the server
200 .TP
201 .B \-times
202 synchronize modification times
203 .TP
204 .B \-ui xxx
205 select user interface ('text' or 'graphic')
206 .TP
207 .B \-version
208 print version and exit
209 .PP
210 Some preferences are just boolean flags. Others take numeric or string
211 arguments, indicated in the preferences list by n or xxx. Most of the
212 string preferences can be given several times; the arguments are
213 accumulated into a list internally.
214 .SH SEE ALSO
215 The program is documented fully in the in-built documentation and the
216 manual, available as HTML, PostScript and text in /usr/share/doc/unison/.
217 .SH AUTHOR
218 This manual page was written by Robert McQueen <robot101@debian.org>,
219 for the Debian GNU/Linux system (but may be used by others).
|
