summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpancake <nopcode.org>2010-11-18 16:32:00 +0100
committerpancake <nopcode.org>2010-11-18 16:32:00 +0100
commitb0f69c8b6b6c73440c5fd29fccd618d0046b4640 (patch)
treef978e0ec3a525a6be3e26f8ebf7d30a061cd9f1c
parentdc4fd72133cd8988ffe087d7e320bee6c993c8ae (diff)
download0xFFFF-b0f69c8b6b6c73440c5fd29fccd618d0046b4640.tar.bz2
* Add manpages (thanks sre!)
-rw-r--r--Makefile2
-rw-r--r--man/0xFFFF.199
-rw-r--r--man/goxf.120
-rw-r--r--man/logotool.141
4 files changed, 162 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index 1614e3c..7068039 100644
--- a/Makefile
+++ b/Makefile
@@ -32,6 +32,8 @@ install:
-cp src/gui/goxf ${DESTDIR}${PREFIX}/bin
cp logotool/logotool ${DESTDIR}${PREFIX}/bin
cp 0xFFFF.desktop ${DESTDIR}${PREFIX}/share/applications/
+ mkdir -p ${DESTDIR}${PREFIX}/share/man/man1
+ cp man/*.1 ${DESTDIR}${PREFIX}/share/man/man1
deinstall:
rm -f ${DESTDIR}${PREFIX}/bin/0xFFFF
diff --git a/man/0xFFFF.1 b/man/0xFFFF.1
new file mode 100644
index 0000000..4897300
--- /dev/null
+++ b/man/0xFFFF.1
@@ -0,0 +1,99 @@
+.TH 0xFFFF 1 "November 18, 2010"
+.\" Please adjust this date whenever revising the manpage.
+.SH NAME
+0xFFFF \- Open Free Fiasco Firmware Flasher
+
+.SH SYNOPSIS
+.B 0xFFFF
+.RB [OPTION]...
+.SH DESCRIPTION
+The 'Open Free Fiasco Firmware Flasher' aka 0xFFFF utility implements
+a free (GPL3) userspace handler for the NOLO bootloader and related
+utilities for the Nokia Internet Tablets like flashing, setting device
+options, packing/unpacking FIASCO firmware format and more.
+
+.SH OPTIONS
+.TP
+.BI -b [args]
+boots the kernel with arguments
+.TP
+.BI -c
+console prompt mode
+.TP
+.BI -d [vid:pid]
+injects a usb device into the supported list
+.TP
+.BI -D [0|1|2]
+sets the root device to flash (0), mmc (1) or usb (2)
+.TP
+.BI -f <flags>
+set the given RD flags (see '-f help')
+.TP
+.BI -i
+show device information (let standby mode)
+.TP
+.BI -l
+list supported usb device ids
+.TP
+.BI -p [[p%]file]
+piece-of-firmware % file-where-this-piece-is
+.TP
+.BI -r [0|1]
+disable/enable R&D mode
+.TP
+.BI -R
+reboot the omap board
+.TP
+.BI -U [0|1]
+disable/enable the usb host mode
+.TP
+.BI -Q
+enter shared queues server mode (for gui or remote)
+.TP
+.BI -s [serial]
+serial port console (minicom like terminal)
+.TP
+.BI -h
+show help message
+.TP
+.BI -S [subversion]
+unpacks/flash pieces matching this sub-version information
+.TP
+.BI -n
+do not flash or write to disk (simulation)
+.TP
+.BI -C [/dev/mtd]
+check bad blocks on mtd
+.TP
+.BI -e [path]
+dump/extract pieces to path
+.TP
+.BI -F [fiasco]
+flash a fiasco firmware image
+.TP
+.BI -H [file]
+calculate hash for file
+.TP
+.BI -I [piece]
+identify a firmware piece
+.TP
+.BI -P [new-fiasco]
+creates a new fiasco package, pieces as arguments
+.TP
+.BI -u [fiasco]
+unpack target fiasco image
+.TP
+.BI -v
+be verbose and noisy
+.TP
+.BI -V
+show version information and exit.
+.TP
+.BI -x
+extract configuration entries from /dev/mtd1
+
+.SH AUTHOR
+0xFFFF was written by pancake.
+.PP
+This manual page was written by Sebastian Reichel <elektranox@gmail.com>,
+for the Debian project (but may be used by others).
diff --git a/man/goxf.1 b/man/goxf.1
new file mode 100644
index 0000000..797411d
--- /dev/null
+++ b/man/goxf.1
@@ -0,0 +1,20 @@
+.TH GOXF 1 "November 18, 2010"
+.\" Please adjust this date whenever revising the manpage.
+.SH NAME
+goxf \- 0xFFFF GUI
+.SH SYNOPSIS
+.B goxf
+.RB [FILE]
+.SH DESCRIPTION
+This utility is a graphical interface to 0xFFFF. It is used to
+communicate with the NOLO bootloader of Nokia's internet tablets
+(N770, N800, N810, N900).
+.SH OPTIONS
+goxf takes no options.
+.SH SEE ALSO
+.B 0xFFFF(1)
+.SH AUTHOR
+goxf was written by pancake.
+.PP
+This manual page was written by Sebastian Reichel <elektranox@gmail.com>,
+for the Debian project (but may be used by others).
diff --git a/man/logotool.1 b/man/logotool.1
new file mode 100644
index 0000000..f19d38b
--- /dev/null
+++ b/man/logotool.1
@@ -0,0 +1,41 @@
+.TH LOGOTOOL 1 "November 18, 2010"
+.\" Please adjust this date whenever revising the manpage.
+.SH NAME
+logotool \- FIASCO logo file tool
+.SH SYNOPSIS
+.B logotool
+.RB [OPTION]...
+.SH DESCRIPTION
+Tool to compress, uncompress or watch FIASCO logo files.
+.SH OPTIONS
+.TP
+.BI -u img
+uncompress image to img.rgb
+.TP
+.BI -c img
+compres a 24 bit rgb raw image to a 16(565) one
+.TP
+.BI -m img
+show image using mplayer (dumps to <img>.yuv)
+.TP
+.BI -v img
+view uncompressed image using the 'display' command from ImageMagick (in monochrome)
+.TP
+.BI -w
+specify width (required for -v and -c)
+.TP
+.BI -a
+force RGBA instead of RGB when compressing (use with -c)
+.TP
+.BI -h
+specify height (required for -v and -c)
+.TP
+.BI -V
+show version information and exit.
+.SH SEE ALSO
+.B 0xFFFF(1)
+.SH AUTHOR
+logotool was written by pancake and esteve.
+.PP
+This manual page was written by Sebastian Reichel <elektranox@gmail.com>,
+for the Debian project (but may be used by others).