From 67445b63a656accaff67a86f9374ed488ea34375 Mon Sep 17 00:00:00 2001 From: Jens Axboe Date: Wed, 12 Mar 2014 10:49:36 -0600 Subject: [PATCH] Update documentation for filename/directory Sync the HOWTO and man page, and add a reference from 'directory' to 'filename' on how to escape certain characters. Signed-off-by: Jens Axboe --- HOWTO | 3 ++- fio.1 | 11 +++++++++-- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/HOWTO b/HOWTO index 9a9f02a7..725214fb 100644 --- a/HOWTO +++ b/HOWTO @@ -262,7 +262,8 @@ description=str Text description of the job. Doesn't do anything except not parsed. directory=str Prefix filenames with this directory. Used to place files - in a different location than "./". + in a different location than "./". See the 'filename' option + for escaping certain characters. filename=str Fio normally makes up a filename based on the job name, thread number, and file number. If you want to share diff --git a/fio.1 b/fio.1 index 764e323a..2dee56b5 100644 --- a/fio.1 +++ b/fio.1 @@ -166,7 +166,9 @@ character. These directories will be assigned equally distributed to job clones creates with \fInumjobs\fR as long as they are using generated filenames. If specific \fIfilename(s)\fR are set fio will use the first listed directory, and thereby matching the \fIfilename\fR semantic which generates a file each -clone if not specified, but let all clones use the same if set. +clone if not specified, but let all clones use the same if set. See +\fIfilename\fR for considerations regarding escaping certain characters on +some platforms. .TP .BI filename \fR=\fPstr .B fio @@ -176,7 +178,12 @@ specify a \fIfilename\fR for each of them to override the default. If the I/O engine is file-based, you can specify a number of files by separating the names with a `:' character. `\-' is a reserved name, meaning stdin or stdout, depending on the read/write direction -set. +set. On Windows, disk devices are accessed as \\.\PhysicalDrive0 for the first +device, \\.\PhysicalDrive1 for the second etc. Note: Windows and FreeBSD +prevent write access to areas of the disk containing in-use data +(e.g. filesystems). If the wanted filename does need to include a colon, then +escape that with a '\' character. For instance, if the filename is +"/dev/dsk/foo@3,0:c", then you would use filename="/dev/dsk/foo@3,0\:c". .TP .BI filename_format \fR=\fPstr If sharing multiple files between jobs, it is usually necessary to have -- 2.25.1