From e6d814d43843549bb59f73b891c3bce9a8a5f2ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=A1s=20Ortega=20Froysa?= Date: Tue, 30 Apr 2024 17:21:08 +0200 Subject: [PATCH] Add more helpful information to the README. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Nicolás Ortega Froysa --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cbd68d1..4cfbb1a 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ to boot from a USB depending on just how broken it is). ## Installation -Dependencies: +### Dependencies - Perl 5 - `File::ReadBackwards` module @@ -20,6 +20,31 @@ You can install these packages with the following command: # pacman -S perl perl-file-readbackwards perl-par-packer ``` +### Compiling & Installing + +The script is compiled and installed using GNU Makefile. Therefore you can use +`make install` to build and install the script and its man-page as expected. +They are installed (by default) to `/usr/local`. To change this to a different +directory simply prepend the `PREFIX=` to your `make install` command. + +## Usage + +The first concept to understand is that of a transaction. A transaction is +defined in the pacman logs as package operations done during a single use of the +command (or so it seems, at least). If you look at the logs +(`/var/log/pacman.log`) this would be everything between the lines `[ALPM] +transaction started` and `[ALPM] transaction completed`. You can set how many +transactions to list/undo by using the `-t` argument. + +There are two modes for undoing pacman transactions: + +- Interactive (`-i`, default): will show you a numbered list with all the package + operations of the selected transactions. +- Automatic (`-r`): will automatically undo all package operations of the + selected transactions. + +Look at the man-page (`man pacundo`) for more information. + ## License This project is licensed under the terms & conditions of the Zlib license.