derivepassphrase.git

Add man page for `derivepassphrase_export`
Parent 32d3a91
Marco Ricci

Marco Ricci commited on 2024-09-01 16:46:57
Zeige 4 geänderte Dateien mit 59 Einfügungen und 1 Löschungen. 

The help text/docstring was missing a mention of which configuration
formats are supported, which has now been added.
docs/reference/derivepassphrase_export.1.md
Zeige Datei @ d081a2b
... ... 
@@ -0,0 +1,54 @@
1 
+# derivepassphrase\_export(1)
2 
+
3 
+## NAME
4 
+
5 
+derivepassphrase\_export – export a vault-native configuration to standard
6 
+output
7 
+
8 
+## SYNOPSIS
9 
+
10 
+````
11 
+derivepassphrase_export [OPTIONS] PATH
12 
+````
13 
+
14 
+## DESCRIPTION
15 
+
16 
+Read the <b>vault</b>-native configuration at <i>PATH</i>, extract all
17 
+information from it, and export the resulting configuration to standard
18 
+output. Depending on the configuration format, this may either be a file or
19 
+a directory.  Supports the vault "v0.2", "v0.3" and "storeroom" formats.
20 
+
21 
+If <i>PATH</i> is explicitly given as `VAULT_PATH`, then use the
22 
+`VAULT_PATH` environment variable to determine the correct path. (Use
23 
+`./VAULT_PATH` or similar to indicate a file/directory actually named
24 
+`VAULT_PATH`.)
25 
+
26 
+## OPTIONS
27 
+
28 
+<b>-f</b>, <b>-</b><b>-format</b> <i>FMT</i>
29 
+:    try the following storage formats, in order (default: `v0.3`, `v0.2`)
30 
+
31 
+<b>-k</b>, <b>-</b><b>-key</b> <i>K</i>
32 
+:    use <i>K</i> as the storage master key (default: check the `VAULT_KEY`,
33 
+     `LOGNAME`, `USER` or `USERNAME` environment variables)
34 
+
35 
+<b>-h</b>, <b>-</b><b>-help</b>
36 
+:    Show this message and exit.
37 
+
38 
+## ENVIRONMENT VARIABLES
39 
+
40 
+<b>VAULT_PATH</b>
41 
+:   A default path, relative to the home directory, where to look for the
42 
+    configuration to load.
43 
+
44 
+<b>VAULT\_KEY</b>
45 
+:   A password with which the vault configuration is encrypted.  The
46 
+    password is interpreted as a UTF-8 byte string.
47 
+
48 
+<b>LOGNAME</b>, <b>USER</b>, <b>USERNAME</b>
49 
+:   Fallback values for `VAULT_KEY`.
50 
+
51 
+## SEE ALSO
52 
+
53 
+[derivepassphrase(1)](derivepassphrase.1.md),
54 
+[vault(1)](https://github.com/jcoglan/vault)
docs/reference/index.md
Zeige Datei @ d081a2b
... ... 
@@ -5,6 +5,7 @@ title: Reference overview
5 5 
 ## Man pages
6 6
7 7 
 * [`derivepassphrase(1)`][cli_man]: A deterministic, stateless password manager: command-line tool.
8 
+* [`derivepassphrase_export(1)`][export_man]: Export a vault-native configuration to standard output.
8 9
9 10 
 ## Modules and packages
10 11
... ... 
@@ -19,3 +20,4 @@ title: Reference overview
19 20 
     * [`derivepassphrase.vault`][]: Python port of the vault(1) password generation scheme.
20 21
21 22 
   [cli_man]: derivepassphrase.1.md
23 
+  [export_man]: derivepassphrase_export.1.md
mkdocs.yml
Zeige Datei @ d081a2b
... ... 
@@ -93,6 +93,7 @@ nav:
93 93 
   - Reference:
94 94 
     - reference/index.md
95 95 
     - 'Man page: derivepassphrase': reference/derivepassphrase.1.md
96 
+    - 'Man page: derivepassphrase_export': reference/derivepassphrase_export.1.md
96 97 
     - Module derivepassphrase:
97 98 
       - Submodule cli: reference/derivepassphrase.md
98 99 
       - Subpackage exporter:
src/derivepassphrase/exporter/cli.py
Zeige Datei @ d081a2b
... ... 
@@ -110,7 +110,8 @@ def derivepassphrase_export(
110 110 
     Read the vault-native configuration at PATH, extract all information
111 111 
     from it, and export the resulting configuration to standard output.
112 112 
     Depending on the configuration format, this may either be a file or
113 
-    a directory.
113 
+    a directory.  Supports the vault "v0.2", "v0.3" and "storeroom"
114 
+    formats.
114 115
115 116 
     If PATH is explicitly given as `VAULT_PATH`, then use the
116 117 
     `VAULT_PATH` environment variable to determine the correct path.
117 118