From fad780edca929a656a0428c1c627e838c2b3326c Mon Sep 17 00:00:00 2001
From: chrfranke <chrfranke@4ea69e1a-61f1-4043-bf83-b5c94c648137>
Date: Sun, 11 Apr 2004 17:13:39 +0000
Subject: [PATCH] Clarified the distinction of Cygwin and Windows version

git-svn-id: https://smartmontools.svn.sourceforge.net/svnroot/smartmontools/trunk@1670 4ea69e1a-61f1-4043-bf83-b5c94c648137
---
 sm5/INSTALL          | 54 +++++++++++++++++++++++++++++++-------------
 sm5/TODO             | 18 +++++++++------
 sm5/WARNINGS         |  7 +++---
 sm5/smartctl.8.in    |  6 +++--
 sm5/smartd.8.in      | 31 +++++++++++++------------
 sm5/smartd.conf.5.in |  8 +++----
 6 files changed, 77 insertions(+), 47 deletions(-)

diff --git a/sm5/INSTALL b/sm5/INSTALL
index 56db649c6..2f00ef7c2 100644
--- a/sm5/INSTALL
+++ b/sm5/INSTALL
@@ -1,7 +1,7 @@
 Smartmontools installation instructions
 =======================================
 
-$Id: INSTALL,v 1.41 2004/04/06 22:01:19 chrfranke Exp $
+$Id: INSTALL,v 1.42 2004/04/11 17:13:38 chrfranke Exp $
 
 Please also see the smartmontools home page:
 http://smartmontools.sourceforge.net/
@@ -15,9 +15,10 @@ Table of contents:
 [5] Guidelines for FreeBSD
 [6] Guidelines for NetBSD
 [7] Guidelines for Solaris
-[8] Guidelines for Windows
-[9] Comments
-[10] Detailed description of ./configure options
+[8] Guidelines for Cygwin
+[9] Guidelines for Windows
+[10] Comments
+[11] Detailed description of ./configure options
 
 [1] System requirements
 =======================
@@ -78,9 +79,9 @@ Table of contents:
     ATAng will not support 100% operation, as the SMART status can not
     be reliably retrieved.  There is patch pending approval of the
     ATAng driver maintainer that will address this issue.
-    
+
     C) Solaris
-    
+
     The SCSI code has been tested on a variety of Solaris 8 and 9
     systems.  ATA/IDE code only works on SPARC platform.  All tested
     kernels worked correctly.
@@ -91,9 +92,18 @@ Table of contents:
     also function under 1.6.1 and later releases (unverified).  Currently
     it doesn't support ATA devices on 3ware RAID controllers.
 
-    E) Windows
+    E) Cygwin
+
+    The code was tested on Cygwin 1.5.7 and should also work on other
+    recent releases.
+
+    Both Cygwin and Windows versions of smartmontools share the same code
+    to access the IDE/ATA or SCSI devices. The information in the "Windows"
+    section below also applies to the Cygwin version.
+
+    F) Windows
 
-    The Code was tested on Windows 98SE, NT4, 2000 and XP. It should also
+    The code was tested on Windows 98SE, NT4, 2000 and XP. It should also
     work on Windows 95(OSR2) and ME.
 
     On 9x/ME, only standard (legacy) IDE/ATA devices 0-3 are supported.
@@ -109,7 +119,6 @@ Table of contents:
     SCSI devices are supported on all versions of Windows. An installed
     ASPI interface (WNASPI32.DLL) is required to access SCSI devices.
 
-
 [2] Installing from CVS
 =======================
     Get the sources from the CVS repository:
@@ -281,17 +290,30 @@ SuSE:
     where <knum> is related to <snum> such that the higher snum is the
     lower knum must be.
 
-[8] Guidelines for Windows
-==========================
-Cygwin:
-  ./configure --mandir=/usr/share/man                            \
+[8] Guidelines for Cygwin
+=========================
+
+Same as Red Hat:
+  ./configure
+  OR EQUIVALENTLY
+  ./configure --sbindir=/usr/sbin                               \
+              --sysconfdir=/etc                                 \
+              --mandir=/usr/share/man                           \
+              --with-initscriptdir=/etc/rc.d/init.d             \
               --with-docdir=/usr/share/doc/smartmontools-VERSION
 
-MinGW:
+[9] Guidelines for Windows
+==========================
+
+To compile the Windows release with MinGW, use the following on Cygwin:
+
   ./configure --disable-dependency-tracking --build mingw32
