Mercurial > p > roundup > code
annotate share/man/man1/roundup-mailgw.1 @ 5543:bc3e00a3d24b
MySQL backend fixes for Python 3.
With Python 2, text sent to and from MySQL is treated as bytes in
Python. The database may be recorded by MySQL as having some other
encoding (latin1 being the default in some MySQL versions - Roundup
does not set an encoding explicitly, unlike in back_postgresql), but
as long as MySQL's notion of the connection encoding agrees with its
notion of the database encoding, no conversions actually take place
and the bytes are stored and returned as-is.
With Python 3, text sent to and from MySQL is treated as Python
Unicode strings. When the database and connection encoding is latin1,
that means the bytes stored in the database under Python 2 are
interpreted as latin1 and converted from that to Unicode, producing
incorrect results for any non-ASCII characters; furthermore, if trying
to store new non-ASCII data in the database under Python 3, any
non-latin1 characters produce errors.
This patch arranges for both the connection and database character
sets to be UTF-8 when using Python 3, and documents a need to export
and import the database when moving from Python 2 to Python 3 with
this backend.
| author | Joseph Myers <jsm@polyomino.org.uk> |
|---|---|
| date | Sun, 16 Sep 2018 16:19:20 +0000 |
| parents | a5a9b81f8f6b |
| children | 76e270b35e63 |
| rev | line source |
|---|---|
|
4096
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
1 .TH ROUNDUP-MAILGW 1 "24 January 2003" |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
2 .SH NAME |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
3 roundup-mailgw \- mail gateway for roundup |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
4 .SH SYNOPSIS |
|
4706
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
5 \fBroundup-mailgw\fP \fIinstance_home\fP [\fImethod\fP] |
|
4096
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
6 .SH OPTIONS |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
7 .TP |
|
4706
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
8 \fB-v\fP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
9 Print version and exit. |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
10 .TP |
|
4096
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
11 \fB-C\fP \fIhyperdb class\fP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
12 specify a tracker class - one of msg (the default), issue, file, user - to |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
13 manipulate with -S options |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
14 .TP |
|
4706
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
15 \fB-S\fP \fIproperty\fP\fB=\fP\fIvalue\fP[\fB;\fP\fIproperty\fP\fB=\fP\fIvalue\fP] \fIpairs\fP |
|
4096
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
16 specify the values to set on the class specified by -C using the same |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
17 format as the Subject line property manipulations |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
18 .SH DESCRIPTION |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
19 The roundup mail gateway may be called in one of three ways: |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
20 .IP \(bu |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
21 with an instance home as the only argument, |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
22 .IP \(bu |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
23 with both an instance home and a mail spool file, or |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
24 .IP \(bu |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
25 with both an instance home and a pop server account. |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
26 .PP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
27 \fBPIPE\fP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
28 .br |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
29 In the first case, the mail gateway reads a single message from the |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
30 standard input and submits the message to the roundup.mailgw module. |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
31 |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
32 \fBUNIX mailbox\fP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
33 .br |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
34 In the second case, the gateway reads all messages from the mail spool |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
35 file and submits each in turn to the roundup.mailgw module. The file is |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
36 emptied once all messages have been successfully handled. The file is |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
37 specified as: |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
38 \fImailbox /path/to/mailbox\fP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
39 |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
40 In all of the following the username and password can be stored in a |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
41 ~/.netrc file. In this case only the server name need be specified on |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
42 the command-line. |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
43 |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
44 The username and/or password will be prompted for if not supplied on |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
45 the command-line or in ~/.netrc. |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
46 |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
47 \fBPOP\fP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
48 .br |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
49 In the third case, the gateway reads all messages from the POP server |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
50 specified and submits each in turn to the roundup.mailgw module. The |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
51 server is specified as: |
|
4706
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
52 \fBpop\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP |
|
4096
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
53 .br |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
54 The username and password may be omitted: |
|
4706
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
55 \fBpop\fP \fIusername\fP\fB@\fP\fIserver\fP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
56 \fBpop\fP \fIserver\fP |
|
4096
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
57 .br |
|
4706
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
58 are both valid. The username and/or password will be prompted for if |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
59 not supplied on the command-line. |
|
4096
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
60 |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
61 \fBAPOP\fP |
|
4706
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
62 .br |
|
4096
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
63 Same as POP, but using Authenticated POP: |
|
4706
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
64 \fBapop\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
65 |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
66 \fBIMAP\fP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
67 .br |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
68 Connect to an IMAP server. This supports the same notation as that of |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
69 POP mail. |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
70 \fBimap\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
71 .br |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
72 It also allows you to specify a specific mailbox other than INBOX using |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
73 this format: |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
74 \fBimap\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver mailbox\fP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
75 |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
76 \fBIMAPS\fP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
77 .br |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
78 Connect to an IMAP server over ssl. |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
79 This supports the same notation as IMAP. |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
80 \fBimaps\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP [\fImailbox\fP] |
|
4096
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
81 .SH AUTHOR |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
82 This manpage was written by Bastian Kleineidam |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
83 <calvin@debian.org> for the Debian distribution of roundup. |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
84 |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
85 The main author of roundup is Richard Jones |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
86 <richard@users.sourceforge.net>. |
