diff --git a/twander.1 b/twander.1 index ebecfc7..ea34bc3 100644 --- a/twander.1 +++ b/twander.1 @@ -1226,19 +1226,39 @@ also be entered in hexadecimal format: 0xNNN, where NNN is the numeric expression in hex. -A String Option can be any string of characters but the empty string -is not allowed: - -.nf -# Bad String Option Assignment - Causes Warning -BCOLOR = -.fi +A String Option can be any string of characters. +.B Quotation marks are treated as part of the string! +Do not include any quotation marks unless you really want +them to be assigned to the option in question (almost never +the case). Furthermore, as described above, you cannot use the \'#\' symbol as part of the string assignment because \*(TW always treats this character as the beginning of a comment no matter where it appears. +For consistency with other \*(CF entries, Program Option Statements +may have a blank Right Hand Side. Such statements are +simply ignored. This is convenient when you want to leave +a placeholder in your \*(CF but don't actually want to +activate it at the moment. However, be careful - depending +on what precedes the statement, you'll get different +settings for the option in question. For example: + +.nf +# This effectively sets BCOLOR to its default value when +# the \*(CF is reloaded +BCOLOR = + +# But this means the value of BCOLOR is set to red + +BCOLOR = red +BCOLOR = +.nf + +In other words, you should think of Program Option Statements +with a blank Right Hand Side as comments - present but ignored. + Other than this basic type-checking, \*(TW does no further validation of the Right Hand Side of a Program Option Statement. It is perfectly possible to provide a RHS which passes \*(TWs