+  make
 
+  Instead of using "make install", copy the .exe files into
+  some directory in the PATH.
 
-[9] Comments
+[10] Comments
 ============
 
 To compile from another directory, you can replace the step
@@ -352,7 +374,7 @@ The following files are installed if ./configure has no options:
 /usr/share/doc/smartmontools-5.X/examplescripts	[Executable scripts for -M exec of smartd.conf (4 files)]
 
 
-[10] Detailed description of arguments to configure command
+[11] Detailed description of arguments to configure command
 ===========================================================
 
 When you type:
diff --git a/sm5/TODO b/sm5/TODO
index f32dd01fd..42b637704 100644
--- a/sm5/TODO
+++ b/sm5/TODO
@@ -1,6 +1,6 @@
 TODO list for smartmontools:
 
-$Id: TODO,v 1.50 2004/04/07 10:11:35 chrfranke Exp $
+$Id: TODO,v 1.51 2004/04/11 17:13:39 chrfranke Exp $
 
 SATA devices
 ------------
@@ -81,17 +81,21 @@ FreeBSD
 Get interface for 3ware Escalade controllers working (Eduard).
 Modify smartctl -h examples
 
+Cygwin and Windows
+------------------
+Add IDE/ATA selective self test and check power mode.
+
+Access SCSI devices via IOCTL_SCSI_PASS_THROUGH on 2000/XP
+to support systems with missing ASPI driver.
+
 Windows
 -------
