sequoia-sq/README.md
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

898 B

sq, the Sequoia-PGP command line tool

Sequoia-PGP is an implementation of OpenPGP in Rust. It includes a suite of library crates, which are meant to be used from applications. This crate provides the sq command line application. sq is aimed at command line users as a way to use OpenPGP conveniently from the command line.

See the sq user guide for instructions. The program also has built-in help, using the --help option and help subcommand:

$ sq help
...

These are collected as the sq help page, for your convenience.

Building

This crate can be built using the standard cargo toolchain:

cargo build

The above creates the sq executable, the manual pages, and its shell completions.