Commit Graph

1407 Commits

Author SHA1 Message Date
Justus Winter
5b92b6ee9d
Make the WoT examples more compact.
- Drop --keyring and --trust-root.  We get that from our certd.
2024-01-11 18:00:50 +01:00
Justus Winter
6d18c95001
Use single quotes in examples, don't quote unnecessarily. 2024-01-11 17:48:37 +01:00
Justus Winter
43dc8fc19f
Improve documentation of the CLI parser infrastructure. 2024-01-11 17:17:45 +01:00
Justus Winter
6c41d0dd43
Move the sq wot gossip example. 2024-01-11 17:08:31 +01:00
Justus Winter
6e07bb93d8
Remove {n} that snuck in. 2024-01-11 16:59:27 +01:00
Justus Winter
615d7ebe6d
Add missing about and long-about for sq wot. 2024-01-11 16:54:39 +01:00
Justus Winter
5b3f59a774
Fix rendering of indented paragraphs after tagged paragraphs. 2024-01-11 16:40:50 +01:00
Justus Winter
36aaf6fe3b
Render EXIT STATUS sections. 2024-01-11 16:34:57 +01:00
Justus Winter
0f3a796bc1
Improve rendering of examples.
- Join adjacent code blocks, prevent wrapping in HTML.
2024-01-11 13:41:51 +01:00
Justus Winter
479aeaec22
Fail the compilation if a line in an example is too long. 2024-01-11 13:26:09 +01:00
Justus Winter
c21d762fff
Put all the parent commands into the see-also section. 2024-01-11 13:00:28 +01:00
Justus Winter
e28e4dd829
Drop crypto-backend information from the manual pages.
- The interface should be independent of the backend, even if
    capabilities vary slightly.
2024-01-11 12:02:25 +01:00
Justus Winter
4fbab2777b
Make all top-level options global.
- This means that they can be given anywhere in the command line,
    not only directly following 'sq'.

  - Remove the '[GLOBAL OPTIONS]' from the man pages.  Adapt pandoc
    filter.
2024-01-11 11:46:39 +01:00
Justus Winter
b5dd71d761
Change sq keyring lint -f to -F to avoid a conflict with --force. 2024-01-11 11:39:24 +01:00
Justus Winter
e131ea102e
Use the README.md as top-level crate documentation.
- Previously, we used a concatenation of all subcommand help
    outputs, but this is unwieldy nowadays and an artifact from back
    when we didn't have proper manual pages and a way to host them
    nicely.  Drop this.
2024-01-10 18:00:33 +01:00
Justus Winter
f384e89cf3
Add documentation links to the README.md. 2024-01-10 17:52:47 +01:00
Justus Winter
d1bc1a3552
Turn entries in the synopsis into links.
- Filter pandoc's AST using lua instead of transforming pandoc's
    output with sed.  This allows us to also turn the entries in the
    synopsis into links, greatly improving usability.

  - Also, tweak the title.
2024-01-10 17:52:47 +01:00
Justus Winter
0e36c0f75a
Certify user IDs matched by email.
- Fixes #66.
2024-01-10 14:20:38 +01:00
Justus Winter
f3dbe53b91
Generalize certifying, prepare for email and fuzzy matching.
- This doesn't change the behavior, but prepares the code for
    matching on emails and fuzzy matching, and certifying multiple
    user IDs in one go.
2024-01-10 13:54:35 +01:00
Justus Winter
d6df68eff8
Generalize notation parsing. 2024-01-10 13:54:35 +01:00
Justus Winter
ab41e25df7
Simplify exact matching on user IDs. 2024-01-10 13:54:35 +01:00
Justus Winter
785acd5627
If certify --regex is given, require --depth.
- --regex only makes sense with a depth > 0, and the default depth
    is 0.
