The easiest way to use Scribe is to go the log administration panel or web page. From the Windows configurator, just click on the Scribe icon. From the web-based administration, just click on Logging from the main administration page.
This gives you the simplest interface to Scribe. To configure a logging event, you just need to fill in these fields. Once you do that, you can manually start and stop logging just by clicking the enable and disable buttons.
The first field is the Log Event Name. This is simply a name that you give the logging event to allow you to know which log event you are talking about. Just give it a name that you will associate with this particular log event or channel.
The next field is the Channel field. Set this to the channel that you wish to log. Don't forget the # sign at the beginning.
Next you must decide whether to log to a single file or to a directory. If this is a one-time log, you will probably want to log to a specific file so you'll know where the log is. If this is a recurring log event, you will probably prefer to log to a directory, creating separate log files for each instance of this log event.
To log to a file, check the file box and enter the filename. It must be possible to create this file under the logs directory. So if the filename is classes/engineering.log, there must already be a classes directory under the logs directory.
To log to a directory, check the directory box and enter a directory name. This directory must already exist or it must be possible to create it. So if the directory name is classes/engineering there must already be a directory called classes under the logs directory.
Next you must specify a web path. This will determine where the web page to access the log will go. This path is relative to the Data(Windows) or htdocs(UNIX) directory. It must be possible to create the named file and it must end in .htm or .html. For example, you could use events/tech.htm if you had an events directory under your Data or htdocs directory. The URL people would then use would end in events/tech.htm.
The Title and Description are fields that can later be used to index the logs. If you log to a directory, this information will be displayed to allow people to choose between logs.
The Theme setting will determine what look the log has. The server will build the web page in the location you specified based on the selected theme's template file in the template directory.
You may then select a start time and stop time for the log event. If you want the log to start whenever the log event is enabled, leave the start time blank. If you don't want the log to stop until it's disabled, leave the stop time blank.
If the log event recurs on a fixed interval, you can set that interval. This will cause the log to repeat on a regular schedule.
The first time Scribe actually begins logging, it will build the specified web page. You can then view it from a browser.
If you left the start and stop time blank, you can
easily start and stop the log manually. If you called the
log event mylog you can start it by typing:
/as log mylog enable
and stop it by typing:
/as log mylog disable
That's really all you need to know to use Scribe. You can now create logging events and have the associated web pages built automatically. However, to get to Scribe's real power, you will need to get under the hood a little bit.