Macintosh-HW/RASCSI
1
0
Fork 0
mirror of https://github.com/akuker/RASCSI.git synced 2024-11-22 16:33:17 +00:00
Code Issues Projects Releases Wiki Activity
12bb86db9b
RASCSI/doc/scsimon.1

30 lines
1.1 KiB
Groff
Raw Normal View History

Issue #7 - implement a scsi monitor function for RaSCSI to log SCSI traffic (#46) * #7 Re-merge scsimon functionality with latest master. The old scsimon branch was waaaaay too out of date * #7 Re-merge scsimon functionality with latest master. The old scsimon branch was waaaaay too out of date * Added libspdlog-dev as a required package * Cleanup from master re-base * Updated to use GCC version 8, to match the raspberry pi Co-authored-by: akuker <akuker@gmail.com>
2020-10-19 12:31:06 +00:00
.TH scsimon 1
.SH 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.
.SH SYNOPSIS
.B scsimon
.SH DESCRIPTION
.B scsimon
Rebrand project to PiSCSI (#1016) * Rebrand project to PiSCSI - rascsi ->piscsi - rasctl -> scsictl - rasdump -> scsidump - ras* -> piscsi* (rasutil -> piscsi_util, etc.) * Refined the formatting and wording of the app startup banner * Kept some references to rascsi and rasctl where backwards compatibility is concerned * Point to the new github repo URL Co-authored-by: nucleogenic <nr@nucleogenic.com> Co-authored-by: Uwe Seimet <Uwe.Seimet@seimet.de>
2022-12-05 17:58:23 +00:00
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.
Issue #7 - implement a scsi monitor function for RaSCSI to log SCSI traffic (#46) * #7 Re-merge scsimon functionality with latest master. The old scsimon branch was waaaaay too out of date * #7 Re-merge scsimon functionality with latest master. The old scsimon branch was waaaaay too out of date * Added libspdlog-dev as a required package * Cleanup from master re-base * Updated to use GCC version 8, to match the raspberry pi Co-authored-by: akuker <akuker@gmail.com>
2020-10-19 12:31:06 +00:00
.PP
The logged data is stored in a file called "log.vcd" in the current working directory from where scsimon was launched.
Fixed typos (#110)
2021-06-19 15:17:23 +00:00
Currently, scsimon doesn't accept any arguments.
Issue #7 - implement a scsi monitor function for RaSCSI to log SCSI traffic (#46) * #7 Re-merge scsimon functionality with latest master. The old scsimon branch was waaaaay too out of date * #7 Re-merge scsimon functionality with latest master. The old scsimon branch was waaaaay too out of date * Added libspdlog-dev as a required package * Cleanup from master re-base * Updated to use GCC version 8, to match the raspberry pi Co-authored-by: akuker <akuker@gmail.com>
2020-10-19 12:31:06 +00:00
To quit scsimon, press Control + C.
.SH OPTIONS
.TP
None
.SH EXAMPLES
Clarify docs and error strings for scsimon (#1175) * Better usage hints in scsimon man page * In error message, clarify that piscsi needs to be shut down
2023-06-24 20:20:15 +00:00
Make sure you've stopped the piscsi service. Then launch scsimon to capture all SCSI traffic available to the PiSCSI hardware:
Issue #7 - implement a scsi monitor function for RaSCSI to log SCSI traffic (#46) * #7 Re-merge scsimon functionality with latest master. The old scsimon branch was waaaaay too out of date * #7 Re-merge scsimon functionality with latest master. The old scsimon branch was waaaaay too out of date * Added libspdlog-dev as a required package * Cleanup from master re-base * Updated to use GCC version 8, to match the raspberry pi Co-authored-by: akuker <akuker@gmail.com>
2020-10-19 12:31:06 +00:00
scsimon
Clarify docs and error strings for scsimon (#1175) * Better usage hints in scsimon man page * In error message, clarify that piscsi needs to be shut down
2023-06-24 20:20:15 +00:00
If you're trying to capture a specific scenario, you'll want to wait to start scsimon until immediately before the scenario.
Issue #7 - implement a scsi monitor function for RaSCSI to log SCSI traffic (#46) * #7 Re-merge scsimon functionality with latest master. The old scsimon branch was waaaaay too out of date * #7 Re-merge scsimon functionality with latest master. The old scsimon branch was waaaaay too out of date * Added libspdlog-dev as a required package * Cleanup from master re-base * Updated to use GCC version 8, to match the raspberry pi Co-authored-by: akuker <akuker@gmail.com>
2020-10-19 12:31:06 +00:00
.SH SEE ALSO
Rebrand project to PiSCSI (#1016) * Rebrand project to PiSCSI - rascsi ->piscsi - rasctl -> scsictl - rasdump -> scsidump - ras* -> piscsi* (rasutil -> piscsi_util, etc.) * Refined the formatting and wording of the app startup banner * Kept some references to rascsi and rasctl where backwards compatibility is concerned * Point to the new github repo URL Co-authored-by: nucleogenic <nr@nucleogenic.com> Co-authored-by: Uwe Seimet <Uwe.Seimet@seimet.de>
2022-12-05 17:58:23 +00:00
scsictl(1), piscsi(1), scsidump(1)
Issue #7 - implement a scsi monitor function for RaSCSI to log SCSI traffic (#46) * #7 Re-merge scsimon functionality with latest master. The old scsimon branch was waaaaay too out of date * #7 Re-merge scsimon functionality with latest master. The old scsimon branch was waaaaay too out of date * Added libspdlog-dev as a required package * Cleanup from master re-base * Updated to use GCC version 8, to match the raspberry pi Co-authored-by: akuker <akuker@gmail.com>
2020-10-19 12:31:06 +00:00
Rebrand project to PiSCSI (#1016) * Rebrand project to PiSCSI - rascsi ->piscsi - rasctl -> scsictl - rasdump -> scsidump - ras* -> piscsi* (rasutil -> piscsi_util, etc.) * Refined the formatting and wording of the app startup banner * Kept some references to rascsi and rasctl where backwards compatibility is concerned * Point to the new github repo URL Co-authored-by: nucleogenic <nr@nucleogenic.com> Co-authored-by: Uwe Seimet <Uwe.Seimet@seimet.de>
2022-12-05 17:58:23 +00:00
Full documentation is available at: <https://www.piscsi.com>
Reference in New Issue Copy Permalink