FBWF Manager
5/10/2007
The FBWF Manager is a command-line tool for embedded developing to quickly integrate and prototype the FBWF. FBWF Manager is intended primarily for design time use, but can also be used to configure FBWF at run time.
FBWF Manager Command Line Syntax
The FBWF Manager command-line syntax follows:
fbwfmgr [/? | /help /[switch] | /displayconfig | /overlaydetail | /enable | /disable | /addvolume [volumename] | /removevolume [volumename] [1|0] |
/addexclusion [volumename] [file or directory path] | /removeexclusion [volumename] [file or directory path] |
/setthreshold [threshold] | /setcompression [1|0] | /setpreallocation [1|0] | /commit [volumename] [file path] | /restore [volumename] [file path] | /setsizedisplay [1|0] | /getvirtualsize [volumename] | /getactualsize [volumename] ]
The following table describes the command-line switches.
| Switch | Description |
|---|---|
? |
Displays usage and help. |
addexclusion |
Adds a write-through path to the exclusion list for next boot. The volumename can either be a case-insensitive volume device name (for example, \Device\HarddiskVolume1), or a drive letter (for example, C: or D:). Note that the name is not the volume label that Windows Explorer displays before the drive letter. The file or directory path must be an absolute path starting with "\". |
addvolume |
Adds a volume to the protected volume list for the next boot. |
commit |
Commits the changes made to the file to the underlying media. The volumename can either be a case-insensitive volume device name (for example, \Device\HarddiskVolume1), or a drive letter (for example, C: or D:). Note that the name is not the volume label that Windows Explorer displays before the drive letter. The file path must be an absolute path starting with "\". Note that the volume must currently be protected. Otherwise, the error message "The system cannot find the drive specified." is displayed. |
disable |
Disables the write filter on the next restart. |
displayconfig |
Displays all configuration information for the write filter including protected volumes list, overlay configuration and write-through paths. The command returns: State—Indicating current filter state (enable or disable) and state for the next boot. Protected Volumes—List of protected volumes including the current and the next boot state. Compression—Current and next boot state for cache compression. Threshold—Current and next boot values for the overlay cache threshold. Write-Through Paths—Displays a complete list of active and next boot write-through paths. Pre-allocation Status—Displays current and next boot status for cache pre-allocation. |
enable |
Enables the write filter on the next restart. |
getactualsize |
Displays the actual volume disk size information. |
getvirtualsize |
Displays the virtual volume disk size information. |
help / [switch] |
Displays help information for a specific FBWF Manager switch. |
overlaydetail |
Displays details on the current overlay contents for all protected volumes. The command returns: Contents—Files and folders currently in the overlay for all protected volumes including sizes (size of data in overlay) and open file handles. Memory Usage—Total amount of memory being consumed by the overlay. |
removeexclusion |
Removes a write-through path from the exclusion list for next boot. The volumename can either be a case-insensitive volume device name (for example, \Device\HarddiskVolume1), or a drive letter (for example, C: or D:). Note that the name is not the volume label that Windows Explorer displays before the drive letter. The file or directory path must be an absolute path starting with "\". |
removevolume |
Removes a volume from the protected volume list for next boot, and either preserves the exclusion list (0) or removes it (1). |
restore |
Discards the changes made to the file, that is, restores the files to its original contents from the underlying media. The volumename can either be a case-insensitive volume device name (for example, "\Device\HarddiskVolume1"), or a drive letter (for example, "C:" or "D:"). Note that the name is not the volume label that Windows Explorer displays before the drive letter. The file path must be an absolute path starting with "\". It is acceptable that the file was deleted, in which case it is recovered. Note that the volume must currently be protected. Otherwise, the error message "The system cannot find the drive specified." is displayed. |
setcompression |
Sets overlay compression as enabled (1) or disabled (0) for the next boot. |
setpreallocation |
Sets cache pre-allocation as enabled (1) or disabled (0) for the next boot. |
setsizedisplay |
Sets the size display mode to either virtual (1) or actual (0). The new mode takes effect after the next reboot. |
setthreshold |
Sets the overlay threshold value for the next boot. The input field threshold is the overlay threshold in MB. |
If no switch is provided, the FBWF Manager displays all the configuration information, just like the DisplayConfig switch.
For comprehensive management and configuration of devices in the field, FBWF APIs are provided.
FBWF does not resolve substituted paths; use complete file names instead.
See Also
Concepts
Other Resources
Configuring FBWF at Run Time