Blame iscsiuio/docs/iscsiuio.8

Packit Service 646995
.\" Copyright (c) 2010-2013 Broadcom Corporation
Packit Service 646995
.\" Copyright (c) 2014, QLogic Corporation
Packit Service 646995
.\" This is free documentation; you can redistribute it and/or
Packit Service 646995
.\" modify it under the terms of the GNU General Public License as
Packit Service 646995
.\" published by the Free Software Foundation.
Packit Service 646995
.\"
Packit Service 646995
.\" bnx2.4,v 0.7.8.1b
Packit Service 646995
.\"
Packit Service 646995
.TH iscsiuio 8 "12/10/2013" "QLogic Corporation"
Packit Service 646995
.\"
Packit Service 646995
.\" NAME part
Packit Service 646995
.\"
Packit Service 646995
.SH NAME
Packit Service 646995
iscsiuio \- iSCSI UserSpace I/O driver
Packit Service 646995
.\"
Packit Service 646995
.\" SYNOPSIS part
Packit Service 646995
.\"
Packit Service 646995
.SH SYNOPSIS
Packit Service 646995
.B iscsiuio
Packit Service 646995
.RB [ -d -f -v ]
Packit Service 646995
.PP
Packit Service 646995
.\"
Packit Service 646995
.\" DESCRIPTION part
Packit Service 646995
.\"
Packit Service 646995
.SH DESCRIPTION
Packit Service 646995
iscsiuio is the UserSpace I/O driver for the QLogic NetXtreme II
Packit Service 646995
BCM5706/5708/5709 series PCI/PCI-X Gigabit Ethernet Network Interface Card
Packit Service 646995
(NIC) and for the QLogic NetXtreme II BCM57710/57711/57712/57800/57810/57840
Packit Service 646995
series PCI-E 10 Gigabit Ethernet Network Interface Card.
Packit Service 646995
The driver has been tested on 2.6.28 kernels and above.
Packit Service 646995
.PP
Packit Service 646995
Refer to the README.TXT from the driver package on how to
Packit Service 646995
compile and install the driver.
Packit Service 646995
.PP
Packit Service 646995
Refer to various Linux documentations
Packit Service 646995
on how to configure network protocol and address.
Packit Service 646995
.\"
Packit Service 646995
.\" DRIVER DEPENDENCIES part
Packit Service 646995
.\"
Packit Service 646995
.SH DRIVER DEPENDENCIES
Packit Service 646995
Packit Service 646995
.\"
Packit Service 646995
.\" PARAMETER part
Packit Service 646995
.\"
Packit Service 646995
.SH PARAMETERS
Packit Service 646995
There are very few parameters when running this application.
Packit Service 646995
.TP
Packit Service 646995
.BI -d|--debug <debug level>
Packit Service 646995
This is to enable debug mode where debug messages will be sent to stdout
Packit Service 646995
The following debug modes are supported
Packit Service 646995
.P
Packit Service 646995
.RS
Packit Service 646995
DEBUG         4 - Print all messages
Packit Service 646995
.P
Packit Service 646995
INFO          3 - Print messages needed to follow the uIP code (default)
Packit Service 646995
.P
Packit Service 646995
WARN          2 - Print warning messages
Packit Service 646995
.P
Packit Service 646995
ERROR         1 - Only print critical errors
Packit Service 646995
.RE
Packit Service 646995
.PP
Packit Service 646995
.TP
Packit Service 646995
.TP
Packit Service 646995
.BI -f|--foreground
Packit Service 646995
This is to enable foreground mode so that this application doesn't get sent
Packit Service 646995
into the background.
Packit Service 646995
.PP
Packit Service 646995
.TP
Packit Service 646995
.BI -v|--version
Packit Service 646995
This is to print the version.
Packit Service 646995
.PP
Packit Service 646995
.TP
Packit Service 646995
.BI -p|--pid <pidfile>
Packit Service 646995
Use pidfile (default  /run/iscsiuio.pid )
Packit Service 646995
.PP
Packit Service 646995
.TP
Packit Service 646995
.BI -h|--help
Packit Service 646995
Display this help and exit.
Packit Service 646995
Packit Service 646995
Packit Service 646995
.\"
Packit Service 646995
.\" AUTHOR part
Packit Service 646995
.\"
Packit Service 646995
.SH AUTHOR
Packit Service 646995
Benjamin Li \- benli@broadcom.com
Packit Service 646995
.P
Packit Service 646995
Eddie Wai \- eddie.wai@broadcom.com
Packit Service 646995
.SH Maintained by
Packit Service 646995
QLogic-Storage-Upstream@qlogic.com