From 96b6876326098212a8facc5230af245771b30790 Mon Sep 17 00:00:00 2001
From: Nico Schottelius
Date: Fri, 27 Jan 2006 23:07:35 +0100
Subject: [PATCH] Minor documentation changes
---
doc/CHANGES | 2 +-
doc/TODO | 8 ++++----
doc/ccollect.html | 17 ++++++++---------
doc/ccollect.text | 2 +-
4 files changed, 14 insertions(+), 15 deletions(-)
diff --git a/doc/CHANGES b/doc/CHANGES
index 5a610b0..5ec56de 100644
--- a/doc/CHANGES
+++ b/doc/CHANGES
@@ -1,5 +1,5 @@
0.3.1 to 0.3.2:
- * added ?
+ * ccollect now prints the start time, end time and duration of the backup
0.3 to 0.3.1:
* added support for printing a summary
diff --git a/doc/TODO b/doc/TODO
index 7374b26..25f2078 100644
--- a/doc/TODO
+++ b/doc/TODO
@@ -1,19 +1,18 @@
- update documentation:
- - exit pre/post exec -> error codes (after implementation!)
- - summary support -> release 0.3.1
+ - exit pre/post exec -> error codes (after implementation!) (in 0.4)
- write mkccollectconfig
o create source configuration
o another script for changing defaults
x intervalls
x pre-/post exec
- o dialog based?
+ o (X)dialog based
- implement pre- and post-exec commands
o what to do with return values?
+ -> Check them, abort on error
- Documentation
- write/generate a manpage
- - rsync_options \n seperated
DONE
@@ -29,6 +28,7 @@ DONE
- write a simple manual
- Hints section
- add note to --exclude=/proc/ vs. --exclude=/proc/*
+ - rsync_options \n seperated
- implement pre- and post-exec commands
o For the general backup process
o source specific
diff --git a/doc/ccollect.html b/doc/ccollect.html
index a48ef42..3d4a65b 100644
--- a/doc/ccollect.html
+++ b/doc/ccollect.html
@@ -392,17 +392,16 @@ This number defines how many versions of this intervall to keep.
/etc/ccollect/defaults/pre_exec (same with post_exec), ccollect
will start pre_exec before the whole backup process and
post_exec after backup of all sources is done.
-Example:
+The following Example describes how to report free disk space in
+human readable format before and after the whole backup process:
[13:00] hydrogenium:~# mkdir -p /etc/ccollect/defaults/
-[13:00] hydrogenium:~# echo '!/bin/sh' > /etc/ccollect/defaults/pre_exec
-[13:01] hydrogenium:~# echo '' > /etc/ccollect/defaults/pre_exec
-[13:01] hydrogenium:~# echo '!/bin/sh' > /etc/ccollect/defaults/pre_exec
-[13:01] hydrogenium:~# echo '' >> /etc/ccollect/defaults/pre_exec
-[13:01] hydrogenium:~# echo 'df -h' >> /etc/ccollect/defaults/pre_exec
+[13:00] hydrogenium:~# echo '!/bin/sh' > /etc/ccollect/defaults/pre_exec
+[13:01] hydrogenium:~# echo '' >> /etc/ccollect/defaults/pre_exec
+[13:01] hydrogenium:~# echo 'df -h' >> /etc/ccollect/defaults/pre_exec
[13:01] hydrogenium:~# chmod 0755 /etc/ccollect/defaults/pre_exec
-[13:01] hydrogenium:~# cp /etc/ccollect/defaults/pre_exec /etc/ccollect/defaults/post_exec
+[13:01] hydrogenium:~# ln -s /etc/ccollect/defaults/pre_exec /etc/ccollect/defaults/post_exec
4.3. Source configuration
Each source configuration exists below $CCOLLECT_CONF/sources/$name or
@@ -711,7 +710,7 @@ even a good idea when thinking of security) add the destination
to source/exclude. (Daniel Aubry reported this problem)
6.3. Why does ccollect say "Permission denied" with my pre-/postexec script?
The most common error is to not give your script the correct
-permissions. Try chmod 0755 /etc/ccollect/sources/yoursource/*_exec.
+permissions. Try chmod 0755 /etc/ccollect/sources/yoursource/*_exec`.
7. Examples
@@ -813,7 +812,7 @@ the hardlinks allocate.