From 40bce0615ae972a0cc53bb6e88bdf33e9713a7b4 Mon Sep 17 00:00:00 2001 From: Nejc Bertoncelj Date: Sat, 26 Oct 2024 23:47:38 +0200 Subject: [PATCH 1/2] Do not highlight literal blocks in README.rst None of the blocks contain Bash source code. Root operations render greyed out as comments and the list of files at the end has various characters coloured as if they were Bash. --- README.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.rst b/README.rst index c0788db..bb9eef3 100644 --- a/README.rst +++ b/README.rst @@ -15,8 +15,6 @@ F3 stands for Fight Flash Fraud, or Fight Fake Flash. .. _examples: -.. highlight:: bash - Examples ======== From e9311a57acfb1b5781bbb48f1464672a8aaaae91 Mon Sep 17 00:00:00 2001 From: Nejc Bertoncelj Date: Sun, 27 Oct 2024 00:00:40 +0200 Subject: [PATCH 2/2] Rework 'Files' and 'Bash scripts' sections into lists --- README.rst | 34 ++++++++++++++++++---------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index bb9eef3..b39167f 100644 --- a/README.rst +++ b/README.rst @@ -345,31 +345,33 @@ authors. This will improve their code as it has improved mine. Files ----- -:: +- ``changelog`` - Change log for package maintainers +- ``f3read.1`` - Man page for f3read and f3write + + In order to read this manual page, run ``man ./f3read.1``. + To install the page, run + ``install --owner=root --group=root --mode=644 f3read.1 /usr/share/man/man1``. - changelog - Change log for package maintainers - f3read.1 - Man page for f3read and f3write - In order to read this manual page, run `man ./f3read.1` - To install the page, run - `install --owner=root --group=root --mode=644 f3read.1 /usr/share/man/man1` - LICENSE - License (GPLv3) - Makefile - make(1) file - README - This file - *.h and *.c - C code of F3 +- ``LICENSE`` - License (GPLv3) +- ``Makefile`` - make(1) file +- ``README`` - This file +- ``*.h`` and ``*.c`` - C code of F3 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. So you can -personalize F3 to your specific needs:: +personalize F3 to your specific needs: + +- ``f3write.h2w`` - Script to create files exactly like H2testw. + + Use example: ``f3write.h2w /media/michel/5EBD-5C80/``. - f3write.h2w - Script to create files exactly like H2testw. - Use example: `f3write.h2w /media/michel/5EBD-5C80/` +- ``log-f3wr`` - Script that runs f3write and f3read, and records + their output into a log file. - log-f3wr - Script that runs f3write and f3read, and records - their output into a log file. - Use example: `log-f3wr log-filename /media/michel/5EBD-5C80/` + Use example: ``log-f3wr log-filename /media/michel/5EBD-5C80/``. Please notice that all scripts and use examples above assume that f3write, f3read, and the scripts are in the same folder.