Skip to content

Commit cda3681

Browse files
rdmarkrdmark
committed
regenerate plain test man pages
1 parent 00743d1 commit cda3681

5 files changed

Lines changed: 341 additions & 294 deletions

File tree

‎doc/piscsi_man_page.txt‎

Lines changed: 121 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -1,151 +1,175 @@
11
!! ------ THIS FILE IS AUTO_GENERATED! DO NOT MANUALLY UPDATE!!!
2-
!! ------ The native file is piscsi.1. Re-run 'make docs' after updating\n\n
3-
piscsi(1) General Commands Manual piscsi(1)
2+
!! ------ The native file is piscsi.1. Re-run 'make docs' after updating
3+
4+
5+
PISCSI(1) General Commands Manual PISCSI(1)
46

57
NAME
6-
piscsi - Emulates SCSI devices using the Raspberry Pi GPIO pins
8+
piscsi — Emulates SCSI devices using the Raspberry Pi GPIO pins
79

810
SYNOPSIS
9-
piscsi [-F FOLDER] [-L LOG_LEVEL[:ID:[LUN]]] [-P ACCESS_TOKEN_FILE] [-R
10-
SCAN_DEPTH] [-h] [-n VENDOR:PRODUCT:REVISION] [-p PORT] [-r RE‐
11-
SERVED_IDS] [-n TYPE] [-v] [-z LOCALE] [-IDn:[u] FILE] [-HDn[:u]
12-
FILE]...
11+
piscsi [-b BLOCK_SIZE] [-F FOLDER] [-L LOG_LEVEL[: ID[: LUN]]]
12+
[-n VENDOR:PRODUCT:REVISION] [-P ACCESS_TOKEN_FILE] [-p PORT]
13+
[-R SCAN_DEPTH] [-r RESERVED_IDS] [-s MICROSECONDS] [-t TYPE]
14+
[-z LOCALE] [-IDn[:u] FILE] [-HDn[:u] FILE ...]
15+
piscsi [-h]
16+
piscsi [-v]
1317

1418
DESCRIPTION
1519
piscsi emulates SCSI devices using the Raspberry Pi GPIO pins.
1620

17-
In the arguments to PiSCSI, one or more SCSI (-IDn[:u]) devices can be
18-
specified. The number (n) after the ID or HD identifier specifies the
19-
ID number for that device. The optional number (u) specifies the LUN
20-
(logical unit) for that device. The default LUN is 0. For SCSI: The ID
21-
is limited from 0-7. However, typically SCSI ID 7 is reserved for the
21+
In the arguments to PiSCSI, one or more SCSI (-IDn[:u]) devices can be
22+
specified. The number (n) after the ID or HD identifier specifies the
23+
ID number for that device. The optional number (u) specifies the LUN
24+
(logical unit) for that device. The default LUN is 0. For SCSI: The ID
25+
is limited from 0-7. However, typically SCSI ID 7 is reserved for the
2226
"initiator" (the host computer). The LUN is limited from 0-31.
2327

