Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
CSYNC2(1)			  User Commands 		       CSYNC2(1)

NAME
     csync2 - cluster synchronization tool, 2nd generation

SYNOPSIS
     csync2 [-v..] [-C config-name] [-D database-dir] [-N hostname] [-p port]...

COPYRIGHT
     csync2 is copyright (C) 2004 - 2013 by LINBIT Information Technologies GmbH

     csync2  is  distributed under the GNU public license.  See the file COPYING
     for details.

DESCRIPTION
     This manual page documents briefly the csync2 command.
     A verbose manual can be found on the csync2 homepage:

	    http://oss.linbit.com/csync2/paper.pdf

     csync2 is a program for cluster wide file synchronization.

OPTIONS
   With file parameters:
     -h [-r] file..
	    Add (recursive) hints for check to db

     -c [-r] file..
	    Check files and maybe add to dirty db

     -u [-d] [-r] file..
	    Updates files if listed in dirty db

     -o [-r] file..
	    Create list of files in compare-mode

     -f [-r] file..
	    Force files to win next conflict resolution

     -m file..
	    Mark files in database as dirty

   Simple mode:
     -x [-d] [[-r] file..]
	    Run checks for all given files and update remote hosts.

   Without file parameters:
     -c     Check all hints in db and eventually mark files as dirty

     -u [-d] Update (transfer dirty files to peers and mark as clear)

     -H     List all pending hints from status db

     -L     List all file-entries from status db

     -M     List all dirty files from status db

     -S myname peername
	    List file-entries from status db for this synchronization pair.

     -T     Test if everything is in sync with all peers.

     -T filename
	    Test if this file is in sync with all peers.

     -T myname peername
	    Test if this synchronization pair is in sync.

     -T myname peer file
	    Test only this file in this sync pair.

     -TT    As -T, but print the unified diffs.

	    The modes -H, -L, -M and -S return 2 if the requested db  is  empty.
	    The mode -T returns 2 if both hosts are in sync.

     -i     Run in inetd server mode.

     -ii    Run in stand-alone server mode.

     -iii   Run in stand-alone server mode (one connect only).

     -R     Remove files from database which do not match config entries.

   Exit codes:
	    The  modes	-H, -L, -M and -S return 2 if the requested db is empty.
	    The mode -T returns 2 if both hosts are in	sync.	Otherwise,  only
	    exit  codes  0  (no errors) and 1 (some unspecified errrors) are ex-
	    pected.

   Modifiers:
     -r     Recursive operation over subdirectories

     -d     Dry-run on all remote update operations

     -B     Do not block everything into big SQL transactions. This  slows  down
	    csync2  but  allows multiple csync2 processes to access the database
	    at the same time. Use e.g. when slow lines are used  or  huge  files
	    are transferred.

     -A     Open  database in asynchronous mode. This will cause data corruption
	    if the operating system crashes or the computer loses power.

     -I     Init-run. Use with care and read the documentation first!  You  usu-
	    ally do not need this option unless you are initializing groups with
	    really large file lists.

     -X     Also add removals to dirty db when doing a -TI run.

     -U     Don't mark all other peers as dirty when doing a -TI run.

     -G Group1,Group2,Group3,...

	    Only use these groups from config-file.

     -P peer1,peer1,...

	    Only  update these peers (still mark all as dirty).  Only show files
	    for these peers in -o (compare) mode.

     -F     Add new entries to dirty database with force flag set.

     -t     Print timestamps to debug output (e.g. for profiling).

     -s filename

	    Print timestamps also to this file.

     -W fd
	    Write a list of directories in which relevant files can be found  to
	    the  specified file descriptor (when doing a -c run).  The directory
	    names in this output are zero-terminated.

   Database switches:
     -D database-dir or url

	    default: /var/lib/csync2
		Absolute path: use sqlite database in that directory.

	    URLs:
		sqlite:///some/path[/database.db3]
		sqlite3:///some/path[/database.db3]
		sqlite2:///some/path[/database.db]
		mysql://[<user>:<password>@]<hostname>/[database]
		pgsql://[<user>:<password>@]<hostname>/[database]

	    If database is not given, it defaults to csync2_<qualified hostname>

	    Note that for non-sqlite backends, the database name  is  "cleaned",
	    characters outside of [0-9][a-z][A-Z] will be replaced with _.

   Creating key file:
	    csync2 -k filename

   Environment variables:
	    CSYNC2_SYSTEM_DIR

	    Directory  containing csync2.cfg and other csync2 system files.  De-
	    faults to /etc.

   Note:
     Csync2 will refuse to do anything	if  this  file	is  found:  $CSYNC2_SYS-
     TEM_DIR/csync2.lock

SEE ALSO
     http://oss.linbit.com/csync2/paper.pdf
     http://git.linbit.com/csync2.git/?a=blob;f=AUTHORS

     This manual page is a hand-edited help2man processed csync2 help.

csync2				   March 2013			       CSYNC2(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=csync2&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help