Permalink
Browse files

Add madwimax man page.

git-svn-id: http://madwimax.googlecode.com/svn/trunk@146 195ec174-b24d-11dd-8bee-0be8dff76351
  • Loading branch information...
1 parent 2b0966f commit e73d1dda47d4295aee7cbb3428238bc4fd45ed8f @ago committed Apr 11, 2009
Showing with 106 additions and 1 deletion.
  1. +1 −1 Makefile.am
  2. +1 −0 configure.ac
  3. +11 −0 man/Makefile.am
  4. +93 −0 man/madwimax.8.txt
View
@@ -1 +1 @@
-SUBDIRS = include src scripts
+SUBDIRS = include man src scripts
View
@@ -144,6 +144,7 @@ AC_SUBST(script)
AC_CONFIG_FILES([
Makefile
include/Makefile
+ man/Makefile
src/Makefile
scripts/events/Makefile
${scriptfile}
View
@@ -0,0 +1,11 @@
+# decide which pages to install
+man_MANS = madwimax.8
+
+# distribute the source in asciidoc format
+EXTRA_DIST = madwimax.8.txt
+
+madwimax.8.xml: $(srcdir)/madwimax.8.txt
+ asciidoc -b docbook -d manpage -o $@ $<
+
+madwimax.8: madwimax.8.xml
+ xsltproc /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl $<
View
@@ -0,0 +1,93 @@
+MADWIMAX(8)
+===========
+Alexander Gordeev <lasaine@lvk.cs.msu.su>
+
+
+NAME
+----
+madwimax - driver for mobile WiMAX equipment based on Samsung CMC-730
+
+
+SYNOPSIS
+--------
+*madwimax* ['OPTIONS']
+
+
+DESCRIPTION
+-----------
+*madwimax* is an experimental reverse-engineered linux driver for
+mobile WiMAX (802.16e) devices based on Samsung CMC-730 chip. These
+devices are currently supported:
+
+* Samsung SWC-U200
+* Samsung SWC-E100
+* Samsung SWM-S10R (it is built in Samsung NC-10 netbook)
+
+The driver is completely user-space. It requires libusb-1.0 and
+TUN/TAP driver to work.
+
+
+OPTIONS
+-------
+*-d, --daemonize*::
+ Daemonize after startup.
+
+*--device*='VID:PID'::
+ Specify the USB device by 'VID:PID' combination.
+
+*--exact-device*='BUS/DEVICE'::
+ Specify the exact USB 'BUS/DEVICE' (use with care!).
+
+*-f, --detach-dvd*::
+ Detach pseudo-DVD kernel driver on startup.
+
+*-h, --help*::
+ Display help.
+
+*-l* 'FILE', *--log-file*='FILE'::
+ Write log to the specified 'FILE' instead of the other methods.
+
+*-o, --diode-off*::
+ Turn off the diode (diode is turned on by default).
+
+*-q, --quiet*::
+ Switch off logging.
+
+*-V, --version*::
+ Print the program version number.
+
+*-v, --verbose*::
+ Increase the log level.
+
+
+EXIT STATUS
+-----------
+*0*::
+ Success
+
+*1*::
+ Failure (syntax or usage error; hardware error; underlying
+ software error; unexpected error).
+
+
+BUGS
+----
+See the madwimax issue tracker:
+<http://code.google.com/p/madwimax/issues/list>
+
+
+AUTHOR
+------
+Written by Alexander Gordeev, <mailto:lasaine@lvk.cs.msu.su>
+
+
+RESOURCES
+---------
+Main web site: <http://code.google.com/p/madwimax/>
+
+
+COPYING
+-------
+Copyright \(C) 2008-2009 Alexander Gordeev. Free use of this software
+is granted under the terms of the GNU General Public License (GPL).
+

0 comments on commit e73d1dd

Please sign in to comment.