Skip to content
Snippets Groups Projects
diceware.1 5.25 KiB
Newer Older
  • Learn to ignore specific revisions
  • ulif's avatar
    ulif committed
    .\" Man page generated from reStructuredText.
    .
    
    ulif's avatar
    ulif committed
    .TH DICEWARE 1 "September 2017" "diceware 0.9.4.dev0" "User Commands"
    
    ulif's avatar
    ulif committed
    .SH NAME
    
    ulif's avatar
    ulif committed
    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]
    
    ulif's avatar
    ulif committed
    .SH DESCRIPTION
    
    ulif's avatar
    ulif committed
    .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
    
    ulif's avatar
    ulif committed
    .TP
    
    ulif's avatar
    ulif committed
    .B FILE
    
    ulif's avatar
    ulif committed
    optional input wordlist. \fB\(aq\-\(aq\fP will read from stdin. Should contain one
    word per line.
    
    ulif's avatar
    ulif committed
    .UNINDENT
    .UNINDENT
    .UNINDENT
    .sp
    \fBoptional arguments\fP:
    .INDENT 0.0
    .INDENT 3.5
    .INDENT 0.0
    
    ulif's avatar
    ulif committed
    .TP
    
    ulif's avatar
    ulif committed
    .B \fB\-h\fP, \fB\-\-help\fP
    show help message and exit
    
    ulif's avatar
    ulif committed
    .TP
    
    ulif's avatar
    ulif committed
    .B \fB\-n\fP \fINUM\fP, \fB\-\-num\fP \fINUM\fP
    number of words to concatenate. Default 6
    
    ulif's avatar
    ulif committed
    .TP
    
    ulif's avatar
    ulif committed
    .B \fB\-c\fP, \fB\-\-caps\fP
    
    ulif's avatar
    ulif committed
    Capitalize words. This is the default.
    .TP
    
    ulif's avatar
    ulif committed
    .B \fB\-\-no\-caps\fP
    
    ulif's avatar
    ulif committed
    Turn off capitalization.
    .TP
    
    ulif's avatar
    ulif committed
    .B \fB\-s\fP \fINUM\fP, \fB\-\-specials\fP \fINUM\fP
    
    ulif's avatar
    ulif committed
    Insert NUM special chars into generated word.
    .TP
    
    ulif's avatar
    ulif committed
    .B \fB\-d\fP \fIDELIMITER\fP, \fB\-\-delimiter\fP \fIDELIMITER\fP
    
    ulif's avatar
    ulif committed
    Separate words by DELIMITER. Empty string by default.
    .TP
    
    ulif's avatar
    ulif committed
    .B \fB\-r\fP \fISOURCE\fP, \fB\-\-randomsource\fP \fISOURCE\fP
    
    ulif's avatar
    ulif committed
    Get randomness from this source. Possible values:
    
    ulif's avatar
    ulif committed
    \fBrealdice\fP, \fBsystem\fP\&. Default: \fBsystem\fP
    
    ulif's avatar
    ulif committed
    .TP
    
    ulif's avatar
    ulif committed
    .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
    
    ulif's avatar
    ulif committed
    .TP
    
    ulif's avatar
    ulif committed
    .B \fB\-v\fP, \fB\-\-verbose\fP
    
    ulif's avatar
    ulif committed
    Be verbose. Use several times for increased verbosity.
    .TP
    
    ulif's avatar
    ulif committed
    .B \fB\-\-version\fP
    
    ulif's avatar
    ulif committed
    output version information and exit.
    
    ulif's avatar
    ulif committed
    .UNINDENT
    .UNINDENT
    .UNINDENT
    .sp
    \fBArguments related to\fP \fIrealdice\fP \fBrandomsource\fP:
    .INDENT 0.0
    .INDENT 3.5
    .INDENT 0.0
    
    ulif's avatar
    ulif committed
    .TP
    
    ulif's avatar
    ulif committed
    .B \fB\-\-dice\-sides\fP \fIN\fP
    
    ulif's avatar
    ulif committed
    Number of sides of dice. Default: 6
    
    ulif's avatar
    ulif committed
    .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.
    
    ulif's avatar
    ulif committed
    .TP
    .B \fBdiceware mywordlist.txt\fP
    Create a passphrase with words from file "mywordlist.txt". The file should
    contain one word on each line.
    
    ulif's avatar
    ulif committed
    .UNINDENT
    
    ulif's avatar
    ulif committed
    .SH COPYRIGHT
    
    ulif's avatar
    ulif committed
    .sp
    diceware \-\- Python implementation
    Copyright (C) 2015\-2017 Uli Fouquet and contributors
    .sp
    
    ulif's avatar
    ulif committed
    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.
    
    ulif's avatar
    ulif committed
    .sp
    
    ulif's avatar
    ulif committed
    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.
    
    ulif's avatar
    ulif committed
    .sp
    
    ulif's avatar
    ulif committed
    You should have received a copy of the GNU General Public License
    
    ulif's avatar
    ulif committed
    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.
    .