summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLee Duncan <lduncan@suse.com>2021-12-03 10:12:19 -0800
committerLee Duncan <lduncan@suse.com>2021-12-03 10:12:19 -0800
commit6744522f3032ed39b0715aba0cc6f6799e8df7e3 (patch)
treecc5db1f8d73893c63e09f3078b9a169c8ced53a6 /doc
parentad7c5d6b5ccadb122662961e5316eadebbe4f4a4 (diff)
downloadopen-iscsi-6744522f3032ed39b0715aba0cc6f6799e8df7e3.tar.gz
Add man page for the iscsi-gen-initiatorname script.
Diffstat (limited to 'doc')
-rw-r--r--doc/iscsi-gen-initiatorname.836
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/iscsi-gen-initiatorname.8 b/doc/iscsi-gen-initiatorname.8
new file mode 100644
index 0000000..5ad0a1e
--- /dev/null
+++ b/doc/iscsi-gen-initiatorname.8
@@ -0,0 +1,36 @@
+.TH ISCSI_GEN_INITIATORNAME 8 "Dec 2021" "" "Linux Administrator's Manual"
+.SH NAME
+iscsi-gen-initiatorname \- smart iSCSI initiator name generation tool
+.SH SYNOPSIS
+.BI iscsi-gen-initiatorname
+[OPTIONS]
+.SH "DESCRIPTION"
+.B iscsi-gen-initiatorname
+generates a unique iSCSI node name on every invocation. If
+iBFT is in use, the iBFT-registered initiator name will be used.
+.P
+If there is an existing initiator name, it will not be overwritten
+unless the \fB-f\fP option is supplied.
+.SH OPTIONS
+.TP
+.BI [-h]
+Display a help message and exit.
+.TP
+.BI [-f]
+Force overwrite of existing initiator name, if present.
+.TP
+.BI [-p] \fIIQN-PREFIX\fP
+Use \fIIQN-PREFIX\fP as the prefix to the IQN generated,
+instead of the default of \fBiqn.1996-04.de.suse:01\fP.
+.SH FILES
+.TP
+/etc/iscsi/initiatorname.iscsi
+The file containing the initiator name. Do not edit manually.
+.SH "SEE ALSO"
+.BR iscsi-iname (8)
+.SH AUTHORS
+Open-iSCSI project <http://www.open-iscsi.com/>
+.br
+Hannes Reinecke <hare@suse.de>
+.br
+Lee Duncan <lduncan@suse.com>