slipenkomk/sequoia-sq
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
01cb33e27a
sequoia-sq/README.md
David Runge 3ea5afe4e3
Add instructions on man page creation to README 
- Add instructions on how to build the `sq` executable and its shell
 completions.
- Add information on how to generate the man pages using the `SQ_MAN`
  environment variable.
- Disable printing of info about `clap_mangen` generated man pages,
  since they still lack features and are partially incorrect.
2023-06-12 16:14:50 +02:00

1010 B
Raw Blame History

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 and its shell completions.

To create the man pages for sq in a directory (here manpages/) use the built executable:

SQ_MAN=manpages cargo run