Macintosh-HW/RASCSI
1
0
Fork 0
mirror of https://github.com/akuker/RASCSI.git synced 2024-06-13 23:29:30 +00:00
Code Issues Projects Releases Wiki Activity

Regenerated text versions of man pages. This was missed in PR #110

Browse Source
This commit is contained in:
akuker 2021-06-22 19:30:33 -05:00
parent 51210a7002
commit 7dd93728f9
3 changed files with 74 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
doc/rascsi_man_page.txt
View File

@ -2,7 +2,7 @@
!! ------ The native file is rascsi.1. Re-run 'make docs' after updating
rascsi(1) General Commands Manual rascsi(1)
rascsi(1) General Commands Manual rascsi(1)
NAME
rascsi - Emulates SCSI devices using the Raspberry Pi GPIO pins
@ -13,27 +13,40 @@ SYNOPSIS
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 com‐
puters.
In the arguments to RaSCSI, one or more SCSI (-IDn) or SASI (-HDn) de‐
vices can be specified. The number (n) after the ID or HD identifier
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)
RaSCSI will determine 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)
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:
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 in‐
stance of RaSCSI. Once RaSCSI has initialized, the rasctl utility can be used to send commands.
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 com‐
mands.
To quit RaSCSI, press Control + C. If it is running in the background, you can kill it using an INT signal.
To quit RaSCSI, press Control + C. If it is running in the background,
you can kill it using an INT signal.
OPTIONS
-IDn FILE
@ -46,13 +59,15 @@ OPTIONS
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.
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
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:
@ -61,6 +76,7 @@ EXAMPLES
SEE ALSO
rasctl(1), scsimon(1)
Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>
Full documentation is available at:
<https://www.github.com/akuker/RASCSI/wiki/>
rascsi(1)
rascsi(1)

38
doc/rasctl_man_page.txt
View File

@ -2,7 +2,7 @@
!! ------ The native file is rasctl.1. Re-run 'make docs' after updating
rascsi(1) General Commands Manual rascsi(1)
rascsi(1) General Commands Manual rascsi(1)
NAME
rasctl - Sends management commands to the rascsi process
@ -11,21 +11,26 @@ 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 status of the devices.
rasctl Sends commands to the rascsi process to make configuration ad‐
justments 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.
Note: The command and type arguments are case insensitive. Only the
first letter of the command/type is evaluated by the tool.
OPTIONS
-l List all of the devices that are currently being emulated by RaSCSI, as well as their current status.
-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)
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
@ -34,20 +39,25 @@ OPTIONS
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
When the command is omitted, 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:
Specifies the type of disk. If this disagrees with the file ex‐
tension 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)
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.
Path to the disk image file. See the rascsi(1) man page for al‐
lowable file types.
EXAMPLES
Show a listing of all of the SCSI devices and their current status
Show a listing of all of the SCSI devices and their current status.
rasctl -l
Example output:
@ -57,12 +67,14 @@ EXAMPLES
| 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".
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) scsimon(1)
Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>
Full documentation is available at:
<https://www.github.com/akuker/RASCSI/wiki/>
rascsi(1)
rascsi(1)

25
doc/scsimon_man_page.txt
View File

@ -2,21 +2,26 @@
!! ------ The native file is scsimon.1. Re-run 'make docs' after updating
scsimon(1) General Commands Manual scsimon(1)
scsimon(1) General Commands Manual scsimon(1)
NAME
scsimon - Acts as a data capture tool for all traffic on the SCSI bus. Data is stored in a Value Change Dump (VCD) file.
scsimon - Acts as a data capture tool for all traffic on the SCSI bus.
Data is stored in a Value Change Dump (VCD) file.
SYNOPSIS
scsimon
DESCRIPTION
scsimon Monitors all of the traffic on the SCSI bus, using a RaSCSI device. The data is cached in memory while the tool is running. A circular buffer is used so that only the most recent 1,000,000
transactions are stored. The tool will continue to run until the user presses CTRL-C, or the process receives a SIGINT signal.
scsimon Monitors all of the traffic on the SCSI bus, using a RaSCSI de‐
vice. The data is cached in memory while the tool is running. A circu‐
lar buffer is used so that only the most recent 1,000,000 transactions
are stored. The tool will continue to run until the user presses CTRL-
C, or the process receives a SIGINT signal.
The logged data is stored in a file called "log.vcd" in the current working directory from where scsimon was launched.
The logged data is stored in a file called "log.vcd" in the current
working directory from where scsimon was launched.
Currently, scsimon doesn't accept any agruments.
Currently, scsimon doesn't accept any arguments.
To quit scsimon, press Control + C.
@ -24,12 +29,14 @@ OPTIONS
None
EXAMPLES
Launch scsimon to capture all SCSI traffic available to the RaSCSI hardware:
Launch scsimon to capture all SCSI traffic available to the RaSCSI
hardware:
scsimon
SEE ALSO
rasctl(1), rascsi(1)
Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>
Full documentation is available at:
<https://www.github.com/akuker/RASCSI/wiki/>
scsimon(1)
scsimon(1)