.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "kw-backup - Save and restore kw internal data" "" "" ""
.SH Name
kw-backup - Save and restore kw internal data \- 
.SH SYNOPSIS
.nf
\fIkw\fP \fIbackup\fP [<path>]
\fIkw\fP \fIbackup\fP (\-r | \-\-restore) <path> [(\-f | \-\-force)]
\fIkw\fP \fIbackup\fP (\-\-verbose)
.fi
.sp
.SH DESCRIPTION
.INDENT 0.0
.INDENT 3.5
If you provide a path, a tar.gz file will be generated and stored in \fI<path>\fP,
containing all the data found in the \fBKW_DATA_DIR\fP folder. If no path is
provided, then the backup will be stored in the current directory.
.UNINDENT
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
.B \-r, \-\-restore <path>:
This option allows you to recover all the data from kw, by extracting a tar.gz
file located in \fI<path>\fP and storing it back again in the \fBKW_DATA_DIR\fP
folder. If files with the same name are found during the restoration process,
then it will by default ask you on how to proceed. To simply replace all files
from \fBKW_DATA_DIR\fP with the backup, you may use the \fI\-\-force\fP option.
.TP
.B \-\-verbose:
Verbose mode is an option that causes the kw program to display debug messages to track
its progress. This functionality is very useful during the debugging process, allowing
you to identify possible errors more easily.
.UNINDENT
.SH EXAMPLES
.sp
To generate a backup file in your current directory, run:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
kw backup
.EE
.UNINDENT
.UNINDENT
.sp
You can also specify the directory to save the backup. Let\(aqs say you want to
save it into /documents/backup, then run:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
kw backup /documents/backup
.EE
.UNINDENT
.UNINDENT
.sp
To restore a backup, use the \fI\-\-restore\fP option. Suppose you want to restore the
backup stored in /documents/backup/kw\-backup\-from\-yesterday.tar.gz, run:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
kw backup \-\-restore /documents/backup/kw\-backup\-from\-yesterday.tar.gz
.EE
.UNINDENT
.UNINDENT
.\" End of generated man page.