'\" -*- coding: utf-8 -*-
.\" Man page generated from reStructuredText.
.
.TH XKCDPASS 1 "2018-04-10" "" "Admin"
.SH NAME
xkcdpass \- generate memorable, secure multiword passphrases
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.nf
\fBxkcdpass\fP [ \fIoption\fP ... ]
\fBxkcdpass\fP \fB\-\-help\fP
.fi
.sp
.SH DESCRIPTION
.sp
A flexible and scriptable password generator which generates strong
passphrases, inspired by XKCD 936:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ xkcdpass
> correct horse battery staple
.ft P
.fi
.UNINDENT
.UNINDENT
.SH OPTIONS
.sp
\fB\-\-help\fP
.INDENT 0.0
.INDENT 3.5
Describe how to use this command.
.UNINDENT
.UNINDENT
.sp
\fB\-\-wordfile\fP \fIWORDFILE\fP, \fB\-w\fP \fIWORDFILE\fP
.INDENT 0.0
.INDENT 3.5
Specify that the file \fIWORDFILE\fP contains the list of valid words
from which to generate passphrases.
.UNINDENT
.UNINDENT
.sp
\fB\-\-min\fP \fIMIN_LENGTH\fP
.INDENT 0.0
.INDENT 3.5
Generate passphrases containing at least \fIMIN_LENGTH\fP words. (Default: 5)
.UNINDENT
.UNINDENT
.sp
\fB\-\-max\fP \fIMAX_LENGTH\fP
.INDENT 0.0
.INDENT 3.5
Generate passphrases containing at most \fIMAX_LENGTH\fP words. (Default: 9)
.UNINDENT
.UNINDENT
.sp
\fB\-\-numwords\fP \fINUM_WORDS\fP, \fB\-n\fP \fINUM_WORDS\fP
.INDENT 0.0
.INDENT 3.5
Generate passphrases containing exactly \fINUM_WORDS\fP words. (Default: 6)
.UNINDENT
.UNINDENT
.sp
\fB\-\-interactive\fP, \fB\-i\fP
.INDENT 0.0
.INDENT 3.5
Generate and output a passphrase, query the user to accept it, and
loop until one is accepted.
.UNINDENT
.UNINDENT
.sp
\fB\-\-valid_chars\fP \fIVALID_CHARS\fP, \fB\-v\fP \fIVALID_CHARS\fP
.INDENT 0.0
.INDENT 3.5
Limit passphrases to only include words matching the regex pattern
\fIVALID_CHARS\fP (e.g. \fB\(aq[a\-z]\(aq\fP).
.UNINDENT
.UNINDENT
.sp
\fB\-\-verbose\fP, \fB\-V\fP
.INDENT 0.0
.INDENT 3.5
Report various metrics for given options.
.UNINDENT
.UNINDENT
.sp
\fB\-\-acrostic\fP \fIACROSTIC\fP, \fB\-a\fP \fIACROSTIC\fP
.INDENT 0.0
.INDENT 3.5
Generate passphrases with an acrostic matching \fIACROSTIC\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-\-count\fP \fICOUNT\fP, \fB\-c\fP \fICOUNT\fP
.INDENT 0.0
.INDENT 3.5
Generate \fICOUNT\fP passphrases. (Default: 1)
.UNINDENT
.UNINDENT
.sp
\fB\-\-delimiter\fP \fIDELIM\fP, \fB\-d\fP \fIDELIM\fP
.INDENT 0.0
.INDENT 3.5
Separate words within a passphrase with \fIDELIM\fP\&. (Default: \(aq \(aq)
.UNINDENT
.UNINDENT
.sp
\fB\-\-separator\fP \fISEP\fP, \fB\-s\fP \fISEP\fP
.INDENT 0.0
.INDENT 3.5
Separate multiple passphrases with \fISEP\fP\&. (Default: U+000A LINE
FEED)
.UNINDENT
.UNINDENT
.sp
\fB\-\-case\fP \fICASE\fP, \fB\-C\fP \fICASE\fP
.INDENT 0.0
.INDENT 3.5
Set the case of each word in the passphrase by method \fICASE\fP\&.
(Default: \fBlower\fP)
.sp
Valid \fICASE\fP values are \fBalternating\fP, \fBupper\fP, \fBlower\fP,
\fBfirst\fP, \fBrandom\fP\&.
.UNINDENT
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
.IP \(bu 2
.nf
\fBxkcdpass\fP
.fi
.sp
.sp
Generates one passphrase with the default options. Example output:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
pinball previous deprive militancy bereaved numeric
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
.nf
\fBxkcdpass\fP \-\-count=5 \-\-acrostic=\(aqchaos\(aq \-\-delimiter=\(aq|\(aq \-\-min=5 \-\-max=6 \-\-valid_chars=\(aq[a\-z]\(aq
.fi
.sp
.sp
Generates 5 passphrases, all from lower\-case words and meeting the
acrostic “chaos”, delimited by the “|” character. Example output:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
collar|highly|asset|ovoid|sultan
caper|hangup|addle|oboist|scroll
couple|honcho|abbot|obtain|simple
cutler|hotly|aortae|outset|stool
cradle|helot|axial|ordure|shale
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SH HISTORY
.sp
The \fBxkcdpass\fP command invokes the Python program \fBxkcd_password.py\fP\&.
.sp
The inspiration for the program\(aqs purpose is the \fI\%XKCD 936\fP “Password
Strength” cartoon.
.sp
The application is maintained by Steven Tobin <\fI\%steven@steventob.in\fP>.
.sp
This manual page was written by Ben Finney <\fI\%ben+python@benfinney.id.au\fP>\&.
.\" Local variables:
.\" coding: utf-8
.\" mode: rst
.\" time-stamp-format: "%:y-%02m-%02d"
.\" time-stamp-start: "^:Date:[         ]+"
.\" time-stamp-end: "$"
.\" time-stamp-line-limit: 20
.\" End:
.\" vim: fileencoding=utf-8 filetype=rst :
.
.SH AUTHOR
Ben Finney <ben+python@benfinney.id.au>
.SH COPYRIGHT
BSD license, attribution and disclaimer required, no endorsement allowed.
.\" Generated by docutils manpage writer.
.