Skip to content
Snippets Groups Projects
Commit 5a4fff06 authored by ulif's avatar ulif
Browse files

Replace manpage.

Use version generated by docutils from manpage template in `docs/`.
parent c768e66f
No related branches found
No related tags found
No related merge requests found
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.44.1.
.TH DICEWARE "1" "April 2017" "diceware 0.9.2.dev0" "User Commands"
.\" Man page generated from reStructuredText.
.
.TH DICEWARE 1 "September 2017" "diceware 0.9.2.dev0" "User Commands"
.SH NAME
diceware \- manual page for diceware 0.9.2.dev0
diceware \- create 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
.sp
\fBdiceware\fP [\fIOPTION\fP]... [\fIFILE\fP]
.SH DESCRIPTION
usage: diceware [\-h] [\-n NUM] [\-c | \fB\-\-no\-caps]\fR [\-s NUM] [\-d DELIMITER]
.IP
[\-r SOURCE] [\-w NAME] [\-\-dice\-sides N] [\-v] [\-\-version]
[INFILE]
.PP
Create a passphrase
.SS "positional arguments:"
.sp
\fBdiceware\fP generates passphrases by concatenating words randomly picked from
wordlists. It supports also real dice for passphrase generation.
.sp
It is based on the proposals of Arnold G. Reinhold on \fI\%http://diceware.com\fP\&.
.SH OPTIONS
.sp
\fBpositional arguments\fP:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
INFILE
Input wordlist. `\-' will read from stdin.
.SS "optional arguments:"
.B FILE
input wordlist. \fB\(aq\-\(aq\fP will read from stdin.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBoptional arguments\fP:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.B \fB\-h\fP, \fB\-\-help\fP
show help message and exit
.TP
\fB\-n\fR NUM, \fB\-\-num\fR NUM
number of words to concatenate. Default: 6
.B \fB\-n\fP \fINUM\fP, \fB\-\-num\fP \fINUM\fP
number of words to concatenate. Default 6
.TP
\fB\-c\fR, \fB\-\-caps\fR
.B \fB\-c\fP, \fB\-\-caps\fP
Capitalize words. This is the default.
.TP
\fB\-\-no\-caps\fR
.B \fB\-\-no\-caps\fP
Turn off capitalization.
.TP
\fB\-s\fR NUM, \fB\-\-specials\fR NUM
.B \fB\-s\fP \fINUM\fP, \fB\-\-specials\fP \fINUM\fP
Insert NUM special chars into generated word.
.TP
\fB\-d\fR DELIMITER, \fB\-\-delimiter\fR DELIMITER
.B \fB\-d\fP \fIDELIMITER\fP, \fB\-\-delimiter\fP \fIDELIMITER\fP
Separate words by DELIMITER. Empty string by default.
.TP
\fB\-r\fR SOURCE, \fB\-\-randomsource\fR SOURCE
.B \fB\-r\fP \fISOURCE\fP, \fB\-\-randomsource\fP \fISOURCE\fP
Get randomness from this source. Possible values:
`realdice', `system'. Default: system
\fBrealdice\fP, \fBsystem\fP\&. Default: \fBsystem\fP
.TP
\fB\-w\fR NAME, \fB\-\-wordlist\fR NAME
Use words from this wordlist. Possible values: `en',
`en_eff', `en_orig', `en_securedrop'. Wordlists are
stored in the folder displayed below. Default: en_eff
.B \fB\-w\fP \fINAME\fP, \fB\-\-wordlist\fP \fINAME\fP
Use words from this wordlist. Possible values: \fIen\fP, \fIen_eff\fP, \fIen_orig\fP,
\fIen_securedrop\fP\&. Wordlists are stored in the folder displayed below.
Default: \fBen_eff\fP
.TP
\fB\-v\fR, \fB\-\-verbose\fR
.B \fB\-v\fP, \fB\-\-verbose\fP
Be verbose. Use several times for increased verbosity.
.TP
\fB\-\-version\fR
.B \fB\-\-version\fP
output version information and exit.
.SS "Arguments related to `realdice' randomsource:"
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBArguments related to\fP \fIrealdice\fP \fBrandomsource\fP:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
\fB\-\-dice\-sides\fR N
.B \fB\-\-dice\-sides\fP \fIN\fP
Number of sides of dice. Default: 6
.UNINDENT
.UNINDENT
.UNINDENT
.SH FILES
.INDENT 0.0
.TP
.B \fI~/.diceware.ini\fP
Your personal diceware configuration file.
.UNINDENT
.sp
\fBdiceware\fP also comes with a set of wordlists. The path where these lists are
stored is showed with \fB\-\-help\fP\&.
.SH EXAMPLES
.INDENT 0.0
.TP
.B \fBdiceware\fP
Create a passphrase using defaults. Outputs something like
"\fBWheelDyeHonkCanvasWitsPuck\fP"
.TP
.B \fBdiceware \-d\fP \fI"\-"\fP \fB\-n\fP \fI3\fP
Create a passphrase with three words, separated by dash ("\fI\-\fP"). Results in
something like "\fBWheel\-Dye\-Honk\fP"
.TP
.B \fBdiceware \-\-no\-caps\fP
Create a passphrase without capital words. Creates something like
"\fBwheel\-dye\-honk\fP".
.TP
.B \fBdiceware \-r\fP \fIrealdice\fP
Use real dice to create a passphrase. The programm will tell you what to do
(roll dice and tell what numbers appear) and in the end present a
passphrase.
.UNINDENT
.SH COPYRIGHT
Copyright \(co 2015\-2017 Uli Fouquet
diceware is based on suggestions of Arnold G. Reinhold.
See http://diceware.com for details.
\&'Diceware' is a trademark of Arnold G. Reinhold.
.PP
.sp
diceware \-\- Python implementation
Copyright (C) 2015\-2017 Uli Fouquet and contributors
.sp
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
.PP
.sp
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
.PP
.sp
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
along with this program. If not, see <\fI\%http://www.gnu.org/licenses/\fP>.
.sp
diceware is a concept invented by Arnold G. Reinhold, Cambridge, Massachusetts
USA.
.sp
The English Diceware Wordlists used with this programme are licensed
by Arnold G. Reinhold (files \fBwordlists/wordlist_en_orig.asc\fP,
\fBwordlists/wordlist_en.txt\fP) under the \fICreative Commons CC\-BY 3.0\fP
license (see \fI\%http://creativecommons.org/licenses/by/3.0/\fP).
.sp
The Securedrop wordlist (file
\fBwordlists/wordlist_en_securedrop.asc\fP) by Heartsucker is licensed
under the \fIMIT\fP license (see \fI\%http://mit\-license.org/\fP).
.sp
The EFF wordlist (file \fBwordlsts/wordlist_en_eff.txt\fP) is licensed
by the Electronic Frontier Foundation under the \fICreative Commons
CC\-BY 3.0 US\fP license (see
\fI\%https://creativecommons.org/licenses/by/3.0/us/\fP).
.sp
"Diceware" is a trademark of A G Reinhold.
.SH AUTHOR
Written by Uli Fouquet and contributors
.\" Generated by docutils manpage writer.
.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment