mirror of
https://github.com/akuker/RASCSI.git
synced 2024-09-12 09:55:00 +00:00
* Added messages * Comment update * Interface update * Support for localized descriptions * Sort operations * Completed meta data * rasctl -s returns operation meta data * Manpage update * Type update * Comment update * Description updates * Comment update * Added convenience method * Added convenience method * Code cleanup * Comment update * Display permitted values * For completeness sake added permitted boolean values * Added support for default value * Removed redundant message field * Description update * Description upddate * Squashed commit of the following: commit 8171c6ea27982c736c30c0db69a7fdde07ee10ce Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 12:43:14 2021 +0100 The data type is implicit commit fb01dc9d82e8ff7456b05a0cb9d08069adacc64c Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 12:37:49 2021 +0100 Renaming commit 057dbf1aca7be3f7e76a5ff89a582a276b6d3089 Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 12:29:54 2021 +0100 Comment update commit 5f699aad2f835f72accdb445d1e59f094aeb108f Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 12:24:25 2021 +0100 Signature update commit cbcf8b09f9d1ba7b82f816269bcfe91d9f00eb6e Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 12:22:45 2021 +0100 Signature update commit a8148ef802ca809e5a305d2caa69856c9033d932 Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 12:16:46 2021 +0100 Comment update commit ce685a92d4827e131d80d10ecd56e2b3baf173f8 Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 12:15:46 2021 +0100 Use map instead of list commit 454c0438f3589904f5dbe5253963dd200ea416dd Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 10:47:36 2021 +0100 Updated size check commit b386dbba4b0262f4f6f02aecb2a1daeffd41f4a2 Author: Uwe Seimet <Uwe.Seimet@seimet.de> Date: Sat Dec 18 01:23:43 2021 +0100 Initial improvements * Default value update * Comment update * Comment update * Map operations by ordinal * Added safeguard against unknown operations * Added cast * Data type update * Sort map by operation name * Renaming * Code cleanup * Comment update * Renaming * Comment update * Description updates * Fixed typo * Added operation * Logging update * Interface comment update * Fixed typo * Aded operation parameters * Updated handling of mandatory parameters * Updated assertion handling * Added missing condition * Removed duplicate cod3 * Code cleanup * Logging update * Removed duplicate code * Code cleanup * Squashed commit of the following: commit4ae273ccbd
Author: akuker <34318535+akuker@users.noreply.github.com> Date: Sun Dec 19 22:30:22 2021 -0600 Loopback tester pcb (#545) commit46c5c1966f
Author: akuker <34318535+akuker@users.noreply.github.com> Date: Sun Dec 19 22:29:59 2021 -0600 RaSCSI Zero version 1.0 (#546) commitd09df31d67
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 20:25:23 2021 -0800 Remove redundant code from OLED script (#547) commitd8828da690
Author: akuker <34318535+akuker@users.noreply.github.com> Date: Sun Dec 19 21:02:50 2021 -0600 Added list of sponsors commitbcd7e8396d
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:51:45 2021 -0800 Second attempt at properly creating the manpage dir (#542) commitc887edfc8c
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:50:03 2021 -0800 Remove special elevated privileges for the Web Interface (#536) * Use the pi_shutdown method to restart the rascsi service * Use the pi_shutdown method to restart the rascsi service * Remove modifications to sudoers no longer needed * Introduce sleeps attempting to connect to socket; reduce overall number of retries * Remove systemd helped methods and the functionality that depends on it * Attempts to speed up splash code * Remove unneccessary verbosity * Attempt to optimize service definition commit801aebfb96
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:47:22 2021 -0800 More readable message when downloading a file (#531) commit29cf58288f
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:47:03 2021 -0800 Add a warning notice when ejecting removable media (#526) commit7efa895239
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:46:22 2021 -0800 Unzip zipfiles before storing to iso (#525) * Unzip zipfiles before storing to iso * Add helptext * Skip unzip for MacZip format * Should not be an fstring commit39bc485671
Author: Daniel Markstedt <markstedt@gmail.com> Date: Sun Dec 19 15:28:22 2021 -0800 Add pip3 to global dependencies; remove duplicates from monitor_rascs… (#523) * Add pip3 to global dependencies; remove duplicates from monitor_rascsi dependencies * Cleanup * Shutdown functionality is only available if started with root permissions * Only restrict shutdown parameters, not everything if not root * Updated operation count check
174 lines
5.5 KiB
Groff
174 lines
5.5 KiB
Groff
.TH rascsi 1
|
|
.SH NAME
|
|
rasctl \- Sends management commands to the rascsi process
|
|
.SH SYNOPSIS
|
|
.B rasctl
|
|
\fB\-e\fR |
|
|
\fB\-l\fR |
|
|
\fB\-m\fR |
|
|
\fB\-o\fR |
|
|
\fB\-s\fR |
|
|
\fB\-v\fR |
|
|
\fB\-D\fR |
|
|
\fB\-I\fR |
|
|
\fB\-L\fR |
|
|
\fB\-O\fR |
|
|
\fB\-P\fR |
|
|
\fB\-T\fR |
|
|
\fB\-V\fR |
|
|
\fB\-X\fR |
|
|
[\fB\-C\fR \fIFILENAME:FILESIZE\fR]
|
|
[\fB\-E\fR \fIFILENAME\fR]
|
|
[\fB\-F\fR \fIIMAGE_FOLDER\fR]
|
|
[\fB\-R\fR \fICURRENT_NAME:NEW_NAME\fR]
|
|
[\fB\-c\fR \fICMD\fR]
|
|
[\fB\-f\fR \fIFILE|PARAM\fR]
|
|
[\fB\-g\fR \fILOG_LEVEL\fR]
|
|
[\fB\-h\fR \fIHOST\fR]
|
|
[\fB\-i\fR \fIID\fR
|
|
[\fB\-n\fR \fINAME\fR]
|
|
[\fB\-p\fR \fIPORT\fR]
|
|
[\fB\-r\fR \fIRESERVED_IDS\fR]
|
|
[\fB\-t\fR \fITYPE\fR]
|
|
[\fB\-u\fR \fIUNIT\fR]
|
|
[\fB\-x\fR \fICURRENT_NAME:NEW_NAME\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 is evaluated by the tool.
|
|
|
|
.SH OPTIONS
|
|
.TP
|
|
.BR \-C\fI " "\fIFILENAME:FILESIZE
|
|
Create an image file in the default image folder with the specified name and size in bytes.
|
|
.TP
|
|
.BR \-D\fI
|
|
Detach all devices.
|
|
.TP
|
|
.BR \-E\fI " " \fIFILENAME
|
|
Display information on an image file.
|
|
.TP
|
|
.BR \-F\fI " "\fIIMAGE_FOLDER
|
|
Set the default image folder.
|
|
.TP
|
|
.BR \-I\fI
|
|
Gets the list of reserved device IDs.
|
|
.TP
|
|
.BR \-L\fI " "\fILOG_LEVEL
|
|
Set the rascsi log level (trace, debug, info, warn, err, critical, off).
|
|
.TP
|
|
.BR \-h\fI " " \fIHOST
|
|
The rascsi host to connect to, default is 'localhost'.
|
|
.TP
|
|
.BR \-e\fI
|
|
List all images files in the default image folder.
|
|
.TP
|
|
.BR \-N\fI
|
|
Lists all available network interfaces provided that they are up.
|
|
.TP
|
|
.BR \-O\fI
|
|
Display the available rascsi server log levels and the current log level.
|
|
.TP
|
|
.BR \-P\fI
|
|
Prompt for the access token in case rascsi requires authentication.
|
|
.TP
|
|
.BR \-l\fI
|
|
List all of the devices that are currently being emulated by RaSCSI, as well as their current status.
|
|
.TP
|
|
.BR \-m\fI
|
|
List all file extensions recognized by RaSCSI and the device types they map to.
|
|
.TP
|
|
.BR \-o\fI
|
|
Display operation meta data information.
|
|
.TP
|
|
.BR \-R\fI " "\fICURRENT_NAME:NEW_NAME
|
|
Rename an image file in the default image folder.
|
|
.TP
|
|
.BR \-p\fI " " \fIPORT
|
|
The rascsi port to connect to, default is 6868.
|
|
.TP
|
|
.BR \-r\fI " " \fIRESERVED_IDS
|
|
Comma-separated list of IDs to reserve.
|
|
.TP
|
|
.BR \-s\fI
|
|
Display server-side settings like available images or supported device types.
|
|
.TP
|
|
.BR \-T\fI
|
|
Display all device types and their properties.
|
|
.TP
|
|
.BR \-v\fI " " \fI
|
|
Display the rascsi server version.
|
|
.TP
|
|
.BR \-V\fI " " \fI
|
|
Display the rasctl version.
|
|
.TP
|
|
.BR \-X\fI " " \fI
|
|
Shut down the rascsi process.
|
|
.TP
|
|
.BR \-d\fI " "\fIFILENAME
|
|
Delete an image file in the default image folder.
|
|
.TP
|
|
.BR \-x\fI " "\fICURRENT_NAME:NEW_NAME
|
|
Copy an image file in the default image folder.
|
|
.TP
|
|
.BR \-i\fI " " \fIID
|
|
ID is the SCSI ID that you want to control. (0-7)
|
|
.TP
|
|
.BR \-c\fI " " \fICMD
|
|
Command is the operation being requested. Options are:
|
|
a(ttach): Attach disk
|
|
d(etach): Detach disk
|
|
i(nsert): Insert media (removable media devices only)
|
|
e(ject): Eject media (removable media devices only)
|
|
p(rotect): Write protect 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
|
|
.IP
|
|
eject, protect and unprotect are idempotent.
|
|
.TP
|
|
.BR \-b\fI " " \fIBLOCK_SIZE
|
|
The optional block size. For SCSI drives 512, 1024, 2048 or 4096 bytes, default size is 512 bytes. For SASI drives 256 or 1024 bytes, default is 256 bytes.
|
|
.TP
|
|
.BR \-f\fI " " \fIFILE|PARAM
|
|
Device-specific: Either a path to a disk image file, or a parameter for a non-disk device. See the rascsi(1) man page for permitted file types.
|
|
.TP
|
|
.BR \-t\fI " " \fITYPE
|
|
Specifies the device type. This type overrides the type derived from the file extension of the specified image. See the rascsi(1) man page for the available device types. For some types there are shortcuts (only the first letter is required):
|
|
hd: SCSI hard disk drive
|
|
rm: SCSI removable media drive
|
|
cd: CD-ROM
|
|
mo: Magneto-Optical disk
|
|
bridge: Bridge device (Only applicable to the Sharp X68000)
|
|
daynaport: DaynaPORT network adapter
|
|
.TP
|
|
.BR \-n\fI " " \fIVENDOR:PRODUCT:REVISION
|
|
The vendor, product and revision for the device, to be returned with the INQUIRY data. A complete set of name components must be provided. VENDOR may have up to 8, PRODUCT up to 16, REVISION up to 4 characters. Padding with blanks to the maxium length is automatically applied. Once set the name of a device cannot be changed.
|
|
.TP
|
|
.BR \-u\fI " " \fIUNIT
|
|
Unit number (0-31). 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)
|
|
|
|
.SH EXAMPLES
|
|
Show a listing of all of the SCSI devices and their current status.
|
|
rasctl -l
|
|
|
|
|
|
Example output:
|
|
+----+-----+------+-------------------------------------
|
|
| ID | LUN | TYPE | IMAGE FILE
|
|
+----+-----+------+-------------------------------------
|
|
| 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), scsimon(1), rasdump(1), sasidump(1)
|
|
|
|
Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>
|