Project

General

Profile

Logging Options » History » Version 19

Per Amundsen, 02/26/2023 08:37 PM

1 14 Per Amundsen
{{>toc}}
2 1 Per Amundsen
3
h1. Logging Options
4
5
_See also [[/log]]._
6
7
h2. Log Channels
8
9
When enabled, logs all channel windows.
10
11 19 Per Amundsen
h2. Log Private Chat
12 1 Per Amundsen
13
When enabled, logs all private windows.
14
15
h2. Log Servers
16
17
When enabled, logs all server windows.
18
19
h2. Log hidden events
20
21
When enabled, logs all events hidden by [[Events Options]].
22 19 Per Amundsen
23
h2. Edit logs in Default Editor
24
25
Opens log files for editing in the default editor.
26
27
h2. Edit logs in Custom Editor
28
29
Opens log files for editing in the specified custom editor.
30 1 Per Amundsen
31
h2. Make separate folder for each server
32
33
When enabled, will create a sub folder with the network name and save the logfile there.
34
35
h2. Strip mIRC tags
36
37
When enabled, Removes all [[Formatting_Text|control codes]] from the message before logging.
38
39
h2. Use Timestamp
40
41
When enabled, adds a timestamp with the specified Timeformat to the message before logging.
42
43 13 Per Amundsen
h2. Use server-time when available
44
45
If enabled, the logged line will be logged with the timestamp retrieved from the server when the "IRCv3 server-time":https://ircv3.net/specs/extensions/server-time-3.2.html cap is used, otherwise the current localtime is used.
46
47 1 Per Amundsen
h2. Use line colors
48
49
When enabled, the line colors used for the message will be added to the log.
50
51
h2. Log Nickcolumn character
52
53
When enabled, the Nickcolumn character used to separate timestamp/nick from the message will be saved and correctly restored.
54
55 17 Per Amundsen
h2. Log link character
56
57
When enabled, the link character used to style links in a message will be saved and correctly restored.
58
59 2 Per Amundsen
h2. Log session start/close
60
61
When enabled, session start and close date will be logged to the logfile.
62
63 15 Per Amundsen
h2. Lock files
64
65
When enabled, all logfiles in use are locked until the associated window is closed.
66
67 1 Per Amundsen
h2. LogFolder
68
69
The Folder to save the log files.
70
71
h2. Timeformat
72
73
The time format to use when Use Timestamp is enabled.
74
75 3 Per Amundsen
Click the Show date/time variables link to see available variables, these variables ONLY work for the timestamp, not for the filename.
76
77 1 Per Amundsen
h2. FileName
78
79
The filename to use for logs,
80
81 3 Per Amundsen
Variables available:
82
83
$network - The network name associated with the log window.
84
$channel - The channel/query name associated with the log window.
85
$date - Current date in the yyyymmdd format.
86 18 Per Amundsen
$mdate - Current date in the yyyymm format.
87 3 Per Amundsen
88
_Date/time/other variables are not available to keep the filenames predictable for restore logs._
89
90 1 Per Amundsen
h2. Rotated filename
91
92 10 Per Amundsen
The filename to use for logs when *Split log files at [X]* is enabled and the log is to be rotated,
93 3 Per Amundsen
94
Variables available:
95
96
$network - The network name associated with the log window.
97
$channel - The channel/query name associated with the log window.
98 1 Per Amundsen
$date - Current date in the yyyymmdd format.
99
$count - A incremental number based on number of files with the same filename minus the $count number.
100
101
_Date/time/other variables are not available to keep the filenames predictable for restore logs._
102 11 Per Amundsen
103 16 Per Amundsen
h2. Restore last [X] messages in private windows
104
105
If enabled, the last [X] messages from the log files will be restored when a private window is opened.
106
107
h2. Restore last [X] messages in channel windows
108
109
If enabled, the last [X] messages from the log files will be restored when a channel window is opened.
110
111 11 Per Amundsen
h2. Separate logs
112
113 12 Per Amundsen
When enabled, save the logfiles in a subfolder based on the selected interval.
114 11 Per Amundsen
115
Daily = YYYY-MM-DD.
116
Weekly = YYYY-WW.
117
Monthly = YYYY-MM.
118
Yearly = YYYY.
119 1 Per Amundsen
120 9 Per Amundsen
h2. Trim logs at [X] kb
121
122
When enabled and a log file becomes bigger than [X] kilobytes, it will be trimmed to fit the specified size.
123
124
_Cannot be used with split log files._
125
126 10 Per Amundsen
h2. Split log files at [X] kb
127 1 Per Amundsen
128
When enabled and a log file becomes bigger than [X] kilobytes, it will be renamed to *Rotated filename* and a new log created.
129
130
_Cannot be used with trim log files._
131
132
h2. Remove log files older than [x] days
133
134
When enabled, all log files not modified since [x] days ago will be removed when AdiIRC exits.
135
136 8 Per Amundsen
h2. Disable logging for channel/private windows
137 1 Per Amundsen
138
Channels and users in this list will not be logged.
139
140 5 Per Amundsen
_Per server settings can be added using network:#channel syntax._
141
142 6 Per Amundsen
_These windows ignores/overrides the "Log channels/servers/Log privatechat" option._
143
144 7 Per Amundsen
_Can also be toggled by right-clicking the window in [[Switchbar Control|Switchbar]]/[[Treebar Control|Treebar]] -> Logging._
145 6 Per Amundsen
146 8 Per Amundsen
h2. Always log channel/private windows
147 1 Per Amundsen
148
Channels and users in this list will always be logged, regardless of the *Log Channels* and *Log Privatechat* options.
149 5 Per Amundsen
150
_Per server settings can be added using network:#channel syntax._
151 6 Per Amundsen
152
_These windows ignores/overrides the "Log channels/servers/Log privatechat" option._
153
154 7 Per Amundsen
_Can also be toggled by right-clicking the window in [[Switchbar Control|Switchbar]]/[[Treebar Control|Treebar]] -> Logging._
155 4 Per Amundsen
156
h1. Log Events
157
158
_If Log hidden events is enabled, these options are ignored._
159
160
Default = Log event if logging is enabled for the channel.
161
On = Log event in channels even if logging for the channel is disabled.
162
Off = Never log event in channels even if logging for the channel is enabled.
163
164
h2. Messages
165
166
Log regular messages.
167
168
h2. Joins
169
170
Log when a user joins a channel.
171
172
h2. Modes
173
174
Log when a user changes channel modes.
175
176
h2. Parts
177
178
Log when a user leaves a channel.
179
180
h2. Topics
181
182
Log when a user changes a channel topic.
183
184
h2. Quits
185
186
Log when a user quits irc.
187
188
h2. Ctcps
189
190
Log when a user sends a ctcp request.
191
192
h2. Kicks
193
194
Log when a user is kicked from a channel.
195
196
h2. Nicks
197
198
Log when a user changes nick.