Skip to content
Snippets Groups Projects
Commit 23882d8f authored by ulif's avatar ulif
Browse files

Update docs.

parent 6d9c367a
No related branches found
No related tags found
No related merge requests found
......@@ -44,10 +44,13 @@ Usage
Once installed, use ``--help`` to list all available options::
$ diceware --help
usage: diceware [-h] [-n NUM] [-c | --no-caps] [-s NUM]
usage: diceware [-h] [-n NUM] [-c | --no-caps] [-s NUM] [INFILE]
Create a passphrase
positional arguments:
INFILE Input wordlist. `-' will read from stdin.
optional arguments:
-h, --help show this help message and exit
-n NUM, --num NUM number of words to concatenate. Default: 6
......@@ -93,6 +96,27 @@ You can nevertheless disable caps with the ``--no-caps`` option::
This leads to lower-case passphrases, maybe easier to type on smart
phones or similar.
`diceware` comes with an English wordlist (the 'diceware8k' list)
provided by Arnold G. Reinhold, which will be used by default and
contains 8192 different words.
If you do not like the wordlist provided, you can use your own one. Any
`INFILE` provided will be parsed line by line and each line considered
a possible word. For instance::
$ echo -e "hi\nhello\n" > mywordlist.txt
$ diceware mywordlist.txt
HelloHelloHiHiHiHello
With filename ``-`` you can pipe in wordlists::
$ echo -e "hi\nhello\n" > mywordlist.txt
$ cat mywordlist.txt | diceware -
HiHiHelloHiHiHello
In custom wordlists we take each line for a valid word and ignore
empty lines (i.e. lines containing whitespace characters only).
What is it good for?
--------------------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment