[Emacs-diffs] scratch/gnus-cloud f183639 3/3: doc/misc/gnus.texi: Document Gnus Cloud package.

[Teodor Zlatanov]

branch: scratch/gnus-cloud
commit f183639bede2f48fc6ea2f138508817446c9f061
Author: Ted Zlatanov <address@hidden>
Commit: Ted Zlatanov <address@hidden>

    doc/misc/gnus.texi: Document Gnus Cloud package.
---
 doc/misc/gnus.texi |   96 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 96 insertions(+)

diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi
index df673fc..2473d26 100644
--- a/doc/misc/gnus.texi
+++ b/doc/misc/gnus.texi
@@ -828,6 +828,7 @@ Various
 * Thwarting Email Spam::        Simple ways to avoid unsolicited commercial 
email.
 * Spam Package::                A package for filtering and processing spam.
 * The Gnus Registry::           A package for tracking messages by Message-ID.
+* The Gnus Cloud::              A package for synchronizing Gnus marks.
 * Other modes::                 Interaction with other modes.
 * Various Various::             Things that are really various.
 
@@ -22208,6 +22209,7 @@ to you, using @kbd{G b u} and updating the group will 
usually fix this.
 * Thwarting Email Spam::        Simple ways to avoid unsolicited commercial 
email.
 * Spam Package::                A package for filtering and processing spam.
 * The Gnus Registry::           A package for tracking messages by Message-ID.
+* The Gnus Cloud::              A package for synchronizing Gnus marks.
 * Other modes::                 Interaction with other modes.
 * Various Various::             Things that are really various.
 @end menu
@@ -26166,6 +26168,100 @@ default this is just @code{(marks)} so the custom 
registry marks are
 precious.
 @end defvar
 
address@hidden The Gnus Cloud
address@hidden The Gnus Cloud
address@hidden cloud
address@hidden gnus-cloud
address@hidden synchronization
address@hidden sync
address@hidden synch
+
+The Gnus Cloud is a way to synchronize marks and general files and
+data across multiple machines.
+
+Very often, you want all your marks (what articles you've read, which
+ones were important, and so on) to be synchronized between several
+machines. With IMAP, that's built into the protocol, so you can read
+nnimap groups from many machines and they are automatically
+synchronized. But NNTP, nnrss, and many other backends do not store
+marks, so you have to do it locally.
+
+The Gnus Cloud package stores the marks, plus any files you choose, on
+an IMAP server in a special folder. It's like a
+DropTorrentSyncBoxOakTree(TM).
+
address@hidden
+* Gnus Cloud Setup::
+* Gnus Cloud Usage::
address@hidden menu
+
address@hidden Gnus Cloud Setup
address@hidden Gnus Cloud Setup
+
+Setting up the Gnus Cloud takes less than a minute. From the Group
+buffer:
+
+Press @kbd{^} to go to the Server buffer. Here you'll see all the
+servers that Gnus knows. @xref{Server Buffer}.
+
+Then press @kbd{i} to mark any servers as cloud-synchronized (their marks are 
synchronized).
+
+Then press @kbd{I} to mark a single server as the cloud host (it must
+be an IMAP server, and will host a special IMAP folder with all the
+synchronization data). This will set the variable
address@hidden (using the Customize facilities), then ask
+you to optionally upload your first CloudSynchronizationDataPack(TM).
+
address@hidden Gnus Cloud Usage
address@hidden Gnus Cloud Usage
+
+After setting up, you can use these shortcuts from the Group buffer:
+
address@hidden @kbd
address@hidden ~ RET
address@hidden ~ d
address@hidden gnus-cloud-download-all-data
address@hidden cloud, download
+Download the latest Gnus Cloud data.
+
address@hidden ~ u
address@hidden ~ ~
address@hidden gnus-cloud-upload-all-data
address@hidden cloud, download
+Upload the local Gnus Cloud data. Creates a new
+CloudSynchronizationDataPack(TM).
+
address@hidden table
+
+But wait, there's more. Of course there's more. So much more. You can
+customize all of the following.
+
address@hidden gnus-cloud-synced-files
+These are the files that will be part of every
+CloudSynchronizationDataPack(TM). They are included in every upload,
+so don't synchronize a lot of large files. Files under 100Kb are best.
address@hidden defvar
+
address@hidden gnus-cloud-storage-method
+This is a choice from several storage methods. It's highly recommended
+to use the EPG facilities. It will be automatic if have GnuPG
+installed and EPG loaded. Otherwise, you could use Base64+gzip,
+Base64, or no encoding.
address@hidden defvar
+
address@hidden gnus-cloud-interactive
+When this is set, and by default it is, the Gnus Cloud package will
+ask you for confirmation here and there. Leave it on until you're
+comfortable with the package.
address@hidden defvar
+
+
address@hidden gnus-cloud-method
+The name of the IMAP server to store the
+CloudSynchronizationDataPack(TM)s. It's easiest to set this from the
+Server buffer (@pxref{Gnus Cloud Setup}).
address@hidden defvar
+
 @node Other modes
 @section Interaction with other modes