diff --git a/ChangeLog b/ChangeLog index a54eb3f..7b19f93 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,17 +1,21 @@ RCS file: RCS/imapsync,v Working file: imapsync -head: 1.6 +head: 1.7 branch: locks: strict - gilles: 1.6 + gilles: 1.7 access list: symbolic names: keyword substitution: kv -total revisions: 6; selected revisions: 6 +total revisions: 7; selected revisions: 7 description: ---------------------------- -revision 1.6 locked by: gilles; +revision 1.7 locked by: gilles; +date: 2003/03/15 03:40:54; author: gilles; state: Exp; lines: +19 -9 +Added documentation. +---------------------------- +revision 1.6 date: 2003/03/14 02:17:24; author: gilles; state: Exp; lines: +5 -3 Added positive exit if errors occurred. ---------------------------- diff --git a/INSTALL b/INSTALL index f941200..8706dad 100644 --- a/INSTALL +++ b/INSTALL @@ -1,4 +1,4 @@ -# $Id: INSTALL,v 1.1 2003/03/12 23:14:27 gilles Exp gilles $ +# $Id: INSTALL,v 1.2 2003/03/15 03:41:31 gilles Exp gilles $ # # INSTALL file for ftpsync @@ -8,6 +8,16 @@ GETTING http://www.linux-france.org/prj/imapsync/dist/ +PREREQUISITES +------------- + +You need : +- Perl + try : perl -v + +- Mail::IMAPClient module + try : perl -mMail::IMAPClient -e '' + TESTING ------- diff --git a/README b/README index c87014b..e7ad791 100644 --- a/README +++ b/README @@ -1,7 +1,7 @@ NAME imapsync - synchronize mailboxes between two imap servers. - $Revision: 1.6 $ + $Revision: 1.7 $ INSTALL Get imapsync at http://www.linux-france.org/prj/imapsync/dist/ @@ -10,7 +10,10 @@ INSTALL freshmeat record: http://freshmeat.net/projects/imapsync/ SYNOPSIS - imapsync [options] SOURCE DEST + imapsync [options] + + imapsync --help + imapsync imapsync [--host1 server1] [--port1 ] [--user1 ] [--passfile1 ] @@ -21,9 +24,6 @@ SYNOPSIS [--dry] [--debug] [--debugimap] [--version] [--help] - - imapsync --help - imapsync DESCRIPTION The command imapsync is a tool allowing incremental and recursive imap @@ -35,7 +35,16 @@ DESCRIPTION imapsync is the adequate tool because it reduces the amount of data transfered by not transfering a given message if it is already on both sides. All flags are preserved, unread will stay unread, read will stay - read, deleted will stay deleted. + read, deleted will stay deleted. You can stop the transfert at any time + and restart it later, imapsync is adapted to a bad connection. + + You can decide to delete the messages from the source mailbox after a + successful transfert (it is a good feature when migrating). In that + case, use the --delete option, and run imapsync again with the --expunge + option. + + You can also just synchronize a mailbox A from another mailbox B in case + you just want to keep a "live" copy of B in A. OPTIONS Invoke: imapsync --help @@ -48,7 +57,7 @@ HISTORY mailbox was well transfered and delete it after a good transfert. imapsync started its life being a copy_folder.pl patch. The tool copy_folder.pl comes from the Mail-IMAPClient-2.1.3 perl module tarball - source (in the examples/ directory). + source (in the examples/ directory of the tarball). EXAMPLES While working on imapsync parameters please run imapsync in dry mode (no @@ -89,5 +98,5 @@ BUGS SIMILAR SOFTWARES None known. Feedback will be welcome. - $Id: imapsync,v 1.6 2003/03/14 02:17:24 gilles Exp gilles $ + $Id: imapsync,v 1.7 2003/03/15 03:40:54 gilles Exp gilles $ diff --git a/VERSION b/VERSION index 810ee4e..d3bdbdf 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.6 +1.7 diff --git a/imapsync b/imapsync index 59dd7e6..1604881 100755 --- a/imapsync +++ b/imapsync @@ -4,7 +4,7 @@ imapsync - synchronize mailboxes between two imap servers. -$Revision: 1.6 $ +$Revision: 1.7 $ =head1 INSTALL @@ -15,7 +15,10 @@ $Revision: 1.6 $ =head1 SYNOPSIS - imapsync [options] SOURCE DEST + imapsync [options] + + imapsync --help + imapsync imapsync [--host1 server1] [--port1 ] [--user1 ] [--passfile1 ] @@ -26,9 +29,6 @@ $Revision: 1.6 $ [--dry] [--debug] [--debugimap] [--version] [--help] - - imapsync --help - imapsync =cut # comment @@ -45,7 +45,17 @@ another. This is called migration. imapsync is the adequate tool because it reduces the amount of data transfered by not transfering a given message if it is already on both sides. All flags are preserved, unread will stay unread, read -will stay read, deleted will stay deleted. +will stay read, deleted will stay deleted. You can stop the +transfert at any time and restart it later, imapsync is adapted +to a bad connection. + +You can decide to delete the messages from the source mailbox +after a successful transfert (it is a good feature when migrating). +In that case, use the --delete option, and run imapsync again +with the --expunge option. + +You can also just synchronize a mailbox A from another mailbox B +in case you just want to keep a "live" copy of B in A. =head1 OPTIONS @@ -61,7 +71,7 @@ every mailbox was well transfered and delete it after a good transfert. imapsync started its life being a copy_folder.pl patch. The tool copy_folder.pl comes from the Mail-IMAPClient-2.1.3 perl -module tarball source (in the examples/ directory). +module tarball source (in the examples/ directory of the tarball). =head1 EXAMPLES @@ -110,7 +120,7 @@ Report any bugs to the author: lamiral@linux-france.org None known. Feedback will be welcome. -$Id: imapsync,v 1.6 2003/03/14 02:17:24 gilles Exp gilles $ +$Id: imapsync,v 1.7 2003/03/15 03:40:54 gilles Exp gilles $ =cut @@ -135,7 +145,7 @@ my( use vars qw ($opt_G); # missing code for this will be option. -$rcs = ' $Id: imapsync,v 1.6 2003/03/14 02:17:24 gilles Exp gilles $ '; +$rcs = ' $Id: imapsync,v 1.7 2003/03/15 03:40:54 gilles Exp gilles $ '; $rcs =~ m/,v (\d+\.\d+)/; $VERSION = ($1) ? $1 : "UNKNOWN"; $error=0;