ungleich-public/ccollect
6
0
Fork 1
Code Issues Pull requests 1 Projects Releases Wiki Activity

update documentation with all exported variables

Browse source 
Signed-off-by: Nico Schottelius <nico@ikn.schottelius.org>
This commit is contained in:
Nico Schottelius 2009-11-01 13:36:50 +01:00
parent 7d1669827a
commit e1ccba4f57
1 changed files with 18 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
doc/ccollect.text
View file

@ -335,6 +335,12 @@ If you add '$CCOLLECT_CONF/defaults/`pre_exec`' or
will start `pre_exec` before the whole backup process and will start `pre_exec` before the whole backup process and
`post_exec` after backup of all sources is done. `post_exec` after backup of all sources is done.
The `pre_exec` and `post_exec` script can access the following exported variables:
- 'INTERVAL': the interval selected (`daily`)
- 'no_sources': number of sources to backup (`2`)
- 'source_$no': name of the source, '$no' starts at 0
The following example describes how to report free disk space in The following example describes how to report free disk space in
human readable format before and after the whole backup process: human readable format before and after the whole backup process:
------------------------------------------------------------------------- -------------------------------------------------------------------------
@ -602,9 +608,10 @@ backups, see above for general configuration.
The `post_exec` script can access the following exported variables from The `post_exec` script can access the following exported variables from
ccollect: ccollect:
- destination_name: contains the base directory name (`daily.20091031-1013.24496`) - 'name': name of the source that is being backed up
- destination_dir: full path (`/tmp/ccollect/daily.20091031-1013.24496`) - 'destination_name': contains the base directory name (`daily.20091031-1013.24496`)
- destination_full: like 'destination_dir', but prepended with the remote_host, if set (`host:/tmp/ccollect/daily.20091031-1013.24496` or `/tmp/ccollect/daily.20091031-1013.24496`) - 'destination_dir': full path (`/tmp/ccollect/daily.20091031-1013.24496`)
- 'destination_full': like 'destination_dir', but prepended with the remote_host, if set (`host:/tmp/ccollect/daily.20091031-1013.24496` or `/tmp/ccollect/daily.20091031-1013.24496`)
Example: Example:
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
@ -710,12 +717,16 @@ Using source names or interval in pre_/post_exec scripts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The pre-/post_exec scripts can access some internal variables from `ccollect`: The pre-/post_exec scripts can access some internal variables from `ccollect`:
- INTERVAL: The interval specified on the command line - 'INTERVAL': The interval specified on the command line
- no_sources: number of sources - 'no_sources': number of sources
- source_$NUM: the name of the source - 'source_$NUM': the name of the source
- name: the name of the currently being backuped source (not available for - 'name': the name of the currently being backuped source (not available for
generic pre_exec script) generic pre_exec script)
Only available for `post_exec`:
- 'remote_host': name of host we backup to (empty if unused)
Using rsync protocol without ssh Using rsync protocol without ssh
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~