From owner-svn-src-head@freebsd.org Thu Dec 27 14:44:02 2018 Return-Path: Delivered-To: svn-src-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 75774136163C; Thu, 27 Dec 2018 14:44:02 +0000 (UTC) (envelope-from 0mp@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) server-signature RSA-PSS (4096 bits) client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 1782C76CAF; Thu, 27 Dec 2018 14:44:02 +0000 (UTC) (envelope-from 0mp@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 0BD9FD0D6; Thu, 27 Dec 2018 14:44:02 +0000 (UTC) (envelope-from 0mp@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id wBREi101038064; Thu, 27 Dec 2018 14:44:01 GMT (envelope-from 0mp@FreeBSD.org) Received: (from 0mp@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id wBREi1C6038063; Thu, 27 Dec 2018 14:44:01 GMT (envelope-from 0mp@FreeBSD.org) Message-Id: <201812271444.wBREi1C6038063@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: 0mp set sender to 0mp@FreeBSD.org using -f From: Mateusz Piotrowski <0mp@FreeBSD.org> Date: Thu, 27 Dec 2018 14:44:01 +0000 (UTC) To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r342553 - head/usr.bin/iscsictl X-SVN-Group: head X-SVN-Commit-Author: 0mp X-SVN-Commit-Paths: head/usr.bin/iscsictl X-SVN-Commit-Revision: 342553 X-SVN-Commit-Repository: base MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Rspamd-Queue-Id: 1782C76CAF X-Spamd-Bar: -- Authentication-Results: mx1.freebsd.org X-Spamd-Result: default: False [-2.96 / 15.00]; local_wl_from(0.00)[FreeBSD.org]; NEURAL_HAM_MEDIUM(-1.00)[-0.999,0]; NEURAL_HAM_LONG(-1.00)[-0.999,0]; NEURAL_HAM_SHORT(-0.96)[-0.964,0]; ASN(0.00)[asn:11403, ipnet:2610:1c1:1::/48, country:US] X-BeenThere: svn-src-head@freebsd.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: SVN commit messages for the src tree for head/-current List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 27 Dec 2018 14:44:02 -0000 Author: 0mp (ports committer) Date: Thu Dec 27 14:44:01 2018 New Revision: 342553 URL: https://svnweb.freebsd.org/changeset/base/342553 Log: iscsictl.8: Add missing flag parameters - Add missing parameters to flags in the description of available options. - Remove spaces between alternative parameters and "|". - Align descriptions of options to the longest option. - Use em dash instead of a hyphen. Reviewed by: bcr Approved by: doc (bcr) Approved by: krion (mentor, implicit), mat (mentor, implicit) Differential Revision: https://reviews.freebsd.org/D18608 Modified: head/usr.bin/iscsictl/iscsictl.8 Modified: head/usr.bin/iscsictl/iscsictl.8 ============================================================================== --- head/usr.bin/iscsictl/iscsictl.8 Thu Dec 27 14:14:41 2018 (r342552) +++ head/usr.bin/iscsictl/iscsictl.8 Thu Dec 27 14:44:01 2018 (r342553) @@ -27,7 +27,7 @@ .\" .\" $FreeBSD$ .\" -.Dd May 6, 2016 +.Dd December 27, 2018 .Dt ISCSICTL 8 .Os .Sh NAME @@ -40,13 +40,13 @@ .Op Fl u Ar user Fl s Ar secret .Op Fl w Ar timeout .Op Fl r -.Op Fl e Cm on | off +.Op Fl e Cm on Ns | Ns Cm off .Nm .Fl A .Fl d Ar discovery-host .Op Fl u Ar user Fl s Ar secret .Op Fl r -.Op Fl e Cm on | off +.Op Fl e Cm on Ns | Ns Cm off .Nm .Fl A .Fl a Op Fl c Ar path @@ -60,7 +60,7 @@ .Op Fl t Ar target .Op Fl u Ar user .Op Fl s Ar secret -.Op Fl e Cm on | off +.Op Fl e Cm on Ns | Ns Cm off .Nm .Fl M .Fl i Ar session-id @@ -85,7 +85,7 @@ The utility is used to configure the iSCSI initiator. .Pp The following options are available: -.Bl -tag -width ".Fl A" +.Bl -tag -width "-d discovery-host" .It Fl -libxo Generate output via .Xr libxo 3 @@ -104,38 +104,40 @@ List sessions. .It Fl a When adding, add all sessions defined in the configuration file. When removing, remove all currently established sessions. -.It Fl c +.It Fl c Ar path Path to the configuration file. The default is .Pa /etc/iscsi.conf . -.It Fl d +.It Fl d Ar discovery-host Target host name or address used for SendTargets discovery. When used, it will add a temporary discovery session. After discovery is done, sessions will be added for each discovered target, and the temporary discovery session will be removed. -.It Fl e +.It Fl e Cm on Ns | Ns Cm off Enable or disable the session. This is ignored for discovery sessions, but gets passed down to normal sessions they add. -.It Fl i +.It Fl i Ar session-id Session ID, as displayed by .Nm .Fl v . -.It Fl n -The "nickname" of session defined in the configuration file. -.It Fl p -Target portal - host name or address - for statically defined targets. +.It Fl n Ar nickname +The +.Ar nickname +of a session defined in the configuration file. +.It Fl p Ar portal +Target portal \(em host name or address \(em for statically defined targets. .It Fl r Use iSER (iSCSI over RDMA) instead of plain iSCSI over TCP/IP. -.It Fl s +.It Fl s Ar secret CHAP secret. -.It Fl t +.It Fl t Ar target Target name. -.It Fl u +.It Fl u Ar user CHAP login. .It Fl v Verbose mode. -.It Fl w +.It Fl w Ar timeout Instead of returning immediately, wait up to .Ar timeout seconds until all configured sessions are successfully established.