Revision: 54013
http://brlcad.svn.sourceforge.net/brlcad/?rev=54013&view=rev
Author: starseeker
Date: 2012-12-06 22:24:13 +0000 (Thu, 06 Dec 2012)
Log Message:
-----------
Remove old man pages.
Modified Paths:
--------------
brlcad/trunk/bench/CMakeLists.txt
brlcad/trunk/bench/Makefile.am
brlcad/trunk/doc/CMakeLists.txt
brlcad/trunk/doc/Makefile.am
brlcad/trunk/misc/CMakeLists.txt
brlcad/trunk/misc/Makefile.am
brlcad/trunk/misc/enigma/CMakeLists.txt
brlcad/trunk/misc/enigma/Makefile.am
Removed Paths:
-------------
brlcad/trunk/bench/benchmark.1
brlcad/trunk/bench/pixcmp.1
brlcad/trunk/doc/bw.5
brlcad/trunk/doc/cmap.5
brlcad/trunk/doc/pix.5
brlcad/trunk/doc/plot3.5
brlcad/trunk/misc/brlcad-config.1
brlcad/trunk/misc/enigma/enigma.1
Modified: brlcad/trunk/bench/CMakeLists.txt
===================================================================
--- brlcad/trunk/bench/CMakeLists.txt 2012-12-06 22:17:58 UTC (rev 54012)
+++ brlcad/trunk/bench/CMakeLists.txt 2012-12-06 22:24:13 UTC (rev 54013)
@@ -23,11 +23,6 @@
file(APPEND ${CMAKE_BINARY_DIR}/CMakeTmp/benchmsg.cmake "message(\"Run 'make
benchmark-clean' in the bench directory to delete the logic\")\n")
file(APPEND ${CMAKE_BINARY_DIR}/CMakeTmp/benchmsg.cmake "message(\"and image
files generated during the benchmark analysis.\")\n")
-set(bench_MANS
- benchmark.1
- pixcmp.1
-)
-ADD_MAN_PAGES(1 bench_MANS)
CMAKEFILES(lgt.sh run.sh try.sh viewdiff.sh Makefile.am)
if(SH_EXEC)
Modified: brlcad/trunk/bench/Makefile.am
===================================================================
--- brlcad/trunk/bench/Makefile.am 2012-12-06 22:17:58 UTC (rev 54012)
+++ brlcad/trunk/bench/Makefile.am 2012-12-06 22:24:13 UTC (rev 54013)
@@ -9,12 +9,7 @@
dist_bin_SCRIPTS = \
benchmark
-man_MANS = \
- benchmark.1 \
- pixcmp.1
-
EXTRA_DIST = \
- $(man_MANS) \
${dist_bin_SCRIPTS} \
lgt.sh \
run.sh \
Deleted: brlcad/trunk/bench/benchmark.1
===================================================================
--- brlcad/trunk/bench/benchmark.1 2012-12-06 22:17:58 UTC (rev 54012)
+++ brlcad/trunk/bench/benchmark.1 2012-12-06 22:24:13 UTC (rev 54013)
@@ -1,181 +0,0 @@
-'\" t
-.\" Title: BENCHMARK
-.\" Author:
-.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 12/04/2012
-.\" Manual: BRL-CAD
-.\" Source: BRL-CAD
-.\" Language: English
-.\"
-.TH "BENCHMARK" "1" "12/04/2012" "BRL\-CAD" "BRL\-CAD"
-.\" -----------------------------------------------------------------
-.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.ie \n(.g .ds Aq \(aq
-.el .ds Aq '
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-benchmark \- runs the BRL\-CAD benchmark
-.SH "SYNOPSIS"
-.PP
-\fB[OPTION=value] benchmark [command] [OPTION=value] [RT_OPTIONS]\fR
-.SH "DESCRIPTION"
-.PP
-The benchmark suite will test the performance of a given system by iteratively
rendering several well\-known datasets into 512x512 images where performance
metrics are documented and fairly well understood\&. The local machine
performance is compared to the base system (called VGR) and a numeric "VGR"
multiplier of performance is computed\&. This number is a simplified metric
from which one may qualitatively compare cpu and cache performance, versions of
BRL\-CAD, and different compiler characteristics\&.
-.PP
-Run without any arguments or variables set, the benchmark suite will run a
series of tests where it renders several image frames\&. By default, the
benchmark suite will attempt to calibrate the intensity of the test frames with
the performance characteristics of the machine running the tests\&.
-.PP
-There are several
-\fBOPTION\fR
-environment variables that will modify how the BRL\-CAD benchmark behaves so
that it may be run in a stand\-alone environment:
-.PP
-
-\fBRT\fR
-\- the ray\-trace binary (e\&.g\&. \&.\&./src/rt/rt or /usr/brlcad/bin/rt)
-
-\fBDB\fR
-\- the directory containing the reference geometry (e\&.g\&. \&.\&./db)
-
-\fBPIX\fR
-\- the directory containing the reference images (e\&.g\&. \&.\&./pix)
-
-\fBLOG\fR
-\- the directory containing the reference logs (e\&.g\&. \&.\&./pix)
-
-\fBCMP\fR
-\- the name of a pixel comparison tool (e\&.g\&. \&./pixcmp or cmp)
-
-\fBELP\fR
-\- the name of an elapsed time tool (e\&.g\&. \&.\&./sh/elapsed\&.sh)
-
-\fBTIMEFRAME\fR
-\- minimum number of seconds each ray\-trace frame should take
-
-\fBMAXTIME\fR
-\- maximum number of seconds to spend on any test
-
-\fBDEVIATION\fR
-\- minimum sufficient % deviation from the average
-
-\fBAVERAGE\fR
-\- how many frames to average together
-
-\fBVERBOSE\fR
-\- turn on extra debug output (set to yes)
-
-\fBQUIET\fR
-\- turn off all output (set to yes)
-.PP
-The
-\fITIMEFRAME\fR,
-\fIMAXTIME\fR,
-\fIDEVIATION\fR, and
-\fIAVERAGE\fR
-options control how the benchmark will proceed including how long it should
take\&. Each individual benchmark run will consume at least a minimum
-\fITIMEFRAME\fR
-of wallclock time so that the results can stabilize\&. After consuming at
least the minimum
-\fITIMEFRAME\fR, additional frames may be computed until the standard
deviation from the last
-\fIAVERAGE\fR
-count of frames is below the specified
-\fIDEVIATION\fR\&. When a test is run and it completes in less than
-\fITIMEFRAME\fR, the raytrace is restarted using double the number of rays
from the previous run\&. If the machine is fast enough, the benchmark may
accelerate the number or rays being fired\&. These additional rays are
hypersampled but without any jitter, so it is effectively performing a
multiplier amount of work over the initial frame\&.
-.PP
-There are various
-\fBcommand\fRs that may be give to the BRL\-CAD benchmark that cause it to
perform various actions such as invoking the computation tests or filesystem
clean\-up:
-.PP
-
-\fBclean\fR
-\- remove the test\-specific pix and log files
-
-\fBclobber\fR
-\- same as clean, also benchmark\&.log files and user is prompted
-
-\fBhelp\fR
-\- displays a brief usage statement
-
-\fBinstructions\fR
-\- displays more detailed usage instructions
-
-\fBquiet\fR
-\- quell printing output (still logs)
-
-\fBverbose\fR
-\- remove the test\-specific pix and log files
-
-\fBclean\fR
-\- remove the test\-specific pix and log files
-
-\fBrun\fR
-\- initiate the benchmark analysis
-.PP
-When the benchmark completes, output should be saved to several log files
including a \*(Aqsummary\*(Aq file containing tabulated results, a
\*(Aqbenchmark\&.log\*(Aq file containing the output from a given run, and
multiple log files for each test frame\&. Use the
-\fIclean\fR
-and
-\fIclobber\fR
-commands during execution to remove the files generated during the benchmark\&.
-.PP
-The
-\fIclean\fR
-command removes the test pix and log files\&. The
-\fIclobber\fR
-command removes those same files as well as any *benchmark\&.log files
encountered, and prompting the user beforehand\&. The generated tabular
-\fIsummary\fR
-file will not be removed automatically regardless of invocation command\&. The
-\fIsummary\fR
-file must always be manually deleted\&.
-.SH "REPORTING RESULTS"
-.PP
-Please send your BRL\-CAD Benchmark results to the developers along with
detailed system information to <devs@brlcad\&.org>\&. Include at least:
-.PP
-0) Compiler name and version (e\&.g\&. gcc \-\-version) 1) CPU configuration
(e\&.g\&. cat /proc/cpuinfo or hinv or sysctl \-a) 2) Cache (data and/or
instruction) details for L1/L2/L3 and system (e\&.g\&. cat /proc/cpuinfo or
hinv or sysctl \-a) 3) All generated log files (i\&.e\&. *\&.log* after
benchmark completes) 4) Anything else you think might be relevant to performance
-.SH "EXAMPLES"
-.PP
-\fBbenchmark run\fR
-default run of the suite, taking approximately 10 minutes
-.PP
-\fBbenchmark run TIMEFRAME=1\fR
-quick test run for testing functionality and performance ballpark
-.PP
-\fBbenchmark run DEVIATION=1 TIMEFRAME=60 MAXTIME=600\fR
-excessive analysis, attempt to stabilize within 1 percent deviation with each
frame taking at least 60 seconds but no more than 10 minutes per test (the
entire analysis will probably take 30 to 60 minutes)
-\fBbenchmark run QUIET=1 \-P1\fR
-perform a benchmark analysis only using one CPU and only logging results to a
file
-.PP
-\fBbenchmark clean\fR
-delete all of the log and pix image files generated during a benchmark
analysis, leaving only the summary file and any *benchmark\&.log files
-.SH "SEE ALSO"
-.PP
-\fBbrlcad\fR(1),
-\fBrt\fR(1),
-\fBpix-fb\fR(1),
-\fBlibrt\fR(3),
-\fBpix\fR(5)\&.
-.SH "AUTHOR"
-.PP
-Christopher Sean Morrison
-Michael John Muuss
-Susan Muuss
-.SH "COPYRIGHT"
-.PP
-This software is Copyright (c) 2006\-2012 United States Government as
represented by the U\&.S\&. Army Research Laboratory\&. All rights reserved\&.
-.SH "BUG REPORTS"
-.PP
-Reports of bugs or problems should be submitted via electronic mail to
<devs@brlcad\&.org>\&.
-.SH "AUTHOR"
-.br
-.RS 4
-Author.
-.RE
Deleted: brlcad/trunk/bench/pixcmp.1
===================================================================
--- brlcad/trunk/bench/pixcmp.1 2012-12-06 22:17:58 UTC (rev 54012)
+++ brlcad/trunk/bench/pixcmp.1 2012-12-06 22:24:13 UTC (rev 54013)
@@ -1,125 +0,0 @@
-'\" t
-.\" Title: PIXCMP
-.\" Author:
-.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 12/04/2012
-.\" Manual: BRL-CAD
-.\" Source: BRL-CAD
-.\" Language: English
-.\"
-.TH "PIXCMP" "1" "12/04/2012" "BRL\-CAD" "BRL\-CAD"
-.\" -----------------------------------------------------------------
-.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.ie \n(.g .ds Aq \(aq
-.el .ds Aq '
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-pixcmp \- compare two pix image files pixel by pixel
-.SH "SYNOPSIS"
-.HP \w'\fBpixcmp\fR\ 'u
-\fBpixcmp\fR [\fIOPTIONS\fR] \fIFILE1\fR [\fIFILE2\fR\ [\fISKIP1\fR\
[\fISKIP2\fR]]]
-.SH "DESCRIPTION"
-.PP
-\fBpixcmp\fR
-is a program to compare two BRL\-CAD pix image files pixel by pixel\&. The
following
-\fIOPTIONS\fR
-are available:
-.PP
-\fB\-l\fR
-.RS 4
-Output pixel numbers, counting from 1, and values for all pixels that differ\&.
-.RE
-.PP
-\fB\-b\fR
-.RS 4
-Use bytes instead of pixels for both processing and output\&. With this
option, the
-\fB\-i\fR
-SKIP values should be specified as bytes instead of pixels\&.
-.RE
-.PP
-\fB\-i\fR \fISKIP\fR
-.RS 4
-Skip the first SKIP pixels of input (for FILE1 and FILE2)\&.
-.RE
-.PP
-\fB\-i\fR \fISKIP1\fR:\fISKIP2\fR
-.RS 4
-Skip the first SKIP1 pixels of FILE1 and the first SKIP2 pixels of FILE2\&.
-.RE
-.PP
-\fB\-s\fR
-.RS 4
-Silent output\&. Only return an exit status\&.
-.RE
-.PP
-SKIP1 and SKIP2 are the number of pixels to skip in each file\&.
-.PP
-If FILE is `\fB\-\fR` or missing,
-\fBpixcmp\fR
-reads from the standard input\&.
-.SH "RETURN VALUES"
-.PP
-The
-\fBpixcmp\fR
-utility returns
-0
-if there are no differences,
-1
-if there are only off\-by\-one differences,
-2
-if there are off\-by\-many errors,
-126
-if there are file processing problems, and
-127
-if there are argument processing or usage errors\&.
-.SH "EXAMPLES"
-.PP
-\fBpixcmp \-l file1 file2\fR
-.RS 4
-The two files are compared pixel by pixel with each difference printed instead
of just the summary\&.
-.RE
-.PP
-\fBpixdiff file1\&.pix file2\&.pix | pixcmp \- file3\&.pix\fR
-.RS 4
-The
-\fIpixdiff\fR
-tool compares the pixels in file1\&.pix with those in file2\&.pix and then
outputs a resulting `diff` image which is then processed by
-\fBpixcmp\fR
-as input and compared against file3\&.pix, reporting on the differences\&.
-.RE
-.SH "SEE ALSO"
-.PP
-\fBbrlcad\fR(1),
-\fBpixdiff\fR(1),
-\fBpix\fR(5),
-\fBbw\fR(5)
-.SH "AUTHOR"
-.PP
-Christopher Sean Morrison
-Charles M\&. Kennedy
-Michael John Muuss
-.SH "COPYRIGHT"
-.PP
-This software is Copyright (c) 2007\-2012 by the United States Government as
represented by U\&.S\&. Army Research Laboratory\&.
-.SH "BUG REPORTS"
-.PP
-Reports of bugs or problems should be submitted via electronic mail to
<devs@brlcad\&.org>\&.
-.SH "AUTHOR"
-.br
-.RS 4
-Author.
-.RE
Modified: brlcad/trunk/doc/CMakeLists.txt
===================================================================
--- brlcad/trunk/doc/CMakeLists.txt 2012-12-06 22:17:58 UTC (rev 54012)
+++ brlcad/trunk/doc/CMakeLists.txt 2012-12-06 22:24:13 UTC (rev 54013)
@@ -216,14 +216,6 @@
)
ADD_DOC(documentation_mged_old_DATA mged_old)
-set(doc_MANS
- bw.5
- cmap.5
- pix.5
- plot3.5
- )
-ADD_MAN_PAGES(5 doc_MANS)
-
configure_file(pad_file.xml.in ${CMAKE_CURRENT_BINARY_DIR}/pad_file.xml @ONLY)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/pad_file.xml DESTINATION ${DOC_DIR})
Modified: brlcad/trunk/doc/Makefile.am
===================================================================
--- brlcad/trunk/doc/Makefile.am 2012-12-06 22:17:58 UTC (rev 54012)
+++ brlcad/trunk/doc/Makefile.am 2012-12-06 22:24:13 UTC (rev 54013)
@@ -212,15 +212,8 @@
tube.txt \
tool_categories.txt
-man_MANS = \
- bw.5 \
- cmap.5 \
- pix.5 \
- plot3.5
-
EXTRA_DIST = \
$(documentation_DATA) \
- $(man_MANS) \
docbook \
STARTERS \
pad_file.xml.in \
Deleted: brlcad/trunk/doc/bw.5
===================================================================
--- brlcad/trunk/doc/bw.5 2012-12-06 22:17:58 UTC (rev 54012)
+++ brlcad/trunk/doc/bw.5 2012-12-06 22:24:13 UTC (rev 54013)
@@ -1,114 +0,0 @@
-'\" t
-.\" Title: BW
-.\" Author:
-.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 12/04/2012
-.\" Manual: BRL-CAD
-.\" Source: BRL-CAD
-.\" Language: English
-.\"
-.TH "BW" "5" "12/04/2012" "BRL\-CAD" "BRL\-CAD"
-.\" -----------------------------------------------------------------
-.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.ie \n(.g .ds Aq \(aq
-.el .ds Aq '
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-bw \- Black and White image file format and utilities
-.SH "FORMAT"
-.PP
-A
-\fIbw\fR
-file contains sequences of pixels\&. Each pixel is stored as one
-\fBunsigned char\fR, and thus ranges in intensity from 0 (black) to 255
(white)\&. The first pixel in a
-\fIbw\fR
-file is the lower left corner of the image\&. The pixels proceed from
left\-to\-right across each scanline, with scanlines being written from the
bottom to the top of the image\&.
-.PP
-By convention,
-\fIbw\fR
-images are usually square, and thus their dimensions can be determined by the
file size\&. If this is not the case, often only the file width need be known
by a program reading the file\&. History has left us with two "standard" sizes,
512x512 and the "higher" 1024x1024\&. A common practice for other file sizes is
to include the file width in the filename\&.
-.PP
-At some time in the future
-\fIbw\fR
-files will probably get self\-typing headers so that parameters such as their
size can be automatically determined by programs\&.
-.SH "UTILITIES"
-.PP
-\fBbw\-fb\fR
-display a \&.bw format image on a framebuffer\&.
-.PP
-\fBfb\-bw\fR
-produce a \&.bw file from a framebuffer image\&.
-.PP
-\fBbw\-pix\fR
-convert a \&.bw file to a color \&.pix file\&.
-.PP
-\fBpix\-bw\fR
-convert a color \&.pix file to a \&.bw file\&.
-.PP
-\fBbwstat\fR
-gives statistics concerning a \&.bw file\&.
-.PP
-\fBbwhist\fR
-displays a histogram on a framebuffer\&.
-.PP
-\fBbwmod\fR
-a filter to shift and scale pixel intensities\&.
-.PP
-\fBbwdiff\fR
-yields the difference between two \&.bw files\&.
-.PP
-\fBbwrect\fR
-extracts an arbitrary rectangle from a \&.bw file\&.
-.PP
-\fBbwcrop\fR
-maps any quadrilateral in a \&.bw file into any rectangle\&.
-.PP
-\fBbwrot\fR
-rotates, reverses, or inverts a \&.bw file\&.
-.PP
-\fBbwscale\fR
-scales a \&.bw file larger or smaller\&.
-.PP
-\fBbwfilter\fR
-a variety of 3x3 kernel filters for \&.bw images\&.
-.PP
-\fBbw3\-pix\fR
-merges three \&.bw files into one \&.pix file\&.
-.PP
-\fBpix\-bw3\fR
-separates \&.pix file RGB colors into three \&.bw files\&.
-.SH "FILES"
-.PP
-file\&.bw
-.SH "SEE ALSO"
-.PP
-\fBbrlcad\fR(1),
-\fBpix\fR(5), and above named programs\&.
-.SH "AUTHOR"
-.PP
-BRL\-CAD Team
-.SH "COPYRIGHT"
-.PP
-This software is Copyright (c) 1989\-2012 by the United States Government as
represented by U\&.S\&. Army Research Laboratory\&.
-.SH "BUG REPORTS"
-.PP
-Reports of bugs or problems should be submitted via electronic mail to
<devs@brlcad\&.org>\&.
-.SH "AUTHOR"
-.br
-.RS 4
-Author.
-.RE
Deleted: brlcad/trunk/doc/cmap.5
===================================================================
--- brlcad/trunk/doc/cmap.5 2012-12-06 22:17:58 UTC (rev 54012)
+++ brlcad/trunk/doc/cmap.5 2012-12-06 22:24:13 UTC (rev 54013)
@@ -1,94 +0,0 @@
-'\" t
-.\" Title: CMAP
-.\" Author:
-.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 12/04/2012
-.\" Manual: BRL-CAD
-.\" Source: BRL-CAD
-.\" Language: English
-.\"
-.TH "CMAP" "5" "12/04/2012" "BRL\-CAD" "BRL\-CAD"
-.\" -----------------------------------------------------------------
-.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.ie \n(.g .ds Aq \(aq
-.el .ds Aq '
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-cmap \- Framebuffer colormap file format and utilities
-.SH "FORMAT"
-.PP
-A
-\fIcmap\fR
-file is a storage format for framebuffer colormaps\&. It is an ascii file with
one line per colormap entry\&. In order to accommodate colormaps of any "depth"
(number of bits per entry), 16 bit unsigned integers were selected (see
-\fBlibfb\fR(3)
-for a discussion of the C program interface to colormaps)\&. A value of zero
corresponds to full off, or black, a value of 65535 decimal or ffff hexadecimal
corresponds to full on, or white\&. A given device will use as many of the
"leftmost" bits as it can support\&.
-.PP
-Each line of the file has a decimal colormap index, followed by a tab
character, and then three 4 digit hexadecimal values, separated by spaces,
which correspond to the red, green, and blue, channels\&. Any blank lines or
lines beginning with non\-numeric characters are ignored, and can thus be used
for comments\&.
-.PP
-There is no requirement for all 256 entries to be specified\&. What is done
with any unspecified entries is up to the individual programs using the
colormap\&.
-.SH "EXAMPLE"
-.PP
-The beginning of an eight bit inverse video colormap might look as follows:
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
- # Inverse video colormap
- 0 ff00 ff00 ff00
- 1 fe00 fe00 fe00
- 2 fd00 fd00 fd00
- 3 fc00 fc00 fc00
- 4 fb00 fb00 fb00
-
-.fi
-.if n \{\
-.RE
-.\}
-.SH "UTILITIES"
-.PP
-\fBfb\-cmap\fR
-save a colormap from a framebuffer\&.
-.PP
-\fBcmap\-fb\fR
-load a saved colormap into a framebuffer\&.
-.PP
-\fBfbcmap\fR
-loads one of several "standard" colormaps\&.
-.PP
-\fBfbgamma\fR
-loads gamma correcting colormaps\&.
-.SH "FILES"
-.PP
-file\&.cm
-.SH "SEE ALSO"
-.PP
-\fBbrlcad\fR(1), and above named programs\&.
-.SH "AUTHOR"
-.PP
-BRL\-CAD Team
-.SH "COPYRIGHT"
-.PP
-This software is Copyright (c) 1989\-2012 by the United States Government as
represented by U\&.S\&. Army Research Laboratory\&.
-.SH "BUG REPORTS"
-.PP
-Reports of bugs or problems should be submitted via electronic mail to
<devs@brlcad\&.org>\&.
-.SH "AUTHOR"
-.br
-.RS 4
-Author.
-.RE
Deleted: brlcad/trunk/doc/pix.5
===================================================================
--- brlcad/trunk/doc/pix.5 2012-12-06 22:17:58 UTC (rev 54012)
+++ brlcad/trunk/doc/pix.5 2012-12-06 22:24:13 UTC (rev 54013)
@@ -1,120 +0,0 @@
-'\" t
-.\" Title: PIX
-.\" Author:
-.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 12/04/2012
-.\" Manual: BRL-CAD
-.\" Source: BRL-CAD
-.\" Language: English
-.\"
-.TH "PIX" "5" "12/04/2012" "BRL\-CAD" "BRL\-CAD"
-.\" -----------------------------------------------------------------
-.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.ie \n(.g .ds Aq \(aq
-.el .ds Aq '
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-pix \- Color RGB image file format and utilities
-.SH "FORMAT"
-.PP
-A
-\fIpix\fR
-file contains sequences of pixels\&. Each pixel is stored as three
-\fBunsigned char\fRs, first red, then green, then blue\&. The intensity of
each color ranges from 0 ("off") to 255 ("on")\&. The first pixel in a
-\fIpix\fR
-file is the lower left corner of the image\&. The pixels proceed from
left\-to\-right across each scanline, with scanlines being written from the
bottom to the top of the image\&.
-.PP
-By convention,
-\fIpix\fR
-images are usually square, and thus their dimensions can be determined by the
file size\&. If this is not the case, often only the file width need be known
by a program reading the file\&. History has left us with two "standard" sizes,
512x512 and the "higher" 1024x1024\&. A common practice for other file sizes is
to include the file width in the filename\&.
-.PP
-At some time in the future
-\fIpix\fR
-files will probably get self\-typing headers so that parameters such as their
size can be automatically determined by programs\&.
-.SH "UTILITIES"
-.PP
-\fBpix\-fb\fR
-display a \&.pix format image on a framebuffer\&.
-.PP
-\fBfb\-pix\fR
-produce a \&.pix file from a framebuffer image\&.
-.PP
-\fBpix\-bw\fR
-convert a \&.pix file to a black and white \&.bw file\&.
-.PP
-\fBbw\-pix\fR
-convert a black and white \&.bw file to a \&.pix file\&.
-.PP
-\fBap\-pix\fR
-convert an Applicon Color Plotter file to a \&.pix file\&.
-.PP
-\fBpixtile\fR
-combine several small \&.pix files into one large one\&.
-.PP
-\fBpixstat\fR
-gives statistics concerning a \&.pix file\&.
-.PP
-\fBpixhist\fR
-displays a color histogram on a framebuffer\&.
-.PP
-\fBpixhist3d\fR
-display three views of an RGB color space histogram on a framebuffer\&.
-.PP
-\fBpixhist3d\-pl\fR
-unix plot of RGB color space utilization\&.
-.PP
-\fBpixdiff\fR
-shows which pixels/colors differ between two \&.pix files\&.
-.PP
-\fBpixrect\fR
-extracts an arbitrary rectangle from a \&.pix file\&.
-.PP
-\fBpixrot\fR
-rotate, reverse, or invert a \&.pix file\&.
-.PP
-\fBpixscale\fR
-scale a \&.pix file up or down\&.
-.PP
-\fBpixfilter\fR
-a collection of 3x3 kernel filters for \&.pix files\&.
-.PP
-\fBbw3\-pix\fR
-merges three \&.bw files into one \&.pix file\&.
-.PP
-\fBpix\-bw3\fR
-separates \&.pix file RGB colors into three \&.bw files\&.
-.SH "FILES"
-.PP
-file\&.pix
-.SH "SEE ALSO"
-.PP
-\fBbrlcad\fR(1),
-\fBbw\fR(5), and above named programs\&.
-.SH "AUTHOR"
-.PP
-BRL\-CAD Team
-.SH "COPYRIGHT"
-.PP
-This software is Copyright (c) 1989\-2012 by the United States Government as
represented by U\&.S\&. Army Research Laboratory\&.
-.SH "BUG REPORTS"
-.PP
-Reports of bugs or problems should be submitted via electronic mail to
<devs@brlcad\&.org>\&.
-.SH "AUTHOR"
-.br
-.RS 4
-Author.
-.RE
Deleted: brlcad/trunk/doc/plot3.5
===================================================================
--- brlcad/trunk/doc/plot3.5 2012-12-06 22:17:58 UTC (rev 54012)
+++ brlcad/trunk/doc/plot3.5 2012-12-06 22:24:13 UTC (rev 54013)
@@ -1,284 +0,0 @@
-'\" t
-.\" Title: PLOT3
-.\" Author:
-.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 12/04/2012
-.\" Manual: BRL-CAD
-.\" Source: BRL-CAD
-.\" Language: English
-.\"
-.TH "PLOT3" "5" "12/04/2012" "BRL\-CAD" "BRL\-CAD"
-.\" -----------------------------------------------------------------
-.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.ie \n(.g .ds Aq \(aq
-.el .ds Aq '
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-plot3 \- 3\-D and color graphic plotting interface
-.SH "DESCRIPTION"
-.PP
-Files of this format are produced by programs such as
-\fBpixhist3d-pl\fR(1), using the routines described in
-\fBlibplot3\fR(3)
-and are interpreted for various devices by standard programs described in
-\fBplot\fR(1G), as well as additional programs such as
-\fBpl-fb\fR(1)\&. The format of output from
-\fIlibplot3\fR
-differs from that of
-\fIlibplot\fR
-only in the addition of 3\-D primitives and color\&. A graphics file is a
stream of plotting instructions\&. Each instruction consists of an
-ASCII
-
-letter usually followed by bytes of binary information\&. The instructions are
executed in order\&. A point is designated by four bytes representing the
-\fBx\fR
-and
-\fBy\fR
-values; each value is a signed 16\-bit integer\&. These integers are written
with the most significant byte first\&. Three\-dimensional data have an
additional
-\fBz\fR
-value, which is assumed to be zero for two\-dimensional instructions\&. The
last designated point in an
-\fBl\fR,
-\fBm\fR,
-\fBn\fR,
-\fBp\fR,
-\fBL\fR,
-\fBM\fR,
-\fBN\fR, or
-\fBP\fR
-instruction becomes the "current point" for the next instruction\&.
-.PP
-Each of the following descriptions begins with the name of the corresponding
routine in
-\fBlibplot3\fR(3)\&.
-.PP
-\fBm\fR
-.RS 4
-move: The next four bytes give a new current point\&.
-.RE
-.PP
-\fBn\fR
-.RS 4
-cont: Draw a line from the current point to the point given by the next four
bytes\&. See
-\fBplot\fR(1G)\&.
-.RE
-.PP
-\fBp\fR
-.RS 4
-point: Plot the point given by the next four bytes\&.
-.RE
-.PP
-\fBl\fR
-.RS 4
-line: Draw a line from the point given by the next four bytes to the point
given by the following four bytes\&.
-.RE
-.PP
-\fBt\fR
-.RS 4
-label: Place the following
-ASCII
-
-string so that its first character falls on the current point\&. The string is
terminated by a new\-line\&.
-.RE
-.PP
-\fBa\fR
-.RS 4
-arc: The first four bytes give the center, the next four give the starting
point, and the last four give the end point of a circular arc\&. The least
significant coordinate of the end point is used only to determine the
quadrant\&. The arc is drawn counter\-clockwise\&.
-.RE
-.PP
-\fBc\fR
-.RS 4
-circle: The first four bytes give the center of the circle, the next two the
radius\&. Circles and arcs are not supported on all devices\&.
-.RE
-.PP
-\fBe\fR
-.RS 4
-erase: Start another frame of output\&.
-.RE
-.PP
-\fBf\fR
-.RS 4
-linmod: Take the following string, up to a new\-line, as the style for drawing
further lines\&. The styles are "dotted", "solid", "longdashed", "shortdashed",
and "dotdashed"\&. Effective only for the
-\fB\-T4014\fR
-and
-\fB\-Tver\fR
-options of
-\fBplot\fR(1G)
-(
-TEKTRONIX
-
-4014 terminal and Versatec plotter)\&.
-.RE
-.PP
-\fBs\fR
-.RS 4
-space: The next four bytes give the lower left corner of the plotting area;
the following four give the upper right corner\&. The plot will be magnified or
reduced to fit the device as closely as possible\&.
-.RE
-.PP
-The following were added at BRL\&. Three\-dimensional primitives have their
-\fBz\fR
-values ignored when displayed on two\-dimensional devices\&.
-.PP
-\fBC\fR
-.RS 4
-color: The next three bytes give respectively the intensities (0\&.\&.255) of
the three color components (additive colors red, green, and blue if a terminal;
subtractive colors cyan, magenta, and yellow if hardcopy) to be used for
subsequent plotting\&. The initial color is assumed to be (255,255,255), which
is white on a terminal and black on hardcopy\&. Color specifications are
ignored for black\-and\-white devices\&.
-.RE
-.PP
-\fBM\fR
-.RS 4
-3move: The next six bytes give a new current point\&.
-.RE
-.PP
-\fBN\fR
-.RS 4
-3cont: Draw a line from the current point to the point given by the next six
bytes\&. See
-\fBplot\fR(1G)\&.
-.RE
-.PP
-\fBP\fR
-.RS 4
-3point: Plot the point given by the next six bytes\&.
-.RE
-.PP
-\fBL\fR
-.RS 4
-3line: Draw a line from the point given by the next six bytes to the point
given by the following six bytes\&.
-.RE
-.PP
-\fBS\fR
-.RS 4
-3space: The next six bytes give the minimum corner of the plotting area; the
following six give the maximum corner\&. The plot will be magnified or reduced
to fit the device as closely as possible\&.
-.RE
-.PP
-\fBF\fR
-.RS 4
-3flush:
-.RE
-.PP
-\fBx\fR
-.RS 4
-double_point: The double\-precision version of point\&.
-.RE
-.PP
-\fBv\fR
-.RS 4
-double_line: The double\-precision version of line\&.
-.RE
-.PP
-\fBo\fR
-.RS 4
-double_move: The double\-precision version of move\&.
-.RE
-.PP
-\fBq\fR
-.RS 4
-double_cont: The double\-precision version of cont\&.
-.RE
-.PP
-\fBw\fR
-.RS 4
-double_space: The double\-precision version of space\&.
-.RE
-.PP
-\fBi\fR
-.RS 4
-double_circle: The double\-precision version of circle\&.
-.RE
-.PP
-\fBr\fR
-.RS 4
-double_arc: The double\-precision version of arc\&.
-.RE
-.PP
-\fBW\fR
-.RS 4
-double_3space: The double\-precision, 3_D version of space\&.
-.RE
-.PP
-\fBX\fR
-.RS 4
-double_3point: The double\-precision, 3_D version of point\&.
-.RE
-.PP
-\fBO\fR
-.RS 4
-double_3move: The double\-precision, 3_D version of move\&.
-.RE
-.PP
-\fBQ\fR
-.RS 4
-double_3cont: The double\-precision, 3_D version of cont\&.
-.RE
-.PP
-\fBV\fR
-.RS 4
-double_3line: The double\-precision, 3_D version of line\&.
-.RE
-.PP
-Space settings that exactly fill the plotting area with unity scaling appear
below for devices supported by the filters of
-\fBplot\fR(1G)\&. The upper limit is just outside the plotting area, except
for the Megatek which displays the entire range of possible coordinates\&. In
every case the plotting area is taken to be square; points outside may be
displayable on devices whose face is not square\&.
-.PP
-\fIDASI 300\fR
-.RS 4
-space(0, 0, 4096, 4096);
-.RE
-.PP
-\fIDASI 300s\fR
-.RS 4
-space(0, 0, 4096, 4096);
-.RE
-.PP
-\fIDASI 450\fR
-.RS 4
-space(0, 0, 4096, 4096);
-.RE
-.PP
-TEKTRONIX 4014
-.RS 4
-space(0, 0, 3120, 3120);
-.RE
-.PP
-Versatec plotter
-.RS 4
-space(0, 0, 2048, 2048);
-.RE
-.PP
-Megatek display
-.RS 4
-space(\-32768, \-32768, 32767, 32767);
-.RE
-.SH "SEE ALSO"
-.PP
-\fBlibplot3\fR(3),
-\fBplot\fR(3),
-\fBplot\fR(5)\&.
-.PP
-\fBgraph\fR(1G),
-\fBplot\fR(1G)
-in the
-\fI\fR\fIUNIX\fR\fI\fR\fI System User Reference Manual\fR\&.
-.SH "AUTHOR"
-.PP
-Douglas A\&. Gwyn made the 3\-D and color extensions to UNIX\-plot\&.
-.SH "COPYRIGHT"
-.PP
-This software is Copyright (c) 1989\-2012 by the United States Government as
represented by U\&.S\&. Army Research Laboratory\&.
-.SH "BUG REPORTS"
-.PP
-Reports of bugs or problems should be submitted via electronic mail to
<devs@brlcad\&.org>\&.
-.SH "AUTHOR"
-.br
-.RS 4
-Author.
-.RE
Modified: brlcad/trunk/misc/CMakeLists.txt
===================================================================
--- brlcad/trunk/misc/CMakeLists.txt 2012-12-06 22:17:58 UTC (rev 54012)
+++ brlcad/trunk/misc/CMakeLists.txt 2012-12-06 22:24:13 UTC (rev 54013)
@@ -41,7 +41,6 @@
endif(NOT CMAKE_CONFIGURATION_TYPES)
BRLCAD_ADDDATA(fortran_example.f sample_applications)
-ADD_MAN_PAGES(1 brlcad-config.1)
set(density_DATAFILES
GQA_SAMPLE_DENSITIES
Modified: brlcad/trunk/misc/Makefile.am
===================================================================
--- brlcad/trunk/misc/Makefile.am 2012-12-06 22:17:58 UTC (rev 54012)
+++ brlcad/trunk/misc/Makefile.am 2012-12-06 22:24:13 UTC (rev 54013)
@@ -8,14 +8,12 @@
sample_applications_DATA = fortran_example.f
bin_SCRIPTS = brlcad-config
-man_MANS = brlcad-config.1
DATAFILES = \
GQA_SAMPLE_DENSITIES \
NIST_DENSITIES
EXTRA_DIST = \
- $(man_MANS) \
$(sample_applications_DATA) \
${DATAFILES} \
CMake \
Deleted: brlcad/trunk/misc/brlcad-config.1
===================================================================
--- brlcad/trunk/misc/brlcad-config.1 2012-12-06 22:17:58 UTC (rev 54012)
+++ brlcad/trunk/misc/brlcad-config.1 2012-12-06 22:24:13 UTC (rev 54013)
@@ -1,105 +0,0 @@
-'\" t
-.\" Title: BRLCAD-CONFIG
-.\" Author:
-.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 12/04/2012
-.\" Manual: BRL-CAD
-.\" Source: BRL-CAD
-.\" Language: English
-.\"
-.TH "BRLCAD\-CONFIG" "1" "12/04/2012" "BRL\-CAD" "BRL\-CAD"
-.\" -----------------------------------------------------------------
-.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.ie \n(.g .ds Aq \(aq
-.el .ds Aq '
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-brlcad-config \- script to get information about the installed version of
BRL\-CAD
-.SH "SYNOPSIS"
-.HP \w'\fBbrlcad\-config\fR\ 'u
-\fBbrlcad\-config\fR [\-\-prefix\ [\fI=DIR\fR]] [\-\-libs] [\-\-cflags]
[\-\-version] [\-\-help]
-.SH "DESCRIPTION"
-.PP
-\fBbrlcad\-config\fR
-is a script that describes the compile and linker flags that should be used to
compile and link programs that use
-\fIBRL\-CAD\fR\*(Aqs libraries\&.
-.SH "OPTIONS"
-.PP
-\fBbrlcad\-config\fR
-.RS 4
-accepts the following options:
-.RE
-.PP
-\fB\-\-prefix=PREFIX\fR
-.RS 4
-If specified, use the provided installation PREFIX instead of the prefix that
-\fIBRL\-CAD\fR
-was compiled with when providing the output for the other
-\fBbrlcad\-config\fR
-script options\&.
-.RE
-.PP
-\fB\-\-libs\fR
-.RS 4
-Prints out library linker flags that are generally needed when creating a
program that links to
-\fIBRL\-CAD\fR
-libraries\&.
-.RE
-.PP
-\fB\-\-cflags\fR
-.RS 4
-Prints out compilation flags that are generally needed when creating a program
that refers to
-\fIBRL\-CAD\fR
-headers\&.
-.RE
-.PP
-\fB\-\-version\fR
-.RS 4
-Prints out the version of
-\fIBRL\-CAD\fR
-that is installed\&.
-.RE
-.PP
-\fB\-\-help\fR
-.RS 4
-Display usage\&.
-.RE
-.SH "SEE ALSO"
-.PP
-\fBbrlcad\fR(1),
-\fBlibbu\fR(3),
-\fBlibbn\fR(3),
-\fBlibrt\fR(3),
-\fBlibwdb\fR(3)\&.
-.SH "BUGS"
-.PP
-No bugs known for
-\fBbrlcad\-config\fR\&.
-.SH "AUTHOR"
-.PP
-Christopher Sean Morrison
-.SH "COPYRIGHT"
-.PP
-This software is Copyright (c) 2007\-2012 United States Government as
represented by the U\&.S\&. Army Research Laboratory\&. All rights reserved\&.
-.SH "BUG REPORTS"
-.PP
-Reports of bugs or problems should be submitted via electronic mail to
<devs@brlcad\&.org>\&.
-.SH "AUTHOR"
-.br
-.RS 4
-Author.
-.RE
Modified: brlcad/trunk/misc/enigma/CMakeLists.txt
===================================================================
--- brlcad/trunk/misc/enigma/CMakeLists.txt 2012-12-06 22:17:58 UTC (rev
54012)
+++ brlcad/trunk/misc/enigma/CMakeLists.txt 2012-12-06 22:24:13 UTC (rev
54013)
@@ -23,7 +23,6 @@
CMAKEFILES(enigma.c)
endif(NOT BRLCAD_ENABLE_TARGETS OR "${BRLCAD_ENABLE_TARGETS}" GREATER 2)
-ADD_MAN_PAGES(1 enigma.1)
set(enigma_ignore_files
AUTHORS
COPYING
Modified: brlcad/trunk/misc/enigma/Makefile.am
===================================================================
--- brlcad/trunk/misc/enigma/Makefile.am 2012-12-06 22:17:58 UTC (rev
54012)
+++ brlcad/trunk/misc/enigma/Makefile.am 2012-12-06 22:24:13 UTC (rev
54013)
@@ -4,8 +4,6 @@
enigma_SOURCE = enigma.c
enigma_LDFLAGS = ${LIBBSD}
-dist_man_MANS = enigma.1
-
EXTRA_DIST = \
AUTHORS \
COPYING \
Deleted: brlcad/trunk/misc/enigma/enigma.1
===================================================================
--- brlcad/trunk/misc/enigma/enigma.1 2012-12-06 22:17:58 UTC (rev 54012)
+++ brlcad/trunk/misc/enigma/enigma.1 2012-12-06 22:24:13 UTC (rev 54013)
@@ -1,127 +0,0 @@
-'\" t
-.\" Title: ENIGMA
-.\" Author: Joerg Wunsch
-.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 12/04/2012
-.\" Manual: BRL-CAD
-.\" Source: BRL-CAD
-.\" Language: English
-.\"
-.TH "ENIGMA" "1" "12/04/2012" "BRL\-CAD" "BRL\-CAD"
-.\" -----------------------------------------------------------------
-.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.ie \n(.g .ds Aq \(aq
-.el .ds Aq '
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-enigma \- very simple file encryption
-.SH "SYNOPSIS"
-.HP \w'\fBenigma,\fR\ 'u
-\fBenigma,\fR \-\-s \-\-k \fIpassword\fR \fIenigma,\fR \-\-s \-\-k
\fIpassword\fR
-.SH "DESCRIPTION"
-.PP
-\fB enigma,\fR
-also known as
-\fB enigma,\fR
-is a
-\fIvery\fR
-simple encryption program, working on a "secret\-key" basis\&. It operates as
a filter, i\&. e\&. it encrypts or decrypts a stream of data from standard
input, and writes the result to standard output\&. It automatically detects
whether the input data stream is already encrypted, and switches into
decryption mode in this case\&.
-.PP
-There are several ways to provide the secret key to the program\&. By default,
the program prompts the user on the controlling terminal for the key, using
-\fBgetpass\fR(3)\&. This is the only safe way of providing it\&.
-.PP
-Alternatively, the key can be provided as the sole command\-line argument
-\fIpassword\fR
-when starting the program\&. Obviously, this way the key can easily be spotted
by other users running
-\fBps\fR(1)\&. As yet another alternative,
-\fB enigma,\fR
-can be given the option
-\fB\-k\fR, and it will take the key from the environment variable
-\fBCrYpTkEy\fR\&. While this at a first glance seems to be more secure than
the previous option, it actually isn\*(Aqt since environment variables can also
be examined with
-\fBps\fR(1)\&. Thus this option is mainly provided for compatibility with
other implementations of
-\fB enigma,\fR
-.PP
-When specifying the option
-\fB\-s\fR,
-\fB enigma,\fR
-modifies the encryption engine in a way that is supposed to make it a little
more secure, but incompatible with other implementations\&.
-.SS "Warning"
-.PP
-The cryptographic value of
-\fB enigma,\fR
-is rather small\&. This program is only provided here for compatibility with
other operating systems that also provide an implementation\&. For real
encryption, refer to
-\fBbdes\fR(1)
-(from the DES distribution package), or
-\fBpgp\fR(1)
-(from the ports collection)\&. However, restrictions for exporting, importing
or using such tools might exist in some countries, so those stronger programs
are not being shipped as part of the operating system by default\&.
-.SH "ENVIRONMENT"
-.PP
-\fBCrYpTkEy\fR
-.RS 4
-used to obtain the secret key when option
-\fB\-k\fR
-has been given
-.RE
-.SH "EXAMPLES"
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-man enigma | enigma > encrypted
-Enter key: (XXX \-\- key not echoed)
-.fi
-.if n \{\
-.RE
-.\}
-.PP
-This will create an encrypted form of this man page, and store it in the file
\*(Aq encrypted \*(Aq\&.
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-enigma XXX < encrypted
-.fi
-.if n \{\
-.RE
-.\}
-.PP
-This displays the previously created file on the terminal\&.
-.SH "SEE ALSO"
-.PP
-\fBbdes\fR(1),
-\fBpgp\fR(1),
-\fBps\fR(1),
-\fBgetpass\fR(3)
-.SH "HISTORY"
-.PP
-Implementations of
-\fB enigma,\fR
-are very common among
-Unix
-operating systems\&. This implementation has been taken from the
-\fICrypt\fR
-\fIBreaker\*(Aqs\fR
-\fIWorkbench\fR
-which is in the public domain\&.
-.SH "AUTHOR"
-.PP
-\fBJoerg Wunsch\fR
-.RS 4
-enigma
-.RE
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
LogMeIn Rescue: Anywhere, Anytime Remote support for IT. Free Trial
Remotely access PCs and mobile devices and provide instant support
Improve your efficiency, and focus on delivering more value-add services
Discover what IT Professionals Know. Rescue delivers
http://p.sf.net/sfu/logmein_12329d2d
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
