From bb88608f1ef06e82a7325e1b66a3c09f0f8c7ea6 Mon Sep 17 00:00:00 2001
From: "David M. Syzdek" <david@syzdek.net>
Date: Mon, 18 Jan 2010 16:23:26 -0900
Subject: Adding man page for bitops.

---
 doc/bindump.1.in    |  1 +
 doc/bitops.1.in     | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/numconvert.1.in |  1 +
 3 files changed, 65 insertions(+)
 create mode 100644 doc/bitops.1.in

(limited to 'doc')

diff --git a/doc/bindump.1.in b/doc/bindump.1.in
index 6598337..bd0869c 100644
--- a/doc/bindump.1.in
+++ b/doc/bindump.1.in
@@ -59,6 +59,7 @@ Disable xterm output.
 Report bugs to David M. Syzdek <@PACKAGE_BUGREPORT@>.
 
 .SH "SEE ALSO"
+.BR bitops (1),
 .BR codetagger (1),
 .BR numconvert (1)
 .\" end of man page
diff --git a/doc/bitops.1.in b/doc/bitops.1.in
new file mode 100644
index 0000000..9463e84
--- /dev/null
+++ b/doc/bitops.1.in
@@ -0,0 +1,63 @@
+.\"
+.\" 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/bitops.1.in - man page for bitops
+.\"
+.TH "BITOPS" "1" "@RELEASE_MONTH@" "@PACKAGE_TARNAME@ @PACKAGE_VERSION@" "User Commands"
+.SH NAME
+bitops \- displays the result of two values after performing bitwise operations
+.SH SYNOPSIS
+\fBbitops\fR [\fB-BDOX\fR] \fInumber1 number2\fR
+.sp
+\fBbitops\fR [\fB--help\fR | \fB-h\fR] [\fB--version\fR | \fB-V\fR]
+
+.SH DESCRIPTION
+The \fBbitops\fR utility is a filter which displays the result of two values 
+after using bitwise operations.  The operations performed are Arithmetic left
+shift, Arithmetic right shift, AND, OR, Inclusive OR, and negation. 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-D\fR
+Display the values as decimal numerals.
+.TP
+\fB\-h\fR, \fB--help\fR
+Displays usage information and exits.
+.TP
+\fB-O\fR
+Display the values as octal numerals.
+.TP
+\fB\-V\fR, \fB--version\fR
+displays version number and exits.
+.TP
+\fB-X\fR
+Display the values as hexadecimal numerals.
+
+.SH "REPORTING BUGS"
+Report bugs to David M. Syzdek <@PACKAGE_BUGREPORT@>.
+
+.SH "SEE ALSO"
+.BR bindump (1),
+.BR codetagger (1),
+.BR numconvert (1)
+.\" end of man page
diff --git a/doc/numconvert.1.in b/doc/numconvert.1.in
index 960a0c5..72eec72 100644
--- a/doc/numconvert.1.in
+++ b/doc/numconvert.1.in
@@ -79,6 +79,7 @@ Process input strings as hexadecimal numerals.
 Report bugs to David M. Syzdek <@PACKAGE_BUGREPORT@>.
 
 .SH "SEE ALSO"
+.BR bitops (1),
 .BR codetagger (1),
 .BR numconvert (1)
 .\" end of man page
-- 
cgit v1.2.3