mirror of
https://github.com/thewesker/RASCSI.git
synced 2025-12-20 12:21:10 -05:00
Updated man pages and generated text version of the doc
This commit is contained in:
akuker
62
doc/rascsi.1
Normal file
62
doc/rascsi.1
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
.TH rascsi 1
|
||||||
|
.SH NAME
|
||||||
|
rascsi \- Emulates SCSI devices using the Raspberry Pi GPIO pins
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B rascsi
|
||||||
|
[\fB\-IDn\fR \fIfile\fR]
|
||||||
|
[\fB\-HDn\fR \fIfile\fR]...
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.B rascsi
|
||||||
|
Emulates SCSI devices using the Raspberry Pi GPIO pins.
|
||||||
|
.PP
|
||||||
|
In the arguments to RaSCSI, one or more SCSI (-IDn) or SASI (-HDn) devices can be specified.
|
||||||
|
The number (n) after the ID or HD idnetifier specifies the ID number for that device.
|
||||||
|
For SCSI: The ID is limited from 0-7. However, typically SCSI ID 7 is reserved for the "initiator" (the host computer).Note that SASI is considered rare and only used on very early Sharp X68000 computers.
|
||||||
|
.PP
|
||||||
|
RaSCSI will determin the type of device based upon the file extension of the FILE argument.
|
||||||
|
hdf: SASI Hard Disk image (XM6 SASI HD image - typically only used with X68000)
|
||||||
|
hds: SCSI Hard Disk image (XM6 SCSI HD image - typically only used with X68000)
|
||||||
|
hdn: SCSI Hard Disk image (NEC GENUINE)
|
||||||
|
hdi: SCSI Hard Disk image (Anex86 HD image)
|
||||||
|
nhd: SCSI Hard Disk image (T98Next HD image)
|
||||||
|
hda: SCSI Hard Disk image (APPLE GENUINE - typically used with Mac SCSI emulation)
|
||||||
|
mos: SCSI Magneto-optical image (XM6 SCSI MO image - typically only used with X68000)
|
||||||
|
iso: SCSI CD-ROM image (ISO 9660 image)
|
||||||
|
|
||||||
|
For example, if you want to specify an Apple-compatible HD image on ID 0, you can use the following command:
|
||||||
|
sudo rascsi -ID0 /path/to/drive/hdimage.hda
|
||||||
|
|
||||||
|
Once RaSCSI starts, it will open a socket (port 6868) to allow external management commands.
|
||||||
|
If another process is using port 6868, RaSCSI will terminate, since it is likely another instance of RaSCSI.
|
||||||
|
Once RaSCSI has initialized, the rasctl utility can be used to send commands.
|
||||||
|
|
||||||
|
To quit RaSCSI, press Control + C. If it is running in the background, you can kill it using an INT signal.
|
||||||
|
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
.BR \-ID\fIn " " \fIFILE
|
||||||
|
n is the SCSI ID number (0-7)
|
||||||
|
.IP
|
||||||
|
FILE is the name of the image file to attach to that ID.
|
||||||
|
.TP
|
||||||
|
.BR \-HD\fIn " " \fIFILE
|
||||||
|
n is the SASI ID number (0-15)
|
||||||
|
.IP
|
||||||
|
FILE is the name of the image file to attach to that ID.
|
||||||
|
.IP
|
||||||
|
Note: SASI usage is rare, and is typically limited to early Sharp X68000 systems.
|
||||||
|
|
||||||
|
.SH EXAMPLES
|
||||||
|
Launch RaSCSI with no emulated drives attached:
|
||||||
|
rascsi
|
||||||
|
|
||||||
|
Launch RaSCSI with an Apple hard drive image as ID0 and a CD-ROM as ID 2
|
||||||
|
rascsi -ID0 /path/to/harddrive.hda -ID2 /path/to/cdimage.iso
|
||||||
|
|
||||||
|
To create an empty, 100MB HD image, use the following command:
|
||||||
|
dd if=/dev/zero of=/path/to/newimage.hda bs=512 count=204800
|
||||||
|
|
||||||
|
.SH SEE ALSO
|
||||||
|
rasctl(1), scsidump(1)
|
||||||
|
|
||||||
|
Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>
|
||||||
64
doc/rascsi_man_page.txt
Normal file
64
doc/rascsi_man_page.txt
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
rascsi(1) General Commands Manual rascsi(1)
|
||||||
|
|
||||||
|
NAME
|
||||||
|
rascsi - Emulates SCSI devices using the Raspberry Pi GPIO pins
|
||||||
|
|
||||||
|
SYNOPSIS
|
||||||
|
rascsi [-IDn file] [-HDn file]...
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
rascsi Emulates SCSI devices using the Raspberry Pi GPIO pins.
|
||||||
|
|
||||||
|
In the arguments to RaSCSI, one or more SCSI (-IDn) or SASI (-HDn) devices can be specified. The number (n)
|
||||||
|
after the ID or HD idnetifier specifies the ID number for that device. For SCSI: The ID is limited from 0-7.
|
||||||
|
However, typically SCSI ID 7 is reserved for the "initiator" (the host computer).Note that SASI is considered
|
||||||
|
rare and only used on very early Sharp X68000 computers.
|
||||||
|
|
||||||
|
RaSCSI will determin the type of device based upon the file extension of the FILE argument.
|
||||||
|
hdf: SASI Hard Disk image (XM6 SASI HD image - typically only used with X68000)
|
||||||
|
hds: SCSI Hard Disk image (XM6 SCSI HD image - typically only used with X68000)
|
||||||
|
hdn: SCSI Hard Disk image (NEC GENUINE)
|
||||||
|
hdi: SCSI Hard Disk image (Anex86 HD image)
|
||||||
|
nhd: SCSI Hard Disk image (T98Next HD image)
|
||||||
|
hda: SCSI Hard Disk image (APPLE GENUINE - typically used with Mac SCSI emulation)
|
||||||
|
mos: SCSI Magneto-optical image (XM6 SCSI MO image - typically only used with X68000)
|
||||||
|
iso: SCSI CD-ROM image (ISO 9660 image)
|
||||||
|
|
||||||
|
For example, if you want to specify an Apple-compatible HD image on ID 0, you can use the following command:
|
||||||
|
sudo rascsi -ID0 /path/to/drive/hdimage.hda
|
||||||
|
|
||||||
|
Once RaSCSI starts, it will open a socket (port 6868) to allow external management commands. If another
|
||||||
|
process is using port 6868, RaSCSI will terminate, since it is likely another instance of RaSCSI. Once
|
||||||
|
RaSCSI has initialized, the rasctl utility can be used to send commands.
|
||||||
|
|
||||||
|
To quit RaSCSI, press Control + C. If it is running in the background, you can kill it using an INT signal.
|
||||||
|
|
||||||
|
OPTIONS
|
||||||
|
-IDn FILE
|
||||||
|
n is the SCSI ID number (0-7)
|
||||||
|
|
||||||
|
FILE is the name of the image file to attach to that ID.
|
||||||
|
|
||||||
|
-HDn FILE
|
||||||
|
n is the SASI ID number (0-15)
|
||||||
|
|
||||||
|
FILE is the name of the image file to attach to that ID.
|
||||||
|
|
||||||
|
Note: SASI usage is rare, and is typically limited to early Sharp X68000 systems.
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
Launch RaSCSI with no emulated drives attached:
|
||||||
|
rascsi
|
||||||
|
|
||||||
|
Launch RaSCSI with an Apple hard drive image as ID0 and a CD-ROM as ID 2
|
||||||
|
rascsi -ID0 /path/to/harddrive.hda -ID2 /path/to/cdimage.iso
|
||||||
|
|
||||||
|
To create an empty, 100MB HD image, use the following command:
|
||||||
|
dd if=/dev/zero of=/path/to/newimage.hda bs=512 count=204800
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
rasctl(1), scsidump(1)
|
||||||
|
|
||||||
|
Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>
|
||||||
|
|
||||||
|
rascsi(1)
|
||||||
71
doc/rasctl.1
Normal file
71
doc/rasctl.1
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
.TH rascsi 1
|
||||||
|
.SH NAME
|
||||||
|
rasctl \- Sends management commands to the rascsi process
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B rasctl
|
||||||
|
\fB\-l\fR |
|
||||||
|
\fB\-i\fR \fIID\fR
|
||||||
|
[\fB\-u\fR \fIUNIT\fR]
|
||||||
|
[\fB\-c\fR \fICMD\fR]
|
||||||
|
[\fB\-t\fR \fITYPE\fR]
|
||||||
|
[\fB\-f\fR \fIFILE\fR]
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.B rasctl
|
||||||
|
Sends commands to the rascsi process to make configuration adjustments at runtime or to check the status of the devices.
|
||||||
|
|
||||||
|
Either the -i or -l option should be specified at one time. Not both.
|
||||||
|
|
||||||
|
You do NOT need root privileges to use rasctl.
|
||||||
|
|
||||||
|
Note: The command and type arguments are case insensitive. Only the first letter of the command/type are evaluated by the tool.
|
||||||
|
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
.BR \-l\fI
|
||||||
|
List all of the devices that are currently being emulated by RaSCSI, as well as their current status.
|
||||||
|
.TP
|
||||||
|
.BR \-i\fI " " \fIID
|
||||||
|
ID is the SCSI ID that you want to control. (0-7)
|
||||||
|
.TP
|
||||||
|
.BR \-u\fI " " \fIUNIT
|
||||||
|
Unit number (0 or 1). This will default to 0. This option is only used when there are multiple SCSI devices on a shared SCSI controller. (This is not common)
|
||||||
|
.TP
|
||||||
|
.BR \-c\fI " " \fICMD
|
||||||
|
Command is the operation being requested. options are:
|
||||||
|
attach: attach disk
|
||||||
|
detach: detach disk
|
||||||
|
insert: insert media (Magneto-Optical and CD only)
|
||||||
|
eject: eject media (Magneto-Optical and CD only)
|
||||||
|
protect: Write protect the media (Magneto-Optical only)
|
||||||
|
.IP
|
||||||
|
When the command is omited, rasctl will default to the 'attach' command
|
||||||
|
.TP
|
||||||
|
.BR \-t\fI " " \fITYPE
|
||||||
|
Specifies the type of disk. If this disagrees with the file extension of the specified image, the TYPE argument is ignored. Available drive types are:
|
||||||
|
hd: Hard disk (SCSI or SASI)
|
||||||
|
mo: Magneto-Optical disk)
|
||||||
|
cd: CD-ROM
|
||||||
|
bridge: Bridge device (This is only applicable to the Sharp X68000)
|
||||||
|
.TP
|
||||||
|
.BR \-f\fI " " \fIFILE
|
||||||
|
Path to the disk image file. See the rascsi(1) man page for allowable file types.
|
||||||
|
|
||||||
|
.SH EXAMPLES
|
||||||
|
Show a listing of all of the SCSI devices and their current status
|
||||||
|
rasctl -l
|
||||||
|
|
||||||
|
|
||||||
|
Example output:
|
||||||
|
+----+----+------+-------------------------------------
|
||||||
|
| ID | UN | TYPE | DEVICE STATUS
|
||||||
|
+----+----+------+-------------------------------------
|
||||||
|
| 0 | 1 | SCHD | /home/pi/harddisk.hda
|
||||||
|
+----+----+------+-------------------------------------
|
||||||
|
|
||||||
|
Request the RaSCSI process to attach a disk (assumed) to SCSI ID 0 with the contents of the file system image "HDIIMAGE0.HDS".
|
||||||
|
rasctl -i 0 -f HDIIMAGE0.HDS
|
||||||
|
|
||||||
|
.SH SEE ALSO
|
||||||
|
rascsi(1)
|
||||||
|
|
||||||
|
Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>
|
||||||
69
doc/rasctl_man_page.txt
Normal file
69
doc/rasctl_man_page.txt
Normal file
@@ -0,0 +1,69 @@
|
|||||||
|
rascsi(1) General Commands Manual rascsi(1)
|
||||||
|
|
||||||
|
NAME
|
||||||
|
rasctl - Sends management commands to the rascsi process
|
||||||
|
|
||||||
|
SYNOPSIS
|
||||||
|
rasctl -l | -i ID [-u UNIT] [-c CMD] [-t TYPE] [-f FILE]
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
rasctl Sends commands to the rascsi process to make configuration adjustments at runtime or to check the sta‐
|
||||||
|
tus of the devices.
|
||||||
|
|
||||||
|
Either the -i or -l option should be specified at one time. Not both.
|
||||||
|
|
||||||
|
You do NOT need root privileges to use rasctl.
|
||||||
|
|
||||||
|
Note: The command and type arguments are case insensitive. Only the first letter of the command/type are
|
||||||
|
evaluated by the tool.
|
||||||
|
|
||||||
|
OPTIONS
|
||||||
|
-l List all of the devices that are currently being emulated by RaSCSI, as well as their current status.
|
||||||
|
|
||||||
|
-i ID ID is the SCSI ID that you want to control. (0-7)
|
||||||
|
|
||||||
|
-u UNIT
|
||||||
|
Unit number (0 or 1). This will default to 0. This option is only used when there are multiple SCSI
|
||||||
|
devices on a shared SCSI controller. (This is not common)
|
||||||
|
|
||||||
|
-c CMD Command is the operation being requested. options are:
|
||||||
|
attach: attach disk
|
||||||
|
detach: detach disk
|
||||||
|
insert: insert media (Magneto-Optical and CD only)
|
||||||
|
eject: eject media (Magneto-Optical and CD only)
|
||||||
|
protect: Write protect the media (Magneto-Optical only)
|
||||||
|
|
||||||
|
When the command is omited, rasctl will default to the 'attach' command
|
||||||
|
|
||||||
|
-t TYPE
|
||||||
|
Specifies the type of disk. If this disagrees with the file extension of the specified image, the TYPE
|
||||||
|
argument is ignored. Available drive types are:
|
||||||
|
hd: Hard disk (SCSI or SASI)
|
||||||
|
mo: Magneto-Optical disk)
|
||||||
|
cd: CD-ROM
|
||||||
|
bridge: Bridge device (This is only applicable to the Sharp X68000)
|
||||||
|
|
||||||
|
-f FILE
|
||||||
|
Path to the disk image file. See the rascsi(1) man page for allowable file types.
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
Show a listing of all of the SCSI devices and their current status
|
||||||
|
rasctl -l
|
||||||
|
|
||||||
|
Example output:
|
||||||
|
+----+----+------+-------------------------------------
|
||||||
|
| ID | UN | TYPE | DEVICE STATUS
|
||||||
|
+----+----+------+-------------------------------------
|
||||||
|
| 0 | 1 | SCHD | /home/pi/harddisk.hda
|
||||||
|
+----+----+------+-------------------------------------
|
||||||
|
|
||||||
|
Request the RaSCSI process to attach a disk (assumed) to SCSI ID 0 with the contents of the file system image
|
||||||
|
"HDIIMAGE0.HDS".
|
||||||
|
rasctl -i 0 -f HDIIMAGE0.HDS
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
rascsi(1)
|
||||||
|
|
||||||
|
Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>
|
||||||
|
|
||||||
|
rascsi(1)
|
||||||
Reference in New Issue
Block a user