www.nico.schottelius.org/software/ccollect/documentation/man/ccollect.1

214 lines
4.2 KiB
Groff

'\" t
.\" Title: ccollect
.\" Author: Nico Schottelius <nico-ccollect--@--schottelius.org>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 08/26/2020
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "CCOLLECT" "1" "08/26/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * 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 '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ccollect \- (pseudo) incremental backup with different exclude lists using hardlinks and rsync
.SH "SYNOPSIS"
.sp
\fIccollect\&.sh\fR [args] <interval name> <sources to backup>
.SH "DESCRIPTION"
.sp
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 \fIdash\fR, \fIksh\fR, \fIzsh\fR, \fIbash\fR, \&...)\&.
.sp
For more information refer to the manual titled "ccollect \- Installing, Configuring and Using" (available as text (asciidoc), texinfo or html)\&.
.SH "OPTIONS"
.PP
\-a, \-\-all
.RS 4
Backup all sources specified in /etc/ccollect/sources
.RE
.PP
\-e, \-\-errors
.RS 4
Log only errors
.RE
.PP
\-h, \-\-help
.RS 4
Show the help screen
.RE
.PP
\-j [max], \-\-jobs [max]
.RS 4
Specifies the number of jobs to run simultaneously\&. If max is not specified then parallelise all jobs\&.
.RE
.PP
\-l FILE, \-\-logfile FILE
.RS 4
Log to specified file
.RE
.PP
\-p, \-\-parallel
.RS 4
Parallelise backup processes (deprecated from 2\&.0)
.RE
.PP
\-s, \-\-syslog
.RS 4
Log to syslog with tag ccollect
.RE
.PP
\-V, \-\-version
.RS 4
Show version and exit
.RE
.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
.SH "SEE ALSO"
.sp
ccollect_add_source(1), ccollect_analyse_logs(1), ccollect_logwrapper(1) ccollect_delete_source(1), ccollect_list_intervals(1)
.SH "AUTHOR"
.sp
Nico Schottelius <nico\-ccollect\-\-@\-\-schottelius\&.org>
.SH "RESOURCES"
.sp
Main web site: http://www\&.nico\&.schottelius\&.org/software/ccollect/
.SH "COPYING"
.sp
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)\&.
.SH "AUTHOR"
.PP
\fBNico Schottelius\fR <\&nico\-ccollect\-\-@\-\-schottelius\&.org\&>
.RS 4
Author.
.RE