diff options
| author | Eric Biggers <ebiggers@google.com> | 2021-06-10 00:20:56 -0700 |
|---|---|---|
| committer | Eric Biggers <ebiggers@google.com> | 2021-06-10 19:29:33 -0700 |
| commit | a1243f21c7c268c32de326ab717a6648107f7112 (patch) | |
| tree | efd0b09bdcedaf965bcda875b281ddbd369c3c8f /README.md | |
| parent | 811f6d328c23a8ba284abcb30e9e3aba50f124b2 (diff) | |
| download | fsverity-utils-a1243f21c7c268c32de326ab717a6648107f7112.tar.gz | |
Add man page for fsverity
Add a manual page for the fsverity utility, documenting all subcommands
and options.
The page is written in Markdown and is translated to groff using pandoc.
It can be installed by 'make install-man'.
Link: https://lore.kernel.org/r/20210610072056.35190-1-ebiggers@kernel.org
Acked-by: Luca Boccassi <bluca@debian.org>
Reviewed-by: Victor Hsieh <victorhsieh@google.com>
Signed-off-by: Eric Biggers <ebiggers@google.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 11 insertions, 3 deletions
@@ -24,20 +24,22 @@ See `libfsverity.h` for the API of this library. ## Building and installing -fsverity-utils uses the OpenSSL library, so you first must install the -needed development files. For example, on Debian-based systems, run: +To build fsverity-utils, first install the needed build dependencies. For +example, on Debian-based systems, run: ```bash sudo apt-get install libssl-dev + sudo apt-get install pandoc # optional ``` -OpenSSL must be version 1.0.0 or later. +OpenSSL must be version 1.0.0 or later. This is the only runtime dependency. Then, to build and install fsverity-utils: ```bash make sudo make install + sudo make install-man # optional ``` By default, the following targets are built and installed: the program @@ -45,6 +47,9 @@ By default, the following targets are built and installed: the program `libfsverity.so`. You can also run `make check` to build and run the tests, or `make help` to display all available build targets. +`make install-man` installs the `fsverity.1` manual page. This step requires +that `pandoc` be installed. + By default, `fsverity` is statically linked to `libfsverity`. You can use `make USE_SHARED_LIB=1` to use dynamic linking instead. @@ -63,6 +68,9 @@ A Windows build of OpenSSL/libcrypto needs to be available. ## Examples +Full usage information for `fsverity` can be found in the manual page +(`man fsverity`). Here, we just show some typical examples. + ### Basic use ```bash |