UNISON-2.51+4.13.1-GTK(1)

📦 version 2.51.5, in debian bookworm, ubuntu jammy

✨ unison-2.51+4.13.1-gtk ✨

okay bestie, gather round, because this is the manual page for unison-2.51+4.13.1-gtk — and it lives in the General Commands Manual section of the Debian world. she's a file-synchronization tool for Unix and Windows and she is, genuinely, that girl. 💖

🌸 NAME 🌸

unison-2.51+4.13.1-gtk — a file-synchronization tool for Unix and Windows 🦋

🎀 SYNOPSIS 🎀

unison-2.51+4.13.1-gtk [options]
unison-2.51+4.13.1-gtk root1 root2 [options]
unison-2.51+4.13.1-gtk profilename [options]

💅 DESCRIPTION 💅

so this manual page is a brief lil rundown of Unison, and it was written for the Debian GNU/Linux distribution because the original program doesn't ship a manual page. that's right, we did it ourselves, no cap. 😭 if you want the full description, pls go read the inbuilt documentation or the manuals in /usr/share/doc/unison-2.51+4.13.1/. also heads up: the unison-2.51+4.13.1-gtk-gtk binary has similar command-line options, but it lets you select and create profiles and configure options from inside the program itself. main character energy tbh. 👑

so what is Unison, you ask? it's a file-synchronization tool for Unix and Windows. it lets two replicas of a collection of files and directories live on different hosts (or different disks on the same host), get modified separately, and then get brought up to date by propagating the changes in each replica to the other. it's giving mutual glow-up. ✨

Unison has several advantages over other sync methods like CVS, Coda, rsync, Intellisync, etc. like:

  • Unison can run on and synchronize between Windows and many UNIX platforms. 🌈
  • Unison requires no root privileges, no system access and no kernel changes to function. she's low-maintenance, we love that. 🫶
  • Unison can synchronize changes to files and directories in both directions, on the same machine, or across a network using ssh or a direct socket connection.

transfers are optimised using a version of the rsync protocol, which makes it ideal for slower links — yes bestie, your sad lil hotel wifi is safe. 💀 Unison has a clear and precise specification, and she's resilient to failure thanks to careful handling of the replicas and her private structures. she's not messy, she's prepared. 🎀

the two roots can be specified using an URI or a path. the URI must follow the convention:

protocol://[user@][host][:port][/path]

and the protocol part can be file, socket, ssh or rsh. pick your fighter. ⭐

✨ OPTIONS ✨

okay so here's the thing — all Unison options are long, and they start with one dash (-) only. not two. one. don't come at me with a double dash, she will not answer. 🙈