24-
PiSCSI will determine the type of device based upon the file extension
28+
PiSCSI will determine the type of device based upon the file extension
2529
of the FILE argument.
26-
hd1: SCSI Hard Disk image (generic, non-removable, SCSI-1)
27-
hds: SCSI Hard Disk image (generic, non-removable)
28-
hdr: SCSI Hard Disk image (generic, removable)
29-
hdn: SCSI Hard Disk image (NEC compatible - only used with PC-98
30+
hds: Hard Disk image (generic, non-removable)
31+
hd1: Hard Disk image (generic, non-removable, SCSI-1 compatibility
32+
mode)
33+
hdr: Hard Disk image (generic, removable)
34+
hdn: Hard Disk image (NEC compatible - only used with PC-98 comput‐
35+
ers)
36+
hdi: Hard Disk image (Anex86 proprietary - only used with PC-98 com‐
37+
puters)
38+
nhd: Hard Disk image (T98Next proprietary - only used with PC-98
3039
computers)
31-
hdi: SCSI Hard Disk image (Anex86 proprietary - only used with
32-
PC-98 computers)
33-
nhd: SCSI Hard Disk image (T98Next proprietary - only used with
34-
PC-98 computers)
35-
hda: SCSI Hard Disk image (Apple compatible - typically used with
36-
Macintosh computers)
37-
mos: SCSI Magneto-Optical image (generic - typically used with
38-
NeXT, X68000, etc.)
39-
iso: SCSI CD-ROM or DVD-ROM image (ISO 9660 image)
40-
is1: SCSI CD-ROM or DVD-ROM image (ISO 9660 image, SCSI-1)
41-
42-
For example, if you want to specify an Apple-compatible HD image on ID
40+
hda: Hard Disk image (Apple compatible - typically used with Macin‐
41+
tosh computers)
42+
mos: Magneto-Optical image (generic - typically used with NeXT,
43+
X68000, etc.)
44+
iso: CD-ROM or DVD-ROM image (ISO 9660 image)
45+
is1: CD-ROM or DVD-ROM image (ISO 9660 image, SCSI-1 compatibility
46+
mode)
47+
tap: Tape image (raw tape image containing non-block data)
48+
tar: Tape archive (tape block data in tar format)
49+
50+
If the file extension is not recognized, the device type can be speci‐
51+
fied explicitly using the -t option and a four letter code.
52+
SCCD: SCSI CD-ROM (generic CD-ROM or DVD-ROM drive)
53+
SCDP: SCSI DaynaPort (DaynaPort compatible network adapter)
54+
SCHD: SCSI Hard Disk (generic, non-removable)
55+
SCHS: SCSI Host Services (used for special host services)
56+
SCLP: SCSI Printer (generic line printer)
57+
SCMO: SCSI Magneto-Optical Drive (generic MO drive)
58+
SCRM: SCSI Removable Hard Disk (generic, removable)
59+
SCTP: SCSI Tape Drive (generic tape, or streamer, drive)
60+
61+
For example, if you want to specify an Apple-compatible HD image on ID
4362
0, you can use the following command:
4463
sudo piscsi -ID0 /path/to/drive/hdimage.hda
4564

46-
Note: PiSCSI is a fork of RaSCSI. The two cannot be run in parallel on
65+
Note: PiSCSI is a fork of RaSCSI. The two cannot be run in parallel on
4766
the same system.
4867

49-
Once PiSCSI starts, it will open a socket (default port is 6868) to al‐
50-
low external management commands. If another process is using this
51-
port, PiSCSI will terminate, since it is likely another instance of
52-
PiSCSI or RaSCSI. Once PiSCSI has initialized, the scsictl utility can
68+
Once PiSCSI starts, it will open a socket (default port is 6868) to al‐
69+
low external management commands. If another process is using this
70+
port, PiSCSI will terminate, since it is likely another instance of
71+
PiSCSI or RaSCSI. Once PiSCSI has initialized, the scsictl utility can
5372
be used to send commands.
5473

55-
To quit PiSCSI, press Control + C. If it is running in the background,
74+
To quit PiSCSI, press Control + C. If it is running in the background,
5675
you can kill it using an INT signal.
5776

5877
OPTIONS
5978
-b BLOCK_SIZE
60-
The optional block size, either 512, 1024, 2048 or 4096 bytes.
61-
Default size is 512 bytes.
79+
The optional block size, either 512, 1024, 2048 or 4096 bytes.
80+
Default size is 512 bytes.
6281

6382
-F FOLDER
64-
The default folder for image files. For files in this folder no
65-
absolute path needs to be specified. The initial default folder
66-
is '~/images'.
83+
The default folder for image files. For files in this folder no
84+
absolute path needs to be specified. The initial default folder
85+
is '~/images'.
6786

68-
-L LOG_LEVEL[:ID:[LUN]]
69-
The piscsi log level (trace, debug, info, warning, error, off).
70-
The default log level is 'info' for all devices unless a partic‐
71-
ular device ID and an optional LUN was provided.
87+
-h Show a help page.
7288

73-
-P ACCESS_TOKEN_FILE
74-
Enable authentication and read the access token from the speci‐
75-
fied file. The access token file must be owned by root and must
76-
be readable by root only.
77-
78-
-R SCAN_DEPTH
79-
Scan for image files recursively, up to a depth of SCAN_DEPTH.
80-
Depth 0 means to ignore any folders within the default image
81-
filder. Be careful when using this option with many sub-folders
82-
in the default image folder. The default depth is 1.
83-
84-
-h Show a help page.
89+
-L LOG_LEVEL[: ID[: LUN]]
90+
The piscsi log level (trace, debug, info, warning, error, off).
91+
The default log level is 'info' for all devices unless a partic‐
92+
ular device ID and an optional LUN was provided.
8593

8694
-n VENDOR:PRODUCT:REVISION
87-
Set the vendor, product and revision for the device, to be re‐
88-
turned with the INQUIRY data. A complete set of name components
89-
must be provided. VENDOR may have up to 8, PRODUCT up to 16, RE‐
90-
VISION up to 4 characters. Padding with blanks to the maxium
91-
length is automatically applied. Once set the name of a device
92-
cannot be changed.
95+
Set the vendor, product and revision for the device, to be re‐
96+
turned with the INQUIRY data. A complete set of name components
97+
must be provided. VENDOR may have up to 8, PRODUCT up to 16, RE‐
98+
VISION up to 4 characters. Padding with blanks to the maxium
99+
length is automatically applied. Once set the name of a device
100+
cannot be changed.
101+
102+
-P ACCESS_TOKEN_FILE
103+
Enable authentication and read the access token from the speci‐
104+
fied file. The access token file must be owned by root and must
105+
be readable by root only.
93106

94107
-p PORT
95-
The piscsi server port, default is 6868.
108+
The piscsi server port, default is 6868.
96109

97-
-r RESERVED_IDS
98-
Comma-separated list of IDs to reserve. Pass an empty list in
99-
order to not reserve anything. -p TYPE The optional case-insen‐
100-
sitive device type (SAHD, SCHD, SCRM, SCCD, SCMO, SCBR, SCDP,
101-
SCLP, SCHS). If no type is specified for devices that support an
102-
image file, piscsi tries to derive the type from the file exten‐
103-
sion.
110+
-R SCAN_DEPTH
111+
Scan for image files recursively, up to a depth of SCAN_DEPTH.
112+
Depth 0 means to ignore any folders within the default image
113+
folder. Be careful when using this option with many sub-folders
114+
in the default image folder. The default depth is 1.
104115

105-
-v Display the piscsi version.
116+
-r RESERVED_IDS
117+
Comma-separated list of IDs to reserve. Pass an empty list in
118+
order to not reserve anything.
106119

107-
-z LOCALE
108-
Overrides the default locale for client-faces error messages.
109-
The client can override the locale.
120+
-s MICROSECONDS
121+
Minimum execution time for SCSI commands in microseconds. De‐
122+
fault is 50. Higher values may be needed for some older SCSI
123+
initiators to work properly.
110124

111-
-IDn[:u] FILE
112-
n is the SCSI ID number (0-7). u (0-31) is the optional LUN
113-
(logical unit). The default LUN is 0.
125+
-t TYPE
126+
The optional case-insensitive device type (see list of type
127+
codes above). If no type is specified for devices that support
128+
an image file, piscsi tries to derive the type from the file ex‐
129+
tension.
114130

115-
FILE is the name of the image file to use for the SCSI device.
116-
For devices that do not support an image file (SCBR, SCDP, SCLP,
117-
SCHS) the filename may have a special meaning or a dummy name
118-
can be provided. For SCBR and SCDP it is an optioinal priori‐
119-
tized list of network interfaces, an optional IP address and
120-
netmask, e.g. "interface=eth0,eth1,wlan0:inet=10.10.20.1/24".
121-
For SCLP it is the print command to be used and a reservation
122-
timeout in seconds, e.g. "cmd=lp -oraw %f:timeout=60".
131+
-v Display the piscsi version.
123132

124-
FILE is the name of the image file to use for the SCSI device.
133+
-z LOCALE
134+
Sets the default locale for client-facing error messages. The
135+
client can override the locale.
136+
137+
-ID n[: u] FILE
138+
n is the SCSI ID number (0-7). u (0-31) is the optional LUN
139+
(logical unit). The default LUN is 0.
140+
141+
FILE is the name of the image file to use for a SCSI mass stor‐
142+
age device. For devices that do not support an image file (SCDP,
143+
SCLP, SCHS) the filename may have a special meaning or a dummy
144+
name can be provided. For SCDP it is a prioritized list of net‐
145+
work interfaces with an IP address and netmask, e.g. "inter‐
146+
face=eth0,eth1,wlan0:inet=10.10.20.1/24". For SCLP it is the
147+
print command to be used and a reservation timeout in seconds,
148+
e.g. "cmd=lp -oraw %f:timeout=60".
125149

126150
EXAMPLES
127151
Launch PiSCSI with no emulated drives attached:
128-
piscsi
152+
piscsi
129153

130-
Launch PiSCSI with an Apple hard drive image as ID 0 and a CD-ROM as ID
154+
Launch PiSCSI with an Apple hard drive image as ID 0 and a CD-ROM as ID
131155
2
132-
piscsi -ID0 /path/to/harddrive.hda -ID2 /path/to/cdimage.iso
156+
piscsi -ID0 /path/to/harddrive.hda -ID2 /path/to/cdimage.iso
133157

134-
Launch PiSCSI with a removable SCSI drive image as ID 0 and the raw de‐
135-
vice file /dev/hdb (e.g. a USB stick) and a DaynaPort network adapter
136-
as ID 6:
137-
piscsi -ID0 -t scrm /dev/hdb -ID6 -t scdp daynaport
158+
Launch PiSCSI with a removable SCSI drive image as ID 0 and the raw de‐
159+
vice file /dev/hdb (e.g. a USB stick) and a DaynaPort network adapter as
160+
ID 6:
161+
piscsi -ID0 -t scrm /dev/hdb -ID6 -t scdp daynaport
138162

139163
To create an empty, 100MiB HD image, use the following command:
140-
dd if=/dev/zero of=/path/to/newimage.hda bs=512 count=204800
164+
dd if=/dev/zero of=/path/to/newimage.hda bs=512 count=204800
141165

142-
In case the fallocate command is available a much faster alternative to
166+
In case the fallocate command is available a much faster alternative to
143167
the dd command is:
144-
fallocate -l 104857600 /path/to/newimage.hda
168+
fallocate -l 104857600 /path/to/newimage.hda
145169

146170
SEE ALSO
147171
scsictl(1), scsimon(1), scsidump(1)
148172

149173
Full documentation is available at: <https://www.piscsi.com>
150174

151-
piscsi(1)
175+
PiSCSI December 18, 2025 PISCSI(1)

0 commit comments

Comments
 (0)