Documentation, put SPEC info on dedicated page

1 files changed, 31 insertions, 9 deletions

diff --git a/kiki.hs b/kiki.hs
index c00ab84..a50c237 100644
--- a/kiki.hs
+++ b/kiki.hs
@@ -461,7 +461,7 @@ kiki_usage bSecret cmd = putStr $
                 ,""
                 ,"     --key SPEC"
                 ,"           Show fingerprints for the specified key and all its subkeys"
-                ,"           and UID."
+                ,"           and UID. (See 'kiki help spec' for more information.)"
                 ,""
                 ,"     --all Show fingerprints and UIDs and usage tags for all known keys."
                 ,""
@@ -471,15 +471,19 @@ kiki_usage bSecret cmd = putStr $
                 ,""
                 ,"     --pem SPEC"
                 ,"           Outputs the PKCS #8 public key corresponding to SPEC."
+                ,"           (See 'kiki help spec' for more information.)"
                 ,""
                 ,"     --cert SPEC"
                 ,"           Outputs X509 certificates associated with the key SPEC."
+                ,"           (See 'kiki help spec' for more information.)"
                 ,""
                 ,"     --ssh SPEC"
                 ,"           Outputs the ssh-rsa blob for the specified public key."
+                ,"           (See 'kiki help spec' for more information.)"
                 ,""
                 ,"     --wip SPEC"
                 ,"           Outputs the secret crypto-coin key in Wallet Input Format."
+                ,"           (See 'kiki help spec' for more information.)"
                 ,""
                 ,"     --torhash FILE"
                 ,"           Outputs tor address and base32 hash of the PEM-format key in"
@@ -487,7 +491,7 @@ kiki_usage bSecret cmd = putStr $
                 ,""
                 ,"     --help     Shows this help screen."
                 ,""
-                ] ++ keyspec
+                ] 
          "sync-secret" -> unlines $
             ["kiki sync-secret [options...]"
             ,""
@@ -502,7 +506,9 @@ kiki_usage bSecret cmd = putStr $
             ,"     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."
-            ] ++ syncflags ++ keyspec
+            ,""
+            ,"     (See 'kiki help spec' for more information.)"
+            ] ++ syncflags 
          "sync-public" -> unlines $
             ["kiki sync-public [options...]"
             ,""
@@ -521,7 +527,9 @@ kiki_usage bSecret cmd = putStr $
             ,"     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."
-            ] ++ syncflags ++ keyspec
+            ,""
+            ,"     (See 'kiki help spec' for more information.)"
+            ] ++ syncflags 
          "import-secret" -> unlines $
             ["kiki import-secret [options...]"
             ,""
@@ -535,7 +543,9 @@ kiki_usage bSecret cmd = putStr $
             ,"     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."
-            ] ++ syncflags ++ keyspec
+            ,""
+            ,"     (See 'kiki help spec' for more information.)"
+            ] ++ syncflags 
          "import-public" -> unlines $
             ["kiki import-public [options...]"
             ,""
@@ -554,7 +564,9 @@ kiki_usage bSecret cmd = putStr $
             ,"     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."
-            ] ++ syncflags ++ keyspec
+            ,""
+            ,"     (See 'kiki help spec' for more information.)"
+            ] ++ syncflags 
          "export-secret" -> unlines $
             ["kiki export-secret [options...]"
             ,""
@@ -563,7 +575,9 @@ kiki_usage bSecret cmd = putStr $
             ,"     The files pubring.gpg and secring.gpg in the directory specified by the "
             ,"     --homedir option are implicitly included in the keyring set."
             ,""
-            ] ++ syncflags ++ keyspec
+            ,"     (See 'kiki help spec' for more information.)"
+            ,""
+            ] ++ syncflags 
          "export-public" -> unlines $
             ["kiki export-public [options...]"
             ,""
@@ -574,7 +588,10 @@ kiki_usage bSecret cmd = putStr $
             ,"     difference betwen this command and export-secret is that no secret keys are"
             ,"     exported by this command regardless of input."
             ,""
-            ] ++ syncflags ++ keyspec
+            ,"     (See 'kiki help spec' for more information.)"
+            ,""
+            ] ++ syncflags 
+         "spec" -> unlines keyspec
         where 
             commonOptions :: [String]
             commonOptions =
@@ -631,7 +648,7 @@ kiki_usage bSecret cmd = putStr $
                         ,"                "
                         ,"                KEYSPEC ::= SPEC=FILE{CMD} "
                         ,""
-                        ,"                The form of SPEC is documented below. If there is only one master"
+                        ,"                The form of SPEC is documented elsewhere. If there is only one master"
                         ,"                key in your keyring and only one key is used for each purpose, then"
                         ,"                it is possible for SPEC in this case to merely be a tag which offers"
                         ,"                information about what this key is used for, for example, any of"
@@ -639,6 +656,7 @@ kiki_usage bSecret cmd = putStr $
                         ,""
                         ,"                If neither SPEC or FILE match any keys, then the CMD will be "
                         ,"                executed in order to create the FILE."
+                        ,"                (See 'kiki help spec' for more information.)"
                         ,""]
             keyspec = -- unlines $
                  ["Specifying keys on the kiki command line:"
@@ -843,6 +861,7 @@ sync bExport bImport bSecret cmdarg args_raw = do
     forM_ report $ \(fname,act) -> do
         putStrLn $ fname ++ ": " ++ reportString act
 
+
 kiki "sync-secret" args_raw =
     sync True True True "sync-secret" args_raw
 
@@ -879,10 +898,13 @@ kiki "help" [] = do
         putStrLn $ "   " ++ pad cmd ++ help
     putStr . unlines $ [""
                        ,"See 'kiki help <command>' for more information on a specific command."
+                       ,"Or see 'kiki help spec' for kiki's notation for specifying keys."
                        ]
     return ()
 
 kiki "help" args = forM_ args $ \arg -> case lookup arg commands of
+    Nothing | arg == "spec" -> kiki_usage False arg 
+    Nothing | arg == "SPEC" -> kiki_usage False arg 
     Nothing -> putStrLn $ "No help available for commmand '" ++ arg ++ "'."
     _       -> kiki arg ["--help"]