gui/man/barrybackup.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH BARRYBACKUP 1 "July 28, 2009"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 .B barrybackup
  20 \- Barry Project's backup program for the BlackBerry handheld
  21 .SH SYNOPSIS
  22 .B barrybackup
  23 [\-?][\-d]
  24 .SH DESCRIPTION
  25 .PP
  26 .B barrybackup
  27 is a GUI application for backing up and restoring Blackberry handheld
  28 databases.
  29
  30 The application allows for filtering of databases for both backup
  31 and restore, so not all databases need to be backed up at once,
  32 nor all restored.
  33
  34 Backups and configuration files are stored by default in the user's
  35 home directory, under ~/.barry/backup/PIN.  This destination can be
  36 changed in the config dialogs, per device.
  37
  38 The backup files are compressed tarballs containing specially named
  39 files for each record of the databases.
  40 .SH OPTIONS
  41 .TP
  42 .B \-d
  43 .B \-\-debug\-output
  44 Enables low level protocol debug output written to stdout/stderr.
  45 .TP
  46 .B \-\-display=DISPLAY
  47 Specify which X display to use.
  48 .TP
  49 .B \-?
  50 .B \-\-help
  51 Show summary of options.
  52 .TP
  53 .B \-h, \-\-help
  54 Show summary of options.
  55
  56 .SH TAR FORMAT
  57 Backups are stored in tar format, compressed with gzip.  Backup files
  58 are named with the following pattern:
  59
  60         PIN\-YYYYMMDD\-HHMMSS[\-tag_name].tar.gz
  61
  62 The tag name is optional and is used to name a particular backup.
  63
  64 Each record is appended to the tar file using the following pattern
  65 for the filename:
  66
  67         DBname/RecordID RecordTypeID
  68
  69 That is, the database name is used as the directory name, and
  70 the filename contains the record ID and record type ID separated
  71 by a space.
  72
  73 Database names can contain spaces.
  74
  75 Record IDs are generally unique, but not all Blackberry devices
  76 mandate this, so it is possible, but rare, to have two records
  77 in the tar file with the same filename.  This is ok.  The only problem you'd
  78 see is if you expanded such a tar file to a filesystem.  The restore
  79 process just reads in the filename sequentially and writes them to
  80 the device, so duplicate record IDs are not a problem.
  81
  82 .SH AUTHOR
  83 .nh
  84 .B barrybackup
  85 is part of the Barry project.
  86 This manual page was written by Chris Frey.
  87 .SH SEE ALSO
  88 .PP
  89 http://www.netdirect.ca/software/packages/barry
  90