Add --section command line option

[fio.git] / README

diff --git a/README b/README
index 940839c3892a354da5332b1234dca4d914e1b473..0b0cb7ef049a2686699cac067c42a2e0818e3d94 100644 (file)
--- a/README
+++ b/README
@@ -64,7 +64,7 @@ Command line
 $ fio
         --debug         Enable some debugging options (see below)
         --output        Write output to file
 $ fio
         --debug         Enable some debugging options (see below)
         --output        Write output to file

-        --runtime       Runtime in seconds
+        --timeout       Runtime in seconds

         --latency-log   Generate per-job latency logs
         --bandwidth-log Generate per-job bandwidth logs
         --minimal       Minimal (terse) output
         --latency-log   Generate per-job latency logs
         --bandwidth-log Generate per-job bandwidth logs
         --minimal       Minimal (terse) output


@@ -72,9 +72,10 @@ $ fio
        --help          Print this page
        --cmdhelp=cmd   Print command help, "all" for all of them
        --showcmd       Turn a job file into command line options
        --help          Print this page
        --cmdhelp=cmd   Print command help, "all" for all of them
        --showcmd       Turn a job file into command line options

-       --readonly      Turn on safety read-only checks
+       --readonly      Turn on safety read-only checks, preventing writes

        --eta=when      When ETA estimate should be printed
                        May be "always", "never" or "auto"
        --eta=when      When ETA estimate should be printed
                        May be "always", "never" or "auto"

+       --section=name  Only run specified section in job file

 
 
 Any parameters following the options will be assumed to be job files,
 
 
 Any parameters following the options will be assumed to be job files,


@@ -103,6 +104,13 @@ options in fio. Currently the options are:
 You can specify as many as you want, eg --debug=file,mem will enable
 file and memory debugging.
 
 You can specify as many as you want, eg --debug=file,mem will enable
 file and memory debugging.
 

+The section switch is meant to make it easier to ship a bigger job file
+instead of several smaller ones. Say you define a job file with light,
+moderate, and heavy parts. Then you can ask fio to run the given part
+only by giving it a --section=heavy command line option. The section
+option only applies to job sections, the reserved 'global' section is
+always parsed and taken into account.
+

 
 Job file
 --------
 
 Job file
 --------