/*******************************************************************
 * INSTALL file for ifchk-1.1.2.                                   *
 *                                                                 *
 * Copyright (C) 2002 - 2020 Joshua Birnbaum <engineer@noorg.org>. *
 * All Rights Reserved.                                            *
 *******************************************************************/


Please read the NOTES section below, prior to building ifchk.


Building ifchk.
--------------


Building ifchk should be straightforward on most systems (may require root/sudo):

# cd ~/ifchk-1.1.2
# make
# mv ifchk /to/somewhere/suitable/in/your/$PATH
# cp ifchk.conf /to/a/suitable/configuration/directory
# cp docs/ifchk.1 /to/somewhere/suitable/in/your/$MANPATH
# cp docs/ifchk.conf.5 /to/somewhere/suitable/in/your/$MANPATH

To clean out the ifchk build directory:

# cd ~/ifchk-1.1.2
# make clean


Installing ifchk.
----------------


Install the ifchkboot init script - for CentOS 6, Red Hat Enterprise Linux 6:

# cp ~/ifchk-1.1.2/ifchkboot/6/ifchkboot /etc/rc.d/init.d
# chkconfig --add ifchkboot


Install the ifchkboot service unit - for CentOS 7, Red Hat Enterprise Linux 7:

# cp ~/ifchk-1.1.2/ifchkboot/7/ifchkboot.service /usr/lib/systemd/system
# systemctl enable ifchkboot.service


Install the ifchkboot init script - for other Linux distributions:

  /* Refer to your linux distribution's manual  */
  /* page collection to complete this task.     */
  /* Start by reading its init(8) or systemd(1) */
  /* manual page(s).                            */


NOTES.
-----

* ifchk compilation requires an ANSI C compiler.
  Makefile assumes the use of gcc. Reset the CC environment variable
  in Makefile if you are building with a different ANSI C compiler
  implementation (e.g., Intel icc).
  Also, check that this compiler supports the -g flag, as assigned to
  the CFLAGS environment variable.

* ifchk makes extensive use of the SysFS filesystem to perform interface
  specific tasks. This requires the installation of SysFS libraries to
  resolve calls to the sysfs(2) subsystem.
 
  Be sure to check that you have the relevant SysFS libraries installed
  for your Linux distribution. Your distribution's website will likely
  provide information regarding these requisite libraries.


REPORTING BUGS.
--------------

* When reporting bugs or problems related to ifchk, please include
  uname -a, dmesg, and C compiler revision output. Please also include
  the version of ifchk in question. This information can be sent to
  me at engineer@noorg.org, as can comments, and suggestions.


Enjoy.

-Josh Birnbaum <engineer@noorg.org>.
