Commented all the entries in setup.h.

diff --git a/setup.h b/setup.h
index 64baf64..14d6e2c 100644 (file)
--- a/setup.h
+++ b/setup.h
@@ -2,6 +2,9 @@
  * $Id$
  *
  * $Log$
+ * Revision 1.3  1999/06/03 10:52:32  short
+ * Commented all the entries in setup.h.
+ *
  * Revision 1.2  1999/06/03 10:38:52  short
  * Implemented remaining communication timeouts and maximum retry count.
  *
@@ -10,32 +13,34 @@
  *
  */
 
-#define CONFIG_MAIN "/etc/" PACKAGE "rc"
-#define CONFIG_HOME    "/." PACKAGE "rc" /* $HOME is prepended automatically */
-#define DEF_DEVICE "/dev/mobildock"
+#define CONFIG_MAIN "/etc/" PACKAGE "rc" /* global configuration file */
+#define CONFIG_HOME    "/." PACKAGE "rc" /* user-local cfg file,
+                                            $HOME is prepended automatically */
+#define DEF_DEVICE "/dev/mobildock" /* --device default */
 #ifndef DEF_LOCKFILE
-#define DEF_LOCKFILE "/var/lock/LCK..%s"
+#define DEF_LOCKFILE "/var/lock/LCK..%s" /* --lockfile default */
 #endif
-#define DEF_MAXRETRY 10
-#define DEF_READTIME 60*60
-#define DEF_CHARTIME 10
-#define DEF_CMDTIME 500
-#define MAXCONFIG 4096
-#define MAXCFGARGS 256
-#define MAXCFGLOOP 5
-#define MAXCFGNUM 20
-#define DEVLOCK_PERIOD 2 /* sec between attempts to obtain a lockfile */
-#define DEVLOCK_MAXEMPTY 1
-#define MAXSENDTIME 2
-#define ADDR_NAT 0x81
-#define ADDR_INT 0x91
-#define PDU_TYPE 0x11
-#define PDU_MR   0x00
-#define PDU_PID  0x00
-#define PDU_DCS  0x00
-#define PDU_VP   0xFF
-#define MAXNUMLEN 20
-#define MAXBODYLEN 160
-#define BODYLOAD 200
-#define ERROR_SUBSTR1 "ERROR"
-#define ERROR_SUBSTR2 "\nError:"
+#define DEF_MAXRETRY 10 /* --maxretry default */
+#define DEF_READTIME 60*60 /* --readtime default */
+#define DEF_CHARTIME 10 /* --chartime default */
+#define DEF_CMDTIME 500 /* --cmdtime default */
+#define MAXCONFIG 4096 /* maximum allowed size of any configuration file */
+#define MAXCFGARGS 256 /* maximum allowed number of arguments in cfg file */
+#define MAXCFGLOOP 5 /* maximum number of recursive opens in cfg files */
+#define MAXCFGNUM 20 /* total maximum number of cfgs read during one run */
+#define DEVLOCK_PERIOD 2 /* seconds between attempts to obtain a lockfile */
+#define DEVLOCK_MAXEMPTY 1 /* seconds to wait while lockfile is empty
+                              to prevent races during lock creation */
+#define MAXSENDTIME 2 /* max. allowed number of seconds for sending one char */
+#define ADDR_NAT 0x81 /* PDU address type for non-'+' numbers */
+#define ADDR_INT 0x91 /* PDU address type for numbers prefixed by '+' */
+#define PDU_TYPE 0x11 /* first byte of PDU, SMS submit */
+#define PDU_MR   0x00 /* default message reference, filled by Siemens A1 */
+#define PDU_PID  0x00 /* PDU protocol identifier, SMS message type */
+#define PDU_DCS  0x00 /* PDU Data Coding Scheme, 7-bit class-2 message */
+#define PDU_VP   0xFF /* PDU Validity Period, maximum relative time */
+#define MAXNUMLEN 20 /* maximum number of digits in GSM number */
+#define MAXBODYLEN 160 /* maximum length of characters in SMS body */
+#define BODYLOAD 200 /* number of bytes to read when body not on command line */
+#define ERROR_SUBSTR1 "ERROR" /* first failure ind. substring in A1 response */
+#define ERROR_SUBSTR2 "\nError:" /* second such, this one from MobilDock */