Merge branch 'ical'
[alpine.git] / doc / man1 / rpload.1
blobf645a24865f4e17196d74d47edd85255454df077
1 .TH rpload 1
2 .SH NAME
3 rpload \- alpine remote data utility
4 .SH SYNTAX 
6 .B rpload
7 [ -f ] [ -s trimSize ] -t Type -l Local_file -r Remote_folder
8 .SH DESCRIPTION
10 Rpload may be used to convert local Alpine configuration files or address
11 books into remote configurations or address books.
12 It is intended to be used by system administrators.
13 Regular users should normally use the facilities provided within Alpine.
14 .LP
15 Local_file will usually be a user's alpine configuration file, and
16 Remote_folder is the IMAP folder which will be used
17 (with the help of Alpine's \fB-p\fR, \fB-P\fR, and \fB-x\fR commands or
18 PINECONF, PINERC, and PINERCEX environment variables)
19 as the user's remote configuration folder.
20 A copy of Local_file will be placed in the folder with the correct header
21 lines to satisfy Alpine.
22 .IP \fB-f\fR 20
23 Force the load even if the remote folder is in the wrong format.
24 This will \fBdelete\fR the contents of the folder so use it carefully.
25 .IP \fB-s\fR\ \fBtrimSize\fR 20
26 If the number of messages in the remote folder is more than one plus
27 trimsize (one is for the header message), then messages 2, 3, and so on
28 will be deleted until there are only one plus trimsize messages left.
29 If this option is not set no trimming will be done.
30 .IP \fB-t\fR\ \fBType\fR 20
31 The possible Types are \fBpinerc\fR, \fBabook\fR, and \fBsig\fR.
32 (Sig is mostly obsolete. Literal signatures contained within the remote
33 pinerc should be used instead.)
34 .IP \fB-l\fR\ \fBLocal_file\fR 20
35 The file on this system that is to be copied.
36 .IP \fB-r\fR\ \fBRemote_folder\fR 20
37 A remote folder name to be copied to.
38 See the Alpine documentation for the syntax of a remote folder name.
39 One example is
40 .br
41 {my.imap.server}remote_pinerc.
42 .SH DIAGNOSTICS
43 Exit status is zero if all goes well, -1 otherwise.
44 .SH "SEE ALSO"
45 Rpdump(1).
46 .LP
47 Copyright 1989-2007 by the University of Washington.
49 $Date: 2005/01/14 20:40:14 $