Changeset 81a96af

Timestamp:

Apr 14, 2009, 10:50:28 AM (16 years ago)

Author:

Nelson Elhage <nelhage@mit.edu>

Branches:

master, debian, release-1.10, release-1.4, release-1.5, release-1.6, release-1.7, release-1.8, release-1.9

Children:

b814715

Parents:

32620ac

Message:

Update the docs on 'zsig' and 'zsigproc'.

Correctly document the order in which they are checked for values before
being used.

fixes #74

Reported-By: Xavid Pretzer <xavid@mit.edu>

File:

• variable.c (modified) (2 diffs)

variable.c

@@ -195 +195 @@
                "name of a program to run that will generate zsigs",
                "This program should produce a zsig on stdout when run.\n"
-               "Note that it is important that this program not block.\n" ),
+               "Note that it is important that this program not block.\n\n"
+               "See the documentation for 'zsig' for more information about\n"
+               "how the outgoing zsig is chosen."
+               ),
 
   OWLVAR_PATH( "newmsgproc" /* %OwlVarStub:newmsgproc */, NULL,
@@ -211 +214 @@
 
   OWLVAR_STRING( "zsig" /* %OwlVarStub */, "",
-                 "zephyr signature", 
-                 "If 'zsigproc' is not set, this string will be used\n"
-                 "as a zsig.  If this is also unset, the 'zwrite-signature'\n"
-                 "zephyr variable will be used instead.\n"),
+                 "zephyr signature",
+                 "The zsig to get on outgoing messages. If this variable is\n"
+                 "unset, 'zsigproc' will be run to generate a zsig. If that is\n"
+                 "also unset, the 'zwrite-signature' zephyr variable will be\n"
+                 "used instead.\n"),
 
   OWLVAR_STRING( "appendtosepbar" /* %OwlVarStub */, "",