1 2 3 4PLAN(4) PLAN(4) 5 6 7NNAAMMEE 8 ~/.dayplan - database file of plan(1) 9 10SSYYNNOOPPSSIISS 11DDEESSCCRRIIPPTTIIOONN 12 The ~/.dayplan file is read and written by the plan and 13 pland programs. It can be edited manually, but it has not 14 been designed for this. Generally, the format is annoy� 15 ingly unmnemonic, and there is virtually no error check� 16 ing. Use at your own risk. The only reason I didn't make 17 this a binary file is that I dislike binary config files 18 as a matter of principle. 19 20 The type of every line depends on the first character of 21 the line. The second character is always a single TAB 22 character. All following characters are arguments. Com� 23 ments and blank lines (which are ignored) can appear any� 24 where. "Header types" are all at the beginning of the file 25 before the first "entry type". 26 27 TYPES THAT CAN APPEAR ANYWHERE: 28 29 # Comment line. The rest of the line is ignored. 30 31 32 HEADER TYPES: 33 34 o Options. The argument consists of 14 consecutive 35 flag characters, and five numerical arguments. In 36 order, the flags are: 37 38 s sunday first 39 40 a 12-hour (am/pm) mode 41 42 m US date format mm/dd/yy 43 44 d auto-delete past options 45 46 j show julian dates 47 48 w show week numbers 49 50 n show the next three notes, rather than the 51 first three 52 53 - always a minus sign, not used (used to be 54 warning popup mode) 55 56 w show advance warnings graphically in week 57 view 58 59 u show file names next to note strings in week 60 view 61 62 63 64 1 65 66 67 68 69 70PLAN(4) PLAN(4) 71 72 73 b show appointments without time as full-width 74 bar in week views 75 76 - if "w", the first week of the year is the 77 one with full seven days; if "t", the first 78 Thursday controls which week is the first; 79 otherwise, any partial week is first 80 81 c use group color of other file appointments 82 as the background color for the text of 83 these appointments in the day boxes in the 84 month view 85 86 o turn the own-only flag in appointment entry 87 menus on by default, and only show appoint� 88 ments from the main ~/.dayplan file. 89 90 After the flags, there is a sequence of integers: 91 92 - default early warning time in seconds 93 94 - default late warning time in seconds 95 96 - expiration time of notifier windows in sec� 97 onds; 0 means notifiers never expire 98 99 - beginning hour of week views, default is 8 100 (8:00 o'clock) 101 102 - ending hour of week views, default is 20 103 (20:00 o'clock) 104 105 - the number of days displayed in a week view, 106 1..28, default is 7 107 108 O More options. The argument consists of 24 consecu� 109 tive flag characters, most of which are unused and 110 reserved for future use. '-' means an option is 111 off, everything else means the option is on. In 112 order, the flags are: 113 114 s use the main window for all views 115 116 a resize windows if the contents change 117 118 t Time adjustment parameters as defined with the 119 Adjust Time popup. The five numeric parameters are 120 the offset to the system clock in seconds, the 121 timezone offset in seconds, the DST flag (0=always 122 on, 1=always off, 2=automatic), and the Julian 123 begin and end dates for automatic DST. 124 125 e Early warning flags, 126 127 128 129 130 2 131 132 133 134 135 136PLAN(4) PLAN(4) 137 138 139 l Late warning flags, and 140 141 a alarm flags: 142 These three have the same format. The first three 143 argument chars are flags, as specified in the Alarm 144 Options popup. '-' means the flag is off, every� 145 thing else means the flag is on. In order, the 146 flags are: 147 148 w show a color-coded window when the warn� 149 ing/alarm triggers 150 151 m send mail when the warning/alarm triggers 152 153 x execute a command when the warning/alarm 154 triggers 155 156 The flags are followed by a single blank. The rest 157 of the line is the command to execute when the 158 warning/alarm triggers and the 'x' flag is on. 159 160 y Year overview options. There are 10 consecutive 161 flag characters and three numerical arguments. 162 Only one flag is currently defined: 163 164 s show single-day appointments too (those with 165 a repeat-every count of 1) 166 167 - nine unused flags that must be present, all 168 '-' 169 170 After the flags, there is a sequence of integers: 171 172 - the number of months (zoom factor) that 173 fills one screenful 174 175 - The display mode is 0 for the default files 176 as defined in the file list menu, 1 for all 177 files, 2 for own appointments only, and 2 178 for the file defined by the following num� 179 ber. 180 181 - the number of the file whose appointments 182 are displayed if the previous number is 3. 183 184 P The PostScript printing options. Ten flag charac� 185 ters, followed by a blank and the print mode: 186 187 a omit all appointments from the printout 188 189 p omit all private appointments from the 190 printout 191 192 - eight unused flags that must be present, all 193 194 195 196 3 197 198 199 200 201 202PLAN(4) PLAN(4) 203 204 205 '-' 206 207 - the mode: 0 for month, 1 for year, 2 for 208 landscape week, and 3 for portrait week 209 210 p The print spooling string. When printing a 211 PostScript calendar, the PostScript code is sent to 212 stdin of this command. 213 214 m The mailer program, as specified in the Alarm 215 Options menu. Up to one "%s" is allowed, it is 216 replaced by the (quoted) note string. "%s" is typ� 217 ically used for a subject. 218 219 U This code is obsolete since version 1.5. 220 221 u One file in the file list. There are five arguments 222 (the order is strange because the month flag has 223 been added later in version 1.4): 224 225 - the file (login) name 226 227 - the file path 228 229 - 0 if the file is shown in week views, 1 if 230 the file is suspended 231 232 - the color used in the week view, a number in 233 the range 0..7 234 235 - 0 if the file is shown in month views, 1 if 236 the file is suspended 237 238 - 0 if appointments from this file are silent, 239 1 if they can trigger their alarms 240 241 242 ENTRY TYPES: 243 244 [0-9] Begins an entry. This is the only mandatory line, 245 all others that follow are optional. All following 246 lines that do not begin with a numeric digit are 247 extra information for the entry. Unlike all other 248 types, there is no TAB character in the second col� 249 umn, the first character is the first digit of the 250 trigger date. 251 252 The line consists of five date/time fields, seper� 253 ated by at least one blank, and three flag charac� 254 ters that must be consecutive. As usual, flags are 255 off if the character is '-', and on otherwise. The 256 fields are: 257 258 1/2/3 trigger date, month/day/year. Year can be 259 260 261 262 4 263 264 265 266 267 268PLAN(4) PLAN(4) 269 270 271 either 70..99,00..38, or 1970..2038. Do 272 not enter appointments after 2037. If 273 there is demand, I'll fix this bug in 274 about 50 years. 275 276 1:2:3 trigger time, hour:minutes:seconds, in 277 24-hour format. 99:99:99 means that there 278 is no alarm time ("-" in the time column). 279 280 1:2:3 length, hour:minutes:seconds, in 24-hour 281 format 282 283 1:2:3 early-warning time, hour:minutes:seconds, 284 in 24-hour format, 0:0:0 means there is no 285 early warning 286 287 1:2:3 late-warning time, hour:minutes:seconds, 288 in 24-hour format, 0:0:0 means there is no 289 late warning 290 291 S suspended (the green button at the left 292 edge is off) 293 294 P private (goes into the private dayplan 295 file that has mode 0600) 296 297 N no alarm (trigger warnings if nonzero, but 298 no final alarm) 299 300 M do not show this appointment in the month 301 view 302 303 Y do not show this appointment in the year 304 view 305 306 W do not show this appointment in the week 307 view 308 309 O do not show this appointment in the year 310 overview 311 312 D do not show this appointment in the day 313 view 314 315 t this is an active todo item, move to today 316 if in the past 317 318 - one unused flag, always '-' 319 320 0 appointment text color in month calendar: 321 0 is default, 1..8 are colors 322 323 0 show a warning this many days in advance: 324 0 means never, 1 means one day ahead, etc. 325 326 327 328 5 329 330 331 332 333 334PLAN(4) PLAN(4) 335 336 337 E Add an exception date to the appointment. After the 338 'E', a tab and a date m/d/y on which the appoint� 339 ment will not trigger follow. There can be up to 340 four 'E' lines for each appointment (see NEXC in 341 conf.h). 342 343 R Add repetition information to the current entry. 344 There are five numeric fields, separated by at 345 least one blank. This one is particularly unsuited 346 for human consumption, sorry. 347 348 1 trigger alarm every <1> days (in seconds) 349 350 2 delete alarm after this date (seconds since 351 1/1/70 0:00:00) 352 353 3 weekday bitmap and nth-week bitmap: 354 bit0=sunday ... bit6=saturday 355 bit8=first ... bit12=fifth, bit13=last 356 357 4 month day bitmap, bit0=last day of the 358 month, bits 1..31=on that day of the month 359 360 5 if 1, the entry repeats every year; if 0, it 361 doesn't. 362 363 N Add a note string to the current entry. All charac� 364 ters that follow the TAB are part of the note 365 string. 366 367 M Add another line to the current entry's message. 368 All characters that follow the TAB are part of the 369 line. There can be multiple M lines, they all add 370 to the message. 371 372 S Add another line to the current entry's script. All 373 characters that follow the TAB are part of the 374 line. There can be multiple S lines, they all add 375 to the script. 376 377 G Reserved for group meetings, not currently used. 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 6 395 396 397