From 0ced7a2fa610efcf6aa84aa03c4f696ce10fa21f Mon Sep 17 00:00:00 2001 From: richard Date: Wed, 26 Mar 2003 06:17:16 +0000 Subject: [PATCH] doc fixes git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@1632 57a73879-2fb5-44c3-a270-3262357dd7e2 --- doc/Makefile | 2 +- doc/customizing.txt | 7 ++++--- doc/installation.txt | 4 ++-- doc/roundup-mailgw.1 | 4 ++++ doc/upgrading.txt | 10 +++++----- doc/user_guide.txt | 24 +++++++++++++++++------- 6 files changed, 33 insertions(+), 18 deletions(-) diff --git a/doc/Makefile b/doc/Makefile index eb1701c..5322ca0 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,5 +1,5 @@ PYTHON = /usr/bin/python2 -STXTOHTML = stx2html +STXTOHTML = rst2html SOURCE = announcement.txt customizing.txt developers.txt FAQ.txt features.txt \ glossary.txt implementation.txt index.txt design.txt \ diff --git a/doc/customizing.txt b/doc/customizing.txt index 761e48c..3298e01 100644 --- a/doc/customizing.txt +++ b/doc/customizing.txt @@ -2,7 +2,7 @@ Customising Roundup =================== -:Version: $Revision: 1.79 $ +:Version: $Revision: 1.80 $ .. This document borrows from the ZopeBook section on ZPT. The original is at: http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx @@ -120,7 +120,8 @@ The configuration variables available are: Additional text to include in the "name" part of the ``From:`` address used in nosy messages. If the sending user is "Foo Bar", the ``From:`` line is usually:: - "Foo Bar" + + "Foo Bar" the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so:: @@ -2918,7 +2919,7 @@ is resolved. To achieve this: priority=Link("priority"), status=Link("status")) 2. Add the new "blockers" property to the issue.item edit page, using - something like: + something like:: Waiting On diff --git a/doc/installation.txt b/doc/installation.txt index 3d8833b..0276111 100644 --- a/doc/installation.txt +++ b/doc/installation.txt @@ -2,7 +2,7 @@ Installing Roundup ================== -:Version: $Revision: 1.41 $ +:Version: $Revision: 1.42 $ .. contents:: @@ -215,7 +215,7 @@ There's several to choose from, each with benefits and limitations: **mysql** Backend for popular RDBMS MySQL. This backend uses MySQL's Berkeley DB (transaction safe) table format, so with small amount of data it may be a - bit slower than *dbm backends (due to mysql layer's overhead). However with + bit slower than \*dbm backends (due to mysql layer's overhead). However with lots of data mysql may perform better (due to query optimisation). No actual serious benchmarks were made though. For more info on installation of this backend see doc/mysql.txt. diff --git a/doc/roundup-mailgw.1 b/doc/roundup-mailgw.1 index b0cf288..593cd47 100644 --- a/doc/roundup-mailgw.1 +++ b/doc/roundup-mailgw.1 @@ -47,6 +47,10 @@ The username and password may be omitted: .br are both valid. The username and/or password will be prompted for if not supplied on the command-line. + +\fBAPOP\fP +Same as POP, but using Authenticated POP: + \fIapop username:password@server\fP .SH AUTHOR This manpage was written by Bastian Kleineidam for the Debian distribution of roundup. diff --git a/doc/upgrading.txt b/doc/upgrading.txt index 9ba63c7..a334470 100644 --- a/doc/upgrading.txt +++ b/doc/upgrading.txt @@ -81,12 +81,12 @@ name:confirm -> :confirm:name timezone=String()) And second - html interface. Add following lines to - $TRACKER_HOME/html/user.item template: + $TRACKER_HOME/html/user.item template:: - - Timezone - timezone - + + Timezone + timezone + After that all users should be able to provide their timezone information. Timezone should be a positive or negative integer - offset from GMT. diff --git a/doc/user_guide.txt b/doc/user_guide.txt index 49ca3a3..0117c55 100644 --- a/doc/user_guide.txt +++ b/doc/user_guide.txt @@ -2,7 +2,7 @@ User Guide ========== -:Version: $Revision: 1.14 $ +:Version: $Revision: 1.15 $ .. contents:: @@ -108,14 +108,17 @@ XXX: some information about how searching works Some fields in the search page (e.g. "Activity" or "Creation date") accept ranges of dates. You can specify range of dates in one of two formats: - 1. Native english syntax: - [[From] ][ To ] - Keywords "From" and "To" are case insensitive. Keyword "From" is optional. +1. Native english syntax:: - 2. "Geek" syntax: - [][; ] + [[From] ][ To ] -Either first or second can be omitted in both syntaxes. + Keywords "From" and "To" are case insensitive. Keyword "From" is optional. + +2. "Geek" syntax:: + + [][; ] + +Either first or second ```` can be omitted in both syntaxes. For example: @@ -377,15 +380,22 @@ POP: In the third case, the gateway reads all messages from the POP server specified and submits each in turn to the roundup.mailgw module. The server is specified as:: + pop username:password@server The username and password may be omitted:: + pop username@server pop server are both valid. The username and/or password will be prompted for if not supplied on the command-line. +APOP: + Same as POP, but using Authenticated POP:: + + apop username:password@server + Command Line Tool ================= -- 2.30.2