Module Name: src
Committed By: wiz
Date: Fri Jun 19 19:31:18 UTC 2009
Modified Files:
src/usr.sbin/iscsi/initiator: iscsi-initiator.8
Log Message:
Add RCS Id.
Sort options.
End sentences with dots.
Use standard section headers.
Fix Xref.
Make HTML-ready.
To generate a diff of this commit:
cvs rdiff -u -r1.1 -r1.2 src/usr.sbin/iscsi/initiator/iscsi-initiator.8
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/usr.sbin/iscsi/initiator/iscsi-initiator.8
diff -u src/usr.sbin/iscsi/initiator/iscsi-initiator.8:1.1 src/usr.sbin/iscsi/initiator/iscsi-initiator.8:1.2
--- src/usr.sbin/iscsi/initiator/iscsi-initiator.8:1.1 Fri Jun 19 07:17:09 2009
+++ src/usr.sbin/iscsi/initiator/iscsi-initiator.8 Fri Jun 19 19:31:18 2009
@@ -1,3 +1,4 @@
+.\" $NetBSD: iscsi-initiator.8,v 1.2 2009/06/19 19:31:18 wiz Exp $
.\"
.\" Copyright © 2007 Alistair Crooks. All rights reserved.
.\"
@@ -33,7 +34,7 @@
.Nd refuse-based iSCSI initiator
.Sh SYNOPSIS
.Nm
-.Op Fl 46bcfvV
+.Op Fl 46bcfVv
.Op Fl a Ar authentication-type
.Op Fl d Ar digest-type
.Op Fl h Ar target-hostname
@@ -54,23 +55,23 @@
The various arguments are as follows:
.Bl -tag -width Ds
.It Fl 4
-Use an IPv4 connection to the target
+Use an IPv4 connection to the target.
.It Fl 6
-Use an IPv6 connection to the target
+Use an IPv6 connection to the target.
.It Fl a Ar authentication-type
Use the specified authentication type when communicating with the target.
The possible values are chap, kerberos, srp or none.
The default value is none.
.It Fl b
-Show the storage as a block device
+Show the storage as a block device.
.It Fl c
-Show the storage as a character device
+Show the storage as a character device.
.It Fl d Ar digest-type
Use the specified digest type when communicating with the target.
The possible values are header, data, both, all or none.
The default value is none.
.It Fl f
-Show the storage as a regular file
+Show the storage as a regular file.
.It Fl h Ar hostname
Connect to the iSCSI target running on the host specified as the argument.
.It Fl p Ar port-number
@@ -81,26 +82,24 @@
.It Fl u Ar username
Use the specified user's credentials when logging in to the iSCSI target.
There is no default.
-.It Fl v
-Be verbose in operation
.It Fl V
Print out the version number and then exit.
+.It Fl v
+Be verbose in operation.
.El
.Pp
The
.Xr refuse 3
library is used to provide the file system features.
.Pp
-The mandatory parameter is
-the local mount
-point.
+The mandatory parameter is the local mount point.
.Pp
This iSCSI initiator presents a view of the targets underneath the
mount point.
Firstly, it creates a directory tree with the hostname of the target,
and, in that directory, a virtual directory is created for each
target name exported by the iSCSI target program.
-Within that virtual target directory, symbolic links exist for
+Within that virtual target directory, symbolic links exist for
the hostname (for convenience),
a textual representation of the IP address,
the iSCSI target product name,
@@ -118,32 +117,32 @@
kernel module loaded via
.Xr modload 8
to operate.
-.Sh EXAMPLE
+.Sh EXAMPLES
.Bd -literal
# ./iscsi-initiator -u agc iscsi-target0.alistaircrooks.co.uk /mnt
# ls -al /mnt/iscsi-target0.alistaircrooks.co.uk/target0
total 576
drwxr-xr-x 2 agc agc 512 May 11 22:24 .
drwxr-xr-x 2 agc agc 512 May 11 22:24 ..
-lrw-r--r-- 1 agc agc 39 May 11 22:24 hostname -> iscsi-target0.alistaircrooks.co.uk
-lrw-r--r-- 1 agc agc 14 May 11 22:24 ip -> 172.16.135.130
-lrw-r--r-- 1 agc agc 16 May 11 22:24 product -> NetBSD iSCSI
+lrw-r--r-- 1 agc agc 39 May 11 22:24 hostname -\*[Gt] iscsi-target0.alistaircrooks.co.uk
+lrw-r--r-- 1 agc agc 14 May 11 22:24 ip -\*[Gt] 172.16.135.130
+lrw-r--r-- 1 agc agc 16 May 11 22:24 product -\*[Gt] NetBSD iSCSI
-rw-r--r-- 1 agc agc 104857600 May 11 22:24 storage
-lrw-r--r-- 1 agc agc 43 May 11 22:24 targetname -> iqn.1994-04.org.netbsd.iscsi-target:target0
-lrw-r--r-- 1 agc agc 8 May 11 22:24 vendor -> NetBSD
-lrw-r--r-- 1 agc agc 4 May 11 22:24 version -> 0
+lrw-r--r-- 1 agc agc 43 May 11 22:24 targetname -\*[Gt] iqn.1994-04.org.netbsd.iscsi-target:target0
+lrw-r--r-- 1 agc agc 8 May 11 22:24 vendor -\*[Gt] NetBSD
+lrw-r--r-- 1 agc agc 4 May 11 22:24 version -\*[Gt] 0
#
.Ed
.Sh SEE ALSO
-.Xr librefuse 3 ,
.Xr puffs 3 ,
-.Xr iscsi-target 8 .
+.Xr refuse 3 ,
+.Xr iscsi-target 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Nx 5.0 .
-.Sh AUTHOR
+.Sh AUTHORS
The
.Nm
utility was written by
