example man page created with ronn

exam.1

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "EXAM" "1" "May 2012" "" ""
.
.SH "NAME"
\fBexam\fR \- display exam grades
.
.SH "SYNOPSIS"
\fBexam\fR [\fB\-list\fR] \fIexam\-name\fR
.
.P
\fBexam \-plot\fR \fIexam\-name\fR \fB| jgraph \-P | gv \-\fR
.
.P
\fBexam \-dist\fR [\fB\-minima\fR] [\fB\-sigma\fR \fIsigma\fR] \fIexam\-name\fR \fB| jgraph \-P | gv \-\fR
.
.P
\fBexam \-dist \-land\fR [\fB\-minima\fR] [\fB\-sigma\fR \fIsigma\fR] \fIexam\-name\fR \fB| jgraph \-P \-L | gv \-\fR
.
.P
\fBexam \-fit\fR [\fB\-upto\fR \fIassignment\-name\fR] \fIexam\-name\fR
.
.P
\fBexam \-pfit\fR [\fB\-upto\fR \fIassignment\-name\fR] \fIexam\-name\fR \fB| jgraph \-P | gv \-\fR
.
.SH "DESCRIPTION"
Displays exam grades five ways:
.
.IP "\(bu" 4
Sorted list of totals
.
.IP "\(bu" 4
Plot with one Tukey box per problem
.
.IP "\(bu" 4
Histogram (aka "distribution)
.
.IP "\(bu" 4
Linear\-regression fit to homework grades
.
.IP "\(bu" 4
Linear\-regression fit to homework grades (plotted)
.
.IP "" 0
.
.P
A typical \fIexam\-name\fR would be \fBmidterm\fR or \fBfinal\fR\.
.
.SH "OPTIONS"
.
.IP "\(bu" 4
\fB\-list\fR List the grades from high to low\.
.
.IP "\(bu" 4
\fB\-plot\fR Plot a Tukey box showing the distribution of point totals for each problem on the exam, emitting code for consumption by jgraph(1)\.
.
.IP "\(bu" 4
\fB\-dist\fR Plot a smoothed histogram (distribution) of the raw scores on the exam, emitting code for consumption by jgraph(1)\.
.
.IP "\(bu" 4
\fB\-sigma\fR \fInumber\fR Give the estimated deviation, in points, of an actual graded point total from the "true" ideal total for that exam\. This number is used to smooth the histogram, and useful values tend to range from 1\.5 to 3 points\.
.
.IP "\(bu" 4
\fB\-minima\fR On a histogram, display local minima\.
.
.IP "\(bu" 4
\fB\-land\fR Give jgraph(1) plot dimensions suited to a landscape plot
.
.IP "\(bu" 4
\fB\-fit\fR Compute a least\-squares fit indicating how many "homework points" correspond to a single exam point, and what homework grade best corresponds to a blank final\. This data can be entered into the book\.lua(5) file, where it is used to compute final course averages using commensurate units\.
.
.IP "\(bu" 4
\fB\-pfit\fR Emit, for consumption by jgraph(1), a scatterplot showing the least\-squares fit computed by the \fB\-fit\fR option\.
.
.IP "\(bu" 4
\fB\-upto\fR \fIassignment\-name\fR When computing a fit, use only the assigmments up to and including the named assignment\.
.
.IP "" 0
.
.SH "SEE ALSO"
jgraph(1), book\.lua(5), courseware(7)