home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / programs / comms_networking / zonk / rawdocs / clog < prev    next >
Encoding:
Text File  |  1999-02-13  |  2.0 KB  |  41 lines

  1. $zonkpage 1.07
  2.  
  3. title: log
  4.  
  5. nobrs:
  6.  
  7. text:{<sh>Syntax</sh>
  8.  
  9.  
  10. <lit><zonk log [<var>variablename</var>...]></lit> 
  11.  
  12. <sh>Description</sh>
  13.  
  14. Attempts to write to a log file, the name of which must have been given in the <ref sconf>system or global</r> configuration files. If the write succeeds the information logged is in the following form:
  15.  
  16. <pre>
  17. $logged: Wed Jan 27 10:30:27 1999  <-- time of log
  18. $outputwas: doco01/htm             <-- file being output
  19. $datafrom: mydata                  <-- user datafile
  20. $templatewas: test1                <-- template used
  21. $globalwas: (none)                 <-- global file used (if any)
  22. VARIABLENAME1:VALUE                <-- any variables you ask Zonk to log
  23. VARIABLENAME2:VALUE                <-- you don't have to specify any
  24. </pre>
  25.  
  26. Note that any filenames shown are as given to the program, they may include full paths or they may assume a working directory.
  27.  
  28. If you don't specify any <var>variablename</var> parameters, just the system information will be logged. There is no limit to the number of <var>variablename</var> parameters that you can give.
  29.  
  30. If a variable is undefined or has a NULL value when you attempt to log it, that variable will be ignored, although the system information and any variables with values will still be logged.
  31.  
  32. The values of any variables specified is as they are at the place where the <lit>zonk log</lit> command is in the template. There is no restriction as to where you can place <lit>zonk log</lit> commands. If you place the command inside a loop then one log record will be written each time around the loop. You can have as many zonk log commands in one template as you like. Be aware though that excessive logging will noticeably slow down the processing of a template.
  33.  
  34. Log files can be read back in as part of a datafile (see <ref logs>user logs files</r>).
  35.  
  36. <sh>Example</sh>
  37.  
  38. <lit><zonk log town partyhost></lit> 
  39.  
  40. will log the system information plus the current values of the variables 'town' and 'partyhost'.
  41.