xref: /netbsd-src/sbin/iscsid/iscsid.8 (revision a5847cc334d9a7029f6352b847e9e8d71a0f9e0c)
1.\" $NetBSD: iscsid.8,v 1.1 2011/10/23 21:11:23 agc Exp $
2.\"
3.\" Copyright (c) 2011 Alistair Crooks <agc@NetBSD.org>
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd August 8, 2011
27.Dt ISCSICTL 8
28.Os
29.Sh NAME
30.Nm iscsid
31.Nd interface to kernel iSCSI driver
32.Sh SYNOPSIS
33.Nm
34.Sh DESCRIPTION
35The iSCSI initiator runs as a kernel driver, and provides access
36to iSCSI targets running across a network using the iSCSI protocol,
37RFC 3270.
38The
39.Nm
40utility itself interfaces to the kernel iSCSI driver, and also
41communicates, using
42.Xr libisns 3 ,
43with the iSCSI name service running on other hosts
44to locate services and iSCSI instances.
45In normal operation,
46.Nm
47is a standard daemon, and will detach from the controlling
48terminal using
49.Xr daemon 3
50and then loops, reading requests, processing them,
51and sending responses.
52Communication takes place over a
53Unix domain socket.
54.Nm
55exits on receiving a terminate message,
56(no response to one that is sent to the kernel),
57or when an error occurs reading from or writing to the socket.
58.Pp
59There are no command line arguments to
60.Nm .
61.Pp
62It is envisaged that user-level communication take place with
63.Nm
64using the
65.Xr iscsictl 8
66utility, rather than directly over its communication socket.
67An example of setting up the in-kernel iSCSI initiator
68is shown in
69.Xr iscsictl 8 .
70.Sh SEE ALSO
71.Xr daemon 3 ,
72.Xr libisns 3 ,
73.Xr iscsictl 8
74.Sh HISTORY
75The
76.Nm
77utility appeared in
78.Nx 6.0 .
79.Sh AUTHORS
80.An Alistair Crooks Aq agc@NetBSD.org
81wrote this manual page.
82The
83.Nm
84utility was contributed by Wasabi Systems, Inc.
85