Commit faee7ae3 authored by Irene "Tissy" Pirrotta's avatar Irene "Tissy" Pirrotta
Browse files

upload qt man, plugins and docbook

parent cc50cb75
<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY appname "Back In Time">
<!ENTITY app "<application>&appname;</application>">
<!ENTITY appversion "1.2.1">
<!ENTITY manrevision "1.2.1">
<!ENTITY date "Juliy 2010">
]>
<!--
(Do not remove this comment block.)
Maintained by the GNOME Documentation Project
http://live.gnome.org/DocumentationProject
Template version: 3.0 beta
Template last modified 2006-11-21
-->
<!-- =============Document Header ============================= -->
<article id="index" lang="C">
<articleinfo>
<title>&app; Manual</title>
<abstract role="description">
<para>&app; is a simple backup tool for KDE4 desktop.</para>
</abstract>
<copyright>
<year>2008-2009</year>
<holder>Oprea Dan, Bart de Koning, Richard Bailey</holder>
</copyright>
<!-- An address can be added to the publisher information. -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="legal.xml"/>
<!-- The file legal.xml contains link to license for the documentation,
and other legal stuff such as "NO WARRANTY" statement.
Please do not change any of this. -->
<!-- According to GNU FDL, revision history is mandatory if you are -->
<!-- modifying/reusing someone else's document. If not, you can omit it. -->
<!-- Remember to remove the &manrevision; entity from the revision entries other
-->
<!-- than the current revision. -->
<!-- The revision numbering system for GNOME manuals is as follows: -->
<!-- * the revision number consists of two components -->
<!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
<!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
<!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
<!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
<!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
<!-- to V3.0, and so on. -->
<releaseinfo>This manual describes version &appversion; of Back In Time.
</releaseinfo>
<legalnotice>
<title>Feedback</title>
<para>To report a bug or make a suggestion regarding the &app; application or
this manual, send an email to:
<ulink url="mailto:bit-team@lists.launchpad.net" type="mailto">bit-team@lists.launchpad.net</ulink>.
</para>
<!-- Translators may also add here feedback address for translations -->
</legalnotice>
</articleinfo>
<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
<!-- Use the Introduction section to give a brief overview of what
the application is and what it does. -->
<sect1 id="backintime-introduction">
<title>Introduction</title>
<para>&app; is a simple backup tool for Linux (this is KDE4 version). The backup is done by taking snapshots of
a specified set of folders.</para>
<para>All you have to do is:</para>
<itemizedlist>
<listitem><para>configure where to save snapshots</para></listitem>
<listitem><para>cofigure what folders to backup</para></listitem>
<listitem><para>schedule automatic backup: disabled, every 5 minutes, every 10 minutes, every hour, every day, every week, every month</para></listitem>
</itemizedlist>
<para>&app; acts as a "user mode" backup tool. This means that you can backup/restore only folders
you have write access to (actually you can backup read-only folders, but you can't restore them).</para>
<para>If you want to run it as root you need to use "sudo -i backintime" (command line) or "backintime-qt_polkit" (GUI).</para>
<para>A new snapshot is created only if something changed since the last snapshot (if any).</para>
<para>A snapshot contains all the files from the selected folders (except for exclude patterns).
In order to reduce disk space it use hard-links (if possible) between snapshots for unchanged files.
This way a file of 10MiB, unchanged for 10 snapshots, will use only 10Mb on the disk.</para>
<para>When you restore a file 'A', if it already exists on the file system it will be renamed to
'A.backup.currentdate'.</para>
<para>This documentation is not maintained (at least for the moment), please use the man-page 'man backintime'
</para>
</sect1>
<!-- ============= About ================================== -->
<!-- This section contains info about the program (not docs), such as
author's name(s), web page, license, feedback address. This
section is optional: primary place for this info is "About.." box of
the program. However, if you do wish to include this info in the
manual, this is the place to put it. Alternatively, you can put this information in the title page.-->
<sect1 id="backintime-about">
<title>About &app;</title>
<para> &app; was written by Oprea Dan
(<email>dan@le-web.org</email>), Bart de Koning (<email>bratdaking@gmail.com</email>),
Richard Bailey (<email>rmjb@mail.com<email>). To find more information about
&app;, please visit the
<ulink url="https://github.com/bit-team/backintime" type="http">Back In Time Web
page</ulink>. </para>
<para>
To report a bug or make a suggestion regarding this application or
this manual, sent a mail to
<ulink url="mailto:bit-team@lists.launchpad.net" type="mailto">bit-team@lists.launchpad.net</ulink>.
</para>
<para> This program is distributed under the terms of the GNU
General Public license version 2 as published by the Free Software
Foundation. A copy of this license can be found in the file
LICENSE included with the source code of this program. </para>
</sect1>
</article>
<legalnotice id="legalnotice">
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License (GFDL), Version 1.1 or any later version published
by the Free Software Foundation with no Invariant Sections,
no Front-Cover Texts, and no Back-Cover Texts. You can find
a copy of the GFDL at this <ulink type="help"
url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS
distributed with this manual.
</para>
<para> This manual is part of a collection of GNOME manuals
distributed under the GFDL. If you want to distribute this
manual separately from the collection, you can do so by
adding a copy of the license to the manual, as described in
section 6 of the license.
</para>
<para>
Many of the names used by companies to distinguish their
products and services are claimed as trademarks. Where those
names appear in any GNOME documentation, and the members of
the GNOME Documentation Project are made aware of those
trademarks, then the names are in capital letters or initial
capital letters.
</para>
<para>
DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE
WITH THE FURTHER UNDERSTANDING THAT:
<orderedlist>
<listitem>
<para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
THAT THE DOCUMENT OR MODIFIED VERSION OF THE
DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
OF THE DOCUMENT OR MODIFIED VERSION OF THE
DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
EXCEPT UNDER THIS DISCLAIMER; AND
</para>
</listitem>
<listitem>
<para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
PARTIES, BE LIABLE TO ANY PERSON FOR ANY
DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES OF ANY CHARACTER
INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
LOSSES ARISING OUT OF OR RELATING TO USE OF THE
DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
THE POSSIBILITY OF SUCH DAMAGES.
</para>
</listitem>
</orderedlist>
</para>
</legalnotice>
.TH backintime-qt 1 "Aug 2016" "version 1.2.1" "USER COMMANDS"
.SH NAME
backintime-qt \- a simple backup tool.
.SH SYNOPSIS
.B backintime-qt
[\-\-checksum]
[\-\-config PATH]
[\-\-debug]
[\-\-delete]
[\-\-help | \-h]
[\-\-keep\-mount]
[\-\-license]
[\-\-local\-backup |
\-\-no\-local\-backup]
[\-\-no\-crontab]
[\-\-only\-new]
[\-\-profile NAME |
\-\-profile\-id ID]
[\-\-quiet]
[\-\-share\-path PATH]
[\-\-version]
{ backup | backup\-job |
benchmark-cipher [FILE-SIZE] |
check-config |
decode [PATH] |
last\-snapshot | last\-snapshot\-path |
pw\-cache [start|stop|restart|reload|status] |
remove[\-and\-do\-not\-ask\-again] [SNAPSHOT_ID] |
restore [WHAT [WHERE [SNAPSHOT_ID]]] |
shutdown |
smart\-remove |
snapshots\-list | snapshots\-list\-path |
snapshots\-path |
unmount }
.SH DESCRIPTION
Back In Time is a simple backup tool for Linux. This is the Qt5 version.
For more information about Back In Time see backintime man page.
.PP
If you want to run it as root you need to use 'backintime-qt_polkit'.
.SH OPTIONS
.TP
\-\-checksum
Force to use checksum for checking if files have been changed. This is the same
as 'Use checksum to detect changes' in Options. But you can use this to
periodically run checksums from cronjobs. Only valid with \fIbackup\fR,
\fIbackup-job\fR and \fIrestore\fR.
.TP
\-\-config PATH
Read config from PATH. Default = ~/.config/backintime/config
.TP
--debug
Show debug messages.
.TP
--delete
Restore and delete newer files which are not in the snapshot.
WARNING: deleting files in filesystem root could break your whole system!!!
Only valid with \fIrestore\fR.
.TP
\-h, \-\-help
Display a short help
.TP
\-\-keep\-mount
Don't unmount on exit. Only valid with \fIsnapshots\-path\fR, \fIsnapshots\-list\-path\fR and
\fIlast\-snapshot\-path\fR.
.TP
\-\-license
Show license
.TP
--local-backup
Create backup files before changing local files.
Only valid with \fIrestore\fR.
.TP
--no-crontab
Do not install crontab entries.
Only valid with \fIcheck-config\fR.
.TP
--no-local-backup
Temporary disable creation of backup files before changing local files.
Only valid with \fIrestore\fR.
.TP
--only-new
Only restore files which does not exist or are newer than those in destination.
Using "rsync --update" option.
Only valid with \fIrestore\fR.
.TP
\-\-profile NAME
Select profile by name
.TP
\-\-profile\-id ID
Select profile by id
.TP
\-\-quiet
Suppress status messages on standard output.
.TP
\-\-share\-path PATH
Write runtime data (locks, messages, log and mountpoints) to PATH.
.TP
\-v, \-\-version
Show version
.SH COMMANDS
.TP
backup | \-b | \-\-backup
Take a snapshot now.
.TP
backup\-job | \-\-backup\-job
Take a snapshot (if needed) depending on schedule rules (used for cron jobs).
Back In Time will run in background for this.
.TP
benchmark-cipher | \-\-benchmark-cipher [FILE-SIZE]
Show a benchmark of all ciphers for ssh transfer.
.TP
check-config
Verify the profile in config, create snapshot path and crontab entries.
.TP
decode | \-\-decode [PATH]
Decode encrypted PATH. If no PATH is given Back In Time will read paths from
standard input.
.TP
last\-snapshot | \-\-last\-snapshot
Display last snapshot ID (if any)
.TP
last\-snapshot\-path | \-\-last\-snapshot\-path
Display the path to the last snapshot (if any)
.TP
pw\-cache | \-\-pw\-cache [start|stop|restart|reload|status]
Control the Password Cache Daemon. If no argument is given the Password Cache
will start in foreground.
.TP
remove[\-and\-do\-not\-ask\-again] | \-\-remove[\-and\-do\-not\-ask\-again] [SNAPSHOT_ID]
Remove the snapshot. If SNAPSHOT_ID is missing it will be prompted. SNAPSHOT_ID
can be an index (starting with 0 for the last snapshot) or the exact SnapshotID
(19 characters like '20130606-230501-984').
\fIremove\-and\-do\-not\-ask\-again\fR will remove the snapshot immediately.
Be careful with this!
.TP
restore | \-\-restore [WHAT [WHERE [SNAPSHOT_ID]]]
Restore file WHAT to path WHERE from snapshot SNAPSHOT_ID. If arguments are
missing they will be prompted. To restore to the original path WHERE can be an
empty string '' or just press Enter at the prompt. SNAPSHOT_ID can be an index
(starting with 0 for the last snapshot) or the exact SnapshotID
(19 characters like '20130606-230501-984')
.TP
shutdown
Shutdown the computer after the snapshot is done.
.TP
smart\-remove
Remove snapshots based on the configured Smart-Remove pattern.
.TP
snapshots\-list | \-\-snapshots\-list
Display the list of snapshot IDs (if any)
.TP
snapshots\-list\-path | \-\-snapshots\-list\-path
Display the paths to snapshots (if any)
.TP
snapshots\-path | \-\-snapshots\-path
Display path where is saves the snapshots (if configured)
.TP
unmount | \-\-unmount
Unmount the profile.
.SH SEE ALSO
backintime, backintime-config.
.PP
Back In Time also has a website: https://github.com/bit-team/backintime
.SH AUTHOR
This manual page was written by BIT Team(<bit\-team@lists.launchpad.net>).
# Back In Time
# Copyright (C) 2008-2019 Oprea Dan, Bart de Koning, Richard Bailey, Germar Reitze
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
import os
import pluginmanager
import subprocess
class NotifyPlugin(pluginmanager.Plugin):
def __init__(self):
self.user = ''
try:
self.user = os.getlogin()
except:
pass
if not self.user:
try:
user = os.environ['USER']
except:
pass
if not self.user:
try:
user = os.environ['LOGNAME']
except:
pass
def isGui(self):
return True
def message(self, profile_id, profile_name, level, message, timeout):
if 1 == level:
cmd = ['notify-send']
if timeout > 0:
cmd.extend(['-t', str(1000 * timeout)])
title = "Back In Time (%s) : %s" % (self.user, profile_name)
message = message.replace("\n", ' ')
message = message.replace("\r", '')
cmd.append(title)
cmd.append(message)
print(' '.join(cmd))
subprocess.Popen(cmd).communicate()
return
# Back In Time
# Copyright (C) 2008-2019 Oprea Dan, Bart de Koning, Richard Bailey, Germar Reitze
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
import sys
import os
import pluginmanager
import tools
import logger
import time
import gettext
import _thread
import subprocess
_=gettext.gettext
if not os.getenv('DISPLAY', ''):
os.putenv('DISPLAY', ':0.0')
class QtPlugin(pluginmanager.Plugin):
def __init__(self):
self.process = None
self.snapshots = None
def init(self, snapshots):
self.snapshots = snapshots
if not tools.checkXServer():
return False
return True
def isGui(self):
return True
def processBegin(self):
try:
path = os.path.join(tools.backintimePath('qt'), 'qtsystrayicon.py')
self.process = subprocess.Popen([sys.executable, path, self.snapshots.config.currentProfile()])
except:
pass
def processEnd(self):
if not self.process is None:
try:
#self.process.terminate()
return
except:
pass
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment