derivepassphrase.git

@@ -686,13 +686,14 @@ class Label(enum.Enum):

     )

     """"""

     SETTINGS_ORIGIN_INTERACTIVE = commented(

-        "This value is used as the {key} metavar for "

+        "This value is used as the key metavar for "

         "Label.PASSPHRASE_NOT_NORMALIZED if the passphrase was "

         "entered interactively.",

     )(

         "Label :: Error message :: Metavar",

         "interactive input",

     )

+    """"""

     CONFIGURATION_EPILOG = commented(

         "",

     )(

@@ -982,6 +983,15 @@ class Label(enum.Enum):

         "Also emit debug information.  Implies --verbose.",

     )

     """"""

+    DEBUG_OPTION_SPEC_AND_HELP_TEXT = commented(

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "--debug\n"

+        "\n"

+        "Also emit debug information.  Implies --verbose.",

+    )

+    """"""

     DERIVEPASSPHRASE_01 = commented(

         "This is the first paragraph of the command help text, "

         "but it also appears (in truncated form, if necessary) "

@@ -1034,6 +1044,16 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_CONFIG_SPEC_AND_HELP_TEXT = commented(

+        "Same SERVICE metavar as in "

+        '"Deriving a passphrase requires a SERVICE." message.',

+    )(

+        "Label :: Help text :: One-line description",

+        "-c, --config\n"

+        "\n"

+        "Save the given settings for SERVICE, or global.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_DASH_HELP_TEXT = commented(

         "The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.",

     )(

@@ -1042,6 +1062,15 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_DASH_SPEC_AND_HELP_TEXT = commented(

+        "Same NUMBER metavar as --lower option.",

+    )(

+        "Label :: Help text :: One-line description",

+        "--dash NUMBER\n"

+        "\n"

+        'Ensure at least NUMBER "-" or "_" characters.',

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_DELETE_ALL_HELP_TEXT = commented(

         "",

     )(

@@ -1049,6 +1078,15 @@ class Label(enum.Enum):

         "Delete all settings.",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_DELETE_ALL_SPEC_AND_HELP_TEXT = commented(

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "-X, --clear\n"

+        "\n"

+        "Delete all settings.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_DELETE_GLOBALS_HELP_TEXT = commented(

         "",

     )(

@@ -1056,6 +1094,15 @@ class Label(enum.Enum):

         "Delete the global settings.",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_DELETE_GLOBALS_SPEC_AND_HELP_TEXT = commented(

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "--delete-globals\n"

+        "\n"

+        "Delete the global settings.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_DELETE_HELP_TEXT = commented(

         "The metavar is Label.VAULT_METAVAR_SERVICE.",

     )(

@@ -1064,6 +1111,16 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_DELETE_SPEC_AND_HELP_TEXT = commented(

+        "Same SERVICE metavar as in "

+        '"Deriving a passphrase requires a SERVICE." message.',

+    )(

+        "Label :: Help text :: One-line description",

+        "-x SERVICE, --delete SERVICE\n"

+        "\n"

+        "Delete the settings for SERVICE.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_EDITOR_INTERFACE_HELP_TEXT = commented(

         "The corresponding option is displayed as "

         '"--modern-editor-interface / --vault-legacy-editor-interface", '

@@ -1079,6 +1136,19 @@ class Label(enum.Enum):

         "or the vault-like legacy one (default).",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_EDITOR_INTERFACE_SPEC_AND_HELP_TEXT = commented(

+        "Though the vault(1) legacy editor interface clearly has deficiencies "

+        "and (in my opinion) should only be used for compatibility purposes, "

+        "the one-line help text should try not to sound too judgmental, "

+        "if possible.",

+    )(

+        "Label :: Help text :: One-line description",

+        "--modern-editor-interface / --vault-legacy-editor-interface\n"

+        "\n"

+        "Edit notes using the modern editor interface "

+        "or the vault-like legacy one (default).",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_EXPORT_AS_HELP_TEXT = commented(

         "The corresponding option is displayed as "

         '"--export-as=json|sh", so json refers to the JSON format (default) '

@@ -1091,6 +1161,17 @@ class Label(enum.Enum):

         "When exporting, export as JSON (default) or as POSIX sh.",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_EXPORT_AS_SPEC_AND_HELP_TEXT = commented(

+        'Please ensure that it is clear what the "json" and "sh" format names '

+        "refer to, even if you cannot use texutal correspondence "

+        "like the English text does.",

+    )(

+        "Label :: Help text :: One-line description",

+        "--export-as [json|sh]\n"

+        "\n"

+        "When exporting, export as JSON (default) or as POSIX sh.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_EXPORT_HELP_TEXT = commented(

         "The metavar is Label.STORAGE_MANAGEMENT_METAVAR_PATH.",

     )(

@@ -1099,6 +1180,15 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_EXPORT_SPEC_AND_HELP_TEXT = commented(

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "-e PATH, --export PATH\n"

+        "\n"

+        "Export all saved settings to PATH.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_IMPORT_HELP_TEXT = commented(

         "The metavar is Label.STORAGE_MANAGEMENT_METAVAR_PATH.",

     )(

@@ -1107,6 +1197,15 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_IMPORT_SPEC_AND_HELP_TEXT = commented(

+        "Same PATH metavar as --export option.",

+    )(

+        "Label :: Help text :: One-line description",

+        "-i PATH, --import PATH\n"

+        "\n"

+        "Import saved settings from PATH.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_KEY_HELP_TEXT = commented(

         "",

     )(

@@ -1114,6 +1213,15 @@ class Label(enum.Enum):

         "Select a suitable SSH key from the SSH agent.",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_KEY_SPEC_AND_HELP_TEXT = commented(

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "-k, --key\n"

+        "\n"

+        "Select a suitable SSH key from the SSH agent.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_LENGTH_HELP_TEXT = commented(

         "The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.",

     )(

@@ -1122,6 +1230,15 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_LENGTH_SPEC_AND_HELP_TEXT = commented(

+        "Same NUMBER metavar as --lower option.",

+    )(

+        "Label :: Help text :: One-line description",

+        "-l NUMBER, --length NUMBER\n"

+        "\n"

+        "Ensure a passphrase length of NUMBER characters.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_LOWER_HELP_TEXT = commented(

         "The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.",

     )(

@@ -1130,6 +1247,15 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_LOWER_SPEC_AND_HELP_TEXT = commented(

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "--lower NUMBER\n"

+        "\n"

+        "Ensure at least NUMBER lowercase characters.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_NOTES_HELP_TEXT = commented(

         "The metavar is Label.VAULT_METAVAR_SERVICE.",

     )(

@@ -1138,6 +1264,16 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_NOTES_SPEC_AND_HELP_TEXT = commented(

+        "Same SERVICE metavar as in "

+        '"Deriving a passphrase requires a SERVICE." message.',

+    )(

+        "Label :: Help text :: One-line description",

+        "-n, --notes\n",

+        "\n"

+        "With --config and SERVICE, spawn an editor to edit notes.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_NUMBER_HELP_TEXT = commented(

         "The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.",

     )(

@@ -1146,6 +1282,15 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_NUMBER_SPEC_AND_HELP_TEXT = commented(

+        "Same NUMBER metavar as --lower option.",

+    )(

+        "Label :: Help text :: One-line description",

+        "--number NUMBER\n"

+        "\n"

+        "Ensure at least NUMBER digits.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_OVERWRITE_HELP_TEXT = commented(

         "The corresponding option is displayed as "

         '"--overwrite-existing / --merge-existing", so you may want to '

@@ -1155,6 +1300,15 @@ class Label(enum.Enum):

         "Overwrite or merge (default) the existing configuration.",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_OVERWRITE_SPEC_AND_HELP_TEXT = commented(

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "--overwrite-existing / --merge-existing\n"

+        "\n"

+        "Overwrite or merge (default) the existing configuration.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_PHRASE_HELP_TEXT = commented(

         "",

     )(

@@ -1162,6 +1316,15 @@ class Label(enum.Enum):

         "Prompt for a master passphrase.",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_PHRASE_SPEC_AND_HELP_TEXT = commented(

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "-p, --phrase\n"

+        "\n"

+        "Prompt for a master passphrase.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_PRINT_NOTES_BEFORE_HELP_TEXT = commented(

         "The corresponding option is displayed as "

         '"--print-notes-before / --print-notes-after", so you may want to '

@@ -1173,6 +1336,16 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_PRINT_NOTES_BEFORE_SPEC_AND_HELP_TEXT = commented(

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "--print-notes-before / --print-notes-after\n"

+        "\n"

+        "Print the notes for SERVICE (if any) before or "

+        "after (default) the derived passphrase.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_REPEAT_HELP_TEXT = commented(

         "The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.",

     )(

@@ -1182,6 +1355,16 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_REPEAT_SPEC_AND_HELP_TEXT = commented(

+        "Same NUMBER metavar as --lower option.",

+    )(

+        "Label :: Help text :: One-line description",

+        "-r NUMBER, --repeat NUMBER\n"

+        "\n"

+        "Restrict runs of identical characters to at most NUMBER "

+        "characters.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_SSH_AGENT_SOCKET_PROVIDER_HELP_TEXT = commented(

         "The metavar is "

         "Label.VAULT_COMPATIBILITY_METAVAR_SSH_AGENT_SOCKET_PROVIDER.",

@@ -1191,6 +1374,15 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_SSH_AGENT_SOCKET_PROVIDER_SPEC_AND_HELP_TEXT = commented(  # noqa: E501

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "--ssh-agent-socket-provider PROVIDER\n"

+        "\n"

+        "Use PROVIDER as the SSH agent socket provider.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_SPACE_HELP_TEXT = commented(

         "The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.",

     )(

@@ -1199,6 +1391,15 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_SPACE_SPEC_AND_HELP_TEXT = commented(

+        "Same NUMBER metavar as --lower option.",

+    )(

+        "Label :: Help text :: One-line description",

+        "--space NUMBER\n"

+        "\n"

+        "Ensure at least NUMBER spaces.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_SYMBOL_HELP_TEXT = commented(

         "The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.",

     )(

@@ -1207,6 +1408,15 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_SYMBOL_SPEC_AND_HELP_TEXT = commented(

+        "Same NUMBER metavar as --lower option.",

+    )(

+        "Label :: Help text :: One-line description",

+        "--symbol NUMBER\n"

+        "\n"

+        "Ensure at least NUMBER symbol characters.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_UNSET_HELP_TEXT = commented(

         "The corresponding option is displayed as "

         '"--unset=phrase|key|...|symbol", so the "given setting" is '

@@ -1220,6 +1430,18 @@ class Label(enum.Enum):

         "May be specified multiple times.",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_UNSET_SPEC_AND_HELP_TEXT = commented(

+        '"with --config" here means that the user must also specify '

+        '"--config" for this option to have any effect.',

+    )(

+        "Label :: Help text :: One-line description",

+        "--unset [phrase|key|length|repeat|lower|upper|"

+        "number|space|dash|symbol|notes]\n"

+        "\n"

+        "With --config, also unset the given setting.  "

+        "May be specified multiple times.",

+    )

+    """"""

     DERIVEPASSPHRASE_VAULT_UPPER_HELP_TEXT = commented(

         "The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.",

     )(

@@ -1228,6 +1450,15 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    DERIVEPASSPHRASE_VAULT_UPPER_SPEC_AND_HELP_TEXT = commented(

+        "Same NUMBER metavar as --lower option.",

+    )(

+        "Label :: Help text :: One-line description",

+        "--upper NUMBER\n"

+        "\n"

+        "Ensure at least NUMBER uppercase characters.",

+    )

+    """"""

     EXPORT_VAULT_FORMAT_DEFAULTS_HELP_TEXT = commented(

         "See EXPORT_VAULT_FORMAT_HELP_TEXT.  "

@@ -1250,6 +1481,19 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    EXPORT_VAULT_FORMAT_SPEC_AND_HELP_TEXT = commented(

+        'The format names/labels "v0.3", "v0.2" and "storeroom" '

+        "should not be translated.",

+    )(

+        "Label :: Help text :: One-line description",

+        "-f FMT, --format FMT\n"

+        "\n"

+        "Try the following storage format FMT.  "

+        "If specified multiple times, the "

+        "formats will be tried in order.  "

+        "Default: v0.3, v0.2, storeroom.",

+    )

+    """"""

     EXPORT_VAULT_KEY_DEFAULTS_HELP_TEXT = commented(

         "See EXPORT_VAULT_KEY_HELP_TEXT.",

     )(

@@ -1267,6 +1511,17 @@ class Label(enum.Enum):

         flags="python-brace-format",

     )

     """"""

+    EXPORT_VAULT_KEY_SPEC_AND_HELP_TEXT = commented(

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "-k K, --key K\n"

+        "\n"

+        "Use K as the storage master key.  ",

+        "Default: check the VAULT_KEY, LOGNAME, USER, or USERNAME "

+        "environment variables.",

+    )

+    """"""

     HELP_OPTION_HELP_TEXT = commented(

         "",

     )(

@@ -1274,6 +1529,15 @@ class Label(enum.Enum):

         "Show this help text, then exit.",

     )

     """"""

+    HELP_OPTION_SPEC_AND_HELP_TEXT = commented(

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "-h, --help\n"

+        "\n"

+        "Show this help text, then exit.",

+    )

+    """"""

     QUIET_OPTION_HELP_TEXT = commented(

         "",

     )(

@@ -1281,6 +1545,15 @@ class Label(enum.Enum):

         "Suppress even warnings; emit only errors.",

     )

     """"""

+    QUIET_OPTION_SPEC_AND_HELP_TEXT = commented(

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "-q, --quiet\n"

+        "\n"

+        "Suppress even warnings; emit only errors.",

+    )

+    """"""

     VERBOSE_OPTION_HELP_TEXT = commented(

         "",

     )(

@@ -1288,6 +1561,15 @@ class Label(enum.Enum):

         "Emit extra/progress information to standard error.",

     )

     """"""

+    VERBOSE_OPTION_SPEC_AND_HELP_TEXT = commented(

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "-v, --verbose\n"

+        "\n"

+        "Emit extra/progress information to standard error.",

+    )

+    """"""

     VERSION_OPTION_HELP_TEXT = commented(

         "",

     )(

@@ -1295,6 +1577,15 @@ class Label(enum.Enum):

         "Show version and feature information, then exit.",

     )

     """"""

+    VERSION_OPTION_SPEC_AND_HELP_TEXT = commented(

+        "",

+    )(

+        "Label :: Help text :: One-line description",

+        "--version\n"

+        "\n"

+        "Show version and feature information, then exit.",

+    )

+    """"""

     COMMANDS_LABEL = commented(

         "",

     )(