Added documentation for the Windows version

git-svn-id: https://smartmontools.svn.sourceforge.net/svnroot/smartmontools/trunk@1632 4ea69e1a-61f1-4043-bf83-b5c94c648137

sm5/TODO

 TODO list for smartmontools:
 
-$Id: TODO,v 1.48 2004/03/23 13:08:40 ballen4705 Exp $
+$Id: TODO,v 1.49 2004/04/01 21:02:11 chrfranke Exp $
 
 SATA devices
 ------------
@@ -81,6 +81,20 @@ FreeBSD
 Get interface for 3ware Escalade controllers working (Eduard).
 Modify smartctl -h examples
 
+Windows
+-------
+Add warning Mail feature to Windows/Native smartd, probably using
+the Blat mailer as a default (http://www.blat.net/).
+
+Add DEVICESCAN for SCSI devices.
+
+Add IDE/ATA selective self test and check power mode.
+
+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.
+
 Packaging
 ---------
 Under freebsd and solaris, the following are wrong:

sm5/WARNINGS

-$Id: WARNINGS,v 1.21 2004/03/30 20:20:16 ballen4705 Exp $
+$Id: WARNINGS,v 1.22 2004/04/01 21:02:11 chrfranke Exp $
 
 The most recent version of this file can be found here:
 http://cvs.sourceforge.net/viewcvs.py/smartmontools/sm5/WARNINGS?view=markup
@@ -89,3 +89,20 @@ SOLARIS
 
 [No reports yet.]
 
+
+WINDOWS
+-------
+
+SYSTEM:   Any Windows 2000 or XP system.
+PROBLEM:  Use of an undocumented system call for IDE/ATA read log
+          (smartctl -l, --log, -a, --all) may affect system stability.
+REPORTER: Christian Franke <smartmontools-support@lists.sourceforge.net>
+NOTE:     The IOCTL call SMART_RCV_DRIVE_DATA does not support 
+          ATA_SMART_READ_LOG_SECTOR on NT4/2000/XP. The Win32 
+          implementation of smartctl/smartd uses the undocumented
+          and possibly buggy IOCTL_IDE_PASS_THROUGH for this purpose.
+          This IOCTL is not implemented under NT4.
+          Invalid log output has been reported for at least one
+          W2K system.
+
+

sm5/smartd.8.in

 .ig
 Copyright (C) 2002-4 Bruce Allen <smartmontools-support@lists.sourceforge.net>
  
-$Id: smartd.8.in,v 1.48 2004/03/15 17:26:35 ballen4705 Exp $
+$Id: smartd.8.in,v 1.49 2004/04/01 21:02:11 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,6 +60,8 @@ the command:
 .fi
 \fBkillall -HUP smartd\fP.
 .fi
+(Windows/Native: 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
 \fBsmartd\fP is already running, then is told with a \fBHUP\fP signal
@@ -71,7 +73,8 @@ signal had never been received.
 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.
+configuration file. To exit \fBsmartd\fP use CONTROL-\e
+(Windows/Native: CONTROL-Break).
 
 On startup, in the absence of the configuration file
 \fB/etc/smartd.conf\fP, the \fBsmartd\fP daemon first scans for all
@@ -118,7 +121,11 @@ 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.
+file.  Please use CONTROL-\e to exit (Windows/Native: CONTROL-Break).
+
+Windows/Native 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
 .B \-D, \-\-showdirectives
 Prints a list (to STDOUT) of all the possible Directives which may
@@ -147,6 +154,9 @@ also use:
 .B killall -USR1 smartd
 .fi
 for the same purpose.
+.fi
+(Windows/Native: Use \'\fBsmartd sigusr1\fP\' to simulate the USR1 signal.)
+
 .TP
 .B \-l FACILITY, \-\-logfacility=FACILITY
 Uses syslog facility FACILITY to log the messages from \fBsmartd\fP.
@@ -185,6 +195,29 @@ For more detailed information, please refer to the man pages for
 \fBsyslog.conf\fP, \fBsyslogd\fP, and \fBsyslog\fP.  You may also want
 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)
+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
+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
+(Win9x/ME or access denied). By specifying other values of FACILITY,
+log output is redirected as follows:
+\'\-l local0\' to file \fB./smartd.log\fP,
+\'\-l local1\' to standard output (redirect with \'>\' to any file),
+\'\-l local2\' to standard error,
+\'\-l local[3-7]\': to file \fB./smartd[1-5].log\fP.
+
+When using the event log, the enclosed utility \fBsyslogevt.exe\fP
+should be registered as an event message file to avoid error
+messages from the event viewer. Use \'\fBsyslogevt -r smartd\fP\'
+to register, \'\fBsyslogevt -u smartd\fP\' to unregister and
+\'\fBsyslogevt\fP\' for more help.
+
 .TP
 .B \-p NAME, \-\-pidfile=NAME
 Writes pidfile \fINAME\fP containing the \fBsmartd\fP Process ID
@@ -795,6 +828,11 @@ 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.
+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.
+
 .TP
 .B \-M TYPE
 These Directives modify the behavior of the
@@ -972,6 +1010,10 @@ 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.
+The other \'-M\' directives work in conjunction with the display of
+warning message boxes by \'-m msgbox\' or \'-m sysmsgbox\' (see above).
+
 .TP
 .B \-f
 Check for \'failure\' of any Usage Attributes.  If these Attributes are
@@ -1397,6 +1439,24 @@ 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.
+
+Windows/Native: The following built-in commands can be used to control
+the \fBsmartd\fP process:
+
+\'\fBsmartd status\fP\' \- check status
+
+\'\fBsmartd stop\fP\' \- stop smartd
+
+\'\fBsmartd reload\fP\' \- reread config file
+
+\'\fBsmartd restart\fP\' \- restart smartd
+
+\'\fBsmartd sigusr1\fP\' \- check disks now
+
+\'\fBsmartd sigusr2\fP\' \- toggle debug mode
+
 .SH RETURN VALUES
 The return value (exit status) of 
 \fBsmartd\fP
@@ -1512,4 +1572,4 @@ smartmontools home page at \fBhttp://smartmontools.sourceforge.net/\fP .
 
 .SH
 CVS ID OF THIS PAGE:
-$Id: smartd.8.in,v 1.48 2004/03/15 17:26:35 ballen4705 Exp $
+$Id: smartd.8.in,v 1.49 2004/04/01 21:02:11 chrfranke Exp $

sm5/smartd.conf.5.in

 .ig
 Copyright (C) 2002-4 Bruce Allen <smartmontools-support@lists.sourceforge.net>
 
-$Id: smartd.conf.5.in,v 1.38 2004/03/15 17:26:35 ballen4705 Exp $
+$Id: smartd.conf.5.in,v 1.39 2004/04/01 21:02:11 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
@@ -517,6 +517,11 @@ 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.
+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.
+
 .TP
 .B \-M TYPE
 These Directives modify the behavior of the
@@ -694,6 +699,10 @@ 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.
+The other \'-M\' directives work in conjunction with the display of
+warning message boxes by \'-m msgbox\' or \'-m sysmsgbox\' (see above).
+
 .TP
 .B \-f
 Check for \'failure\' of any Usage Attributes.  If these Attributes are
@@ -1088,4 +1097,4 @@ SEE ALSO:
 
 .SH
 CVS ID OF THIS PAGE:
-$Id: smartd.conf.5.in,v 1.38 2004/03/15 17:26:35 ballen4705 Exp $
+$Id: smartd.conf.5.in,v 1.39 2004/04/01 21:02:11 chrfranke Exp $