add doxygen support and json export document support
[heimdal.git] / appl / otp / otpprint.1
blob8045933980d7e7779c6de8dbe2b290eefa9c675f
1 .\" Copyright (c) 1996, 2000 - 2001 Kungliga Tekniska Högskolan
2 .\" (Royal Institute of Technology, Stockholm, Sweden).
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\"
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\"
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" 3. Neither the name of the Institute nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\" $Id$
33 .\"
34 .Dd November 17, 1996
35 .Dt OTP 1
36 .Os KTH-KRB
37 .Sh NAME
38 .Nm otpprint
39 .Nd print lists of one-time passwords
40 .Sh SYNOPSIS
41 .Nm otp
42 .Op Fl n Ar count
43 .Op Fl e
44 .Op Fl h
45 .Op Fl f Ar algorithm
46 .Ar sequence-number
47 .Ar seed
48 .Sh DESCRIPTION
49 The
50 .Nm
51 program prints lists of OTPs.
52 .Pp
53 Use this to print out a series of one-time passwords.  You will have
54 to supply the
55 .Ar sequence number
56 and the
57 .Ar seed
58 as arguments and then the program will prompt you for your pass-phrase.
59 .Pp
60 There are several different print formats.  The default is to print
61 each password with six short english words.
62 .Pp
63 Options are:
64 .Bl -tag -width Ds
65 .It Fl e
66 Print the passwords in ``extended'' format.  In this format a prefix
67 that says ``hex:'' or ``word:'' is included.
68 .It Fl f
69 To choose a different
70 .Ar algorithm
71 from the default md5.  Pick any of: md4, md5, and sha.
72 .It Fl h
73 Print the passwords in hex.
74 .It Fl n
75 Print
76 .Ar count
77 one-time passwords, starting at
78 .Ar sequence-number
79 and going backwards. The default is 10.
80 .El
81 .Sh SEE ALSO
82 .Xr otp 1