# Last edited on 2013-10-31 18:06:33 by stolfilocal

This directory contains the source for library modules and executable
programs to perform certain bit operations on memory areas or files:

  cryptoy_mem.{h,c} - (library) bit operations in memory.
  
  cryptoy_file.{h,c} - (library) bit operations on files.
  
  bxor.c - (executable) bitwise XOR of two files.
  
  bmix.c - (executable) bit-swapping between two files, controlled by a third.
  
 
DOCUMENTATION

  To get the manpage of an executable program "{PROG}" (e.g. "bxor" or
  "bmix") execute "bxor -info" (or "bxor -help" for a short reminder).

  Other examples of use can be found in tests/{PROG}/Makefile.

  Samples of output plots can be found in tests/{PROG}/out-check

BUILDING

  The code and Makefile seem to work on Fedora GNU/Linux as installed on my machine.
  They will probably need adjustments for other environments.  
  
  Executing "make" at the root directory will compile all modules and link the 
  executable "bxor".
  
  You may have to delete the file "Deps.make".
  
  Executing "make" in the "tests" sub-directory should run three examples and 
  display the output Postscript files (in the "tests/out" sub-directory).
  If all goes well, they should be identical to the files in "tests/out-check".
  
DISCLAIMERS

  This software is provided "as is", WITHOUT ANY EXPLICIT OR
  IMPLICIT WARRANTY, not even the implied warranties of merchantibility
  and fitness for a particular purpose.

  Permission to use, copy, modify, and redistribute this software and
  its documentation for any purpose is hereby granted, royalty-free,
  provided that: (1) the notices in the source files about copyright,
  authorship, warranty and rights in all source files are retained or
  replaced by completely free alternatives, such as the GNU Public
  License (GPL); (2) no executable code derived from this file is
  published or distributed without the corresponding source code; and
  (3) these same rights are granted to any recipient of such code, under
  the same conditions.