aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormarcusw2011-04-12 19:11:32 +0000
committermarcusw2011-04-12 19:11:32 +0000
commite288f23f0474b6225fb864bad5ba716ab3c3d134 (patch)
tree7e2e2fae61c2f4dfef380f8f546fa5c64162f52d
parent48ca0fd0b89a985a46deadae4ec6dda32ce84dfe (diff)
Added man pages for each of the scripts. While distutils and therefore setup.py don't do anything with these, packagers for various unix-based systems will hopefully find them helpful.
-rw-r--r--docs/nxt_filer.121
-rw-r--r--docs/nxt_push.122
-rw-r--r--docs/nxt_test.115
3 files changed, 58 insertions, 0 deletions
diff --git a/docs/nxt_filer.1 b/docs/nxt_filer.1
new file mode 100644
index 0000000..3fe87b2
--- /dev/null
+++ b/docs/nxt_filer.1
@@ -0,0 +1,21 @@
+.\" Author: Marcus Wanner <marcus@wanners.net>
+.\" Language: English
+.TH NXT_FILER "1" "April 2011" "nxt-python" "nxt-python"
+.SH "NAME"
+nxt_filer \- a simple tkinter GUI to manage files on an nxt brick
+.SH "SYNOPSIS"
+.P
+.B nxt_filer
+[
+.B --host
+.I macaddress
+]
+.SH "DESCRIPTION"
+.P
+The
+.B nxt_filer
+program runs a minimal GUI for managing files on a nxt brick. It uses the tkinter component of the python standard library, so should work on most systems. It operates almost entirely based on drag and drop and may have limited functionality on some systems which do not support this or have nothing to interface with it.
+.SH "OPTIONS"
+.SS "--host macaddress"
+.P
+Specify the mac address of the brick to manage files on. Useful if multiple bricks are connected or within bluetooth range.
diff --git a/docs/nxt_push.1 b/docs/nxt_push.1
new file mode 100644
index 0000000..ca86762
--- /dev/null
+++ b/docs/nxt_push.1
@@ -0,0 +1,22 @@
+.\" Author: Marcus Wanner <marcus@wanners.net>
+.\" Language: English
+.TH NXT_PUSH "1" "April 2011" "nxt-python" "nxt-python"
+.SH "NAME"
+nxt_push \- write a file onto the nxt's user flash
+.SH "SYNOPSIS"
+.P
+.B nxt_push
+[
+.B --host
+.I macaddress
+]
+.I file
+.SH "DESCRIPTION"
+.P
+The
+.B nxt_push
+command reads a file from the disk and writes it to the nxt's user flash filesystem. This is useful when adding sound files, text files, compiled .rxe files, or any other file which might need to be on the brick.
+.SH "OPTIONS"
+.SS "--host macaddress"
+.P
+Specify the mac address of the brick to have the file loaded onto. Useful if multiple bricks are connected or within bluetooth range.
diff --git a/docs/nxt_test.1 b/docs/nxt_test.1
new file mode 100644
index 0000000..31b89a0
--- /dev/null
+++ b/docs/nxt_test.1
@@ -0,0 +1,15 @@
+.\" Author: Marcus Wanner <marcus@wanners.net>
+.\" Language: English
+.TH NXT_TEST "1" "April 2011" "nxt-python" "nxt-python"
+.SH "NAME"
+nxt_test \- test the nxt-python setup and brick firmware interaction
+.SH "DESCRIPTION"
+.P
+The
+.B nxt_test
+command looks for nxt bricks and prints out various statistics about each one. It relies most heavily on the nxt.brick.Brick.get_device_info() function for its data. Running it ensures that the relevant communication subsystem is usable and that the firmware on the brick is talking to nxt-python correctly.
+.SH "OPTIONS"
+.PP
+When run,
+.B nxt_test
+doesn't accept any arguments.