Browse Source

lots of new stuff in README.md

Pat Beirne 7 tháng trước cách đây
mục cha
commit
43fa5bd613
1 tập tin đã thay đổi với 55 bổ sung0 xóa
  1. 55 0
      README.md

+ 55 - 0
README.md

@@ -14,8 +14,63 @@ The program runs locally on a UNIX/Linux based computer, and the passphrase neve
 
 ### Usage
 
+Simply invoke the program, and the defaults will give you a usable password phrase:
 
+    pwgen
 
+returns
+
+    boards.coziest.allure
+
+as a potential pass phrase. The following options exist:
+
+    -p    pad the words with spaces
+    -P    pad the words with spaces, periods or commas
+    -n    pad with numbers
+    -N    pad with numbers, spaces, periods or commas
+    -L <n>
+    --length <n> minimum phrase length (default=20)
+    -c    make 2 word phrases with conjunction between them
+    <n>   make multiple phrases (default=1)
+
+By default, <code>pwgen</code> will build a pass phrase using words from the dictionary at <code>/usr/share/dict/words</code> and add punctuation to separate the words. 
+
+    $ pwgen
+    consequently?restraining
+
+Adding the **<code>-p</code>** option will insist that the passphrase be padded with only spaces, making it easier to type on a smartphone. Similarly, the **<code>-P</code>** option uses only spaces, periods and commas, which are often easily accessed on a smartphone.
+
+    $ pwgen -p
+    garments mazes queasy
+    $ pwgen -P
+    crufted..teeth...buy
+
+Some servers require numbers to be embedded in the password, so the **<code>-n</code>** and **<code>-N</code>** options are available.
+
+    $ pwgen -N
+    bleeding5clusters5berries
+
+The **<code>-L</code>** option allows you to specify a minimum length for the pass phrase, although the result may be a few characters longer than you requested, so that the words aren't chopped up.
+
+    $ pwgen -L 30
+    dittoed___nonabrasive___atomic
+
+The **<code>-c</code>** option uses common English conjunctions to separate a pair of words. If the 2nd word starts with a vowel, the conjuntion "a" is changed to "an". I find these phrases much easier to remember than just a sequence of words.
+
+    $ pwgen -c
+    quick in a crowd
+
+Part of the reason for using pass phrases is to make them easier to remember for us humans. Sometimes, the first phrases offered just doesn't seem memorable, so you can add a small integer after <code>pwgen</code> to get multiple offerings, and you can just choose the one that seems memorable to you.
+
+    $ pwgen 6
+    mechanisms..contempt
+    windbreak\\knuckling
+    pith$seconding$unkempt
+    adore/anthems/welder
+    firesides!!!spaceman
+    wannest=tabloids=weighty
+
+Coming soon: Instead of spaces & punctuation, you will be able to use CamelCase to indicate word boundaries. Snake_case is also a commonly requested format. L3tt3rSubst!tut!0n will also be implemented.