Updated documentation for sync-secret.

1 files changed, 56 insertions, 4 deletions

diff --git a/kiki.hs b/kiki.hs
index 6eb5954..498f41e 100644
--- a/kiki.hs
+++ b/kiki.hs
@@ -507,21 +507,73 @@ kiki_usage bSecret cmd = putStr $
                 ,""
                 ] 
          "sync-secret" -> unlines $
-            ["kiki sync-secret [options...]"
+            ["kiki sync-secret [KEYSPEC ...]"
+            ,"kiki sync-secret FLAGS [--keypairs KEYSPEC ...] [--keyrings FILE ...] [--hosts FILE ...]"
+            ,"                       [--wallets FILE ...]"
             ,""
             ,"     sync-secret merges a set of key files into a combined database and then"
             ,"     uses the database to update all the input files, those inside and outside of"
             ,"     of the home directory (see --homedir), to have the most complete information."
             ,""
-            ,"     The files pubring.gpg and secring.gpg in the directory specified by the "
-            ,"     --homedir option are implicitly included in the keyring set."
+            ,"     The files pubring.gpg and secring.gpg in the directory specified by the"
+            ,"     --homedir option are implicitly included in the keyring set even if they"
+            ,"     are not included after the --keyrings option."
             ,""
             ,"     Subkeys that are imported with kiki are given an annotation \"usage@\" which"
             ,"     indicates what the key is for.  This tag can be used as a SPEC to select a"
             ,"     particular key.  Master keys may be specified by using fingerprints or by"
             ,"     specifying a substring of an associated UID."
             ,""
-            ,"     (See 'kiki help spec' for more information.)"
+            ,"     If no \"INPUT FILE\" options (documented below) are specified, then arguments"
+            ,"     are implicitly interpreted as being KEYSPECs for the --keypairs option."
+            ,""
+            ,"FLAGS"
+            ,"     --help             Gives usage information"
+            ,""
+            ,"     --homedir PATH     Specifies the path where pubring.gpg and secring.gpg are located."
+            ,"                        Typically this would be your ~/.gnupg or the contents of the"
+            ,"                        GNUPGHOME environment variable."
+            ,""
+            ,"     --passphrase-fd FD The file descriptor from which to read a passphrase."
+            ,""
+            ,"     --import           Update home keyring files (pubring.gpg and secring.gpg) with"
+            ,"                        new master keys found in the input files specified by the"
+            ,"                        --keyrings option.  Note that new subkeys for known master-key"
+            ,"                        identities will be imported regardless."
+            ,""
+            ,"     --import-if-authentic"
+            ,"                        Like --import except that it requires a signature from the"
+            ,"                        working key on any new identities that are imported into the"
+            ,"                        home keyring files."
+            ,""
+            ,"     --autosign         Create or sign a self-authenticating UID based on tor key."
+            ,"                        Combine this with --import-if-authentic to import self-authenticating"
+            ,"                        identities that may not have previously been signed."
+            ,""
+            ,"     --show-wk          After the operation completes, output the possibly modified working"
+            ,"                        key identity information."
+            ,""
+            ,"INPUT FILES"
+            ,"    --keypairs [KEYSPEC ...]"
+            ,"        KEYSPEC := tag '=' file  '{' <shell command to create key file> '}'"
+            ,"                 | tag '=' file"
+            ,"        Note that this option is implicit if no options documented in this section"
+            ,"        were specified.  See 'kiki help spec' for more information."
+            ,""
+            ,"    --keyrings [FILE ...]"
+            ,"        These files are PGP keyring files.  The format is similar to that of the"
+            ,"        GNU GPG state files: pubring.gpg and secring.gpg.  Those files needn't be"
+            ,"        specified here as they are included implicitly."
+            ,""
+            ,"    --wallets  [FILE ...]"
+            ,"        Bitcoin wallet files.  TODO: document format."
+            ,""
+            ,"    --hosts    [FILE ...]"
+            ,"        EXPERIMENTAL! May be removed in the future.  This option specifies files"
+            ,"        from which to read or write hostname aliases.  The format is the same as"
+            ,"        /etc/hosts on unix systems.  WARNING: hostname aliases may be imported into"
+            ,"        the gpg keyring files, but they are currently NOT signed and may be altered"
+            ,"        in transit."
             ] ++ syncflags 
          "sync-public" -> unlines $
             ["kiki sync-public [options...]"