[man] - added brief man pages

ipxe · Mar 3, 2011 · 6602f15 · 6602f15
1 parent aa659ff
commit 6602f15
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 0 deletions.
diff --git a/man/pb_driver-load.1 b/man/pb_driver-load.1
@@ -0,0 +1,23 @@
+.TH "PB_DRIVER-[UN]LOAD" "1" "" "" "User Commands"
+.SH "NAME"
+\fBpb_driver-load\fR, \fBpb_driver-unload\fR
+
+.SH "SYNOPSIS"
+These commands load and unload the pulseblaster driver, granting permissions as necessary.
+
+Note: these should not normally be required: the module should be automatically loaded at boot,
+and the permissions should be granted by pam_console_apply at login. See: /etc/security/console.perms.d/90-pulseblaster.perms
+
+.SH "COMMANDS"
+.LP 
+\fBpb_driver-load\fR
+.IP 
+Load the pulseblaster kernel module, and grant permissions to the logged-in user. May also be invoked with \fB-h\fR to show help.
+
+.LP 
+\fBpb_driver-unload\fR
+.IP 
+Unload the pulseblaster kernel module. May also be invoked with \fB-h\fR to show help.
+
+.SH "SEE ALSO"
+\fBpulseblaster\fR(1), \fBpb_utils\fR(1)
diff --git a/man/pb_test-flash-2Hz.1 b/man/pb_test-flash-2Hz.1
@@ -0,0 +1,23 @@
+.TH "PB_TESTS" "1" "" "" "User Commands"
+.SH "NAME"
+\fBpb_test-flash-2Hz\fR, \fBpb_test-flash-fastest-5.55MHz\fR, \fBpb_test-identify-output\fR
+
+.SH "SYNOPSIS"
+This tests the pulseblaster hardware and driver. 
+
+.SH "COMMANDS"
+.LP 
+\fBpb_test-flash-2Hz\fR
+.IP 
+Flash the LEDs on all 24 channels, simultaneously at 2Hz. Invoke with \fB-h\fR for help.
+.LP 
+\fBpb_test-flash-fastest-5.55MHz\fR
+.IP 
+Flash the LEDs on all 24 channels, simultaneously at 5.5555 MHz (the limit of the hardware). Invoke with \fB-h\fR for help.
+.LP 
+\fBpb_test-identify-output  BIT_N\fR
+.IP 
+Flash one specific bit at 2Hz. Useful for channel identification. Invoke with \fB-h\fR for help.
+
+.SH "SEE ALSO"
+\fBpulseblaster\fR(1), \fBpb_driver-load\fR(1)
diff --git a/man/pbctl.1 b/man/pbctl.1
@@ -0,0 +1,15 @@
+.TH "PBCTL" "1" "" "" "User Commands"
+.SH "NAME"
+\fBpbctl\fR
+
+.SH "SYNOPSIS"
+PulseBlaster control program. Simple perl script to program and stop/start/arm/continue the pulseblaster.
+
+.SH "COMMANDS"
+.LP 
+\fBpbctl -h\fR
+.IP 
+Invoke pbctl with -h for further details.
+
+.SH "SEE ALSO"
+\fBpulseblaster\fR(1), \fBpb_utils\fR(1)