warren/libiscsi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README: Rename into README.md

Browse Source 
Additionally, restrict the contents of README.md to 80 columns.
This commit is contained in:
Bart Van Assche
2021-07-17 19:15:31 -07:00
parent b446ab3188
commit c9fd0743bc
1 changed files with 41 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README → README.md
+41 -35
View File
@@ -1,20 +1,20 @@
Libiscsi is a client-side library to implement the iSCSI protocol that can be used Libiscsi is a client-side library to implement the iSCSI protocol that can be
to access the resources of an iSCSI target. used to access the resources of an iSCSI target.
The library is fully asynchronous with regards to iSCSI commands and SCSI tasks, The library is fully asynchronous with regards to iSCSI commands and SCSI
but a synchronous layer is also provided for ease of use for simpler tasks, but a synchronous layer is also provided for ease of use for simpler
applications. applications.
The src directory contains a handful of useful iSCSI utilities such as logging in The src directory contains a handful of useful iSCSI utilities such as logging
to and enumerating all targets on a portal and all devices of a target. in to and enumerating all targets on a portal and all devices of a target.
The examples directory contains example implementation of how to access both the The examples directory contains example implementation of how to access both
synchronous and asynchronous APIs of libiscsi. the synchronous and asynchronous APIs of libiscsi.
Libiscsi is a work in progress. Libiscsi is a work in progress. It aims to become a fully asynchronous
It aims to become a fully asynchronous library for iSCSI functionality, including library for iSCSI functionality, including all features required to establish
all features required to establish and maintain an iSCSI session, as well as a and maintain an iSCSI session, as well as a low-level SCSI library to create
low-level SCSI library to create SCSI CDBs and parse/unmarshall data-in structures. SCSI CDBs and parse/unmarshall data-in structures.
Installation Installation
@@ -77,10 +77,11 @@ Example:
Bidirectional CHAP Authentication Bidirectional CHAP Authentication
================================= =================================
Bidirectional CHAP is when you not only authenticate the initiator to the target
but also authenticate the target back to the initiator. Bidirectional CHAP is when you not only authenticate the initiator to the
This is only available if you also first specify normal authentication as per target but also authenticate the target back to the initiator. This is only
the previous section. available if you also first specify normal authentication as per the previous
section.
Bidirectional CHAP can be set either via URL arguments or via environment Bidirectional CHAP can be set either via URL arguments or via environment
variables. If specifying it via URL arguments, be careful so that you do variables. If specifying it via URL arguments, be careful so that you do
@@ -103,10 +104,10 @@ Setting the CHAP authentication via environment variables:
IPv6 support IPv6 support
============ ============
Libiscsi supports IPv6, either as names resolving into IPv6 addresses or when Libiscsi supports IPv6, either as names resolving into IPv6 addresses or when
IPv6 addresses are explicitely set in the URL. IPv6 addresses are explicitely set in the URL. When specifying IPv6 addresses
When specifying IPv6 addresses in the URL, they have to be specified in in the URL, they have to be specified in [...] bracket form.
[...] bracket form.
Example: Example:
iscsi://[fec0:2727::3]:3260/iqn.ronnie.test/1 iscsi://[fec0:2727::3]:3260/iqn.ronnie.test/1
@@ -114,18 +115,18 @@ Example:
Header Digest Header Digest
============= =============
Libiscsi supports HeaderDigest.
By default, libiscsi will offer None,CRC32C and let the target pick whether Libiscsi supports HeaderDigest. By default, libiscsi will offer None,CRC32C
Header digest is to be used or not. and let the target pick whether Header digest is to be used or not. This can
This can be overridden by an application by calling iscsi_set_header_digest() be overridden by an application by calling iscsi_set_header_digest() if the
if the application wants to force a specific setting. application wants to force a specific setting.
Patches Patches
======= =======
The patches subdirectory contains patches to make some external packages The patches subdirectory contains patches to make some external packages
iSCSI-aware and make them use libiscsi. iSCSI-aware and make them use libiscsi. Currently we have SG3-UTILS and MTX.
Currently we have SG3-UTILS and MTX.
Patches for other packages would be welcome. Patches for other packages would be welcome.
@@ -133,8 +134,8 @@ ISCSI-TEST-CU
============= =============
iscsi-test-cu is a CUnit based test tool for scsi and iscsi. iscsi-test-cu is a CUnit based test tool for scsi and iscsi.
iscsi-test-cu depends on the CUnit library and will only build if libcunit can be iscsi-test-cu depends on the CUnit library and will only build if libcunit can
found during configure. be found during configure.
The configure script will check if a suitable libcunit is available and only The configure script will check if a suitable libcunit is available and only
build the test tool if it can find libcunit. build the test tool if it can find libcunit.
@@ -239,6 +240,7 @@ To run the tests:
SUPPORTED PLATFORMS SUPPORTED PLATFORMS
=================== ===================
libiscsi is pure POSIX and should with some tweaks run on any host that libiscsi is pure POSIX and should with some tweaks run on any host that
provides a POSIX-like environment. provides a POSIX-like environment.
@@ -253,18 +255,22 @@ Libiscsi has been tested on:
RELEASE TARBALLS RELEASE TARBALLS
================ ================
Release tarballs are available at https://sites.google.com/site/libiscsitarballs/libiscsitarballs/
Release tarballs are available at
https://sites.google.com/site/libiscsitarballs/libiscsitarballs/
CONTRIBUTING CONTRIBUTING
============ ============
If you want to contribute, please do.
For sending me patches you can either do that by sending a pull request to my If you want to contribute, please do. For sending me patches you can either
github repo or you can send them in an email directly to me at do that by sending a pull request to my github repo or you can send them in an
ronniesahlberg@gmail.com email directly to me at ronniesahlberg@gmail.com
MAILINGLIST MAILINGLIST
=========== ===========
A libiscsi mailing list is available at http://groups.google.com/group/libiscsi
Announcements of new versions of libiscsi will be posted to this list. A libiscsi mailing list is available at
http://groups.google.com/group/libiscsi. Announcements of new versions of
libiscsi will be posted to this list.