TheCloud/f3
1
0
Fork 0
mirror of https://github.com/AltraMayor/f3.git synced 2025-09-15 10:07:26 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #64 from anarcat/patch-1

Browse Source 
README improvements
This commit is contained in:
Michel Machado 2017-07-19 11:46:33 -04:00 committed by GitHub
commit 6450f07bdf
1 changed files with 49 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
README.md
View File

@ -1,3 +1,50 @@
# f3 - Fight Flash Fraud
f3 is a simple tool that tests flash cards capacity and performance to see if they live up to claimed specifications.
For more information see http://oss.digirati.com.br/f3/
**Table of Contents**
- [Examples](#examples)
- [Installation](#installation)
- [Other resources](#other-resources)
# Examples
## Testing performance with f3read/f3write
Use these two programs in this order. f3write will write large files to your mounted disk and f3read will check if the flash disk contains exactly the written files.
```
$ ./f3write /media/michel/5EBD-5C80/
$ ./f3read /media/michel/5EBD-5C80/
```
Please replace "/media/michel/5EBD-5C80/" with the appropriate path.
USB devices are mounted in "/Volumes" on Macs.
If you have installed f3read and f3write, you can remove the "./"
that is shown before their names.
## Quick capacity tests with f3probe
f3probe is the fastest drive test and suitable for large disks because it only writes what's necessary to test the drive. It operates directly on the (unmounted) block device and needs to be run as a privileged user.
**Warning**: This will destroy any previously stored data on your disk!
```
# ./f3probe --destructive --time-ops /dev/sdb
```
## Correcting capacity to actual size with f3fix
f3fix creates a partition that fits the actual size of the fake drive. Use f3probe's output to determine the parameters for i3fix.
```
# ./f3fix --last-sec=16477878 /dev/sdb
```
# Installation
## Compile stable software on Linux or FreeBSD
```
@ -132,39 +179,7 @@ If you want to install the extra applications, run the following command:
make install-extra
```
## Use examples
For more information see http://oss.digirati.com.br/f3/
### Example for f3write/f3read
Use these two programs in this order. f3write will write large files to your mounted disk and f3read will check if the flash disk contains exactly the written files.
```
$ ./f3write /media/michel/5EBD-5C80/
$ ./f3read /media/michel/5EBD-5C80/
```
Please replace "/media/michel/5EBD-5C80/" with the appropriate path.
USB devices are mounted in "/Volumes" on Macs.
If you have installed f3read and f3write, you can remove the "./"
that is shown before their names.
### Example for f3probe
f3probe is the fastest drive test and suitable for large disks because it only writes what's necessary to test the drive. It operates directly on the (unmounted) block device and needs to be run as a privileged user.
**Warning**: This will destroy any previously stored data on your disk!
```
# ./f3probe --destructive --time-ops /dev/sdb
```
### Example for f3fix
f3fix creates a partition that fits the actual size of the fake drive. Use f3probe's output to determine the parameters for i3fix.
```
# ./f3fix --last-sec=16477878 /dev/sdb
```
# Other resources
## Files
@ -178,7 +193,7 @@ f3fix creates a partition that fits the actual size of the fake drive. Use f3pro
README - This file
*.h and *.c - C code of F3
### Bash scripts
## Bash scripts
Although the simple scripts listed in this section are ready for use,
they are really meant to help you to write your own scripts.