~ubuntu-branches/ubuntu/dapper/sg3-utils/dapper-backports

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
.TH SG_SYNC "8" "June 2006" "sg3_utils-1.21" SG3_UTILS
.SH NAME
sg_sync \- send the scsi command synchronize cache
.SH SYNOPSIS
.B sg_sync
[\fI--count=<n>\fR] [\fI--group=<n>\fR] [\fI--help\fR] [\fI--immed\fR]
[\fI--lba=<n>\fR] [\fI--sync-nv\fR] [\fI--verbose\fR] [\fI--version\fR]
\fI<scsi_device>\fR
.SH DESCRIPTION
.\" Add any additional description here
.PP
Send SYNCHRONIZE CACHE (10) command to a Linux SCSI device.
This command is defined for SCSI block devices (see SBC-2). If successful
this command makes sure that any blocks whose latest versions are held
in (volatile) cache are written to (also termed as "synchronized with")
the medium. If the '--sync-nv' option is given and the device has a
non-volatile cache then any blocks whose latest versions are held
in volatile cache are written to non-volatile cache.
.PP
If the arguments to '--lba' and '--count' are both zero (their defaults)
then all blocks in the cache are synchronized. If '--lba' is greater than
zero while '--count' is zero then blocks in the cache whose address
is from and including the '--lba' argument to the highest lba on the
device are synchronized. If both '--lba' and '--count' are non zero
then blocks in the cache whose addresses lie in the range lba_argument to 
lba_argument+count_argument-1 inclusive are synchronized with the medium.
.TP
--count=<n> | -c <n>
number of block to synchronize from and including the '--lba' argument.
Default value is 0. When 0 then all blocks in the (volatile) cache from
and including the '--lba' argument to the highest block address are
synchronized.
.TP
--group=<n> | -g <n>
the group number can be between 0 and 31 inclusive. The default value is 0 .
Group numbers are used to segregate data collected within the device.
This is a new feature in SBC-2 and can probably be ignored for the time
being.
.TP
--help | -h
output the usage message then exit.
.TP
--imm | -i
sets the "imm" bit in the SYNCHRONIZE CACHE command. This instructs the
device, if the format of the command is acceptable, to return a GOOD
status immediately rather than wait for the blocks in the (volatile)
cache to be synchronized with (i.e. written to) the medium (or the
non-volatile cache).
.TP
--lba=<n> | -l <n>
the lowest logical block address in the (volatile) cache to synchronize
to the medium (or the non-volatile cache). Default value is 0 .
.TP
--sync-nv | -s
synchronize the (volatile) cache with the non-volatile cache. Without this
option (or if there is no non-volatile cache in the device) the synchronization
is with the medium.
.TP
--verbose | -v
increase the level of verbosity, (i.e. debug output).
.TP
--version | -V
print the version string and then exit.
.PP
The arguments to --count, --group and --lba may be followed by one of these
multiplicative suffixes:
c C *1; w W *2; b B *512; k K KiB *1,024; KB *1,000; m M MiB *1,048,576;
MB *1,000,000 . This pattern continues for "G", "T" and "P". Also a suffix of
the form "x<n>" multiplies the leading number by <n>. The "T" and "P"
suffixes can only be used for --count and --lba.
.PP
Alternatively numerical values can be given in hexadecimal preceded by
either "0x" or "0X" (or with a trailing "h" or "H"). When hex numbers are
given, multipliers cannot be used.
.SH EXIT STATUS
The exit status of sg_sync is 0 when it is successful. Otherwise see
the sg3_utils(8) man page.
.SH AUTHORS
Written by Douglas Gilbert.
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
Copyright \(co 2004-2006 Douglas Gilbert
.br
This software is distributed under a FreeBSD license. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH "SEE ALSO"
.B sg_start(sg3_utils)