Add a change log and a man page

Joao Eriberto Mota Filho contributed the change log and man page.
This commit is contained in:
Michel Machado 2014-05-14 10:34:44 -04:00
parent a41f4a0c08
commit 1c50c85a4d
3 changed files with 110 additions and 0 deletions

12
README
View File

@ -19,3 +19,15 @@ Please replace "/media/5EBD-5C80/" with the appropriate path.
USB devices are mounted in "/Volumes" on Macs.
### For more information see http://oss.digirati.com.br/f3/
### Files
changelog - Change log for package maintainers.
f3read.1 - Man page for f3read and f3write.
In order to read run 'man ./f3read.1', and to install run
'install --owner=root --group=root --mode=644 f3read.1 /usr/share/man/man1'.
LICENSE - GPLv3.
Makefile - make(1) file.
README - This file.
*.h and *.c - C Code for f3write and f3read.

51
changelog Normal file
View File

@ -0,0 +1,51 @@
***
*** CHANGELOG. PLEASE, SEE /usr/share/doc/f3/README.source.
***
Version 2.2 - Feb 8, 2013
* add option parameter --start-at=NUM to F3.
* remove arbitrary limit on filenames.
* fix bug first reported by Martin Theiss.
* minor code refinements.
Version 2.1 - Mar 7, 2012
* report version and copyright in help message.
* made f3write remove old F3 files in order.
* refined flow control algorithm of f3write.
* verify that "all" F3 files are present.
* added a rough approximation of posix_fadvise for Macs.
Version 2.0 - Dec 20, 2011
* added a very simple Makefile.
* reviewed code.
* added support for Macs.
* f3write now reports proper progress.
* added progress printout in f3read.
* improved precision of speed measurements.
* formated code following Linux's coding style.
Version 1.1.3 - Sep 21, 2010
* fixes some warning issued by GCC when compiling f3read.c on 64bits
machines. Nicolai Abruzzese was the first one to report this issue.
Version 1.1.2 - Aug 31, 2010
* handles an I/O error reported by Misha Aizatulin.
Version 1.1.1 - Aug 16, 2010
* fixes some warnings issued by gcc when the parameter -Wall is used
to compile the source.
Version 1.1 - Aug 10, 2010
* adds a nice report at the end of the output of f3read.
* works fine with large memory cards.
Version 1.0 - Aug 02, 2010
* Initial release.

47
f3read.1 Normal file
View File

@ -0,0 +1,47 @@
.\"Text automatically generated by txt2man
.TH F3 "1" "May 2013" "F3 2.2" "test real flash memory capacity"
.SH NAME
\fBf3write, f3read \fP- test real flash memory capacity
.SH SYNOPSIS
.nf
.fam C
\fBf3write\fP [\fB--start-at\fP=NUM] <PATH>
\fBf3read\fP [\fB--start-at\fP=NUM] <PATH>
.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
F3 (Fight Flash Fraud or Fight Fake Flash) tests the full capacity
of a flash card (flash drive, flash disk, pendrive). It writes to the
card and then checks if can read it. It will assure you haven't been
sold a card with a smaller capacity than stated.
.PP
When writing to flash drive, \fBf3write\fP fills the filesystem with 1GB
files named N.fff, where N is a number (i.e. /[0-9]+/).
.PP
WARNING: all data on the tested disk might be lost!
.SH OPTIONS
.TP
.B
\fB--start-at\fP=NUM
Initial number to files names. Default value is 1.
.SH EXAMPLE
To write over a flash drive mounted at /media/TEST:
.PP
.nf
.fam C
$ f3write /media/TEST
.fam T
.fi
To read this flash drive:
.PP
.nf
.fam C
$ f3read /media/TEST
.fam T
.fi
.SH AUTHOR
F3 was written by Michel Machado <michel@digirati.com.br>.
This manual page was written by Joao Eriberto Mota Filho <eriberto@eriberto.pro.br>.