manpages for rasdump and sasidump (#295)

* Fixed compile time issues

* Fix compile time error in sasidump.cpp

* Fix comment in Makefile

* Fix compile time error in sasidump.cpp

* Restore rasdump and sasidump to BIN_ALL

* Fix typo

* Install rasdump and sasidump

* manpage for rasdump

* Create manpage for sasidump

Co-authored-by: Uwe Seimet <Uwe.Seimet@seimet.de>

doc/rascsi.1

@@ -98,6 +98,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
-rasctl(1), scsimon(1)
+rasctl(1), scsimon(1), rasdump(1), sasidump(1)
  
 Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>

doc/rasctl.1

@@ -140,6 +140,6 @@ Request the RaSCSI process to attach a disk (assumed) to SCSI ID 0 with the cont
    rasctl -i 0 -f HDIIMAGE0.HDS
 
 .SH SEE ALSO
-rascsi(1) scsimon(1)
+rascsi(1), scsimon(1), rasdump(1), sasidump(1)
 
 Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>

doc/rasdump.1

@@ -0,0 +1,35 @@
+.TH rasdump 1
+.SH NAME
+rasdump \- SCSI disk dumping tool for RaSCSI
+.SH SYNOPSIS
+.B rasdump
+\fB\-i\fR \fIID\fR
+[\fB\-b\fR \fIBID\fR]
+\fB\-f\fR \fIFILE\fR
+[\fB\-r\fR]
+.SH DESCRIPTION
+.B rasdump
+Samples the data on physical SCSI storage media, including hard drives and MO drives, and stores it to an image file. It can also restore from a dumped file onto physical SCSI storage media. Can be connected directly, through a STANDARD RaSCSI board, or a FULLSPEC RaSCSI board.
+
+Set its own ID with the BID option. Defaults to 7 if ommitted.
+
+.SH OPTIONS
+.TP
+.BR \-i\fI " "\fIID
+SCSI ID of the target device
+.TP
+.BR \-b\fI " "\fIBID
+SCSI ID of the RaSCSI device
+.TP
+.BR \-f\fI " "\fIFILE
+Path to the dump file
+.TP
+.BR \-r\fI
+Restoration mode
+
+.SH EXAMPLES
+
+.SH SEE ALSO
+rasctl(1), rascsi(1), scsimon(1), sasidump(1)
+ 
+Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>

doc/sasidump.1

@@ -0,0 +1,41 @@
+.TH sasidump 1
+.SH NAME
+sasidump \- SASI disk dumping tool for RaSCSI
+.SH SYNOPSIS
+.B sasidump
+\fB\-i\fR \fIID\fR
+[\fB\-u\fR \fIUT\fR]
+[\fB\-b\fR \fIBSIZE\fR]
+\fB\-c\fR \fICOUNT\fR
+\fB\-f\fR \fIFILE\fR
+[\fB\-r\fR]
+.SH DESCRIPTION
+.B sasidump
+Samples the data on physical SASI storage media, and stores it to an image file. It can also restore from a dumped file onto physical SASI storage media.
+
+.SH OPTIONS
+.TP
+.BR \-i\fI " "\fIID
+SASI ID of the target device
+.TP
+.BR \-u\fI " "\fIUD
+Unit ID of the target device
+.TP
+.BR \-b\fI " "\fIBSIZE
+Block size (default is 512)
+.TP
+.BR \-c\fI " "\fICOUNT
+Block count
+.TP
+.BR \-f\fI " "\fIFILE
+Path to the dump file
+.TP
+.BR \-r\fI
+Restoration mode
+
+.SH EXAMPLES
+
+.SH SEE ALSO
+rasctl(1), rascsi(1), scsimon(1), rasdump(1)
+ 
+Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>

doc/scsimon.1

@@ -22,6 +22,6 @@ Launch scsimon to capture all SCSI traffic available to the RaSCSI hardware:
    scsimon
 
 .SH SEE ALSO
-rasctl(1), rascsi(1)
+rasctl(1), rascsi(1), rasdump(1), sasidump(1)
  
 Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>

src/raspberrypi/Makefile

@@ -206,7 +206,20 @@ run:
 ##              *   sudo systemctl enable rascsi
 ##              *   sudo systemctl start rascsi
 .PHONY: install
-install: $(MAN_PAGE_DIR)/rascsi.1 $(MAN_PAGE_DIR)/rasctl.1 $(MAN_PAGE_DIR)/scsimon.1 $(USR_LOCAL_BIN)/$(RASCTL) $(USR_LOCAL_BIN)/$(RASCSI) $(USR_LOCAL_BIN)/$(SCSIMON) $(SYSTEMD_CONF) $(RSYSLOG_CONF) $(RSYSLOG_LOG)
+install: \
+	$(MAN_PAGE_DIR)/rascsi.1 \
+	$(MAN_PAGE_DIR)/rasctl.1 \
+	$(MAN_PAGE_DIR)/scsimon.1 \
+	$(MAN_PAGE_DIR)/rasdump.1 \
+	$(MAN_PAGE_DIR)/sasidump.1 \
+	$(USR_LOCAL_BIN)/$(RASCTL) \
+	$(USR_LOCAL_BIN)/$(RASCSI) \
+	$(USR_LOCAL_BIN)/$(SCSIMON) \
+	$(USR_LOCAL_BIN)/$(RASDUMP) \
+	$(USR_LOCAL_BIN)/$(SASIDUMP) \
+	$(SYSTEMD_CONF) \
+	$(RSYSLOG_CONF) \
+	$(RSYSLOG_LOG)
 	@echo "-- Done installing!"
 
 $(USR_LOCAL_BIN)% : $(BINDIR)/%

src/raspberrypi/rasdump.cpp

@@ -860,7 +860,7 @@ int main(int argc, char* argv[])
 
 	// Start dump
 	printf("TARGET ID               : %d\n", targetid);
-	printf("BORAD ID                : %d\n", boardid);
+	printf("BOARD ID                : %d\n", boardid);
 
 	// TEST UNIT READY
 	count = TestUnitReady(targetid);