mars/contrib/monitoring/mars-status.8

75 lines
2.0 KiB
Groff

.TH mars-status 8 "11.04.2014" "" "Mars Status"
.SH NAME
mars-status \- program to display status information from mars
.SH SYNOPSIS
.B "Usage: mars-status [--help]"
.br
.B "Usage: mars-status [--version]"
.br
.B "Usage: mars-status (without specification of parameters, an abstract of all the informations spent)"
.br
.B "Usage: mars-status [--resource <RESNAME>] [--interval <seconds>] [[--history] [--debug] [--system]]"
.br
.B " --resource : limits the display to the specified resource"
.br
.B " --interval : refreshes the display every second xxx"
.br
.B " --history : shows information about the log files, version numbers and their status"
.br
.B " --status : shows informations about resize, sync, replay and fetch status"
.br
.B " --system : display mars-system informations"
.br
.B " --debug : additional display error messages and warnings to internal"
.br
.br
.br
.br
(See the OPTIONS section for alternate option syntax with long option names.)
.SH DESCRIPTION
This manual page explains the
.B mars-status
program. This program is used to display information from the Mars clusters, whose resources and the logfiles with its versions.
.SH OPTIONS
.SS "Generic Program Information"
.TP
.B \-h ", " \-\^\-help
Print a usage message briefly summarizing these command-line options and the bug-reporting address, then exit.
.TP
.BR \-V ", " \-\^\-version
Print the version number of
.B marsadm
This version number should be included in all bug reports (see below).
.SS "Display Options"
.TP
.BR without " " options
.B mars-status
display short summary of all informations of all resources on Cluster.
.TP
.BR resource " " RESNAME
Limits the display to the specified resource.
.TP
.BR interval " " seconds
Refreshes the display every second xxx.
.TP
.BR long " " history
Shows information about the log files, version numbers and their status.
.TP
.BR debug
Additional display error messages and warnings to internal.
.TP
.SH BUGS
Problems and errors in the program are not known ;)