mirror of
https://github.com/akuker/RASCSI.git
synced 2024-06-26 07:29:31 +00:00
* PbDevice returns information on whether a device is removable * Fixed log message * Added additional status data (ejectable, protctable, removable) * Assume ejectable == removable * Removed obsolete fields * Added locked/lockable to interface * Code review * Logging update * The user should be allowed to also write protect hard disk drives * Updated error handling * Testing * INSERT also has to search in the default file folder * Added TODO * Manpage update * Message updates * Moved some sanity checks to the server, so that they are run for any client * Updated error handling * Moved CR/LF handling to the client, the server should not format too much * rascsi should not mention "rasctl" in its messages, there may be other clients * Improved error messages * Improved error handling by returning an error string * Added TODO * Moved check for duplicate ID to ProcessCmd() * Removed debug output * Moved include * Removed obsolete includes, updated includes * Reverted ready check * Fixed error messages * Added convenience method * Simplified error handling * Socket/error handling review * "NO MEDIA" is added by the client, not by the server * Added missing include * Only check for duplicate ID when attaching a device * Added type/string converters for PbDeviceType * PbDevice indicates whether image files are supported * Write-protecing a read-only devices is not treated as an error anymore * Updated read-only check * Made difference between read-only and protected more explicit * Added comment * Comment update * Made hard disk drives write-protectable by the user * Resolved https://github.com/akuker/RASCSI/issues/166 * Addressing compiler error - type needs to be initialized Co-authored-by: akuker <akuker@gmail.com>
93 lines
2.9 KiB
Groff
93 lines
2.9 KiB
Groff
.TH rascsi 1
|
|
.SH NAME
|
|
rasctl \- Sends management commands to the rascsi process
|
|
.SH SYNOPSIS
|
|
.B rasctl
|
|
\fB\-l\fR |
|
|
\fB\-s\fR |
|
|
[\fB\-g\fR \fILOG_LEVEL\fR]
|
|
[\fB\-h\fR \fIHOST\fR]
|
|
[\fB\-p\fR \fIPORT\fR]
|
|
[\fB\-v\fR]
|
|
\fB\-i\fR \fIID\fR
|
|
[\fB\-c\fR \fICMD\fR]
|
|
[\fB\-f\fR \fIFILE\fR]
|
|
[\fB\-t\fR \fITYPE\fR]
|
|
[\fB\-u\fR \fIUNIT\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 \-g\fI " "\fILOG_LEVEL
|
|
The rascsi log level to set (trace, debug, info, warn, err, critical, off)
|
|
.TP
|
|
.BR \-h\fI " " \fIHOST
|
|
The rascsi host to connect to, default is 'localhost'.
|
|
.TP
|
|
.BR \-l\fI
|
|
List all of the devices that are currently being emulated by RaSCSI, as well as their current status.
|
|
.TP
|
|
.BR \-p\fI " " \fIPORT
|
|
The rascsi port to connect to, default is 6868.
|
|
.TP
|
|
.BR \-s\fI
|
|
Display the server-side configuration settings.
|
|
.TP
|
|
.BR \-v\fI " " \fI
|
|
Display the rascsi version.
|
|
.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:
|
|
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)
|
|
unprotect: Remove write protection from the media (Magneto-Optical only)
|
|
.IP
|
|
When the command is omitted, rasctl will default to the 'attach' command.
|
|
.TP
|
|
.BR \-f\fI " " \fIFILE
|
|
Path to the disk image file. See the rascsi(1) man page for allowable file types.
|
|
.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 \-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)
|
|
|
|
.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) scsimon(1)
|
|
|
|
Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>
|