diff --git a/docs/source/_images/setup/storage/delete_file_confirm.png b/docs/source/_images/setup/storage/delete_file_confirm.png new file mode 100644 index 0000000000..aaee0d02a2 Binary files /dev/null and b/docs/source/_images/setup/storage/delete_file_confirm.png differ diff --git a/docs/source/_images/setup/storage/delete_file_progress.png b/docs/source/_images/setup/storage/delete_file_progress.png new file mode 100644 index 0000000000..fb1904f2c5 Binary files /dev/null and b/docs/source/_images/setup/storage/delete_file_progress.png differ diff --git a/docs/source/_images/setup/storage/preview.png b/docs/source/_images/setup/storage/preview.png new file mode 100644 index 0000000000..7cf8ef0c20 Binary files /dev/null and b/docs/source/_images/setup/storage/preview.png differ diff --git a/docs/source/_images/setup/storage/scanning_files.png b/docs/source/_images/setup/storage/scanning_files.png new file mode 100644 index 0000000000..5135b16521 Binary files /dev/null and b/docs/source/_images/setup/storage/scanning_files.png differ diff --git a/docs/source/setup/index.rst b/docs/source/setup/index.rst index cbc747699f..352a79e8b0 100644 --- a/docs/source/setup/index.rst +++ b/docs/source/setup/index.rst @@ -37,5 +37,6 @@ For usage questions, ask the `GIS StackExchange community `, :btn:``, :btn:``, :btn:`` ) to navigate through the files and directories. +- Press :code:`Enter` to enter a directory. + +.. thumbnail:: ../_images/setup/storage/preview.png + :title: NCDU preview + :width: 70% + :align: center + +Understanding the Interface +---------------------------- + +- The size of the files and directories is shown on the left . +- The graphical representation of disk usage is displayed next to the size. +- The percentage of disk space used by each file or directory relative to the parent directory is shown at the beginning of each line. + +Advanced Usage +============== + +.. Attention:: + + Be cautious when deleting files or directories. Deleting system files or directories can cause system instability or data loss. + +- Press ``d`` to delete a file or directory (be cautious with this operation). +- Press ``q`` to quit :code:`ncdu`. + +.. thumbnail:: ../_images/setup/storage/delete_file_confirm.png + :title: NCDU delete confirmation + :width: 70% + :align: center + +.. thumbnail:: ../_images/setup/storage/delete_file_progress.png + :title: NCDU delete progress + :width: 70% + :align: center + +To see a list of all available options and features, you can use the ``--help`` option: + +.. code-block:: bash + + ncdu --help + +Some useful flags include: + +- ``-x``: Stay on the filesystem of the directory being scanned. +- ``-q``: Quick mode, doesn't count sizes of subdirectories. +- ``-o``: Export the results to a file.