smc.8

.\" smc.8
.\"
.\"
.\" Copyright IBM Corp. 2020
.\" Author(s):  Guvenc Gulce <guvenc@linux.ibm.com>
.\" ----------------------------------------------------------------------
.\"
.TH SMC 8 "June 2020" "smc-tools" "Linux Programmer's Manual"

.SH NAME
smc \- Print information about SMC linkgroups, links, devices

.SH SYNOPSIS
.B smc
.RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
.BR help " }"
.sp

.IR OBJECT " := { "
.BR device " | " info " | " linkgroup " | " stats " }"
.sp

.IR OPTIONS " := { "
\fB\-V\fR[\fIersion\fR] |
\fB\-a\fR[\fIbsolute\fR] |
\fB\-v\fR[\fIerbose\fR] |
\fB\-vv\fR[\fIerbose\fR]}

.SH OPTIONS

.TP
.BR "\-V" , " -Version"
Print the version of the
.B smc
utility and exit.

.TP
.BR "\-a", " \-absolute"
Print absolute statistic value (valid only for stats).

.TP
.BR "\-v", " \-verbose"
Print detailed information.

.TP
.BR "\-vv", " \-vverbose"
Print more detailed information.

.SH SMC - COMMAND SYNTAX

.SS
.I OBJECT

.B device
Device(s) as used by SMC

.TP
.B info
Generic SMC information

.TP
.B linkgroup
Linkgroup(s) or link(s) as used by SMC

.TP
.B stats
SMC statistics

.PP
The names of all objects can be abbreviated down to
a unique stem. For example,
.B device
can be abbreviated to
.B dev
or just
.B d.
Man pages in
.B SEE ALSO
section contain more 
information for individual objects.

.SS
.I COMMAND

Specifies the action to perform on the object.
The set of possible actions depends on the object type.
As a rule, it is possible to
.BR " show " or " link-show"
objects, but some objects do not allow all of these operations. The
.B help
command is available for all objects. It prints
out a list of available commands and argument syntax conventions.
.sp
If no command is given, a default command 
is assumed.

.SH RETURN CODES
Successful
.IR smc
commands return 0 and display the requested information.
If an error occurs,
.IR smc
writes a message to stderr and completes with a return code other than 0.
.P
.SH SEE ALSO
.BR af_smc (7),
.BR smc-device (8),
.BR smc-info (8),
.BR smc-linkgroup (8)
.BR smc-stats (8)