search

redacted / XKCD-password-generator

Generate secure multiword passwords/passphrases, inspired by XKCD
BSD 3-Clause "New" or "Revised" License
1.32k stars 185 forks source link

Option ‘--wordlist’ help text fails to mention the wordfile is ignored if missing #147

Open bignose-debian opened 2 years ago

bignose-debian commented 2 years ago

The help text for the --wordlist option describes its behaviour as:

Specify that the file WORDFILE contains the list of
valid words from which to generate passphrases. Multiple 
wordfiles can be provided, separated by commas.
Provided wordfiles: […]

This implies (“the list of valid words”) that the specified file will be used, but gives no description of what happens if the specified WORDLIST does not exist.

Currently, the behaviour is that the program will silently use a different wordlist. The documentation would be improved if this was explicitly described.

bignose-debian commented 2 years ago

The branch wip/issue/147/specified-wordfile-silently-ignored (in my personal fork repository) changes the various documentation to describe --wordlist behaviour more accurately.

The branch currently merges cleanly to master.