From b0ce82d06186f8b2fd7de54d1f7047e6d6838d5e Mon Sep 17 00:00:00 2001
From: lissav <lissav@8638fb3e-16cb-4fca-ae20-7b5d299a9bcd>
Date: Mon, 10 Dec 2012 14:29:49 +0000
Subject: [PATCH] document device support

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@14607 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
---
 xCAT-client/pods/man1/sinv.1.pod | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

diff --git a/xCAT-client/pods/man1/sinv.1.pod b/xCAT-client/pods/man1/sinv.1.pod
index 5f0a3bf80..7184a2b94 100644
--- a/xCAT-client/pods/man1/sinv.1.pod
+++ b/xCAT-client/pods/man1/sinv.1.pod
@@ -4,7 +4,7 @@ B<sinv> - Checks the software configuration of the nodes in the cluster.
 
 =head1 B<SYNOPSIS>
 
-B<sinv>  [B<-o> I<output>] [B<-p> I<template path>] [B<-t> I<template count>] [B<-s> I<seed node>] [B<-i>] [B<-e>] [B<-r>] [B<-V>] [[B<-f> I<command file>] | [B<-c> I<command>]]
+B<sinv>  [B<-o> I<output>] [B<-p> I<template path>] [B<-t> I<template count>] [B<-s> I<seed node>] [B<-i>] [B<-e>] [B<-r>] [B<-V>] [B<--devicetype> I<type_of_device>]  [B<-l>  I<userID>] [[B<-f> I<command file>] | [B<-c> I<command>]]
 
 B<sinv> [B<-h> | B<-v>]
 
@@ -132,6 +132,26 @@ it would be considered a match, as long as all rpms listed in the template
 were on the node. With exactmatch set, the output must be identical 
 to the template. 
 
+=item B<--devicetype> I<type_of_device>
+
+Specify a user-defined device type that references the location
+of relevant device configuration file. The devicetype value must
+correspond to a valid device configuration file.
+xCAT ships some default configuration files
+for Ethernet switches and and IB switches under
+I</opt/xcat/share/xcat/devicetype> directory. If you want to overwrite
+any of the configuration files, please copy it to I</var/opt/xcat/>
+directory and cutomize it.
+For example, I<base/IBSwitch/Qlogic/config> is the configuration
+file location if devicetype is specified as IBSwitch::Qlogic.
+xCAT will first search config file using I</var/opt/xcat/> as the base.
+If not found, it will search for it using
+I</opt/xcat/share/xcat/devicetype/> as the base.
+
+=item B<-l>|B<--user> I<user_ID>
+
+Specifies a remote user name to use for remote command execution.
+
 =item B<-c>|B<--command>
 
 The xdsh or rinv command that will be run. The command should be enclosed in 
@@ -254,9 +274,16 @@ B<xdsh> I<compute1 "cat /etc/hosts" | xdshcoll > /tmp/sinv2/template"
 
 B<sinv> I<-c "xdsh -i 611dskls  cat /etc/hosts" -e -t1 -p /tmp/sinv.template  -o /tmp/sinv.output> 
 
+=item *
+
+To execute B<sinv> on the device mswitch2 and compare to mswitch1
+
+B<sinv> I<-c "xdsh mswitch  enable;show version"  -s mswitch1 -p /tmp/sinv/template --devicetype IBSwitch::Mellanox -l admin -t 2>
+
+
 =back
 
-=head1 B<Files>
+B<Files>
 
 B</opt/xcat/bin/sinv/>