Adding man page for numconvert.

1 files changed, 84 insertions, 0 deletions

diff --git a/doc/numconvert.1.in b/doc/numconvert.1.in
new file mode 100644
index 0000000..960a0c5
--- /dev/null
+++ b/doc/numconvert.1.in
@@ -0,0 +1,84 @@
+.\"
+.\" DMS Tools and Utilities
+.\" Copyright (C) 2010 David M. Syzdek <david@syzdek.net>
+.\"
+.\" @SYZDEK_COPYRIGHT_HEADER_START@
+.\"
+.\" Permission is granted to copy, distribute and/or modify this document
+.\" under the terms of the GNU Free Documentation License, Version 1.2
+.\" or any later version published by the Free Software Foundation;
+.\" with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+.\" A copy of the license is included in the section entitled "GNU
+.\" Free Documentation License".
+.\"
+.\" @SYZDEK_COPYRIGHT_HEADER_END@
+.\"
+.\" doc/numconvert.1.in - man page for numconvert
+.\"
+.TH "NUMCONVERT" "1" "@RELEASE_MONTH@" "@PACKAGE_TARNAME@ @PACKAGE_VERSION@" "User Commands"
+.SH NAME
+numconvert \- displays values using multiple numeral systems
+.SH SYNOPSIS
+\fBnumconvert\fR [\fB-BbDdlOoRrsXx\fR] [\fInumber1 number2 ... numberN\fR] 
+.sp
+\fBnumconvert\fR [\fB--help\fR | \fB-h\fR] [\fB--version\fR | \fB-V\fR]
+
+.SH DESCRIPTION
+The \fBnumconvert\fR utility is a filter which displays numbers using different
+numeral systems.  Input strings which are prefixed with \fI0x\fR are assumed to be
+ hexidecimal numerals.  Input strings which are prefixed with a single `\fI0\fR'
+character are assumed to be octal numerals.  Input strings which are prefixed with
+`\fI00\fR' are assumed to be binary numerals.  All other strings are assumed
+to be in decimal numerals.
+
+.SH OPTIONS
+.TP
+\fB-B\fR
+Display the values as binary numerals.
+.TP
+\fB-b\fR
+Process input strings as binary numerals.
+.TP
+\fB-D\fR
+Display the values as decimal numerals.
+.TP
+\fB-d\fR
+Process input strings as decimal numerals.
+.TP
+\fB\-h\fR, \fB--help\fR
+Displays usage information and exits.
+.TP
+\fB-l\fR
+Display hexadecimal and binary numerals using the least amount of digits possible.
+.TP
+\fB-O\fR
+Display the values as octal numerals.
+.TP
+\fB-o\fR
+Process input strings as octal numerals.
+.TP
+\fB-R\fR
+Display binary numerals in little endian byte order.
+.TP
+\fB-r\fR
+Display binary numerals in little endian byte order and little endian bit order
+.TP
+\fB-s\fR
+Do not print spaces when displaying numerals.
+.TP
+\fB\-V\fR, \fB--version\fR
+displays version number and exits.
+.TP
+\fB-X\fR
+Display the values as hexadecimal numerals.
+.TP
+\fB-x\fR
+Process input strings as hexadecimal numerals.
+
+.SH "REPORTING BUGS"
+Report bugs to David M. Syzdek <@PACKAGE_BUGREPORT@>.
+
+.SH "SEE ALSO"
+.BR codetagger (1),
+.BR numconvert (1)
+.\" end of man page