Blame iscsiuio/docs/iscsiuio.8

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