summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJaromil <jaromil@dyne.org>2014-05-12 10:00:30 (GMT)
committer Jaromil <jaromil@dyne.org>2014-05-12 10:01:40 (GMT)
commitafb06bf75f3273012f06c7f23c8eb6542227f677 (patch)
tree1d2c0a3d508a2fe992f8e1b5a6e5645ffcb044f8
parentdd9124e12a57510d409c054ead82b87cbd518d6a (diff)
release documentationv2.0
-rw-r--r--ChangeLog.md2
-rw-r--r--README.md54
-rw-r--r--doc/Accounts/default.txt52
-rw-r--r--doc/jaromail-manual.pdfbin880014 -> 880014 bytes
-rw-r--r--doc/jaromail-manual.tex2
5 files changed, 87 insertions, 23 deletions
diff --git a/ChangeLog.md b/ChangeLog.md
index 6de9745..c2503dc 100644
--- a/ChangeLog.md
+++ b/ChangeLog.md
@@ -1,7 +1,7 @@
# JaroMail ChangeLog
## 2.0
-### 10 May 2014
+### 12 May 2014
This release includes a major rewrite of the filter engine now using
our own system based on ZSh map arrays in place of Procmail, improving
diff --git a/README.md b/README.md
index 63cbbf7..4af1759 100644
--- a/README.md
+++ b/README.md
@@ -55,21 +55,28 @@ A round-up on JaroMail features follows:
# INSTALL
-**Apple/OSX** users can simply drag JaroMail into /Applications
-When started JaroMail opens a Terminal window preconfigured with its
-environment, to activate it for any terminal add this to `~/.profile`:
+**Apple/OSX** users can simply drag JaroMail into /Applications When
+ started JaroMail opens a Terminal window preconfigured with its
+ environment, to activate it for any terminal add this to
+ `~/.profile`:
```
export PATH=/Applications/JaroMail.app/Contents/Resources/jaro/bin:$PATH
```
-**GNU/Linux** users can run `make` to install all needed components (done automatically, requires root) and compile auxiliary tools. Once compiled then `make install` will put JaroMail in `/usr/local`.
+**GNU/Linux** users can run `make` to install all needed components
+ (done automatically, requires root) and compile auxiliary
+ tools. Once compiled then `make install` will put JaroMail in
+ `/usr/local`.
The dependencies to be installed on the system for JaroMail are
* build: `bison flex make autoconf automake sqlite3 libgnome-keyring-dev`
* run: `procmail fetchmail msmtp mutt mairix pinentry abook wipe`
Bare in mind **you need to read the Manual**: this software is not
-graphical, it is not meant to be intuitive, does not contains eyecandies (except for stats on mail traffic). JaroMail is operated via Terminal, configured in plain text and overall made by geeks for geeks.
+graphical, it is not meant to be intuitive, does not contains
+eyecandies (except for stats on mail traffic). JaroMail is operated
+via Terminal, configured in plain text and overall made by geeks for
+geeks.
# Manual and usage instructions
@@ -88,7 +95,8 @@ https://github.com/dyne/JaroMail/blob/master/doc/jaromail-manual.org
All revisioned in Git, see: https://github.com/dyne/JaroMail
-Pull requests and patches welcome, for an overview of current plans see [TODO](TODO.md)
+Pull requests and patches welcome, for an overview of current plans
+see [TODO](TODO.md)
Our chat channel is **#dyne** on https://irc.dyne.org
@@ -106,11 +114,15 @@ By donating you will encourage further development.
# ACKNOWLEDGEMENTS
-The JaroMail software and user's manual is conceived, designed and put together with a substantial amount of ZShell scripts and some C code by Denis Roio aka [Jaromil](http://jaromil.dyne.org).
+The JaroMail software and user's manual is conceived, designed and put
+together with a substantial amount of ZShell scripts and some C code
+by Denis Roio aka [Jaromil](http://jaromil.dyne.org).
-The email envelop NyanCat graphics is kindly contributed by the Société ECOGEX.
+The email envelop NyanCat graphics is kindly contributed by the
+Société ECOGEX.
-JaroMail makes use of many external components to work and here below there is a non-inclusive list of those, with authors and contributors.
+JaroMail makes use of many external components to work and here below
+there is a non-inclusive list of those, with authors and contributors.
## Mutt
@@ -185,18 +197,18 @@ Visualize.JQuery by Scott Jehl Copyright (c) 2009 Filament Group
# Disclaimer
- JaroMail is Copyright (C) 2010-2014 Denis Roio <jaromil@dyne.org>
+JaroMail is Copyright (C) 2010-2014 Denis Roio <jaromil@dyne.org>
- This source code is free software; you can redistribute it and/or
- modify it under the terms of the GNU Public License as published by
- the Free Software Foundation; either version 3 of the License, or
- (at your option) any later version.
+This source code is free software; you can redistribute it and/or
+modify it under the terms of the GNU Public License as published by
+the Free Software Foundation; either version 3 of the License, or (at
+your option) any later version.
- This source code 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.
- Please refer to the GNU Public License for more details.
+This source code 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. Please refer to
+the GNU Public License for more details.
- You should have received a copy of the GNU Public License along with
- this source code; if not, write to:
- Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+You should have received a copy of the GNU Public License along with
+this source code; if not, write to: Free Software Foundation, Inc.,
+675 Mass Ave, Cambridge, MA 02139, USA.
diff --git a/doc/Accounts/default.txt b/doc/Accounts/default.txt
new file mode 100644
index 0000000..be36412
--- /dev/null
+++ b/doc/Accounts/default.txt
@@ -0,0 +1,52 @@
+# Name and values are separated by spaces or tabs
+# comments start the line with a hash
+
+# Give a name to this account
+name To Be Configured
+# configure Identity.txt to set your From: field
+
+# Email address (default is same as login)
+email unknown@gmail.com
+
+# Username
+login USERNAME@gmail.com
+
+## Change the settings only if you need
+
+# Imap host address
+imap imap.gmail.com
+
+# Imap port: usually 443, 220 or 993
+imap_port 993
+
+
+# Smtp host address
+smtp smtp.gmail.com
+
+# Smtp port: usually 25 or 465
+smtp_port 25
+
+
+# Authentication type
+auth plain # or kerberos, etc
+
+# Server certificate: check or ignore
+cert ignore
+
+# Transport protocol: ssl, tls or plain
+transport ssl
+
+
+# Options when fetching
+# to empty your mailbox you can use: fetchall flush
+# by default this is 'keep': don't delete mails from server
+options keep
+
+# Imap folders
+# uncomment to provide a list of folders to be fetched
+# folders INBOX, known, priv, lists, ml.unsorted, unsorted
+
+
+#
+# The password field will be filled in automatically
+#
diff --git a/doc/jaromail-manual.pdf b/doc/jaromail-manual.pdf
index 5ddb272..3e78d13 100644
--- a/doc/jaromail-manual.pdf
+++ b/doc/jaromail-manual.pdf
Binary files differ
diff --git a/doc/jaromail-manual.tex b/doc/jaromail-manual.tex
index c91dff5..a69ed36 100644
--- a/doc/jaromail-manual.tex
+++ b/doc/jaromail-manual.tex
@@ -1,4 +1,4 @@
-% Created 2014-05-09 Fri 19:58
+% Created 2014-05-12 Mon 11:58
\documentclass[a4,onecolumn,portrait]{article}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}