UNISON(1) General Commands Manual (urm) UNISON(1) (NAME) unison - (SYNOPSIS) unison [options] unison root1 root2 [options] unison profilename [options] (DESCRIPTION) Unison POSIX ( BSD* GNU/Linux macOS) Windows . (replica) ( ) . Unison . Unison . : o (mirroring) Unison . o Unison Windows Unix . o Unison : (superuser) FUSE . o Unison ssh(1) TCP . . rsync(1) . o Unison . . (OPTION SUMMARY) Basic options: General: -doc xxx show documentation ('-doc topics' lists topics) -version print version and exit What to sync: -group synchronize group attributes -ignore xxx add a pattern to the ignore list -ignorenot xxx add a pattern to the ignorenot list -nocreation xxx prevent file creations on one replica -nodeletion xxx prevent file deletions on one replica -noupdate xxx prevent file updates and deletions on one replica -owner synchronize owner -path xxx path to synchronize -perms n part of the permissions which is synchronized -root xxx root of a replica (should be used exactly twice) -times synchronize modification times How to sync: -batch batch mode: ask no questions at all How to sync (text interface (CLI) only): -auto automatically accept default (nonconflicting) actions -silent print nothing except error messages -terse suppress status messages Text interface (CLI): -i interactive profile mode (text UI); command-line only Advanced options: Fine-tune sync: -acl synchronize ACLs -atomic xxx add a pattern to the atomic list -follow xxx add a pattern to the follow list -force xxx force changes from this replica to the other -forcepartial xxx add a pattern to the forcepartial list -ignorecase xxx identify upper/lowercase filenames (true/false/default) -immutable xxx add a pattern to the immutable list -immutablenot xxx add a pattern to the immutablenot list -links xxx allow the synchronization of symbolic links (true/false/default) -merge xxx add a pattern to the merge list -moves-experimental optimize transfers by detecting renames and moves -nocreationpartial xxx add a pattern to the nocreationpartial list -nodeletionpartial xxx add a pattern to the nodeletionpartial list -noupdatepartial xxx add a pattern to the noupdatepartial list -prefer xxx choose this replica's version for conflicting changes -preferpartial xxx add a pattern to the preferpartial list -rsrc xxx synchronize resource forks (true/false/default) -xattrignore xxx add a pattern to the xattrignore list -xattrignorenot xxx add a pattern to the xattrignorenot list -xattrs synchronize extended attributes (xattrs) How to sync: -backup xxx add a pattern to the backup list -backupcurr xxx add a pattern to the backupcurr list -backupcurrnot xxx add a pattern to the backupcurrnot list -backupdir xxx directory for storing centralized backups -backuploc xxx where backups are stored ('local' or 'central') -backupnot xxx add a pattern to the backupnot list -backupprefix xxx prefix for the names of backup files -backups (deprecated) keep backup copies of all files (see also 'backup') -backupsuffix xxx a suffix to be added to names of backup files -confirmbigdel ask about whole-replica (or path) deletes (default true) -confirmmerge ask for confirmation before committing results of a merge -copyonconflict keep copies of conflicting files -dontchmod when set, never use the chmod system call -fastcheck xxx do fast update detection (true/false/default) -fat use appropriate options for FAT filesystems -ignoreinodenumbers ignore inode number changes when detecting updates -maxbackups n number of backed up versions of a file -numericids don't map uid/gid values by user/group names -sortbysize list changed files by size, not name -sortfirst xxx add a pattern to the sortfirst list -sortlast xxx add a pattern to the sortlast list -sortnewfirst list new before changed files How to sync (text interface (CLI) only): -repeat xxx synchronize repeatedly (text interface only) -retry n re-try failed synchronizations N times (text ui only) Text interface (CLI): -color xxx use color output for text UI (true/false/default) -dumbtty do not change terminal settings in text UI Graphical interface (GUI): -height n height (in lines) of main window in graphical interface Remote connections: -addversionno add version number to name of unison on server -clientHostName xxx set host name of client -halfduplex (deprecated) force half-duplex communication with the server -killserver kill server when done (even when using sockets) -listen xxx listen on this name or addr in server socket mode (can repeat) -rsync activate the rsync transfer mode (default true) -servercmd xxx name of unison executable on remote server -socket xxx act as a server on a socket -sshargs xxx other arguments (if any) for remote shell command -sshcmd xxx path to the ssh executable -stream (deprecated) use a streaming protocol for transferring file contents (default true) -testserver exit immediately after the connection to the server -xferbycopying optimize transfers using local copies (default true) Archive management: -ignorearchives ignore existing archive files Other: -addprefsto xxx file to add new prefs to -contactquietly suppress the 'contacting server' message during startup -copymax n (deprecated) maximum number of simultaneous copyprog transfers -copyprog xxx (deprecated) external program for copying large files -copyprogrest xxx (deprecated) variant of copyprog for resuming partial transfers -copythreshold n (deprecated) use copyprog on files bigger than this (if >=0, in Kb) -diff xxx set command for showing differences between files -ignorelocks ignore locks left over from previous run (dangerous!) -include xxx include a profile's preferences -key xxx define a keyboard shortcut for this profile (in some UIs) -label xxx provide a descriptive string label for this profile -log record actions in logfile (default true) -logfile xxx logfile name -maxerrors n maximum number of errors before a directory transfer is aborted -maxsizethreshold n prevent transfer of files bigger than this (if >=0, in Kb) -maxthreads n maximum number of simultaneous file transfers -mountpoint xxx abort if this path does not exist -rootalias xxx register alias for canonical root names -showarchive show 'true names' (for rootalias) of roots and archive -source xxx include a file's preferences -ui xxx select UI ('text' or 'graphic'); command-line only -unicode xxx assume Unicode encoding in case insensitive mode -watch when set, use a file watcher process to detect changes Expert options: -debug xxx debug module xxx ('all' -> everything, 'verbose' -> more) -dumparchives dump contents of archives just after loading -fastercheckUNSAFE skip computing fingerprints for new files (experts only!) -selftest run internal tests and exit (OPTIONS) . : -option. acl true (ACL) . ACL . NFSv4 ACL . addprefsto xxx Unison ( ignore ) Unison . addprefsto filename Unison filename . addversionno true Unison unison-currentmajorversionnumber unison ( - unison-2.51). unison : . atomic xxx . (atomic) . backupcurr . auto true . ( .) backup xxx -backup pathspec Unison pathspec ( ) . backuplocation . backupprefix backupsuffix . maxbackups . pathspec " (Path Specification)" . backupcurr xxx -backupcurr pathspec Unison pathspec . 000 . . merge . " (Merging Conflicting Versions)" . pathspec " (Path Specification)" . backupcurrnot xxx backupcurr ignorenot. backupdir xxx backuplocation central Unison backup . UNISONBACKUPDIR . backuploc xxx backupdir . local central backupdir . backupnot xxx backup - backup . backupprefix xxx NAME backuplocation backupprefixNAMEbackupsuffix . backupprefix ( Unison ) backupprefix backupsuffix $VERSION (1 2 ...). . : backuploc local Unison backupprefix backupsuffix . . backups () true backuplocation local backup Name *. backupsuffix xxx backupprefix . batch true . . clientHostName xxx . color xxx true . false . NO_COLOR . confirmbigdel true Unison . batch . path . ( .) mountpoint . confirmmerge . . (batch-mode) . false . contactquietly Unison "Contacting server" ( ) . copymax n () Unison ( 1 ). copyonconflict Unison . -repeat watch -prefer newer . copyprog xxx () ( ). rsync - . copyprogrest xxx () copyprog . copyprogrest copyprog ( --partial rsync). rsync - . copythreshold n () ( ) Unison copyprog . 0 . -1 . debug xxx Unison . . debug Util.debug ( grep). -debug all ( Unison ) -debug verbose ( ). diff xxx . "diff -u OLDER NEWER" . CURRENT1 CURRENT2 . NEWER OLDER NEWER . . . doc xxx -doc secname unison secname . -doc all HTML . -doc topics . dontchmod Unison 'chmod' . ( ) chmod . Unison chmod . dumbtty true . ( Unison " " .) Unison Emacs . dumbtty Unison (carriage return) . ( Unison .) . dumparchives Unison unison.dump . fastcheck xxx true Unison " inode " . ( Unison ). Unison . Unison . Unison Unison fastcheck false . yes no default true false auto . " (Fast Update Detection)" . fastercheckUNSAFE . true Unison ( Unison ) '' . Unison : Unison Unison . . : (touch) Unison ( ) . -- . ( Unison Unison ). Unison . fat true Unison FAT : (perms = 0) chmod (dontchmod = true) (ignorecase = true) (links = false) inode (ignoreinodenumbers = true). . follow xxx -follow pathspec Unison pathspec "" . " (Symbolic Links)" . pathspec " (Path Specification)" . force xxx -force root Unison ( ) root . Unison (mirroring) . . -force newer ( -force older) Unison () . -times . newer older ( ). forcepartial . ! forcepartial xxx forcepartial = PATHSPEC -> root Unison ( ) PATHSPEC root ( " (Path Specification)" ). Unison . . forcepartial PATHSPEC -> newer ( forcepartial PATHSPEC -> older) Unison () . -times . newer older ( ). ! group true . numericids . halfduplex () true Unison (half-duplex) ( ). . height n ( ) . i . . batch silent . ignore xxx -ignore pathspec Unison pathspec ( ) . . pathspec " (Path Specification)" " (Ignoring Paths)" . ignorearchives Unison . : . ignorecase xxx true Unison - "" . false Unison . default OSX . . ignoreinodenumbers true Unison inode . inode . ignorelocks Unison Unison Unison . Unison ( unison ). : . ignorenot xxx ignore . ( ignore) ignore . ignore ignorenot . Unison . ignore ignorenot . ignore ignorenot . ignore = Path * ignorenot . path . immutable xxx (immutable) -- . Unison ( ). immutablenot xxx immutable . include xxx . include name "name" ( "name" .unison "name") . key xxx (0-9) . killserver true Unison . ssh ssh Unison . ( Unison .) label xxx . ( " " .) links xxx true Unison . false . default . Unison . . default . listen xxx TCP Unison "any" ( 0.0.0.0 [::]) . . IP . log Unison () . logfile xxx unison.log .unison . . .unison . SIGUSR1 ( ) . maxbackups n unison backup . 2 . maxerrors n Unison . Unison . 1 . ( ) Unison . maxsizethreshold n ( ) Unison . force prefer . . -1 . maxthreads n . Unison ( 1) Unison . 0 20 1000 . merge xxx . pathspec -> cmd " (Path Specification)" " (Merging Conflicting Versions)" . mountpoint xxx -mountpoint PATH Unison PATH . (mount) . . " (Mount Points and Removable Media)" . moves-experimental Unison . . false. . nocreation xxx -nocreation root Unison root . . . nocreationpartial xxx nocreationpartial = PATHSPEC -> root Unison PATHSPEC root ( " (Path Specification)" ). BelowPath . nodeletion xxx -nodeletion root Unison root . . . nodeletionpartial xxx nodeletionpartial = PATHSPEC -> root Unison PATHSPEC root ( " (Path Specification)" ). BelowPath . noupdate xxx -noupdate root Unison root . . . noupdatepartial xxx noupdatepartial = PATHSPEC -> root Unison PATHSPEC root ( " (Path Specification)" ). BelowPath . numericids true . 0 (uid 0) 0 (group 0) / . owner true . numericids . path xxx path Unison . path Unison . ( .) path - . perms n . $0o1777$ : set-uid set-gid ( ). $-1$ . FAT [] fat . Unison $0$ dontchmod true. prefer xxx -prefer root Unison root merge . ( root root newer older). . preferpartial . ! preferpartial xxx preferpartial = PATHSPEC -> root Unison PATHSPEC root ( " (Path Specification)" ). ( root root newer older). . ! repeat xxx . Unison . watch Unison . + . watch+3600 . retry n . N . root xxx Unison . root . " (Roots)" . Unison . "" Unison . rootalias xxx Unison rootalias . rsrc xxx true Unison (resource forks) HFS . resource forks AppleDouble._ Carbon . false Unison . default OSX . . rsync Unison ' rsync' ' ' . false Unison . 'rsync failure' false . selftest . : . . : . backupdir backupdir "test" . ( .) servercmd xxx Unison ( ) . showarchive Unison ' ' rootalias . silent true . silent true batch true . socket xxx unison TCP ( TCP ) ( ) ( ) . sortbysize ( ) . . ( ) 'Sort' . sortfirst xxx sortfirst pathspec . . pathspec " (Path Specification)" . sortlast xxx sortfirst . sortnewfirst . "" -- -- . source xxx . source name "name" .unison . sshargs xxx ( Unison ) ssh . . sshcmd xxx ssh ( ) . stream () Unison . true. terse true . testserver Unison . . . times true ( ) . ui xxx . graphic text. Unison . . Unison . ( .) unicode xxx true Unison unison March 17, 2022 unison