mirror of
https://github.com/AltraMayor/f3.git
synced 2025-08-04 02:55:57 -04:00
split webpage in different documents
This commit is contained in:
Antoine Beaupré
parent
6a2591a463
commit
d0523b7d5f
31
README.rst
31
README.rst
@ -4,7 +4,7 @@ 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/
|
||||
F3 stands for Fight Flash Fraud, or Fight Fake Flash.
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
@ -12,6 +12,8 @@ For more information see http://oss.digirati.com.br/f3/
|
||||
- `Installation <#installation>`__
|
||||
- `Other resources <#other-resources>`__
|
||||
|
||||
.. _examples:
|
||||
|
||||
Examples
|
||||
========
|
||||
|
||||
@ -54,6 +56,16 @@ Use f3probe's output to determine the parameters for i3fix::
|
||||
Installation
|
||||
============
|
||||
|
||||
Download and Compile
|
||||
--------------------
|
||||
|
||||
The files of the stable version of F3 are
|
||||
`here <https://github.com/AltraMayor/f3/releases>`__. The
|
||||
following command uncompresses the files::
|
||||
|
||||
$ unzip f3-6.0.zip
|
||||
|
||||
|
||||
Compile stable software on Linux or FreeBSD
|
||||
-------------------------------------------
|
||||
|
||||
@ -190,6 +202,23 @@ command::
|
||||
Other resources
|
||||
===============
|
||||
|
||||
Graphical User Interfaces
|
||||
-------------------------
|
||||
|
||||
Thanks to our growing community of fraud fighters, we have a couple of
|
||||
graphical user interfaces (GUIs) available for F3:
|
||||
|
||||
`F3 QT <https://github.com/zwpwjwtz/f3-qt>`__ is a Linux GUI that uses
|
||||
QT. F3 QT supports ``f3write``, ``f3read``, and ``f3probe``. Author:
|
||||
Tianze.
|
||||
|
||||
`F3 X <https://github.com/insidegui/F3X>`__ is a OS X GUI that uses
|
||||
Cocoa. F3 X supports ``f3write`` and ``f3read``. Author: Guilherme
|
||||
Rambo.
|
||||
|
||||
Please support these projects testing and giving feedback to their
|
||||
authors. This will make their code improve as it has improved mine.
|
||||
|
||||
Files
|
||||
-----
|
||||
|
||||
|
||||
81
doc/contribute.rst
Normal file
81
doc/contribute.rst
Normal file
@ -0,0 +1,81 @@
|
||||
Contribute
|
||||
==========
|
||||
|
||||
Help wanted
|
||||
-----------
|
||||
|
||||
I maintain this project in my spare time, and I no longer have been able
|
||||
to answer all questions and address all feedback that I receive.
|
||||
Nevertheless, I still think that F3's users can stop flash
|
||||
counterfeiters, but I need a little bit of help to keep moving forward.
|
||||
How can you help?
|
||||
|
||||
- If F3 has helped you, consider signaling this to other users staring
|
||||
F3 on GitHub. The larger the number of stars a project has, the more
|
||||
confident new users are to try it out.
|
||||
- If you know a journalist, or are one, suggest to him or her writing
|
||||
an article about fake flash. The media has not been corvering this
|
||||
subject, and having more users aware that fake flash exists will make
|
||||
counterfeiters' life harder.
|
||||
- If you own fake flash, consider donating them to me. I've been
|
||||
working on ``f3probe`` to tell in a few seconds if a flash drive is
|
||||
fake or not. I expect that ``f3probe`` will be a game changer, but I
|
||||
lack a diverse set of fake flash samples to check my hypotheses.
|
||||
Before you mail me the card, e-mail me the output you got from
|
||||
``f3write``, ``f3read``, and (if possible) ``f3probe`` as well as the
|
||||
size the card was expected to be; I'm trying to amass a diverse set
|
||||
of fake flash, not necessarily a large number of them.
|
||||
- If you know how to use F3 well on your platform, write a blog entry
|
||||
about it, and let me know the link so I can post it on this page. You
|
||||
can also send me your name and e-mail to publish on this page as
|
||||
someone that can help other users of your platform.
|
||||
- (New) If you have a dual-boot machine with Windows and Linux, write a
|
||||
blog entry that compares h2testw, f3write/f3read, FakeFlashTest.exe,
|
||||
and f3probe. If you do this comparison, please send me the link to
|
||||
publish it on this page.
|
||||
- If you are able to test F3 on your platform, send me your name and
|
||||
e-mail, and I'll send to you a request to test new code when it is
|
||||
available on GitHub before I release it as stable to everyone. I only
|
||||
have Linux boxes, so other platforms are specially helpful.
|
||||
- If you are able to code, improve F3. I want to keep the code small to
|
||||
easily audit it, so focus on things that will either address a real
|
||||
need, for example, users' requests, or to simplify the code, or fix
|
||||
bugs, or make F3 work on a new platform, or improve the
|
||||
documentation. If you want, I can list your contact on this page as
|
||||
well, so people can reach out to you directly.
|
||||
- If you know how to code a graphic user interface, please create one
|
||||
for the platforms you can. This would increase the number of users
|
||||
that, in turn, would win ground againt the counterfeiters. I'll add a
|
||||
link to your application on this page.
|
||||
- Tell your frinds about F3, teach them how to use it, publish a video
|
||||
about F3, find ways to help me to better organize our efforts, spread
|
||||
the word, ask for your money back when you buy a fake drive, etc.
|
||||
|
||||
I've originally implemented F3 to address a personal need, but you have
|
||||
turned it into a great tool. Let's work closer to bring it to the next
|
||||
level!
|
||||
|
||||
Repository
|
||||
----------
|
||||
|
||||
The Git repository is kept `here <https://github.com/AltraMayor/f3>`__.
|
||||
|
||||
Author
|
||||
------
|
||||
|
||||
Michel Machado. E-mail me at michel at digirati dot com dot br.
|
||||
|
||||
Please try to figure out the solution for your question on your own, or
|
||||
ask for help from a nearby friend before you e-mail me. My spare time is
|
||||
very limited. For reporting bugs, requesting features, and making
|
||||
suggestions, open an issue on GitHub
|
||||
`here <https://github.com/AltraMayor/f3/issues>`__ to allow other users
|
||||
to help me.
|
||||
|
||||
Copyright and License
|
||||
---------------------
|
||||
|
||||
F3 is licensed under the `GNU General Public License (GPL) version
|
||||
3 <https://www.gnu.org/copyleft/gpl.html>`__.
|
||||
|
||||
Copyright (c) 2010 `Digirati <http://www.digirati.com.br/>`__.
|
||||
57
doc/history.rst
Normal file
57
doc/history.rst
Normal file
@ -0,0 +1,57 @@
|
||||
History
|
||||
=======
|
||||
|
||||
I started this project when I bought a 32GB microSDHC card for my
|
||||
Android phone back in 2010, and found out that this card always fails
|
||||
when one fills it up. Googling about this issue, I arrived at the blogs
|
||||
`Fight Flash Fraud <https://fightflashfraud.wordpress.com/>`__ and
|
||||
`SOSFakeFlash <https://sosfakeflash.wordpress.com/>`__, which recomend
|
||||
the software H2testw (see
|
||||
`here <https://fightflashfraud.wordpress.com/2008/11/24/h2testw-gold-standard-in-detecting-fake-capacity-flash/>`__
|
||||
or
|
||||
`here <https://sosfakeflash.wordpress.com/2008/09/02/h2testw-14-gold-standard-in-detecting-usb-counterfeit-drives/comment-page-3/#comment-9861>`__)
|
||||
to test flash memories.
|
||||
|
||||
I downloaded H2testw and found two issues with it: (1) it is for Windows
|
||||
only, and (2) it is not open source. However, its author, Harald
|
||||
Bögeholz, was kind enough to include a text file that explains what it
|
||||
does, and provided the pseudo random number generator used in H2testw.
|
||||
|
||||
F3 is my GPLv3 implementation of the algorithm of H2testw,
|
||||
and other tools that I have been implementing to speed up the
|
||||
identification of fake drives as well as making them usable:
|
||||
``f3probe``, ``f3fix``, and ``f3brew``. My implementation of H2testw,
|
||||
which I've broken into two applications named ``f3write`` and
|
||||
``f3read``, runs on Linux, Macs, Windows/Cygwin, and FreeBSD.
|
||||
``f3probe`` is the fastest way to identify fake drives and their real
|
||||
sizes. ``f3fix`` enables users to use the real capacity of fake drives
|
||||
without losing data. ``f3brew`` helps developers to infer how fake
|
||||
drives work. ``f3probe``, ``f3fix``, and ``f3brew`` currently runs only
|
||||
on Linux.
|
||||
|
||||
Change log
|
||||
----------
|
||||
|
||||
Starting at version 2.0, F3 supports the platform Mac. Mac users may
|
||||
want to check out Thijs Kuipers'
|
||||
`page <http://www.broes.nl/2012/08/verify-the-integrity-of-a-flash-sd-card-on-a-mac/>`__
|
||||
for help.
|
||||
|
||||
Starting at version 3.0, F3 supports the platform Windows/Cygwin, and
|
||||
adopts H2testw's file format. People interested in exchanging files
|
||||
between F3 and H2testw should read the `section <#comp_h2testw>`__ about
|
||||
it to understand the caveats.
|
||||
|
||||
Starting at version 4.0, F3 supports the platform FreeBSD. **Mac
|
||||
users:** Version 4.0 does not compile on Macs. The issue has been fixed
|
||||
on version 5.0.
|
||||
|
||||
Starting at version 5.0, F3 includes ``f3probe`` and ``f3fix`` as
|
||||
experimental, and for Linux only.
|
||||
|
||||
Starting at version 6.0, F3 includes ``f3brew`` as experimental, and for
|
||||
Linux only. Linux users may want to check out Vasiliy Kaygorodov's
|
||||
`page <https://serverissues.com/blog/2015/12/12/finding-out-chinese-flash-disk-slash-sdhc-card-real-size/>`__
|
||||
or Ahmed Essam's
|
||||
`page <http://ahmedspace.com/linux-how-to-fix-a-flash-memory-corrupting-files/>`__
|
||||
for help.
|
||||
@ -3,17 +3,18 @@
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to f3's documentation!
|
||||
==============================
|
||||
f3 - Fight Flash Fraud
|
||||
======================
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
introduction.rst
|
||||
webpage.rst
|
||||
|
||||
introduction
|
||||
usage
|
||||
history
|
||||
contribute
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
1
doc/introduction.rst
Symbolic link
1
doc/introduction.rst
Symbolic link
@ -0,0 +1 @@
|
||||
../README.rst
|
||||
@ -1,145 +1,5 @@
|
||||
F3 by Digirati
|
||||
|
||||
F3 - an alternative to h2testw
|
||||
==============================
|
||||
|
||||
I started this project when I bought a 32GB microSDHC card for my
|
||||
Android phone back in 2010, and found out that this card always fails
|
||||
when one fills it up. Googling about this issue, I arrived at the blogs
|
||||
`Fight Flash Fraud <https://fightflashfraud.wordpress.com/>`__ and
|
||||
`SOSFakeFlash <https://sosfakeflash.wordpress.com/>`__, which recomend
|
||||
the software H2testw (see
|
||||
`here <https://fightflashfraud.wordpress.com/2008/11/24/h2testw-gold-standard-in-detecting-fake-capacity-flash/>`__
|
||||
or
|
||||
`here <https://sosfakeflash.wordpress.com/2008/09/02/h2testw-14-gold-standard-in-detecting-usb-counterfeit-drives/comment-page-3/#comment-9861>`__)
|
||||
to test flash memories.
|
||||
|
||||
I downloaded H2testw and found two issues with it: (1) it is for Windows
|
||||
only, and (2) it is not open source. However, its author, Harald
|
||||
Bögeholz, was kind enough to include a text file that explains what it
|
||||
does, and provided the pseudo random number generator used in H2testw.
|
||||
|
||||
This page is about my GPLv3 implementation of the algorithm of H2testw,
|
||||
and other tools that I have been implementing to speed up the
|
||||
identification of fake drives as well as making them usable:
|
||||
``f3probe``, ``f3fix``, and ``f3brew``. My implementation of H2testw,
|
||||
which I've broken into two applications named ``f3write`` and
|
||||
``f3read``, runs on Linux, Macs, Windows/Cygwin, and FreeBSD.
|
||||
``f3probe`` is the fastest way to identify fake drives and their real
|
||||
sizes. ``f3fix`` enables users to use the real capacity of fake drives
|
||||
without losing data. ``f3brew`` helps developers to infer how fake
|
||||
drives work. ``f3probe``, ``f3fix``, and ``f3brew`` currently runs only
|
||||
on Linux.
|
||||
|
||||
F3 stands for Fight Flash Fraud, or Fight Fake Flash.
|
||||
|
||||
Help wanted
|
||||
-----------
|
||||
|
||||
I maintain this project in my spare time, and I no longer have been able
|
||||
to answer all questions and address all feedback that I receive.
|
||||
Nevertheless, I still think that F3's users can stop flash
|
||||
counterfeiters, but I need a little bit of help to keep moving forward.
|
||||
How can you help?
|
||||
|
||||
- If F3 has helped you, consider signaling this to other users staring
|
||||
F3 on GitHub. The larger the number of stars a project has, the more
|
||||
confident new users are to try it out.
|
||||
- If you know a journalist, or are one, suggest to him or her writing
|
||||
an article about fake flash. The media has not been corvering this
|
||||
subject, and having more users aware that fake flash exists will make
|
||||
counterfeiters' life harder.
|
||||
- If you own fake flash, consider donating them to me. I've been
|
||||
working on ``f3probe`` to tell in a few seconds if a flash drive is
|
||||
fake or not. I expect that ``f3probe`` will be a game changer, but I
|
||||
lack a diverse set of fake flash samples to check my hypotheses.
|
||||
Before you mail me the card, e-mail me the output you got from
|
||||
``f3write``, ``f3read``, and (if possible) ``f3probe`` as well as the
|
||||
size the card was expected to be; I'm trying to amass a diverse set
|
||||
of fake flash, not necessarily a large number of them.
|
||||
- If you know how to use F3 well on your platform, write a blog entry
|
||||
about it, and let me know the link so I can post it on this page. You
|
||||
can also send me your name and e-mail to publish on this page as
|
||||
someone that can help other users of your platform.
|
||||
- (New) If you have a dual-boot machine with Windows and Linux, write a
|
||||
blog entry that compares h2testw, f3write/f3read, FakeFlashTest.exe,
|
||||
and f3probe. If you do this comparison, please send me the link to
|
||||
publish it on this page.
|
||||
- If you are able to test F3 on your platform, send me your name and
|
||||
e-mail, and I'll send to you a request to test new code when it is
|
||||
available on GitHub before I release it as stable to everyone. I only
|
||||
have Linux boxes, so other platforms are specially helpful.
|
||||
- If you are able to code, improve F3. I want to keep the code small to
|
||||
easily audit it, so focus on things that will either address a real
|
||||
need, for example, users' requests, or to simplify the code, or fix
|
||||
bugs, or make F3 work on a new platform, or improve the
|
||||
documentation. If you want, I can list your contact on this page as
|
||||
well, so people can reach out to you directly.
|
||||
- If you know how to code a graphic user interface, please create one
|
||||
for the platforms you can. This would increase the number of users
|
||||
that, in turn, would win ground againt the counterfeiters. I'll add a
|
||||
link to your application on this page.
|
||||
- Tell your frinds about F3, teach them how to use it, publish a video
|
||||
about F3, find ways to help me to better organize our efforts, spread
|
||||
the word, ask for your money back when you buy a fake drive, etc.
|
||||
|
||||
I've originally implemented F3 to address a personal need, but you have
|
||||
turned it into a great tool. Let's work closer to bring it to the next
|
||||
level!
|
||||
|
||||
Graphical User Interfaces
|
||||
-------------------------
|
||||
|
||||
Thanks to our growing community of fraud fighters, we have a couple of
|
||||
graphical user interfaces (GUIs) available for F3:
|
||||
|
||||
`F3 QT <https://github.com/zwpwjwtz/f3-qt>`__ is a Linux GUI that uses
|
||||
QT. F3 QT supports ``f3write``, ``f3read``, and ``f3probe``. Author:
|
||||
Tianze.
|
||||
|
||||
`F3 X <https://github.com/insidegui/F3X>`__ is a OS X GUI that uses
|
||||
Cocoa. F3 X supports ``f3write`` and ``f3read``. Author: Guilherme
|
||||
Rambo.
|
||||
|
||||
Please support these projects testing and giving feedback to their
|
||||
authors. This will make their code improve as it has improved mine.
|
||||
|
||||
Download and Compile
|
||||
--------------------
|
||||
|
||||
The files of the stable version of F3 are
|
||||
`here <https://github.com/AltraMayor/f3/archive/v6.0.zip>`__. The
|
||||
command below uncompresses the files. Follow instructions in file
|
||||
README.md to compile it on your computer:
|
||||
|
||||
::
|
||||
|
||||
$ unzip f3-6.0.zip
|
||||
|
||||
|
||||
Starting at version 2.0, F3 supports the platform Mac. Mac users may
|
||||
want to check out Thijs Kuipers'
|
||||
`page <http://www.broes.nl/2012/08/verify-the-integrity-of-a-flash-sd-card-on-a-mac/>`__
|
||||
for help.
|
||||
|
||||
Starting at version 3.0, F3 supports the platform Windows/Cygwin, and
|
||||
adopts H2testw's file format. People interested in exchanging files
|
||||
between F3 and H2testw should read the `section <#comp_h2testw>`__ about
|
||||
it to understand the caveats.
|
||||
|
||||
Starting at version 4.0, F3 supports the platform FreeBSD. **Mac
|
||||
users:** Version 4.0 does not compile on Macs. The issue has been fixed
|
||||
on version 5.0.
|
||||
|
||||
Starting at version 5.0, F3 includes ``f3probe`` and ``f3fix`` as
|
||||
experimental, and for Linux only.
|
||||
|
||||
Starting at version 6.0, F3 includes ``f3brew`` as experimental, and for
|
||||
Linux only. Linux users may want to check out Vasiliy Kaygorodov's
|
||||
`page <https://serverissues.com/blog/2015/12/12/finding-out-chinese-flash-disk-slash-sdhc-card-real-size/>`__
|
||||
or Ahmed Essam's
|
||||
`page <http://ahmedspace.com/linux-how-to-fix-a-flash-memory-corrupting-files/>`__
|
||||
for help.
|
||||
Usage
|
||||
=====
|
||||
|
||||
How to use f3write and f3read
|
||||
-----------------------------
|
||||
@ -953,28 +813,3 @@ However, if the corrupeted sectors persist, the drive is junk because
|
||||
not only is it a fake drive, but its real memory is already failing.
|
||||
|
||||
Good luck!
|
||||
|
||||
Repository
|
||||
----------
|
||||
|
||||
The Git repository is kept `here <https://github.com/AltraMayor/f3>`__.
|
||||
|
||||
Author
|
||||
------
|
||||
|
||||
Michel Machado. E-mail me at michel at digirati dot com dot br.
|
||||
|
||||
Please try to figure out the solution for your question on your own, or
|
||||
ask for help from a nearby friend before you e-mail me. My spare time is
|
||||
very limited. For reporting bugs, requesting features, and making
|
||||
suggestions, open an issue on GitHub
|
||||
`here <https://github.com/AltraMayor/f3/issues>`__ to allow other users
|
||||
to help me.
|
||||
|
||||
Copyright and License
|
||||
---------------------
|
||||
|
||||
F3 is licensed under the `GNU General Public License (GPL) version
|
||||
3 <https://www.gnu.org/copyleft/gpl.html>`__.
|
||||
|
||||
Copyright (c) 2010 `Digirati <http://www.digirati.com.br/>`__.
|
||||
Loading…
x
Reference in New Issue
Block a user