Skip to content

Commit 0cf1e05

Browse files
authored
Update README.md
1 parent 8236fba commit 0cf1e05

File tree

1 file changed

+103
-1
lines changed

1 file changed

+103
-1
lines changed

README.md

Lines changed: 103 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,105 @@
11
# PS2Client
22

3-
![CI](https://github.com/ps2dev/ps2client/workflows/CI/badge.svg)
3+
![CI](https://github.com/ps2dev/ps2client/workflows/CI/badge.svg)
4+
5+
6+
## PS2CLIENT USAGE AND INFORMATION
7+
8+
### THE INTRODUCTION
9+
10+
These programs, ps2client & fsclient, are command line tools used for interacting with a ps2 system running ps2link and/or ps2netfs. It will allow you to send various commands as well as respond to requests for data. This program was written and tested under Linux, Cygwin and Mac OS X but should compile on any reasonably unixlike system.
11+
12+
### BUILDING THE CLIENTS
13+
Building and installing is very simple:
14+
15+
`make clean; make install`
16+
17+
There are some build options, however:
18+
19+
`PREFIX=/dir`
20+
21+
Install directory, defaults to: `$PS2DEV`. `/bin` will be automatically appended.
22+
The software will be installed to the `/bin` sub-directory, under `PREFIX` (`PREFIX/bin`).
23+
24+
These options can be used as follows:
25+
26+
`make clean; make PREFIX=/new/path/prefix install`
27+
28+
### BUILDING WINDOWS BINARIES
29+
For building windows binaries on Unix system, you need to setup mingw cross-compiler and win32 threads.
30+
Build command:
31+
32+
`make -f Makefile.mingw32`
33+
34+
### BASIC CLIENT USAGE
35+
Basic usage:
36+
37+
```
38+
ps2client [-h hostname] [-t timeout] <command> [arguments]
39+
fsclient [-h hostname] <command> <arguments>
40+
```
41+
42+
**[-h hostname]**
43+
44+
The address of the remote ps2. This can be an IP or a hostname. If none is given, the environment variable `$PS2HOSTNAME` will be checked for a valid address. If this variable isn't set, a default of 192.168.0.10 will be used.
45+
46+
**[-t timeout]**
47+
48+
An idle timeout period in seconds that the client will wait before exiting. This is useful to allow a script to continue after calling ps2client to send a command to ps2link or ps2netfs.
49+
50+
### PS2LINK COMMANDS
51+
- `reset`
52+
53+
Send a reset request to ps2link.
54+
55+
- `execiop <filename> [arguments]`
56+
57+
Tell ps2link to load and execute a file on the IOP.
58+
59+
- `execee <filename> [arguments]`
60+
61+
Tell ps2link to load and execute a file on the EE.
62+
63+
- `poweroff`
64+
65+
Send a poweroff request to ps2link.
66+
67+
- `scrdump`
68+
69+
Tell ps2link to dump exceptions to the screen.
70+
71+
- `netdump`
72+
73+
Tell ps2link to dump execetions to the network console.
74+
75+
- `dumpmem <offset> <size> <filename>`
76+
77+
Dump the contents of memory into a file.
78+
79+
- `startvu <vu>`
80+
81+
Tell the specified vector unit to start operation.
82+
83+
- `stopvu <vu>`
84+
85+
Tell the specified vector unit to stop operation.
86+
87+
- `dumpreg <type> <filename>`
88+
89+
Dump the registers of a given type into a file.
90+
91+
- `gsexec <size> <filename>`
92+
93+
Tell ps2link to load and send a file to the GS.
94+
95+
- `writemem <offset> <size> <filename>`
96+
97+
Write the contents of a file into memory.
98+
99+
- `iopexcep`
100+
101+
I really don't know! OH NOES!!
102+
103+
- `listen`
104+
105+
Listen to the ps2link network console.

0 commit comments

Comments
 (0)