FriiDump 0.5.3.16: finalize release identity and documentation

[friidump.git] / docs / options

diff --git a/docs/options b/docs/options
index b106e85fc7c89a2687245561f25b9df98e8fb316..f3c02485cb7b3aabc3df6bd0b385654e53636f0d 100644 (file)
--- a/docs/options
+++ b/docs/options
@@ -1,4 +1,5 @@
-FriiDump 0.5.3.15 - Copyright (C) 2007 Arep
+[FRIIDUMP] Log file: friidump.log
+FriiDump 0.5.3.16-pf1 - Copyright (C) 2007 Arep

 This software comes with ABSOLUTELY NO WARRANTY.
 This is free software, and you are welcome to redistribute it
 under certain conditions; see COPYING for details.
 This software comes with ABSOLUTELY NO WARRANTY.
 This is free software, and you are welcome to redistribute it
 under certain conditions; see COPYING for details.


@@ -90,13 +91,26 @@ Available command line options:
      --scan-dump-prefix <prefix>       Optional raw 0xE7 window dump prefix for --hlds-e7-scan
      --hlds-profile-report <file> Write selected HLDS profile/evidence JSON
      --redump-dat-dir <dir> Directory containing canonical Redump DAT files
      --scan-dump-prefix <prefix>       Optional raw 0xE7 window dump prefix for --hlds-e7-scan
      --hlds-profile-report <file> Write selected HLDS profile/evidence JSON
      --redump-dat-dir <dir> Directory containing canonical Redump DAT files

-                              (default: executable-relative redump_dat, then current directory)
+                              (default: bundled executable data, installed share data, then current directory)
+                              Environment override: FRIIDUMP_REDUMP_DAT_DIR

      --redump-report <file>   Write atomic Redump evidence JSON
      --no-redump-verify       Disable automatic post-dump DAT verification
      --xgd1-layout-probe <file> Read-only locked/unlocked XGD1 boundary probe;
                               writes atomic JSON and does not create an ISO
      --xgd1-raw-id-probe <file> Modified-firmware cache-flushed, block-aligned raw-ID probe;
                               maps logical LBAs to decoded physical sector IDs
      --redump-report <file>   Write atomic Redump evidence JSON
      --no-redump-verify       Disable automatic post-dump DAT verification
      --xgd1-layout-probe <file> Read-only locked/unlocked XGD1 boundary probe;
                               writes atomic JSON and does not create an ISO
      --xgd1-raw-id-probe <file> Modified-firmware cache-flushed, block-aligned raw-ID probe;
                               maps logical LBAs to decoded physical sector IDs

+                              Native .friidump.json reports are created by default
+                              beside the final log using its filename
+     --report-json <file>     Override the complete native report pathname
+     --report-dir <directory> Override only the report destination directory
+                              (may be combined with --report-json)
+     --firmware-modified <note> Mark firmware modified; omission assumes stock

  -A, --allmethods              Try all known command/method combinations until
                                one works. Reopens the drive for each command so
                                command-specific vendor handlers are rebound.
  -A, --allmethods              Try all known command/method combinations until
                                one works. Reopens the drive for each command so
                                command-specific vendor handlers are rebound.

+
+Linux raw-I/O requirement:
+  GC/Wii memory-dump methods and Xbox vendor-unlock paths require effective
+  CAP_SYS_RAWIO. Apply cap_sys_rawio=ep to the exact validated executable;
+  do not run FriiDump as root. Rebuilds and replacements clear capabilities.
+  See docs/LINUX.md and validation/friidump-linux-rawio-capability.sh.