From patchwork Thu Sep 20 16:27:57 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bart Van Assche X-Patchwork-Id: 1486551 X-Patchwork-Delegate: alexne@voltaire.com Return-Path: X-Original-To: patchwork-linux-rdma@patchwork.kernel.org Delivered-To: patchwork-process-083081@patchwork1.kernel.org Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by patchwork1.kernel.org (Postfix) with ESMTP id 4A5C73FE65 for ; Thu, 20 Sep 2012 16:28:15 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751200Ab2ITQ2M (ORCPT ); Thu, 20 Sep 2012 12:28:12 -0400 Received: from [178.239.52.149] ([178.239.52.149]:38466 "EHLO wimaserver10.be" rhost-flags-FAIL-FAIL-OK-FAIL) by vger.kernel.org with ESMTP id S1751165Ab2ITQ2L (ORCPT ); Thu, 20 Sep 2012 12:28:11 -0400 Received: from 178-119-64-133.access.telenet.be ([178.119.64.133] helo=[192.168.1.101]) by wimaserver10.be with esmtpsa (TLSv1:AES256-SHA:256) (Exim 4.72) (envelope-from ) id 1TEjiC-0002Mb-O2; Thu, 20 Sep 2012 18:34:48 +0200 Message-ID: <505B440D.3010000@acm.org> Date: Thu, 20 Sep 2012 18:27:57 +0200 From: Bart Van Assche User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:15.0) Gecko/20120825 Thunderbird/15.0 MIME-Version: 1.0 To: Alex Netes CC: "linux-rdma@vger.kernel.org" Subject: [PATCH] Correct option names in opensm man page Sender: linux-rdma-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org Long options have to be preceded by a double dash instead of a single. Signed-off-by: Bart Van Assche --- man/opensm.8.in | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/man/opensm.8.in b/man/opensm.8.in index 79ff6a5..4e61c2e 100644 --- a/man/opensm.8.in +++ b/man/opensm.8.in @@ -11,7 +11,7 @@ opensm \- InfiniBand subnet manager and administration (SM/SA) [\-g(uid) ] [\-l(mc) ] [\-p(riority) ] -[\-smkey ] +[\-\-smkey ] [\-\-sm_sl ] [\-r(eassign_lids)] [\-R | \-\-routing_engine ] @@ -34,9 +34,9 @@ opensm \- InfiniBand subnet manager and administration (SM/SA) [\-s(weep) ] [\-t(imeout) ] [\-\-retries ] -[\-maxsmps ] -[\-console [off | local | socket | loopback]] -[\-console-port ] +[\-\-maxsmps ] +[\-\-console [off | local | socket | loopback]] +[\-\-console-port ] [\-i(gnore-guids) ] [\-w | \-\-hop_weights_file ] [\-O | \-\-port_search_ordering_file ] @@ -134,7 +134,7 @@ This will effect the handover cases, where master is chosen by priority and GUID. Range goes from 0 (default and lowest priority) to 15 (highest). .TP -\fB\-smkey\fR +\fB\-\-smkey\fR This option specifies the SM\'s SM_Key (64 bits). This will effect SM authentication. Note that OpenSM version 3.2.1 and below used the default value '1' @@ -263,15 +263,15 @@ for transactions. Without --retries, OpenSM defaults to 3 retries for transactions. .TP -\fB\-maxsmps\fR +\fB\-\-maxsmps\fR This option specifies the number of VL15 SMP MADs allowed on the wire at any one time. -Specifying -maxsmps 0 allows unlimited outstanding +Specifying \-\-maxsmps 0 allows unlimited outstanding SMPs. -Without -maxsmps, OpenSM defaults to a maximum of +Without \-\-maxsmps, OpenSM defaults to a maximum of 4 outstanding SMPs. .TP -\fB\-console [off | local | loopback | socket]\fR +\fB\-\-console [off | local | loopback | socket]\fR This option brings up the OpenSM console (default off). Note, loopback and socket open a socket which can be connected to WITHOUT CREDENTIALS. Loopback is safer if access to your SM host is controlled. tcp_wrappers @@ -279,12 +279,12 @@ is safer if access to your SM host is controlled. tcp_wrappers will only be available if OpenSM was built with --enable-console-loopback (default yes) and --enable-console-socket (default no) respectively. .TP -\fB\-console-port\fR +\fB\-\-console-port\fR Specify an alternate telnet port for the socket console (default 10000). Note that this option only appears if OpenSM was built with --enable-console-socket. .TP -\fB\-i\fR, \fB\-ignore-guids\fR +\fB\-i\fR, \fB\-\-ignore-guids\fR This option provides the means to define a set of ports (by node guid and port number) that will be ignored by the link load equalization algorithm. @@ -320,7 +320,7 @@ listed on a line are assigned to the remaining dimensions, in port order. Anything after a # is a comment. .TP \fB\-O\fR, \fB\-\-dimn_ports_file\fR \fB(DEPRECATED)\fR -This is a deprecated flag. Please use \fB-port_search_ordering_file\fR instead. +This is a deprecated flag. Please use \fB\-\-port_search_ordering_file\fR instead. This option provides a mapping between hypercube dimensions and ports on a per switch basis for the DOR routing engine. The file consists of lines containing a switch node GUID (specified as a 64 bit hex @@ -409,12 +409,12 @@ option can be used in conjunction with the perfmgr so as to run a standalone performance manager without SM/SA. However, this is NOT currently implemented in the performance manager. .TP -\fB\-perfmgr\fR +\fB\-\-perfmgr\fR Enable the perfmgr. Only takes effect if --enable-perfmgr was specified at configure time. See performance-manager-HOWTO.txt in opensm doc for more information on running perfmgr. .TP -\fB\-perfmgr_sweep_time_s\fR +\fB\-\-perfmgr_sweep_time_s\fR Specify the sweep time for the performance manager in seconds (default is 180 seconds). Only takes effect if --enable-perfmgr was specified at configure time. @@ -962,7 +962,7 @@ port GUID. The latter is supplied by: -i .br --ignore-guids +\-\-ignore-guids This option provides the means to define a set of ports (by guid) that will be ignored by the link load equalization algorithm. Note that only endports (CA,