From 0382078531d865698b6d68fd04f8e1bb42661a40 Mon Sep 17 00:00:00 2001
From: Nico Schottelius <nico@srsyg01.(none)>
Date: Thu, 8 Dec 2005 11:37:31 +0100
Subject: [PATCH] Added and cleaned up some documentation

---
 CONFIGURATION                    | 7 ++++++-
 INSTALL                          | 5 +++++
 REQUIREMENTS                     | 8 ++++----
 TODO                             | 1 +
 conf/defaults/intervalls/monthly | 1 +
 conf/defaults/intervalls/weekly  | 1 +
 6 files changed, 18 insertions(+), 5 deletions(-)
 create mode 100644 INSTALL
 create mode 100644 conf/defaults/intervalls/monthly
 create mode 100644 conf/defaults/intervalls/weekly

diff --git a/CONFIGURATION b/CONFIGURATION
index a5fd287..f69d4d5 100644
--- a/CONFIGURATION
+++ b/CONFIGURATION
@@ -6,6 +6,7 @@ ccollect.sh, Nico Schottelius, 2005-12-07
 1. General configuration
 2. Source configuration
 
+--------------------------------------------------------------------------------
 0. Runtime options
 
 ccollect looks for its configuration in /etc/ccollect or, if set, in
@@ -16,6 +17,7 @@ There are also some self explaining parameters you can pass to ccollect, simply
 
 The "intervall" is used to know how many backups to keep.
 
+--------------------------------------------------------------------------------
 1. General configuration
 
 The general configuration can be found below $CCOLLECT_CONF/defaults or /etc/ccollect/defaults.
@@ -24,8 +26,11 @@ The general configuration can be found below $CCOLLECT_CONF/defaults or /etc/cco
 
 Below this directory should be:
 
-   intervalls/<intervall
+   intervalls/<intervall name>
 
+   The number in this file tells ccollect how many versions to keep.
+
+--------------------------------------------------------------------------------
 2. Source configuration
 
 Each source configuration exists below $CCOLLECT_CONF/sources/$name.
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..82d4808
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,5 @@
+--------------------------------------------------------------------------------
+ccollect.sh, Nico Schottelius, 2005-12-08
+--------------------------------------------------------------------------------
+
+Simply copy it to a directory in your $PATH.
diff --git a/REQUIREMENTS b/REQUIREMENTS
index 6c7f9d8..c622283 100644
--- a/REQUIREMENTS
+++ b/REQUIREMENTS
@@ -3,10 +3,10 @@ ccollect.sh, Nico Schottelius, 2005-12-06 (updated: 2005-12-07)
 Requirements
 --------------------------------------------------------------------------------
 
-You need at least:
+ccollect needs the following packages:
 
-   - rsync
-   - cp with support for hard links
-   - ssh if you want to use rsync over ssh
    - a bourne shell (/bin/sh) compatible shell
    - bc
+   - cp with support for hard links (cp -al is used)
+   - rsync
+   - ssh if you want to use rsync over ssh
diff --git a/TODO b/TODO
index 5c783a9..92375f3 100644
--- a/TODO
+++ b/TODO
@@ -1,4 +1,5 @@
 - write a manpage
+- write a simple manual
 - implement verbosity
    o general, very verbose (set -x)
 - implement general log
diff --git a/conf/defaults/intervalls/monthly b/conf/defaults/intervalls/monthly
new file mode 100644
index 0000000..48082f7
--- /dev/null
+++ b/conf/defaults/intervalls/monthly
@@ -0,0 +1 @@
+12
diff --git a/conf/defaults/intervalls/weekly b/conf/defaults/intervalls/weekly
new file mode 100644
index 0000000..b8626c4
--- /dev/null
+++ b/conf/defaults/intervalls/weekly
@@ -0,0 +1 @@
+4