Added manpage, fixex control file

This commit is contained in:
crt0mega 2023-10-23 16:39:06 +02:00
parent e5f6c99ba8
commit 5e035ee974
Signed by: crt0mega
GPG Key ID: 7F512C892B9C60CD
5 changed files with 209 additions and 211 deletions

3
.gitignore vendored
View File

@ -4,7 +4,6 @@ debian/*.log
debian/*.debhelper
debian/*.substvars
debian/debhelper-build-stamp
debian/hdl-dump-deb
debian/hdl-dump-deb*
debian/hdl-dump
debian/files
.pc

10
debian/control vendored
View File

@ -1,12 +1,12 @@
Source: hdl-dump
Section: unknown
Section: utils
Priority: optional
Maintainer: crt0mega <crt0mega@c-r-t.tk>
Rules-Requires-Root: no
Build-Depends:
debhelper-compat (= 13),
Standards-Version: 4.6.2
Homepage: <insert the upstream URL, if relevant>
Homepage: https://github.com/ps2homebrew/hdl-dump
#Vcs-Browser: https://salsa.debian.org/debian/hdl-dump
#Vcs-Git: https://salsa.debian.org/debian/hdl-dump.git
@ -16,5 +16,7 @@ Multi-Arch: foreign
Depends:
${shlibs:Depends},
${misc:Depends},
Description: <insert up to 60 chars description>
<Insert long description, indented with spaces.>
Description: Command line application for dumping PS2 games to a HDD
HDL DUMP / HDL DUMB are a set of tools to install Playstation 2 games,
which are to be played using HD Loader or OPL. This package only contains
the hdl_dump command line utility.

1
debian/hdl-dump.manpages vendored Normal file
View File

@ -0,0 +1 @@
debian/hdl_dump.1

201
debian/hdl_dump.1 vendored Normal file
View File

@ -0,0 +1,201 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH HDL_DUMP-0.9.2 "1" "October 2023" "hdl_dump-0.9.2 by The W1zard 0f 0z (AKA b...) w1zard0f07@yahoo.com" "User Commands"
.SH NAME
hdl_dump-0.9.2 \- manual page for hdl_dump-0.9.2 by The W1zard 0f 0z (AKA b...) w1zard0f07@yahoo.com
.SH DESCRIPTION
hdl_dump\-0.9.2 by The W1zard 0f 0z (AKA b...) w1zard0f07@yahoo.com
revisited by AKuHAK
https://github.com/ps2homebrew/hdl\-dump
.PP
Usage: hdl_dump command arguments
.PP
Commands list:
.TP
dump
make device image (AKA ISO\-image)
.TP
compare_iin
compare two ISO inputs
.TP
toc
display PlayStation 2 HDD TOC
.TP
hdl_toc
display a list of all HDL games on the PlayStation 2 HDD
.TP
map
display PlayStation 2 HDD usage map
.TP
zero
fill HDD with zeroes. All information on the HDD will be lost /!\e
.TP
cutout
display partition table as if a new partition has been created
.TP
info
display information about HDL partition
.TP
extract
extract application image from HDL partition
.TP
inject_cd
create a new HDL partition from a CD /!\e
.TP
inject_dvd
create a new HDL partition from a DVD /!\e
.TP
install
create a new HDL partition from a source, that has an entry in compatibility list /!\e
.TP
cdvd_info
display signature (startup file), volume label and data size for a CD\-/DVD\-drive or image file
.TP
cdvd_info2
display media type, startup ELF, volume label and data size for a CD\-/DVD\-drive or image file
.TP
poweroff
power off Playstation 2
.TP
inject_mbr
inject input_file into MBR /!\e
.TP
dump_mbr
dump mbr to disc
.TP
backup_toc
dump TOC into a binary file
.TP
restore_toc
restore TOC from a binary file /!\e
.TP
diag
scan PS2 HDD for partition errors
.TP
modify
rename a game and/or change compatibility flags /!\e
.TP
copy_hdd
copy file between two device /!\e
.TP
modify_header
inject attributes into partition header for using with HDD OSD or BB Navigator /!\e
.TP
dump_header
dump all attributes from partition header
.PP
Use: hdl_dump command
to show "command" help.
.PP
Warning: Commands, marked with /!\e does write on the HDD
.IP
and could cause corruption. Use with care.
.PP
License: You are only allowed to use this program with a software
.IP
you legally own. Use at your own risk.
.PP
\fB\-\-help\fR: unrecognized command.
.PP
revisited by AKuHAK
https://github.com/ps2homebrew/hdl\-dump
.PP
Usage: hdl_dump command arguments
.PP
Commands list:
.TP
dump
make device image (AKA ISO\-image)
.TP
compare_iin
compare two ISO inputs
.TP
toc
display PlayStation 2 HDD TOC
.TP
hdl_toc
display a list of all HDL games on the PlayStation 2 HDD
.TP
map
display PlayStation 2 HDD usage map
.TP
zero
fill HDD with zeroes. All information on the HDD will be lost /!\e
.TP
cutout
display partition table as if a new partition has been created
.TP
info
display information about HDL partition
.TP
extract
extract application image from HDL partition
.TP
inject_cd
create a new HDL partition from a CD /!\e
.TP
inject_dvd
create a new HDL partition from a DVD /!\e
.TP
install
create a new HDL partition from a source, that has an entry in compatibility list /!\e
.TP
cdvd_info
display signature (startup file), volume label and data size for a CD\-/DVD\-drive or image file
.TP
cdvd_info2
display media type, startup ELF, volume label and data size for a CD\-/DVD\-drive or image file
.TP
poweroff
power off Playstation 2
.TP
inject_mbr
inject input_file into MBR /!\e
.TP
dump_mbr
dump mbr to disc
.TP
backup_toc
dump TOC into a binary file
.TP
restore_toc
restore TOC from a binary file /!\e
.TP
diag
scan PS2 HDD for partition errors
.TP
modify
rename a game and/or change compatibility flags /!\e
.TP
copy_hdd
copy file between two device /!\e
.TP
modify_header
inject attributes into partition header for using with HDD OSD or BB Navigator /!\e
.TP
dump_header
dump all attributes from partition header
.PP
Use: hdl_dump command
to show "command" help.
.PP
Warning: Commands, marked with /!\e does write on the HDD
.IP
and could cause corruption. Use with care.
.PP
License: You are only allowed to use this program with a software
.IP
you legally own. Use at your own risk.
.PP
\fB\-\-version\fR: unrecognized command.
.SH "SEE ALSO"
The full documentation for
.B hdl_dump-0.9.2
is maintained as a Texinfo manual. If the
.B info
and
.B hdl_dump-0.9.2
programs are properly installed at your site, the command
.IP
.B info hdl_dump-0.9.2
.PP
should give you access to the complete manual.

205
debian/manpage.1 vendored
View File

@ -1,205 +0,0 @@
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "README" "" "October 2023" ""
.SH "Contents"
.IP "\[ci]" 4
Intro
.IP "\[ci]" 4
Networking server
.IP "\[ci]" 4
Compilation
.IP "\[ci]" 4
Configuration and list file location
.IP "\[ci]" 4
Configuration
.IP "\[ci]" 4
New features
.IP "" 0
.SH "Intro"
The latest version, as well as documentation, can be found on the new official repository, \fIhttps://github\.com/ps2homebrew/hdl\-dump/\fR
.P
\fIMe reads \fIw1zard0f07@yahoo\.com\fR and psx\-scene forums every now and then\.(c)\fR
.P
Easy guide for installing games can be found here \fIhttp://web\.archive\.org/web/20120720230755/http://openps2loader\.info/hdldump/howto\.html\fR
.SH "Networking server"
\fIUpdate:\fR Currently, OPL built\-in NBD server is the preferred option\.
.P
\fIDeprecated:\fR A UDP\-based network server is available, based on the SMAP driver released by @sp193 \fIhttp://ichiba\.geocities\.jp/ysai187/PS2/smap\.htm\fR\. It is called \fBhdl_svr_093\.elf\fR and is now part of the \fBhdl_dump\fR sources\.
.P
\fI\fBNote\fR: You might need to punch a hole in your firewall for incoming UDP from port 12345\.\fR
.SH "Compilation"
First of all, you have to update your PS2SDK\.
.P
Finally: You can run the shell script in the project folder: \fBmkrel\.sh\fR\. It will compile both GUI and CLI versions for Windows\.
.IP "\[ci]" 4
\fBLinux\fR: Build and copy executable into a directory of your choice\.
.IP "" 4
.nf
make RELEASE=yes
.fi
.IP "" 0
.IP
Advanced Linux build commands:
.IP "" 4
.nf
make XC=win # for Windows cross\-compilation using mingw32
make \-C gui # for WineLib compilation (currently not working)
make \-C gui XC=win # for GUI cross\-compilation using mingw32
.fi
.IP "" 0
.IP "\[ci]" 4
\fBMac OS X\fR or \fBFreeBSD\fR: You'll need to have GNU make installed, then
.IP "" 4
.nf
gmake RELEASE=yes IIN_OPTICAL_MMAP=no
.fi
.IP "" 0
.IP
or
.IP "" 4
.nf
make RELEASE=yes IIN_OPTICAL_MMAP=no
.fi
.IP "" 0
.IP "\[ci]" 4
\fBWindows\fR: You need to have MINGW32 installed; then use
.IP "" 4
.nf
make RELEASE=yes
make \-C gui RELEASE=yes
.fi
.IP "" 0
.IP
to compile command\-line or GUI version\.
.IP "" 0
.SH "Configuration and list file location"
You can place these files in the folder where is installed hdl_dump for making it portable\.
.IP "\[ci]" 4
\fBWindows\fR:
.IP
\fB%APPDATA%\ehdl_dump\.conf\fR \fB%APPDATA%\ehdl_dump\.list\fR
.IP "\[ci]" 4
\fBLinux\fR, \fBMac OS X\fR and \fBFreeBSD\fR: (\fB~\fR is your home dir)
.IP
\fB~/\.hdl_dump\.conf\fR \fB~/\.hdl_dump\.list\fR
.IP "" 0
.SH "Configuration"
.IP "\[ci]" 4
\fBdisc_database_file\fR \-\- full path to your disc compatibility database file;
.IP "" 0
.SH "New features"
All new stuff can be used from HDD OSD, BB Navigator, or XMB from PSX DVR\.
.SS "ZSO support"
hdl\-dump supports zso compressed files\. For using ZSO, you must keep original ISO (or cue/bin) files in the same folder and with the same name as ZSO compressed file\. You should select original ISO (or cue/bin) and hdl\-dump will check zso existence on installation\. If ZSO file exists, it will install ZSO, if it does not exist it will install original ISO\. Unfortunately, you need to keep original file for program to work\.
.SS "<code>inject_dvd</code>, <code>inject_cd</code>, <code>install</code> or <code>copy_hdd</code>\."
This command will install games onto the hard disk\.
.P
\fI\fBWarning\fR: Be careful with \fBcopy_hdd\fR \- every HDLoader game will be given the same icon\.\fR
.P
Optionally, you can place \fBboot\.elf\fR (which is actually \fBminiopl\.elf\fR) in the folder where \fBhdl_dump\fR is launched from\. You can also optionally include \fBlist\.ico\fR (\fB*\.ico\fR from memory card) and \fBicon\.sys\fR (\fB*\.sys\fR from memory card), or you can write your own \fBicon\.sys\fR file\.
.P
If you don't include an \fB*\.ico\fR, the HDLoader logo is used\. If you don't include \fB*\.sys\fR, the default HDLoader icon settings are used\.\.
.P
Note: following options aren't supported by PSX1 (PSX DESR 1st generation)\.
.P
\fBboot\.elf\fR, \fBboot\.kelf\fR \- PS2 executable file in signed or unsigned form\. OPL\-Launcher \fIhttps://github\.com/ps2homebrew/OPL\-Launcher\fR is a preferable option\. Injection address \- \fB0x111000\fR\. Size limit \- 2,026,464 bytes (thanks to kHn)
.SS "<code>inject_mbr</code>"
.nf
hdl_dump inject_mbr /dev/sdb MBR\.KELF
.fi
.P
When you use this command and place the hard drive into your PlayStation 2 phat, it will launch the injected \fBMBR\.KELF\fR\. This option can be used as an entry point for PS2\.
.P
All HDD data will remain intact\.
.P
\fBMBR\.KELF\fR injection address \- \fB0x00404000\fR (for compatibility with PlayStation BB Navigator)
.P
\fBMBR\.KELF\fR size should be a maximum of \fB883200\fR bytes and have a valid header\.
.SS "<code>modify_header</code>"
This command injects header attributes into an existing partition\.
.IP "" 4
.nf
hdl_dump\.exe modify_header 192\.168\.0\.10 PP\.TEST
.fi
.IP "" 0
.P
It can inject these files:
.IP "\[ci]" 4
\fBsystem\.cnf\fR
.IP "\[ci]" 4
\fBicon\.sys\fR
.IP "\[ci]" 4
\fBlist\.ico\fR
.IP "\[ci]" 4
\fBdel\.ico\fR
.IP "\[ci]" 4
\fBboot\.kelf\fR
.IP "\[ci]" 4
\fBboot\.elf\fR
.IP "\[ci]" 4
\fBboot\.kirx\fR
.IP "" 0
.P
Any one can be skipped\. It first tries to inject \fBboot\.kelf\fR, then if not found it will try to inject \fBboot\.elf\fR\.
.P
Now \fBicon\.sys\fR can be in any of 2 formats: Memory Card format or HDD format\.
.P
\fBdel\.ico\fR injection address: \fB0x041000\fR (If \fBdel\.ico\fR is used \fBlist\.ico\fR maximum size 260,096 bytes)
.P
\fBboot\.elf\fR (or \fBboot\.kelf\fR) injection address \- \fB0x111000\fR
.P
\fBboot\.elf\fR size limit \- 2,026,464 bytes (thanks to kHn)
.P
\fBboot\.kelf\fR size limit \- 3,076,096 bytes (if \fBboot\.kirx\fR not used)
.P
\fBboot\.kelf\fR size limit \- 2,031,616 bytes (if \fBboot\.kirx\fR is used)
.P
\fBboot\.kirx\fR injection address \- \fB0x301000\fR
.P
\fBboot\.kirx\fR size limit \- 1,044,480 bytes
.SS "Hiding Games"
You can hide games so that they are not visible in the HDD Browser by using the \fB\-hide\fR switch with the \fBinstall\fR, \fBinject_cd\fR, \fBinject_dvd\fR, or \fBmodify\fR commands\. A hidden game can be made visible again using the \fB\-unhide\fR switch with the \fBmodify\fR command\. This is a necessary option for installing the games on PSX1 (1st DESR generation)\.
.SS "Others"
If you want to know more about these files (and their restrictions), you have to study the official SONY ps2sdk document called \fBhdd_rule_3\.0\.2\.pdf\fR
.P
There are also some undocumented features like this:
.IP "\[ci]" 4
If you want to inject \fBboot\.kelf\fR (or \fBboot\.elf\fR), you have to change \fBBOOT2\fR in \fBsystem\.cnf\fR\.
.IP "" 4
.nf
BOOT2 = PATINFO
.fi
.IP "" 0
.IP
If you need to erase \fBboot\.elf\fR from the PATINFO you have to place zero\-sized \fBboot\.kelf\fR or elf in program folder\. _\fBNote\fR: PSX1 (DESR 1st generation) doesn't support the PATINFO parameter\.
.IP "\[ci]" 4
If you want to launch KELF from the PFS partition you have to change \fBBOOT2\fR in \fBsystem\.cnf\fR
.IP "" 4
.nf
BOOT2 = pfs:/EXECUTE\.KELF
.fi
.IP "" 0
.IP
where \fBEXECUTE\.KELF\fR \- is the path to KELF that is placed into the partition\. Changedable\.
.IP "\[ci]" 4
If you want to inject kirx into the partition you have to add a line into \fBsystem\.cnf\fR
.IP "" 4
.nf
IOPRP = PATINFO
.fi
.IP "" 0
.IP
Don't ask about kirx \- I don't know where that is used\. _\fBNote\fR: PSX1 (DESR 1st generation) doesn't support the IOPRP parameter\.
.IP "\[ci]" 4
If you don't want to boot from HDD OSD you have to add such a line into system\.cnf
.IP "" 4
.nf
BOOT2 = NOBOOT
.fi
.IP "" 0
.IP "" 0
.P
Happy gaming\.