'\" te
.\" Copyright (c) 2007, 2013, Oracle and/or its affiliates. All rights
.\"  reserved.
.TH filebench 1 "19 Nov 2013" "SunOS 5.11" "User Commands"
.SH NAME
filebench \- framework of workloads to measure and compare filesystem performance
.SH SYNOPSIS
.LP
.nf
\fB/usr/benchmarks/filebench/bin/filebench\fR \fIprofile\fR
.fi

.LP
.nf
\fB/usr/benchmarks/filebench/bin/filebench\fR \fB-c\fR \fIstats_dir...\fR
.fi

.SH DESCRIPTION
.sp
.LP
\fBfilebench\fR runs workloads to measure and compare filesystem performance.
.sp
.LP
Full documentation can be found at the performance community at: http://solaris.java.net/
.SH OPTIONS
.sp
.LP
The following options are supported:
.sp
.ne 2
.mk
.na
\fB\fB-c\fR \fIstats_dir...\fR\fR
.ad
.RS 19n
.rt  
Generates a HTML file (\fBindex.html\fR) that is a comparison of the specified directories. \fIstats_dir\fR specifies the directory or directories in which the results are stored. 
.RE

.SH OPERANDS
.sp
.LP
The following operands are supported:
.sp
.ne 2
.mk
.na
\fB\fIprofile\fR\fR
.ad
.RS 11n
.rt  
Specifies the name of the configuration file ending in \fB\&.prof\fR. The configuration file specifies:
.RS +4
.TP
.ie t \(bu
.el o
what workloads to run,
.RE
.RS +4
.TP
.ie t \(bu
.el o
what parameters to run,
.RE
.RS +4
.TP
.ie t \(bu
.el o
the directory path on which to operate, and
.RE
.RS +4
.TP
.ie t \(bu
.el o
the directory path in which to store the results.
.RE
.RE

.SH EXIT STATUS
.sp
.LP
The following exit values are returned:
.sp
.ne 2
.mk
.na
\fB\fB0\fR\fR
.ad
.RS 5n
.rt  
Successful completion.
.RE

.sp
.ne 2
.mk
.na
\fB\fB1\fR\fR
.ad
.RS 5n
.rt  
An error occurred.
.RE

.sp
.ne 2
.mk
.na
\fB\fB2\fR\fR
.ad
.RS 5n
.rt  
Invalid command line options were specified.
.RE

.SH EXAMPLES
.LP
\fBExample 1 \fRRunning the Multi-stream Sequential Read Workload
.sp
.LP
The following example runs the workloads described in the configuration file named \fBsqread.prof\fR:

.sp
.in +2
.nf
# filebench sqread
.fi
.in -2
.sp

.LP
\fBExample 2 \fRComparing Multiple Runs
.sp
.LP
The following example compares the results of two previous runs.

.sp
.LP
This example assumes that the results from the two previous \fBfilebench\fR runs were located in the directories: \fB/stats/wombat-zfs-noel-Jun_27_2007-15h_45m_33s\fR and \fB/stats/wombat-ufs-noel-Jun_27_2007-15h_52m_11s\fR. 

.sp
.LP
This example generates a HTML file named \fBindex.html\fR in your current working directory.

.sp
.in +2
.nf
# filebench -c /stats/wombat-zfs-noel-Jun_27_2007-15h_45m_33s \e

      /stats/wombat-ufs-noel-Jun_27_2007-15h_52m_11s
.fi
.in -2
.sp

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Availabilitybenchmark/filebench
_
Interface StabilityUncommitted
.TE

.SH SEE ALSO
.sp
.LP
\fBattributes\fR(5)