1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH FILEBENCH 1 "Oct 9, 2007"
   7 .SH NAME
   8 filebench \- framework of workloads to measure and compare filesystem
   9 performance
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/usr/benchmarks/filebench/bin/filebench\fR \fIprofile\fR
  14 .fi
  15 
  16 .LP
  17 .nf
  18 \fB/usr/benchmarks/filebench/bin/filebench\fR \fB-c\fR \fIstats_dir...\fR
  19 .fi
  20 
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 \fBfilebench\fR runs workloads to measure and compare filesystem performance.
  25 .sp
  26 .LP
  27 Full documentation can be found at the performance community at:
  28 http://www.opensolaris.org
  29 .SH OPTIONS
  30 .sp
  31 .LP
  32 The following options are supported:
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fB-c\fR \fIstats_dir...\fR\fR
  37 .ad
  38 .RS 19n
  39 Generates a HTML file (\fBindex.html\fR) that is a comparison of the specified
  40 directories. \fIstats_dir\fR specifies the directory or directories in which
  41 the results are stored.
  42 .RE
  43 
  44 .SH OPERANDS
  45 .sp
  46 .LP
  47 The following operands are supported:
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fIprofile\fR\fR
  52 .ad
  53 .RS 11n
  54 Specifies the name of the configuration file ending in \fB\&.prof\fR. The
  55 configuration file specifies:
  56 .RS +4
  57 .TP
  58 .ie t \(bu
  59 .el o
  60 what workloads to run,
  61 .RE
  62 .RS +4
  63 .TP
  64 .ie t \(bu
  65 .el o
  66 what parameters to run,
  67 .RE
  68 .RS +4
  69 .TP
  70 .ie t \(bu
  71 .el o
  72 the directory path on which to operate, and
  73 .RE
  74 .RS +4
  75 .TP
  76 .ie t \(bu
  77 .el o
  78 the directory path in which to store the results.
  79 .RE
  80 .RE
  81 
  82 .SH EXIT STATUS
  83 .sp
  84 .LP
  85 The following exit values are returned:
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB0\fR\fR
  90 .ad
  91 .RS 5n
  92 Successful completion.
  93 .RE
  94 
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fB1\fR\fR
  99 .ad
 100 .RS 5n
 101 An error occurred.
 102 .RE
 103 
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fB2\fR\fR
 108 .ad
 109 .RS 5n
 110 Invalid command line options were specified.
 111 .RE
 112 
 113 .SH EXAMPLES
 114 .LP
 115 \fBExample 1 \fRRunning the Multi-stream Sequential Read Workload
 116 .sp
 117 .LP
 118 The following example runs the workloads described in the configuration file
 119 named \fBsqread.prof\fR:
 120 
 121 .sp
 122 .in +2
 123 .nf
 124 # filebench sqread
 125 .fi
 126 .in -2
 127 .sp
 128 
 129 .LP
 130 \fBExample 2 \fRComparing Multiple Runs
 131 .sp
 132 .LP
 133 The following example compares the results of two previous runs.
 134 
 135 .sp
 136 .LP
 137 This example assumes that the results from the two previous \fBfilebench\fR
 138 runs were located in the directories:
 139 \fB/stats/wombat-zfs-noel-Jun_27_2007-15h_45m_33s\fR and
 140 \fB/stats/wombat-ufs-noel-Jun_27_2007-15h_52m_11s\fR.
 141 
 142 .sp
 143 .LP
 144 This example generates a HTML file named \fBindex.html\fR in your current
 145 working directory.
 146 
 147 .sp
 148 .in +2
 149 .nf
 150 # filebench -c /stats/wombat-zfs-noel-Jun_27_2007-15h_45m_33s \e
 151       /stats/wombat-ufs-noel-Jun_27_2007-15h_52m_11s
 152 .fi
 153 .in -2
 154 .sp
 155 
 156 .SH ATTRIBUTES
 157 .sp
 158 .LP
 159 See \fBattributes\fR(5) for descriptions of the following attributes:
 160 .sp
 161 
 162 .sp
 163 .TS
 164 box;
 165 c | c
 166 l | l .
 167 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 168 _
 169 Interface Stability     Uncommitted
 170 .TE
 171 
 172 .SH SEE ALSO
 173 .sp
 174 .LP
 175 \fBattributes\fR(5)