Installation docs update (#1927)

This commit is contained in:
Soxoj
2024-12-03 20:23:49 +01:00
committed by GitHub
parent 1a8bbe7ff8
commit e982be4109
9 changed files with 83 additions and 45 deletions
+26 -9
View File
@@ -3,49 +3,66 @@
Usage examples
==============
Start a search for accounts with username ``machine42`` on top 500 sites from the Maigret DB.
1. Search for accounts with username ``machine42`` on top 500 sites (by default, according to Alexa rank) from the Maigret DB.
.. code-block:: console
maigret machine42
Start a search for accounts with username ``machine42`` on **all sites** from the Maigret DB.
2. Search for accounts with username ``machine42`` on **all sites** from the Maigret DB.
.. code-block:: console
maigret machine42 -a
Start a search [...] and generate HTML and PDF reports.
.. note::
Maigret will search for accounts on a huge number of sites,
and some of them may return false positive results. At the moment, we are working on autorepair mode to deliver
the most accurate results.
If you experience many false positives, you can do the following:
- Install the last development version of Maigret from GitHub
- Run Maigret with ``--self-check`` flag and agree on disabling of problematic sites
3. Search for accounts with username ``machine42`` and generate HTML and PDF reports.
.. code-block:: console
maigret machine42 -a -HP
maigret machine42 -HP
Start a search for accounts with username ``machine42`` only on Facebook.
or
.. code-block:: console
maigret machine42 -a --html --pdf
4. Search for accounts with username ``machine42`` on Facebook only.
.. code-block:: console
maigret machine42 --site Facebook
Extract information from the Steam page by URL and start a search for accounts with found username ``machine42``.
5. Extract information from the Steam page by URL and start a search for accounts with found username ``machine42``.
.. code-block:: console
maigret --parse https://steamcommunity.com/profiles/76561199113454789
Start a search for accounts with username ``machine42`` only on US and Japanese sites.
6. Search for accounts with username ``machine42`` only on US and Japanese sites.
.. code-block:: console
maigret machine42 --tags en,jp
Start a search for accounts with username ``machine42`` only on sites related to software development.
7. Search for accounts with username ``machine42`` only on sites related to software development.
.. code-block:: console
maigret machine42 --tags coding
Start a search for accounts with username ``machine42`` on uCoz sites only (mostly CIS countries).
8. Search for accounts with username ``machine42`` on uCoz sites only (mostly CIS countries).
.. code-block:: console