Added and cleaned up some documentation

This commit is contained in:
Nico Schottelius 2005-12-08 11:37:31 +01:00
parent fa5554bd82
commit 0382078531
6 changed files with 18 additions and 5 deletions

View file

@ -6,6 +6,7 @@ ccollect.sh, Nico Schottelius, 2005-12-07
1. General configuration 1. General configuration
2. Source configuration 2. Source configuration
--------------------------------------------------------------------------------
0. Runtime options 0. Runtime options
ccollect looks for its configuration in /etc/ccollect or, if set, in 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. The "intervall" is used to know how many backups to keep.
--------------------------------------------------------------------------------
1. General configuration 1. General configuration
The general configuration can be found below $CCOLLECT_CONF/defaults or /etc/ccollect/defaults. 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: 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 2. Source configuration
Each source configuration exists below $CCOLLECT_CONF/sources/$name. Each source configuration exists below $CCOLLECT_CONF/sources/$name.

5
INSTALL Normal file
View file

@ -0,0 +1,5 @@
--------------------------------------------------------------------------------
ccollect.sh, Nico Schottelius, 2005-12-08
--------------------------------------------------------------------------------
Simply copy it to a directory in your $PATH.

View file

@ -3,10 +3,10 @@ ccollect.sh, Nico Schottelius, 2005-12-06 (updated: 2005-12-07)
Requirements 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 - a bourne shell (/bin/sh) compatible shell
- bc - bc
- cp with support for hard links (cp -al is used)
- rsync
- ssh if you want to use rsync over ssh

1
TODO
View file

@ -1,4 +1,5 @@
- write a manpage - write a manpage
- write a simple manual
- implement verbosity - implement verbosity
o general, very verbose (set -x) o general, very verbose (set -x)
- implement general log - implement general log

View file

@ -0,0 +1 @@
12

View file

@ -0,0 +1 @@
4