175 lines
6.1 KiB
Groff
175 lines
6.1 KiB
Groff
.\" generated with Ronn-NG/v0.9.1
|
|
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
|
.TH "README" "" "October 2023" ""
|
|
This tool allows you to browse and transfer files to and from PFS filesystems using the command line\. This tool is useful for transferring configuration and media files used by programs such as Open PS2 Loader and SMS\.
|
|
.SH "Quickstart"
|
|
Binaries for Win32 are available here: \fIhttps://github\.com/ps2homebrew/pfsshell/releases\fR To start the program, provide the path to it on the command line:
|
|
.IP "" 4
|
|
.nf
|
|
/path/to/pfsshell
|
|
.fi
|
|
.IP "" 0
|
|
.P
|
|
You will get a prompt similar to the following:
|
|
.IP "" 4
|
|
.nf
|
|
>
|
|
.fi
|
|
.IP "" 0
|
|
.P
|
|
To get a list of commands, type in the following:
|
|
.IP "" 4
|
|
.nf
|
|
> help
|
|
.fi
|
|
.IP "" 0
|
|
.P
|
|
To select a device which can be a disk image or block device, type in the following:
|
|
.IP "" 4
|
|
.nf
|
|
> device /path/to/device
|
|
.fi
|
|
.IP "" 0
|
|
.P
|
|
On the Windows systems, the block devices can be used by using the UNC path\. To get the UNC path, use this command:
|
|
.P
|
|
\fBcmd wmic diskdrive get Caption,DeviceID,InterfaceType\fR
|
|
.P
|
|
Once a device is selected, the prompt will change to the following:
|
|
.IP "" 4
|
|
.nf
|
|
#
|
|
.fi
|
|
.IP "" 0
|
|
.P
|
|
To mount a partition (for example, the \fB+OPL\fR partition), type in the following:
|
|
.IP "" 4
|
|
.nf
|
|
# mount +OPL
|
|
.fi
|
|
.IP "" 0
|
|
.P
|
|
The prompt will change to the following:
|
|
.IP "" 4
|
|
.nf
|
|
+OPL:/#
|
|
.fi
|
|
.IP "" 0
|
|
.P
|
|
To get a list of files or partitions, type in the following:
|
|
.IP "" 4
|
|
.nf
|
|
+OPL:/# ls
|
|
or
|
|
+OPL:/# ls \-l
|
|
.fi
|
|
.IP "" 0
|
|
.P
|
|
To transfer a file from the current directory of the PFS partition to the current directory of the process, type in the following:
|
|
.IP "" 4
|
|
.nf
|
|
+OPL:/# get example\.txt
|
|
.fi
|
|
.IP "" 0
|
|
.P
|
|
To transfer a file from the current directory of the process to the current directory of the PFS partition, type in the following:
|
|
.IP "" 4
|
|
.nf
|
|
+OPL:/# put example\.txt
|
|
.fi
|
|
.IP "" 0
|
|
.P
|
|
Once you are finished looking around in the partition, type in the following:
|
|
.IP "" 4
|
|
.nf
|
|
+OPL:/# umount
|
|
.fi
|
|
.IP "" 0
|
|
.P
|
|
Once you are finished with the program, type in the following:
|
|
.IP "" 4
|
|
.nf
|
|
# exit
|
|
.fi
|
|
.IP "" 0
|
|
.SH "List of commands"
|
|
Commands marked with DESTRUCTIVE could potentially wipe or remove important information\. Remember to make backups if using these commands\.
|
|
.P
|
|
\fBDevice Selection & Initialization\fR
|
|
.IP "" 4
|
|
.nf
|
|
lcd [path] \- print/change the local working directory
|
|
|
|
device <device> \- select the PS2 HDD device
|
|
|
|
initialize \- blank and create a partition on a PS2 HDD device (DESTRUCTIVE)
|
|
.fi
|
|
.IP "" 0
|
|
.P
|
|
\fBPartition Editing\fR
|
|
.IP "" 4
|
|
.nf
|
|
ls \- list partitions (only when no partition mounted)
|
|
|
|
mkpart <part_name> <size> \- create a new partition (IMPORTANT size must be power of 2)
|
|
|
|
mkfs <part_name> \- blank and create PFS on a new partition (DESTRUCTIVE)
|
|
|
|
mount <part_name> \- mount a partition
|
|
|
|
unmount \- unmount the active partition
|
|
|
|
rmpart <part_name> \- remove a partition (DESTRUCTIVE)
|
|
.fi
|
|
.IP "" 0
|
|
.P
|
|
\fBFile & Folder Editing\fR
|
|
.IP "" 4
|
|
.nf
|
|
pwd \- print the current PS2 HDD directory
|
|
|
|
ls \- list folders/files (only when partition mounted)
|
|
|
|
cd <dir_name> \- change directory
|
|
|
|
mkdir <dir_name> \- create a new directory
|
|
|
|
rmdir <dir_name> \- delete an existing directory
|
|
|
|
pwd \- print the current PS2 HDD directory
|
|
|
|
get <file_name> \- copy a file from PS2 HDD to the working directory
|
|
|
|
put <file_name> \- copy a file from the working directory to the PS2 HDD
|
|
|
|
rm <file_name> \- delete a file
|
|
|
|
rename <curr_name> <new_name> \- rename a file or directory
|
|
.fi
|
|
.IP "" 0
|
|
.SH "pfsfuse"
|
|
\fBpfsfuse\fR provides an ability to mount partition into host filesystem (like network folder)\. \fBpfsfuse\fR supports physically connected drives, raw drive images as regular files, and an NBD network server from OPL\. Your system has to support fuse\. For example, in the Linux \fBfuse\fR package should be installed, on the MacOS \fBmacfuse\fR can be used\. The Unix users can use the following command for mounting the partition:
|
|
.P
|
|
\fBsh mkdir \-p mountpoint pfsfuse \-\-partition=+OPL /path/to/device mountpoint/ df \-h mountpoint/ # will show information about free space\fR
|
|
.P
|
|
\fBmountpoint\fR is accessible like a normal folder\. Once you are finished looking around in the partition, type in the following:
|
|
.IP "" 4
|
|
.nf
|
|
umount mountpoint
|
|
.fi
|
|
.IP "" 0
|
|
.P
|
|
Note: for full access without root, use the argument \fB\-o allow_other\fR when mounting\.
|
|
.SS "pfsfuse\-win32"
|
|
Windows port uses Dokan FUSE wrapper \fIhttps://github\.com/dokan\-dev/dokany\fR implementation as a base\. Before using \fBpfsfuse\fR on Windows you should install Dokany\. Installation instructions \fIhttps://github\.com/dokan\-dev/dokany/wiki/Installation\fR\. After successful installation, you can use \fBpfsfuse\fR by pasting command in command line (CMD) or PowerShell with elevated privileges (run as administrator): \fBsh pfsfuse\.exe \-\-partition=+OPL \e\e\.\ePHYSICALDRIVE2 M \-o volname=+OPL or pfsfuse\.exe \-\-partition=+OPL D:\eps2image\.bin M \-o volname=+OPL\fR
|
|
.P
|
|
Where \fBM\fR \- is drive letter (please choose unused driver letter)\. \fB\-o volname=+OPL\fR \- will be volume name in File Explorer\. For unmounting, please locate dokanctl\.exe and launch the following command in the elevated command prompt: \fBsh dokanctl\.exe /u M\fR Where \fBM\fR \- is mounted point drive letter\.
|
|
.SH "NBD server support"
|
|
The latest Open PS2 Loader revisions have a built\-in NBD server\. \fBpfsshell/pfsfuse\fR have full support for an NBD block device, once an NBD server is mounted in the host filesystem\.
|
|
.SH "Building"
|
|
This project can be built by using the Meson build system\. For more information about the system, please visit the following location: \fIhttps://mesonbuild\.com/\fR
|
|
.SH "Original project"
|
|
The original project was created by Wizard of Oz\. More information about the original project can be found at the following location: \fIhttp://web\.archive\.org/web/20061220090822/http://hdldump\.ps2\-scene\.org/\fR
|
|
.SH "License"
|
|
This project as a whole is licensed under the GNU General Public License GPL version 2\. Please read the \fBCOPYING\fR file for more information\. The APA, PFS, and iomanX libraries are licensed under The Academic Free License version 2\. Please read the \fBCOPYING\.AFLv2\fR file for more information\.
|