man-kbackup.1.docbook 6.61 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<?xml version="1.0" ?>
<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "/usr/share/kf5/kdoctools/customization/dtd/kdedbx45.dtd" [
  <!ENTITY % addindex "IGNORE">
]>

<!--Rename this template to man-$applicationname.x.docbook,
where x is the manual section, see https://en.wikipedia.org/wiki/Man_page#Manual_sections
-->

<refentry lang="&language;">
<refentryinfo>
<!-- replace Foo with the application name-->
<title>KBackup User's Manual</title>
<author><personname>
<firstname>Scarlett</firstname>
<surname>Moore</surname>
</personname>
<email>sgmoore@kde.org</email></author>
<!--Date when this manpage was written, in the ISO 8601 format 'yyyy-mm-dd'-->
<date>2020-07-23</date>
<!--version information of application this manpage is valid for.
Change date/releaseinfo only if
   docbook is updated and verified to be valid for the current app version
   docbook is proofreaded and verified to be valid for the current app version
-->
<releaseinfo>Applications 20.04</releaseinfo>
<!-- replace $applicationname with the application name; &kde; as prefix/namespace could
be not needed, ask the promo team in case of doubt
Example:
Frameworks xx.yy for docbooks in frameworks
Plasma xx.yy for docbooks in plasma
Applications xx.yy for docbooks released as Applications
xx.yy (Applications xx.yy) for docbooks with own version released as Applications
$applicationname xx.yy for applications with independent release schedule (extragear/playground)
-->

<productname>KDE Applications</productname>
<!-- no productname in man pages for extragear applications -->
</refentryinfo>

<refmeta>
42
<refentrytitle><command>kbackup</command></refentrytitle>
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
<manvolnum>1</manvolnum>
</refmeta>

<refnamediv>
<refname><command>kbackup</command></refname>
<refpurpose>Backup program with an easy-to-use interface</refpurpose>
</refnamediv>

<refsynopsisdiv id="_synopsis">
<cmdsynopsis>
<command>kbackup</command>
<arg rep="repeat"><replaceable>OPTIONS</replaceable></arg>
<arg rep="repeat"><replaceable>Module name | Module set name</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>


<refsect1>
<title>DESCRIPTION</title>
<para> Kbackup is a program that lets you back up any directories or files. It uses
 an easy to use directory tree to select the things to back up and lets you
 save your settings in "profile" files. These are simple textfiles containing
 definitions for directories and files to be included or excluded from the
 backup process.</para> 

</refsect1>

<refsect1>
<title>OPTIONS</title>
<!--App options, in a variablelist-->
<variablelist>
<varlistentry>
<term>
    <option>-v, --version</option>
</term>
<listitem>
    <para>Displays version information.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
    <option>-h, --help</option>
</term>
<listitem>
    <para>Displays help on commandline options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
    <option>--help-all</option>
</term>
<listitem>
    <para>Displays help including Qt specific options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
    <option>--help-all --qmljsdebugger <replaceable>value</replaceable></option>
</term>
<listitem>
    <para>Activates the QML/JS debugger with a specified port. 
  The value must be of format port:1234[,block]. "block" makes the application wait for a connection.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
    <option>--script <replaceable>file</replaceable></option>
</term>
<listitem>
    <para>Script to run after finishing one archive slice.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
    <option>--auto <replaceable>profile</replaceable></option>
</term>
<listitem>
    <para>Automatically run the backup with the given profile and terminate when done.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
    <option>--autobg <replaceable>profile</replaceable> </option>
</term>
<listitem>
    <para>Automatically run the backup with the given profile in the background (without showing a window) and terminate when done.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
    <option>--verbose <replaceable>profile</replaceable></option>
</term>
<listitem>
    <para>In autobg mode be verbose and print every single filename during backup.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
    <option>--forceFull </option>
</term>
<listitem>
    <para>In auto/autobg mode force the backup to be a full backup instead of acting on the profile settings.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
    <option>--author</option>
</term>
<listitem>
    <para>Show author information.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
    <option>--license</option>
</term>
<listitem>
    <para>Show license information.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
    <option>--desktopfile <replaceable>file</replaceable> </option>
</term>
<listitem>
    <para>The base file name of the desktop entry for this application.</para>
</listitem>
</varlistentry>
</variablelist>

</refsect1>

<!--The Following sections are optional, but recommended if they are
applicable.-->

<refsect1>
<title>ENVIRONMENT</title>
<para><!--Environment variables that affect this command, how to set
them, who sets them, how they affect it, probably in a variablelist.  Only for
man sections 1, 6, 7 and 8--></para>
</refsect1>

<refsect1>
<title>FILES</title>
<para>.kbp profile files. Generated by user on save profile.</para>
</refsect1>

<refsect1>
<title>See Also</title>
<simplelist>
<member>More detailed user documentation is available from <ulink
url="help:/ --commandname-- ">help:/kbackup</ulink>
(either enter this &URL; into &konqueror;, or run
<userinput><command>khelpcenter</command>
<parameter>man:/kbackup</parameter></userinput>).</member>
<!--for man pages replace "help:/" with "man:/" in this member-->
<member>kf5options(7)</member> <!-- only for application with a GUI-->
<member>qt5options(7)</member> <!-- only for application with a GUI-->
<!--<member>foo(1)</member> more man page references if applicable-->
<member>There is also further information available at <ulink url="https://kde.org/applications/en/utilities/org.kde.kbackup">https://kde.org/applications/en/utilities/org.kde.kbackup</ulink>  </member>
</simplelist>
</refsect1>

<refsect1>
<title>Examples</title>
<para>kbackup myData.kbp
    Used to load existing profile.
    </para>
</refsect1>


<refsect1>
<title>Authors</title>
<para>Kbackup was written by Martin Koller <email> kollix@aon.at</email>
217
        This man-page was created by Scott Kitterman <email>scott@kitterman.com</email> and updated by Scarlett Moore <email>sgmoore@kde.org</email>, it is
218
219
220
221
licensed under the same terms as kbackup.</para>
</refsect1>

</refentry>