Skip to content

Commit

Permalink
Update readme and checksum message
Browse files Browse the repository at this point in the history
  • Loading branch information
antangelo committed Aug 11, 2023
1 parent e02e12c commit b60ad59
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 15 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,14 @@ Running `xdvdfs` with no args will bring up the help screen, showing supported s
Usage: xdvdfs [COMMAND]
Commands:
ls List files in an image
tree List all files in an image, recursively
md5 Show MD5 checksums for files in an image
info Print information about image metadata
unpack Unpack an entire image to a directory
pack Pack an image from a given directory or source ISO image
help Print this message or the help of the given subcommand(s)
ls List files in an image
tree List all files in an image, recursively
md5 Show MD5 checksums for files in an image
checksum Compute deterministic checksum of image contents
info Print information about image metadata
unpack Unpack an entire image to a directory
pack Pack an image from a given directory or source ISO image
help Print this message or the help of the given subcommand(s)
```

Running a subcommand with the `-h` flag will show help information for that specific subcommand.
Expand Down Expand Up @@ -72,6 +73,7 @@ $ xdvdfs unpack <path to image> [optional output path]
| `xdvsfs ls <path to image> [path within image]` | Lists files within the specified directory, defaulting to root |
| `xdvdfs tree <path to image>` | Prints a listing of every file within the image |
| `xdvdfs md5 <path to image> [optional path to file within image]` | Prints md5 sums for specified files, or every file, within the image |
| `xdvdfs checksum [path to img1]...` | Computes a checksum for all image contents to check integrity against other images |
| `xdvdfs info <path to image> [path within image]` | Prints metadata info for the specified directory entry, or root volume |

## xdvdfs-core
Expand Down
16 changes: 9 additions & 7 deletions xdvdfs-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,14 @@ Running `xdvdfs` with no args will bring up the help screen, showing supported s
Usage: xdvdfs [COMMAND]
Commands:
ls List files in an image
tree List all files in an image, recursively
md5 Show MD5 checksums for files in an image
info Print information about image metadata
unpack Unpack an entire image to a directory
pack Pack an image from a given directory or source ISO image
help Print this message or the help of the given subcommand(s)
ls List files in an image
tree List all files in an image, recursively
md5 Show MD5 checksums for files in an image
checksum Compute deterministic checksum of image contents
info Print information about image metadata
unpack Unpack an entire image to a directory
pack Pack an image from a given directory or source ISO image
help Print this message or the help of the given subcommand(s)
```

Running a subcommand with the `-h` flag will show help information for that specific subcommand.
Expand Down Expand Up @@ -66,4 +67,5 @@ $ xdvdfs unpack <path to image> [optional output path]
| `xdvsfs ls <path to image> [path within image]` | Lists files within the specified directory, defaulting to root |
| `xdvdfs tree <path to image>` | Prints a listing of every file within the image |
| `xdvdfs md5 <path to image> [optional path to file within image]` | Prints md5 sums for specified files, or every file, within the image |
| `xdvdfs checksum [path to img1]...` | Computes a checksum for all image contents to check integrity against other images |
| `xdvdfs info <path to image> [path within image]` | Prints metadata info for the specified directory entry, or root volume |
2 changes: 1 addition & 1 deletion xdvdfs-cli/src/cmd_read.rs
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ async fn checksum_single(img_path: &str) -> Result<(), anyhow::Error> {

#[maybe_async(?Send)]
pub async fn cmd_checksum(images: &Vec<String>) -> Result<(), anyhow::Error> {
println!("This SHA256 sum is a condensed checksum of the all the game data inside the image");
println!("This SHA256 sum is a condensed checksum of the all the data inside the image");
println!("It does not encode information about the filesystem structure outside of the data being in the correct order.");
println!("Note that this is NOT a SHA256 sum of the full image, and cannot be compared to a SHA256 sum of the full image.");
println!("This checksum is only useful when compared to other checksums created by this tool.");
Expand Down

0 comments on commit b60ad59

Please sign in to comment.