lockbox

password manager
Log | Files | Refs | README | LICENSE

commit 3178dcbdd20ec38dcd426f91d8361b2c167de220
parent 66bec62ac6f26e19067a1fb56780469ffa4728da
Author: Sean Enck <sean@ttypty.com>
Date:   Wed, 15 Feb 2023 18:13:32 -0500

cleaning up output line lengths

Diffstat:
MMakefile | 1+
Mcmd/doc.sections | 29++++++++++++++++-------------
Minternal/cli/core.go | 10+++++-----
3 files changed, 22 insertions(+), 18 deletions(-)

diff --git a/Makefile b/Makefile @@ -22,6 +22,7 @@ $(TESTDIR): cd $@ && go test check: $(TARGET) $(TESTDIR) $(DOC) $(RUNS) + sed -n '/\(.\)\{79\}/p' $(DOC) | wc -l | grep -q '^exit 0$$' $(RUNS): rm -f $(BUILD)*.kdbx diff --git a/cmd/doc.sections b/cmd/doc.sections @@ -1,11 +1,12 @@ [database] While 'lb' uses a kdbx file (version 4), it is opinionated about how to store data within the file. This means 'lb' should be the only way a user normally -interacts with or changes the underlying database. However as the file is a normal -kdbx file format (e.g. can be opened in tools supporting the format) it is possible -to use the database in those applications, just take caution when changing it outside -of 'lb' usage. If a database not normally used by 'lb' is to be used by 'lb', try -using the various readonly settings to control interactions. +interacts with or changes the underlying database. However as the file is a +normal kdbx file format (e.g. can be opened in tools supporting the format) it +is possible to use the database in those applications, just take caution when +changing it outside of 'lb' usage. If a database not normally used by 'lb' is +to be used by 'lb', try using the various readonly settings to control +interactions. [remove] The 'rm' command can handle a simplistic glob if it is at the END of the path. @@ -17,18 +18,20 @@ lb rm path/to/leaf/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 +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 +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 [rekey] -The password store can have the key (and file) changed via the 'key' subcommand. This -will require setting additional environment variables for the new key, key mode, key file, -and store (as specified as environment variables) but with '_NEW' added as a suffix +The password store can have the key (and file) changed via the 'key' +subcommand. This will require setting additional environment variables for the +new key, key mode, key file, and store (as specified as environment variables) +but with '_NEW' added as a suffix [environment variables] diff --git a/internal/cli/core.go b/internal/cli/core.go @@ -201,18 +201,18 @@ func Usage() ([]string, error) { return nil, err } var results []string - results = append(results, command(BashCommand, "", "generate bash completions")) - results = append(results, subCommand(BashCommand, BashDefaultsCommand, "", "generate default bash completion, not user environment specific")) + results = append(results, command(BashCommand, "", "generate user environment bash completion")) + results = append(results, subCommand(BashCommand, BashDefaultsCommand, "", "generate default bash completion")) results = append(results, command(ClipCommand, "entry", "copy the entry's value into the clipboard")) results = append(results, command(EnvCommand, "", "display environment variable information")) - results = append(results, command(FindCommand, "criteria", "perform a simplistic text search over the entry keys")) + results = append(results, command(FindCommand, "criteria", "perform a text search over the entry keys")) results = append(results, command(HelpCommand, "", "show this usage information")) results = append(results, subCommand(HelpCommand, HelpAdvancedCommand, "", "display verbose help information")) results = append(results, command(InsertCommand, "entry", "insert a new entry into the store")) results = append(results, subCommand(InsertCommand, InsertMultiCommand, "entry", "insert a multi-line entry")) results = append(results, subCommand(InsertCommand, InsertTOTPCommand, "entry", "insert a new totp entry")) results = append(results, command(ListCommand, "", "list entries")) - results = append(results, command(MoveCommand, "src dst", "move an entry from one location to another with the store")) + results = append(results, command(MoveCommand, "src dst", "move an entry from source to destination")) results = append(results, command(RemoveCommand, "entry", "remove an entry from the store")) results = append(results, command(ShowCommand, "entry", "show the entry's value")) results = append(results, command(StatsCommand, "entry", "display entry detail information")) @@ -220,7 +220,7 @@ func Usage() ([]string, error) { results = append(results, subCommand(TOTPCommand, TOTPClipCommand, "entry", "copy totp code to clipboard")) results = append(results, subCommand(TOTPCommand, TOTPListCommand, "", "list entries with totp settings")) results = append(results, subCommand(TOTPCommand, TOTPOnceCommand, "entry", "display the first generated code")) - results = append(results, subCommand(TOTPCommand, TOTPShortCommand, "entry", "display the first generated code with no details")) + results = append(results, subCommand(TOTPCommand, TOTPShortCommand, "entry", "display the first generated code (no details)")) results = append(results, command(VersionCommand, "", "display version information")) sort.Strings(results) usage := []string{fmt.Sprintf("%s usage:", name)}