svn commit: r271543 - in head: share/man/man4 usr.bin/iscsictl usr.sbin/iscsid

Sat Sep 13 18:40:13 UTC 2014

Author: allanjude (doc committer)
Date: Sat Sep 13 18:40:12 2014
New Revision: 271543
URL: http://svnweb.freebsd.org/changeset/base/271543

Log:
  Add the new iscsi(4) man page
  Cross reference it from iscsid(8) and iscsictl(8)
  
  Reviewed by:	trasz
  Approved by:	bcr (mentor), wblock (mentor)
  Sponsored by:	ScaleEngine Inc.
  CR:		https://reviews.freebsd.org/D741

Added:
  head/share/man/man4/iscsi.4   (contents, props changed)
Modified:
  head/share/man/man4/Makefile
  head/usr.bin/iscsictl/iscsictl.8
  head/usr.sbin/iscsid/iscsid.8

Modified: head/share/man/man4/Makefile
==============================================================================

--- head/share/man/man4/Makefile	Sat Sep 13 18:34:56 2014	(r271542)
+++ head/share/man/man4/Makefile	Sat Sep 13 18:40:12 2014	(r271543)
@@ -206,6 +206,7 @@ MAN=	aac.4 \
 	ipw.4 \
 	ipwfw.4 \
 	isci.4 \
+	iscsi.4 \
 	iscsi_initiator.4 \
 	ismt.4 \
 	isp.4 \

Added: head/share/man/man4/iscsi.4
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ head/share/man/man4/iscsi.4	Sat Sep 13 18:40:12 2014	(r271543)
@@ -0,0 +1,111 @@
+.\" Copyright (c) 2014 Edward Tomasz Napierala
+.\" 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 AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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.
+.\"
+.\" $FreeBSD$
+.Dd September 11, 2014
+.Dt ISCSI 4
+.Os
+.Sh NAME
+.Nm iscsi
+.Nd iSCSI initiator
+.Sh SYNOPSIS
+To compile this driver into the kernel,
+place the following line in the
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device iscsi"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+iscsi_load="YES"
+.Ed
+.Sh DESCRIPTION
+The
+.Nm
+subsystem provides the kernel component of an iSCSI initiator.
+The initiator is the iSCSI client, which connects to an iSCSI target,
+providing local access to a remote block device.
+The userland component is provided by
+.Xr iscsid 8
+and both the kernel and userland are configured using
+.Xr iscsictl 8 .
+The
+.Nm
+subsystem is responsible for implementing the
+.Qq Full Feature Phase
+of the iSCSI protocol.
+.Sh SYSCTL VARIABLES
+The following variables are available as both
+.Xr sysctl 8
+variables and
+.Xr loader 8
+tunables:
+.Bl -tag -width indent
+.It Va kern.iscsi.ping_timeout
+The number of seconds to wait for the target to respond to a NOP-Out
+PDU.
+In the event that there is no response within that time the session gets
+forcibly restarted.
+.It Va kern.iscsi.iscsid_timeout
+The number of seconds to wait for
+.Xr ctld 8
+to establish a session.
+After that time
+.Nm
+will abort and retry.
+.It Va kern.iscsi.login_timeout
+The number of seconds to wait for a login attempt to succeed.
+After that time
+.Nm
+will abort and retry.
+.It Va kern.iscsi.maxtags
+The maximum number of outstanding IO requests.
+.It Va kern.iscsi.fail_on_disconnection
+Controls the behavior after an iSCSI connection has been dropped due to
+network problems.
+When set to 1, a dropped connection causes the iSCSI device nodes
+to be destroyed.
+After reconnecting, they will be created again.
+By default, the device nodes are left intact.
+While the connection is down all input/output operations are suspended, to be
+retried after the connection is reestablished.
+.El
+.Sh SEE ALSO
+.Xr iscsi.conf 5 ,
+.Xr iscsictl 8 ,
+.Xr iscsid 8
+.Sh HISTORY
+The
+.Nm
+subsystem first appeared in
+.Fx 10.0 .
+.Sh AUTHORS
+The
+.Nm
+subsystem was developed by
+.An Edward Tomasz Napierala Aq Mt trasz at FreeBSD.org
+under sponsorship from the FreeBSD Foundation.

Modified: head/usr.bin/iscsictl/iscsictl.8
==============================================================================
--- head/usr.bin/iscsictl/iscsictl.8	Sat Sep 13 18:34:56 2014	(r271542)
+++ head/usr.bin/iscsictl/iscsictl.8	Sat Sep 13 18:40:12 2014	(r271543)
@@ -27,7 +27,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd July 18, 2014
+.Dd September 12, 2014
 .Dt ISCSICTL 8
 .Os
 .Sh NAME
@@ -171,6 +171,7 @@ Attach to target iqn.2012-06.com.example
 Disconnect all iSCSI sessions:
 .Dl Nm Fl Ra
 .Sh SEE ALSO
+.Xr iscsi 4 ,
 .Xr iscsi.conf 5 ,
 .Xr iscsid 8
 .Sh HISTORY
@@ -181,6 +182,6 @@ command appeared in
 .Sh AUTHORS
 The
 .Nm
-was developed by
+utility was developed by
 .An Edward Tomasz Napierala Aq Mt trasz at FreeBSD.org
 under sponsorship from the FreeBSD Foundation.

Modified: head/usr.sbin/iscsid/iscsid.8
==============================================================================
--- head/usr.sbin/iscsid/iscsid.8	Sat Sep 13 18:34:56 2014	(r271542)
+++ head/usr.sbin/iscsid/iscsid.8	Sat Sep 13 18:40:12 2014	(r271543)
@@ -27,7 +27,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd September 20, 2012
+.Dd September 12, 2014
 .Dt ISCSID 8
 .Os
 .Sh NAME
@@ -49,12 +49,13 @@ as well as performing SendTargets discov
 Upon startup, the
 .Nm
 daemon opens the iSCSI initiator device file and waits for kernel requests.
-It doesn't use any configuration file; all the information it needs it gets
-from the kernel.
+.Nm
+does not use any configuration files.
+All needed information is supplied by the kernel.
 .Pp
 When the
 .Nm
-damon is not running, already established iSCSI connections continue
+daemon is not running, already established iSCSI connections continue
 to work.
 However, establishing new connections, or recovering existing ones in case
 of connection error, is not possible.
@@ -99,6 +100,7 @@ The
 .Nm
 utility exits 0 on success, and >0 if an error occurs.
 .Sh SEE ALSO
+.Xr iscsi 4 ,
 .Xr iscsictl 8
 .Sh HISTORY
 The
@@ -108,6 +110,6 @@ command appeared in
 .Sh AUTHORS
 The
 .Nm
-was developed by
+utility was developed by
 .An Edward Tomasz Napierala Aq Mt trasz at FreeBSD.org
 under sponsorship from the FreeBSD Foundation.