-Add warning Mail feature to Windows/Native smartd, probably using
-the Blat mailer as a default (http://www.blat.net/).
-
-Add IDE/ATA selective self test and check power mode.
+Add warning mail feature to smartd, probably using the
+"Blat" mailer as a default (http://www.blat.net/).
 
 Add ability to run smartd as a windows service.
 
-Access SCSI devices via IOCTL_SCSI_PASS_THROUGH on 2000/XP
-to support systems with missing ASPI driver.
+Provide some installer.
 
 Packaging
 ---------
diff --git a/sm5/WARNINGS b/sm5/WARNINGS
index 946b86a9a..b7f55f9b8 100644
--- a/sm5/WARNINGS
+++ b/sm5/WARNINGS
@@ -1,4 +1,4 @@
-$Id: WARNINGS,v 1.23 2004/04/09 23:18:39 ballen4705 Exp $
+$Id: WARNINGS,v 1.24 2004/04/11 17:13:39 chrfranke Exp $
 
 The most recent version of this file can be found here:
 http://cvs.sourceforge.net/viewcvs.py/smartmontools/sm5/WARNINGS?view=markup
@@ -91,8 +91,8 @@ SOLARIS
 [No problem reports yet.]
 
 
-WINDOWS
--------
+CYGWIN and WINDOWS
+------------------
 
 SYSTEM:   Any Windows 2000 or XP system.
 PROBLEM:  Use of an undocumented system call for IDE/ATA read log
@@ -106,4 +106,3 @@ NOTE:     The IOCTL call SMART_RCV_DRIVE_DATA does not support
           Invalid log output has been reported for at least one
           W2K system.
 
-
diff --git a/sm5/smartctl.8.in b/sm5/smartctl.8.in
index 6813e3e6d..9ea011039 100644
--- a/sm5/smartctl.8.in
+++ b/sm5/smartctl.8.in
@@ -1,7 +1,7 @@
 .ig
  Copyright (C) 2002-4 Bruce Allen <smartmontools-support@lists.sourceforge.net>
 
- $Id: smartctl.8.in,v 1.44 2004/04/07 22:06:12 ballen4705 Exp $
+ $Id: smartctl.8.in,v 1.45 2004/04/11 17:13:38 chrfranke Exp $
  
  This program is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by the Free
@@ -77,6 +77,8 @@ Use the forms \fB"/dev/hd[a-j]"\fP for IDE/ATA devices
 \fB"/dev/hd[a-d]"\fP for standard IDE/ATA devices on Win95/98/98SE/ME,
 and \fB"/dev/scsi[0-9][0-f]"\fP for SCSI devices on ASPI adapter 0-9, ID 0-15.
 The prefix \fB"/dev/"\fP is optional.
+.IP \fBCYGWIN\fP: 9
+See "WINDOWS" above.
 .PP
 Based on the device path, \fBsmartctl\fP will guess the device type
 (ATA or SCSI).  If necessary, the \'\-d\' option can be used to over-ride
@@ -1147,7 +1149,7 @@ these documents may be found in the References section of the
 
 .SH
 CVS ID OF THIS PAGE:
-$Id: smartctl.8.in,v 1.44 2004/04/07 22:06:12 ballen4705 Exp $
+$Id: smartctl.8.in,v 1.45 2004/04/11 17:13:38 chrfranke Exp $
 .\" Local Variables:	         
 .\" mode: nroff         
 .\" End:
diff --git a/sm5/smartd.8.in b/sm5/smartd.8.in
index 41abfaf02..628dbc59d 100644
--- a/sm5/smartd.8.in
+++ b/sm5/smartd.8.in
@@ -1,7 +1,7 @@
 .ig
 Copyright (C) 2002-4 Bruce Allen <smartmontools-support@lists.sourceforge.net>
  
-$Id: smartd.8.in,v 1.59 2004/04/09 04:16:06 ballen4705 Exp $
+$Id: smartd.8.in,v 1.60 2004/04/11 17:13:39 chrfranke Exp $
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -60,7 +60,7 @@ the command:
 .fi
 \fBkillall -HUP smartd\fP.
 .fi
-(Windows/Native: Use \'\fBsmartd reload\fP\' to simulate the HUP signal.)
+(Windows: Use \'\fBsmartd reload\fP\' to simulate the HUP signal.)
 
 On startup, if \fBsmartd\fP finds a syntax error in the configuration
 file, it will print an error message and then exit. However if
@@ -74,7 +74,7 @@ When \fBsmartd\fP is running in debug mode, the \fBQUIT\fP signal
 (normally generated from a shell with CONTROL\-C) is treated in the
 same way as a \fBHUP\fP signal: it makes \fBsmartd\fP reload its
 configuration file. To exit \fBsmartd\fP use CONTROL-\e
-(Windows/Native: CONTROL-Break).
+(Windows: CONTROL-Break).
 
 On startup, in the absence of the configuration file
 \fB/etc/smartd.conf\fP, the \fBsmartd\fP daemon first scans for all
@@ -97,6 +97,8 @@ for IDE/ATA devices on WinNT4/2000/XP, \fB"/dev/hd[a-d]"\fP
 (bitmask from "\\\\.\\SMARTVSD") for IDE/ATA devices on Win95/98/98SE/ME,
 and \fB"/dev/scsi[0-3][0-7]"\fP (ASPI adapter 0-3, ID 0-7) for SCSI
 devices on all versions of Windows.
+.IP \fBCYGWIN\fP: 9
+See "WINDOWS" above.
 .PP
 \fBsmartd\fP then monitors
 for \fIall\fP possible SMART errors (corresponding to the \fB\'\-a\'\fP
@@ -138,9 +140,9 @@ terminal.  In this mode, \fBsmartd\fP also prints more verbose
 information about what it is doing than when operating in "daemon"
 mode. In this mode, the \fBQUIT\fP signal (normally generated from a
 terminal with CONTROL\-C) makes \fBsmartd\fP reload its configuration
-file.  Please use CONTROL-\e to exit (Windows/Native: CONTROL-Break).
+file.  Please use CONTROL-\e to exit (Windows: CONTROL-Break).
 
-Windows/Native only: The "debug" mode can be toggled by the command
+Windows only: The "debug" mode can be toggled by the command
 \fBsmartd sigusr2\fP. A new console for debug output is opened when
 debug mode is enabled.
 .TP
@@ -172,7 +174,7 @@ also use:
 .fi
 for the same purpose.
 .fi
-(Windows/Native: Use \'\fBsmartd sigusr1\fP\' to simulate the USR1 signal.)
+(Windows: Use \'\fBsmartd sigusr1\fP\' to simulate the USR1 signal.)
 
 .TP
 .B \-l FACILITY, \-\-logfacility=FACILITY
@@ -213,12 +215,12 @@ For more detailed information, please refer to the man pages for
 to modify the log rotation configuration files; see the man pages for
 \fBlogrotate\fP and examine your system\'s /etc/logrotate.conf file.
 
-Windows/Cygwin: The current release of Cygwin writes \fBsyslog\fP(3)
+Cygwin: The current release of Cygwin writes \fBsyslog\fP(3)
 messages to Windows event log or to file \fBC:/CYGWIN_SYSLOG.TXT\fP
 if the event log is not available.
 The FACILITY parameter is always ignored by Cygwin.
 
-Windows/Native: Some \fBsyslog\fP(3) functionality is implemented
+Windows: Some \fBsyslog\fP(3) functionality is implemented
 internally in \fBsmartd\fP as follows: If no \'\-l\' option
 (or \'\-l daemon\') is specified, messages are written to Windows
 event log or to file \fB./smartd.log\fP if event log is not available
@@ -843,7 +845,7 @@ you have mail problems, we recommend running \fBsmartd\fP in debug
 mode with the \'-d\' flag, using the \'-M test\' Directive described
 below.
 
-Windows/Native: The mail warning facility is not implemented yet.
+Windows: The mail warning facility is not implemented yet.
 By specifying \'\fB-m msgbox\fP\', a warning "email" is displayed
 as a message box on the screen. With \'\fB-m sysmsgbox\fP\', a system
 modal (always on top) message box is used.
@@ -1033,7 +1035,7 @@ Some EXAMPLES of scripts that can be used with the \'\-M exec\'
 Directive are given below. Some sample scripts are also included in
 /usr/share/doc/smartmontools-5.1/examplescripts/.
 
-Windows/Native: \'-M exec\' is not implemented yet.
+Windows: \'-M exec\' is not implemented yet.
 The other \'-M\' directives work in conjunction with the display of
 warning message boxes by \'-m msgbox\' or \'-m sysmsgbox\' (see above).
 
@@ -1496,10 +1498,11 @@ to read:
 Alternatively, you can use a local facility to log messages: please
 see the \fBsmartd\fP '-l' command-line option described above.
 
-On Windows, the log messages are written to the event log or to a file.
-See documentation of the '-l FACILITY' option above for details.
+On Cygwin and Windows, the log messages are written to the event log
+or to a file. See documentation of the '-l FACILITY' option above for
+details.
 
-Windows/Native: The following built-in commands can be used to control
+On Windows, the following built-in commands can be used to control
 the \fBsmartd\fP process:
 
 \'\fBsmartd status\fP\' \- check status
@@ -1644,4 +1647,4 @@ smartmontools home page at \fBhttp://smartmontools.sourceforge.net/\fP .
 
 .SH
 CVS ID OF THIS PAGE:
-$Id: smartd.8.in,v 1.59 2004/04/09 04:16:06 ballen4705 Exp $
+$Id: smartd.8.in,v 1.60 2004/04/11 17:13:39 chrfranke Exp $
diff --git a/sm5/smartd.conf.5.in b/sm5/smartd.conf.5.in
index 9928bc89e..684ec726c 100644
--- a/sm5/smartd.conf.5.in
+++ b/sm5/smartd.conf.5.in
@@ -1,7 +1,7 @@
 .ig
 Copyright (C) 2002-4 Bruce Allen <smartmontools-support@lists.sourceforge.net>
 
-$Id: smartd.conf.5.in,v 1.46 2004/04/09 04:16:06 ballen4705 Exp $
+$Id: smartd.conf.5.in,v 1.47 2004/04/11 17:13:39 chrfranke Exp $
 
 This program is free software; you can redistribute it and/or modify it
 under the terms of the GNU General Public License as published by the Free
@@ -515,7 +515,7 @@ you have mail problems, we recommend running \fBsmartd\fP in debug
 mode with the \'-d\' flag, using the \'-M test\' Directive described
 below.
 
-Windows/Native: The mail warning facility is not implemented yet.
+Windows: The mail warning facility is not implemented yet.
 By specifying \'\fB-m msgbox\fP\', a warning "email" is displayed
 as a message box on the screen. With \'\fB-m sysmsgbox\fP\', a system
 modal (always on top) message box is used.
@@ -705,7 +705,7 @@ Some EXAMPLES of scripts that can be used with the \'\-M exec\'
 Directive are given below. Some sample scripts are also included in
 /usr/share/doc/smartmontools-5.1/examplescripts/.
 
-Windows/Native: \'-M exec\' is not implemented yet.
+Windows: \'-M exec\' is not implemented yet.
 The other \'-M\' directives work in conjunction with the display of
 warning message boxes by \'-m msgbox\' or \'-m sysmsgbox\' (see above).
 
@@ -1152,4 +1152,4 @@ SEE ALSO:
 
 .SH
 CVS ID OF THIS PAGE:
-$Id: smartd.conf.5.in,v 1.46 2004/04/09 04:16:06 ballen4705 Exp $
+$Id: smartd.conf.5.in,v 1.47 2004/04/11 17:13:39 chrfranke Exp $
-- 
GitLab