MUSHclient documentation: Logging

Logging

Logging
Standard HTML preamble/postamble This button is active if HTML logging is select. Click it to insert a reasonable HTML preamble/postamble into the "file preamble" and "file postamble" boxes. With those commands there you could save the log to disk and open in your web browser, and it would look reasonable. File Preamble: Text to put at the start of the log file (or session, if you are appending to earlier sessions in the same file). (...) Click to edit the file preamble in a larger window. File Postamble: Text to put at the start of the log file. (...) Click to edit the file postamble in a larger window. (?) Click to display a help window reminding you of the special characters that can be placed in the various preamble/postamble boxes, as well as the log file name itself. This currently says ... Special characters for date/time etc. ------------------------------------- General %E - MUSHclient startup (initial) directory %F - world files directory %L - log files directory %n - new line (in some cases only) %N - world name %P - player name Date/time %a - Abbreviated weekday name %A - Full weekday name %b - Abbreviated month name %B - Full month name %c - Date and time representation appropriate for locale %d - Day of month as decimal number (01 - 31) %H - Hour in 24-hour format (00 - 23) %I - Hour in 12-hour format (01 - 12) %j - Day of year as decimal number (001 - 366) %m - Month as decimal number (01 - 12) %M - Minute as decimal number (00 - 59) %p - Current locale’s A.M./P.M. indicator for 12-hour clock %S - Second as decimal number (00 - 59) %U - Week of year as decimal number, with Sunday as first day of week (00 - 53) %w - Weekday as decimal number (0 - 6; Sunday is 0) %W - Week of year as decimal number, with Monday as first day of week (00 - 53) %x - Date representation for current locale %X - Time representation for current locale %y - Year without century, as decimal number (00 - 99) %Y - Year with century, as decimal number %z, %Z - Time-zone name or abbreviation; no characters if time zone is unknown %% - Percent sign Modification The # flag may prefix any formatting code. In that case, the meaning of the format code is changed as follows. %#a, %#A, %#b, %#B, %#p, %#X, %#z, %#Z, %#% - # flag is ignored. %#c - Long date and time representation, appropriate for current locale. For example: "Tuesday, March 14, 1995, 12:41:29". %#x - Long date representation, appropriate to current locale. For example: "Tuesday, March 4, 1995". %#d, %#H, %#I, %#j, %#m, %#M, %#S, %#U, %#w, %#W, %#y, %#Y - Remove leading zeros (if any). Log Output If checked, output from the MUD is logged. Log Commands If checked, commands you type are logged. Log Notes If checked, script notes are logged. HTML If checked, logging is in HTML, which will attempt to preserve the colours and spacing in the world window. (Colours only if "colour" is checked). Colour If checked, and HTML is checked, colours are written to the log file. Write world name to log file If checked, the name of the current world is written to the log file. Automatically log to this file: The name of the file to automatically log to. If blank, logging will not commence automatically. You can use special strings (described above) to make the file name contain things like the date, time and world name. Browse... Click to browse for a file name to log to. Preamble / Postamble Enter some text in these boxes if you want each line in the log file to have a prefix/suffix. The preamble will be placed in front of each line, and the postamble will be placed at the end of line. You can incorporate the date and time into this field. See below for more details. For example, to log the time each line arrived you might put: %H:%M ... Output lines: Preamble/postamble for each line of output from the MUD. Commands: Preamble/postamble for each line of commands you type. Script notes: Preamble/postamble for each line of script notes. Raw If checked, logging is in "raw" format. This is intended to simply copy the MUD output straight to the log file exactly as it arrives (after decompression, if MCCP is in use). This lets you make an "image" of what arrived, colour codes, MXP codes and all. You could use this later to "pipe" back into the client to test it, for example, for speed. Normally you wouldn't use this. Omitting some lines from the log file You can use triggers to omit lines from the log file (if they match a trigger). See "Edit trigger" for more details about doing this. Alternatively, you can default to outputting no lines (by unchecking Log Output) and then use a trigger to send particular lines to the log. You can also use aliases to omit outgoing messages from the log file (if they match an alias). See "Edit alias" for more details about doing this. See Also ... Topic Logging Command ConfigureLogging (Sets logging options) Dialog Timers Functions CloseLog (Closes the log file) FlushLog (Flushes the log file to disk) IsLogOpen (Tests to see if a log file is open) LogInput (The property of whether commands are logged to the log file) LogNotes (The property of whether notes are logged to the log file) LogOutput (The property of whether MUD output is logged to the log file) LogSend (Sends a message to the MUD and logs it) OpenLog (Opens a log file.) WriteLog (Writes to the log file) (Help topic: dialog=IDD_PREFS_P4) Documentation contents page

