Read Me

Welcome to strerror!

This is a program for error codes describing. It can use arbitrary
number of codes, ranges or shows full system range. strerror will
be avail in understanding error messages such as "Error 71".

This program is distributed under the terms of explicitly
GNU GPL v.3 license. Please read LICENSE file for details.

_____________
Requirements:
~~~~~~~~~~~~~
- Working build suit. Even gcc 3.x would be enough, but
  gcc 4.x is recommended for better code optimization and
  gcc >= 4.2.0 for the most reliable CPU detection.

- libiberty. It is needed for obtaining maximum errno number,
  available in your system and for errno names obtaining.
  It is usually shipped within binutils package. Version higher
  2.18.50 will work definitely, but lower versions should work too.

______________
How to obtain:
~~~~~~~~~~~~~~
You can get releases from:
https://sourceforge.net/projects/strerror/

SVN repository with the latest code is available here:
https://strerror.svn.sourceforge.net/svnroot/strerror/

Use this command to obtain sources in the first time:
svn co https://strerror.svn.sourceforge.net/svnroot/strerror strerror
To update code later you can just type:
svn up
within strerror directory.

_____________
Installation:
~~~~~~~~~~~~~
Compiler and build options can be tweaked via $CC, $CFLAGS,
$LDFLAGS and $DESTDIR environment variables.

To configure program type:
./configure
See ./configure --help for more details.
Please note, configure script is smart enough and can detect
even your CPU optimizations flags automatically (but better
use gcc >= 4.2.0).

To compile program type:
make

Build system honors standard install path variables.
Currently useful $DESTDIR, $prefix, $bindir, $mandir and $docdir;
so you may tweak install paths.

To install program you may just type:
make install
But package-based installation is recommended.

To cleanup build directory use:
make distclean

To uninstall program use:
make uninstall

_________
Packages:
~~~~~~~~~
It is advisable to use some package system instead of just using
make install. This will help to keep your system in order and will
simplify its maintenance.

Currently I can provide rpm and ebuild packages. But if you made a 
package of another type (deb, ebuild, etc) and want to provide it 
for other people, please let me know and I'll consider its 
inclusion in the main program source tree.

To make rpm:
1) copy strerror.spec file to your SPECS dir, tune it as
required for your system if needed;
2) copy source tarball into your SOURCES directory;
3) type:
rpmbuild -bb --clean [--target=<your architecture>] strerror.spec
within your SPECS directory.
4) install as root compiled rpm from SOURCES/<arch_type> directory.

To install ebuild:
1) copy strerror.ebuild to your local portage tree;
2) copy source tarball to your distfiles dir;
3) emerge package as usual:
emerge --deep strerror

______
Usage:
~~~~~~
The simplest way to use the program is to type:
strerror <code>

This will describe error code <code>.

Please look at manual page for full description, for shorter 
remainder see strerror -h.