xkcdpass.1

   1 .SH xkcdpass
   2 .SS generate memorable, secure multiword passphrases
   3 .TP
   4 .B Author
   5 |authorname| |authoremail|
   6 .RS
   7 .RE
   8 .TP
   9 .B Date
  10 2015\-01\-17
  11 .RS
  12 .RE
  13 .TP
  14 .B Copyright
  15 BSD license, attribution and disclaimer required, no endorsement
  16 allowed.
  17 .RS
  18 .RE
  19 .TP
  20 .B Manual section
  21 1
  22 .RS
  23 .RE
  24 .TP
  25 .B Manual group
  26 Admin
  27 .RS
  28 .RE
  29 .SS SYNOPSIS
  30 .PP
  31 \f[B]xkcdpass\f[] [ option ...
  32 ]
  33 .PD 0
  34 .P
  35 .PD
  36 \f[B]xkcdpass\f[] \f[B]\-\-help\f[]
  37 .SS DESCRIPTION
  38 .PP
  39 A flexible and scriptable password generator which generates strong
  40 passphrases, inspired by XKCD 936:
  41 .IP
  42 .nf
  43 \f[C]
  44 $\ xkcdpass
  45 >\ correct\ horse\ battery\ staple
  46 \f[]
  47 .fi
  48 .SS OPTIONS
  49 .PP
  50 \f[B]\-\-help\f[]
  51 .RS
  52 .PP
  53 Describe how to use this command.
  54 .RE
  55 .PP
  56 \f[B]\-\-wordfile\f[] WORDFILE, \f[B]\-w\f[] WORDFILE
  57 .RS
  58 .PP
  59 Specify that the file WORDFILE contains the list of valid words from
  60 which to generate passphrases.
  61 .RE
  62 .PP
  63 \f[B]\-\-min\f[] MIN_LENGTH
  64 .RS
  65 .PP
  66 Generate passphrases containing at least MIN_LENGTH words.
  67 (Default: 5)
  68 .RE
  69 .PP
  70 \f[B]\-\-max\f[] MAX_LENGTH
  71 .RS
  72 .PP
  73 Generate passphrases containing at most MAX_LENGTH words.
  74 (Default: 9)
  75 .RE
  76 .PP
  77 \f[B]\-\-numwords\f[] NUM_WORDS, \f[B]\-n\f[] NUM_WORDS
  78 .RS
  79 .PP
  80 Generate passphrases containing exactly NUM_WORDS words.
  81 (Default: 6)
  82 .RE
  83 .PP
  84 \f[B]\-\-interactive\f[], \f[B]\-i\f[]
  85 .RS
  86 .PP
  87 Generate and output a passphrase, query the user to accept it, and loop
  88 until one is accepted.
  89 .RE
  90 .PP
  91 \f[B]\-\-valid_chars\f[] VALID_CHARS, \f[B]\-v\f[] VALID_CHARS
  92 .RS
  93 .PP
  94 Limit passphrases to only include words matching the regex pattern
  95 VALID_CHARS (e.g.
  96 \f[C]\[aq][a\-z]\[aq]\f[]).
  97 .RE
  98 .PP
  99 \f[B]\-\-verbose\f[], \f[B]\-V\f[]
 100 .RS
 101 .PP
 102 Report various metrics for given options.
 103 .RE
 104 .PP
 105 \f[B]\-\-acrostic\f[] ACROSTIC, \f[B]\-a\f[] ACROSTIC
 106 .RS
 107 .PP
 108 Generate passphrases with an acrostic matching ACROSTIC.
 109 .RE
 110 .PP
 111 \f[B]\-\-count\f[] COUNT, \f[B]\-c\f[] COUNT
 112 .RS
 113 .PP
 114 Generate COUNT passphrases.
 115 (Default: 1)
 116 .RE
 117 .PP
 118 \f[B]\-\-delimiter\f[] DELIM, \f[B]\-d\f[] DELIM
 119 .RS
 120 .PP
 121 Separate words within a passphrase with DELIM.
 122 (Default: \[aq] \[aq])
 123 .RE
 124 .SS EXAMPLES
 125 .IP \[bu] 2
 126 \f[B]xkcdpass\f[]
 127 .RS 2
 128 .PP
 129 Generates one passphrase with the default options.
 130 Example output:
 131 .IP
 132 .nf
 133 \f[C]
 134 pinball\ previous\ deprive\ militancy\ bereaved\ numeric
 135 \f[]
 136 .fi
 137 .RE
 138 .IP \[bu] 2
 139 \f[B]xkcdpass\f[] \-\-count=5 \-\-acrostic=\[aq]chaos\[aq]
 140 \-\-delimiter=\[aq]|\[aq] \-\-min=5 \-\-max=6
 141 \-\-valid_chars=\[aq][a\-z]\[aq]
 142 .RS 2
 143 .PP
 144 Generates 5 passphrases, all from lower\-case words and meeting the
 145 acrostic “chaos”, delimited by the “|” character.
 146 Example output:
 147 .IP
 148 .nf
 149 \f[C]
 150 collar|highly|asset|ovoid|sultan
 151 caper|hangup|addle|oboist|scroll
 152 couple|honcho|abbot|obtain|simple
 153 cutler|hotly|aortae|outset|stool
 154 cradle|helot|axial|ordure|shale
 155 \f[]
 156 .fi
 157 .RE
 158 .SS HISTORY
 159 .PP
 160 The \f[B]xkcdpass\f[] command invokes the Python program
 161 \f[C]xkcd_password.py\f[].
 162 .PP
 163 The inspiration for the program\[aq]s purpose is the XKCD 936_ “Password
 164 Strength” cartoon.
 165 .PP
 166 The application is maintained by Steven Tobin <<steven@steventob.in>>.
 167 .PP
 168 This manual page was written by |authorname| |authoremail|.
 169 .SS \f
 170 .RS
 171 .PP
 172 Local variables: mode: rst coding: utf\-8 time\-stamp\-format:
 173 "%:y\-%02m\-%02d" time\-stamp\-start: "^:Date:[ ]+" time\-stamp\-end:
 174 "$" time\-stamp\-line\-limit: 20 End: vim: filetype=rst
 175 fileencoding=utf\-8 :
 176 .RE