1 # cloggerconfig.cif

     2 # 

     3 # Copyright (c) 2010 Accenture. All rights reserved.

     4 # This component and the accompanying materials are made available

     5 # under the terms of the "Eclipse Public License v1.0"

     6 # which accompanies this distribution, and is available

     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 # 

     9 # Initial Contributors:

    10 # Accenture - Initial contribution

    11 #

    12 

    13 ==name cloggerconfig

    14 

    15 ==short-description

    16 

    17 Gets and sets the configuration of the Clogger server.

    18 

    19 ==long-description

    20 

    21 If no arguments are given, lists all settings. See F<\epoc32\include\clogger.h> for more information about the C<RClogger> interface, or see L<clogger|clogger> in the fshell documentation. Some of the 'magic numbers' you may wish to use are documented here as well.

    22 

    23 Rotate options (for --set-rotate), can be ORed together:

    24 

    25 	1  ECopyRotatedToExternalMedia

    26 	4  EAutoRotateAtStartup

    27 	8  ECompressRotatedLogs

    28 

    29 Global options (for --set-global), can be ORed together:

    30 

    31 	1  EBufferLog

    32 	2  EMirrorToRDebugPrint

    33 	4  EMirrorToBluetooth

    34 	8  ERedirectRDebugPrintToClogger

    35 	16 EDisableFileWriter

    36 

    37 ==argument string tag_name optional

    38 

    39 Specify a particular tag name to get or set.

    40 

    41 ==argument uint enabled_mask optional

    42 

    43 The bitmask to set. If not specified, the curent value is shown instead.

    44 

    45 ==option uint g set-global

    46 

    47 Set global options. See description below.

    48 

    49 ==option bool p persist

    50 

    51 Persist any settings that are changed during this call, by calling C<RClogger::PersistSettings> at the end.

    52 

    53 ==option bool s reset

    54 

    55 Resets all settings, by calling C<RClogger::ResetSettings>.

    56 

    57 ==option uint o set-rotate

    58 

    59 Set rotate options. See description below.

    60 

    61 ==option bool r rotate

    62 

    63 Rotates the log file, for more info see C<RClogger::Rotate>.

    64 

    65 ==option bool f follow

    66 

    67 Displays the logging in the console as it is written. Note that this only shows logging that occurs after the command is invoked. To look at what's already been logged you need to examine the log file F<c:\Logs\clogger.txt> directly. Currently this option has to switch on C<EBufferLog> to function correctly and it dosen't switch it off again at the end.

    68 

    69 ==option int n num-buffers

    70 

    71 Sets the number of buffers to use (if buffered logging is enabled).

    72 

    73 ==option uint b buffer-size

    74 

    75 Sets the buffer size in bytes (if buffered logging is enabled).

    76 

    77 ==option bool w wipe

    78 

    79 Erases everything in F<c:\Logs\clogger.txt>, without rotating.

    80 

    81 ==option bool d rdebug

    82 

    83 Switches on rdebug redirection and prints to console (roughly equivalent to C<--set-global 8 --follow>).

    84 

    85 ==option bool a backup

    86 

    87 Saves the current persisted clogger settings to the removable media.

    88 

    89 ==option bool e restore

    90 

    91 Restores settings saved with C<--backup>.

    92 

    93 ==option bool D disable-all

    94 

    95 Disable all the currently registered tags.

    96 

    97 ==option bool E enable-all

    98 

    99 Enable all the currently registered tags.

   100 

   101 ==copyright

   102 

   103 Copyright (c) 2007-2010 Accenture. All rights reserved.

   104