shared-macros.mk: simplify java settings
[oi-userland.git] / components / sysutils / filebench / filebench.1
blob7b1dc83838b5079239ee055972f24428e6f73c59
1 '\" te
2 .\" Based on man page by Hushan Jia
3 .\" https://bugzilla.redhat.com/show_bug.cgi?id=733179
4 .\" 
5 .TH filebench 1  "Sep 1, 2011" "revision 01" "USER COMMANDS"
6 .SH NAME
7 filebench \- interprets WML script and generates apporpriate filesystem workload
8 .SH SYNOPSIS
9 .B /usr/benchmarks/filebench/bin/filebench [-f <filename>] [-h]
10 .SH DESCRIPTION
11 .B Filebench
12 is a file system and storage benchmark that allows to generate a large variety of workloads. Unlike typical benchmarks it is very flexible and allows to minutely specify (any) applications' behaviour using extensive Workload Model Language (WML). Filebench uses loadable workload personalities to allow easy emulation of complex applications (e.g., mail, web, file, and database servers). Filebench is quick to set up and easy to use compared to deploying real applications. It is also a handy tool for micro-benchmarking.
13 .PP
14 .B Filebench
15 includes many features to facilitate file system benchmarking:
16 .IP \[bu] 2
17 Multiple workload types support via loadable personalities
18 .IP \[bu]
19 Ships with more than 40 pre-defined personalities, including the one that describe mail, web, file, and database servers behaviour
20 .IP \[bu]
21 Easy to add new personalities using reach Workload Model Language (WML)
22 .IP \[bu]
23 Multi-process and multi-thread workload support
24 .IP \[bu]
25 Configurable directory hierarchies with depth, width, and file sizes set to given statistical distributions
26 .IP \[bu]
27 Support of asynchronous I/O and process synchronization primitives
28 .IP \[bu]
29 Integrated statistics for throughput, latency, and CPU cycle counts per system call 
31 .SH OPTIONS
32 .TP
33 \-f <filename>
34 use specified file as an input instead of stdin
35 .TP
36 \-h
37 Display verbose help
38 .SH EXAMPLES
39 .TP
40 Run filebench interactively:
41 .TP
42 .B $ /usr/benchmarks/filebench/bin/filebench
43 Start filebench interactive shell, filebench prompt will appear after that.
44 .TP
45 .B filebench> load fileserver
46 Load fileserver personality using load command.
47 .TP
48 .B filebench> set $dir=/mnt
49 After personality is loaded, tunables of the workload personality can be set. Here we change the benchmark directory to /mnt where the file system we want to benchmark is presumably mounted.
50 .TP
51 .B filebench> run 60
52 Start workload for 60 seconds. After 60 seconds of the run the statistics is printed and Filebench exits.
53 .TP
54 Run filebench non-interactively:
55 .TP
56 .B filebench -f /usr/share/filebench/workloads/fileserver.f
57 Run filebench non-interactively, however, you need to add 'run <time>' to the end of the workload personality file before calling filebench.
58 .PP
59 .SH EXIT STATUS
60 .TP
61 0 if OK,
62 .TP
63 1 An error occured