this is a summary of the options. for a complete description, see the inbuilt documentation or the manuals in /usr/share/doc/unison-2.51+4.13.1/.

  • -auto — automatically accept default (nonconflicting) actions
  • -batch — batch mode: ask no questions at all
  • -doc xxx — show documentation (-doc topics lists topics)
  • -fat — use appropriate options for FAT filesystems
  • -group — synchronize group attributes
  • -i — interactive profile mode (text UI); command-line only
  • -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)
  • -silent — print nothing except error messages
  • -terse — suppress status messages
  • -testserver — exit immediately after the connection to the server
  • -times — synchronize modification times
  • -version — print version and exit
  • -addprefsto xxx — file to add new prefs to
  • -addversionno — add version number to name of unison on server
  • -atomic xxx — add a pattern to the atomic list
  • -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 — keep backup copies of all files (see also 'backup')
  • -backupsuffix xxx — a suffix to be added to names of backup files
  • -clientHostName xxx — set host name of client
  • -color xxx — use color output for text UI (true/false/default)
  • -confirmbigdel — ask about whole-replica (or path) deletes (default true)
  • -confirmmerge — ask for confirmation before committing results of a merge
  • -contactquietly — suppress the 'contacting server' message during startup
  • -copymax n — maximum number of simultaneous copyprog transfers
  • -copyonconflict — keep copies of conflicting files
  • -copyprog xxx — external program for copying large files
  • -copyprogrest xxx — variant of copyprog for resuming partial transfers
  • -copyquoterem xxx — add quotes to remote file name for copyprog (true/false/default)
  • -copythreshold n — use copyprog on files bigger than this (if >=0, in Kb)
  • -debug xxx — debug module xxx ('all' -> everything, 'verbose' -> more)
  • -diff xxx — set command for showing differences between files
  • -dontchmod — when set, never use the chmod system call
  • -dumbtty — do not change terminal settings in text UI
  • -fastcheck xxx — do fast update detection (true/false/default)
  • -fastercheckUNSAFE — skip computing fingerprints for new files (experts only!)
  • -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
  • -halfduplex — force half-duplex communication with the server
  • -height n — height (in lines) of main window in graphical interface
  • -host xxx — bind the socket to this host name in server socket mode
  • -ignorearchives — ignore existing archive files
  • -ignorecase xxx — identify upper/lowercase filenames (true/false/default)
  • -ignoreinodenumbers — ignore inode number changes when detecting updates
  • -ignorelocks — ignore locks left over from previous run (dangerous!)
  • -immutable xxx — add a pattern to the immutable list
  • -immutablenot xxx — add a pattern to the immutablenot list
  • -key xxx — define a keyboard shortcut for this profile (in some UIs)
  • -killserver — kill server when done (even when using sockets)
  • -label xxx — provide a descriptive string label for this profile
  • -links xxx — allow the synchronization of symbolic links (true/false/default)
  • -log — record actions in logfile (default true)
  • -logfile xxx — logfile name
  • -maxbackups n — number of backed up versions of a file
  • -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
  • -merge xxx — add a pattern to the merge list
  • -mountpoint xxx — abort if this path does not exist
  • -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
  • -numericids — don't map uid/gid values by user/group names
  • -prefer xxx — choose this replica's version for conflicting changes
  • -preferpartial xxx — add a pattern to the preferpartial list
  • -repeat xxx — synchronize repeatedly (text interface only)
  • -retry n — re-try failed synchronizations N times (text ui only)
  • -rootalias xxx — register alias for canonical root names
  • -rsrc xxx — synchronize resource forks (true/false/default)
  • -rsync — activate the rsync transfer mode (default true)
  • -selftest — run internal tests and exit
  • -servercmd xxx — name of unison executable on remote server
  • -showarchive — show 'true names' (for rootalias) of roots and archive
  • -socket xxx — act as a server on a socket
  • -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
  • -sshargs xxx — other arguments (if any) for remote shell command
  • -sshcmd xxx — path to the ssh executable
  • -stream — use a streaming protocol for transferring file contents (default true)
  • -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
  • -xferbycopying — optimize transfers using local copies (default true)
  • -include xxx — include a profile file's preferences
  • -source xxx — include a file's preferences
quick vibe check bestie: some preferences are just boolean flags. others take numeric or string arguments, and you can spot those in the preferences list because they're marked by n or xxx. also — most of the string preferences can be given several times; the arguments get accumulated into a list internally. she's collecting them like pokémon. 🧚

🦋 SEE ALSO 🦋

the program is documented fully in the in-built documentation and the manual, available as text in /usr/share/doc/unison-2.51+4.13.1/. go read it, she wrote a whole essay. 📚

👑 AUTHOR 👑

the options are automatically extracted from unison -help. the rest of this manual page was written by Robert McQueen <robot101@debian.org>, for the Debian GNU/Linux system (but may be used by others). iconic behaviour honestly. 🫶

and that's the whole page, bestie!! Unison 2.51+4.13.1-gtk, manual page dated July 23, 2020 — go forth and sync, slay, and back up your stuff before something tragic happens to your laptop. 💖✨🎀🦋🌸💅

📦 where this page comes from