Warning, /utilities/kbackup/doc/en/man-kbackup.1.docbook is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" ?> 0002 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "/usr/share/kf5/kdoctools/customization/dtd/kdedbx45.dtd" [ 0003 <!ENTITY % addindex "IGNORE"> 0004 ]> 0005 0006 <!--Rename this template to man-$applicationname.x.docbook, 0007 where x is the manual section, see https://en.wikipedia.org/wiki/Man_page#Manual_sections 0008 --> 0009 0010 <refentry lang="&language;"> 0011 <refentryinfo> 0012 <!-- replace Foo with the application name--> 0013 <title>KBackup User's Manual</title> 0014 <author><personname> 0015 <firstname>Scarlett</firstname> 0016 <surname>Moore</surname> 0017 </personname> 0018 <email>sgmoore@kde.org</email></author> 0019 <!--Date when this manpage was written, in the ISO 8601 format 'yyyy-mm-dd'--> 0020 <date>2020-07-23</date> 0021 <!--version information of application this manpage is valid for. 0022 Change date/releaseinfo only if 0023 docbook is updated and verified to be valid for the current app version 0024 docbook is proofreaded and verified to be valid for the current app version 0025 --> 0026 <releaseinfo>Applications 20.04</releaseinfo> 0027 <!-- replace $applicationname with the application name; &kde; as prefix/namespace could 0028 be not needed, ask the promo team in case of doubt 0029 Example: 0030 Frameworks xx.yy for docbooks in frameworks 0031 Plasma xx.yy for docbooks in plasma 0032 Applications xx.yy for docbooks released as Applications 0033 xx.yy (Applications xx.yy) for docbooks with own version released as Applications 0034 $applicationname xx.yy for applications with independent release schedule (extragear/playground) 0035 --> 0036 0037 <productname>KDE Applications</productname> 0038 <!-- no productname in man pages for extragear applications --> 0039 </refentryinfo> 0040 0041 <refmeta> 0042 <refentrytitle><command>kbackup</command></refentrytitle> 0043 <manvolnum>1</manvolnum> 0044 </refmeta> 0045 0046 <refnamediv> 0047 <refname><command>kbackup</command></refname> 0048 <refpurpose>Backup program with an easy-to-use interface</refpurpose> 0049 </refnamediv> 0050 0051 <refsynopsisdiv id="_synopsis"> 0052 <cmdsynopsis> 0053 <command>kbackup</command> 0054 <arg rep="repeat"><replaceable>OPTIONS</replaceable></arg> 0055 <arg rep="repeat"><replaceable>Module name | Module set name</replaceable></arg> 0056 </cmdsynopsis> 0057 </refsynopsisdiv> 0058 0059 0060 <refsect1> 0061 <title>DESCRIPTION</title> 0062 <para> Kbackup is a program that lets you back up any directories or files. It uses 0063 an easy to use directory tree to select the things to back up and lets you 0064 save your settings in "profile" files. These are simple textfiles containing 0065 definitions for directories and files to be included or excluded from the 0066 backup process.</para> 0067 0068 </refsect1> 0069 0070 <refsect1> 0071 <title>OPTIONS</title> 0072 <!--App options, in a variablelist--> 0073 <variablelist> 0074 <varlistentry> 0075 <term> 0076 <option>-v, --version</option> 0077 </term> 0078 <listitem> 0079 <para>Displays version information.</para> 0080 </listitem> 0081 </varlistentry> 0082 <varlistentry> 0083 <term> 0084 <option>-h, --help</option> 0085 </term> 0086 <listitem> 0087 <para>Displays help on commandline options.</para> 0088 </listitem> 0089 </varlistentry> 0090 <varlistentry> 0091 <term> 0092 <option>--help-all</option> 0093 </term> 0094 <listitem> 0095 <para>Displays help including Qt specific options.</para> 0096 </listitem> 0097 </varlistentry> 0098 <varlistentry> 0099 <term> 0100 <option>--help-all --qmljsdebugger <replaceable>value</replaceable></option> 0101 </term> 0102 <listitem> 0103 <para>Activates the QML/JS debugger with a specified port. 0104 The value must be of format port:1234[,block]. "block" makes the application wait for a connection.</para> 0105 </listitem> 0106 </varlistentry> 0107 <varlistentry> 0108 <term> 0109 <option>--script <replaceable>file</replaceable></option> 0110 </term> 0111 <listitem> 0112 <para>Script to run after finishing one archive slice.</para> 0113 </listitem> 0114 </varlistentry> 0115 <varlistentry> 0116 <term> 0117 <option>--auto <replaceable>profile</replaceable></option> 0118 </term> 0119 <listitem> 0120 <para>Automatically run the backup with the given profile and terminate when done.</para> 0121 </listitem> 0122 </varlistentry> 0123 <varlistentry> 0124 <term> 0125 <option>--autobg <replaceable>profile</replaceable> </option> 0126 </term> 0127 <listitem> 0128 <para>Automatically run the backup with the given profile in the background (without showing a window) and terminate when done.</para> 0129 </listitem> 0130 </varlistentry> 0131 <varlistentry> 0132 <term> 0133 <option>--verbose <replaceable>profile</replaceable></option> 0134 </term> 0135 <listitem> 0136 <para>In autobg mode be verbose and print every single filename during backup.</para> 0137 </listitem> 0138 </varlistentry> 0139 <varlistentry> 0140 <term> 0141 <option>--forceFull </option> 0142 </term> 0143 <listitem> 0144 <para>In auto/autobg mode force the backup to be a full backup instead of acting on the profile settings.</para> 0145 </listitem> 0146 </varlistentry> 0147 <varlistentry> 0148 <term> 0149 <option>--author</option> 0150 </term> 0151 <listitem> 0152 <para>Show author information.</para> 0153 </listitem> 0154 </varlistentry> 0155 <varlistentry> 0156 <term> 0157 <option>--license</option> 0158 </term> 0159 <listitem> 0160 <para>Show license information.</para> 0161 </listitem> 0162 </varlistentry> 0163 <varlistentry> 0164 <term> 0165 <option>--desktopfile <replaceable>file</replaceable> </option> 0166 </term> 0167 <listitem> 0168 <para>The base file name of the desktop entry for this application.</para> 0169 </listitem> 0170 </varlistentry> 0171 </variablelist> 0172 0173 </refsect1> 0174 0175 <!--The Following sections are optional, but recommended if they are 0176 applicable.--> 0177 0178 <refsect1> 0179 <title>ENVIRONMENT</title> 0180 <para><!--Environment variables that affect this command, how to set 0181 them, who sets them, how they affect it, probably in a variablelist. Only for 0182 man sections 1, 6, 7 and 8--></para> 0183 </refsect1> 0184 0185 <refsect1> 0186 <title>FILES</title> 0187 <para>.kbp profile files. Generated by user on save profile.</para> 0188 </refsect1> 0189 0190 <refsect1> 0191 <title>See Also</title> 0192 <simplelist> 0193 <member>More detailed user documentation is available from <ulink 0194 url="help:/ --commandname-- ">help:/kbackup</ulink> 0195 (either enter this &URL; into &konqueror;, or run 0196 <userinput><command>khelpcenter</command> 0197 <parameter>man:/kbackup</parameter></userinput>).</member> 0198 <!--for man pages replace "help:/" with "man:/" in this member--> 0199 <member>kf5options(7)</member> <!-- only for application with a GUI--> 0200 <member>qt5options(7)</member> <!-- only for application with a GUI--> 0201 <!--<member>foo(1)</member> more man page references if applicable--> 0202 <member>There is also further information available at <ulink url="https://apps.kde.org/kbackup">https://apps.kde.org/kbackup</ulink> </member> 0203 </simplelist> 0204 </refsect1> 0205 0206 <refsect1> 0207 <title>Examples</title> 0208 <para>kbackup myData.kbp 0209 Used to load existing profile. 0210 </para> 0211 </refsect1> 0212 0213 0214 <refsect1> 0215 <title>Authors</title> 0216 <para>Kbackup was written by Martin Koller <email> kollix@aon.at</email> 0217 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 0218 licensed under the same terms as kbackup.</para> 0219 </refsect1> 0220 0221 </refentry>