Projekt

Allgemein

Profil

« Zurück | Weiter » 

Revision 874a3b3d

Von Moritz Bunkus vor mehr als 13 Jahren hinzugefügt

Mehr Dokumentation für SL/LxDebug.pm

Unterschiede anzeigen:

SL/LXDebug.pm
406 406

  
407 407
=back
408 408

  
409
=head1 CONFIGURATION
410

  
411
C<SL::LXDebug> gets its configuration from the C<[debug]> section of
412
the C<config/lx_office.conf> configuration file. The available options
413
are:
414

  
415
=over 4
416

  
417
=item C<global_level>
418

  
419
A string of log level names that should be activated by
420
default. Multiple log levels are separated by C<|>.
421

  
422
=item C<watch_form>
423

  
424
A boolean (C<1> or C<0>). Turns on the C<$::form> watch facility. If
425
this is enabled then any key inside C<$::form> can be monitored for
426
changes. For example:
427

  
428
  # Start watching 'action'
429
  $::form->{"Watchdog::action"} = 1;
430
  # Stop watching 'invtotal'
431
  $::form->{"Watchdog::invtotal"} = 0;
432

  
433
A log message is written when the watchdog is enabled for a variable
434
and for each subsequent change. The log message includes the place
435
(file name and line number) of the instruction changing the key.
436

  
437
Note that this entails a performance penalty. Also only the keys
438
themselves are monitored -- not the references they point to. E.g. the
439
following would not trigger a change:
440

  
441
  $::form->{"Watchdog::some_hash"} = 1;
442
  # Does not trigger:
443
  $::form->{some_hash}->{some_value} = 42;
444
  # This does trigger:
445
  $::form->{some_hash} = { something => 'else' };
446

  
447
=item C<show_debug_menu>
448

  
449
A boolean (C<1> or C<0>). If turned on then certain debug facilities
450
are available from the v1 menu. These include e.g.
451

  
452
=over 6
453

  
454
=item *
455

  
456
restarting the FastCGI process by forcefully exiting after the
457
request,
458

  
459
=item *
460

  
461
enabling and disabling function tracing,
462

  
463
=item *
464

  
465
enabling and disabling certain debug levels.
466

  
467
=back
468

  
469
Note that these are only useful if Lx-Office is running as a FastCGI
470
application because otherwise the changes would be lost when the
471
process exits in a normal CGI environment.
472

  
473
=item C<keep_temp_files>
474

  
475
A boolean (C<1> or C<0>). If turned on then certain temporary files
476
are not removed but kept in the C<users> directory. These include the
477
temporary files used during printing, e.g. LaTeX files.
478

  
479
=item C<file_name>
480

  
481
The path and file name of the debug log file. Must be a location
482
writeable by the web server process.
483

  
484
=back
485

  
409 486
=head1 FUNCTIONS
410 487

  
411 488
=over 4

Auch abrufbar als: Unified diff