02| INTRO
03| FEEDBACK
04| CATALOG
05| CREDITS
—01| HOW TO USE THIS DOCUMENT
What does this project have as far as documentation goes?
See INTRO.
I found an error in the documentation. How do I report it?
See FEEDBACK.
I would like to make a comment or suggestion, how do I do that?
See FEEDBACK.
What files should be in this directory? What are they about?
See CATALOG.
—02| INTRO
The documentation for Gen consists of command reference pages similar to those of the core Tcl commands.
Each command is well-documented with a reference page which includes:
- A short description for the command.
- Usage synopsis.
- Return value description.
- Argument descriptions.
- Table of error conditions, error code and message, and consequences of the error occurrence.
- Examples.
- Related commands to see also.
- Links to the keyword index.
- Various additional notes.
Each command also has an exceptions page which will, in time, come to include:
- A table of error conditions, error messages, and error codes.
- General comments on how to troubleshoot.
- Information on how to set up logging and debugging.
- Information on how to set policies and define what is and is not an error.
To go through the documentation you can use:
- Compiled HTML Help. Open gen.chm.
- Frames-based HTML. Open manual-home.html.
- No-frames HTML. Open noframes-start.html.
—03| FEEDBACK
We have a feedback page with a form you can use to send a message.
Alternatively, send an email to one of:
gen.questions@robertbrogan.com
gen.comments@robertbrogan.com
gen.bugreport@robertbrogan.com
gen.wishlist@robertbrogan.com
gen.other@robertbrogan.com
and we will try to get back to you ASAP.
—04| CATALOG
gen.chm
Compiled HTML Help file
manual-home.html
Start here for manual homepage with frames.
noframes-start.html
Start here for manual homepage without frames.
menu.html
The list of command pages, used by the frames-based manual.
frames-intro.html
Introduction used by the frames-based manual.
doc.css
Styles the manual pages.
addepilogue.html
Page for the command AddEpilogue.
addprologue.html
Page for the command AddPrologue.
addto.html
Page for the command AddTo.
appendstring2file.html
Page for the command AppendString2File.
arrangedict.html
Page for the command ArrangeDict.
backupifexists.html
Page for the command BackupIfExists.
changecasing.html
Page for the command ChangeCasing.
chopleft.html
Page for the command ChopLeft.
chopright.html
Page for the command ChopRight.
coe.html
Page for the command Coe.
commaseparatedstringtolist.html
Page for the command CommaSeparatedStringToList.
copyeverythingindirectory.html
Page for the command CopyEverythingInDirectory.
currentdayoftheweek.html
Page for the command CurrentDayOfTheWeek.
currenttimeofday.html
Page for the command CurrentTimeOfDay.
currenttimeofdayisabout.html
Page for the command CurrentTimeOfDayIsAbout.
currenttimeofdayisafter.html
Page for the command CurrentTimeOfDayIsAfter.
currenttimeofdayisatorafter.html
Page for the command CurrentTimeOfDayIsAtOrAfter.
currenttimeofdayisatorbefore.html
Page for the command CurrentTimeOfDayIsAtOrBefore.
currenttimeofdayisbefore.html
Page for the command CurrentTimeOfDayIsBefore.
currenttimeofdayisbetween.html
Page for the command CurrentTimeOfDayIsBetween.
dateisafter.html
Page for the command DateIsAfter.
dateisbefore.html
Page for the command DateIsBefore.
dateisbetween.html
Page for the command DateIsBetween.
dateison.html
Page for the command DateIsOn.
dateisonorafter.html
Page for the command DateIsOnOrAfter.
dateisonorbefore.html
Page for the command DateIsOnOrBefore.
dateminus.html
Page for the command DateMinus.
dateminusdays.html
Page for the command DateMinusDays.
dateplus.html
Page for the command DatePlus.
dateplusdays.html
Page for the command DatePlusDays.
datetimeisafter.html
Page for the command DatetimeIsAfter.
datetimeisat.html
Page for the command DatetimeIsAt.
datetimeisatorafter.html
Page for the command DatetimeIsAtOrAfter.
datetimeisatorbefore.html
Page for the command DatetimeIsAtOrBefore.
datetimeisbefore.html
Page for the command DatetimeIsBefore.
datetimeisbetween.html
Page for the command DatetimeIsBetween.
datetimeminus.html
Page for the command DatetimeMinus.
datetimeplus.html
Page for the command DatetimePlus.
datetimequantity2seconds.html
Page for the command DatetimeQuantity2Seconds.
dbaseregsub.html
Page for the command DbaseRegsub.
decr.html
Page for the command Decr.
decrdbglobal.html
Page for the command DecrDbGlobal.
deleteeverythingindirectory.html
Page for the command DeleteEverythingInDirectory.
dict2registrytree.html
Page for the command Dict2RegistryTree.
diffhhmmss.html
Page for the command DiffHhmmss.
divideby.html
Page for the command DivideBy.
doublechop.html
Page for the command DoubleChop.
endswith.html
Page for the command EndsWith.
evallist.html
Page for the command EvalList.
file2list.html
Page for the command File2List.
file2string.html
Page for the command File2String.
findandremove.html
Page for the command FindAndRemove.
findnearestprecedingrecurrence.html
Page for the command FindNearestPrecedingRecurrence.
findnearestsucceedingrecurrence.html
Page for the command FindNearestSucceedingRecurrence.
firstof.html
Page for the command FirstOf.
flip.html
Page for the command Flip.
foreachrecord.html
Page for the command ForeachRecord.
ftpcleanremotedirectory.html
Page for the command FtpCleanRemoteDirectory.
ftpdownloaddirectory.html
Page for the command FtpDownloadDirectory.
ftpdownloadfiles.html
Page for the command FtpDownloadFiles.
ftpdownloadsite.html
Page for the command FtpDownloadSite.
ftpmirrorlocaltoremote.html
Page for the command FtpMirrorLocalToRemote.
ftpmirrorremotetolocal.html
Page for the command FtpMirrorRemoteToLocal.
ftpuploaddirectory.html
Page for the command FtpUploadDirectory.
ftpuploadfiles.html
Page for the command FtpUploadFiles.
ftpuploadsite.html
Page for the command FtpUploadSite.
ftpwhichislarger.html
Page for the command FtpWhichIsLarger.
ftpwhichisnewer.html
Page for the command FtpWhichIsNewer.
getdbglobal.html
Page for the command GetDbGlobal.
getemailusingimap4.html
Page for the command GetEmailUsingImap4.
getemailusingpop3.html
Page for the command GetEmailUsingPop3.
hhmmss2seconds.html
Page for the command Hhmmss2Seconds.
htmllisttreefromdict.html
Page for the command HtmlListTreeFromDict.
htmlparagraphsfromdoublenewlinesstring.html
Page for the command HtmlParagraphsFromDoubleNewlinesString.
includeexcludelistfilter.html
Page for the command IncludeExcludeListFilter.
incrdbglobal.html
Page for the command IncrDbGlobal.
isdate.html
Page for the command IsDate.
isdatetime.html
Page for the command IsDatetime.
isdatetimequantity.html
Page for the command IsDatetimeQuantity.
isdict.html
Page for the command IsDict.
isempty.html
Page for the command IsEmpty.
ishhmmss.html
Page for the command IsHhmmss.
ismatrix.html
Page for the command IsMatrix.
isnegative.html
Page for the command IsNegative.
isnonnegative.html
Page for the command IsNonNegative.
isnonnumeric.html
Page for the command IsNonNumeric.
isnonpositive.html
Page for the command IsNonPositive.
isnonzero.html
Page for the command IsNonZero.
isnumeric.html
Page for the command IsNumeric.
ispositive.html
Page for the command IsPositive.
istimeofday.html
Page for the command IsTimeOfDay.
isvalidlistindex.html
Page for the command IsValidListIndex.
iszero.html
Page for the command IsZero.
lappendifnotalready.html
Page for the command LappendIfNotAlready.
lastid.html
Page for the command LastId.
lastmonth.html
Page for the command LastMonth.
lastof.html
Page for the command LastOf.
lastyear.html
Page for the command LastYear.
limitlinelengthinfile.html
Page for the command LimitLineLengthInFile.
linktclvariabletoregistryvalue.html
Page for the command LinkTclVariableToRegistryValue.
linkvartodbglobal.html
Page for the command LinkVarToDbGlobal.
list2file.html
Page for the command List2File.
listendindex.html
Page for the command ListEndIndex.
listremoveat.html
Page for the command ListRemoveAt.
mash.html
Page for the command Mash.
matrix2htmltable.html
Page for the command Matrix2HtmlTable.
multiset.html
Page for the command MultiSet.
multiplyby.html
Page for the command MultiplyBy.
multiplyhhmmss.html
Page for the command MultiplyHhmmss.
newlinesstringtoonehtmlparagraph.html
Page for the command NewlinesStringToOneHtmlParagraph.
nextmonth.html
Page for the command NextMonth.
nextyear.html
Page for the command NextYear.
notempty.html
Page for the command NotEmpty.
now.html
Page for the command Now.
prepend.html
Page for the command Prepend.
printdict.html
Page for the command PrintDict.
printmatrix.html
Page for the command PrintMatrix.
printvar.html
Page for the command PrintVar.
printvars.html
Page for the command PrintVars.
q1.html
Page for the command Q1.
qq.html
Page for the command QQ.
quasitablefromkeyvaluelist.html
Page for the command QuasiTableFromKeyValueList.
raise.html
Page for the command Raise.
registryexists.html
Page for the command RegistryExists.
registryprint.html
Page for the command RegistryPrint.
registrytree2dict.html
Page for the command RegistryTree2Dict.
reloadpackage.html
Page for the command ReloadPackage.
restoreifexists.html
Page for the command RestoreIfExists.
restoreworkingdirectory.html
Page for the command RestoreWorkingDirectory.
retzeroifempty.html
Page for the command RetZeroIfEmpty.
run.html
Page for the command Run.
runsqlcreatetable.html
Page for the command RunSqlCreateTable.
runsqlenter.html
Page for the command RunSqlEnter.
runsqlinsertifdoesnotexist.html
Page for the command RunSqlInsertIfDoesNotExist.
saveworkingdirectory.html
Page for the command SaveWorkingDirectory.
seconds2datetimequantity.html
Page for the command Seconds2DatetimeQuantity.
seconds2hhmmss.html
Page for the command Seconds2Hhmmss.
sendemail.html
Page for the command SendEmail.
setdateformat.html
Page for the command SetDateFormat.
setdatetimeformat.html
Page for the command SetDatetimeFormat.
setdbglobal.html
Page for the command SetDbGlobal.
settimeofdayformat.html
Page for the command SetTimeOfDayFormat.
setzeroifempty.html
Page for the command SetZeroIfEmpty.
showtable.html
Page for the command ShowTable.
sliceleft.html
Page for the command SliceLeft.
sliceright.html
Page for the command SliceRight.
splitandtrim.html
Page for the command SplitAndTrim.
splitntimes.html
Page for the command SplitNTimes.
splitstringbycharactercount.html
Page for the command SplitStringByCharacterCount.
sqlcountstatement.html
Page for the command SqlCountStatement.
sqlinsertstatement.html
Page for the command SqlInsertStatement.
sqlrecordexists.html
Page for the command SqlRecordExists.
sqlselectstatement.html
Page for the command SqlSelectStatement.
sqlsetclause.html
Page for the command SqlSetClause.
sqlupdatestatement.html
Page for the command SqlUpdateStatement.
sqlwhereclause.html
Page for the command SqlWhereClause.
sqlitecolumnnameandtypelist.html
Page for the command SqliteColumnNameAndTypeList.
sqlitecolumnnamelist.html
Page for the command SqliteColumnNameList.
sqlitecolumntype.html
Page for the command SqliteColumnType.
sqlitecopytable.html
Page for the command SqliteCopyTable.
sqliterenamecolumn.html
Page for the command SqliteRenameColumn.
sqlitetableexists.html
Page for the command SqliteTableExists.
startsandendswith.html
Page for the command StartsAndEndsWith.
startswith.html
Page for the command StartsWith.
string2file.html
Page for the command String2File.
stringcontains.html
Page for the command StringContains.
stringinsert.html
Page for the command StringInsert.
stringmatchesany.html
Page for the command StringMatchesAny.
stringmid.html
Page for the command StringMid.
striphtmltags.html
Page for the command StripHtmlTags.
subtractfrom.html
Page for the command SubtractFrom.
sumhhmmss.html
Page for the command SumHhmmss.
surroundeach.html
Page for the command SurroundEach.
swap.html
Page for the command Swap.
ter.html
Page for the command Ter.
thismonth.html
Page for the command ThisMonth.
thisyear.html
Page for the command ThisYear.
timebetweendates.html
Page for the command TimeBetweenDates.
timebetweendatetimes.html
Page for the command TimeBetweenDatetimes.
timebetweentimesofday.html
Page for the command TimeBetweenTimesOfDay.
timeleftuntiltargetdate.html
Page for the command TimeLeftUntilTargetDate.
timeleftuntiltargetdatetime.html
Page for the command TimeLeftUntilTargetDatetime.
timeleftuntiltargettimeofday.html
Page for the command TimeLeftUntilTargetTimeOfDay.
timeofdayisabout.html
Page for the command TimeOfDayIsAbout.
timeofdayisafter.html
Page for the command TimeOfDayIsAfter.
timeofdayisat.html
Page for the command TimeOfDayIsAt.
timeofdayisatorafter.html
Page for the command TimeOfDayIsAtOrAfter.
timeofdayisatorbefore.html
Page for the command TimeOfDayIsAtOrBefore.
timeofdayisbefore.html
Page for the command TimeOfDayIsBefore.
timeofdayisbetween.html
Page for the command TimeOfDayIsBetween.
tobackslashes.html
Page for the command ToBackslashes.
todoublebackslashes.html
Page for the command ToDoubleBackslashes.
toforwardslashes.html
Page for the command ToForwardSlashes.
today.html
Page for the command Today.
tomorrow.html
Page for the command Tomorrow.
unlinktclvariablefromregistryvalue.html
Page for the command UnlinkTclVariableFromRegistryValue.
unlinkvarfromdbglobal.html
Page for the command UnlinkVarFromDbGlobal.
unsetdbglobal.html
Page for the command UnsetDbGlobal.
upvarexistingordie.html
Page for the command UpvarExistingOrDie.
upvarx.html
Page for the command UpvarX.
varexistsincaller.html
Page for the command VarExistsInCaller.
yesterday.html
Page for the command Yesterday.
—05| CREDITS
HTML Help Workshop was used to compile the help file.