2024-01-10 13:54:35 +01:00
Justus Winter
af170f6b45
Implement sq certify --add-userid.
- See #14.
2024-01-10 13:54:35 +01:00
Justus Winter
b25529cda7
Remove unused test inputs. 2024-01-10 13:54:35 +01:00
Justus Winter
2cf6ff7a4a
Align option rendering, don't repeat global options. 2024-01-10 13:51:49 +01:00
Justus Winter
57154efb10
Prefer the long help text over the short help text. 2024-01-10 13:51:49 +01:00
Justus Winter
04574a0647
Fix rendering of options with multiple paragraphs. 2024-01-10 13:51:49 +01:00
Justus Winter
04970d5d94
Fix rendering of boolean flags. 2024-01-10 10:43:16 +01:00
Justus Winter
0af7ef6279
Fix rendering of options with multiple value names. 2024-01-10 10:07:13 +01:00
Justus Winter
a0313312e8
Drop unused constant. 2024-01-10 10:05:37 +01:00
Justus Winter
6478a7903c
Fix rendering of examples with multi-line descriptions. 2024-01-10 09:49:20 +01:00
Justus Winter
a338e1efb4
Warn if examples exceed 78 characters in man pages. 2024-01-09 17:14:38 +01:00
Justus Winter
6884e41f16
Move the armor and dearmor commands to sq packet.
- While sq packet isn't quite the right home for these commands,
    they shouldn't be featured so prominently and clutter the
    top-level subcommand hierarchy.

  - See also #169.
2024-01-09 17:14:38 +01:00
Justus Winter
5932d91ecd
Reflow and align examples.
- Examples may not wrap around in rendered documentation, and if
    they do, it may distort the meaning.  Care must be taken to keep
    the line length reasonable.
2024-01-09 13:28:15 +01:00
Justus Winter
f9981e6e3e
ci: Fix redirects. 2024-01-08 18:46:06 +01:00
Justus Winter
befb3e270e
Fix cloning instructions. 2024-01-08 18:12:51 +01:00
Justus Winter
891cc859e0
Build and deploy rustdoc, man pages, subplot.
- Fixes #60.
2024-01-08 18:12:51 +01:00
Justus Winter
0588bbedb1
Improve rendering of examples with continuations. 2024-01-08 14:18:42 +01:00
Justus Winter
c6b4943dcd
Align the WoT documentation with other subcommands. 2024-01-08 14:18:42 +01:00
Justus Winter
3ef3de3408
Align the keyring linter documentation with other subcommands. 2024-01-08 14:18:42 +01:00
Justus Winter
86058193e1
Fix the password prompts.
- Fixes a5a7fd09b6.
2024-01-08 14:18:42 +01:00
Justus Winter
fd08784e3a
Use std::io::IsTerminal instead of is-terminal.
- Available since Rust 1.70.
2024-01-08 14:18:42 +01:00
Justus Winter
fc3e4e046e
Ask for the password even if stdin is not connected to the TTY.
- As we prompt on the TTY, we can do that even if stdin is not
    connected to it.

  - Reverts f3cfb1b602.

  - Fixes #167.
2024-01-08 14:18:42 +01:00
Justus Winter
1b4761a045
Don't ask for passwords if we don't support the S2K mechanism. 2024-01-08 14:18:42 +01:00
Justus Winter
c4a2c5666f
tests: Detach console for child processes.
- Otherwise, rpassword will ask for passwords and hang the tests.
2024-01-08 14:18:42 +01:00
Justus Winter
0ea5ef9fad
Write assets like manual pages to a predictable location.
- Fixes #45.
2024-01-05 15:57:05 +01:00
Justus Winter
2580e26ba5
Refactor asset creation. 2024-01-05 15:45:54 +01:00
Justus Winter
03dbe1db84
Editorial changes to example text format.
- Similar to #27.
2024-01-05 15:37:08 +01:00
Justus Winter
79fd3d7333
Editorial changes to example text format.
- Fixes #27.
2024-01-05 15:32:54 +01:00
Justus Winter
f81d6f09af
Use our custom manual page generator during build time.
- Previously, there were two ways of generating manual pages.
    We used to use the upstream clap_mangen crate, but decided to
    develop our own custom formatter.  However, we didn't quite switch
    to it, keeping the old mechanism in place and adding our new
    solution to sq, activated by a hidden environment variable.

  - This patch drops the upstream formatter, and uses the custom
    formatter during build time.  First, our custom code can be
    tweaked easily to suit our needs, and switching back to the
    upstream solution is easy enough should it better suit our needs.
    Second, generating manual pages at build time should help
    cross-building environments.
2024-01-05 13:56:32 +01:00