From 61201b1f6a07026587680ff923744e3814c9796f Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Wed, 25 Jan 2006 00:14:58 +0100 Subject: [PATCH] Documentation: added summary --- doc/ccollect.html | 57 +++++++++++++++++++++++++++++++++++++++-------- doc/ccollect.text | 42 +++++++++++++++++++++++++++++++++- 2 files changed, 89 insertions(+), 10 deletions(-) diff --git a/doc/ccollect.html b/doc/ccollect.html index 87cea26..615cf37 100644 --- a/doc/ccollect.html +++ b/doc/ccollect.html @@ -262,8 +262,8 @@ div.exampleblock-content {

ccollect - Installing, Configuring and Using

Nico Schottelius
<nico-linux-ccollect__@__schottelius.org>
-version 0.3.0, -for ccollect 0.3, Initial Version from 2005-01-13 +version 0.3.1, +for ccollect 0.3.1, Initial Version from 2005-01-13
@@ -430,6 +430,11 @@ will start pre_exec before the whole backup process and

  • +summary create a transfer summary when rsync finished +

    +
    • +
  • +

    exclude exclude list for rsync. newline (\n) seperated list.

    • @@ -492,7 +497,41 @@ To use the rsync protocol without the ssh-tunnel, use 
       [23:67] nohost:~% touch conf/sources/testsource1/very_verbose
    -

    4.3.4. Detailled description of "exclude"

    +

    4.3.4. Detailled description of "summary"

    +

    If you create the file summary below the source definition, +ccollect will present you with a nice summary at the end.

    +
    +
    +
    backup:~# touch /etc/ccollect/sources/root/summary
+backup:~# ccollect.sh werktags root
+==> ccollect.sh: Beginning backup using intervall werktags <==
+[root] Beginning to backup this source ...
+[root] Currently 3 backup(s) exist, total keeping 50 backup(s).
+[root] Beginning to backup, this may take some time...
+[root] Hard linking...
+[root] Transferring files...
+[root]
+[root] Number of files: 84183
+[root] Number of files transferred: 32
+[root] Total file size: 26234080536 bytes
+[root] Total transferred file size: 9988252 bytes
+[root] Literal data: 9988252 bytes
+[root] Matched data: 0 bytes
+[root] File list size: 3016771
+[root] File list generation time: 1.786 seconds
+[root] File list transfer time: 0.000 seconds
+[root] Total bytes sent: 13009119
+[root] Total bytes received: 2152
+[root]
+[root] sent 13009119 bytes  received 2152 bytes  2891393.56 bytes/sec
+[root] total size is 26234080536  speedup is 2016.26
+[root] Successfully finished backup.
+==> Finished ccollect.sh <==
    +
    +

    You could also combine it with verbose or very_verbose, but they +already print some statistics (but not all / the same as presented by +summary).

    +

    4.3.5. Detailled description of "exclude"

    exclude specifies a list of paths to exclude. The entries are new line (\n) seperated.

    Example:

    @@ -504,7 +543,7 @@ seperated.

    etwas mit leerzeichenli something with spaces is not a problem
    -

    4.3.5. Detailled description of "destination"

    +

    4.3.6. Detailled description of "destination"

    destination must be a link to the destination directory.

    Example:

    @@ -512,7 +551,7 @@ seperated.

       [11:36] zaphodbeeblebrox:ccollect-0.2% ls -l conf/sources/testsource2/destination
    lrwxrwxrwx  1 nico users 20 2005-11-17 16:44 conf/sources/testsource2/destination -> /home/nico/backupdir
    -

    4.3.6. Detailled description of "intervalls/"

    +

    4.3.7. Detailled description of "intervalls/"

    When you create a subdirectory intervalls/ within your source configuration directory, you can specify individiual intervalls for this specific source. Each file below this directory describes an intervall.

    @@ -527,7 +566,7 @@ Each file below this directory describes an intervall.

    5 20 -

    4.3.7. Detailled description of "rsync_options"

    +

    4.3.8. Detailled description of "rsync_options"

    When you create the file rsync_options below your source configuration, all the parameters found in this file will be passed to rsync. This way you can pass additional options to rsync. For instance you can tell rsync @@ -539,7 +578,7 @@ to use for automatic backup over the rsync-protocol.

       [23:42] hydrogenium:ccollect-0.2% cat conf/sources/test_rsync/rsync_options
    --password-file=/home/user/backup/protected_password_file
    -

    4.3.8. Detailled description of "pre_exec" and "post_exec"

    +

    4.3.9. Detailled description of "pre_exec" and "post_exec"

    When you create pre_exec and / or post_exec below your source configuration, ccollect will execute this command before, respective after doing the backup for this specific source. @@ -748,8 +787,8 @@ srwali01:/etc/ccollect/sources# du -sh /mnt/hdbackup/wl6/*

    diff --git a/doc/ccollect.text b/doc/ccollect.text index 718338c..9159347 100644 --- a/doc/ccollect.text +++ b/doc/ccollect.text @@ -1,7 +1,7 @@ ccollect - Installing, Configuring and Using ============================================ Nico Schottelius -0.3.0, for ccollect 0.3, Initial Version from 2005-01-13 +0.3.1, for ccollect 0.3.1, Initial Version from 2005-01-13 :Author Initials: NS (pseudo) incremental backup @@ -150,6 +150,8 @@ Additionally a source may have the following files: - `verbose` whether to be verbose (passes -v to `rsync`) - `very_verbose` be very verbose (-v also for `mkdir`, `cp`, `rm`) + - `summary` create a transfer summary when `rsync` finished + - `exclude` exclude list for `rsync`. newline ('\n') seperated list. - `rsync_options' extra options to pass to `rsync` @@ -208,6 +210,44 @@ Example: [23:67] nohost:~% touch conf/sources/testsource1/very_verbose -------------------------------------------------------------------------------- +Detailled description of "summary" +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you create the file `summary` below the source definition, +`ccollect` will present you with a nice summary at the end. + +------------------------------------------------------------------------------- +backup:~# touch /etc/ccollect/sources/root/summary +backup:~# ccollect.sh werktags root +==> ccollect.sh: Beginning backup using intervall werktags <== +[root] Beginning to backup this source ... +[root] Currently 3 backup(s) exist, total keeping 50 backup(s). +[root] Beginning to backup, this may take some time... +[root] Hard linking... +[root] Transferring files... +[root] +[root] Number of files: 84183 +[root] Number of files transferred: 32 +[root] Total file size: 26234080536 bytes +[root] Total transferred file size: 9988252 bytes +[root] Literal data: 9988252 bytes +[root] Matched data: 0 bytes +[root] File list size: 3016771 +[root] File list generation time: 1.786 seconds +[root] File list transfer time: 0.000 seconds +[root] Total bytes sent: 13009119 +[root] Total bytes received: 2152 +[root] +[root] sent 13009119 bytes received 2152 bytes 2891393.56 bytes/sec +[root] total size is 26234080536 speedup is 2016.26 +[root] Successfully finished backup. +==> Finished ccollect.sh <== +------------------------------------------------------------------------------- + +You could also combine it with `verbose` or `very_verbose`, but they +already print some statistics (but not all / the same as presented by +`summary`). + Detailled description of "exclude" ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^