Macintosh-HW/RASCSI
1
0
Fork 0
mirror of https://github.com/akuker/RASCSI.git synced 2024-05-28 09:41:33 +00:00
Code Issues Projects Releases Wiki Activity

Update manpages

Browse Source
This commit is contained in:
Uwe Seimet 2023-11-15 18:22:35 +01:00
parent a6059a1cba
commit 636311e62d
8 changed files with 37 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/piscsi.1
View File

@ -109,6 +109,6 @@ In case the fallocate command is available a much faster alternative to the dd c
fallocate -l 104857600 /path/to/newimage.hda
.SH SEE ALSO
scsictl(1), scsimon(1), scsidump(1)
scsictl(1), scsimon(1), scsidump(1), scsiexec(1)
Full documentation is available at: <https://www.piscsi.com>

2
doc/piscsi_man_page.txt
View File

@ -144,7 +144,7 @@ EXAMPLES
fallocate -l 104857600 /path/to/newimage.hda
SEE ALSO
scsictl(1), scsimon(1), scsidump(1)
scsictl(1), scsimon(1), scsidump(1), scsiexec(1)
Full documentation is available at: <https://www.piscsi.com>

2
doc/scsictl.1
View File

@ -177,6 +177,6 @@ Request the PiSCSI process to attach a disk (assumed) to SCSI ID 0 with the cont
scsictl -i 0 -f HDIIMAGE0.HDS
.SH SEE ALSO
piscsi(1), scsimon(1), scsidump(1)
piscsi(1), scsimon(1), scsidump(1), scsiexec(1)
Full documentation is available at: <https://www.piscsi.com>

2
doc/scsictl_man_page.txt
View File

@ -168,7 +168,7 @@ EXAMPLES
scsictl -i 0 -f HDIIMAGE0.HDS
SEE ALSO
piscsi(1), scsimon(1), scsidump(1)
piscsi(1), scsimon(1), scsidump(1), scsiexec(1)
Full documentation is available at: <https://www.piscsi.com>

2
doc/scsiloop.1
View File

@ -30,6 +30,6 @@ The loopback connections for the DB25 connector are shown here:
The piscsi log level (trace, debug, info, warn, err, off). The default log level is 'info'.
.SH SEE ALSO
scsictl(1), piscsi(1), scsimon(1)
scsictl(1), piscsi(1), scsimon(1), scsiexec(1)
Full documentation is available at: <https://www.piscsi.com>

26
doc/scsiloop_man_page.txt
View File

@ -1,21 +1,22 @@
!! ------ THIS FILE IS AUTO_GENERATED! DO NOT MANUALLY UPDATE!!!
!! ------ The native file is scsiloop.1. Re-run 'make docs' after updating
scsiloop(1) General Commands Manual scsiloop(1)
!! ------ The native file is scsiloop.1. Re-run 'make docs' after updating\n\n
scsiloop(1) General Commands Manual scsiloop(1)
NAME
scsiloop - Tool for testing the PiSCSI board with a loopback adapter installed
scsiloop - Tool for testing the PiSCSI board with a loopback adapter
installed
SYNOPSIS
scsiloop [-L LOG_LEVEL]
DESCRIPTION
scsiloop Performs a self-test of the PiSCSI hardware to ensure that the board is functioning properly. In order for this
tool to work, a special loopback cable MUST be attached to the PiSCSI SCSI connector.
scsiloop Performs a self-test of the PiSCSI hardware to ensure that the
board is functioning properly. In order for this tool to work, a spe‐
cial loopback cable MUST be attached to the PiSCSI SCSI connector.
In addition to testing the GPIO signals, scsiloop will perform a self-test of the hardware timers that are built into the
system on a chip (SoC).
In addition to testing the GPIO signals, scsiloop will perform a self-
test of the hardware timers that are built into the system on a chip
(SoC).
The loopback connections for the DB25 connector are shown here:
@ -33,11 +34,12 @@ DESCRIPTION
OPTIONS
-L LOG_LEVEL
The piscsi log level (trace, debug, info, warn, err, off). The default log level is 'info'.
The piscsi log level (trace, debug, info, warn, err, off). The
default log level is 'info'.
SEE ALSO
scsictl(1), piscsi(1), scsimon(1)
scsictl(1), piscsi(1), scsimon(1), scsiexec(1)
Full documentation is available at: <https://www.piscsi.com>
scsiloop(1)
scsiloop(1)

2
doc/scsimon.1
View File

@ -24,6 +24,6 @@ Make sure you've stopped the piscsi service. Then launch scsimon to capture all
If you're trying to capture a specific scenario, you'll want to wait to start scsimon until immediately before the scenario.
.SH SEE ALSO
scsictl(1), piscsi(1), scsidump(1)
scsictl(1), piscsi(1), scsidump(1), scsiexec(1)
Full documentation is available at: <https://www.piscsi.com>

34
doc/scsimon_man_page.txt
View File

@ -1,23 +1,23 @@
!! ------ THIS FILE IS AUTO_GENERATED! DO NOT MANUALLY UPDATE!!!
!! ------ The native file is scsimon.1. Re-run 'make docs' after updating
scsimon(1) General Commands Manual scsimon(1)
!! ------ The native file is scsimon.1. Re-run 'make docs' after updating\n\n
scsimon(1) General Commands Manual scsimon(1)
NAME
scsimon - Acts as a data capture tool for all traffic on the SCSI bus. Data is stored in a Value Change Dump
(VCD) file.
scsimon - Acts as a data capture tool for all traffic on the SCSI bus.
Data is stored in a Value Change Dump (VCD) file.
SYNOPSIS
scsimon
DESCRIPTION
scsimon monitors all of the traffic on the SCSI bus, using a PiSCSI device. The data is cached in memory while
the tool is running. A circular buffer is used so that only the most recent 1,000,000 transactions are stored.
The tool will continue to run until the user presses CTRL-C, or the process receives a SIGINT signal.
scsimon monitors all of the traffic on the SCSI bus, using a PiSCSI de‐
vice. The data is cached in memory while the tool is running. A circu‐
lar buffer is used so that only the most recent 1,000,000 transactions
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 working directory from where scsimon was
launched.
The logged data is stored in a file called "log.vcd" in the current
working directory from where scsimon was launched.
Currently, scsimon doesn't accept any arguments.
@ -27,16 +27,16 @@ OPTIONS
None
EXAMPLES
Make sure you've stopped the piscsi service. Then launch scsimon to capture all SCSI traffic available to the
PiSCSI hardware:
Make sure you've stopped the piscsi service. Then launch scsimon to
capture all SCSI traffic available to the PiSCSI hardware:
scsimon
If you're trying to capture a specific scenario, you'll want to wait to start scsimon until immediately before
the scenario.
If you're trying to capture a specific scenario, you'll want to wait to
start scsimon until immediately before the scenario.
SEE ALSO
scsictl(1), piscsi(1), scsidump(1)
scsictl(1), piscsi(1), scsidump(1), scsiexec(1)
Full documentation is available at: <https://www.piscsi.com>
scsimon(1)
scsimon(1)