From: Gerhard Sittig <redacted>
Date: Wed, 14 Dec 2022 16:57:19 +0000 (+0100)
Subject: manpage: add environment variables section (firmware, decoders path)
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=394fd9b7a456f16c7ac15f41b0e29081f1d951f8;p=sigrok-cli.git

manpage: add environment variables section (firmware, decoders path)

Add the SIGROK_FIRMWARE_DIR, SIGROK_FIRMWARE_PATH, SIGROKDECODE_DIR, and
SIGROKDECODE_PATH environment variables to the sigrok-cli(1) manpage.

Strictly speaking these are the libraries' environment variables, when
libsigrok looks up device firmware, and libsigrokdecode searches for
Python scripts. But the libraries don't have individual manpages. So
let's put them here for better perception, and to have them _somewhere_
and not lose this information.
---

diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1
index 47ec579..9c847a7 100644
--- a/doc/sigrok-cli.1
+++ b/doc/sigrok-cli.1
@@ -588,6 +588,25 @@ To turn on internal logging on a Lascar EL-USB series device:
 .SH "EXIT STATUS"
 .B sigrok\-cli
 exits with 0 on success, 1 on most failures.
+.SH "ENVIRONMENT"
+.TP
+.B SIGROK_FIRMWARE_DIR
+A single path where to search for firmware images, in addition to a
+builtin list of locations.
+.TP
+.B SIGROK_FIRMWARE_PATH
+Multiple path entries where to search for firmware images, in addition
+to builtin locations.
+.TP
+When decoder support was enabled in the application's configuration:
+.TP
+.B SIGROKDECODE_DIR
+A single path where to search for protocol decoders, in addition to
+a builtin list of locations.
+.TP
+.B SIGROKDECODE_PATH
+Multiple path entries where to search for protocol decoders, in addition
+to builtin locations.
 .SH "SEE ALSO"
 \fBpulseview\fP(1)
 .SH "BUGS"