Standard HTML preamble/postamble

This button is active if HTML logging is select. Click it to insert a reasonable HTML preamble/postamble into the "file preamble" and "file postamble" boxes. With those commands there you could save the log to disk and open in your web browser, and it would look reasonable.

File Preamble:

Text to put at the start of the log file (or session, if you are appending to earlier sessions in the same file).

(...)

Click to edit the file preamble in a larger window.

File Postamble:

Text to put at the start of the log file.

(...)

Click to edit the file postamble in a larger window.

(?)

Click to display a help window reminding you of the special characters that can be placed in the various preamble/postamble boxes, as well as the log file name itself. This currently says ...


Special characters for date/time etc.
-------------------------------------

General

%E - MUSHclient startup (initial) directory
%F - world files directory
%L - log files directory
%n - new line (in some cases only)
%N - world name
%P - player name

Date/time

%a - Abbreviated weekday name
%A - Full weekday name
%b - Abbreviated month name
%B - Full month name
%c - Date and time representation appropriate for locale
%d - Day of month as decimal number (01 - 31)
%H - Hour in 24-hour format (00 - 23)

%I - Hour in 12-hour format (01 - 12)
%j - Day of year as decimal number (001 - 366)
%m - Month as decimal number (01 - 12)
%M - Minute as decimal number (00 - 59)
%p - Current locale’s A.M./P.M. indicator for 12-hour clock
%S - Second as decimal number (00 - 59)
%U - Week of year as decimal number, with Sunday as first day of week (00 - 53)
%w - Weekday as decimal number (0 - 6; Sunday is 0)
%W - Week of year as decimal number, with Monday as first day of week (00 - 53)
%x - Date representation for current locale
%X - Time representation for current locale
%y - Year without century, as decimal number (00 - 99)
%Y - Year with century, as decimal number
%z, %Z  - Time-zone name or abbreviation; no characters if time zone is unknown
%% - Percent sign

Modification

The # flag may prefix any formatting code. In that case, the meaning of the format code is changed as follows.

%#a, %#A, %#b, %#B, %#p, %#X, %#z, %#Z, %#% - # flag is ignored.

%#c - Long date and time representation, appropriate for current locale. For example: "Tuesday, March 14, 1995, 12:41:29".

%#x - Long date representation, appropriate to current locale. For example: "Tuesday, March 4, 1995".

%#d, %#H, %#I, %#j, %#m, %#M, %#S, %#U, %#w, %#W, %#y, %#Y - Remove leading zeros (if any).

Log Output

If checked, output from the MUD is logged.

Log Commands

If checked, commands you type are logged.

Log Notes

If checked, script notes are logged.

HTML

If checked, logging is in HTML, which will attempt to preserve the colours and spacing in the world window. (Colours only if "colour" is checked).

Colour

If checked, and HTML is checked, colours are written to the log file.

Write world name to log file

If checked, the name of the current world is written to the log file.

Automatically log to this file:

The name of the file to automatically log to. If blank, logging will not commence automatically. You can use special strings (described above) to make the file name contain things like the date, time and world name.

Browse...

Click to browse for a file name to log to.

Preamble / Postamble

Enter some text in these boxes if you want each line in the log file to have a prefix/suffix. The preamble will be placed in front of each line, and the postamble will be placed at the end of line. You can incorporate the date and time into this field. See below for more details.

For example, to log the time each line arrived you might put:

%H:%M ...

Output lines:

Preamble/postamble for each line of output from the MUD.

Commands:

Preamble/postamble for each line of commands you type.

Script notes:

Preamble/postamble for each line of script notes.

Raw

If checked, logging is in "raw" format. This is intended to simply copy the MUD output straight to the log file exactly as it arrives (after decompression, if MCCP is in use). This lets you make an "image" of what arrived, colour codes, MXP codes and all. You could use this later to "pipe" back into the client to test it, for example, for speed. Normally you wouldn't use this.

Omitting some lines from the log file

You can use triggers to omit lines from the log file (if they match a trigger). See "Edit trigger" for more details about doing this.

Alternatively, you can default to outputting no lines (by unchecking Log Output) and then use a trigger to send particular lines to the log.

You can also use aliases to omit outgoing messages from the log file (if they match an alias). See "Edit alias" for more details about doing this.

See Also ...

Topic