RASCSI/doc/scsimon.1
Daniel Markstedt c231541bb4
Manpage improvements (#882)
* Capitalization of description paragraph

* Flesh out descriptions of disk image types

* Remove redundant word
2022-10-02 15:29:22 +02:00

28 lines
989 B
Groff

.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
monitors all of the traffic on the SCSI bus, using a RaSCSI 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.
.PP
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.
To quit scsimon, press Control + C.
.SH OPTIONS
.TP
None
.SH EXAMPLES
Launch scsimon to capture all SCSI traffic available to the RaSCSI hardware:
scsimon
.SH SEE ALSO
rasctl(1), rascsi(1), rasdump(1), sasidump(1)
Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>