lockbox

commit 6b063ffd59c9e80ca90e3a36e64331294bb78500
parent 1ba4c16f9e2436293bdc6bedb5d193e318023a6b
Author: Sean Enck <sean@ttypty.com>
Date:   Tue, 11 Oct 2022 18:57:14 -0400

manpage information

Diffstat:
M
Makefile
 | 
6
++++--
M
contrib/doc.sections
 | 
43
+++++++++++++++++++++++++++++++++++++++++++

2 files changed, 47 insertions(+), 2 deletions(-)
diff --git a/Makefile b/Makefile
@@ -2,6 +2,8 @@ DESTDIR :=
 BUILD   := bin/
 TARGET  := $(BUILD)lb
 TESTDIR := $(sort $(dir $(wildcard internal/**/*_test.go)))
+DOC     := contrib/doc.sections
+MAN     := $(BUILD)lb.man
 
 .PHONY: $(TESTDIR)
 
@@ -20,8 +22,8 @@ check: $(TARGET) $(TESTDIR)
 clean:
 	rm -rf $(BUILD)
 
-man: $(TARGET)
-	help2man --include contrib/doc.sections -h help -v version ./$(TARGET) > $(BUILD)lb.man
+$(MAN): $(TARGET) $(DOC)
+	help2man --include $(DOC) -h help -v version ./$(TARGET) > $(MAN)
 
 install:
 	install -Dm755 $(TARGET) $(DESTDIR)bin/lb
diff --git a/contrib/doc.sections b/contrib/doc.sections
@@ -6,3 +6,46 @@ still be required for removal (matching entries will be listed)
 lb rm path/to/leave/dir/*
 
 lb rm path/to/*
+
+[clipboard]
+By default clipboard commands are detected via determing the platform and utilizing default
+commands to interact with (copy to/paste to) the clipboard. These settings can be overriden
+via environment variables
+
+[totp]
+By default lb tries to use some reasonable defaults to setup/manage oauth token inputs and
+displaying of code outputs. Many of these settings can be changed via environment variables
+
+[environment variables]
+Most of lb is managed by using environment variables, the following environment
+variables are REQUIRED for lb to operate:
+
+[required environment variables]
+- LOCKBOX_STORE (unset) directory to the database
+
+- LOCKBOX_KEYMODE (command) how to retrieve the database store password, can be 'plaintext' or 'command'
+
+- LOCKBOX_KEY (unset) the database key (plaintext) or shell command to run (command) to retrieve the database password
+
+[additional environment variables]
+- LOCKBOX_NOCLIP (no) disable clipboard operations, 'yes'/'no'
+
+- LOCKBOX_NOCOLOR (no) disable terminal colors, 'yes/no'
+
+- LOCKBOX_INTERACTIVE (yes) enable interactive mode, 'yes/no'
+
+- LOCKBOX_READONLY (no) operate in readonly mode, 'yes/no'
+
+- LOCKBOX_TOTP (totp) attribute name to store TOTP tokens
+
+- LOCKBOX_TOTP_FORMAT (unset) override the otpauth url used to store totp tokens
+ 
+- LOCKBOX_TOTP_BETWEEN (unset) override when to set totp generated outputs to different colors
+
+- LOCKBOX_CLIP_PASTE (unset) override the detected platform paste command
+
+- LOCKBOX_CLIP_COPY (unset) override the detected platform clip command
+
+- LOCKBOX_CLIP_MAX (unset) override the amount of time before totp clears the clipboard
+
+- LOCKBOX_PLATFORM (unset) override the detected platform