summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndy Grover <agrover@redhat.com>2014-02-24 14:36:54 -0800
committerAndy Grover <agrover@redhat.com>2014-02-24 14:36:54 -0800
commit4a99051ece74cb14ded719c4a66d50d259afeeae (patch)
treea3e50cef74fe57fae770631fb8e605070f53b0f7
parent2be01f39ca38c456f9aa00c0e373a37a2065abed (diff)
downloadtargetcli-4a99051ece74cb14ded719c4a66d50d259afeeae.tar.gz
Add a quickstart section to manpage
This stuff is still a pain to get started using. Add a quickstart section as a band-aid. Signed-off-by: Andy Grover <agrover@redhat.com>
-rw-r--r--targetcli.824
1 files changed, 24 insertions, 0 deletions
diff --git a/targetcli.8 b/targetcli.8
index 3c927af..8464b57 100644
--- a/targetcli.8
+++ b/targetcli.8
@@ -46,6 +46,30 @@ set to
.BR true ,
the default.
.P
+.SH QUICKSTART
+To create an iSCSI target and share a file-backed LUN without any auth checks:
+.P
+$ sudo targetcli
+.br
+/> backstores/fileio create test /tmp/test.img 100m
+.br
+/> iscsi/ create iqn.2006-04.example.com:test-target
+.br
+/> cd iscsi/iqn.2006-04.example.com:test-target/tpg1/
+.br
+tpg1/> portals/ create
+.br
+tpg1/> luns/ create /backstores/fileio/test
+.br
+tpg1/> set attribute authentication=0
+.br
+tpg1/> set attribute generate_node_acls=1
+.br
+tpg1/> exit
+.P
+See
+.B EXAMPLES
+below for more detailed information.
.SH BACKSTORES
.B Backstores
are different kinds of local storage resources that the kernel target