2009-07-01 20:44:36 +00:00
'\" t
2009-05-26 21:45:19 +00:00
. \" Title: ccollect
2016-09-26 16:01:01 +00:00
. \" Author: Nico Schottelius <nico-ccollect--@--schottelius.org>
2019-05-01 12:55:11 +00:00
. \" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
2020-08-26 06:46:37 +00:00
. \" Date: 08/26/2020
2016-09-26 16:01:01 +00:00
. \" Manual: \ \&
. \" Source: \ \&
2009-07-01 20:44:36 +00:00
. \" Language: English
2009-05-26 21:45:19 +00:00
. \"
2020-08-26 06:46:37 +00:00
.TH "CCOLLECT" "1" "08/26/2020" "\ \&" "\ \&"
2016-09-26 16:01:01 +00:00
. \" -----------------------------------------------------------------
. \" * Define some portability stuff
. \" -----------------------------------------------------------------
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
. \" http://bugs.debian.org/507673
. \" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n (.g .ds Aq \(aq
.el .ds Aq '
2009-07-01 20:44:36 +00:00
. \" -----------------------------------------------------------------
. \" * set default formatting
. \" -----------------------------------------------------------------
2009-05-26 21:45:19 +00:00
. \" disable hyphenation
.nh
. \" disable justification (adjust text to left margin only)
.ad l
2009-07-01 20:44:36 +00:00
. \" -----------------------------------------------------------------
. \" * MAIN CONTENT STARTS HERE *
. \" -----------------------------------------------------------------
2009-05-26 21:45:19 +00:00
.SH "NAME"
2009-07-01 20:44:36 +00:00
ccollect \- (pseudo) incremental backup with different exclude lists using hardlinks and rsync
2009-05-26 21:45:19 +00:00
.SH "SYNOPSIS"
.sp
2010-03-30 16:47:12 +00:00
\fI ccollect\& .sh\fR [args] <interval name> <sources to backup>
2009-05-26 21:45:19 +00:00
.SH "DESCRIPTION"
.sp
2009-07-01 20:44:36 +00:00
ccollect is a backup utility written in the sh\- scripting language\& . It does not depend on a specific shell, only /bin/sh needs to be bourne shell compatibel (like \fI dash\fR , \fI ksh\fR , \fI zsh\fR , \fI bash\fR , \& ...)\& .
2009-05-26 21:45:19 +00:00
.sp
2009-07-01 20:44:36 +00:00
For more information refer to the manual titled "ccollect \- Installing, Configuring and Using" (available as text (asciidoc), texinfo or html)\& .
2009-05-26 21:45:19 +00:00
.SH "OPTIONS"
.PP
2016-09-26 16:01:01 +00:00
\- a, \- \- all
.RS 4
Backup all sources specified in /etc/ccollect/sources
.RE
.PP
2017-03-22 09:55:34 +00:00
\- e, \- \- errors
.RS 4
Log only errors
.RE
.PP
2009-05-26 21:45:19 +00:00
\- h, \- \- help
.RS 4
Show the help screen
.RE
.PP
2016-09-26 16:01:01 +00:00
\- j [max], \- \- jobs [max]
2009-05-26 21:45:19 +00:00
.RS 4
2016-09-26 16:01:01 +00:00
Specifies the number of jobs to run simultaneously\& . If max is not specified then parallelise all jobs\& .
2009-05-26 21:45:19 +00:00
.RE
.PP
2017-03-22 09:55:34 +00:00
\- l FILE, \- \- logfile FILE
.RS 4
Log to specified file
.RE
.PP
2016-09-26 16:01:01 +00:00
\- p, \- \- parallel
2009-05-26 21:45:19 +00:00
.RS 4
2016-09-26 16:01:01 +00:00
Parallelise backup processes (deprecated from 2\& .0)
2009-05-26 21:45:19 +00:00
.RE
.PP
2017-03-22 09:55:34 +00:00
\- s, \- \- syslog
2009-05-26 21:45:19 +00:00
.RS 4
2017-03-22 09:55:34 +00:00
Log to syslog with tag ccollect
2010-03-30 16:47:12 +00:00
.RE
.PP
\- V, \- \- version
.RS 4
Show version and exit
2009-05-26 21:45:19 +00:00
.RE
2017-03-22 09:55:34 +00:00
.PP
\- v, \- \- verbose
.RS 4
Be very verbose (uses set \- x)
.RE
.SH "LOGGING MECHANISM"
.sp
ccollect logging depends on running in non\- interactive/interactive mode and on specified optins\& . The mechanism behaves as the following:
.PP
non\- interactive mode
.RS 4
.sp
.RS 4
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
standard output goes to syslog
.RE
.sp
.RS 4
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
optional: specify logging into file
.RE
.sp
.RS 4
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
log all output by default
.RE
.sp
.RS 4
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
optional: log only errors
.RE
.RE
.PP
interactive mode
.RS 4
.sp
.RS 4
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
standard output goes to stdout
.RE
.sp
.RS 4
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
log only errors
.RE
.sp
.RS 4
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
optional: log into syslog or file
.sp
.RS 4
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
log all output by default
.RE
.sp
.RS 4
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
optional: log only errors
.RE
.RE
.RE
2009-05-26 21:45:19 +00:00
.SH "SEE ALSO"
.sp
2009-07-01 20:44:36 +00:00
ccollect_add_source(1), ccollect_analyse_logs(1), ccollect_logwrapper(1) ccollect_delete_source(1), ccollect_list_intervals(1)
2009-05-26 21:45:19 +00:00
.SH "AUTHOR"
.sp
2009-07-01 20:44:36 +00:00
Nico Schottelius <nico\- ccollect\- \- @\- \- schottelius\& .org>
2009-05-26 21:45:19 +00:00
.SH "RESOURCES"
.sp
2009-07-01 20:44:36 +00:00
Main web site: http://www\& .nico\& .schottelius\& .org/software/ccollect/
2009-05-26 21:45:19 +00:00
.SH "COPYING"
.sp
2009-07-01 20:44:36 +00:00
Copyright (C) 2006\- 2008 Nico Schottelius\& . Free use of this software is granted under the terms of the GNU General Public License Version 3 (GPLv3)\& .
2016-09-26 16:01:01 +00:00
.SH "AUTHOR"
.PP
\fB Nico Schottelius\fR <\& nico\- ccollect\- \- @\- \- schottelius\& .org\& >
.RS 4
Author.
.RE