commands/cloggerconfig/cloggerconfig.cif
author Tom Sutcliffe <thomas.sutcliffe@accenture.com>
Sun, 17 Oct 2010 18:43:12 +0100
changeset 69 849a0b46c767
parent 0 7f656887cf89
permissions -rw-r--r--
Fixed lots of issues with installing a low-caps version of fshell from SIS file. * Fixed issue in CCommandFactory whereby some APIs like GetCommandInfoL could trigger allocations on the wrong heap or signals to the wrong thread. The symptoms were often seen as a crash in the which_00 thread when running ciftest. * Lots of build fixes for when FSHELL_PROTECTED_UIDS isn't defined and when all capabilities aren't available. * Added new platform.mmh macro FSHELL_OPEN_SIGNED. * Open signing of fshell SIS files is now supported for production S60 handsets. Build fshell with the FSHELL_OPEN_SIGNED macro defined (and without defining FSHELL_CAP_ALL or FSHELL_PROTECTED_UIDS) in your platform.mmh and submit \epoc32\fshell\fshell.unsigned.sis to https://www.symbiansigned.com/app/page/public/openSignedOnline.do . The following commands are not available when using Open Signing due to Platform Security restrictions: fdb; kerninfo; chunkinfo; svrinfo; objinfo; sudo; fsck; localdrive; ramdefrag; readmem; reboot; setcritical; setpriority. Others such as chkdeps, e32header, ps, and fshell itself will run but in a restricted capacity (for example, fshell will no longer allow you to modify files in the \sys\bin directory). * Removed commands objinfo, svrinfo, chunkinfo, readmem, fsck completely when memory access isn't present - previously they would still appear in the help but would give an error if you tried to run them.

# cloggerconfig.cif
# 
# Copyright (c) 2010 Accenture. All rights reserved.
# This component and the accompanying materials are made available
# under the terms of the "Eclipse Public License v1.0"
# which accompanies this distribution, and is available
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
# 
# Initial Contributors:
# Accenture - Initial contribution
#

==name cloggerconfig

==short-description

Gets and sets the configuration of the Clogger server.

==long-description

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.

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

	1  ECopyRotatedToExternalMedia
	4  EAutoRotateAtStartup
	8  ECompressRotatedLogs

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

	1  EBufferLog
	2  EMirrorToRDebugPrint
	4  EMirrorToBluetooth
	8  ERedirectRDebugPrintToClogger
	16 EDisableFileWriter

==argument string tag_name optional

Specify a particular tag name to get or set.

==argument uint enabled_mask optional

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

==option uint g set-global

Set global options. See description below.

==option bool p persist

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

==option bool s reset

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

==option uint o set-rotate

Set rotate options. See description below.

==option bool r rotate

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

==option bool f follow

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.

==option int n num-buffers

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

==option uint b buffer-size

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

==option bool w wipe

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

==option bool d rdebug

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

==option bool a backup

Saves the current persisted clogger settings to the removable media.

==option bool e restore

Restores settings saved with C<--backup>.

==option bool D disable-all

Disable all the currently registered tags.

==option bool E enable-all

Enable all the currently registered tags.

==copyright

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