Module Name: othersrc
Committed By: agc
Date: Wed Aug 17 14:44:06 UTC 2011
Added Files:
othersrc/external/bsd/iscsi/sbin/iscsid: iscsid.8
Log Message:
add a first stab at a manual page for this daemon
To generate a diff of this commit:
cvs rdiff -u -r0 -r1.1 othersrc/external/bsd/iscsi/sbin/iscsid/iscsid.8
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Added files:
Index: othersrc/external/bsd/iscsi/sbin/iscsid/iscsid.8
diff -u /dev/null othersrc/external/bsd/iscsi/sbin/iscsid/iscsid.8:1.1
--- /dev/null Wed Aug 17 14:44:06 2011
+++ othersrc/external/bsd/iscsi/sbin/iscsid/iscsid.8 Wed Aug 17 14:44:06 2011
@@ -0,0 +1,84 @@
+.\" $NetBSD: iscsid.8,v 1.1 2011/08/17 14:44:06 agc Exp $
+.\"
+.\" Copyright (c) 2011 Alistair Crooks <a...@netbsd.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd August 8, 2011
+.Dt ISCSICTL 8
+.Os
+.Sh NAME
+.Nm iscsid
+.Nd interface to kernel iSCSI driver
+.Sh SYNOPSIS
+.Nm
+.Sh DESCRIPTION
+The iSCSI initiator runs as a kernel driver, and provides access
+to iSCSI targets running across a network using the iSCSI protocol,
+RFC 3270.
+The
+.Nm
+utility itself interfaces to the kernel iSCSI driver, and also
+communicates, using
+.Xr libisns 3
+with the iSCSI name service running on other hosts
+to locate services and iSCSI instances.
+In normal operation,
+.Nm
+is a standard daemon, and will detach from the controlling
+terminal using
+.Xr daemon 3
+and then loops, reading requests, processing them,
+and sending responses.
+Communication takes place over a
+Unix domain socket.
+.Nm
+exits on receiving a terminate message,
+(no response to one that is sent to the kernel),
+or when an error occurs reading from or writing to the socket.
+.Pp
+There are no command line arguments to
+.Nm
+.Pp
+It is envisaged that user-level communication take place with
+.Nm
+using the
+.Xr iscsictl 8
+utility, rather than directly over its communication socket.
+An example of setting up the in-kernel iSCSI initiator
+is shown in
+.Xr iscsictl 8 .
+.Sh SEE ALSO
+.Xr daemon 3 ,
+.Xr libisns 3 ,
+.Xr iscsictl 8
+.Sh HISTORY
+The
+.Nm
+utility appeared in
+.Nx 6.0 .
+.Sh AUTHORS
+.An Alistair Crooks Aq a...@netbsd.org
+wrote this manual page.
+The
+.Nm
+utility was contributed by Wasabi Systems, Inc.
