diff --git a/man/Makefile.am b/man/Makefile.am index 9689c7e7..bba78c4b 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -28,6 +28,7 @@ dist_man_MANS = \ mu-mkdir.1 \ mu-remove.1 \ mu-server.1 \ + mu-stats.1 \ mu-verify.1 \ mu-view.1 \ mu.1 \ diff --git a/man/mu-stats.1 b/man/mu-stats.1 new file mode 100644 index 00000000..b8a63c08 --- /dev/null +++ b/man/mu-stats.1 @@ -0,0 +1,51 @@ +.TH MU VERIFY 1 "October 2012" "User Manuals" + +.SH NAME + +mu stats\- run statistic on the mu database + +.SH SYNOPSIS + +.B mu stats [options] --stat=|--list [] + +.SH DESCRIPTION + +\fBmu stats\fR is the \fBmu\fR command to get statistics from the \fBmu\fR +database. The statistics are implement in the Guile programming language, and +thus only work if your \fBmu\fR is built with support for Guile. In addition, +you need to have \fBgnuplot\fR installed. + +.SH OPTIONS + +.TP +\fB\-\-list\fR +list the available statistics + +\fB\-\-stat=\fR\fI\fR +run the given statistic; \fB--list\fR shows the available statistics + +\fB\-\-textonly\fR +show the statistics in text-only format, even if the environment is +capable of graphics. + +\fB\-\-muhome\fR +causes \fBmu\fR to use an alternative directory to +store and read its database and logs. By default, \fI~/.mu\fR is used. + +.SH RETURN VALUE + +\fBmu stats\fR returns 0 when all went well, and returns some non-zero error +code when this is not the case. + +.SH BUGS + +Please report bugs if you find them: +.BR http://code.google.com/p/mu0/issues/list + +.SH AUTHOR + +Dirk-Jan C. Binnema + +.SH "SEE ALSO" + +.BR mu(1)