From 1cd21855f277fc85f62abcac16188f59b1bd0845 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Wed, 2 Jul 2008 20:37:21 +0200 Subject: [PATCH] Improve the manpage, add description and example section. --- doc/csync.txt | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/doc/csync.txt b/doc/csync.txt index 3280c3822..21395be30 100644 --- a/doc/csync.txt +++ b/doc/csync.txt @@ -7,15 +7,24 @@ NAME csync - A commandline frontent for csync a user level bidirectional file synchronizer. + SYNOPSIS -------- *csync* ['OPTION'...] 'SOURCE' 'DESTINATION' + DESCRIPTION ----------- -foobar +csync is a client only bidirectional file synchronizer. It synchronizes the +content of 'SOURCE' with 'DESTINATION' and vice versa. The 'DESTINATION' can +be a local directory or a remote file server. + +You can use csync for different things. The intention is to provide Roaming +Home Directories for Linux but you can use it to synchronize your music +collection or create a backup of a directory. + OPTIONS ------- @@ -41,6 +50,7 @@ OPTIONS *-V, --version*:: Print program version + EXIT STATUS ----------- *0*:: @@ -50,21 +60,41 @@ EXIT STATUS Failure (syntax or usage error; configuration error; unexpected error). + +EXAMPLES +-------- + +* csync /home/user /backup/home/user + + Synchronizer two local directories. + +* csync /home/user smb://server/share/user + + Synchronize a home directory with a SMB share. + +* csync /home/user smb://user:password@server/share/user + + Synchronize a home directory with a SMB share and provide username and + password directly. + BUGS ---- Please report bugs at https://dev.csync.org/. + SEE ALSO -------- *libcsync*(7) + AUTHORS ------- Andreas Schneider + COPYING ------- Copyright \(c) 2006-2008 Andreas Schneider. Free use of this software is