Allow an error code to be returned in the head.error element of the ioctl.
[dragonfly.git] / usr.bin / keyinfo / keyinfo.1
blob048b70eecb8c0d2438d959a196a5a3a91fe0bdbe
1 .\"     from: @(#)keyinfo.1     1.1 (Bellcore) 7/20/93
2 .\" $FreeBSD: src/usr.bin/keyinfo/keyinfo.1,v 1.7.2.2 2001/12/21 10:07:20 ru Exp $
3 .\" $DragonFly: src/usr.bin/keyinfo/keyinfo.1,v 1.2 2003/06/17 04:29:27 dillon Exp $
4 .\"
5 .Dd April 26, 1996
6 .Dt KEYINFO 1
7 .Os
8 .Sh NAME
9 .Nm keyinfo
10 .Nd display current S/Key sequence number and seed
11 .Sh SYNOPSIS
12 .Nm
13 .Op Ar username
14 .Sh DESCRIPTION
15 .Nm
16 takes an optional user name and displays the user\'s current sequence
17 number and seed found in the S/Key database
18 .Pa /etc/skeykeys .
19 .Pp
20 The command can be useful when generating a list of passwords for use
21 on a field trip, by combining with the command
22 .Xr key 1
23 in the form:
24 .Bd -literal -offset indent
25 key -n  <number of passwords> `keyinfo` | lpr
26 .Ed
27 .Pp
28 The optional
29 .Ar username
30 argument specifies the S/Key user for whom to display the information.
31 The default is to display S/Key information
32 on the user who invokes the command.
33 Only the superuser can ask for another user's key information.
34 .Sh EXAMPLES
35 Usage example:
36 .Bd -literal -offset indent
37 $ keyinfo
38 .Ed
39 .Pp
40 This would produce the following output:
41 .Bd -literal -offset indent
42 98 ws91340
43 .Ed
44 .Sh DIAGNOSTICS
45 The
46 .Nm
47 utility
48 exits with status 0 if a key for the requested user has been found,
49 else with status 1.
50 .Sh SEE ALSO
51 .Xr key 1 ,
52 .Xr keyinit 1
53 .Sh AUTHORS
54 .An -nosplit
55 Original command by
56 .An Phil Karn ,
57 .An Neil M. Haller
58 and
59 .An John S. Walden .
60 Rewritten in Perl by
61 .An J\(:org Wunsch
62 so that it could be made setuid, with the S/Key keys file read-protected
63 from the users.
64 Rewritten in C by
65 .An Warner Losh .