Escape several minus signs in the manual page.
[donkey:pkg-debian.git] / donkey.1
1 .TH DONKEY 1 "October 4, 1995" "" ""
2 .\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
3 .\" other parms are allowed: see man(7), man(1)
4 .SH NAME
5 donkey \- alternative for S/KEY's "key" command.
6 .SH SYNOPSIS
7 .B donkey
8 .I "[options] sequence seed"
9 .br
10 .B donkey
11 .I "\-i"
12 .P
13 .B key
14 .I "[option] sequence seed"
15 .br
16 .B key
17 .I "\-i"
18 .SH "DESCRIPTION"
19 .PP
20 This manual page documents briefly the
21 .BR donkey ,
22 and
23 .B key
24 commands.
25 This manual page was written for the Debian GNU/Linux distribution
26 because the original program does not have a manual page.
27 Instead, it has documentation in /usr/share/doc/donkey
28 .PP
29 .B donkey
30 is an alternative for S/KEY's "key" command. The new feature that
31 the original key doesn't have is print an entry for skeykeys as
32 follows;
33
34 .nf
35 .RS
36 kazu 0099 al02004          115d83956f1089b6  Apr 26,1995 22:13:27
37 .RE
38 .fi
39
40 This means that donkey is also an alternative for "keyinit". Since the
41 entry is printed to stdout (not to /etc/skeykeys), you can easily sent
42 it to remote operator by e-mail (with PGP signature or something). So,
43 it possible to initiate S/KEY without login from the console of the
44 host.
45
46 .SH OPTIONS
47 .PP
48 A summary of options are included below.
49 .TP
50 .B \-n
51 .I num
52 specify number of keys to be calculated.
53 .TP
54 .B \-f
55 .I func
56 choose hash function from 
57 .B MD2
58
59 .B MD4
60 , and 
61 .B MD5
62 .
63
64 .SH EXAMPLES
65 .PP
66 .SS (1) Calculate an One-Time-Password.
67 Execute Donkey with sequence and seed, then input your passphrase.
68
69 .nf
70 .RS
71 % donkey 80 is12345
72 Enter passphrase : xxxxxxxxxxxxxxxxxxxxxxx
73 SOFT O SAW SWAB CON RODE
74 .RE
75 .fi
76
77 You can choose hash function from MD2, MD4, and MD5.
78
79 .nf
80 .RS
81 % donkey 80 is12345
82 Enter passphrase : xxxxxxxxxxxxxxxxxxxxxxx
83 SOFT O SAW SWAB CON RODE
84
85 %donkey \-f md5 80 is12345
86 Enter passphrase : xxxxxxxxxxxxxxxxxxxxxxx
87 LACK WIN ROSE ANNA STUN REEK
88 .RE
89 .fi
90
91 The default hash function is MD4 due to the historical reason.
92
93 .SS (2) Calculate some One-Time-Passwords at once.
94 Use \-n option.
95
96 .nf
97 .RS
98 % donkey \-n 10 80 is12345
99 Enter passphrase : xxxxxxxxxxxxxxxxxxxxxxx
100 71: WORE HELL CUB FAR DORA MALE  
101 72: SAIL DAN DONE BEER DAYS MOS  
102 73: PAN TONE THAT TOUT BURY EST  
103 74: KEN ROAM HEAT NAN MEAN HEN   
104 75: MINI MARS HASH BOTH SITU SING
105 76: TOW SHIN FLUE ARID AHOY NE   
106 77: SLID LEEK NO TREE STOW BEY   
107 78: RUDY WINE GIFT FUSS AGEE SUE 
108 79: GELD THIN MAID THIN BUD TURF 
109 80: SOFT O SAW SWAB CON RODE     
110 .RE
111 .fi
112
113 Note that though "Enter passphrase" is printed out to stderr,
114 One-Time-Passwords is to stdout. So, you can redirect the output
115 safely.
116
117 .SS (3) Print skeykeys entry.
118 Use \-i option without argments. Then, enter login name, sequence and
119 seed. If you like default value, just type RET. Input your passphrase
120 twice to get the entry.
121
122 .nf
123 .RS
124 % donkey \-i
125 Enter login name [default kazu]: 
126 Enter sequence 1 to 999 [default 99]: 
127 Enter new seed [default ur18122]: 
128 Please choose passphrase between 8 and 256 characters.
129 Enter passphrase : xxxxxxxxxxxxxxxxxxxxxxxxxxx
130 Re-enter passphrase : xxxxxxxxxxxxxxxxxxxxxxxxxxx
131 kazu 0099 ur18122          fc5b023e684968ff  Oct 02,1995 16:15:30
132 WINK SEAM GRAB ROAD HELL FEST
133 .RE
134 .fi
135
136 .SH BUGS
137 .PP
138 Things to do:
139 .TP
140 Support other one time passwords such as OTP.
141 .TP
142 Support other secure hash functions. 
143
144 .SH AUTHOR
145 .PP
146 This program is developed by Kazuhiko Yamamoto <kazu@is.aist\-nara.ac.jp>.
147 This manual page was written by Fumitoshi UKAI <ukai@debian.or.jp>,
148 based on documents of this program, for the Debian GNU/Linux system 
149 (but may be used by others).