Manpage updates

This commit is contained in:
Uwe Seimet 2021-08-25 14:10:03 +02:00
parent 501ba07404
commit 7fae0c0c5c
4 changed files with 26 additions and 23 deletions

View File

@ -43,7 +43,7 @@ To quit RaSCSI, press Control + C. If it is running in the background, you can k
.SH OPTIONS
.TP
.BR \-b\fI " " \fIBLOCK_SIZE
The optional block size for SCSI hard disk drives, either 512, 1024, 2048 or 4096. The default size 512 bytes.
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 " " \fIFOLDER
The default folder for image files. For files in this folder no absolute path needs to be specified. The initial default folder is '~/images'.

View File

@ -50,34 +50,35 @@ DESCRIPTION
OPTIONS
-b BLOCK_SIZE
The optional block size for SCSI hard disk drives, either 512,
1024, 2048 or 4096. The default size 512 bytes.
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.
-f FOLDER
The default folder for image files. For files in this folder no
absolute path needs to be specified. The initial default folder
The default folder for image files. For files in this folder no
absolute path needs to be specified. The initial default folder
is '~/images'.
-g 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'.
-h Show a help page.
-n VENDOR:PRODUCT:REVISION
Set the vendor, product and revision for the device, to be re
turned with the INQUIRY data. A complete set of name components
Set the vendor, product and revision for the device, to be re
turned with the INQUIRY data. A complete set of name components
must be provided. VENDOR may have up to 8, PRODUCT up to 16, RE
VISION up to 4 characters. Padding with blanks to the maxium
length is automatically applied. Once set the name of a device
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
The rascsi server port, default is 6868.
-p TYPE
The optional case-insensitive device type (SAHD, SCHD, SCRM,
SCCD, SCMO, SCBR, SCDP). If no type is specified for devices
The optional case-insensitive device type (SAHD, SCHD, SCRM,
SCCD, SCMO, SCBR, SCDP). If no type is specified for devices
that support an image file, rascsi tries to derive the type from
the file extension.
@ -86,8 +87,8 @@ OPTIONS
-IDn FILE
n is the SCSI ID number (0-7)
FILE is the name of the image file to use for the SCSI device.
For devices that do not support an image file (SCBR, SCDP) a
FILE is the name of the image file to use for the SCSI device.
For devices that do not support an image file (SCBR, SCDP) a
dummy name must be provided.
-HDn FILE
@ -95,7 +96,7 @@ OPTIONS
FILE is the name of the image file to use for the SASI device.
Note: SASI usage is rare, and is typically limited to early
Note: SASI usage is rare, and is typically limited to early
Sharp X68000 systems.
EXAMPLES
@ -107,7 +108,7 @@ EXAMPLES
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
vice file /dev/hdb (e.g. a USB stick) and a DaynaPort network adapter
vice file /dev/hdb (e.g. a USB stick) and a DaynaPort network adapter
as ID 6:
rascsi -ID0 -t scrm /dev/hdb -ID6 -t scdp DUMMY_FILENAME

View File

@ -40,7 +40,7 @@ List all of the devices that are currently being emulated by RaSCSI, as well as
The rascsi port to connect to, default is 6868.
.TP
.BR \-s\fI
Display the server-side configuration settings.
Display server-side settings like available images or supported device types.
.TP
.BR \-v\fI " " \fI
Display the rascsi version.
@ -60,7 +60,7 @@ Command is the operation being requested. options are:
eject, protect and unprotect are idempotent.
.TP
.BR \-b\fI " " \fIBLOCK_SIZE
The optional block size for SCSI hard disk drives, either 512, 1024, 2048 or 4096. The default size is 512 bytes.
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
Path to the disk image file. See the rascsi(1) man page for allowable file types.

View File

@ -34,7 +34,8 @@ OPTIONS
-p PORT
The rascsi port to connect to, default is 6868.
-s Display the server-side configuration settings.
-s Display server-side settings like available images or supported
device types.
-v Display the rascsi version.
@ -45,16 +46,17 @@ OPTIONS
detach: detach disk
insert: insert media (removable media devices only)
eject: eject media (removable media devices only)
protect: write protect the media (not for CD-ROMs, which are
protect: write protect the media (not for CD-ROMs, which are
always read-only)
unprotect: remove write protection from the media (not for
unprotect: remove write protection from the media (not for
CD-ROMs, which are always read-only)
eject, protect and unprotect are idempotent.
-b BLOCK_SIZE
The optional block size for SCSI hard disk drives, either 512,
1024, 2048 or 4096. The default size is 512 bytes.
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.
-f FILE
Path to the disk image file. See the rascsi(1) man page for al