maint: fixed missing argument in tagged release script
[barry.git] / man / btardump.1
blob7f59f357194c7346b139073df3928805d7830572
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 BTARDUMP 1 "December 7, 2010"
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 btardump
20 \- Command line parser for Barry backup files
21 .SH SYNOPSIS
22 .B btardump
23 [-d db][-h][-i charset][-V] filename [filenames...]
24 .SH DESCRIPTION
25 .PP
26 .B btardump
27 takes one or more Barry backup tar files on the command line, and
28 dumps parsed database records to stdout.  By default, all records
29 are dumped, but this can be limited by the -d option.
30 .SH OPTIONS
31 .TP
32 .B \-d db
33 Name of database to dump to stdout.  Can be used multiple times
34 to parse multiple databases at once.  If not specified, all available
35 databases from the backup file are dumped.
36 .TP
37 .B \-h, \-\-help
38 Show summary of options.
39 .TP
40 .B \-i charset
41 Specifies the iconv charset to use for converting international strings.
42 The Blackberry uses the WINDOWS-1252 charset, which is incompatible with
43 the more common code pages used in Linux.  The most useful charset to use
44 with this option is UTF-8, and is highly recommended.  Any other charset
45 available via 'iconv --list' can be used here too, but may not be
46 successful for some character conversions.
47 .TP
48 .B \-V
49 Enable vformat MIME output where available.  Address Book gets printed
50 in vCard format, Calendar in vEvent format, Memos in vJournal, and
51 Tasks in vTodo, etc.
53 .SH AUTHOR
54 .nh
55 .B btardump
56 is part of the Barry project.
57 .SH SEE ALSO
58 .PP
59 http://www.netdirect.ca/barry