debian/xkcdpass.1.txt

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