Fork: 0
tundra / tbku
Browse code
Restructured document as a man page. Began editing content.
master
1 parent d0f3921 commit a9c95a60897300e811666e4faa94e3d49da787a5
@tundra tundra authored on 19 Mar 2008
Patch
Unified Split
Showing 1 changed file
View
143
■■■■■
 tbku.txt
What Is ``tbku``?
=================
**NAME**
 
tbku - Table-driven backup script
 
 
How Does ``tbku`` Work?
=======================
**SYNOPSIS**
 
This program produces tarballs of backup "sets". The tarball is
written to $BKUDIR. By default, this is '/bku' but you can override
this with the $TBKUDIR environment variable to point to any
directory you wish. If the directory does not exist, 'tbku' will
create it for you when it runs.
``tbku allsets | [fileset] ...``
 
 
**DESCRIPTION**
 
``tbku`` is a utility script for producing "tarball" backups of
some- or all of your file systems. It is useful both for producing
incremental backups and for systemwide images or "snapshots". The
script can be run either from the command line or, more typically,
as a ``cron`` job to automate system backup tasks.
 
``tbku`` was originally developed as a backup tool for FreeBSD
systems. Since then, it has been updated to also work with SUSE
Linux. ``tbku`` should work with little- or no modification on any
other Unix-like system.
 
 
**HOW tbku WORKS**
 
 
This program produces tarballs of backup "sets". The tarball is
written to $BKUDIR. By default, this is '/bku' but you can override
this with the $TBKUDIR environment variable to point to any
directory you wish. If the directory does not exist, 'tbku' will
create it for you when it runs.
 
A backup "set" consists of a related set of files and directories
that are all to be backed up together into a single tarball. The
file containing all the names of all the files and directories in a
If the setname is "tape", then output will be written to the device
or file specified in the $TAPEDEV variable instead of a file in the
backup directory.
 
Customizing
===========
**CUSTOMIZING**
 
As "shipped", 'tbku' is setup with defaults that make sense for
FreeBSD. It is pretty simple to modify it for other operating
systems like Linux in the variable assignments below. Typically,
the program locations and the tape device name have to be changed as
you move 'tbku' across various systems.
'tbku'
 
 
Updates & Support
=================
**UPDATES & SUPPORT**
 
To get the latest version of 'tbku', go to:
To get the latest version of 'tbku', go to:
http://www.tundraware.com/Software/tbku
 
For Updates See: http://www.tundraware.com/Software/tbku
For questions, comments, or other feedback, send email to:
 
tbku@tundraware.com
 
 
Author
======
**AUTHOR**
 
Tim Daneliuk - tbku@tundraware.com
 
Comments and/or improvements welcome!
Tim Daneliuk, TundraWare Inc.
 
 
Document Information
====================
**COPYRIGHT & LICENSING**
 
This document was produced using the very useful ``reStructuredText``
tools in the ``docutils`` package. For more information, see:
``tbku`` is Copyright (c) 2004-2008, TundraWare Inc., Des Plaines, IL, USA
 
There is no fee for using ``tbku`` either personally or commercially
*so long as the terms of the tbku license are met*. Please read the
``tbku-license.txt`` file for a full explanation of the licensing
terms.
 
 
**DOCUMENT INFORMATION**
 
This document was produced using the very useful
``reStructuredText`` tools in the ``docutils`` package. For more
information, see:
 
http://docutils.sourceforge.net/rst.html
 
This document is Copyright (c) 2008, TundraWare Inc., Des Plaines, IL
Permission is hereby given to freely distribute, copy, or otherwise
disseminate this document without charge, so long as you do so without
modifying it in any way.
``$Id: tbku.txt,v 1.104 2008/03/19 15:23:48 tundra Exp $``
 
``$Id: tbku.txt,v 1.103 2008/03/19 06:16:11 tundra Exp $``