Import version 1.8.3
[s390-tools.git] / zconf / lszcrypt.8
blob01d4fa7c70a718835c66ff7a899ca563584b6c80
1 .TH LSZCRYPT 8 "AUG 2008" "s390-tools"
2 .SH NAME
3 lszcrypt \- display zcrypt device and configuration information
4 .SH SYNOPSIS
5 .TP 9
6 .B lszcrypt
7 .RB "[ " -V " | " -VV " ] "
9 .I <device id>
10 [...]]
11 .TP
12 .B lszcrypt -b
13 .TP
14 .B lszcrypt -h
15 .TP
16 .B lszcrypt -v
17 .SH DESCRIPTION
18 The
19 .B lszcrypt
20 command is used to display information about cryptographic adapters managed by
21 zcrypt and zcrypt's AP bus attributes. Displayed information depends on the
22 kernel version.
23 .B lszcrypt
24 requires that the sysfs filesystem is mounted.
26 The following information can be displayed for each cryptographic adapter: card
27 type, online status, hardware card type, hardware queue depth, and request
28 count. The following AP bus attributes can be displayed: AP domain,
29 configuration timer, poll thread status, poll timeout, and AP interrupt status.
30 .SH OPTIONS
31 .TP 8
32 .B -V, --verbose
33 Increase verbose level for cryptographic adapter information. Maximum verbose
34 level is two. At verbose level one card type and online status are displayed.
35 At verbose level two card type, online status, hardware card type, hardware
36 queue depth, and request count are displayed.
37 .TP 8
38 .B <device id>
39 Specifies a cryptographic adapter which will be displayed. A cryptographic
40 adapter can be specified either in decimal or hexadecimal notation using
41 a '0x' prefix. If no adapters are specified information about all available
42 adapters will be displayed.
43 .TP 8
44 .B -b, --bus
45 Show AP bus attributes and exit.
46 .TP 8
47 .B -h, --help
48 Print help text and exit.
49 .TP 8
50 .B -v, --version
51 Print version information and exit.
52 .SH EXAMPLES
53 .TP
54 .B lszcrypt -V
55 Will display card type and online status of all available cryptographic
56 adapters.
57 .TP
58 .B lszcrypt -VV 0 1 10 12
59 Will display card type, online status, hardware card type, hardware queue
60 depth, and request count for cryptographic adapters in decimal notation 0, 1,
61 10, and 12.
62 .TP
63 .B lszcrypt -b
64 Will display AP bus information.
65 .SH SEE ALSO
66 \fBchzcrypt\fR(8)
67 .SH AUTHOR
68 .nf
69 This man-page was written by Ralph Wuerthner <rwuerthn@de.ibm.com> and
70 Felix Beck <felix.beck@de.ibm.com>.
71 .fi