Add manpages for all executables (Uwe Hermann)

git-svn-id: https://svn.gnumonks.org/trunk/librfid@2045 e0336214-984f-0b4b-a45f-81c69e1f0ede

diff --git a/utils/Makefile.am b/utils/Makefile.am
index c6b4cd6..cd4adbc 100644 (file)
--- a/utils/Makefile.am
+++ b/utils/Makefile.am
@@ -2,6 +2,11 @@ INCLUDES = $(all_includes) -I$(top_srcdir)/include
 
 if ENABLE_FIRMWARE
 else
+
+man_MANS = librfid-tool.1 mifare-tool.1 librfid-send_script.1
+
+EXTRA_DIST = $(man_MANS)
+
 bin_PROGRAMS = librfid-tool mifare-tool librfid-send_script 
 
 noinst_HEADERS = librfid-tool.h common.h

diff --git a/utils/librfid-send_script.1 b/utils/librfid-send_script.1
new file mode 100644 (file)
index 0000000..02fe610
--- /dev/null
+++ b/utils/librfid-send_script.1
@@ -0,0 +1,23 @@
+.TH librfid-send_script 1 "January 24, 2008"
+.SH NAME
+librfid-send_script \- Command line tool for testing librfid
+.SH SYNOPSIS
+.BR librfid-send_script " scriptfile"
+.SH DESCRIPTION
+.B librfid-send_script
+is a command line tool for testing librfid.
+.SH OPTIONS
+None.
+.SH BUGS
+Please report any bugs on the
+.B librfid-devel
+mailing list at
+.BR https://lists.gnumonks.org/mailman/listinfo/librfid-devel/ "."
+.SH LICENCE
+.B librfid-send_script
+is covered by the GNU General Public License (GPL), version 2.
+.SH AUTHORS
+Harald Welte <laforge@gnumonks.org>
+.PP
+This manual page was written by Uwe Hermann <uwe@hermann-uwe.de>.
+It is licensed under the terms of the GNU GPL (version 2 or later).

diff --git a/utils/librfid-tool.1 b/utils/librfid-tool.1
new file mode 100644 (file)
index 0000000..f8e0e1a
--- /dev/null
+++ b/utils/librfid-tool.1
@@ -0,0 +1,44 @@
+.TH LIBRFID-TOOL 1 "January 24, 2008"
+.SH NAME
+librfid-tool \- Low-level RFID access command line tool based on librfid
+.SH SYNOPSIS
+.B librfid-tool \fR[\fB\-sSplh\fR]
+.SH DESCRIPTION
+.B librfid-tool
+is a command line tool which gives you low-level RFID access using one
+of the RFID reader devices supported by librfid.
+.SH OPTIONS
+.B "\-s, \-\-scan"
+Scan for RFID tags until the first tag is found.
+.TP
+.B "\-S, \-\-scan-loop"
+Scan for RFID tags in an endless loop. Show information on the detected
+RFID tags (if any).
+.TP
+.B "\-p, \-\-protocol"
+Specify the RFID protocol to use. Possible values are:
+.BR tcl ,
+.BR mifare-ultralight ", and "
+.BR mifare-classic "."
+.TP
+.B "\-l, \-\-layer2"
+Specify the layer 2 protocol to use. Possible values are:
+.BR iso14443a ,
+.BR iso14443b ", and "
+.BR iso15693 "."
+.TP
+.B "\-h, \-\-help"
+Show a help text and exit.
+.SH BUGS
+Please report any bugs on the
+.B librfid-devel
+mailing list at
+.BR https://lists.gnumonks.org/mailman/listinfo/librfid-devel/ "."
+.SH LICENCE
+.B librfid-tool
+is covered by the GNU General Public License (GPL), version 2.
+.SH AUTHORS
+Harald Welte <laforge@gnumonks.org>
+.PP
+This manual page was written by Uwe Hermann <uwe@hermann-uwe.de>.
+It is licensed under the terms of the GNU GPL (version 2 or later).

diff --git a/utils/mifare-tool.1 b/utils/mifare-tool.1
new file mode 100644 (file)
index 0000000..5c97118
--- /dev/null
+++ b/utils/mifare-tool.1
@@ -0,0 +1,39 @@
+.TH mifare-tool 1 "January 24, 2008"
+.SH NAME
+mifare-tool \- Low-level mifare tag command line tool based on librfid
+.SH SYNOPSIS
+.B mifare-tool \fR[\fB\-rlwkbh\fR]
+.SH DESCRIPTION
+.B mifare-tool
+is a command line tool for testing low-level mifare tag support in librfid.
+.SH OPTIONS
+.B "\-r, \-\-read"
+Read a mifare sector.
+.TP
+.B "\-l, \-\-loop-read"
+Loop reading a mifare sector.
+.TP
+.B "\-w, \-\-write"
+Write a mifare sector.
+.TP
+.B "\-k, \-\-key"
+Specify a mifare access key (in hex tuples).
+.TP
+.B "\-b, \-\-brute-force N"
+Brute-force read sector N.
+.TP
+.B "\-h, \-\-help"
+Show a help text and exit.
+.SH BUGS
+Please report any bugs on the
+.B librfid-devel
+mailing list at
+.BR https://lists.gnumonks.org/mailman/listinfo/librfid-devel/ "."
+.SH LICENCE
+.B mifare-tool
+is covered by the GNU General Public License (GPL), version 2.
+.SH AUTHORS
+Harald Welte <laforge@gnumonks.org>
+.PP
+This manual page was written by Uwe Hermann <uwe@hermann-uwe.de>.
+It is licensed under the terms of the GNU GPL (version 2 or later).