X-Git-Url: https://git.jtryba.com/browse/friidump.git/blobdiff_plain/d44030dfa440b1967ec7dcd3ccfe46fb69934486..3faddd693c9198081778561c683f21c7904c7376:/docs/options?ds=inline

diff --git a/docs/options b/docs/options
index b39d268..f3c0248 100644
--- a/docs/options
+++ b/docs/options
@@ -1,4 +1,5 @@
-FriiDump 0.5.3.2 - 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.
@@ -36,21 +37,24 @@ Available command line options:
 				3 - DVD
 				4 - Xbox/XGD 2048-byte-sector mode
 				    Native profiles: GDR-8050L and GDR-3120L.
-				    Forced Xbox mode requires a supported Xbox
-				    unlock profile; no GC/Wii fallback is used.
+				    Other drives keep normal FriiDump behavior
+				    unless Xbox mode is explicitly forced.
  -S, --size <sectors>		Force disc size
  -r, --raw <file>		Output to file <file> in raw format (2064-byte
 				sectors)
- -i, --iso <file>		Output to file <file> in ISO format (2048-byte
-				sectors). For Xbox/XGD this reconstructs the
-				redump-style XGD1 layout and writes .pfi.bin,
-				.dmi.bin, and .redump.json metadata when possible
- -X, --xiso <file>		Output Xbox/XGD game partition as XISO (.xiso).
-				Attempts to read the 32-sector game lead-in
-				from drive-readable sectors and zero-fills only
-				unreadable lead-in sectors. Use -i for
-				redump-style ISO + PFI/DMI/JSON; use -X only
-				for game-partition XISO.
+ -i, --iso[=<file>]		Output to file <file> in ISO format (2048-byte
+				sectors). For Xbox/GDR-8050L, omitting <file>
+				derives Title[MediaID].iso from the XBE/DMI;
+				providing <file> is an explicit override. For
+				Xbox/XGD this reconstructs the redump-style
+				XGD1 layout and writes .pfi.bin, .dmi.bin, and
+				.redump.json metadata when possible
+ -X, --xiso[=<file>]	Output Xbox/XGD game partition as XISO (.xiso).
+				For Xbox/GDR-8050L, omitting <file> derives
+				Title[MediaID].xiso from the XBE/DMI; providing
+				<file> is an explicit override. Attempts to read
+				the 32-sector game lead-in from drive-readable
+				sectors and zero-fills only unreadable sectors.
  -u, --unscramble <file>	Convert (unscramble) raw image contained in
 				<file> to ISO format
  -H, --nohash			Do not compute CRC32/MD5/SHA-1/SHA-256 hashes
@@ -77,14 +81,36 @@ Available command line options:
  -9, --method9			Use dumping method 9 (Read and dump 5 blocks
 				at a time, using streaming read, using DMA and
 				some speed tricks)
+     --hlds-e7-scan		Probe HLDS HIT 0xE7 cache/memdump bases only;
+				writes JSON and does not crack seeds or dump data
+     --hlds-e7-subcmd-sweep	Probe HIT 0xE7 subcommands/address candidates only;
+				writes JSON and does not crack seeds or dump data
+     --hlds-e7-memrange-sweep	Sweep wider HIT 0xE7 subcmd 0x01 address ranges;
+				writes JSON and does not crack seeds or dump data
+     --scan-log <file>		JSON output path for --hlds-e7-scan
+     --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: 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
+                              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.
 
-Xbox dump notes:
- - GDR-8050L redump-style -i follows the original dumper order:
-   primary handshake, media-cycle, re-handshake, metadata/auth probe,
-   media-cycle back to visible DVD-video view, capture video L0/L1, final
-   handshake, zero-fill the 32-sector game lead-in, read game data, then write
-   .pfi.bin, .dmi.bin, and .redump.json.
- - FriiDump sends STOP UNIT / spin-down after dump attempts, success or failure.
+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.