Codebase list ibutils / 46667d42-6d28-4f6f-9da8-c4c4650ae96c/main ibdm / doc / ibdmtr.1
46667d42-6d28-4f6f-9da8-c4c4650ae96c/main

Tree @46667d42-6d28-4f6f-9da8-c4c4650ae96c/main (Download .tar.gz)

ibdmtr.1 @46667d42-6d28-4f6f-9da8-c4c4650ae96c/mainraw · history · blame

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "IBDMTR 1"
.TH IBDMTR 1 "2008-06-16" "IBDM 1.0" "IB DATA MODEL PACKAGE"
.SH "NAME"
\&\fBibdmtr\fR \-  Fabric Trace Route
.SH "SYNOPSYS"
.IX Header "SYNOPSYS"
ibdmtr [\-v][\-h] {\-c <cbaling file>|\-t <topo file>} \-s <sm node name>
  \-p <sm port num> \-d <comma\-sep\-dr\-path>
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This utility parses a cabling list or topology file describing the systems connections that make a fabric.  Then it start following the direct route provided and print out the systems and nodes on the route.
.SH "ARGUMENTS Required arguments description."
.IX Header "ARGUMENTS Required arguments description."
.IP "\-t|\-\-topology <file>" 4
.IX Item "-t|--topology <file>"
.RS 4
.PD 0
.IP "Topology file describing the network. See man ibdm\-topology\-file." 4
.IX Item "Topology file describing the network. See man ibdm-topology-file."
.RE
.RS 4
.RE
.IP "\-c|\-\-cables <file>" 4
.IX Item "-c|--cables <file>"
.RS 4
.IP "Cabling list file. Following the line format:" 4
.IX Item "Cabling list file. Following the line format:"
.RE
.RS 4
.PD
.Sp
<Sys1Type> <Sys1Name> <Port1Name> <Sys2Type> <Sys2Name> <Port2Name>
.RE
.IP "\-s|\-\-sm\-node <name>" 4
.IX Item "-s|--sm-node <name>"
.RS 4
.PD 0
.IP "The name of the \s-1SM\s0 node (not system). E.g. \s-1OSM/U1\s0." 4
.IX Item "The name of the SM node (not system). E.g. OSM/U1."
.RE
.RS 4
.RE
.IP "\-p|\-\-port\-num <num>" 4
.IX Item "-p|--port-num <num>"
.RS 4
.IP "The number of the \s-1SM\s0 node port the \s-1SM\s0 is attached to" 4
.IX Item "The number of the SM node port the SM is attached to"
.RE
.RS 4
.RE
.IP "\-d|\-\-dr\-path <comm\-sep\-dr\-path>" 4
.IX Item "-d|--dr-path <comm-sep-dr-path>"
.RS 4
.IP "A list of ports to go out through" 4
.IX Item "A list of ports to go out through"
.RE
.RS 4
.PD
.SH "OPTIONS"
.IX Header "OPTIONS"
.RE
.IP "\-v|\-\-verbose" 4
.IX Item "-v|--verbose"
.RS 4
.PD 0
.IP "verbsoe mode" 4
.IX Item "verbsoe mode"
.RE
.RS 4
.RE
.IP "\-h|\-\-help" 4
.IX Item "-h|--help"
.RS 4
.IP "provide this help message" 4
.IX Item "provide this help message"
.RE
.RS 4
.PD
.SH "AUTHOR"
.IX Header "AUTHOR"
Eitan Zahavi, Mellanox Technologies \s-1LTD\s0, eitan@mellanox.co.il