From 15348fb2453ef5cf2ac6e4d871d69f116f0b8593 Mon Sep 17 00:00:00 2001
From: Manos Pitsidianakis <el13635@mail.ntua.gr>
Date: Wed, 27 Nov 2019 17:40:00 +0200
Subject: [PATCH] meli.1: add contacts doc

---
 meli.1 | 114 +++++++++++++++++++++++++++++++++------------------------
 1 file changed, 67 insertions(+), 47 deletions(-)

diff --git a/meli.1 b/meli.1
index 70333629f..900c929ad 100644
--- a/meli.1
+++ b/meli.1
@@ -105,6 +105,54 @@ instead to use the mailcap entry for the MIME type of the attachment, if any. Se
 for the location of the mailcap files and
 .Xr mailcap 5
 for their syntax.
+.Sh SEARCH
+Each e-mail storage backend has its default search method.
+.Em IMAP
+uses the SEARCH command,
+.Em notmuch
+uses libnotmuch and
+.Em Maildir/mbox
+have to do a slow linear search. Thus it is advised to use a cache on
+.Em Maildir/mbox
+accounts.
+.Nm Ns
+, if built with sqlite3, includes the ability to perform full text search on the following fields: From, To, Cc, Bcc, In-Reply-To, References, Subject and Date. The message body (in plain text human readable form) and the flags can also be queried. To enable sqlite3 indexing for an account set
+.Em cache_type
+to
+.Em sqlite3
+in the configuration file and to create the sqlite3 index issue command
+.Cm index Ar ACCOUNT_NAME Ns \&.
+
+To search in the message body type your keywords without any special formatting.
+To search in specific fields, prepend your search keyword with "field:" like so:
+.Pp
+.D1 subject:helloooo or subject:\&"call for help\&" or \&"You remind me today of a small, Mexican chihuahua.\&"
+.Pp
+.D1 not ((from:unrealistic and (to:complex or not "query")) or flags:seen,draft)
+.Pp
+.D1 alladdresses:mailing@list.tld and cc:me@domain.tld
+.Pp
+Boolean operators are
+.Em or Ns
+,
+.Em and
+and
+.Em not
+.Po
+alias:
+.Em \&!
+.Pc
+String keywords with spaces must be quoted. Quotes should always be escaped.
+.sp
+.Sy Important Notice about IMAP
+.sp
+To prevent downloading all your messages from your IMAP server, don't set
+.Em cache_type
+to
+.Em sqlite3 Ns
+\&.
+.Nm
+will relay your queries to the IMAP server. Expect a delay between query and response. Sqlite3 on the contrary at reasonable mailbox sizes should have a non noticable delay.
 .Sh COMPOSING
 To send mail, press
 .Cm m
@@ -157,54 +205,26 @@ issue Ctrl-z and to resume editing press the
 command again (default
 .Em e Ns
 ).
-.Sh SEARCH
-Each e-mail storage backend has its default search method.
-.Em IMAP
-uses the SEARCH command,
-.Em notmuch
-uses libnotmuch and
-.Em Maildir/mbox
-have to do a slow linear search. Thus it is advised to use a cache on
-.Em Maildir/mbox
-accounts.
-.Nm Ns
-, if built with sqlite3, includes the ability to perform full text search on the following fields: From, To, Cc, Bcc, In-Reply-To, References, Subject and Date. The message body (in plain text human readable form) and the flags can also be queried. To enable sqlite3 indexing for an account set
-.Em cache_type
-to
-.Em sqlite3
-in the configuration file and to create the sqlite3 index issue command
-.Cm index Ar ACCOUNT_NAME Ns \&.
-
-To search in the message body type your keywords without any special formatting.
-To search in specific fields, prepend your search keyword with "field:" like so:
-.Pp
-.D1 subject:helloooo or subject:\&"call for help\&" or \&"You remind me today of a small, Mexican chihuahua.\&"
-.Pp
-.D1 not ((from:unrealistic and (to:complex or not "query")) or flags:seen,draft)
-.Pp
-.D1 alladdresses:mailing@list.tld and cc:me@domain.tld
-.Pp
-Boolean operators are
-.Em or Ns
-,
-.Em and
-and
-.Em not
-.Po
-alias:
-.Em \&!
-.Pc
-String keywords with spaces must be quoted. Quotes should always be escaped.
-.sp
-.Sy Important Notice about IMAP
-.sp
-To prevent downloading all your messages from your IMAP server, don't set
-.Em cache_type
-to
-.Em sqlite3 Ns
-\&.
+.Sh CONTACTS
 .Nm
-will relay your queries to the IMAP server. Expect a delay between query and response. Sqlite3 on the contrary at reasonable mailbox sizes should have a non noticable delay.
+supports two kinds of contact backends:
+
+.Bl -enum -compact -offset indent
+.It
+an internal format that gets saved under
+.Pa $XDG_DATA_HOME/meli/account_name/addressbook Ns
+\&.
+.It
+vCard files (v3, v4) through the
+.Ic vcard_folder
+option in the account section. The path defined as
+.Ic vcard_folder
+can hold multiple vCards per file. They are loaded read only.
+.El
+
+See
+.Xr meli.conf 5 ACCOUNTS
+for the complete account configuration values.
 .Sh EXECUTE mode
 Commands are issued in EXECUTE mode, by default started with Space and exited with Escape key.
 .Pp