Skip to content

Commit

Permalink
update README to reflect latest code changes
Browse files Browse the repository at this point in the history
  • Loading branch information
atoponce committed Sep 11, 2017
1 parent af310ef commit 0f5a6c4
Showing 1 changed file with 31 additions and 31 deletions.
62 changes: 31 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,87 +8,87 @@ be needed to view the emoji characters correctly.

Options are:

-h
--help
-h
--help
Print this help and exit.

-d <language>
--diceware <language>
-d <language>
--diceware <language>
Choose a Diceware language. Default is English.
<language> must be one of:
Basque, Beale, Bulgarian, Catalan, Chinese, Czech,
Danish, Dutch, English, Esperanto, Finnish, French,
German, Italian, Japanese, Maori, Norwegian, Polish,
Portuguese, Russian, Slovenian, Spanish, Swedish, Turkish.

-e <wordlist>
--eff <wordlist>
-e <wordlist>
--eff <wordlist>
Choose an EFF wordlist. Default is Short.
<wordlist> must be one of:
Distant, Long, Short.

-a <wordlist>
--alternate <wordlist>
-a <wordlist>
--alternate <wordlist>
Choose an alternate wordlist. Default is Trump.
<wordlist> must be one of:
Elvish, Klingon, PGP, Rockyou, Simposons, Trump

-b <language>
--bitcoin <language>
-b <language>
--bitcoin <language>
Choose a Bitcoin language. Default is English.
<language> must be one of:
Chinese, English, French, Italian, Japanese, Korean
NOTE:
Simplified Chinese is the default Chinese character set.
If you want to use Traditional Chinese, use --traditional.

-t
--traditional
-t
--traditional
Use the Traditional Chinese character set with Bitcoin.

-s
--system
-s
--system
Use /usr/share/dict/words for building your passphrase.
Obviously, the more words in that file, the more entropy per word.
Also, larger system word lists will contain more obscure words.

-n
--ninja
-n
--ninja
Choose Secret Ninja encoding.

-c
--cosby
-c
--cosby
Choose Bill Cosby Bebob.

-k
--kpop
-k
--kpop
Choose Korean K-pop words.

-e <base>
--random <base>
-e <base>
--random <base>
Choose a number base to generated. Default is Base94
<base> must be one of:
Base94, Base64, Base32, Base16, Base10.

-o <generator>
--only <generator>
-o <generator>
--only <generator>
Choose a generator instead of printing all six (default).
<generator> must be one of:
Alternate, Bitcoin, Diceware, EFF System,
Pseudowords, Random, or Emoji

-m <number>
--min-entropy <number>
-m <number>
--min-entropy <number>
Set a minimum entropy requirement in bits. Default is 70.

-j
--json
-j
--json
Output the passwords and meta in JSON format.

-H
--hyphenate
-H
--hyphenate
Add hyphens to the Diceware, EFF, and Alternate passphrases.

Output can be valid JSON, meant to be both human and machine parseable. Default
is unformatted plaintext:

Expand Down

0 comments on commit 0f5a6c4

Please sign in to comment.