doc: various fixes and URL changes

[ssoma-mda.git] / Documentation / ssoma.txt

diff --git a/Documentation/ssoma.txt b/Documentation/ssoma.txt
index 3fab29bcad36d16e05be765b3fd77bf0236a0366..f05e230d20af317599cb35b44ad17bf010dbed59 100644 (file)
--- a/Documentation/ssoma.txt
+++ b/Documentation/ssoma.txt
@@ -6,18 +6,22 @@ ssoma - mail archive synchronization and extraction client
 
 # SYNOPSIS
 
-ssoma add LISTNAME URL maildir:/path/to/maildir/
+ssoma add LISTNAME URL maildir:/path/to/maildir/ [TARGET]
+
 ssoma add LISTNAME URL mbox:/path/to/mbox
+
 ssoma add LISTNAME URL imap://USER@HOST/INBOX
-ssoma sync [LISTNAME]
+
+ssoma sync [--since=DATE] [LISTNAME]
+
 ssoma cat MESSAGE-ID [LISTNAME|GIT_DIR]
 
 # DESCRIPTION
 
-The client component of ssoma may be used to sync and export mail to Maildir
-or mbox(5) from any published ssoma git repository.
+ssoma may be used to sync and export mail to Maildir, IMAP or mbox(5)
+from any published ssoma git repository.
 
-* add LISTNAME URL DESTINATION
+* add LISTNAME URL DESTINATION [TARGET]
 
 This starts a subscription to a mailing list by configuring a git
 repository.  LISTNAME is a name of your choosing.  It must only consist
@@ -35,14 +39,23 @@ IMAP users may configure the imap.pass and imap.tunnel variables in
 ~/.ssoma/$LISTNAME.git/config in the same way as git-imap-send(1).
 Remember to restrict permissions to ~/.ssoma/$LISTNAME.git/config
 if you are storing a password in it.
+.
+TARGET may optionally be specified if you wish to extract a list
+to multiple destinations (e.g. an mbox for certain tools, but also
+to your IMAP account).  The default TARGET name is "local".
 
-* sync [LISTNAME]
+* sync [--since=DATE] [LISTNAME] [TARGET]
 
 This clones/fetches from the remote git repository into the local
 repository and extracts messages into destinations configured with the
 "add" sub-command.  If LISTNAME is not given, all list subscriptions are
 synchronized.  If LISTNAME is given, only subscriptions for a given LISTNAME
+is synchronized.  If TARGET is also given, the only the specified TARGET
 is synchronized.
+.
+If you are following a list with a long history, you may only want to
+extract recent messages by specifying --since=DATE and passing any DATE
+format understood by git-log(1).
 
 * cat MESSAGE-ID [LISTNAME|GIT_DIR]
 
@@ -64,16 +77,16 @@ This is useful for testing, but not recommended otherwise.
 
 # CONTACT
 
-All feedback welcome via plain-text mail to <ssoma@public-inbox.org>\
-The mail archives are hosted at git://public-inbox.org/ssoma
+All feedback welcome via plain-text mail to <meta@public-inbox.org>\
+The mail archives are hosted at git://public-inbox.org/meta
 You may subscribe using ssoma:
 
-       ssoma add ssoma git://public-inbox.org/ssoma mbox:/path/to/mbox
-       ssoma sync ssoma
+       ssoma add pi git://public-inbox.org/meta mbox:/path/to/mbox
+       ssoma sync pi
 
 # SOURCE CODE
 
-       git clone git://bogomips.org/ssoma
+       git clone git://80x24.org/ssoma
 
 # COPYRIGHT