Macintosh-HW/RASCSI
1
0
Fork 0
mirror of https://github.com/akuker/RASCSI.git synced 2024-11-29 01:49:19 +00:00
Code Issues Projects Releases Wiki Activity

Updated man page txts after running make docs (#885)

Browse Source
This commit is contained in:
Daniel Markstedt 2022-10-03 11:35:19 -07:00 committed by GitHub
parent 2dae021cdd
commit c80953e0a4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 97 additions and 151 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

127
doc/rascsi_man_page.txt
View File

@ -1,117 +1,92 @@
!! ------ THIS FILE IS AUTO_GENERATED! DO NOT MANUALLY UPDATE!!! !! ------ THIS FILE IS AUTO_GENERATED! DO NOT MANUALLY UPDATE!!!
!! ------ The native file is rascsi.1. Re-run 'make docs' after updating\n\n !! ------ 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 NAME
rascsi - Emulates SCSI devices using the Raspberry Pi GPIO pins rascsi - Emulates SCSI devices using the Raspberry Pi GPIO pins
SYNOPSIS SYNOPSIS
rascsi [-F[u00AE] FOLDER] [-L[u00AE] LOG_LEVEL] [-P[u00AE] ACCESS_TO‐ rascsi [-F[u00AE] FOLDER] [-L[u00AE] LOG_LEVEL] [-P[u00AE] ACCESS_TOKEN_FILE] [-R SCAN_DEPTH] [-h] [-n VENDOR:PRODUCT:REVI‐
KEN_FILE] [-R SCAN_DEPTH] [-h] [-n VENDOR:PRODUCT:REVISION] [-p[u00AE] SION] [-p[u00AE] PORT] [-r RESERVED_IDS] [-n TYPE] [-v] [-z LOCALE] [-IDn:[u] FILE] [-HDn[:u] FILE]...
PORT] [-r RESERVED_IDS] [-n TYPE] [-v] [-z LOCALE] [-IDn:[u] FILE]
[-HDn[:u] FILE]...
DESCRIPTION DESCRIPTION
rascsi Emulates SCSI devices using the Raspberry Pi GPIO pins. rascsi emulates SCSI devices using the Raspberry Pi GPIO pins.
In the arguments to RaSCSI, one or more SCSI (-IDn[:u]) devices can be In the arguments to RaSCSI, one or more SCSI (-IDn[:u]) devices can be specified. The number (n) after the ID or HD iden‐
specified. The number (n) after the ID or HD identifier specifies the tifier specifies the ID number for that device. The optional number (u) specifies the LUN (logical unit) for that device.
ID number for that device. The optional number (u) specifies the LUN The default LUN is 0. For SCSI: The ID is limited from 0-7. However, typically SCSI ID 7 is reserved for the "initiator"
(logical unit) for that device. The default LUN is 0. For SCSI: The ID (the host computer). The LUN is limited from 0-31.
is limited from 0-7. However, typically SCSI ID 7 is reserved for the
"initiator" (the host computer). The LUN is limited from 0-31.
RaSCSI will determine the type of device based upon the file extension RaSCSI will determine the type of device based upon the file extension of the FILE argument.
of the FILE argument.
hd1: SCSI Hard Disk image (generic, non-removable, SCSI-1) hd1: SCSI Hard Disk image (generic, non-removable, SCSI-1)
hds: SCSI Hard Disk image (generic, non-removable) hds: SCSI Hard Disk image (generic, non-removable)
hdr: SCSI Hard Disk image (generic, removable) hdr: SCSI Hard Disk image (generic, removable)
hdn: SCSI Hard Disk image (NEC GENUINE) hdn: SCSI Hard Disk image (NEC compatible - only used with PC-98 computers)
hdi: SCSI Hard Disk image (Anex86 HD image) hdi: SCSI Hard Disk image (Anex86 proprietary - only used with PC-98 computers)
nhd: SCSI Hard Disk image (T98Next HD image) nhd: SCSI Hard Disk image (T98Next proprietary - only used with PC-98 computers)
hda: SCSI Hard Disk image (APPLE GENUINE - typically used with Mac hda: SCSI Hard Disk image (Apple compatible - typically used with Macintosh computers)
SCSI emulation) mos: SCSI Magneto-Optical image (generic - typically used with NeXT, X68000, etc.)
mos: SCSI Magneto-optical image (XM6 SCSI MO image - typically only iso: SCSI CD-ROM or DVD-ROM image (ISO 9660 image)
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 For example, if you want to specify an Apple-compatible HD image on ID 0, you can use the following command:
0, you can use the following command:
sudo rascsi -ID0 /path/to/drive/hdimage.hda sudo rascsi -ID0 /path/to/drive/hdimage.hda
Once RaSCSI starts, it will open a socket (default port is 6868) to al‐ Once RaSCSI starts, it will open a socket (default port is 6868) to allow external management commands. If another process
low external management commands. If another process is using the is using the rascsi port, RaSCSI will terminate, since it is likely another instance of RaSCSI. Once RaSCSI has initial‐
rascsi port, RaSCSI will terminate, since it is likely another instance ized, the rasctl utility can be used to send commands.
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, To quit RaSCSI, press Control + C. If it is running in the background, you can kill it using an INT signal.
you can kill it using an INT signal.
OPTIONS OPTIONS
-b BLOCK_SIZE -b BLOCK_SIZE
The optional block size, either 512, 1024, 2048 or 4096 bytes. The optional block size, either 512, 1024, 2048 or 4096 bytes. Default size is 512 bytes.
Default size is 512 bytes.
-F FOLDER -F FOLDER
The default folder for image files. For files in this folder no The default folder for image files. For files in this folder no absolute path needs to be specified. The initial de‐
absolute path needs to be specified. The initial default folder fault folder is '~/images'.
is '~/images'.
-L LOG_LEVEL -L LOG_LEVEL
The rascsi log level (trace, debug, info, warn, err, critical, The rascsi log level (trace, debug, info, warn, err, critical, off). The default log level is 'info'.
off). The default log level is 'info'.
-P ACCESS_TOKEN_FILE -P ACCESS_TOKEN_FILE
Enable authentication and read the access token from the speci‐ Enable authentication and read the access token from the specified file. The access token file must be owned by root
fied file. The access token file must be owned by root and must and must be readable by root only.
be readable by root only.
-R SCAN_DEPTH -R SCAN_DEPTH
Scan for image files recursively, up to a depth of SCAN_DEPTH. Scan for image files recursively, up to a depth of SCAN_DEPTH. Depth 0 means to ignore any folders within the de‐
Depth 0 means to ignore any folders within the default image fault image filder. Be careful when using this option with many sub-folders in the default image folder. The default
filder. Be careful when using this option with many sub-folders depth is 1.
in the default image folder. The default depth is 1.
-h Show a help page. -h Show a help page.
-n VENDOR:PRODUCT:REVISION -n VENDOR:PRODUCT:REVISION
Set the vendor, product and revision for the device, to be re‐ Set the vendor, product and revision for the device, to be returned with the INQUIRY data. A complete set of name
turned with the INQUIRY data. A complete set of name components components must be provided. VENDOR may have up to 8, PRODUCT up to 16, REVISION up to 4 characters. Padding with
must be provided. VENDOR may have up to 8, PRODUCT up to 16, RE‐ blanks to the maxium length is automatically applied. Once set the name of a device cannot be changed.
VISION up to 4 characters. Padding with blanks to the maxium
length is automatically applied. Once set the name of a device
cannot be changed.
-p PORT -p PORT
The rascsi server port, default is 6868. The rascsi server port, default is 6868.
-r RESERVED_IDS -r RESERVED_IDS
Comma-separated list of IDs to reserve. Pass an empty list in Comma-separated list of IDs to reserve. Pass an empty list in order to not reserve anything. -p TYPE The optional
order to not reserve anything. -p TYPE The optional case-insen‐ case-insensitive device type (SAHD, SCHD, SCRM, SCCD, SCMO, SCBR, SCDP, SCLP, SCHS). If no type is specified for de‐
sitive device type (SAHD, SCHD, SCRM, SCCD, SCMO, SCBR, SCDP, vices that support an image file, rascsi tries to derive the type from the file extension.
SCLP, SCHS). If no type is specified for devices that support an
image file, rascsi tries to derive the type from the file exten‐
sion.
-v Display the rascsi version. -v Display the rascsi version.
-z LOCALE -z LOCALE
Overrides the default locale for client-faces error messages. Overrides the default locale for client-faces error messages. The client can override the locale.
The client can override the locale.
-IDn[:u] FILE -IDn[:u] FILE
n is the SCSI ID number (0-7). u (0-31) is the optional LUN n is the SCSI ID number (0-7). u (0-31) is the optional LUN (logical unit). The default LUN is 0.
(logical unit). The default LUN is 0.
FILE is the name of the image file to use for the SCSI device. FILE is the name of the image file to use for the SCSI device. For devices that do not support an image file (SCBR,
For devices that do not support an image file (SCBR, SCDP, SCLP, SCDP, SCLP, SCHS) the filename may have a special meaning or a dummy name can be provided. For SCBR and SCDP it is
SCHS) the filename may have a special meaning or a dummy name an optioinal prioritized list of network interfaces, an optional IP address and netmask, e.g. "inter‐
can be provided. For SCBR and SCDP it is an optioinal priori‐ faces=eth0,eth1,wlan0:inet=10.10.20.1/24". For SCLP it is the print command to be used and a reservation timeout in
tized list of network interfaces, an optional IP address and seconds, e.g. "cmd=lp -oraw %f:timeout=60".
netmask, e.g. "interfaces=eth0,eth1,wlan0:inet=10.10.20.1/24".
For SCLP it is the print command to be used and a reservation
timeout in seconds, e.g. "cmd=lp -oraw %f:timeout=60".
FILE is the name of the image file to use for the SCSI device. FILE is the name of the image file to use for the SCSI device.
@ -119,26 +94,22 @@ EXAMPLES
Launch RaSCSI with no emulated drives attached: Launch RaSCSI with no emulated drives attached:
rascsi rascsi
Launch RaSCSI with an Apple hard drive image as ID 0 and a CD-ROM as ID Launch RaSCSI with an Apple hard drive image as ID 0 and a CD-ROM as ID 2
2
rascsi -ID0 /path/to/harddrive.hda -ID2 /path/to/cdimage.iso rascsi -ID0 /path/to/harddrive.hda -ID2 /path/to/cdimage.iso
Launch RaSCSI with a removable SCSI drive image as ID 0 and the raw de‐ Launch RaSCSI with a removable SCSI drive image as ID 0 and the raw device file /dev/hdb (e.g. a USB stick) and a DaynaPort
vice file /dev/hdb (e.g. a USB stick) and a DaynaPort network adapter network adapter as ID 6:
as ID 6:
rascsi -ID0 -t scrm /dev/hdb -ID6 -t scdp daynaport rascsi -ID0 -t scrm /dev/hdb -ID6 -t scdp daynaport
To create an empty, 100MiB HD image, use the following command: To create an empty, 100MiB HD image, use the following command:
dd if=/dev/zero of=/path/to/newimage.hda bs=512 count=204800 dd if=/dev/zero of=/path/to/newimage.hda bs=512 count=204800
In case the fallocate command is available a much faster alternative to In case the fallocate command is available a much faster alternative to the dd command is:
the dd command is:
fallocate -l 104857600 /path/to/newimage.hda fallocate -l 104857600 /path/to/newimage.hda
SEE ALSO SEE ALSO
rasctl(1), scsimon(1), rasdump(1), sasidump(1) rasctl(1), scsimon(1), rasdump(1), sasidump(1)
Full documentation is available at: Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>
<https://www.github.com/akuker/RASCSI/wiki/>
rascsi(1) rascsi(1)

89
doc/rasctl_man_page.txt
View File

@ -1,32 +1,31 @@
!! ------ THIS FILE IS AUTO_GENERATED! DO NOT MANUALLY UPDATE!!! !! ------ THIS FILE IS AUTO_GENERATED! DO NOT MANUALLY UPDATE!!!
!! ------ The native file is rasctl.1. Re-run 'make docs' after updating\n\n !! ------ 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 NAME
rasctl - Sends management commands to the rascsi process rasctl - Sends management commands to the rascsi process
SYNOPSIS SYNOPSIS
rasctl -e | -l | -m | -o | -s | -v | -D | -I | -L | -O | -P | -T | -V | rasctl -e | -l | -m | -o | -s | -v | -D | -I | -L | -O | -P | -T | -V | -X | [-C FILENAME:FILESIZE] [-E FILENAME] [-F IM‐
-X | [-C FILENAME:FILESIZE] [-E FILENAME] [-F IMAGE_FOLDER] [-R CUR‐ AGE_FOLDER] [-R CURRENT_NAME:NEW_NAME] [-c CMD] [-f FILE|PARAM] [-g LOG_LEVEL] [-h HOST] [-i ID [-n NAME] [-p PORT] [-r RE‐
RENT_NAME:NEW_NAME] [-c CMD] [-f FILE|PARAM] [-g LOG_LEVEL] [-h HOST] SERVED_IDS] [-t TYPE] [-u UNIT] [-x CURRENT_NAME:NEW_NAME] [-z LOCALE]
[-i ID [-n NAME] [-p PORT] [-r RESERVED_IDS] [-t TYPE] [-u UNIT] [-x
CURRENT_NAME:NEW_NAME] [-z LOCALE]
DESCRIPTION DESCRIPTION
rasctl Sends commands to the rascsi process to make configuration ad‐ rasctl sends commands to the rascsi process to make configuration adjustments at runtime or to check the status of the de‐
justments at runtime or to check the status of the devices. vices.
Either the -i or -l option should be specified at one time. Not both. Either the -i or -l option should be specified at one time. Not both.
You do NOT need root privileges to use rasctl. You do NOT need root privileges to use rasctl.
Note: The command and type arguments are case insensitive. Only the Note: The command and type arguments are case insensitive. Only the first letter of the command/type is evaluated by the
first letter of the command/type is evaluated by the tool. tool.
OPTIONS OPTIONS
-C FILENAME:FILESIZE -C FILENAME:FILESIZE
Create an image file in the default image folder with the speci‐ Create an image file in the default image folder with the specified name and size in bytes.
fied name and size in bytes.
-D Detach all devices. -D Detach all devices.
@ -39,28 +38,22 @@ OPTIONS
-I Gets the list of reserved device IDs. -I Gets the list of reserved device IDs.
-L LOG_LEVEL -L LOG_LEVEL
Set the rascsi log level (trace, debug, info, warn, err, criti‐ Set the rascsi log level (trace, debug, info, warn, err, critical, off).
cal, off).
-h HOST -h HOST
The rascsi host to connect to, default is 'localhost'. The rascsi host to connect to, default is 'localhost'.
-e List all images files in the default image folder. -e List all images files in the default image folder.
-N Lists all available network interfaces provided that they are -N Lists all available network interfaces provided that they are up.
up.
-O Display the available rascsi server log levels and the current -O Display the available rascsi server log levels and the current log level.
log level.
-P Prompt for the access token in case rascsi requires authentica‐ -P Prompt for the access token in case rascsi requires authentication.
tion.
-l List all of the devices that are currently being emulated by -l List all of the devices that are currently being emulated by RaSCSI, as well as their current status.
RaSCSI, as well as their current status.
-m List all file extensions recognized by RaSCSI and the device -m List all file extensions recognized by RaSCSI and the device types they map to.
types they map to.
-o Display operation meta data information. -o Display operation meta data information.
@ -71,11 +64,9 @@ OPTIONS
The rascsi port to connect to, default is 6868. The rascsi port to connect to, default is 6868.
-r RESERVED_IDS -r RESERVED_IDS
Comma-separated list of IDs to reserve. Pass an empty list in Comma-separated list of IDs to reserve. Pass an empty list in order to not reserve anything.
order to not reserve anything.
-s Display server-side settings like available images or supported -s Display server-side settings like available images or supported device types.
device types.
-T Display all device types and their properties. -T Display all device types and their properties.
@ -101,28 +92,23 @@ OPTIONS
d(etach): Detach disk d(etach): Detach disk
i(nsert): Insert media (removable media devices only) i(nsert): Insert media (removable media devices only)
e(ject): Eject media (removable media devices only) e(ject): Eject media (removable media devices only)
p(rotect): Write protect the medium (not for CD-ROMs, which p(rotect): Write protect the medium (not for CD-ROMs, which are always read-only)
are always read-only) u(nprotect): Remove write protection from the medium (not for CD-ROMs, which are always read-only)
u(nprotect): Remove write protection from the medium (not for
CD-ROMs, which are always read-only)
s(how): Display device information s(how): Display device information
eject, protect and unprotect are idempotent. eject, protect and unprotect are idempotent.
-b BLOCK_SIZE -b BLOCK_SIZE
The optional block size, either 512, 1024, 2048 or 4096 bytes. The optional block size, either 512, 1024, 2048 or 4096 bytes. The default size is 512 bytes.
The default size is 512 bytes.
-f FILE|PARAM -f FILE|PARAM
Device-specific: Either a path to a disk image file, or a param‐ Device-specific: Either a path to a disk image file, or a parameter for a non-disk device. See the rascsi(1) man
eter for a non-disk device. See the rascsi(1) man page for per‐ page for permitted file types.
mitted file types.
-t TYPE -t TYPE
Specifies the device type. This type overrides the type derived Specifies the device type. This type overrides the type derived from the file extension of the specified image. See
from the file extension of the specified image. See the the rascsi(1) man page for the available device types. For some types there are shortcuts (only the first letter is
rascsi(1) man page for the available device types. For some required):
types there are shortcuts (only the first letter is required):
hd: SCSI hard disk drive hd: SCSI hard disk drive
rm: SCSI removable media drive rm: SCSI removable media drive
cd: CD-ROM cd: CD-ROM
@ -133,17 +119,13 @@ OPTIONS
services: Host services device services: Host services device
-n VENDOR:PRODUCT:REVISION -n VENDOR:PRODUCT:REVISION
The vendor, product and revision for the device, to be returned The vendor, product and revision for the device, to be returned with the INQUIRY data. A complete set of name compo‐
with the INQUIRY data. A complete set of name components must be nents must be provided. VENDOR may have up to 8, PRODUCT up to 16, REVISION up to 4 characters. Padding with blanks
provided. VENDOR may have up to 8, PRODUCT up to 16, REVISION up to the maxium length is automatically applied. Once set the name of a device cannot be changed.
to 4 characters. Padding with blanks to the maxium length is au‐
tomatically applied. Once set the name of a device cannot be
changed.
-u UNIT -u UNIT
Unit number (0-31). This will default to 0. This option is only Unit number (0-31). This will default to 0. This option is only used when there are multiple SCSI devices on a
used when there are multiple SCSI devices on a shared SCSI con‐ shared SCSI controller. (This is not common)
troller. (This is not common)
EXAMPLES 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.
@ -156,14 +138,13 @@ EXAMPLES
| 0 | 1 | SCHD | /home/pi/harddisk.hda | 0 | 1 | SCHD | /home/pi/harddisk.hda
+----+-----+------+------------------------------------- +----+-----+------+-------------------------------------
Request the RaSCSI process to attach a disk (assumed) to SCSI ID 0 with Request the RaSCSI process to attach a disk (assumed) to SCSI ID 0 with the contents of the file system image "HDIIM‐
the contents of the file system image "HDIIMAGE0.HDS". AGE0.HDS".
rasctl -i 0 -f HDIIMAGE0.HDS rasctl -i 0 -f HDIIMAGE0.HDS
SEE ALSO SEE ALSO
rascsi(1), scsimon(1), rasdump(1), sasidump(1) rascsi(1), scsimon(1), rasdump(1), sasidump(1)
Full documentation is available at: Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>
<https://www.github.com/akuker/RASCSI/wiki/>
rascsi(1) rascsi(1)

20
doc/scsimon_man_page.txt
View File

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