summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjoe <joe@jerkface.net>2015-06-23 18:05:49 -0400
committerjoe <joe@jerkface.net>2015-06-23 18:05:49 -0400
commitbe560ff09484e5c806d8c18bd922b014885d115b (patch)
tree4a8b73f842e02ecb0ce84d507033384bcd5bfb53
parent8c270f0c8600e872cd2c617e77e3e305462bb4c2 (diff)
Updated documentation for sync-secret.
-rw-r--r--kiki.hs60
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 $
507 ,"" 507 ,""
508 ] 508 ]
509 "sync-secret" -> unlines $ 509 "sync-secret" -> unlines $
510 ["kiki sync-secret [options...]" 510 ["kiki sync-secret [KEYSPEC ...]"
511 ,"kiki sync-secret FLAGS [--keypairs KEYSPEC ...] [--keyrings FILE ...] [--hosts FILE ...]"
512 ," [--wallets FILE ...]"
511 ,"" 513 ,""
512 ," sync-secret merges a set of key files into a combined database and then" 514 ," sync-secret merges a set of key files into a combined database and then"
513 ," uses the database to update all the input files, those inside and outside of" 515 ," uses the database to update all the input files, those inside and outside of"
514 ," of the home directory (see --homedir), to have the most complete information." 516 ," of the home directory (see --homedir), to have the most complete information."
515 ,"" 517 ,""
516 ," The files pubring.gpg and secring.gpg in the directory specified by the " 518 ," The files pubring.gpg and secring.gpg in the directory specified by the"
517 ," --homedir option are implicitly included in the keyring set." 519 ," --homedir option are implicitly included in the keyring set even if they"
520 ," are not included after the --keyrings option."
518 ,"" 521 ,""
519 ," Subkeys that are imported with kiki are given an annotation \"usage@\" which" 522 ," Subkeys that are imported with kiki are given an annotation \"usage@\" which"
520 ," indicates what the key is for. This tag can be used as a SPEC to select a" 523 ," indicates what the key is for. This tag can be used as a SPEC to select a"
521 ," particular key. Master keys may be specified by using fingerprints or by" 524 ," particular key. Master keys may be specified by using fingerprints or by"
522 ," specifying a substring of an associated UID." 525 ," specifying a substring of an associated UID."
523 ,"" 526 ,""
524 ," (See 'kiki help spec' for more information.)" 527 ," If no \"INPUT FILE\" options (documented below) are specified, then arguments"
528 ," are implicitly interpreted as being KEYSPECs for the --keypairs option."
529 ,""
530 ,"FLAGS"
531 ," --help Gives usage information"
532 ,""
533 ," --homedir PATH Specifies the path where pubring.gpg and secring.gpg are located."
534 ," Typically this would be your ~/.gnupg or the contents of the"
535 ," GNUPGHOME environment variable."
536 ,""
537 ," --passphrase-fd FD The file descriptor from which to read a passphrase."
538 ,""
539 ," --import Update home keyring files (pubring.gpg and secring.gpg) with"
540 ," new master keys found in the input files specified by the"
541 ," --keyrings option. Note that new subkeys for known master-key"
542 ," identities will be imported regardless."
543 ,""
544 ," --import-if-authentic"
545 ," Like --import except that it requires a signature from the"
546 ," working key on any new identities that are imported into the"
547 ," home keyring files."
548 ,""
549 ," --autosign Create or sign a self-authenticating UID based on tor key."
550 ," Combine this with --import-if-authentic to import self-authenticating"
551 ," identities that may not have previously been signed."
552 ,""
553 ," --show-wk After the operation completes, output the possibly modified working"
554 ," key identity information."
555 ,""
556 ,"INPUT FILES"
557 ," --keypairs [KEYSPEC ...]"
558 ," KEYSPEC := tag '=' file '{' <shell command to create key file> '}'"
559 ," | tag '=' file"
560 ," Note that this option is implicit if no options documented in this section"
561 ," were specified. See 'kiki help spec' for more information."
562 ,""
563 ," --keyrings [FILE ...]"
564 ," These files are PGP keyring files. The format is similar to that of the"
565 ," GNU GPG state files: pubring.gpg and secring.gpg. Those files needn't be"
566 ," specified here as they are included implicitly."
567 ,""
568 ," --wallets [FILE ...]"
569 ," Bitcoin wallet files. TODO: document format."
570 ,""
571 ," --hosts [FILE ...]"
572 ," EXPERIMENTAL! May be removed in the future. This option specifies files"
573 ," from which to read or write hostname aliases. The format is the same as"
574 ," /etc/hosts on unix systems. WARNING: hostname aliases may be imported into"
575 ," the gpg keyring files, but they are currently NOT signed and may be altered"
576 ," in transit."
525 ] ++ syncflags 577 ] ++ syncflags
526 "sync-public" -> unlines $ 578 "sync-public" -> unlines $
527 ["kiki sync-public [options...]" 579 ["kiki sync-public [options...]"