~ubuntu-branches/ubuntu/edgy/pilot-link/edgy

« back to all changes in this revision

Viewing changes to doc/man/install-datebook.1

  • Committer: Bazaar Package Importer
  • Author(s): Ludovic Rousseau
  • Date: 2006-09-22 11:51:36 UTC
  • mfrom: (3.1.8 edgy)
  • Revision ID: james.westby@ubuntu.com-20060922115136-qqmy17bx8j5x0y72
Tags: 0.12.1-5
* urgency medium since libpisock-dev was not usable to build any package
* libpisock-dev now depends on libusb-dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\"Generated by db2man.xsl. Don't modify this, modify the source.
 
2
.de Sh \" Subsection
 
3
.br
 
4
.if t .Sp
 
5
.ne 5
 
6
.PP
 
7
\fB\\$1\fR
 
8
.PP
 
9
..
 
10
.de Sp \" Vertical space (when we can't use .PP)
 
11
.if t .sp .5v
 
12
.if n .sp
 
13
..
 
14
.de Ip \" List item
 
15
.br
 
16
.ie \\n(.$>=3 .ne \\$3
 
17
.el .ne 3
 
18
.IP "\\$1" \\$2
 
19
..
 
20
.TH "install-datebook" 1 "Copyright 1996-2005 FSF" "0.12.1" "PILOT-LINK"
 
21
.SH NAME
 
22
install-datebook \- Installs one or more new datebook entries onto your Palm handheld.
 
23
.SH "SECTION"
 
24
 
 
25
.PP
 
26
pilot\-link: Conduits
 
27
 
 
28
.SH "SYNOPSIS"
 
29
 
 
30
.PP
 
31
 \fIinstall\-datebook\fR [\fB\-p\fR|\fB\-\-port\fR <\fBport\fR>] [\fB\-\-version\fR] [\fB\-?\fR|\fB\-\-help\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-usage\fR] [\fB\-r\fR|\fB\-\-read\fR  \fIfile\fR]
 
32
 
 
33
.SH "DESCRIPTION"
 
34
 
 
35
.PP
 
36
 \fIinstall\-datebook\fR allows the user to create one or more datebook entries from one or more source files\&.
 
37
 
 
38
.PP
 
39
The format of the source file contains one datebook entry per line, containing four tab separated fields\&. The fields are start date/time, end date/time, alarm settings, and the description of datebook entry\&. This program doesn't yet support repeated entries\&. The date and time must be in format understood by \fIparsedate\&.y\fR\&. At the very least, the following two formats are understood:
 
40
 
 
41
.PP
 
42
August 11, 1997 0800 GMT+300
 
43
 
 
44
.PP
 
45
1997/08/11 08:22:33 GMT+300
 
46
 
 
47
.PP
 
48
If either one of the date and time fields is empty, the entry is installed without time\&. If the alarm field is empty, the entry is installed without setting any alarms\&. The alarm field can contain numbers followed by "m" (minutes), "h" (hours), or "d" (days)\&.
 
49
 
 
50
.SH "OPTIONS"
 
51
 
 
52
.SS "install-datebook options"
 
53
 
 
54
.TP
 
55
\fB\-r\fR, \fB\-\-read\fR
 
56
Read entries from \fIfile\fR\&.
 
57
 
 
58
.SS "Conduit Options"
 
59
 
 
60
.TP
 
61
\fB\-p\fR, \fB\-\-port\fR <\fBport\fR>
 
62
Use device file <\fIport\fR> to communicate with the Palm handheld\&. If this is not specified,\fIinstall\-datebook\fR will look for the\fI$PILOTPORT\fR environment variable\&. If neither are found, \fIinstall\-datebook\fR will print the usage information\&.
 
63
 
 
64
.TP
 
65
\fB\-q\fR, \fB\-\-quiet\fR
 
66
Suppress 'Hit HotSync button' message
 
67
 
 
68
.TP
 
69
\fB\-\-version\fR
 
70
Display the copyright information, version number, license details and build details and exit without connecting\&.
 
71
 
 
72
.SS "Help options"
 
73
 
 
74
.TP
 
75
\fB\-?\fR, \fB\-\-help\fR
 
76
Show the help message and exit without connecting\&.
 
77
 
 
78
.TP
 
79
\fB\-\-usage\fR
 
80
Display a brief usage message and exit without connecting\&.
 
81
 
 
82
.SH "USAGE"
 
83
 
 
84
.PP
 
85
The program will connect to the target Palm device, and create Datebook entries based on the datebook\-formatted file given on the commandline onto the Palm handheld (into the DatebookDB\&.pdb file)\&.
 
86
 
 
87
.SH "EXAMPLES"
 
88
 
 
89
.PP
 
90
([__TAB__] = tab, [__NL__] = newline in these examples):
 
91
 
 
92
.PP
 
93
1997/08/11 0800 GMT+300 [__TAB__] 1997/08/11 0900 GMT+300 [__TAB__] [__TAB__] IETF Registration [__NL__]
 
94
 
 
95
.PP
 
96
August 11, 1997 0900 GMT+300 [__TAB__] August 11, 1997 0930 GMT+300 [__TAB__] 2m [__TAB__] Introductions [__NL__]
 
97
 
 
98
.SH "AUTHOR"
 
99
 
 
100
.PP
 
101
 \fIinstall\-datebook\fR was originally written by Tero Kivinen <kivinen@iki\&.fi>\&. This program was based on \fIinstall\-todos\fR program written by Robert A\&. Kaplan <kaplan@openmarket\&.com>\&.
 
102
 
 
103
.PP
 
104
This manual page was converted to XML by Neil Williams <linux@codehelp\&.co\&.uk> 
 
105
 
 
106
.SH "BUGS"
 
107
 
 
108
.SS "Known Bugs"
 
109
 
 
110
.PP
 
111
If no timezone is given, \fIinstall\-datebook\fR will assume the time is in GMT and it will convert it to localtime\&. If you don't want to create timezone entries for all begin and end times, set the TZ environment variable to GMT before running this program\&.
 
112
 
 
113
.SS "Reporting Bugs"
 
114
 
 
115
.PP
 
116
Report bugs at \fIhttp://bugs\&.pilot\-link\&.org/\fR 
 
117
 
 
118
.SH "COPYRIGHT"
 
119
 
 
120
.PP
 
121
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version\&.
 
122
 
 
123
.PP
 
124
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU General Public License for more details\&.
 
125
 
 
126
.PP
 
127
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc\&., 51 Franklin St, Fifth Floor, Boston, MA 02110\-1301, USA\&.
 
128
 
 
129
.SH "SEE ALSO"
 
130
 
 
131
.PP
 
132
 \fIinstall\-todos\fR(1), \fIpilot\-link\fR(7)\&.
 
133