doc/man/gpodder-backup.1

   1 .TH GPODDER-BACKUP "1" "February 2009" "gpodder-backup 1.0" "User Commands"
   2 .SH NAME
   3 gpodder-backup \- Backup and restore utility for gPodder user data
   4 .SH SYNOPSIS
   5 .B gpodder-backup
   6 [\fI--create|--extract\fR] \fI<archive.gpo.tar.gz> \fR[\fIoptions\fR]
   7 .B gpodder-backup
   8 \fI\-\-purge\fR
   9 .SH DESCRIPTION
  10 .PP
  11 This utility can be used to create a dump of the current gPodder
  12 data (configuration files + downloads), optionally skipping the
  13 real contents of the download folder (for submitting your data
  14 to a bug report without having to transfer lots of data).
  15 .SH OPTIONS
  16 .TP
  17 \fB\-\-version\fR
  18 show program's version number and exit
  19 .TP
  20 \fB\-h\fR, \fB\-\-help\fR
  21 show this help message and exit
  22 .TP
  23 \fB\-c\fR <FILE>, \fB\-\-create=\fR<FILE>
  24 Create a new archive
  25 .TP
  26 \fB\-x\fR <FILE>, \fB\-\-extract=\fR<FILE>
  27 Extract an existing archive
  28 .TP
  29 \fB\-f\fR, \fB\-\-fake\-downloads\fR
  30 Do not store contents of downloaded files
  31 .TP
  32 \fB\-n\fR, \fB\-\-no\-covers\fR
  33 Do not include cover files in archive
  34 .TP
  35 \fB\-D\fR <DIR>, \fB\-\-destination=\fR<DIR>
  36 Extract downloads in different folder
  37 .TP
  38 \fB\-P\fR, \fB\-\-purge\fR
  39 Remove current data (can be combined with \-\-extract)
  40 .SH "USAGE FOR BUG REPORTING"
  41 .TP
  42 This command is useful if you want to report a bug in gPodder:
  43 .TP
  44 .B gpodder-backup \-\-create bug123.gpo.tar.gz \-\-fake-downloads
  45 Backup your current data to file \fIbug123.gpo.tar.gz\fR, but don't store
  46 download data (create zero-size dummy files instead). You can then attach
  47 \fIbug123.gpo.tar.gz\fR to the bug report.
  48 .TP
  49 If you are instructed to try gPodder from a "clean state", you can use the following command (be sure to backup your data before!):
  50 .TP
  51 .B gpodder-backup \-\-purge
  52 Remove all gPodder data, so you can start from a clean state
  53 .SH EXAMPLES
  54 .TP
  55 .B gpodder-backup \-\-create today.gpo.tar.gz
  56 Backup your current data to file \fItoday.gpo.tar.gz\fR
  57 .TP
  58 .B gpodder-backup \-\-extract mybackup.gpo.tar.gz
  59 Restore (without purging) the contents of \fImybackup.gpo.tar.gz\fR
  60 .TP
  61 .B gpodder-backup \-\-extract default.gpo.tar.gz \-\-purge
  62 Remove current data, then restore the contents of \fIdefault.gpo.tar.gz\fR
  63 .TP
  64 .B gpodder-backup \-\-purge
  65 Remove all gPodder data, so you can start from a clean state
  66 .SH AUTHOR
  67 gpodder-backup was written by Thomas Perl (thp@gpodder.org)